add expand descriptions

Author: burrbull

svd-parser/Cargo.toml

@@ -27,7 +27,7 @@ thiserror = "1.0.31"
 [dev-dependencies]
 serde_json = { version = "1.0", features = ["preserve_order"] }
 serde_yaml = "0.8.26"
-svd-rs = { version = "0.14.1", path = "../svd-rs", features = ["serde"] }
+svd-rs = { version = "0.14.3", path = "../svd-rs", features = ["serde"] }
 
 [[example]]
 name = "svd2json"

svd-parser/src/expand.rs

@@ -5,8 +5,9 @@ use std::collections::HashMap;
 use std::fmt;
 use std::mem::take;
 use svd_rs::{
-    array::names, cluster, field, peripheral, register, BitRange, Cluster, ClusterInfo, DeriveFrom,
-    Device, EnumeratedValues, Field, Peripheral, Register, RegisterCluster, RegisterProperties,
+    array::{descriptions, names},
+    cluster, field, peripheral, register, BitRange, Cluster, ClusterInfo, DeriveFrom, Device,
+    EnumeratedValues, Field, Peripheral, Register, RegisterCluster, RegisterProperties,
 };
 
 /// Path to `peripheral` or `cluster` element
@@ -320,10 +321,12 @@ fn expand_cluster_array(
         Cluster::Single(c) => expand_cluster(regs, c),
         Cluster::Array(info, dim) => {
             for c in names(&info, &dim)
+                .zip(descriptions(&info, &dim))
                 .zip(cluster::address_offsets(&info, &dim))
-                .map(|(name, address_offset)| {
+                .map(|((name, description), address_offset)| {
                     let mut info = info.clone();
                     info.name = name;
+                    info.description = description;
                     info.address_offset = address_offset;
                     info
                 })
@@ -435,7 +438,7 @@ fn expand_cluster(regs: &mut Vec<RegisterCluster>, c: ClusterInfo) {
             RegisterCluster::Register(mut r) => {
                 r.name = format!("{}_{}", c.name, r.name);
                 r.address_offset += c.address_offset;
-                regs.push(RegisterCluster::Register(r));
+                regs.push(r.into());
             }
         }
     }
@@ -462,19 +465,21 @@ fn expand_register_array(
 
     match r {
         Register::Single(_) => {
-            regs.push(RegisterCluster::Register(r));
+            regs.push(r.into());
         }
         Register::Array(info, dim) => {
             for rx in names(&info, &dim)
+                .zip(descriptions(&info, &dim))
                 .zip(register::address_offsets(&info, &dim))
-                .map(|(name, address_offset)| {
+                .map(|((name, description), address_offset)| {
                     let mut info = info.clone();
                     info.name = name;
+                    info.description = description;
                     info.address_offset = address_offset;
-                    Register::Single(info)
+                    info.single()
                 })
             {
-                regs.push(RegisterCluster::Register(rx));
+                regs.push(rx.into());
             }
         }
     }
@@ -506,15 +511,16 @@ fn expand_field(
             fields.push(f);
         }
         Field::Array(info, dim) => {
-            for fx in
-                names(&info, &dim)
-                    .zip(field::bit_offsets(&info, &dim))
-                    .map(|(name, bit_offset)| {
-                        let mut info = info.clone();
-                        info.name = name;
-                        info.bit_range = BitRange::from_offset_width(bit_offset, info.bit_width());
-                        Field::Single(info)
-                    })
+            for fx in names(&info, &dim)
+                .zip(descriptions(&info, &dim))
+                .zip(field::bit_offsets(&info, &dim))
+                .map(|((name, description), bit_offset)| {
+                    let mut info = info.clone();
+                    info.name = name;
+                    info.description = description;
+                    info.bit_range = BitRange::from_offset_width(bit_offset, info.bit_width());
+                    Field::Single(info)
+                })
             {
                 fields.push(fx);
             }
@@ -631,10 +637,12 @@ pub fn expand(indevice: &Device) -> Result<Device> {
             }
             Peripheral::Array(info, dim) => {
                 for px in names(&info, &dim)
+                    .zip(descriptions(&info, &dim))
                     .zip(peripheral::base_addresses(&info, &dim))
-                    .map(|(name, base_address)| {
+                    .map(|((name, description), base_address)| {
                         let mut info = info.clone();
                         info.name = name;
+                        info.description = description;
                         info.base_address = base_address;
                         Peripheral::Single(info)
                     })

svd-parser/src/registercluster.rs

@@ -9,8 +9,8 @@ impl Parse for RegisterCluster {
 
     fn parse(tree: &Node, config: &Self::Config) -> Result<Self, Self::Error> {
         match tree.tag_name().name() {
-            "register" => Register::parse(tree, config).map(RegisterCluster::Register),
-            "cluster" => Cluster::parse(tree, config).map(RegisterCluster::Cluster),
+            "register" => Register::parse(tree, config).map(Into::into),
+            "cluster" => Cluster::parse(tree, config).map(Into::into),
             _ => Err(
                 SVDError::InvalidRegisterCluster(tree.tag_name().name().to_string()).at(tree.id()),
             ),