Data Structures | |
| struct | wsfBufPoolDesc_t |
| Buffer pool descriptor structure. More... | |
| struct | WsfBufPoolStat_t |
| Pool statistics. More... | |
| struct | wsfBufDiagAllocFail_t |
| WSF buffer diagnostics - buffer allocation failure. More... | |
| struct | WsfBufDiag_t |
| WSF buffer diagnostics message. More... | |
Macros | |
| #define | WSF_BUF_FREE_CHECK_ASSERT TRUE |
| Check if trying to free a buffer that is already free. More... | |
| #define | WSF_BUF_ALLOC_BEST_FIT_FAIL_ASSERT FALSE |
| Assert on best-fit buffer allocation failure. More... | |
| #define | WSF_BUF_ALLOC_FAIL_ASSERT TRUE |
| Assert on buffer allocation failure. More... | |
| #define | WSF_BUF_STATS_HIST FALSE |
| Buffer histogram stats. More... | |
| #define | WSF_BUF_STATS_MAX_LEN 128 |
| Length of the buffer statistics array. More... | |
| #define | WSF_BUF_STATS_MAX_POOL 32 |
| Max number of pools can allocate. More... | |
| #define | WSF_BUF_ALLOC_FAILED 1 |
| Failure Codes. More... | |
| #define | WSF_BUF_STATS FALSE |
| Enable buffer allocation statistics. More... | |
Typedefs | |
| typedef void(* | WsfBufDiagCback_t) (WsfBufDiag_t *pInfo) |
| Callback providing WSF buffer diagnostic messages. More... | |
Functions | |
| uint32_t | WsfBufCalcSize (uint8_t numPools, wsfBufPoolDesc_t *pDesc) |
| Calculate size required by the buffer pool. More... | |
| uint32_t | WsfBufInit (uint8_t numPools, wsfBufPoolDesc_t *pDesc) |
| Initialize the buffer pool service. This function should only be called once upon system initialization. More... | |
| void * | WsfBufAlloc (uint16_t len) |
| Allocate a buffer. More... | |
| void | WsfBufFree (void *pBuf) |
| Free a buffer. More... | |
| uint8_t * | WsfBufGetAllocStats (void) |
| Diagnostic function to get the buffer allocation statistics. More... | |
| uint8_t * | WsfBufGetPoolOverFlowStats (void) |
| Diagnostic function to get the number of overflow times for each pool. More... | |
| uint8_t | WsfBufGetNumPool (void) |
| Get number of pools. More... | |
| void | WsfBufGetPoolStats (WsfBufPoolStat_t *pStat, uint8_t numPool) |
| Get statistics for each pool. More... | |
| void | WsfBufDiagRegister (WsfBufDiagCback_t callback) |
| Called to register the buffer diagnostics callback function. More... | |
| #define WSF_BUF_ALLOC_BEST_FIT_FAIL_ASSERT FALSE |
| #define WSF_BUF_ALLOC_FAIL_ASSERT TRUE |
| #define WSF_BUF_FREE_CHECK_ASSERT TRUE |
| #define WSF_BUF_STATS FALSE |
| #define WSF_BUF_STATS_MAX_LEN 128 |
| #define WSF_BUF_STATS_MAX_POOL 32 |
| typedef void(* WsfBufDiagCback_t) (WsfBufDiag_t *pInfo) |
| void* WsfBufAlloc | ( | uint16_t | len | ) |
Allocate a buffer.
| len | Length of buffer to allocate. |
| uint32_t WsfBufCalcSize | ( | uint8_t | numPools, |
| wsfBufPoolDesc_t * | pDesc | ||
| ) |
Calculate size required by the buffer pool.
| numPools | Number of buffer pools. |
| pDesc | Array of buffer pool descriptors, one for each pool. |
| void WsfBufDiagRegister | ( | WsfBufDiagCback_t | callback | ) |
Called to register the buffer diagnostics callback function.
| callback | Pointer to the callback function. |
| void WsfBufFree | ( | void * | pBuf | ) |
Free a buffer.
| pBuf | Buffer to free. |
| uint8_t* WsfBufGetAllocStats | ( | void | ) |
Diagnostic function to get the buffer allocation statistics.
| uint8_t WsfBufGetNumPool | ( | void | ) |
Get number of pools.
| uint8_t* WsfBufGetPoolOverFlowStats | ( | void | ) |
Diagnostic function to get the number of overflow times for each pool.
| void WsfBufGetPoolStats | ( | WsfBufPoolStat_t * | pStat, |
| uint8_t | numPool | ||
| ) |
Get statistics for each pool.
| pStat | Buffer to store the statistics. |
| numPool | Number of pool elements. |
| uint32_t WsfBufInit | ( | uint8_t | numPools, |
| wsfBufPoolDesc_t * | pDesc | ||
| ) |
Initialize the buffer pool service. This function should only be called once upon system initialization.
| numPools | Number of buffer pools. |
| pDesc | Array of buffer pool descriptors, one for each pool. |
