- Generated on Fri Jun 25 2021 12:16:22 for RKH by
1.9.2
|
RKH
|
Configuration options related to queue facility (QUE) More...
Macros | |
| #define | RKH_CFG_QUE_EN RKH_ENABLED |
| If the RKH_CFG_QUE_EN is set to 1 then RKH will include the native queue facility. More... | |
| #define | RKH_CFG_QUE_SIZEOF_NELEM 8u |
| Specify the maximum number of elements that any queue can contain. The valid values [in bits] are 8, 16 or 32. Default is 8. See RKH_QUENE_T type. More... | |
| #define | RKH_CFG_QUE_GET_LWMARK_EN RKH_ENABLED |
| If the RKH_CFG_QUE_GET_LWMARK_EN is set to 1 then RKH allows to known the minimum number of free elements ever in the queue (low-watermark ). This provides valuable empirical data for proper sizing of the queue. See rkh_rq_get_lwm() function. More... | |
| #define | RKH_CFG_QUE_GET_INFO_EN RKH_ENABLED |
| If the RKH_CFG_QUE_GET_INFO_EN is set to 1 then RKH allows to collect and retrives performance information for a particular queue. See rkh_rq_get_info() and rkh_rq_clear_info() functions. More... | |
| #define | RKH_CFG_QUE_READ_EN RKH_ENABLED |
| If the RKH_CFG_QUE_READ_EN is set to 1 then RKH will include the rkh_rq_read() function that allows read an element from a queue without remove it. See rkh_rq_read() function. More... | |
| #define | RKH_CFG_QUE_DEPLETE_EN RKH_ENABLED |
| If the RKH_CFG_QUE_DEPLETE_EN is set to 1 then RKH will include the rkh_rq_deplete() function that empties the contents of the queue and eliminates all stored elements. See rkh_rq_deplete() function. More... | |
| #define | RKH_CFG_QUE_IS_FULL_EN RKH_ENABLED |
| If the RKH_CFG_QUE_IS_FULL_EN is set to 1 then RKH will include the rkh_rq_is_full() function that allows to known if a queue is full. See rkh_rq_is_full() function. More... | |
| #define | RKH_CFG_QUE_GET_NELEMS_EN RKH_ENABLED |
| If the RKH_CFG_QUE_GET_NELEMS_EN is set to 1 then RKH will include the rkh_rq_get_num() function that returns the number of elements currently in the queue. See rkh_rq_get_num() function. More... | |
| #define | RKH_CFG_QUE_PUT_LIFO_EN RKH_ENABLED |
| If the RKH_CFG_QUE_PUT_LIFO_EN is set to 1 then RKH will include the rkh_rq_put_lifo() function that puts an element on a queue in a LIFO manner. See rkh_rq_put_lifo() function. More... | |
Configuration options related to queue facility (QUE)
| #define RKH_CFG_QUE_EN RKH_ENABLED |
If the RKH_CFG_QUE_EN is set to 1 then RKH will include the native queue facility.
| #define RKH_CFG_QUE_SIZEOF_NELEM 8u |
Specify the maximum number of elements that any queue can contain. The valid values [in bits] are 8, 16 or 32. Default is 8. See RKH_QUENE_T type.
| #define RKH_CFG_QUE_GET_LWMARK_EN RKH_ENABLED |
If the RKH_CFG_QUE_GET_LWMARK_EN is set to 1 then RKH allows to known the minimum number of free elements ever in the queue (low-watermark ). This provides valuable empirical data for proper sizing of the queue. See rkh_rq_get_lwm() function.
| #define RKH_CFG_QUE_GET_INFO_EN RKH_ENABLED |
If the RKH_CFG_QUE_GET_INFO_EN is set to 1 then RKH allows to collect and retrives performance information for a particular queue. See rkh_rq_get_info() and rkh_rq_clear_info() functions.
| #define RKH_CFG_QUE_READ_EN RKH_ENABLED |
If the RKH_CFG_QUE_READ_EN is set to 1 then RKH will include the rkh_rq_read() function that allows read an element from a queue without remove it. See rkh_rq_read() function.
| #define RKH_CFG_QUE_DEPLETE_EN RKH_ENABLED |
If the RKH_CFG_QUE_DEPLETE_EN is set to 1 then RKH will include the rkh_rq_deplete() function that empties the contents of the queue and eliminates all stored elements. See rkh_rq_deplete() function.
| #define RKH_CFG_QUE_IS_FULL_EN RKH_ENABLED |
If the RKH_CFG_QUE_IS_FULL_EN is set to 1 then RKH will include the rkh_rq_is_full() function that allows to known if a queue is full. See rkh_rq_is_full() function.
| #define RKH_CFG_QUE_GET_NELEMS_EN RKH_ENABLED |
If the RKH_CFG_QUE_GET_NELEMS_EN is set to 1 then RKH will include the rkh_rq_get_num() function that returns the number of elements currently in the queue. See rkh_rq_get_num() function.
| #define RKH_CFG_QUE_PUT_LIFO_EN RKH_ENABLED |
If the RKH_CFG_QUE_PUT_LIFO_EN is set to 1 then RKH will include the rkh_rq_put_lifo() function that puts an element on a queue in a LIFO manner. See rkh_rq_put_lifo() function.
1.9.2