PDK API Guide for J721E

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

The ALE module IOCTL enums.

Enumerator
CPSW_ALE_IOCTL_ADD_UNICAST 

Add unicast address entry to ALE table.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_ADD_MULTICAST 

Add multicast address entry to ALE table.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_ADD_VLAN 

Add inner/outer vlan entry to ALE table.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_ADD_OUI 

Add oui address entry to ALE table IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_ADD_IPV4ADDR 

Add IPv4 address to ALE table.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_ADD_IPV6ADDR 

Add IPv6 address to ALE table.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_ADD_ETHERTYPE 

Add ethertype entry to ALE table.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_LOOKUP_UNICAST 

Return ALE entry info for given unicast address.

IOCTL params:

CPSW_ALE_IOCTL_LOOKUP_MULTICAST 

Return ALE entry info for given multicast address.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_LOOKUP_VLAN 

Return ALE entry info for given vlanId.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_REMOVE_ADDR 

Delete ALE entry info for given unicast/multicast addr.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_REMOVE_VLAN 

Delete ALE entry info for given vlanId.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_REMOVE_OUI 

Delete ALE entry info for given oui addr.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_REMOVE_IPV4ADDR 

Delete ALE entry info for given IPv4 address.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_REMOVE_IPV6ADDR 

Delete ALE entry info for given IPv6 address.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_REMOVE_ETHERTYPE 

Delete ALE entry info for given Ethertype.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_SET_POLICER 

Set Policer/Classifier entry.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_GET_POLICER 

Get Policer/Classifier entry info.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_DEL_POLICER 

Delete Policer/Classifier entry.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_DUMP_TABLE 

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 

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 

Get ALE policer stats.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_SET_PORT_MIRROR_CFG 

Set Port Mirroring configuration.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_SET_TRUNK_CFG 

Set Port Trunking configuration.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_SET_OAMLPBK_CFG 

Enable OAM loopback for ports.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_DEL_ALL_ENTRIES 

Delete all ALE entries.

IOCTL params:

  • inArgs: None
  • outArgs: None

Calling context: Task

CPSW_ALE_IOCTL_SET_RX_FILTER 

Set host port Rx filter.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_GET_RX_FILTER 

Get current host port Rx filter.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_SET_PORT_STATE 

Set ALE port state IOCTL params:

CPSW_ALE_IOCTL_SET_BCAST_MCAST_LIMIT 

Set Broadcast/Multicast rate limit configuration.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_SET_DEFAULT_THREADCFG 

Set default thread configuration.

IOCTL params:

Calling context:Task

CPSW_ALE_IOCTL_AGE_ALE_ENTRIES 

Age all ALE entries now.

IOCTL params:

  • inArgs: None
  • outArgs: None

Calling context:ISR/SWI/Task

CPSW_ALE_IOCTL_SET_INTERVLAN_CFG 

Set InterVLAN routing configuration.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_GET_INTERVLAN_CFG 

Set InterVLAN routing configuration.

IOCTL params:

  • inArgs: None
  • outArgs: None

Calling context: Task

CPSW_ALE_IOCTL_DEL_LEARNT_ENTRIES 

Delete all learnt ALE entries.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_SET_POLICER_THREADCFG 

Set thread id for given classifier/policer.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_GET_PORT_MACADDR 

Get mac addresses reachable on given port.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_DISABLE_PORT_MIRROR 

Delete port mirror configuration for a given port.

IOCTL params:

  • inArgs: None
  • outArgs: None

Calling context: Task

CPSW_ALE_IOCTL_DISABLE_BCAST_MCAST_LIMIT 

Disable Broadcast/Multicast rate limit configuration.

IOCTL params:

  • inArgs: None
  • outArgs: None

Calling context: Task

CPSW_ALE_IOCTL_SET_POLICER_GLOBAL_CONFIG 

Configure policer global settings IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_GET_BCAST_MCAST_LIMIT 

Get configured Broadcast/Multicast rate limit params.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_GET_PORT_STATE 

Set ALE port state.

IOCTL params:

Calling context: ISR/SWI/Task

CPSW_ALE_IOCTL_GET_DEFAULT_THREADCFG 

Get default thread configuration.

IOCTL params:

Calling context:Task

CPSW_ALE_IOCTL_PRINT_REGS 

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 

Configure policer global settings.

IOCTL params:

Calling context: Task

CPSW_ALE_IOCTL_DEL_ALL_POLICER_THREADID 

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 

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:

Calling context: Task