RKH
Related to RKH port

Configuration options related to RKH port. More...

Macros

#define RKH_CFGPORT_SMA_THREAD_EN   RKH_ENABLED
 If the RKH_CFGPORT_SMA_THREAD_EN is set to 1, each SMA (active object) has its own thread of execution. More...
 
#define RKH_CFGPORT_SMA_THREAD_DATA_EN   RKH_ENABLED
 If the RKH_CFGPORT_SMA_THREAD_EN and RKH_CFGPORT_SMA_THREAD_DATA_EN are set to 1, each SMA (active object) has its own thread of execution and its own object data. When enabling it, the option RKH_OSSIGNAL_TYPE must be defined. More...
 
#define RKH_CFGPORT_NATIVE_SCHEDULER_EN   RKH_ENABLED
 If the RKH_CFGPORT_NATIVE_SCHEDULER_EN is set to 1 then RKH will include the simple, cooperative, and nonpreemptive scheduler RKHS. When RKH_CFGPORT_NATIVE_SCHEDULER_EN is enabled RKH also will automatically define RKH_EQ_TYPE, and include rkh_sma_block(), rkh_sma_setReady(), rkh_sma_setUnready(), and assume the native priority scheme. More...
 
#define RKH_CFGPORT_NATIVE_EQUEUE_EN   RKH_ENABLED
 If the RKH_CFGPORT_NATIVE_EQUEUE_EN is set to 1 and the native event queue is enabled (see RKH_CFG_QUE_EN) then RKH will include its own implementation of rkh_sma_post_fifo(), rkh_sma_post_lifo(), and rkh_sma_get() functions. More...
 
#define RKH_CFGPORT_NATIVE_DYN_EVT_EN   RKH_ENABLED
 If the RKH_CFGPORT_NATIVE_DYN_EVT_EN is set to 1 and the native fixed-size memory block facility is enabled (see RKH_CFG_MP_EN) then RKH will include its own implementation of dynamic memory management. When RKH_CFGPORT_NATIVE_DYN_EVT_EN is enabled RKH also will provide the event pool manager implementation based on its native memory pool module. More...
 
#define RKH_CFGPORT_REENTRANT_EN   RKH_ENABLED
 If the RKH_CFGPORT_REENTRANT_EN is set to 1, the RKH event dispatch allows to be invoked from several threads of executions. Enable this only if the application is based on a multi-thread architecture. More...
 
#define RKH_CFGPORT_TRC_SIZEOF_PTR   32u
 Specify the size of void pointer. The valid values [in bits] are 16 or 32. Default is 32. See RKH_TRC_SYM() macro. More...
 
#define RKH_CFGPORT_TRC_SIZEOF_FUN_PTR   32u
 Specify the size of function pointer. The valid values [in bits] are 16 or 32. Default is 32. See RKH_TUSR_FUN() and RKH_TRC_FUN() macros. More...
 
#define RKH_CFGPORT_TRC_SIZEOF_TSTAMP   32u
 Specify the number of bytes (size) used by the trace record timestamp. The valid values [in bits] are 8, 16 or 32. Default is 16. More...
 
#define RKH_CFGPORT_SMA_QSTO_EN   RKH_ENABLED
 If the RKH_CFGPORT_SMA_QSTO_EN is set to 1 then RKH_SMA_ACTIVATE() macro invokes the rkh_sma_activate() function ignoring the external event queue storage argument, qs. More...
 
#define RKH_CFGPORT_SMA_STK_EN   RKH_ENABLED
 If the RKH_CFGPORT_SMA_STK_EN is set to 0 then RKH_SMA_ACTIVATE() macro invokes the rkh_sma_activate() function ignoring the thread's stack related arguments, stks and stksize. More...
 

Detailed Description

Configuration options related to RKH port.

Macro Definition Documentation

◆ RKH_CFGPORT_SMA_THREAD_EN

#define RKH_CFGPORT_SMA_THREAD_EN   RKH_ENABLED

If the RKH_CFGPORT_SMA_THREAD_EN is set to 1, each SMA (active object) has its own thread of execution.

Type value Boolean
Range value
Default configuration: RKH_DISABLED

Definition at line 2074 of file rkhitl.h.

◆ RKH_CFGPORT_SMA_THREAD_DATA_EN

#define RKH_CFGPORT_SMA_THREAD_DATA_EN   RKH_ENABLED

If the RKH_CFGPORT_SMA_THREAD_EN and RKH_CFGPORT_SMA_THREAD_DATA_EN are set to 1, each SMA (active object) has its own thread of execution and its own object data. When enabling it, the option RKH_OSSIGNAL_TYPE must be defined.

The os_signal member of RKH_SMA_T is necessary when the underlying OS does not provide an adequate queue facility, so the native RKH queue RKH_QUEUE_T must be used. In this case the RKH_OSSIGNAL_TYPE indicates an operating system specific primitive to efficiently block the native RKH event queue when the queue is empty. Frequently, the active object has its own task processing loop that waits for the signal to be posted, and when it is, loops to remove and process all events that are currently queued. The RKH_SMA_POST_FIFO() macro enqueues an event and signals the OS that an event has arrived. In this case, os_signal holds the OS object used to signal that an event has been queued.

Type value Boolean
Range value
Default configuration: RKH_DISABLED

Definition at line 2089 of file rkhitl.h.

◆ RKH_CFGPORT_NATIVE_SCHEDULER_EN

#define RKH_CFGPORT_NATIVE_SCHEDULER_EN   RKH_ENABLED

If the RKH_CFGPORT_NATIVE_SCHEDULER_EN is set to 1 then RKH will include the simple, cooperative, and nonpreemptive scheduler RKHS. When RKH_CFGPORT_NATIVE_SCHEDULER_EN is enabled RKH also will automatically define RKH_EQ_TYPE, and include rkh_sma_block(), rkh_sma_setReady(), rkh_sma_setUnready(), and assume the native priority scheme.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 2104 of file rkhitl.h.

◆ RKH_CFGPORT_NATIVE_EQUEUE_EN

#define RKH_CFGPORT_NATIVE_EQUEUE_EN   RKH_ENABLED

If the RKH_CFGPORT_NATIVE_EQUEUE_EN is set to 1 and the native event queue is enabled (see RKH_CFG_QUE_EN) then RKH will include its own implementation of rkh_sma_post_fifo(), rkh_sma_post_lifo(), and rkh_sma_get() functions.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 2117 of file rkhitl.h.

◆ RKH_CFGPORT_NATIVE_DYN_EVT_EN

#define RKH_CFGPORT_NATIVE_DYN_EVT_EN   RKH_ENABLED

If the RKH_CFGPORT_NATIVE_DYN_EVT_EN is set to 1 and the native fixed-size memory block facility is enabled (see RKH_CFG_MP_EN) then RKH will include its own implementation of dynamic memory management. When RKH_CFGPORT_NATIVE_DYN_EVT_EN is enabled RKH also will provide the event pool manager implementation based on its native memory pool module.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 2132 of file rkhitl.h.

◆ RKH_CFGPORT_REENTRANT_EN

#define RKH_CFGPORT_REENTRANT_EN   RKH_ENABLED

If the RKH_CFGPORT_REENTRANT_EN is set to 1, the RKH event dispatch allows to be invoked from several threads of executions. Enable this only if the application is based on a multi-thread architecture.

Type value Boolean
Range value
Default configuration: RKH_DISABLED

Definition at line 2144 of file rkhitl.h.

◆ RKH_CFGPORT_TRC_SIZEOF_PTR

#define RKH_CFGPORT_TRC_SIZEOF_PTR   32u

Specify the size of void pointer. The valid values [in bits] are 16 or 32. Default is 32. See RKH_TRC_SYM() macro.

Type value Integer
Range value [8, 16, 32]
Default configuration: 32

Definition at line 2155 of file rkhitl.h.

◆ RKH_CFGPORT_TRC_SIZEOF_FUN_PTR

#define RKH_CFGPORT_TRC_SIZEOF_FUN_PTR   32u

Specify the size of function pointer. The valid values [in bits] are 16 or 32. Default is 32. See RKH_TUSR_FUN() and RKH_TRC_FUN() macros.

Type value Integer
Range value [8, 16, 32]
Default configuration: 32

Definition at line 2166 of file rkhitl.h.

◆ RKH_CFGPORT_TRC_SIZEOF_TSTAMP

#define RKH_CFGPORT_TRC_SIZEOF_TSTAMP   32u

Specify the number of bytes (size) used by the trace record timestamp. The valid values [in bits] are 8, 16 or 32. Default is 16.

Type value Integer
Range value [8, 16, 32]
Default configuration: 16

Definition at line 2177 of file rkhitl.h.

◆ RKH_CFGPORT_SMA_QSTO_EN

#define RKH_CFGPORT_SMA_QSTO_EN   RKH_ENABLED

If the RKH_CFGPORT_SMA_QSTO_EN is set to 1 then RKH_SMA_ACTIVATE() macro invokes the rkh_sma_activate() function ignoring the external event queue storage argument, qs.

Type value Boolean
Range value
Default configuration: RKH_ENABLED

Definition at line 2189 of file rkhitl.h.

◆ RKH_CFGPORT_SMA_STK_EN

#define RKH_CFGPORT_SMA_STK_EN   RKH_ENABLED

If the RKH_CFGPORT_SMA_STK_EN is set to 0 then RKH_SMA_ACTIVATE() macro invokes the rkh_sma_activate() function ignoring the thread's stack related arguments, stks and stksize.

Type value Boolean
Range value
Default configuration: RKH_DISABLED

Definition at line 2201 of file rkhitl.h.