some-serial 0.6.1

#![no_std]

//! # Some Serial - 嵌入式串口驱动集合
//!
//! 本库提供统一的串口驱动接口，支持多种硬件平台：
//! - ARM PL011 UART
//! - NS16550/16450 UART（IO Port、MMIO 和 DesignWare APB 版本）
//!
//! ## 特性
//!
//! - 🏗️ 统一抽象接口 - 基于 `rdif-serial` 的统一串口抽象
//! - 🛡️ 无标准库设计 (`no_std`) - 适用于裸机和嵌入式系统
//! - 📦 模块化架构 - 每个驱动独立模块，按需选择
//! - 🔒 类型安全 - 使用 Rust 类型系统确保内存安全
//! - ⚡ 高性能 - 零拷贝数据传输，直接硬件访问
//!
//! ## 支持的驱动
//!
//! ### ARM PL011 UART
//! - 广泛用于 ARM Cortex-A、Cortex-M、Cortex-R 系列
//! - 支持 FIFO、中断、回环等完整功能
//!
//! ### NS16550/16450 UART
//! - 经典 PC 串口控制器，广泛兼容
//! - 支持 IO Port（x86_64）、MMIO（通用）和 DesignWare APB 访问方式
//! - 支持 16 字节 FIFO 缓冲
//!
//! ## 快速开始
//!
//! ```rust
//! use some_serial::pl011::Pl011; // ARM PL011
//! use some_serial::{Config, Serial, ns16550::Ns16550Mmio}; // NS16550 MMIO
//!
//! // 选择合适的驱动
//! #[cfg(target_arch = "aarch64")]
//! let mut uart = Pl011::new(NonNull::new(0x9000000 as *mut u8).unwrap(), 24_000_000);
//!
//! #[cfg(not(target_arch = "aarch64"))]
//! let mut uart = Ns16550Mmio::new(NonNull::new(0x9000000 as *mut u8).unwrap(), 1_843_200);
//!
//! // 配置串口
//! let config = Config::new()
//!     .baudrate(115200)
//!     .data_bits(some_serial::DataBits::Eight)
//!     .stop_bits(some_serial::StopBits::One)
//!     .parity(some_serial::Parity::None);
//!
//! uart.set_config(&config).unwrap();
//! uart.open().unwrap();
//! ```

pub mod ns16550;
pub mod pl011;

use enum_dispatch::enum_dispatch;
// 重新导出 rdif-serial 的所有类型
pub use rdif_serial::*;

#[enum_dispatch]
pub enum Sender {
    #[cfg(target_arch = "x86_64")]
    Ns16550Sender(ns16550::Ns16550Sender<ns16550::Port>),
    Ns16550MmioSender(ns16550::Ns16550Sender<ns16550::Mmio>),
    Ns16550DwApbSender(ns16550::Ns16550Sender<ns16550::DwApb>),
    Ns16550RockchipFiqSender(ns16550::rockchip_fiq::RockchipFiqSender),
    Pl011Sender(pl011::Pl011Sender),
}

#[enum_dispatch(Sender)]
trait RawSender {
    fn write_byte(&mut self, byte: u8) -> bool;
    fn write_bytes(&mut self, buffer: &[u8]) -> usize {
        let mut written = 0;
        for &byte in buffer.iter() {
            if !self.write_byte(byte) {
                break;
            }
            written += 1;
        }
        written
    }
}

impl TSender for Sender {
    fn write_byte(&mut self, byte: u8) -> bool {
        RawSender::write_byte(self, byte)
    }

    fn write_bytes(&mut self, buffer: &[u8]) -> usize {
        RawSender::write_bytes(self, buffer)
    }
}

#[enum_dispatch]
pub enum Receiver {
    #[cfg(target_arch = "x86_64")]
    Ns16550Receiver(ns16550::Ns16550Receiver<ns16550::Port>),
    Ns16550MmioReceiver(ns16550::Ns16550Receiver<ns16550::Mmio>),
    Ns16550DwApbReceiver(ns16550::Ns16550Receiver<ns16550::DwApb>),
    Ns16550RockchipFiqReceiver(ns16550::rockchip_fiq::RockchipFiqReceiver),
    Pl011Receiver(pl011::Pl011Receiver),
}

impl TReceiver for Receiver {
    fn read_byte(&mut self) -> Option<Result<u8, TransferError>> {
        RawReceiver::read_byte(self)
    }

    fn read_bytes(&mut self, bytes: &mut [u8]) -> Result<usize, TransBytesError> {
        RawReceiver::read_bytes(self, bytes)
    }
}

#[enum_dispatch(Receiver)]
trait RawReceiver {
    fn read_byte(&mut self) -> Option<Result<u8, TransferError>>;

    fn read_bytes(&mut self, bytes: &mut [u8]) -> Result<usize, TransBytesError> {
        let mut read_count = 0;
        for byte in bytes.iter_mut() {
            match self.read_byte() {
                Some(Ok(b)) => {
                    *byte = b;
                }
                Some(Err(e)) => {
                    return Err(TransBytesError {
                        bytes_transferred: read_count,
                        kind: e,
                    });
                }
                None => break,
            }

            read_count += 1;
        }
        Ok(read_count)
    }
}