Implement restriction-based pin filtering

Author: bugadani

Cargo.lock

@@ -28,7 +28,7 @@ strum                  = "0.27.2"
 inquire                = "0.9.1"
 clap                   = { version = "4.5.54", features = ["derive"] }
 env_logger             = "0.11.8"
-esp-metadata-generated = { version = "0.3.0", features = ["build-script"], git = "https://github.com/esp-rs/esp-hal", rev = "66c4313eb" }
+esp-metadata-generated = { version = "0.3.0", features = ["build-script"], git = "https://github.com/esp-rs/esp-hal", rev = "f9150cbbc" }
 log                    = "0.4.29"
 ratatui                = { version = "0.30.0", features = ["crossterm", "unstable"] }
 somni-expr             = "0.2.0"

Cargo.toml

@@ -1,6 +1,8 @@
-use esp_metadata_generated::MemoryRegion;
+use esp_metadata_generated::{MemoryRegion, PinInfo};
 use serde::{Deserialize, Serialize};
 
+use crate::modules::Module;
+
 pub mod cargo;
 pub mod config;
 pub mod modules;
@@ -60,6 +62,28 @@ impl Chip {
             .region("dram2_uninit")
             .expect("All chips should have a dram2_uninit region")
     }
+
+    pub fn pins(self) -> &'static [PinInfo] {
+        self.metadata().pins()
+    }
+
+    pub fn modules(self) -> &'static [Module] {
+        match self {
+            Chip::Esp32 => crate::modules::ESP32_MODULES,
+            Chip::Esp32c2 => crate::modules::ESP32C2_MODULES,
+            Chip::Esp32c3 => crate::modules::ESP32C3_MODULES,
+            Chip::Esp32c6 => crate::modules::ESP32C6_MODULES,
+            Chip::Esp32h2 => crate::modules::ESP32H2_MODULES,
+            Chip::Esp32s2 => crate::modules::ESP32S2_MODULES,
+            Chip::Esp32s3 => crate::modules::ESP32S3_MODULES,
+        }
+    }
+
+    pub fn module_by_name(&self, module_name: &str) -> Option<&'static Module> {
+        self.modules()
+            .iter()
+            .find(|module| module.name == module_name)
+    }
 }
 
 /// This turns a list of strings into a sentence, and appends it to the base string.

src/lib.rs

@@ -14,6 +14,7 @@ use esp_generate::{
 };
 use inquire::{Select, Text};
 use ratatui::crossterm::event;
+use std::fmt::Write;
 use std::{
     collections::HashMap,
     env, fs,
@@ -403,22 +404,51 @@ fn main() -> Result<()> {
     }
 
     if let Some(ref module_name) = selected_module {
-        if let Some(module) = esp_generate::modules::find_module(module_name) {
-            // Only set module-selected if there are GPIOs to reserve,
-            // otherwise the generated code would have unused `peripherals` variable
-            if !module.reserved_gpios.is_empty() {
-                selected.push("module-selected".to_string());
-                if module.octal_psram {
-                    selected.push("octal-psram".to_string());
-                }
-                let reserved_gpio_code = module
-                    .reserved_gpios
+        if let Some(module) = chip.module_by_name(module_name) {
+            let restricted_pins = chip.pins().iter().filter(|pin| {
+                module
+                    .remove_pins
+                    .iter()
+                    .any(|lim| pin.limitations.contains(&lim))
+            });
+            let strapping_pins = chip
+                .pins()
+                .iter()
+                .filter(|pin| pin.limitations.contains(&"strapping"))
+                .collect::<Vec<_>>();
+
+            let mut reserved_gpio_code = String::new();
+
+            if !strapping_pins.is_empty() {
+                let strapping = strapping_pins
                     .iter()
-                    .map(|g| format!("    let _ = peripherals.GPIO{g};"))
+                    .map(|pin| format!("// - GPIO{}", pin.pin))
                     .collect::<Vec<_>>()
                     .join("\n");
-                variables.push(("reserved_gpio_code".to_string(), reserved_gpio_code));
+                writeln!(
+                    &mut reserved_gpio_code,
+                    r#"// The following pins are used to bootstrap the chip. They are available
+                    // for use, but check the datasheet of the module for more information on them.
+                    {strapping}"#
+                )
+                .unwrap();
             }
+
+            // Only set module-selected if there are GPIOs to reserve
+            if restricted_pins.clone().next().is_some() {
+                let pin_plucker = restricted_pins
+                    .map(|pin| format!("    let _ = peripherals.GPIO{};", pin.pin))
+                    .collect::<Vec<_>>()
+                    .join("\n");
+                writeln!(
+                    &mut reserved_gpio_code,
+                    r#"// These GPIO pins are in use by some feature of the module and should not be used.
+                    {pin_plucker}"#
+                )
+                .unwrap();
+            };
+
+            variables.push(("reserved_gpio_code".to_string(), reserved_gpio_code));
         }
     }
 

src/main.rs

@@ -5,184 +5,128 @@ pub struct Module {
     pub name: &'static str,
     pub display_name: &'static str,
     pub chip: Chip,
-    pub reserved_gpios: &'static [u8],
-    pub octal_psram: bool,
+    pub remove_pins: &'static [&'static str],
 }
 
-pub const MODULES: &[Module] = &[
-    // ESP32-C6 modules (in-package flash, SPI flash pins 24-26,28-30 not exposed in HAL)
+pub const ESP32_MODULES: &[Module] = &[
     Module {
-        name: "esp32c6-wroom-1",
-        display_name: "ESP32-C6-WROOM-1 (4MB flash)",
-        chip: Chip::Esp32c6,
-        reserved_gpios: &[],
-        octal_psram: false,
-    },
-    Module {
-        name: "esp32c6-wroom-1u",
-        display_name: "ESP32-C6-WROOM-1U (4MB flash, U.FL)",
-        chip: Chip::Esp32c6,
-        reserved_gpios: &[],
-        octal_psram: false,
-    },
-    Module {
-        name: "esp32c6-mini-1",
-        display_name: "ESP32-C6-MINI-1 (4/8MB flash)",
-        chip: Chip::Esp32c6,
-        reserved_gpios: &[],
-        octal_psram: false,
-    },
-    // ESP32-S3 modules (SPI flash pins 26-32 not exposed in HAL)
-    // Quad flash/PSRAM modules: no additional reserved pins
-    // Octal flash/PSRAM modules: pins 33-37 connected to octal flash/PSRAM
-    Module {
-        name: "esp32s3-wroom-1",
-        display_name: "ESP32-S3-WROOM-1 (quad flash/PSRAM)",
-        chip: Chip::Esp32s3,
-        reserved_gpios: &[],
-        octal_psram: false,
-    },
-    Module {
-        name: "esp32s3-wroom-1u",
-        display_name: "ESP32-S3-WROOM-1U (quad flash/PSRAM, U.FL)",
-        chip: Chip::Esp32s3,
-        reserved_gpios: &[],
-        octal_psram: false,
-    },
-    Module {
-        name: "esp32s3-wroom-2",
-        display_name: "ESP32-S3-WROOM-2 (octal flash/PSRAM)",
-        chip: Chip::Esp32s3,
-        reserved_gpios: &[33, 34, 35, 36, 37],
-        octal_psram: true,
+        name: "esp32-wroom-32e",
+        display_name: "ESP32-WROOM-32E/32UE (4/8/16MB flash)",
+        chip: Chip::Esp32,
+        remove_pins: &["spi_flash", "esp32_pico_v3"],
     },
     Module {
-        name: "esp32s3-mini-1",
-        display_name: "ESP32-S3-MINI-1 (quad flash/PSRAM)",
-        chip: Chip::Esp32s3,
-        reserved_gpios: &[],
-        octal_psram: false,
+        name: "esp32-wrover-e",
+        display_name: "ESP32-WROVER-E/IE (8MB PSRAM)",
+        chip: Chip::Esp32,
+        remove_pins: &["spi_flash", "spi_psram", "esp32_pico_v3"],
     },
     Module {
-        name: "esp32s3-mini-1u",
-        display_name: "ESP32-S3-MINI-1U (quad flash/PSRAM, U.FL)",
-        chip: Chip::Esp32s3,
-        reserved_gpios: &[],
-        octal_psram: false,
+        name: "esp32-mini-1",
+        display_name: "ESP32-MINI-1 (4MB flash)",
+        chip: Chip::Esp32,
+        remove_pins: &["spi_flash", "esp32_pico_v3"],
     },
-    // ESP32-C3 modules (in-package flash, SPI flash pins 11-17 not exposed in HAL)
+];
+
+pub const ESP32C2_MODULES: &[Module] = &[Module {
+    name: "esp32c2-mini-1",
+    display_name: "ESP32-C2-MINI-1 (2/4MB flash)",
+    chip: Chip::Esp32c2,
+    remove_pins: &["spi_flash"],
+}];
+
+pub const ESP32C3_MODULES: &[Module] = &[
     Module {
         name: "esp32c3-wroom-02",
-        display_name: "ESP32-C3-WROOM-02 (4MB flash)",
-        chip: Chip::Esp32c3,
-        reserved_gpios: &[],
-        octal_psram: false,
-    },
-    Module {
-        name: "esp32c3-wroom-02u",
-        display_name: "ESP32-C3-WROOM-02U (4MB flash, U.FL)",
+        display_name: "ESP32-C3-WROOM-02/02U (4MB flash)",
         chip: Chip::Esp32c3,
-        reserved_gpios: &[],
-        octal_psram: false,
+        remove_pins: &["spi_flash"],
     },
     Module {
         name: "esp32c3-mini-1",
         display_name: "ESP32-C3-MINI-1 (4MB flash)",
         chip: Chip::Esp32c3,
-        reserved_gpios: &[],
-        octal_psram: false,
+        remove_pins: &["spi_flash"],
     },
-    // ESP32 modules (SPI flash pins 6-11 not exposed in HAL)
-    // WROVER-E has PSRAM on pins 16, 17 which need to be reserved
+];
+
+pub const ESP32C6_MODULES: &[Module] = &[
     Module {
-        name: "esp32-wroom-32e",
-        display_name: "ESP32-WROOM-32E (4/8/16MB flash)",
-        chip: Chip::Esp32,
-        reserved_gpios: &[],
-        octal_psram: false,
+        name: "esp32c6-wroom-1",
+        display_name: "ESP32-C6-WROOM-1/1U (4MB flash)",
+        chip: Chip::Esp32c6,
+        remove_pins: &["spi_flash"],
     },
     Module {
-        name: "esp32-wroom-32ue",
-        display_name: "ESP32-WROOM-32UE (4/8/16MB flash, U.FL)",
-        chip: Chip::Esp32,
-        reserved_gpios: &[],
-        octal_psram: false,
+        name: "esp32c6-mini-1",
+        display_name: "ESP32-C6-MINI-1 (4/8MB flash)",
+        chip: Chip::Esp32c6,
+        remove_pins: &["spi_flash"],
     },
+];
+
+pub const ESP32H2_MODULES: &[Module] = &[
     Module {
-        name: "esp32-wrover-e",
-        display_name: "ESP32-WROVER-E (8MB PSRAM)",
-        chip: Chip::Esp32,
-        reserved_gpios: &[16, 17],
-        octal_psram: false,
+        name: "esp32h2-wroom-02",
+        display_name: "ESP32-H2-WROOM-02 (4MB flash)",
+        chip: Chip::Esp32h2,
+        remove_pins: &["spi_flash"],
     },
     Module {
-        name: "esp32-mini-1",
-        display_name: "ESP32-MINI-1 (4MB flash)",
-        chip: Chip::Esp32,
-        reserved_gpios: &[],
-        octal_psram: false,
+        name: "esp32h2-mini-1",
+        display_name: "ESP32-H2-MINI-1 (4MB flash)",
+        chip: Chip::Esp32h2,
+        remove_pins: &["spi_flash"],
     },
-    // ESP32-S2 modules (SPI flash pins 26-32 not exposed in HAL)
+];
+
+pub const ESP32S2_MODULES: &[Module] = &[
     Module {
         name: "esp32s2-wroom",
         display_name: "ESP32-S2-WROOM (4MB flash)",
         chip: Chip::Esp32s2,
-        reserved_gpios: &[],
-        octal_psram: false,
+        remove_pins: &["spi_flash"],
     },
     Module {
         name: "esp32s2-wrover",
         display_name: "ESP32-S2-WROVER (2MB PSRAM)",
         chip: Chip::Esp32s2,
-        reserved_gpios: &[],
-        octal_psram: false,
+        remove_pins: &["spi_flash", "spi_psram"],
     },
     Module {
         name: "esp32s2-mini-1",
         display_name: "ESP32-S2-MINI-1 (4MB flash)",
         chip: Chip::Esp32s2,
-        reserved_gpios: &[],
-        octal_psram: false,
+        remove_pins: &["spi_flash"],
     },
-    // ESP32-C2 modules (SPI flash pins 11-17 not exposed in HAL)
+];
+
+pub const ESP32S3_MODULES: &[Module] = &[
     Module {
-        name: "esp32c2-mini-1",
-        display_name: "ESP32-C2-MINI-1 (2/4MB flash)",
-        chip: Chip::Esp32c2,
-        reserved_gpios: &[],
-        octal_psram: false,
+        name: "esp32s3-wroom-1",
+        display_name: "ESP32-S3-WROOM-1/1U (quad flash/PSRAM)",
+        chip: Chip::Esp32s3,
+        remove_pins: &["spi_flash"],
     },
-    // ESP32-H2 modules (in-package flash, no reserved GPIOs)
     Module {
-        name: "esp32h2-wroom-02",
-        display_name: "ESP32-H2-WROOM-02 (4MB flash)",
-        chip: Chip::Esp32h2,
-        reserved_gpios: &[],
-        octal_psram: false,
+        name: "esp32s3-wroom-2",
+        display_name: "ESP32-S3-WROOM-2 (octal flash/PSRAM)",
+        chip: Chip::Esp32s3,
+        remove_pins: &[],
     },
     Module {
-        name: "esp32h2-mini-1",
-        display_name: "ESP32-H2-MINI-1 (4MB flash)",
-        chip: Chip::Esp32h2,
-        reserved_gpios: &[],
-        octal_psram: false,
+        name: "esp32s3-mini-1",
+        display_name: "ESP32-S3-MINI-1/1U (quad flash/PSRAM)",
+        chip: Chip::Esp32s3,
+        remove_pins: &[],
     },
 ];
 
-pub fn modules_for_chip(chip: Chip) -> Vec<&'static Module> {
-    MODULES.iter().filter(|m| m.chip == chip).collect()
-}
-
-pub fn find_module(name: &str) -> Option<&'static Module> {
-    MODULES.iter().find(|m| m.name == name)
-}
-
 use crate::template::GeneratorOptionItem;
 
 /// Populates the module category in the template options with chip-specific modules.
 pub fn populate_module_category(chip: Chip, options: &mut [GeneratorOptionItem]) {
-    let modules = modules_for_chip(chip);
-
     for item in options.iter_mut() {
         let GeneratorOptionItem::Category(category) = item else {
             continue;
@@ -200,7 +144,7 @@ pub fn populate_module_category(chip: Chip, options: &mut [GeneratorOptionItem])
 
         category.options.clear();
 
-        for module in modules {
+        for module in chip.modules() {
             let mut opt = template_opt.clone();
             opt.name = module.name.to_string();
             opt.display_name = module.display_name.to_string();