some_serial/lib.rs
1#![no_std]
2
3//! # Some Serial - 嵌入式串口驱动集合
4//!
5//! 本库提供统一的串口驱动接口，支持多种硬件平台：
6//! - ARM PL011 UART
7//! - NS16550/16450 UART（IO Port、MMIO 和 DesignWare APB 版本）
8//!
9//! ## 特性
10//!
11//! - 🏗️ 统一抽象接口 - raw 层只提供 UART 寄存器语义，运行期队列由 rdif/OS 层提供
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（通用）和 DesignWare APB 访问方式
26//! - 支持 16 字节 FIFO 缓冲
27//!
28//! ## 快速开始
29//!
30//! ```rust,no_run
31//! use core::ptr::NonNull;
32//!
33//! use some_serial::{Config, RawUart as _, ns16550::Ns16550, pl011::Pl011};
34//!
35//! // 选择合适的驱动
36//! #[cfg(target_arch = "aarch64")]
37//! let mut uart = Pl011::new(NonNull::new(0x9000000 as *mut u8).unwrap(), 24_000_000);
38//!
39//! #[cfg(not(target_arch = "aarch64"))]
40//! let mut uart = Ns16550::new_mmio(NonNull::new(0x9000000 as *mut u8).unwrap(), 1_843_200, 1);
41//!
42//! // 配置串口
43//! let config = Config::new()
44//! .baudrate(115200)
45//! .data_bits(some_serial::DataBits::Eight)
46//! .stop_bits(some_serial::StopBits::One)
47//! .parity(some_serial::Parity::None);
48//!
49//! uart.startup(&config).unwrap();
50//!
51//! while !uart.poll_status().tx_ready() {
52//! core::hint::spin_loop();
53//! }
54//! uart.write_byte(b'h');
55//! ```
56
57#[cfg(test)]
58extern crate std;
59
60pub mod ns16550;
61pub mod pl011;
62
63// 重新导出 rdif-serial 的所有类型
64pub use rdif_serial::*;