Common PLATFORM_HEADER Configuration#

Compiler and Platform specific definitions and typedefs common to all platforms.

platform-common.h provides PLATFORM_HEADER defaults and common definitions. This head should never be included directly, it should only be included by the specific PLATFORM_HEADER used by your platform.

See platform-common.h for source code.

Generic Types#

#define
TRUE 1

An alias for one, used for clarity.

#define
FALSE 0

An alias for zero, used for clarity.

#define
NULL ((void *)0)

The null pointer.

Bit Manipulation Macros#

#define
BIT (x)

Useful to reference a single bit of a byte.

#define
BIT32 (x)

Useful to reference a single bit of an uint32_t type.

#define
SETBIT (reg, bit)

Sets bit in the reg register or byte.

#define
SETBITS (reg, bits)

Sets the bits in the reg register or the byte as specified in the bitmask bits.

#define
CLEARBIT (reg, bit)

Clears a bit in the reg register or byte.

#define
CLEARBITS (reg, bits)

Clears the bits in the reg register or byte as specified in the bitmask bits.

#define
READBIT (reg, bit)

Returns the value of bit within the register or byte reg.

#define
READBITS (reg, bits)

Returns the value of the bitmask bits within the register or byte reg.

Byte Manipulation Macros#

#define
LOW_BYTE (n)

Returns the low byte of the 16-bit value n as an uint8_t.

#define
HIGH_BYTE (n)

Returns the high byte of the 16-bit value n as an uint8_t.

#define
HIGH_LOW_TO_INT (high, low)

Returns the value built from the two uint8_t values high and low.

#define
INT8U_TO_INT32U (byte3, byte2, byte1, byte0)

Returns the value built from the four uint8_t as an uint32_t.

#define
BYTE_0 (n)

Returns the low byte of the 32-bit value n as an uint8_t.

#define
BYTE_1 (n)

Returns the second byte of the 32-bit value n as an uint8_t.

#define
BYTE_2 (n)

Returns the third byte of the 32-bit value n as an uint8_t.

#define
BYTE_3 (n)

Returns the high byte of the 32-bit value n as an uint8_t.

#define
BYTE_4 (n)

Returns the fifth byte of the 64-bit value n as an uint8_t.

#define
BYTE_5 (n)

Returns the sixth byte of the 64-bit value n as an uint8_t.

#define
BYTE_6 (n)

Returns the seventh byte of the 64-bit value n as an uint8_t.

#define
BYTE_7 (n)

Returns the high byte of the 64-bit value n as an uint8_t.

#define
COUNTOF (a)

Returns the number of entries in an array.

Time Manipulation Macros#

#define
elapsedTimeInt8u (oldTime, newTime)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.

#define
elapsedTimeInt16u (oldTime, newTime)

Returns the elapsed time between two 16 bit values. Result may not be valid if the time samples differ by more than 32767.

#define
elapsedTimeInt32u (oldTime, newTime)

Returns the elapsed time between two 32 bit values. Result may not be valid if the time samples differ by more than 2147483647.

#define
MAX_INT8U_VALUE (0xFF)

Returns true if t1 is greater than t2. Can only account for 1 wrap around of the variable before it is wrong.

#define
HALF_MAX_INT8U_VALUE (0x80)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.

#define
timeGTorEqualInt8u (t1, t2)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.

#define
MAX_INT16U_VALUE (0xFFFF)

Returns true if t1 is greater than t2. Can only account for 1 wrap around of the variable before it is wrong.

#define
HALF_MAX_INT16U_VALUE (0x8000)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.

#define
timeGTorEqualInt16u (t1, t2)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.

#define
MAX_INT32U_VALUE (0xFFFFFFFFUL)

Returns true if t1 is greater than t2. Can only account for 1 wrap around of the variable before it is wrong.

#define
HALF_MAX_INT32U_VALUE (0x80000000UL)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.

#define
timeGTorEqualInt32u (t1, t2)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.

Miscellaneous Macros#

#define
UNUSED_VAR (x)

  • Description:\n Useful macro for avoiding compiler warnings related to unused#

    function arguments or unused variables.

#define
DEBUG_LEVEL BASIC_DEBUG

Set debug level based on whether DEBUG or DEBUG_STRIPPED are defined.

#define
STATIC_ASSERT (__condition, __errorstr)

Disable static assertions on compilers that don't support them.

Generic Types Documentation#

TRUE#

#define TRUE
Value:
1

An alias for one, used for clarity.


FALSE#

#define FALSE
Value:
0

An alias for zero, used for clarity.


NULL#

#define NULL
Value:
((void *)0)

The null pointer.


Bit Manipulation Macros Documentation#

BIT#

#define BIT
Value:
(x)

Useful to reference a single bit of a byte.


BIT32#

#define BIT32
Value:
(x)

Useful to reference a single bit of an uint32_t type.


SETBIT#

#define SETBIT
Value:
(reg, bit)

Sets bit in the reg register or byte.

Note

  • Assuming reg is an IO register, some platforms (such as the AVR) can implement this in a single atomic operation.


SETBITS#

#define SETBITS
Value:
(reg, bits)

Sets the bits in the reg register or the byte as specified in the bitmask bits.

Note

  • This is never a single atomic operation.


CLEARBIT#

#define CLEARBIT
Value:
(reg, bit)

Clears a bit in the reg register or byte.

Note

  • Assuming reg is an IO register, some platforms (such as the AVR) can implement this in a single atomic operation.


CLEARBITS#

#define CLEARBITS
Value:
(reg, bits)

Clears the bits in the reg register or byte as specified in the bitmask bits.

Note

  • This is never a single atomic operation.


READBIT#

#define READBIT
Value:
(reg, bit)

Returns the value of bit within the register or byte reg.


READBITS#

#define READBITS
Value:
(reg, bits)

Returns the value of the bitmask bits within the register or byte reg.


Byte Manipulation Macros Documentation#

LOW_BYTE#

#define LOW_BYTE
Value:
(n)

Returns the low byte of the 16-bit value n as an uint8_t.


HIGH_BYTE#

#define HIGH_BYTE
Value:
(n)

Returns the high byte of the 16-bit value n as an uint8_t.


HIGH_LOW_TO_INT#

#define HIGH_LOW_TO_INT
Value:
( \
((uint16_t) (((uint16_t) (high)) << 8)) \
+ ((uint16_t) ((low) & 0xFFu)) \
)

Returns the value built from the two uint8_t values high and low.


INT8U_TO_INT32U#

#define INT8U_TO_INT32U
Value:
( \
(((uint32_t) (byte3)) << 24) \
+ (((uint32_t) (byte2)) << 16) \
+ (((uint32_t) (byte1)) << 8) \
+ ((uint32_t) ((byte0) & 0xFFu)) \
)

Returns the value built from the four uint8_t as an uint32_t.


BYTE_0#

#define BYTE_0
Value:
(n)

Returns the low byte of the 32-bit value n as an uint8_t.


BYTE_1#

#define BYTE_1
Value:
(n)

Returns the second byte of the 32-bit value n as an uint8_t.


BYTE_2#

#define BYTE_2
Value:
(n)

Returns the third byte of the 32-bit value n as an uint8_t.


BYTE_3#

#define BYTE_3
Value:
(n)

Returns the high byte of the 32-bit value n as an uint8_t.


BYTE_4#

#define BYTE_4
Value:
(n)

Returns the fifth byte of the 64-bit value n as an uint8_t.


BYTE_5#

#define BYTE_5
Value:
(n)

Returns the sixth byte of the 64-bit value n as an uint8_t.


BYTE_6#

#define BYTE_6
Value:
(n)

Returns the seventh byte of the 64-bit value n as an uint8_t.


BYTE_7#

#define BYTE_7
Value:
(n)

Returns the high byte of the 64-bit value n as an uint8_t.


COUNTOF#

#define COUNTOF
Value:
(a)

Returns the number of entries in an array.


Time Manipulation Macros Documentation#

elapsedTimeInt8u#

#define elapsedTimeInt8u
Value:
(oldTime, newTime)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.


elapsedTimeInt16u#

#define elapsedTimeInt16u
Value:
(oldTime, newTime)

Returns the elapsed time between two 16 bit values. Result may not be valid if the time samples differ by more than 32767.


elapsedTimeInt32u#

#define elapsedTimeInt32u
Value:
(oldTime, newTime)

Returns the elapsed time between two 32 bit values. Result may not be valid if the time samples differ by more than 2147483647.


MAX_INT8U_VALUE#

#define MAX_INT8U_VALUE
Value:
(0xFF)

Returns true if t1 is greater than t2. Can only account for 1 wrap around of the variable before it is wrong.


HALF_MAX_INT8U_VALUE#

#define HALF_MAX_INT8U_VALUE
Value:
(0x80)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.


timeGTorEqualInt8u#

#define timeGTorEqualInt8u
Value:
(t1, t2)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.


MAX_INT16U_VALUE#

#define MAX_INT16U_VALUE
Value:
(0xFFFF)

Returns true if t1 is greater than t2. Can only account for 1 wrap around of the variable before it is wrong.


HALF_MAX_INT16U_VALUE#

#define HALF_MAX_INT16U_VALUE
Value:
(0x8000)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.


timeGTorEqualInt16u#

#define timeGTorEqualInt16u
Value:
(t1, t2)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.


MAX_INT32U_VALUE#

#define MAX_INT32U_VALUE
Value:
(0xFFFFFFFFUL)

Returns true if t1 is greater than t2. Can only account for 1 wrap around of the variable before it is wrong.


HALF_MAX_INT32U_VALUE#

#define HALF_MAX_INT32U_VALUE
Value:
(0x80000000UL)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.


timeGTorEqualInt32u#

#define timeGTorEqualInt32u
Value:
(t1, t2)

Returns the elapsed time between two 8 bit values. Result may not be valid if the time samples differ by more than 127.


Miscellaneous Macros Documentation#

UNUSED_VAR#

#define UNUSED_VAR
Value:
(x)

  • Description:\n Useful macro for avoiding compiler warnings related to unused#

    function arguments or unused variables.


DEBUG_LEVEL#

#define DEBUG_LEVEL
Value:
BASIC_DEBUG

Set debug level based on whether DEBUG or DEBUG_STRIPPED are defined.


STATIC_ASSERT#

#define STATIC_ASSERT

Disable static assertions on compilers that don't support them.