Power Class Reference

class Power

User-level domain manager's interface to Kernel-level power management.

Member Functions Documentation

CancelWakeupEventNotification()

IMPORT_C void CancelWakeupEventNotification ( ) [static]

Cancels a pending wakeup event notification request.

If, at the time this function is called, the notification request is still pending, then the request completes with KErrCancel status.

The caller must have PowerMgnt capability to perform this call; otherwise it panics with EPlatformSecurityTrap code

panic
KERN-EXEC 46 if the caller does not have PowerMgnt capability.
capability
PowerMgmt

DisableWakeupEvents()

IMPORT_C void DisableWakeupEvents ( ) [static]

Disables wakeup events.

If, at the time this function is called, wakeup events are disabled, then the function does nothing and returns immediately.

The caller must have PowerMgnt capability to perform this call; otherwise it panics with EPlatformSecurityTrap code.

panic
KERN-EXEC 46 if the caller does not have PowerMgnt capability.
capability
PowerMgmt

EnableWakeupEvents(TPowerState)

IMPORT_C TInt EnableWakeupEvents ( TPowerState ) [static]

Enables wakeup events.

Starts a system-wide transition to a low power state enabling wakeup events.

The exact specification of wakeup events depends on the target power state and the platform. For example, an absolute timer expiration event wakes up the system from the EPwStandby power state on all currently supported platforms.

If, at the time this function is called, wakeup events are enabled, then the implementation disables them before enabling them again.

The caller must have PowerMgnt capability to perform this call; otherwise it panics with EPlatformSecurityTrap code.

panic
KERN-EXEC 46 if the caller does not have PowerMgnt capability.
Power::DisableWakeupEvents()
capability
PowerMgmt

Parameters

TPowerState The target low power state; this can be EPwStandby or KPwOff.

PowerDown()

IMPORT_C TInt PowerDown ( ) [static]

Lowers the kernel power state.

Changes the kernel power state from EPwActive to the state specified by the last call to EnableWakeupEvents() .

If the target state is EPwStandby, the function returns either immediately, if at least one wakeup event has occurred since the last call to EnableWakeupEvent(), or when a wakeup event eventually occurs.

When this function returns, wakeup events are disabled.

If the target state is EPwOff, this function never returns, the system is powered off, and can subsequently only come back by rebooting.

The caller must have PowerMgnt capability to perform this call; otherwise it panics with EPlatformSecurityTrap code

panic
KERN-EXEC 46 if the caller does not have PowerMgnt capability.
capability
PowerMgmt

RequestWakeupEventNotification(TRequestStatus &)

IMPORT_C void RequestWakeupEventNotification ( TRequestStatus & ) [static]

Requests notification of a subsequent wakeup event.

Typically the user-side domain manager issues this request before starting a system-wide transition to a low power state by enabling wakeup events.

Only one pending request is allowed. The request completes immediately with KErrInUse status if another request is currently pending.

The caller must have PowerMgnt capability to perform this call; otherwise it panics with EPlatformSecurityTrap code.

panic
KERN-EXEC 46 if the caller does not have PowerMgnt capability.
Power::EnableWakeupEvents()
capability
PowerMgmt

Parameters

TRequestStatus & The request status to signal on wakeup event