esos/include/all_generic.h

Go to the documentation of this file.

/*
 * "Copyright (c) 2008 Robert B. Reese, Bryan A. Jones, J. W. Bruce ("AUTHORS")"
 * All rights reserved.
 * (R. Reese, reese_AT_ece.msstate.edu, Mississippi State University)
 * (B. A. Jones, bjones_AT_ece.msstate.edu, Mississippi State University)
 * (J. W. Bruce, jwbruce_AT_ece.msstate.edu, Mississippi State 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


#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 Microchip PIC24 microcontrollers
#include "pic24_generic.h"
#endif


typedef union _UINT8 {
  uint8 _uint8;
  uint8 u8;
  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 _uint16;
  uint16 u16;
  struct {
    uint8 u8Lsb;
    uint8 u8Msb;
  };
  struct {
    uint8 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 _uint32;
  uint32 u32;
  struct {
    uint8 u8LoLsb;
    uint8 u8LoMsb;
    uint8 u8HiLsb;
    uint8 u8HiMsb;
  };
  struct {
    uint16 u16LoWord;
    uint16 u16HiWord;
  };
  struct {
    uint16 u16Words[2];
  };
  struct {
    uint8 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 NULLPTR         0

#define NULLIDX         0xFF

#define BIT0            0x01

#define BIT1            0x02

#define BIT2            0x04

#define BIT3            0x08

#define BIT4            0x10

#define BIT5            0x20

#define BIT6            0x40

#define BIT7            0x80

#define BIT8            0x0100

#define BIT9            0x0200

#define BIT10           0x0400

#define BIT11           0x0800

#define BIT12           0x1000

#define BIT13           0x2000

#define BIT14           0x4000

#define BIT15           0x8000

#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

---