RDK-B
Data Structures | Macros | Typedefs | Enumerations
Ethernet Switch HAL Data Types
Ethernet Switch HAL

Description

Data Structures

struct  _CCSP_HAL_ETH_STATS
 
struct  _eth_device
 
struct  __appCallBack
 

Macros

#define ULONG   unsigned long
 
#define ULLONG   unsigned long long
 
#define CHAR   char
 
#define UCHAR   unsigned char
 
#define BOOLEAN   UCHAR
 
#define INT   int
 
#define UINT   unsigned int
 
#define TRUE   1
 
#define FALSE   0
 
#define ENABLE   1
 
#define RETURN_OK   0
 
#define RETURN_ERR   -1
 
#define ETHWAN_DEF_INTF_NUM   0
 
#define ETHWAN_INTERFACE_NAME_MAX_LENGTH   32
 

Typedefs

typedef enum _CCSP_HAL_ETHSW_PORT CCSP_HAL_ETHSW_PORT
 
typedef enum _CCSP_HAL_ETHSW_PORT * PCCSP_HAL_ETHSW_PORT
 
typedef enum _CCSP_HAL_ETHSW_LINK_RATE CCSP_HAL_ETHSW_LINK_RATE
 
typedef enum _CCSP_HAL_ETHSW_LINK_RATE * PCCSP_HAL_ETHSW_LINK_RATE
 
typedef enum _CCSP_HAL_ETHSW_DUPLEX_MODE CCSP_HAL_ETHSW_DUPLEX_MODE
 
typedef enum _CCSP_HAL_ETHSW_DUPLEX_MODE * PCCSP_HAL_ETHSW_DUPLEX_MODE
 
typedef enum _CCSP_HAL_ETHSW_LINK_STATUS CCSP_HAL_ETHSW_LINK_STATUS
 
typedef enum _CCSP_HAL_ETHSW_LINK_STATUS * PCCSP_HAL_ETHSW_LINK_STATUS
 
typedef enum _CCSP_HAL_ETHSW_ADMIN_STATUS CCSP_HAL_ETHSW_ADMIN_STATUS
 
typedef enum _CCSP_HAL_ETHSW_ADMIN_STATUS * PCCSP_HAL_ETHSW_ADMIN_STATUS
 
typedef struct _CCSP_HAL_ETH_STATS CCSP_HAL_ETH_STATS
 
typedef struct _CCSP_HAL_ETH_STATS * PCCSP_HAL_ETH_STATS
 
typedef struct _eth_device eth_device_t
 
typedef void(* fpEthWanLink_Up) ()
 
typedef void(* fpEthWanLink_Down) ()
 
typedef struct __appCallBack appCallBack
 

Enumerations

enum  _CCSP_HAL_ETHSW_PORT {
  CCSP_HAL_ETHSW_EthPort1 = 1, CCSP_HAL_ETHSW_EthPort2, CCSP_HAL_ETHSW_EthPort3, CCSP_HAL_ETHSW_EthPort4,
  CCSP_HAL_ETHSW_EthPort5, CCSP_HAL_ETHSW_EthPort6, CCSP_HAL_ETHSW_EthPort7, CCSP_HAL_ETHSW_EthPort8,
  CCSP_HAL_ETHSW_Moca1, CCSP_HAL_ETHSW_Moca2, CCSP_HAL_ETHSW_Wlan1, CCSP_HAL_ETHSW_Wlan2,
  CCSP_HAL_ETHSW_Wlan3, CCSP_HAL_ETHSW_Wlan4, CCSP_HAL_ETHSW_Processor1, CCSP_HAL_ETHSW_Processor2,
  CCSP_HAL_ETHSW_InterconnectPort1, CCSP_HAL_ETHSW_InterconnectPort2, CCSP_HAL_ETHSW_MgmtPort, CCSP_HAL_ETHSW_PortMax
}
 
enum  _CCSP_HAL_ETHSW_LINK_RATE {
  CCSP_HAL_ETHSW_LINK_NULL = 0, CCSP_HAL_ETHSW_LINK_10Mbps, CCSP_HAL_ETHSW_LINK_100Mbps, CCSP_HAL_ETHSW_LINK_1Gbps,
  CCSP_HAL_ETHSW_LINK_2_5Gbps, CCSP_HAL_ETHSW_LINK_5Gbps, CCSP_HAL_ETHSW_LINK_10Gbps, CCSP_HAL_ETHSW_LINK_Auto
}
 
enum  _CCSP_HAL_ETHSW_DUPLEX_MODE { CCSP_HAL_ETHSW_DUPLEX_Auto = 0, CCSP_HAL_ETHSW_DUPLEX_Half, CCSP_HAL_ETHSW_DUPLEX_Full }
 
enum  _CCSP_HAL_ETHSW_LINK_STATUS { CCSP_HAL_ETHSW_LINK_Up = 0, CCSP_HAL_ETHSW_LINK_Down, CCSP_HAL_ETHSW_LINK_Disconnected }
 
enum  _CCSP_HAL_ETHSW_ADMIN_STATUS { CCSP_HAL_ETHSW_AdminUp = 0, CCSP_HAL_ETHSW_AdminDown, CCSP_HAL_ETHSW_AdminTest }
 

Data Structure Documentation

◆ _CCSP_HAL_ETH_STATS

struct _CCSP_HAL_ETH_STATS

Definition at line 248 of file ccsp_hal_ethsw.h.

Collaboration diagram for _CCSP_HAL_ETH_STATS:
Collaboration graph

Data Fields

unsigned long long BytesSent
 
unsigned long long BytesReceived
 
unsigned long PacketsSent
 
unsigned long PacketsReceived
 
unsigned long ErrorsSent
 
unsigned long ErrorsReceived
 
unsigned long UnicastPacketsSent
 
unsigned long UnicastPacketsReceived
 
unsigned long DiscardPacketsSent
 
unsigned long DiscardPacketsReceived
 
unsigned long MulticastPacketsSent
 
unsigned long MulticastPacketsReceived
 
unsigned long BroadcastPacketsSent
 
unsigned long BroadcastPacketsReceived
 
unsigned long UnknownProtoPacketsReceived
 

Field Documentation

◆ BytesSent

unsigned long long _CCSP_HAL_ETH_STATS::BytesSent

Definition at line 251 of file ccsp_hal_ethsw.h.

◆ BytesReceived

unsigned long long _CCSP_HAL_ETH_STATS::BytesReceived

Definition at line 252 of file ccsp_hal_ethsw.h.

◆ PacketsSent

unsigned long _CCSP_HAL_ETH_STATS::PacketsSent

Definition at line 253 of file ccsp_hal_ethsw.h.

◆ PacketsReceived

unsigned long _CCSP_HAL_ETH_STATS::PacketsReceived

Definition at line 254 of file ccsp_hal_ethsw.h.

◆ ErrorsSent

unsigned long _CCSP_HAL_ETH_STATS::ErrorsSent

Definition at line 255 of file ccsp_hal_ethsw.h.

◆ ErrorsReceived

unsigned long _CCSP_HAL_ETH_STATS::ErrorsReceived

Definition at line 256 of file ccsp_hal_ethsw.h.

◆ UnicastPacketsSent

unsigned long _CCSP_HAL_ETH_STATS::UnicastPacketsSent

Definition at line 257 of file ccsp_hal_ethsw.h.

◆ UnicastPacketsReceived

unsigned long _CCSP_HAL_ETH_STATS::UnicastPacketsReceived

Definition at line 258 of file ccsp_hal_ethsw.h.

◆ DiscardPacketsSent

unsigned long _CCSP_HAL_ETH_STATS::DiscardPacketsSent

Definition at line 259 of file ccsp_hal_ethsw.h.

◆ DiscardPacketsReceived

unsigned long _CCSP_HAL_ETH_STATS::DiscardPacketsReceived

Definition at line 260 of file ccsp_hal_ethsw.h.

◆ MulticastPacketsSent

unsigned long _CCSP_HAL_ETH_STATS::MulticastPacketsSent

Definition at line 261 of file ccsp_hal_ethsw.h.

◆ MulticastPacketsReceived

unsigned long _CCSP_HAL_ETH_STATS::MulticastPacketsReceived

Definition at line 262 of file ccsp_hal_ethsw.h.

◆ BroadcastPacketsSent

unsigned long _CCSP_HAL_ETH_STATS::BroadcastPacketsSent

Definition at line 263 of file ccsp_hal_ethsw.h.

◆ BroadcastPacketsReceived

unsigned long _CCSP_HAL_ETH_STATS::BroadcastPacketsReceived

Definition at line 264 of file ccsp_hal_ethsw.h.

◆ UnknownProtoPacketsReceived

unsigned long _CCSP_HAL_ETH_STATS::UnknownProtoPacketsReceived

Definition at line 265 of file ccsp_hal_ethsw.h.

◆ _eth_device

struct _eth_device

Definition at line 519 of file ccsp_hal_ethsw.h.

Collaboration diagram for _eth_device:
Collaboration graph

Data Fields

unsigned char eth_devMacAddress [6]
 
int eth_port
 which external port the device attached to. index start from 0 More...
 
int eth_vlanid
 what vlan ID the the port tagged. More...
 
int eth_devTxRate
 
int eth_devRxRate
 
unsigned char eth_Active
 

Field Documentation

◆ eth_devMacAddress

unsigned char _eth_device::eth_devMacAddress[6]

Definition at line 520 of file ccsp_hal_ethsw.h.

◆ eth_port

int _eth_device::eth_port

which external port the device attached to. index start from 0

Definition at line 521 of file ccsp_hal_ethsw.h.

◆ eth_vlanid

int _eth_device::eth_vlanid

what vlan ID the the port tagged.

Definition at line 522 of file ccsp_hal_ethsw.h.

◆ eth_devTxRate

int _eth_device::eth_devTxRate

Definition at line 523 of file ccsp_hal_ethsw.h.

◆ eth_devRxRate

int _eth_device::eth_devRxRate

Definition at line 524 of file ccsp_hal_ethsw.h.

◆ eth_Active

unsigned char _eth_device::eth_Active

Definition at line 525 of file ccsp_hal_ethsw.h.

◆ __appCallBack

struct __appCallBack

Definition at line 685 of file ccsp_hal_ethsw.h.

Collaboration diagram for __appCallBack:
Collaboration graph

Data Fields

fpEthWanLink_Up pGWP_act_EthWanLinkUP
 
fpEthWanLink_Down pGWP_act_EthWanLinkDown
 

Field Documentation

◆ pGWP_act_EthWanLinkUP

fpEthWanLink_Up __appCallBack::pGWP_act_EthWanLinkUP

Definition at line 687 of file ccsp_hal_ethsw.h.

◆ pGWP_act_EthWanLinkDown

fpEthWanLink_Down __appCallBack::pGWP_act_EthWanLinkDown

Definition at line 688 of file ccsp_hal_ethsw.h.

Macro Definition Documentation

◆ ULONG

#define ULONG   unsigned long

Definition at line 96 of file ccsp_hal_ethsw.h.

◆ ULLONG

#define ULLONG   unsigned long long

Definition at line 100 of file ccsp_hal_ethsw.h.

◆ CHAR

#define CHAR   char

Definition at line 104 of file ccsp_hal_ethsw.h.

◆ UCHAR

#define UCHAR   unsigned char

Definition at line 108 of file ccsp_hal_ethsw.h.

◆ BOOLEAN

#define BOOLEAN   UCHAR

Definition at line 112 of file ccsp_hal_ethsw.h.

◆ INT

#define INT   int

Definition at line 116 of file ccsp_hal_ethsw.h.

◆ UINT

#define UINT   unsigned int

Definition at line 120 of file ccsp_hal_ethsw.h.

◆ TRUE

#define TRUE   1

Definition at line 124 of file ccsp_hal_ethsw.h.

◆ FALSE

#define FALSE   0

Definition at line 128 of file ccsp_hal_ethsw.h.

◆ ENABLE

#define ENABLE   1

Definition at line 132 of file ccsp_hal_ethsw.h.

◆ RETURN_OK

#define RETURN_OK   0

Definition at line 136 of file ccsp_hal_ethsw.h.

◆ RETURN_ERR

#define RETURN_ERR   -1

Definition at line 140 of file ccsp_hal_ethsw.h.

◆ ETHWAN_DEF_INTF_NUM

#define ETHWAN_DEF_INTF_NUM   0

Definition at line 155 of file ccsp_hal_ethsw.h.

◆ ETHWAN_INTERFACE_NAME_MAX_LENGTH

#define ETHWAN_INTERFACE_NAME_MAX_LENGTH   32

Definition at line 164 of file ccsp_hal_ethsw.h.

Typedef Documentation

◆ CCSP_HAL_ETHSW_PORT

typedef enum _CCSP_HAL_ETHSW_PORT CCSP_HAL_ETHSW_PORT

◆ PCCSP_HAL_ETHSW_PORT

typedef enum _CCSP_HAL_ETHSW_PORT * PCCSP_HAL_ETHSW_PORT

◆ CCSP_HAL_ETHSW_LINK_RATE

typedef enum _CCSP_HAL_ETHSW_LINK_RATE CCSP_HAL_ETHSW_LINK_RATE

◆ PCCSP_HAL_ETHSW_LINK_RATE

typedef enum _CCSP_HAL_ETHSW_LINK_RATE * PCCSP_HAL_ETHSW_LINK_RATE

◆ CCSP_HAL_ETHSW_DUPLEX_MODE

typedef enum _CCSP_HAL_ETHSW_DUPLEX_MODE CCSP_HAL_ETHSW_DUPLEX_MODE

◆ PCCSP_HAL_ETHSW_DUPLEX_MODE

typedef enum _CCSP_HAL_ETHSW_DUPLEX_MODE * PCCSP_HAL_ETHSW_DUPLEX_MODE

◆ CCSP_HAL_ETHSW_LINK_STATUS

typedef enum _CCSP_HAL_ETHSW_LINK_STATUS CCSP_HAL_ETHSW_LINK_STATUS

◆ PCCSP_HAL_ETHSW_LINK_STATUS

typedef enum _CCSP_HAL_ETHSW_LINK_STATUS * PCCSP_HAL_ETHSW_LINK_STATUS

◆ CCSP_HAL_ETHSW_ADMIN_STATUS

typedef enum _CCSP_HAL_ETHSW_ADMIN_STATUS CCSP_HAL_ETHSW_ADMIN_STATUS

◆ PCCSP_HAL_ETHSW_ADMIN_STATUS

typedef enum _CCSP_HAL_ETHSW_ADMIN_STATUS * PCCSP_HAL_ETHSW_ADMIN_STATUS

◆ CCSP_HAL_ETH_STATS

typedef struct _CCSP_HAL_ETH_STATS CCSP_HAL_ETH_STATS

◆ PCCSP_HAL_ETH_STATS

typedef struct _CCSP_HAL_ETH_STATS * PCCSP_HAL_ETH_STATS

◆ eth_device_t

typedef struct _eth_device eth_device_t

◆ fpEthWanLink_Up

typedef void( * fpEthWanLink_Up) ()

RDKB expects this callback once EthWan link is UP

Definition at line 678 of file ccsp_hal_ethsw.h.

◆ fpEthWanLink_Down

typedef void( * fpEthWanLink_Down) ()

RDKB expects this callback once EthWan link is Down

Definition at line 679 of file ccsp_hal_ethsw.h.

◆ appCallBack

typedef struct __appCallBack appCallBack

Enumeration Type Documentation

◆ _CCSP_HAL_ETHSW_PORT

enum _CCSP_HAL_ETHSW_PORT
Enumerator
CCSP_HAL_ETHSW_EthPort1 
CCSP_HAL_ETHSW_EthPort2 
CCSP_HAL_ETHSW_EthPort3 
CCSP_HAL_ETHSW_EthPort4 
CCSP_HAL_ETHSW_EthPort5 
CCSP_HAL_ETHSW_EthPort6 
CCSP_HAL_ETHSW_EthPort7 
CCSP_HAL_ETHSW_EthPort8 
CCSP_HAL_ETHSW_Moca1 
CCSP_HAL_ETHSW_Moca2 
CCSP_HAL_ETHSW_Wlan1 
CCSP_HAL_ETHSW_Wlan2 
CCSP_HAL_ETHSW_Wlan3 
CCSP_HAL_ETHSW_Wlan4 
CCSP_HAL_ETHSW_Processor1 
CCSP_HAL_ETHSW_Processor2 
CCSP_HAL_ETHSW_InterconnectPort1 
CCSP_HAL_ETHSW_InterconnectPort2 
CCSP_HAL_ETHSW_MgmtPort 
CCSP_HAL_ETHSW_PortMax 

Definition at line 171 of file ccsp_hal_ethsw.h.

◆ _CCSP_HAL_ETHSW_LINK_RATE

enum _CCSP_HAL_ETHSW_LINK_RATE
Enumerator
CCSP_HAL_ETHSW_LINK_NULL 
CCSP_HAL_ETHSW_LINK_10Mbps 
CCSP_HAL_ETHSW_LINK_100Mbps 
CCSP_HAL_ETHSW_LINK_1Gbps 
CCSP_HAL_ETHSW_LINK_2_5Gbps 
CCSP_HAL_ETHSW_LINK_5Gbps 
CCSP_HAL_ETHSW_LINK_10Gbps 
CCSP_HAL_ETHSW_LINK_Auto 

Definition at line 203 of file ccsp_hal_ethsw.h.

◆ _CCSP_HAL_ETHSW_DUPLEX_MODE

enum _CCSP_HAL_ETHSW_DUPLEX_MODE
Enumerator
CCSP_HAL_ETHSW_DUPLEX_Auto 
CCSP_HAL_ETHSW_DUPLEX_Half 
CCSP_HAL_ETHSW_DUPLEX_Full 

Definition at line 218 of file ccsp_hal_ethsw.h.

◆ _CCSP_HAL_ETHSW_LINK_STATUS

enum _CCSP_HAL_ETHSW_LINK_STATUS
Enumerator
CCSP_HAL_ETHSW_LINK_Up 
CCSP_HAL_ETHSW_LINK_Down 
CCSP_HAL_ETHSW_LINK_Disconnected 

Definition at line 228 of file ccsp_hal_ethsw.h.

◆ _CCSP_HAL_ETHSW_ADMIN_STATUS

enum _CCSP_HAL_ETHSW_ADMIN_STATUS
Enumerator
CCSP_HAL_ETHSW_AdminUp 
CCSP_HAL_ETHSW_AdminDown 
CCSP_HAL_ETHSW_AdminTest 

Definition at line 238 of file ccsp_hal_ethsw.h.