RDK-B
Platform HAL APIs

Description

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_STATEPPSM_STATE
 
typedef struct Traffic_client Traffic_client_t
 
typedef struct Traffic_clientpTraffic_client_t
 
typedef struct DSCP_Element DSCP_Element_t
 
typedef struct DSCP_ElementpDSCP_Element_t
 
typedef struct DSCP_list DSCP_list_t
 
typedef struct DSCP_listpDSCP_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 }
 

Functions

int platform_hal_GetDeviceConfigStatus (char *pValue)
 
int platform_hal_GetTelnetEnable (unsigned char *pFlag)
 
int platform_hal_SetTelnetEnable (unsigned char Flag)
 
int platform_hal_GetSSHEnable (unsigned char *pFlag)
 
int platform_hal_SetSSHEnable (unsigned char Flag)
 
int platform_hal_GetSNMPEnable (char *pValue)
 
int platform_hal_SetSNMPEnable (char *pValue)
 
int platform_hal_GetWebUITimeout (unsigned long *pValue)
 
int platform_hal_SetWebUITimeout (unsigned long value)
 
int platform_hal_GetWebAccessLevel (int userIndex, int ifIndex, unsigned long *pValue)
 
int platform_hal_SetWebAccessLevel (int userIndex, int ifIndex, unsigned long value)
 
int platform_hal_PandMDBInit (void)
 
int platform_hal_DocsisParamsDBInit (void)
 
int platform_hal_GetModelName (char *pValue)
 
int platform_hal_GetRouterRegion (char *pValue)
 
int platform_hal_GetSerialNumber (char *pValue)
 
int platform_hal_GetHardwareVersion (char *pValue)
 
int platform_hal_GetSoftwareVersion (char *pValue, unsigned long maxSize)
 
int platform_hal_GetBootloaderVersion (char *pValue, unsigned long maxSize)
 
int platform_hal_GetFirmwareName (char *pValue, unsigned long maxSize)
 
int platform_hal_GetBaseMacAddress (char *pValue)
 
int platform_hal_GetHardware (char *pValue)
 
int platform_hal_GetHardware_MemUsed (char *pValue)
 
int platform_hal_GetHardware_MemFree (char *pValue)
 
int platform_hal_GetTotalMemorySize (unsigned long *pulSize)
 
int platform_hal_GetUsedMemorySize (unsigned long *pulSize)
 
int platform_hal_GetFreeMemorySize (unsigned long *pulSize)
 
int platform_hal_GetFactoryResetCount (unsigned long *pulSize)
 
int platform_hal_ClearResetCount (unsigned char bFlag)
 
int platform_hal_getTimeOffSet (char *timeOffSet)
 
int platform_hal_SetDeviceCodeImageTimeout (int seconds)
 
int platform_hal_SetDeviceCodeImageValid (unsigned char flag)
 
int platform_hal_getFactoryPartnerId (char *pValue)
 
int platform_hal_getFactoryCmVariant (char *pValue)
 
int platform_hal_setFactoryCmVariant (char *pValue)
 
int platform_hal_setLed (PLEDMGMT_PARAMS pValue)
 
int platform_hal_getLed (PLEDMGMT_PARAMS pValue)
 
unsigned int platform_hal_getFanSpeed (unsigned int fanIndex)
 
unsigned int platform_hal_getRPM (unsigned int fanIndex)
 
int platform_hal_getRotorLock (unsigned int fanIndex)
 
unsigned char platform_hal_getFanStatus (unsigned int fanIndex)
 
int platform_hal_setFanMaxOverride (unsigned char bOverrideFlag, unsigned int fanIndex)
 
int platform_hal_SetSNMPOnboardRebootEnable (char *pValue)
 
int platform_hal_GetMACsecEnable (int ethPort, unsigned char *pFlag)
 
int platform_hal_SetMACsecEnable (int ethPort, unsigned char Flag)
 
int platform_hal_GetMACsecOperationalStatus (int ethPort, unsigned char *pFlag)
 
int platform_hal_StartMACsec (int ethPort, int timeoutSec)
 
int platform_hal_StopMACsec (int ethPort)
 
int platform_hal_GetMemoryPaths (RDK_CPUS index, PPLAT_PROC_MEM_INFO *ppinfo)
 
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)
 
int platform_hal_getCMTSMac (char *pValue)
 
int platform_hal_setDscp (WAN_INTERFACE interfaceType, TRAFFIC_CNT_COMMAND cmd, char *pDscpVals)
 
int platform_hal_resetDscpCounts (WAN_INTERFACE interfaceType)
 
int platform_hal_getDscpClientList (WAN_INTERFACE interfaceType, pDSCP_list_t pDSCP_List)
 
int platform_hal_GetCPUSpeed (char *cpuSpeed)
 

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_listdhcp_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]
 

Data Structure Documentation

◆ dhcp_opt_list

struct dhcp_opt_list

Definition at line 1068 of file platform_hal.h.

Collaboration diagram for dhcp_opt_list:
Collaboration graph

Data Fields

int dhcp_opt
 
char * dhcp_opt_val
 
struct dhcp_opt_listnext
 

◆ Traffic_client

struct Traffic_client

Definition at line 1130 of file platform_hal.h.

Collaboration diagram for Traffic_client:
Collaboration graph

Data Fields

char mac [18]
 
unsigned long rxBytes
 
unsigned long txBytes
 

◆ DSCP_Element

struct DSCP_Element

Definition at line 1136 of file platform_hal.h.

Collaboration diagram for DSCP_Element:
Collaboration graph

Data Fields

unsigned int dscp_value
 
unsigned int numClients
 
Traffic_client_t Client [256]
 

◆ DSCP_list

struct DSCP_list

Definition at line 1142 of file platform_hal.h.

Collaboration diagram for DSCP_list:
Collaboration graph

Data Fields

unsigned int numElements
 
DSCP_Element_t DSCP_Element [64]
 

Typedef Documentation

◆ dhcp_opt_list

◆ PPSM_STATE

typedef enum PSM_STATE * PPSM_STATE

◆ Traffic_client_t

◆ pTraffic_client_t

◆ DSCP_Element_t

◆ pDSCP_Element_t

◆ DSCP_list_t

◆ pDSCP_list_t

Enumeration Type Documentation

◆ PSM_STATE

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.

◆ WAN_INTERFACE

Enumerator
DOCSIS 
EWAN 

Definition at line 1120 of file platform_hal.h.

◆ TRAFFIC_CNT_COMMAND

Enumerator
TRAFFIC_CNT_START 
TRAFFIC_CNT_STOP 

Definition at line 1125 of file platform_hal.h.

Function Documentation

◆ platform_hal_GetDeviceConfigStatus()

int platform_hal_GetDeviceConfigStatus ( char *  pValue)

@description Get the device configuration status

Parameters
pValue- Device Configuration status, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetTelnetEnable()

int platform_hal_GetTelnetEnable ( unsigned char *  pFlag)

@description Get telnet enable status

Parameters
pFlag- Telnet enable value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_SetTelnetEnable()

int platform_hal_SetTelnetEnable ( unsigned char  Flag)

@description Enable/Disable telnet

Parameters
Flag- Telnet enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetSSHEnable()

int platform_hal_GetSSHEnable ( unsigned char *  pFlag)

@description Get SSH enable status

Parameters
pFlag- SSH enable value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_SetSSHEnable()

int platform_hal_SetSSHEnable ( unsigned char  Flag)

@description Enable/diable SSH

Parameters
Flag- SSH enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetSNMPEnable()

int platform_hal_GetSNMPEnable ( char *  pValue)

@description Get SNMP Enable value from the device

Parameters
pValue- SNMP enable value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_SetSNMPEnable()

int platform_hal_SetSNMPEnable ( char *  pValue)

@description Set SNMP Enable value

Parameters
pValue- SNMP enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetWebUITimeout()

int platform_hal_GetWebUITimeout ( unsigned long *  pValue)

@description Get WebUI timeout value

Parameters
pValue- WebUI timeout value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_SetWebUITimeout()

int platform_hal_SetWebUITimeout ( unsigned long  value)

@description Set WebUI timeout value

Parameters
value- WebUI timeout value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetWebAccessLevel()

int platform_hal_GetWebAccessLevel ( int  userIndex,
int  ifIndex,
unsigned long *  pValue 
)

@description Get Web Access Level

Parameters
userIndex- User Index
ifIndex- Interface Index
pValue- Web Access Level, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_SetWebAccessLevel()

int platform_hal_SetWebAccessLevel ( int  userIndex,
int  ifIndex,
unsigned long  value 
)

@description Set Web Access Level

Parameters
userIndex- User Index
ifIndex- Interface Index
value- Web Access Level
Lan Level Vs Index table
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
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_PandMDBInit()

int platform_hal_PandMDBInit ( void  )

@description Initialize PandM DB (Database)

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_DocsisParamsDBInit()

int platform_hal_DocsisParamsDBInit ( void  )

@description Initialize Platform HAL docsis parameters DB

Parameters
None
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetModelName()

int platform_hal_GetModelName ( char *  pValue)

@description Get device model name

Parameters
pValue- Device Model Name, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetRouterRegion()

int platform_hal_GetRouterRegion ( char *  pValue)

@description Get router region

Parameters
pValue- Router region name, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetSerialNumber()

int platform_hal_GetSerialNumber ( char *  pValue)

@description Get device serial number

Parameters
pValue- Device Serial Number, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetHardwareVersion()

int platform_hal_GetHardwareVersion ( char *  pValue)

@description Get hardware version of the device

Parameters
pValue- Hardware version, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetSoftwareVersion()

int platform_hal_GetSoftwareVersion ( char *  pValue,
unsigned long  maxSize 
)

@description Get software version flashed in the device

Parameters
pValue- Software version, to be returned
maxSize- Maximum size of the Software version string
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetBootloaderVersion()

int platform_hal_GetBootloaderVersion ( char *  pValue,
unsigned long  maxSize 
)

@description Get bootloader version flashed in the device

Parameters
pValue- Bootloader version, to be returned
maxSize- Maximum size of the bootloader version string
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetFirmwareName()

int platform_hal_GetFirmwareName ( char *  pValue,
unsigned long  maxSize 
)

@description Get firmware image name flashed in the device

Parameters
pValue- Firmware image name, to be returned
maxSize- Maximum size of the bootloader version string
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetBaseMacAddress()

int platform_hal_GetBaseMacAddress ( char *  pValue)

@description Get base MAC Address of the device

Parameters
pValue- Base MAC Address, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetHardware()

int platform_hal_GetHardware ( char *  pValue)

@description Get total flash size of the hardware

Parameters
pValue- Total flash size, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetHardware_MemUsed()

int platform_hal_GetHardware_MemUsed ( char *  pValue)

@description Get total used memory of the flash

Parameters
pValue- Total used memory, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetHardware_MemFree()

int platform_hal_GetHardware_MemFree ( char *  pValue)

@description Get total availabe memory of the flash

Parameters
pValue- Total available memory, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetTotalMemorySize()

int platform_hal_GetTotalMemorySize ( unsigned long *  pulSize)

@description Get total memory size of the DRAM (Dynamic Random Access Memory)

Parameters
pulSize- Total memory size of DRAM, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetUsedMemorySize()

int platform_hal_GetUsedMemorySize ( unsigned long *  pulSize)

@description Get total used memory of the DRAM (Dynamic Random Access Memory)

Parameters
pulSize- Total used memory of DRAM, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetFreeMemorySize()

int platform_hal_GetFreeMemorySize ( unsigned long *  pulSize)

@description Get total available memory of the DRAM (Dynamic Random Access Memory)

Parameters
pulSize- Total available memory of DRAM, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_GetFactoryResetCount()

int platform_hal_GetFactoryResetCount ( unsigned long *  pulSize)

@description Get total number of times factory reset has been done on the device
Device.DeviceInfo.FactoryResetCount

Parameters
pulSize- Factory reset count, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_ClearResetCount()

int platform_hal_ClearResetCount ( unsigned char  bFlag)

@description Reset factory reset count on the device
Device.DeviceInfo.ClearResetCount

Parameters
bFlag- Reset Factory reset count, if TRUE
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_getTimeOffSet()

int platform_hal_getTimeOffSet ( char *  timeOffSet)

@description Get time offset from the device
Device.DeviceInfo.TimeOffset

Parameters
timeOffSet- Time offset, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_SetDeviceCodeImageTimeout()

int platform_hal_SetDeviceCodeImageTimeout ( int  seconds)

@description Set HW watchdog timeout value. Default value is 60 minutes.

Parameters
seconds- Hardware watchdog timeout value in seconds
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_SetDeviceCodeImageValid()

int platform_hal_SetDeviceCodeImageValid ( unsigned char  flag)

@description Set Valid flag for firmware image flashed in the device.

Parameters
flag- Image valid flag
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_getFactoryPartnerId()

int platform_hal_getFactoryPartnerId ( char *  pValue)

@description Get FactoryPartnerID from the the device.

Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_getFactoryCmVariant()

int platform_hal_getFactoryCmVariant ( char *  pValue)

@description Get FactoryCmVariant from the the device.

Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_setFactoryCmVariant()

int platform_hal_setFactoryCmVariant ( char *  pValue)

@description Set FactoryCmVariant from the the device.

Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_setLed()

int platform_hal_setLed ( PLEDMGMT_PARAMS  pValue)

@description Set Led behavior of the device

Parameters
LEDidentification and control parameters
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_getLed()

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

Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_getFanSpeed()

unsigned int platform_hal_getFanSpeed ( unsigned int  fanIndex)

@description Get the fan speed in RPMs

Parameters
fanIndex- Fan index starting from 0.
Returns
FanSpeed in unsigned int

◆ platform_hal_getRPM()

unsigned int platform_hal_getRPM ( unsigned int  fanIndex)

@description Get the fan speed

Parameters
fanIndex- Fan index starting from 0.
Returns
FanRPM in unsigned int

◆ platform_hal_getRotorLock()

int platform_hal_getRotorLock ( unsigned int  fanIndex)

@description Get the status of rotor lock

Parameters
fanIndex- Fan index starting from 0.
Returns
The status of the rotor lock @rtnval 1 if locked @rtnval 0 if not locked @rtnval -1 if value not applicable

◆ platform_hal_getFanStatus()

unsigned char platform_hal_getFanStatus ( unsigned int  fanIndex)

@description Get the fan status

Parameters
fanIndex- Fan index starting from 0.
Returns
the fan status @rtnval 1 if fan is enabled @rtnval 0 if fan disabled

◆ platform_hal_setFanMaxOverride()

int platform_hal_setFanMaxOverride ( unsigned char  bOverrideFlag,
unsigned int  fanIndex 
)

@description Set the fax to maximum speed

Parameters
bOverrideFlag- Boolean value to enable/disalbe fan tur run in highspeed
Returns
RETURN_OK on success setting/unsetting the fan to run in high speed mode

◆ platform_hal_SetSNMPOnboardRebootEnable()

int platform_hal_SetSNMPOnboardRebootEnable ( char *  pValue)

@description Set SNMP Onboard Reboot Enable value to allow or ignore SNMP reboot

Parameters
pValue- SNMP Onboard Reboot Enable value ("disable", "enable")
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected

◆ platform_hal_GetMACsecEnable()

int platform_hal_GetMACsecEnable ( int  ethPort,
unsigned char *  pFlag 
)

@description Get MACsec enable status

Parameters
ethPort- Ethernet port (zero-based)
pFlag- MACsec enable value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected

◆ platform_hal_SetMACsecEnable()

int platform_hal_SetMACsecEnable ( int  ethPort,
unsigned char  Flag 
)

@description Enable/Disable MACsec

Parameters
ethPort- Ethernet port (zero-based)
Flag- MACsec enable value
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected

◆ platform_hal_GetMACsecOperationalStatus()

int platform_hal_GetMACsecOperationalStatus ( int  ethPort,
unsigned char *  pFlag 
)

@description Get MACsec operation status

Parameters
ethPort- Ethernet port (zero-based)
pFlag- MACsec operation status value, to be returned
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected

◆ platform_hal_StartMACsec()

int platform_hal_StartMACsec ( int  ethPort,
int  timeoutSec 
)

@description Start MACsec - Call should be Blocking

Parameters
ethPort- Ethernet port (zero-based)
timeoutSec- MACsec Start Timeout (0 means retry forever)
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected

◆ platform_hal_StopMACsec()

int platform_hal_StopMACsec ( int  ethPort)

@description Stop MACsec - Call should be Blocking

Parameters
ethPort- Ethernet port (zero-based)
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected

◆ platform_hal_GetMemoryPaths()

int platform_hal_GetMemoryPaths ( RDK_CPUS  index,
PPLAT_PROC_MEM_INFO ppinfo 
)

@description Get the device specific processors DRAM and eMMC paths

Parameters
RDK_CPUSindex - Index to which processor/CPU to request. Host is the primary RDK CPU
PPLAT_PROC_MEM_INFO*ppinfo - Ponter to get the return array
Returns
The status of the operation.
Return values
RETURN_OKif successful.
RETURN_ERRif any error is detected
Execution:\n Synchronous.
Side Effects:\n None.
Note
HAL function need to allocate the array of PPLAT_PROC_MEM_INFO and return with ppinfo.

◆ platform_hal_GetDhcpv4_Options()

int platform_hal_GetDhcpv4_Options ( dhcp_opt_list **  req_opt_list,
dhcp_opt_list **  send_opt_list 
)

◆ platform_hal_GetDhcpv6_Options()

int platform_hal_GetDhcpv6_Options ( dhcp_opt_list **  req_opt_list,
dhcp_opt_list **  send_opt_list 
)

◆ platform_hal_SetLowPowerModeState()

int platform_hal_SetLowPowerModeState ( PPSM_STATE  pState)

@description Set Low Power Mode State value. Hysteresis currently not accounted for before call.

Parameters
seconds- Low Power Mode State.
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

◆ platform_hal_getCMTSMac()

int platform_hal_getCMTSMac ( char *  pValue)

◆ platform_hal_setDscp()

int platform_hal_setDscp ( WAN_INTERFACE  interfaceType,
TRAFFIC_CNT_COMMAND  cmd,
char *  pDscpVals 
)

@description Control/Set traffic counting based on Dscp value

Parameters
interfaceType- 1 for DOCSIS , 2 for EWAN
cmd- START/STOP
dscpValcomma seperated string , e.g. "10,0" , NULL NULL is for all DSCP values , values are base 10
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected

◆ platform_hal_resetDscpCounts()

int platform_hal_resetDscpCounts ( WAN_INTERFACE  interfaceType)

@description To reset Dscp Counter values

Parameters
interfaceType- 1 for DOCSIS , 2 for EWAN
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected

◆ platform_hal_getDscpClientList()

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.

Parameters
interfaceType- 1 for DOCSIS , 2 for EWAN
pDSCP_List- List of client structure to be filled by hal

◆ platform_hal_GetCPUSpeed()

int platform_hal_GetCPUSpeed ( char *  cpuSpeed)

@description get cpu speed.

Parameters
cpuSpeed- store cpu speed
Returns
The status of the operation
Return values
RETURN_OKif successful
RETURN_ERRif any error is detected
Side Effects:\n None

Variable Documentation

◆ dramPath

char _PLAT_PROC_MEM_INFO::dramPath[40]

Definition at line 199 of file platform_hal.h.

◆ emmcPath1

char _PLAT_PROC_MEM_INFO::emmcPath1[40]

Definition at line 200 of file platform_hal.h.

◆ emmcPath2

char _PLAT_PROC_MEM_INFO::emmcPath2[40]

Definition at line 201 of file platform_hal.h.

◆ emmcPath3

char _PLAT_PROC_MEM_INFO::emmcPath3[40]

Definition at line 202 of file platform_hal.h.

◆ LedColor

LED_COLOR _LEDMGMT_PARAMS::LedColor

LED_COLOR.

Definition at line 749 of file platform_hal.h.

◆ State

int _LEDMGMT_PARAMS::State

0 for Solid, 1 for Blink

Definition at line 750 of file platform_hal.h.

◆ Interval

int _LEDMGMT_PARAMS::Interval

In case fs State is blink then interval per second.

Definition at line 751 of file platform_hal.h.

◆ dhcp_opt

int dhcp_opt_list::dhcp_opt

Definition at line 1069 of file platform_hal.h.

◆ dhcp_opt_val

char* dhcp_opt_list::dhcp_opt_val

Definition at line 1070 of file platform_hal.h.

◆ next

struct dhcp_opt_list* dhcp_opt_list::next

Definition at line 1071 of file platform_hal.h.

◆ mac

char Traffic_client::mac[18]

Definition at line 1131 of file platform_hal.h.

◆ rxBytes

unsigned long Traffic_client::rxBytes

Definition at line 1132 of file platform_hal.h.

◆ txBytes

unsigned long Traffic_client::txBytes

Definition at line 1133 of file platform_hal.h.

◆ dscp_value

unsigned int DSCP_Element::dscp_value

Definition at line 1137 of file platform_hal.h.

◆ numClients

unsigned int DSCP_Element::numClients

Definition at line 1138 of file platform_hal.h.

◆ Client

Traffic_client_t DSCP_Element::Client[256]

Definition at line 1139 of file platform_hal.h.

◆ numElements

unsigned int DSCP_list::numElements

Definition at line 1143 of file platform_hal.h.

◆ DSCP_Element

DSCP_Element_t DSCP_list::DSCP_Element[64]

Definition at line 1144 of file platform_hal.h.