RDK-B
Data Structures | Macros | Typedefs
DPoE HAL Data Types
DPoE HAL

Description

Data Structures

struct  dpoe_mac_address
 
struct  dpoe_link_mac_address
 
struct  dpoe_firmware_info
 
struct  dpoe_epon_chip_info
 
struct  dpoe_manufacturer_date
 
struct  dpoe_manufacturer
 
struct  dpoe_onu_packet_buffer_capabilities
 
struct  dpoe_device_sys_descr_info
 
struct  dpoe_onu_max_logical_links
 
struct  dpoe_traffic_stats
 
struct  dpoe_link_traffic_stats
 
struct  dpoe_link_forwarding_state
 
struct  dpoe_link_oam_frame_rate
 
struct  dpoe_link_encrypt_expiry_time
 
struct  dpoe_link_encrypt_mode
 

Macros

#define CHAR   char
 
#define UCHAR   unsigned char
 
#define BOOLEAN   unsigned char
 
#define USHORT   unsigned short
 
#define INT   int
 
#define UINT8   unsigned char
 
#define ULONG   unsigned long
 
#define ULONGLONG   unsigned long long
 
#define TRUE   1
 
#define FALSE   0
 
#define RETURN_OK   0
 
#define RETURN_ERR   -1
 
#define DPOE_HAL_MAJOR_VERSION   1
 This is the major version of this HAL. More...
 
#define DPOE_HAL_MINOR_VERSION   0
 This is the minor version of the HAL. More...
 
#define DPOE_HAL_MAINTENANCE_VERSION   1
 This is the maintenance version of the HAL. More...
 

Typedefs

typedef struct dpoe_mac_address dpoe_mac_address_t
 
typedef struct dpoe_link_mac_address dpoe_link_mac_address_t
 
typedef struct dpoe_firmware_info dpoe_firmware_info_t
 
typedef struct dpoe_epon_chip_info dpoe_epon_chip_info_t
 
typedef struct dpoe_manufacturer_date dpoe_manufacturer_date_t
 
typedef struct dpoe_manufacturer dpoe_manufacturer_t
 
typedef struct dpoe_onu_packet_buffer_capabilities dpoe_onu_packet_buffer_capabilities_t
 
typedef struct dpoe_device_sys_descr_info dpoe_device_sys_descr_info_t
 
typedef struct dpoe_onu_max_logical_links dpoe_onu_max_logical_links_t
 
typedef struct dpoe_traffic_stats dpoe_traffic_stats_t
 
typedef struct dpoe_link_traffic_stats dpoe_link_traffic_stats_t
 
typedef struct dpoe_link_forwarding_state dpoe_link_forwarding_state_t
 
typedef struct dpoe_link_oam_frame_rate dpoe_link_oam_frame_rate_t
 
typedef struct dpoe_link_encrypt_expiry_time dpoe_link_encrypt_expiry_time_t
 
typedef struct dpoe_link_encrypt_mode dpoe_link_encrypt_mode_t
 

Data Structure Documentation

◆ dpoe_mac_address

struct dpoe_mac_address

Definition at line 146 of file dpoe_hal.h.

Collaboration diagram for dpoe_mac_address:
Collaboration graph

Data Fields

unsigned char macAddress [6]
 

Field Documentation

◆ macAddress

unsigned char dpoe_mac_address::macAddress[6]

Definition at line 150 of file dpoe_hal.h.

◆ dpoe_link_mac_address

struct dpoe_link_mac_address

Definition at line 151 of file dpoe_hal.h.

Collaboration diagram for dpoe_link_mac_address:
Collaboration graph

Data Fields

unsigned short numEntries
 
dpoe_mac_address_t * pMacAddress
 

Field Documentation

◆ numEntries

unsigned short dpoe_link_mac_address::numEntries

Definition at line 153 of file dpoe_hal.h.

◆ pMacAddress

dpoe_mac_address_t* dpoe_link_mac_address::pMacAddress

Definition at line 154 of file dpoe_hal.h.

◆ dpoe_firmware_info

struct dpoe_firmware_info

Definition at line 157 of file dpoe_hal.h.

Collaboration diagram for dpoe_firmware_info:
Collaboration graph

Data Fields

unsigned short info_bootVersion
 
unsigned long info_bootCrc32
 
unsigned short info_appVersion
 
unsigned long info_appCrc32
 

Field Documentation

◆ info_bootVersion

unsigned short dpoe_firmware_info::info_bootVersion

Definition at line 159 of file dpoe_hal.h.

◆ info_bootCrc32

unsigned long dpoe_firmware_info::info_bootCrc32

Definition at line 160 of file dpoe_hal.h.

◆ info_appVersion

unsigned short dpoe_firmware_info::info_appVersion

Definition at line 161 of file dpoe_hal.h.

◆ info_appCrc32

unsigned long dpoe_firmware_info::info_appCrc32

Definition at line 162 of file dpoe_hal.h.

◆ dpoe_epon_chip_info

struct dpoe_epon_chip_info

Definition at line 165 of file dpoe_hal.h.

Collaboration diagram for dpoe_epon_chip_info:
Collaboration graph

Data Fields

unsigned short info_JedecId
 
unsigned long info_ChipModel
 
unsigned long info_ChipVersion
 

Field Documentation

◆ info_JedecId

unsigned short dpoe_epon_chip_info::info_JedecId

Definition at line 167 of file dpoe_hal.h.

◆ info_ChipModel

unsigned long dpoe_epon_chip_info::info_ChipModel

Definition at line 168 of file dpoe_hal.h.

◆ info_ChipVersion

unsigned long dpoe_epon_chip_info::info_ChipVersion

Definition at line 169 of file dpoe_hal.h.

◆ dpoe_manufacturer_date

struct dpoe_manufacturer_date

Definition at line 172 of file dpoe_hal.h.

Collaboration diagram for dpoe_manufacturer_date:
Collaboration graph

Data Fields

unsigned short manufacturer_DateYear
 
unsigned char manufacturer_DateMonth
 
unsigned char manufacturer_DateDay
 

Field Documentation

◆ manufacturer_DateYear

unsigned short dpoe_manufacturer_date::manufacturer_DateYear

Definition at line 174 of file dpoe_hal.h.

◆ manufacturer_DateMonth

unsigned char dpoe_manufacturer_date::manufacturer_DateMonth

Definition at line 175 of file dpoe_hal.h.

◆ manufacturer_DateDay

unsigned char dpoe_manufacturer_date::manufacturer_DateDay

Definition at line 176 of file dpoe_hal.h.

◆ dpoe_manufacturer

struct dpoe_manufacturer

Definition at line 179 of file dpoe_hal.h.

Collaboration diagram for dpoe_manufacturer:
Collaboration graph

Data Fields

unsigned char manufacturer_Info [255]
 
unsigned char manufacturer_OrganizationName [255]
 
dpoe_manufacturer_date_t manufacturer_Date
 

Field Documentation

◆ manufacturer_Info

unsigned char dpoe_manufacturer::manufacturer_Info[255]

Definition at line 181 of file dpoe_hal.h.

◆ manufacturer_OrganizationName

unsigned char dpoe_manufacturer::manufacturer_OrganizationName[255]

Definition at line 182 of file dpoe_hal.h.

◆ manufacturer_Date

dpoe_manufacturer_date_t dpoe_manufacturer::manufacturer_Date

Definition at line 183 of file dpoe_hal.h.

◆ dpoe_onu_packet_buffer_capabilities

struct dpoe_onu_packet_buffer_capabilities

Definition at line 186 of file dpoe_hal.h.

Collaboration diagram for dpoe_onu_packet_buffer_capabilities:
Collaboration graph

Data Fields

unsigned char capabilities_UpstreamQueues
 
unsigned char capabilities_UpQueuesMaxPerLink
 
unsigned char capabilities_UpQueueIncrement
 
unsigned char capabilities_DownstreamQueues
 
unsigned char capabilities_DnQueuesMaxPerPort
 
unsigned char capabilities_DnQueueIncrement
 
unsigned short capabilities_TotalPacketBuffer
 
unsigned short capabilities_UpPacketBuffer
 
unsigned short capabilities_DnPacketBuffer
 

Field Documentation

◆ capabilities_UpstreamQueues

unsigned char dpoe_onu_packet_buffer_capabilities::capabilities_UpstreamQueues

Definition at line 188 of file dpoe_hal.h.

◆ capabilities_UpQueuesMaxPerLink

unsigned char dpoe_onu_packet_buffer_capabilities::capabilities_UpQueuesMaxPerLink

Definition at line 189 of file dpoe_hal.h.

◆ capabilities_UpQueueIncrement

unsigned char dpoe_onu_packet_buffer_capabilities::capabilities_UpQueueIncrement

Definition at line 190 of file dpoe_hal.h.

◆ capabilities_DownstreamQueues

unsigned char dpoe_onu_packet_buffer_capabilities::capabilities_DownstreamQueues

Definition at line 191 of file dpoe_hal.h.

◆ capabilities_DnQueuesMaxPerPort

unsigned char dpoe_onu_packet_buffer_capabilities::capabilities_DnQueuesMaxPerPort

Definition at line 192 of file dpoe_hal.h.

◆ capabilities_DnQueueIncrement

unsigned char dpoe_onu_packet_buffer_capabilities::capabilities_DnQueueIncrement

Definition at line 193 of file dpoe_hal.h.

◆ capabilities_TotalPacketBuffer

unsigned short dpoe_onu_packet_buffer_capabilities::capabilities_TotalPacketBuffer

Definition at line 194 of file dpoe_hal.h.

◆ capabilities_UpPacketBuffer

unsigned short dpoe_onu_packet_buffer_capabilities::capabilities_UpPacketBuffer

Definition at line 195 of file dpoe_hal.h.

◆ capabilities_DnPacketBuffer

unsigned short dpoe_onu_packet_buffer_capabilities::capabilities_DnPacketBuffer

Definition at line 196 of file dpoe_hal.h.

◆ dpoe_device_sys_descr_info

struct dpoe_device_sys_descr_info

Definition at line 200 of file dpoe_hal.h.

Collaboration diagram for dpoe_device_sys_descr_info:
Collaboration graph

Data Fields

unsigned char info_VendorName [32]
 
unsigned char info_ModelNumber [32]
 
unsigned char info_HardwareVersion [32]
 

Field Documentation

◆ info_VendorName

unsigned char dpoe_device_sys_descr_info::info_VendorName[32]

Definition at line 202 of file dpoe_hal.h.

◆ info_ModelNumber

unsigned char dpoe_device_sys_descr_info::info_ModelNumber[32]

Definition at line 203 of file dpoe_hal.h.

◆ info_HardwareVersion

unsigned char dpoe_device_sys_descr_info::info_HardwareVersion[32]

Definition at line 204 of file dpoe_hal.h.

◆ dpoe_onu_max_logical_links

struct dpoe_onu_max_logical_links

Definition at line 207 of file dpoe_hal.h.

Collaboration diagram for dpoe_onu_max_logical_links:
Collaboration graph

Data Fields

unsigned short links_bidirectional
 
unsigned short links_downstreamonly
 

Field Documentation

◆ links_bidirectional

unsigned short dpoe_onu_max_logical_links::links_bidirectional

Definition at line 209 of file dpoe_hal.h.

◆ links_downstreamonly

unsigned short dpoe_onu_max_logical_links::links_downstreamonly

Definition at line 210 of file dpoe_hal.h.

◆ dpoe_traffic_stats

struct dpoe_traffic_stats

Definition at line 214 of file dpoe_hal.h.

Collaboration diagram for dpoe_traffic_stats:
Collaboration graph

Data Fields

unsigned long long port_RxUnicastFrames
 
unsigned long long port_TxUnicastFrames
 
unsigned long long port_RxFrameTooShort
 
unsigned long long port_RxFrame64
 
unsigned long long port_RxFrame65_127
 
unsigned long long port_RxFrame128_255
 
unsigned long long port_RxFrame256_511
 
unsigned long long port_RxFrame512_1023
 
unsigned long long port_RxFrame1024_1518
 
unsigned long long port_RxFrame1519_Plus
 
unsigned long long port_TxFrame64
 
unsigned long long port_TxFrame65_127
 
unsigned long long port_TxFrame128_255
 
unsigned long long port_TxFrame256_511
 
unsigned long long port_TxFrame512_1023
 
unsigned long long port_TxFrame_1024_1518
 
unsigned long long port_TxFrame_1519_Plus
 
unsigned long long port_FramesDropped
 
unsigned long long port_BytesDropped
 
unsigned short port_OpticalMonVcc
 
unsigned short port_OpticalMonTxBiasCurrent
 
unsigned short port_OpticalMonTxPower
 
unsigned short port_OpticalMonRxPower
 

Field Documentation

◆ port_RxUnicastFrames

unsigned long long dpoe_traffic_stats::port_RxUnicastFrames

Definition at line 216 of file dpoe_hal.h.

◆ port_TxUnicastFrames

unsigned long long dpoe_traffic_stats::port_TxUnicastFrames

Definition at line 217 of file dpoe_hal.h.

◆ port_RxFrameTooShort

unsigned long long dpoe_traffic_stats::port_RxFrameTooShort

Definition at line 218 of file dpoe_hal.h.

◆ port_RxFrame64

unsigned long long dpoe_traffic_stats::port_RxFrame64

Definition at line 219 of file dpoe_hal.h.

◆ port_RxFrame65_127

unsigned long long dpoe_traffic_stats::port_RxFrame65_127

Definition at line 220 of file dpoe_hal.h.

◆ port_RxFrame128_255

unsigned long long dpoe_traffic_stats::port_RxFrame128_255

Definition at line 221 of file dpoe_hal.h.

◆ port_RxFrame256_511

unsigned long long dpoe_traffic_stats::port_RxFrame256_511

Definition at line 222 of file dpoe_hal.h.

◆ port_RxFrame512_1023

unsigned long long dpoe_traffic_stats::port_RxFrame512_1023

Definition at line 223 of file dpoe_hal.h.

◆ port_RxFrame1024_1518

unsigned long long dpoe_traffic_stats::port_RxFrame1024_1518

Definition at line 224 of file dpoe_hal.h.

◆ port_RxFrame1519_Plus

unsigned long long dpoe_traffic_stats::port_RxFrame1519_Plus

Definition at line 225 of file dpoe_hal.h.

◆ port_TxFrame64

unsigned long long dpoe_traffic_stats::port_TxFrame64

Definition at line 226 of file dpoe_hal.h.

◆ port_TxFrame65_127

unsigned long long dpoe_traffic_stats::port_TxFrame65_127

Definition at line 227 of file dpoe_hal.h.

◆ port_TxFrame128_255

unsigned long long dpoe_traffic_stats::port_TxFrame128_255

Definition at line 228 of file dpoe_hal.h.

◆ port_TxFrame256_511

unsigned long long dpoe_traffic_stats::port_TxFrame256_511

Definition at line 229 of file dpoe_hal.h.

◆ port_TxFrame512_1023

unsigned long long dpoe_traffic_stats::port_TxFrame512_1023

Definition at line 230 of file dpoe_hal.h.

◆ port_TxFrame_1024_1518

unsigned long long dpoe_traffic_stats::port_TxFrame_1024_1518

Definition at line 231 of file dpoe_hal.h.

◆ port_TxFrame_1519_Plus

unsigned long long dpoe_traffic_stats::port_TxFrame_1519_Plus

Definition at line 232 of file dpoe_hal.h.

◆ port_FramesDropped

unsigned long long dpoe_traffic_stats::port_FramesDropped

Definition at line 233 of file dpoe_hal.h.

◆ port_BytesDropped

unsigned long long dpoe_traffic_stats::port_BytesDropped

Definition at line 234 of file dpoe_hal.h.

◆ port_OpticalMonVcc

unsigned short dpoe_traffic_stats::port_OpticalMonVcc

Definition at line 235 of file dpoe_hal.h.

◆ port_OpticalMonTxBiasCurrent

unsigned short dpoe_traffic_stats::port_OpticalMonTxBiasCurrent

Definition at line 236 of file dpoe_hal.h.

◆ port_OpticalMonTxPower

unsigned short dpoe_traffic_stats::port_OpticalMonTxPower

Definition at line 237 of file dpoe_hal.h.

◆ port_OpticalMonRxPower

unsigned short dpoe_traffic_stats::port_OpticalMonRxPower

Definition at line 238 of file dpoe_hal.h.

◆ dpoe_link_traffic_stats

struct dpoe_link_traffic_stats

Definition at line 241 of file dpoe_hal.h.

Collaboration diagram for dpoe_link_traffic_stats:
Collaboration graph

Data Fields

unsigned char link_Id
 
dpoe_traffic_stats_t link_TrafficStats
 

Field Documentation

◆ link_Id

unsigned char dpoe_link_traffic_stats::link_Id

Definition at line 243 of file dpoe_hal.h.

◆ link_TrafficStats

dpoe_traffic_stats_t dpoe_link_traffic_stats::link_TrafficStats

Definition at line 244 of file dpoe_hal.h.

◆ dpoe_link_forwarding_state

struct dpoe_link_forwarding_state

Definition at line 247 of file dpoe_hal.h.

Collaboration diagram for dpoe_link_forwarding_state:
Collaboration graph

Data Fields

unsigned char link_Id
 
unsigned char link_ForwardingState
 

Field Documentation

◆ link_Id

unsigned char dpoe_link_forwarding_state::link_Id

Definition at line 249 of file dpoe_hal.h.

◆ link_ForwardingState

unsigned char dpoe_link_forwarding_state::link_ForwardingState

Definition at line 250 of file dpoe_hal.h.

◆ dpoe_link_oam_frame_rate

struct dpoe_link_oam_frame_rate

Definition at line 253 of file dpoe_hal.h.

Collaboration diagram for dpoe_link_oam_frame_rate:
Collaboration graph

Data Fields

unsigned char link_Id
 
unsigned char link_MaxRate
 
unsigned char link_MinRate
 

Field Documentation

◆ link_Id

unsigned char dpoe_link_oam_frame_rate::link_Id

Definition at line 255 of file dpoe_hal.h.

◆ link_MaxRate

unsigned char dpoe_link_oam_frame_rate::link_MaxRate

Definition at line 256 of file dpoe_hal.h.

◆ link_MinRate

unsigned char dpoe_link_oam_frame_rate::link_MinRate

Definition at line 257 of file dpoe_hal.h.

◆ dpoe_link_encrypt_expiry_time

struct dpoe_link_encrypt_expiry_time

Definition at line 260 of file dpoe_hal.h.

Collaboration diagram for dpoe_link_encrypt_expiry_time:
Collaboration graph

Data Fields

unsigned char link_Id
 
unsigned short link_EncryptExpiryTime
 

Field Documentation

◆ link_Id

unsigned char dpoe_link_encrypt_expiry_time::link_Id

Definition at line 262 of file dpoe_hal.h.

◆ link_EncryptExpiryTime

unsigned short dpoe_link_encrypt_expiry_time::link_EncryptExpiryTime

Definition at line 263 of file dpoe_hal.h.

◆ dpoe_link_encrypt_mode

struct dpoe_link_encrypt_mode

Definition at line 266 of file dpoe_hal.h.

Collaboration diagram for dpoe_link_encrypt_mode:
Collaboration graph

Data Fields

unsigned char link_Id
 
unsigned char link_EncryptMode
 

Field Documentation

◆ link_Id

unsigned char dpoe_link_encrypt_mode::link_Id

Definition at line 268 of file dpoe_hal.h.

◆ link_EncryptMode

unsigned char dpoe_link_encrypt_mode::link_EncryptMode

Definition at line 269 of file dpoe_hal.h.

Macro Definition Documentation

◆ CHAR

#define CHAR   char

Definition at line 90 of file dpoe_hal.h.

◆ UCHAR

#define UCHAR   unsigned char

Definition at line 94 of file dpoe_hal.h.

◆ BOOLEAN

#define BOOLEAN   unsigned char

Definition at line 98 of file dpoe_hal.h.

◆ USHORT

#define USHORT   unsigned short

Definition at line 102 of file dpoe_hal.h.

◆ INT

#define INT   int

Definition at line 106 of file dpoe_hal.h.

◆ UINT8

#define UINT8   unsigned char

Definition at line 110 of file dpoe_hal.h.

◆ ULONG

#define ULONG   unsigned long

Definition at line 114 of file dpoe_hal.h.

◆ ULONGLONG

#define ULONGLONG   unsigned long long

Definition at line 118 of file dpoe_hal.h.

◆ TRUE

#define TRUE   1

Definition at line 122 of file dpoe_hal.h.

◆ FALSE

#define FALSE   0

Definition at line 126 of file dpoe_hal.h.

◆ RETURN_OK

#define RETURN_OK   0

Definition at line 130 of file dpoe_hal.h.

◆ RETURN_ERR

#define RETURN_ERR   -1

Definition at line 134 of file dpoe_hal.h.

◆ DPOE_HAL_MAJOR_VERSION

#define DPOE_HAL_MAJOR_VERSION   1

This is the major version of this HAL.

Definition at line 137 of file dpoe_hal.h.

◆ DPOE_HAL_MINOR_VERSION

#define DPOE_HAL_MINOR_VERSION   0

This is the minor version of the HAL.

Definition at line 138 of file dpoe_hal.h.

◆ DPOE_HAL_MAINTENANCE_VERSION

#define DPOE_HAL_MAINTENANCE_VERSION   1

This is the maintenance version of the HAL.

Definition at line 139 of file dpoe_hal.h.

Typedef Documentation

◆ dpoe_mac_address_t

typedef struct dpoe_mac_address dpoe_mac_address_t

◆ dpoe_link_mac_address_t

typedef struct dpoe_link_mac_address dpoe_link_mac_address_t

◆ dpoe_firmware_info_t

typedef struct dpoe_firmware_info dpoe_firmware_info_t

◆ dpoe_epon_chip_info_t

typedef struct dpoe_epon_chip_info dpoe_epon_chip_info_t

◆ dpoe_manufacturer_date_t

typedef struct dpoe_manufacturer_date dpoe_manufacturer_date_t

◆ dpoe_manufacturer_t

typedef struct dpoe_manufacturer dpoe_manufacturer_t

◆ dpoe_onu_packet_buffer_capabilities_t

typedef struct dpoe_onu_packet_buffer_capabilities dpoe_onu_packet_buffer_capabilities_t

◆ dpoe_device_sys_descr_info_t

typedef struct dpoe_device_sys_descr_info dpoe_device_sys_descr_info_t

◆ dpoe_onu_max_logical_links_t

typedef struct dpoe_onu_max_logical_links dpoe_onu_max_logical_links_t

◆ dpoe_traffic_stats_t

typedef struct dpoe_traffic_stats dpoe_traffic_stats_t

◆ dpoe_link_traffic_stats_t

typedef struct dpoe_link_traffic_stats dpoe_link_traffic_stats_t

◆ dpoe_link_forwarding_state_t

typedef struct dpoe_link_forwarding_state dpoe_link_forwarding_state_t

◆ dpoe_link_oam_frame_rate_t

typedef struct dpoe_link_oam_frame_rate dpoe_link_oam_frame_rate_t

◆ dpoe_link_encrypt_expiry_time_t

typedef struct dpoe_link_encrypt_expiry_time dpoe_link_encrypt_expiry_time_t

◆ dpoe_link_encrypt_mode_t

typedef struct dpoe_link_encrypt_mode dpoe_link_encrypt_mode_t