1 /*
2 * SPDX-FileCopyrightText: 2022-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_efuse.h"
9 #include "esp_efuse_table.h"
10 #include "esp_efuse_rtc_calib.h"
11 #include "hal/efuse_hal.h"
12
13 /**
14 * @brief Get the signed value by the raw data that read from eFuse
15 * @param data The raw data that read from eFuse
16 * @param sign_bit The index of the sign bit, start from 0
17 */
18 #define RTC_CALIB_GET_SIGNED_VAL(data, sign_bit) ((data & BIT##sign_bit) ? -(int)(data & ~BIT##sign_bit) : (int)data)
19
esp_efuse_rtc_calib_get_ver(void)20 int esp_efuse_rtc_calib_get_ver(void)
21 {
22 uint32_t cali_version = 0;
23 uint32_t blk_ver = efuse_hal_blk_version();
24 if (blk_ver >= 2) {
25 cali_version = ESP_EFUSE_ADC_CALIB_VER1;
26 } else {
27 ESP_LOGW("eFuse", "calibration efuse version does not match, set default version to 0");
28 }
29
30 return cali_version;
31 }
32
esp_efuse_rtc_calib_get_init_code(int version,uint32_t adc_unit,int atten)33 uint32_t esp_efuse_rtc_calib_get_init_code(int version, uint32_t adc_unit, int atten)
34 {
35 /* Version validation should be guaranteed in the caller */
36 assert(atten >=0 && atten < 4);
37 (void) adc_unit;
38
39 const esp_efuse_desc_t** init_code_efuse;
40 if (atten == 0) {
41 init_code_efuse = ESP_EFUSE_ADC1_AVE_INITCODE_ATTEN0;
42 } else if (atten == 1) {
43 init_code_efuse = ESP_EFUSE_ADC1_AVE_INITCODE_ATTEN1;
44 } else if (atten == 2) {
45 init_code_efuse = ESP_EFUSE_ADC1_AVE_INITCODE_ATTEN2;
46 } else {
47 init_code_efuse = ESP_EFUSE_ADC1_AVE_INITCODE_ATTEN3;
48 }
49
50 int init_code_size = esp_efuse_get_field_size(init_code_efuse);
51 assert(init_code_size == 10);
52
53 uint32_t init_code = 0;
54 ESP_ERROR_CHECK(esp_efuse_read_field_blob(init_code_efuse, &init_code, init_code_size));
55 return init_code + 1600; // version 1 logic
56 }
57
esp_efuse_rtc_calib_get_chan_compens(int version,uint32_t adc_unit,uint32_t adc_channel,int atten)58 int esp_efuse_rtc_calib_get_chan_compens(int version, uint32_t adc_unit, uint32_t adc_channel, int atten)
59 {
60 /* Version validation should be guaranteed in the caller */
61 assert(atten < 4);
62 assert(adc_channel < SOC_ADC_CHANNEL_NUM(adc_unit));
63
64 const esp_efuse_desc_t** chan_diff_efuse = NULL;
65 switch (adc_channel) {
66 case 0:
67 chan_diff_efuse = ESP_EFUSE_ADC1_CH0_ATTEN0_INITCODE_DIFF;
68 break;
69 case 1:
70 chan_diff_efuse = ESP_EFUSE_ADC1_CH1_ATTEN0_INITCODE_DIFF;
71 break;
72 case 2:
73 chan_diff_efuse = ESP_EFUSE_ADC1_CH2_ATTEN0_INITCODE_DIFF;
74 break;
75 case 3:
76 chan_diff_efuse = ESP_EFUSE_ADC1_CH3_ATTEN0_INITCODE_DIFF;
77 break;
78 default:
79 chan_diff_efuse = ESP_EFUSE_ADC1_CH4_ATTEN0_INITCODE_DIFF;
80 break;
81 }
82
83 int chan_diff_size = esp_efuse_get_field_size(chan_diff_efuse);
84 assert(chan_diff_size == 4);
85 uint32_t chan_diff = 0;
86 ESP_ERROR_CHECK(esp_efuse_read_field_blob(chan_diff_efuse, &chan_diff, chan_diff_size));
87
88 return RTC_CALIB_GET_SIGNED_VAL(chan_diff, 3) * (4 - atten);
89 }
90
esp_efuse_rtc_calib_get_cal_voltage(int version,uint32_t adc_unit,int atten,uint32_t * out_digi,uint32_t * out_vol_mv)91 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)
92 {
93 (void) adc_unit;
94 const esp_efuse_desc_t** cal_vol_efuse[4] = {
95 ESP_EFUSE_ADC1_HI_DOUT_ATTEN0,
96 ESP_EFUSE_ADC1_HI_DOUT_ATTEN1,
97 ESP_EFUSE_ADC1_HI_DOUT_ATTEN2,
98 ESP_EFUSE_ADC1_HI_DOUT_ATTEN3,
99 };
100 const uint32_t input_vout_mv[1][4] = {
101 {750, 1000, 1500, 2800}, // Calibration V1 coefficients
102 };
103
104 if ((version < ESP_EFUSE_ADC_CALIB_VER_MIN) ||
105 (version > ESP_EFUSE_ADC_CALIB_VER_MAX)) {
106 return ESP_ERR_INVALID_ARG;
107 }
108 if (atten >= 4 || atten < 0) {
109 return ESP_ERR_INVALID_ARG;
110 }
111
112 assert(cal_vol_efuse[atten][0]->bit_count == 10);
113
114 uint32_t cal_vol = 0;
115 esp_err_t ret = esp_efuse_read_field_blob(cal_vol_efuse[atten], &cal_vol, cal_vol_efuse[atten][0]->bit_count);
116 if (ret != ESP_OK) {
117 return ret;
118 }
119 uint32_t chk_offset = (atten == 2) ? 2970 : 2900;
120 *out_digi = chk_offset + RTC_CALIB_GET_SIGNED_VAL(cal_vol, 9);
121 *out_vol_mv = input_vout_mv[VER2IDX(version)][atten];
122 return ESP_OK;
123 }
124
esp_efuse_rtc_calib_get_tsens_val(float * tsens_cal)125 esp_err_t esp_efuse_rtc_calib_get_tsens_val(float* tsens_cal)
126 {
127 // Currently calibration is not supported on ESP32-H2, IDF-5236
128 *tsens_cal = 0;
129 return ESP_OK;
130 }
131
