add Send and some docs

Author: burrbull

src/generate/generic.rs

@@ -10,13 +10,20 @@ pub fn render() -> Result<Vec<Tokens>> {
     generic_items.push(quote! {
         use core::marker;
 
-        ///Marker trait for readable register/field
+        ///This trait shows that register has `read` method
+        ///
+        ///Registers marked with `Writable` can be also `modify`'ed
         pub trait Readable {}
 
-        ///Marker trait for writable register/field
+        ///This trait shows that register has `write`, `write_with_zero` and `reset` method
+        ///
+        ///Registers marked with `Readable` can be also `modify`'ed
         pub trait Writable {}
 
         ///Reset value of the register
+        ///
+        ///This value is initial value for `write` method.
+        ///It can be also directly writed to register by `reset` method.
         pub trait ResetValue<U> {
             ///Reset value of the register
             fn reset_value() -> U;
@@ -30,18 +37,22 @@ pub fn render() -> Result<Vec<Tokens>> {
     });
 
     generic_items.push(quote! {
-        ///Wrapper for registers
+        ///This structure provides access to register
         pub struct Reg<U, REG> {
             register: vcell::VolatileCell<U>,
             _marker: marker::PhantomData<REG>,
         }
 
+        unsafe impl<U: Send, REG> Send for Reg<U, REG> { }
+
         impl<U, REG> Reg<U, REG>
         where
             Self: Readable,
             U: Copy
         {
-            ///Reads the contents of the register
+            ///Reads the contents of `Readable` register
+            ///
+            ///See [reading](https://rust-embedded.github.io/book/start/registers.html#reading) in book.
             #[inline(always)]
             pub fn read(&self) -> R<U, Self> {
                 R {bits: self.register.get(), _reg: marker::PhantomData}
@@ -53,7 +64,7 @@ pub fn render() -> Result<Vec<Tokens>> {
             Self: ResetValue<U> + Writable,
             U: Copy,
         {
-            ///Writes the reset value to the register
+            ///Writes the reset value to `Writable` register
             #[inline(always)]
             pub fn reset(&self) {
                 self.register.set(Self::reset_value())
@@ -67,7 +78,9 @@ pub fn render() -> Result<Vec<Tokens>> {
             Self: ResetValue<U> + Writable,
             U: Copy
         {
-            ///Writes to the register
+            ///Writes bits to `Writable` register
+            ///
+            ///See [writing](https://rust-embedded.github.io/book/start/registers.html#writing) in book.
             #[inline(always)]
             pub fn write<F>(&self, f: F)
             where
@@ -84,7 +97,7 @@ pub fn render() -> Result<Vec<Tokens>> {
             Self: Writable,
             U: Copy + Default
         {
-            ///Writes Zero to the register
+            ///Writes Zero to `Writable` register
             #[inline(always)]
             pub fn write_with_zero<F>(&self, f: F)
             where
@@ -102,6 +115,8 @@ pub fn render() -> Result<Vec<Tokens>> {
             U: Copy,
         {
             ///Modifies the contents of the register
+            ///
+            ///See [modifying](https://rust-embedded.github.io/book/start/registers.html#modifying) in book.
             #[inline(always)]
             pub fn modify<F>(&self, f: F)
             where