RKH
Traces of miscellaneous framework

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...
 

Detailed Description

Macros for tracing the framework execution.

Macro Definition Documentation

◆ RKH_TR_FWK_EN

#define RKH_TR_FWK_EN ( )
Value:
RKH_TRC_BEGIN_WOAOSIG(RKH_TE_FWK_EN) \
RKH_TRC_END()
#define RKH_TE_FWK_EN
Initializes the RKH framework.

Initializes the RKH framework.

Description Initialize the RKH framework
Group RKH_TG_FWK
EventID RKH_TE_FWK_EN

Definition at line 1091 of file rkhtrc_record.h.

◆ RKH_TR_FWK_EX

#define RKH_TR_FWK_EX ( )
Value:
RKH_TRC_BEGIN_WOAOSIG(RKH_TE_FWK_EX) \
RKH_TRC_END()
#define RKH_TE_FWK_EX
Exit the RKH framework.

Exit the RKH framework.

Description Terminate the RKH framework
Group RKH_TG_FWK
EventID RKH_TE_FWK_EX

Definition at line 1103 of file rkhtrc_record.h.

◆ RKH_TR_FWK_EPREG

#define RKH_TR_FWK_EPREG (   evtPool_,
  storageSize_,
  evtSize_,
  poolSize_ 
)
Value:
RKH_TRC_BEGIN_WOAOSIG(RKH_TE_FWK_EPREG) \
RKH_TRC_UI8(evtPool_); \
RKH_TRC_UI32(storageSize_); \
RKH_TRC_ES(evtSize_); \
RKH_TRC_NBLK(poolSize_); \
RKH_TRC_END()
#define RKH_TE_FWK_EPREG
Registers a new event pool into the event pool list.

Registers a new event pool into the event pool list.

Description Register an event pool
Group RKH_TG_FWK
EventID RKH_TE_FWK_EPREG
Parameters
[in]evtPool_Event pool id
[in]storageSize_Storage size
[in]evtSize_Event size
[in]poolSize_Total number of blocks

Definition at line 1120 of file rkhtrc_record.h.

◆ RKH_TR_FWK_AE

#define RKH_TR_FWK_AE (   evtSize_,
  evt_,
  nUsed_,
  nMin_,
  sender_ 
)
Value:
RKH_TRC_BEGIN_WOAOSIG(RKH_TE_FWK_AE) \
RKH_TRC_ES(evtSize_); \
RKH_TRC_SIG((evt_)->e); \
RKH_TRC_UI8((evt_)->pool - 1); \
RKH_TRC_UI8((evt_)->nref); \
RKH_TRC_NBLK(nUsed_); \
RKH_TRC_MP_NMIN(nMin_); \
RKH_TRC_SYM(sender_); \
RKH_TRC_END()
#define RKH_TE_FWK_AE
Allocates an event from the previously created event pool.

Allocates an event from the previously created event pool.

Description Allocate an event from pool
Group RKH_TG_FWK
EventID RKH_TE_FWK_AE
Parameters
[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 1149 of file rkhtrc_record.h.

◆ RKH_TR_FWK_GC

#define RKH_TR_FWK_GC (   evt_,
  poolID_,
  refCnt_ 
)
Value:
RKH_TRC_SIG((evt_)->e); \
RKH_TRC_UI8(poolID_); \
RKH_TRC_UI8(refCnt_); \
RKH_TRC_END_NOCRIT()
#define RKH_TE_FWK_GC
Attempt to recycle an event.
#define RKH_TRC_BEGIN_WOAOSIG_NOCRIT(eid_)

Attempt to recycle an event.

Description Attempt to recycle an event
Group RKH_TG_FWK
EventID RKH_TE_FWK_GC
Parameters
[in]evt_Event
[in]poolID_Event pool id
[in]refCnt_Reference count

Definition at line 1172 of file rkhtrc_record.h.

◆ RKH_TR_FWK_GCR

#define RKH_TR_FWK_GCR (   evt_,
  nUsed_,
  nMin_,
  sender_ 
)
Value:
RKH_TRC_SIG((evt_)->e); \
RKH_TRC_UI8((evt_)->pool - 1); \
RKH_TRC_UI8((evt_)->nref); \
RKH_TRC_NBLK(nUsed_); \
RKH_TRC_MP_NMIN(nMin_); \
RKH_TRC_SYM(sender_); \
RKH_TRC_END_NOCRIT()
#define RKH_TE_FWK_GCR
Effective recycling event.

Effective recycling event.

Description Effective recycling of event
Group RKH_TG_FWK
EventID RKH_TE_FWK_GCR
Parameters
[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 1198 of file rkhtrc_record.h.

◆ RKH_TR_FWK_OBJ

#define RKH_TR_FWK_OBJ (   obj_)
Value:
do \
{ \
static RKHROM char __o_n[] = # obj_; \
rkh_trc_obj(RKH_TE_FWK_OBJ, (rui8_t *)obj_, \
__o_n); \
} \
while (0)
#define RKH_TE_FWK_OBJ
Entry symbol table for memory object.

Entry symbol table for memory object.

Description Entry symbol table for memory object
Group RKH_TG_FWK
EventID RKH_TE_FWK_OBJ
Parameters
[in]obj_Object address

e.g.
Associates the address of the object, in memory with its symbolic name.

...
static int g_status;
static RKH_TMR_T tdll;
RKH_TR_FWK_OBJ(&g_status);
#define RKH_TR_FWK_OBJ(obj_)
Entry symbol table for memory object.
Defines the data structure used to maintain information that allows the timer-handling facility to up...
Definition: rkhtmr.h:315

Definition at line 1233 of file rkhtrc_record.h.

◆ RKH_TR_FWK_OBJ_NAME

#define RKH_TR_FWK_OBJ_NAME (   obj_,
  name_ 
)
Value:
do \
{ \
rkh_trc_obj(RKH_TE_FWK_OBJ, (rui8_t *)obj_, name_); \
} \
while (0)

Entry symbol table for memory object. Very similar to RKH_TR_FWK_OBJ() but the name of object must be explicitely defined.

Description Entry symbol table for memory object
Group RKH_TG_FWK
EventID RKH_TE_FWK_OBJ
Parameters
[in]obj_Object address
[in]name_Name of object
Note
This macro uses the same trace event that RKH_TR_FWK_OBJ(). Use when the object name is very long and the Trazer's view is unclear.

e.g.
Associates the address of the object, in memory with a name.

...
RKH_TR_FWK_OBJ_NAME(&RKH_CAST(CLI_T, sma)->cli_utmr, "cliutmr");
#define RKH_CAST(_type, _obj)
Perform downcast of a reference of a base class to one of its derived classes.
Definition: rkhfwk_cast.h:107

Definition at line 1270 of file rkhtrc_record.h.

◆ RKH_TR_FWK_SIG

#define RKH_TR_FWK_SIG (   stateObj_)
Value:
do \
{ \
static RKHROM char __s_n[] = # stateObj_; \
rkh_trc_sig(stateObj_, __s_n); \
} \
while (0)

Entry symbol table for event signal.

Description Entry symbol table for signal
Group RKH_TG_FWK
EventID RKH_TE_FWK_SIG
Parameters
[in]stateObj_Signal

e.g.
Associates the numerical value of the event signal to the symbolic name of the signal.

// in the dedicated application header file resides the signal
// enumeration
enum
{
...
PWR_FAIL,
PRESS_ENTER,
...
};
// frequently, the macro RKH_TR_FWK_SIG() is used in the
// \b main.c file.
RKH_TR_FWK_SIG(PWR_FAIL);
RKH_TR_FWK_SIG(PRESS_ENTER);
#define RKH_TR_FWK_SIG(stateObj_)
Entry symbol table for event signal.

Definition at line 1312 of file rkhtrc_record.h.

◆ RKH_TR_FWK_FUN

#define RKH_TR_FWK_FUN (   function_)
Value:
do \
{ \
static RKHROM char __f_n[] = #function_; \
rkh_trc_obj(RKH_TE_FWK_FUN, (rui8_t *)function_, \
__f_n); \
} \
while (0)
#define RKH_TE_FWK_FUN
Entry symbol table for function object.

Entry symbol table for function object.

Description Entry symbol table for function
Group RKH_TG_FWK
EventID RKH_TE_FWK_FUN
Parameters
[in]function_Function address

e.g.
Associates the address of the function in memory with its symbolic name.

// frequently, the macro RKH_TR_FWK_FUN() is used in the
// \b main.c file.
RKH_TR_FWK_FUN(my_init);
RKH_TR_FWK_FUN(set_x_1);
RKH_TR_FWK_FUN(set_x_2);
RKH_TR_FWK_FUN(set_x_3);
RKH_TR_FWK_FUN(set_y_0);
RKH_TR_FWK_FUN(dummy_exit);
...
#define RKH_TR_FWK_FUN(function_)
Entry symbol table for function object.

Definition at line 1349 of file rkhtrc_record.h.

◆ RKH_TR_FWK_EXE_FUN

#define RKH_TR_FWK_EXE_FUN (   function_)
Value:
do \
{ \
RKH_TRC_BEGIN_WOFIL(RKH_TE_FWK_EXE_FUN) \
RKH_TRC_FUN(function_); \
RKH_TRC_END_WOFIL() \
} \
while (0)
#define RKH_TE_FWK_EXE_FUN
The function was executed.

The function was executed.

Description Executed function
Group RKH_TG_FWK
EventID RKH_TE_FWK_EXE_FUN
Parameters
[in]function_Function address

Example:

void
my_init(const void *sma)
{
CMY(sma)->x = CMY(sma)->y = 0;
}
#define RKH_TR_FWK_EXE_FUN(function_)
The function was executed.

Definition at line 1379 of file rkhtrc_record.h.

◆ RKH_TR_FWK_SYNC_EVT

#define RKH_TR_FWK_SYNC_EVT (   function_,
  senderObj_,
  receiverObj_ 
)
Value:
do \
{ \
RKH_TRC_BEGIN_WOFIL(RKH_TE_FWK_SYNC_EVT) \
RKH_TRC_FUN(function_); \
RKH_TRC_SNDR(senderObj_); \
RKH_TRC_SNDR(receiverObj_); \
RKH_TRC_END_WOFIL() \
} \
while (0)
#define RKH_TE_FWK_SYNC_EVT
The function was synchronously executed. It is not explicitely used by the RKH, instead it's frequent...

The function was synchronously executed. It is not explicitely used by the RKH, instead it's frequently placed on application source code.

Description Function was synchronously executed
Group RKH_TG_FWK
EventID RKH_TE_FWK_SYNC_EVT
Parameters
[in]function_Function address
[in]senderObj_Sender object
[in]receiverObj_Receiver object

Example:

void
Gas_setCommandedFlow(Gas *me, unsigned int p_commandedFlow)
{
(void)pe;
Valve_setAperture(me->itsValve, 0);
RKH_TR_FWK_SYNC_EVT(Valve_setAperture, &itsGas,
me->itsValve);
}
#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 frequent...

Definition at line 1415 of file rkhtrc_record.h.

◆ RKH_TR_FWK_TUSR

#define RKH_TR_FWK_TUSR (   __e)
Value:
do \
{ \
static RKHROM char __e_n[] = # __e; \
RKH_TRC_BEGIN_WOFIL(RKH_TE_FWK_TUSR) \
RKH_TRC_TE_ID(EXTE(__e, RKH_TG_USR)); \
RKH_TRC_STR(__e_n); \
RKH_TRC_END_WOFIL() \
RKH_TRC_FLUSH(); \
} \
while (0)
#define RKH_TE_FWK_TUSR
Entry symbol table for user-defined trace events.
#define RKH_TG_USR
User group (USR)

Entry symbol table for user-defined trace events.

Description Entry symbol table for user-defined trace events
Group RKH_TG_FWK
EventID RKH_TE_FWK_TUSR
Parameters
[in]__eUser trace event ID

e.g.
Associates the numerical value of the user-defined trace event to the symbolic name of that.

...
// frequently, the macro RKH_TR_FWK_TUSR() is used in the
// \b main.c file.
enum // define the user trace events
{
LOWPWR_USRT = RKH_TE_USER,
DISCONNECTED_USRT,
...
};
void
main(void)
{
RKH_TR_FWK_TUSR(LOWPWR_USRT);
RKH_TR_FWK_TUSR(DISCONNECTED_USRT);
...
}
#define RKH_TR_FWK_TUSR(__e)
Entry symbol table for user-defined trace events.

Definition at line 1463 of file rkhtrc_record.h.

◆ RKH_TR_FWK_TCFG

#define RKH_TR_FWK_TCFG (   timeStamp_)

Send trace configuration to Trazer.

Description Send trace configuration table to Trazer
Group RKH_TG_FWK
EventID RKH_TE_FWK_TCFG
Parameters
[in]timeStamp_Trace timestamp in Hz [ticks per second]
Note
The following table shows the format of RKH_TE_FWK_TCFG arguments. The first column means ["byte index", "bit index":"# of bits"] in the data stream.

[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 1527 of file rkhtrc_record.h.

◆ RKH_TR_FWK_ASSERT

#define RKH_TR_FWK_ASSERT (   mod_,
  ln_ 
)
Value:
RKH_TRC_STR((RKHROM char *)mod_); \
RKH_TRC_UI16((rui16_t)ln_); \
RKH_TRC_END_NOCRIT() \
RKH_TRC_FLUSH()
#define RKH_TE_FWK_ASSERT
Assertion expression was evaluated to false.

Assertion expression was evaluated to false.

Description Assertion expression was evaluated to false
Group RKH_TG_FWK
EventID RKH_TE_FWK_EXE_ASSERT
Parameters
[in]mod_Module name (*.c)
[in]ln_Line of code

Definition at line 1583 of file rkhtrc_record.h.

◆ RKH_TR_FWK_AO

#define RKH_TR_FWK_AO (   actObj_)
Value:
do \
{ \
rkh_trc_ao((struct RKH_SMA_T *)actObj_); \
} \
while (0)
Describes the SMA (active object in UML).
Definition: rkhsma.h:772

Entry symbol table for active object.

Description Entry symbol table for active object
Group RKH_TG_FWK
EventID RKH_TE_FWK_OBJ
Parameters
[in]actObj_Active object address

e.g.
Associates the address of the active object, in memory with its symbolic name.

...
typedef struct
{
RKH_SMA_T actObj_;
rui8_t x;
rui8_t y;
} AO_T;
RKH_SMA_CREATE(AO_T, actObj_, 0, HCAL, &S1, ao_init, NULL);
RKH_TR_FWK_OBJ(&actObj_);
@ HCAL
Definition: rkhsm.h:1611
#define RKH_SMA_CREATE(type, name, prio, ppty, initialState, initialAction, initialEvt)
Declare and allocate a SMA (active object) derived from RKH_SMA_T. Also, initializes and assigns a st...
Definition: rkhsma.h:348

Definition at line 1622 of file rkhtrc_record.h.

◆ RKH_TR_FWK_STATE

#define RKH_TR_FWK_STATE (   actObj_,
  stateObj_ 
)
Value:
do \
{ \
rkh_trc_state((struct RKH_SMA_T *)actObj_, \
(rui8_t *)stateObj_); \
} \
while (0)

Entry symbol table for state object.

Description Entry symbol table for state object
Group RKH_TG_FWK
EventID RKH_TE_FWK_OBJ
Parameters
[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.

...
RKH_CREATE_COMP_STATE(S1, en, ex, RKH_ROOT, &S11);
RKH_TRINT(SIX, NULL, show_data),
RKH_TRREG(TWO, NULL, set_y_2, &S2),
...
RKH_TR_FWK_STATE(my, &S1);
#define RKH_CREATE_TRANS_TABLE(name)
This macro creates a state transition table.
Definition: rkhsm.h:777
#define RKH_END_TRANS_TABLE
This macro is used to terminate a state transition table. This table have the general structure shown...
Definition: rkhsm.h:894
#define RKH_TRREG(evt_, guard_, effect_, target_)
This macro defines a regular state transition.
Definition: rkhsm.h:811
#define RKH_TRINT(e, g, a)
This macro defines an internal state transition. Internal transitions are simple reactions to events ...
Definition: rkhsm.h:835
#define RKH_ROOT
This macro indicates the root state of a state machine.
Definition: rkhsm.h:1019

Definition at line 1658 of file rkhtrc_record.h.

◆ RKH_TR_FWK_PSTATE

#define RKH_TR_FWK_PSTATE (   actObj_,
  pseudoStObj_ 
)
Value:
do \
{ \
rkh_trc_state((struct RKH_SMA_T *)actObj_, \
(rui8_t *)pseudoStObj_); \
} \
while (0)

Entry symbol table for pseudostate object.

Description Entry symbol table for pseudostate object
Group RKH_TG_FWK
EventID RKH_TE_FWK_OBJ
Parameters
[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.

...
RKH_CREATE_COND_STATE(C1, 12);
RKH_BRANCH(y_1, NULL, &H),
RKH_BRANCH(y_2, dummy_act, &DH),
RKH_BRANCH(y_0, NULL, &S1),
...
RKH_TR_FWK_PSTATE(my, &C1);
#define RKH_CREATE_BRANCH_TABLE(name)
Definition: rkhsm.h:920
#define RKH_END_BRANCH_TABLE
This macro is used to terminate a state transition table. This table have the general structure shown...
Definition: rkhsm.h:1013
#define RKH_BRANCH(guard_, effect_, target_)
This macro defines a branch in the branch table.
Definition: rkhsm.h:956

Definition at line 1696 of file rkhtrc_record.h.

◆ RKH_TR_FWK_TIMER

#define RKH_TR_FWK_TIMER (   timerObj_)
Value:
do \
{ \
static RKHROM char __to_n[] = # timerObj_; \
rkh_trc_obj(RKH_TE_FWK_TIMER, (rui8_t *)timerObj_, \
__to_n); \
} \
while (0)
#define RKH_TE_FWK_TIMER
Entry symbol table for timer object.

Entry symbol table for timer object.

Description Entry symbol table for timer object
Group RKH_TG_FWK
EventID RKH_TE_FWK_OBJ
Parameters
[in]timerObj_Timer object address

e.g.
Associates the address of the timer object, in memory with its symbolic name.

...
static RKH_TMR_T bky_tmr;
RKH_TR_FWK_TIMER(&bky_tmr);
#define RKH_TR_FWK_TIMER(timerObj_)
Entry symbol table for timer object.

Definition at line 1727 of file rkhtrc_record.h.

◆ RKH_TR_FWK_EPOOL

#define RKH_TR_FWK_EPOOL (   poolId_,
  poolName_ 
)
Value:
do \
{ \
RKH_TRC_BEGIN_WOFIL(RKH_TE_FWK_EPOOL) \
RKH_TRC_UI8(poolId_); \
RKH_TRC_STR(poolName_); \
RKH_TRC_END_WOFIL() \
RKH_TRC_FLUSH(); \
} \
while (0)
#define RKH_TE_FWK_EPOOL
Entry symbol table for event pool object.

Entry symbol table for event pool object.

Description Entry symbol table for event pool object
Group RKH_TG_FWK
EventID RKH_TE_FWK_OBJ
Parameters
[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.

...
rkh_fwk_registerEvtPool(ep0_sto, SIZEOF_EP0STO,
SIZEOF_EP0_BLOCK);
rkh_fwk_registerEvtPool(ep1_sto, SIZEOF_EP1STO,
SIZEOF_EP1_BLOCK);
rkh_fwk_registerEvtPool(ep2_sto, SIZEOF_EP2STO,
SIZEOF_EP2_BLOCK);
RKH_TR_FWK_EPOOL(0, "ep0");
RKH_TR_FWK_EPOOL(1, "ep1");
RKH_TR_FWK_EPOOL(2, "ep2");
...
void rkh_fwk_registerEvtPool(void *sstart, rui32_t ssize, RKH_ES_T esize)
Registers a new event pool into the event pool list.
#define RKH_TR_FWK_EPOOL(poolId_, poolName_)
Entry symbol table for event pool object.

Definition at line 1767 of file rkhtrc_record.h.

◆ RKH_TR_FWK_QUEUE

#define RKH_TR_FWK_QUEUE (   queueObj_)
Value:
do \
{ \
static RKHROM char __qo_n[] = #queueObj_; \
rkh_trc_obj(RKH_TE_FWK_QUEUE, (rui8_t *)queueObj_, \
__qo_n); \
} \
while (0)
#define RKH_TE_FWK_QUEUE
Entry symbol table for queue object.

Entry symbol table for queue object.

Description Entry symbol table for queue object
Group RKH_TG_FWK
EventID RKH_TE_FWK_OBJ
Parameters
[in]queueObj_Queue object address

e.g.
Associates the address of the queue object, in memory with its symbolic name.

...
#define QSTO_SIZE 4
static RKH_EVT_T *qsto[QSTO_SIZE];
...
RKH_TR_FWK_QUEUE(&blinky->equeue);
rkh_sma_activate(blinky, (const RKH_EVT_T **)qsto,
QSTO_SIZE, CV(0), 0);
...
void rkh_sma_activate(RKH_SMA_T *me, const RKH_EVT_T **qSto, RKH_QUENE_T qSize, void *stkSto, rui32_t stkSize)
Initializes and activates a previously created state machine application (SMA) as known as active obj...
Represents events without parameters.
Definition: rkhevt.h:170

Definition at line 1806 of file rkhtrc_record.h.

◆ RKH_TR_FWK_ACTOR

#define RKH_TR_FWK_ACTOR (   actorObj_,
  nm_ 
)
Value:
do \
{ \
rkh_trc_obj(RKH_TE_FWK_ACTOR, (rui8_t *)actorObj_, nm_); \
} \
while (0)
#define RKH_TE_FWK_ACTOR
Entry symbol table for actor object.

Entry symbol table for actor object.

Description Entry symbol table for actor object
Group RKH_TG_FWK
EventID RKH_TE_FWK_ACTOR
Parameters
[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.

...
static int buttonManager;
RKH_TR_FWK_ACTOR(&buttonManager, "buttonManager");
#define RKH_TR_FWK_ACTOR(actorObj_, nm_)
Entry symbol table for actor object.
#define RKH_GET_AO_NAME(ao)
This macro retrieves the name of an registered active object.
Definition: rkhsma.h:691

Definition at line 1840 of file rkhtrc_record.h.