hidden WRaw & RRaw for better docs

Author: burrbull

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
+- removed register writer & reader wrappers, generic `REG` in field writers (#731)
 - Updated syn to version 2 (#732)
 
 ## [v0.29.0] - 2023-06-05

src/generate/generic.rs

@@ -256,7 +256,10 @@ impl<REG: Readable + Writable> Reg<REG> {
 ///
 /// Result of the `read` methods of registers. Also used as a closure argument in the `modify`
 /// method.
-pub struct R<REG: RegisterSpec + ?Sized> {
+pub type R<REG> = RRaw<REG>;
+
+#[doc(hidden)]
+pub struct RRaw<REG: RegisterSpec> {
     pub(crate) bits: REG::Ux,
     _reg: marker::PhantomData<REG>,
 }
@@ -284,25 +287,15 @@ where
 /// Register writer.
 ///
 /// Used as an argument to the closures in the `write` and `modify` methods of the register.
-pub struct W<REG: RegisterSpec + ?Sized> {
+pub type W<REG> = WRaw<REG>;
+
+#[doc(hidden)]
+pub struct WRaw<REG: RegisterSpec> {
     ///Writable bits
     pub(crate) bits: REG::Ux,
     _reg: marker::PhantomData<REG>,
 }
 
-impl<REG: RegisterSpec> W<REG> {
-    /// Writes raw bits to the register.
-    ///
-    /// # Safety
-    ///
-    /// Read datasheet or reference manual to find what values are allowed to pass.
-    #[inline(always)]
-    pub unsafe fn bits(&mut self, bits: REG::Ux) -> &mut Self {
-        self.bits = bits;
-        self
-    }
-}
-
 #[doc(hidden)]
 pub struct FieldReaderRaw<FI = u8>
 where

src/generate/register.rs

@@ -273,7 +273,6 @@ pub fn render_register_mod(
 
         mod_items.extend(w_impl_items);
 
-        /*
         // the writer can be safe if:
         // * there is a single field that covers the entire register
         // * that field can represent all values
@@ -293,7 +292,7 @@ pub fn render_register_mod(
                 #[doc = "Writes raw bits to the register."]
                 #[inline(always)]
                 pub fn bits(&mut self, bits: #rty) -> &mut Self {
-                    unsafe { self.0.bits(bits) };
+                    self.bits = bits;
                     self
                 }
             });
@@ -302,11 +301,11 @@ pub fn render_register_mod(
                 #[doc = "Writes raw bits to the register."]
                 #[inline(always)]
                 pub unsafe fn bits(&mut self, bits: #rty) -> &mut Self {
-                    self.0.bits(bits);
+                    self.bits = bits;
                     self
                 }
             });
-        }*/
+        }
 
         close.to_tokens(&mut mod_items);
     }