COMP HAL

group nrf_comp_hal

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

Defines

NRF_COMP_HAS_ISOURCE

Symbol indicating whether COMP has ISOURCE register.

NRF_COMP_HAS_AIN_AS_PIN

Symbol indicating whether the configuration of analog input using pin number is present.

Typedefs

typedef uint32_t nrf_comp_input_t

COMP analog pin selection.

typedef uint32_t nrf_comp_ext_ref_t

COMP external analog reference selection.

Enums

enum nrf_comp_ref_t

COMP reference selection.

Values:

enumerator NRF_COMP_REF_INT_1V2

VREF = internal 1.2 V reference (VDD >= 1.7 V).

enumerator NRF_COMP_REF_INT_1V8

VREF = internal 1.8 V reference (VDD >= VREF + 0.2 V).

enumerator NRF_COMP_REF_INT_2V4

VREF = internal 2.4 V reference (VDD >= VREF + 0.2 V).

enumerator NRF_COMP_REF_AVDDAO1V8

VREF = AVDD_AO_1V8.

enumerator NRF_COMP_REF_VDD

VREF = VDD.

enumerator NRF_COMP_REF_AREF

VREF = AREF (VDD >= VREF >= AREFMIN).

enum nrf_comp_main_mode_t

COMP main operation mode.

Values:

enumerator NRF_COMP_MAIN_MODE_SE

Single-ended mode.

enumerator NRF_COMP_MAIN_MODE_DIFF

Differential mode.

enum nrf_comp_sp_mode_t

COMP speed and power mode.

Values:

enumerator NRF_COMP_SP_MODE_LOW

Low power mode.

enumerator NRF_COMP_SP_MODE_NORMAL

Normal mode.

enumerator NRF_COMP_SP_MODE_HIGH

High-speed mode.

enum nrf_comp_hyst_t

COMP comparator hysteresis.

Values:

enumerator NRF_COMP_HYST_NO_HYST

Comparator hysteresis disabled.

enumerator NRF_COMP_HYST_40MV

Comparator hysteresis enabled at 40 mV level.

enumerator NRF_COMP_HYST_50MV

Comparator hysteresis enabled at 50 mV level.

enum nrf_isource_t

COMP current source selection on analog input.

Values:

enumerator NRF_COMP_ISOURCE_OFF

Current source disabled.

enumerator NRF_COMP_ISOURCE_IEN_2UA5

Current source enabled (+/- 2.5 uA).

enumerator NRF_COMP_ISOURCE_IEN_5UA

Current source enabled (+/- 5 uA).

enumerator NRF_COMP_ISOURCE_IEN_10UA

Current source enabled (+/- 10 uA).

enum nrf_comp_task_t

COMP tasks.

Values:

enumerator NRF_COMP_TASK_START

COMP start sampling task.

enumerator NRF_COMP_TASK_STOP

COMP stop sampling task.

enumerator NRF_COMP_TASK_SAMPLE

Sample comparator value.

enum nrf_comp_event_t

COMP events.

Values:

enumerator NRF_COMP_EVENT_READY

COMP is ready and output is valid.

enumerator NRF_COMP_EVENT_DOWN

Input voltage crossed the threshold going down.

enumerator NRF_COMP_EVENT_UP

Input voltage crossed the threshold going up.

enumerator NRF_COMP_EVENT_CROSS

Input voltage crossed the threshold in any direction.

enum nrf_comp_int_mask_t

COMP interrupts.

Values:

enumerator NRF_COMP_INT_READY_MASK

Interrupt on READY event.

enumerator NRF_COMP_INT_DOWN_MASK

Interrupt on DOWN event.

enumerator NRF_COMP_INT_UP_MASK

Interrupt on UP event.

enumerator NRF_COMP_INT_CROSS_MASK

Interrupt on CROSS event.

enum nrf_comp_short_mask_t

COMP shortcut masks.

Values:

enumerator NRF_COMP_SHORT_STOP_CROSS_MASK

Shortcut between the CROSS event and the STOP task.

enumerator NRF_COMP_SHORT_STOP_UP_MASK

Shortcut between the UP event and the STOP task.

enumerator NRF_COMP_SHORT_STOP_DOWN_MASK

Shortcut between the DOWN event and the STOP task.

Functions

NRF_STATIC_INLINE void nrf_comp_enable(NRF_COMP_Type *p_reg)

Function for enabling the COMP peripheral.

Parameters:

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

NRF_STATIC_INLINE void nrf_comp_disable(NRF_COMP_Type *p_reg)

Function for disabling the COMP peripheral.

Parameters:

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

NRF_STATIC_INLINE bool nrf_comp_enable_check(NRF_COMP_Type const *p_reg)

Function for checking if the COMP peripheral is enabled.

Parameters:

• p_reg – [in] 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_STATIC_INLINE void nrf_comp_ref_set(NRF_COMP_Type *p_reg, nrf_comp_ref_t reference)

Function for setting the reference source.

Parameters:

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

• reference – [in] COMP reference selection.

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:

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

• ext_ref – [in] COMP external analog reference selection.

NRF_STATIC_INLINE void nrf_comp_th_set(NRF_COMP_Type *p_reg, nrf_comp_th_t threshold)

Function for setting threshold voltages.

Parameters:

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

• threshold – [in] COMP VDOWN and VUP thresholds.

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:

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

• main_mode – [in] COMP main operation mode.

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:

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

• speed_mode – [in] COMP speed and power mode.

NRF_STATIC_INLINE void nrf_comp_hysteresis_set(NRF_COMP_Type *p_reg, nrf_comp_hyst_t hyst)

Function for setting the hysteresis.

Parameters:

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

• hyst – [in] COMP comparator hysteresis.

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:

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

• isource – [in] COMP current source selection on analog input.

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:

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

• input – [in] Input to be selected.

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:

• p_reg – [in] 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_STATIC_INLINE void nrf_comp_int_enable(NRF_COMP_Type *p_reg, uint32_t mask)

Function for enabling interrupts from COMP.

See also

nrf_comp_int_enable_check

Parameters:

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

• mask – [in] Mask of interrupts to be enabled. Use nrf_comp_int_mask_t values for bit masking.

NRF_STATIC_INLINE void nrf_comp_int_disable(NRF_COMP_Type *p_reg, uint32_t mask)

Function for disabling interrupts from COMP.

See also

nrf_comp_int_enable_check

Parameters:

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

• mask – [in] Mask of interrupts to be disabled. Use nrf_comp_int_mask_t values for bit masking.

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:

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

• mask – [in] Mask of interrupts to be checked. Use nrf_comp_int_mask_t values for bit masking.

Returns:

Mask of enabled interrupts.

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:

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

• task – [in] COMP task.

Returns:

Address of the specified COMP task.

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:

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

• event – [in] COMP event.

Returns:

Address of the specified COMP event.

NRF_STATIC_INLINE void nrf_comp_shorts_enable(NRF_COMP_Type *p_reg, uint32_t mask)

Function for setting COMP shortcuts.

Parameters:

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

• mask – [in] Mask of shortcuts.

NRF_STATIC_INLINE void nrf_comp_shorts_disable(NRF_COMP_Type *p_reg, uint32_t mask)

Function for clearing COMP shortcuts by mask.

Parameters:

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

• mask – [in] Mask of shortcuts.

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:

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

• task – [in] Task to be activated.

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:

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

• event – [in] COMP event to be cleared.

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 COMP event.

Parameters:

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

• event – [in] Event to be checked.

Return values:

• true – The event has been generated.

• false – The event has not been generated.

struct nrf_comp_th_t

#include <nrf_comp.h>

COMP THDOWN and THUP values that are used to calculate the threshold voltages VDOWN and VUP.

Public Members

uint8_t th_down

THDOWN value.

uint8_t th_up

THUP value.

struct nrf_comp_ref_conf_t

#include <nrf_comp.h>

COMP reference configuration.

Public Members

nrf_comp_ref_t reference

COMP reference selection.

nrf_comp_ext_ref_t external

COMP external analog reference selection.