enet_per.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_PER_H_
#define ENET_PER_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <include/core/enet_types.h>
#include <include/core/enet_ioctl.h>
#include <include/core/enet_mod_macport.h>
#include <include/phy/enetphy.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
#define ENET_TO_PER(per)                      ((EnetPer_Handle)(per))
 
#define ENET_PER_NAME(per)                    (ENET_TO_PER(per)->name)
 
#define ENET_PER_PUBLIC_IOCTL(x)              (ENET_IOCTL_TYPE_PUBLIC | \
                                               ENET_IOCTL_PER_BASE |    \
                                               ENET_IOCTL_MIN(x))
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
enum EnetPer_Ioctl_e
{
    ENET_PER_IOCTL_GET_VERSION = ENET_PER_PUBLIC_IOCTL(0U),
 
    ENET_PER_IOCTL_PRINT_REGS = ENET_PER_PUBLIC_IOCTL(1U),
 
    ENET_PER_IOCTL_OPEN_PORT_LINK = ENET_PER_PUBLIC_IOCTL(2U),
 
    ENET_PER_IOCTL_CLOSE_PORT_LINK = ENET_PER_PUBLIC_IOCTL(3U),
 
    ENET_PER_IOCTL_IS_PORT_LINK_UP = ENET_PER_PUBLIC_IOCTL(4U),
 
    ENET_PER_IOCTL_GET_PORT_LINK_CFG = ENET_PER_PUBLIC_IOCTL(5U),
 
    ENET_PER_IOCTL_ATTACH_CORE = ENET_PER_PUBLIC_IOCTL(6U),
 
    ENET_PER_IOCTL_DETACH_CORE = ENET_PER_PUBLIC_IOCTL(7U),
 
    ENET_IOCTL_REGISTER_RX_DEFAULT_FLOW = ENET_PER_PUBLIC_IOCTL(8U),
 
    ENET_IOCTL_UNREGISTER_RX_DEFAULT_FLOW = ENET_PER_PUBLIC_IOCTL(9U),
 
    ENET_IOCTL_REGISTER_DSTMAC_RX_FLOW = ENET_PER_PUBLIC_IOCTL(10U),
 
    ENET_IOCTL_UNREGISTER_DSTMAC_RX_FLOW = ENET_PER_PUBLIC_IOCTL(11U),
 
    ENET_PER_IOCTL_SET_VLAN_AWARE = ENET_PER_PUBLIC_IOCTL(12U),
 
    ENET_PER_IOCTL_SET_VLAN_UNAWARE = ENET_PER_PUBLIC_IOCTL(13U),
 
    ENET_PER_IOCTL_HANDLE_EXTPHY_LINKUP_EVENT = ENET_PER_PUBLIC_IOCTL(14U),
 
    ENET_PER_IOCTL_HANDLE_EXTPHY_LINKDOWN_EVENT = ENET_PER_PUBLIC_IOCTL(15U),
 
    ENET_PER_IOCTL_REGISTER_IOCTL_HANDLER = ENET_PER_PUBLIC_IOCTL(16U),
 
    ENET_PER_IOCTL_SET_ISOLATE_STATE = ENET_PER_PUBLIC_IOCTL(17U),
 
    ENET_PER_IOCTL_CLEAR_ISOLATE_STATE = ENET_PER_PUBLIC_IOCTL(17U),
 
};
 
typedef struct Enet_DfltFlowInfo_s
{
    uint32_t coreKey;
 
    uint32_t chIdx;
 
    uint32_t startIdx;
 
    uint32_t flowIdx;
} Enet_DfltFlowInfo;
 
typedef struct Enet_MacDstFlowInfo_s
{
    uint32_t coreKey;
 
    uint32_t startIdx;
 
    uint32_t flowIdx;
 
    uint8_t macAddress[ENET_MAC_ADDR_LEN];
} Enet_MacDstFlowInfo;
 
typedef struct EnetPer_PortLinkCfg_s
{
    Enet_MacPort macPort;
 
    void *macCfg;
 
    EnetPhy_Cfg phyCfg;
 
    EnetMacPort_Interface mii;
 
    EnetMacPort_LinkCfg linkCfg;
} EnetPer_PortLinkCfg;
 
typedef struct EnetPer_AttachCoreOutArgs_s
{
    uint32_t coreKey;
 
    uint32_t rxMtu;
 
    uint32_t txMtu[ENET_PRI_NUM];
} EnetPer_AttachCoreOutArgs;
 
 
typedef struct Enet_ExtPhyLinkUpEventInfo_s
{
    Enet_MacPort macPort;
 
    EnetPhy_LinkCfg phyLinkCfg;
} Enet_ExtPhyLinkUpEventInfo;
 
typedef struct Enet_IoctlRegisterHandlerInArgs_s
{
    uint32_t cmd;
 
    uintptr_t fxn;
} Enet_IoctlRegisterHandlerInArgs;
 
typedef struct EnetPer_Obj_s *EnetPer_Handle;
 
typedef void (* const EnetPer_InitCfg)(EnetPer_Handle hPer,
                                Enet_Type enetType,
                                void *cfg,
                                uint32_t cfgSize);
 
typedef int32_t (* const EnetPer_Open)(EnetPer_Handle hPer,
                                Enet_Type enetType,
                                uint32_t instId,
                                const void *cfg,
                                uint32_t cfgSize);
 
typedef int32_t (* const EnetPer_Rejoin)(EnetPer_Handle hPer,
                                  Enet_Type enetType,
                                  uint32_t instId);
 
typedef int32_t (* const EnetPer_Ioctl)(EnetPer_Handle hPer,
                                 uint32_t cmd,
                                 Enet_IoctlPrms *prms);
 
typedef void (* const EnetPer_Poll)(EnetPer_Handle hPer,
                             Enet_Event evt,
                             const void *arg,
                             uint32_t argSize);
 
typedef uint64_t (* const EnetPer_ConvertTs)(EnetPer_Handle hPer,
                                      uint64_t ts);
 
typedef void (* const EnetPer_PeriodicTick)(EnetPer_Handle hPer);
 
typedef void (* const EnetPer_RegisterEventCb)(EnetPer_Handle hPer,
                                        Enet_Event evt,
                                        uint32_t evtNum,
                                        Enet_EventCallback evtCb,
                                        void *evtCbArgs);
 
typedef void (* const EnetPer_UnregisterEventCb)(EnetPer_Handle hPer,
                                          Enet_Event evt,
                                          uint32_t evtNum);
 
typedef void (* const EnetPer_Close)(EnetPer_Handle hPer);
 
typedef void (* const EnetPer_SaveCtxt)(EnetPer_Handle hPer);
 
typedef int32_t (* const EnetPer_RestoreCtxt)(EnetPer_Handle hPer,
                                              Enet_Type enetType,
                                              uint32_t instId);
 
typedef struct EnetPer_Obj_s
{
    const char *name;
 
    Enet_Type enetType;
 
    uint32_t instId;
 
    Enet_Magic magic;
 
    uint64_t physAddr;
 
    void *virtAddr;
 
    uint64_t physAddr2;
 
    void *virtAddr2;
 
    uint32_t features;
 
    uint32_t errata;
 
    EnetPer_InitCfg initCfg;
 
    EnetPer_Open open;
 
    EnetPer_Rejoin rejoin;
 
    EnetPer_Ioctl ioctl;
 
    EnetPer_Poll poll;
 
    EnetPer_ConvertTs convertTs;
 
    EnetPer_PeriodicTick periodicTick;
 
    EnetPer_RegisterEventCb registerEventCb;
 
    EnetPer_UnregisterEventCb unregisterEventCb;
 
    EnetPer_Close close;
 
    EnetPer_SaveCtxt saveCtxt;
 
    EnetPer_RestoreCtxt restoreCtxt;
} EnetPer_Obj;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ENET_PER_H_ */