1 /*
2 * SPDX-FileCopyrightText: 2016-2021 Espressif Systems (Shanghai) CO LTD
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7 #include <stdlib.h>
8 #include <ctype.h>
9 #include <math.h>
10 #include "sdkconfig.h"
11 #include "esp_types.h"
12 #include "esp_log.h"
13 #include "esp_check.h"
14 #include "esp_private/regi2c_ctrl.h"
15 #include "soc/regi2c_saradc.h"
16 #include "esp_log.h"
17 #include "esp_efuse_rtc_calib.h"
18 #include "hal/temperature_sensor_ll.h"
19 #include "driver/temp_sensor_types_legacy.h"
20 #include "esp_private/periph_ctrl.h"
21 #include "esp_private/sar_periph_ctrl.h"
22
23 static const char *TAG = "tsens";
24
25 #define TSENS_ADC_FACTOR (0.4386)
26 #define TSENS_DAC_FACTOR (27.88)
27 #define TSENS_SYS_OFFSET (20.52)
28
29 typedef struct {
30 int index;
31 int offset;
32 int reg_val;
33 int range_min;
34 int range_max;
35 int error_max;
36 } tsens_dac_offset_t;
37
38 static const tsens_dac_offset_t dac_offset[TSENS_DAC_MAX] = {
39 /* DAC Offset reg_val min max error */
40 {TSENS_DAC_L0, -2, 5, 50, 125, 3},
41 {TSENS_DAC_L1, -1, 7, 20, 100, 2},
42 {TSENS_DAC_L2, 0, 15, -10, 80, 1},
43 {TSENS_DAC_L3, 1, 11, -30, 50, 2},
44 {TSENS_DAC_L4, 2, 10, -40, 20, 3},
45 };
46
47 typedef enum {
48 TSENS_HW_STATE_UNCONFIGURED,
49 TSENS_HW_STATE_CONFIGURED,
50 TSENS_HW_STATE_STARTED,
51 } tsens_hw_state_t;
52
53 static tsens_hw_state_t tsens_hw_state = TSENS_HW_STATE_UNCONFIGURED;
54
55 static float s_deltaT = NAN; // Unused number
56
temp_sensor_set_config(temp_sensor_config_t tsens)57 esp_err_t temp_sensor_set_config(temp_sensor_config_t tsens)
58 {
59 esp_err_t err = ESP_OK;
60 if (tsens_hw_state == TSENS_HW_STATE_STARTED) {
61 ESP_LOGE(TAG, "Do not configure the temp sensor when it's running!");
62 err = ESP_ERR_INVALID_STATE;
63 }
64 temperature_sensor_ll_set_clk_div(tsens.clk_div);
65 temp_sensor_sync_tsens_idx(tsens.dac_offset);
66 temperature_sensor_ll_set_range(dac_offset[tsens.dac_offset].reg_val);
67 ESP_LOGI(TAG, "Config range [%d°C ~ %d°C], error < %d°C",
68 dac_offset[tsens.dac_offset].range_min,
69 dac_offset[tsens.dac_offset].range_max,
70 dac_offset[tsens.dac_offset].error_max);
71 tsens_hw_state = TSENS_HW_STATE_CONFIGURED;
72 return err;
73 }
74
temp_sensor_get_config(temp_sensor_config_t * tsens)75 esp_err_t temp_sensor_get_config(temp_sensor_config_t *tsens)
76 {
77 ESP_RETURN_ON_FALSE(tsens != NULL, ESP_ERR_INVALID_ARG, TAG, "no tsens specified");
78 tsens->dac_offset = temperature_sensor_ll_get_offset();
79 for (int i = TSENS_DAC_L0; i < TSENS_DAC_MAX; i++) {
80 if ((int)tsens->dac_offset == dac_offset[i].reg_val) {
81 tsens->dac_offset = dac_offset[i].index;
82 break;
83 }
84 }
85 tsens->clk_div = temperature_sensor_ll_get_clk_div();
86 return ESP_OK;
87 }
88
temp_sensor_start(void)89 esp_err_t temp_sensor_start(void)
90 {
91 esp_err_t err = ESP_OK;
92 if (tsens_hw_state != TSENS_HW_STATE_CONFIGURED) {
93 ESP_LOGE(TAG, "Is already running or not be configured");
94 err = ESP_ERR_INVALID_STATE;
95 }
96 regi2c_saradc_enable();
97 periph_module_enable(PERIPH_TEMPSENSOR_MODULE);
98 temperature_sensor_power_acquire();
99 temperature_sensor_ll_clk_enable(true);
100 temperature_sensor_ll_clk_sel(TEMPERATURE_SENSOR_CLK_SRC_DEFAULT);
101 tsens_hw_state = TSENS_HW_STATE_STARTED;
102 return err;
103 }
104
temp_sensor_stop(void)105 esp_err_t temp_sensor_stop(void)
106 {
107 regi2c_saradc_disable();
108 temperature_sensor_power_release();
109 tsens_hw_state = TSENS_HW_STATE_CONFIGURED;
110 return ESP_OK;
111 }
112
temp_sensor_read_raw(uint32_t * tsens_out)113 esp_err_t temp_sensor_read_raw(uint32_t *tsens_out)
114 {
115 ESP_RETURN_ON_FALSE(tsens_out != NULL, ESP_ERR_INVALID_ARG, TAG, "no tsens_out specified");
116 *tsens_out = temperature_sensor_ll_get_raw_value();
117 return ESP_OK;
118 }
119
read_delta_t_from_efuse(void)120 static esp_err_t read_delta_t_from_efuse(void)
121 {
122 ESP_RETURN_ON_ERROR(esp_efuse_rtc_calib_get_tsens_val(&s_deltaT), TAG, "Calibration error");
123 return ESP_OK;
124 }
125
parse_temp_sensor_raw_value(uint32_t tsens_raw)126 static float parse_temp_sensor_raw_value(uint32_t tsens_raw)
127 {
128 if (isnan(s_deltaT)) { //suggests that the value is not initialized
129 read_delta_t_from_efuse();
130 }
131 float result = tsens_raw - s_deltaT / 10.0f;
132 return result;
133 }
134
temp_sensor_read_celsius(float * celsius)135 esp_err_t temp_sensor_read_celsius(float *celsius)
136 {
137 ESP_RETURN_ON_FALSE(celsius != NULL, ESP_ERR_INVALID_ARG, TAG, "celsius points to nothing");
138 if (tsens_hw_state != TSENS_HW_STATE_STARTED) {
139 ESP_LOGE(TAG, "Has not been started");
140 return ESP_ERR_INVALID_STATE;
141 }
142 temp_sensor_config_t tsens;
143 temp_sensor_get_config(&tsens);
144 bool range_changed;
145 uint16_t tsens_out = temp_sensor_get_raw_value(&range_changed);
146 *celsius = parse_temp_sensor_raw_value(tsens_out);
147 if (*celsius < TEMPERATURE_SENSOR_LL_MEASURE_MIN || *celsius > TEMPERATURE_SENSOR_LL_MEASURE_MAX) {
148 ESP_LOGE(TAG, "Exceeding temperature measure range.");
149 return ESP_ERR_INVALID_STATE;
150 }
151 if (range_changed) {
152 temp_sensor_get_config(&tsens);
153 }
154 return ESP_OK;
155 }
156
