Power Management interface. More...

Typedefs
typedef void(*	nrfx_pm_event_handler_t) (nrfx_pm_event_t pm_event)
	Power management event handler type.

Enumerations
enum	nrfx_pm_event_t { NRFX_PM_EVENT_SHUTDOWN , NRFX_PM_EVENT_RESTORED }
	Power management event types. More...

Functions
void	nrfx_pm_init (void *p_pm, nrfx_pm_event_handler_t event_handler)
	Function for initializing the power management.

nrfx_err_t	nrfx_pm_power_on (void *p_pm)
	Function for starting power on sequence on a given instance of the peripheral.

nrfx_err_t	nrfx_pm_power_off (void *p_pm, bool force)
	Function for starting power off sequence on a given instance of the peripheral.

Detailed Description

Power Management interface.

Typedef Documentation

typedef void(* nrfx_pm_event_handler_t) (nrfx_pm_event_t pm_event)

Power management event handler type.

Parameters

[in] pm_event Event.

Power management event types.

Enumerator
NRFX_PM_EVENT_SHUTDOWN	Event generated when the instance of the peripheral has been turned off.
NRFX_PM_EVENT_RESTORED	Event generated when the instance of the peripheral has been turned on.

Function for initializing the power management.

Parameters

[in]	p_pm	Pointer to the instance of driver's power management structure.
[in]	event_handler	Event handler provided by the user.

Function for starting power off sequence on a given instance of the peripheral.

Parameters

[in]	p_pm	Pointer to the instance of the power management structure of the peripheral instance.
[in]	force	True if power off sequence is forced, false otherwise.

Return values

NRFX_SUCCESS	Powering down is delegated.
NRFX_ERROR_ALREADY	Peripheral is already powered down.

nrfx_err_t nrfx_pm_power_on ( void * p_pm )

Function for starting power on sequence on a given instance of the peripheral.

Parameters

[in] p_pm Pointer to the instance of driver's power management structure.

Return values

NRFX_SUCCESS	Powering up is delegated.
NRFX_ERROR_ALREADY	Peripheral is already powered up.