bufpool.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2021
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef BUFPOOL_H_
#define BUFPOOL_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
#include <stdio.h>
#include <stdlib.h>

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                                Macros                                      */
/* ========================================================================== */

#define BUFPOOL_MEM_LEN     (BUFPOOL_MAX_POOLS * sizeof(BufPool_Pool))

#define ETH_MAX_PAYLOAD     (1514)

#define VLAN_TAG_SIZE       (4U)

#define ETH_FRAME_SIZE      (ETH_MAX_PAYLOAD + VLAN_TAG_SIZE)

#define BUFPOOL_MCU2_0_R5   (0)

#define BUFPOOL_MCU2_1      (1)

#define BUFPOOL_A72         (2)

#define BUFPOOL_MCU2_0_A72  (3)

#define BUFPOOL_MAX_POOLS   (4)

#define BUFPOOL_BUF_MAX     (1280U)

#define BUFPOOL_OK          (0)       

#define BUFPOOL_ERROR       (-1)      

/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */

typedef struct BufPool_Buf_s
{
    uint8_t payload[ETH_FRAME_SIZE];

    uint16_t payloadLen;

    int16_t refCount;
    
    int16_t isUsed;

    uint32_t poolId;

    uint8_t pad[8];

} BufPool_Buf;

typedef struct BufPool_Pool_s
{
    uint32_t poolId;

    int32_t lastFreed;

    int32_t lastAlloc;

    uint32_t magic;

    uint32_t maxSize;

    uint32_t numBufGet;

    uint32_t numBufFree;

    uint32_t numBufGetErr;

    BufPool_Buf buf_array[BUFPOOL_BUF_MAX];

} BufPool_Pool;

typedef struct BufPool_Pool_s* BufPool_Handle;

#define BUF_OBJ_SIZE_IN_BYTES (sizeof(BufPool_Buf))

/* ========================================================================== */
/*                         External Variable Declarations                     */
/* ========================================================================== */

extern BufPool_Handle BufPoolTable_Handle;

/* ========================================================================== */
/*                     API/Public Function Declarations                       */
/* ========================================================================== */

int32_t BufPool_init(BufPool_Handle hBufPool,
                     uint32_t poolId,
                     uint32_t maxSize);

BufPool_Buf* BufPool_getBuf(BufPool_Handle hBufPool);

int32_t BufPool_freeBuf(BufPool_Buf* hBuf);

#ifdef __cplusplus
}
#endif

#endif /* BUFPOOL_H_ */