Defines constants and macros which are internally used by RKH trace facility. More...

#include "rkhitl.h"

Include dependency graph for rkhtrc_define.h:

Macros
#define	RKH_CFG_TRC_SIZEOF_TE_ID 8
	Specify the size of the trace event identification. The valid values [in bits] are 8, 16 or 32. Default is 8.

#define	RKH_TRC_AO_ISOFF(prio)
	Test the state machine application (SMA) filter condition.

#define	RKH_TRC_SIG_ISOFF(sig)
	Test the event signal filter condition.

#define	RKH_TRC_MAX_EVENTS (RKH_MAX_NUM_TE_PER_GROUP * RKH_TRC_MAX_GROUPS)

#define	RKH_TRC_MAX_SMA (RKH_CFG_FWK_MAX_SMA / 8)
	The size of trcsmaftbl[] (trace SMA filter table) depends on RKH_CFG_FWK_MAX_SMA (see rkhcfg.h).

#define	RKH_TRC_MAX_SIGNALS (RKH_CFG_FWK_MAX_SIGNALS / 8)
	The size of trcsigftbl[] (trace signal filter table) depends on RKH_CFG_FWK_MAX_SIGNALS and RKH_CFG_FWK_SIZEOF_EVT (see rkhcfg.h).

#define	RKH_TOT_NUM_TRC_EVTS

#define	RKH_TRC_MAX_EVENTS_IN_BYTES RKH_TOT_NUM_TRC_EVTS
	Defines the size of trace filter table according to RKH_TOT_NUM_TRC_EVTS and RKH_TRC_MAX_EVENTS.

#define	RKH_TRC_ALL_GROUPS RKH_TG_NGROUP
	Emit or suppress tracing for all groups and events.

#define	RKH_TRC_ALL_EVENTS RKH_TE_NEVENT
	Emit or suppress all trace events.

#define	RKH_TRC_SET_ALL(mode_) ((mode_) \| RKH_TRC_ALL_FILTERS)
	Emit or supress tracing for all signal/active objects.

#define	RKH_XOR 0x20

#define	RKH_FLG 0x7E

#define	RKH_ESC 0x7D

#define	RKH_TG_MP 0
	Memory Pool group (MP)

#define	RKH_TG_QUE 1
	Reference Queue group (QUE)

#define	RKH_TG_SMA 2
	State Machine Application group (SMA)

#define	RKH_TG_SM 3
	State Machine group (SM)

#define	RKH_TG_TMR 4
	Timer group (TIM)

#define	RKH_TG_FWK 5
	Framework RKH group (FWK)

#define	RKH_TG_USR 6
	User group (USR)

#define	RKH_TG_UT 7
	Unit test harness group (UT)

#define	RKH_TG_NGROUP 8
	Number of trace groups.

#define	RKH_TE_MP_INIT RKH_MP_START

#define	RKH_TE_MP_GET (RKH_TE_MP_INIT + 1)

#define	RKH_TE_MP_PUT (RKH_TE_MP_GET + 1)

#define	RKH_TE_QUE_INIT RKH_QUE_START

#define	RKH_TE_QUE_GET (RKH_TE_QUE_INIT + 1)

#define	RKH_TE_QUE_FIFO (RKH_TE_QUE_GET + 1)

#define	RKH_TE_QUE_LIFO (RKH_TE_QUE_FIFO + 1)

#define	RKH_TE_QUE_FULL (RKH_TE_QUE_LIFO + 1)

#define	RKH_TE_QUE_DPT (RKH_TE_QUE_FULL + 1)

#define	RKH_TE_QUE_GET_LAST (RKH_TE_QUE_DPT +1 )

#define	RKH_TE_SMA_ACT RKH_SMA_START

#define	RKH_TE_SMA_TERM (RKH_TE_SMA_ACT + 1)

#define	RKH_TE_SMA_GET (RKH_TE_SMA_TERM + 1)

#define	RKH_TE_SMA_FIFO (RKH_TE_SMA_GET + 1)

#define	RKH_TE_SMA_LIFO (RKH_TE_SMA_FIFO + 1)

#define	RKH_TE_SMA_REG (RKH_TE_SMA_LIFO + 1)

#define	RKH_TE_SMA_UNREG (RKH_TE_SMA_REG + 1)

#define	RKH_TE_SMA_DEFER (RKH_TE_SMA_UNREG + 1)

#define	RKH_TE_SMA_RCALL (RKH_TE_SMA_DEFER + 1)

#define	RKH_TE_SM_INIT RKH_SM_START

#define	RKH_TE_SM_CLRH (RKH_TE_SM_INIT + 1)

#define	RKH_TE_SM_TRN (RKH_TE_SM_CLRH + 1)

#define	RKH_TE_SM_STATE (RKH_TE_SM_TRN + 1)

#define	RKH_TE_SM_ENSTATE (RKH_TE_SM_STATE + 1)

#define	RKH_TE_SM_EXSTATE (RKH_TE_SM_ENSTATE + 1)

#define	RKH_TE_SM_NENEX (RKH_TE_SM_EXSTATE + 1)

#define	RKH_TE_SM_NTRNACT (RKH_TE_SM_NENEX + 1)

#define	RKH_TE_SM_TS_STATE (RKH_TE_SM_NTRNACT + 1)

#define	RKH_TE_SM_EVT_PROC (RKH_TE_SM_TS_STATE + 1)

#define	RKH_TE_SM_EVT_NFOUND (RKH_TE_SM_EVT_PROC + 1)

#define	RKH_TE_SM_GRD_FALSE (RKH_TE_SM_EVT_NFOUND + 1)

#define	RKH_TE_SM_CND_NFOUND (RKH_TE_SM_GRD_FALSE + 1)

#define	RKH_TE_SM_UNKN_STATE (RKH_TE_SM_CND_NFOUND + 1)

#define	RKH_TE_SM_EX_HLEVEL (RKH_TE_SM_UNKN_STATE + 1)

#define	RKH_TE_SM_EX_TSEG (RKH_TE_SM_EX_HLEVEL + 1)

#define	RKH_TE_SM_EXE_ACT (RKH_TE_SM_EX_TSEG + 1)

#define	RKH_TE_SM_DCH (RKH_TE_SM_EXE_ACT + 1)

#define	RKH_TE_TMR_INIT RKH_TMR_START

#define	RKH_TE_TMR_START (RKH_TE_TMR_INIT + 1)

#define	RKH_TE_TMR_STOP (RKH_TE_TMR_START + 1)

#define	RKH_TE_TMR_TOUT (RKH_TE_TMR_STOP + 1)

#define	RKH_TE_TMR_REM (RKH_TE_TMR_TOUT + 1)

#define	RKH_TE_FWK_EN RKH_FWK_START

#define	RKH_TE_FWK_EX (RKH_TE_FWK_EN + 1)

#define	RKH_TE_FWK_EPREG (RKH_TE_FWK_EX + 1)

#define	RKH_TE_FWK_AE (RKH_TE_FWK_EPREG + 1)

#define	RKH_TE_FWK_GC (RKH_TE_FWK_AE + 1)

#define	RKH_TE_FWK_GCR (RKH_TE_FWK_GC + 1)

#define	RKH_TE_FWK_OBJ (RKH_TE_FWK_GCR + 1)

#define	RKH_TE_FWK_SIG (RKH_TE_FWK_OBJ + 1)

#define	RKH_TE_FWK_FUN (RKH_TE_FWK_SIG + 1)

#define	RKH_TE_FWK_EXE_FUN (RKH_TE_FWK_FUN + 1)

#define	RKH_TE_FWK_SYNC_EVT (RKH_TE_FWK_EXE_FUN + 1)

#define	RKH_TE_FWK_TUSR (RKH_TE_FWK_SYNC_EVT + 1)

#define	RKH_TE_FWK_TCFG (RKH_TE_FWK_TUSR + 1)

#define	RKH_TE_FWK_ASSERT (RKH_TE_FWK_TCFG + 1)

#define	RKH_TE_FWK_AO (RKH_TE_FWK_ASSERT + 1)

#define	RKH_TE_FWK_STATE (RKH_TE_FWK_AO + 1)

#define	RKH_TE_FWK_PSTATE (RKH_TE_FWK_STATE + 1)

#define	RKH_TE_FWK_TIMER (RKH_TE_FWK_PSTATE + 1)

#define	RKH_TE_FWK_EPOOL (RKH_TE_FWK_TIMER + 1)

#define	RKH_TE_FWK_QUEUE (RKH_TE_FWK_EPOOL + 1)

#define	RKH_TE_FWK_ACTOR (RKH_TE_FWK_QUEUE + 1)

#define	RKH_TRC_BEGIN_WOFIL(eid_)

#define	RKH_TRC_END_WOFIL()

#define	RKH_TRC_BEGIN_WOFIL_NOCRIT(eid_) rkh_trc_begin(eid_);

#define	RKH_TRC_END_WOFIL_NOCRIT() rkh_trc_end(); \

#define	RKH_TRC_BEGIN_DFT(eid_)

#define	RKH_TRC_END_DFT()

#define	RKH_TRC_U8_RAW(d) rkh_trc_put((d))
	Insert a 1-byte without escaping it.

#define	RKH_TRC_UI8(d) rkh_trc_u8((rui8_t)(d))
	Insert a 1-byte data.

#define	RKH_TRC_UI16(d) rkh_trc_u16((d))
	Insert a 2-byte data.

#define	RKH_TRC_UI32(d) rkh_trc_u32((d))
	Insert a 4-byte data.

#define	RKH_TRC_STR(s) rkh_trc_str((s))
	Insert a string.

#define	RKH_TRC_SYM(sym) RKH_TRC_UI32((rui32_t)sym)
	Insert a object address as trace record argument.

#define	RKH_TRC_SNDR(sym) RKH_TRC_SYM(sym)
	Insert a sender object address as trace record argument.

#define	RKH_TRC_FUN(sym) RKH_TRC_UI32((rui32_t)sym)
	Insert a function address as trace record argument.

#define	RKH_TRC_NTICK(nt) RKH_TRC_UI8(nt)

#define	RKH_TRC_NBLK(nb) RKH_TRC_UI8(nb)

#define	RKH_TRC_BSIZE(bs) RKH_TRC_UI8(bs)

#define	RKH_TRC_NE(ne) RKH_TRC_UI8(ne)

#define	RKH_TRC_SIG(e) RKH_TRC_UI8(e)

#define	RKH_TRC_ES(es) RKH_TRC_UI8(es)

Typedefs
typedef rui8_t	RKH_TE_ID_T
	Describes a trace event identification (ID).

typedef rui16_t	RKH_TS_T
	Defines the size of trace timestamp.

typedef rui8_t	RKH_TG_T
	Group of events.

Enumerations
enum	RKH_TRC_FMT { RKH_I8_T , RKH_UI8_T , RKH_I16_T , RKH_UI16_T , RKH_I32_T , RKH_UI32_T , RKH_X32_T , RKH_STR_T , RKH_MEM_T , RKH_OBJ_T , RKH_FUN_T , RKH_ESIG_T }
	Enumerates data formats recognized by Trazer. More...

enum	RKH_SUBTE_SM_EXE_ACT { RKH_SUBTE_SM_EXE_ACT_EFF , RKH_SUBTE_SM_EXE_ACT_EN , RKH_SUBTE_SM_EXE_ACT_EX , RKH_SUBTE_SM_EXE_ACT_INI , RKH_SUBTE_SM_EXE_ACT_PP , RKH_SUBTE_SM_EXE_ACT_GRD }
	Sub-event of RKH_TE_SM_EXE_ACT event. More...

Detailed Description

Defines constants and macros which are internally used by RKH trace facility.

Definition in file rkhtrc_define.h.

Macro Definition Documentation

◆ RKH_CFG_TRC_SIZEOF_TE_ID

#define RKH_CFG_TRC_SIZEOF_TE_ID 8

Specify the size of the trace event identification. The valid values [in bits] are 8, 16 or 32. Default is 8.

See also: RKH_TE_ID_T data type.

Note: In the future releases, it should be defined in the configuration file of the RKH framework.

Definition at line 75 of file rkhtrc_define.h.

◆ RKH_TRC_AO_ISOFF

#define RKH_TRC_AO_ISOFF ( prio )

Test the state machine application (SMA) filter condition.

Parameters

[in] prio SMA priority.

Returns: '1' (RKH_TRUE) if the SMA is not filtered, otherwise '0' (RKH_FALSE).

Note: This macro is internal to RKH and the user application should not call it.

Definition at line 108 of file rkhtrc_define.h.

◆ RKH_TRC_SIG_ISOFF

#define RKH_TRC_SIG_ISOFF ( sig )

Test the event signal filter condition.

Parameters

[in] sig event signal.

Returns: '1' (RKH_TRUE) if the signal is not filtered, otherwise '0' (RKH_FALSE).

Note: This macro is internal to RKH and the user application should not call it.

Definition at line 134 of file rkhtrc_define.h.

◆ RKH_TRC_MAX_EVENTS

#define RKH_TRC_MAX_EVENTS (RKH_MAX_NUM_TE_PER_GROUP * RKH_TRC_MAX_GROUPS)

Specify the maximum number of trace events, this number is direclty related with the RKH_TE_<group>_<event> definitions. The smaller this number, the lower the RAM consumption. See trceftbl table.

Definition at line 165 of file rkhtrc_define.h.