espressif/ESP8266_RTOS_SDK
1
0
Fork 0
mirror of https://github.com/espressif/ESP8266_RTOS_SDK.git synced 2025-07-15 08:32:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

feature(adc): add adc example

Browse Source
This commit is contained in:
XiongYu
2019-03-22 13:49:26 +08:00
parent 2105cf040a
commit cdc22f273c
9 changed files with 328 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
components/esp8266/Kconfig
View File

@ -444,5 +444,16 @@ config ESP_PHY_INIT_DATA_IN_PARTITION
If unsure, choose 'n'.
config ESP_PHY_INIT_DATA_VDD33_CONST
int "vdd33_const value"
range 0 255
default 33
help
vdd33_const provides ADC mode settings, i.e. selecting system voltage or external voltage measurements.
When measuring system voltage, it must be set to 255.
To read the external voltage on TOUT(ADC) pin, vdd33_const need less than 255
When the ADC reference voltage is set to the actual VDD33 power supply voltage, the value range of vdd33_const is [18,36], the unit is 0.1V.
When the ADC reference voltage is set to the default value of 3.3V as the supply voltage, the range of vdd33_const is [0, 18] or (36, 255).
endmenu # PHY

123
components/esp8266/driver/adc.c
View File

@ -12,19 +12,19 @@
// See the License for the specific language governing permissions and
// limitations under the License.
#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include "esp_attr.h"
#include "esp_err.h"
#include "esp_log.h"
#include "esp_phy_init.h"
#include "esp_heap_caps.h"
#include "driver/adc.h"
#define ENTER_CRITICAL() portENTER_CRITICAL()
#define EXIT_CRITICAL() portEXIT_CRITICAL()
static const char *TAG = "adc";
#define ADC_CHECK(a, str, ret_val) \
if (!(a)) { \
@ -36,19 +36,112 @@ extern uint16_t test_tout();
extern void phy_adc_read_fast(uint16_t *adc_addr, uint16_t adc_num, uint8_t adc_clk_div);
extern uint16_t phy_get_vdd33();
uint16_t adc_read()
typedef struct {
adc_config_t config;
SemaphoreHandle_t adc_mux;
} adc_handle_t;
adc_handle_t *adc_handle = NULL;
esp_err_t adc_read(uint16_t *data)
{
uint16_t ret = test_tout(0);
ADC_CHECK(data, "parameter pointer is empty", ESP_ERR_INVALID_ARG);
ADC_CHECK(adc_handle, "ADC has not been initialized yet.", ESP_FAIL);
uint16_t ret = 0;
xSemaphoreTake(adc_handle->adc_mux, portMAX_DELAY);
if (ret != 0xFFFF) {
// The working voltage of ADC is designed according to 1.1v. Later, the actual working voltage of ADC is increased to 1.2v, so this scale is added.
ret = ret * 12 / 11;
if (adc_handle->config.mode == ADC_READ_TOUT_MODE) {
ret = test_tout(0);
if (ret > 1023) {
// 10-bit precision ADC
ret = 1023;
if (ret != 0xFFFF) {
// The working voltage of ADC is designed according to 1.1v. Later, the actual working voltage of ADC is increased to 1.2v, so this scale is added.
ret = ret * 12 / 11;
if (ret > 1023) {
// 10-bit precision ADC
ret = 1023;
}
}
} else if (adc_handle->config.mode == ADC_READ_VDD_MODE) {
ret = phy_get_vdd33();
if (ret != 0xFFFF) {
// The working voltage of ADC is designed according to 1.1v. Later, the actual working voltage of ADC is increased to 1.2v, so this scale is added.
ret = ret * 12 / 11;
}
}
return ret;
*data = ret;
xSemaphoreGive(adc_handle->adc_mux);
return ESP_OK;
}
esp_err_t adc_read_fast(uint16_t *data, uint16_t len)
{
ADC_CHECK(data && len > 0, "parameter pointer is empty", ESP_ERR_INVALID_ARG);
ADC_CHECK(adc_handle, "ADC has not been initialized yet.", ESP_FAIL);
ADC_CHECK(adc_handle->config.mode == ADC_READ_TOUT_MODE, "adc_read_fast can only be used in ADC_READ_TOUT_MODE mode", ESP_ERR_INVALID_ARG);
ADC_CHECK(adc_handle->config.clk_div >= 8 && adc_handle->config.clk_div <= 32, "ADC sample collection clock=80M/clk_div, range[8, 32]", ESP_FAIL);
uint16_t i;
uint16_t ret;
xSemaphoreTake(adc_handle->adc_mux, portMAX_DELAY);
phy_adc_read_fast(data, len, adc_handle->config.clk_div);
for (i = 0; i < len; i++) {
ret = data[i];
if (ret != 0xFFFF) {
// The working voltage of ADC is designed according to 1.1v. Later, the actual working voltage of ADC is increased to 1.2v, so this scale is added.
ret = ret * 12 / 11;
if (ret > 1023) {
// 10-bit precision ADC
ret = 1023;
}
}
data[i] = ret;
}
xSemaphoreGive(adc_handle->adc_mux);
return ESP_OK;
}
esp_err_t adc_deinit()
{
ADC_CHECK(adc_handle, "ADC has not been initialized yet.", ESP_FAIL);
if (adc_handle->adc_mux) {
vSemaphoreDelete(adc_handle->adc_mux);
}
heap_caps_free(adc_handle);
adc_handle = NULL;
return ESP_OK;
}
esp_err_t adc_init(adc_config_t *config)
{
ADC_CHECK(config, "config error", ESP_ERR_INVALID_ARG);
ADC_CHECK(NULL == adc_handle, "adc has been initialized", ESP_FAIL);
uint8_t vdd33_const;
esp_phy_init_data_t *phy_init_data;
phy_init_data = (esp_phy_init_data_t *)esp_phy_get_init_data();
vdd33_const = phy_init_data->params[107];
ADC_CHECK((config->mode == ADC_READ_TOUT_MODE) ? (vdd33_const <= 255) : true, "To read the external voltage on TOUT(ADC) pin, vdd33_const need less than 255", ESP_FAIL);
ADC_CHECK((config->mode == ADC_READ_VDD_MODE) ? (vdd33_const == 255) : true, "When adc measuring system voltage, vdd33_const must be set to 255,", ESP_FAIL);
adc_handle = heap_caps_malloc(sizeof(adc_handle_t), MALLOC_CAP_8BIT);
ADC_CHECK(adc_handle, "adc handle malloc error", ESP_ERR_NO_MEM);
memcpy(&adc_handle->config, config, sizeof(adc_config_t));
adc_handle->adc_mux = xSemaphoreCreateMutex();
if (NULL == adc_handle->adc_mux) {
adc_deinit();
ADC_CHECK(false, "Semaphore create fail", ESP_ERR_NO_MEM);
}
return ESP_OK;
}

72
components/esp8266/include/driver/adc.h
View File

@ -21,13 +21,79 @@
extern "C" {
#endif
/**
* @brief ADC working mode enumeration
*/
typedef enum {
ADC_READ_TOUT_MODE,
ADC_READ_VDD_MODE
} adc_mode_t;
/**
* @brief Measure the input voltage of TOUT pin 6, unit : 1/1023 V.
* @brief ADC initialization parameter structure type definition
*/
typedef struct {
adc_mode_t mode;
uint8_t clk_div; // ADC sample collection clock=80M/clk_div, range[8, 32]
} adc_config_t;
/**
* @brief Single measurement of TOUT(ADC) pin, unit : 1/1023 V or VDD pin, uint: 1 mV
*
* @return Input voltage of TOUT pin 6, unit : 1/1023 V
* @note When measuring VDD pin voltage, the TOUT(ADC) pin must be left floating.
*
* @param data Pointer to accept adc value.
*
* @return
* - ESP_OK Success
* - ESP_ERR_INVALID_ARG Parameter error
* - ESP_FAIL adc has not been initialized yet
*/
uint16_t adc_read();
esp_err_t adc_read(uint16_t *data);
/**
* @brief Measure the input voltage of TOUT(ADC) pin, unit : 1/1023 V.
*
* @note Wi-Fi and interrupts need to be turned off.
*
* @param data Pointer to accept adc value. Input voltage of TOUT(ADC) pin, unit : 1/1023 V
* @param len Receiving length of ADC value, range [1, 65535]
*
* @return
* - ESP_OK Success
* - ESP_ERR_INVALID_ARG Parameter error
* - ESP_FAIL adc has not been initialized yet
*/
esp_err_t adc_read_fast(uint16_t *data, uint16_t len);
/**
* @brief Deinit the adc
*
* @return
* - ESP_OK Success
* - ESP_FAIL adc has not been initialized yet
*/
esp_err_t adc_deinit();
/**
* @brief Initialize the adc
*
* @note First modify menuconfig->Component config->PHY->vdd33_const value, vdd33_const provides ADC mode settings,
* i.e. selecting system voltage or external voltage measurements.
* When measuring system voltage, it must be set to 255.
* To read the external voltage on TOUT(ADC) pin, vdd33_const need less than 255
* When the ADC reference voltage is set to the actual VDD33 power supply voltage, the value range of vdd33_const is [18,36], the unit is 0.1V.
* When the ADC reference voltage is set to the default value of 3.3V as the supply voltage, the range of vdd33_const is [0, 18] or (36, 255).
*
* @param config Pointer to deliver initialize configuration parameter
*
* @return
* - ESP_OK Success
* - ESP_ERR_NO_MEM malloc fail
* - ESP_ERR_INVALID_ARG Parameter error
* - ESP_FAIL adc has been initialized
*/
esp_err_t adc_init(adc_config_t *config);
#ifdef __cplusplus
}

4
components/esp8266/source/phy_init_data.h
View File

@ -132,7 +132,11 @@ static const esp_phy_init_data_t phy_init_data= { {
0x00,
0x00,
0x00,
#ifdef CONFIG_ESP_PHY_INIT_DATA_VDD33_CONST
CONFIG_ESP_PHY_INIT_DATA_VDD33_CONST,
#else
0x00,
#endif
0x00,
0x00,
0x00,