Introduce more driver abstractions

Cargo.toml

@@ -13,28 +13,26 @@
 default-members = []
 resolver = "2"
 members = [
+    "crates/drivers/bcm2835-aux-uart",
+    "crates/drivers/pl011",
+    "crates/drivers/pl031",
+    "crates/drivers/sp804",
+    "crates/drivers/virtio/blk",
+    "crates/drivers/virtio/hal-impl",
+    "crates/drivers/virtio/net",
     "crates/examples/microkit/banscii/pds/artist",
     "crates/examples/microkit/banscii/pds/artist/interface-types",
     "crates/examples/microkit/banscii/pds/assistant",
     "crates/examples/microkit/banscii/pds/assistant/core",
     "crates/examples/microkit/banscii/pds/assistant/core/test",
-    "crates/examples/microkit/banscii/pds/pl011-driver",
-    "crates/examples/microkit/banscii/pds/pl011-driver/core",
-    "crates/examples/microkit/banscii/pds/pl011-driver/interface-types",
+    "crates/examples/microkit/banscii/pds/serial-driver",
     "crates/examples/microkit/hello/pds/hello",
-    "crates/examples/microkit/http-server/helpers/virtio-hal-impl",
     "crates/examples/microkit/http-server/pds/pl031-driver",
-    "crates/examples/microkit/http-server/pds/pl031-driver/core",
-    "crates/examples/microkit/http-server/pds/pl031-driver/interface-types",
     "crates/examples/microkit/http-server/pds/server",
     "crates/examples/microkit/http-server/pds/server/core",
     "crates/examples/microkit/http-server/pds/sp804-driver",
-    "crates/examples/microkit/http-server/pds/sp804-driver/core",
-    "crates/examples/microkit/http-server/pds/sp804-driver/interface-types",
     "crates/examples/microkit/http-server/pds/virtio-blk-driver",
-    "crates/examples/microkit/http-server/pds/virtio-blk-driver/interface-types",
     "crates/examples/microkit/http-server/pds/virtio-net-driver",
-    "crates/examples/microkit/http-server/pds/virtio-net-driver/interface-types",
     "crates/examples/root-task/example-root-task",
     "crates/examples/root-task/example-root-task-without-runtime",
     "crates/examples/root-task/hello",
@@ -96,10 +94,10 @@ members = [
     "crates/sel4-capdl-initializer/with-embedded-spec/embedded-spec",
     "crates/sel4-capdl-initializer/with-embedded-spec/embedded-spec/validate",
     "crates/sel4-dlmalloc",
+    "crates/sel4-driver-interfaces",
     "crates/sel4-elf-header",
     "crates/sel4-externally-shared",
     "crates/sel4-generate-target-specs",
-    "crates/sel4-hal-adapters",
     "crates/sel4-immediate-sync-once-cell",
     "crates/sel4-immutable-cell",
     "crates/sel4-initialize-tls",
@@ -112,6 +110,7 @@ members = [
     "crates/sel4-logging",
     "crates/sel4-microkit",
     "crates/sel4-microkit/base",
+    "crates/sel4-microkit/driver-adapters",
     "crates/sel4-microkit/macros",
     "crates/sel4-microkit/message",
     "crates/sel4-microkit/message/types",

crates/drivers/bcm2835-aux-uart/Cargo.nix

@@ -0,0 +1,15 @@
+#
+# Copyright 2024, Colias Group, LLC
+#
+# SPDX-License-Identifier: BSD-2-Clause
+#
+
+{ mk, versions, localCrates }:
+
+mk {
+  package.name = "sel4-bcm2835-aux-uart-driver";
+  dependencies = {
+    inherit (versions) tock-registers embedded-hal-nb;
+    inherit (localCrates) sel4-driver-interfaces;
+  };
+}

crates/examples/microkit/banscii/pds/pl011-driver/interface-types/Cargo.toml → crates/drivers/bcm2835-aux-uart/Cargo.toml

@@ -10,11 +10,13 @@
 #
 
 [package]
-name = "banscii-pl011-driver-interface-types"
+name = "sel4-bcm2835-aux-uart-driver"
 version = "0.1.0"
 authors = ["Nick Spinale <[email protected]>"]
 edition = "2021"
 license = "BSD-2-Clause"
 
 [dependencies]
-serde = { version = "1.0.147", default-features = false }
+embedded-hal-nb = "1.0"
+sel4-driver-interfaces = { path = "../../sel4-driver-interfaces" }
+tock-registers = "0.8.1"

crates/sel4-kernel-loader/src/drivers/bcm2835_aux_uart.rs → crates/drivers/bcm2835-aux-uart/src/device.rs

@@ -19,7 +19,7 @@ const MU_LSR_DATAREADY: u32 = 1 << 0;
 
 register_structs! {
     #[allow(non_snake_case)]
-    pub(crate)Bcm2835AuxUartRegisterBlock {
+    pub(crate) RegisterBlock {
         (0x000 => _reserved0),
         (0x040 => IO: ReadWrite<u8>),
         (0x041 => _reserved1),
@@ -30,31 +30,31 @@ register_structs! {
     }
 }
 
-pub(crate) struct Bcm2835AuxUartDevice {
-    base_addr: usize,
+pub(crate) struct Device {
+    ptr: *mut RegisterBlock,
 }
 
-impl Bcm2835AuxUartDevice {
-    pub(crate) const unsafe fn new(base_addr: usize) -> Self {
-        Self { base_addr }
+impl Device {
+    pub(crate) const unsafe fn new(ptr: *mut RegisterBlock) -> Self {
+        Self { ptr }
     }
 
-    fn ptr(&self) -> *const Bcm2835AuxUartRegisterBlock {
-        self.base_addr as *const _
+    fn ptr(&self) -> *const RegisterBlock {
+        self.ptr
     }
 
     pub(crate) fn init(&self) {}
 }
 
-impl Deref for Bcm2835AuxUartDevice {
-    type Target = Bcm2835AuxUartRegisterBlock;
+impl Deref for Device {
+    type Target = RegisterBlock;
 
     fn deref(&self) -> &Self::Target {
         unsafe { &*self.ptr() }
     }
 }
 
-impl Bcm2835AuxUartDevice {
+impl Device {
     pub(crate) fn put_char(&self, c: u8) {
         loop {
             if self.LSR.get() & MU_LSR_TXIDLE != 0 {

crates/drivers/bcm2835-aux-uart/src/lib.rs

@@ -0,0 +1,74 @@
+//
+// Copyright 2024, Colias Group, LLC
+//
+// SPDX-License-Identifier: BSD-2-Clause
+//
+
+#![no_std]
+
+use core::convert::Infallible;
+
+use embedded_hal_nb::nb;
+use embedded_hal_nb::serial;
+
+// use sel4_driver_interfaces::HandleInterrupt;
+
+mod device;
+
+use device::Device;
+
+pub struct Driver {
+    device: Device,
+}
+
+unsafe impl Send for Driver {}
+unsafe impl Sync for Driver {}
+
+impl Driver {
+    #[allow(clippy::missing_safety_doc)]
+    pub const unsafe fn new_uninit(ptr: *mut ()) -> Self {
+        Self {
+            device: Device::new(ptr.cast()),
+        }
+    }
+
+    #[allow(clippy::missing_safety_doc)]
+    pub unsafe fn new(ptr: *mut ()) -> Self {
+        let mut this = Self::new_uninit(ptr);
+        this.init();
+        this
+    }
+
+    pub fn init(&mut self) {
+        self.device.init();
+    }
+}
+
+impl serial::ErrorType for Driver {
+    type Error = Infallible;
+}
+
+// TODO
+// impl serial::Read for Driver {
+//     fn read(&mut self) -> nb::Result<u8, Self::Error> {
+//         self.device.get_char().ok_or(nb::Error::WouldBlock)
+//     }
+// }
+
+impl serial::Write for Driver {
+    fn write(&mut self, word: u8) -> nb::Result<(), Self::Error> {
+        self.device.put_char(word);
+        Ok(())
+    }
+
+    fn flush(&mut self) -> nb::Result<(), Self::Error> {
+        Ok(())
+    }
+}
+
+// TODO
+// impl HandleInterrupt for Driver {
+//     fn handle_interrupt(&mut self) {
+//         self.device.clear_all_interrupts()
+//     }
+// }

crates/drivers/pl011/Cargo.nix

@@ -0,0 +1,15 @@
+#
+# Copyright 2023, Colias Group, LLC
+#
+# SPDX-License-Identifier: BSD-2-Clause
+#
+
+{ mk, versions, localCrates }:
+
+mk {
+  package.name = "sel4-pl011-driver";
+  dependencies = {
+    inherit (versions) tock-registers embedded-hal-nb;
+    inherit (localCrates) sel4-driver-interfaces;
+  };
+}

crates/examples/microkit/http-server/pds/sp804-driver/core/Cargo.toml → crates/drivers/pl011/Cargo.toml

@@ -10,12 +10,13 @@
 #
 
 [package]
-name = "microkit-http-server-example-sp804-driver-core"
+name = "sel4-pl011-driver"
 version = "0.1.0"
 authors = ["Nick Spinale <[email protected]>"]
 edition = "2021"
 license = "BSD-2-Clause"
 
 [dependencies]
-log = "0.4.17"
+embedded-hal-nb = "1.0"
+sel4-driver-interfaces = { path = "../../sel4-driver-interfaces" }
 tock-registers = "0.8.1"

crates/examples/microkit/banscii/pds/pl011-driver/core/src/device.rs → crates/drivers/pl011/src/device.rs

@@ -46,11 +46,11 @@ pub struct Device {
 }
 
 impl Device {
-    pub unsafe fn new(ptr: *mut RegisterBlock) -> Self {
+    pub const unsafe fn new(ptr: *mut RegisterBlock) -> Self {
         Self { ptr }
     }
 
-    fn ptr(&self) -> *mut RegisterBlock {
+    const fn ptr(&self) -> *mut RegisterBlock {
         self.ptr
     }
 

crates/drivers/pl011/src/lib.rs

@@ -0,0 +1,72 @@
+//
+// Copyright 2023, Colias Group, LLC
+//
+// SPDX-License-Identifier: BSD-2-Clause
+//
+
+#![no_std]
+
+use core::convert::Infallible;
+
+use embedded_hal_nb::nb;
+use embedded_hal_nb::serial;
+
+use sel4_driver_interfaces::HandleInterrupt;
+
+mod device;
+
+use device::Device;
+
+pub struct Driver {
+    device: Device,
+}
+
+unsafe impl Send for Driver {}
+unsafe impl Sync for Driver {}
+
+impl Driver {
+    #[allow(clippy::missing_safety_doc)]
+    pub const unsafe fn new_uninit(ptr: *mut ()) -> Self {
+        Self {
+            device: Device::new(ptr.cast()),
+        }
+    }
+
+    #[allow(clippy::missing_safety_doc)]
+    pub unsafe fn new(ptr: *mut ()) -> Self {
+        let mut this = Self::new_uninit(ptr);
+        this.init();
+        this
+    }
+
+    pub fn init(&mut self) {
+        self.device.init();
+    }
+}
+
+impl serial::ErrorType for Driver {
+    type Error = Infallible;
+}
+
+impl serial::Read for Driver {
+    fn read(&mut self) -> nb::Result<u8, Self::Error> {
+        self.device.get_char().ok_or(nb::Error::WouldBlock)
+    }
+}
+
+impl serial::Write for Driver {
+    fn write(&mut self, word: u8) -> nb::Result<(), Self::Error> {
+        self.device.put_char(word);
+        Ok(())
+    }
+
+    fn flush(&mut self) -> nb::Result<(), Self::Error> {
+        Ok(())
+    }
+}
+
+impl HandleInterrupt for Driver {
+    fn handle_interrupt(&mut self) {
+        self.device.clear_all_interrupts()
+    }
+}

crates/drivers/pl031/Cargo.nix

@@ -0,0 +1,14 @@
+#
+# Copyright 2024, Colias Group, LLC
+#
+# SPDX-License-Identifier: BSD-2-Clause
+#
+
+{ mk, versions, localCrates }:
+
+mk {
+  package.name = "sel4-pl031-driver";
+  dependencies = {
+    inherit (versions) tock-registers rtcc;
+  };
+}

crates/examples/microkit/banscii/pds/pl011-driver/core/Cargo.toml → crates/drivers/pl031/Cargo.toml

@@ -10,11 +10,12 @@
 #
 
 [package]
-name = "banscii-pl011-driver-core"
+name = "sel4-pl031-driver"
 version = "0.1.0"
 authors = ["Nick Spinale <[email protected]>"]
 edition = "2021"
 license = "BSD-2-Clause"
 
 [dependencies]
+rtcc = "0.3.2"
 tock-registers = "0.8.1"

crates/examples/microkit/http-server/pds/pl031-driver/core/src/device.rs → crates/drivers/pl031/src/device.rs

@@ -58,7 +58,7 @@ pub struct Device {
 
 #[allow(dead_code)]
 impl Device {
-    pub unsafe fn new(ptr: *const ()) -> Self {
+    pub const unsafe fn new(ptr: *const ()) -> Self {
         let ptr = ptr.cast::<RtcRegisterBlock>();
         Self { ptr }
     }