Hardware access layer (HAL) for managing the Comparator (COMP) peripheral. More...

Data Structures
struct	nrf_comp_th_t
	COMP THDOWN and THUP values that are used to calculate the threshold voltages VDOWN and VUP. More...

struct	nrf_comp_ref_conf_t
	COMP reference configuration. More...

Enumerations
enum	nrf_comp_input_t { NRF_COMP_INPUT_0 = COMP_PSEL_PSEL_AnalogInput0, NRF_COMP_INPUT_1 = COMP_PSEL_PSEL_AnalogInput1, NRF_COMP_INPUT_2 = COMP_PSEL_PSEL_AnalogInput2, NRF_COMP_INPUT_3 = COMP_PSEL_PSEL_AnalogInput3, NRF_COMP_INPUT_4 = COMP_PSEL_PSEL_AnalogInput4, NRF_COMP_INPUT_5 = COMP_PSEL_PSEL_AnalogInput5, NRF_COMP_INPUT_6 = COMP_PSEL_PSEL_AnalogInput6, NRF_COMP_INPUT_7 = COMP_PSEL_PSEL_AnalogInput7, NRF_COMP_VDD_DIV2 = COMP_PSEL_PSEL_VddDiv2, NRF_COMP_VDDH_DIV5 = COMP_PSEL_PSEL_VddhDiv5 }
	COMP analog pin selection. More...

enum	nrf_comp_ref_t { NRF_COMP_REF_Int1V2 = COMP_REFSEL_REFSEL_Int1V2, NRF_COMP_REF_Int1V8 = COMP_REFSEL_REFSEL_Int1V8, NRF_COMP_REF_Int2V4 = COMP_REFSEL_REFSEL_Int2V4, NRF_COMP_REF_VDD = COMP_REFSEL_REFSEL_VDD, NRF_COMP_REF_ARef = COMP_REFSEL_REFSEL_ARef }
	COMP reference selection. More...

enum	nrf_comp_ext_ref_t { NRF_COMP_EXT_REF_0 = COMP_EXTREFSEL_EXTREFSEL_AnalogReference0, NRF_COMP_EXT_REF_1 = COMP_EXTREFSEL_EXTREFSEL_AnalogReference1, NRF_COMP_EXT_REF_2 = COMP_EXTREFSEL_EXTREFSEL_AnalogReference2, NRF_COMP_EXT_REF_3 = COMP_EXTREFSEL_EXTREFSEL_AnalogReference3, NRF_COMP_EXT_REF_4 = COMP_EXTREFSEL_EXTREFSEL_AnalogReference4, NRF_COMP_EXT_REF_5 = COMP_EXTREFSEL_EXTREFSEL_AnalogReference5, NRF_COMP_EXT_REF_6 = COMP_EXTREFSEL_EXTREFSEL_AnalogReference6, NRF_COMP_EXT_REF_7 = COMP_EXTREFSEL_EXTREFSEL_AnalogReference7 }
	COMP external analog reference selection. More...

enum	nrf_comp_main_mode_t { NRF_COMP_MAIN_MODE_SE = COMP_MODE_MAIN_SE, NRF_COMP_MAIN_MODE_Diff = COMP_MODE_MAIN_Diff }
	COMP main operation mode. More...

enum	nrf_comp_sp_mode_t { NRF_COMP_SP_MODE_Low = COMP_MODE_SP_Low, NRF_COMP_SP_MODE_Normal = COMP_MODE_SP_Normal, NRF_COMP_SP_MODE_High = COMP_MODE_SP_High }
	COMP speed and power mode. More...

enum	nrf_comp_hyst_t { NRF_COMP_HYST_NoHyst = COMP_HYST_HYST_NoHyst, NRF_COMP_HYST_50mV = COMP_HYST_HYST_Hyst50mV }
	COMP comparator hysteresis. More...

enum	nrf_isource_t { NRF_COMP_ISOURCE_Off = COMP_ISOURCE_ISOURCE_Off, NRF_COMP_ISOURCE_Ien2uA5 = COMP_ISOURCE_ISOURCE_Ien2mA5, NRF_COMP_ISOURCE_Ien5uA = COMP_ISOURCE_ISOURCE_Ien5mA, NRF_COMP_ISOURCE_Ien10uA = COMP_ISOURCE_ISOURCE_Ien10mA }
	COMP current source selection on analog input. More...

enum	nrf_comp_task_t { NRF_COMP_TASK_START = offsetof(NRF_COMP_Type, TASKS_START), NRF_COMP_TASK_STOP = offsetof(NRF_COMP_Type, TASKS_STOP), NRF_COMP_TASK_SAMPLE = offsetof(NRF_COMP_Type, TASKS_SAMPLE) }
	COMP tasks. More...

enum	nrf_comp_event_t { NRF_COMP_EVENT_READY = offsetof(NRF_COMP_Type, EVENTS_READY), NRF_COMP_EVENT_DOWN = offsetof(NRF_COMP_Type, EVENTS_DOWN), NRF_COMP_EVENT_UP = offsetof(NRF_COMP_Type, EVENTS_UP), NRF_COMP_EVENT_CROSS = offsetof(NRF_COMP_Type, EVENTS_CROSS) }
	COMP events. More...

Functions
NRF_STATIC_INLINE void	nrf_comp_enable (NRF_COMP_Type *p_reg)
	Function for enabling the COMP peripheral. More...

NRF_STATIC_INLINE void	nrf_comp_disable (NRF_COMP_Type *p_reg)
	Function for disabling the COMP peripheral. More...

NRF_STATIC_INLINE bool	nrf_comp_enable_check (NRF_COMP_Type const *p_reg)
	Function for checking if the COMP peripheral is enabled. More...

NRF_STATIC_INLINE void	nrf_comp_ref_set (NRF_COMP_Type *p_reg, nrf_comp_ref_t reference)
	Function for setting the reference source. More...

NRF_STATIC_INLINE void	nrf_comp_ext_ref_set (NRF_COMP_Type *p_reg, nrf_comp_ext_ref_t ext_ref)
	Function for setting the external analog reference source. More...

NRF_STATIC_INLINE void	nrf_comp_th_set (NRF_COMP_Type *p_reg, nrf_comp_th_t threshold)
	Function for setting threshold voltages. More...

NRF_STATIC_INLINE void	nrf_comp_main_mode_set (NRF_COMP_Type *p_reg, nrf_comp_main_mode_t main_mode)
	Function for setting the main mode. More...

NRF_STATIC_INLINE void	nrf_comp_speed_mode_set (NRF_COMP_Type *p_reg, nrf_comp_sp_mode_t speed_mode)
	Function for setting the speed mode. More...

NRF_STATIC_INLINE void	nrf_comp_hysteresis_set (NRF_COMP_Type *p_reg, nrf_comp_hyst_t hyst)
	Function for setting the hysteresis. More...

NRF_STATIC_INLINE void	nrf_comp_isource_set (NRF_COMP_Type *p_reg, nrf_isource_t isource)
	Function for setting the current source on the analog input. More...

NRF_STATIC_INLINE void	nrf_comp_input_select (NRF_COMP_Type *p_reg, nrf_comp_input_t input)
	Function for selecting the active input of the COMP. More...

NRF_STATIC_INLINE uint32_t	nrf_comp_result_get (NRF_COMP_Type const *p_reg)
	Function for getting the last COMP compare result. More...

NRF_STATIC_INLINE void	nrf_comp_int_enable (NRF_COMP_Type *p_reg, uint32_t mask)
	Function for enabling interrupts from COMP. More...

NRF_STATIC_INLINE void	nrf_comp_int_disable (NRF_COMP_Type *p_reg, uint32_t mask)
	Function for disabling interrupts from COMP. More...

NRF_STATIC_INLINE uint32_t	nrf_comp_int_enable_check (NRF_COMP_Type const *p_reg, uint32_t mask)
	Function for checking if the specified interrupts are enabled. More...

NRF_STATIC_INLINE uint32_t	nrf_comp_task_address_get (NRF_COMP_Type const *p_reg, nrf_comp_task_t task)
	Function for getting the address of the specified COMP task register. More...

NRF_STATIC_INLINE uint32_t	nrf_comp_event_address_get (NRF_COMP_Type const *p_reg, nrf_comp_event_t event)
	Function for getting the address of the specified COMP event register. More...

NRF_STATIC_INLINE void	nrf_comp_shorts_enable (NRF_COMP_Type *p_reg, uint32_t mask)
	Function for setting COMP shortcuts. More...

NRF_STATIC_INLINE void	nrf_comp_shorts_disable (NRF_COMP_Type *p_reg, uint32_t mask)
	Function for clearing COMP shortcuts by mask. More...

NRF_STATIC_INLINE void	nrf_comp_task_trigger (NRF_COMP_Type *p_reg, nrf_comp_task_t task)
	Function for setting the specified COMP task. More...

NRF_STATIC_INLINE void	nrf_comp_event_clear (NRF_COMP_Type *p_reg, nrf_comp_event_t event)
	Function for clearing the specified COMP event. More...

NRF_STATIC_INLINE bool	nrf_comp_event_check (NRF_COMP_Type const *p_reg, nrf_comp_event_t event)
	Function for retrieving the state of the UARTE event. More...

Detailed Description

Hardware access layer (HAL) for managing the Comparator (COMP) peripheral.

Enumeration Type Documentation

◆ nrf_comp_event_t

enum nrf_comp_event_t

COMP events.

Enumerator
NRF_COMP_EVENT_READY	COMP is ready and output is valid.
NRF_COMP_EVENT_DOWN	Input voltage crossed the threshold going down.
NRF_COMP_EVENT_UP	Input voltage crossed the threshold going up.
NRF_COMP_EVENT_CROSS	Input voltage crossed the threshold in any direction.

◆ nrf_comp_ext_ref_t

enum nrf_comp_ext_ref_t

COMP external analog reference selection.

Enumerator
NRF_COMP_EXT_REF_0	Use AIN0 as external analog reference.
NRF_COMP_EXT_REF_1	Use AIN1 as external analog reference.
NRF_COMP_EXT_REF_2	Use AIN2 as external analog reference.
NRF_COMP_EXT_REF_3	Use AIN3 as external analog reference.
NRF_COMP_EXT_REF_4	Use AIN4 as external analog reference.
NRF_COMP_EXT_REF_5	Use AIN5 as external analog reference.
NRF_COMP_EXT_REF_6	Use AIN6 as external analog reference.
NRF_COMP_EXT_REF_7	Use AIN7 as external analog reference.

◆ nrf_comp_hyst_t

enum nrf_comp_hyst_t

COMP comparator hysteresis.

Enumerator
NRF_COMP_HYST_NoHyst	Comparator hysteresis disabled.
NRF_COMP_HYST_50mV	Comparator hysteresis enabled.

◆ nrf_comp_input_t

enum nrf_comp_input_t

COMP analog pin selection.

Enumerator
NRF_COMP_INPUT_0	AIN0 selected as analog input.
NRF_COMP_INPUT_1	AIN1 selected as analog input.
NRF_COMP_INPUT_2	AIN2 selected as analog input.
NRF_COMP_INPUT_3	AIN3 selected as analog input.
NRF_COMP_INPUT_4	AIN4 selected as analog input.
NRF_COMP_INPUT_5	AIN5 selected as analog input.
NRF_COMP_INPUT_6	AIN6 selected as analog input.
NRF_COMP_INPUT_7	AIN7 selected as analog input.
NRF_COMP_VDD_DIV2	VDD/2 selected as analog input.
NRF_COMP_VDDH_DIV5	VDDH/5 selected as analog input.

◆ nrf_comp_main_mode_t

enum nrf_comp_main_mode_t

COMP main operation mode.

Enumerator
NRF_COMP_MAIN_MODE_SE	Single-ended mode.
NRF_COMP_MAIN_MODE_Diff	Differential mode.

◆ nrf_comp_ref_t

enum nrf_comp_ref_t

COMP reference selection.

Enumerator
NRF_COMP_REF_Int1V2	VREF = internal 1.2 V reference (VDD >= 1.7 V).
NRF_COMP_REF_Int1V8	VREF = internal 1.8 V reference (VDD >= VREF + 0.2 V).
NRF_COMP_REF_Int2V4	VREF = internal 2.4 V reference (VDD >= VREF + 0.2 V).
NRF_COMP_REF_VDD	VREF = VDD.
NRF_COMP_REF_ARef	VREF = AREF (VDD >= VREF >= AREFMIN).

◆ nrf_comp_sp_mode_t

enum nrf_comp_sp_mode_t

COMP speed and power mode.

Enumerator
NRF_COMP_SP_MODE_Low	Low power mode.
NRF_COMP_SP_MODE_Normal	Normal mode.
NRF_COMP_SP_MODE_High	High-speed mode.

◆ nrf_comp_task_t

enum nrf_comp_task_t

COMP tasks.

Enumerator
NRF_COMP_TASK_START	COMP start sampling task.
NRF_COMP_TASK_STOP	COMP stop sampling task.
NRF_COMP_TASK_SAMPLE	Sample comparator value.

◆ nrf_isource_t

enum nrf_isource_t

COMP current source selection on analog input.

Enumerator
NRF_COMP_ISOURCE_Off	Current source disabled.
NRF_COMP_ISOURCE_Ien2uA5	Current source enabled (+/- 2.5 uA).
NRF_COMP_ISOURCE_Ien5uA	Current source enabled (+/- 5 uA).
NRF_COMP_ISOURCE_Ien10uA	Current source enabled (+/- 10 uA).

Function Documentation

◆ nrf_comp_disable()

NRF_STATIC_INLINE void nrf_comp_disable ( NRF_COMP_Type * p_reg )

Function for disabling the COMP peripheral.

Parameters

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

◆ nrf_comp_enable()

NRF_STATIC_INLINE void nrf_comp_enable ( NRF_COMP_Type * p_reg )

Function for enabling the COMP peripheral.

Parameters

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

◆ nrf_comp_enable_check()

NRF_STATIC_INLINE bool nrf_comp_enable_check ( NRF_COMP_Type const * p_reg )

Function for checking if the COMP peripheral is enabled.

Parameters

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

Return values

true	The COMP peripheral is enabled.
false	The COMP peripheral is not enabled.

◆ nrf_comp_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_comp_event_address_get	(	NRF_COMP_Type const *	p_reg,
		nrf_comp_event_t	event
	)

Function for getting the address of the specified COMP event register.

Parameters

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

Returns: Address of the specified COMP event.

◆ nrf_comp_event_check()

NRF_STATIC_INLINE bool nrf_comp_event_check	(	NRF_COMP_Type const *	p_reg,
		nrf_comp_event_t	event
	)

Function for retrieving the state of the UARTE 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_comp_event_clear()

NRF_STATIC_INLINE void nrf_comp_event_clear	(	NRF_COMP_Type *	p_reg,
		nrf_comp_event_t	event
	)

Function for clearing the specified COMP event.

Parameters

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

◆ nrf_comp_ext_ref_set()

NRF_STATIC_INLINE void nrf_comp_ext_ref_set	(	NRF_COMP_Type *	p_reg,
		nrf_comp_ext_ref_t	ext_ref
	)

Function for setting the external analog reference source.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	ext_ref	COMP external analog reference selection.

◆ nrf_comp_hysteresis_set()

NRF_STATIC_INLINE void nrf_comp_hysteresis_set	(	NRF_COMP_Type *	p_reg,
		nrf_comp_hyst_t	hyst
	)

Function for setting the hysteresis.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	hyst	COMP comparator hysteresis.

◆ nrf_comp_input_select()

NRF_STATIC_INLINE void nrf_comp_input_select	(	NRF_COMP_Type *	p_reg,
		nrf_comp_input_t	input
	)

Function for selecting the active input of the COMP.

Parameters

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

◆ nrf_comp_int_disable()

NRF_STATIC_INLINE void nrf_comp_int_disable	(	NRF_COMP_Type *	p_reg,
		uint32_t	mask
	)

Function for disabling interrupts from COMP.

Parameters

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

See also: nrf_comp_int_enable_check

◆ nrf_comp_int_enable()

NRF_STATIC_INLINE void nrf_comp_int_enable	(	NRF_COMP_Type *	p_reg,
		uint32_t	mask
	)

Function for enabling interrupts from COMP.

Parameters

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

See also: nrf_comp_int_enable_check

◆ nrf_comp_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_comp_int_enable_check	(	NRF_COMP_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_comp_isource_set()

NRF_STATIC_INLINE void nrf_comp_isource_set	(	NRF_COMP_Type *	p_reg,
		nrf_isource_t	isource
	)

Function for setting the current source on the analog input.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	isource	COMP current source selection on analog input.

◆ nrf_comp_main_mode_set()

NRF_STATIC_INLINE void nrf_comp_main_mode_set	(	NRF_COMP_Type *	p_reg,
		nrf_comp_main_mode_t	main_mode
	)

Function for setting the main mode.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	main_mode	COMP main operation mode.

◆ nrf_comp_ref_set()

NRF_STATIC_INLINE void nrf_comp_ref_set	(	NRF_COMP_Type *	p_reg,
		nrf_comp_ref_t	reference
	)

Function for setting the reference source.

Parameters

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

◆ nrf_comp_result_get()

NRF_STATIC_INLINE uint32_t nrf_comp_result_get ( NRF_COMP_Type const * p_reg )

Function for getting the last COMP compare result.

Note: If VIN+ == VIN-, the return value depends on the previous 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 VIN+ > VIN-.

◆ nrf_comp_shorts_disable()

NRF_STATIC_INLINE void nrf_comp_shorts_disable	(	NRF_COMP_Type *	p_reg,
		uint32_t	mask
	)

Function for clearing COMP shortcuts by mask.

Parameters

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

◆ nrf_comp_shorts_enable()

NRF_STATIC_INLINE void nrf_comp_shorts_enable	(	NRF_COMP_Type *	p_reg,
		uint32_t	mask
	)

Function for setting COMP shortcuts.

Parameters

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

◆ nrf_comp_speed_mode_set()

NRF_STATIC_INLINE void nrf_comp_speed_mode_set	(	NRF_COMP_Type *	p_reg,
		nrf_comp_sp_mode_t	speed_mode
	)

Function for setting the speed mode.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	speed_mode	COMP speed and power mode.

◆ nrf_comp_task_address_get()

NRF_STATIC_INLINE uint32_t nrf_comp_task_address_get	(	NRF_COMP_Type const *	p_reg,
		nrf_comp_task_t	task
	)

Function for getting the address of the specified COMP task register.

Parameters

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

Returns: Address of the specified COMP task.

◆ nrf_comp_task_trigger()

NRF_STATIC_INLINE void nrf_comp_task_trigger	(	NRF_COMP_Type *	p_reg,
		nrf_comp_task_t	task
	)

Function for setting the specified COMP task.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Task to be activated.

◆ nrf_comp_th_set()

NRF_STATIC_INLINE void nrf_comp_th_set	(	NRF_COMP_Type *	p_reg,
		nrf_comp_th_t	threshold
	)

Function for setting threshold voltages.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	threshold	COMP VDOWN and VUP thresholds.

Data Structures

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ nrf_comp_event_t

◆ nrf_comp_ext_ref_t

◆ nrf_comp_hyst_t

◆ nrf_comp_input_t

◆ nrf_comp_main_mode_t

◆ nrf_comp_ref_t

◆ nrf_comp_sp_mode_t

◆ nrf_comp_task_t

◆ nrf_isource_t

Function Documentation

◆ nrf_comp_disable()

◆ nrf_comp_enable()

◆ nrf_comp_enable_check()

◆ nrf_comp_event_address_get()

◆ nrf_comp_event_check()

◆ nrf_comp_event_clear()

◆ nrf_comp_ext_ref_set()

◆ nrf_comp_hysteresis_set()

◆ nrf_comp_input_select()

◆ nrf_comp_int_disable()

◆ nrf_comp_int_enable()

◆ nrf_comp_int_enable_check()

◆ nrf_comp_isource_set()

◆ nrf_comp_main_mode_set()

◆ nrf_comp_ref_set()

◆ nrf_comp_result_get()

◆ nrf_comp_shorts_disable()

◆ nrf_comp_shorts_enable()

◆ nrf_comp_speed_mode_set()

◆ nrf_comp_task_address_get()

◆ nrf_comp_task_trigger()

◆ nrf_comp_th_set()