Merge pull request #182 from rust-embedded/default

default enum value

Author: burrbull

.github/workflows/ci.yaml

@@ -48,7 +48,7 @@ jobs:
         target:
           - esp32
           - esp8266
-          - stm32
+          #- stm32
           - lpc55
           #- rp2040
     steps:

CHANGELOG-python.md

@@ -5,6 +5,8 @@ This changelog tracks the Python `svdtools` project. See
 
 ## [Unreleased]
 
+* `-1` for default enum value
+
 ## [v0.1.26] 2023-03-28
 
 * Bump python to 3.9 to fix CI

CHANGELOG-rust.md

@@ -6,6 +6,7 @@ This changelog tracks the Rust `svdtools` project. See
 ## [Unreleased]
 
 * Move field with derived enums before other
+* `-1` for default enum value
 
 ## [v0.3.4] 2023-10-14
 

README.md

@@ -309,6 +309,10 @@ _rebase:
             # By giving the field a dictionary we construct an enumerateValues
             VARIANT: [VALUE, DESCRIPTION]
             VARIANT: [VALUE, DESCRIPTION]
+            # Use `-1` for "default" variant which will be consider
+            # for all other values that are not listed explicitly
+            # usually datasheet marks them `0b0xxx`, `0b1x`, etc.
+            VARIANT: [-1, DESCRIPTION]
 
         FIELD:
             # If a field already has enumerateValues, drop them and

src/patch/mod.rs

@@ -267,34 +267,34 @@ fn make_ev_array(values: &Hash) -> Result<EnumeratedValuesBuilder> {
                 ));
             }
             let vd = vd.vec()?;
-            let value = vd[0].i64()? as u64;
             let description = vd.get(1).and_then(Yaml::as_str).ok_or_else(|| {
-                anyhow!("enumeratedValue can't have empty description for value {value}")
+                anyhow!("enumeratedValue can't have empty description for value {vname}")
             })?;
+            let value = vd[0].i64()?;
+            let def = value == -1;
+            let value = value as u64;
+            let ev = EnumeratedValue::builder()
+                .name(vname.into())
+                .value(Some(value))
+                .description(Some(description.into()));
+            let ev = (if def {
+                ev.is_default(Some(true))
+            } else {
+                ev.value(Some(value))
+            })
+            .build(VAL_LVL)?;
             use std::collections::btree_map::Entry;
             match h.entry(value) {
                 Entry::Occupied(_) => {
                     return Err(anyhow!("enumeratedValue can't have duplicate values"));
                 }
                 Entry::Vacant(e) => {
-                    e.insert((vname.to_string(), description.to_string()));
+                    e.insert(ev);
                 }
             }
         }
     }
-    Ok(EnumeratedValues::builder().values({
-        let mut evs = Vec::new();
-        for (value, vd) in h.into_iter() {
-            evs.push(
-                EnumeratedValue::builder()
-                    .name(vd.0)
-                    .value(Some(value))
-                    .description(Some(vd.1))
-                    .build(VAL_LVL)?,
-            );
-        }
-        evs
-    }))
+    Ok(EnumeratedValues::builder().values(h.into_values().collect()))
 }
 
 /// Returns an enumeratedValues Element which is derivedFrom name

svdtools/patch.py

@@ -178,7 +178,10 @@ def make_enumerated_values(name, values, usage="read-write"):
         el = ET.SubElement(ev, "enumeratedValue")
         ET.SubElement(el, "name").text = vname
         ET.SubElement(el, "description").text = description
-        ET.SubElement(el, "value").text = str(value)
+        if value == -1:
+            ET.SubElement(el, "isDefault").text = "true"
+        else:
+            ET.SubElement(el, "value").text = str(value)
     ev.tail = "\n            "
     return ev