RKH
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Related to fixed-sized memory block facility

Configuration options related to fixed-sized memory block (MP) More...

Macros

#define RKH_CFG_MP_EN   RKH_ENABLED
 If the RKH_CFG_MP_EN is set to 1 then RKH will include the native fixed-size memory block management. More...
 
#define RKH_CFG_MP_REDUCED_EN   RKH_DISABLED
 If the RKH_CFG_MP_EN is set to 1 then RKH will include the native fixed-size memory block management. More...
 
#define RKH_CFG_MP_SIZEOF_BSIZE   8u
 Specify the size of memory block size. The valid values [in bits] are 8, 16 or 32. Default is 8. See RKH_MPBS_T type. More...
 
#define RKH_CFG_MP_SIZEOF_NBLOCK   8u
 Specify size of number of memory block size. The valid values [in bits] are 8, 16 or 32. Default is 8. See RKH_MPNB_T type. More...
 
#define RKH_CFG_MP_GET_BSIZE_EN   RKH_ENABLED
 If the RKH_CFG_MP_GET_BSIZE_EN is set to 1 then RKH will include the rkh_mp_get_bsize() function that returns the size of memory block in bytes. See rkh_mp_get_bsize() function. More...
 
#define RKH_CFG_MP_GET_NFREE_EN   RKH_ENABLED
 If the RKH_CFG_MP_GET_NFREE_EN is set to 1 then RKH will include the rkh_mp_get_nfree() function that returns the current number of free memory blocks in the pool. See rkh_mp_get_nfree() function. More...
 
#define RKH_CFG_MP_GET_LWM_EN   RKH_ENABLED
 If the RKH_CFG_MP_GET_LWM_EN is set to 1 then RKH will include the rkh_mp_get_low_wmark() function that returns the lowest number of free blocks ever present in the pool. This number provides valuable empirical data for proper sizing of the memory pool. See rkh_mp_get_low_wmark() function. More...
 
#define RKH_CFG_MP_GET_INFO_EN   RKH_ENABLED
 If the RKH_CFG_MP_GET_INFO_EN is set to 1 then RKH will include the rkh_mp_get_info() function that retrieves performance information for a particular memory pool. See rkh_mp_get_info() function. More...
 

Detailed Description

Configuration options related to fixed-sized memory block (MP)

Macro Definition Documentation

#define RKH_CFG_MP_EN   RKH_ENABLED

If the RKH_CFG_MP_EN is set to 1 then RKH will include the native fixed-size memory block management.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 1112 of file rkhcfg.h.

#define RKH_CFG_MP_REDUCED_EN   RKH_DISABLED

If the RKH_CFG_MP_EN is set to 1 then RKH will include the native fixed-size memory block management.

Type value
Boolean
Range value
Default configuration:
RKH_DISABLED

Definition at line 1123 of file rkhcfg.h.

#define RKH_CFG_MP_SIZEOF_BSIZE   8u

Specify the size of memory block size. The valid values [in bits] are 8, 16 or 32. Default is 8. See RKH_MPBS_T type.

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

Definition at line 1134 of file rkhcfg.h.

#define RKH_CFG_MP_SIZEOF_NBLOCK   8u

Specify size of number of memory block size. The valid values [in bits] are 8, 16 or 32. Default is 8. See RKH_MPNB_T type.

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

Definition at line 1145 of file rkhcfg.h.

#define RKH_CFG_MP_GET_BSIZE_EN   RKH_ENABLED

If the RKH_CFG_MP_GET_BSIZE_EN is set to 1 then RKH will include the rkh_mp_get_bsize() function that returns the size of memory block in bytes. See rkh_mp_get_bsize() function.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 1157 of file rkhcfg.h.

#define RKH_CFG_MP_GET_NFREE_EN   RKH_ENABLED

If the RKH_CFG_MP_GET_NFREE_EN is set to 1 then RKH will include the rkh_mp_get_nfree() function that returns the current number of free memory blocks in the pool. See rkh_mp_get_nfree() function.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 1170 of file rkhcfg.h.

#define RKH_CFG_MP_GET_LWM_EN   RKH_ENABLED

If the RKH_CFG_MP_GET_LWM_EN is set to 1 then RKH will include the rkh_mp_get_low_wmark() function that returns the lowest number of free blocks ever present in the pool. This number provides valuable empirical data for proper sizing of the memory pool. See rkh_mp_get_low_wmark() function.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 1184 of file rkhcfg.h.

#define RKH_CFG_MP_GET_INFO_EN   RKH_ENABLED

If the RKH_CFG_MP_GET_INFO_EN is set to 1 then RKH will include the rkh_mp_get_info() function that retrieves performance information for a particular memory pool. See rkh_mp_get_info() function.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 1196 of file rkhcfg.h.