enet_utils.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_UTILS_H_
#define ENET_UTILS_H_

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

#include <stdint.h>
#include <stdbool.h>
#include <stdarg.h>
#include <stddef.h>
#include <string.h>
#include <ti/drv/enet/enet_cfg.h>
#include <ti/drv/enet/include/core/enet_types.h>
#include <ti/drv/enet/include/core/enet_mod_macport.h>
#include <ti/drv/enet/priv/core/enet_trace_priv.h>
#include <ti/drv/enet/include/phy/enetphy.h>

#if defined(__KLOCWORK__) || defined(__cplusplus)
#include <stdlib.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif

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

#define container_of(ptr, type, member)                      \
    ({                                                       \
         const typeof(((type *)0)->member) * __mptr = (ptr); \
         (type *)((char *)__mptr - offsetof(type, member));  \
     })

#define ENET_UNUSED(x)                        (x = x)

#define ENET_MK_ONES(c_ebit, c_sbit)          (((1U << (((c_ebit) - (c_sbit)) + 1U)) - 1U) << (c_sbit))

#define ENET_UTILS_ALIGN(x, y)                ((((x) + ((y) - 1)) / (y)) * (y))

#define ENET_UTILS_IS_ALIGNED(addr, alignSz)  (((uintptr_t)addr & ((alignSz) - 1U)) == 0U)

#define ENET_UTILS_ARRAY_COPY(dst, src)                                  \
    do                                                                   \
    {                                                                    \
        /* dst argument of macro should be array and not pointer.*/      \
        ENET_UTILS_COMPILETIME_ASSERT(sizeof(dst) != sizeof(uintptr_t)); \
        memcpy(dst, src, (ENET_ARRAYSIZE(dst) * sizeof(dst[0])));  \
    } while (0)

#if ENET_CFG_IS_ON(ASSERT)
#if defined(__KLOCWORK__) || defined(__cplusplus)
#define Enet_assert(cond, ...)            do { if (!(cond)) abort(); } while (0)
#else /* !defined(__KLOCWORK__) && !defined(__cplusplus) */
#define Enet_assert(cond, ...)                               \
    do {                                                     \
        ENETTRACE_ERR_IF(!(bool)(cond), __VA_ARGS__);        \
        EnetUtils_assertLocal((bool)(cond),                  \
                              (const char *)# cond,          \
                              (const char *)__FILE__,        \
                              (int32_t)__LINE__);            \
    } while (0)
#endif /* defined(__KLOCWORK__) || defined(__cplusplus) */
#else /* !ENET_CFG_IS_ON(ASSERT) */
#define Enet_assert(cond, ...)           (void)(cond)
#endif /* ENET_CFG_IS_ON(ASSERT) */

#if ENET_CFG_IS_ON(ASSERT)
#if defined(__KLOCWORK__) || defined(__cplusplus)
#define Enet_devAssert(cond, ...)         do { if (!(cond)) abort(); } while (0)
#else /* !defined(__KLOCWORK__) && !defined(__cplusplus) */
#define Enet_devAssert(cond, ...)                            \
    do {                                                     \
        ENETTRACE_ERR_IF(!(bool)(cond), __VA_ARGS__);        \
        EnetUtils_assertLocal((bool)(cond),                  \
                              (const char *)# cond,          \
                              (const char *)__FILE__,        \
                              (int32_t)__LINE__);            \
    } while (0)
#endif /* defined(__KLOCWORK__) || defined(__cplusplus) */
#else /* !ENET_CFG_IS_ON(ASSERT) || !ENET_CFG_IS_ON(DEV_ERROR) */
#define Enet_devAssert(cond, fmt, ...)        (void)(cond)
#endif /* ENET_CFG_IS_ON(ASSERT) && ENET_CFG_IS_ON(DEV_ERROR) */

#define ENET_UTILS_COMPILETIME_ASSERT(cond)                 \
    do {                                                    \
        typedef char ErrorCheck[((cond) == true) ? 1 : -1]; \
        ErrorCheck a = {0};                                 \
        a[0U] = a[0U];                                      \
    } while (0)

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

typedef void (*Enet_Print)(const char *fmt, ...);

typedef uint64_t (*Enet_VirtToPhys)(const void *virtAddr, void *appData);

typedef void *(*Enet_PhysToVirt)(uint64_t phyAddr, void *appData);

typedef struct EnetUtils_Cfg_s
{
    Enet_Print print;

    Enet_VirtToPhys virtToPhys;

    Enet_PhysToVirt physToVirt;
} EnetUtils_Cfg;

/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */

/* None */

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

void EnetUtils_init(const EnetUtils_Cfg *cfg);

void EnetUtils_deinit(void);

void EnetUtils_printf(const char *fmt,
                      ...);

void EnetUtils_vprintf(const char *fmt,
                       va_list args);

uint32_t EnetUtils_min(uint32_t num1,
                       uint32_t num2);

uint32_t EnetUtils_max(uint32_t num1,
                       uint32_t num2);

void EnetUtils_delay(uint64_t delayInNsecs);

uint64_t EnetUtils_virtToPhys(const void *virtAddr,
                              void *appData);

void *EnetUtils_physToVirt(uint64_t physAddr,
                           void *appData);

#if ENET_CFG_IS_ON(ASSERT) && !defined(__KLOCWORK__)

static inline void EnetUtils_assertLocal(bool condition,
                                         const char *str,
                                         const char *fileName,
                                         int32_t lineNum);
#endif

EnetPhy_Mii EnetUtils_macToPhyMii(const EnetMacPort_Interface *macMii);

static inline void EnetUtils_copyMacAddr(uint8_t *dst,
                                         const uint8_t *src);

static inline bool EnetUtils_cmpMacAddr(const uint8_t *addr1,
                                        const uint8_t *addr2);

static inline void EnetUtils_clearMacAddr(uint8_t *addr);

static inline bool EnetUtils_isMcastAddr(const uint8_t *addr);

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

/* None */

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

#if ENET_CFG_IS_ON(ASSERT) && !defined(__KLOCWORK__)
static inline void EnetUtils_assertLocal(bool condition,
                                         const char *str,
                                         const char *fileName,
                                         int32_t lineNum)
{
    volatile static bool gEnetAssertWaitInLoop = true;

    if (!condition)
    {
        EnetUtils_printf("Assertion @ Line: %d in %s: %s\n", lineNum, fileName, str);
        while (gEnetAssertWaitInLoop)
        {
            /* Do nothing */
        }
    }
}
#endif

static inline void EnetUtils_copyMacAddr(uint8_t *dst,
                                         const uint8_t *src)
{
    memcpy(dst, src, ENET_MAC_ADDR_LEN);
}

static inline bool EnetUtils_cmpMacAddr(const uint8_t *addr1,
                                        const uint8_t *addr2)
{
    return (memcmp(addr1, addr2, ENET_MAC_ADDR_LEN) == 0U);
}

static inline void EnetUtils_clearMacAddr(uint8_t *addr)
{
    memset(addr, 0, ENET_MAC_ADDR_LEN);
}

static inline bool EnetUtils_isMcastAddr(const uint8_t *addr)
{
    return ((addr[0U] & 1U) == 1U);
}

#ifdef __cplusplus
}
#endif

#endif /* ENET_UTILS_H_ */