Helper layer that provides support for nrfx_pm interface. This file contains functionality that should be used only from inside drivers.
More...
|
#define | NRFX_PM_DEFAULT_CONFIG(_transition_handler) |
| Power Management default configuration. This configuration must be used internally in the drivers.
|
|
Helper layer that provides support for nrfx_pm interface. This file contains functionality that should be used only from inside drivers.
◆ NRFX_PM_DEFAULT_CONFIG
#define NRFX_PM_DEFAULT_CONFIG |
( |
|
_transition_handler | ) |
|
Value: { \
.transition_handler = _transition_handler, \
.event_handler = NULL, \
.peripheral_busy = false \
}
@ NRFX_PM_STATE_OFF
Last completed state of the machine is Power Off.
Definition: nrfx_pm_driver.h:22
Power Management default configuration. This configuration must be used internally in the drivers.
- Parameters
-
[in] | _transition_handler | Transition handler provided by driver. |
◆ nrfx_pm_operation_t
Operations that can be triggered on the driver instance.
Enumerator |
---|
NRFX_PM_OPERATION_TURN_OFF | Turn off instance of the peripheral.
|
NRFX_PM_OPERATION_TURN_ON | Turn on instance of the peripheral.
|
◆ nrfx_pm_state_t
Work states of the internal Power Management finite-state machine.
Enumerator |
---|
NRFX_PM_STATE_OFF | Last completed state of the machine is Power Off.
|
NRFX_PM_STATE_WAKING_UP | Last completed state of the machine is Waking Up.
|
NRFX_PM_STATE_ON | Last completed state of the machine is Power On.
|
NRFX_PM_STATE_POWERING_DOWN | Last completed state of the machine is Powering Down.
|
◆ nrfx_pm_busy_set()
void nrfx_pm_busy_set |
( |
nrfx_pm_t * |
p_pm, |
|
|
bool |
is_busy |
|
) |
| |
Fuction for setting the busy state.
- Parameters
-
[in] | p_pm | Pointer to the instance of driver's power management structure. |
[in] | is_busy | True if the busy state is to be enabled, false otherwise. |
◆ nrfx_pm_is_powered()
Function for checking if the peripheral is powered.
- Parameters
-
[in] | p_pm | Pointer to the instance of driver's power management structure. |
- Return values
-
true | Peripheral instance is powered on. |
false | Peripheral instance is powered off. |
◆ nrfx_pm_notify()
Function to be called when power up or power down procedure is finished.
- Parameters
-
[in] | p_pm | Pointer to the instance of driver's power management structure. |
◆ nrfx_pm_powered_set()
Function for setting the powered status.
- Parameters
-
[in] | p_pm | Pointer to the instance of driver's power management structure. |