diff --git a/esp-hal/CHANGELOG.md b/esp-hal/CHANGELOG.md index 9613fcabf..3b4ec8961 100644 --- a/esp-hal/CHANGELOG.md +++ b/esp-hal/CHANGELOG.md @@ -54,6 +54,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Added `AnyPin::steal(pin_number)` (#2854) - `adc::{AdcCalSource, Attenuation, Resolution}` now implement `Hash` and `defmt::Format` (#2840) - `rtc_cntl::{RtcFastClock, RtcSlowClock, RtcCalSel}` now implement `PartialEq`, `Eq`, `Hash` and `defmt::Format` (#2840) +- Added `tsens::TemperatureSensor` peripheral for ESP32C6 and ESP32C3 (#2875) ### Changed diff --git a/esp-hal/src/lib.rs b/esp-hal/src/lib.rs index 53beb9cac..123073819 100644 --- a/esp-hal/src/lib.rs +++ b/esp-hal/src/lib.rs @@ -267,6 +267,8 @@ unstable_module! { pub mod touch; #[cfg(trace0)] pub mod trace; + #[cfg(tsens)] + pub mod tsens; #[cfg(any(twai0, twai1))] pub mod twai; #[cfg(usb_device)] diff --git a/esp-hal/src/soc/esp32c3/peripherals.rs b/esp-hal/src/soc/esp32c3/peripherals.rs index 00e6548a2..10180d390 100644 --- a/esp-hal/src/soc/esp32c3/peripherals.rs +++ b/esp-hal/src/soc/esp32c3/peripherals.rs @@ -52,6 +52,7 @@ crate::peripherals! { SW_INTERRUPT <= virtual, TIMG0 <= TIMG0, TIMG1 <= TIMG1, + TSENS <= virtual, TWAI0 <= TWAI0, UART0 <= UART0, UART1 <= UART1, diff --git a/esp-hal/src/soc/esp32c6/peripherals.rs b/esp-hal/src/soc/esp32c6/peripherals.rs index 666e7a252..6ae4c7c53 100644 --- a/esp-hal/src/soc/esp32c6/peripherals.rs +++ b/esp-hal/src/soc/esp32c6/peripherals.rs @@ -80,6 +80,7 @@ crate::peripherals! { TIMG0 <= TIMG0, TIMG1 <= TIMG1, TRACE0 <= TRACE, + TSENS <= virtual, TWAI0 <= TWAI0, TWAI1 <= TWAI1, UART0 <= UART0, diff --git a/esp-hal/src/system.rs b/esp-hal/src/system.rs index b87621462..38c2459cc 100755 --- a/esp-hal/src/system.rs +++ b/esp-hal/src/system.rs @@ -132,6 +132,9 @@ pub enum Peripheral { /// Systimer peripheral. #[cfg(systimer)] Systimer, + /// Temperature sensor peripheral. + #[cfg(tsens)] + Tsens, } impl Peripheral { @@ -398,6 +401,10 @@ impl PeripheralClockControl { Peripheral::Systimer => { perip_clk_en0.modify(|_, w| w.systimer_clk_en().bit(enable)); } + #[cfg(tsens)] + Peripheral::Tsens => { + perip_clk_en1.modify(|_, w| w.tsens_clk_en().bit(enable)); + } } } @@ -610,6 +617,16 @@ impl PeripheralClockControl { perip_rst_en0.modify(|_, w| w.systimer_rst().set_bit()); perip_rst_en0.modify(|_, w| w.systimer_rst().clear_bit()); } + #[cfg(all(tsens, esp32c6))] + Peripheral::Tsens => { + perip_rst_en0.modify(|_, w| w.tsens_rst().set_bit()); + perip_rst_en0.modify(|_, w| w.tsens_rst().clear_bit()); + } + #[cfg(all(tsens, esp32c3))] + Peripheral::Tsens => { + perip_rst_en1.modify(|_, w| w.tsens_rst().set_bit()); + perip_rst_en1.modify(|_, w| w.tsens_rst().clear_bit()); + } }); } } @@ -778,6 +795,16 @@ impl PeripheralClockControl { .systimer_conf() .modify(|_, w| w.systimer_clk_en().bit(enable)); } + #[cfg(tsens)] + Peripheral::Tsens => { + system + .tsens_clk_conf() + .modify(|_, w| w.tsens_clk_en().bit(enable)); + + system + .tsens_clk_conf() + .modify(|_, w| w.tsens_clk_sel().bit(enable)); + } } } @@ -977,6 +1004,15 @@ impl PeripheralClockControl { .systimer_conf() .modify(|_, w| w.systimer_rst_en().clear_bit()); } + #[cfg(tsens)] + Peripheral::Tsens => { + system + .tsens_clk_conf() + .modify(|_, w| w.tsens_rst_en().set_bit()); + system + .tsens_clk_conf() + .modify(|_, w| w.tsens_rst_en().clear_bit()); + } } } } diff --git a/esp-hal/src/tsens.rs b/esp-hal/src/tsens.rs new file mode 100644 index 000000000..6fe5cfc46 --- /dev/null +++ b/esp-hal/src/tsens.rs @@ -0,0 +1,189 @@ +//! # Temperature Sensor (tsens) +//! +//! ## Overview +//! +//! The Temperature Sensor peripheral is used to measure the internal +//! temperature inside the chip. The voltage is internally converted via an ADC +//! into a digital value, and has a measuring range of –40 °C to 125 °C. +//! The temperature value depends on factors like microcontroller clock +//! frequency or I/O load. Generally, the chip’s internal temperature is higher +//! than the operating ambient temperature. +//! +//! It is recommended to wait a few hundred microseconds after turning it on +//! before measuring, in order to allow the sensor to stabilize. +//! +//! ## Configuration +//! +//! The temperature sensor can be configured with different clock sources. +//! +//! ## Examples +//! +//! The following example will measure the internal chip temperature every +//! second, and print it +//! +//! ```rust, no_run +#![doc = crate::before_snippet!()] +//! # use esp_hal::tsens::{TemperatureSensor, Config}; +//! # use esp_hal::delay::Delay; +//! +//! let temperature_sensor = TemperatureSensor::new( +//! peripherals.TSENS, +//! Config::default() +//! ).unwrap(); +//! let delay = Delay::new(); +//! delay.delay_micros(200); +//! loop { +//! let temp = temperature_sensor.get_temperature(); +//! println!("Temperature: {:.2}°C", temp.to_celcius()); +//! delay.delay_millis(1_000); +//! } +//! # } +//! ``` +//! +//! ## Implementation State +//! +//! - Temperature calibration range is not supported +//! - Interrupts are not supported + +use crate::{ + peripheral::{Peripheral, PeripheralRef}, + peripherals::TSENS, + system::GenericPeripheralGuard, +}; + +/// Clock source for the temperature sensor +#[derive(Debug, Clone, Default, PartialEq, Eq, Copy, Hash)] +#[cfg_attr(feature = "defmt", derive(defmt::Format))] +pub enum ClockSource { + /// Use RC_FAST clock source + RcFast, + /// Use XTAL clock source + #[default] + Xtal, +} + +/// Temperature sensor configuration +#[derive(Debug, Clone, Default, PartialEq, Eq, Copy, Hash, procmacros::BuilderLite)] +#[cfg_attr(feature = "defmt", derive(defmt::Format))] +#[non_exhaustive] +pub struct Config { + clock_source: ClockSource, +} + +/// Temperature sensor configuration error +#[derive(Debug, Clone, PartialEq, Eq, Copy, Hash)] +#[non_exhaustive] +pub enum ConfigError {} + +/// Temperature value +/// This struct stores the raw ADC value, and can be used to calculate the +/// temperature in Celsius using the formula: +/// `(raw_value * 0.4386) - (offset * 27.88) - 20.52` +#[derive(Debug)] +pub struct Temperature { + /// Raw ADC value + pub raw_value: u8, + + /// Offset value - depends on the temperature range configured + pub offset: i8, +} + +impl Temperature { + /// Create a new temperature value + #[inline] + pub fn new(raw_value: u8, offset: i8) -> Self { + Self { raw_value, offset } + } + + /// Get the temperature in Celsius + #[inline] + pub fn to_celsius(&self) -> f32 { + (self.raw_value as f32) * 0.4386 - (self.offset as f32) * 27.88 - 20.52 + } + + /// Get the temperature in Fahrenheit + #[inline] + pub fn to_fahrenheit(&self) -> f32 { + let celsius = self.to_celsius(); + (celsius * 1.8) + 32.0 + } + + /// Get the temperature in Kelvin + #[inline] + pub fn to_kelvin(&self) -> f32 { + let celsius = self.to_celsius(); + celsius + 273.15 + } +} + +/// Temperature sensor driver +#[derive(Debug)] +pub struct TemperatureSensor<'d> { + _peripheral: PeripheralRef<'d, TSENS>, + _tsens_guard: GenericPeripheralGuard<{ crate::system::Peripheral::Tsens as u8 }>, + _abp_saradc_guard: GenericPeripheralGuard<{ crate::system::Peripheral::ApbSarAdc as u8 }>, +} + +impl<'d> TemperatureSensor<'d> { + /// Create a new temperature sensor instance with configuration + /// The sensor will be automatically powered up + pub fn new( + peripheral: impl Peripheral
+ 'd,
+ config: Config,
+ ) -> Result