1 /*
2  * SPDX-FileCopyrightText: 2020-2023 Espressif Systems (Shanghai) CO LTD
3  *
4  * SPDX-License-Identifier: Apache-2.0
5  */
6 
7 #include <esp_bit_defs.h>
8 #include "esp_log.h"
9 #include "esp_efuse.h"
10 #include "esp_efuse_table.h"
11 #include "esp_efuse_rtc_calib.h"
12 #include "hal/adc_types.h"
13 
esp_efuse_rtc_calib_get_ver(void)14 int esp_efuse_rtc_calib_get_ver(void)
15 {
16     uint32_t blk_ver_major = 0;
17     esp_efuse_read_field_blob(ESP_EFUSE_BLK_VERSION_MAJOR, &blk_ver_major, ESP_EFUSE_BLK_VERSION_MAJOR[0]->bit_count); // IDF-5366
18 
19     uint32_t cali_version = (blk_ver_major == 0) ? ESP_EFUSE_ADC_CALIB_VER : 0;
20     if (!cali_version) {
21         ESP_LOGW("eFuse", "calibration efuse version does not match, set default version to 0");
22     }
23 
24     return cali_version;
25 }
26 
esp_efuse_rtc_calib_get_init_code(int version,uint32_t adc_unit,int atten)27 uint32_t esp_efuse_rtc_calib_get_init_code(int version, uint32_t adc_unit, int atten)
28 {
29     assert((version >= ESP_EFUSE_ADC_CALIB_VER_MIN) &&
30            (version <= ESP_EFUSE_ADC_CALIB_VER_MAX));
31     assert(atten <= ADC_ATTEN_DB_12);
32     (void) adc_unit;
33 
34     if (atten == ADC_ATTEN_DB_2_5 || atten == ADC_ATTEN_DB_6) {
35         /**
36          * - ESP32C2 only supports HW calibration on ADC_ATTEN_DB_0 and ADC_ATTEN_DB_12
37          * - For other attenuation, we just return default value, which is 0.
38          */
39         return 0;
40     }
41 
42     int32_t adc_icode_diff_atten0 = 0;
43     int32_t adc_icode_diff_atten3 = 0;
44     int efuse_icode_bits = 0;
45 
46     efuse_icode_bits = esp_efuse_get_field_size(ESP_EFUSE_ADC1_INIT_CODE_ATTEN0);
47     ESP_ERROR_CHECK(esp_efuse_read_field_blob(ESP_EFUSE_ADC1_INIT_CODE_ATTEN0, &adc_icode_diff_atten0, efuse_icode_bits));
48     adc_icode_diff_atten0 = ((adc_icode_diff_atten0 & BIT(7)) != 0) ? -(adc_icode_diff_atten0 & 0x7f): adc_icode_diff_atten0;
49 
50     efuse_icode_bits = esp_efuse_get_field_size(ESP_EFUSE_ADC1_INIT_CODE_ATTEN3);
51     ESP_ERROR_CHECK(esp_efuse_read_field_blob(ESP_EFUSE_ADC1_INIT_CODE_ATTEN3, &adc_icode_diff_atten3, efuse_icode_bits));
52 
53     ESP_EARLY_LOGV("eFuse", "adc_icode_diff_atten0: 0d%"PRId32", adc_icode_diff_atten3: 0d%"PRId32, adc_icode_diff_atten0, adc_icode_diff_atten3);
54 
55     uint32_t init_code = 0;
56     if (atten == ADC_ATTEN_DB_0) {
57         init_code = adc_icode_diff_atten0 + 2160;
58     } else {
59         //ADC_ATTEN_DB_12
60         init_code = adc_icode_diff_atten3 + adc_icode_diff_atten0 + 2160;
61     }
62 
63     return init_code;
64 }
65 
esp_efuse_rtc_calib_get_cal_voltage(int version,uint32_t adc_unit,int atten,uint32_t * out_digi,uint32_t * out_vol_mv)66 esp_err_t esp_efuse_rtc_calib_get_cal_voltage(int version, uint32_t adc_unit, int atten, uint32_t *out_digi, uint32_t *out_vol_mv)
67 {
68     assert((version >= ESP_EFUSE_ADC_CALIB_VER_MIN) &&
69            (version <= ESP_EFUSE_ADC_CALIB_VER_MAX));
70     assert(atten <= ADC_ATTEN_DB_12);
71     (void) adc_unit;
72 
73     if (atten == ADC_ATTEN_DB_2_5 || atten == ADC_ATTEN_DB_6) {
74         /**
75          * - ESP32C2 only supports SW calibration on ADC_ATTEN_DB_0 and ADC_ATTEN_DB_12
76          * - For other attenuation, we need to return an error, informing upper layer SW calibration driver
77          *   to deal with the error.
78          */
79         return ESP_ERR_INVALID_ARG;
80     }
81 
82     int32_t adc_vol_diff_atten0 = 0;
83     int32_t adc_vol_diff_atten3 = 0;
84     int efuse_vol_bits = 0;
85 
86     efuse_vol_bits = esp_efuse_get_field_size(ESP_EFUSE_ADC1_CAL_VOL_ATTEN0);
87     ESP_ERROR_CHECK(esp_efuse_read_field_blob(ESP_EFUSE_ADC1_CAL_VOL_ATTEN0, &adc_vol_diff_atten0, efuse_vol_bits));
88     adc_vol_diff_atten0 = ((adc_vol_diff_atten0 & BIT(7)) != 0) ? -(adc_vol_diff_atten0 & 0x7f): adc_vol_diff_atten0;
89 
90     efuse_vol_bits = esp_efuse_get_field_size(ESP_EFUSE_ADC1_CAL_VOL_ATTEN3);
91     ESP_ERROR_CHECK(esp_efuse_read_field_blob(ESP_EFUSE_ADC1_CAL_VOL_ATTEN3, &adc_vol_diff_atten3, efuse_vol_bits));
92     adc_vol_diff_atten3 = ((adc_vol_diff_atten3 & BIT(5)) != 0) ? -(adc_vol_diff_atten3 & 0x1f): adc_vol_diff_atten3;
93 
94     ESP_EARLY_LOGV("eFuse", "adc_vol_diff_atten0: 0d%"PRId32", adc_vol_diff_atten3: 0d%"PRId32, adc_vol_diff_atten0, adc_vol_diff_atten3);
95 
96     if (atten == ADC_ATTEN_DB_0) {
97         *out_digi = adc_vol_diff_atten0 + 1540;
98         *out_vol_mv = 400;
99     } else {
100         //ADC_ATTEN_DB_12
101         *out_digi = adc_vol_diff_atten0 + 1540 - adc_vol_diff_atten3 - 123;
102         *out_vol_mv = 1370;
103     }
104 
105     return ESP_OK;
106 }
107 
esp_efuse_rtc_calib_get_tsens_val(float * tsens_cal)108 esp_err_t esp_efuse_rtc_calib_get_tsens_val(float* tsens_cal)
109 {
110     // Currently calibration is not supported on ESP32-C2, IDF-5236
111     *tsens_cal = 0.0;
112     return ESP_OK;
113 }
114