Skip to content

Commit

Permalink
Pre-commit: Done the formatting changes
Browse files Browse the repository at this point in the history 
Pre-commit: Fixed compilation error for other ESP32C3/ESP32S3/ESP32H2 boards
Review comment: Removed the self->pin NULL check
Review comment: Using raise_ValueError_invalid_pin when adc_index is not ADC_UNIT1 for ESP32
Review comment: Optimized the code to set data in buffer from DMA results
Fix: For ESP32C3 boards continuing collecting samples after channel mismatch as DMA runs in alternating UNIT mode
Fix: For ESP32S3 and ESP32H2 setting conversion mode to type2
  • Loading branch information
@milindmovasha
milindmovasha committed Feb 18, 2023
1 parent 58532ec commit ead5751
Showing 1 changed file with 83 additions and 78 deletions.
161 changes: 83 additions & 78 deletions ports/espressif/common-hal/analogbufio/BufferedIn.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,17 @@
#include "freertos/semphr.h"
#include "driver/adc.h"

//#define DEBUG_ANALOGBUFIO
// #define DEBUG_ANALOGBUFIO

#define NUM_SAMPLES_PER_INTERRUPT 256
#define NUM_ADC_CHANNELS 1
#define DMA_BUFFER_SIZE 1024
#define DMA_BUFFER_SIZE 1024
#define ATTENUATION ADC_ATTEN_DB_0
#define ADC_READ_TIMEOUT_MS 2000

#if defined(CONFIG_IDF_TARGET_ESP32)
#define ADC_RESULT_BYTE 2
#define ADC_CONV_LIMIT_EN 1 //For ESP32, this should always be set to 1
#define ADC_CONV_LIMIT_EN 1 // For ESP32, this should always be set to 1
#elif defined(CONFIG_IDF_TARGET_ESP32S2)
#define ADC_RESULT_BYTE 2
#define ADC_CONV_LIMIT_EN 0
Expand All @@ -71,12 +71,8 @@ void common_hal_analogbufio_bufferedin_construct(analogbufio_bufferedin_obj_t *s
uint16_t adc1_chan_mask = 0;
uint16_t adc2_chan_mask = 0;

if( self->pin != NULL) {
mp_raise_ValueError(translate("ADC DMA already initialized"));
}

output_format = ADC_DIGI_OUTPUT_FORMAT_TYPE1;
if(pin->adc_index == ADC_UNIT_1) {
if (pin->adc_index == ADC_UNIT_1) {
convert_mode = ADC_CONV_SINGLE_UNIT_1;
} else {
convert_mode = ADC_CONV_SINGLE_UNIT_2;
Expand All @@ -90,34 +86,37 @@ void common_hal_analogbufio_bufferedin_construct(analogbufio_bufferedin_obj_t *s

/*
* Chip version Conversion Mode Output Format Type
* ESP32 1 TYPE1
* ESP32S2 1,2,BOTH,ALTER TYPE1, TYPE2
* ESP32C3 ALTER TYPE2
* ESP32S3 1,2,BOTH,ALTER TYPE2
* ESP32H3 1,2,BOTH,ALTER TYPE2
* ESP32 1 TYPE1
* ESP32S2 1,2,BOTH,ALTER TYPE1, TYPE2
* ESP32C3 ALTER TYPE2
* ESP32S3 1,2,BOTH,ALTER TYPE2
* ESP32H3 1,2,BOTH,ALTER TYPE2
*/

#if defined(CONFIG_IDF_TARGET_ESP32)
if(pin->adc_index != ADC_UNIT_1) {
mp_raise_ValueError(translate("ESP32 only supports ADC1 unit"));
#if defined(CONFIG_IDF_TARGET_ESP32)
if (pin->adc_index != ADC_UNIT_1) {
/*
* ESP32 only supports ADC1 unit
* https://www.espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf
* Table 29-3
*/
raise_ValueError_invalid_pin();
}
#endif
#if defined(CONFIG_IDF_TARGET_ESP32S2)
#endif
#if defined(CONFIG_IDF_TARGET_ESP32C3)
//ESP32C3 only supports alter mode
#endif

#if defined(CONFIG_IDF_TARGET_ESP32C3)
/* ESP32C3 only supports alter mode */
convert_mode = ADC_CONV_ALTER_UNIT;
#endif

#if defined(CONFIG_IDF_TARGET_ESP32C3) || defined(CONFIG_IDF_TARGET_ESP32S3) || defined(CONFIG_IDF_TARGET_ESP32H2)
output_format = ADC_DIGI_OUTPUT_FORMAT_TYPE2;
#endif
#if defined(CONFIG_IDF_TARGET_ESP32S3)
#endif
#if defined(CONFIG_IDF_TARGET_ESP32H2)
#endif
#endif

self->pin = pin;
common_hal_mcu_pin_claim(pin);

if(pin->adc_index == ADC_UNIT_1) {
if (pin->adc_index == ADC_UNIT_1) {
adc1_chan_mask = 1 << pin->adc_channel;
} else {
adc2_chan_mask = 1 << pin->adc_channel;
Expand All @@ -130,11 +129,11 @@ void common_hal_analogbufio_bufferedin_construct(analogbufio_bufferedin_obj_t *s
.adc2_chan_mask = adc2_chan_mask,
};

#if defined(DEBUG_ANALOGBUFIO)
#if defined(DEBUG_ANALOGBUFIO)
mp_printf(&mp_plat_print,"pin:%d, ADC channel:%d, ADC index:%d, adc1_chan_mask:0x%x, adc2_chan_mask:0x%x\n",pin->number,pin->adc_channel,pin->adc_index,adc1_chan_mask,adc2_chan_mask);
#endif //DEBUG_ANALOGBUFIO
#endif // DEBUG_ANALOGBUFIO
esp_err_t err = adc_digi_initialize(&adc_dma_config);
if(ESP_OK != err) {
if (ESP_OK != err) {
common_hal_analogbufio_bufferedin_deinit(self);
mp_raise_ValueError_varg(translate("Unable to initialize ADC DMA controller, ErrorCode:%d"),err);
}
Expand All @@ -148,32 +147,32 @@ void common_hal_analogbufio_bufferedin_construct(analogbufio_bufferedin_obj_t *s
.format = output_format,
};

#if defined(DEBUG_ANALOGBUFIO)
#if defined(DEBUG_ANALOGBUFIO)
mp_printf(&mp_plat_print,"conversion_mode:%d, format:%d, conv_limit_en:%d, sample_rate:%d\n",convert_mode,output_format,ADC_CONV_LIMIT_EN,sample_rate);
#endif //DEBUG_ANALOGBUFIO
#endif // DEBUG_ANALOGBUFIO

adc_digi_pattern_config_t adc_pattern[NUM_ADC_CHANNELS] = {0};
adc_pattern[0].atten = ATTENUATION;
adc_pattern[0].channel = pin->adc_channel;
if(pin->adc_index == ADC_UNIT_1) {
if (pin->adc_index == ADC_UNIT_1) {
adc_pattern[0].unit = 0;
} else {
adc_pattern[0].unit = 1;
}
adc_pattern[0].bit_width = SOC_ADC_DIGI_MAX_BITWIDTH;

dig_cfg.adc_pattern = adc_pattern;
#if defined(DEBUG_ANALOGBUFIO)
#if defined(DEBUG_ANALOGBUFIO)
mp_printf(&mp_plat_print,"adc_pattern[0].channel:%d, adc_pattern[0].unit:%d, adc_pattern[0].atten:%d\n",adc_pattern[0].channel,adc_pattern[0].unit,adc_pattern[0].atten);
#endif //DEBUG_ANALOGBUFIO
#endif // DEBUG_ANALOGBUFIO

err = adc_digi_controller_configure(&dig_cfg);
if(ESP_OK != err) {
if (ESP_OK != err) {
common_hal_analogbufio_bufferedin_deinit(self);
mp_raise_ValueError_varg(translate("Unable to configure ADC DMA controller, ErrorCode:%d"),err);
}
err = adc_digi_start();
if(ESP_OK != err) {
if (ESP_OK != err) {
common_hal_analogbufio_bufferedin_deinit(self);
mp_raise_ValueError_varg(translate("Unable to start ADC DMA controller, ErrorCode:%d"),err);
}
Expand All @@ -196,88 +195,94 @@ void common_hal_analogbufio_bufferedin_deinit(analogbufio_bufferedin_obj_t *self
self->pin = NULL;
}

static bool check_valid_data(const adc_digi_output_data_t *data)
{
static bool check_valid_data(const adc_digi_output_data_t *data) {
unsigned int unit = data->type2.unit;
if(output_format == ADC_DIGI_OUTPUT_FORMAT_TYPE2) {
if (data->type2.channel >= SOC_ADC_CHANNEL_NUM(unit)) return false;
if (adc_channel != data->type2.channel) return false;
if (output_format == ADC_DIGI_OUTPUT_FORMAT_TYPE2) {
if (data->type2.channel >= SOC_ADC_CHANNEL_NUM(unit)) {
return false;
}
if (adc_channel != data->type2.channel) {
return false;
}
} else {
if( convert_mode == ADC_CONV_SINGLE_UNIT_1 ) {
if ( convert_mode == ADC_CONV_SINGLE_UNIT_1 ) {
unit = 0;
} else {
unit = 1;
}
if (data->type1.channel >= SOC_ADC_CHANNEL_NUM(unit)) return false;
if (adc_channel != data->type1.channel) return false;
#if defined(CONFIG_IDF_TARGET_ESP32) || defined(CONFIG_IDF_TARGET_ESP32S2)
if (data->type1.channel >= SOC_ADC_CHANNEL_NUM(unit)) {
return false;
}
if (adc_channel != data->type1.channel) {
return false;
}
#endif
}
if (unit > 2) {
return false;
}
if (unit > 2) return false;
return true;
}


uint32_t common_hal_analogbufio_bufferedin_readinto(analogbufio_bufferedin_obj_t *self, uint8_t *buffer, uint32_t len, uint8_t bytes_per_sample) {
uint8_t result[NUM_SAMPLES_PER_INTERRUPT] __attribute__ ((aligned (4))) = {0};
uint8_t result[NUM_SAMPLES_PER_INTERRUPT] __attribute__ ((aligned(4))) = {0};
uint32_t captured_samples = 0;
uint32_t captured_bytes = 0;
esp_err_t ret;
uint32_t ret_num = 0;

#if defined(DEBUG_ANALOGBUFIO)
#if defined(DEBUG_ANALOGBUFIO)
mp_printf(&mp_plat_print,"Required bytes: %d\n",len);
#endif //DEBUG_ANALOGBUFIO
#endif // DEBUG_ANALOGBUFIO

while(captured_bytes < len) {
ret_num = 0;
ret = adc_digi_read_bytes(result, NUM_SAMPLES_PER_INTERRUPT, &ret_num, ADC_READ_TIMEOUT_MS);

if (ret == ESP_OK) {
for(uint32_t i=0; i<ret_num; i+=ADC_RESULT_BYTE) {
if(check_valid_data((adc_digi_output_data_t *) (void *)&result[i])) {
if(captured_bytes < len) {
if(ADC_RESULT_BYTE == 2) {
if(output_format == ADC_DIGI_OUTPUT_FORMAT_TYPE1) {
*(uint16_t *)(void *)&buffer[captured_bytes] = ((adc_digi_output_data_t *) (void *)&result[i])->type1.data;
} else {
*(uint16_t *)(void *)&buffer[captured_bytes] = ((adc_digi_output_data_t *) (void *)&result[i])->type2.data;
}
adc_digi_output_data_t *pResult = (adc_digi_output_data_t *) (void *)&result[i];
if (check_valid_data(pResult)) {
if (captured_bytes < len) {
uint16_t *pBuffer = (uint16_t *)(void *)&buffer[captured_bytes];
if (output_format == ADC_DIGI_OUTPUT_FORMAT_TYPE1) {
#if defined(CONFIG_IDF_TARGET_ESP32) || defined(CONFIG_IDF_TARGET_ESP32S2)
*pBuffer = pResult->type1.data;
#endif
} else {
if(output_format == ADC_DIGI_OUTPUT_FORMAT_TYPE1) {
*(uint32_t *)(void *)&buffer[captured_bytes] = ((adc_digi_output_data_t *) (void *)&result[i])->type1.data;
} else {
*(uint32_t *)(void *)&buffer[captured_bytes] = ((adc_digi_output_data_t *) (void *)&result[i])->type2.data;
}
*pBuffer = pResult->type2.data;
}
captured_bytes += ADC_RESULT_BYTE;
captured_bytes += sizeof(uint16_t);
captured_samples++;
} else {
return captured_samples;
}
} else {
#if defined(DEBUG_ANALOGBUFIO)
if(ADC_RESULT_BYTE == 2) {
mp_printf(&mp_plat_print,"Invalid sample received: 0x%0x\n",*(uint16_t *)(void *)&result[i]);
} else {
mp_printf(&mp_plat_print,"Invalid sample received: 0x%0x\n",*(uint32_t *)(void *)&result[i]);
}
#endif //DEBUG_ANALOGBUFIO
#if !defined(CONFIG_IDF_TARGET_ESP32C3)
// For all chips except for ESP32C3 we would receive samples only from one unit
// For ESP32C3 we may receive sample from alternating units and need to ignore them
#if defined(DEBUG_ANALOGBUFIO)
mp_printf(&mp_plat_print,"Invalid sample received: 0x%x\n",pResult->val);
#endif // DEBUG_ANALOGBUFIO
return captured_samples;
}
#endif
}
}
} else if (ret == ESP_ERR_TIMEOUT) {
#if defined(DEBUG_ANALOGBUFIO)
#if defined(DEBUG_ANALOGBUFIO)
mp_printf(&mp_plat_print,"ADC Timeout\n");
#endif //DEBUG_ANALOGBUFIO
#endif // DEBUG_ANALOGBUFIO
return captured_samples;
} else {
#if defined(DEBUG_ANALOGBUFIO)
#if defined(DEBUG_ANALOGBUFIO)
mp_printf(&mp_plat_print,"adc_digi_read_bytes failed error code:%d\n",ret);
#endif //DEBUG_ANALOGBUFIO
#endif // DEBUG_ANALOGBUFIO
return captured_samples;
}
}
#if defined(DEBUG_ANALOGBUFIO)
#if defined(DEBUG_ANALOGBUFIO)
mp_printf(&mp_plat_print,"Captured bytes: %d\n",captured_bytes);
#endif //DEBUG_ANALOGBUFIO
#endif // DEBUG_ANALOGBUFIO
return captured_samples;
}

0 comments on commit ead5751

Please sign in to comment.