Analog-to-digital converter (ADC) driver. More...

Data Structures
struct	nrf_drv_adc_done_evt_t
	Analog-to-digital converter driver DONE event. More...

struct	nrf_drv_adc_sample_evt_t
	Analog-to-digital converter driver SAMPLE event. More...

struct	nrf_drv_adc_evt_t
	Analog-to-digital converter driver event. More...

struct	nrf_drv_adc_channel_config_t
	ADC channel configuration. More...

struct	nrf_drv_adc_channel_s
	ADC channel. More...

struct	nrf_drv_adc_config_t
	ADC configuration. More...

Macros
#define	NRF_DRV_ADC_DEFAULT_CHANNEL(analog_input)
	Macro for initializing the ADC channel with the default configuration. More...

#define	NRF_DRV_ADC_DEFAULT_CONFIG
	ADC default configuration. More...

Typedefs
typedef int16_t	nrf_adc_value_t

typedef struct nrf_drv_adc_channel_s	nrf_drv_adc_channel_t

typedef void(*	nrf_drv_adc_event_handler_t )(nrf_drv_adc_evt_t const *p_event)
	User event handler prototype. More...

Enumerations
enum	nrf_drv_adc_evt_type_t { NRF_DRV_ADC_EVT_DONE, NRF_DRV_ADC_EVT_SAMPLE }
	Driver event types. More...

Functions
ret_code_t	nrf_drv_adc_init (nrf_drv_adc_config_t const *p_config, nrf_drv_adc_event_handler_t event_handler)
	Function for initializing the ADC. More...

void	nrf_drv_adc_uninit (void)
	Function for uninitializing the ADC. More...

void	nrf_drv_adc_channel_enable (nrf_drv_adc_channel_t *const p_channel)
	Function for enabling an ADC channel. More...

void	nrf_drv_adc_channel_disable (nrf_drv_adc_channel_t *const p_channel)
	Function for disabling an ADC channel.

void	nrf_drv_adc_sample (void)
	Function for starting ADC sampling. More...

ret_code_t	nrf_drv_adc_sample_convert (nrf_drv_adc_channel_t const const p_channel, nrf_adc_value_t p_value)
	Function for executing a single ADC conversion. More...

ret_code_t	nrf_drv_adc_buffer_convert (nrf_adc_value_t *buffer, uint16_t size)
	Function for converting data to the buffer. More...

bool	nrf_drv_adc_is_busy (void)
	Function for retrieving the ADC state. More...

__STATIC_INLINE uint32_t	nrf_drv_adc_start_task_get (void)
	Function for getting the address of the ADC START task. More...

__STATIC_INLINE nrf_adc_config_input_t	nrf_drv_adc_gpio_to_ain (uint32_t pin)
	Function for converting a GPIO pin number to an analog input pin mask to be used in the ADC channel configuration. More...

Detailed Description

Analog-to-digital converter (ADC) driver.

Macro Definition Documentation

#define NRF_DRV_ADC_DEFAULT_CHANNEL ( analog_input )

Value:

{{{ \
 .resolution = NRF_ADC_CONFIG_RES_10BIT, \
 .input = NRF_ADC_CONFIG_SCALING_INPUT_FULL_SCALE, \
 .reference = NRF_ADC_CONFIG_REF_VBG, \
 .ain = (analog_input) \
 }}, NULL}

Macro for initializing the ADC channel with the default configuration.

#define NRF_DRV_ADC_DEFAULT_CONFIG

Value:

{ \
 .interrupt_priority = ADC_CONFIG_IRQ_PRIORITY \
}

ADC default configuration.

Typedef Documentation

typedef void(* nrf_drv_adc_event_handler_t)(nrf_drv_adc_evt_t const *p_event)

User event handler prototype.

This function is called when the requested number of samples has been processed.

Parameters

p_event Event.

Enumeration Type Documentation

enum nrf_drv_adc_evt_type_t

Driver event types.

Enumerator
NRF_DRV_ADC_EVT_DONE	Event generated when the buffer is filled with samples.
NRF_DRV_ADC_EVT_SAMPLE	Event generated when the requested channel is sampled.

Function Documentation

ret_code_t nrf_drv_adc_buffer_convert	(	nrf_adc_value_t *	buffer,
		uint16_t	size
	)

Function for converting data to the buffer.

If the driver is initialized in non-blocking mode, this function returns when the first conversion is set up. When the buffer is filled, the application is notified by the event handler. If the driver is initialized in blocking mode, the function returns when the buffer is filled.

Conversion is done on all enabled channels, but it is not triggered by this function. This function will prepare the ADC for sampling and then wait for the SAMPLE task. Sampling can be triggered manually by the nrf_drv_adc_sample function or by PPI using the NRF_ADC_TASK_START task.

Note: If more than one channel is enabled, the function emulates scanning, and a single START task will trigger conversion on all enabled channels. For example: If 3 channels are enabled and the user requests 6 samples, the completion event handler will be called after 2 START tasks.; The application must adjust the sampling frequency. The maximum frequency depends on the sampling timer and the maximum latency of the ADC interrupt. If an interrupt is not handled before the next sampling is triggered, the sample will be lost.

Parameters

[in]	buffer	Result buffer.
[in]	size	Buffer size in samples.

Return values

NRF_SUCCESS	If conversion was successful.
NRF_ERROR_BUSY	If the driver is busy.

void nrf_drv_adc_channel_enable ( nrf_drv_adc_channel_t *const p_channel )

Function for enabling an ADC channel.

This function configures and enables the channel. When nrf_drv_adc_buffer_convert is called, all channels that have been enabled with this function are sampled.

Note: The channel instance variable p_channel is used by the driver as an item in a list. Therefore, it cannot be an automatic variable, and an assertion fails if it is an automatic variable (if asserts are enabled).

__STATIC_INLINE nrf_adc_config_input_t nrf_drv_adc_gpio_to_ain ( uint32_t pin )

Function for converting a GPIO pin number to an analog input pin mask to be used in the ADC channel configuration.

Parameters

[in] pin GPIO pin.

Returns: Analog input pin mask. The function returns NRF_ADC_CONFIG_INPUT_DISABLED if the specified pin is not an analog input.

ret_code_t nrf_drv_adc_init	(	nrf_drv_adc_config_t const *	p_config,
		nrf_drv_adc_event_handler_t	event_handler
	)

Function for initializing the ADC.

If a valid event handler is provided, the driver is initialized in non-blocking mode. If event_handler is NULL, the driver works in blocking mode.

Parameters

[in]	p_config	Driver configuration.
[in]	event_handler	Event handler provided by the user.

Return values

NRF_SUCCESS	If initialization was successful.
NRF_ERROR_INVALID_STATE	If the driver is already initialized.

bool nrf_drv_adc_is_busy ( void )

Function for retrieving the ADC state.

Return values

true	If the ADC is busy.
false	If the ADC is ready.

void nrf_drv_adc_sample ( void )

Function for starting ADC sampling.

This function triggers single ADC sampling. If more than one channel is enabled, the driver emulates scanning and all channels are sampled in the order they were enabled.

ret_code_t nrf_drv_adc_sample_convert	(	nrf_drv_adc_channel_t const *const	p_channel,
		nrf_adc_value_t *	p_value
	)

Function for executing a single ADC conversion.

This function selects the desired input and starts a single conversion. If a valid pointer is provided for the result, the function blocks until the conversion is completed. Otherwise, the function returns when the conversion is started, and the result is provided in an event (driver must be initialized in non-blocking mode otherwise an assertion will fail). The function will fail if ADC is busy. The channel does not need to be enabled to perform a single conversion.

Parameters

[in]	p_channel	Channel.
[out]	p_value	Pointer to the location where the result should be placed. Unless NULL is provided, the function is blocking.

Return values

NRF_SUCCESS	If conversion was successful.
NRF_ERROR_BUSY	If the ADC driver is busy.

__STATIC_INLINE uint32_t nrf_drv_adc_start_task_get ( void )

Function for getting the address of the ADC START task.

This function is used to get the address of the START task, which can be used to trigger ADC conversion.

Returns: Start task address.

void nrf_drv_adc_uninit ( void )

Function for uninitializing the ADC.

This function stops all ongoing conversions and disables all channels.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation