mirror of
				https://github.com/espressif/esp-idf.git
				synced 2025-10-31 21:14:37 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			368 lines
		
	
	
		
			14 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			368 lines
		
	
	
		
			14 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /*
 | |
|  * SPDX-FileCopyrightText: 2019-2024 Espressif Systems (Shanghai) CO LTD
 | |
|  *
 | |
|  * SPDX-License-Identifier: Apache-2.0
 | |
|  */
 | |
| 
 | |
| #include <sys/param.h>
 | |
| #include "sdkconfig.h"
 | |
| #include "hal/adc_hal.h"
 | |
| #include "hal/assert.h"
 | |
| #include "soc/lldesc.h"
 | |
| #include "soc/soc_caps.h"
 | |
| 
 | |
| #if CONFIG_IDF_TARGET_ESP32
 | |
| //ADC utilises I2S0 DMA on ESP32
 | |
| #include "hal/i2s_hal.h"
 | |
| #include "hal/i2s_types.h"
 | |
| #include "soc/i2s_struct.h"
 | |
| #endif
 | |
| 
 | |
| #if CONFIG_IDF_TARGET_ESP32S2
 | |
| //ADC utilises SPI3 DMA on ESP32S2
 | |
| #include "hal/spi_ll.h"
 | |
| #include "soc/spi_struct.h"
 | |
| #endif
 | |
| 
 | |
| /*---------------------------------------------------------------
 | |
|             Define all ADC DMA required operations here
 | |
| ---------------------------------------------------------------*/
 | |
| #if SOC_GDMA_SUPPORTED
 | |
| #define adc_dma_ll_rx_clear_intr(dev, chan, mask)       gdma_ll_rx_clear_interrupt_status(dev, chan, mask)
 | |
| #define adc_dma_ll_rx_enable_intr(dev, chan, mask)      gdma_ll_rx_enable_interrupt(dev, chan, mask, true)
 | |
| #define adc_dma_ll_rx_disable_intr(dev, chan, mask)     gdma_ll_rx_enable_interrupt(dev, chan, mask, false)
 | |
| #define adc_dma_ll_rx_reset_channel(dev, chan)          gdma_ll_rx_reset_channel(dev, chan)
 | |
| #define adc_dma_ll_rx_stop(dev, chan)                   gdma_ll_rx_stop(dev, chan)
 | |
| #define adc_dma_ll_rx_start(dev, chan, addr) do { \
 | |
|             gdma_ll_rx_set_desc_addr(dev, chan, (uint32_t)addr); \
 | |
|             gdma_ll_rx_start(dev, chan); \
 | |
|         } while (0)
 | |
| #define adc_ll_digi_dma_set_eof_num(dev, num)           adc_ll_digi_dma_set_eof_num(num)
 | |
| #define adc_ll_digi_reset(dev)                          adc_ll_digi_reset()
 | |
| #define adc_ll_digi_trigger_enable(dev)                 adc_ll_digi_trigger_enable()
 | |
| #define adc_ll_digi_trigger_disable(dev)                adc_ll_digi_trigger_disable()
 | |
| 
 | |
| //ADC utilises SPI3 DMA on ESP32S2
 | |
| #elif CONFIG_IDF_TARGET_ESP32S2
 | |
| #define adc_dma_ll_rx_get_intr(dev, mask)               spi_ll_get_intr(dev, mask)
 | |
| #define adc_dma_ll_rx_clear_intr(dev, chan, mask)       spi_ll_clear_intr(dev, mask)
 | |
| #define adc_dma_ll_rx_enable_intr(dev, chan, mask)      spi_ll_enable_intr(dev, mask)
 | |
| #define adc_dma_ll_rx_disable_intr(dev, chan, mask)     spi_ll_disable_intr(dev, mask)
 | |
| #define adc_dma_ll_rx_reset_channel(dev, chan)          spi_dma_ll_rx_reset(dev, chan)
 | |
| #define adc_dma_ll_rx_stop(dev, chan)                   spi_dma_ll_rx_stop(dev, chan)
 | |
| #define adc_dma_ll_rx_start(dev, chan, addr)            spi_dma_ll_rx_start(dev, chan, addr)
 | |
| #define adc_dma_ll_get_in_suc_eof_desc_addr(dev, chan)  spi_dma_ll_get_in_suc_eof_desc_addr(dev, chan)
 | |
| #define adc_ll_digi_dma_set_eof_num(dev, num)           adc_ll_digi_dma_set_eof_num(num)
 | |
| #define adc_ll_digi_reset(dev)                          adc_ll_digi_reset()
 | |
| #define adc_ll_digi_trigger_enable(dev)                 adc_ll_digi_trigger_enable()
 | |
| #define adc_ll_digi_trigger_disable(dev)                adc_ll_digi_trigger_disable()
 | |
| 
 | |
| //ADC utilises I2S0 DMA on ESP32
 | |
| #else //CONFIG_IDF_TARGET_ESP32
 | |
| #define adc_dma_ll_rx_get_intr(dev, mask)               ({i2s_ll_get_intr_status(dev) & mask;})
 | |
| #define adc_dma_ll_rx_clear_intr(dev, chan, mask)       i2s_ll_clear_intr_status(dev, mask)
 | |
| #define adc_dma_ll_rx_enable_intr(dev, chan, mask)      do {((i2s_dev_t *)(dev))->int_ena.val |= mask;} while (0)
 | |
| #define adc_dma_ll_rx_disable_intr(dev, chan, mask)     do {((i2s_dev_t *)(dev))->int_ena.val &= ~mask;} while (0)
 | |
| #define adc_dma_ll_rx_reset_channel(dev, chan)          i2s_ll_rx_reset_dma(dev)
 | |
| #define adc_dma_ll_rx_stop(dev, chan)                   i2s_ll_rx_stop_link(dev)
 | |
| #define adc_dma_ll_rx_start(dev, chan, address) do { \
 | |
|             ((i2s_dev_t *)(dev))->in_link.addr = (uint32_t)(address); \
 | |
|             i2s_ll_enable_dma(dev, 1); \
 | |
|             ((i2s_dev_t *)(dev))->in_link.start = 1; \
 | |
|         } while (0)
 | |
| #define adc_dma_ll_get_in_suc_eof_desc_addr(dev, chan)  ({uint32_t addr; i2s_ll_rx_get_eof_des_addr(dev, &addr); addr;})
 | |
| #define adc_ll_digi_dma_set_eof_num(dev, num)            do {((i2s_dev_t *)(dev))->rx_eof_num = num;} while (0)
 | |
| #define adc_ll_digi_reset(dev) do { \
 | |
|             i2s_ll_rx_reset(dev); \
 | |
|             i2s_ll_rx_reset_fifo(dev); \
 | |
|         } while (0)
 | |
| #define adc_ll_digi_trigger_enable(dev)                 i2s_ll_rx_start(dev)
 | |
| #define adc_ll_digi_trigger_disable(dev)                i2s_ll_rx_stop(dev)
 | |
| #define adc_ll_digi_dma_enable()                        adc_ll_digi_set_data_source(1)  //Will this influence I2S0
 | |
| #define adc_ll_digi_dma_disable()                       adc_ll_digi_set_data_source(0)
 | |
| 
 | |
| //ESP32 ADC uses the DMA through I2S. The I2S needs to be configured.
 | |
| #define I2S_BASE_CLK                                    (160 * 1000 * 1000)
 | |
| #define SAMPLE_BITS                                     16
 | |
| #define ADC_LL_CLKM_DIV_NUM_DEFAULT                     2
 | |
| #define ADC_LL_CLKM_DIV_B_DEFAULT                       0
 | |
| #define ADC_LL_CLKM_DIV_A_DEFAULT                       1
 | |
| 
 | |
| #endif
 | |
| 
 | |
| 
 | |
| 
 | |
| void adc_hal_dma_ctx_config(adc_hal_dma_ctx_t *hal, const adc_hal_dma_config_t *config)
 | |
| {
 | |
|     hal->desc_dummy_head.next = hal->rx_desc;
 | |
|     hal->dev = config->dev;
 | |
|     hal->eof_desc_num = config->eof_desc_num;
 | |
|     hal->eof_step = config->eof_step;
 | |
|     hal->dma_chan = config->dma_chan;
 | |
|     hal->eof_num = config->eof_num;
 | |
| }
 | |
| 
 | |
| void adc_hal_digi_init(adc_hal_dma_ctx_t *hal)
 | |
| {
 | |
|     // Set internal FSM wait time, fixed value.
 | |
|     adc_ll_digi_set_fsm_time(ADC_LL_FSM_RSTB_WAIT_DEFAULT, ADC_LL_FSM_START_WAIT_DEFAULT,
 | |
|                              ADC_LL_FSM_STANDBY_WAIT_DEFAULT);
 | |
|     adc_ll_set_sample_cycle(ADC_LL_SAMPLE_CYCLE_DEFAULT);
 | |
|     adc_hal_pwdet_set_cct(ADC_LL_PWDET_CCT_DEFAULT);
 | |
|     adc_ll_digi_output_invert(ADC_UNIT_1, ADC_LL_DIGI_DATA_INVERT_DEFAULT(ADC_UNIT_1));
 | |
|     adc_ll_digi_output_invert(ADC_UNIT_2, ADC_LL_DIGI_DATA_INVERT_DEFAULT(ADC_UNIT_2));
 | |
|     adc_ll_digi_set_clk_div(ADC_LL_DIGI_SAR_CLK_DIV_DEFAULT);
 | |
| 
 | |
|     adc_dma_ll_rx_clear_intr(hal->dev, hal->dma_chan, ADC_HAL_DMA_INTR_MASK);
 | |
|     adc_dma_ll_rx_enable_intr(hal->dev, hal->dma_chan, ADC_HAL_DMA_INTR_MASK);
 | |
|     adc_ll_digi_dma_set_eof_num(hal->dev, hal->eof_num);
 | |
| #if CONFIG_IDF_TARGET_ESP32
 | |
|     i2s_ll_rx_set_sample_bit(hal->dev, SAMPLE_BITS, SAMPLE_BITS);
 | |
|     i2s_ll_rx_enable_mono_mode(hal->dev, 1);
 | |
|     i2s_ll_rx_force_enable_fifo_mod(hal->dev, 1);
 | |
|     i2s_ll_enable_builtin_adc(hal->dev, 1);
 | |
| #endif
 | |
| 
 | |
|     adc_oneshot_ll_disable_all_unit();
 | |
| }
 | |
| 
 | |
| void adc_hal_digi_deinit(adc_hal_dma_ctx_t *hal)
 | |
| {
 | |
|     adc_ll_digi_trigger_disable(hal->dev);
 | |
|     adc_ll_digi_dma_disable();
 | |
|     adc_ll_digi_clear_pattern_table(ADC_UNIT_1);
 | |
|     adc_ll_digi_clear_pattern_table(ADC_UNIT_2);
 | |
|     adc_ll_digi_reset(hal->dev);
 | |
|     adc_ll_digi_controller_clk_disable();
 | |
| }
 | |
| 
 | |
| /*---------------------------------------------------------------
 | |
|                     DMA read
 | |
| ---------------------------------------------------------------*/
 | |
| static adc_ll_digi_convert_mode_t get_convert_mode(adc_digi_convert_mode_t convert_mode)
 | |
| {
 | |
| #if CONFIG_IDF_TARGET_ESP32 || SOC_ADC_DIGI_CONTROLLER_NUM == 1
 | |
|     return ADC_LL_DIGI_CONV_ONLY_ADC1;
 | |
| #elif (SOC_ADC_DIGI_CONTROLLER_NUM >= 2)
 | |
|     switch (convert_mode) {
 | |
|         case ADC_CONV_SINGLE_UNIT_1:
 | |
|             return ADC_LL_DIGI_CONV_ONLY_ADC1;
 | |
|         case ADC_CONV_SINGLE_UNIT_2:
 | |
|             return ADC_LL_DIGI_CONV_ONLY_ADC2;
 | |
|         case ADC_CONV_BOTH_UNIT:
 | |
|             return ADC_LL_DIGI_CONV_BOTH_UNIT;
 | |
|         case ADC_CONV_ALTER_UNIT:
 | |
|             return ADC_LL_DIGI_CONV_ALTER_UNIT;
 | |
|         default:
 | |
|             abort();
 | |
|     }
 | |
| #endif
 | |
| }
 | |
| 
 | |
| /**
 | |
|  * For esp32s2 and later chips
 | |
|  * - Set ADC digital controller clock division factor. The clock is divided from `APLL` or `APB` clock.
 | |
|  *   Expression: controller_clk = APLL/APB * (div_num  + div_a / div_b + 1).
 | |
|  * - Enable clock and select clock source for ADC digital controller.
 | |
|  * For esp32, use I2S clock
 | |
|  */
 | |
| static void adc_hal_digi_sample_freq_config(adc_hal_dma_ctx_t *hal, adc_continuous_clk_src_t clk_src, uint32_t clk_src_freq_hz, uint32_t sample_freq_hz)
 | |
| {
 | |
| #if !CONFIG_IDF_TARGET_ESP32
 | |
|     uint32_t interval = clk_src_freq_hz / (ADC_LL_CLKM_DIV_NUM_DEFAULT + ADC_LL_CLKM_DIV_A_DEFAULT / ADC_LL_CLKM_DIV_B_DEFAULT + 1) / 2 / sample_freq_hz;
 | |
|     //set sample interval
 | |
|     adc_ll_digi_set_trigger_interval(interval);
 | |
|     //Here we set the clock divider factor to make the digital clock to 5M Hz
 | |
|     adc_ll_digi_controller_clk_div(ADC_LL_CLKM_DIV_NUM_DEFAULT, ADC_LL_CLKM_DIV_B_DEFAULT, ADC_LL_CLKM_DIV_A_DEFAULT);
 | |
|     adc_ll_digi_clk_sel(clk_src);
 | |
| #else
 | |
|     i2s_ll_rx_clk_set_src(hal->dev, I2S_CLK_SRC_DEFAULT);    /*!< Clock from PLL_D2_CLK(160M)*/
 | |
|     uint32_t bclk_div = 16;
 | |
|     uint32_t bclk = sample_freq_hz * 2;
 | |
|     uint32_t mclk = bclk * bclk_div;
 | |
|     i2s_ll_mclk_div_t mclk_div = {};
 | |
|     i2s_hal_calc_mclk_precise_division(I2S_BASE_CLK, mclk, &mclk_div);
 | |
|     i2s_ll_rx_set_mclk(hal->dev, &mclk_div);
 | |
|     i2s_ll_rx_set_bck_div_num(hal->dev, bclk_div);
 | |
| #endif
 | |
| }
 | |
| 
 | |
| void adc_hal_digi_controller_config(adc_hal_dma_ctx_t *hal, const adc_hal_digi_ctrlr_cfg_t *cfg)
 | |
| {
 | |
| #if (SOC_ADC_DIGI_CONTROLLER_NUM == 1)
 | |
|     //Only one pattern table, this variable is for readability
 | |
|     const int pattern_both = 0;
 | |
| 
 | |
|     adc_ll_digi_clear_pattern_table(pattern_both);
 | |
|     adc_ll_digi_set_pattern_table_len(pattern_both, cfg->adc_pattern_len);
 | |
|     for (int i = 0; i < cfg->adc_pattern_len; i++) {
 | |
|         adc_ll_digi_set_pattern_table(pattern_both, i, cfg->adc_pattern[i]);
 | |
|     }
 | |
| 
 | |
| #elif (SOC_ADC_DIGI_CONTROLLER_NUM >= 2)
 | |
|     uint32_t adc1_pattern_idx = 0;
 | |
|     uint32_t adc2_pattern_idx = 0;
 | |
| 
 | |
|     adc_ll_digi_clear_pattern_table(ADC_UNIT_1);
 | |
|     adc_ll_digi_clear_pattern_table(ADC_UNIT_2);
 | |
| 
 | |
|     for (int i = 0; i < cfg->adc_pattern_len; i++) {
 | |
|         if (cfg->adc_pattern[i].unit == ADC_UNIT_1) {
 | |
|             adc_ll_digi_set_pattern_table(ADC_UNIT_1, adc1_pattern_idx, cfg->adc_pattern[i]);
 | |
|             adc1_pattern_idx++;
 | |
|         } else if (cfg->adc_pattern[i].unit == ADC_UNIT_2) {
 | |
|             adc_ll_digi_set_pattern_table(ADC_UNIT_2, adc2_pattern_idx, cfg->adc_pattern[i]);
 | |
|             adc2_pattern_idx++;
 | |
|         } else {
 | |
|             abort();
 | |
|         }
 | |
|     }
 | |
|     adc_ll_digi_set_pattern_table_len(ADC_UNIT_1, adc1_pattern_idx);
 | |
|     adc_ll_digi_set_pattern_table_len(ADC_UNIT_2, adc2_pattern_idx);
 | |
| 
 | |
| #endif
 | |
| 
 | |
|     adc_ll_digi_convert_limit_enable(ADC_LL_DEFAULT_CONV_LIMIT_EN);
 | |
|     adc_ll_digi_set_convert_limit_num(ADC_LL_DEFAULT_CONV_LIMIT_NUM);
 | |
|     adc_ll_digi_set_convert_mode(get_convert_mode(cfg->conv_mode));
 | |
| 
 | |
|     //clock and sample frequency
 | |
|     adc_hal_digi_sample_freq_config(hal, cfg->clk_src, cfg->clk_src_freq_hz, cfg->sample_freq_hz);
 | |
| }
 | |
| 
 | |
| static void adc_hal_digi_dma_link_descriptors(dma_descriptor_t *desc, uint8_t *data_buf, uint32_t per_eof_size, uint32_t eof_step, uint32_t eof_num)
 | |
| {
 | |
|     HAL_ASSERT(((uint32_t)data_buf % 4) == 0);
 | |
|     HAL_ASSERT((per_eof_size % 4) == 0);
 | |
|     uint32_t n = 0;
 | |
|     dma_descriptor_t *desc_head = desc;
 | |
| 
 | |
|     while (eof_num--) {
 | |
|         uint32_t eof_size = per_eof_size;
 | |
| 
 | |
|         for (int i = 0; i < eof_step; i++) {
 | |
|             uint32_t this_len = eof_size;
 | |
|             if (this_len > DMA_DESCRIPTOR_BUFFER_MAX_SIZE_4B_ALIGNED) {
 | |
|                 this_len = DMA_DESCRIPTOR_BUFFER_MAX_SIZE_4B_ALIGNED;
 | |
|             }
 | |
| 
 | |
|             desc[n] = (dma_descriptor_t) {
 | |
|                 .dw0.size = this_len,
 | |
|                 .dw0.length = 0,
 | |
|                 .dw0.suc_eof = 0,
 | |
|                 .dw0.owner = 1,
 | |
|                 .buffer = data_buf,
 | |
|                 .next = &desc[n+1]
 | |
|             };
 | |
|             eof_size -= this_len;
 | |
|             data_buf += this_len;
 | |
|             n++;
 | |
|         }
 | |
|     }
 | |
|     desc[n-1].next = desc_head;
 | |
| }
 | |
| 
 | |
| void adc_hal_digi_start(adc_hal_dma_ctx_t *hal, uint8_t *data_buf)
 | |
| {
 | |
|     //stop peripheral and DMA
 | |
|     adc_hal_digi_stop(hal);
 | |
| 
 | |
|     //reset DMA
 | |
|     adc_dma_ll_rx_reset_channel(hal->dev, hal->dma_chan);
 | |
|     //reset peripheral
 | |
|     adc_ll_digi_reset(hal->dev);
 | |
| 
 | |
|     //reset the current descriptor address
 | |
|     hal->cur_desc_ptr = &hal->desc_dummy_head;
 | |
|     adc_hal_digi_dma_link_descriptors(hal->rx_desc, data_buf, hal->eof_num * SOC_ADC_DIGI_DATA_BYTES_PER_CONV, hal->eof_step, hal->eof_desc_num);
 | |
| 
 | |
|     //start DMA
 | |
|     adc_dma_ll_rx_start(hal->dev, hal->dma_chan, (lldesc_t *)hal->rx_desc);
 | |
|     //connect DMA and peripheral
 | |
|     adc_ll_digi_dma_enable();
 | |
|     //start ADC
 | |
|     adc_ll_digi_trigger_enable(hal->dev);
 | |
| }
 | |
| 
 | |
| #if !SOC_GDMA_SUPPORTED
 | |
| intptr_t adc_hal_get_desc_addr(adc_hal_dma_ctx_t *hal)
 | |
| {
 | |
|     return adc_dma_ll_get_in_suc_eof_desc_addr(hal->dev, hal->dma_chan);
 | |
| }
 | |
| 
 | |
| bool adc_hal_check_event(adc_hal_dma_ctx_t *hal, uint32_t mask)
 | |
| {
 | |
|     return adc_dma_ll_rx_get_intr(hal->dev, mask);
 | |
| }
 | |
| #endif  //#if !SOC_GDMA_SUPPORTED
 | |
| 
 | |
| adc_hal_dma_desc_status_t adc_hal_get_reading_result(adc_hal_dma_ctx_t *hal, const intptr_t eof_desc_addr, uint8_t **buffer, uint32_t *len)
 | |
| {
 | |
|     HAL_ASSERT(hal->cur_desc_ptr);
 | |
| 
 | |
|     if (!hal->cur_desc_ptr->next) {
 | |
|         return ADC_HAL_DMA_DESC_NULL;
 | |
|     }
 | |
| 
 | |
|     if ((intptr_t)hal->cur_desc_ptr == eof_desc_addr) {
 | |
|         return ADC_HAL_DMA_DESC_WAITING;
 | |
|     }
 | |
| 
 | |
|     uint8_t *buffer_start = NULL;
 | |
|     uint32_t eof_len = 0;
 | |
|     dma_descriptor_t *eof_desc = hal->cur_desc_ptr;
 | |
| 
 | |
|     //Find the eof list start
 | |
|     eof_desc = eof_desc->next;
 | |
|     eof_desc->dw0.owner = 1;
 | |
|     buffer_start = eof_desc->buffer;
 | |
|     eof_len += eof_desc->dw0.length;
 | |
|     if ((intptr_t)eof_desc == eof_desc_addr) {
 | |
|         goto valid;
 | |
|     }
 | |
| 
 | |
|     //Find the eof list end
 | |
|     for (int i = 1; i < hal->eof_step; i++) {
 | |
|         eof_desc = eof_desc->next;
 | |
|         eof_desc->dw0.owner = 1;
 | |
|         eof_len += eof_desc->dw0.length;
 | |
|         if ((intptr_t)eof_desc == eof_desc_addr) {
 | |
|             goto valid;
 | |
|         }
 | |
|     }
 | |
| 
 | |
| valid:
 | |
|     hal->cur_desc_ptr = eof_desc;
 | |
|     *buffer = buffer_start;
 | |
|     *len = eof_len;
 | |
| 
 | |
|     return ADC_HAL_DMA_DESC_VALID;
 | |
| }
 | |
| 
 | |
| void adc_hal_digi_clr_intr(adc_hal_dma_ctx_t *hal, uint32_t mask)
 | |
| {
 | |
|     adc_dma_ll_rx_clear_intr(hal->dev, hal->dma_chan, mask);
 | |
| }
 | |
| 
 | |
| void adc_hal_digi_dis_intr(adc_hal_dma_ctx_t *hal, uint32_t mask)
 | |
| {
 | |
|     adc_dma_ll_rx_disable_intr(hal->dev, hal->dma_chan, mask);
 | |
| }
 | |
| 
 | |
| void adc_hal_digi_stop(adc_hal_dma_ctx_t *hal)
 | |
| {
 | |
|     //stop ADC
 | |
|     adc_ll_digi_trigger_disable(hal->dev);
 | |
|     //stop DMA
 | |
|     adc_dma_ll_rx_stop(hal->dev, hal->dma_chan);
 | |
|     //disconnect DMA and peripheral
 | |
|     adc_ll_digi_dma_disable();
 | |
| }
 | |
| 
 | |
| #if ADC_LL_WORKAROUND_CLEAR_EOF_COUNTER
 | |
| void adc_hal_digi_clr_eof(void)
 | |
| {
 | |
|     adc_ll_digi_dma_clr_eof();
 | |
| }
 | |
| #endif
 | 
