feature: add derive macro for auto-CharDevice

kernel/Cargo.toml

@@ -17,6 +17,7 @@ cfg-if = "1.x.x"
 tock-registers = "0.7.x"
 fdt-rs = { version = "0.x.x", default-features = false }
 bitflags = "^1.3.0"
+macros = { path = "macros" }
 
 [target.'cfg(target_arch = "aarch64")'.dependencies]
 cortex-a = { version = "6.x.x" }

kernel/macros/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "macros"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[lib]
+proc-macro = true
+
+[dependencies]
+syn = "^1.0.81"
+quote = "^1.0.10"

kernel/macros/src/lib.rs

@@ -0,0 +1,38 @@
+extern crate proc_macro;
+extern crate syn;
+#[macro_use]
+extern crate quote;
+
+use proc_macro::TokenStream;
+use syn::{parse_macro_input, DeriveInput};
+
+#[proc_macro_derive(TtyCharDevice)]
+pub fn derive_tty_char_device(input: TokenStream) -> TokenStream {
+    let ast = parse_macro_input!(input as DeriveInput);
+
+    if !ast.generics.params.is_empty() {
+        panic!(
+            "Derived TtyCharDevice cannot have generic parameters: {:?}",
+            ast.ident
+        );
+    }
+    let ident = ast.ident;
+
+    quote! {
+        impl vfs::CharDevice for #ident {
+            fn read(&self, blocking: bool, data: &mut [u8]) -> Result<usize, libsys::error::Errno> {
+                assert!(blocking);
+                crate::dev::tty::TtyDevice::line_read(self, data)
+            }
+            fn write(&self, blocking: bool, data: &[u8]) -> Result<usize, libsys::error::Errno> {
+                assert!(blocking);
+                crate::dev::tty::TtyDevice::line_write(self, data)
+            }
+            fn ioctl(&self, cmd: libsys::ioctl::IoctlCmd, ptr: usize, len: usize) ->
+                Result<usize, libsys::error::Errno>
+            {
+                crate::dev::tty::TtyDevice::tty_ioctl(self, cmd, ptr, len)
+            }
+        }
+    }.into()
+}

kernel/src/arch/aarch64/mach_orangepi3/uart.rs

@@ -12,7 +12,6 @@ use libsys::error::Errno;
 use tock_registers::interfaces::{ReadWriteable, Readable, Writeable};
 use tock_registers::registers::{Aliased, ReadOnly, ReadWrite};
 use tock_registers::{register_bitfields, register_structs};
-use vfs::{CharDevice, IoctlCmd};
 
 register_bitfields! [
     u32,
@@ -78,6 +77,7 @@ struct UartInner {
     regs: DeviceMemoryIo<Regs>,
 }
 
+#[derive(TtyCharDevice)]
 pub(super) struct Uart {
     inner: InitOnce<IrqSafeSpinLock<UartInner>>,
     ring: CharRing<16>,
@@ -123,22 +123,6 @@ impl SerialDevice for Uart {
     }
 }
 
-impl CharDevice for Uart {
-    fn read(&self, blocking: bool, data: &mut [u8]) -> Result<usize, Errno> {
-        assert!(blocking);
-        self.line_read(data)
-    }
-
-    fn write(&self, blocking: bool, data: &[u8]) -> Result<usize, Errno> {
-        assert!(blocking);
-        self.line_write(data)
-    }
-
-    fn ioctl(&self, cmd: IoctlCmd, ptr: usize, len: usize) -> Result<usize, Errno> {
-        self.tty_ioctl(cmd, ptr, len)
-    }
-}
-
 impl TtyDevice<16> for Uart {
     fn ring(&self) -> &CharRing<16> {
         &self.ring

kernel/src/dev/serial/pl011.rs

@@ -78,6 +78,7 @@ struct Pl011Inner {
 }
 
 /// Device struct for PL011
+#[derive(TtyCharDevice)]
 pub struct Pl011 {
     inner: InitOnce<IrqSafeSpinLock<Pl011Inner>>,
     ring: CharRing<16>,
@@ -117,16 +118,16 @@ impl Pl011Inner {
     }
 }
 
-impl fmt::Write for Pl011Inner {
-    fn write_str(&mut self, s: &str) -> fmt::Result {
-        for &c in s.as_bytes() {
-            unsafe {
-                self.send(c);
-            }
-        }
-        Ok(())
-    }
-}
+// impl fmt::Write for Pl011Inner {
+//     fn write_str(&mut self, s: &str) -> fmt::Result {
+//         for &c in s.as_bytes() {
+//             unsafe {
+//                 self.send(c);
+//             }
+//         }
+//         Ok(())
+//     }
+// }
 
 impl IntSource for Pl011 {
     fn handle_irq(&self) -> Result<(), Errno> {
@@ -168,21 +169,21 @@ impl SerialDevice for Pl011 {
     }
 }
 
-impl CharDevice for Pl011 {
-    fn read(&self, blocking: bool, data: &mut [u8]) -> Result<usize, Errno> {
-        assert!(blocking);
-        self.line_read(data)
-    }
-
-    fn write(&self, blocking: bool, data: &[u8]) -> Result<usize, Errno> {
-        assert!(blocking);
-        self.line_write(data)
-    }
-
-    fn ioctl(&self, cmd: IoctlCmd, ptr: usize, len: usize) -> Result<usize, Errno> {
-        self.tty_ioctl(cmd, ptr, len)
-    }
-}
+// impl CharDevice for Pl011 {
+//     fn read(&self, blocking: bool, data: &mut [u8]) -> Result<usize, Errno> {
+//         assert!(blocking);
+//         self.line_read(data)
+//     }
+//
+//     fn write(&self, blocking: bool, data: &[u8]) -> Result<usize, Errno> {
+//         assert!(blocking);
+//         self.line_write(data)
+//     }
+//
+//     fn ioctl(&self, cmd: IoctlCmd, ptr: usize, len: usize) -> Result<usize, Errno> {
+//         self.tty_ioctl(cmd, ptr, len)
+//     }
+// }
 
 impl TtyDevice<16> for Pl011 {
     fn ring(&self) -> &CharRing<16> {

kernel/src/main.rs

@@ -18,6 +18,8 @@
 #![no_main]
 #![warn(missing_docs)]
 
+#[macro_use]
+extern crate macros;
 #[macro_use]
 extern crate cfg_if;
 #[macro_use]