Merge #646

646: reexport derived mods r=Emilgardis a=burrbull



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

Author: bors[bot]

CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
-- Use register aliases in `RegisterBlock`
+- Use register aliases in `RegisterBlock` (both structure and mod)
 - Create aliases for derived registers & clusters
 - Move cluster struct inside mod
 - Support non-sequential field arrays

src/generate/peripheral.rs

@@ -929,21 +929,27 @@ fn cluster_block(
     let name_constant_case = mod_name.to_constant_case_ident(span);
 
     if let Some(dpath) = dpath {
-        let dparent = util::parent(&dpath);
+        let dparent = util::parent(&dpath).unwrap();
         let mut derived = if &dparent == path {
             type_path(Punctuated::new())
         } else {
             util::block_path_to_ty(&dparent, span)
         };
         let dname = util::replace_suffix(&index.clusters.get(&dpath).unwrap().name, "");
+        let mut mod_derived = derived.clone();
         derived
             .path
             .segments
             .push(path_segment(dname.to_constant_case_ident(span)));
+        mod_derived
+            .path
+            .segments
+            .push(path_segment(dname.to_snake_case_ident(span)));
 
         Ok(quote! {
             #[doc = #description]
             pub use #derived as #name_constant_case;
+            pub use #mod_derived as #name_snake_case;
         })
     } else {
         let cpath = path.new_cluster(&c.name);

src/generate/register.rs

@@ -23,11 +23,9 @@ pub fn render(
     index: &Index,
     config: &Config,
 ) -> Result<TokenStream> {
-    let mut out = TokenStream::new();
     let name = util::name_of(register, config.ignore_groups);
     let span = Span::call_site();
     let name_constant_case = name.to_constant_case_ident(span);
-    let name_constant_case_spec = format!("{name}_SPEC").to_constant_case_ident(span);
     let name_snake_case = name.to_snake_case_ident(span);
     let description = util::escape_brackets(
         util::respace(&register.description.clone().unwrap_or_else(|| {
@@ -44,44 +42,67 @@ pub fn render(
             util::block_path_to_ty(&dpath.block, span)
         };
         let dname = util::name_of(index.registers.get(dpath).unwrap(), config.ignore_groups);
+        let mut mod_derived = derived.clone();
         derived
             .path
             .segments
             .push(path_segment(dname.to_constant_case_ident(span)));
+        mod_derived
+            .path
+            .segments
+            .push(path_segment(dname.to_snake_case_ident(span)));
 
-        out.extend(quote! {
-            #[doc = #description]
+        Ok(quote! {
             pub use #derived as #name_constant_case;
-        });
+            pub use #mod_derived as #name_snake_case;
+        })
     } else {
-        let alias_doc =
-            format!("{name} register accessor: an alias for `Reg<{name_constant_case_spec}>`");
+        let name_constant_case_spec = format!("{name}_SPEC").to_constant_case_ident(span);
+        let access = util::access_of(&register.properties, register.fields.as_deref());
+        let accs = if access.can_read() && access.can_write() {
+            "rw"
+        } else if access.can_write() {
+            "w"
+        } else if access.can_read() {
+            "r"
+        } else {
+            return Err(anyhow!("Incorrect access of register {}", register.name));
+        };
+        let alias_doc = format!(
+            "{name} ({accs}) register accessor: an alias for `Reg<{name_constant_case_spec}>`"
+        );
+        let mut out = TokenStream::new();
         out.extend(quote! {
             #[doc = #alias_doc]
             pub type #name_constant_case = crate::Reg<#name_snake_case::#name_constant_case_spec>;
         });
-        let mod_items =
-            render_register_mod(register, &path.new_register(&register.name), index, config)?;
+        let mod_items = render_register_mod(
+            register,
+            access,
+            &path.new_register(&register.name),
+            index,
+            config,
+        )?;
 
         out.extend(quote! {
             #[doc = #description]
             pub mod #name_snake_case {
                 #mod_items
             }
         });
-    };
 
-    Ok(out)
+        Ok(out)
+    }
 }
 
 pub fn render_register_mod(
     register: &Register,
+    access: Access,
     path: &RegisterPath,
     index: &Index,
     config: &Config,
 ) -> Result<TokenStream> {
     let properties = &register.properties;
-    let access = util::access_of(properties, register.fields.as_deref());
     let name = util::name_of(register, config.ignore_groups);
     let span = Span::call_site();
     let name_constant_case_spec = format!("{name}_SPEC").to_constant_case_ident(span);

src/util.rs

@@ -415,10 +415,10 @@ pub fn path_segment(ident: Ident) -> PathSegment {
     }
 }
 
-pub fn parent(p: &BlockPath) -> BlockPath {
+pub fn parent(p: &BlockPath) -> Option<BlockPath> {
     let mut p = p.clone();
-    p.path.pop().unwrap();
-    p
+    p.path.pop()?;
+    Some(p)
 }
 
 pub trait U32Ext {