驱动 UART

介绍

通过读取设备树信息，我们可以知道 QEMU 使用的 UART 设备与 ns16550a 兼容，阅读全志哪吒 D1 开发板的文档可知它的 UART 设备与 ns16550a 不完全兼容（请注意下文具体提到之处）。因此我们参考 ns16550a 的文档编写两者的驱动程序。其中对于 D1 开发板，我们暂时只关注 UART0，也就是主板上的调试接口。

// QEMU Device Tree
uart@10000000 {
    interrupts = <0x0a>;
    interrupt-parent = <0x03>;
    clock-frequency = "\08@";
    reg = <0x00 0x10000000 0x00 0x100>;
    compatible = "ns16550a";
};

关于 ns16550a，这里主要参考 Serial UART information、D1_User_Manual_V0.1(Draft Version)与龙芯 1C300 处理器用户手册 1.4 版，其中龙芯 1C300 中所用 UART 芯片也是 16550a 兼容芯片，可供参考。

UART 全称通用异步接收发射器，它提供与外部设备、调制解调器（数据载波设备、DCE）的异步串行通信。它将外设接收的数据进行串-并行转换，并将转换后的数据传输到内部总线。它也将传输到外设的数据执行并-串行转换。

FIFO 是“First-In First-Out”的缩写，在此处语境下，它是一个具有先入先出特点的缓冲区，设计目的是提高串口的通讯性能，避免频繁进入中断占用CPU资源，或因如果没有及时读走数据，下一个字节数据覆盖先前数据，导致数据丢失。

使用 FIFO，可以在连续收发若干个数据后才产生一次中断，然后一起进行处理，提高接收效率，缺点是实时性受影响。如果 FIFO 中的数据没有达到指定长度而无法产生中断，可以利用接收超时中断，即在一定的时间内没有接收到数据会进入中断，把不足 FIFO 长度的数据读取完。

解决实时性的问题：保持一个字节进一次接收中断，以保证实时性。把 FIFO 打开，在接收中断处理完后去判断缓冲区中是否仍有数据，若有则继续读入，防止数据丢失，此时不会有数据过短无法产生中断的问题。

D1 开发板的 UART 芯片有以下几个特性：

• 兼容 16550 UART
• 有两个独立的 FIFO：接收 FIFO 和发送 FIFO，UART0 中每个都是 64 bytes
• 从 APB 总线时钟获得工作参考时钟（忽略）
• RS-232 字符的 5 到 8 位数据位，或 RS-485 格式的 9 位
• 支持 1、1.5 或 2 位停止位
• 可编程的校验（奇校验、偶校验或不校验）
• 支持 DMA
• 支持软件/硬件流控制

寄存器及数据结构设计

寄存器参考 D1 文档第 9.2.5 节寄存器列表与 9.2.6 节寄存器描述。

• QEMU：只有从 UART_RBR 到 UART_LSR 的寄存器，我们使用全部这些寄存器。
  • 寄存器宽度为 8bit
  • 其余寄存器均为全志平台特有
• 全志平台：对于全志平台我们只使用从 UART_RBR 到 UART_LSR 的寄存器与 UART_HALT 寄存器。
  • 寄存器宽度为 32bit，但此处所使用的寄存器均只有低 8 位有效（兼容 16550a）

// QEMU
struct uart_16550a_regs {
    uint8_t RBR_THR_DLL; // 0x00, Receiver Buffer Register/Transmitter Holding Register/Divisor Latch LSB
    uint8_t IER_DLM; // 0x01, Interrupt Enable Register/Divisor Latch MSB
    uint8_t IIR_FCR; // 0x02, Interrupt Identification Register/FIFO Control Register
    uint8_t LCR; // 0x03, Line Control Register
    uint8_t MCR; // 0x04, Modem Control Register
    uint8_t LSR; // 0x05, Line Status Register
};

// D1 board
struct uart_sunxi_regs {
    uint32_t RBR_THR_DLL; // 0x00, Receiver Buffer Register/Transmitter Holding Register/Divisor Latch LSB
    uint32_t IER_DLM; // 0x04, Interrupt Enable Register/Divisor Latch MSB
    uint32_t IIR_FCR; // 0x08, Interrupt Identification Register/FIFO Control Register
    uint32_t LCR; // 0x0c, Line Control Register
    uint32_t MCR; // 0x10, Modem Control Register
    uint32_t LSR; // 0x14, Line Status Register
    uint32_t padding1[(0x007C-0x18)/4];
    uint32_t USR; // 0x007C, UART Status Register
    uint32_t padding2[(0x00A4-0x80)/4];
    uint32_t HALT; // 0x00A4, UART Halt TX Register
};

具体寄存器格式请参考 D1_User_Manual_V0.1(Draft Version) 第 899 至 927 页。这里根据几个比较重要的功能和设置来介绍一些寄存器。

RBR 是 UART 模式下串行输入端口上接收的数据。仅当 UART_LSR 中的数据就绪（DR）位为 1 时数据有效。如果在 FIFO 模式，则该寄存器访问接收 FIFO 的头部。THR 是在 UART 模式下的串行输出端口上发送的数据。对于这两个寄存器，当 FIFO 已满时，后续到来的数据会丢失。

DLL 寄存器存放分频除数的低位，DLM 寄存器存放分频除数的高位。

中断使能寄存器（IER）

要想使 16550a 能产生中断，需要将 IER 寄存器的对应为置 1。

中断标识寄存器（IIR）

中断标识寄存器的格式如下：

16550a 可产生 5 种中断，这 5 种中断的发生由上述 IER 寄存器的位控制：

FIFO 控制寄存器（FCR）

这个寄存器主要控制 FIFO 的设置与清除。

线路控制寄存器（LCR）

这个寄存器主要控制寄存器访问与收发时数据帧的格式，包括校验、停止位与字符的长度。

线路状态寄存器（LSR）

其余寄存器如 MCR、MSR 我们用不到，就不再介绍。

UART 操作模式

数据帧格式

UART_LCR 寄存器可以设置数据帧的基本参数：数据宽度(5-8 bits)、停止位（1、1.5 或 2 位停止位）、校验形式。

UART 的帧传输包括启动信号、数据信号、奇偶校验位和停止信号。最低有效位（LSB）首先传输。

• 开始信号（开始位）：数据帧的开始标志。根据 UART 协议，开始位传输信号为低电平。
• 数据信号（数据位）：数据位宽度可以配置为 5 - 8 位。
• 奇偶校验位：1 位的错误校正信号。奇偶校验位可通过 UART_LCR 设置奇校验、偶校验或无校验。
• 停止信号（停止位）：数据帧的停止位。UART_LCR 寄存器可以设置停止位为 1 位、1.5 位或 2 位。结束位传输信号为高电平。

波特率

波特率计算如下：波特率 = SCLK /（16 除数）。D1 开发板中，SCLK 通常是 APB1，可在 CCU 中设置。*

其中除数（divisor, 分频）有 16 位，低 8 位在 UART_DLL 寄存器中，高 8 位在 UART_DLH 寄存器中。

如果要设置波特率为 115200，时钟源的频率为 24 MHz，根据公式可得除数约为 13.

DLAB 定义

UART_LCR 的第 7 位为 DLAB(Divisor Latch Access Bit)，控制分频锁存器的访问。

• DLAB = 0，第一、二个寄存器是 UART_RBR/UART_THR (RX/TX FIFO) 寄存器、UART_IER 寄存器。
• DLAB = 1，第一、二个寄存器是 UART_DLL（除数低位）寄存器、UART_DLH（除数高位）寄存器

初始化设置除数时须设 DLAB = 1，结束配置时须设 DLAB = 0 以便访问数据。

CHCFG_AT_BUSY 定义（全志平台特有，不能忽略，否则初始化会出错）

CHCFG_AT_BUSY（UART_HALT[1]）和 CHANGE_UPDATE（UART_HALT[2]）的功能如下。

CHCFG_AT_BUSY：启用该位，则软件可以在 UART 繁忙时依然设置 UART 控制器，例如 UART_LCR、UART_DLH、UART_DLL 寄存器。

CHANGE_UPDATE：如果启用了 CHCFG_AT_BUSY，并将 CHANGE_UPDATE 写入 1，则 UART 控制器的设置会被更新。完成更新后，位会自动清除到 0。

设置除数应执行以下步骤：

1. 设 CHCFG_AT_BUSY = 1
2. 设 DLAB = 1 并设置 UART_DLH 与 UART_DLL 寄存器
3. 设 CHANGE_UPDATE = 1 以更新配置，更新完成后将会自动被设为 0

UART 忙标志位（全志平台特有）

UART_USR[0] 是 UART 控制器的忙标志位。当有收发数据时，或 FIFO 不为空时，忙标志位就会被自动设为 1，表明 UART 控制器正忙。

程序设计

UART 控制器初始化

I/O 配置(全志平台特有，忽略)：将 GPIO 多路复用配置为 UART 功能，并将 UART 引脚设置为内部上拉模式。

1. 等待发送缓冲区清空（所有数据发送完）
2. 设置 UART_IER = 0 以关闭所有 UART 中断，避免在未设置完成时就触发中断。

波特率配置:

1. 计算 UART 波特率
2. 设置 UART_HALT[HALT_TX] = 1 以禁用发送（全志平台特有）
3. 设置 UART_HALT[CHCFG_AT_BUSY] = 1 使得 DLL 和 DLM 可以被写入（全志平台特有）
4. 设置 UART_LCR[DLAB] = 1，其他位保留默认配置，使第一第二个端口进入波特率设置模式以访问分频锁存器
5. 访问 UART_USR[BUSY] 位，直到其变为 0，等待到 UART 控制器不忙（全志平台特有）
6. 向 UART_DLH 寄存器写入分频的高八位，向 UART_DLL 寄存器写入分频的低八位
7. 设置 HALT[CHANGE_UPDATE] = 1，使得 DLL 和 DLM 被更新（全志平台特有）
8. 等待 HALT[CHANGE_UPDATE] 位置 0，表示 DLL 和 DLM 已经被读取（全志平台特有）
9. 设置 UART_HALT[HALT_TX] = 0 以启用发送（全志平台特有）

控制参数配置：

1. 写入 UART_LCR 以设置数据宽度、停止位、奇偶校验方式，并写 UART_LCR[DLAB] = 0，恢复正常模式
2. 写入 UART_FCR 寄存器设置 FIFO 触发条件并启用 FIFO

中断配置：

1. 设置 UART_IER[ERBFI] = 1 以打开接收有效中断

上面的等待部分需要通过轮询来查询状态，否则几乎必然会有问题，由此可见 D1 开发板的 UART 速度很慢，我们需要不断地确保所有操作已经完成。

代码如下：

// QEMU init
static void uart_16550a_init()
{
    volatile struct uart_qemu_regs *regs = (struct uart_qemu_regs *)uart_device.uart_start_addr;

    regs->IER_DLM = 0; // 关闭 16550a 的所有中断，避免初始化未完成就发生中断
    while(!(regs->LSR & (1 << LSR_THRE))); // 等待发送缓冲区为空

    // 设置波特率
    uint8_t divisor_least = uart_device.divisor & 0xFF;
    uint8_t divisor_most = uart_device.divisor >> 8;
    regs->LCR |= 1 << LCR_DLAB; // 设置 DLAB=1，进入波特率设置模式，访问 DLL 和 DLM 寄存器设置波特率
    regs->IER_DLM = divisor_most; // 设置 DLM
    regs->RBR_THR_DLL = divisor_least; // 设置 DLL

    regs->LCR = 0b00000011; // 一次传输 8bit（1字节），无校验，1 位停止位，禁用 break 信号，设置 DLAB=0，进入数据传输/中断设置模式
    regs->IIR_FCR |= 0b00000001; // 设置 FCR[TL]=00，设置中断阈值为 1 字节，设置 FCR[FIFOE]=1，启动 FIFO
    regs->IER_DLM |= 1 << IER_ERBFI; // 设置 IER，启用接收数据时发生的中断

    uart_device.ops = uart_16550a_ops;
}

// D1 board init
static void uart_16550a_init()
{
    volatile struct uart_sunxi_regs *regs = (struct uart_sunxi_regs *)uart_device.uart_start_addr;
    regs->IER_DLM = 0; // 关闭 16550a 的所有中断，避免初始化未完成就发生中断
    while(!(regs->LSR & (1 << LSR_THRE))); // 等待发送缓冲区为空

    // 设置波特率
    uint8_t divisor_least = uart_device.divisor & 0xFF;
    uint8_t divisor_most = uart_device.divisor >> 8;
    regs->HALT |= 1 << HALT_HALT_TX; // 关闭发送（全志平台特有）
    regs->HALT |= 1 << HALT_CHCFG_AT_BUSY; // 先设置 HALT 中的 CHCFG_AT_BUSY 位，使得 DLL 和 DLM 可以被写入（全志平台特有）
    regs->LCR |= 1 << LCR_DLAB; // 设置 DLAB=1，进入波特率设置模式，访问 DLL 和 DLM 寄存器设置波特率
    while (regs->USR & 1 << USR_BUSY); // 等待 USR 中的 BUSY 位为 0，即空闲
    regs->RBR_THR_DLL = divisor_least; // 设置 DLL
    regs->IER_DLM = divisor_most; // 设置 DLM
    regs->HALT |= 1 << HALT_CHANGE_UPDATE; // 将 HALT 中的 CHANGE_UPDATE 位置 1，使得 DLL 和 DLM 被更新（全志平台特有）
    while (regs->HALT & (1 << HALT_CHANGE_UPDATE)); // 等待 HALT 中的 CHANGE_UPDATE 位置 0，表示 DLL 和 DLM 已经被读取（全志平台特有）
    regs->HALT &= ~(1 << HALT_HALT_TX); // 开启发送（全志平台特有）

    regs->LCR = 0b00000011; // 一次传输 8bit（1字节），无校验，1 位停止位，禁用 break 信号，设置 DLAB=0，进入数据传输/中断设置模式
    regs->IIR_FCR |= 0b00000001; // 设置 FCR[TL]=00，设置中断阈值为 1 字节，设置 FCR[FIFOE]=1，启动 FIFO
    regs->IER_DLM |= 1 << IER_ERBFI; // 设置 IER，启用接收数据时发生的中断

    uart_device.ops = uart_16550a_ops;
}

轮询模式下发送数据

在我们的实验中 UART 一次发送的量通常较小，因此选择简单的轮询模式发送数据。

1. 检查 UART_LSR[THRE] 以检查发送 FIFO 是否为空。若 UART_LSR[THRE] = 0，则表明发送 FIFO 中的仍有数据，等待数据传输完成
2. 写入将要被传送的数据至 UART_THR 寄存器

代码如下：

void uart_16550a_directly_write(int8_t c)
{
    regs->RBR_THR_DLL = c; /* write THR */
}

void uart_16550a_putc(int8_t c)
{
    while (!(regs->LSR & (1 << LSR_THRE)))
        ;
    uart_16550a_directly_write(c);
}

中断模式中接收数据

1. 设置 UART_IER[ERBFI] = 1 以启用 UART 接收中断
2. 当接收 FIFO 的数据达到触发条件时（如达到触发阈值或超时)，UART 接受中断信号将会产生
3. 读取 UART_LSR[DR] 检查 RX_FIFO 状态，若该位为 1，继续从 UART_RBR 读取数据，直至该位变为 0，接收结束

同时我们在中断发生时发送接收到的字符，代码如下：

int8_t uart_16550a_read()
{
    return regs->RBR_THR_DLL; /* read RBR */
}

// QEMU interrupt handler
void uart_16550a_interrupt_handler()
{
    while (regs->LSR & (1 << LSR_DR)) {
        int8_t c = uart_read();
        if (c > -1)
            uart_16550a_putc(c);
    }
}

对于 D1 开发板，在初始化写入分频除数时会产生一个 UART busy 中断，需要在中断处理程序中处理：

// D1 board interrupt handler
static void uart_16550a_interrupt_handler()
{
    volatile struct uart_sunxi_regs *regs = (struct uart_sunxi_regs *)uart_device.uart_start_addr;
    if ((regs->IIR_FCR & IIR_IID_MASK) == UART_BUSY_VALUE)     // 处理有时仍可能会发生的 UART busy 中断，标志是 UART_IIR 寄存器的低 4 位为 0111
        regs->USR;  // 处理方法是读取 regs->USR 以清除中断
    while (regs->LSR & (1 << LSR_DR)) {
        int8_t c = uart_read();
        if (c > -1)
            uart_16550a_putc(c);
    }
}