Generate macros from metadata (#3604)

* Generate macros from metadata

* Don't generate metadata env vars

* Add trm link, change cores to integer

* Port RMT memory constants

* Add some I2C flags

* Auto-generate PeriConfig, remove trait

* Make sure memory_range is hidden

Author: bugadani

esp-hal/Cargo.toml

@@ -45,7 +45,6 @@ strum                    = { version = "0.27.1", default-features = false, featu
 
 esp-build                = { version = "0.3.0", path = "../esp-build" }
 esp-config               = { version = "0.4.0", path = "../esp-config" }
-esp-metadata             = { version = "0.7.0", path = "../esp-metadata", default-features = false }
 procmacros               = { version = "0.18.0", package = "esp-hal-procmacros", path = "../esp-hal-procmacros" }
 
 # Dependencies that are optional because they are used by unstable drivers.

esp-hal/build.rs

@@ -41,6 +41,7 @@ fn main() -> Result<(), Box<dyn Error>> {
 
     // Define all necessary configuration symbols for the configured device:
     config.define_symbols();
+    config.generate_metadata();
 
     // Place all linker scripts in `OUT_DIR`, and instruct Cargo how to find these
     // files:

esp-hal/src/etm.rs

@@ -19,7 +19,7 @@
 //! channel will trigger the corresponding task automatically.
 //!
 //! For more information, please refer to the
-#![doc = concat!("[ESP-IDF documentation](https://docs.espressif.com/projects/esp-idf/en/latest/", crate::chip!(), "/api-reference/peripherals/etm.html)")]
+#![doc = concat!("[ESP-IDF documentation](https://docs.espressif.com/projects/esp-idf/en/latest/", chip!(), "/api-reference/peripherals/etm.html)")]
 //! ## Examples
 //!
 //! ### Control LED by the button via ETM

esp-hal/src/i2c/master/mod.rs

@@ -290,12 +290,12 @@ pub enum SoftwareTimeout {
 #[instability::unstable]
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
-#[cfg(not(any(esp32, esp32s2)))]
+#[cfg(i2c_master_has_fsm_timeouts)]
 pub struct FsmTimeout {
     value: u8,
 }
 
-#[cfg(not(any(esp32, esp32s2)))]
+#[cfg(i2c_master_has_fsm_timeouts)]
 impl FsmTimeout {
     const FSM_TIMEOUT_MAX: u8 = 23;
 
@@ -331,7 +331,7 @@ impl FsmTimeout {
     }
 }
 
-#[cfg(not(any(esp32, esp32s2)))]
+#[cfg(i2c_master_has_fsm_timeouts)]
 impl Default for FsmTimeout {
     fn default() -> Self {
         Self::new_const::<{ Self::FSM_TIMEOUT_DEFAULT }>()
@@ -596,14 +596,14 @@ pub struct Config {
     /// Sets the threshold value for the unchanged period of the SCL_FSM.
     ///
     /// Default value: 16.
-    #[cfg(not(any(esp32, esp32s2)))]
+    #[cfg(i2c_master_has_fsm_timeouts)]
     #[builder_lite(unstable)]
     scl_st_timeout: FsmTimeout,
 
     /// Sets the threshold for the unchanged duration of the SCL_MAIN_FSM.
     ///
     /// Default value: 16.
-    #[cfg(not(any(esp32, esp32s2)))]
+    #[cfg(i2c_master_has_fsm_timeouts)]
     #[builder_lite(unstable)]
     scl_main_st_timeout: FsmTimeout,
 }
@@ -614,9 +614,9 @@ impl Default for Config {
             frequency: Rate::from_khz(100),
             timeout: BusTimeout::BusCycles(10),
             software_timeout: SoftwareTimeout::PerByte(Duration::from_millis(1)),
-            #[cfg(not(any(esp32, esp32s2)))]
+            #[cfg(i2c_master_has_fsm_timeouts)]
             scl_st_timeout: Default::default(),
-            #[cfg(not(any(esp32, esp32s2)))]
+            #[cfg(i2c_master_has_fsm_timeouts)]
             scl_main_st_timeout: Default::default(),
         }
     }
@@ -1540,7 +1540,7 @@ impl Driver<'_> {
         self.set_frequency(config)?;
 
         // Configure additional timeouts
-        #[cfg(not(any(esp32, esp32s2)))]
+        #[cfg(i2c_master_has_fsm_timeouts)]
         {
             self.regs()
                 .scl_st_time_out()
@@ -2236,7 +2236,7 @@ impl Driver<'_> {
             ));
         }
 
-        #[cfg(not(any(esp32, esp32s2)))]
+        #[cfg(i2c_master_has_fsm_timeouts)]
         {
             if r.scl_st_to().bit_is_set() {
                 return Err(Error::Timeout);
@@ -2817,7 +2817,7 @@ fn calculate_chunk_size(remaining: usize) -> usize {
     }
 }
 
-#[cfg(not(any(esp32, esp32s2)))]
+#[cfg(i2c_master_has_hw_bus_clear)]
 mod bus_clear {
     use super::*;
 
@@ -2868,7 +2868,7 @@ mod bus_clear {
     }
 }
 
-#[cfg(any(esp32, esp32s2))]
+#[cfg(not(i2c_master_has_hw_bus_clear))]
 mod bus_clear {
     use super::*;
     use crate::gpio::AnyPin;

esp-hal/src/lib.rs

@@ -182,9 +182,22 @@
 // MUST be the first module
 mod fmt;
 
+#[macro_use]
+/// This module contains code generated by `esp-metadata`.
+///
+/// The main API is the [`property!`] macro, which takes a string key and
+/// returns a value. This macro is available anywhere inside esp-hal, without
+/// additional imports. Note that this macro can't be used in public macros, as
+/// they will fail to compile.
+mod _generated {
+    // This must go before other code, so that they can see macros.
+    // Generated by esp-metadata.
+    include!(concat!(env!("OUT_DIR"), "/_generated.rs"));
+}
+
 use core::marker::PhantomData;
 
-metadata!("build_info", CHIP_NAME, crate::chip!());
+metadata!("build_info", CHIP_NAME, chip!());
 
 #[cfg(riscv)]
 #[cfg_attr(docsrs, doc(cfg(feature = "unstable")))]

esp-hal/src/macros.rs

@@ -41,12 +41,12 @@ macro_rules! before_snippet {
 #[macro_export]
 macro_rules! trm_markdown_link {
     () => {
-        concat!("[Technical Reference Manual](", $crate::trm_link!(), ")")
+        concat!("[Technical Reference Manual](", property!("trm"), ")")
     };
     ($anchor:literal) => {
         concat!(
             "[Technical Reference Manual](",
-            $crate::trm_link!(),
+            property!("trm"),
             "#",
             $anchor,
             ")"

esp-hal/src/rmt.rs

@@ -38,7 +38,7 @@
 )]
 #![doc = ""]
 //! For more information, please refer to the
-#![doc = concat!("[ESP-IDF documentation](https://docs.espressif.com/projects/esp-idf/en/latest/", crate::chip!(), "/api-reference/peripherals/rmt.html)")]
+#![doc = concat!("[ESP-IDF documentation](https://docs.espressif.com/projects/esp-idf/en/latest/", chip!(), "/api-reference/peripherals/rmt.html)")]
 //! ## Configuration
 //! Each TX/RX channel has the same functionality controlled by a dedicated set
 //! of registers and is able to independently transmit or receive data. TX
@@ -241,7 +241,6 @@ use crate::{
     },
     handler,
     peripherals::{Interrupt, RMT},
-    soc::constants,
     system::{self, GenericPeripheralGuard},
     time::Rate,
 };
@@ -329,7 +328,7 @@ impl PulseCode for u32 {
 
 #[inline]
 fn channel_ram_start(ch_num: impl Into<usize>) -> *mut u32 {
-    (constants::RMT_RAM_START + ch_num.into() * constants::RMT_CHANNEL_RAM_SIZE * 4) as *mut u32
+    (property!("rmt.ram_start") + ch_num.into() * property!("rmt.channel_ram_size") * 4) as *mut u32
 }
 
 /// Channel configuration for TX channels
@@ -632,7 +631,7 @@ where
     /// Wait for the transaction to complete
     pub fn wait(mut self) -> Result<C, (Error, C)> {
         let memsize =
-            constants::RMT_CHANNEL_RAM_SIZE * <C as TxChannelInternal>::memsize() as usize;
+            property!("rmt.channel_ram_size") * <C as TxChannelInternal>::memsize() as usize;
 
         while !self.remaining_data.is_empty() {
             // wait for TX-THR
@@ -724,7 +723,8 @@ where
         <C as TxChannelInternal>::update();
 
         let ptr = channel_ram_start(C::CHANNEL);
-        for idx in 0..constants::RMT_CHANNEL_RAM_SIZE * <C as TxChannelInternal>::memsize() as usize
+        for idx in
+            0..property!("rmt.channel_ram_size") * <C as TxChannelInternal>::memsize() as usize
         {
             unsafe {
                 ptr.add(idx).write_volatile(0);
@@ -1234,7 +1234,7 @@ pub trait TxChannel: TxChannelInternal {
     where
         Self: Sized,
     {
-        if data.len() > constants::RMT_CHANNEL_RAM_SIZE * Self::memsize() as usize {
+        if data.len() > property!("rmt.channel_ram_size") * Self::memsize() as usize {
             return Err(Error::Overflow);
         }
 
@@ -1292,7 +1292,7 @@ pub trait RxChannel: RxChannelInternal {
     where
         Self: Sized,
     {
-        if data.len() > constants::RMT_CHANNEL_RAM_SIZE * Self::memsize() as usize {
+        if data.len() > property!("rmt.channel_ram_size") * Self::memsize() as usize {
             return Err(Error::InvalidDataLength);
         }
 
@@ -1373,7 +1373,7 @@ pub trait TxChannelAsync: TxChannelInternal {
     where
         Self: Sized,
     {
-        if data.len() > constants::RMT_CHANNEL_RAM_SIZE * Self::memsize() as usize {
+        if data.len() > property!("rmt.channel_ram_size") * Self::memsize() as usize {
             return Err(Error::InvalidDataLength);
         }
 
@@ -1435,7 +1435,7 @@ pub trait RxChannelAsync: RxChannelInternal {
     where
         Self: Sized,
     {
-        if data.len() > constants::RMT_CHANNEL_RAM_SIZE * Self::memsize() as usize {
+        if data.len() > property!("rmt.channel_ram_size") * Self::memsize() as usize {
             return Err(Error::InvalidDataLength);
         }
 
@@ -1603,7 +1603,7 @@ pub trait TxChannelInternal {
         }
 
         let ptr = channel_ram_start(Self::CHANNEL);
-        let memsize = constants::RMT_CHANNEL_RAM_SIZE * Self::memsize() as usize;
+        let memsize = property!("rmt.channel_ram_size") * Self::memsize() as usize;
         for (idx, entry) in data.iter().take(memsize).enumerate() {
             unsafe {
                 ptr.add(idx).write_volatile(*entry);

esp-hal/src/rng.rs

@@ -25,7 +25,7 @@
 //! considered pseudo-random only.
 //!
 //! For more information, please refer to the
-#![doc = concat!("[ESP-IDF documentation](https://docs.espressif.com/projects/esp-idf/en/latest/", crate::chip!(), "/api-reference/system/random.html)")]
+#![doc = concat!("[ESP-IDF documentation](https://docs.espressif.com/projects/esp-idf/en/latest/", chip!(), "/api-reference/system/random.html)")]
 //! ## Configuration
 //! To use the [Rng] Driver, you need to initialize it with the RNG peripheral.
 //! Once initialized, you can generate random numbers by calling the `random`

esp-hal/src/soc/esp32/mod.rs

@@ -20,21 +20,6 @@ pub mod gpio;
 pub mod peripherals;
 pub(crate) mod regi2c;
 
-/// The name of the chip ("esp32") as `&str`
-#[macro_export]
-macro_rules! chip {
-    () => {
-        "esp32"
-    };
-}
-
-/// A link to the Technical Reference Manual (TRM) for the chip.
-#[doc(hidden)]
-#[macro_export]
-macro_rules! trm_link {
-    () => { "https://www.espressif.com/sites/default/files/documentation/esp32_technical_reference_manual_en.pdf" };
-}
-
 #[cfg_attr(not(feature = "unstable"), allow(unused))]
 pub(crate) mod constants {
     use crate::time::Rate;
@@ -43,10 +28,6 @@ pub(crate) mod constants {
     pub const I2S_SCLK: u32 = 160_000_000;
     /// The default clock source for I2S operations.
     pub const I2S_DEFAULT_CLK_SRC: u32 = 2;
-    /// The starting address of the Remote Control (RMT) module's RAM.
-    pub const RMT_RAM_START: usize = 0x3ff56800;
-    /// The size (number of pulse codes) of each RMT channel's dedicated RAM.
-    pub const RMT_CHANNEL_RAM_SIZE: usize = 64;
     /// A reference clock tick of 1 MHz.
     pub const REF_TICK: Rate = Rate::from_mhz(1);
 }

esp-hal/src/soc/esp32c2/mod.rs

@@ -13,21 +13,6 @@ pub mod gpio;
 pub mod peripherals;
 pub(crate) mod regi2c;
 
-/// The name of the chip ("esp32c2") as `&str`
-#[macro_export]
-macro_rules! chip {
-    () => {
-        "esp32c2"
-    };
-}
-
-/// A link to the Technical Reference Manual (TRM) for the chip.
-#[doc(hidden)]
-#[macro_export]
-macro_rules! trm_link {
-    () => { "https://www.espressif.com/sites/default/files/documentation/esp8684_technical_reference_manual_en.pdf" };
-}
-
 #[allow(unused)]
 pub(crate) mod registers {
     pub const INTERRUPT_MAP_BASE: u32 = 0x600c2000;