RDK-B
|
Modules | |
Platform HAL Data Types | |
Data Structures | |
struct | dhcp_opt_list |
struct | Traffic_client |
struct | DSCP_Element |
struct | DSCP_list |
Typedefs | |
typedef struct dhcp_opt_list | dhcp_opt_list |
typedef enum PSM_STATE * | PPSM_STATE |
typedef struct Traffic_client | Traffic_client_t |
typedef struct Traffic_client * | pTraffic_client_t |
typedef struct DSCP_Element | DSCP_Element_t |
typedef struct DSCP_Element * | pDSCP_Element_t |
typedef struct DSCP_list | DSCP_list_t |
typedef struct DSCP_list * | pDSCP_list_t |
Enumerations | |
enum | PSM_STATE { PSM_UNKNOWN =0, PSM_AC, PSM_BATT, PSM_HOT, PSM_COOLED, PSM_NOT_SUPPORTED } |
enum | WAN_INTERFACE { DOCSIS =1, EWAN =2 } |
enum | TRAFFIC_CNT_COMMAND { TRAFFIC_CNT_START =1, TRAFFIC_CNT_STOP =2 } |
Variables | |
char | _PLAT_PROC_MEM_INFO::dramPath [40] |
char | _PLAT_PROC_MEM_INFO::emmcPath1 [40] |
char | _PLAT_PROC_MEM_INFO::emmcPath2 [40] |
char | _PLAT_PROC_MEM_INFO::emmcPath3 [40] |
LED_COLOR | _LEDMGMT_PARAMS::LedColor |
LED_COLOR. More... | |
int | _LEDMGMT_PARAMS::State |
0 for Solid, 1 for Blink More... | |
int | _LEDMGMT_PARAMS::Interval |
In case fs State is blink then interval per second. More... | |
int | dhcp_opt_list::dhcp_opt |
char * | dhcp_opt_list::dhcp_opt_val |
struct dhcp_opt_list * | dhcp_opt_list::next |
char | Traffic_client::mac [18] |
unsigned long | Traffic_client::rxBytes |
unsigned long | Traffic_client::txBytes |
unsigned int | DSCP_Element::dscp_value |
unsigned int | DSCP_Element::numClients |
Traffic_client_t | DSCP_Element::Client [256] |
unsigned int | DSCP_list::numElements |
DSCP_Element_t | DSCP_list::DSCP_Element [64] |
struct dhcp_opt_list |
Definition at line 1068 of file platform_hal.h.
Data Fields | |
int | dhcp_opt |
char * | dhcp_opt_val |
struct dhcp_opt_list * | next |
struct Traffic_client |
Definition at line 1130 of file platform_hal.h.
Data Fields | |
char | mac [18] |
unsigned long | rxBytes |
unsigned long | txBytes |
struct DSCP_Element |
Definition at line 1136 of file platform_hal.h.
Data Fields | |
unsigned int | dscp_value |
unsigned int | numClients |
Traffic_client_t | Client [256] |
struct DSCP_list |
Definition at line 1142 of file platform_hal.h.
Data Fields | |
unsigned int | numElements |
DSCP_Element_t | DSCP_Element [64] |
typedef struct dhcp_opt_list dhcp_opt_list |
typedef enum PSM_STATE * PPSM_STATE |
typedef struct Traffic_client Traffic_client_t |
typedef struct Traffic_client * pTraffic_client_t |
typedef struct DSCP_Element DSCP_Element_t |
typedef struct DSCP_Element * pDSCP_Element_t |
typedef struct DSCP_list DSCP_list_t |
typedef struct DSCP_list * pDSCP_list_t |
enum PSM_STATE |
Enumerator | |
---|---|
PSM_UNKNOWN | |
PSM_AC | |
PSM_BATT | |
PSM_HOT | |
PSM_COOLED | |
PSM_NOT_SUPPORTED |
Definition at line 1094 of file platform_hal.h.
enum WAN_INTERFACE |
Enumerator | |
---|---|
DOCSIS | |
EWAN |
Definition at line 1120 of file platform_hal.h.
enum TRAFFIC_CNT_COMMAND |
Enumerator | |
---|---|
TRAFFIC_CNT_START | |
TRAFFIC_CNT_STOP |
Definition at line 1125 of file platform_hal.h.
int platform_hal_GetDeviceConfigStatus | ( | char * | pValue | ) |
@description Get the device configuration status
pValue | - Device Configuration status, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetTelnetEnable | ( | unsigned char * | pFlag | ) |
@description Get telnet enable status
pFlag | - Telnet enable value, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_SetTelnetEnable | ( | unsigned char | Flag | ) |
@description Enable/Disable telnet
Flag | - Telnet enable value |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetSSHEnable | ( | unsigned char * | pFlag | ) |
@description Get SSH enable status
pFlag | - SSH enable value, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_SetSSHEnable | ( | unsigned char | Flag | ) |
@description Enable/diable SSH
Flag | - SSH enable value |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetSNMPEnable | ( | char * | pValue | ) |
@description Get SNMP Enable value from the device
pValue | - SNMP enable value, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_SetSNMPEnable | ( | char * | pValue | ) |
@description Set SNMP Enable value
pValue | - SNMP enable value |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetWebUITimeout | ( | unsigned long * | pValue | ) |
@description Get WebUI timeout value
pValue | - WebUI timeout value, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_SetWebUITimeout | ( | unsigned long | value | ) |
@description Set WebUI timeout value
value | - WebUI timeout value |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetWebAccessLevel | ( | int | userIndex, |
int | ifIndex, | ||
unsigned long * | pValue | ||
) |
@description Get Web Access Level
userIndex | - User Index |
ifIndex | - Interface Index |
pValue | - Web Access Level, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_SetWebAccessLevel | ( | int | userIndex, |
int | ifIndex, | ||
unsigned long | value | ||
) |
@description Set Web Access Level
userIndex | - User Index |
ifIndex | - Interface Index |
value | - Web Access Level |
Lan Level | User Index | Interface Index |
---|---|---|
HomeUser_Lan_Level | 1 | 1 |
HomeUser_RfCM_Level | 1 | 2 |
HomeUser_Mta_Level | 1 | 16 |
HomeUser_WanRG_Level | 1 | 40 |
CusAdmin_Lan_Level | 5 | 1 |
CusAdmin_RfCM_Level | 5 | 2 |
CusAdmin_Mta_Level | 5 | 16 |
CusAdmin_WanRG_Level | 5 | 40 |
AdvUser_Lan_Level | 10 | 1 |
AdvUser_RfCM_Level | 10 | 2 |
AdvUser_Mta_Level | 10 | 16 |
AdvUser_WanRG_Level | 10 | 40 |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_PandMDBInit | ( | void | ) |
@description Initialize PandM DB (Database)
None |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_DocsisParamsDBInit | ( | void | ) |
@description Initialize Platform HAL docsis parameters DB
None |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetModelName | ( | char * | pValue | ) |
@description Get device model name
pValue | - Device Model Name, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetRouterRegion | ( | char * | pValue | ) |
@description Get router region
pValue | - Router region name, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetSerialNumber | ( | char * | pValue | ) |
@description Get device serial number
pValue | - Device Serial Number, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetHardwareVersion | ( | char * | pValue | ) |
@description Get hardware version of the device
pValue | - Hardware version, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetSoftwareVersion | ( | char * | pValue, |
unsigned long | maxSize | ||
) |
@description Get software version flashed in the device
pValue | - Software version, to be returned |
maxSize | - Maximum size of the Software version string |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetBootloaderVersion | ( | char * | pValue, |
unsigned long | maxSize | ||
) |
@description Get bootloader version flashed in the device
pValue | - Bootloader version, to be returned |
maxSize | - Maximum size of the bootloader version string |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetFirmwareName | ( | char * | pValue, |
unsigned long | maxSize | ||
) |
@description Get firmware image name flashed in the device
pValue | - Firmware image name, to be returned |
maxSize | - Maximum size of the bootloader version string |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetBaseMacAddress | ( | char * | pValue | ) |
@description Get base MAC Address of the device
pValue | - Base MAC Address, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetHardware | ( | char * | pValue | ) |
@description Get total flash size of the hardware
pValue | - Total flash size, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetHardware_MemUsed | ( | char * | pValue | ) |
@description Get total used memory of the flash
pValue | - Total used memory, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetHardware_MemFree | ( | char * | pValue | ) |
@description Get total availabe memory of the flash
pValue | - Total available memory, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetTotalMemorySize | ( | unsigned long * | pulSize | ) |
@description Get total memory size of the DRAM (Dynamic Random Access Memory)
pulSize | - Total memory size of DRAM, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetUsedMemorySize | ( | unsigned long * | pulSize | ) |
@description Get total used memory of the DRAM (Dynamic Random Access Memory)
pulSize | - Total used memory of DRAM, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetFreeMemorySize | ( | unsigned long * | pulSize | ) |
@description Get total available memory of the DRAM (Dynamic Random Access Memory)
pulSize | - Total available memory of DRAM, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetFactoryResetCount | ( | unsigned long * | pulSize | ) |
@description Get total number of times factory reset has been done on the device
Device.DeviceInfo.FactoryResetCount
pulSize | - Factory reset count, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_ClearResetCount | ( | unsigned char | bFlag | ) |
@description Reset factory reset count on the device
Device.DeviceInfo.ClearResetCount
bFlag | - Reset Factory reset count, if TRUE |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_getTimeOffSet | ( | char * | timeOffSet | ) |
@description Get time offset from the device
Device.DeviceInfo.TimeOffset
timeOffSet | - Time offset, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_SetDeviceCodeImageTimeout | ( | int | seconds | ) |
@description Set HW watchdog timeout value. Default value is 60 minutes.
seconds | - Hardware watchdog timeout value in seconds |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_SetDeviceCodeImageValid | ( | unsigned char | flag | ) |
@description Set Valid flag for firmware image flashed in the device.
flag | - Image valid flag |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_getFactoryPartnerId | ( | char * | pValue | ) |
@description Get FactoryPartnerID from the the device.
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_getFactoryCmVariant | ( | char * | pValue | ) |
@description Get FactoryCmVariant from the the device.
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_setFactoryCmVariant | ( | char * | pValue | ) |
@description Set FactoryCmVariant from the the device.
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_setLed | ( | PLEDMGMT_PARAMS | pValue | ) |
@description Set Led behavior of the device
LED | identification and control parameters |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_getLed | ( | PLEDMGMT_PARAMS | pValue | ) |
@description Get Led behavior of the device at time of call
@pValue The Current Led Buffer to be populated
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
unsigned int platform_hal_getFanSpeed | ( | unsigned int | fanIndex | ) |
@description Get the fan speed in RPMs
fanIndex | - Fan index starting from 0. |
unsigned int platform_hal_getRPM | ( | unsigned int | fanIndex | ) |
@description Get the fan speed
fanIndex | - Fan index starting from 0. |
int platform_hal_getRotorLock | ( | unsigned int | fanIndex | ) |
@description Get the status of rotor lock
fanIndex | - Fan index starting from 0. |
unsigned char platform_hal_getFanStatus | ( | unsigned int | fanIndex | ) |
@description Get the fan status
fanIndex | - Fan index starting from 0. |
int platform_hal_setFanMaxOverride | ( | unsigned char | bOverrideFlag, |
unsigned int | fanIndex | ||
) |
@description Set the fax to maximum speed
bOverrideFlag | - Boolean value to enable/disalbe fan tur run in highspeed |
int platform_hal_SetSNMPOnboardRebootEnable | ( | char * | pValue | ) |
@description Set SNMP Onboard Reboot Enable value to allow or ignore SNMP reboot
pValue | - SNMP Onboard Reboot Enable value ("disable", "enable") |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetMACsecEnable | ( | int | ethPort, |
unsigned char * | pFlag | ||
) |
@description Get MACsec enable status
ethPort | - Ethernet port (zero-based) |
pFlag | - MACsec enable value, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_SetMACsecEnable | ( | int | ethPort, |
unsigned char | Flag | ||
) |
@description Enable/Disable MACsec
ethPort | - Ethernet port (zero-based) |
Flag | - MACsec enable value |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetMACsecOperationalStatus | ( | int | ethPort, |
unsigned char * | pFlag | ||
) |
@description Get MACsec operation status
ethPort | - Ethernet port (zero-based) |
pFlag | - MACsec operation status value, to be returned |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_StartMACsec | ( | int | ethPort, |
int | timeoutSec | ||
) |
@description Start MACsec - Call should be Blocking
ethPort | - Ethernet port (zero-based) |
timeoutSec | - MACsec Start Timeout (0 means retry forever) |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_StopMACsec | ( | int | ethPort | ) |
@description Stop MACsec - Call should be Blocking
ethPort | - Ethernet port (zero-based) |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_GetMemoryPaths | ( | RDK_CPUS | index, |
PPLAT_PROC_MEM_INFO * | ppinfo | ||
) |
@description Get the device specific processors DRAM and eMMC paths
RDK_CPUS | index - Index to which processor/CPU to request. Host is the primary RDK CPU |
PPLAT_PROC_MEM_INFO | *ppinfo - Ponter to get the return array |
RETURN_OK | if successful. |
RETURN_ERR | if any error is detected |
int platform_hal_GetDhcpv4_Options | ( | dhcp_opt_list ** | req_opt_list, |
dhcp_opt_list ** | send_opt_list | ||
) |
int platform_hal_GetDhcpv6_Options | ( | dhcp_opt_list ** | req_opt_list, |
dhcp_opt_list ** | send_opt_list | ||
) |
int platform_hal_SetLowPowerModeState | ( | PPSM_STATE | pState | ) |
@description Set Low Power Mode State value. Hysteresis currently not accounted for before call.
seconds | - Low Power Mode State. |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_getCMTSMac | ( | char * | pValue | ) |
int platform_hal_setDscp | ( | WAN_INTERFACE | interfaceType, |
TRAFFIC_CNT_COMMAND | cmd, | ||
char * | pDscpVals | ||
) |
@description Control/Set traffic counting based on Dscp value
interfaceType | - 1 for DOCSIS , 2 for EWAN |
cmd | - START/STOP |
dscpVal | comma seperated string , e.g. "10,0" , NULL NULL is for all DSCP values , values are base 10 |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_resetDscpCounts | ( | WAN_INTERFACE | interfaceType | ) |
@description To reset Dscp Counter values
interfaceType | - 1 for DOCSIS , 2 for EWAN |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
int platform_hal_getDscpClientList | ( | WAN_INTERFACE | interfaceType, |
pDSCP_list_t | pDSCP_List | ||
) |
@description To get counter data e.g. DSCP_list_t DSCP_List; platform_hal_getDscpClientList(DOCSIS,&DSCP_List); DSCP_List should be filled by hal.
interfaceType | - 1 for DOCSIS , 2 for EWAN |
pDSCP_List | - List of client structure to be filled by hal |
int platform_hal_GetCPUSpeed | ( | char * | cpuSpeed | ) |
@description get cpu speed.
cpuSpeed | - store cpu speed |
RETURN_OK | if successful |
RETURN_ERR | if any error is detected |
char _PLAT_PROC_MEM_INFO::dramPath[40] |
Definition at line 199 of file platform_hal.h.
char _PLAT_PROC_MEM_INFO::emmcPath1[40] |
Definition at line 200 of file platform_hal.h.
char _PLAT_PROC_MEM_INFO::emmcPath2[40] |
Definition at line 201 of file platform_hal.h.
char _PLAT_PROC_MEM_INFO::emmcPath3[40] |
Definition at line 202 of file platform_hal.h.
LED_COLOR _LEDMGMT_PARAMS::LedColor |
LED_COLOR.
Definition at line 749 of file platform_hal.h.
int _LEDMGMT_PARAMS::State |
0 for Solid, 1 for Blink
Definition at line 750 of file platform_hal.h.
int _LEDMGMT_PARAMS::Interval |
In case fs State is blink then interval per second.
Definition at line 751 of file platform_hal.h.
int dhcp_opt_list::dhcp_opt |
Definition at line 1069 of file platform_hal.h.
char* dhcp_opt_list::dhcp_opt_val |
Definition at line 1070 of file platform_hal.h.
struct dhcp_opt_list* dhcp_opt_list::next |
Definition at line 1071 of file platform_hal.h.
char Traffic_client::mac[18] |
Definition at line 1131 of file platform_hal.h.
unsigned long Traffic_client::rxBytes |
Definition at line 1132 of file platform_hal.h.
unsigned long Traffic_client::txBytes |
Definition at line 1133 of file platform_hal.h.
unsigned int DSCP_Element::dscp_value |
Definition at line 1137 of file platform_hal.h.
unsigned int DSCP_Element::numClients |
Definition at line 1138 of file platform_hal.h.
Traffic_client_t DSCP_Element::Client[256] |
Definition at line 1139 of file platform_hal.h.
unsigned int DSCP_list::numElements |
Definition at line 1143 of file platform_hal.h.
DSCP_Element_t DSCP_list::DSCP_Element[64] |
Definition at line 1144 of file platform_hal.h.