mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
318 lines
12 KiB
C
318 lines
12 KiB
C
// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#pragma once
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include "esp_err.h"
|
|
#include "driver/gpio.h"
|
|
#include "hal/adc_types.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**** `adc1_channel_t` will be deprecated functions, combine into `adc_channel_t` ********/
|
|
typedef enum {
|
|
ADC1_CHANNEL_0 = 0, /*!< ADC1 channel 0 is GPIO36 (ESP32), GPIO1 (ESP32-S2) */
|
|
ADC1_CHANNEL_1, /*!< ADC1 channel 1 is GPIO37 (ESP32), GPIO2 (ESP32-S2) */
|
|
ADC1_CHANNEL_2, /*!< ADC1 channel 2 is GPIO38 (ESP32), GPIO3 (ESP32-S2) */
|
|
ADC1_CHANNEL_3, /*!< ADC1 channel 3 is GPIO39 (ESP32), GPIO4 (ESP32-S2) */
|
|
ADC1_CHANNEL_4, /*!< ADC1 channel 4 is GPIO32 (ESP32), GPIO5 (ESP32-S2) */
|
|
ADC1_CHANNEL_5, /*!< ADC1 channel 5 is GPIO33 (ESP32), GPIO6 (ESP32-S2) */
|
|
ADC1_CHANNEL_6, /*!< ADC1 channel 6 is GPIO34 (ESP32), GPIO7 (ESP32-S2) */
|
|
ADC1_CHANNEL_7, /*!< ADC1 channel 7 is GPIO35 (ESP32), GPIO8 (ESP32-S2) */
|
|
#if CONFIG_IDF_TARGET_ESP32
|
|
ADC1_CHANNEL_MAX,
|
|
#elif CONFIG_IDF_TARGET_ESP32S2
|
|
ADC1_CHANNEL_8, /*!< ADC1 channel 6 is GPIO9 (ESP32-S2)*/
|
|
ADC1_CHANNEL_9, /*!< ADC1 channel 7 is GPIO10 (ESP32-S2) */
|
|
ADC1_CHANNEL_MAX,
|
|
#endif
|
|
} adc1_channel_t;
|
|
|
|
/**** `adc2_channel_t` will be deprecated functions, combine into `adc_channel_t` ********/
|
|
typedef enum {
|
|
ADC2_CHANNEL_0 = 0, /*!< ADC2 channel 0 is GPIO4 (ESP32), GPIO11 (ESP32-S2) */
|
|
ADC2_CHANNEL_1, /*!< ADC2 channel 1 is GPIO0 (ESP32), GPIO12 (ESP32-S2) */
|
|
ADC2_CHANNEL_2, /*!< ADC2 channel 2 is GPIO2 (ESP32), GPIO13 (ESP32-S2) */
|
|
ADC2_CHANNEL_3, /*!< ADC2 channel 3 is GPIO15 (ESP32), GPIO14 (ESP32-S2) */
|
|
ADC2_CHANNEL_4, /*!< ADC2 channel 4 is GPIO13 (ESP32), GPIO15 (ESP32-S2) */
|
|
ADC2_CHANNEL_5, /*!< ADC2 channel 5 is GPIO12 (ESP32), GPIO16 (ESP32-S2) */
|
|
ADC2_CHANNEL_6, /*!< ADC2 channel 6 is GPIO14 (ESP32), GPIO17 (ESP32-S2) */
|
|
ADC2_CHANNEL_7, /*!< ADC2 channel 7 is GPIO27 (ESP32), GPIO18 (ESP32-S2) */
|
|
ADC2_CHANNEL_8, /*!< ADC2 channel 8 is GPIO25 (ESP32), GPIO19 (ESP32-S2) */
|
|
ADC2_CHANNEL_9, /*!< ADC2 channel 9 is GPIO26 (ESP32), GPIO20 (ESP32-S2) */
|
|
ADC2_CHANNEL_MAX,
|
|
} adc2_channel_t;
|
|
|
|
/**
|
|
* @brief ADC rtc controller attenuation option.
|
|
*
|
|
* @note This definitions are only for being back-compatible
|
|
*/
|
|
#define ADC_ATTEN_0db ADC_ATTEN_DB_0
|
|
#define ADC_ATTEN_2_5db ADC_ATTEN_DB_2_5
|
|
#define ADC_ATTEN_6db ADC_ATTEN_DB_6
|
|
#define ADC_ATTEN_11db ADC_ATTEN_DB_11
|
|
//this definitions are only for being back-compatible
|
|
#define ADC_WIDTH_9Bit ADC_WIDTH_BIT_9
|
|
#define ADC_WIDTH_10Bit ADC_WIDTH_BIT_10
|
|
#define ADC_WIDTH_11Bit ADC_WIDTH_BIT_11
|
|
#define ADC_WIDTH_12Bit ADC_WIDTH_BIT_12
|
|
|
|
/**
|
|
* @brief ADC digital controller encode option.
|
|
*
|
|
* @deprecated The ESP32S2 don't use I2S DMA. Call ``adc_digi_output_format_t`` instead.
|
|
*/
|
|
typedef enum {
|
|
ADC_ENCODE_12BIT, /*!< ADC to DMA data format, , [15:12]-channel [11:0]-12 bits ADC data */
|
|
ADC_ENCODE_11BIT, /*!< ADC to DMA data format, [15]-unit, [14:11]-channel [10:0]-11 bits ADC data */
|
|
ADC_ENCODE_MAX,
|
|
} adc_i2s_encode_t;
|
|
|
|
/**
|
|
* @brief Get the GPIO number of a specific ADC1 channel.
|
|
*
|
|
* @param channel Channel to get the GPIO number
|
|
* @param gpio_num output buffer to hold the GPIO number
|
|
*
|
|
* @return
|
|
* - ESP_OK if success
|
|
* - ESP_ERR_INVALID_ARG if channel not valid
|
|
*/
|
|
esp_err_t adc1_pad_get_io_num(adc1_channel_t channel, gpio_num_t *gpio_num);
|
|
|
|
/**
|
|
* @brief Set the attenuation of a particular channel on ADC1, and configure its associated GPIO pin mux.
|
|
*
|
|
* The default ADC full-scale voltage is 1.1 V. To read higher voltages (up to the pin maximum voltage,
|
|
* usually 3.3 V) requires setting >0 dB signal attenuation for that ADC channel.
|
|
*
|
|
* When VDD_A is 3.3 V:
|
|
*
|
|
* - 0 dB attenuation (ADC_ATTEN_DB_0) gives full-scale voltage 1.1 V
|
|
* - 2.5 dB attenuation (ADC_ATTEN_DB_2_5) gives full-scale voltage 1.5 V
|
|
* - 6 dB attenuation (ADC_ATTEN_DB_6) gives full-scale voltage 2.2 V
|
|
* - 11 dB attenuation (ADC_ATTEN_DB_11) gives full-scale voltage 3.9 V (see note below)
|
|
*
|
|
* @note The full-scale voltage is the voltage corresponding to a maximum reading (depending on ADC1 configured bit width,
|
|
* this value in ESP32 is: 4095 for 12-bits, 2047 for 11-bits, 1023 for 10-bits, 511 for 9 bits.
|
|
* this value in ESP32S2 is: 8191 for 13-bits.)
|
|
*
|
|
* @note At 11 dB attenuation the maximum voltage is limited by VDD_A, not the full scale voltage.
|
|
*
|
|
* @note For ESP32:
|
|
* Due to ADC characteristics, most accurate results are obtained within the following approximate voltage ranges:
|
|
*
|
|
* - 0 dB attenuation (ADC_ATTEN_DB_0) between 100 and 950 mV
|
|
* - 2.5 dB attenuation (ADC_ATTEN_DB_2_5) between 100 and 1250 mV
|
|
* - 6 dB attenuation (ADC_ATTEN_DB_6) between 150 to 1750 mV
|
|
* - 11 dB attenuation (ADC_ATTEN_DB_11) between 150 to 2450 mV
|
|
*
|
|
* For maximum accuracy, use the ADC calibration APIs and measure voltages within these recommended ranges.
|
|
*
|
|
* @note For any given channel, this function must be called before the first time ``adc1_get_raw()`` is called for that channel.
|
|
*
|
|
* @note This function can be called multiple times to configure multiple
|
|
* ADC channels simultaneously. ``adc1_get_raw()`` can then be called for any configured channel.
|
|
*
|
|
* @param channel ADC1 channel to configure
|
|
* @param atten Attenuation level
|
|
*
|
|
* @return
|
|
* - ESP_OK success
|
|
* - ESP_ERR_INVALID_ARG Parameter error
|
|
*/
|
|
esp_err_t adc1_config_channel_atten(adc1_channel_t channel, adc_atten_t atten);
|
|
|
|
/**
|
|
* @brief Configure ADC1 capture width, meanwhile enable output invert for ADC1.
|
|
* The configuration is for all channels of ADC1
|
|
* @param width_bit Bit capture width for ADC1
|
|
*
|
|
* @return
|
|
* - ESP_OK success
|
|
* - ESP_ERR_INVALID_ARG Parameter error
|
|
*/
|
|
esp_err_t adc1_config_width(adc_bits_width_t width_bit);
|
|
|
|
/**
|
|
* @brief Take an ADC1 reading from a single channel.
|
|
* @note ESP32:
|
|
* When the power switch of SARADC1, SARADC2, HALL sensor and AMP sensor is turned on,
|
|
* the input of GPIO36 and GPIO39 will be pulled down for about 80ns.
|
|
* When enabling power for any of these peripherals, ignore input from GPIO36 and GPIO39.
|
|
* Please refer to section 3.11 of 'ECO_and_Workarounds_for_Bugs_in_ESP32' for the description of this issue.
|
|
*
|
|
* @note Call ``adc1_config_width()`` before the first time this
|
|
* function is called.
|
|
*
|
|
* @note For any given channel, adc1_config_channel_atten(channel)
|
|
* must be called before the first time this function is called. Configuring
|
|
* a new channel does not prevent a previously configured channel from being read.
|
|
*
|
|
* @param channel ADC1 channel to read
|
|
*
|
|
* @return
|
|
* - -1: Parameter error
|
|
* - Other: ADC1 channel reading.
|
|
*/
|
|
int adc1_get_raw(adc1_channel_t channel);
|
|
|
|
/**
|
|
* @brief Enable ADC power
|
|
*/
|
|
void adc_power_on(void);
|
|
|
|
/**
|
|
* @brief Power off SAR ADC
|
|
* This function will force power down for ADC
|
|
*/
|
|
void adc_power_off(void);
|
|
|
|
/**
|
|
* @brief Initialize ADC pad
|
|
* @param adc_unit ADC unit index
|
|
* @param channel ADC channel index
|
|
* @return
|
|
* - ESP_OK success
|
|
* - ESP_ERR_INVALID_ARG Parameter error
|
|
*/
|
|
esp_err_t adc_gpio_init(adc_unit_t adc_unit, adc_channel_t channel);
|
|
|
|
/**
|
|
* @brief Set ADC data invert
|
|
* @param adc_unit ADC unit index
|
|
* @param inv_en whether enable data invert
|
|
* @return
|
|
* - ESP_OK success
|
|
* - ESP_ERR_INVALID_ARG Parameter error
|
|
*/
|
|
esp_err_t adc_set_data_inv(adc_unit_t adc_unit, bool inv_en);
|
|
|
|
/**
|
|
* @brief Set ADC source clock
|
|
* @param clk_div ADC clock divider, ADC clock is divided from APB clock
|
|
* @return
|
|
* - ESP_OK success
|
|
*/
|
|
esp_err_t adc_set_clk_div(uint8_t clk_div);
|
|
|
|
/**
|
|
* @brief Configure ADC capture width.
|
|
*
|
|
* @note For ESP32S2, only support ``ADC_WIDTH_BIT_13``.
|
|
*
|
|
* @param adc_unit ADC unit index
|
|
* @param width_bit Bit capture width for ADC unit. For ESP32S2, only support ``ADC_WIDTH_BIT_13``.
|
|
*
|
|
* @return
|
|
* - ESP_OK success
|
|
* - ESP_ERR_INVALID_ARG Parameter error
|
|
*/
|
|
esp_err_t adc_set_data_width(adc_unit_t adc_unit, adc_bits_width_t width_bit);
|
|
|
|
/**
|
|
* @brief Configure ADC1 to be usable by the ULP
|
|
*
|
|
* This function reconfigures ADC1 to be controlled by the ULP.
|
|
* Effect of this function can be reverted using ``adc1_get_raw()`` function.
|
|
*
|
|
* Note that adc1_config_channel_atten, ``adc1_config_width()`` functions need
|
|
* to be called to configure ADC1 channels, before ADC1 is used by the ULP.
|
|
*/
|
|
void adc1_ulp_enable(void);
|
|
|
|
/**
|
|
* @brief Get the GPIO number of a specific ADC2 channel.
|
|
*
|
|
* @param channel Channel to get the GPIO number
|
|
*
|
|
* @param gpio_num output buffer to hold the GPIO number
|
|
*
|
|
* @return
|
|
* - ESP_OK if success
|
|
* - ESP_ERR_INVALID_ARG if channel not valid
|
|
*/
|
|
esp_err_t adc2_pad_get_io_num(adc2_channel_t channel, gpio_num_t *gpio_num);
|
|
|
|
/**
|
|
* @brief Configure the ADC2 channel, including setting attenuation.
|
|
*
|
|
* The default ADC full-scale voltage is 1.1 V. To read higher voltages (up to the pin maximum voltage,
|
|
* usually 3.3 V) requires setting >0 dB signal attenuation for that ADC channel.
|
|
*
|
|
* When VDD_A is 3.3 V:
|
|
*
|
|
* - 0 dB attenuation (ADC_ATTEN_0db) gives full-scale voltage 1.1 V
|
|
* - 2.5 dB attenuation (ADC_ATTEN_2_5db) gives full-scale voltage 1.5 V
|
|
* - 6 dB attenuation (ADC_ATTEN_6db) gives full-scale voltage 2.2 V
|
|
* - 11 dB attenuation (ADC_ATTEN_11db) gives full-scale voltage 3.9 V (see note below)
|
|
*
|
|
* @note This function also configures the input GPIO pin mux to
|
|
* connect it to the ADC2 channel. It must be called before calling
|
|
* ``adc2_get_raw()`` for this channel.
|
|
*
|
|
* @note The full-scale voltage is the voltage corresponding to a maximum reading
|
|
* (depending on ADC2 configured bit width,
|
|
* this value of ESP32 is: 4095 for 12-bits, 2047 for 11-bits, 1023 for 10-bits, 511 for 9 bits.
|
|
* this value of ESP32S2 is: 8191 for 13-bits.)
|
|
*
|
|
* @note At 11 dB attenuation the maximum voltage is limited by VDD_A, not the full scale voltage.
|
|
*
|
|
* @param channel ADC2 channel to configure
|
|
* @param atten Attenuation level
|
|
*
|
|
* @return
|
|
* - ESP_OK success
|
|
* - ESP_ERR_INVALID_ARG Parameter error
|
|
*/
|
|
esp_err_t adc2_config_channel_atten(adc2_channel_t channel, adc_atten_t atten);
|
|
|
|
/**
|
|
* @brief Take an ADC2 reading on a single channel
|
|
*
|
|
* @note ESP32:
|
|
* When the power switch of SARADC1, SARADC2, HALL sensor and AMP sensor is turned on,
|
|
* the input of GPIO36 and GPIO39 will be pulled down for about 80ns.
|
|
* When enabling power for any of these peripherals, ignore input from GPIO36 and GPIO39.
|
|
* Please refer to section 3.11 of 'ECO_and_Workarounds_for_Bugs_in_ESP32' for the description of this issue.
|
|
*
|
|
* @note ESP32:
|
|
* For a given channel, ``adc2_config_channel_atten()``
|
|
* must be called before the first time this function is called. If Wi-Fi is started via ``esp_wifi_start()``, this
|
|
* function will always fail with ``ESP_ERR_TIMEOUT``.
|
|
*
|
|
* @note ESP32S2:
|
|
* ADC2 support hardware arbiter. The arbiter is to improve the use efficiency of ADC2. After the control right is robbed by the high priority,
|
|
* the low priority controller will read the invalid ADC2 data. Default priority: Wi-Fi > RTC > Digital;
|
|
*
|
|
* @param channel ADC2 channel to read
|
|
* @param width_bit Bit capture width for ADC2. For ESP32S2, only support ``ADC_WIDTH_BIT_13``.
|
|
* @param raw_out the variable to hold the output data.
|
|
*
|
|
* @return
|
|
* - ESP_OK if success
|
|
* - ESP_ERR_TIMEOUT ADC2 is being used by other controller and the request timed out.
|
|
* - ESP_ERR_INVALID_STATE The controller status is invalid. Please try again.
|
|
*/
|
|
esp_err_t adc2_get_raw(adc2_channel_t channel, adc_bits_width_t width_bit, int *raw_out);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|