RDK-B
WAN HAL Data Types

Description

Data Structures

struct  _WAN_IPV4_CFG
 
struct  _WAN_IPV6_CFG
 
struct  _WAN_QOS_QUEUE
 
struct  _WAN_MAPT_CFG
 
struct  _SELFHEAL_CONFIG
 

Macros

#define RETURN_ERROR   1
 
#define RETURN_OK   0
 
#define BUFLEN_8   8
 
#define BUFLEN_32   32
 
#define BUFLEN_64   64
 

Typedefs

typedef struct _WAN_IPV4_CFG WAN_IPV4_CFG
 
typedef struct _WAN_IPV4_CFGPWAN_IPV4_CFG
 
typedef struct _WAN_IPV6_CFG WAN_IPV6_CFG
 
typedef struct _WAN_IPV6_CFGPWAN_IPV6_CFG
 
typedef struct _WAN_QOS_QUEUE WAN_QOS_QUEUE
 
typedef struct _WAN_QOS_QUEUEPWAN_QOS_QUEUE
 
typedef struct _WAN_MAPT_CFG WAN_MAPT_CFG
 
typedef struct _WAN_MAPT_CFGPWAN_MAPT_CFG
 
typedef struct _SELFHEAL_CONFIG SELFHEAL_CONFIG
 
typedef struct _SELFHEAL_CONFIGPSELFHEAL_CONFIG
 

Enumerations

enum  t_eWanMode { WAN_MODE_DISABLED = 1, WAN_MODE_DSL_ONLY = 2, WAN_MODE_ETH_ONLY = 3, WAN_MODE_AUTO = 4 }
 

Data Structure Documentation

◆ _WAN_IPV4_CFG

struct _WAN_IPV4_CFG

Definition at line 56 of file wan_hal.h.

Collaboration diagram for _WAN_IPV4_CFG:
Collaboration graph

Data Fields

char ifname [64]
 
char subnetmask [64]
 
char ipaddress [64]
 
char dnsservers [256]
 
char defaultgateway [64]
 

Field Documentation

◆ ifname

char _WAN_IPV4_CFG::ifname[64]

Definition at line 59 of file wan_hal.h.

◆ subnetmask

char _WAN_IPV4_CFG::subnetmask[64]

Definition at line 60 of file wan_hal.h.

◆ ipaddress

char _WAN_IPV4_CFG::ipaddress[64]

Definition at line 61 of file wan_hal.h.

◆ dnsservers

char _WAN_IPV4_CFG::dnsservers[256]

Definition at line 62 of file wan_hal.h.

◆ defaultgateway

char _WAN_IPV4_CFG::defaultgateway[64]

Definition at line 63 of file wan_hal.h.

◆ _WAN_IPV6_CFG

struct _WAN_IPV6_CFG

Definition at line 67 of file wan_hal.h.

Collaboration diagram for _WAN_IPV6_CFG:
Collaboration graph

Data Fields

char ifname [64]
 
char ipaddress [128]
 
char dnsservers [512]
 
int preferredlifetime
 
int validlifetime
 

Field Documentation

◆ ifname

char _WAN_IPV6_CFG::ifname[64]

Definition at line 70 of file wan_hal.h.

◆ ipaddress

char _WAN_IPV6_CFG::ipaddress[128]

Definition at line 71 of file wan_hal.h.

◆ dnsservers

char _WAN_IPV6_CFG::dnsservers[512]

Definition at line 72 of file wan_hal.h.

◆ preferredlifetime

int _WAN_IPV6_CFG::preferredlifetime

Definition at line 73 of file wan_hal.h.

◆ validlifetime

int _WAN_IPV6_CFG::validlifetime

Definition at line 74 of file wan_hal.h.

◆ _WAN_QOS_QUEUE

struct _WAN_QOS_QUEUE

Definition at line 81 of file wan_hal.h.

Collaboration diagram for _WAN_QOS_QUEUE:
Collaboration graph

Data Fields

unsigned long InstanceNumber
 
char Alias [64]
 
unsigned long queueKey
 
unsigned char queueEnable
 
char queueStatus [256]
 
char queueInterface [256]
 
unsigned long queueWeight
 
unsigned long queuePrecedence
 
unsigned long REDThreshold
 
char dropAlgorithm [256]
 
char schedulerAlgorithm [256]
 
signed long shapingRate
 
unsigned long shapingBurstSize
 
signed long MinBitRate
 
char QueueName [256]
 
signed long DslLatency
 
signed long PtmPriority
 
unsigned long QueueId
 
unsigned long LowClassMaxThreshold
 
unsigned long LowClassMinThreshold
 
unsigned long HighClassMinThreshold
 
unsigned long HighClassMaxThreshold
 
char L2DeviceType [32]
 

Field Documentation

◆ InstanceNumber

unsigned long _WAN_QOS_QUEUE::InstanceNumber

Definition at line 84 of file wan_hal.h.

◆ Alias

char _WAN_QOS_QUEUE::Alias[64]

Definition at line 85 of file wan_hal.h.

◆ queueKey

unsigned long _WAN_QOS_QUEUE::queueKey

Definition at line 86 of file wan_hal.h.

◆ queueEnable

unsigned char _WAN_QOS_QUEUE::queueEnable

Definition at line 87 of file wan_hal.h.

◆ queueStatus

char _WAN_QOS_QUEUE::queueStatus[256]

Definition at line 88 of file wan_hal.h.

◆ queueInterface

char _WAN_QOS_QUEUE::queueInterface[256]

Definition at line 89 of file wan_hal.h.

◆ queueWeight

unsigned long _WAN_QOS_QUEUE::queueWeight

Definition at line 90 of file wan_hal.h.

◆ queuePrecedence

unsigned long _WAN_QOS_QUEUE::queuePrecedence

Definition at line 91 of file wan_hal.h.

◆ REDThreshold

unsigned long _WAN_QOS_QUEUE::REDThreshold

Definition at line 92 of file wan_hal.h.

◆ dropAlgorithm

char _WAN_QOS_QUEUE::dropAlgorithm[256]

Definition at line 93 of file wan_hal.h.

◆ schedulerAlgorithm

char _WAN_QOS_QUEUE::schedulerAlgorithm[256]

Definition at line 94 of file wan_hal.h.

◆ shapingRate

signed long _WAN_QOS_QUEUE::shapingRate

Definition at line 95 of file wan_hal.h.

◆ shapingBurstSize

unsigned long _WAN_QOS_QUEUE::shapingBurstSize

Definition at line 96 of file wan_hal.h.

◆ MinBitRate

signed long _WAN_QOS_QUEUE::MinBitRate

Definition at line 97 of file wan_hal.h.

◆ QueueName

char _WAN_QOS_QUEUE::QueueName[256]

Definition at line 98 of file wan_hal.h.

◆ DslLatency

signed long _WAN_QOS_QUEUE::DslLatency

Definition at line 99 of file wan_hal.h.

◆ PtmPriority

signed long _WAN_QOS_QUEUE::PtmPriority

Definition at line 100 of file wan_hal.h.

◆ QueueId

unsigned long _WAN_QOS_QUEUE::QueueId

Definition at line 101 of file wan_hal.h.

◆ LowClassMaxThreshold

unsigned long _WAN_QOS_QUEUE::LowClassMaxThreshold

Definition at line 102 of file wan_hal.h.

◆ LowClassMinThreshold

unsigned long _WAN_QOS_QUEUE::LowClassMinThreshold

Definition at line 103 of file wan_hal.h.

◆ HighClassMinThreshold

unsigned long _WAN_QOS_QUEUE::HighClassMinThreshold

Definition at line 104 of file wan_hal.h.

◆ HighClassMaxThreshold

unsigned long _WAN_QOS_QUEUE::HighClassMaxThreshold

Definition at line 105 of file wan_hal.h.

◆ L2DeviceType

char _WAN_QOS_QUEUE::L2DeviceType[32]

Definition at line 106 of file wan_hal.h.

◆ _WAN_MAPT_CFG

struct _WAN_MAPT_CFG

Definition at line 111 of file wan_hal.h.

Collaboration diagram for _WAN_MAPT_CFG:
Collaboration graph

Data Fields

char ifName [64]
 
char brIPv6Prefix [128]
 
char ruleIPv4Prefix [128]
 
char ruleIPv6Prefix [128]
 
unsigned int psidOffset
 
unsigned int ratio
 
char pdIPv6Prefix [128]
 

Field Documentation

◆ ifName

char _WAN_MAPT_CFG::ifName[64]

Definition at line 114 of file wan_hal.h.

◆ brIPv6Prefix

char _WAN_MAPT_CFG::brIPv6Prefix[128]

Definition at line 115 of file wan_hal.h.

◆ ruleIPv4Prefix

char _WAN_MAPT_CFG::ruleIPv4Prefix[128]

Definition at line 116 of file wan_hal.h.

◆ ruleIPv6Prefix

char _WAN_MAPT_CFG::ruleIPv6Prefix[128]

Definition at line 117 of file wan_hal.h.

◆ psidOffset

unsigned int _WAN_MAPT_CFG::psidOffset

Definition at line 118 of file wan_hal.h.

◆ ratio

unsigned int _WAN_MAPT_CFG::ratio

Definition at line 119 of file wan_hal.h.

◆ pdIPv6Prefix

char _WAN_MAPT_CFG::pdIPv6Prefix[128]

Definition at line 120 of file wan_hal.h.

◆ _SELFHEAL_CONFIG

struct _SELFHEAL_CONFIG

Structure for SELFHEAL configuration which is required in ccsp-wanagent and wan hal.

Definition at line 127 of file wan_hal.h.

Collaboration diagram for _SELFHEAL_CONFIG:
Collaboration graph

Data Fields

unsigned int rebootStatus
 

Field Documentation

◆ rebootStatus

unsigned int _SELFHEAL_CONFIG::rebootStatus

Definition at line 130 of file wan_hal.h.

Macro Definition Documentation

◆ RETURN_ERROR

#define RETURN_ERROR   1

Definition at line 41 of file wan_hal.h.

◆ RETURN_OK

#define RETURN_OK   0

Definition at line 42 of file wan_hal.h.

◆ BUFLEN_8

#define BUFLEN_8   8

Definition at line 44 of file wan_hal.h.

◆ BUFLEN_32

#define BUFLEN_32   32

Definition at line 45 of file wan_hal.h.

◆ BUFLEN_64

#define BUFLEN_64   64

Definition at line 46 of file wan_hal.h.

Typedef Documentation

◆ WAN_IPV4_CFG

◆ PWAN_IPV4_CFG

◆ WAN_IPV6_CFG

◆ PWAN_IPV6_CFG

◆ WAN_QOS_QUEUE

◆ PWAN_QOS_QUEUE

◆ WAN_MAPT_CFG

◆ PWAN_MAPT_CFG

◆ SELFHEAL_CONFIG

Structure for SELFHEAL configuration which is required in ccsp-wanagent and wan hal.

◆ PSELFHEAL_CONFIG

Enumeration Type Documentation

◆ t_eWanMode

enum t_eWanMode
Enumerator
WAN_MODE_DISABLED 
WAN_MODE_DSL_ONLY 
WAN_MODE_ETH_ONLY 
WAN_MODE_AUTO 

Definition at line 48 of file wan_hal.h.