Deep Sleep Manager HAL Public API. More...

#include "libIARM.h"
#include "libIBusDaemon.h"

Include dependency graph for deepSleepMgr.h:

Data Structures
struct	_IARM_Bus_DeepSleepMgr_SetDeepSleepTimer_Param_t
	Structure which holds the HAL timeout in seconds. More...

struct	_IARM_Bus_DeepSleepMgr_WakeupKeyCode_Param_t
	Struct for handling the wake up key code. More...

Macros
#define	IARM_BUS_DEEPSLEEPMGR_NAME "DEEPSLEEPMgr"

#define	IARM_BUS_DEEPSLEEPMGR_API_SetDeepSleepTimer "SetDeepSleepTimer"

#define	IARM_BUS_DEEPSLEEPMGR_API_GetLastWakeupReason "GetLastWakeupReason"

#define	IARM_BUS_DEEPSLEEPMGR_API_GetLastWakeupKeyCode "GetLastWakeupKeycode"

Typedefs
typedef enum _DeepSleepStatus_t	DeepSleepStatus_t

typedef struct _IARM_Bus_DeepSleepMgr_SetDeepSleepTimer_Param_t	IARM_Bus_DeepSleepMgr_SetDeepSleepTimer_Param_t
	Structure which holds the HAL timeout in seconds.

typedef enum _DeepSleep_WakeupReason_t	DeepSleep_WakeupReason_t
	Enum for all possible Wakeup Reasons from DeepSleep State.

typedef struct _IARM_Bus_DeepSleepMgr_WakeupKeyCode_Param_t	IARM_Bus_DeepSleepMgr_WakeupKeyCode_Param_t
	Struct for handling the wake up key code.

Enumerations
enum	_DeepSleepStatus_t { DeepSleepStatus_Failed = -1 , DeepSleepStatus_NotStarted = 0 , DeepSleepStatus_InProgress , DeepSleepStatus_Completed }

enum	_DeepSleep_WakeupReason_t { DEEPSLEEP_WAKEUPREASON_IR = 0 , DEEPSLEEP_WAKEUPREASON_RCU_BT , DEEPSLEEP_WAKEUPREASON_RCU_RF4CE , DEEPSLEEP_WAKEUPREASON_GPIO , DEEPSLEEP_WAKEUPREASON_LAN , DEEPSLEEP_WAKEUPREASON_WLAN , DEEPSLEEP_WAKEUPREASON_TIMER , DEEPSLEEP_WAKEUPREASON_FRONT_PANEL , DEEPSLEEP_WAKEUPREASON_WATCHDOG , DEEPSLEEP_WAKEUPREASON_SOFTWARE_RESET , DEEPSLEEP_WAKEUPREASON_THERMAL_RESET , DEEPSLEEP_WAKEUPREASON_WARM_RESET , DEEPSLEEP_WAKEUPREASON_COLDBOOT , DEEPSLEEP_WAKEUPREASON_STR_AUTH_FAILURE , DEEPSLEEP_WAKEUPREASON_CEC , DEEPSLEEP_WAKEUPREASON_PRESENCE , DEEPSLEEP_WAKEUPREASON_VOICE , DEEPSLEEP_WAKEUPREASON_UNKNOWN }
	Enum for all possible Wakeup Reasons from DeepSleep State. More...

Functions
int	PLAT_DS_INIT (void)
	Initializes the underlying Deep Sleep Management module.

int	PLAT_DS_SetDeepSleep (uint32_t deep_sleep_timeout, bool *isGPIOWakeup)
	Sets the CPE's Power State to Deep Sleep.

void	PLAT_DS_DeepSleepWakeup (void)
	Sets or configures the platform status after deepsleep wake-up.

void	PLAT_DS_TERM (void)
	Terminates the CPE Deep Sleep Management module.

int	PLAT_DS_GetLastWakeupReason (DeepSleep_WakeupReason_t *wakeupReason)
	Gets the CPE's Last wakeup reason.

int	PLAT_DS_GetLastWakeupKeyCode (IARM_Bus_DeepSleepMgr_WakeupKeyCode_Param_t *wakeupKeyCode)
	Gets the CPE's Last wakeup key code.

Detailed Description

Deep Sleep Manager HAL Public API.

This API defines the structures and functions for the Deep Sleep Manager HAL

Abbreviations

Data Structures