The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
TARGET_VBLUNO51/TOOLCHAIN_ARM_STD/nrf_drv_adc.h@171:3a7713b1edbc, 2018-11-08 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 08 11:45:42 2018 +0000
- Revision:
- 171:3a7713b1edbc
- Parent:
- TARGET_VBLUNO51/TARGET_NORDIC/TARGET_NRF5x/TARGET_NRF51/TARGET_MCU_NRF51822_UNIFIED/sdk/drivers_nrf/adc/nrf_drv_adc.h@169:a7c7b631e539
mbed library. Release version 164
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 146:22da6e220af6 | 1 | /* |
AnnaBridge | 146:22da6e220af6 | 2 | * Copyright (c) 2015 Nordic Semiconductor ASA |
AnnaBridge | 146:22da6e220af6 | 3 | * All rights reserved. |
AnnaBridge | 146:22da6e220af6 | 4 | * |
AnnaBridge | 146:22da6e220af6 | 5 | * Redistribution and use in source and binary forms, with or without modification, |
AnnaBridge | 146:22da6e220af6 | 6 | * are permitted provided that the following conditions are met: |
AnnaBridge | 146:22da6e220af6 | 7 | * |
AnnaBridge | 146:22da6e220af6 | 8 | * 1. Redistributions of source code must retain the above copyright notice, this list |
AnnaBridge | 146:22da6e220af6 | 9 | * of conditions and the following disclaimer. |
AnnaBridge | 146:22da6e220af6 | 10 | * |
AnnaBridge | 146:22da6e220af6 | 11 | * 2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA |
AnnaBridge | 146:22da6e220af6 | 12 | * integrated circuit in a product or a software update for such product, must reproduce |
AnnaBridge | 146:22da6e220af6 | 13 | * the above copyright notice, this list of conditions and the following disclaimer in |
AnnaBridge | 146:22da6e220af6 | 14 | * the documentation and/or other materials provided with the distribution. |
AnnaBridge | 146:22da6e220af6 | 15 | * |
AnnaBridge | 146:22da6e220af6 | 16 | * 3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be |
AnnaBridge | 146:22da6e220af6 | 17 | * used to endorse or promote products derived from this software without specific prior |
AnnaBridge | 146:22da6e220af6 | 18 | * written permission. |
AnnaBridge | 146:22da6e220af6 | 19 | * |
AnnaBridge | 146:22da6e220af6 | 20 | * 4. This software, with or without modification, must only be used with a |
AnnaBridge | 146:22da6e220af6 | 21 | * Nordic Semiconductor ASA integrated circuit. |
AnnaBridge | 146:22da6e220af6 | 22 | * |
AnnaBridge | 146:22da6e220af6 | 23 | * 5. Any software provided in binary or object form under this license must not be reverse |
AnnaBridge | 146:22da6e220af6 | 24 | * engineered, decompiled, modified and/or disassembled. |
AnnaBridge | 146:22da6e220af6 | 25 | * |
AnnaBridge | 146:22da6e220af6 | 26 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
AnnaBridge | 146:22da6e220af6 | 27 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
AnnaBridge | 146:22da6e220af6 | 28 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
AnnaBridge | 146:22da6e220af6 | 29 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR |
AnnaBridge | 146:22da6e220af6 | 30 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
AnnaBridge | 146:22da6e220af6 | 31 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
AnnaBridge | 146:22da6e220af6 | 32 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
AnnaBridge | 146:22da6e220af6 | 33 | * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
AnnaBridge | 146:22da6e220af6 | 34 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
AnnaBridge | 146:22da6e220af6 | 35 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
AnnaBridge | 146:22da6e220af6 | 36 | * |
AnnaBridge | 146:22da6e220af6 | 37 | */ |
AnnaBridge | 146:22da6e220af6 | 38 | |
AnnaBridge | 146:22da6e220af6 | 39 | |
AnnaBridge | 146:22da6e220af6 | 40 | #include "nrf_adc.h" |
AnnaBridge | 146:22da6e220af6 | 41 | #include "nrf_drv_config.h" |
AnnaBridge | 146:22da6e220af6 | 42 | #include "sdk_errors.h" |
AnnaBridge | 146:22da6e220af6 | 43 | #include <stdbool.h> |
AnnaBridge | 146:22da6e220af6 | 44 | |
AnnaBridge | 146:22da6e220af6 | 45 | #ifdef __cplusplus |
AnnaBridge | 146:22da6e220af6 | 46 | extern "C" { |
AnnaBridge | 146:22da6e220af6 | 47 | #endif |
AnnaBridge | 146:22da6e220af6 | 48 | |
AnnaBridge | 146:22da6e220af6 | 49 | /** |
AnnaBridge | 146:22da6e220af6 | 50 | * @addtogroup nrf_adc ADC HAL and driver |
AnnaBridge | 146:22da6e220af6 | 51 | * @ingroup nrf_drivers |
AnnaBridge | 146:22da6e220af6 | 52 | * @brief Analog-to-digital converter (ADC) APIs. |
AnnaBridge | 146:22da6e220af6 | 53 | * @details The ADC HAL provides basic APIs for accessing the registers of the analog-to-digital converter. |
AnnaBridge | 146:22da6e220af6 | 54 | * The ADC driver provides APIs on a higher level. |
AnnaBridge | 146:22da6e220af6 | 55 | * |
AnnaBridge | 146:22da6e220af6 | 56 | * @defgroup nrf_adc_drv ADC driver |
AnnaBridge | 146:22da6e220af6 | 57 | * @{ |
AnnaBridge | 146:22da6e220af6 | 58 | * @ingroup nrf_adc |
AnnaBridge | 146:22da6e220af6 | 59 | * @brief Analog-to-digital converter (ADC) driver. |
AnnaBridge | 146:22da6e220af6 | 60 | */ |
AnnaBridge | 146:22da6e220af6 | 61 | |
AnnaBridge | 146:22da6e220af6 | 62 | |
AnnaBridge | 146:22da6e220af6 | 63 | /** |
AnnaBridge | 146:22da6e220af6 | 64 | * @brief Driver event types. |
AnnaBridge | 146:22da6e220af6 | 65 | */ |
AnnaBridge | 146:22da6e220af6 | 66 | typedef enum |
AnnaBridge | 146:22da6e220af6 | 67 | { |
AnnaBridge | 146:22da6e220af6 | 68 | NRF_DRV_ADC_EVT_DONE, ///< Event generated when the buffer is filled with samples. |
AnnaBridge | 146:22da6e220af6 | 69 | NRF_DRV_ADC_EVT_SAMPLE, ///< Event generated when the requested channel is sampled. |
AnnaBridge | 146:22da6e220af6 | 70 | } nrf_drv_adc_evt_type_t; |
AnnaBridge | 146:22da6e220af6 | 71 | |
AnnaBridge | 146:22da6e220af6 | 72 | typedef int16_t nrf_adc_value_t; |
AnnaBridge | 146:22da6e220af6 | 73 | |
AnnaBridge | 146:22da6e220af6 | 74 | /** |
AnnaBridge | 146:22da6e220af6 | 75 | * @brief Analog-to-digital converter driver DONE event. |
AnnaBridge | 146:22da6e220af6 | 76 | */ |
AnnaBridge | 146:22da6e220af6 | 77 | typedef struct |
AnnaBridge | 146:22da6e220af6 | 78 | { |
AnnaBridge | 146:22da6e220af6 | 79 | nrf_adc_value_t * p_buffer; ///< Pointer to buffer with converted samples. |
AnnaBridge | 146:22da6e220af6 | 80 | uint16_t size; ///< Number of samples in the buffer. |
AnnaBridge | 146:22da6e220af6 | 81 | } nrf_drv_adc_done_evt_t; |
AnnaBridge | 146:22da6e220af6 | 82 | |
AnnaBridge | 146:22da6e220af6 | 83 | /** |
AnnaBridge | 146:22da6e220af6 | 84 | * @brief Analog-to-digital converter driver SAMPLE event. |
AnnaBridge | 146:22da6e220af6 | 85 | */ |
AnnaBridge | 146:22da6e220af6 | 86 | typedef struct |
AnnaBridge | 146:22da6e220af6 | 87 | { |
AnnaBridge | 146:22da6e220af6 | 88 | nrf_adc_value_t sample; ///< Converted sample. |
AnnaBridge | 146:22da6e220af6 | 89 | } nrf_drv_adc_sample_evt_t; |
AnnaBridge | 146:22da6e220af6 | 90 | |
AnnaBridge | 146:22da6e220af6 | 91 | /** |
AnnaBridge | 146:22da6e220af6 | 92 | * @brief Analog-to-digital converter driver event. |
AnnaBridge | 146:22da6e220af6 | 93 | */ |
AnnaBridge | 146:22da6e220af6 | 94 | typedef struct |
AnnaBridge | 146:22da6e220af6 | 95 | { |
AnnaBridge | 146:22da6e220af6 | 96 | nrf_drv_adc_evt_type_t type; ///< Event type. |
AnnaBridge | 146:22da6e220af6 | 97 | union |
AnnaBridge | 146:22da6e220af6 | 98 | { |
AnnaBridge | 146:22da6e220af6 | 99 | nrf_drv_adc_done_evt_t done; ///< Data for DONE event. |
AnnaBridge | 146:22da6e220af6 | 100 | nrf_drv_adc_sample_evt_t sample; ///< Data for SAMPLE event. |
AnnaBridge | 146:22da6e220af6 | 101 | } data; |
AnnaBridge | 146:22da6e220af6 | 102 | } nrf_drv_adc_evt_t; |
AnnaBridge | 146:22da6e220af6 | 103 | |
AnnaBridge | 146:22da6e220af6 | 104 | /**@brief Macro for initializing the ADC channel with the default configuration. */ |
AnnaBridge | 146:22da6e220af6 | 105 | #define NRF_DRV_ADC_DEFAULT_CHANNEL(analog_input) \ |
AnnaBridge | 146:22da6e220af6 | 106 | {{{ \ |
AnnaBridge | 146:22da6e220af6 | 107 | .resolution = NRF_ADC_CONFIG_RES_10BIT, \ |
AnnaBridge | 146:22da6e220af6 | 108 | .input = NRF_ADC_CONFIG_SCALING_INPUT_FULL_SCALE, \ |
AnnaBridge | 146:22da6e220af6 | 109 | .reference = NRF_ADC_CONFIG_REF_VBG, \ |
AnnaBridge | 146:22da6e220af6 | 110 | .ain = (analog_input) \ |
AnnaBridge | 146:22da6e220af6 | 111 | }}, NULL} |
AnnaBridge | 146:22da6e220af6 | 112 | |
AnnaBridge | 146:22da6e220af6 | 113 | /** |
AnnaBridge | 146:22da6e220af6 | 114 | * @brief ADC channel configuration. |
AnnaBridge | 146:22da6e220af6 | 115 | * |
AnnaBridge | 146:22da6e220af6 | 116 | * @note The bit fields reflect bit fields in the ADC CONFIG register. |
AnnaBridge | 146:22da6e220af6 | 117 | */ |
AnnaBridge | 146:22da6e220af6 | 118 | typedef struct |
AnnaBridge | 146:22da6e220af6 | 119 | { |
AnnaBridge | 146:22da6e220af6 | 120 | uint32_t resolution :2; ///< 8-10 bit resolution. |
AnnaBridge | 146:22da6e220af6 | 121 | uint32_t input :3; ///< Input selection and scaling. |
AnnaBridge | 146:22da6e220af6 | 122 | uint32_t reference :2; ///< Reference source. |
AnnaBridge | 146:22da6e220af6 | 123 | uint32_t reserved :1; ///< Unused bit fields. |
AnnaBridge | 146:22da6e220af6 | 124 | uint32_t ain :8; ///< Analog input. |
AnnaBridge | 146:22da6e220af6 | 125 | uint32_t external_reference:2; ///< Eternal reference source. |
AnnaBridge | 146:22da6e220af6 | 126 | }nrf_drv_adc_channel_config_t; |
AnnaBridge | 146:22da6e220af6 | 127 | |
AnnaBridge | 146:22da6e220af6 | 128 | // Forward declaration of the nrf_drv_adc_channel_t type. |
AnnaBridge | 146:22da6e220af6 | 129 | typedef struct nrf_drv_adc_channel_s nrf_drv_adc_channel_t; |
AnnaBridge | 146:22da6e220af6 | 130 | |
AnnaBridge | 146:22da6e220af6 | 131 | /** |
AnnaBridge | 146:22da6e220af6 | 132 | * @brief ADC channel. |
AnnaBridge | 146:22da6e220af6 | 133 | * |
AnnaBridge | 146:22da6e220af6 | 134 | * This structure is defined by the user and used by the driver. Therefore, it should |
AnnaBridge | 146:22da6e220af6 | 135 | * not be defined on the stack as a local variable. |
AnnaBridge | 146:22da6e220af6 | 136 | */ |
AnnaBridge | 146:22da6e220af6 | 137 | struct nrf_drv_adc_channel_s |
AnnaBridge | 146:22da6e220af6 | 138 | { |
AnnaBridge | 146:22da6e220af6 | 139 | union |
AnnaBridge | 146:22da6e220af6 | 140 | { |
AnnaBridge | 146:22da6e220af6 | 141 | nrf_drv_adc_channel_config_t config; ///< Channel configuration. |
AnnaBridge | 146:22da6e220af6 | 142 | uint32_t data; ///< Raw value. |
AnnaBridge | 146:22da6e220af6 | 143 | } config; |
AnnaBridge | 146:22da6e220af6 | 144 | nrf_drv_adc_channel_t * p_next; ///< Pointer to the next enabled channel (for internal use). |
AnnaBridge | 146:22da6e220af6 | 145 | }; |
AnnaBridge | 146:22da6e220af6 | 146 | |
AnnaBridge | 146:22da6e220af6 | 147 | /** |
AnnaBridge | 146:22da6e220af6 | 148 | * @brief ADC configuration. |
AnnaBridge | 146:22da6e220af6 | 149 | */ |
AnnaBridge | 146:22da6e220af6 | 150 | typedef struct |
AnnaBridge | 146:22da6e220af6 | 151 | { |
AnnaBridge | 146:22da6e220af6 | 152 | uint8_t interrupt_priority; ///< Priority of ADC interrupt. |
AnnaBridge | 146:22da6e220af6 | 153 | } nrf_drv_adc_config_t; |
AnnaBridge | 146:22da6e220af6 | 154 | |
AnnaBridge | 146:22da6e220af6 | 155 | /** @brief ADC default configuration. */ |
AnnaBridge | 146:22da6e220af6 | 156 | #define NRF_DRV_ADC_DEFAULT_CONFIG \ |
AnnaBridge | 146:22da6e220af6 | 157 | { \ |
AnnaBridge | 146:22da6e220af6 | 158 | .interrupt_priority = ADC_CONFIG_IRQ_PRIORITY \ |
AnnaBridge | 146:22da6e220af6 | 159 | } |
AnnaBridge | 146:22da6e220af6 | 160 | |
AnnaBridge | 146:22da6e220af6 | 161 | /** |
AnnaBridge | 146:22da6e220af6 | 162 | * @brief User event handler prototype. |
AnnaBridge | 146:22da6e220af6 | 163 | * |
AnnaBridge | 146:22da6e220af6 | 164 | * This function is called when the requested number of samples has been processed. |
AnnaBridge | 146:22da6e220af6 | 165 | * |
AnnaBridge | 146:22da6e220af6 | 166 | * @param p_event Event. |
AnnaBridge | 146:22da6e220af6 | 167 | */ |
AnnaBridge | 146:22da6e220af6 | 168 | typedef void (*nrf_drv_adc_event_handler_t)(nrf_drv_adc_evt_t const * p_event); |
AnnaBridge | 146:22da6e220af6 | 169 | |
AnnaBridge | 146:22da6e220af6 | 170 | /** |
AnnaBridge | 146:22da6e220af6 | 171 | * @brief Function for initializing the ADC. |
AnnaBridge | 146:22da6e220af6 | 172 | * |
AnnaBridge | 146:22da6e220af6 | 173 | * If a valid event handler is provided, the driver is initialized in non-blocking mode. |
AnnaBridge | 146:22da6e220af6 | 174 | * If event_handler is NULL, the driver works in blocking mode. |
AnnaBridge | 146:22da6e220af6 | 175 | * |
AnnaBridge | 146:22da6e220af6 | 176 | * @param[in] p_config Driver configuration. |
AnnaBridge | 146:22da6e220af6 | 177 | * @param[in] event_handler Event handler provided by the user. |
AnnaBridge | 146:22da6e220af6 | 178 | * |
AnnaBridge | 146:22da6e220af6 | 179 | * @retval NRF_SUCCESS If initialization was successful. |
AnnaBridge | 146:22da6e220af6 | 180 | * @retval NRF_ERROR_INVALID_STATE If the driver is already initialized. |
AnnaBridge | 146:22da6e220af6 | 181 | */ |
AnnaBridge | 146:22da6e220af6 | 182 | ret_code_t nrf_drv_adc_init(nrf_drv_adc_config_t const * p_config, |
AnnaBridge | 146:22da6e220af6 | 183 | nrf_drv_adc_event_handler_t event_handler); |
AnnaBridge | 146:22da6e220af6 | 184 | |
AnnaBridge | 146:22da6e220af6 | 185 | /** |
AnnaBridge | 146:22da6e220af6 | 186 | * @brief Function for uninitializing the ADC. |
AnnaBridge | 146:22da6e220af6 | 187 | * |
AnnaBridge | 146:22da6e220af6 | 188 | * This function stops all ongoing conversions and disables all channels. |
AnnaBridge | 146:22da6e220af6 | 189 | */ |
AnnaBridge | 146:22da6e220af6 | 190 | void nrf_drv_adc_uninit(void); |
AnnaBridge | 146:22da6e220af6 | 191 | |
AnnaBridge | 146:22da6e220af6 | 192 | /** |
AnnaBridge | 146:22da6e220af6 | 193 | * @brief Function for enabling an ADC channel. |
AnnaBridge | 146:22da6e220af6 | 194 | * |
AnnaBridge | 146:22da6e220af6 | 195 | * This function configures and enables the channel. When @ref nrf_drv_adc_buffer_convert is |
AnnaBridge | 146:22da6e220af6 | 196 | * called, all channels that have been enabled with this function are sampled. |
AnnaBridge | 146:22da6e220af6 | 197 | * |
AnnaBridge | 146:22da6e220af6 | 198 | * @note The channel instance variable @p p_channel is used by the driver as an item |
AnnaBridge | 146:22da6e220af6 | 199 | * in a list. Therefore, it cannot be an automatic variable, and an assertion fails if it is |
AnnaBridge | 146:22da6e220af6 | 200 | * an automatic variable (if asserts are enabled). |
AnnaBridge | 146:22da6e220af6 | 201 | */ |
AnnaBridge | 146:22da6e220af6 | 202 | void nrf_drv_adc_channel_enable(nrf_drv_adc_channel_t * const p_channel); |
AnnaBridge | 146:22da6e220af6 | 203 | |
AnnaBridge | 146:22da6e220af6 | 204 | /** |
AnnaBridge | 146:22da6e220af6 | 205 | * @brief Function for disabling an ADC channel. |
AnnaBridge | 146:22da6e220af6 | 206 | */ |
AnnaBridge | 146:22da6e220af6 | 207 | void nrf_drv_adc_channel_disable(nrf_drv_adc_channel_t * const p_channel); |
AnnaBridge | 146:22da6e220af6 | 208 | |
AnnaBridge | 146:22da6e220af6 | 209 | /** |
AnnaBridge | 146:22da6e220af6 | 210 | * @brief Function for starting ADC sampling. |
AnnaBridge | 146:22da6e220af6 | 211 | * |
AnnaBridge | 146:22da6e220af6 | 212 | * This function triggers single ADC sampling. If more than one channel is enabled, the driver |
AnnaBridge | 146:22da6e220af6 | 213 | * emulates scanning and all channels are sampled in the order they were enabled. |
AnnaBridge | 146:22da6e220af6 | 214 | */ |
AnnaBridge | 146:22da6e220af6 | 215 | void nrf_drv_adc_sample(void); |
AnnaBridge | 146:22da6e220af6 | 216 | |
AnnaBridge | 146:22da6e220af6 | 217 | /** |
AnnaBridge | 146:22da6e220af6 | 218 | * @brief Function for executing a single ADC conversion. |
AnnaBridge | 146:22da6e220af6 | 219 | * |
AnnaBridge | 146:22da6e220af6 | 220 | * This function selects the desired input and starts a single conversion. If a valid pointer |
AnnaBridge | 146:22da6e220af6 | 221 | * is provided for the result, the function blocks until the conversion is completed. Otherwise, the |
AnnaBridge | 146:22da6e220af6 | 222 | * function returns when the conversion is started, and the result is provided in an event (driver |
AnnaBridge | 146:22da6e220af6 | 223 | * must be initialized in non-blocking mode otherwise an assertion will fail). The function will fail if |
AnnaBridge | 146:22da6e220af6 | 224 | * ADC is busy. The channel does not need to be enabled to perform a single conversion. |
AnnaBridge | 146:22da6e220af6 | 225 | * |
AnnaBridge | 146:22da6e220af6 | 226 | * @param[in] p_channel Channel. |
AnnaBridge | 146:22da6e220af6 | 227 | * @param[out] p_value Pointer to the location where the result should be placed. Unless NULL is |
AnnaBridge | 146:22da6e220af6 | 228 | * provided, the function is blocking. |
AnnaBridge | 146:22da6e220af6 | 229 | * |
AnnaBridge | 146:22da6e220af6 | 230 | * @retval NRF_SUCCESS If conversion was successful. |
AnnaBridge | 146:22da6e220af6 | 231 | * @retval NRF_ERROR_BUSY If the ADC driver is busy. |
AnnaBridge | 146:22da6e220af6 | 232 | */ |
AnnaBridge | 146:22da6e220af6 | 233 | ret_code_t nrf_drv_adc_sample_convert(nrf_drv_adc_channel_t const * const p_channel, |
AnnaBridge | 146:22da6e220af6 | 234 | nrf_adc_value_t * p_value); |
AnnaBridge | 146:22da6e220af6 | 235 | |
AnnaBridge | 146:22da6e220af6 | 236 | /** |
AnnaBridge | 146:22da6e220af6 | 237 | * @brief Function for converting data to the buffer. |
AnnaBridge | 146:22da6e220af6 | 238 | * |
AnnaBridge | 146:22da6e220af6 | 239 | * If the driver is initialized in non-blocking mode, this function returns when the first conversion |
AnnaBridge | 146:22da6e220af6 | 240 | * is set up. When the buffer is filled, the application is notified by the event handler. If the |
AnnaBridge | 146:22da6e220af6 | 241 | * driver is initialized in blocking mode, the function returns when the buffer is filled. |
AnnaBridge | 146:22da6e220af6 | 242 | * |
AnnaBridge | 146:22da6e220af6 | 243 | * Conversion is done on all enabled channels, but it is not triggered by this |
AnnaBridge | 146:22da6e220af6 | 244 | * function. This function will prepare the ADC for sampling and then |
AnnaBridge | 146:22da6e220af6 | 245 | * wait for the SAMPLE task. Sampling can be triggered manually by the @ref |
AnnaBridge | 146:22da6e220af6 | 246 | * nrf_drv_adc_sample function or by PPI using the @ref NRF_ADC_TASK_START task. |
AnnaBridge | 146:22da6e220af6 | 247 | * |
AnnaBridge | 146:22da6e220af6 | 248 | * @note If more than one channel is enabled, the function emulates scanning, and |
AnnaBridge | 146:22da6e220af6 | 249 | * a single START task will trigger conversion on all enabled channels. For example: |
AnnaBridge | 146:22da6e220af6 | 250 | * If 3 channels are enabled and the user requests 6 samples, the completion event |
AnnaBridge | 146:22da6e220af6 | 251 | * handler will be called after 2 START tasks. |
AnnaBridge | 146:22da6e220af6 | 252 | * @note The application must adjust the sampling frequency. The maximum frequency |
AnnaBridge | 146:22da6e220af6 | 253 | * depends on the sampling timer and the maximum latency of the ADC interrupt. If |
AnnaBridge | 146:22da6e220af6 | 254 | * an interrupt is not handled before the next sampling is triggered, the sample |
AnnaBridge | 146:22da6e220af6 | 255 | * will be lost. |
AnnaBridge | 146:22da6e220af6 | 256 | * |
AnnaBridge | 146:22da6e220af6 | 257 | * @param[in] buffer Result buffer. |
AnnaBridge | 146:22da6e220af6 | 258 | * @param[in] size Buffer size in samples. |
AnnaBridge | 146:22da6e220af6 | 259 | * |
AnnaBridge | 146:22da6e220af6 | 260 | * @retval NRF_SUCCESS If conversion was successful. |
AnnaBridge | 146:22da6e220af6 | 261 | * @retval NRF_ERROR_BUSY If the driver is busy. |
AnnaBridge | 146:22da6e220af6 | 262 | */ |
AnnaBridge | 146:22da6e220af6 | 263 | ret_code_t nrf_drv_adc_buffer_convert(nrf_adc_value_t * buffer, uint16_t size); |
AnnaBridge | 146:22da6e220af6 | 264 | |
AnnaBridge | 146:22da6e220af6 | 265 | /** |
AnnaBridge | 146:22da6e220af6 | 266 | * @brief Function for retrieving the ADC state. |
AnnaBridge | 146:22da6e220af6 | 267 | * |
AnnaBridge | 146:22da6e220af6 | 268 | * @retval true If the ADC is busy. |
AnnaBridge | 146:22da6e220af6 | 269 | * @retval false If the ADC is ready. |
AnnaBridge | 146:22da6e220af6 | 270 | */ |
AnnaBridge | 146:22da6e220af6 | 271 | bool nrf_drv_adc_is_busy(void); |
AnnaBridge | 146:22da6e220af6 | 272 | |
AnnaBridge | 146:22da6e220af6 | 273 | /** |
AnnaBridge | 146:22da6e220af6 | 274 | * @brief Function for getting the address of the ADC START task. |
AnnaBridge | 146:22da6e220af6 | 275 | * |
AnnaBridge | 146:22da6e220af6 | 276 | * This function is used to get the address of the START task, which can be used to trigger ADC |
AnnaBridge | 146:22da6e220af6 | 277 | * conversion. |
AnnaBridge | 146:22da6e220af6 | 278 | * |
AnnaBridge | 146:22da6e220af6 | 279 | * @return Start task address. |
AnnaBridge | 146:22da6e220af6 | 280 | */ |
AnnaBridge | 146:22da6e220af6 | 281 | __STATIC_INLINE uint32_t nrf_drv_adc_start_task_get(void); |
AnnaBridge | 146:22da6e220af6 | 282 | |
AnnaBridge | 146:22da6e220af6 | 283 | /** |
AnnaBridge | 146:22da6e220af6 | 284 | * @brief Function for converting a GPIO pin number to an analog input pin mask to be used in |
AnnaBridge | 146:22da6e220af6 | 285 | * the ADC channel configuration. |
AnnaBridge | 146:22da6e220af6 | 286 | * |
AnnaBridge | 146:22da6e220af6 | 287 | * @param[in] pin GPIO pin. |
AnnaBridge | 146:22da6e220af6 | 288 | * |
AnnaBridge | 146:22da6e220af6 | 289 | * @return Analog input pin mask. The function returns @ref NRF_ADC_CONFIG_INPUT_DISABLED |
AnnaBridge | 146:22da6e220af6 | 290 | * if the specified pin is not an analog input. |
AnnaBridge | 146:22da6e220af6 | 291 | */ |
AnnaBridge | 146:22da6e220af6 | 292 | __STATIC_INLINE nrf_adc_config_input_t nrf_drv_adc_gpio_to_ain(uint32_t pin); |
AnnaBridge | 146:22da6e220af6 | 293 | |
AnnaBridge | 146:22da6e220af6 | 294 | #ifndef SUPPRESS_INLINE_IMPLEMENTATION |
AnnaBridge | 146:22da6e220af6 | 295 | |
AnnaBridge | 146:22da6e220af6 | 296 | __STATIC_INLINE uint32_t nrf_drv_adc_start_task_get(void) |
AnnaBridge | 146:22da6e220af6 | 297 | { |
AnnaBridge | 146:22da6e220af6 | 298 | return nrf_adc_task_address_get(NRF_ADC_TASK_START); |
AnnaBridge | 146:22da6e220af6 | 299 | } |
AnnaBridge | 146:22da6e220af6 | 300 | |
AnnaBridge | 146:22da6e220af6 | 301 | __STATIC_INLINE nrf_adc_config_input_t nrf_drv_adc_gpio_to_ain(uint32_t pin) |
AnnaBridge | 146:22da6e220af6 | 302 | { |
AnnaBridge | 146:22da6e220af6 | 303 | // AIN2 - AIN7 |
AnnaBridge | 146:22da6e220af6 | 304 | if (pin >= 1 && pin <= 6) |
AnnaBridge | 146:22da6e220af6 | 305 | { |
AnnaBridge | 146:22da6e220af6 | 306 | return (nrf_adc_config_input_t)(1 << (pin+1)); |
AnnaBridge | 146:22da6e220af6 | 307 | } |
AnnaBridge | 146:22da6e220af6 | 308 | // AIN0 - AIN1 |
AnnaBridge | 146:22da6e220af6 | 309 | else if (pin >= 26 && pin <= 27) |
AnnaBridge | 146:22da6e220af6 | 310 | { |
AnnaBridge | 146:22da6e220af6 | 311 | return (nrf_adc_config_input_t)(1 <<(pin - 26)); |
AnnaBridge | 146:22da6e220af6 | 312 | } |
AnnaBridge | 146:22da6e220af6 | 313 | else |
AnnaBridge | 146:22da6e220af6 | 314 | { |
AnnaBridge | 146:22da6e220af6 | 315 | return NRF_ADC_CONFIG_INPUT_DISABLED; |
AnnaBridge | 146:22da6e220af6 | 316 | } |
AnnaBridge | 146:22da6e220af6 | 317 | } |
AnnaBridge | 146:22da6e220af6 | 318 | |
AnnaBridge | 146:22da6e220af6 | 319 | #ifdef __cplusplus |
AnnaBridge | 146:22da6e220af6 | 320 | } |
AnnaBridge | 146:22da6e220af6 | 321 | #endif |
AnnaBridge | 146:22da6e220af6 | 322 | |
AnnaBridge | 146:22da6e220af6 | 323 | #endif |
AnnaBridge | 146:22da6e220af6 | 324 | /** @} */ |