enet_soc.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_SOC_H_
#define ENET_SOC_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <include/core/enet_types.h>
#include <include/core/enet_base.h>
#include <kernel/dpl/DebugP.h>
 
#if defined(SOC_AM64X) || defined(SOC_AM243X)
#include <soc/k3/am64x_am243x/enet_soc.h>
#include <soc/k3/k3_soc.h>
#include <drivers/udma/soc/am64x_am243x/udma_soc.h>
#elif defined (SOC_AM273X)
#include <soc/am273x/enet_soc.h>
#elif defined(SOC_AWR294X)
#include <soc/awr294x/enet_soc.h>
#elif defined(SOC_AM263X)
#include <soc/am263x/enet_soc.h>
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
 
#if ENET_CFG_IS_ON(ASSERT)
#if defined(__KLOCWORK__) || defined(__cplusplus)
#define EnetSoc_assert(cond, ...)            do { if (!(cond)) abort(); } while (0)
#else /* !defined(__KLOCWORK__) && !defined(__cplusplus) */
#define EnetSoc_assert(cond, ...)                               \
    do {                                                        \
            DebugP_assert((bool)((cond)));                         \
    } while (0)
#endif /* defined(__KLOCWORK__) || defined(__cplusplus) */
#else /* !ENET_CFG_IS_ON(ASSERT) */
#define EnetSoc_assert(cond, ...)           (void)(cond)
#endif /* ENET_CFG_IS_ON(ASSERT) */
 
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t EnetSoc_init(void);
 
void EnetSoc_deinit(void);
 
EnetDma_Handle EnetSoc_getDmaHandle(Enet_Type enetType,
                                    uint32_t instId);
 
Enet_Handle EnetSoc_getEnetHandleByIdx(uint32_t idx);
 
Enet_Handle EnetSoc_getEnetHandle(Enet_Type enetType,
                                  uint32_t instId);
 
uint32_t EnetSoc_getCoreId(void);
 
uint32_t EnetSoc_getCoreKey(uint32_t coreId);
 
bool EnetSoc_isCoreAllowed(Enet_Type enetType,
                           uint32_t instId,
                           uint32_t coreId);
 
uint32_t EnetSoc_getEnetNum(void);
 
uint32_t EnetSoc_getMacPortMax(Enet_Type enetType,
                               uint32_t instId);
 
uint32_t EnetSoc_getClkFreq(Enet_Type enetType,
                            uint32_t instId,
                            uint32_t clkId);
 
int32_t EnetSoc_setupIntrCfg(Enet_Type enetType,
                             uint32_t instId,
                             uint32_t intrId);
 
int32_t EnetSoc_releaseIntrCfg(Enet_Type enetType,
                               uint32_t instId,
                               uint32_t intrId);
 
uint32_t EnetSoc_getIntrNum(Enet_Type enetType,
                            uint32_t instId,
                            uint32_t intrId);
 
uint32_t EnetSoc_getIntrTriggerType(Enet_Type enetType,
                                    uint32_t instId,
                                    uint32_t intrId);
 
int32_t EnetSoc_getEFusedMacAddrs(uint8_t macAddr[][ENET_MAC_ADDR_LEN],
                                  uint32_t *num);
 
uint32_t EnetSoc_getMacPortCaps(Enet_Type enetType,
                                uint32_t instId,
                                Enet_MacPort macPort);
 
int32_t EnetSoc_getMacPortMii(Enet_Type enetType,
                              uint32_t instId,
                              Enet_MacPort macPort,
                              EnetMacPort_Interface *mii);
uint32_t EnetSoc_isIpSupported(Enet_Type enetType,
                               uint32_t instId);
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ENET_SOC_H_ */