all_generic.h

Go to the documentation of this file.

/*
 * "Copyright (c) 2019 J. W. Bruce ("AUTHOR(S)")"
 * All rights reserved.
 * (J. W. Bruce, jwbruce_AT_tntech.edu, Tennessee Tech University)
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose, without fee, and without written agreement is
 * hereby granted, provided that the above copyright notice, the following
 * two paragraphs and the authors appear in all copies of this software.
 *
 * IN NO EVENT SHALL THE "AUTHORS" BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
 * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE "AUTHORS"
 * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * THE "AUTHORS" SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE "AUTHORS" HAS NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
 *
 * Please maintain this header in its entirety when copying/modifying
 * these files.
 *
 *
 */
 
// Documentation for this file. If the \file tag isn't present,
// this file won't be documented.
#ifndef __ALL_GENERIC_H
#define __ALL_GENERIC_H
 
#include <stdint.h>
#ifdef  __linux
#warning    Compiling for 32-bit Linux
#include "pc_generic.h"
#define HELLO_MSG "\n" __FILE__ ", built on " __DATE__ " at " __TIME__ "\n"
#else
//#warning    Compiling for STM32 L4
#define HELLO_MSG "\n" __FILE__ ", built on " __DATE__ " at " __TIME__ "\n"
/*
 * We might need to include pc_generic.h here or write a new one.
 */
#endif
 
 
typedef union _UINT8 {
  uint8_t _uint8;
  uint8_t u8;
  struct {
    unsigned LSN: 4;    
    unsigned MSN: 4;    
  };
  struct {
unsigned b0:
    1;
unsigned b1:
    1;
unsigned b2:
    1;
unsigned b3:
    1;
unsigned b4:
    1;
unsigned b5:
    1;
unsigned b6:
    1;
unsigned b7:
    1;
  };
} UINT8;
 
typedef union _UINT16 {
  uint16_t _uint16;
  uint16_t u16;
  int16_t int16;
  int16_t i16;
  struct {
    uint8_t u8Lsb;
    uint8_t u8Msb;
  };
  struct {
    unsigned LSBLSN: 4;
    unsigned LSBMSN: 4;
    unsigned MSBLSN: 4;
    unsigned MSBMSN: 4;
  };
  struct {
    uint8_t u8Bytes[2];
  };
  struct {
unsigned b0:
    1;
unsigned b1:
    1;
unsigned b2:
    1;
unsigned b3:
    1;
unsigned b4:
    1;
unsigned b5:
    1;
unsigned b6:
    1;
unsigned b7:
    1;
unsigned b8:
    1;
unsigned b9:
    1;
unsigned b10:
    1;
unsigned b11:
    1;
unsigned b12:
    1;
unsigned b13:
    1;
unsigned b14:
    1;
unsigned b15:
    1;
  };
} UINT16;
 
#define LSB(a)      ((a).u8Bytes[0])
 
#define MSB(a)      ((a).u8Bytes[1])
 
typedef union _UINT32 {
  uint32_t _uint32;
  uint32_t u32;
  struct {
    uint8_t u8LoLsb;
    uint8_t u8LoMsb;
    uint8_t u8HiLsb;
    uint8_t u8HiMsb;
  };
  struct {
    uint16_t u16LoWord;
    uint16_t u16HiWord;
  };
  struct {
    uint16_t u16Words[2];
  };
  struct {
    uint8_t u8Bytes[4];
  };
  struct {
unsigned b0:
    1;
unsigned b1:
    1;
unsigned b2:
    1;
unsigned b3:
    1;
unsigned b4:
    1;
unsigned b5:
    1;
unsigned b6:
    1;
unsigned b7:
    1;
unsigned b8:
    1;
unsigned b9:
    1;
unsigned b10:
    1;
unsigned b11:
    1;
unsigned b12:
    1;
unsigned b13:
    1;
unsigned b14:
    1;
unsigned b15:
    1;
unsigned b16:
    1;
unsigned b17:
    1;
unsigned b18:
    1;
unsigned b19:
    1;
unsigned b20:
    1;
unsigned b21:
    1;
unsigned b22:
    1;
unsigned b23:
    1;
unsigned b24:
    1;
unsigned b25:
    1;
unsigned b26:
    1;
unsigned b27:
    1;
unsigned b28:
    1;
unsigned b29:
    1;
unsigned b30:
    1;
unsigned b31:
    1;
  };
} UINT32;
 
// Now, some macros to help navigate these structures.....
#define LOWER_WORD(a)   ((a).u16Words[0])
 
#define UPPER_WORD(a)   ((a).u16Words[1])
 
#define LOWER_LSB(a)    ((a).u8Bytes[0])
 
#define LOWER_MSB(a)    ((a).u8Bytes[1])
 
#define UPPER_LSB(a)    ((a).u8Bytes[2])
 
#define UPPER_MSB(a)    ((a).u8Bytes[3])
 
typedef enum _BOOL {
  FALSE = 0,
  TRUE
} BOOL;
 
#define OK              TRUE
 
#define FAIL            FALSE
 
 
#define ON        TRUE
#define OFF       FALSE
 
 
#define HIGH      TRUE
#define LOW       FALSE
 
// These defines are defined in the HAL include files.  If we define
// them here, it throws compiler errors
//      error: redeclaration of enumerator 'FALSE'
#ifndef USE_HAL_DRIVER
#define ENABLE      TRUE
#define DISABLE     FALSE
#endif
 
#define NULLPTR         0
 
#define NULLIDX         0xFF
 
// Create bit masks for ease-of-use.  Surround each
// with #ifndef because some libraries (libopencm3,
// for example) have already defined these constants
//
//
#ifndef ESOS_BIT0
#define ESOS_BIT0            0x0001
#endif
 
#ifndef ESOS_BIT1
#define ESOS_BIT1            0x0002
#endif
 
#ifndef ESOS_BIT2
#define ESOS_BIT2            0x0004
#endif
 
#ifndef ESOS_BIT3
#define ESOS_BIT3            0x0008
#endif
 
#ifndef ESOS_BIT4
#define ESOS_BIT4            0x0010
#endif
 
#ifndef ESOS_BIT5
#define ESOS_BIT5            0x0020
#endif
 
#ifndef ESOS_BIT6
#define ESOS_BIT6            0x0040
#endif
 
#ifndef ESOS_BIT7
#define ESOS_BIT7            0x0080
#endif
 
#ifndef ESOS_BIT8
#define ESOS_BIT8            0x0100
#endif
 
#ifndef ESOS_BIT9
#define ESOS_BIT9            0x0200
#endif
 
#ifndef ESOS_BIT10
#define ESOS_BIT10           0x0400
#endif
 
#ifndef ESOS_BIT11
#define ESOS_BIT11           0x0800
#endif
 
#ifndef ESOS_BIT12
#define ESOS_BIT12           0x1000
#endif
 
#ifndef ESOS_BIT13
#define ESOS_BIT13           0x2000
#endif
 
#ifndef ESOS_BIT14
#define ESOS_BIT14           0x4000
#endif
 
#ifndef ESOS_BIT15
#define ESOS_BIT15           0x8000
#endif
 
#ifndef ESOS_BIT16
#define ESOS_BIT16            0x00010000
#endif
 
#ifndef ESOS_BIT17
#define ESOS_BIT17            0x00020000
#endif
 
#ifndef ESOS_BIT18
#define ESOS_BIT18            0x00040000
#endif
 
#ifndef ESOS_BIT19
#define ESOS_BIT19            0x00080000
#endif
 
#ifndef ESOS_BIT20
#define ESOS_BIT20            0x00100000
#endif
 
#ifndef ESOS_BIT21
#define ESOS_BIT21            0x00200000
#endif
 
#ifndef ESOS_BIT22
#define ESOS_BIT22            0x00400000
#endif
 
#ifndef ESOS_BIT23
#define ESOS_BIT23           0x00800000
#endif
 
#ifndef ESOS_BIT24
#define ESOS_BIT24            0x01000000
#endif
 
#ifndef ESOS_BIT25
#define ESOS_BIT25            0x02000000
#endif
 
#ifndef ESOS_BIT26
#define ESOS_BIT26           0x04000000
#endif
 
#ifndef ESOS_BIT27
#define ESOS_BIT27           0x08000000
#endif
 
#ifndef ESOS_BIT28
#define ESOS_BIT28           0x10000000
#endif
 
#ifndef ESOS_BIT29
#define ESOS_BIT29           0x20000000
#endif
 
#ifndef ESOS_BIT30
#define ESOS_BIT30           0x40000000
#endif
 
#ifndef ESOS_BIT31
#define ESOS_BIT31           0x80000000
#endif
 
#define BIT_SET_MASK(var, mask)             ((var) |= (mask))
 
#define BIT_CLEAR_MASK(var, mask)           ((var) &= (~(mask)))
 
#define BIT_TOGGLE_MASK(var, mask)          ((var) ^= (mask))
 
#define IS_BIT_SET_MASK(var, mask)          (((var) & (mask)))
 
#define IS_BIT_CLEAR_MASK(var, mask)        ((~(var) & (mask)))
 
#define BIT_SET(var, bitnum)             ((var) |= (1 << (bitnum)))
 
#define BIT_CLEAR(var, bitnum)           ((var) &= (~(1 << (bitnum))))
 
#define BIT_TOGGLE(var, bitnum)          ((var) ^= (1 << (bitnum)))
 
#define IS_BIT_SET(var, bitnum)          ((var) & (1 << (bitnum)))
 
#define IS_BIT_CLEAR(var, bitnum)        (~(var) & ((1 << (bitnum))))
 
#endif    // __ALL_GENERIC_H