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::pl011::Pl011; // ARM PL011
32//! use some_serial::{Config, Serial, ns16550::Ns16550Mmio}; // NS16550 MMIO
33//!
34//! // 选择合适的驱动
35//! #[cfg(target_arch = "aarch64")]
36//! let mut uart = Pl011::new(NonNull::new(0x9000000 as *mut u8).unwrap(), 24_000_000);
37//!
38//! #[cfg(not(target_arch = "aarch64"))]
39//! let mut uart = Ns16550Mmio::new(NonNull::new(0x9000000 as *mut u8).unwrap(), 1_843_200);
40//!
41//! // 配置串口
42//! let config = Config::new()
43//!     .baudrate(115200)
44//!     .data_bits(some_serial::DataBits::Eight)
45//!     .stop_bits(some_serial::StopBits::One)
46//!     .parity(some_serial::Parity::None);
47//!
48//! uart.set_config(&config).unwrap();
49//! uart.open().unwrap();
50//! ```
51
52// 导入核心模块
53pub mod ns16550;
54pub mod pl011;
55
56use enum_dispatch::enum_dispatch;
57// 重新导出 rdif-serial 的所有类型
58pub use rdif_serial::*;
59
60#[enum_dispatch]
61pub enum Sender {
62    #[cfg(target_arch = "x86_64")]
63    Ns16550Sender(ns16550::Ns16550Sender<ns16550::Port>),
64    Ns16550MmioSender(ns16550::Ns16550Sender<ns16550::Mmio>),
65    Pl011Sender(pl011::Pl011Sender),
66}
67
68#[enum_dispatch(Sender)]
69trait RawSender {
70    fn write_byte(&mut self, byte: u8) -> bool;
71    fn write_bytes(&mut self, buffer: &[u8]) -> usize {
72        let mut written = 0;
73        for &byte in buffer.iter() {
74            if !self.write_byte(byte) {
75                break;
76            }
77            written += 1;
78        }
79        written
80    }
81}
82
83impl TSender for Sender {
84    fn write_byte(&mut self, byte: u8) -> bool {
85        RawSender::write_byte(self, byte)
86    }
87
88    fn write_bytes(&mut self, buffer: &[u8]) -> usize {
89        RawSender::write_bytes(self, buffer)
90    }
91}
92
93#[enum_dispatch]
94pub enum Reciever {
95    #[cfg(target_arch = "x86_64")]
96    Ns16550Reciever(ns16550::Ns16550Reciever<ns16550::Port>),
97    Ns16550MmioReciever(ns16550::Ns16550Reciever<ns16550::Mmio>),
98    Pl011Reciever(pl011::Pl011Reciever),
99}
100
101impl TReciever for Reciever {
102    fn read_byte(&mut self) -> Option<Result<u8, TransferError>> {
103        RawReciever::read_byte(self)
104    }
105
106    fn read_bytes(&mut self, bytes: &mut [u8]) -> Result<usize, TransBytesError> {
107        RawReciever::read_bytes(self, bytes)
108    }
109}
110
111#[enum_dispatch(Reciever)]
112trait RawReciever {
113    fn read_byte(&mut self) -> Option<Result<u8, TransferError>>;
114
115    fn read_bytes(&mut self, bytes: &mut [u8]) -> Result<usize, TransBytesError> {
116        let mut read_count = 0;
117        for byte in bytes.iter_mut() {
118            match self.read_byte() {
119                Some(Ok(b)) => {
120                    *byte = b;
121                }
122                Some(Err(e)) => {
123                    return Err(TransBytesError {
124                        bytes_transferred: read_count,
125                        kind: e,
126                    });
127                }
128                None => break,
129            }
130
131            read_count += 1;
132        }
133        Ok(read_count)
134    }
135}
some_serial/lib.rs

some_serial/
lib.rs
