cpsw_ale.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2018
 *
 *  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 "cpsw_types.h"

#ifdef __cplusplus
extern "C" {
#endif

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

#define CPSW_ALE_NUM_PORTS                           ((uint32_t)9)

#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                      ((1U << CPSW_ALE_NUM_PORTS) - 1U)

#define CPSW_ALE_ALL_MACPORTS_MASK                   (((1U << CPSW_ALE_NUM_PORTS) - 1U) - 1U)

#define CPSW_ALE_HOST_PORT_MASK                      (0x1U)

#define CPSW_ALE_HOST_PORT_NUM                       (0x0U)

#define CPSW_ALE_MCAST_IGN_BITS_MAX                  (10U)

#define CPSW_ALE_MACADDR_NUM_OCTETS                  (CPSW_MAC_ADDR_LEN)

#define CPSW_ALE_OUIADDR_NUM_OCTETS                  (3U)

#define CPSW_ALE_IPV4ADDR_NUM_OCTETS                 (4U)

#define CPSW_ALE_IPV6ADDR_NUM_OCTETS                 (16U)

#define CPSW_ALE_PEAKBITRATE_DISABLE                 (0U)

#define CPSW_ALE_COMMITBITRATE_DISABLE               (0U)

#define CPSW_ALE_THREADID_INVALID                    (~0U)

#define CPSW_ALE_POLICER_MATCH_PORT                  (CPSW_SET_BIT(0U))

#define CPSW_ALE_POLICER_MATCH_PRIORITY              (CPSW_SET_BIT(1U))

#define CPSW_ALE_POLICER_MATCH_OUI                   (CPSW_SET_BIT(2U))

#define CPSW_ALE_POLICER_MATCH_MACDST                (CPSW_SET_BIT(3U))

#define CPSW_ALE_POLICER_MATCH_MACSRC                (CPSW_SET_BIT(4U))

#define CPSW_ALE_POLICER_MATCH_OVLAN                 (CPSW_SET_BIT(5U))

#define CPSW_ALE_POLICER_MATCH_IVLAN                 (CPSW_SET_BIT(6U))

#define CPSW_ALE_POLICER_MATCH_ETHERTYPE             (CPSW_SET_BIT(7U))

#define CPSW_ALE_POLICER_MATCH_IPSRC                 (CPSW_SET_BIT(8U))

#define CPSW_ALE_POLICER_MATCH_IPDST                 (CPSW_SET_BIT(9U))
/*  @} */

#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)

/*  @} */

#define CPSW_ALE_MACPORT_BASE                        (1U)

#define CPSW_ALE_MACPORT_TO_ALEPORT(macPortNum)      (CPSW_NORMALIZE_MACPORT(macPortNum) + CPSW_ALE_MACPORT_BASE)

#define CPSW_ALE_ALEPORT_TO_MACPORT(alePortNum)      (CPSW_DENORMALIZE_MACPORT(alePortNum - CPSW_ALE_MACPORT_BASE))

#define CPSW_ALE_MACPORT_TO_PORTMASK(macPortNum)     CPSW_SET_BIT(CPSW_ALE_MACPORT_TO_ALEPORT(macPortNum))

#define CPSW_ALE_PUBLIC_IOCTL(x)                     (CPSW_IOCTL_ALE_BASE | CPSW_IOCTL_MIN(x))

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

typedef enum CPSW_ALE_IOCTL_TAG
{
    CPSW_ALE_IOCTL_ADD_UNICAST               = CPSW_ALE_PUBLIC_IOCTL(0U),

    CPSW_ALE_IOCTL_ADD_MULTICAST             = CPSW_ALE_PUBLIC_IOCTL(1U),

    CPSW_ALE_IOCTL_ADD_VLAN                  = CPSW_ALE_PUBLIC_IOCTL(2U),

    CPSW_ALE_IOCTL_ADD_OUI                   = CPSW_ALE_PUBLIC_IOCTL(3U),

    CPSW_ALE_IOCTL_ADD_IPV4ADDR              = CPSW_ALE_PUBLIC_IOCTL(4U),

    CPSW_ALE_IOCTL_ADD_IPV6ADDR              = CPSW_ALE_PUBLIC_IOCTL(5U),

    CPSW_ALE_IOCTL_ADD_ETHERTYPE             = CPSW_ALE_PUBLIC_IOCTL(6U),

    CPSW_ALE_IOCTL_LOOKUP_UNICAST            = CPSW_ALE_PUBLIC_IOCTL(7U),

    CPSW_ALE_IOCTL_LOOKUP_MULTICAST          = CPSW_ALE_PUBLIC_IOCTL(8U),

    CPSW_ALE_IOCTL_LOOKUP_VLAN               = CPSW_ALE_PUBLIC_IOCTL(9U),

    CPSW_ALE_IOCTL_REMOVE_ADDR               = CPSW_ALE_PUBLIC_IOCTL(10U),

    CPSW_ALE_IOCTL_REMOVE_VLAN               = CPSW_ALE_PUBLIC_IOCTL(11U),

    CPSW_ALE_IOCTL_REMOVE_OUI                = CPSW_ALE_PUBLIC_IOCTL(12U),

    CPSW_ALE_IOCTL_REMOVE_IPV4ADDR           = CPSW_ALE_PUBLIC_IOCTL(13U),

    CPSW_ALE_IOCTL_REMOVE_IPV6ADDR           = CPSW_ALE_PUBLIC_IOCTL(14U),

    CPSW_ALE_IOCTL_REMOVE_ETHERTYPE          = CPSW_ALE_PUBLIC_IOCTL(15U),

    CPSW_ALE_IOCTL_SET_POLICER               = CPSW_ALE_PUBLIC_IOCTL(16U),

    CPSW_ALE_IOCTL_GET_POLICER               = CPSW_ALE_PUBLIC_IOCTL(17U),

    CPSW_ALE_IOCTL_DEL_POLICER               = CPSW_ALE_PUBLIC_IOCTL(18U),

    CPSW_ALE_IOCTL_DUMP_TABLE                = CPSW_ALE_PUBLIC_IOCTL(19U),

    CPSW_ALE_IOCTL_DUMP_POLICER_ENTRIES      = CPSW_ALE_PUBLIC_IOCTL(20U),

    CPSW_ALE_IOCTL_GET_POLICER_STATS         = CPSW_ALE_PUBLIC_IOCTL(21U),

    CPSW_ALE_IOCTL_SET_PORT_MIRROR_CFG       = CPSW_ALE_PUBLIC_IOCTL(22U),

    CPSW_ALE_IOCTL_SET_TRUNK_CFG             = CPSW_ALE_PUBLIC_IOCTL(23U),

    CPSW_ALE_IOCTL_SET_OAMLPBK_CFG           = CPSW_ALE_PUBLIC_IOCTL(24U),

    CPSW_ALE_IOCTL_DEL_ALL_ENTRIES           = CPSW_ALE_PUBLIC_IOCTL(25U),

    CPSW_ALE_IOCTL_SET_RX_FILTER             = CPSW_ALE_PUBLIC_IOCTL(26U),

    CPSW_ALE_IOCTL_GET_RX_FILTER             = CPSW_ALE_PUBLIC_IOCTL(27U),

    CPSW_ALE_IOCTL_SET_PORT_STATE            = CPSW_ALE_PUBLIC_IOCTL(28U),

    CPSW_ALE_IOCTL_SET_BCAST_MCAST_LIMIT     = CPSW_ALE_PUBLIC_IOCTL(29U),

    CPSW_ALE_IOCTL_SET_DEFAULT_THREADCFG     = CPSW_ALE_PUBLIC_IOCTL(30U),

    CPSW_ALE_IOCTL_AGE_ALE_ENTRIES           = CPSW_ALE_PUBLIC_IOCTL(31U),

    CPSW_ALE_IOCTL_SET_INTERVLAN_CFG         = CPSW_ALE_PUBLIC_IOCTL(32U),

    CPSW_ALE_IOCTL_GET_INTERVLAN_CFG         = CPSW_ALE_PUBLIC_IOCTL(33U),

    CPSW_ALE_IOCTL_DEL_LEARNT_ENTRIES        = CPSW_ALE_PUBLIC_IOCTL(34U),

    CPSW_ALE_IOCTL_SET_POLICER_THREADCFG     = CPSW_ALE_PUBLIC_IOCTL(35U),

    CPSW_ALE_IOCTL_GET_PORT_MACADDR          = CPSW_ALE_PUBLIC_IOCTL(36U),

    CPSW_ALE_IOCTL_DISABLE_PORT_MIRROR       = CPSW_ALE_PUBLIC_IOCTL(37U),

    CPSW_ALE_IOCTL_DISABLE_BCAST_MCAST_LIMIT = CPSW_ALE_PUBLIC_IOCTL(38U),

    CPSW_ALE_IOCTL_SET_POLICER_GLOBAL_CONFIG = CPSW_ALE_PUBLIC_IOCTL(39U),

    CPSW_ALE_IOCTL_GET_BCAST_MCAST_LIMIT     = CPSW_ALE_PUBLIC_IOCTL(40U),

    CPSW_ALE_IOCTL_GET_PORT_STATE            = CPSW_ALE_PUBLIC_IOCTL(41U),

    CPSW_ALE_IOCTL_GET_DEFAULT_THREADCFG     = CPSW_ALE_PUBLIC_IOCTL(42U),

    CPSW_ALE_IOCTL_PRINT_REGS                = CPSW_ALE_PUBLIC_IOCTL(43U),

    CPSW_ALE_IOCTL_GET_POLICER_GLOBAL_CONFIG = CPSW_ALE_PUBLIC_IOCTL(44U),

    CPSW_ALE_IOCTL_DEL_ALL_POLICER_THREADID  = CPSW_ALE_PUBLIC_IOCTL(45U),

    CPSW_ALE_IOCTL_BLOCK_CLASSIFIER_HOSTPORT = CPSW_ALE_PUBLIC_IOCTL(46U),
} CPSW_ALE_IOCTL_E;
/* @} */

typedef enum CPSW_ALE_FWDSTLVL_TAG
{
    CPSW_ALE_FWDSTLVL_FORWARDING  = 0,

    CPSW_ALE_FWDSTLVL_BLK_FWD_LRN = 1,

    CPSW_ALE_FWDSTLVL_FWD_LRN     = 2,
} CPSW_ALE_FWDSTLVL_E;

typedef enum
{
    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,
} CPSW_ALE_POLICER_YELLOWTHRESH_E;

typedef enum CPSW_ALE_POLICER_NOMATCH_MODE_TAG
{
    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,
} CPSW_ALE_POLICER_NOMATCH_MODE_E;

typedef enum CPSW_ALE_PORTSTATE_TAG
{
    CPSW_ALE_PORTSTATE_DISABLED = 0,

    CPSW_ALE_PORTSTATE_BLOCKED,

    CPSW_ALE_PORTSTATE_LEARN,

    CPSW_ALE_PORTSTATE_FORWARD
} CPSW_ALE_PORTSTATE_E;

typedef enum CPSW_ALE_IPADDR_CLASSIFIER_TAG
{
    CPSW_ALE_IPADDR_CLASSIFIER_IPV4 = 0x00U,

    CPSW_ALE_IPADDR_CLASSIFIER_IPV6 = 0x01U,
} CPSW_ALE_IPADDR_CLASSIFIER_E;

typedef enum CPSW_ALE_TBLENTRYTYPE_TAG
{
    CPSW_ALE_TBLENTRYTYPE_ADDR,
 
    CPSW_ALE_TBLENTRYTYPE_VLAN,

    CPSW_ALE_TBLENTRYTYPE_ETHERTYPE,

    CPSW_ALE_TBLENTRYTYPE_OUI,

    CPSW_ALE_TBLENTRYTYPE_IPV4,

    CPSW_ALE_TBLENTRYTYPE_IPV6
} CPSW_ALE_TBLENTRYTYPE_E;

#define CPSW_ALE_CONFIG_MASK_ALE_MODULE_ENABLE            (CPSW_SET_BIT(0))

#define CPSW_ALE_CONFIG_MASK_ALE_BYPASS_ENABLE            (CPSW_SET_BIT(1))

#define CPSW_ALE_CONFIG_MASK_UNKNOWN_UNICAST_FLOOD2HOST   (CPSW_SET_BIT(2))

typedef enum CPSW_ALE_RXFILTER_TAG
{
    CPSW_ALE_RXFILTER_NOTHING      = 0x0000U,

    CPSW_ALE_RXFILTER_DIRECT       = 0x0001U,

    CPSW_ALE_RXFILTER_BROADCAST    = 0x0002U,

    CPSW_ALE_RXFILTER_MULTICAST    = 0x0003U,

    CPSW_ALE_RXFILTER_ALLMULTICAST = 0x0004U,

    CPSW_ALE_RXFILTER_ALL          = 0x0005U
} CPSW_ALE_RXFILTER_E;

typedef struct CpswAle_MacAddrInfo_s
{
    uint8_t addr[CPSW_ALE_MACADDR_NUM_OCTETS];

    uint32_t vlanId;
} CpswAle_MacAddrInfo;

typedef struct CpswAle_Ipv4EntryInfo_s
{
    uint8_t ipv4Addr[CPSW_ALE_IPV4ADDR_NUM_OCTETS];

    uint32_t numLSBIgnoreBits;
} CpswAle_Ipv4EntryInfo;

typedef struct CpswAle_Ipv6EntryInfo_s
{
    uint8_t ipv6Addr[CPSW_ALE_IPV6ADDR_NUM_OCTETS];

    uint32_t numLSBIgnoreBits;
} CpswAle_Ipv6EntryInfo;

typedef struct CpswAle_McastEntryInfo_s
{
    bool superFlag;

    CPSW_ALE_FWDSTLVL_E fwdState;

    uint32_t portMask;

    uint32_t numIgnBits;
} CpswAle_McastEntryInfo;

typedef struct CpswAle_UcastEntryInfo_s
{
    uint32_t portNum;

    bool blocked;

    bool secure;

    bool super;

    bool ageable;

    bool trunk;
} CpswAle_UcastEntryInfo;

typedef struct CpswAle_IpAddrClassifierInfo_s
{
    CPSW_ALE_IPADDR_CLASSIFIER_E ipAddrtype;

    CpswAle_Ipv4EntryInfo ipv4;

    CpswAle_Ipv6EntryInfo ipv6;
} CpswAle_IpAddrClassifierInfo;

typedef struct CpswAle_OuiEntryInfo_s
{
    uint8_t ouiAddr[CPSW_ALE_OUIADDR_NUM_OCTETS];
} CpswAle_OuiEntryInfo;

typedef struct CpswAle_EtherTypeEntryInfo_s
{
    uint32_t etherType;
} CpswAle_EtherTypeEntryInfo;

typedef struct CpswAle_VlanIdInfo_s
{
    uint32_t vlanId;

    bool outerVlanFlag;
} 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 disallowIPFragmentation;
} CpswAle_VlanEntryInfo;

typedef struct CpswAle_MacSrcAddrClassifierInfo_s
{
    CpswAle_MacAddrInfo addr;

    uint32_t ingressPortNum;
} CpswAle_MacSrcAddrClassifierInfo;

typedef struct CpswAle_MacDstAddrClassifierInfo_s
{
    CpswAle_MacAddrInfo addr;

    uint32_t egressPortNum;
} CpswAle_MacDstAddrClassifierInfo;

typedef struct CpswAle_PolicerMatchParams_s
{
    uint32_t policerMatchEnableMask;

    uint32_t portNum;

    bool portIsTrunk;

    uint32_t priority;

    CpswAle_OuiEntryInfo oui;

    CpswAle_MacSrcAddrClassifierInfo srcMacAddr;

    CpswAle_MacDstAddrClassifierInfo dstMacAddr;

    uint32_t ivlanId;

    uint32_t ovlanId;

    CpswAle_EtherTypeEntryInfo etherType;

    CpswAle_IpAddrClassifierInfo srcIp;

    CpswAle_IpAddrClassifierInfo dstIp;
} CpswAle_PolicerMatchParams;

typedef struct CpswAle_HostRxFilterParams_s
{
    CPSW_ALE_RXFILTER_E rxFilter;
} CpswAle_HostRxFilterParams;

typedef struct CpswAle_MirrorMatchParams_s
{
    CPSW_ALE_TBLENTRYTYPE_E entryType;

    CpswAle_MacDstAddrClassifierInfo macAddrInfo;

    CpswAle_VlanIdInfo vlanIdInfo;

    CpswAle_Ipv4EntryInfo ipv4Info;

    CpswAle_Ipv6EntryInfo ipv6Info;

    CpswAle_OuiEntryInfo ouiInfo;

    CpswAle_EtherTypeEntryInfo etherTypeInfo;
} CpswAle_MirrorMatchParams;

typedef CpswAle_VlanEntryInfo CpswAle_PortVlanConfig;

typedef struct  CpswAle_PortBcastMcastRateLimitParams_s
{
    uint32_t portNum;

    bool enableBRateLimitForPort;

    bool enableMRateLimitForPort;

    uint32_t bcastLimitNumPktsPerSec;

    uint32_t mcastLimitNumPktsPerSec;
} CpswAle_PortBcastMcastRateLimitParams;

typedef struct CpswAle_UnregulatedTrafficPolicer_s
{
    uint32_t peakRateInBitsPerSec;

    uint32_t commitRateInBitsPerSec;
} CpswAle_UnregulatedTrafficPolicer;

typedef struct CpswAle_AddEntryOutArgs_s
{
    uint32_t aleEntryIndex;
} CpswAle_AddEntryOutArgs;

typedef struct CpswAle_SetUcastEntryInArgs_s
{
    CpswAle_MacAddrInfo addr;

    CpswAle_UcastEntryInfo info;
} CpswAle_SetUcastEntryInArgs;

typedef struct CpswAle_GetUcastEntryOutArgs_s
{
    CpswAle_UcastEntryInfo unicastInfo;

    bool touched;

    uint32_t aleEntryIndex;
} CpswAle_GetUcastEntryOutArgs;

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 outInfo;

    uint32_t aleIndex;
} CpswAle_GetMcastEntryOutArgs;

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 disallowIPFragmentation;

    uint32_t aleEntryIndex;
} CpswAle_GetVlanEntryOutArgs;

typedef struct CpswAle_SetPolicerEntryInArgs_s
{
    CpswAle_PolicerMatchParams policerMatch;

    bool threadIdEnable;

    uint32_t threadId;

    uint32_t peakRateInBitsPerSec;

    uint32_t commitRateInBitsPerSec;
} CpswAle_SetPolicerEntryInArgs;

typedef struct CpswAle_SetPolicerEntryOutArgs_s
{
    uint32_t ouiAleEntryIndex;

    uint32_t srcMacAleEntryIndex;

    uint32_t dstMacAleEntryIndex;

    uint32_t ivlanAleEntryIndex;

    uint32_t ovlanAleEntryIndex;

    uint32_t etherTypeAleEntryIndex;

    uint32_t srcIpAleEntryIndex;

    uint32_t dstIpAleEntryIndex;

    uint32_t policerEntryIndex;
} CpswAle_SetPolicerEntryOutArgs;

typedef struct CpswAle_GetPolicerEntryOutArgs_s
{
    uint32_t policerMatchEnableMask;

    uint32_t port;

    bool portIsTrunk;

    uint32_t priority;

    uint32_t ouiAleEntryIndex;

    uint32_t srcMacAleEntryIndex;

    uint32_t dstMacAleEntryIndex;

    uint32_t ivlanAleEntryIndex;

    uint32_t ovlanAleEntryIndex;

    uint32_t etherTypeAleEntryIndex;

    uint32_t srcIpAleEntryIndex;

    uint32_t dstIpAleEntryIndex;

    bool threadIdEnable;

    uint32_t threadId;

    uint32_t peakRateInBitsPerSec;

    uint32_t commitRateInBitsPerSec;

    uint32_t policerEntryIndex;

    bool egressOpEnabled;

    uint32_t egressOpcode;

    bool enableTTLCheck;

    uint32_t egressTrunkIndex;

    uint32_t destPortMask;
} CpswAle_GetPolicerEntryOutArgs;

typedef struct CpswAle_DelPolicerEntryInArgs_s
{
    CpswAle_PolicerMatchParams policerMatch;

    uint32_t delAleEntryMask;
} CpswAle_DelPolicerEntryInArgs;

typedef struct CpswAle_SetOAMLoopbackInArgs_s
{
    uint32_t enableLpbkPortMask;
} CpswAle_SetOAMLoopbackInArgs;

typedef struct  CpswAle_SetPortStateInArgs_s
{
    uint32_t portNum;

    CPSW_ALE_PORTSTATE_E portState;
} CpswAle_SetPortStateInArgs;

typedef struct  CpswAle_GetPortStateInArgs_s
{
    uint32_t portNum;
} CpswAle_GetPortStateInArgs;

typedef struct  CpswAle_GetPortStateOutArgs_s
{
    CPSW_ALE_PORTSTATE_E portState;
} CpswAle_GetPortStateOutArgs;

typedef struct CpswAle_SetPortMirroringConfigInArgs_s
{
    bool enableSrc;

    bool enableDst;

    bool enableMatch;

    uint32_t destPortNum;

    uint32_t toPortNum;

    CpswAle_MirrorMatchParams matchParams;

    uint32_t srcPortNumMask;
} CpswAle_SetPortMirroringConfigInArgs;

typedef struct CpswAle_SetTrunkConfigInArgs_s
{
    uint32_t trunkId;

    uint32_t numPorts;

    uint32_t trunkPortIndex[CPSW_ALE_NUM_PORTS];

    uint32_t trunkHashBase;

    bool enableDstIP;

    bool enableSrcIP;

    bool enableInnerVLAN;

    bool enablePri;

    bool enableSrc;

    bool enableDst;
} CpswAle_SetTrunkConfigInArgs;

typedef struct CpswAle_SetDefaultThreadConfigInArgs_s
{
    bool defaultThreadEnable;

    uint32_t threadId;

    bool enablePriorityOR;

    bool disableMacPortDefaultThread;
} CpswAle_SetDefaultThreadConfigInArgs;

typedef CpswAle_SetDefaultThreadConfigInArgs CpswAle_GetDefaultThreadConfigOutArgs;

typedef struct CpswAle_SetInterVLANConfigInArgs_s
{
    CpswAle_PolicerMatchParams policerMatch;

    bool enableTTLCheck;

    uint32_t destPortMask;

    uint32_t routeIndex;

    uint32_t egressTrunkIndex;
} CpswAle_SetInterVLANConfigInArgs;

typedef CpswAle_GetPolicerEntryOutArgs CpswAle_SetInterVLANConfigOutArgs;

typedef CpswAle_GetPolicerEntryOutArgs CpswAle_BlockClassifierHostPortOutArgs;

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_SetBcastMcastRateLimitInArgs_s
{
    bool rateLimitAtTxPort;

    uint32_t numPorts;

    CpswAle_PortBcastMcastRateLimitParams portPrms[CPSW_ALE_NUM_PORTS];
} CpswAle_SetBcastMcastRateLimitInArgs;

typedef struct CpswAle_GetBcastMcastRateLimitOutArgs_s
{
    bool rateLimitEnabled;

    bool rateLimitAtTxPort;

    uint32_t numPorts;

    CpswAle_PortBcastMcastRateLimitParams portPrms[CPSW_ALE_NUM_PORTS];
} CpswAle_GetBcastMcastRateLimitOutArgs;

typedef struct CpswAle_GetPortMacAddrInArgs_s
{
    uint32_t portNum;

    CpswAle_MacAddrInfo *macAddr;

    uint32_t maxNumAddr;
} CpswAle_GetPortMacAddrInArgs;

typedef struct CpswAle_GetPortMacAddrOutArgs_s
{
    CpswAle_MacAddrInfo *macAddr;

    uint32_t addrCount;

    uint32_t totalPortMacAddrCount;
} CpswAle_GetPortMacAddrOutArgs;

typedef struct CpswAle_DelLearntEntriesInArgs_s
{
    uint32_t portNum;
} CpswAle_DelLearntEntriesInArgs;

typedef struct CpswAle_SetPolicerThreadConfigInArgs_s
{
    CpswAle_PolicerMatchParams policerMatch;

    bool threadIdEnable;

    uint32_t threadId;
} CpswAle_SetPolicerThreadConfigInArgs;

typedef CpswAle_GetPolicerEntryOutArgs CpswAle_SetPolicerThreadConfigOutArgs;

typedef struct CpswAle_PolicerGlobalConfig_s CpswAle_SetPolicerGlobalConfigInArgs;

typedef struct CpswAle_PolicerGlobalConfig_s CpswAle_GetPolicerGlobalConfigOutArgs;

/*  @} */

typedef struct CpswAle_PolicerGlobalConfig_s
{
    bool policingEnable;

    bool yellowDropEnable;

    bool redDropEnable;

    CPSW_ALE_POLICER_YELLOWTHRESH_E yellowThresh;

    CPSW_ALE_POLICER_NOMATCH_MODE_E policerNoMatchMode;

    CpswAle_UnregulatedTrafficPolicer noMatchPolicer;
} CpswAle_PolicerGlobalConfig;

typedef struct CpswAle_AgingConfig_s
{
    bool enableAutoAging;

    uint32_t agingPeriodInMs;
} CpswAle_AgingConfig;

typedef struct CpswAle_InitVlanConfig_s
{
    bool aleVlanAwareMode;

    bool cpswVlanAwareMode;

    bool autoLearnWithVLAN;

    bool unknownVlanNoLearn;

    uint32_t unknownForceUntaggedEgressMask;

    uint32_t unknownRegMcastFloodMask;

    uint32_t unknownUnregMcastFloodMask;

    uint32_t unknownVlanMemberListMask;
} CpswAle_InitVlanConfig;

typedef struct CpswAle_PortMacModeConfig_s
{
    bool macOnlyCafEnable;

    bool macOnlyEnable;
} CpswAle_PortMacModeConfig;

typedef struct CpswAle_MacAuthConfig_s
{
    bool enableAuthMode;

    uint32_t macAuthDisableMask;
} CpswAle_MacAuthConfig;

typedef struct CpswAle_PortVlanSecurityConfig_s
{
    bool vidIngressCheck;

    bool dropUntagged;

    bool dropDualVlan;

    bool dropDoubleVlan;
} CpswAle_PortVlanSecurityConfig;

typedef struct CpswAle_PortLearningSecurityConfig_s
{
    bool noLearn;

    bool noSaUpdateEnable;
} CpswAle_PortLearningSecurityConfig;

typedef struct CpswAle_IPPktSecurityConfig_s
{
    bool enableDefaultNoFragment;

    bool enableDefaultNxtHdrWhitelist;

    uint32_t ipNxtHdrWhitelistCount;

    uint8_t ipNxtHdrWhitelist[CPSW_ALE_MAX_WHITELIST_IP_NXT_HDR];
} CpswAle_IPPktSecurityConfig;

typedef struct CpswAle_MalformedPktSecurityConfig_s
{
    bool disableSrcMcastDrop;

    bool enableBadLenPktDrop;
} CpswAle_MalformedPktSecurityConfig;

typedef struct CpswAle_LearningSecurityConfig_s
{
    bool updStatic;

    bool uVlanNoLearn;

    bool learnNoVlanID;
} CpswAle_LearningSecurityConfig;

typedef struct CpswAle_NetworkSecurityConfig_s
{
    bool hostOuiNoMatchDeny;

    bool enableVid0Mode;

    CpswAle_MalformedPktSecurityConfig malformedPktCfg;

    CpswAle_IPPktSecurityConfig ipPktCfg;

    CpswAle_MacAuthConfig macAuthCfg;
} CpswAle_NetworkSecurityConfig;

typedef struct CpswAle_PortConfig_s
{
    CpswAle_PortLearningSecurityConfig learningCfg;

    CpswAle_PortVlanSecurityConfig vlanCfg;

    CpswAle_PortMacModeConfig macModeCfg;

    CpswAle_PortVlanConfig pvidCfg;
} CpswAle_PortConfig;

typedef struct CpswAle_Config_s
{
    uint32_t modeFlags;

    CpswAle_PolicerGlobalConfig policerGlobalConfig;

    CpswAle_AgingConfig agingConfig;

    CpswAle_InitVlanConfig vlanConfig;

    CpswAle_NetworkSecurityConfig nwSecCfg;

    CpswAle_PortConfig portCfg[CPSW_ALE_NUM_PORTS];
} CpswAle_Config;

typedef struct CpswAle_RestartConfig_s
{
    Cpsw_Type cpswType;

    Cpsw_RestartType restartType;

    bool cpswVlanAwareMode;

    CpswAle_PortVlanConfig pvidCfg[CPSW_ALE_NUM_PORTS];

    uint8_t macAddr[CPSW_ALE_NUM_MAC_PORTS][CPSW_ALE_MACADDR_NUM_OCTETS];
} CpswAle_RestartConfig;
/*  @} */

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

typedef struct CpswAle_Obj_s *CpswAle_Handle;

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

void CpswAle_initParams(CpswAle_Config *pALEConfig);

CpswAle_Handle CpswAle_open(Cpsw_Type cpswType,
                            const CpswAle_Config *pALEConfig);

int32_t  CpswAle_close(CpswAle_Handle hAle);

int32_t  CpswAle_ioctl(CpswAle_Handle hAle,
                       CPSW_ALE_IOCTL_E cmd,
                       Cpsw_IoctlPrms *prms);

CpswAle_Handle CpswAle_getHandle(Cpsw_Type cpswType);

CpswAle_Handle CpswAle_restart(CpswAle_RestartConfig *pALERestartConfig);

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

/* None */

#ifdef __cplusplus
}
#endif

#endif /* CPSW_ALE_H_ */