Hardware access layer for accessing the SAADC peripheral. More...
Data Structures | |
struct | nrf_saadc_config_t |
Analog-to-digital converter configuration structure. More... | |
struct | nrf_saadc_channel_config_t |
Analog-to-digital converter channel configuration structure. More... | |
Macros | |
#define | NRF_SAADC_CHANNEL_COUNT 8 |
Typedefs | |
typedef int16_t | nrf_saadc_value_t |
Type of a single ADC conversion result. | |
Enumerations | |
enum | nrf_saadc_resolution_t { NRF_SAADC_RESOLUTION_8BIT = SAADC_RESOLUTION_VAL_8bit, NRF_SAADC_RESOLUTION_10BIT = SAADC_RESOLUTION_VAL_10bit, NRF_SAADC_RESOLUTION_12BIT = SAADC_RESOLUTION_VAL_12bit, NRF_SAADC_RESOLUTION_14BIT = SAADC_RESOLUTION_VAL_14bit } |
Resolution of the analog-to-digital converter. More... | |
enum | nrf_saadc_input_t { NRF_SAADC_INPUT_DISABLED = SAADC_CH_PSELP_PSELP_NC, NRF_SAADC_INPUT_AIN0 = SAADC_CH_PSELP_PSELP_AnalogInput0, NRF_SAADC_INPUT_AIN1 = SAADC_CH_PSELP_PSELP_AnalogInput1, NRF_SAADC_INPUT_AIN2 = SAADC_CH_PSELP_PSELP_AnalogInput2, NRF_SAADC_INPUT_AIN3 = SAADC_CH_PSELP_PSELP_AnalogInput3, NRF_SAADC_INPUT_AIN4 = SAADC_CH_PSELP_PSELP_AnalogInput4, NRF_SAADC_INPUT_AIN5 = SAADC_CH_PSELP_PSELP_AnalogInput5, NRF_SAADC_INPUT_AIN6 = SAADC_CH_PSELP_PSELP_AnalogInput6, NRF_SAADC_INPUT_AIN7 = SAADC_CH_PSELP_PSELP_AnalogInput7, NRF_SAADC_INPUT_VDD = SAADC_CH_PSELP_PSELP_VDD } |
Input selection for the analog-to-digital converter. More... | |
enum | nrf_saadc_oversample_t { NRF_SAADC_OVERSAMPLE_DISABLED = SAADC_OVERSAMPLE_OVERSAMPLE_Bypass, NRF_SAADC_OVERSAMPLE_2X = SAADC_OVERSAMPLE_OVERSAMPLE_Over2x, NRF_SAADC_OVERSAMPLE_4X = SAADC_OVERSAMPLE_OVERSAMPLE_Over4x, NRF_SAADC_OVERSAMPLE_8X = SAADC_OVERSAMPLE_OVERSAMPLE_Over8x, NRF_SAADC_OVERSAMPLE_16X = SAADC_OVERSAMPLE_OVERSAMPLE_Over16x, NRF_SAADC_OVERSAMPLE_32X = SAADC_OVERSAMPLE_OVERSAMPLE_Over32x, NRF_SAADC_OVERSAMPLE_64X = SAADC_OVERSAMPLE_OVERSAMPLE_Over64x, NRF_SAADC_OVERSAMPLE_128X = SAADC_OVERSAMPLE_OVERSAMPLE_Over128x, NRF_SAADC_OVERSAMPLE_256X = SAADC_OVERSAMPLE_OVERSAMPLE_Over256x } |
Analog-to-digital converter oversampling mode. More... | |
enum | nrf_saadc_resistor_t { NRF_SAADC_RESISTOR_DISABLED = SAADC_CH_CONFIG_RESP_Bypass, NRF_SAADC_RESISTOR_PULLDOWN = SAADC_CH_CONFIG_RESP_Pulldown, NRF_SAADC_RESISTOR_PULLUP = SAADC_CH_CONFIG_RESP_Pullup, NRF_SAADC_RESISTOR_VDD1_2 = SAADC_CH_CONFIG_RESP_VDD1_2 } |
Analog-to-digital converter channel resistor control. More... | |
enum | nrf_saadc_gain_t { NRF_SAADC_GAIN1_6 = SAADC_CH_CONFIG_GAIN_Gain1_6, NRF_SAADC_GAIN1_5 = SAADC_CH_CONFIG_GAIN_Gain1_5, NRF_SAADC_GAIN1_4 = SAADC_CH_CONFIG_GAIN_Gain1_4, NRF_SAADC_GAIN1_3 = SAADC_CH_CONFIG_GAIN_Gain1_3, NRF_SAADC_GAIN1_2 = SAADC_CH_CONFIG_GAIN_Gain1_2, NRF_SAADC_GAIN1 = SAADC_CH_CONFIG_GAIN_Gain1, NRF_SAADC_GAIN2 = SAADC_CH_CONFIG_GAIN_Gain2, NRF_SAADC_GAIN4 = SAADC_CH_CONFIG_GAIN_Gain4 } |
Gain factor of the analog-to-digital converter input. More... | |
enum | nrf_saadc_reference_t { NRF_SAADC_REFERENCE_INTERNAL = SAADC_CH_CONFIG_REFSEL_Internal, NRF_SAADC_REFERENCE_VDD4 = SAADC_CH_CONFIG_REFSEL_VDD1_4 } |
Reference selection for the analog-to-digital converter. More... | |
enum | nrf_saadc_acqtime_t { NRF_SAADC_ACQTIME_3US = SAADC_CH_CONFIG_TACQ_3us, NRF_SAADC_ACQTIME_5US = SAADC_CH_CONFIG_TACQ_5us, NRF_SAADC_ACQTIME_10US = SAADC_CH_CONFIG_TACQ_10us, NRF_SAADC_ACQTIME_15US = SAADC_CH_CONFIG_TACQ_15us, NRF_SAADC_ACQTIME_20US = SAADC_CH_CONFIG_TACQ_20us, NRF_SAADC_ACQTIME_40US = SAADC_CH_CONFIG_TACQ_40us } |
Analog-to-digital converter acquisition time. More... | |
enum | nrf_saadc_mode_t { NRF_SAADC_MODE_SINGLE_ENDED = SAADC_CH_CONFIG_MODE_SE, NRF_SAADC_MODE_DIFFERENTIAL = SAADC_CH_CONFIG_MODE_Diff } |
Analog-to-digital converter channel mode. More... | |
enum | nrf_saadc_burst_t { NRF_SAADC_BURST_DISABLED = SAADC_CH_CONFIG_BURST_Disabled, NRF_SAADC_BURST_ENABLED = SAADC_CH_CONFIG_BURST_Enabled } |
Analog-to-digital converter channel burst mode. More... | |
enum | nrf_saadc_task_t { NRF_SAADC_TASK_START = offsetof(NRF_SAADC_Type, TASKS_START), NRF_SAADC_TASK_SAMPLE = offsetof(NRF_SAADC_Type, TASKS_SAMPLE), NRF_SAADC_TASK_STOP = offsetof(NRF_SAADC_Type, TASKS_STOP), NRF_SAADC_TASK_CALIBRATEOFFSET = offsetof(NRF_SAADC_Type, TASKS_CALIBRATEOFFSET) } |
Analog-to-digital converter tasks. More... | |
enum | nrf_saadc_event_t { NRF_SAADC_EVENT_STARTED = offsetof(NRF_SAADC_Type, EVENTS_STARTED), NRF_SAADC_EVENT_END = offsetof(NRF_SAADC_Type, EVENTS_END), NRF_SAADC_EVENT_DONE = offsetof(NRF_SAADC_Type, EVENTS_DONE), NRF_SAADC_EVENT_RESULTDONE = offsetof(NRF_SAADC_Type, EVENTS_RESULTDONE), NRF_SAADC_EVENT_CALIBRATEDONE = offsetof(NRF_SAADC_Type, EVENTS_CALIBRATEDONE), NRF_SAADC_EVENT_STOPPED = offsetof(NRF_SAADC_Type, EVENTS_STOPPED), NRF_SAADC_EVENT_CH0_LIMITH = offsetof(NRF_SAADC_Type, EVENTS_CH[0].LIMITH), NRF_SAADC_EVENT_CH0_LIMITL = offsetof(NRF_SAADC_Type, EVENTS_CH[0].LIMITL), NRF_SAADC_EVENT_CH1_LIMITH = offsetof(NRF_SAADC_Type, EVENTS_CH[1].LIMITH), NRF_SAADC_EVENT_CH1_LIMITL = offsetof(NRF_SAADC_Type, EVENTS_CH[1].LIMITL), NRF_SAADC_EVENT_CH2_LIMITH = offsetof(NRF_SAADC_Type, EVENTS_CH[2].LIMITH), NRF_SAADC_EVENT_CH2_LIMITL = offsetof(NRF_SAADC_Type, EVENTS_CH[2].LIMITL), NRF_SAADC_EVENT_CH3_LIMITH = offsetof(NRF_SAADC_Type, EVENTS_CH[3].LIMITH), NRF_SAADC_EVENT_CH3_LIMITL = offsetof(NRF_SAADC_Type, EVENTS_CH[3].LIMITL), NRF_SAADC_EVENT_CH4_LIMITH = offsetof(NRF_SAADC_Type, EVENTS_CH[4].LIMITH), NRF_SAADC_EVENT_CH4_LIMITL = offsetof(NRF_SAADC_Type, EVENTS_CH[4].LIMITL), NRF_SAADC_EVENT_CH5_LIMITH = offsetof(NRF_SAADC_Type, EVENTS_CH[5].LIMITH), NRF_SAADC_EVENT_CH5_LIMITL = offsetof(NRF_SAADC_Type, EVENTS_CH[5].LIMITL), NRF_SAADC_EVENT_CH6_LIMITH = offsetof(NRF_SAADC_Type, EVENTS_CH[6].LIMITH), NRF_SAADC_EVENT_CH6_LIMITL = offsetof(NRF_SAADC_Type, EVENTS_CH[6].LIMITL), NRF_SAADC_EVENT_CH7_LIMITH = offsetof(NRF_SAADC_Type, EVENTS_CH[7].LIMITH), NRF_SAADC_EVENT_CH7_LIMITL = offsetof(NRF_SAADC_Type, EVENTS_CH[7].LIMITL) } |
Analog-to-digital converter events. More... | |
enum | nrf_saadc_int_mask_t { NRF_SAADC_INT_STARTED = SAADC_INTENSET_STARTED_Msk, NRF_SAADC_INT_END = SAADC_INTENSET_END_Msk, NRF_SAADC_INT_DONE = SAADC_INTENSET_DONE_Msk, NRF_SAADC_INT_RESULTDONE = SAADC_INTENSET_RESULTDONE_Msk, NRF_SAADC_INT_CALIBRATEDONE = SAADC_INTENSET_CALIBRATEDONE_Msk, NRF_SAADC_INT_STOPPED = SAADC_INTENSET_STOPPED_Msk, NRF_SAADC_INT_CH0LIMITH = SAADC_INTENSET_CH0LIMITH_Msk, NRF_SAADC_INT_CH0LIMITL = SAADC_INTENSET_CH0LIMITL_Msk, NRF_SAADC_INT_CH1LIMITH = SAADC_INTENSET_CH1LIMITH_Msk, NRF_SAADC_INT_CH1LIMITL = SAADC_INTENSET_CH1LIMITL_Msk, NRF_SAADC_INT_CH2LIMITH = SAADC_INTENSET_CH2LIMITH_Msk, NRF_SAADC_INT_CH2LIMITL = SAADC_INTENSET_CH2LIMITL_Msk, NRF_SAADC_INT_CH3LIMITH = SAADC_INTENSET_CH3LIMITH_Msk, NRF_SAADC_INT_CH3LIMITL = SAADC_INTENSET_CH3LIMITL_Msk, NRF_SAADC_INT_CH4LIMITH = SAADC_INTENSET_CH4LIMITH_Msk, NRF_SAADC_INT_CH4LIMITL = SAADC_INTENSET_CH4LIMITL_Msk, NRF_SAADC_INT_CH5LIMITH = SAADC_INTENSET_CH5LIMITH_Msk, NRF_SAADC_INT_CH5LIMITL = SAADC_INTENSET_CH5LIMITL_Msk, NRF_SAADC_INT_CH6LIMITH = SAADC_INTENSET_CH6LIMITH_Msk, NRF_SAADC_INT_CH6LIMITL = SAADC_INTENSET_CH6LIMITL_Msk, NRF_SAADC_INT_CH7LIMITH = SAADC_INTENSET_CH7LIMITH_Msk, NRF_SAADC_INT_CH7LIMITL = SAADC_INTENSET_CH7LIMITL_Msk, NRF_SAADC_INT_ALL = 0x7FFFFFFFUL } |
Analog-to-digital converter interrupt masks. More... | |
enum | nrf_saadc_limit_t { NRF_SAADC_LIMIT_LOW = 0, NRF_SAADC_LIMIT_HIGH = 1 } |
Analog-to-digital converter value limit type. | |
Functions | |
__STATIC_INLINE void | nrf_saadc_task_trigger (nrf_saadc_task_t saadc_task) |
Function for triggering a specific SAADC task. More... | |
__STATIC_INLINE uint32_t | nrf_saadc_task_address_get (nrf_saadc_task_t saadc_task) |
Function for getting the address of a specific SAADC task register. More... | |
__STATIC_INLINE bool | nrf_saadc_event_check (nrf_saadc_event_t saadc_event) |
Function for getting the state of a specific SAADC event. More... | |
__STATIC_INLINE void | nrf_saadc_event_clear (nrf_saadc_event_t saadc_event) |
Function for clearing the specific SAADC event. More... | |
__STATIC_INLINE uint32_t | nrf_saadc_event_address_get (nrf_saadc_event_t saadc_event) |
Function for getting the address of a specific SAADC event register. More... | |
__STATIC_INLINE volatile uint32_t * | nrf_saadc_event_limit_address_get (uint8_t channel, nrf_saadc_limit_t limit_type) |
Function for getting the address of a specific SAADC limit event register. More... | |
__STATIC_INLINE nrf_saadc_event_t | nrf_saadc_event_limit_get (uint8_t channel, nrf_saadc_limit_t limit_type) |
Function for getting the SAADC channel monitoring limit events. More... | |
__STATIC_INLINE void | nrf_saadc_channel_input_set (uint8_t channel, nrf_saadc_input_t pselp, nrf_saadc_input_t pseln) |
Function for configuring the input pins for a specific SAADC channel. More... | |
__STATIC_INLINE void | nrf_saadc_channel_limits_set (uint8_t channel, int16_t low, int16_t high) |
Function for setting the SAADC channel monitoring limits. More... | |
__STATIC_INLINE void | nrf_saadc_int_enable (uint32_t saadc_int_mask) |
Function for enabling specified SAADC interrupts. More... | |
__STATIC_INLINE bool | nrf_saadc_int_enable_check (uint32_t saadc_int_mask) |
Function for retrieving the state of specified SAADC interrupts. More... | |
__STATIC_INLINE void | nrf_saadc_int_disable (uint32_t saadc_int_mask) |
Function for disabling specified interrupts. More... | |
__STATIC_INLINE uint32_t | nrf_saadc_limit_int_get (uint8_t channel, nrf_saadc_limit_t limit_type) |
Function for generating masks for SAADC channel limit interrupts. More... | |
__STATIC_INLINE bool | nrf_saadc_busy_check (void) |
Function for checking whether the SAADC is busy. More... | |
__STATIC_INLINE void | nrf_saadc_enable (void) |
Function for enabling the SAADC. More... | |
__STATIC_INLINE void | nrf_saadc_disable (void) |
Function for disabling the SAADC. | |
__STATIC_INLINE bool | nrf_saadc_enable_check (void) |
Function for checking if the SAADC is enabled. More... | |
__STATIC_INLINE void | nrf_saadc_buffer_init (nrf_saadc_value_t *buffer, uint32_t num) |
Function for initializing the SAADC result buffer. More... | |
__STATIC_INLINE uint16_t | nrf_saadc_amount_get (void) |
Function for getting the number of buffer words transferred since last START operation. More... | |
__STATIC_INLINE void | nrf_saadc_resolution_set (nrf_saadc_resolution_t resolution) |
Function for setting the SAADC sample resolution. More... | |
__STATIC_INLINE void | nrf_saadc_oversample_set (nrf_saadc_oversample_t oversample) |
Function for configuring the oversampling feature. More... | |
__STATIC_INLINE nrf_saadc_oversample_t | nrf_saadc_oversample_get (void) |
Function for getting the oversampling feature configuration. More... | |
void | nrf_saadc_channel_init (uint8_t channel, nrf_saadc_channel_config_t const *const config) |
Function for initializing the SAADC channel. More... | |
Hardware access layer for accessing the SAADC peripheral.
enum nrf_saadc_acqtime_t |
enum nrf_saadc_burst_t |
enum nrf_saadc_event_t |
Analog-to-digital converter events.
enum nrf_saadc_gain_t |
Gain factor of the analog-to-digital converter input.
enum nrf_saadc_input_t |
Input selection for the analog-to-digital converter.
enum nrf_saadc_int_mask_t |
Analog-to-digital converter interrupt masks.
enum nrf_saadc_mode_t |
Analog-to-digital converter oversampling mode.
enum nrf_saadc_resistor_t |
enum nrf_saadc_task_t |
Analog-to-digital converter tasks.
__STATIC_INLINE uint16_t nrf_saadc_amount_get | ( | void | ) |
Function for getting the number of buffer words transferred since last START operation.
__STATIC_INLINE void nrf_saadc_buffer_init | ( | nrf_saadc_value_t * | buffer, |
uint32_t | num | ||
) |
Function for initializing the SAADC result buffer.
[in] | buffer | Pointer to the result buffer. |
[in] | num | Size of buffer in words. |
__STATIC_INLINE bool nrf_saadc_busy_check | ( | void | ) |
Function for checking whether the SAADC is busy.
This function checks whether the analog-to-digital converter is busy with a conversion.
true | If the SAADC is busy. |
false | If the SAADC is not busy. |
void nrf_saadc_channel_init | ( | uint8_t | channel, |
nrf_saadc_channel_config_t const *const | config | ||
) |
Function for initializing the SAADC channel.
[in] | channel | Channel number. |
[in] | config | Pointer to the channel configuration structure. |
__STATIC_INLINE void nrf_saadc_channel_input_set | ( | uint8_t | channel, |
nrf_saadc_input_t | pselp, | ||
nrf_saadc_input_t | pseln | ||
) |
Function for configuring the input pins for a specific SAADC channel.
[in] | channel | Channel number. |
[in] | pselp | Positive input. |
[in] | pseln | Negative input. Set to NRF_SAADC_INPUT_DISABLED in single ended mode. |
__STATIC_INLINE void nrf_saadc_channel_limits_set | ( | uint8_t | channel, |
int16_t | low, | ||
int16_t | high | ||
) |
Function for setting the SAADC channel monitoring limits.
[in] | channel | Channel number. |
[in] | low | Low limit. |
[in] | high | High limit. |
__STATIC_INLINE void nrf_saadc_enable | ( | void | ) |
Function for enabling the SAADC.
The analog-to-digital converter must be enabled before use.
__STATIC_INLINE bool nrf_saadc_enable_check | ( | void | ) |
Function for checking if the SAADC is enabled.
true | If the SAADC is enabled. |
false | If the SAADC is not enabled. |
__STATIC_INLINE uint32_t nrf_saadc_event_address_get | ( | nrf_saadc_event_t | saadc_event | ) |
Function for getting the address of a specific SAADC event register.
[in] | saadc_event | SAADC event. |
__STATIC_INLINE bool nrf_saadc_event_check | ( | nrf_saadc_event_t | saadc_event | ) |
Function for getting the state of a specific SAADC event.
[in] | saadc_event | SAADC event. |
__STATIC_INLINE void nrf_saadc_event_clear | ( | nrf_saadc_event_t | saadc_event | ) |
Function for clearing the specific SAADC event.
[in] | saadc_event | SAADC event. |
__STATIC_INLINE volatile uint32_t* nrf_saadc_event_limit_address_get | ( | uint8_t | channel, |
nrf_saadc_limit_t | limit_type | ||
) |
Function for getting the address of a specific SAADC limit event register.
[in] | channel | Channel number. |
[in] | limit_type | Low limit or high limit. |
__STATIC_INLINE nrf_saadc_event_t nrf_saadc_event_limit_get | ( | uint8_t | channel, |
nrf_saadc_limit_t | limit_type | ||
) |
Function for getting the SAADC channel monitoring limit events.
[in] | channel | Channel number. |
[in] | limit_type | Low limit or high limit. |
__STATIC_INLINE void nrf_saadc_int_disable | ( | uint32_t | saadc_int_mask | ) |
Function for disabling specified interrupts.
saadc_int_mask | Interrupt(s) to disable. |
__STATIC_INLINE void nrf_saadc_int_enable | ( | uint32_t | saadc_int_mask | ) |
Function for enabling specified SAADC interrupts.
[in] | saadc_int_mask | Interrupt(s) to enable. |
__STATIC_INLINE bool nrf_saadc_int_enable_check | ( | uint32_t | saadc_int_mask | ) |
Function for retrieving the state of specified SAADC interrupts.
[in] | saadc_int_mask | Interrupt(s) to check. |
true | If all specified interrupts are enabled. |
false | If at least one of the given interrupts is not enabled. |
__STATIC_INLINE uint32_t nrf_saadc_limit_int_get | ( | uint8_t | channel, |
nrf_saadc_limit_t | limit_type | ||
) |
Function for generating masks for SAADC channel limit interrupts.
[in] | channel | SAADC channel number. |
[in] | limit_type | Limit type. |
__STATIC_INLINE nrf_saadc_oversample_t nrf_saadc_oversample_get | ( | void | ) |
Function for getting the oversampling feature configuration.
__STATIC_INLINE void nrf_saadc_oversample_set | ( | nrf_saadc_oversample_t | oversample | ) |
Function for configuring the oversampling feature.
[in] | oversample | Oversampling mode. |
__STATIC_INLINE void nrf_saadc_resolution_set | ( | nrf_saadc_resolution_t | resolution | ) |
Function for setting the SAADC sample resolution.
[in] | resolution | Bit resolution. |
__STATIC_INLINE uint32_t nrf_saadc_task_address_get | ( | nrf_saadc_task_t | saadc_task | ) |
Function for getting the address of a specific SAADC task register.
[in] | saadc_task | SAADC task. |
__STATIC_INLINE void nrf_saadc_task_trigger | ( | nrf_saadc_task_t | saadc_task | ) |
Function for triggering a specific SAADC task.
[in] | saadc_task | SAADC task. |