Hardware access layer for managing the Low Power Comparator (LPCOMP) peripheral. More...
Data Structures | |
struct | nrf_lpcomp_config_t |
LPCOMP configuration. More... | |
Macros | |
#define | NRF_LPCOMP_CONFIG_DEFAULT { NRF_LPCOMP_REF_SUPPLY_FOUR_EIGHT, NRF_LPCOMP_DETECT_DOWN } |
Enumerations | |
enum | nrf_lpcomp_ref_t { NRF_LPCOMP_REF_SUPPLY_1_8 = LPCOMP_REFSEL_REFSEL_SupplyOneEighthPrescaling, NRF_LPCOMP_REF_SUPPLY_2_8 = LPCOMP_REFSEL_REFSEL_SupplyTwoEighthsPrescaling, NRF_LPCOMP_REF_SUPPLY_3_8 = LPCOMP_REFSEL_REFSEL_SupplyThreeEighthsPrescaling, NRF_LPCOMP_REF_SUPPLY_4_8 = LPCOMP_REFSEL_REFSEL_SupplyFourEighthsPrescaling, NRF_LPCOMP_REF_SUPPLY_5_8 = LPCOMP_REFSEL_REFSEL_SupplyFiveEighthsPrescaling, NRF_LPCOMP_REF_SUPPLY_6_8 = LPCOMP_REFSEL_REFSEL_SupplySixEighthsPrescaling, NRF_LPCOMP_REF_SUPPLY_7_8 = LPCOMP_REFSEL_REFSEL_SupplySevenEighthsPrescaling, NRF_LPCOMP_REF_EXT_REF0, NRF_LPCOMP_CONFIG_REF_EXT_REF1 } |
LPCOMP reference selection. More... | |
enum | nrf_lpcomp_input_t { NRF_LPCOMP_INPUT_0 = LPCOMP_PSEL_PSEL_AnalogInput0, NRF_LPCOMP_INPUT_1 = LPCOMP_PSEL_PSEL_AnalogInput1, NRF_LPCOMP_INPUT_2 = LPCOMP_PSEL_PSEL_AnalogInput2, NRF_LPCOMP_INPUT_3 = LPCOMP_PSEL_PSEL_AnalogInput3, NRF_LPCOMP_INPUT_4 = LPCOMP_PSEL_PSEL_AnalogInput4, NRF_LPCOMP_INPUT_5 = LPCOMP_PSEL_PSEL_AnalogInput5, NRF_LPCOMP_INPUT_6 = LPCOMP_PSEL_PSEL_AnalogInput6, NRF_LPCOMP_INPUT_7 = LPCOMP_PSEL_PSEL_AnalogInput7 } |
LPCOMP input selection. More... | |
enum | nrf_lpcomp_detect_t { NRF_LPCOMP_DETECT_CROSS = LPCOMP_ANADETECT_ANADETECT_Cross, NRF_LPCOMP_DETECT_UP = LPCOMP_ANADETECT_ANADETECT_Up, NRF_LPCOMP_DETECT_DOWN = LPCOMP_ANADETECT_ANADETECT_Down } |
LPCOMP detection type selection. More... | |
enum | nrf_lpcomp_task_t { NRF_LPCOMP_TASK_START = offsetof(NRF_LPCOMP_Type, TASKS_START), NRF_LPCOMP_TASK_STOP = offsetof(NRF_LPCOMP_Type, TASKS_STOP), NRF_LPCOMP_TASK_SAMPLE = offsetof(NRF_LPCOMP_Type, TASKS_SAMPLE) } |
LPCOMP tasks. More... | |
enum | nrf_lpcomp_event_t { NRF_LPCOMP_EVENT_READY = offsetof(NRF_LPCOMP_Type, EVENTS_READY), NRF_LPCOMP_EVENT_DOWN = offsetof(NRF_LPCOMP_Type, EVENTS_DOWN), NRF_LPCOMP_EVENT_UP = offsetof(NRF_LPCOMP_Type, EVENTS_UP), NRF_LPCOMP_EVENT_CROSS = offsetof(NRF_LPCOMP_Type, EVENTS_CROSS) } |
LPCOMP events. More... | |
enum | nrf_lpcomp_short_mask_t { NRF_LPCOMP_SHORT_CROSS_STOP_MASK = LPCOMP_SHORTS_CROSS_STOP_Msk, NRF_LPCOMP_SHORT_UP_STOP_MASK = LPCOMP_SHORTS_UP_STOP_Msk, NRF_LPCOMP_SHORT_DOWN_STOP_MASK = LPCOMP_SHORTS_DOWN_STOP_Msk, NRF_LPCOMP_SHORT_READY_STOP_MASK = LPCOMP_SHORTS_READY_STOP_Msk, NRF_LPCOMP_SHORT_READY_SAMPLE_MASK = LPCOMP_SHORTS_READY_SAMPLE_Msk } |
LPCOMP shortcut masks. More... | |
Functions | |
__STATIC_INLINE void | nrf_lpcomp_configure (const nrf_lpcomp_config_t *p_config) |
Function for configuring LPCOMP. More... | |
__STATIC_INLINE void | nrf_lpcomp_input_select (nrf_lpcomp_input_t input) |
Function for selecting the LPCOMP input. More... | |
__STATIC_INLINE void | nrf_lpcomp_enable (void) |
Function for enabling the Low Power Comparator. More... | |
__STATIC_INLINE void | nrf_lpcomp_disable (void) |
Function for disabling the Low Power Comparator. More... | |
__STATIC_INLINE uint32_t | nrf_lpcomp_result_get (void) |
Function for getting the last LPCOMP compare result. More... | |
__STATIC_INLINE void | nrf_lpcomp_int_enable (uint32_t int_mask) |
Function for enabling interrupts from LPCOMP. More... | |
__STATIC_INLINE void | nrf_lpcomp_int_disable (uint32_t int_mask) |
Function for disabling interrupts from LPCOMP. More... | |
__STATIC_INLINE bool | nrf_lpcomp_int_enable_check (uint32_t int_mask) |
Function for getting the enabled interrupts of LPCOMP. More... | |
__STATIC_INLINE uint32_t * | nrf_lpcomp_task_address_get (nrf_lpcomp_task_t task) |
Function for getting the address of the specified LPCOMP task register. More... | |
__STATIC_INLINE uint32_t * | nrf_lpcomp_event_address_get (nrf_lpcomp_event_t event) |
Function for getting the address of the specified LPCOMP event register. More... | |
__STATIC_INLINE void | nrf_lpcomp_shorts_enable (uint32_t mask) |
Function for setting LPCOMP shorts. More... | |
__STATIC_INLINE void | nrf_lpcomp_shorts_disable (uint32_t mask) |
Function for clearing LPCOMP shorts by mask. More... | |
__STATIC_INLINE void | nrf_lpcomp_task_trigger (nrf_lpcomp_task_t task) |
Function for setting the specified LPCOMP task. More... | |
__STATIC_INLINE void | nrf_lpcomp_event_clear (nrf_lpcomp_event_t event) |
Function for clearing the specified LPCOMP event. More... | |
__STATIC_INLINE bool | nrf_lpcomp_event_check (nrf_lpcomp_event_t event) |
Function for retrieving the state of the LPCOMP event. More... | |
Hardware access layer for managing the Low Power Comparator (LPCOMP) peripheral.
#define NRF_LPCOMP_CONFIG_DEFAULT { NRF_LPCOMP_REF_SUPPLY_FOUR_EIGHT, NRF_LPCOMP_DETECT_DOWN } |
Default LPCOMP configuration.
enum nrf_lpcomp_detect_t |
enum nrf_lpcomp_event_t |
enum nrf_lpcomp_input_t |
enum nrf_lpcomp_ref_t |
LPCOMP reference selection.
LPCOMP shortcut masks.
enum nrf_lpcomp_task_t |
__STATIC_INLINE void nrf_lpcomp_configure | ( | const nrf_lpcomp_config_t * | p_config | ) |
Function for configuring LPCOMP.
This function powers on LPCOMP and configures it. LPCOMP is in DISABLE state after configuration, so it must be enabled before using it. All shorts are inactive, events are cleared, and LPCOMP is stopped.
[in] | p_config | Configuration. |
__STATIC_INLINE void nrf_lpcomp_disable | ( | void | ) |
Function for disabling the Low Power Comparator.
This function disables LPCOMP.
__STATIC_INLINE void nrf_lpcomp_enable | ( | void | ) |
Function for enabling the Low Power Comparator.
This function enables LPCOMP.
__STATIC_INLINE uint32_t* nrf_lpcomp_event_address_get | ( | nrf_lpcomp_event_t | event | ) |
Function for getting the address of the specified LPCOMP event register.
[in] | event | LPCOMP event. |
__STATIC_INLINE bool nrf_lpcomp_event_check | ( | nrf_lpcomp_event_t | event | ) |
Function for retrieving the state of the LPCOMP event.
[in] | event | Event to be checked. |
true | The event has been generated. |
false | The event has not been generated. |
__STATIC_INLINE void nrf_lpcomp_event_clear | ( | nrf_lpcomp_event_t | event | ) |
Function for clearing the specified LPCOMP event.
[in] | event | LPCOMP event to be cleared. |
__STATIC_INLINE void nrf_lpcomp_input_select | ( | nrf_lpcomp_input_t | input | ) |
Function for selecting the LPCOMP input.
This function selects the active input of LPCOMP.
[in] | input | Input to be selected. |
__STATIC_INLINE void nrf_lpcomp_int_disable | ( | uint32_t | int_mask | ) |
Function for disabling interrupts from LPCOMP.
[in] | int_mask | Mask of interrupts to be disabled. |
__STATIC_INLINE void nrf_lpcomp_int_enable | ( | uint32_t | int_mask | ) |
Function for enabling interrupts from LPCOMP.
[in] | int_mask | Mask of interrupts to be enabled. |
__STATIC_INLINE bool nrf_lpcomp_int_enable_check | ( | uint32_t | int_mask | ) |
Function for getting the enabled interrupts of LPCOMP.
[in] | int_mask | Mask of interrupts to be checked. |
true | Any of interrupts of the specified mask are enabled. |
false | None interrupt specified by the mask are enabled. |
__STATIC_INLINE uint32_t nrf_lpcomp_result_get | ( | void | ) |
Function for getting the last LPCOMP compare result.
__STATIC_INLINE void nrf_lpcomp_shorts_disable | ( | uint32_t | mask | ) |
Function for clearing LPCOMP shorts by mask.
[in] | mask | Mask of shortcuts. |
__STATIC_INLINE void nrf_lpcomp_shorts_enable | ( | uint32_t | mask | ) |
Function for setting LPCOMP shorts.
[in] | mask | Mask of shortcuts. |
__STATIC_INLINE uint32_t* nrf_lpcomp_task_address_get | ( | nrf_lpcomp_task_t | task | ) |
Function for getting the address of the specified LPCOMP task register.
[in] | task | LPCOMP task. |
__STATIC_INLINE void nrf_lpcomp_task_trigger | ( | nrf_lpcomp_task_t | task | ) |
Function for setting the specified LPCOMP task.
[in] | task | LPCOMP task to be set. |