Introduction

Data Structures
struct	EnetRm_NodeInfo
	Enet RM node information. More...

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_AllocTxChInArgs
	Input args for ENET_RM_IOCTL_ALLOC_TX_CH_PEERID command. More...

struct	EnetRm_AllocHwPushOutArgs
	Output args for ENET_RM_IOCTL_ALLOC_HW_PUSH_INST command. More...

struct	EnetRm_FreeHwPushInArgs
	Input args for ENET_RM_IOCTL_FREE_HW_PUSH_INST 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...

struct	EnetRm_ValidatePermissionInArgs
	Input args for ENET_RM_IOCTL_VALIDATE_PERMISSION command. More...

struct	EnetRm_AllocInternalRxFlowInArgs
	Input args for ENET_RM_IOCTL_INTERNAL_ALLOC_RX_FLOW command. More...

struct	EnetRm_FreeInternalRxFlowInArgs
	Input args for ENET_RM_IOCTL_FREE_RX_FLOW command. More...

struct	EnetRm_Cfg
	Enet RM configuration parameters. More...

struct	EnetRm_ResEntry_t
	Resource manager entry. More...

struct	EnetRm_CoreResInfo_t
	Resources of a given core. More...

struct	EnetRm_CoreResTbl_t
	Resource table of all cores. More...

struct	EnetRm_TxChObj
	TX resources. More...

struct	EnetRm_RxFlowIdxObj
	RX resources. More...

struct	EnetRm_HwPushObj

struct	EnetRm_MacAddressObj
	MAC address resources. More...

struct	EnetRm_CoreAttachInfo
	Information about attached cores. More...

struct	EnetRm_Obj
	Enet Resource Manager driver object. More...

Functions
int32_t	EnetRm_open (EnetMod_Handle hMod, Enet_Type enetType, uint32_t instId, const void *cfg, uint32_t cfgSize)
	Open and initialize Enet RM module. More...

int32_t	EnetRm_rejoin (EnetMod_Handle hMod, Enet_Type enetType, uint32_t instId)
	Rejoin Enet RM module for a running peripheral. More...

int32_t	EnetRm_ioctl (EnetMod_Handle hMod, uint32_t cmd, Enet_IoctlPrms *prms)
	Run an IOCTL operation on Enet RM. More...

void	EnetRm_close (EnetMod_Handle hMod)
	Close Enet RM module. More...

Typedefs
typedef EnetRm_FreeRxFlowInArgs	EnetRm_ValidateRxFlowInArgs
	Input args for ENET_RM_IOCTL_VALIDATE_RX_FLOW command. More...

typedef EnetRm_Obj *	EnetRm_Handle
	Enet RM module handle. 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_ALLOC_HW_PUSH_INST = ENET_RM_PUBLIC_IOCTL(6U), ENET_RM_IOCTL_FREE_HW_PUSH_INST = ENET_RM_PUBLIC_IOCTL(7U) }
	Enet RM IOCTL commands. More...

enum	EnetRm_TxCh { ENET_RM_TX_CH_0 = 0U, ENET_RM_TX_CH_1, ENET_RM_TX_CH_2, ENET_RM_TX_CH_3, ENET_RM_TX_CH_4, ENET_RM_TX_CH_5, ENET_RM_TX_CH_6, ENET_RM_TX_CH_7, ENET_RM_TX_CH_LAST = ENET_RM_TX_CH_7, ENET_RM_TX_CH_ANY = 0xFF }
	RM tx channel. More...

enum	EnetRm_NodeType { ENET_RM_NODE_NONE = 0U, ENET_RM_NODE_TX, ENET_RM_NODE_RX, ENET_RM_NODE_MAC, ENET_RM_NODE_HW_PUSH }
	Enet RM node types. More...

enum	EnetRm_PrivIoctls { ENET_RM_IOCTL_VALIDATE_PERMISSION = ENET_RM_PRIVATE_IOCTL(0U), ENET_RM_IOCTL_ATTACH = ENET_RM_PRIVATE_IOCTL(1U), ENET_RM_IOCTL_DETACH = ENET_RM_PRIVATE_IOCTL(2U), ENET_RM_IOCTL_INTERNAL_ALLOC_RX_FLOW = ENET_RM_PRIVATE_IOCTL(3U), ENET_RM_IOCTL_INTERNAL_FREE_RX_FLOW = ENET_RM_PRIVATE_IOCTL(4U), ENET_RM_IOCTL_VALIDATE_RX_FLOW = ENET_RM_PRIVATE_IOCTL(5U) }
	Enet RM private IOCTL commands. 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 (1U)
	Maximum number of RX channels (i.e. sets of flows) More...

#define	ENET_RM_PRIVATE_IOCTL(x)
	Helper macro to create private IOCTL commands for Enet RM module. 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_UNDEFINED_NODEID (0xABCDABCDU)
	Enet RM undefined node id. More...

#define	ENET_RM_INVALIDCORE (0x5562AEFEU)
	Enet RM invalid core. More...

Macro Definition Documentation

◆ ENET_RM_PUBLIC_IOCTL

#define ENET_RM_PUBLIC_IOCTL ( x )

Value:

(ENET_IOCTL_TYPE_PUBLIC | \
                                               ENET_IOCTL_RM_BASE |     \
                                               ENET_IOCTL_PER_GENERIC | \
                                               ENET_IOCTL_MIN(x))

Helper macro to create IOCTL commands for Enet RM module.

◆ ENET_RM_TXCHNUM_INVALID

#define ENET_RM_TXCHNUM_INVALID (0xABCDABCDU)

Enet RM invalid TX channel number.

◆ ENET_RM_RXFLOWIDX_INVALID

#define ENET_RM_RXFLOWIDX_INVALID (0xABCDABCDU)

Enet RM invalid RX flow id.

◆ ENET_RM_UNDEFINED_NODEID

#define ENET_RM_UNDEFINED_NODEID (0xABCDABCDU)

Enet RM undefined node id.

◆ ENET_RM_INVALIDCORE

#define ENET_RM_INVALIDCORE (0x5562AEFEU)

Enet RM invalid core.

◆ ENET_RM_NUM_IOCTL_PERM_ENTRY_MAX

#define ENET_RM_NUM_IOCTL_PERM_ENTRY_MAX (16U)

Maximum number of entries for IOCTL permission.

◆ ENET_RM_NUM_MACADDR_MAX

#define ENET_RM_NUM_MACADDR_MAX (10U)

Maximum number of macaddress to be managed by RM.

◆ ENET_RM_NUM_RXCHAN_MAX

#define ENET_RM_NUM_RXCHAN_MAX (1U)

Maximum number of RX channels (i.e. sets of flows)

◆ ENET_RM_PRIVATE_IOCTL

#define ENET_RM_PRIVATE_IOCTL ( x )

Value:

(ENET_IOCTL_TYPE_PRIVATE | \
                                               ENET_IOCTL_RM_BASE |      \
                                               ENET_IOCTL_PER_GENERIC |  \
                                               ENET_IOCTL_MIN(x))

Helper macro to create private IOCTL commands for Enet RM module.

Typedef Documentation

◆ EnetRm_ValidateRxFlowInArgs

typedef EnetRm_FreeRxFlowInArgs EnetRm_ValidateRxFlowInArgs

Input args for ENET_RM_IOCTL_VALIDATE_RX_FLOW command.

◆ EnetRm_Handle

typedef EnetRm_Obj* EnetRm_Handle

Enet RM module handle.

Enumeration Type Documentation

◆ EnetRm_Ioctls

enum EnetRm_Ioctls

Enet RM IOCTL commands.

Enumerator
ENET_RM_IOCTL_ALLOC_MAC_ADDR	Alloc MAC address. IOCTL parameters: inArgs: uint32_t coreKey outArgs: EnetRm_AllocMacAddrOutArgs
ENET_RM_IOCTL_FREE_MAC_ADDR	Free MAC address. IOCTL parameters: inArgs: EnetRm_FreeMacAddrInArgs outArgs: None
ENET_RM_IOCTL_ALLOC_RX_FLOW	Alloc RX flow. IOCTL parameters: inArgs: EnetRm_AllocRxFlowInArgs outArgs: EnetRm_AllocRxFlow
ENET_RM_IOCTL_FREE_RX_FLOW	Free RX flow. IOCTL parameters: inArgs: EnetRm_FreeRxFlowInArgs outArgs: None
ENET_RM_IOCTL_ALLOC_TX_CH_PEERID	Alloc TX channel peer id. IOCTL parameters: inArgs: EnetRm_AllocTxChInArgs outArgs: uint32_t txPSILThreadId
ENET_RM_IOCTL_FREE_TX_CH_PEERID	Free TX channel peer id. IOCTL parameters: inArgs: EnetRm_FreeTxChInArgs outArgs: None
ENET_RM_IOCTL_ALLOC_HW_PUSH_INST	Alloc HW Push instance. IOCTL parameters: inArgs: uint32_t coreKey outArgs: EnetRm_AllocHwPushOutArgs
ENET_RM_IOCTL_FREE_HW_PUSH_INST	Free HW Push instance. IOCTL parameters: inArgs: EnetRm_FreeHwPushInArgs outArgs: None

◆ EnetRm_TxCh

enum EnetRm_TxCh

RM tx channel.

This enum holds the number of tx channel.

Enumerator
ENET_RM_TX_CH_0	Channel no 0
ENET_RM_TX_CH_1	Channel no 1
ENET_RM_TX_CH_2	Channel no 2
ENET_RM_TX_CH_3	Channel no 3
ENET_RM_TX_CH_4	Channel no 4
ENET_RM_TX_CH_5	Channel no 5
ENET_RM_TX_CH_6	Channel no 6
ENET_RM_TX_CH_7	Channel no 7
ENET_RM_TX_CH_LAST	Max number of tx channels available
ENET_RM_TX_CH_ANY	Default Channel

◆ EnetRm_NodeType

enum EnetRm_NodeType

Enet RM node types.

This enum holds type of node information

Enumerator
ENET_RM_NODE_NONE	Undefined Node
ENET_RM_NODE_TX	TX Node
ENET_RM_NODE_RX	RX Node
ENET_RM_NODE_MAC	MAC Node
ENET_RM_NODE_HW_PUSH	Hw Push Node

◆ EnetRm_PrivIoctls

enum EnetRm_PrivIoctls

Enet RM private IOCTL commands.

Enumerator
ENET_RM_IOCTL_VALIDATE_PERMISSION	Validate IOCTL permission. IOCTL parameters: inArgs: EnetRm_ValidatePermissionInArgs outArgs: None
ENET_RM_IOCTL_ATTACH	Attach core. IOCTL parameters: inArgs: uint32_t coreId outArgs: uint32_t coreKey
ENET_RM_IOCTL_DETACH	Detach core. IOCTL parameters: inArgs: uint32_t coreKey outArgs: None
ENET_RM_IOCTL_INTERNAL_ALLOC_RX_FLOW	Internal RX flow allocation. IOCTL parameters: inArgs: uint32_t coreId outArgs: EnetRm_AllocRxFlow rxAllocOutArgs
ENET_RM_IOCTL_INTERNAL_FREE_RX_FLOW	Internal RX flow free. IOCTL parameters: inArgs: EnetRm_FreeInternalRxFlowInArgs outArgs: None
ENET_RM_IOCTL_VALIDATE_RX_FLOW	Validate RX flow is allocated resource and is from a attached core. IOCTL parameters: inArgs: EnetRm_ValidateRxFlowInArgs outArgs: None

Function Documentation

◆ EnetRm_open()

int32_t EnetRm_open	(	EnetMod_Handle	hMod,
		Enet_Type	enetType,
		uint32_t	instId,
		const void *	cfg,
		uint32_t	cfgSize
	)

Open and initialize Enet RM module.

Parameters

hMod	Enet Module handle
enetType	Enet Peripheral type
instId	Enet Peripheral instance id
cfg	Configuration parameters
cfgSize	Size of the configuration parameters

Returns: Enet_ErrorCodes

◆ EnetRm_rejoin()

int32_t EnetRm_rejoin	(	EnetMod_Handle	hMod,
		Enet_Type	enetType,
		uint32_t	instId
	)

Rejoin Enet RM module for a running peripheral.

Parameters

hMod	Enet Module handle
enetType	Enet Peripheral type
instId	Enet Peripheral instance id

Returns: Enet_ErrorCodes

◆ EnetRm_ioctl()

int32_t EnetRm_ioctl	(	EnetMod_Handle	hMod,
		uint32_t	cmd,
		Enet_IoctlPrms *	prms
	)

Run an IOCTL operation on Enet RM.

Parameters

hMod	Enet Module handle
cmd	IOCTL command Id
prms	IOCTL parameters

Returns: Enet_ErrorCodes

◆ EnetRm_close()

void EnetRm_close ( EnetMod_Handle hMod )

Close Enet RM module.

Parameters

hMod	Enet Module handle

Introduction

Data Structures

Functions

Typedefs

Enumerations

Macros

Resource Manager Error Codes

Macro Definition Documentation

◆ ENET_RM_PUBLIC_IOCTL

◆ ENET_RM_TXCHNUM_INVALID

◆ ENET_RM_RXFLOWIDX_INVALID

◆ ENET_RM_UNDEFINED_NODEID

◆ ENET_RM_INVALIDCORE

◆ ENET_RM_NUM_IOCTL_PERM_ENTRY_MAX

◆ ENET_RM_NUM_MACADDR_MAX

◆ ENET_RM_NUM_RXCHAN_MAX

◆ ENET_RM_PRIVATE_IOCTL

Typedef Documentation

◆ EnetRm_ValidateRxFlowInArgs

◆ EnetRm_Handle

Enumeration Type Documentation

◆ EnetRm_Ioctls

◆ EnetRm_TxCh

◆ EnetRm_NodeType

◆ EnetRm_PrivIoctls

Function Documentation

◆ EnetRm_open()

◆ EnetRm_rejoin()

◆ EnetRm_ioctl()

◆ EnetRm_close()