PDK API Guide for AM65xx
cpsw_ale_priv.h File Reference

Introduction

This file contains private type definitions and helper macros for the CPSW ALE module which are meant for internal use in Enet Per drivers.

Go to the source code of this file.

Data Structures

struct  CpswAle_Obj
 CPSW ALE object. More...
 

Macros

#define CPSW_ALE_FEATURE_FLOW_PRIORITY   (ENET_BIT(0U))
 Flow priority feature mask. More...
 
#define CPSW_ALE_FEATURE_IP_HDR_WHITELIST   (ENET_BIT(1U))
 IP header white-list feature mask. More...
 

Typedefs

typedef CpswAle_ObjCpswAle_Handle
 CPSW ALE module handle. More...
 

Enumerations

enum  CpswAle_AddrType { CPSW_ALE_ADDR_TYPE_SRC, CPSW_ALE_ADDR_TYPE_DST }
 Address type: source or destination. More...
 

Functions

int32_t CpswAle_open (EnetMod_Handle hMod, Enet_Type enetType, uint32_t instId, const void *cfg, uint32_t cfgSize)
 Open and initialize CPSW ALE. More...
 
int32_t CpswAle_rejoin (EnetMod_Handle hMod, Enet_Type enetType, uint32_t instId)
 Rejoin a running CPSW ALE module. More...
 
int32_t CpswAle_ioctl (EnetMod_Handle hMod, uint32_t cmd, Enet_IoctlPrms *prms)
 Run an IOCTL operation on CPSW ALE. More...
 
void CpswAle_close (EnetMod_Handle hMod)
 Close CPSW ALE. More...
 

Macro Definition Documentation

◆ CPSW_ALE_FEATURE_FLOW_PRIORITY

#define CPSW_ALE_FEATURE_FLOW_PRIORITY   (ENET_BIT(0U))

Flow priority feature mask.

◆ CPSW_ALE_FEATURE_IP_HDR_WHITELIST

#define CPSW_ALE_FEATURE_IP_HDR_WHITELIST   (ENET_BIT(1U))

IP header white-list feature mask.

Typedef Documentation

◆ CpswAle_Handle

CPSW ALE module handle.

Enumeration Type Documentation

◆ CpswAle_AddrType

Address type: source or destination.

Enumerator
CPSW_ALE_ADDR_TYPE_SRC 

Source address type

CPSW_ALE_ADDR_TYPE_DST 

Destination address type

Function Documentation

◆ CpswAle_open()

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

Open and initialize CPSW ALE.

Parameters
hModEnet Module handle
enetTypeEnet Peripheral type
instIdEnet Peripheral instance id
cfgConfiguration parameters
cfgSizeSize of the configuration parameters
Returns
Enet_ErrorCodes

◆ CpswAle_rejoin()

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

Rejoin a running CPSW ALE module.

Parameters
hModEnet Module handle
enetTypeEnet Peripheral type
instIdEnet Peripheral instance id
Returns
Enet_ErrorCodes

◆ CpswAle_ioctl()

int32_t CpswAle_ioctl ( EnetMod_Handle  hMod,
uint32_t  cmd,
Enet_IoctlPrms prms 
)

Run an IOCTL operation on CPSW ALE.

Parameters
hModEnet Module handle
cmdIOCTL command Id
prmsIOCTL parameters
Returns
Enet_ErrorCodes

◆ CpswAle_close()

void CpswAle_close ( EnetMod_Handle  hMod)

Close CPSW ALE.

Parameters
hModEnet Module handle