Move timer instance config into driver metadata (#3626)

* Remove timg_timer1 symbol

* Ensure instances exist

* Rename timers to timergroup

* Remove unnecessary cfg

Author: bugadani

esp-hal/build.rs

@@ -168,7 +168,7 @@ fn main() -> Result<(), Box<dyn Error>> {
 
     for (key, value) in &cfg {
         if let Value::Bool(true) = value {
-            config_symbols.push(key);
+            config_symbols.push(key.to_string());
         }
     }
 
@@ -230,7 +230,7 @@ fn main() -> Result<(), Box<dyn Error>> {
 // Helper Functions
 
 fn copy_dir_all(
-    config_symbols: &[&str],
+    config_symbols: &[String],
     cfg: &HashMap<String, Value>,
     src: impl AsRef<Path>,
     dst: impl AsRef<Path>,
@@ -260,7 +260,7 @@ fn copy_dir_all(
 
 /// A naive pre-processor for linker scripts
 fn preprocess_file(
-    config: &[&str],
+    config: &[String],
     cfg: &HashMap<String, Value>,
     src: impl AsRef<Path>,
     dst: impl AsRef<Path>,
@@ -279,7 +279,7 @@ fn preprocess_file(
 
         if let Some(condition) = trimmed.strip_prefix("#IF ") {
             let should_take = take.iter().all(|v| *v);
-            let should_take = should_take && config.contains(&condition);
+            let should_take = should_take && config.iter().any(|c| c.as_str() == condition);
             take.push(should_take);
             continue;
         } else if trimmed == "#ELSE" {

esp-hal/src/config.rs

@@ -58,8 +58,9 @@ pub struct WatchdogConfig {
     /// Configures the reset watchdog timer.
     rwdt: WatchdogStatus,
     /// Configures the `timg0` watchdog timer.
+    #[cfg(timergroup_timg0)]
     timg0: WatchdogStatus,
-    #[cfg(timg1)]
+    #[cfg(timergroup_timg1)]
     /// Configures the `timg1` watchdog timer.
     ///
     /// By default, the bootloader does not enable this watchdog timer.

esp-hal/src/lib.rs

@@ -308,7 +308,7 @@ unstable_module! {
     // Drivers needed for initialization or they are tightly coupled to something else.
     #[cfg(any(adc1, adc2, dac))]
     pub mod analog;
-    #[cfg(any(systimer, timg0, timg1))]
+    #[cfg(any(systimer, timergroup))]
     pub mod timer;
     #[cfg(any(lp_clkrst, rtc_cntl))]
     pub mod rtc_cntl;
@@ -325,7 +325,6 @@ unstable_driver! {
     pub mod aes;
     #[cfg(assist_debug)]
     pub mod assist_debug;
-    #[cfg(any(xtensa, all(riscv, systimer)))]
     pub mod delay;
     #[cfg(ecc)]
     pub mod ecc;
@@ -634,6 +633,7 @@ pub fn init(config: Config) -> Peripherals {
                 }
             }
 
+            #[cfg(timergroup_timg0)]
             match config.watchdog.timg0() {
                 WatchdogStatus::Enabled(duration) => {
                     let mut timg0_wd = crate::timer::timg::Wdt::<crate::peripherals::TIMG0<'static>>::new();
@@ -645,7 +645,7 @@ pub fn init(config: Config) -> Peripherals {
                 }
             }
 
-            #[cfg(timg1)]
+            #[cfg(timergroup_timg1)]
             match config.watchdog.timg1() {
                 WatchdogStatus::Enabled(duration) => {
                     let mut timg1_wd = crate::timer::timg::Wdt::<crate::peripherals::TIMG1<'static>>::new();
@@ -664,9 +664,10 @@ pub fn init(config: Config) -> Peripherals {
 
             rtc.rwdt.disable();
 
+            #[cfg(timergroup_timg0)]
             crate::timer::timg::Wdt::<crate::peripherals::TIMG0<'static>>::new().disable();
 
-            #[cfg(timg1)]
+            #[cfg(timergroup_timg1)]
             crate::timer::timg::Wdt::<crate::peripherals::TIMG1<'static>>::new().disable();
         }
     }

esp-hal/src/system.rs

@@ -129,6 +129,7 @@ impl Peripheral {
         Peripheral::UsbDevice,
         #[cfg(systimer)]
         Peripheral::Systimer,
+        #[cfg(timg0)]
         Peripheral::Timg0,
         #[cfg(esp32c6)] // used by some wifi calibration steps.
         // TODO: We should probably automatically enable this when needed.

esp-hal/src/timer/mod.rs

@@ -60,7 +60,7 @@ use crate::{
 
 #[cfg(systimer)]
 pub mod systimer;
-#[cfg(any(timg0, timg1))]
+#[cfg(timergroup)]
 pub mod timg;
 
 /// Timer errors.
@@ -416,6 +416,7 @@ where
 crate::any_peripheral! {
     /// Any Timer peripheral.
     pub peripheral AnyTimer<'d> {
+        #[cfg(timergroup)]
         TimgTimer(timg::Timer<'d>),
         #[cfg(systimer)]
         SystimerAlarm(systimer::Alarm<'d>),

esp-hal/src/timer/timg.rs

@@ -69,7 +69,7 @@
 use core::marker::PhantomData;
 
 use super::Error;
-#[cfg(timg1)]
+#[cfg(timergroup_timg1)]
 use crate::peripherals::TIMG1;
 #[cfg(any(esp32c6, esp32h2))]
 use crate::soc::constants::TIMG_DEFAULT_CLK_SRC;
@@ -84,21 +84,21 @@ use crate::{
     time::{Duration, Instant, Rate},
 };
 
-const NUM_TIMG: usize = 1 + cfg!(timg1) as usize;
+const NUM_TIMG: usize = 1 + cfg!(timergroup_timg1) as usize;
 
 cfg_if::cfg_if! {
     // We need no locks when a TIMG has a single timer, and we don't need locks for ESP32
     // and S2 where the effective interrupt enable register (config) is not shared between
     // the timers.
-    if #[cfg(all(timg_timer1, not(any(esp32, esp32s2))))] {
+    if #[cfg(all(timergroup_timg_has_timer1, not(any(esp32, esp32s2))))] {
         use crate::sync::{lock, RawMutex};
         static INT_ENA_LOCK: [RawMutex; NUM_TIMG] = [const { RawMutex::new() }; NUM_TIMG];
     }
 }
 
 /// A timer group consisting of
-#[cfg_attr(not(timg_timer1), doc = "a general purpose timer")]
-#[cfg_attr(timg_timer1, doc = "2 timers")]
+#[cfg_attr(not(timergroup_timg_has_timer1), doc = "a general purpose timer")]
+#[cfg_attr(timergroup_timg_has_timer1, doc = "2 timers")]
 /// and a watchdog timer.
 pub struct TimerGroup<'d, T>
 where
@@ -108,7 +108,7 @@ where
     /// Timer 0
     pub timer0: Timer<'d>,
     /// Timer 1
-    #[cfg(timg_timer1)]
+    #[cfg(timergroup_timg_has_timer1)]
     pub timer1: Timer<'d>,
     /// Watchdog timer
     pub wdt: Wdt<T>,
@@ -125,6 +125,7 @@ pub trait TimerGroupInstance {
     fn wdt_interrupt() -> Interrupt;
 }
 
+#[cfg(timergroup_timg0)]
 impl TimerGroupInstance for TIMG0<'_> {
     fn id() -> u8 {
         0
@@ -186,7 +187,7 @@ impl TimerGroupInstance for TIMG0<'_> {
     }
 }
 
-#[cfg(timg1)]
+#[cfg(timergroup_timg1)]
 impl TimerGroupInstance for crate::peripherals::TIMG1<'_> {
     fn id() -> u8 {
         1
@@ -262,7 +263,7 @@ where
                 register_block: T::register_block(),
                 _lifetime: PhantomData,
             },
-            #[cfg(timg_timer1)]
+            #[cfg(timergroup_timg_has_timer1)]
             timer1: Timer {
                 timer: 1,
                 tg: T::id(),
@@ -325,11 +326,11 @@ impl super::Timer for Timer<'_> {
     fn async_interrupt_handler(&self) -> InterruptHandler {
         match (self.timer_group(), self.timer_number()) {
             (0, 0) => asynch::timg0_timer0_handler,
-            #[cfg(timg_timer1)]
+            #[cfg(timergroup_timg_has_timer1)]
             (0, 1) => asynch::timg0_timer1_handler,
-            #[cfg(timg1)]
+            #[cfg(timergroup_timg1)]
             (1, 0) => asynch::timg1_timer0_handler,
-            #[cfg(all(timg_timer1, timg1))]
+            #[cfg(all(timergroup_timg_has_timer1, timergroup_timg1))]
             (1, 1) => asynch::timg1_timer1_handler,
             _ => unreachable!(),
         }
@@ -338,11 +339,11 @@ impl super::Timer for Timer<'_> {
     fn peripheral_interrupt(&self) -> Interrupt {
         match (self.timer_group(), self.timer_number()) {
             (0, 0) => Interrupt::TG0_T0_LEVEL,
-            #[cfg(timg_timer1)]
+            #[cfg(timergroup_timg_has_timer1)]
             (0, 1) => Interrupt::TG0_T1_LEVEL,
-            #[cfg(timg1)]
+            #[cfg(timergroup_timg1)]
             (1, 0) => Interrupt::TG1_T0_LEVEL,
-            #[cfg(all(timg_timer1, timg1))]
+            #[cfg(all(timergroup_timg_has_timer1, timergroup_timg1))]
             (1, 1) => Interrupt::TG1_T1_LEVEL,
             _ => unreachable!(),
         }
@@ -398,11 +399,11 @@ impl Timer<'_> {
     pub(crate) fn set_interrupt_handler(&self, handler: InterruptHandler) {
         let interrupt = match (self.timer_group(), self.timer_number()) {
             (0, 0) => Interrupt::TG0_T0_LEVEL,
-            #[cfg(timg_timer1)]
+            #[cfg(timergroup_timg_has_timer1)]
             (0, 1) => Interrupt::TG0_T1_LEVEL,
-            #[cfg(timg1)]
+            #[cfg(timergroup_timg1)]
             (1, 0) => Interrupt::TG1_T0_LEVEL,
-            #[cfg(all(timg_timer1, timg1))]
+            #[cfg(all(timergroup_timg_has_timer1, timergroup_timg1))]
             (1, 1) => Interrupt::TG1_T1_LEVEL,
             _ => unreachable!(),
         };
@@ -560,7 +561,7 @@ impl Timer<'_> {
                     .t(self.timer as usize)
                     .config()
                     .modify(|_, w| w.level_int_en().bit(state));
-            } else if #[cfg(timg_timer1)] {
+            } else if #[cfg(timergroup_timg_has_timer1)] {
                 lock(&INT_ENA_LOCK[self.timer_group() as usize], || {
                     self.register_block()
                         .int_ena()
@@ -828,7 +829,7 @@ mod asynch {
     use crate::asynch::AtomicWaker;
 
     const NUM_WAKERS: usize = {
-        let timer_per_group = 1 + cfg!(timg_timer1) as usize;
+        let timer_per_group = 1 + cfg!(timergroup_timg_has_timer1) as usize;
         NUM_TIMG * timer_per_group
     };
 
@@ -859,7 +860,7 @@ mod asynch {
         });
     }
 
-    #[cfg(timg1)]
+    #[cfg(timergroup_timg1)]
     #[handler]
     pub(crate) fn timg1_timer0_handler() {
         handle_irq(Timer {
@@ -870,7 +871,7 @@ mod asynch {
         });
     }
 
-    #[cfg(timg_timer1)]
+    #[cfg(timergroup_timg_has_timer1)]
     #[handler]
     pub(crate) fn timg0_timer1_handler() {
         handle_irq(Timer {
@@ -881,7 +882,7 @@ mod asynch {
         });
     }
 
-    #[cfg(all(timg1, timg_timer1))]
+    #[cfg(all(timergroup_timg1, timergroup_timg_has_timer1))]
     #[handler]
     pub(crate) fn timg1_timer1_handler() {
         handle_irq(Timer {

esp-metadata/devices/esp32.toml

@@ -67,7 +67,6 @@ symbols = [
     "pdma",
     "phy",
     "psram",
-    "timg_timer1",
     "touch",
     "large_intr_status",
     "gpio_bank_1",
@@ -108,6 +107,10 @@ channel_ram_size = 64
 [device.spi_master]
 status = "supported"
 
+[device.timergroup]
+timg_has_timer1 = true
+instances = [{ name = "timg0" }, { name = "timg1" }]
+
 [device.uart]
 status = "supported"
 
@@ -146,7 +149,7 @@ status = "not_supported"
 [device.psram]
 [device.temp_sensor]
 [device.sleep]
-[device.timers]
+
 [device.ulp_fsm]
 
 ## Radio

esp-metadata/devices/esp32c2.toml

@@ -80,6 +80,9 @@ bus_timeout_is_exponential = true
 [device.spi_master]
 status = "supported"
 
+[device.timergroup]
+instances = [{ name = "timg0" }]
+
 [device.uart]
 status = "supported"
 
@@ -103,7 +106,6 @@ status = "supported"
 [device.io_mux]
 [device.temp_sensor]
 [device.sleep]
-[device.timers]
 [device.systimer]
 
 ## Radio

esp-metadata/devices/esp32c3.toml

@@ -100,6 +100,9 @@ channel_ram_size = 48
 [device.spi_master]
 status = "supported"
 
+[device.timergroup]
+instances = [{ name = "timg0" }, { name = "timg1" }]
+
 [device.uart]
 status = "supported"
 
@@ -129,7 +132,6 @@ status = "not_supported"
 [device.interrupts]
 [device.io_mux]
 [device.temp_sensor]
-[device.timers]
 [device.sleep]
 [device.systimer]
 

esp-metadata/devices/esp32c6.toml

@@ -131,6 +131,9 @@ channel_ram_size = 48
 [device.spi_master]
 status = "supported"
 
+[device.timergroup]
+instances = [{ name = "timg0" }, { name = "timg1" }]
+
 [device.uart]
 status = "supported"
 
@@ -172,7 +175,6 @@ has_wifi6 = true
 [device.sleep]
 [device.temp_sensor]
 [device.systimer]
-[device.timers]
 [device.ulp_riscv]
 
 ## Radio