Merge #629

629: sort fields & register sizes r=therealprof a=burrbull

r? `@Emilgardis` 

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

Author: bors[bot]

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   case conversation traits
 - Add new feature `feature_group` which will generate cfg attribute for
   every group name when it is on
+- Sort fields by offset before process
 
 ## [v0.24.1] - 2022-07-04
 

src/generate/register.rs

@@ -151,7 +151,7 @@ pub fn render(
 
         if !cur_fields.is_empty() {
             fields(
-                &cur_fields,
+                cur_fields,
                 register,
                 &name_constant_case_spec,
                 all_registers,
@@ -317,7 +317,7 @@ pub fn render(
 
 #[allow(clippy::too_many_arguments)]
 pub fn fields(
-    fields: &[&Field],
+    mut fields: Vec<&Field>,
     register: &Register,
     name_constant_case_spec: &Ident,
     all_registers: &[&Register],
@@ -335,6 +335,8 @@ pub fn fields(
     let can_read = access.can_read();
     let can_write = access.can_write();
 
+    fields.sort_by_key(|f| f.bit_offset());
+
     // TODO enumeratedValues
     let inline = quote! { #[inline(always)] };
     for f in fields.iter() {
@@ -366,7 +368,7 @@ pub fn fields(
 
         let lookup_results = lookup(
             evs,
-            fields,
+            &fields,
             register,
             all_registers,
             peripheral,
@@ -1044,13 +1046,23 @@ fn derive_from_base(
     });
 }
 
-#[derive(Clone, Debug)]
+#[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
 pub struct Base<'a> {
     pub peripheral: Option<&'a str>,
     pub register: Option<&'a str>,
     pub field: &'a str,
 }
 
+impl<'a> Base<'a> {
+    pub fn from_field(field: &'a str) -> Self {
+        Self {
+            peripheral: None,
+            register: None,
+            field,
+        }
+    }
+}
+
 fn lookup<'a>(
     evs: &'a [EnumeratedValues],
     fields: &'a [&'a Field],
@@ -1208,14 +1220,7 @@ fn lookup_in_register<'r>(
             base_evs,
             register.name
         )),
-        [(evs, field)] => Ok((
-            evs,
-            Some(Base {
-                field,
-                register: None,
-                peripheral: None,
-            }),
-        )),
+        [(evs, field)] => Ok((evs, Some(Base::from_field(field)))),
         matches => {
             let fields = matches.iter().map(|(f, _)| &f.name).collect::<Vec<_>>();
             Err(anyhow!(

src/util.rs

@@ -456,7 +456,7 @@ fn handle_erc_error<T>(msg: &str, name: &str, descrip: &str, res: Result<T>) ->
     res.with_context(|| format!("{}\nName: {}\nDescription: {}", msg, name, descrip))
 }
 
-pub fn get_register_sizes(d: &Device) -> HashSet<u32> {
+pub fn get_register_sizes(d: &Device) -> Vec<u32> {
     let mut reg_sizes = HashSet::new();
     for p in &d.peripherals {
         for r in p.all_registers() {
@@ -465,6 +465,8 @@ pub fn get_register_sizes(d: &Device) -> HashSet<u32> {
             }
         }
     }
+    let mut reg_sizes: Vec<_> = reg_sizes.into_iter().collect();
+    reg_sizes.sort();
     reg_sizes
 }