/* * SPDX-FileCopyrightText: 2016-2021 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ #include #include #include #include "esp_types.h" #include "freertos/FreeRTOS.h" #include "freertos/semphr.h" #include "esp_log.h" #include "esp_check.h" #include "soc/rtc_cntl_reg.h" #include "soc/rtc_io_reg.h" #include "soc/rtc_io_struct.h" #include "soc/sens_reg.h" #include "soc/sens_struct.h" #include "driver/temp_sensor.h" #include "regi2c_ctrl.h" #include "esp_log.h" #include "esp_efuse_rtc_table.h" #include "esp_private/sar_periph_ctrl.h" static const char *TAG = "tsens"; #define TSENS_XPD_WAIT_DEFAULT 0xFF /* Set wait cycle time(8MHz) from power up to reset enable. */ #define TEMPERATURE_SENSOR_MEASURE_MAX (125) #define TEMPERATURE_SENSOR_MEASURE_MIN (-40) const tsens_dac_offset_t dac_offset[TSENS_DAC_MAX] = { /* DAC Offset reg_val min max error */ {TSENS_DAC_L0, -2, 5, 50, 125, 3}, {TSENS_DAC_L1, -1, 7, 20, 100, 2}, {TSENS_DAC_L2, 0, 15, -10, 80, 1}, {TSENS_DAC_L3, 1, 11, -30, 50, 2}, {TSENS_DAC_L4, 2, 10, -40, 20, 3}, }; typedef enum { TSENS_HW_STATE_UNCONFIGURED, TSENS_HW_STATE_CONFIGURED, TSENS_HW_STATE_STARTED, } tsens_hw_state_t; static tsens_hw_state_t tsens_hw_state = TSENS_HW_STATE_UNCONFIGURED; static SemaphoreHandle_t rtc_tsens_mux = NULL; static float s_deltaT = NAN; // Unused number esp_err_t temp_sensor_set_config(temp_sensor_config_t tsens) { esp_err_t err = ESP_OK; if (tsens_hw_state == TSENS_HW_STATE_STARTED) { ESP_LOGE(TAG, "Do not configure the temp sensor when it's running!"); err = ESP_ERR_INVALID_STATE; } CLEAR_PERI_REG_MASK(RTC_CNTL_ANA_CONF_REG, RTC_CNTL_SAR_I2C_FORCE_PD_M); SET_PERI_REG_MASK(RTC_CNTL_ANA_CONF_REG, RTC_CNTL_SAR_I2C_FORCE_PU_M); CLEAR_PERI_REG_MASK(ANA_CONFIG_REG, I2C_SAR_M); SET_PERI_REG_MASK(ANA_CONFIG2_REG, ANA_SAR_CFG2_M); REGI2C_WRITE_MASK(I2C_SAR_ADC, I2C_SARADC_TSENS_DAC, dac_offset[tsens.dac_offset].set_val); SENS.sar_tctrl.tsens_clk_div = tsens.clk_div; SENS.sar_tctrl2.tsens_xpd_wait = TSENS_XPD_WAIT_DEFAULT; SENS.sar_tctrl2.tsens_reset = 1;// Reset the temp sensor. SENS.sar_tctrl2.tsens_reset = 0;// Clear the reset status. temp_sensor_sync_tsens_idx(tsens.dac_offset); ESP_LOGI(TAG, "Config temperature range [%d°C ~ %d°C], error < %d°C", dac_offset[tsens.dac_offset].range_min, dac_offset[tsens.dac_offset].range_max, dac_offset[tsens.dac_offset].error_max); tsens_hw_state = TSENS_HW_STATE_CONFIGURED; return err; } esp_err_t temp_sensor_get_config(temp_sensor_config_t *tsens) { ESP_RETURN_ON_FALSE(tsens != NULL, ESP_ERR_INVALID_ARG, TAG, "no tsens specified"); CLEAR_PERI_REG_MASK(RTC_CNTL_ANA_CONF_REG, RTC_CNTL_SAR_I2C_FORCE_PD_M); SET_PERI_REG_MASK(RTC_CNTL_ANA_CONF_REG, RTC_CNTL_SAR_I2C_FORCE_PU_M); CLEAR_PERI_REG_MASK(ANA_CONFIG_REG, I2C_SAR_M); SET_PERI_REG_MASK(ANA_CONFIG2_REG, ANA_SAR_CFG2_M); tsens->dac_offset = REGI2C_READ_MASK(I2C_SAR_ADC, I2C_SARADC_TSENS_DAC); for (int i = TSENS_DAC_L0; i < TSENS_DAC_MAX; i++) { if ((int)tsens->dac_offset == dac_offset[i].set_val) { tsens->dac_offset = dac_offset[i].index; break; } } tsens->clk_div = SENS.sar_tctrl.tsens_clk_div; return ESP_OK; } esp_err_t temp_sensor_start(void) { esp_err_t err = ESP_OK; if (tsens_hw_state != TSENS_HW_STATE_CONFIGURED) { ESP_LOGE(TAG, "Temperature sensor is already running or not be configured"); err = ESP_ERR_INVALID_STATE; } if (rtc_tsens_mux == NULL) { rtc_tsens_mux = xSemaphoreCreateMutex(); } ESP_RETURN_ON_FALSE(rtc_tsens_mux != NULL, ESP_ERR_NO_MEM, TAG, "failed to create mutex"); temperature_sensor_power_acquire(); SENS.sar_tctrl.tsens_dump_out = 0; tsens_hw_state = TSENS_HW_STATE_STARTED; return err; } esp_err_t temp_sensor_stop(void) { temperature_sensor_power_release(); if (rtc_tsens_mux != NULL) { vSemaphoreDelete(rtc_tsens_mux); rtc_tsens_mux = NULL; } tsens_hw_state = TSENS_HW_STATE_CONFIGURED; return ESP_OK; } esp_err_t temp_sensor_read_raw(uint32_t *tsens_out) { ESP_RETURN_ON_FALSE(tsens_out != NULL, ESP_ERR_INVALID_ARG, TAG, "no tsens_out specified"); ESP_RETURN_ON_FALSE(rtc_tsens_mux != NULL, ESP_ERR_INVALID_STATE, TAG, "mutex not ready"); xSemaphoreTake(rtc_tsens_mux, portMAX_DELAY); SENS.sar_tctrl.tsens_dump_out = 1; while (!SENS.sar_tctrl.tsens_ready); *tsens_out = SENS.sar_tctrl.tsens_out; SENS.sar_tctrl.tsens_dump_out = 0; xSemaphoreGive(rtc_tsens_mux); return ESP_OK; } static void read_delta_t_from_efuse(void) { uint32_t version = esp_efuse_rtc_table_read_calib_version(); if (version == 1 || version == 2) { // fetch calibration value for temp sensor from eFuse s_deltaT = esp_efuse_rtc_table_get_parsed_efuse_value(RTCCALIB_IDX_TMPSENSOR, false) / 10.0; } else { // no value to fetch, use 0. s_deltaT = 0; } ESP_LOGD(TAG, "s_deltaT = %f\n", s_deltaT); } static float parse_temp_sensor_raw_value(int16_t tsens_raw) { if (isnan(s_deltaT)) { //suggests that the value is not initialized read_delta_t_from_efuse(); } float result = tsens_raw - s_deltaT / 10.0; return result; } esp_err_t temp_sensor_read_celsius(float *celsius) { ESP_RETURN_ON_FALSE(celsius != NULL, ESP_ERR_INVALID_ARG, TAG, "celsius points to nothing"); temp_sensor_config_t tsens; temp_sensor_get_config(&tsens); bool range_changed; int16_t tsens_out = temp_sensor_get_raw_value(&range_changed); *celsius = parse_temp_sensor_raw_value(tsens_out); if (*celsius < TEMPERATURE_SENSOR_MEASURE_MIN || *celsius > TEMPERATURE_SENSOR_MEASURE_MAX) { ESP_LOGE(TAG, "Exceeding temperature measure range."); return ESP_ERR_INVALID_STATE; } if (range_changed) { temp_sensor_get_config(&tsens); } return ESP_OK; }