From 95b01526371f082252ad3b598646872cf6e622f4 Mon Sep 17 00:00:00 2001 From: Armando Date: Mon, 30 Oct 2023 12:17:25 +0800 Subject: [PATCH] doc(adc): added efuse related failure doc Closes https://github.com/espressif/esp-idf/issues/12372 --- docs/en/api-guides/flash_psram_config.rst | 2 +- docs/en/api-reference/peripherals/adc_calibration.rst | 11 ++++++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/en/api-guides/flash_psram_config.rst b/docs/en/api-guides/flash_psram_config.rst index fc7e352b63..a272a91036 100644 --- a/docs/en/api-guides/flash_psram_config.rst +++ b/docs/en/api-guides/flash_psram_config.rst @@ -173,7 +173,7 @@ Error Handling this means: - either you're using a board with a Quad Flash - - or you're using a board with an Octal Flash, but the eFuse bit ``FLASH_TYPE`` isn't burnt. Espressif guarantees this bit during module manufacturing, but if the module is manufactured by others, this may happen. + - or you're using a board with an Octal Flash, but the eFuse bit ``FLASH_TYPE`` isn't burnt. Espressif guarantees this bit is burnt during module manufacturing, but if the module is manufactured by others, this may happen. Here is a method to burn the eFuse bit: diff --git a/docs/en/api-reference/peripherals/adc_calibration.rst b/docs/en/api-reference/peripherals/adc_calibration.rst index ce1d6119c1..53903e4291 100644 --- a/docs/en/api-reference/peripherals/adc_calibration.rst +++ b/docs/en/api-reference/peripherals/adc_calibration.rst @@ -104,7 +104,16 @@ If you use your custom ADC calibration schemes, you could either modify this fun - :cpp:member:`adc_cali_curve_fitting_config_t::atten`, ADC attenuation that your ADC raw results use. - :cpp:member:`adc_cali_curve_fitting_config_t::bitwidth`, bit width of ADC raw result. - After setting up the configuration structure, call :cpp:func:`adc_cali_create_scheme_curve_fitting` to create a Curve Fitting calibration scheme handle. This function may fail due to reasons such as :c:macro:`ESP_ERR_INVALID_ARG` or :c:macro:`ESP_ERR_NO_MEM`. Especially, when the function return :c:macro:`ESP_ERR_NOT_SUPPORTED`, this means the calibration scheme required eFuse bits are not burnt on your board. + After setting up the configuration structure, call :cpp:func:`adc_cali_create_scheme_curve_fitting` to create a Curve Fitting calibration scheme handle. This function may fail due to reasons such as :c:macro:`ESP_ERR_INVALID_ARG` or :c:macro:`ESP_ERR_NO_MEM`. + + ADC Calibration Efuse Related Failures + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + When the function :cpp:func:`adc_cali_create_scheme_curve_fitting` returns :c:macro:`ESP_ERR_NOT_SUPPORTED`, this means the calibration scheme required eFuse bits are not correct on your board. + + ESP-IDF provided ADC calibration scheme is based on the values in certain ADC calibration related on-chip eFuse bits. Espressif guarantees that these bits are burnt during module manufacturing, so you don't have to burn these eFuses bits yourself. + + If you see such an error, please contact us at `Technical Inquiries `__ website. Create Curve Fitting Scheme ~~~~~~~~~~~~~~~~~~~~~~~~~~~