RDK Documentation (Open Sourced RDK Components)
Functions
IARM-Bus HAL Power Manager API.
IARM Manager » HAL Types and Public APIDevicesettingsIARM-Sys Manager internal API. | IARM-Disk Manager internal API. | IARM-Disk Manager API. | IARM-Bus IR Manager API. | IARM-MFR Manager API | IARM-Sys Manager internal API. | IARM-VREX Manager API. » | Iarmmgrs » | Hal » Power Manager (HAL Types and Public API)IARM-Sys Manager internal API. | IARM-Disk Manager internal API. | IARM-Disk Manager API. | IARM-Bus IR Manager API. | IARM-MFR Manager API | IARM-Sys Manager internal API. | IARM-VREX Manager API. » Iarmmgrs » Mfr » | IARM-Sys Manager API

Description

Described herein are the IARM-Bus HAL types and functions that are part of the Power Manager application. This manager monitors Power IR key events and reacts to power state changes based on Comcast RDK Power Management Specification. It dispatches Power Mode Change events to IARM-Bus. All listeners should releases resources when entering POWER OFF/STANDBY state and re-acquire them when entering POWER ON state.

Functions

int PLAT_INIT (void)
 Initialize the underlying Power Management module. More...
 
int PLAT_API_SetPowerState (IARM_Bus_PWRMgr_PowerState_t newState)
 This API sets the CPE Power State. More...
 
int PLAT_API_GetPowerState (IARM_Bus_PWRMgr_PowerState_t *curState)
 This function is used to get the CPE Power State. More...
 
void PLAT_Reset (IARM_Bus_PWRMgr_PowerState_t newState)
 This API resets the power state of the device. More...
 
void PLAT_TERM (void)
 This API terminates the power management module. More...
 

Function Documentation

◆ PLAT_INIT()

int PLAT_INIT ( void  )

Initialize the underlying Power Management module.

This function must initialize all aspects of the CPE's Power Management module.

Returns
Returns the status of the operation
Return values
0if successful, appropiate error code otherwise.

◆ PLAT_API_SetPowerState()

int PLAT_API_SetPowerState ( IARM_Bus_PWRMgr_PowerState_t  newState)

This API sets the CPE Power State.

This function sets the CPE's current power state to the specified state.

Parameters
[in]newStateThe power state to which to set the CPE.
Returns
Returns the status of the operation.
Return values
0if successful, appropiate error code otherwise.

◆ PLAT_API_GetPowerState()

int PLAT_API_GetPowerState ( IARM_Bus_PWRMgr_PowerState_t *  curState)

This function is used to get the CPE Power State.

This function returns the current power state of the CPE.

Parameters
[in]curStateThe address of a location to hold the current power state of the CPE on return.
Returns
Returns the status of the operation.
Return values
0if successful, appropiate error code otherwise.

◆ PLAT_Reset()

void PLAT_Reset ( IARM_Bus_PWRMgr_PowerState_t  newState)

This API resets the power state of the device.

Parameters
[in]newStateThe state to be set. The input paramter is not in use.

◆ PLAT_TERM()

void PLAT_TERM ( void  )

This API terminates the power management module.

This function must terminate the CPE Power Management module. It must reset any data structures used within Power Management module and release any Power Management specific handles and resources.