hal_bp.h

Go to the documentation of this file.

#ifndef HAL_BP_H_
#define HAL_BP_H_


#include "hal_core.h"
#include <stdint.h>


/*
 * Internal configuration of the buffer pool module.
 */

/* The alignment of the memory area inside of the (partial) buffers. */
#define HAL_BP_MEM_ALIGN                4UL

#define HAL_BP_MUTEX_DECLARE(name)      void* name
#define HAL_BP_MUTEX_CREATE(name)       name = NULL
#define HAL_BP_MUTEX_LOCK(name)         CORE_EnterCritical()
#define HAL_BP_MUTEX_UNLOCK(name)       CORE_ExitCritical()


struct BP_BufferPool_Tag;
typedef struct BP_BufferPool_Tag* BP_BufferPool;

typedef struct BP_PartialBuf_Tag
{
    uint32_t size;
    void* data;
    struct BP_PartialBuf_Tag* next;
    BP_BufferPool pool;
} BP_PartialBuf_T;

typedef BP_PartialBuf_T* BP_PartialBuffer;


BP_BufferPool BP_Create(uint32_t no_buffers, uint32_t buffer_size);

BP_PartialBuffer BP_GetBuffer(BP_BufferPool bp, uint32_t buf_len);

void BP_ReleaseBuffer(BP_PartialBuffer buf);

uint32_t BP_CopyToMem(BP_PartialBuffer src, void* dst, uint32_t src_offset, uint32_t data_len);

uint32_t BP_CopyToBuf(BP_PartialBuffer dst, const void* src, uint32_t dst_offset, uint32_t data_len);

void BP_InitStandaloneBuf(BP_PartialBuffer buf, void* mem_area, uint32_t mem_size);

#endif /* HAL_BP_H_ */