RDK Documentation (Open Sourced RDK Components)
pwrMgr.h File Reference

IARM-Bus Power Manager Public API. More...

#include "libIARM.h"
#include "libIBusDaemon.h"
#include <stdint.h>
#include <stdbool.h>
Include dependency graph for pwrMgr.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _PWRMgr_EventData_t
 Structure which holds the event data. More...
 
struct  _IARM_BUS_PWRMgr_DeepSleepTimeout_EventData_t
 Structure which holds the Deep sleep timeout value. More...
 
struct  _IARM_BUS_PWRMgr_WareHouseOpn_EventData_t
 Structure which holds warehouse opn status value. More...
 
struct  _IARM_Bus_PWRMgr_SetPowerState_Param_t
 Structure which holds the new powerstate to be set to the device. More...
 
struct  _IARM_Bus_PWRMgr_GetPowerState_Param_t
 Structure which holds the current power state of the CPE. More...
 
struct  _IARM_Bus_PWRMgr_WareHouseReset_Param_t
 Structure which holds the ware house reset time. More...
 
struct  _IARM_Bus_PWRMgr_SetDeepSleepTimeOut_Param_t
 Structure which holds the timeout value to set for Deep sleep. More...
 
struct  _IARM_Bus_PWRMgr_SleepTimer_Param_t
 Structure which holds the sleep timer information. More...
 
struct  _IARM_Bus_PWRMgr_StandbyVideoState_Param_t
 
struct  _IARM_Bus_PWRMgr_NetworkStandbyMode_Param_t
 
struct  _IARM_Bus_PWRMgr_GetPowerStateBeforeReboot_Param_t
 Structure which holds the power state before reboot of the CPE. More...
 
struct  _IARM_Bus_PWRMgr_RebootParam_t
 Structure to pass reboot reason argument with the reboot call. More...
 
union  _PWRMgr_EventData_t.data
 
struct  _MODE_DATA.data.state
 

Macros

#define IARM_BUS_PWRMGR_NAME   "PWRMgr"
 
#define IARM_BUS_PWRMGR_API_SetPowerState   "SetPowerState"
 
#define IARM_BUS_PWRMGR_API_GetPowerState   "GetPowerState"
 
#define IARM_BUS_PWRMGR_API_WareHouseReset   "WareHouseReset"
 
#define IARM_BUS_PWRMGR_API_WareHouseClear   "WarehouseClear"
 
#define IARM_BUS_PWRMGR_API_ColdFactoryReset   "ColdFactoryReset"
 
#define IARM_BUS_PWRMGR_API_FactoryReset   "FactoryReset"
 
#define IARM_BUS_PWRMGR_API_UserFactoryReset   "UserFactoryReset"
 
#define IARM_BUS_PWRMGR_API_SetDeepSleepTimeOut   "SetDeepSleepTimeOut"
 
#define IARM_BUS_PWRMGR_API_SetSleepTimer   "SetSleepTimer"
 
#define IARM_BUS_PWRMGR_API_GetSleepTimer   "GetSleepTimer"
 
#define PWRMGR_MAX_VIDEO_PORT_NAME_LENGTH   16
 Structure which holds the setting for whether video port is enabled in standby.
 
#define IARM_BUS_PWRMGR_API_SetStandbyVideoState   "SetStandbyVideoState"
 
#define IARM_BUS_PWRMGR_API_GetStandbyVideoState   "GetStandbyVideoState"
 
#define IARM_BUS_PWRMGR_API_SetNetworkStandbyMode   "SetNetworkStandbyMode"
 
#define IARM_BUS_PWRMGR_API_GetNetworkStandbyMode   "GetNetworkStandbyMode"
 
#define MAX_PWR_STATE_BEF_REBOOR_STR_LEN   (32)
 
#define IARM_BUS_PWRMGR_API_GetPowerStateBeforeReboot   "GetPowerStateBeforeReboot"
 
#define PWRMGR_MAX_REBOOT_REASON_LENGTH   100
 
#define PWRMGR_REBOOT_REASON_MAINTENANCE   "MAINTENANCE_REBOOT"
 
#define IARM_BUS_PWRMGR_API_Reboot   "performReboot"
 
#define IARM_BUS_PWRMGR_API_handleDeepsleepTimeoutWakeup   "handleDeepsleepTimeoutWakeup"
 

Typedefs

typedef enum _PWRMgr_EventId_t IARM_Bus_PWRMgr_EventId_t
 Represents the published Events from PWR Manager.
 
typedef enum _IARM_Bus_PWRMgr_ThermalState_t IARM_Bus_PWRMgr_ThermalState_t
 Enumerator which represents the possible temeperature states.
 
typedef enum _IARM_Bus_PWRMgr_WareHouseOps_t IARM_Bus_PWRMgr_WareHouseOps_t
 Enumerator which represents the possible warehouse ops.
 
typedef enum _IARM_Bus_PWRMgr_WareHouseOpsStatus_t IARM_Bus_PWRMgr_WareHouseOpsStatus_t
 Enumerator which represents the possible warehouse ops.
 
typedef struct _PWRMgr_EventData_t IARM_Bus_PWRMgr_EventData_t
 Structure which holds the event data.
 
typedef struct _IARM_BUS_PWRMgr_DeepSleepTimeout_EventData_t IARM_BUS_PWRMgr_DeepSleepTimeout_EventData_t
 Structure which holds the Deep sleep timeout value.
 
typedef struct _IARM_BUS_PWRMgr_WareHouseOpn_EventData_t IARM_BUS_PWRMgr_WareHouseOpn_EventData_t
 Structure which holds warehouse opn status value.
 
typedef struct _IARM_Bus_PWRMgr_SetPowerState_Param_t IARM_Bus_PWRMgr_SetPowerState_Param_t
 Structure which holds the new powerstate to be set to the device.
 
typedef struct _IARM_Bus_PWRMgr_GetPowerState_Param_t IARM_Bus_PWRMgr_GetPowerState_Param_t
 Structure which holds the current power state of the CPE.
 
typedef struct _IARM_Bus_PWRMgr_WareHouseReset_Param_t IARM_Bus_PWRMgr_WareHouseReset_Param_t
 Structure which holds the ware house reset time.
 
typedef struct _IARM_Bus_PWRMgr_SetDeepSleepTimeOut_Param_t IARM_Bus_PWRMgr_SetDeepSleepTimeOut_Param_t
 Structure which holds the timeout value to set for Deep sleep.
 
typedef struct _IARM_Bus_PWRMgr_SleepTimer_Param_t IARM_Bus_PWRMgr_SleepTimer_Param_t
 Structure which holds the sleep timer information.
 
typedef struct _IARM_Bus_PWRMgr_StandbyVideoState_Param_t IARM_Bus_PWRMgr_StandbyVideoState_Param_t
 
typedef struct _IARM_Bus_PWRMgr_NetworkStandbyMode_Param_t IARM_Bus_PWRMgr_NetworkStandbyMode_Param_t
 
typedef struct _IARM_Bus_PWRMgr_GetPowerStateBeforeReboot_Param_t IARM_Bus_PWRMgr_GetPowerStateBeforeReboot_Param_t
 Structure which holds the power state before reboot of the CPE.
 
typedef struct _IARM_Bus_PWRMgr_RebootParam_t IARM_Bus_PWRMgr_RebootParam_t
 Structure to pass reboot reason argument with the reboot call.
 

Enumerations

enum  _PWRMgr_EventId_t
 Represents the published Events from PWR Manager. More...
 
enum  _IARM_Bus_PWRMgr_ThermalState_t
 Enumerator which represents the possible temeperature states.
 
enum  _IARM_Bus_PWRMgr_WareHouseOps_t
 Enumerator which represents the possible warehouse ops.
 
enum  _IARM_Bus_PWRMgr_WareHouseOpsStatus_t
 Enumerator which represents the possible warehouse ops.
 

yes

IARM-Bus Power Manager Public API.

This API defines the structures and functions for the IARM-Bus Power Manager interface.

Definition in file pwrMgr.h.