lib: single-core boot sequence

Signed-off-by: Zhouqi Jiang <luojia@hust.edu.cn>

Cargo.lock

@@ -2,6 +2,12 @@
 # It is not intended for manual editing.
 version = 3
 
+[[package]]
+name = "autocfg"
+version = "1.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0c4b4d0bd25bd0b74681c0ad21497610ce1b7c91b1022cd21c80c6fbdd9476b0"
+
 [[package]]
 name = "critical-section"
 version = "1.1.2"
@@ -14,12 +20,46 @@ version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "361a90feb7004eca4019fb28352a9465666b24f840f5c3cddf0ff13920590b89"
 
+[[package]]
+name = "lock_api"
+version = "0.4.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "07af8b9cdd281b7915f413fa73f29ebd5d55d0d3f0155584dade1ff18cea1b17"
+dependencies = [
+ "autocfg",
+ "scopeguard",
+]
+
+[[package]]
+name = "log"
+version = "0.4.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "90ed8c1e510134f979dbc4f070f87d4313098b704861a105fe34231c70a3901c"
+
 [[package]]
 name = "panic-halt"
 version = "0.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "de96540e0ebde571dc55c73d60ef407c653844e6f9a1e2fdbd40c07b9252d812"
 
+[[package]]
+name = "proc-macro2"
+version = "1.0.82"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8ad3d49ab951a01fbaafe34f2ec74122942fe18a3f9814c3268f1bb72042131b"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.36"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0fa76aaf39101c457836aec0ce2316dbdc3ab723cdda1c6bd4e6ad4208acaca7"
+dependencies = [
+ "proc-macro2",
+]
+
 [[package]]
 name = "riscv"
 version = "0.11.1"
@@ -30,14 +70,81 @@ dependencies = [
  "embedded-hal",
 ]
 
+[[package]]
+name = "rustsbi"
+version = "0.4.0-alpha.2"
+source = "git+https://github.com/rustsbi/rustsbi#2daec25b1bdcb8596ae01a25327eb9ce6fb4738f"
+dependencies = [
+ "riscv",
+ "rustsbi-macros",
+ "sbi-spec",
+]
+
+[[package]]
+name = "rustsbi-macros"
+version = "0.0.1"
+source = "git+https://github.com/rustsbi/rustsbi#2daec25b1bdcb8596ae01a25327eb9ce6fb4738f"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
 [[package]]
 name = "rustsbi-prototyper"
 version = "0.0.0"
 dependencies = [
+ "log",
  "panic-halt",
  "riscv",
+ "rustsbi",
+ "spin",
+ "uart16550",
 ]
 
+[[package]]
+name = "sbi-spec"
+version = "0.0.7"
+source = "git+https://github.com/rustsbi/rustsbi#2daec25b1bdcb8596ae01a25327eb9ce6fb4738f"
+
+[[package]]
+name = "scopeguard"
+version = "1.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
+
+[[package]]
+name = "spin"
+version = "0.9.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6980e8d7511241f8acf4aebddbb1ff938df5eebe98691418c4468d0b72a96a67"
+dependencies = [
+ "lock_api",
+]
+
+[[package]]
+name = "syn"
+version = "2.0.61"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c993ed8ccba56ae856363b1845da7266a7cb78e1d146c8a32d54b45a8b831fc9"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "uart16550"
+version = "0.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "939f6f9ccad815fe3efca8fd06f2ec1620c0387fb1bca2b231b61ce710bffb9b"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
+
 [[package]]
 name = "xtask"
 version = "0.1.0"

Cargo.toml

@@ -9,8 +9,12 @@ repository.workspace = true
 forced-target = "riscv64imac-unknown-none-elf"
 
 [dependencies]
+log = "0.4.21"
 panic-halt = "0.2.0"
 riscv = "0.11.1"
+rustsbi = { git = "https://github.com/rustsbi/rustsbi", features = ["machine"] }
+spin = "0.9.8"
+uart16550 = "0.0.1"
 
 [[bin]]
 name = "rustsbi-prototyper"

src/board.rs

@@ -0,0 +1,33 @@
+//! Board support, including peripheral and core drivers.
+
+use rustsbi::{Console, Physical, RustSBI, SbiRet};
+
+#[derive(RustSBI)]
+#[rustsbi(dynamic)]
+pub struct Board<'a> {
+    #[rustsbi(console)]
+    uart16550: Option<ConsoleUart16550<'a>>,
+}
+
+struct ConsoleUart16550<'a> {
+    inner: &'a uart16550::Uart16550<u8>,
+}
+
+impl<'a> Console for ConsoleUart16550<'a> {
+    #[inline]
+    fn write(&self, bytes: Physical<&[u8]>) -> SbiRet {
+        // TODO verify valid memory range for a `Physical` slice.
+        let start = bytes.phys_addr_lo();
+        let buf = unsafe { core::slice::from_raw_parts(start as *const u8, bytes.num_bytes()) };
+        SbiRet::success(self.inner.write(buf))
+    }
+    #[inline]
+    fn read(&self, _bytes: Physical<&mut [u8]>) -> SbiRet {
+        todo!()
+    }
+    #[inline]
+    fn write_byte(&self, byte: u8) -> SbiRet {
+        self.inner.write(&[byte]);
+        SbiRet::success(0)
+    }
+}

src/console.rs

@@ -0,0 +1,77 @@
+use core::{
+    fmt::{self, Write},
+    str::FromStr,
+};
+use log::{Level, LevelFilter};
+use spin::Mutex;
+use uart16550::Uart16550;
+
+#[doc(hidden)]
+pub enum MachineConsole {
+    Uart16550(*const Uart16550<u8>),
+}
+
+impl fmt::Write for MachineConsole {
+    #[inline]
+    fn write_str(&mut self, s: &str) -> fmt::Result {
+        let mut bytes = s.as_bytes();
+        match self {
+            Self::Uart16550(uart16550) => {
+                while !bytes.is_empty() {
+                    let count = unsafe { &**uart16550 }.write(bytes);
+                    bytes = &bytes[count..];
+                }
+            }
+        }
+        Ok(())
+    }
+}
+
+unsafe impl Send for MachineConsole {}
+unsafe impl Sync for MachineConsole {}
+
+#[doc(hidden)]
+pub static CONSOLE: Mutex<MachineConsole> =
+    Mutex::new(MachineConsole::Uart16550(0x10000000 as *const _));
+
+pub fn init() {
+    log::set_max_level(
+        option_env!("RUST_LOG")
+            .and_then(|s| LevelFilter::from_str(s).ok())
+            .unwrap_or(LevelFilter::Info),
+    );
+    log::set_logger(&Logger).unwrap();
+}
+
+struct Logger;
+
+impl log::Log for Logger {
+    #[inline]
+    fn enabled(&self, _metadata: &log::Metadata) -> bool {
+        true
+    }
+
+    #[inline]
+    fn log(&self, record: &log::Record) {
+        let color_code: u8 = match record.level() {
+            Level::Error => 31,
+            Level::Warn => 93,
+            Level::Info => 34,
+            Level::Debug => 32,
+            Level::Trace => 90,
+        };
+        println!(
+            "\x1b[{color_code}m[{:>5}] {}\x1b[0m",
+            record.level(),
+            record.args(),
+        );
+    }
+
+    fn flush(&self) {}
+}
+
+// pub fn load_console_uart16550(uart16550: &Uart16550<u8>) {
+//     let mut console = CONSOLE.lock();
+//     *console = MachineConsole::Uart16550(uart16550);
+//     drop(console);
+// }

src/macros.rs

@@ -0,0 +1,21 @@
+// Ref: rcore-console crate
+
+#[allow(unused)]
+macro_rules! print {
+    ($($arg:tt)*) => {
+        let mut console = $crate::console::CONSOLE.lock();
+        console.write_fmt(core::format_args!($($arg)*)).unwrap();
+        drop(console);
+    }
+}
+
+#[allow(unused)]
+macro_rules! println {
+    () => ($crate::print!("\n"));
+    ($($arg:tt)*) => {{
+        let mut console = $crate::console::CONSOLE.lock();
+        console.write_fmt(core::format_args!($($arg)*)).unwrap();
+        console.write_char('\n').unwrap();
+        drop(console);
+    }}
+}

src/main.rs

@@ -2,6 +2,13 @@
 #![no_std]
 #![no_main]
 
+#[macro_use]
+extern crate log;
+#[macro_use]
+mod macros;
+
+mod board;
+mod console;
 mod dynamic;
 
 use panic_halt as _;
@@ -9,6 +16,13 @@ use riscv::register::mstatus;
 
 extern "C" fn main(hart_id: usize, opaque: usize, nonstandard_a2: usize) -> usize {
     let _ = (hart_id, opaque);
+    console::init();
+
+    info!("RustSBI version {}", rustsbi::VERSION);
+    for line in rustsbi::LOGO.lines() {
+        info!("{}", line);
+    }
+    info!("Initializing RustSBI machine-mode environment.");
 
     let info = dynamic::read_paddr(nonstandard_a2).unwrap_or_else(fail_no_dynamic_info_available);