RDK-B
Data Structures | Macros | Typedefs | Enumerations | Functions
platform_hal.h File Reference

For CCSP Component: CcspPandM. More...

Go to the source code of this file.

Data Structures

struct  _PLAT_PROC_MEM_INFO
 
struct  _LEDMGMT_PARAMS
 
struct  dhcp_opt_list
 
struct  Traffic_client
 
struct  DSCP_Element
 
struct  DSCP_list
 

Macros

#define CHAR   char
 
#define UCHAR   unsigned char
 
#define BOOLEAN   unsigned char
 
#define INT   int
 
#define UINT   unsigned int
 
#define ULONG   unsigned long
 
#define TRUE   1
 
#define FALSE   0
 
#define ENABLE   1
 
#define RETURN_OK   0
 
#define RETURN_ERR   -1
 
#define DHCPV6_OPT_82   82
 
#define DHCPV6_OPT_23   23
 
#define DHCPV6_OPT_95   95
 
#define DHCPV6_OPT_24   24
 
#define DHCPV6_OPT_83   83
 
#define DHCPV6_OPT_17   17
 
#define DHCPV6_OPT_31   31
 
#define DHCPV6_OPT_15   15
 
#define DHCPV6_OPT_16   16
 
#define DHCPV6_OPT_20   20
 
#define DHCPV4_OPT_42   42
 
#define DHCPV4_OPT_43   43
 
#define DHCPV4_OPT_58   58
 
#define DHCPV4_OPT_59   59
 
#define DHCPV4_OPT_60   60
 
#define DHCPV4_OPT_61   61
 
#define DHCPV4_OPT_100   100
 
#define DHCPV4_OPT_122   122
 
#define DHCPV4_OPT_125   125
 
#define DHCPV4_OPT_242   242
 
#define DHCPV4_OPT_243   243
 
#define DHCPV4_OPT_END   255
 
#define PLAT_PROC_MEM_MAX_LEN   40
 
#define LED_BUFFER_SIZE   3
 

Typedefs

typedef struct _PLAT_PROC_MEM_INFO PLAT_PROC_MEM_INFO
 
typedef struct _PLAT_PROC_MEM_INFO * PPLAT_PROC_MEM_INFO
 
typedef struct _LEDMGMT_PARAMS LEDMGMT_PARAMS
 
typedef struct _LEDMGMT_PARAMS * PLEDMGMT_PARAMS
 
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  RDK_CPUS { HOST_CPU =0, PEER_CPU =1, NOT_SUPPORTED_CPU =3 }
 
enum  LED_COLOR {
  LED_WHITE =0, LED_YELLOW =1, LED_GREEN =2, LED_RED =3,
  LED_BLUE =4, LED_RED_AND_GREEN =5, LED_YELLOW_AND_GREEN = 6, NOT_SUPPORTED =7
}
 
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)
 

yes

For CCSP Component: CcspPandM.

Author
Cisco @description This header file gives the function call prototypes and structure definitions used for the RDK-Broadband hardware abstraction layer for platform.

Definition in file platform_hal.h.

Macro Definition Documentation

◆ DHCPV6_OPT_82

#define DHCPV6_OPT_82   82

Definition at line 151 of file platform_hal.h.

◆ DHCPV6_OPT_23

#define DHCPV6_OPT_23   23

Definition at line 152 of file platform_hal.h.

◆ DHCPV6_OPT_95

#define DHCPV6_OPT_95   95

Definition at line 153 of file platform_hal.h.

◆ DHCPV6_OPT_24

#define DHCPV6_OPT_24   24

Definition at line 154 of file platform_hal.h.

◆ DHCPV6_OPT_83

#define DHCPV6_OPT_83   83

Definition at line 155 of file platform_hal.h.

◆ DHCPV6_OPT_17

#define DHCPV6_OPT_17   17

Definition at line 156 of file platform_hal.h.

◆ DHCPV6_OPT_31

#define DHCPV6_OPT_31   31

Definition at line 157 of file platform_hal.h.

◆ DHCPV6_OPT_15

#define DHCPV6_OPT_15   15

Definition at line 158 of file platform_hal.h.

◆ DHCPV6_OPT_16

#define DHCPV6_OPT_16   16

Definition at line 159 of file platform_hal.h.

◆ DHCPV6_OPT_20

#define DHCPV6_OPT_20   20

Definition at line 160 of file platform_hal.h.

◆ DHCPV4_OPT_42

#define DHCPV4_OPT_42   42

Definition at line 164 of file platform_hal.h.

◆ DHCPV4_OPT_43

#define DHCPV4_OPT_43   43

Definition at line 165 of file platform_hal.h.

◆ DHCPV4_OPT_58

#define DHCPV4_OPT_58   58

Definition at line 166 of file platform_hal.h.

◆ DHCPV4_OPT_59

#define DHCPV4_OPT_59   59

Definition at line 167 of file platform_hal.h.

◆ DHCPV4_OPT_60

#define DHCPV4_OPT_60   60

Definition at line 168 of file platform_hal.h.

◆ DHCPV4_OPT_61

#define DHCPV4_OPT_61   61

Definition at line 169 of file platform_hal.h.

◆ DHCPV4_OPT_100

#define DHCPV4_OPT_100   100

Definition at line 170 of file platform_hal.h.

◆ DHCPV4_OPT_122

#define DHCPV4_OPT_122   122

Definition at line 171 of file platform_hal.h.

◆ DHCPV4_OPT_125

#define DHCPV4_OPT_125   125

Definition at line 172 of file platform_hal.h.

◆ DHCPV4_OPT_242

#define DHCPV4_OPT_242   242

Definition at line 173 of file platform_hal.h.

◆ DHCPV4_OPT_243

#define DHCPV4_OPT_243   243

Definition at line 174 of file platform_hal.h.

◆ DHCPV4_OPT_END

#define DHCPV4_OPT_END   255

Definition at line 175 of file platform_hal.h.

◆ PLAT_PROC_MEM_MAX_LEN

#define PLAT_PROC_MEM_MAX_LEN   40

Definition at line 188 of file platform_hal.h.

Typedef Documentation

◆ PLAT_PROC_MEM_INFO

typedef struct _PLAT_PROC_MEM_INFO PLAT_PROC_MEM_INFO

◆ PPLAT_PROC_MEM_INFO

typedef struct _PLAT_PROC_MEM_INFO * PPLAT_PROC_MEM_INFO

Enumeration Type Documentation

◆ RDK_CPUS

enum RDK_CPUS
Enumerator
HOST_CPU 
PEER_CPU 
NOT_SUPPORTED_CPU 

Definition at line 181 of file platform_hal.h.