Hardware access layer for managing the Low Power Comparator (LPCOMP) peripheral. More...
Data Structures | |
struct | nrf_lpcomp_config_t |
LPCOMP configuration. More... | |
Typedefs | |
typedef uint32_t | nrf_lpcomp_ext_ref_t |
LPCOMP external reference selection. | |
typedef uint32_t | nrf_lpcomp_input_t |
LPCOMP input selection. | |
Enumerations | |
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_int_mask_t { NRF_LPCOMP_INT_READY_MASK = LPCOMP_INTENSET_READY_Msk , NRF_LPCOMP_INT_DOWN_MASK = LPCOMP_INTENSET_DOWN_Msk , NRF_LPCOMP_INT_UP_MASK = LPCOMP_INTENSET_UP_Msk , NRF_LPCOMP_INT_CROSS_MASK = LPCOMP_INTENSET_CROSS_Msk } |
LPCOMP interrupts. 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... | |
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_REF = LPCOMP_REFSEL_REFSEL_ARef } |
LPCOMP reference 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_hyst_t { NRF_LPCOMP_HYST_NOHYST = LPCOMP_HYST_HYST_Disabled , NRF_LPCOMP_HYST_ENABLED = LPCOMP_HYST_HYST_Enabled } |
LPCOMP hysteresis. More... | |
Functions | |
NRF_STATIC_INLINE void | nrf_lpcomp_task_trigger (NRF_LPCOMP_Type *p_reg, nrf_lpcomp_task_t task) |
Function for setting the specified LPCOMP task. | |
NRF_STATIC_INLINE uint32_t | nrf_lpcomp_task_address_get (NRF_LPCOMP_Type const *p_reg, nrf_lpcomp_task_t task) |
Function for getting the address of the specified LPCOMP task register. | |
NRF_STATIC_INLINE bool | nrf_lpcomp_event_check (NRF_LPCOMP_Type const *p_reg, nrf_lpcomp_event_t event) |
Function for retrieving the state of the LPCOMP event. | |
NRF_STATIC_INLINE void | nrf_lpcomp_event_clear (NRF_LPCOMP_Type *p_reg, nrf_lpcomp_event_t event) |
Function for clearing the specified LPCOMP event. | |
NRF_STATIC_INLINE uint32_t | nrf_lpcomp_event_address_get (NRF_LPCOMP_Type const *p_reg, nrf_lpcomp_event_t event) |
Function for getting the address of the specified LPCOMP event register. | |
NRF_STATIC_INLINE void | nrf_lpcomp_shorts_enable (NRF_LPCOMP_Type *p_reg, uint32_t mask) |
Function for setting LPCOMP shorts. | |
NRF_STATIC_INLINE void | nrf_lpcomp_shorts_disable (NRF_LPCOMP_Type *p_reg, uint32_t mask) |
Function for clearing LPCOMP shorts by mask. | |
NRF_STATIC_INLINE void | nrf_lpcomp_shorts_set (NRF_LPCOMP_Type *p_reg, uint32_t mask) |
Function for for setting the specified shortcuts. | |
NRF_STATIC_INLINE void | nrf_lpcomp_int_enable (NRF_LPCOMP_Type *p_reg, uint32_t mask) |
Function for enabling interrupts from LPCOMP. | |
NRF_STATIC_INLINE void | nrf_lpcomp_int_disable (NRF_LPCOMP_Type *p_reg, uint32_t mask) |
Function for disabling interrupts from LPCOMP. | |
NRF_STATIC_INLINE uint32_t | nrf_lpcomp_int_enable_check (NRF_LPCOMP_Type const *p_reg, uint32_t mask) |
Function for checking if the specified interrupts are enabled. | |
NRF_STATIC_INLINE void | nrf_lpcomp_subscribe_set (NRF_LPCOMP_Type *p_reg, nrf_lpcomp_task_t task, uint8_t channel) |
Function for setting subscribe configuration for a given LPCOMP task. | |
NRF_STATIC_INLINE void | nrf_lpcomp_subscribe_clear (NRF_LPCOMP_Type *p_reg, nrf_lpcomp_task_t task) |
Function for clearing subscribe configuration for a given LPCOMP task. | |
NRF_STATIC_INLINE void | nrf_lpcomp_publish_set (NRF_LPCOMP_Type *p_reg, nrf_lpcomp_event_t event, uint8_t channel) |
Function for setting publish configuration for a given LPCOMP event. | |
NRF_STATIC_INLINE void | nrf_lpcomp_publish_clear (NRF_LPCOMP_Type *p_reg, nrf_lpcomp_event_t event) |
Function for clearing publish configuration for a given LPCOMP event. | |
NRF_STATIC_INLINE void | nrf_lpcomp_configure (NRF_LPCOMP_Type *p_reg, nrf_lpcomp_config_t const *p_config) |
Function for configuring LPCOMP. | |
NRF_STATIC_INLINE void | nrf_lpcomp_ref_set (NRF_LPCOMP_Type *p_reg, nrf_lpcomp_ref_t reference) |
Function for setting the reference source. | |
NRF_STATIC_INLINE void | nrf_lpcomp_ext_ref_set (NRF_LPCOMP_Type *p_reg, nrf_lpcomp_ext_ref_t ext_ref) |
Function for setting the external analog reference source. | |
NRF_STATIC_INLINE void | nrf_lpcomp_input_select (NRF_LPCOMP_Type *p_reg, nrf_lpcomp_input_t input) |
Function for selecting an active LPCOMP input. | |
NRF_STATIC_INLINE void | nrf_lpcomp_detection_set (NRF_LPCOMP_Type *p_reg, nrf_lpcomp_detect_t detection) |
Function for setting the detection type. | |
NRF_STATIC_INLINE void | nrf_lpcomp_hysteresis_set (NRF_LPCOMP_Type *p_reg, nrf_lpcomp_hyst_t hyst) |
Function for setting the hysteresis. | |
NRF_STATIC_INLINE void | nrf_lpcomp_enable (NRF_LPCOMP_Type *p_reg) |
Function for enabling the LPCOMP. | |
NRF_STATIC_INLINE void | nrf_lpcomp_disable (NRF_LPCOMP_Type *p_reg) |
Function for disabling the LPCOMP. | |
NRF_STATIC_INLINE bool | nrf_lpcomp_enable_check (NRF_LPCOMP_Type *p_reg) |
Function for checking if the LPCOMP peripheral is enabled. | |
NRF_STATIC_INLINE uint32_t | nrf_lpcomp_result_get (NRF_LPCOMP_Type const *p_reg) |
Function for getting the last LPCOMP compare result. | |
Hardware access layer for managing the Low Power Comparator (LPCOMP) peripheral.
enum nrf_lpcomp_detect_t |
enum nrf_lpcomp_event_t |
enum nrf_lpcomp_hyst_t |
enum nrf_lpcomp_ref_t |
LPCOMP reference selection.
LPCOMP shortcut masks.
enum nrf_lpcomp_task_t |
NRF_STATIC_INLINE void nrf_lpcomp_configure | ( | NRF_LPCOMP_Type * | p_reg, |
nrf_lpcomp_config_t const * | 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_reg | Pointer to the structure of registers of the peripheral. |
[in] | p_config | Configuration. |
NRF_STATIC_INLINE void nrf_lpcomp_detection_set | ( | NRF_LPCOMP_Type * | p_reg, |
nrf_lpcomp_detect_t | detection | ||
) |
Function for setting the detection type.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | detection | LPCOMP detection type. |
NRF_STATIC_INLINE void nrf_lpcomp_disable | ( | NRF_LPCOMP_Type * | p_reg | ) |
Function for disabling the LPCOMP.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_lpcomp_enable | ( | NRF_LPCOMP_Type * | p_reg | ) |
Function for enabling the LPCOMP.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE bool nrf_lpcomp_enable_check | ( | NRF_LPCOMP_Type * | p_reg | ) |
Function for checking if the LPCOMP peripheral is enabled.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
true | The LPCOMP peripheral is enabled. |
false | The LPCOMP peripheral is not enabled. |
NRF_STATIC_INLINE uint32_t nrf_lpcomp_event_address_get | ( | NRF_LPCOMP_Type const * | p_reg, |
nrf_lpcomp_event_t | event | ||
) |
Function for getting the address of the specified LPCOMP event register.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | LPCOMP event. |
NRF_STATIC_INLINE bool nrf_lpcomp_event_check | ( | NRF_LPCOMP_Type const * | p_reg, |
nrf_lpcomp_event_t | event | ||
) |
Function for retrieving the state of the LPCOMP event.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | Event to be checked. |
true | The event has been generated. |
false | The event has not been generated. |
NRF_STATIC_INLINE void nrf_lpcomp_event_clear | ( | NRF_LPCOMP_Type * | p_reg, |
nrf_lpcomp_event_t | event | ||
) |
Function for clearing the specified LPCOMP event.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | LPCOMP event to be cleared. |
NRF_STATIC_INLINE void nrf_lpcomp_ext_ref_set | ( | NRF_LPCOMP_Type * | p_reg, |
nrf_lpcomp_ext_ref_t | ext_ref | ||
) |
Function for setting the external analog reference source.
To use external reference first call nrf_lpcomp_ref_set with NRF_LPCOMP_REF_EXT_REF argument.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | ext_ref | LPCOMP external analog reference selection. |
NRF_STATIC_INLINE void nrf_lpcomp_hysteresis_set | ( | NRF_LPCOMP_Type * | p_reg, |
nrf_lpcomp_hyst_t | hyst | ||
) |
Function for setting the hysteresis.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | hyst | LPCOMP comparator hysteresis. |
NRF_STATIC_INLINE void nrf_lpcomp_input_select | ( | NRF_LPCOMP_Type * | p_reg, |
nrf_lpcomp_input_t | input | ||
) |
Function for selecting an active LPCOMP input.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | input | Input to be selected. |
NRF_STATIC_INLINE void nrf_lpcomp_int_disable | ( | NRF_LPCOMP_Type * | p_reg, |
uint32_t | mask | ||
) |
Function for disabling interrupts from LPCOMP.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Mask of interrupts to be disabled. Use nrf_lpcomp_int_mask_t values for bit masking. |
NRF_STATIC_INLINE void nrf_lpcomp_int_enable | ( | NRF_LPCOMP_Type * | p_reg, |
uint32_t | mask | ||
) |
Function for enabling interrupts from LPCOMP.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Mask of interrupts to be enabled. Use nrf_lpcomp_int_mask_t values for bit masking. |
NRF_STATIC_INLINE uint32_t nrf_lpcomp_int_enable_check | ( | NRF_LPCOMP_Type const * | p_reg, |
uint32_t | mask | ||
) |
Function for checking if the specified interrupts are enabled.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Mask of interrupts to be checked. Use nrf_lpcomp_int_mask_t values for bit masking. |
NRF_STATIC_INLINE void nrf_lpcomp_publish_clear | ( | NRF_LPCOMP_Type * | p_reg, |
nrf_lpcomp_event_t | event | ||
) |
Function for clearing publish configuration for a given LPCOMP event.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | Event for which the configuration is cleared. |
NRF_STATIC_INLINE void nrf_lpcomp_publish_set | ( | NRF_LPCOMP_Type * | p_reg, |
nrf_lpcomp_event_t | event, | ||
uint8_t | channel | ||
) |
Function for setting publish configuration for a given LPCOMP event.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | Event for which the configuration is set. |
[in] | channel | Channel through which the event is published. |
NRF_STATIC_INLINE void nrf_lpcomp_ref_set | ( | NRF_LPCOMP_Type * | p_reg, |
nrf_lpcomp_ref_t | reference | ||
) |
Function for setting the reference source.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | reference | LPCOMP reference selection. |
NRF_STATIC_INLINE uint32_t nrf_lpcomp_result_get | ( | NRF_LPCOMP_Type const * | p_reg | ) |
Function for getting the last LPCOMP compare result.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_lpcomp_shorts_disable | ( | NRF_LPCOMP_Type * | p_reg, |
uint32_t | mask | ||
) |
Function for clearing LPCOMP shorts by mask.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Mask of shortcuts. |
NRF_STATIC_INLINE void nrf_lpcomp_shorts_enable | ( | NRF_LPCOMP_Type * | p_reg, |
uint32_t | mask | ||
) |
Function for setting LPCOMP shorts.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Mask of shortcuts. |
NRF_STATIC_INLINE void nrf_lpcomp_shorts_set | ( | NRF_LPCOMP_Type * | p_reg, |
uint32_t | mask | ||
) |
Function for for setting the specified shortcuts.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Mask of shortcuts. |
NRF_STATIC_INLINE void nrf_lpcomp_subscribe_clear | ( | NRF_LPCOMP_Type * | p_reg, |
nrf_lpcomp_task_t | task | ||
) |
Function for clearing subscribe configuration for a given LPCOMP task.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | task | Task for which the configuration is cleared. |
NRF_STATIC_INLINE void nrf_lpcomp_subscribe_set | ( | NRF_LPCOMP_Type * | p_reg, |
nrf_lpcomp_task_t | task, | ||
uint8_t | channel | ||
) |
Function for setting subscribe configuration for a given LPCOMP task.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | task | Task for which the configuration is set. |
[in] | channel | Channel through which events are subscribed. |
NRF_STATIC_INLINE uint32_t nrf_lpcomp_task_address_get | ( | NRF_LPCOMP_Type const * | p_reg, |
nrf_lpcomp_task_t | task | ||
) |
Function for getting the address of the specified LPCOMP task register.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | task | LPCOMP task. |
NRF_STATIC_INLINE void nrf_lpcomp_task_trigger | ( | NRF_LPCOMP_Type * | p_reg, |
nrf_lpcomp_task_t | task | ||
) |
Function for setting the specified LPCOMP task.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | task | LPCOMP task to be set. |