Merge #190

190: offsets r=Emilgardis a=burrbull



Co-authored-by: Andrey Zgarbul <[email protected]>

svd-rs/CHANGELOG.md

@@ -8,7 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## Unreleased
 
 - skip serializing `values` in `EnumeratedValues` if empty
-- add `names` function for arrays
+- add `names` function for arrays, `base_addresses` for `Peripheral`,
+  `address_offsets` for `Register` and `Cluster`, `bit_offsets` for `Field` arrays
 - add missing fields in `Device`, require `version`, `description`, `address_unit_bits` and `width`,
   also `schema_version` is required, but skipped during (de)serialization
 - merge `register` with `registerinfo` modules same as other `info`s

svd-rs/src/cluster.rs

@@ -71,6 +71,14 @@ pub struct ClusterInfo {
     pub derived_from: Option<String>,
 }
 
+/// Return iterator over address offsets of each cluster in array
+pub fn address_offsets<'a>(
+    info: &'a ClusterInfo,
+    dim: &'a DimElement,
+) -> impl Iterator<Item = u32> + 'a {
+    (0..dim.dim).map(move |i| info.address_offset + i * dim.dim_increment)
+}
+
 /// Builder for [`ClusterInfo`]
 #[derive(Clone, Debug, Default, PartialEq)]
 pub struct ClusterInfoBuilder {

svd-rs/src/field.rs

@@ -81,6 +81,11 @@ pub struct FieldInfo {
     pub derived_from: Option<String>,
 }
 
+/// Return iterator over bit offsets of each field in array
+pub fn bit_offsets<'a>(info: &'a FieldInfo, dim: &'a DimElement) -> impl Iterator<Item = u32> + 'a {
+    (0..dim.dim).map(move |i| info.bit_offset() + i * dim.dim_increment)
+}
+
 /// Builder for [`FieldInfo`]
 
 #[derive(Clone, Debug, Default, PartialEq)]

svd-rs/src/peripheral.rs

@@ -123,6 +123,14 @@ pub struct PeripheralInfo {
     pub derived_from: Option<String>,
 }
 
+/// Return iterator over base addresses of each peripheral in array
+pub fn base_addresses<'a>(
+    info: &'a PeripheralInfo,
+    dim: &'a DimElement,
+) -> impl Iterator<Item = u64> + 'a {
+    (0..dim.dim as u64).map(move |i| info.base_address + i * dim.dim_increment as u64)
+}
+
 /// Builder for [`Peripheral`]
 #[derive(Clone, Debug, Default, PartialEq)]
 pub struct PeripheralInfoBuilder {

svd-rs/src/register.rs

@@ -101,6 +101,14 @@ pub struct RegisterInfo {
     pub derived_from: Option<String>,
 }
 
+/// Return iterator over address offsets of each register in array
+pub fn address_offsets<'a>(
+    info: &'a RegisterInfo,
+    dim: &'a DimElement,
+) -> impl Iterator<Item = u32> + 'a {
+    (0..dim.dim).map(move |i| info.address_offset + i * dim.dim_increment)
+}
+
 /// Builder for [`RegisterInfo`]
 #[derive(Clone, Debug, Default, PartialEq)]
 pub struct RegisterInfoBuilder {