Hardware access layer for managing the Low Power Comparator (LPCOMP) peripheral. More...

Data Structures
struct	nrf_lpcomp_config_t
	LPCOMP configuration. More...

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_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_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_hysteresis_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_configure (NRF_LPCOMP_Type p_reg, nrf_lpcomp_config_t const p_config)
	Function for configuring LPCOMP. More...

NRF_STATIC_INLINE void	nrf_lpcomp_input_select (NRF_LPCOMP_Type *p_reg, nrf_lpcomp_input_t input)
	Function for selecting the LPCOMP input. More...

NRF_STATIC_INLINE void	nrf_lpcomp_enable (NRF_LPCOMP_Type *p_reg)
	Function for enabling the Low Power Comparator. More...

NRF_STATIC_INLINE void	nrf_lpcomp_disable (NRF_LPCOMP_Type *p_reg)
	Function for disabling the Low Power Comparator. More...

NRF_STATIC_INLINE uint32_t	nrf_lpcomp_result_get (NRF_LPCOMP_Type const *p_reg)
	Function for getting the last LPCOMP compare result. More...

NRF_STATIC_INLINE void	nrf_lpcomp_int_enable (NRF_LPCOMP_Type *p_reg, uint32_t mask)
	Function for enabling interrupts from LPCOMP. More...

NRF_STATIC_INLINE void	nrf_lpcomp_int_disable (NRF_LPCOMP_Type *p_reg, uint32_t mask)
	Function for disabling interrupts from LPCOMP. More...

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. More...

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. More...

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. More...

NRF_STATIC_INLINE void	nrf_lpcomp_shorts_enable (NRF_LPCOMP_Type *p_reg, uint32_t mask)
	Function for setting LPCOMP shorts. More...

NRF_STATIC_INLINE void	nrf_lpcomp_shorts_disable (NRF_LPCOMP_Type *p_reg, uint32_t mask)
	Function for clearing LPCOMP shorts by mask. More...

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. More...

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. More...

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. More...

Detailed Description

Hardware access layer for managing the Low Power Comparator (LPCOMP) peripheral.

Enumeration Type Documentation

◆ nrf_lpcomp_detect_t

enum nrf_lpcomp_detect_t

LPCOMP detection type selection.

Enumerator
NRF_LPCOMP_DETECT_CROSS	Generate ANADETEC on crossing, both upwards and downwards crossing.
NRF_LPCOMP_DETECT_UP	Generate ANADETEC on upwards crossing only.
NRF_LPCOMP_DETECT_DOWN	Generate ANADETEC on downwards crossing only.

◆ nrf_lpcomp_event_t

enum nrf_lpcomp_event_t

LPCOMP events.

Enumerator
NRF_LPCOMP_EVENT_READY	LPCOMP is ready and output is valid.
NRF_LPCOMP_EVENT_DOWN	Input voltage crossed the threshold going down.
NRF_LPCOMP_EVENT_UP	Input voltage crossed the threshold going up.
NRF_LPCOMP_EVENT_CROSS	Input voltage crossed the threshold in any direction.

◆ nrf_lpcomp_hysteresis_t

enum nrf_lpcomp_hysteresis_t

LPCOMP hysteresis.

Enumerator
NRF_LPCOMP_HYST_NOHYST	Comparator hysteresis disabled.
NRF_LPCOMP_HYST_ENABLED	Comparator hysteresis enabled (typically 50 mV).

◆ nrf_lpcomp_input_t

enum nrf_lpcomp_input_t

LPCOMP input selection.

Enumerator
NRF_LPCOMP_INPUT_0	Input 0.
NRF_LPCOMP_INPUT_1	Input 1.
NRF_LPCOMP_INPUT_2	Input 2.
NRF_LPCOMP_INPUT_3	Input 3.
NRF_LPCOMP_INPUT_4	Input 4.
NRF_LPCOMP_INPUT_5	Input 5.
NRF_LPCOMP_INPUT_6	Input 6.
NRF_LPCOMP_INPUT_7	Input 7.

◆ nrf_lpcomp_int_mask_t

enum nrf_lpcomp_int_mask_t

LPCOMP interrupts.

Enumerator
NRF_LPCOMP_INT_READY_MASK	Interrupt on READY event.
NRF_LPCOMP_INT_DOWN_MASK	Interrupt on DOWN event.
NRF_LPCOMP_INT_UP_MASK	Interrupt on UP event.
NRF_LPCOMP_INT_CROSS_MASK	Interrupt on CROSS event.

◆ nrf_lpcomp_ref_t

enum nrf_lpcomp_ref_t

LPCOMP reference selection.

Enumerator
NRF_LPCOMP_REF_SUPPLY_1_8	Use supply with a 1/8 prescaler as reference.
NRF_LPCOMP_REF_SUPPLY_2_8	Use supply with a 2/8 prescaler as reference.
NRF_LPCOMP_REF_SUPPLY_3_8	Use supply with a 3/8 prescaler as reference.
NRF_LPCOMP_REF_SUPPLY_4_8	Use supply with a 4/8 prescaler as reference.
NRF_LPCOMP_REF_SUPPLY_5_8	Use supply with a 5/8 prescaler as reference.
NRF_LPCOMP_REF_SUPPLY_6_8	Use supply with a 6/8 prescaler as reference.
NRF_LPCOMP_REF_SUPPLY_7_8	Use supply with a 7/8 prescaler as reference.
NRF_LPCOMP_REF_EXT_REF0	External reference 0.
NRF_LPCOMP_REF_EXT_REF1	External reference 1.

◆ nrf_lpcomp_short_mask_t

enum nrf_lpcomp_short_mask_t

LPCOMP shortcut masks.

Enumerator
NRF_LPCOMP_SHORT_CROSS_STOP_MASK	Shortcut between CROSS event and STOP task.
NRF_LPCOMP_SHORT_UP_STOP_MASK	Shortcut between UP event and STOP task.
NRF_LPCOMP_SHORT_DOWN_STOP_MASK	Shortcut between DOWN event and STOP task.
NRF_LPCOMP_SHORT_READY_STOP_MASK	Shortcut between READY event and STOP task.
NRF_LPCOMP_SHORT_READY_SAMPLE_MASK	Shortcut between READY event and SAMPLE task.

◆ nrf_lpcomp_task_t

enum nrf_lpcomp_task_t

LPCOMP tasks.

Enumerator
NRF_LPCOMP_TASK_START	LPCOMP start sampling task.
NRF_LPCOMP_TASK_STOP	LPCOMP stop sampling task.
NRF_LPCOMP_TASK_SAMPLE	Sample comparator value.

Function Documentation

◆ nrf_lpcomp_configure()

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.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	p_config	Configuration.

◆ nrf_lpcomp_disable()

NRF_STATIC_INLINE void nrf_lpcomp_disable ( NRF_LPCOMP_Type * p_reg )

Function for disabling the Low Power Comparator.

This function disables LPCOMP.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

◆ nrf_lpcomp_enable()

NRF_STATIC_INLINE void nrf_lpcomp_enable ( NRF_LPCOMP_Type * p_reg )

Function for enabling the Low Power Comparator.

This function enables LPCOMP.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

◆ nrf_lpcomp_event_address_get()

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.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	LPCOMP event.

Returns: The address of the specified LPCOMP event.

◆ nrf_lpcomp_event_check()

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.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event to be checked.

Return values

true	The event has been generated.
false	The event has not been generated.

◆ nrf_lpcomp_event_clear()

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.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	LPCOMP event to be cleared.

◆ nrf_lpcomp_input_select()

NRF_STATIC_INLINE void nrf_lpcomp_input_select	(	NRF_LPCOMP_Type *	p_reg,
		nrf_lpcomp_input_t	input
	)

Function for selecting the LPCOMP input.

This function selects the active input of LPCOMP.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	input	Input to be selected.

◆ nrf_lpcomp_int_disable()

NRF_STATIC_INLINE void nrf_lpcomp_int_disable	(	NRF_LPCOMP_Type *	p_reg,
		uint32_t	mask
	)

Function for disabling interrupts from LPCOMP.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of interrupts to be disabled.

See also: nrf_lpcomp_int_enable; nrf_lpcomp_int_enable_check

◆ nrf_lpcomp_int_enable()

NRF_STATIC_INLINE void nrf_lpcomp_int_enable	(	NRF_LPCOMP_Type *	p_reg,
		uint32_t	mask
	)

Function for enabling interrupts from LPCOMP.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of interrupts to be enabled.

See also: nrf_lpcomp_int_disable; nrf_lpcomp_int_enable_check

◆ nrf_lpcomp_int_enable_check()

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.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of interrupts to be checked.

Returns: Mask of enabled interrupts.

◆ nrf_lpcomp_result_get()

NRF_STATIC_INLINE uint32_t nrf_lpcomp_result_get ( NRF_LPCOMP_Type const * p_reg )

Function for getting the last LPCOMP compare result.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

Returns: The last compare result. If 0 then VIN+ < VIN-, if 1 then the opposite.

◆ nrf_lpcomp_shorts_disable()

NRF_STATIC_INLINE void nrf_lpcomp_shorts_disable	(	NRF_LPCOMP_Type *	p_reg,
		uint32_t	mask
	)

Function for clearing LPCOMP shorts by mask.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of shortcuts.

◆ nrf_lpcomp_shorts_enable()

NRF_STATIC_INLINE void nrf_lpcomp_shorts_enable	(	NRF_LPCOMP_Type *	p_reg,
		uint32_t	mask
	)

Function for setting LPCOMP shorts.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of shortcuts.

◆ nrf_lpcomp_task_address_get()

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.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	LPCOMP task.

Returns: The address of the specified LPCOMP task.

◆ nrf_lpcomp_task_trigger()

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.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	LPCOMP task to be set.

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ nrf_lpcomp_detect_t

◆ nrf_lpcomp_event_t

◆ nrf_lpcomp_hysteresis_t

◆ nrf_lpcomp_input_t

◆ nrf_lpcomp_int_mask_t

◆ nrf_lpcomp_ref_t

◆ nrf_lpcomp_short_mask_t

◆ nrf_lpcomp_task_t

Function Documentation

◆ nrf_lpcomp_configure()

◆ nrf_lpcomp_disable()

◆ nrf_lpcomp_enable()

◆ nrf_lpcomp_event_address_get()

◆ nrf_lpcomp_event_check()

◆ nrf_lpcomp_event_clear()

◆ nrf_lpcomp_input_select()

◆ nrf_lpcomp_int_disable()

◆ nrf_lpcomp_int_enable()

◆ nrf_lpcomp_int_enable_check()

◆ nrf_lpcomp_result_get()

◆ nrf_lpcomp_shorts_disable()

◆ nrf_lpcomp_shorts_enable()

◆ nrf_lpcomp_task_address_get()

◆ nrf_lpcomp_task_trigger()