sg200x-bsp 0.6.0

//! SG2002 Pinmux 驱动模块
//!
//! 本模块提供 SG2002 芯片引脚复用(Pinmux)功能的驱动程序。
//!
//! # 功能概述
//!
//! SG2002 芯片的引脚复用系统包含两类寄存器:
//!
//! 1. **FMUX (Function Mux) 寄存器**: 用于选择引脚的功能模式
//!    - 基地址: [`crate::soc::FMUX_BASE`]
//!    - 每个引脚可以选择多种功能(如 GPIO、UART、SPI、I2C 等)
//!
//! 2. **IOBLK (IO Block) 寄存器**: 用于配置引脚的电气特性
//!    - 多个 IO 组(G1, G7, G10, G12, GRTC)
//!    - 配置上拉/下拉、驱动强度、施密特触发器等
//!
//! # 使用示例
//!
//! 本模块按外设/信号提供 **set_xxx_func** / **get_xxx_func** 等封装，没有统一的 `set_function`。
//! 具体可选功能值见各 **`FMUX_*::FSEL`** 枚举及 [`FmuxRegisters`]；未封装的引脚可通过
//! [`Pinmux::fmux`]、[`Pinmux::ioblk_g1`] 等方法拿到寄存器块后自行读写。
//!
//! ```rust,ignore
//! use sg200x_bsp::pinmux::{Pinmux, PullConfig, FMUX_SD0_CLK, FMUX_UART0_TX};
//! use sg200x_bsp::soc::{
//!     FMUX_BASE, IOBLK_BASE, IOBLK_GRTC_BASE,
//! };
//!
//! let pinmux = unsafe { Pinmux::new(FMUX_BASE, IOBLK_BASE, IOBLK_GRTC_BASE) };
//!
//! // SD0_CLK → XGPIOA[7]
//! pinmux.set_sd0_clk_func(FMUX_SD0_CLK::FSEL::XGPIOA_7);
//!
//! // UART0_TX：功能 + 上拉（对部分信号有组合封装）
//! pinmux.set_uart0_tx_func(FMUX_UART0_TX::FSEL::UART0_TX);
//! pinmux.set_uart0_tx_pull(PullConfig::PullUp);
//! ```
//!
//! # `set_<信号>_func` / `get_<信号>_func` 参数约定
//!
//! - **`func`**（`set_*_func`）：要写入 FMUX 的目标功能，类型为对应 `FMUX_*::FSEL::Value`，
//!   即寄存器 **FSEL** 字段的枚举取值（数字外设/GPIO 等）。
//! - **返回值**（`get_*_func`）：当前 **FSEL** 的原始 `u32` 值（通常 0..8，具体含义见各 `FMUX_*` 枚举）。
//! - **`pull`**（如 `set_uart0_tx_pull`）：[`PullConfig`]，仅作用于 IOBLK 电气属性，不改变 FMUX 功能选择。

mod fmux;
mod ioblk;

pub use fmux::*;
pub use ioblk::*;

use tock_registers::interfaces::{ReadWriteable, Readable, Writeable};

pub use crate::soc::{
    FMUX_BASE, IOBLK_BASE, IOBLK_G1_OFFSET, IOBLK_G10_OFFSET, IOBLK_G12_OFFSET, IOBLK_G7_OFFSET,
    IOBLK_GRTC_BASE,
};

/// 上拉/下拉配置
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PullConfig {
    /// 无上拉/下拉
    None,
    /// 上拉使能
    PullUp,
    /// 下拉使能
    PullDown,
}

/// 驱动强度等级
///
/// 驱动强度由 DS0, DS1 (部分引脚还有 DS2) 位控制
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DriveStrength {
    /// 等级 0 (最弱)
    Level0 = 0,
    /// 等级 1
    Level1 = 1,
    /// 等级 2 (默认)
    Level2 = 2,
    /// 等级 3
    Level3 = 3,
    /// 等级 4 (仅部分引脚支持)
    Level4 = 4,
    /// 等级 5 (仅部分引脚支持)
    Level5 = 5,
    /// 等级 6 (仅部分引脚支持)
    Level6 = 6,
    /// 等级 7 (最强, 仅部分引脚支持)
    Level7 = 7,
}

/// 施密特触发器等级
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum SchmittTriggerLevel {
    /// 等级 0 (禁用)
    Level0 = 0,
    /// 等级 1
    Level1 = 1,
    /// 等级 2
    Level2 = 2,
    /// 等级 3
    Level3 = 3,
}

/// Pinmux 驱动结构体
///
/// 提供对 SG2002 引脚复用系统的访问接口
pub struct Pinmux {
    /// FMUX 寄存器组
    pub fmux: &'static FmuxRegisters,
    /// IOBLK G1 组寄存器
    ioblk_g1: &'static IoblkG1Registers,
    /// IOBLK G7 组寄存器
    ioblk_g7: &'static IoblkG7Registers,
    /// IOBLK G10 组寄存器
    ioblk_g10: &'static IoblkG10Registers,
    /// IOBLK G12 组寄存器
    ioblk_g12: &'static IoblkG12Registers,
    /// IOBLK GRTC 组寄存器
    ioblk_grtc: &'static IoblkGrtcRegisters,
}

impl Pinmux {
    /// 创建新的 Pinmux 驱动实例
    ///
    /// # 参数
    ///
    /// - `fmux_base`: FMUX 寄存器 MMIO 基地址（见 [`FMUX_BASE`]）
    /// - `ioblk_base`: Active Domain IOBLK 基地址（见 [`IOBLK_BASE`]，G1/G7/G10/G12 按 [`IOBLK_G*_OFFSET`] 寻址）
    /// - `ioblk_grtc_base`: RTC 域 IOBLK GRTC 基地址（见 [`IOBLK_GRTC_BASE`]）
    ///
    /// # Safety
    ///
    /// 调用者必须确保:
    /// - 所有基地址有效且可访问
    /// - 不会创建多个实例导致数据竞争
    pub unsafe fn new(fmux_base: usize, ioblk_base: usize, ioblk_grtc_base: usize) -> Self {
        unsafe {
            Self {
                fmux: &*(fmux_base as *const FmuxRegisters),
                ioblk_g1: &*((ioblk_base + IOBLK_G1_OFFSET) as *const IoblkG1Registers),
                ioblk_g7: &*((ioblk_base + IOBLK_G7_OFFSET) as *const IoblkG7Registers),
                ioblk_g10: &*((ioblk_base + IOBLK_G10_OFFSET) as *const IoblkG10Registers),
                ioblk_g12: &*((ioblk_base + IOBLK_G12_OFFSET) as *const IoblkG12Registers),
                ioblk_grtc: &*(ioblk_grtc_base as *const IoblkGrtcRegisters),
            }
        }
    }

    /// 获取 FMUX 寄存器组的引用
    pub fn fmux(&self) -> &FmuxRegisters {
        self.fmux
    }

    /// 获取 IOBLK G1 组寄存器的引用
    pub fn ioblk_g1(&self) -> &IoblkG1Registers {
        self.ioblk_g1
    }

    /// 获取 IOBLK G7 组寄存器的引用
    pub fn ioblk_g7(&self) -> &IoblkG7Registers {
        self.ioblk_g7
    }

    /// 获取 IOBLK G10 组寄存器的引用
    pub fn ioblk_g10(&self) -> &IoblkG10Registers {
        self.ioblk_g10
    }

    /// 获取 IOBLK G12 组寄存器的引用
    pub fn ioblk_g12(&self) -> &IoblkG12Registers {
        self.ioblk_g12
    }

    /// 获取 IOBLK GRTC 组寄存器的引用
    pub fn ioblk_grtc(&self) -> &IoblkGrtcRegisters {
        self.ioblk_grtc
    }
}

// ============================================================================
// SD0 引脚配置便捷方法
// ============================================================================

impl Pinmux {
    /// 设置 SD0_CLK 引脚功能 (类型安全版本)
    ///
    /// 使用枚举值设置功能，例如:
    /// ```ignore
    /// pinmux.set_sd0_clk_func(FMUX_SD0_CLK::FSEL::XGPIOA_7);
    /// ```
    pub fn set_sd0_clk_func(&self, func: FMUX_SD0_CLK::FSEL::Value) {
        self.fmux.sd0_clk.write(FMUX_SD0_CLK::FSEL.val(func as u32));
    }

    /// 获取 SD0_CLK 引脚当前功能
    pub fn get_sd0_clk_func(&self) -> u32 {
        self.fmux.sd0_clk.read(FMUX_SD0_CLK::FSEL)
    }

    /// 设置 SD0_CMD 引脚功能 (类型安全版本)
    pub fn set_sd0_cmd_func(&self, func: FMUX_SD0_CMD::FSEL::Value) {
        self.fmux.sd0_cmd.write(FMUX_SD0_CMD::FSEL.val(func as u32));
    }

    /// 获取 SD0_CMD 引脚当前功能
    pub fn get_sd0_cmd_func(&self) -> u32 {
        self.fmux.sd0_cmd.read(FMUX_SD0_CMD::FSEL)
    }

    /// 设置 SD0_D0 引脚功能 (类型安全版本)
    pub fn set_sd0_d0_func(&self, func: FMUX_SD0_D0::FSEL::Value) {
        self.fmux.sd0_d0.write(FMUX_SD0_D0::FSEL.val(func as u32));
    }

    /// 获取 SD0_D0 引脚当前功能
    pub fn get_sd0_d0_func(&self) -> u32 {
        self.fmux.sd0_d0.read(FMUX_SD0_D0::FSEL)
    }

    /// 设置 SD0_D1 引脚功能 (类型安全版本)
    pub fn set_sd0_d1_func(&self, func: FMUX_SD0_D1::FSEL::Value) {
        self.fmux.sd0_d1.write(FMUX_SD0_D1::FSEL.val(func as u32));
    }

    /// 获取 SD0_D1 引脚当前功能
    pub fn get_sd0_d1_func(&self) -> u32 {
        self.fmux.sd0_d1.read(FMUX_SD0_D1::FSEL)
    }

    /// 设置 SD0_D2 引脚功能 (类型安全版本)
    pub fn set_sd0_d2_func(&self, func: FMUX_SD0_D2::FSEL::Value) {
        self.fmux.sd0_d2.write(FMUX_SD0_D2::FSEL.val(func as u32));
    }

    /// 获取 SD0_D2 引脚当前功能
    pub fn get_sd0_d2_func(&self) -> u32 {
        self.fmux.sd0_d2.read(FMUX_SD0_D2::FSEL)
    }

    /// 设置 SD0_D3 引脚功能 (类型安全版本)
    pub fn set_sd0_d3_func(&self, func: FMUX_SD0_D3::FSEL::Value) {
        self.fmux.sd0_d3.write(FMUX_SD0_D3::FSEL.val(func as u32));
    }

    /// 获取 SD0_D3 引脚当前功能
    pub fn get_sd0_d3_func(&self) -> u32 {
        self.fmux.sd0_d3.read(FMUX_SD0_D3::FSEL)
    }

    pub fn get_aux0_input(&self) -> u32 {
        self.fmux.aux0.read(FMUX_AUX0::FSEL)
    }
}

// ============================================================================
// UART0 引脚配置便捷方法
// ============================================================================

impl Pinmux {
    /// 设置 UART0_TX 引脚功能 (类型安全版本)
    pub fn set_uart0_tx_func(&self, func: FMUX_UART0_TX::FSEL::Value) {
        self.fmux.uart0_tx.write(FMUX_UART0_TX::FSEL.val(func as u32));
    }

    /// 获取 UART0_TX 引脚当前功能
    pub fn get_uart0_tx_func(&self) -> u32 {
        self.fmux.uart0_tx.read(FMUX_UART0_TX::FSEL)
    }

    /// 设置 UART0_RX 引脚功能 (类型安全版本)
    pub fn set_uart0_rx_func(&self, func: FMUX_UART0_RX::FSEL::Value) {
        self.fmux.uart0_rx.write(FMUX_UART0_RX::FSEL.val(func as u32));
    }

    /// 获取 UART0_RX 引脚当前功能
    pub fn get_uart0_rx_func(&self) -> u32 {
        self.fmux.uart0_rx.read(FMUX_UART0_RX::FSEL)
    }

    /// 配置 UART0_TX 引脚的上拉/下拉
    pub fn set_uart0_tx_pull(&self, pull: PullConfig) {
        match pull {
            PullConfig::None => {
                self.ioblk_g7.uart0_tx.modify(IOBLK_REG::PU::CLEAR + IOBLK_REG::PD::CLEAR);
            }
            PullConfig::PullUp => {
                self.ioblk_g7.uart0_tx.modify(IOBLK_REG::PU::SET + IOBLK_REG::PD::CLEAR);
            }
            PullConfig::PullDown => {
                self.ioblk_g7.uart0_tx.modify(IOBLK_REG::PU::CLEAR + IOBLK_REG::PD::SET);
            }
        }
    }

    /// 配置 UART0_RX 引脚的上拉/下拉
    pub fn set_uart0_rx_pull(&self, pull: PullConfig) {
        match pull {
            PullConfig::None => {
                self.ioblk_g7.uart0_rx.modify(IOBLK_REG::PU::CLEAR + IOBLK_REG::PD::CLEAR);
            }
            PullConfig::PullUp => {
                self.ioblk_g7.uart0_rx.modify(IOBLK_REG::PU::SET + IOBLK_REG::PD::CLEAR);
            }
            PullConfig::PullDown => {
                self.ioblk_g7.uart0_rx.modify(IOBLK_REG::PU::CLEAR + IOBLK_REG::PD::SET);
            }
        }
    }
}

// ============================================================================
// I2C0 引脚配置便捷方法
// ============================================================================

impl Pinmux {
    /// 设置 IIC0_SCL 引脚功能 (类型安全版本)
    pub fn set_iic0_scl_func(&self, func: FMUX_IIC0_SCL::FSEL::Value) {
        self.fmux.iic0_scl.write(FMUX_IIC0_SCL::FSEL.val(func as u32));
    }

    /// 获取 IIC0_SCL 引脚当前功能
    pub fn get_iic0_scl_func(&self) -> u32 {
        self.fmux.iic0_scl.read(FMUX_IIC0_SCL::FSEL)
    }

    /// 设置 IIC0_SDA 引脚功能 (类型安全版本)
    pub fn set_iic0_sda_func(&self, func: FMUX_IIC0_SDA::FSEL::Value) {
        self.fmux.iic0_sda.write(FMUX_IIC0_SDA::FSEL.val(func as u32));
    }

    /// 获取 IIC0_SDA 引脚当前功能
    pub fn get_iic0_sda_func(&self) -> u32 {
        self.fmux.iic0_sda.read(FMUX_IIC0_SDA::FSEL)
    }
}

// ============================================================================
// PWR GPIO 引脚配置便捷方法
// ============================================================================

impl Pinmux {
    /// 设置 PWR_GPIO0 引脚功能 (类型安全版本)
    pub fn set_pwr_gpio0_func(&self, func: FMUX_PWR_GPIO0::FSEL::Value) {
        self.fmux.pwr_gpio0.write(FMUX_PWR_GPIO0::FSEL.val(func as u32));
    }

    /// 获取 PWR_GPIO0 引脚当前功能
    pub fn get_pwr_gpio0_func(&self) -> u32 {
        self.fmux.pwr_gpio0.read(FMUX_PWR_GPIO0::FSEL)
    }

    /// 设置 PWR_GPIO1 引脚功能 (类型安全版本)
    pub fn set_pwr_gpio1_func(&self, func: FMUX_PWR_GPIO1::FSEL::Value) {
        self.fmux.pwr_gpio1.write(FMUX_PWR_GPIO1::FSEL.val(func as u32));
    }

    /// 获取 PWR_GPIO1 引脚当前功能
    pub fn get_pwr_gpio1_func(&self) -> u32 {
        self.fmux.pwr_gpio1.read(FMUX_PWR_GPIO1::FSEL)
    }

    /// 设置 PWR_GPIO2 引脚功能 (类型安全版本)
    pub fn set_pwr_gpio2_func(&self, func: FMUX_PWR_GPIO2::FSEL::Value) {
        self.fmux.pwr_gpio2.write(FMUX_PWR_GPIO2::FSEL.val(func as u32));
    }

    /// 获取 PWR_GPIO2 引脚当前功能
    pub fn get_pwr_gpio2_func(&self) -> u32 {
        self.fmux.pwr_gpio2.read(FMUX_PWR_GPIO2::FSEL)
    }
}

// ============================================================================
// IIC3 引脚配置便捷方法 (通过 SD1_CMD/SD1_CLK 复用)
// ============================================================================

impl Pinmux {
    /// 配置 SD1_CMD 为 IIC3_SCL 功能
    ///
    /// 将 SD1_CMD (Pin 55) 引脚复用为 I2C3 的时钟线 (SCL)
    /// 功能选择值 = 2
    ///
    /// # 示例
    /// ```ignore
    /// use sg200x_bsp::soc::{FMUX_BASE, IOBLK_BASE, IOBLK_GRTC_BASE};
    /// let pinmux = unsafe { Pinmux::new(FMUX_BASE, IOBLK_BASE, IOBLK_GRTC_BASE) };
    /// pinmux.set_iic3_scl_on_sd1_cmd();
    /// ```
    pub fn set_iic3_scl_on_sd1_cmd(&self) {
        self.fmux.sd1_cmd.write(FMUX_SD1_CMD::FSEL.val(FMUX_SD1_CMD::FSEL::IIC3_SCL.into()));
    }

    /// 配置 SD1_CLK 为 IIC3_SDA 功能
    ///
    /// 将 SD1_CLK (Pin 56) 引脚复用为 I2C3 的数据线 (SDA)
    /// 功能选择值 = 2
    ///
    /// # 示例
    /// ```ignore
    /// let pinmux = unsafe { Pinmux::new(FMUX_BASE, IOBLK_BASE, IOBLK_GRTC_BASE) };
    /// pinmux.set_iic3_sda_on_sd1_clk();
    /// ```
    pub fn set_iic3_sda_on_sd1_clk(&self) {
        self.fmux.sd1_clk.write(FMUX_SD1_CLK::FSEL.val(FMUX_SD1_CLK::FSEL::IIC3_SDA.into()));
    }

    /// 配置 IIC3 引脚 (SD1_CMD -> SCL, SD1_CLK -> SDA)
    ///
    /// 一次性配置 I2C3 的两个引脚:
    /// - SD1_CMD (Pin 55) -> IIC3_SCL
    /// - SD1_CLK (Pin 56) -> IIC3_SDA
    ///
    /// # 示例
    /// ```ignore
    /// let pinmux = unsafe { Pinmux::new(FMUX_BASE, IOBLK_BASE, IOBLK_GRTC_BASE) };
    /// pinmux.setup_iic3_pins();
    /// ```
    pub fn setup_iic3_pins(&self) {
        self.set_iic3_scl_on_sd1_cmd();
        self.set_iic3_sda_on_sd1_clk();
    }

    /// 设置 SD1_D3 引脚功能 (类型安全版本)
    pub fn set_sd1_d3_func(&self, func: FMUX_SD1_D3::FSEL::Value) {
        self.fmux.sd1_d3.write(FMUX_SD1_D3::FSEL.val(func as u32));
    }

    /// 获取 SD1_D3 引脚当前功能
    pub fn get_sd1_d3_func(&self) -> u32 {
        self.fmux.sd1_d3.read(FMUX_SD1_D3::FSEL)
    }

    /// 设置 SD1_D2 引脚功能 (类型安全版本)
    pub fn set_sd1_d2_func(&self, func: FMUX_SD1_D2::FSEL::Value) {
        self.fmux.sd1_d2.write(FMUX_SD1_D2::FSEL.val(func as u32));
    }

    /// 获取 SD1_D2 引脚当前功能
    pub fn get_sd1_d2_func(&self) -> u32 {
        self.fmux.sd1_d2.read(FMUX_SD1_D2::FSEL)
    }

    /// 设置 SD1_D1 引脚功能 (类型安全版本)
    pub fn set_sd1_d1_func(&self, func: FMUX_SD1_D1::FSEL::Value) {
        self.fmux.sd1_d1.write(FMUX_SD1_D1::FSEL.val(func as u32));
    }

    /// 获取 SD1_D1 引脚当前功能
    pub fn get_sd1_d1_func(&self) -> u32 {
        self.fmux.sd1_d1.read(FMUX_SD1_D1::FSEL)
    }

    /// 设置 SD1_D0 引脚功能 (类型安全版本)
    pub fn set_sd1_d0_func(&self, func: FMUX_SD1_D0::FSEL::Value) {
        self.fmux.sd1_d0.write(FMUX_SD1_D0::FSEL.val(func as u32));
    }

    /// 获取 SD1_D0 引脚当前功能
    pub fn get_sd1_d0_func(&self) -> u32 {
        self.fmux.sd1_d0.read(FMUX_SD1_D0::FSEL)
    }

    /// 设置 SD1_CMD 引脚功能 (类型安全版本)
    ///
    /// 注意: IIC3_SCL 在此引脚上 (功能选择 = 2)
    pub fn set_sd1_cmd_func(&self, func: FMUX_SD1_CMD::FSEL::Value) {
        self.fmux.sd1_cmd.write(FMUX_SD1_CMD::FSEL.val(func as u32));
    }

    /// 获取 SD1_CMD 引脚当前功能
    pub fn get_sd1_cmd_func(&self) -> u32 {
        self.fmux.sd1_cmd.read(FMUX_SD1_CMD::FSEL)
    }

    /// 设置 SD1_CLK 引脚功能 (类型安全版本)
    ///
    /// 注意: IIC3_SDA 在此引脚上 (功能选择 = 2)
    pub fn set_sd1_clk_func(&self, func: FMUX_SD1_CLK::FSEL::Value) {
        self.fmux.sd1_clk.write(FMUX_SD1_CLK::FSEL.val(func as u32));
    }

    /// 获取 SD1_CLK 引脚当前功能
    pub fn get_sd1_clk_func(&self) -> u32 {
        self.fmux.sd1_clk.read(FMUX_SD1_CLK::FSEL)
    }
}

impl Pinmux {
    pub fn set_iic3(&self) {
        self.fmux.sd1_cmd.write(FMUX_SD1_CMD::FSEL::IIC3_SCL);
        self.fmux.sd1_clk.write(FMUX_SD1_CLK::FSEL::IIC3_SDA);
    }

    pub fn set_pwm_7(&self) {
        self.fmux.jtag_cpu_tms.write(FMUX_JTAG_CPU_TMS::FSEL::PWM_7);
    }

    pub fn set_uart1(&self) {
        self.fmux.jtag_cpu_tms.write(FMUX_JTAG_CPU_TMS::FSEL::UART1_TX);
        self.fmux.jtag_cpu_tck.write(FMUX_JTAG_CPU_TCK::FSEL::UART1_RX);
    }

    pub fn set_camera(&self) {
        self.fmux.pwr_gpio1.write(FMUX_PWR_GPIO1::FSEL::PWR_GPIO_1);
        self.fmux.pad_mipirx0n.write(FMUX_PAD_MIPIRX0N::FSEL::CAM_MCLK1);
        self.fmux.pwr_wakeup0.write(FMUX_PWR_WAKEUP0::FSEL::IIC4_SCL);
        self.fmux.pwr_button1.write(FMUX_PWR_BUTTON1::FSEL::IIC4_SDA);
    }
}