names & offsets

Author: burrbull

svd-rs/src/cluster.rs

@@ -1,4 +1,5 @@
 use core::ops::{Deref, DerefMut};
+use std::borrow::Cow;
 
 use super::{ClusterInfo, DimElement};
 
@@ -40,6 +41,25 @@ impl Cluster {
     pub const fn is_array(&self) -> bool {
         matches!(self, Self::Array(_, _))
     }
+    /// Returns list of register or register array names
+    pub fn names(&self) -> Vec<Cow<str>> {
+        match self {
+            Self::Single(info) => vec![info.name.as_str().into()],
+            Self::Array(info, dim) => dim
+                .indexes()
+                .map(|i| info.name.replace("[%s]", &i).replace("%s", &i).into())
+                .collect(),
+        }
+    }
+    /// Returns list of register or register array address_offsets
+    pub fn address_offsets(&self) -> Vec<u32> {
+        match self {
+            Self::Single(info) => vec![info.address_offset],
+            Self::Array(info, dim) => (0..dim.dim)
+                .map(|n| info.address_offset + n * dim.dim_increment)
+                .collect(),
+        }
+    }
 }
 
 #[cfg(feature = "serde")]

svd-rs/src/field.rs

@@ -1,5 +1,6 @@
 use super::{DimElement, FieldInfo};
 use core::ops::{Deref, DerefMut};
+use std::borrow::Cow;
 
 /// Describes a field or fields of a [register](crate::RegisterInfo).
 #[derive(Clone, Debug, PartialEq)]
@@ -39,6 +40,25 @@ impl Field {
     pub const fn is_array(&self) -> bool {
         matches!(self, Self::Array(_, _))
     }
+    /// Returns list of register or register array names
+    pub fn names(&self) -> Vec<Cow<str>> {
+        match self {
+            Self::Single(info) => vec![info.name.as_str().into()],
+            Self::Array(info, dim) => dim
+                .indexes()
+                .map(|i| info.name.replace("[%s]", &i).replace("%s", &i).into())
+                .collect(),
+        }
+    }
+    /// Returns list of register or register array bit offsets
+    pub fn bit_offsets(&self) -> Vec<u32> {
+        match self {
+            Self::Single(info) => vec![info.bit_offset()],
+            Self::Array(info, dim) => (0..dim.dim)
+                .map(|n| info.bit_offset() + n * dim.dim_increment)
+                .collect(),
+        }
+    }
 }
 
 #[cfg(feature = "serde")]

svd-rs/src/fieldinfo.rs

@@ -303,6 +303,25 @@ impl FieldInfo {
         Ok(())
     }
 
+    /// Get bit offset
+    pub fn bit_offset(&self) -> u32 {
+        self.bit_range.offset
+    }
+
+    /// Get bit width
+    pub fn bit_width(&self) -> u32 {
+        self.bit_range.width
+    }
+
+    /// Get the position of the least significant bit
+    pub fn lsb(&self) -> u32 {
+        self.bit_range.lsb()
+    }
+    /// Get the position of the most significant bit
+    pub fn msb(&self) -> u32 {
+        self.bit_range.msb()
+    }
+
     /// Get enumeratedValues cluster by usage
     pub fn get_enumerated_values(&self, usage: Usage) -> Option<&EnumeratedValues> {
         match self.enumerated_values.len() {

svd-rs/src/peripheral.rs

@@ -1,4 +1,5 @@
 use core::ops::{Deref, DerefMut};
+use std::borrow::Cow;
 
 use super::{DimElement, PeripheralInfo};
 
@@ -40,6 +41,25 @@ impl Peripheral {
     pub const fn is_array(&self) -> bool {
         matches!(self, Self::Array(_, _))
     }
+    /// Returns list of register or register array names
+    pub fn names(&self) -> Vec<Cow<str>> {
+        match self {
+            Self::Single(info) => vec![info.name.as_str().into()],
+            Self::Array(info, dim) => dim
+                .indexes()
+                .map(|i| info.name.replace("[%s]", &i).replace("%s", &i).into())
+                .collect(),
+        }
+    }
+    /// Returns list of register or register array memory addresses
+    pub fn base_addresses(&self) -> Vec<u64> {
+        match self {
+            Self::Single(info) => vec![info.base_address],
+            Self::Array(info, dim) => (0..dim.dim)
+                .map(|n| info.base_address + (n as u64) * (dim.dim_increment as u64))
+                .collect(),
+        }
+    }
 }
 
 #[cfg(feature = "serde")]

svd-rs/src/register.rs

@@ -1,4 +1,5 @@
 use core::ops::{Deref, DerefMut};
+use std::borrow::Cow;
 
 #[doc(hidden)]
 pub use super::registercluster::{AllRegistersIter as RegIter, AllRegistersIterMut as RegIterMut};
@@ -42,6 +43,25 @@ impl Register {
     pub const fn is_array(&self) -> bool {
         matches!(self, Self::Array(_, _))
     }
+    /// Returns list of register or register array names
+    pub fn names(&self) -> Vec<Cow<str>> {
+        match self {
+            Self::Single(info) => vec![info.name.as_str().into()],
+            Self::Array(info, dim) => dim
+                .indexes()
+                .map(|i| info.name.replace("[%s]", &i).replace("%s", &i).into())
+                .collect(),
+        }
+    }
+    /// Returns list of register or register array address_offsets
+    pub fn address_offsets(&self) -> Vec<u32> {
+        match self {
+            Self::Single(info) => vec![info.address_offset],
+            Self::Array(info, dim) => (0..dim.dim)
+                .map(|n| info.address_offset + n * dim.dim_increment)
+                .collect(),
+        }
+    }
 }
 
 #[cfg(feature = "serde")]