enet_dma_pktutils.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2020
 *
 *  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 ENET_DMA_PKTUTILS_H_
#define ENET_DMA_PKTUTILS_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

#include <stdarg.h>
#include <ti/drv/enet/include/core/enet_utils.h>

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */


#define ENET_UTILS_GET_STATE(state, mask, bitshift)    ((*(state) & (mask)) >> (bitshift))
#define ENET_UTILS_SET_STATE(state, mask, bitshift, value) \
    ({                                                     \
         *(state) &= ~(mask);                              \
         *(state) |= ((value) << (bitshift));              \
     })

#define ENET_UTILS_DRIVER_STATE_MASK            (0x000000FFU)
#define ENET_UTILS_DRIVER_STATE_BIT_SHIFT       (0U)

#define ENET_DMA_MEMMGR_STATE_MASK          (0x0000FF00U)
#define ENET_DMA_MEMMGR_STATE_BIT_SHIFT     (8U)

#define ENET_UTILS_APP_STATE_MASK               (0x00FF0000U)
#define ENET_UTILS_APP_STATE_BIT_SHIFT          (16U)

#define ENET_UTILS_GET_PKT_DRIVER_STATE(state)          \
    (ENET_UTILS_GET_STATE(state,                        \
                          ENET_UTILS_DRIVER_STATE_MASK, \
                          ENET_UTILS_DRIVER_STATE_BIT_SHIFT))

#define ENET_UTILS_SET_PKT_DRIVER_STATE(state, value)        \
    (ENET_UTILS_SET_STATE(state,                             \
                          ENET_UTILS_DRIVER_STATE_MASK,      \
                          ENET_UTILS_DRIVER_STATE_BIT_SHIFT, \
                          value))

#define ENET_UTILS_GET_PKT_MEMMGR_STATE(state)          \
    (ENET_UTILS_GET_STATE(state,                          \
                          ENET_DMA_MEMMGR_STATE_MASK, \
                          ENET_DMA_MEMMGR_STATE_BIT_SHIFT))

#define ENET_UTILS_SET_PKT_MEMMGR_STATE(state, value)        \
    (ENET_UTILS_SET_STATE(state,                               \
                          ENET_DMA_MEMMGR_STATE_MASK,      \
                          ENET_DMA_MEMMGR_STATE_BIT_SHIFT, \
                          value))

#define ENET_UTILS_GET_PKT_APP_STATE(state)          \
    (ENET_UTILS_GET_STATE(state,                     \
                          ENET_UTILS_APP_STATE_MASK, \
                          ENET_UTILS_APP_STATE_BIT_SHIFT))

#define ENET_UTILS_SET_PKT_APP_STATE(state, value)        \
    (ENET_UTILS_SET_STATE(state,                          \
                          ENET_UTILS_APP_STATE_MASK,      \
                          ENET_UTILS_APP_STATE_BIT_SHIFT, \
                          value))

#define ENET_DMA_MEMMGR_DESCSTATE_MASK                      (0x000000FFU)
#define ENET_DMA_MEMMGR_DESCSTATE_SHIFT                     (0U)

#define ENET_UTILS_GET_DESC_MEMMGR_STATE(state)             \
    (ENET_UTILS_GET_STATE(state,                              \
                          ENET_DMA_MEMMGR_DESCSTATE_MASK, \
                          ENET_DMA_MEMMGR_DESCSTATE_SHIFT))

#define ENET_UTILS_SET_DESC_MEMMGR_STATE(state, value)       \
    (ENET_UTILS_SET_STATE(state,                               \
                          ENET_DMA_MEMMGR_DESCSTATE_MASK,  \
                          ENET_DMA_MEMMGR_DESCSTATE_SHIFT, \
                          value))

typedef enum EnetDma_DescStateMemMgr_e
{
    ENET_DESCSTATE_MEMMGR_FREE = 0U,

    ENET_DESCSTATE_MEMMGR_ALLOC
} EnetDma_DescStateMemMgr;

typedef enum EnetDma_PktStateApp_e
{
    ENET_PKTSTATE_APP_WITH_FREEQ = 0U,

    ENET_PKTSTATE_APP_WITH_READYQ,

    ENET_PKTSTATE_APP_WITH_DRIVER
} EnetDma_PktStateApp;

typedef enum EnetDma_PktStateDma_e
{
    ENET_PKTSTATE_DMA_WITH_HW = 0U,

    ENET_PKTSTATE_DMA_NOT_WITH_HW
} EnetDma_PktStateDma;

typedef enum EnetDma_PktStateMemMgr_e
{
    ENET_PKTSTATE_MEMMGR_FREE = 0U,

    ENET_PKTSTATE_MEMMGR_ALLOC,
} EnetDma_PktStateMemMgr;

typedef enum EnetDma_PktStateModuleType_e
{
    ENET_PKTSTATE_MODULE_APP = 0U,

    ENET_PKTSTATE_MODULE_DRIVER,

    ENET_PKTSTATE_MODULE_MEMMGR,
} EnetDma_PktStateModuleType;

/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

static inline void EnetDma_checkPktState(uint32_t *pStateVar,
                             EnetDma_PktStateModuleType module,
                             uint32_t expectedState,
                             uint32_t newState);

static inline void EnetDma_checkDescState(uint32_t *pStateVar,
                              EnetDma_DescStateMemMgr expectedState,
                              EnetDma_DescStateMemMgr newState);

/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */

static inline void EnetDma_checkDescState(uint32_t *pStateVar,
                              EnetDma_DescStateMemMgr expectedState,
                              EnetDma_DescStateMemMgr newState)
{
    Enet_assert(ENET_UTILS_GET_DESC_MEMMGR_STATE(pStateVar) == expectedState);
    ENET_UTILS_SET_DESC_MEMMGR_STATE(pStateVar, newState);
}

static inline void EnetDma_checkPktState(uint32_t *pStateVar,
                             EnetDma_PktStateModuleType module,
                             uint32_t expectedState,
                             uint32_t newState)
{
    switch (module)
    {
        case ENET_PKTSTATE_MODULE_APP:
            Enet_assert(ENET_UTILS_GET_PKT_APP_STATE(pStateVar) == expectedState);
            ENET_UTILS_SET_PKT_APP_STATE(pStateVar, newState);
            break;

        case ENET_PKTSTATE_MODULE_DRIVER:
            Enet_assert(ENET_UTILS_GET_PKT_DRIVER_STATE(pStateVar) == expectedState);
            ENET_UTILS_SET_PKT_DRIVER_STATE(pStateVar, newState);
            break;

        case ENET_PKTSTATE_MODULE_MEMMGR:
            Enet_assert(ENET_UTILS_GET_PKT_MEMMGR_STATE(pStateVar) == expectedState);
            ENET_UTILS_SET_PKT_MEMMGR_STATE(pStateVar, newState);
            break;

        default:
            break;
    }
}

#ifdef __cplusplus
}
#endif

#endif /* #ifndef ENET_DMA_PKTUTILS_H_ */