Add SOC config that is hidden from the peri table (#3839)

Author: bugadani

esp-metadata/src/cfg.rs

@@ -71,12 +71,15 @@ pub(crate) struct PeriInstance<I = EmptyInstanceConfig> {
 }
 
 /// A single cell in the peripheral support table.
+#[derive(Default)]
 pub(crate) struct SupportItem {
     /// The human-readable name of the driver in the table (leftmost cell.)
     pub name: &'static str,
     /// The ID of the driver ([device.<config_group>]) in the TOML, that this
     /// item corresponds to.
     pub config_group: &'static str,
+    /// If true, this driver is not shown in the peripheral support table.
+    pub hide_from_peri_table: bool,
 }
 
 /// Define driver configuration structs, and a PeriConfig struct
@@ -88,6 +91,9 @@ macro_rules! driver_configs {
     (@property (Option<u32>)   $self:ident, $config:ident) => { Value::from($self.$config) };
     (@property ($($other:ty)*) $self:ident, $config:ident) => { Value::Unset };  // Not a property
 
+    (@default $default:literal) => { $default };
+    (@default $default:literal $opt:literal) => { $opt };
+
     // Creates a single struct
     (@one
         $struct:ident $(<$instance_config:ident>)? ($group:ident) {
@@ -129,6 +135,7 @@ macro_rules! driver_configs {
             driver: $driver:ident,
             // Driver name, used in the generated documentation.
             name: $name:literal,
+            $(hide_from_peri_table: $hide:literal,)?
             $(has_computed_properties: $computed:literal,)?
             properties: $tokens:tt
         },
@@ -156,6 +163,7 @@ macro_rules! driver_configs {
                         SupportItem {
                             name: $name,
                             config_group: stringify!($driver),
+                            hide_from_peri_table: driver_configs!(@default false $($hide)?),
                         },
                     )+
                 ]
@@ -224,6 +232,13 @@ macro_rules! driver_configs {
 
 // TODO: sort this similar to how the product portfolio is organized
 driver_configs![
+    SocProperties {
+        driver: soc,
+        name: "SOC",
+        hide_from_peri_table: true,
+        properties: {}
+    },
+
     AdcProperties {
         driver: adc,
         name: "ADC",

esp-metadata/src/lib.rs

@@ -979,7 +979,12 @@ pub fn generate_chip_support_status(output: &mut impl Write) -> std::fmt::Result
 
     // Calculate the width of the first column.
     let driver_col_width = std::iter::once("Driver")
-        .chain(PeriConfig::drivers().iter().map(|i| i.name))
+        .chain(
+            PeriConfig::drivers()
+                .iter()
+                .filter(|i| !i.hide_from_peri_table)
+                .map(|i| i.name),
+        )
         .map(|c| c.len())
         .max()
         .unwrap();
@@ -1003,7 +1008,15 @@ pub fn generate_chip_support_status(output: &mut impl Write) -> std::fmt::Result
     writeln!(output)?;
 
     // Driver support status
-    for SupportItem { name, config_group } in PeriConfig::drivers() {
+    for SupportItem {
+        name,
+        config_group,
+        hide_from_peri_table,
+    } in PeriConfig::drivers()
+    {
+        if *hide_from_peri_table {
+            continue;
+        }
         write!(output, "| {name:driver_col_width$} |")?;
         for chip in Chip::iter() {
             let config = Config::for_chip(&chip);