RKH
|
Macros for tracing the framework execution. More...
Macros | |
#define | RKH_TR_FWK_EN() |
Initializes the RKH framework. More... | |
#define | RKH_TR_FWK_EX() |
Exit the RKH framework. More... | |
#define | RKH_TR_FWK_EPREG(evtPool_, storageSize_, evtSize_, poolSize_) |
Registers a new event pool into the event pool list. More... | |
#define | RKH_TR_FWK_AE(evtSize_, evt_, nUsed_, nMin_, sender_) |
Allocates an event from the previously created event pool. More... | |
#define | RKH_TR_FWK_GC(evt_, poolID_, refCnt_) |
Attempt to recycle an event. More... | |
#define | RKH_TR_FWK_GCR(evt_, nUsed_, nMin_, sender_) |
Effective recycling event. More... | |
#define | RKH_TR_FWK_OBJ(obj_) |
Entry symbol table for memory object. More... | |
#define | RKH_TR_FWK_OBJ_NAME(obj_, name_) |
Entry symbol table for memory object. Very similar to RKH_TR_FWK_OBJ() but the name of object must be explicitely defined. More... | |
#define | RKH_TR_FWK_SIG(stateObj_) |
Entry symbol table for event signal. More... | |
#define | RKH_TR_FWK_FUN(function_) |
Entry symbol table for function object. More... | |
#define | RKH_TR_FWK_EXE_FUN(function_) |
The function was executed. More... | |
#define | RKH_TR_FWK_SYNC_EVT(function_, senderObj_, receiverObj_) |
The function was synchronously executed. It is not explicitely used by the RKH, instead it's frequently placed on application source code. More... | |
#define | RKH_TR_FWK_TUSR(__e) |
Entry symbol table for user-defined trace events. More... | |
#define | RKH_TR_FWK_TCFG(timeStamp_) |
Send trace configuration to Trazer. More... | |
#define | RKH_TR_FWK_ASSERT(mod_, ln_) |
Assertion expression was evaluated to false. More... | |
#define | RKH_TR_FWK_AO(actObj_) |
Entry symbol table for active object. More... | |
#define | RKH_TR_FWK_STATE(actObj_, stateObj_) |
Entry symbol table for state object. More... | |
#define | RKH_TR_FWK_PSTATE(actObj_, pseudoStObj_) |
Entry symbol table for pseudostate object. More... | |
#define | RKH_TR_FWK_TIMER(timerObj_) |
Entry symbol table for timer object. More... | |
#define | RKH_TR_FWK_EPOOL(poolId_, poolName_) |
Entry symbol table for event pool object. More... | |
#define | RKH_TR_FWK_QUEUE(queueObj_) |
Entry symbol table for queue object. More... | |
#define | RKH_TR_FWK_ACTOR(actorObj_, nm_) |
Entry symbol table for actor object. More... | |
Macros for tracing the framework execution.
#define RKH_TR_FWK_EN | ( | ) |
Initializes the RKH framework.
Definition at line 1088 of file rkhtrc_record.h.
#define RKH_TR_FWK_EX | ( | ) |
Exit the RKH framework.
Definition at line 1100 of file rkhtrc_record.h.
#define RKH_TR_FWK_EPREG | ( | evtPool_, | |
storageSize_, | |||
evtSize_, | |||
poolSize_ | |||
) |
Registers a new event pool into the event pool list.
[in] | evtPool_ | Event pool id |
[in] | storageSize_ | Storage size |
[in] | evtSize_ | Event size |
[in] | poolSize_ | Total number of blocks |
Definition at line 1117 of file rkhtrc_record.h.
#define RKH_TR_FWK_AE | ( | evtSize_, | |
evt_, | |||
nUsed_, | |||
nMin_, | |||
sender_ | |||
) |
Allocates an event from the previously created event pool.
[in] | evtSize_ | Event size |
[in] | evt_ | Pointer to event object |
[in] | nUsed_ | Current number of memory blocks used |
[in] | nMin_ | Lowest number of free blocks ever present |
[in] | sender_ | Pointer to the actor that request a memory block. It is not necessarily a pointer to an active object. In fact, if RKH_ALLOC_EVT() is called from an interrupt or other context, it can create a unique object just to unambiguously identify the publisher of the event. |
Definition at line 1146 of file rkhtrc_record.h.
#define RKH_TR_FWK_GC | ( | evt_, | |
poolID_, | |||
refCnt_ | |||
) |
Attempt to recycle an event.
[in] | evt_ | Event |
[in] | poolID_ | Event pool id |
[in] | refCnt_ | Reference count |
Definition at line 1169 of file rkhtrc_record.h.
#define RKH_TR_FWK_GCR | ( | evt_, | |
nUsed_, | |||
nMin_, | |||
sender_ | |||
) |
Effective recycling event.
[in] | evt_ | Pointer to event object |
[in] | nUsed_ | Current number of memory blocks used |
[in] | nMin_ | Lowest number of free blocks ever present |
[in] | sender_ | Pointer to the actor that request a memory block. It is not necessarily a pointer to an active object. In fact, if RKH_ALLOC_EVT() is called from an interrupt or other context, it can create a unique object just to unambiguously identify the publisher of the event. |
Definition at line 1195 of file rkhtrc_record.h.
#define RKH_TR_FWK_OBJ | ( | obj_ | ) |
Entry symbol table for memory object.
[in] | obj_ | Object address |
e.g.
Associates the address of the object, in memory with its symbolic name.
Definition at line 1230 of file rkhtrc_record.h.
#define RKH_TR_FWK_OBJ_NAME | ( | obj_, | |
name_ | |||
) |
Entry symbol table for memory object. Very similar to RKH_TR_FWK_OBJ() but the name of object must be explicitely defined.
[in] | obj_ | Object address |
[in] | name_ | Name of object |
e.g.
Associates the address of the object, in memory with a name.
Definition at line 1267 of file rkhtrc_record.h.
#define RKH_TR_FWK_SIG | ( | stateObj_ | ) |
Entry symbol table for event signal.
[in] | stateObj_ | Signal |
e.g.
Associates the numerical value of the event signal to the symbolic name of the signal.
Definition at line 1309 of file rkhtrc_record.h.
#define RKH_TR_FWK_FUN | ( | function_ | ) |
Entry symbol table for function object.
[in] | function_ | Function address |
e.g.
Associates the address of the function in memory with its symbolic name.
Definition at line 1346 of file rkhtrc_record.h.
#define RKH_TR_FWK_EXE_FUN | ( | function_ | ) |
The function was executed.
[in] | function_ | Function address |
Example:
Definition at line 1376 of file rkhtrc_record.h.
#define RKH_TR_FWK_SYNC_EVT | ( | function_, | |
senderObj_, | |||
receiverObj_ | |||
) |
The function was synchronously executed. It is not explicitely used by the RKH, instead it's frequently placed on application source code.
[in] | function_ | Function address |
[in] | senderObj_ | Sender object |
[in] | receiverObj_ | Receiver object |
Example:
Definition at line 1408 of file rkhtrc_record.h.
#define RKH_TR_FWK_TUSR | ( | __e | ) |
Entry symbol table for user-defined trace events.
[in] | __e | User trace event ID |
e.g.
Associates the numerical value of the user-defined trace event to the symbolic name of that.
Definition at line 1452 of file rkhtrc_record.h.
#define RKH_TR_FWK_TCFG | ( | timeStamp_ | ) |
Send trace configuration to Trazer.
[in] | timeStamp_ | Trace timestamp in Hz [ticks per second] |
[byte_index:size in bits]
[ 0, 0:16] - RKH_VERSION_CODE
[ 2, 0: 1] - RKH_CFG_SMA_TRC_SNDR_EN
[ 2, 1: 1] - RKH_CFG_TRC_RTFIL_EN
[ 2, 2: 1] - RKH_CFG_TRC_USER_TRACE_EN
[ 2, 3: 1] - RKH_CFG_TRC_ALL_EN
[ 2, 4: 1] - RKH_CFG_TRC_MP_EN
[ 2, 5: 1] - RKH_CFG_TRC_QUE_EN
[ 2, 6: 1] - RKH_CFG_TRC_SMA_EN
[ 2, 7: 1] - RKH_CFG_TRC_TMR_EN
[ 3, 8: 1] - RKH_CFG_TRC_SM_EN
[ 3, 9: 1] - RKH_CFG_TRC_FWK_EN
[ 3,10: 1] - RKH_CFG_TRC_ASSERT_EN
[ 3,11: 1] - RKH_CFG_QUE_GET_LWMARK_EN
[ 3,12: 1] - RKH_CFG_MP_GET_LWM_EN
[ 3,13: 1] - RKH_CFG_TRC_RTFIL_SMA_EN
[ 3,14: 1] - RKH_CFG_TRC_RTFIL_SIGNAL_EN
[ 3,15: 1] - RKH_CFG_TRC_NSEQ_EN
[ 4,16: 1] - RKH_CFG_TRC_TSTAMP_EN
[ 4,17: 1] - RKH_CFG_TRC_CHK_EN
[ 4,18:14] - 0 (Reserved)
[ 6, 0: 4] - RKH_CFG_FWK_SIZEOF_EVT
[ 6, 4: 4] - RKH_CFGPORT_TRC_SIZEOF_TSTAMP
[ 7, 0: 4] - RKH_CFGPORT_TRC_SIZEOF_PTR
[ 7, 4: 4] - RKH_CFG_TMR_SIZEOF_NTIMER
[ 8, 0: 4] - RKH_CFG_MP_SIZEOF_NBLOCK
[ 8, 4: 4] - RKH_CFG_QUE_SIZEOF_NELEM
[ 9, 0: 4] - RKH_CFG_FWK_SIZEOF_EVT_SIZE
[ 9, 4: 4] - 0 (Reserved)
[10, 0: 4] - RKH_CFG_MP_SIZEOF_BSIZE
[10, 4: 4] - RKH_CFG_FWK_MAX_EVT_POOL
[11, 0:16] - Timestamp HZ (ticks per second)
Definition at line 1516 of file rkhtrc_record.h.
#define RKH_TR_FWK_ASSERT | ( | mod_, | |
ln_ | |||
) |
Assertion expression was evaluated to false.
[in] | mod_ | Module name (*.c) |
[in] | ln_ | Line of code |
Definition at line 1572 of file rkhtrc_record.h.
#define RKH_TR_FWK_AO | ( | actObj_ | ) |
Entry symbol table for active object.
[in] | actObj_ | Active object address |
e.g.
Associates the address of the active object, in memory with its symbolic name.
Definition at line 1611 of file rkhtrc_record.h.
#define RKH_TR_FWK_STATE | ( | actObj_, | |
stateObj_ | |||
) |
Entry symbol table for state object.
[in] | actObj_ | Active object address |
[in] | stateObj_ | State object address |
e.g.
Associates the address of the state object, in memory with its symbolic name.
Definition at line 1647 of file rkhtrc_record.h.
#define RKH_TR_FWK_PSTATE | ( | actObj_, | |
pseudoStObj_ | |||
) |
Entry symbol table for pseudostate object.
[in] | actObj_ | Active object address |
[in] | pseudoStObj_ | Pseudostate object address |
e.g.
Associates the address of the pseudostate object, in memory with its symbolic name.
Definition at line 1685 of file rkhtrc_record.h.
#define RKH_TR_FWK_TIMER | ( | timerObj_ | ) |
Entry symbol table for timer object.
[in] | timerObj_ | Timer object address |
e.g.
Associates the address of the timer object, in memory with its symbolic name.
Definition at line 1716 of file rkhtrc_record.h.
#define RKH_TR_FWK_EPOOL | ( | poolId_, | |
poolName_ | |||
) |
Entry symbol table for event pool object.
[in] | poolId_ | Event pool ID (index of event pool list) |
[in] | poolName_ | String terminated in '\0'. |
e.g.
Associates the ID of the event pool, with a symbolic name.
Definition at line 1756 of file rkhtrc_record.h.
#define RKH_TR_FWK_QUEUE | ( | queueObj_ | ) |
Entry symbol table for queue object.
[in] | queueObj_ | Queue object address |
e.g.
Associates the address of the queue object, in memory with its symbolic name.
Definition at line 1791 of file rkhtrc_record.h.
#define RKH_TR_FWK_ACTOR | ( | actorObj_, | |
nm_ | |||
) |
Entry symbol table for actor object.
[in] | actorObj_ | Actor object address. Generally, it's used for active object and ISR, i.e. event producers. |
[in] | nm_ | String terminated in '\0' |
e.g.
Associates the address of an actor object, in memory with its symbolic name.
Definition at line 1825 of file rkhtrc_record.h.