enet.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_H_
#define ENET_H_

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

#include <stdint.h>
#include <stdbool.h>
#include <ti/drv/enet/enet_cfg.h>
#include <ti/drv/enet/include/core/enet_types.h>
#include <ti/drv/enet/include/core/enet_base.h>
#include <ti/drv/enet/include/core/enet_osal.h>
#include <ti/drv/enet/include/core/enet_utils.h>
#include <ti/drv/enet/include/core/enet_ioctl.h>
#include <ti/drv/enet/include/core/enet_trace.h>
#include <ti/drv/enet/include/core/enet_queue.h>
#include <ti/drv/enet/include/core/enet_soc.h>
#include <ti/drv/enet/include/core/enet_mod_fdb.h>
#include <ti/drv/enet/include/core/enet_mod_port.h>
#include <ti/drv/enet/include/core/enet_mod_timesync.h>
#include <ti/drv/enet/include/core/enet_mod_tas.h>
#include <ti/drv/enet/include/core/enet_mod_phy.h>
#include <ti/drv/enet/include/core/enet_dma.h>

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

/* None */

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

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

/* None */

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

uint32_t Enet_getCoreId(void);

EnetTrace_TraceLevel Enet_setTraceLevel(EnetTrace_TraceLevel level);

EnetTrace_TraceLevel Enet_getTraceLevel(void);

void Enet_initOsalCfg(EnetOsal_Cfg *osalCfg);

void Enet_initUtilsCfg(EnetUtils_Cfg *utilsCfg);

void Enet_init(const EnetOsal_Cfg *osalCfg,
               const EnetUtils_Cfg *utilsCfg);

void Enet_deinit(void);

Enet_Handle Enet_getHandle(Enet_Type enetType,
                           uint32_t instId);

uint32_t Enet_getMacPortMax(Enet_Type enetType,
                            uint32_t instId);

void Enet_initCfg(Enet_Type enetType,
                  uint32_t instId,
                  void *cfg,
                  uint32_t cfgSize);

Enet_Handle Enet_open(Enet_Type enetType,
                      uint32_t instId,
                      const void *cfg,
                      uint32_t cfgSize);

Enet_Handle Enet_rejoin(Enet_Type enetType,
                        uint32_t instId);

EnetDma_Handle Enet_getDmaHandle(Enet_Handle hEnet);

int32_t Enet_ioctl(Enet_Handle hEnet,
                   uint32_t coreId,
                   uint32_t cmd,
                   Enet_IoctlPrms *prms);

void Enet_registerEventCb(Enet_Handle hEnet,
                          Enet_Event evt,
                          uint32_t evtNum,
                          Enet_EventCallback evtCb,
                          void *evtCbArgs);

void Enet_unregisterEventCb(Enet_Handle hEnet,
                            Enet_Event evt,
                            uint32_t evtNum);

void Enet_poll(Enet_Handle hEnet,
               Enet_Event evt,
               const void *arg,
               uint32_t argSize);

void Enet_periodicTick(Enet_Handle hEnet);

uint32_t Enet_getMacPortCnt(Enet_Handle hEnet);

void Enet_close(Enet_Handle hEnet);

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

/* None */

#endif /* ENET_H_ */