some_serial/
lib.rs

1#![no_std]
2
3//! # Some Serial - 嵌入式串口驱动集合
4//!
5//! 本库提供统一的串口驱动接口，支持多种硬件平台：
6//! - ARM PL011 UART
7//! - NS16550/16450 UART（IO Port 和 MMIO 版本）
8//!
9//! ## 特性
10//!
11//! - 🏗️ 统一抽象接口 - 基于 `rdif-serial` 的统一串口抽象
12//! - 🛡️ 无标准库设计 (`no_std`) - 适用于裸机和嵌入式系统
13//! - 📦 模块化架构 - 每个驱动独立模块，按需选择
14//! - 🔒 类型安全 - 使用 Rust 类型系统确保内存安全
15//! - ⚡ 高性能 - 零拷贝数据传输，直接硬件访问
16//!
17//! ## 支持的驱动
18//!
19//! ### ARM PL011 UART
20//! - 广泛用于 ARM Cortex-A、Cortex-M、Cortex-R 系列
21//! - 支持 FIFO、中断、回环等完整功能
22//!
23//! ### NS16550/16450 UART
24//! - 经典 PC 串口控制器，广泛兼容
25//! - 支持 IO Port（x86_64）和 MMIO（通用）两种访问方式
26//! - 支持 16 字节 FIFO 缓冲
27//!
28//! ## 快速开始
29//!
30//! ```rust
31//! use some_serial::{Serial, Config};
32//! use some_serial::pl011::Pl011; // ARM PL011
33//! use some_serial::ns16550::Ns16550Mmio; // NS16550 MMIO
34//!
35//! // 选择合适的驱动
36//! #[cfg(target_arch = "aarch64")]
37//! let mut uart = Pl011::new(
38//!     NonNull::new(0x9000000 as *mut u8).unwrap(),
39//!     24_000_000
40//! );
41//!
42//! #[cfg(not(target_arch = "aarch64"))]
43//! let mut uart = Ns16550Mmio::new(
44//!     NonNull::new(0x9000000 as *mut u8).unwrap(),
45//!     1_843_200
46//! );
47//!
48//! // 配置串口
49//! let config = Config::new()
50//!     .baudrate(115200)
51//!     .data_bits(some_serial::DataBits::Eight)
52//!     .stop_bits(some_serial::StopBits::One)
53//!     .parity(some_serial::Parity::None);
54//!
55//! uart.set_config(&config).unwrap();
56//! uart.open().unwrap();
57//! ```
58
59// 导入核心模块
60pub mod ns16550;
61pub mod pl011;
62
63use enum_dispatch::enum_dispatch;
64// 重新导出 rdif-serial 的所有类型
65pub use rdif_serial::*;
66
67#[enum_dispatch]
68pub enum Sender {
69    #[cfg(target_arch = "x86_64")]
70    Ns16550Sender(ns16550::Ns16550Sender<ns16550::Port>),
71    Ns16550MmioSender(ns16550::Ns16550Sender<ns16550::Mmio>),
72    Pl011Sender(pl011::Pl011Sender),
73}
74
75#[enum_dispatch(Sender)]
76trait RawSender {
77    fn write_byte(&mut self, byte: u8) -> bool;
78    fn write_bytes(&mut self, buffer: &[u8]) -> usize {
79        let mut written = 0;
80        for &byte in buffer.iter() {
81            if !self.write_byte(byte) {
82                break;
83            }
84            written += 1;
85        }
86        written
87    }
88}
89
90impl TSender for Sender {
91    fn write_byte(&mut self, byte: u8) -> bool {
92        RawSender::write_byte(self, byte)
93    }
94
95    fn write_bytes(&mut self, buffer: &[u8]) -> usize {
96        RawSender::write_bytes(self, buffer)
97    }
98}
99
100#[enum_dispatch]
101pub enum Reciever {
102    #[cfg(target_arch = "x86_64")]
103    Ns16550Reciever(ns16550::Ns16550Reciever<ns16550::Port>),
104    Ns16550MmioReciever(ns16550::Ns16550Reciever<ns16550::Mmio>),
105    Pl011Reciever(pl011::Pl011Reciever),
106}
107
108impl TReciever for Reciever {
109    fn read_byte(&mut self) -> Option<Result<u8, TransferError>> {
110        RawReciever::read_byte(self)
111    }
112
113    fn read_bytes(&mut self, bytes: &mut [u8]) -> Result<usize, TransBytesError> {
114        RawReciever::read_bytes(self, bytes)
115    }
116}
117
118#[enum_dispatch(Reciever)]
119trait RawReciever {
120    fn read_byte(&mut self) -> Option<Result<u8, TransferError>>;
121
122    fn read_bytes(&mut self, bytes: &mut [u8]) -> Result<usize, TransBytesError> {
123        let mut read_count = 0;
124        for byte in bytes.iter_mut() {
125            match self.read_byte() {
126                Some(Ok(b)) => {
127                    *byte = b;
128                }
129                Some(Err(e)) => {
130                    return Err(TransBytesError {
131                        bytes_transferred: read_count,
132                        kind: e,
133                    });
134                }
135                None => break,
136            }
137
138            read_count += 1;
139        }
140        Ok(read_count)
141    }
142}
some_serial/lib.rs

some_serial/
lib.rs
