Hilscher netX microcontroller driver
V0.0.5.0
Documentation of the netX driver package
|
Data Structures | |
struct | DRV_TRACE_QUEUE_ELEMENT_T |
Trace structure used for debug tracing of the drivers. More... | |
Macros | |
#define | TRACE_MODULE_ACTIVE |
Defines if the trace module is used. More... | |
#define | ulTraceQueueSize ((uint32_t const) 512) |
Defines the queue for the trace functionality. More... | |
Enumerations | |
enum | DRV_TRACE_KEY_E { DRV_TRACE_KEY_DEFAULT = 0x0ul, DRV_TRACE_KEY_DATA, DRV_TRACE_KEY_MODE, DRV_TRACE_KEY_BORDER, DRV_TRACE_KEY_COUNTER, DRV_TRACE_KEY_ITERATION, DRV_TRACE_KEY_LENGTH, DRV_TRACE_KEY_IRQ, DRV_TRACE_KEY_MSK, DRV_TRACE_KEY_STATE, DRV_TRACE_KEY_INFO, DRV_TRACE_KEY_11, DRV_TRACE_KEY_12, DRV_TRACE_KEY_13, DRV_TRACE_KEY_COUNT } |
Enumerates the keys used for the trace function. More... | |
Functions | |
void | TRACE (uint32_t ulKey, uint32_t ulValue) |
The trace function stores the given key and the given value in a cyclic list. More... | |
__STATIC_FORCEINLINE void | TRACE_PAUSE (void) |
Stop the trace. More... | |
__STATIC_FORCEINLINE void | TRACE_RUN (void) |
Start the trace. More... | |
void | TRACE_RESET (void) |
The trace reset is doing what its name tells. It resets the trace. More... | |
Variables | |
char const *const | g_pabDrvTraceKeySrings [] |
References the string array of the keys. More... | |
uint32_t volatile | g_ulQueueCounter |
references the counter that points to the next queue element. More... | |
uint32_t volatile | g_ulRunFlag |
references the running flag of the tracer. More... | |
uint32_t volatile | g_ulQueueSize |
References the ques size. More... | |
volatile DRV_TRACE_QUEUE_ELEMENT_T | g_atTraceQueue [] |
References the queue used for the debug trace functionality. More... | |
uint32_t volatile | g_ulQueueCounter = 0 |
references the counter that points to the next queue element. More... | |
uint32_t volatile | g_ulRunFlag = 0 |
references the running flag of the tracer. More... | |
volatile DRV_TRACE_QUEUE_ELEMENT_T | g_atTraceQueue [ulTraceQueueSize] |
References the queue used for the debug trace functionality. More... | |
char const *const | g_pabDrvTraceKeySrings [] |
References the string array of the keys. More... | |
size_t | u_DRV_TRACE_KEY_STRINGS |
#define TRACE_MODULE_ACTIVE |
Defines if the trace module is used.
Definition at line 247 of file netx_drv.h.
#define ulTraceQueueSize ((uint32_t const) 512) |
Defines the queue for the trace functionality.
Definition at line 308 of file netx_drv.h.
enum DRV_TRACE_KEY_E |
Enumerates the keys used for the trace function.
Definition at line 252 of file netx_drv.h.
void TRACE | ( | uint32_t | ulKey, |
uint32_t | ulValue | ||
) |
The trace function stores the given key and the given value in a cyclic list.
[in] | ulKey | A key from the DRV_TRACE_KEY_E |
[in] | ulValue | A value to be stored besides the key |
This is the debug trace functionality that is capable of logging a given key and value pair with minimal trade of.
Definition at line 65 of file netx_drv.c.
__STATIC_FORCEINLINE void TRACE_PAUSE | ( | void | ) |
Stop the trace.
void |
Definition at line 323 of file netx_drv.h.
void TRACE_RESET | ( | void | ) |
The trace reset is doing what its name tells. It resets the trace.
Function, that resets the ringbuffer of the trace to default values.
Definition at line 82 of file netx_drv.c.
__STATIC_FORCEINLINE void TRACE_RUN | ( | void | ) |
Start the trace.
void |
Definition at line 333 of file netx_drv.h.
volatile DRV_TRACE_QUEUE_ELEMENT_T g_atTraceQueue[ulTraceQueueSize] |
References the queue used for the debug trace functionality.
This is the queue used for the debug trace functionality
Definition at line 47 of file netx_drv.c.
volatile DRV_TRACE_QUEUE_ELEMENT_T g_atTraceQueue[] |
References the queue used for the debug trace functionality.
This is the queue used for the debug trace functionality
Definition at line 47 of file netx_drv.c.
char const* const g_pabDrvTraceKeySrings[] |
References the string array of the keys.
Array, containing the strings of the associated keys
Definition at line 54 of file netx_drv.c.
char const* const g_pabDrvTraceKeySrings[] |
References the string array of the keys.
Array, containing the strings of the associated keys
Definition at line 54 of file netx_drv.c.
uint32_t volatile g_ulQueueCounter = 0 |
references the counter that points to the next queue element.
The following part is used for debugging purposes.
This is the counter that points to the next queue element
Definition at line 37 of file netx_drv.c.
uint32_t volatile g_ulQueueCounter |
references the counter that points to the next queue element.
The following part is used for debugging purposes.
This is the counter that points to the next queue element
Definition at line 37 of file netx_drv.c.
uint32_t volatile g_ulQueueSize |
References the ques size.
uint32_t volatile g_ulRunFlag = 0 |
references the running flag of the tracer.
This is the flag if the trace is allowed to run or not.
Definition at line 42 of file netx_drv.c.
uint32_t volatile g_ulRunFlag |
references the running flag of the tracer.
This is the flag if the trace is allowed to run or not.
Definition at line 42 of file netx_drv.c.
size_t u_DRV_TRACE_KEY_STRINGS |
Definition at line 59 of file netx_drv.c.