Common library convenience headers, macros and functions.
More...
Common library convenience headers, macros and functions.
Common utility headers containing macros, functions, enums and types which are common to all aspects of the library.
Macro for encasing other multi-statement macros. This should be used along with a preceding closing brace at the end of any multi-statement macro, so that the macros contents as a whole are treated as a discrete block and not as a list of separate statements which may cause problems when used as a block (such as inline if
statements).
Definition at line 160 of file Common.h.
Macro for encasing other multi-statement macros. This should be used along with an opening brace before the start of any multi-statement macro, so that the macros contents as a whole are treated as a discrete block and not as a list of separate statements which may cause problems when used as a block (such as inline if
statements).
Definition at line 153 of file Common.h.
#define MAX |
( |
|
x, |
|
|
|
y |
|
) |
| (((x) > (y)) ? (x) : (y)) |
Convenience macro to determine the larger of two values.
- Note
- This macro should only be used with operands that do not have side effects from being evaluated multiple times.
- Parameters
-
x | First value to compare |
y | First value to compare |
- Returns
- The larger of the two input parameters
Definition at line 173 of file Common.h.
#define MIN |
( |
|
x, |
|
|
|
y |
|
) |
| (((x) < (y)) ? (x) : (y)) |
Convenience macro to determine the smaller of two values.
- Note
- This macro should only be used with operands that do not have side effects from being evaluated multiple times.
- Parameters
-
x | First value to compare |
y | First value to compare |
- Returns
- The smaller of the two input parameters
Definition at line 187 of file Common.h.
#define STRINGIFY |
( |
|
x | ) |
#x |
Converts the given input into a string, via the C Preprocessor. This macro puts literal quotation marks around the input, converting the source into a string literal.
- Parameters
-
x | Input to convert into a string literal. |
- Returns
- String version of the input.
Definition at line 198 of file Common.h.
Converts the given input into a string after macro expansion, via the C Preprocessor. This macro puts literal quotation marks around the expanded input, converting the source into a string literal.
- Parameters
-
x | Input to expand and convert into a string literal. |
- Returns
- String version of the expanded input.
Definition at line 207 of file Common.h.
Type define for an unsigned integer the same width as the selected architecture's machine register. This is distinct from the non-specific standard int data type, whose width is machine dependant but which may not reflect the actual machine register width on some targets (e.g. LPC).
Definition at line 87 of file Common.h.
static uint8_t BitReverse |
( |
uint8_t |
Byte | ) |
|
|
inlinestatic |
Function to reverse the individual bits in a byte - i.e. bit 7 is moved to bit 0, bit 6 to bit 1, etc.
- Parameters
-
Byte | Byte of data whose bits are to be reversed. |
Definition at line 235 of file Common.h.
static void Delay_MS |
( |
uint16_t |
Milliseconds | ) |
|
|
inlinestatic |
Function to perform a blocking delay for a specified number of milliseconds. The actual delay will be at a minimum the specified number of milliseconds, however due to loop overhead and internal calculations may be slightly higher.
- Parameters
-
Milliseconds | Number of milliseconds to delay |
Definition at line 252 of file Common.h.