Merge pull request #208 from rust-embedded/enumname

specify `name` for `enumeratedValues`

Author: burrbull

CHANGELOG-python.md

@@ -6,6 +6,7 @@ This changelog tracks the Python `svdtools` project. See
 ## [Unreleased]
 
 * Fix #176 in `collect_in_cluster`
+* Allow to specify `name` for `enumeratedValues`
 
 ## [v0.1.27] 2023-12-23
 

CHANGELOG-rust.md

@@ -5,6 +5,8 @@ This changelog tracks the Rust `svdtools` project. See
 
 ## [Unreleased]
 
+* Allow to specify `name` for `enumeratedValues`
+
 ## [v0.3.9] 2024-01-19
 
 * Use `<details>` instead of JavaScript in `html` template

Cargo.toml

@@ -28,8 +28,8 @@ rust-version = "1.70"
 clap = { version = "4.4", features = ["derive", "cargo", "color"] }
 serde = { version = "1.0", features = ["derive"] }
 quick-xml = { version = "0.31", features = ["serialize"] }
-svd-rs = { version = "0.14.6", features = ["serde", "derive-from"] }
-svd-parser = { version = "0.14.4", features = ["expand"] }
+svd-rs = { version = "0.14.8", features = ["serde", "derive-from"] }
+svd-parser = { version = "0.14.5", features = ["expand"] }
 svd-encoder = "0.14.4"
 yaml-rust = "0.4"
 # serde_yaml 0.9.x looks broken
@@ -40,14 +40,15 @@ thiserror = "1.0.35"
 linked-hash-map = "0.5"
 globset = "0.4.14"
 commands = "0.0.5"
-env_logger = "0.10"
+env_logger = "0.11"
 log = { version = "~0.4", features = ["std"] }
 normpath = "1.1.0"
 liquid = "0.26.0"
 once_cell = "1.18.0"
 rayon = "1.7.0"
-regex = "1.9.1"
+regex = "1.10"
 itertools = "0.12.0"
+phf = { version = "0.11", features = ["macros"] }
 
 [dev-dependencies]
 tempfile = "3.3"

README.md

@@ -306,6 +306,8 @@ _rebase:
 
         # A field in this register, matches an SVD <field> tag
         FIELD:
+            # You can optionally specify name for `enumeratedValues`
+            _name: NAME
             # By giving the field a dictionary we construct an enumerateValues
             VARIANT: [VALUE, DESCRIPTION]
             VARIANT: [VALUE, DESCRIPTION]

src/patch/register.rs

@@ -512,43 +512,36 @@ impl RegisterExt for Register {
         fmod: &Yaml,
         config: &Config,
     ) -> PatchResult {
-        const READ_KEYS: [&str; 5] = ["_read", "_RM", "_RS", "_RC", "_RME"];
-        const READ_VALS: [Option<ReadAction>; 5] = [
-            None,
-            Some(ReadAction::Modify),
-            Some(ReadAction::Set),
-            Some(ReadAction::Clear),
-            Some(ReadAction::ModifyExternal),
-        ];
-        const WRITE_KEYS: [&str; 10] = [
-            "_write", "_WM", "_WS", "_WC", "_W1S", "_W0C", "_W1C", "_W0S", "_W1T", "_W0T",
-        ];
-        const WRITE_VALS: [Option<ModifiedWriteValues>; 10] = [
-            None,
-            Some(ModifiedWriteValues::Modify),
-            Some(ModifiedWriteValues::Set),
-            Some(ModifiedWriteValues::Clear),
-            Some(ModifiedWriteValues::OneToSet),
-            Some(ModifiedWriteValues::ZeroToClear),
-            Some(ModifiedWriteValues::OneToClear),
-            Some(ModifiedWriteValues::ZeroToSet),
-            Some(ModifiedWriteValues::OneToToggle),
-            Some(ModifiedWriteValues::ZeroToToggle),
-        ];
+        const READ: phf::Map<&'static str, Option<ReadAction>> = phf::phf_map! {
+            "_read" => None,
+            "_RM" =>  Some(ReadAction::Modify),
+            "_RS" => Some(ReadAction::Set),
+            "_RC" => Some(ReadAction::Clear),
+            "_RME" => Some(ReadAction::ModifyExternal),
+        };
+        const WRITE: phf::Map<&'static str, Option<ModifiedWriteValues>> = phf::phf_map! {
+            "_write" => None,
+            "_WM" => Some(ModifiedWriteValues::Modify),
+            "_WS" => Some(ModifiedWriteValues::Set),
+            "_WC" => Some(ModifiedWriteValues::Clear),
+            "_W1S" => Some(ModifiedWriteValues::OneToSet),
+            "_W0C" => Some(ModifiedWriteValues::ZeroToClear),
+            "_W1C" => Some(ModifiedWriteValues::OneToClear),
+            "_W0S" => Some(ModifiedWriteValues::ZeroToSet),
+            "_W1T" => Some(ModifiedWriteValues::OneToToggle),
+            "_W0T" => Some(ModifiedWriteValues::ZeroToToggle),
+        };
+
         match fmod {
             Yaml::Hash(fmod) => {
-                let is_read = READ_KEYS
-                    .iter()
-                    .any(|key| fmod.contains_key(&key.to_yaml()));
-                let is_write = WRITE_KEYS
-                    .iter()
-                    .any(|key| fmod.contains_key(&key.to_yaml()));
+                let is_read = READ.keys().any(|key| fmod.contains_key(&key.to_yaml()));
+                let is_write = WRITE.keys().any(|key| fmod.contains_key(&key.to_yaml()));
                 if !is_read && !is_write {
                     self.process_field_enum(pname, fspec, fmod, None, config)
                         .with_context(|| "Adding read-write enumeratedValues")?;
                 } else {
                     if is_read {
-                        for (key, action) in READ_KEYS.into_iter().zip(READ_VALS.into_iter()) {
+                        for (key, action) in &READ {
                             if let Some(fmod) = fmod.get_hash(key)? {
                                 if !fmod.is_empty() {
                                     self.process_field_enum(
@@ -561,14 +554,14 @@ impl RegisterExt for Register {
                                     .with_context(|| "Adding read-only enumeratedValues")?;
                                 }
                                 if let Some(action) = action {
-                                    self.set_field_read_action(fspec, action);
+                                    self.set_field_read_action(fspec, *action);
                                 }
                                 break;
                             }
                         }
                     }
                     if is_write {
-                        for (key, mwv) in WRITE_KEYS.into_iter().zip(WRITE_VALS.into_iter()) {
+                        for (key, mwv) in &WRITE {
                             if let Some(fmod) = fmod.get_hash(key)? {
                                 if !fmod.is_empty() {
                                     self.process_field_enum(
@@ -581,7 +574,7 @@ impl RegisterExt for Register {
                                     .with_context(|| "Adding write-only enumeratedValues")?;
                                 }
                                 if let Some(mwv) = mwv {
-                                    self.set_field_modified_write_values(fspec, mwv);
+                                    self.set_field_modified_write_values(fspec, *mwv);
                                 }
                             }
                         }
@@ -749,7 +742,11 @@ impl RegisterExt for Register {
             let (min_offset, fname, min_offset_pos) =
                 offsets.iter().min_by_key(|&on| on.0).unwrap();
             let min_pos = offsets.iter().map(|on| on.2).min().unwrap();
-            let name = make_ev_name(&fname.replace("%s", ""), usage)?;
+            let name = if let Some(name) = fmod.get_str("_name")? {
+                name.to_string()
+            } else {
+                make_ev_name(&fname.replace("%s", ""), usage)?
+            };
             for ftag in self.iter_fields(fspec) {
                 let access = ftag.access.or(reg_access).unwrap_or_default();
                 let checked_usage = check_usage(access, usage)

svdtools/patch.py

@@ -1713,6 +1713,8 @@ def process_field_enum(self, pname, fspec, field, usage="read-write"):
         for ftag in sorted_fields(list(self.iter_fields(fspec))):
             if "_derivedFrom" in field:
                 derived = field["_derivedFrom"]
+            elif "_name" in field:
+                name = field["_name"]
             else:
                 name = ftag.find("name").text