Skip to main content

os/
serial.rs

1/*
2 * ============================================
3 * RISC-V 串口驱动模块
4 * ============================================
5 * 功能:提供 UART 16550 串口输出功能
6 * 用途:调试输出、日志记录、与 QEMU 通信
7 *
8 * RISC-V QEMU virt 机器的串口地址:0x10000000
9 * ============================================
10 */
11
12use core::fmt;
13use lazy_static::lazy_static;
14use spin::Mutex;
15use volatile::Volatile;
16
17// RISC-V QEMU virt 机器的 UART 基地址
18const UART_BASE_ADDRESS: usize = 0x1000_0000;
19
20/// UART 16550 寄存器偏移
21const UART_THR: usize = 0; // Transmitter Holding Register
22const UART_LSR: usize = 5; // Line Status Register
23
24/// Line Status Register 位定义
25const UART_LSR_THRE: u8 = 1 << 5; // Transmitter Holding Register Empty
26
27/// 简单的 UART 串口驱动
28pub struct SerialPort {
29    base_address: usize,
30}
31
32impl SerialPort {
33    /// 创建新的串口实例
34    ///
35    /// # Safety
36    ///
37    /// `base_address` must point to a valid UART-compatible MMIO region for
38    /// the lifetime of the returned serial port.
39    pub unsafe fn new(base_address: usize) -> Self {
40        SerialPort { base_address }
41    }
42
43    /// 初始化串口
44    pub fn init(&mut self) {
45        // QEMU 的 UART 默认已初始化,无需额外配置
46    }
47
48    /// 发送一个字节
49    fn send(&mut self, byte: u8) {
50        unsafe {
51            // 等待发送缓冲区为空
52            while !self.is_transmit_empty() {}
53
54            // 写入数据
55            let thr = (self.base_address + UART_THR) as *mut Volatile<u8>;
56            (*thr).write(byte);
57        }
58    }
59
60    /// 检查发送缓冲区是否为空
61    fn is_transmit_empty(&self) -> bool {
62        unsafe {
63            let lsr = (self.base_address + UART_LSR) as *const Volatile<u8>;
64            (*lsr).read() & UART_LSR_THRE != 0
65        }
66    }
67}
68
69impl fmt::Write for SerialPort {
70    fn write_str(&mut self, s: &str) -> fmt::Result {
71        for byte in s.bytes() {
72            self.send(byte);
73        }
74        Ok(())
75    }
76}
77
78/// Write raw bytes directly to the serial port (for syscall stdout).
79pub fn write_bytes(data: &[u8]) {
80    crate::interrupts::without_interrupts(|| {
81        let mut port = SERIAL1.lock();
82        for &byte in data {
83            port.send(byte);
84        }
85    });
86}
87
88lazy_static! {
89    /// 全局串口实例(UART0)
90    ///
91    /// 使用 Mutex 保护以支持多核访问
92    /// 在 RISC-V QEMU virt 机器中,UART 映射到 0x10000000
93    pub static ref SERIAL1: Mutex<SerialPort> = {
94        let mut serial_port = unsafe { SerialPort::new(UART_BASE_ADDRESS) };
95        serial_port.init();
96        Mutex::new(serial_port)
97    };
98}
99
100/// 底层打印函数
101///
102/// # 功能
103/// - 格式化输出到串口
104/// - 在临界区内执行,禁用中断以防止死锁
105///
106/// # 参数
107/// - `args`: 格式化参数
108#[doc(hidden)]
109pub fn _print(args: ::core::fmt::Arguments) {
110    use core::fmt::Write;
111
112    // RISC-V 中断禁用/启用
113    // 使用自旋锁时禁用中断,防止死锁
114    crate::interrupts::without_interrupts(|| {
115        SERIAL1
116            .lock()
117            .write_fmt(args)
118            .expect("Printing to serial failed");
119    });
120}
121
122/// 串口打印宏
123///
124/// # 用法
125/// ```rust
126/// serial_print!("Hello, RISC-V!");
127/// serial_print!("Value: {}", 42);
128/// ```
129#[macro_export]
130macro_rules! serial_print {
131    ($($arg:tt)*) => {
132        $crate::serial::_print(format_args!($($arg)*));
133    };
134}
135
136/// 串口打印宏(带换行)
137///
138/// # 用法
139/// ```rust
140/// serial_println!();                    // 仅换行
141/// serial_println!("Hello, RISC-V!");    // 打印并换行
142/// serial_println!("x = {}", x);         // 格式化打印
143/// ```
144#[macro_export]
145macro_rules! serial_println {
146    () => ($crate::serial_print!("\n"));
147    ($fmt:expr) => ($crate::serial_print!(concat!($fmt, "\n")));
148    ($fmt:expr, $($arg:tt)*) => ($crate::serial_print!(
149        concat!($fmt, "\n"), $($arg)*));
150}