POWER peripheral driver. More...
Modules | |
POWER peripheral driver configuration | |
Data Structures | |
struct | nrfx_power_config_t |
General power configuration. More... | |
struct | nrfx_power_pofwarn_config_t |
The configuration for power failure comparator. More... | |
struct | nrfx_power_sleepevt_config_t |
The configuration of sleep event processing. More... | |
struct | nrfx_power_usbevt_config_t |
The configuration of the USB-related power events. More... | |
Enumerations | |
enum | nrfx_power_mode_t { NRFX_POWER_MODE_CONSTLAT , NRFX_POWER_MODE_LOWPWR } |
Power mode possible configurations. More... | |
enum | nrfx_power_sleep_evt_t { NRFX_POWER_SLEEP_EVT_ENTER , NRFX_POWER_SLEEP_EVT_EXIT } |
Events from power system. More... | |
enum | nrfx_power_usb_evt_t { NRFX_POWER_USB_EVT_DETECTED , NRFX_POWER_USB_EVT_REMOVED , NRFX_POWER_USB_EVT_READY } |
Events from USB power system. More... | |
enum | nrfx_power_usb_state_t { NRFX_POWER_USB_STATE_DISCONNECTED , NRFX_POWER_USB_STATE_CONNECTED , NRFX_POWER_USB_STATE_READY } |
USB power state. More... | |
Functions | |
nrfx_power_pofwarn_event_handler_t | nrfx_power_pof_handler_get (void) |
Function for getting the handler of the power failure comparator. | |
nrfx_power_usb_event_handler_t | nrfx_power_usb_handler_get (void) |
Function for getting the handler of the USB power. | |
nrfx_err_t | nrfx_power_init (nrfx_power_config_t const *p_config) |
Function for initializing the power module driver. | |
void | nrfx_power_uninit (void) |
Function for unintializing the power module driver. | |
bool | nrfx_power_init_check (void) |
Function for checking if the power module driver is initialized. | |
void | nrfx_power_pof_init (nrfx_power_pofwarn_config_t const *p_config) |
Function for initializing the power failure comparator. | |
void | nrfx_power_pof_enable (nrfx_power_pofwarn_config_t const *p_config) |
Function for enabling the power failure comparator. Sets and enables the interrupt of the power failure comparator. This function cannot be in use when SoftDevice is enabled. If the event handler set in the init function is set to NULL, the interrupt will be disabled. | |
void | nrfx_power_pof_disable (void) |
Function for disabling the power failure comparator. | |
void | nrfx_power_pof_uninit (void) |
Function for clearing the power failure comparator settings. | |
void | nrfx_power_sleepevt_init (nrfx_power_sleepevt_config_t const *p_config) |
Function for initializing the processing of the sleep events. | |
void | nrfx_power_sleepevt_enable (nrfx_power_sleepevt_config_t const *p_config) |
Function for enabling the processing of the sleep events. | |
void | nrfx_power_sleepevt_disable (void) |
Function for disabling the processing of the sleep events. | |
void | nrfx_power_sleepevt_uninit (void) |
Function for uninitializing the processing of the sleep events. | |
void | nrfx_power_usbevt_init (nrfx_power_usbevt_config_t const *p_config) |
Function for initializing the processing of USB power event. | |
void | nrfx_power_usbevt_enable (void) |
Function for enabling the processing of USB power event. | |
void | nrfx_power_usbevt_disable (void) |
Function for disabling the processing of USB power event. | |
void | nrfx_power_usbevt_uninit (void) |
Function for uninitalizing the processing of USB power event. | |
NRFX_STATIC_INLINE nrfx_power_usb_state_t | nrfx_power_usbstatus_get (void) |
Function for getting the status of USB power. | |
Callback types | |
Defined types of callback functions. | |
typedef void(* | nrfx_power_pofwarn_event_handler_t) (void) |
Event handler for power failure warning. | |
typedef void(* | nrfx_power_sleep_event_handler_t) (nrfx_power_sleep_evt_t event) |
Event handler for the sleep events. | |
typedef void(* | nrfx_power_usb_event_handler_t) (nrfx_power_usb_evt_t event) |
Event handler for the USB-related power events. | |
POWER peripheral driver.
typedef void(* nrfx_power_sleep_event_handler_t) (nrfx_power_sleep_evt_t event) |
Event handler for the sleep events.
event | Event type |
typedef void(* nrfx_power_usb_event_handler_t) (nrfx_power_usb_evt_t event) |
Event handler for the USB-related power events.
event | Event type |
enum nrfx_power_mode_t |
enum nrfx_power_usb_evt_t |
USB power state.
The single enumerator that holds all data about current state of USB related POWER.
Organized this way that higher power state has higher numeric value
nrfx_err_t nrfx_power_init | ( | nrfx_power_config_t const * | p_config | ) |
Function for initializing the power module driver.
Enabled power module driver processes all the interrupts from the power system.
[in] | p_config | Pointer to the structure with the initial configuration. |
NRFX_SUCCESS | Successfully initialized. |
NRFX_ERROR_ALREADY | Module was already initialized. |
bool nrfx_power_init_check | ( | void | ) |
Function for checking if the power module driver is initialized.
true | Driver is already initialized. |
false | Driver is not initialized. |
void nrfx_power_pof_disable | ( | void | ) |
Function for disabling the power failure comparator.
Disables the power failure comparator interrupt.
void nrfx_power_pof_enable | ( | nrfx_power_pofwarn_config_t const * | p_config | ) |
Function for enabling the power failure comparator. Sets and enables the interrupt of the power failure comparator. This function cannot be in use when SoftDevice is enabled. If the event handler set in the init function is set to NULL, the interrupt will be disabled.
[in] | p_config | Configuration with values and event handler. |
nrfx_power_pofwarn_event_handler_t nrfx_power_pof_handler_get | ( | void | ) |
Function for getting the handler of the power failure comparator.
void nrfx_power_pof_init | ( | nrfx_power_pofwarn_config_t const * | p_config | ) |
Function for initializing the power failure comparator.
Configures the power failure comparator. This function does not set it up and enable it. These steps can be done with functions nrfx_power_pof_enable and nrfx_power_pof_disable or with the SoftDevice API (when in use).
[in] | p_config | Configuration with values and event handler. If event handler is set to NULL, the interrupt will be disabled. |
void nrfx_power_pof_uninit | ( | void | ) |
Function for clearing the power failure comparator settings.
Clears the settings of the power failure comparator.
void nrfx_power_sleepevt_enable | ( | nrfx_power_sleepevt_config_t const * | p_config | ) |
Function for enabling the processing of the sleep events.
[in] | p_config | Configuration with values and event handler. |
void nrfx_power_sleepevt_init | ( | nrfx_power_sleepevt_config_t const * | p_config | ) |
Function for initializing the processing of the sleep events.
Configures and sets up the sleep event processing.
[in] | p_config | Configuration with values and event handler. |
void nrfx_power_sleepevt_uninit | ( | void | ) |
Function for uninitializing the processing of the sleep events.
void nrfx_power_uninit | ( | void | ) |
Function for unintializing the power module driver.
Disables all the interrupt handling in the module.
nrfx_power_usb_event_handler_t nrfx_power_usb_handler_get | ( | void | ) |
Function for getting the handler of the USB power.
void nrfx_power_usbevt_init | ( | nrfx_power_usbevt_config_t const * | p_config | ) |
Function for initializing the processing of USB power event.
Configures and sets up the USB power event processing.
[in] | p_config | Configuration with values and event handler. |
void nrfx_power_usbevt_uninit | ( | void | ) |
Function for uninitalizing the processing of USB power event.
NRFX_STATIC_INLINE nrfx_power_usb_state_t nrfx_power_usbstatus_get | ( | void | ) |
Function for getting the status of USB power.