ignore if not exists

Author: burrbull

CHANGELOG-python.md

@@ -6,6 +6,7 @@ This changelog tracks the Python `svdtools` project. See
 ## [Unreleased]
 
 * `-1` for default enum value
+* Ignore rule if starts with "?@" and no matched instances
 
 ## [v0.1.26] 2023-03-28
 

CHANGELOG-rust.md

@@ -13,6 +13,7 @@ This changelog tracks the Rust `svdtools` project. See
 
 ## [v0.3.5] 2023-11-30
 
+* Ignore rule if starts with "?@" and no matched instances
 * Move field with derived enums before other
 * `-1` for default enum value
 * Update `displayName` during collect, improve searching common `description`

README.md

@@ -351,7 +351,18 @@ _rebase:
             _strip_end:
                 - "_POSTFIX_"
 
-
+# You can list glob-like rules separated by commas to cover more periperals or registers at time.
+# If rule is optional (peripheral may be missing in some devices) add `?@` in the header.
+# Don't abuse it. First test not optional rule.
+"?@TIM[18],TIM20":
+  CR2:
+    # Fields also support collecting in arrays
+    _array:
+      OIS?:
+        description: Output Idle state %s (OC%s output)
+      # Optional rules are supported here too
+      "?@OIS?N":
+        description: Output Idle state %s (OC%sN output)
 ```
 
 ### Name Matching

src/patch/device.rs

@@ -9,7 +9,7 @@ use std::{fs::File, io::Read, path::Path};
 use super::iterators::{MatchIter, Matched};
 use super::peripheral::{PeripheralExt, RegisterBlockExt};
 use super::yaml_ext::{AsType, GetVal};
-use super::{abspath, matchname, Config, PatchResult, VAL_LVL};
+use super::{abspath, matchname, Config, PatchResult, Spec, VAL_LVL};
 use super::{make_address_block, make_address_blocks, make_cpu, make_interrupt, make_peripheral};
 use super::{make_dim_element, modify_dim_element, modify_register_properties};
 
@@ -418,12 +418,13 @@ impl DeviceExt for Device {
     ) -> PatchResult {
         // Find all peripherals that match the spec
         let mut pcount = 0;
+        let (pspec, ignore) = pspec.spec();
         for ptag in self.iter_peripherals(pspec) {
             pcount += 1;
             ptag.process(peripheral, config)
                 .with_context(|| format!("Processing peripheral `{}`", ptag.name))?;
         }
-        if pcount == 0 {
+        if !ignore && pcount == 0 {
             Err(anyhow!(
                 "Could not find `{pspec}. Present peripherals: {}.`",
                 self.peripherals.iter().map(|p| p.name.as_str()).join(", ")

src/patch/mod.rs

@@ -717,3 +717,18 @@ fn common_description(descs: &[Option<&str>], dim_index: &[String]) -> Option<Op
     }
     same.then(|| desc0.map(Into::into))
 }
+
+pub trait Spec {
+    /// Return specification and `ignore_if_not_exists` flag
+    fn spec(&self) -> (&str, bool);
+}
+
+impl Spec for str {
+    fn spec(&self) -> (&str, bool) {
+        if let Some(s) = self.strip_prefix("?@") {
+            (s, true)
+        } else {
+            (self, false)
+        }
+    }
+}

src/patch/peripheral.rs

@@ -11,7 +11,7 @@ use super::register::{RegisterExt, RegisterInfoExt};
 use super::yaml_ext::{AsType, GetVal, ToYaml};
 use super::{
     check_offsets, common_description, make_dim_element, matchname, matchsubspec,
-    modify_dim_element, spec_ind, Config, PatchResult, VAL_LVL,
+    modify_dim_element, spec_ind, Config, PatchResult, Spec, VAL_LVL,
 };
 use super::{make_cluster, make_interrupt, make_register};
 
@@ -407,6 +407,7 @@ impl RegisterBlockExt for Peripheral {
     }
 
     fn modify_register(&mut self, rspec: &str, rmod: &Hash) -> PatchResult {
+        // TODO: empty error
         let rtags = self.iter_registers(rspec).collect::<Vec<_>>();
         if !rtags.is_empty() {
             let register_builder = make_register(rmod)?;
@@ -557,6 +558,7 @@ impl RegisterBlockExt for Peripheral {
     }
 
     fn modify_cluster(&mut self, cspec: &str, cmod: &Hash) -> PatchResult {
+        // TODO: empty error
         let ctags = self.iter_clusters(cspec).collect::<Vec<_>>();
         if !ctags.is_empty() {
             let cluster_builder = make_cluster(cmod)?;
@@ -635,12 +637,13 @@ impl RegisterBlockExt for Peripheral {
         // Find all registers that match the spec
         let mut rcount = 0;
         let pname = self.name.clone();
+        let (rspec, ignore) = rspec.spec();
         for rtag in self.iter_registers(rspec) {
             rcount += 1;
             rtag.process(rmod, &pname, config)
                 .with_context(|| format!("Processing register `{}`", rtag.name))?;
         }
-        if rcount == 0 {
+        if !ignore && rcount == 0 {
             Err(anyhow!(
                 "Could not find `{pname}:{rspec}. Present registers: {}.`",
                 self.registers().map(|r| r.name.as_str()).join(", ")
@@ -654,12 +657,13 @@ impl RegisterBlockExt for Peripheral {
         // Find all clusters that match the spec
         let mut ccount = 0;
         let pname = self.name.clone();
+        let (cspec, ignore) = cspec.spec();
         for ctag in self.iter_clusters(cspec) {
             ccount += 1;
             ctag.process(cmod, &pname, config)
                 .with_context(|| format!("Processing cluster `{}`", ctag.name))?;
         }
-        if ccount == 0 {
+        if !ignore && ccount == 0 {
             Err(anyhow!(
                 "Could not find `{pname}:{cspec}. Present clusters: {}.`",
                 self.clusters().map(|c| c.name.as_str()).join(", ")
@@ -1090,12 +1094,13 @@ impl RegisterBlockExt for Cluster {
         // Find all registers that match the spec
         let mut rcount = 0;
         let pname = self.name.clone();
+        let (rspec, ignore) = rspec.spec();
         for rtag in self.iter_registers(rspec) {
             rcount += 1;
             rtag.process(rmod, &pname, config)
                 .with_context(|| format!("Processing register `{}`", rtag.name))?;
         }
-        if rcount == 0 {
+        if !ignore && rcount == 0 {
             Err(anyhow!(
                 "Could not find `{pname}:{}:{rspec}. Present registers: {}.`",
                 self.name,
@@ -1110,12 +1115,13 @@ impl RegisterBlockExt for Cluster {
         // Find all clusters that match the spec
         let mut ccount = 0;
         let pname = self.name.clone();
+        let (cspec, ignore) = cspec.spec();
         for ctag in self.iter_clusters(cspec) {
             ccount += 1;
             ctag.process(cmod, &pname, config)
                 .with_context(|| format!("Processing cluster `{}`", ctag.name))?;
         }
-        if ccount == 0 {
+        if !ignore && ccount == 0 {
             Err(anyhow!(
                 "Could not find `{pname}:{}:{cspec}. Present clusters: {}.`",
                 self.name,
@@ -1137,6 +1143,7 @@ fn collect_in_array(
     let mut registers = Vec::new();
     let mut place = usize::MAX;
     let mut i = 0;
+    let (rspec, ignore) = rspec.spec();
     while i < regs.len() {
         match &regs[i] {
             RegisterCluster::Register(Register::Single(r)) if matchname(&r.name, rspec) => {
@@ -1149,6 +1156,9 @@ fn collect_in_array(
         }
     }
     if registers.is_empty() {
+        if ignore {
+            return Ok(());
+        }
         return Err(anyhow!(
             "{path}: registers {rspec} not found. Present registers: {}.`",
             regs.iter()
@@ -1277,9 +1287,9 @@ fn collect_in_cluster(
         if rspec == "description" {
             continue;
         }
-        rspecs.push(rspec.to_string());
         let mut registers = Vec::new();
         let mut i = 0;
+        let (rspec, ignore) = rspec.spec();
         while i < regs.len() {
             match &regs[i] {
                 RegisterCluster::Register(Register::Single(r)) if matchname(&r.name, rspec) => {
@@ -1292,6 +1302,9 @@ fn collect_in_cluster(
             }
         }
         if registers.is_empty() {
+            if ignore {
+                continue;
+            }
             return Err(anyhow!(
                 "{path}: registers {rspec} not found. Present registers: {}.`",
                 regs.iter()
@@ -1302,6 +1315,7 @@ fn collect_in_cluster(
                     .join(", ")
             ));
         }
+        rspecs.push(rspec.to_string());
         if single {
             if registers.len() > 1 {
                 return Err(anyhow!("{path}: more than one registers {rspec} found"));
@@ -1362,6 +1376,11 @@ fn collect_in_cluster(
         }
         rdict.insert(rspec.to_string(), registers);
     }
+    if rdict.is_empty() {
+        return Err(anyhow!(
+            "{path}: registers cannot be collected into {cname} cluster. No matches found"
+        ));
+    }
     let address_offset = rdict
         .values()
         .min_by_key(|rs| rs[0].address_offset)

src/patch/register.rs

@@ -12,7 +12,7 @@ use super::iterators::{MatchIter, Matched};
 use super::yaml_ext::{AsType, GetVal, ToYaml};
 use super::{
     check_offsets, common_description, make_dim_element, matchname, modify_dim_element, spec_ind,
-    Config, PatchResult, VAL_LVL,
+    Config, PatchResult, Spec, VAL_LVL,
 };
 use super::{make_derived_enumerated_values, make_ev_array, make_ev_name, make_field};
 
@@ -370,6 +370,7 @@ impl RegisterExt for Register {
             let mut fields = Vec::new();
             let mut place = usize::MAX;
             let mut i = 0;
+            let (fspec, ignore) = fspec.spec();
             while i < fs.len() {
                 match &fs[i] {
                     Field::Single(f) if matchname(&f.name, fspec) => {
@@ -382,6 +383,9 @@ impl RegisterExt for Register {
                 }
             }
             if fields.is_empty() {
+                if ignore {
+                    return Ok(());
+                }
                 return Err(anyhow!(
                     "{}: fields {fspec} not found. Present fields: {}.`",
                     self.name,
@@ -448,9 +452,13 @@ impl RegisterExt for Register {
         Ok(())
     }
     fn split_fields(&mut self, fspec: &str, fsplit: &Hash) -> PatchResult {
+        let (fspec, ignore) = fspec.spec();
         let mut it = self.iter_fields(fspec);
         let (new_fields, name) = match (it.next(), it.next()) {
             (None, _) => {
+                if ignore {
+                    return Ok(());
+                }
                 return Err(anyhow!(
                     "Could not find any fields to split {}:{fspec}. Present fields: {}.`",
                     self.name,
@@ -721,13 +729,17 @@ impl RegisterExt for Register {
                 set_enum(ftag, evs.clone(), orig_usage, true, access)?;
             }
         } else {
+            let (fspec, ignore) = fspec.spec();
             let mut offsets: Vec<_> = Vec::new();
             for (i, f) in self.fields().enumerate() {
                 if matchname(&f.name, fspec) {
                     offsets.push((f.bit_range.offset, f.name.to_string(), i));
                 }
             }
             if offsets.is_empty() {
+                if ignore {
+                    return Ok(());
+                }
                 return Err(anyhow!(
                     "Could not find field {pname}:{}:{fspec}. Present fields: {}.`",
                     self.name,
@@ -779,14 +791,15 @@ impl RegisterExt for Register {
 
     fn process_field_range(&mut self, pname: &str, fspec: &str, fmod: &[Yaml]) -> PatchResult {
         let mut set_any = false;
+        let (fspec, ignore) = fspec.spec();
         for ftag in self.iter_fields(fspec) {
             ftag.write_constraint = Some(WriteConstraint::Range(WriteConstraintRange {
                 min: fmod[0].i64()? as u64,
                 max: fmod[1].i64()? as u64,
             }));
             set_any = true;
         }
-        if !set_any {
+        if !ignore && !set_any {
             return Err(anyhow!(
                 "Could not find field {pname}:{}:{fspec}. Present fields: {}.`",
                 self.name,