PDK Documentation

Introduction

Runtime control commands supported by ALE

Enumerations

enum  CPSW_ALE_IOCTL_E {
  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)
}
 The ALE module IOCTL enums. More...
 

Enumeration Type Documentation

◆ CPSW_ALE_IOCTL_E

The ALE module IOCTL enums.

Enumerator
CPSW_ALE_IOCTL_ADD_UNICAST 

Functionality: Add unicast address entry to ALE table. IOCTL params : inArgs:. CpswAle_SetUcastEntryInArgs outArgs: CpswAle_AddEntryOutArgs Calling context: Task

CPSW_ALE_IOCTL_ADD_MULTICAST 

Functionality: Add multicast address entry to ALE table IOCTL params : inArgs:. CpswAle_SetMcastEntryInArgs outArgs: CpswAle_AddEntryOutArgs Calling context: Task

CPSW_ALE_IOCTL_ADD_VLAN 

Functionality: Add inner/outer vlan entry to ALE table IOCTL params : inArgs:. CpswAle_VlanEntryInfo outArgs: CpswAle_AddEntryOutArgs Calling context: Task

CPSW_ALE_IOCTL_ADD_OUI 

Functionality: Add oui address entry to ALE table IOCTL params : inArgs:. CpswAle_OuiEntryInfo outArgs: CpswAle_AddEntryOutArgs Calling context: Task

CPSW_ALE_IOCTL_ADD_IPV4ADDR 

Functionality: Add IPv4 address to ALE table IOCTL params : inArgs:. CpswAle_Ipv4EntryInfo outArgs: CpswAle_AddEntryOutArgs Calling context: Task

CPSW_ALE_IOCTL_ADD_IPV6ADDR 

Functionality: Add IPv6 address to ALE table IOCTL params : inArgs:. CpswAle_Ipv6EntryInfo outArgs: CpswAle_AddEntryOutArgs Calling context: Task

CPSW_ALE_IOCTL_ADD_ETHERTYPE 

Functionality: Add ethertype entry to ALE table IOCTL params : inArgs:. CpswAle_EtherTypeEntryInfo outArgs: CpswAle_AddEntryOutArgs Calling context: Task

CPSW_ALE_IOCTL_LOOKUP_UNICAST 

Functionality: Return ALE entry info for given unicast address IOCTL params : inArgs: CpswAle_macAddrInfo outArgs:CpswAle_GetUcastEntryOutArgs Calling context: Task

CPSW_ALE_IOCTL_LOOKUP_MULTICAST 

Functionality: Return ALE entry info for given multicast address IOCTL params : inArgs: CpswAle_GetMcastEntryInArgs outArgs:CpswAle_GetMcastEntryOutArgs Calling context: Task

CPSW_ALE_IOCTL_LOOKUP_VLAN 

Functionality: Return ALE entry info for given vlanId IOCTL params : inArgs: CpswAle_VlanIdInfo outArgs:CpswAle_GetVlanEntryOutArgs Calling context: Task

CPSW_ALE_IOCTL_REMOVE_ADDR 

Functionality: Delete ALE entry info for given unicast/multicast addr IOCTL params : inArgs: CpswAle_MacAddrInfo outArgs:NULL Calling context: Task

CPSW_ALE_IOCTL_REMOVE_VLAN 

Functionality: Delete ALE entry info for given vlanId IOCTL params : inArgs: CpswAle_VlanIdInfo outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_REMOVE_OUI 

Functionality: Delete ALE entry info for given oui addr IOCTL params : inArgs:. CpswAle_OuiEntryInfo outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_REMOVE_IPV4ADDR 

Functionality: Delete ALE entry info for given IPV4 addr IOCTL params : inArgs: CpswAle_Ipv4EntryInfo outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_REMOVE_IPV6ADDR 

Functionality: Delete ALE entry info for given IPV6 addr IOCTL params : inArgs: CpswAle_Ipv6EntryInfo outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_REMOVE_ETHERTYPE 

Functionality: Delete ALE entry info for given Ethertype IOCTL params : inArgs: CpswAle_EtherTypeEntryInfo outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_SET_POLICER 

Functionality: Set Policer/Classifier entry IOCTL params : inArgs: CpswAle_SetPolicerEntryInArgs outArgs: CpswAle_SetPolicerEntryOutArgs Calling context: Task

CPSW_ALE_IOCTL_GET_POLICER 

Functionality: Get Policer/Classifier entry info IOCTL params : inArgs: CpswAle_PolicerMatchParams outArgs: CpswAle_GetPolicerEntryOutArgs Calling context: Task

CPSW_ALE_IOCTL_DEL_POLICER 

Functionality: Delete Policer/Classifier entry IOCTL params : inArgs: CpswAle_PolicerMatchParams outArgs:NONE Calling context: Task

CPSW_ALE_IOCTL_DUMP_TABLE 

Functionality: Dump ALE table entries. Table entries will be printed using CpswUtils_Prms::printFxn param passed at CPSW open time IOCTL params : inArgs: NONE outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_DUMP_POLICER_ENTRIES 

Functionality: Dump ALE policer entries. Table entries will be printed using CpswUtils_Prms::printFxn param passed at CPSW open time IOCTL params : inArgs: NONE outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_GET_POLICER_STATS 

Functionality: Get ALE policer stats. IOCTL params : inArgs:. CpswAle_GetPolicerStatsInArgs outArgs: CpswAle_GetPolicerStatsOutArgs Calling context: Task

CPSW_ALE_IOCTL_SET_PORT_MIRROR_CFG 

Functionality: Set Port Mirroring configuration IOCTL params : inArgs: CpswAle_SetPortMirroringConfigInArgs outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_SET_TRUNK_CFG 

Functionality: Set Port Trunking configuration IOCTL params : inArgs:. CpswAle_SetTrunkConfigInArgs outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_SET_OAMLPBK_CFG 

Functionality: Enable OAM loopback for ports IOCTL params : inArgs: CpswAle_SetOAMLoopbackInArgs outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_DEL_ALL_ENTRIES 

Functionality: Delete all ALE entries IOCTL params : inArgs: NONE outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_SET_RX_FILTER 

Functionality: Set host port Rx filter IOCTL params : inArgs: CpswAle_HostRxFilterParams outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_GET_RX_FILTER 

Functionality: Get current host port Rx filter IOCTL params : inArgs: NONE outArgs:CpswAle_HostRxFilterParams Calling context: Task

CPSW_ALE_IOCTL_SET_PORT_STATE 

Functionality: Set ALE port state IOCTL params : inArgs: CpswAle_SetPortStateInArgs outArgs: NONE Calling context: ISR/SWI/Task

CPSW_ALE_IOCTL_SET_BCAST_MCAST_LIMIT 

Functionality: Set Broadcast/Multicast rate limit configuration IOCTL params : inArgs: CpswAle_SetBcastMcastRateLimitInArgs outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_SET_DEFAULT_THREADCFG 

Functionality: Set default thread configuration IOCTL params : inArgs: CpswAle_SetDefaultThreadConfigInArgs outArgs: NONE Calling context:Task

CPSW_ALE_IOCTL_AGE_ALE_ENTRIES 

Functionality: Age all ALE entries now IOCTL params : inArgs: NONE outArgs: NONE Calling context:ISR/SWI/Task

CPSW_ALE_IOCTL_SET_INTERVLAN_CFG 

Functionality: Set InterVLAN routing configuration IOCTL params : inArgs:. CpswAle_SetInterVLANConfigInArgs outArgs: CpswAle_SetInterVLANConfigOutArgs Calling context: Task

CPSW_ALE_IOCTL_GET_INTERVLAN_CFG 

Functionality: Set InterVLAN routing configuration IOCTL params : inArgs:. outArgs: Calling context: Task

CPSW_ALE_IOCTL_DEL_LEARNT_ENTRIES 

Functionality: Delete all learnt ALE entries IOCTL params : inArgs:. CpswAle_DelLearntEntriesInArgs outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_SET_POLICER_THREADCFG 

Functionality: Set thread id for given classifier/policer IOCTL params : inArgs: CpswAle_SetPolicerThreadConfigInArgs outArgs: CpswAle_SetPolicerThreadConfigOutArgs Calling context: Task

CPSW_ALE_IOCTL_GET_PORT_MACADDR 

Functionality: Get mac addresses reachable on given port IOCTL params : inArgs:. CpswAle_GetPortMacAddrInArgs outArgs: CpswAle_GetPortMacAddrOutArgs Calling context: Task

CPSW_ALE_IOCTL_DISABLE_PORT_MIRROR 

Functionality: Delete port mirror configuration for a given port IOCTL params : inArgs:. NONE outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_DISABLE_BCAST_MCAST_LIMIT 

Functionality: Disable Broadcast/Multicast rate limit configuration IOCTL params : inArgs: NONE outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_SET_POLICER_GLOBAL_CONFIG 

Functionality: Configure policer global settings IOCTL params : inArgs: CpswAle_SetPolicerGlobalConfigInArgs outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_GET_BCAST_MCAST_LIMIT 

Functionality: Get configured Broadcast/Multicast rate limit params IOCTL params : inArgs: NONE outArgs: CpswAle_GetBcastMcastRateLimitOutArgs Calling context: Task

CPSW_ALE_IOCTL_GET_PORT_STATE 

Functionality: Set ALE port state IOCTL params : inArgs: CpswAle_GetPortStateInArgs outArgs: CpswAle_GetPortStateOutArgs Calling context: ISR/SWI/Task

CPSW_ALE_IOCTL_GET_DEFAULT_THREADCFG 

Functionality: Get default thread configuration IOCTL params : inArgs: NONE outArgs: CpswAle_GetDefaultThreadConfigOutArgs Calling context:Task

CPSW_ALE_IOCTL_PRINT_REGS 

Functionality: Dump ALE registers. All ALE registers wil be printed using CpswUtils_Prms::printFxn param passed at CPSW open time IOCTL params : inArgs: NONE outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_GET_POLICER_GLOBAL_CONFIG 

Functionality: Configure policer global settings IOCTL params : inArgs: NONE outArgs: CpswAle_GetPolicerGlobalConfigOutArgs Calling context: Task

CPSW_ALE_IOCTL_DEL_ALL_POLICER_THREADID 

Functionality: Delete all policer entries and associated ALE entry with the given threadId IOCTL params : inArgs: uint32_t threadId outArgs: NONE Calling context: Task

CPSW_ALE_IOCTL_BLOCK_CLASSIFIER_HOSTPORT 

Functionality: Blacklist classifier to host port ALE supports feature to allow packets matching policer match criteria that is destined for host port to be dropped. IOCTL params : inArgs: CpswAle_PolicerMatchParams outArgs: CpswAle_BlockClassifierHostPortOutArgs Calling context: Task