ptxBufferPool.h

Go to the documentation of this file.

 
#ifndef PTXBUFFERPOOL_H
#define PTXBUFFERPOOL_H
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include "ptx_Status.h"
#include "ptxOsal.h"
#include "ptxLog.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES / INTERNALS
 * ####################################################################################################################
 */
 
typedef enum ptxBufferPool_ItemState
{
    ptxBufferPool_ItemState_IDLE,
    ptxBufferPool_ItemState_ACTIVE,
    ptxBufferPool_ItemState_IN_USE,
    ptxBufferPool_ItemState_MAX_COUNT
} ptxBufferPool_ItemState_t;
 
/*
 * Forward declaration
 */
struct ptxBufferPool;
 
typedef struct ptxBufferPool_Item
{
    ptxBufferPool_ItemState_t       State;                  
    uint8_t                         Number;                 
    ptxMutex_t                     *Mx;                     
    struct ptxBufferPool           *BufferPool;             
    size_t                          StartingIndex;          
    size_t                          Length;                 
    struct ptxBufferPool_Item      *NextBufferItem;         
    struct ptxBufferPool_Item      *PrevBufferItem;         
} ptxBufferPool_Item_t;
 
typedef struct ptxBufferPool
{
    /* Administrative.*/
    ptxMutex_t                      Mx;                     
    ptxSemaphore_t                  Sem;                    
    uint8_t                         LogDetails;             
    struct ptxOsal                 *OS;                     
    ptxLog_t                       *LOG;                    
    /* Buffer of items */
    ptxBufferPool_Item_t           *Items;                  
    size_t                          NumItems;               
    /* Handling memory. */
    uint8_t                        *MemSpace;               
    size_t                          MemSize;                
    ptxBufferPool_Item_t           *ListItems;              
} ptxBufferPool_t;
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
ptxStatus_t ptxBufferPool_Init(ptxBufferPool_t *bufPool, struct ptxOsal *osAl, ptxLog_t *logCtx, size_t maxNumBuffers, size_t memSize, uint8_t logDetails);
 
ptxStatus_t ptxBufferPool_DeInit(ptxBufferPool_t *bufPool);
 
ptxStatus_t ptxBufferPool_ProvideItem(ptxBufferPool_t *bufPool, ptxBufferPool_Item_t **poolItem, size_t sizeReq);
 
ptxStatus_t ptxBufferPool_ClaimItem(ptxBufferPool_Item_t *poolItem);
 
ptxStatus_t ptxBufferPool_ReleaseItem(ptxBufferPool_Item_t *poolItem);
 
ptxStatus_t ptxBufferPool_ReleaseUnusedItem(ptxBufferPool_Item_t *poolItem);
 
ptxStatus_t ptxBufferPool_ProvideAndClaimItem(ptxBufferPool_t *bufPool, ptxBufferPool_Item_t **poolItem, size_t sizeReq);
 
uint8_t *ptxBufferPool_GetBuffer(ptxBufferPool_Item_t *poolItem);
 
size_t *ptxBufferPool_PointToLength(ptxBufferPool_Item_t *poolItem);
 
size_t ptxBufferPool_GetLength(ptxBufferPool_Item_t *poolItem);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */