1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

// Copyright 2023 Google LLC
// SPDX-License-Identifier: Apache-2.0
const FLAG_REGISTER_OFFSET: usize = 0x18;
const FR_BUSY: u8 = 1 << 3;
const FR_TXFF: u8 = 1 << 5;

/// PL011 UART 的最小驱动程序。
#[derive(Debug)]
pub struct Uart {
    base_address: *mut u8,
}

impl Uart {
    /// 为 PL011 设备构造一个新的 UART 驱动程序实例
    /// 给定基地址。
    ///
    /// ＃ 安全
    ///
    /// 给定的基地址必须指向一个MMIO的8个控制寄存器
    ///PL011设备，必须映射到进程的地址空间
    /// 作为设备内存并且没有任何其他别名。
    pub unsafe fn new(base_address: *mut u8) -> Self {
        Self { base_address }
    }

    /// 将单个字节写入 UART。
    pub fn write_byte(&self, byte: u8) {
        // 等待，直到 TX 缓冲区中有空间。
        while self.read_flag_register() & FR_TXFF != 0 {}

        // 安全：我们知道基地址指向控件
        // 正确映射的 PL011 设备的寄存器。
        unsafe {
            // 写入 TX 缓冲区。
            self.base_address.write_volatile(byte);
        }

        // 等待 UART 不再繁忙。
        while self.read_flag_register() & FR_BUSY != 0 {}
    }

    fn read_flag_register(&self) -> u8 {
        // 安全：我们知道基地址指向控件
        // 正确映射的 PL011 设备的寄存器。
        unsafe { self.base_address.add(FLAG_REGISTER_OFFSET).read_volatile() }
    }
}