cpsw_ale.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 CPSW_ALE_H_
#define CPSW_ALE_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <enet_cfg.h>
#include <include/core/enet_mod_fdb.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                                 Macros                                     */
/* ========================================================================== */
 
#define CPSW_ALE_PUBLIC_IOCTL(x)              (ENET_IOCTL_TYPE_PUBLIC | \
                                               ENET_IOCTL_FDB_BASE |    \
                                               ENET_IOCTL_PER_CPSW |    \
                                               ENET_IOCTL_MIN(x))
 
#define CPSW_ALE_PRIVATE_IOCTL(x)              (ENET_IOCTL_TYPE_PRIVATE | \
                                                ENET_IOCTL_FDB_BASE |    \
                                                ENET_IOCTL_PER_CPSW |    \
                                                ENET_IOCTL_MIN(x))
 
#define CPSW_ALE_NUM_MAC_PORTS                (CPSW_ALE_NUM_PORTS - 1U)
 
#define CPSW_ALE_MAX_WHITELIST_IP_NXT_HDR     (4U)
 
#define CPSW_ALE_ALL_PORTS_MASK               ((uint32_t)((1U << CPSW_ALE_NUM_PORTS) - 1U))
 
#define CPSW_ALE_ALL_MACPORTS_MASK            ((uint32_t)(((1U << CPSW_ALE_NUM_PORTS) - 1U) - 1U))
 
#define CPSW_ALE_HOST_PORT_MASK               (ENET_BIT(0))
 
#define CPSW_ALE_HOST_PORT_NUM                (0U)
 
#define CPSW_ALE_MACPORT_BASE                 (1U)
 
#define CPSW_ALE_MACPORT_TO_ALEPORT(macPortNum)      (ENET_MACPORT_NORM(macPortNum) + CPSW_ALE_MACPORT_BASE)
 
#define CPSW_ALE_ALEPORT_TO_MACPORT(alePortNum)      (ENET_MACPORT_DENORM(alePortNum - CPSW_ALE_MACPORT_BASE))
 
#define CPSW_ALE_MACPORT_TO_PORTMASK(macPort)        (ENET_BIT(CPSW_ALE_MACPORT_TO_ALEPORT(macPort)))
 
#define CPSW_ALE_MCAST_IGN_BITS_MAX           (10U)
 
#define CPSW_ALE_PEAKBITRATE_DISABLE          (0U)
 
#define CPSW_ALE_COMMITBITRATE_DISABLE        (0U)
 
#define CPSW_ALE_THREADID_INVALID             (~0U)
 
#define CPSW_ALE_MAX_TABLE_ENTRY_SAVED         50U
 
#define CPSW_ALE_MAX_POLICER_ENTRY_SAVED       64U
 
#define CPSW_ALE_CFG_MODULE_EN                (ENET_BIT(0U))
 
#define CPSW_ALE_CFG_BYPASS_EN                (ENET_BIT(1U))
 
#define CPSW_ALE_CFG_UNKNOWN_UCAST_FLOOD2HOST (ENET_BIT(2U))
 
#define CPSW_ALE_CFG_MULTIHOST                (ENET_BIT(3U))
 
#define CPSW_ALE_POLICER_MATCH_PORT           (ENET_BIT(0U))
 
#define CPSW_ALE_POLICER_MATCH_PRIORITY       (ENET_BIT(1U))
 
#define CPSW_ALE_POLICER_MATCH_OUI            (ENET_BIT(2U))
 
#define CPSW_ALE_POLICER_MATCH_MACDST         (ENET_BIT(3U))
 
#define CPSW_ALE_POLICER_MATCH_MACSRC         (ENET_BIT(4U))
 
#define CPSW_ALE_POLICER_MATCH_OVLAN          (ENET_BIT(5U))
 
#define CPSW_ALE_POLICER_MATCH_IVLAN          (ENET_BIT(6U))
 
#define CPSW_ALE_POLICER_MATCH_ETHERTYPE      (ENET_BIT(7U))
 
#define CPSW_ALE_POLICER_MATCH_IPSRC          (ENET_BIT(8U))
 
#define CPSW_ALE_POLICER_MATCH_IPDST          (ENET_BIT(9U))
 
#define CPSW_ALE_POLICER_TABLE_PART_MAX        (5U)
 
#define CPSW_ALE_POLICER_TABLEENTRY_DELETE_OUI       (CPSW_ALE_POLICER_MATCH_PRIORITY)
 
#define CPSW_ALE_POLICER_TABLEENTRY_DELETE_MACSRC    (CPSW_ALE_POLICER_MATCH_MACSRC)
 
#define CPSW_ALE_POLICER_TABLEENTRY_DELETE_MACDST    (CPSW_ALE_POLICER_MATCH_MACDST)
 
#define CPSW_ALE_POLICER_TABLEENTRY_DELETE_IVLAN     (CPSW_ALE_POLICER_MATCH_IVLAN)
 
#define CPSW_ALE_POLICER_TABLEENTRY_DELETE_OVLAN     (CPSW_ALE_POLICER_MATCH_OVLAN)
 
#define CPSW_ALE_POLICER_TABLEENTRY_DELETE_ETHERTYPE (CPSW_ALE_POLICER_MATCH_ETHERTYPE)
 
#define CPSW_ALE_POLICER_TABLEENTRY_DELETE_IPSRC     (CPSW_ALE_POLICER_MATCH_IPSRC)
 
#define CPSW_ALE_POLICER_TABLEENTRY_DELETE_IPDST     (CPSW_ALE_POLICER_MATCH_IPDST)
 
#define CPSW_ALE_POLICER_TABLEENTRY_DELETE_ALL       (CPSW_ALE_POLICER_TABLEENTRY_DELETE_OUI |       \
                                                      CPSW_ALE_POLICER_TABLEENTRY_DELETE_MACSRC |    \
                                                      CPSW_ALE_POLICER_TABLEENTRY_DELETE_MACDST |    \
                                                      CPSW_ALE_POLICER_TABLEENTRY_DELETE_IVLAN |     \
                                                      CPSW_ALE_POLICER_TABLEENTRY_DELETE_OVLAN |     \
                                                      CPSW_ALE_POLICER_TABLEENTRY_DELETE_ETHERTYPE | \
                                                      CPSW_ALE_POLICER_TABLEENTRY_DELETE_IPSRC |     \
                                                      CPSW_ALE_POLICER_TABLEENTRY_DELETE_IPDST)
 
/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */
 
typedef enum CpswAle_Ioctl_e
{
    CPSW_ALE_IOCTL_DUMP_TABLE = CPSW_ALE_PUBLIC_IOCTL(0U),
 
    CPSW_ALE_IOCTL_ADD_UCAST = CPSW_ALE_PUBLIC_IOCTL(1U),
 
    CPSW_ALE_IOCTL_ADD_MCAST = CPSW_ALE_PUBLIC_IOCTL(2U),
 
    CPSW_ALE_IOCTL_ADD_VLAN = CPSW_ALE_PUBLIC_IOCTL(3U),
 
    CPSW_ALE_IOCTL_ADD_OUI = CPSW_ALE_PUBLIC_IOCTL(4U),
 
    CPSW_ALE_IOCTL_ADD_IPV4ADDR = CPSW_ALE_PUBLIC_IOCTL(5U),
 
    CPSW_ALE_IOCTL_ADD_IPV6ADDR = CPSW_ALE_PUBLIC_IOCTL(6U),
 
    CPSW_ALE_IOCTL_ADD_ETHERTYPE = CPSW_ALE_PUBLIC_IOCTL(7U),
 
    CPSW_ALE_IOCTL_LOOKUP_UCAST = CPSW_ALE_PUBLIC_IOCTL(8U),
 
    CPSW_ALE_IOCTL_LOOKUP_MCAST = CPSW_ALE_PUBLIC_IOCTL(9U),
 
    CPSW_ALE_IOCTL_LOOKUP_VLAN = CPSW_ALE_PUBLIC_IOCTL(10U),
 
    CPSW_ALE_IOCTL_REMOVE_ADDR = CPSW_ALE_PUBLIC_IOCTL(11U),
 
    CPSW_ALE_IOCTL_REMOVE_VLAN = CPSW_ALE_PUBLIC_IOCTL(12U),
 
    CPSW_ALE_IOCTL_REMOVE_OUI = CPSW_ALE_PUBLIC_IOCTL(13U),
 
    CPSW_ALE_IOCTL_REMOVE_IPV4ADDR = CPSW_ALE_PUBLIC_IOCTL(14U),
 
    CPSW_ALE_IOCTL_REMOVE_IPV6ADDR = CPSW_ALE_PUBLIC_IOCTL(15U),
 
    CPSW_ALE_IOCTL_REMOVE_ETHERTYPE = CPSW_ALE_PUBLIC_IOCTL(16U),
 
    CPSW_ALE_IOCTL_REMOVE_LEARNED_ENTRIES = CPSW_ALE_PUBLIC_IOCTL(17U),
 
    CPSW_ALE_IOCTL_REMOVE_ALL_ENTRIES = CPSW_ALE_PUBLIC_IOCTL(18U),
 
    CPSW_ALE_IOCTL_AGE_ALL_ENTRIES = CPSW_ALE_PUBLIC_IOCTL(19U),
 
    CPSW_ALE_IOCTL_SET_RX_FILTER = CPSW_ALE_PUBLIC_IOCTL(20U),
 
    CPSW_ALE_IOCTL_GET_RX_FILTER = CPSW_ALE_PUBLIC_IOCTL(21U),
 
    CPSW_ALE_IOCTL_SET_PORT_STATE = CPSW_ALE_PUBLIC_IOCTL(22U),
 
    CPSW_ALE_IOCTL_GET_PORT_STATE = CPSW_ALE_PUBLIC_IOCTL(23U),
 
    CPSW_ALE_IOCTL_GET_PORT_MACADDR = CPSW_ALE_PUBLIC_IOCTL(24U),
 
    CPSW_ALE_IOCTL_SET_DEFAULT_THREADCFG = CPSW_ALE_PUBLIC_IOCTL(25U),
 
    CPSW_ALE_IOCTL_GET_DEFAULT_THREADCFG = CPSW_ALE_PUBLIC_IOCTL(26U),
 
    CPSW_ALE_IOCTL_SET_PORT_MIRROR_CFG = CPSW_ALE_PUBLIC_IOCTL(27U),
 
    CPSW_ALE_IOCTL_DISABLE_PORT_MIRROR = CPSW_ALE_PUBLIC_IOCTL(28U),
 
    CPSW_ALE_IOCTL_SET_TRUNK_CFG = CPSW_ALE_PUBLIC_IOCTL(29U),
 
    CPSW_ALE_IOCTL_SET_OAMLPBK_CFG = CPSW_ALE_PUBLIC_IOCTL(30U),
 
    CPSW_ALE_IOCTL_SET_BCAST_MCAST_LIMIT = CPSW_ALE_PUBLIC_IOCTL(31U),
 
    CPSW_ALE_IOCTL_GET_BCAST_MCAST_LIMIT = CPSW_ALE_PUBLIC_IOCTL(32U),
 
    CPSW_ALE_IOCTL_DISABLE_BCAST_MCAST_LIMIT = CPSW_ALE_PUBLIC_IOCTL(33U),
 
    CPSW_ALE_IOCTL_SET_POLICER = CPSW_ALE_PUBLIC_IOCTL(34U),
 
    CPSW_ALE_IOCTL_GET_POLICER = CPSW_ALE_PUBLIC_IOCTL(35U),
 
    CPSW_ALE_IOCTL_DEL_POLICER = CPSW_ALE_PUBLIC_IOCTL(36U),
 
    CPSW_ALE_IOCTL_DUMP_POLICER_ENTRIES = CPSW_ALE_PUBLIC_IOCTL(37U),
 
    CPSW_ALE_IOCTL_GET_POLICER_STATS = CPSW_ALE_PUBLIC_IOCTL(38U),
 
    CPSW_ALE_IOCTL_SET_POLICER_THREADCFG = CPSW_ALE_PUBLIC_IOCTL(39U),
 
    CPSW_ALE_IOCTL_SET_POLICER_GLOBAL_CFG = CPSW_ALE_PUBLIC_IOCTL(40U),
 
    CPSW_ALE_IOCTL_GET_POLICER_GLOBAL_CFG = CPSW_ALE_PUBLIC_IOCTL(41U),
 
    CPSW_ALE_IOCTL_DEL_ALL_POLICER_THREADID = CPSW_ALE_PUBLIC_IOCTL(42U),
 
    CPSW_ALE_IOCTL_BLOCK_CLASSIFIER_HOSTPORT = CPSW_ALE_PUBLIC_IOCTL(43U),
 
    CPSW_ALE_IOCTL_SET_INTERVLAN_CFG = CPSW_ALE_PUBLIC_IOCTL(44U),
 
    CPSW_ALE_IOCTL_GET_INTERVLAN_CFG = CPSW_ALE_PUBLIC_IOCTL(45U),
 
    CPSW_ALE_IOCTL_SET_POLICER_IN_PARTITION = CPSW_ALE_PUBLIC_IOCTL(46U),
 
} CpswAle_Ioctl;
 
 
 
typedef enum CpswAle_PortState_e
{
    CPSW_ALE_PORTSTATE_DISABLED = 0U,
 
    CPSW_ALE_PORTSTATE_BLOCKED,
 
    CPSW_ALE_PORTSTATE_LEARN,
 
    CPSW_ALE_PORTSTATE_FORWARD,
} CpswAle_PortState;
 
typedef enum CpswAle_FwdStateLevel_e
{
    CPSW_ALE_FWDSTLVL_FWD  = 0U,
 
    CPSW_ALE_FWDSTLVL_BLK_FWD_LRN,
 
    CPSW_ALE_FWDSTLVL_FWD_LRN,
} CpswAle_FwdStateLevel;
 
typedef enum CpswAle_RxFilter_e
{
    CPSW_ALE_RXFILTER_NOTHING = 0U,
 
    CPSW_ALE_RXFILTER_DIRECT,
 
    CPSW_ALE_RXFILTER_BCAST,
 
    CPSW_ALE_RXFILTER_MCAST,
 
    CPSW_ALE_RXFILTER_ALLMCAST,
 
    CPSW_ALE_RXFILTER_ALL,
} CpswAle_RxFilter;
 
typedef enum CpswAle_PolicerPartLevel_e
{
    CPSW_ALE_POLICER_PARTITION_LEVEL_1 = 0U,
    CPSW_ALE_POLICER_PARTITION_LEVEL_2,
    CPSW_ALE_POLICER_PARTITION_LEVEL_3,
    CPSW_ALE_POLICER_PARTITION_LEVEL_4,
    CPSW_ALE_POLICER_PARTITION_DEFAULT
} CpswAle_PolicerPartLevel;
 
typedef struct CpswAle_MacAddrInfo_s
{
    uint8_t addr[ENET_MAC_ADDR_LEN];
 
    uint32_t vlanId;
} CpswAle_MacAddrInfo;
 
typedef struct CpswAle_UcastEntryInfo_s
{
    uint32_t portNum;
 
    bool blocked;
 
    bool secure;
 
    bool super;
 
    bool ageable;
 
    bool trunk;
} CpswAle_UcastEntryInfo;
 
typedef struct CpswAle_SetUcastEntryInArgs_s
{
    CpswAle_MacAddrInfo addr;
 
    CpswAle_UcastEntryInfo info;
} CpswAle_SetUcastEntryInArgs;
 
typedef struct CpswAle_GetUcastEntryOutArgs_s
{
    CpswAle_UcastEntryInfo info;
 
    bool touched;
 
    uint32_t aleEntryIdx;
} CpswAle_GetUcastEntryOutArgs;
 
typedef struct CpswAle_McastEntryInfo_s
{
    bool super;
 
    CpswAle_FwdStateLevel fwdState;
 
    uint32_t portMask;
 
    uint32_t numIgnBits;
} CpswAle_McastEntryInfo;
 
typedef struct CpswAle_SetMcastEntryInArgs_s
{
    CpswAle_MacAddrInfo addr;
 
    CpswAle_McastEntryInfo info;
} CpswAle_SetMcastEntryInArgs;
 
typedef struct CpswAle_GetMcastEntryInArgs_s
{
    CpswAle_MacAddrInfo addr;
 
    uint32_t numIgnBits;
} CpswAle_GetMcastEntryInArgs;
 
typedef struct CpswAle_GetMcastEntryOutArgs_s
{
    CpswAle_McastEntryInfo info;
 
    uint32_t aleEntryIdx;
} CpswAle_GetMcastEntryOutArgs;
 
typedef struct CpswAle_VlanIdInfo_s
{
    uint32_t vlanId;
 
    Enet_VlanTagType tagType;
} CpswAle_VlanIdInfo;
 
typedef struct CpswAle_VlanEntryInfo_s
{
    CpswAle_VlanIdInfo vlanIdInfo;
 
    uint32_t vlanMemberList;
 
    uint32_t unregMcastFloodMask;
 
    uint32_t regMcastFloodMask;
 
    uint32_t forceUntaggedEgressMask;
 
    uint32_t noLearnMask;
 
    bool vidIngressCheck;
 
    bool limitIPNxtHdr;
 
    bool disallowIPFrag;
} CpswAle_VlanEntryInfo;
 
typedef struct CpswAle_GetVlanEntryOutArgs_s
{
    uint32_t vlanMemberList;
 
    uint32_t unregMcastFloodMask;
 
    uint32_t regMcastFloodMask;
 
    uint32_t forceUntaggedEgressMask;
 
    uint32_t noLearnMask;
 
    bool vidIngressCheck;
 
    bool limitIPNxtHdr;
 
    bool disallowIPFrag;
 
    uint32_t aleEntryIdx;
} CpswAle_GetVlanEntryOutArgs;
 
typedef struct CpswAle_OuiEntryInfo_s
{
    uint8_t ouiAddr[ENET_OUI_ADDR_LEN];
} CpswAle_OuiEntryInfo;
 
typedef struct CpswAle_IPv4EntryInfo_s
{
    uint8_t ipv4Addr[ENET_IPv4_ADDR_LEN];
 
    uint32_t numLSBIgnoreBits;
} CpswAle_IPv4EntryInfo;
 
typedef struct CpswAle_IPv6EntryInfo_s
{
    uint8_t ipv6Addr[ENET_IPv6_ADDR_LEN];
 
    uint32_t numLSBIgnoreBits;
} CpswAle_IPv6EntryInfo;
 
typedef struct CpswAle_SetPortStateInArgs_s
{
    uint32_t portNum;
 
    CpswAle_PortState portState;
} CpswAle_SetPortStateInArgs;
 
typedef struct CpswAle_GetPortMacAddrInArgs_s
{
    uint32_t portNum;
 
    CpswAle_MacAddrInfo *addrs;
 
    uint32_t addrCnt;
} CpswAle_GetPortMacAddrInArgs;
 
typedef struct CpswAle_GetPortMacAddrOutArgs_s
{
    CpswAle_MacAddrInfo *addrs;
 
    uint32_t addrCnt;
 
    uint32_t totalAddrCnt;
} CpswAle_GetPortMacAddrOutArgs;
 
typedef struct CpswAle_DefaultThreadCfg_s
{
    bool dfltThreadEn;
 
    uint32_t threadId;
 
    bool priorityOrEn;
 
    bool macPortDfltThreadDis;
} CpswAle_DfltThreadCfg;
 
typedef enum CpswAle_TableEntryType_s
{
    CPSW_ALE_TABLE_ENTRY_TYPE_ADDR,
 
    CPSW_ALE_TABLE_ENTRY_TYPE_VLAN,
 
    CPSW_ALE_TABLE_ENTRY_TYPE_ETHERTYPE,
 
    CPSW_ALE_TABLE_ENTRY_TYPE_OUI,
 
    CPSW_ALE_TABLE_ENTRY_TYPE_IPV4,
 
    CPSW_ALE_TABLE_ENTRY_TYPE_IPV6
} CpswAle_TableEntryType;
 
typedef struct CpswAle_MacAddrClassifierInfo_s
{
    CpswAle_MacAddrInfo addr;
 
    uint32_t portNum;
} CpswAle_MacAddrClassifierInfo;
 
typedef struct CpswAle_MirrorMatchParams_s
{
    CpswAle_TableEntryType entryType;
 
    CpswAle_MacAddrClassifierInfo dstMacAddrInfo;
 
    CpswAle_VlanIdInfo vlanIdInfo;
 
    CpswAle_IPv4EntryInfo ipv4Info;
 
    CpswAle_IPv6EntryInfo ipv6Info;
 
    CpswAle_OuiEntryInfo ouiInfo;
 
    uint16_t etherType;
} CpswAle_MirrorMatchParams;
 
typedef struct CpswAle_PortMirroringCfg_s
{
    bool srcEn;
 
    bool dstEnEn;
 
    bool matchEn;
 
    uint32_t dstPortNum;
 
    uint32_t toPortNum;
 
    CpswAle_MirrorMatchParams matchParams;
 
    uint32_t srcPortNumMask;
} CpswAle_PortMirroringCfg;
 
typedef struct CpswAle_TrunkCfg_s
{
    uint32_t trunkId;
 
    uint32_t numPorts;
 
    uint32_t trunkPortIdx[CPSW_ALE_NUM_PORTS];
 
    uint32_t trunkHashBase;
 
    bool dstIPEn;
 
    bool srcIPEn;
 
    bool innerVlanEn;
 
    bool enablePri;
 
    bool srcEn;
 
    bool dstEnEn;
} CpswAle_TrunkCfg;
 
typedef struct CpswAle_PortBcastMcastRateLimitParams_s
{
    uint32_t portNum;
 
    bool bcastRateLimitForPortEn;
 
    bool mcastRateLimitForPortEn;
 
    uint32_t bcastLimitNumPktsPerSec;
 
    uint32_t mcastLimitNumPktsPerSec;
} CpswAle_PortBcastMcastRateLimitParams;
 
typedef struct CpswAle_SetBcastMcastRateLimitInArgs_s
{
    bool rateLimitAtTxPort;
 
    uint32_t numPorts;
 
    CpswAle_PortBcastMcastRateLimitParams portPrms[CPSW_ALE_NUM_PORTS];
} CpswAle_SetBcastMcastRateLimitInArgs;
 
typedef struct CpswAle_GetBcastMcastRateLimitOutArgs_s
{
    bool rateLimitEn;
 
    bool rateLimitAtTxPort;
 
    uint32_t numPorts;
 
    CpswAle_PortBcastMcastRateLimitParams portPrms[CPSW_ALE_NUM_PORTS];
} CpswAle_GetBcastMcastRateLimitOutArgs;
 
typedef enum CpswAle_IpAddrClassifierType_e
{
    CPSW_ALE_IPADDR_CLASSIFIER_IPV4 = 0x00U,
 
    CPSW_ALE_IPADDR_CLASSIFIER_IPV6 = 0x01U,
} CpswAle_IpAddrClassifierType;
 
typedef struct CpswAle_IpAddrClassifierInfo_s
{
    CpswAle_IpAddrClassifierType ipAddrType;
 
    CpswAle_IPv4EntryInfo ipv4Info;
 
    CpswAle_IPv6EntryInfo ipv6Info;
} CpswAle_IpAddrClassifierInfo;
 
typedef struct CpswAle_PolicerMatchParams_s
{
    uint32_t policerMatchEnMask;
 
    uint32_t portNum;
 
    bool portIsTrunk;
 
    uint32_t priority;
 
    CpswAle_OuiEntryInfo ouiInfo;
 
    CpswAle_MacAddrClassifierInfo srcMacAddrInfo;
 
    CpswAle_MacAddrClassifierInfo dstMacAddrInfo;
 
    uint32_t ivlanId;
 
    uint32_t ovlanId;
 
    uint16_t etherType;
 
    CpswAle_IpAddrClassifierInfo srcIpInfo;
 
    CpswAle_IpAddrClassifierInfo dstIpInfo;
} CpswAle_PolicerMatchParams;
 
typedef struct CpswAle_SetPolicerEntryInArgs_s
{
    CpswAle_PolicerMatchParams policerMatch;
 
    bool threadIdEn;
 
    uint32_t threadId;
 
    uint32_t peakRateInBitsPerSec;
 
    uint32_t commitRateInBitsPerSec;
} CpswAle_SetPolicerEntryInArgs;
 
typedef struct CpswAle_SetPolicerEntryInPartitionInArgs_s
{
    CpswAle_PolicerMatchParams policerMatch;
 
    bool threadIdEn;
 
    uint32_t threadId;
 
    uint32_t peakRateInBitsPerSec;
 
    uint32_t commitRateInBitsPerSec;
 
    CpswAle_PolicerPartLevel policerPartLevel;
} CpswAle_SetPolicerEntryInPartitionInArgs;
 
typedef struct CpswAle_SetPolicerEntryOutArgs_s
{
    uint32_t ouiAleEntryIdx;
 
    uint32_t srcMacAleEntryIdx;
 
    uint32_t dstMacAleEntryIdx;
 
    uint32_t ivlanAleEntryIdx;
 
    uint32_t ovlanAleEntryIdx;
 
    uint32_t etherTypeAleEntryIdx;
 
    uint32_t srcIpAleEntryIdx;
 
    uint32_t dstIpAleEntryIdx;
 
    uint32_t policerEntryIdx;
} CpswAle_SetPolicerEntryOutArgs;
 
typedef struct CpswAle_PolicerEntryOutArgs_s
{
    uint32_t policerMatchEnMask;
 
    uint32_t port;
 
    bool portIsTrunk;
 
    uint32_t priority;
 
    uint32_t ouiAleEntryIdx;
 
    uint32_t srcMacAleEntryIdx;
 
    uint32_t dstMacAleEntryIdx;
 
    uint32_t ivlanAleEntryIdx;
 
    uint32_t ovlanAleEntryIdx;
 
    uint32_t etherTypeAleEntryIdx;
 
    uint32_t srcIpAleEntryIdx;
 
    uint32_t dstIpAleEntryIdx;
 
    bool threadIdEn;
 
    uint32_t threadId;
 
    uint32_t peakRateInBitsPerSec;
 
    uint32_t commitRateInBitsPerSec;
 
    uint32_t policerEntryIdx;
 
    bool egressOpEn;
 
    uint32_t egressOpcode;
 
    bool ttlCheckEn;
 
    uint32_t egressTrunkIdx;
 
    uint32_t dstPortMask;
} CpswAle_PolicerEntryOutArgs;
 
typedef struct CpswAle_DelPolicerEntryInArgs_s
{
    CpswAle_PolicerMatchParams policerMatch;
 
    uint32_t aleEntryMask;
} CpswAle_DelPolicerEntryInArgs;
 
typedef struct CpswAle_GetPolicerStatsInArgs_s
{
    CpswAle_PolicerMatchParams policerInfo;
 
    bool clearStats;
} CpswAle_GetPolicerStatsInArgs;
 
typedef struct CpswAle_GetPolicerStatsOutArgs_s
{
    bool policerHit;
 
    bool policerRedHit;
 
    bool policerYellowHit;
} CpswAle_GetPolicerStatsOutArgs;
 
typedef struct CpswAle_SetPolicerThreadCfgInArgs_s
{
    CpswAle_PolicerMatchParams policerMatch;
 
    bool threadIdEn;
 
    uint32_t threadId;
} CpswAle_SetPolicerThreadCfgInArgs;
 
typedef enum CpswAle_PolicerYellowThresh_e
{
    CPSW_ALE_POLICER_YELLOWTHRESH_DROP_PERCENT_100,
 
    CPSW_ALE_POLICER_YELLOWTHRESH_DROP_PERCENT_50,
 
    CPSW_ALE_POLICER_YELLOWTHRESH_DROP_PERCENT_33,
 
    CPSW_ALE_POLICER_YELLOWTHRESH_DROP_PERCENT_25,
 
    CPSW_ALE_POLICER_YELLOWTHRESH_DROP_PERCENT_20,
 
    CPSW_ALE_POLICER_YELLOWTHRESH_DROP_PERCENT_17,
 
    CPSW_ALE_POLICER_YELLOWTHRESH_DROP_PERCENT_14,
 
    CPSW_ALE_POLICER_YELLOWTHRESH_DROP_PERCENT_13,
} CpswAle_PolicerYellowThresh;
 
typedef enum CpswAle_PolicerNoMatchMode_e
{
    CPSW_ALE_POLICER_NOMATCH_MODE_GREEN,
 
    CPSW_ALE_POLICER_NOMATCH_MODE_YELLOW,
 
    CPSW_ALE_POLICER_NOMATCH_MODE_RED,
 
    CPSW_ALE_POLICER_NOMATCH_MODE_UNREGULATED_TRAFFIC_POLICER,
} CpswAle_PolicerNoMatchMode;
 
typedef struct CpswAle_UnregulatedTrafficPolicer_s
{
    uint32_t peakRateInBitsPerSec;
 
    uint32_t commitRateInBitsPerSec;
} CpswAle_UnregulatedTrafficPolicer;
 
typedef struct CpswAle_PolicerGlobalCfg_s
{
    bool policingEn;
 
    bool yellowDropEn;
 
    bool redDropEn;
 
    CpswAle_PolicerYellowThresh yellowThresh;
 
    CpswAle_PolicerNoMatchMode policerNoMatchMode;
 
    CpswAle_UnregulatedTrafficPolicer noMatchPolicer;
} CpswAle_PolicerGlobalCfg;
 
typedef struct CpswAle_SetInterVlanCfgInArgs_s
{
    CpswAle_PolicerMatchParams policerMatch;
 
    bool ttlCheckEn;
 
    uint32_t dstPortMask;
 
    uint32_t routeIdx;
 
    uint32_t egressTrunkIdx;
} CpswAle_SetInterVlanCfgInArgs;
 
typedef struct CpswAle_AgingCfg_s
{
    bool autoAgingEn;
 
    uint32_t agingPeriodInMs;
} CpswAle_AgingCfg;
 
typedef struct CpswAle_InitVlanCfg_s
{
    bool aleVlanAwareMode;
 
    bool cpswVlanAwareMode;
 
    bool autoLearnWithVlan;
 
    bool unknownVlanNoLearn;
 
    uint32_t unknownForceUntaggedEgressMask;
 
    uint32_t unknownRegMcastFloodMask;
 
    uint32_t unknownUnregMcastFloodMask;
 
    uint32_t unknownVlanMemberListMask;
} CpswAle_InitVlanCfg;
 
typedef struct CpswAle_MalformedPktSecurityCfg_s
{
    bool srcMcastDropDis;
 
    bool badLenPktDropEn;
} CpswAle_MalformedPktSecurityCfg;
 
typedef struct CpswAle_IPPktSecurityCfg_s
{
    bool dfltNoFragEn;
 
    bool dfltNxtHdrWhitelistEn;
 
    uint32_t ipNxtHdrWhitelistCnt;
 
    uint8_t ipNxtHdrWhitelist[CPSW_ALE_MAX_WHITELIST_IP_NXT_HDR];
} CpswAle_IPPktSecurityCfg;
 
typedef struct CpswAle_MacAuthCfg_s
{
    bool authModeEn;
 
    uint32_t macAuthDisMask;
} CpswAle_MacAuthCfg;
 
typedef struct CpswAle_NetworkSecurityCfg_s
{
    bool hostOuiNoMatchDeny;
 
    bool vid0ModeEn;
 
    CpswAle_MalformedPktSecurityCfg malformedPktCfg;
 
    CpswAle_IPPktSecurityCfg ipPktCfg;
 
    CpswAle_MacAuthCfg macAuthCfg;
} CpswAle_NetworkSecurityCfg;
 
typedef struct CpswAle_PortLearningSecurityCfg_s
{
    bool noLearn;
 
    bool noSaUpdateEn;
} CpswAle_PortLearningSecurityCfg;
 
typedef struct CpswAle_PortVlanSecurityCfg_s
{
    bool vidIngressCheck;
 
    bool dropUntagged;
 
    bool dropDualVlan;
 
    bool dropDoubleVlan;
} CpswAle_PortVlanSecurityCfg;
 
typedef struct CpswAle_PortMacModeCfg_s
{
    bool macOnlyCafEn;
 
    bool macOnlyEn;
} CpswAle_PortMacModeCfg;
 
typedef CpswAle_VlanEntryInfo CpswAle_PortVlanCfg;
 
typedef struct CpswAle_PortCfg_s
{
    CpswAle_PortLearningSecurityCfg learningCfg;
 
    CpswAle_PortVlanSecurityCfg vlanCfg;
 
    CpswAle_PortMacModeCfg macModeCfg;
 
    CpswAle_PortVlanCfg pvidCfg;
} CpswAle_PortCfg;
 
typedef struct CpswAle_Cfg_s
{
    uint32_t modeFlags;
 
    CpswAle_PolicerGlobalCfg policerGlobalCfg;
 
    CpswAle_AgingCfg agingCfg;
 
    CpswAle_InitVlanCfg vlanCfg;
 
    CpswAle_NetworkSecurityCfg nwSecCfg;
 
    CpswAle_PortCfg portCfg[CPSW_ALE_NUM_PORTS];
 
    uint32_t policerTablePartSize[CPSW_ALE_POLICER_TABLE_PART_MAX];
} CpswAle_Cfg;
 
/* ========================================================================== */
/*                         Global Variables Declarations                      */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void CpswAle_initCfg(CpswAle_Cfg *aleCfg);
 
/* ========================================================================== */
/*                        Deprecated Function Declarations                    */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* CPSW_ALE_H_ */