AM263x MCU+ SDK  10.00.00
enet_rm.h File Reference

Introduction

This file contains the type definitions and helper macros for the Enet Resource Manager module.

Go to the source code of this file.

Data Structures

struct  EnetRm_ResourceInfo
 Enet RM resource information. More...
 
struct  EnetRm_ResPrms
 Enet RM resource parameters. More...
 
struct  EnetRm_IoctlPermissionEntry
 Enet RM IOCTL permission entry. More...
 
struct  EnetRm_IoctlPermissionTable
 Enet RM IOCTL permission table. More...
 
struct  EnetRm_MacAddressPool
 Enet RM MAC address pool. More...
 
struct  EnetRm_AllocRxFlowInArgs
 Input args for ENET_RM_IOCTL_ALLOC_RX_FLOW command. More...
 
struct  EnetRm_AllocRxFlow
 Output args for ENET_RM_IOCTL_ALLOC_RX_FLOW command. More...
 
struct  EnetRm_AllocMacAddrOutArgs
 Input args for ENET_RM_IOCTL_ALLOC_MAC_ADDR command. More...
 
struct  EnetRm_FreeTxChInArgs
 Input args for ENET_RM_IOCTL_FREE_TX_CH_PEERID command. More...
 
struct  EnetRm_FreeRxFlowInArgs
 Input args for ENET_RM_IOCTL_FREE_RX_FLOW command. More...
 
struct  EnetRm_FreeMacAddrInArgs
 Input args for ENET_RM_IOCTL_FREE_MAC_ADDR command. More...
 
struct  EnetRm_ResCfg
 Resource manager configuration parameters. More...
 

Macros

#define ENET_RM_PUBLIC_IOCTL(x)
 Helper macro to create IOCTL commands for Enet RM module. More...
 
#define ENET_RM_NUM_IOCTL_PERM_ENTRY_MAX   (16U)
 Maximum number of entries for IOCTL permission. More...
 
#define ENET_RM_NUM_MACADDR_MAX   (10U)
 Maximum number of macaddress to be managed by RM. More...
 
#define ENET_RM_NUM_RXCHAN_MAX   (2U)
 Maximum number of RX channels (i.e. sets of flows). More...
 
Resource Manager Error Codes

Error codes returned by RM functions.

#define ENET_RM_TXCHNUM_INVALID   (0xABCDABCDU)
 Enet RM invalid TX channel number. More...
 
#define ENET_RM_RXFLOWIDX_INVALID   (0xABCDABCDU)
 Enet RM invalid RX flow id. More...
 
#define ENET_RM_INVALIDCORE   (0x5562AEFEU)
 Enet RM invalid core. More...
 

Enumerations

enum  EnetRm_Ioctls {
  ENET_RM_IOCTL_ALLOC_MAC_ADDR = ENET_RM_PUBLIC_IOCTL(0U), ENET_RM_IOCTL_FREE_MAC_ADDR = ENET_RM_PUBLIC_IOCTL(1U), ENET_RM_IOCTL_ALLOC_RX_FLOW = ENET_RM_PUBLIC_IOCTL(2U), ENET_RM_IOCTL_FREE_RX_FLOW = ENET_RM_PUBLIC_IOCTL(3U),
  ENET_RM_IOCTL_ALLOC_TX_CH_PEERID = ENET_RM_PUBLIC_IOCTL(4U), ENET_RM_IOCTL_FREE_TX_CH_PEERID = ENET_RM_PUBLIC_IOCTL(5U)
}
 Enet RM IOCTL commands. More...