riscv: add CSR unimplemented helper variant

Adds a variant arm to the read-only CSR helper macro to create a CSR
register type which may not be implemented on the platform.

Takes a sentinel value to test whether the CSR is implemented.

Author: rmsyn

riscv/src/register/macros.rs

@@ -92,6 +92,27 @@ macro_rules! read_csr_as {
             })
         }
     };
+
+    ($register:ident, $csr_number:literal, $sentinel:tt) => {
+        $crate::read_csr!($csr_number);
+
+        /// Reads the CSR.
+        ///
+        /// **WARNING**: panics on targets not implementing this CSR.
+        #[inline]
+        pub fn read() -> $register {
+            try_read().unwrap()
+        }
+
+        /// Attempts to reads the CSR.
+        #[inline]
+        pub fn try_read() -> $crate::result::Result<$register> {
+            match unsafe { _try_read()? } {
+                $sentinel => Err($crate::result::Error::Unimplemented),
+                bits => Ok($register { bits }),
+            }
+        }
+    };
 }
 
 /// `RV32`: Convenience macro to read a CSR register value as a `register` type.
@@ -732,6 +753,16 @@ macro_rules! read_only_csr {
 
         $crate::read_csr_as!($ty, $csr);
     };
+
+    ($(#[$doc:meta])+
+     $ty:ident: $csr:tt,
+     mask: $mask:tt,
+     sentinel: $sentinel:tt$(,)?,
+    ) => {
+        $crate::csr! { $(#[$doc])+ $ty, $mask }
+
+        $crate::read_csr_as!($ty, $csr, $sentinel);
+    };
 }
 
 /// Helper macro to create a read-only CSR type.