RKH
Related to trace facility

Configuration options related to trace facility (TRC) More...

Macros

#define RKH_CFG_TRC_EN   RKH_ENABLED
 If the RKH_CFG_TRC_EN is set to 1 then RKH will include the trace facility. More...
 
#define RKH_CFG_TRC_RTFIL_EN   RKH_ENABLED
 If the RKH_CFG_TRC_RTFIL_EN is set to 1 then RKH will include the runtime trace filter facility. When RKH_CFG_TRC_RTFIL_EN is enabled RKH also will automatically define RKH_FILTER_ON_GROUP(), RKH_FILTER_OFF_GROUP(), RKH_FILTER_ON_EVENT(), RKH_FILTER_OFF_EVENT(), RKH_FILTER_ON_GROUP_ALL_EVENTS(), RKH_FILTER_OFF_GROUP_ALL_EVENTS(), RKH_FILTER_ON_SMA(), and RKH_FILTER_OFF_SMA() macros. More...
 
#define RKH_CFG_TRC_RTFIL_SMA_EN   RKH_ENABLED
 If the RKH_CFG_TRC_RTFIL_EN and RKH_CFG_TRC_RTFIL_SMA_EN are set to 1, the RKH allows the usage of runtime trace filter for state machine applications (active objects). More...
 
#define RKH_CFG_TRC_RTFIL_SIGNAL_EN   RKH_ENABLED
 If the RKH_CFG_TRC_RTFIL_EN and RKH_CFG_TRC_RTFIL_SIGNAL_EN are set to 1, the RKH allows the usage of runtime trace filter for signals (events). More...
 
#define RKH_CFG_TRC_USER_TRACE_EN   RKH_ENABLED
 If the RKH_CFG_TRC_USER_TRACE_EN is set to 1 then RKH will allow to build and generate tracing information from the application-level code. This trace records are application-specific. More...
 
#define RKH_CFG_TRC_ALL_EN   RKH_ENABLED
 If the RKH_CFG_TRC_ALL_EN is set to 1 then RKH will include all its own trace records. More...
 
#define RKH_CFG_TRC_MP_EN   RKH_ENABLED
 If the RKH_CFG_TRC_MP_EN is set to 1 then RKH will include all trace records related to the native fixed-size memory blocks. More...
 
#define RKH_CFG_TRC_QUE_EN   RKH_ENABLED
 If the RKH_CFG_TRC_QUE_EN is set to 1 then RKH will include all trace records related to the native queues. More...
 
#define RKH_CFG_TRC_SMA_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SMA_EN is set to 1 then RKH will include all trace records related to the state machine applications. More...
 
#define RKH_CFG_TRC_TMR_EN   RKH_ENABLED
 If the RKH_CFG_TRC_TMR_EN is set to 1 then RKH will include all trace records related to the native software timer. More...
 
#define RKH_CFG_TRC_SM_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SM_EN is set to 1 then RKH will include all trace records related to the state machine (hierarchical and "flat"). More...
 
#define RKH_CFG_TRC_FWK_EN   RKH_ENABLED
 If the RKH_CFG_TRC_FWK_EN is set to 1 then RKH will include all trace records related to the nativenative event framework. More...
 
#define RKH_CFG_TRC_ASSERT_EN   RKH_ENABLED
 If the RKH_CFG_TRC_ASSERT_EN and RKH_CFG_TRC_FWK_EN are set to 1 then RKH will include the "assertion" trace record. More...
 
#define RKH_CFG_TRC_SM_INIT_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SM_INIT_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "init state machine" trace record. More...
 
#define RKH_CFG_TRC_SM_DCH_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SM_DCH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "start a state machine" trace record. More...
 
#define RKH_CFG_TRC_SM_CLRH_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "dispatch an event to state machine" trace record. More...
 
#define RKH_CFG_TRC_SM_TRN_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "clear the history pseudostate" trace record. More...
 
#define RKH_CFG_TRC_SM_STATE_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SM_STATE_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "final state of transition" trace record. More...
 
#define RKH_CFG_TRC_SM_ENSTATE_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "entry state" trace record. More...
 
#define RKH_CFG_TRC_SM_EXSTATE_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "exit state" trace record. More...
 
#define RKH_CFG_TRC_SM_NENEX_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "number of entry and exit states in transition" trace record. More...
 
#define RKH_CFG_TRC_SM_NTRNACT_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "number of executed actions in transition" trace record. More...
 
#define RKH_CFG_TRC_SM_TS_STATE_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "state or pseudostate in a compound transition" trace record. More...
 
#define RKH_CFG_TRC_SM_PROCESS_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "returned code from dispatch function" trace record. More...
 
#define RKH_CFG_TRC_SM_EXE_ACT_EN   RKH_ENABLED
 If the RKH_CFG_TRC_SM_EXE_ACT_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "executed behavior of state machine" trace record. More...
 
#define RKH_CFG_TRC_NSEQ_EN   RKH_ENABLED
 If the RKH_CFG_TRC_NSEQ_EN is set to 1 then RKH will add to the trace record an incremental number (1-byte), used like a sequence number. See RKH_TRC_NSEQ() and RKH_TRC_HDR() macros. More...
 
#define RKH_CFG_TRC_CHK_EN   RKH_ENABLED
 If the RKH_CFG_TRC_CHK_EN is set to 1 then RKH will add to the trace record a checksum (1-byte). See RKH_TRC_CHK() macro. More...
 
#define RKH_CFG_TRC_TSTAMP_EN   RKH_ENABLED
 If the RKH_CFG_TRC_TSTAMP_EN is set to 1 then RKH will add to the trace record a timestamp field. It's configurable by means of RKH_CFGPORT_TRC_SIZEOF_TSTAMP. More...
 
#define RKH_CFG_TRC_SIZEOF_STREAM   128u
 Specify the maximum number of trace events in the stream. The smaller this number, the lower the RAM consumption. More...
 

Detailed Description

Configuration options related to trace facility (TRC)

Macro Definition Documentation

◆ RKH_CFG_TRC_EN

#define RKH_CFG_TRC_EN   RKH_ENABLED

If the RKH_CFG_TRC_EN is set to 1 then RKH will include the trace facility.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 693 of file rkhcfg.h.

◆ RKH_CFG_TRC_RTFIL_EN

#define RKH_CFG_TRC_RTFIL_EN   RKH_ENABLED

If the RKH_CFG_TRC_RTFIL_EN is set to 1 then RKH will include the runtime trace filter facility. When RKH_CFG_TRC_RTFIL_EN is enabled RKH also will automatically define RKH_FILTER_ON_GROUP(), RKH_FILTER_OFF_GROUP(), RKH_FILTER_ON_EVENT(), RKH_FILTER_OFF_EVENT(), RKH_FILTER_ON_GROUP_ALL_EVENTS(), RKH_FILTER_OFF_GROUP_ALL_EVENTS(), RKH_FILTER_ON_SMA(), and RKH_FILTER_OFF_SMA() macros.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 709 of file rkhcfg.h.

◆ RKH_CFG_TRC_RTFIL_SMA_EN

#define RKH_CFG_TRC_RTFIL_SMA_EN   RKH_ENABLED

If the RKH_CFG_TRC_RTFIL_EN and RKH_CFG_TRC_RTFIL_SMA_EN are set to 1, the RKH allows the usage of runtime trace filter for state machine applications (active objects).

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 721 of file rkhcfg.h.

◆ RKH_CFG_TRC_RTFIL_SIGNAL_EN

#define RKH_CFG_TRC_RTFIL_SIGNAL_EN   RKH_ENABLED

If the RKH_CFG_TRC_RTFIL_EN and RKH_CFG_TRC_RTFIL_SIGNAL_EN are set to 1, the RKH allows the usage of runtime trace filter for signals (events).

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 733 of file rkhcfg.h.

◆ RKH_CFG_TRC_USER_TRACE_EN

#define RKH_CFG_TRC_USER_TRACE_EN   RKH_ENABLED

If the RKH_CFG_TRC_USER_TRACE_EN is set to 1 then RKH will allow to build and generate tracing information from the application-level code. This trace records are application-specific.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 745 of file rkhcfg.h.

◆ RKH_CFG_TRC_ALL_EN

#define RKH_CFG_TRC_ALL_EN   RKH_ENABLED

If the RKH_CFG_TRC_ALL_EN is set to 1 then RKH will include all its own trace records.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 756 of file rkhcfg.h.

◆ RKH_CFG_TRC_MP_EN

#define RKH_CFG_TRC_MP_EN   RKH_ENABLED

If the RKH_CFG_TRC_MP_EN is set to 1 then RKH will include all trace records related to the native fixed-size memory blocks.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 767 of file rkhcfg.h.

◆ RKH_CFG_TRC_QUE_EN

#define RKH_CFG_TRC_QUE_EN   RKH_ENABLED

If the RKH_CFG_TRC_QUE_EN is set to 1 then RKH will include all trace records related to the native queues.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 778 of file rkhcfg.h.

◆ RKH_CFG_TRC_SMA_EN

#define RKH_CFG_TRC_SMA_EN   RKH_ENABLED

If the RKH_CFG_TRC_SMA_EN is set to 1 then RKH will include all trace records related to the state machine applications.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 789 of file rkhcfg.h.

◆ RKH_CFG_TRC_TMR_EN

#define RKH_CFG_TRC_TMR_EN   RKH_ENABLED

If the RKH_CFG_TRC_TMR_EN is set to 1 then RKH will include all trace records related to the native software timer.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 800 of file rkhcfg.h.

◆ RKH_CFG_TRC_SM_EN

#define RKH_CFG_TRC_SM_EN   RKH_ENABLED

If the RKH_CFG_TRC_SM_EN is set to 1 then RKH will include all trace records related to the state machine (hierarchical and "flat").

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 812 of file rkhcfg.h.

◆ RKH_CFG_TRC_FWK_EN

#define RKH_CFG_TRC_FWK_EN   RKH_ENABLED

If the RKH_CFG_TRC_FWK_EN is set to 1 then RKH will include all trace records related to the nativenative event framework.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 823 of file rkhcfg.h.

◆ RKH_CFG_TRC_ASSERT_EN

#define RKH_CFG_TRC_ASSERT_EN   RKH_ENABLED

If the RKH_CFG_TRC_ASSERT_EN and RKH_CFG_TRC_FWK_EN are set to 1 then RKH will include the "assertion" trace record.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 834 of file rkhcfg.h.

◆ RKH_CFG_TRC_SM_INIT_EN

#define RKH_CFG_TRC_SM_INIT_EN   RKH_ENABLED

If the RKH_CFG_TRC_SM_INIT_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "init state machine" trace record.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 845 of file rkhcfg.h.

◆ RKH_CFG_TRC_SM_DCH_EN

#define RKH_CFG_TRC_SM_DCH_EN   RKH_ENABLED

If the RKH_CFG_TRC_SM_DCH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "start a state machine" trace record.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 856 of file rkhcfg.h.

◆ RKH_CFG_TRC_SM_CLRH_EN

#define RKH_CFG_TRC_SM_CLRH_EN   RKH_ENABLED

If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "dispatch an event to state machine" trace record.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 867 of file rkhcfg.h.

◆ RKH_CFG_TRC_SM_TRN_EN

#define RKH_CFG_TRC_SM_TRN_EN   RKH_ENABLED

If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "clear the history pseudostate" trace record.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 878 of file rkhcfg.h.

◆ RKH_CFG_TRC_SM_STATE_EN

#define RKH_CFG_TRC_SM_STATE_EN   RKH_ENABLED

If the RKH_CFG_TRC_SM_STATE_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "final state of transition" trace record.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 889 of file rkhcfg.h.

◆ RKH_CFG_TRC_SM_ENSTATE_EN

#define RKH_CFG_TRC_SM_ENSTATE_EN   RKH_ENABLED

If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "entry state" trace record.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 900 of file rkhcfg.h.

◆ RKH_CFG_TRC_SM_EXSTATE_EN

#define RKH_CFG_TRC_SM_EXSTATE_EN   RKH_ENABLED

If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "exit state" trace record.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 911 of file rkhcfg.h.

◆ RKH_CFG_TRC_SM_NENEX_EN

#define RKH_CFG_TRC_SM_NENEX_EN   RKH_ENABLED

If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "number of entry and exit states in transition" trace record.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 923 of file rkhcfg.h.

◆ RKH_CFG_TRC_SM_NTRNACT_EN

#define RKH_CFG_TRC_SM_NTRNACT_EN   RKH_ENABLED

If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "number of executed actions in transition" trace record.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 935 of file rkhcfg.h.

◆ RKH_CFG_TRC_SM_TS_STATE_EN

#define RKH_CFG_TRC_SM_TS_STATE_EN   RKH_ENABLED

If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "state or pseudostate in a compound transition" trace record.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 947 of file rkhcfg.h.

◆ RKH_CFG_TRC_SM_PROCESS_EN

#define RKH_CFG_TRC_SM_PROCESS_EN   RKH_ENABLED

If the RKH_CFG_TRC_SM_CLRH_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "returned code from dispatch function" trace record.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 958 of file rkhcfg.h.

◆ RKH_CFG_TRC_SM_EXE_ACT_EN

#define RKH_CFG_TRC_SM_EXE_ACT_EN   RKH_ENABLED

If the RKH_CFG_TRC_SM_EXE_ACT_EN and RKH_CFG_TRC_SM_EN are set to 1 then RKH will include the "executed behavior of state machine" trace record.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 970 of file rkhcfg.h.

◆ RKH_CFG_TRC_NSEQ_EN

#define RKH_CFG_TRC_NSEQ_EN   RKH_ENABLED

If the RKH_CFG_TRC_NSEQ_EN is set to 1 then RKH will add to the trace record an incremental number (1-byte), used like a sequence number. See RKH_TRC_NSEQ() and RKH_TRC_HDR() macros.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 982 of file rkhcfg.h.

◆ RKH_CFG_TRC_CHK_EN

#define RKH_CFG_TRC_CHK_EN   RKH_ENABLED

If the RKH_CFG_TRC_CHK_EN is set to 1 then RKH will add to the trace record a checksum (1-byte). See RKH_TRC_CHK() macro.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 993 of file rkhcfg.h.

◆ RKH_CFG_TRC_TSTAMP_EN

#define RKH_CFG_TRC_TSTAMP_EN   RKH_ENABLED

If the RKH_CFG_TRC_TSTAMP_EN is set to 1 then RKH will add to the trace record a timestamp field. It's configurable by means of RKH_CFGPORT_TRC_SIZEOF_TSTAMP.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 1005 of file rkhcfg.h.

◆ RKH_CFG_TRC_SIZEOF_STREAM

#define RKH_CFG_TRC_SIZEOF_STREAM   128u

Specify the maximum number of trace events in the stream. The smaller this number, the lower the RAM consumption.

Type value Integer
Range value [1..65536]
Default configuration: 128

Definition at line 1016 of file rkhcfg.h.