lib: support uart peripheral, small fixes

Signed-off-by: zhujunxing <zjx1319@hust.edu.cn>

Author: jakezhu9

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "hello-world"
-version = "0.1.0"
+version = "0.0.0"
 
 edition.workspace = true
 license.workspace = true
@@ -9,7 +9,6 @@ repository.workspace = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-uart16550 = "0.0.1"
 sophgo-rom-rt = { version = "0.0.0", path = "../../sophgo-rom-rt" }
 panic-halt = "0.2.0"
 

examples/hello-world/Cargo.toml

@@ -5,13 +5,12 @@
 #![no_main]
 
 use panic_halt as _;
-use sophgo_rom_rt::entry;
+use sophgo_rom_rt::{entry, Peripherals};
 
 #[entry]
-fn main() -> ! {
-    let uart = unsafe { &*(0x04140000 as *const uart16550::Uart16550<u32>) };
+fn main(p: Peripherals) -> ! {
     loop {
-        uart.write(b"Hello World from Rust!\n");
+        p.uart0.write(b"Hello World from Rust!\n");
         // TODO fix Uart16550 crate bug; it doesn't block when UART FIFO is not empty
     }
 }

examples/hello-world/src/main.rs

@@ -9,3 +9,5 @@ repository.workspace = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+base-address = "0.0.0"
+uart16550 = "0.0.1"

sophgo-hal/Cargo.toml

@@ -1 +1,19 @@
 #![no_std]
+
+use core::ops;
+
+use base_address::BaseAddress;
+
+/// Universal Asynchronous Receiver/Transmitter.
+pub struct UART<A: BaseAddress> {
+    base: A,
+}
+
+impl<A: BaseAddress> ops::Deref for UART<A> {
+    type Target = uart16550::Uart16550<u32>;
+
+    #[inline(always)]
+    fn deref(&self) -> &Self::Target {
+        unsafe { &*(self.base.ptr() as *const _) }
+    }
+}

sophgo-hal/src/lib.rs

@@ -9,4 +9,6 @@ repository.workspace = true
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+base-address = "0.0.0"
+sophgo-hal = { version = "0.0.0", path = "../sophgo-hal" }
 sophgo-rom-rt-macros = { version = "0.0.0", path = "macros" }

sophgo-rom-rt/Cargo.toml

@@ -1,7 +1,10 @@
 [package]
 name = "sophgo-rom-rt-macros"
 version = "0.0.0"
-edition = "2021"
+
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

sophgo-rom-rt/macros/Cargo.toml

@@ -15,7 +15,7 @@ pub fn entry(args: TokenStream, input: TokenStream) -> TokenStream {
 
     let f = parse_macro_input!(input as ItemFn);
 
-    if f.sig.inputs.len() != 0 {
+    if f.sig.inputs.len() != 1 {
         return parse::Error::new(
             f.sig.inputs.span(),
             "`#[entry]` function without rom peripherals should not include any parameter",
@@ -35,7 +35,7 @@ pub fn entry(args: TokenStream, input: TokenStream) -> TokenStream {
     if !valid_signature {
         return parse::Error::new(
             f.sig.span(),
-            "`#[entry]` function must have signature `[unsafe] fn() -> !`",
+            "`#[entry]` function must have signature `[unsafe] fn(Peripherals) -> !`",
         )
         .to_compile_error()
         .into();
@@ -44,12 +44,18 @@ pub fn entry(args: TokenStream, input: TokenStream) -> TokenStream {
     let attrs = f.attrs;
     let unsafety = f.sig.unsafety;
     let stmts = f.block.stmts;
+    let inputs = f.sig.inputs;
 
     quote!(
-        #[allow(non_snake_case)]
         #[export_name = "main"]
+        pub extern "C" fn main() -> ! {
+            let p = unsafe { core::mem::transmute(()) };
+            unsafe { __sophgo_rom_rt_macros__main(p) }
+        }
+        #[allow(non_snake_case)]
+        #[inline(always)]
         #(#attrs)*
-        pub #unsafety fn main() -> ! {
+        #unsafety fn __sophgo_rom_rt_macros__main(#inputs) -> ! {
             #(#stmts)*
         }
     )

sophgo-rom-rt/macros/src/lib.rs

@@ -3,6 +3,14 @@
 
 pub use sophgo_rom_rt_macros::entry;
 
+use base_address::Static;
+
+/// Peripherals available on ROM start.
+pub struct Peripherals {
+    /// Universal Asynchronous Receiver/Transmitter 0.
+    pub uart0: sophgo_hal::UART<Static<0x04140000>>,
+}
+
 #[cfg(target_arch = "riscv64")]
 use core::arch::asm;
 

sophgo-rom-rt/src/lib.rs

@@ -1,6 +1,6 @@
 [package]
 name = "sophgo-rom-tool"
-version = "0.1.0"
+version = "0.0.0"
 
 edition.workspace = true
 license.workspace = true