IPC API
3.30.03.14
|
============================================================================
Go to the source code of this file.
Data Structures | |
struct | IpcPower_WugenEvtMask |
Type representing OMAP's WUGEN_MEVT[0|1] registers. More... | |
Macros | |
#define | IpcPower_S_SUCCESS (0) |
Operation is successful. More... | |
#define | IpcPower_E_FAIL (-1) |
Operation is not successful. More... | |
#define | IpcPower_E_MEMORY (-2) |
Operation resulted in memory failure. More... | |
Typedefs | |
typedef enum IpcPower_Event | IpcPower_Event |
Event types for power management callbacks. More... | |
typedef Void(* | IpcPower_CallbackFuncPtr )(Int event, Ptr data) |
Power Event Callback function type definition. More... | |
typedef struct IpcPower_WugenEvtMask | IpcPower_WugenEvtMask |
Type representing OMAP's WUGEN_MEVT[0|1] registers. More... | |
Enumerations | |
enum | IpcPower_Event { IpcPower_Event_SUSPEND = 0, IpcPower_Event_RESUME = 1 } |
Event types for power management callbacks. More... | |
Functions | |
Void | IpcPower_init () |
Initialize the IpcPower module. More... | |
Void | IpcPower_exit () |
Finalize the IpcPower module. More... | |
Void | IpcPower_suspend () |
Initiate the suspend procedure. More... | |
Void | IpcPower_wakeLock () |
Disable the deep sleep mode in the core. More... | |
Void | IpcPower_wakeUnlock () |
Enable the core to go to deep sleep mode. More... | |
UInt | IpcPower_hibernateLock () |
Disable the core to go to suspend / hibernate. More... | |
UInt | IpcPower_hibernateUnlock () |
Enable the core to go to suspend / hibernate. More... | |
Bool | IpcPower_canHibernate () |
Return TRUE if hibernation is allowed. More... | |
Int | IpcPower_registerCallback (Int event, IpcPower_CallbackFuncPtr fxn, Ptr data) |
Register callback function for a Power event. More... | |
Int | IpcPower_unregisterCallback (Int event, IpcPower_CallbackFuncPtr fxn) |
Unregister callback function for a Power event. More... | |
Void | IpcPower_getWugenEvtMask (IpcPower_WugenEvtMask *mask) |
Retrieve current WUGEN mask used for suspend. More... | |
Void | IpcPower_setWugenEvtMask (IpcPower_WugenEvtMask *mask) |
Set WUGEN mask used for suspend. More... | |
#define IpcPower_S_SUCCESS (0) |
Operation is successful.
#define IpcPower_E_FAIL (-1) |
Operation is not successful.
#define IpcPower_E_MEMORY (-2) |
Operation resulted in memory failure.
typedef enum IpcPower_Event IpcPower_Event |
Event types for power management callbacks.
typedef Void(* IpcPower_CallbackFuncPtr)(Int event, Ptr data) |
Power Event Callback function type definition.
typedef struct IpcPower_WugenEvtMask IpcPower_WugenEvtMask |
Type representing OMAP's WUGEN_MEVT[0|1] registers.
For APIs IpcPower_getWugenEvtMask() and IpcPower_setWugenEvtMask()
enum IpcPower_Event |
Void IpcPower_init | ( | ) |
Initialize the IpcPower module.
Void IpcPower_exit | ( | ) |
Finalize the IpcPower module.
Void IpcPower_suspend | ( | ) |
Initiate the suspend procedure.
Void IpcPower_wakeLock | ( | ) |
Disable the deep sleep mode in the core.
Void IpcPower_wakeUnlock | ( | ) |
Enable the core to go to deep sleep mode.
UInt IpcPower_hibernateLock | ( | ) |
Disable the core to go to suspend / hibernate.
UInt IpcPower_hibernateUnlock | ( | ) |
Enable the core to go to suspend / hibernate.
Bool IpcPower_canHibernate | ( | ) |
Return TRUE if hibernation is allowed.
Int IpcPower_registerCallback | ( | Int | event, |
IpcPower_CallbackFuncPtr | fxn, | ||
Ptr | data | ||
) |
Register callback function for a Power event.
[in] | event | Power Management callback event type. |
[in] | fxn | Function being registered. |
[in] | data | Data to be passed as argument to function. |
Returns SUCCESS or FAIL
Int IpcPower_unregisterCallback | ( | Int | event, |
IpcPower_CallbackFuncPtr | fxn | ||
) |
Unregister callback function for a Power event.
[in] | event | Power Management callback event type. |
[in] | fxn | Function being unregistered. |
Returns SUCCESS or FAIL
Void IpcPower_getWugenEvtMask | ( | IpcPower_WugenEvtMask * | mask | ) |
Retrieve current WUGEN mask used for suspend.
[in] | mask | Pointer to structure for holding WUGEN event mask |
Void IpcPower_setWugenEvtMask | ( | IpcPower_WugenEvtMask * | mask | ) |
Set WUGEN mask used for suspend.
The values in the passed structure are copied into the internal WUGEN event mask. To achieve an ORing of certain bits in the mask, first retrieve the current mask with IpcPower_getWugenEvtMask() and then OR in the bits you want to enable.
[in] | mask | Pointer to WUGEN event mask structure |