/**
 * @file esc_lan9252.h
 * @brief LAN9252 EtherCAT 从站控制器(ESC)驱动接口。
 * @note 通过 EscExmcBus 16-bit 并行总线,以 HBI Indexed Address Mode 访问 LAN9252。
 *       访问模型(1.5.39 按 DS 12.11 修正,此前误以为整个 16 位索引空间统一可寻址):
 *       - HBI 直接地址空间:仅 LAN9252 系统 CSR(BYTE_TEST 0x064 等)+ 访问端口
 *         (PRAM FIFO 0x000-0x03C、ECAT_CSR_DATA/CMD 0x300/0x304、PRAM_ADDR_LEN/CMD
 *         0x308-0x314)——经 HBI_IDX_0/HBI_DATA_0 直接读写;
 *       - EtherCAT 核心 CSR(0x0000-0x0FFF:AL Status、SyncManager、EEPROM 接口等)
 *         不在直接空间,必须经 ECAT_CSR_CMD/CSR_DATA 间接访问(csrRead/csrWrite);
 *       - 过程 RAM(0x1000-0x1FFF:邮箱/PDO)必须经 PRAM FIFO(pramRead/pramWrite)。
 *
 *       接口调用约束(避免 EXMC 总线争用):
 *       - 运行期 ESC 寄存器/PDI 访问统一走 SSC 移植层 hw_gd32exmc.cpp 的 HW 系列函数
 *         (主循环路径带 HBI 互斥守卫,ISR 路径由 ethercat_sync.cpp 包装器保证互斥)。
 *       - initOnly 系列:INIT-ONLY,仅允许在 EthercatSync::init() 使能 EXTI NVIC 之前调用
 *         (如 EthercatSlave::init 的芯片 ID/AL 状态探针)。
 */
#ifndef COMM_ESC_LAN9252_H
#define COMM_ESC_LAN9252_H

#include <cstdint>
#include <cstddef>

/**
 * @brief LAN9252 ESC 驱动。
 * @note 封装 ESC 寄存器读写与 PDI(Process Data Interface)内存块访问。
 */
class EscLan9252 {
public:
    /** @brief 初始化 EXMC 总线与 ESC 基本寄存器。
     *  @note 1.5.25 起内部先执行一次 hardwareReset() 受控复位(s_resetDone 门控,
     *        重复调用不会二次复位 SSC 已配置好的芯片),再探活 EXMC/HBI。
     *  @return bool true 表示 EXMC 总线探活通过(可继续读取芯片 ID)。 */
    static bool init();

    /** @brief INIT-ONLY:ECAT_NRST(PB10)受控复位序列(拉低 CONFIG_ESC_NRST_ASSERT_MS 后释放)。
     *  @note 满足 LAN9252 手册 18.6.3 tpurstd≥25ms/trstia≥200µs;RST# 释放瞬间
     *        重锁 CHIP_MODE strap。运行期调用会打断 EtherCAT 通信,仅供 init/诊断用。 */
    static void hardwareReset();

    /** @brief 诊断:手动控制/回读 ECAT_NRST(PB10)实际电平(SPI 0xA2 action 20+ 转发到此)。
     *  @param action 0=恢复自动态(推挽输出高) 1=持续拉低 2=持续拉高 3=浮空输入(交给 R44) 4=只读回
     *  @return 实际引脚电平 0/1(GD32 输入通路常连引脚,输出态亦读真实电压);0xEE=无效 action。
     *  判读:action 1→2 切换后引脚电平不变 => 网络被外部短路或驱动器损伤;
     *  驱动高读回低 => ECAT_NRST 被按死在复位,LAS9252 永在复位态。 */
    static uint8_t nrstDrive(uint8_t action);

    /**
     * @brief 读取 ESC 芯片 ID(INIT-ONLY,供 init 打印诊断用)。
     * @return uint32_t 32-bit 芯片 ID(期望值 0x87654321)。
     */
    static uint32_t readChipId();

    /** @brief INIT-ONLY:仅允许在 EthercatSync::init() 使能 EXTI NVIC 之前调用;运行期禁止调用,需 ESC 寄存器访问须通过 SSC 移植层(HW_*)。
     *  @note  1.5.39 起经 CSR_CMD/CSR_DATA 间接端口读 ESC 核心 CSR(此前直读 HBI 索引,
     *         而 EtherCAT 核心寄存器根本不在 HBI 直接地址空间,恒读 0)。 */
    static uint16_t initOnlyReadReg(uint16_t addr);

    /** @brief INIT-ONLY:仅允许在 EthercatSync::init() 使能 EXTI NVIC 之前调用;运行期禁止调用。 */
    static void initOnlyWriteReg(uint16_t addr, uint16_t v);

    /** @brief ESC 核心 CSR 间接读(ECAT_CSR_CMD/DATA 端口,0x0000-0x0FFF 地址空间)。
     *  @note  1.5.39:LAN9252 的 HBI/SPI 直接地址空间只有 LAN9252 系统 CSR 与访问端口
     *         (DS 12.11/表 12-13),EtherCAT 核心寄存器(0x0000-0x0FFF)必须经
     *         CSR_CMD(0x304)/CSR_DATA(0x300) 间接访问;过程 RAM(0x1000-0x1FFF)
     *         必须经 PRAM FIFO。size=1/2/4(size2 需偶地址,size4 需 4 字节对齐)。
     *         调用方负责 HBI 互斥(主循环 EscExmcBus::maskEnter / 已在 ISR 上下文)。 */
    static uint32_t csrRead(uint16_t addr, uint8_t size);

    /** @brief ESC 核心 CSR 间接写(ECAT_CSR_CMD/DATA 端口)。约束同 csrRead。 */
    static void csrWrite(uint16_t addr, uint32_t data, uint8_t size);

    /** @brief 过程 RAM(0x1000-0x1FFF)经 PRAM 读 FIFO 读取 len 字节到 buf。 */
    static void pramRead(uint16_t addr, uint8_t *buf, uint16_t len);

    /** @brief 过程 RAM(0x1000-0x1FFF)经 PRAM 写 FIFO 写入 len 字节。 */
    static void pramWrite(uint16_t addr, const uint8_t *buf, uint16_t len);

    /** @brief EXMC 总线 + HBI_IDX_0 探针 + BYTE_TEST 全部通过(init 成功)后为 true。
     *  @note  与 init() 返回值一致,可作运行期查询。 */
    static bool isBusReady() { return s_busReady; }

    /** @brief EEPROM(SII) 加载完成、EtherCAT 核心使能(1.5.39)。
     *  @note  false 时核心寄存器对 PDI 读全 0、写静默丢弃,SSC MainInit 会全部
     *         落空(AL Event Mask/邮箱 SM 配置写不进),调用方必须跳过 SSC 初始化。 */
    static bool isCoreReady() { return s_coreReady; }

private:
    /** @brief 使能 LAN9252 的 IRQ 引脚输出(IRQ_CFG 0x054 / INT_EN 0x05C)。
     *  @note  1.5.43 新增,由 init() 在 PDI/核心就绪后调用。两寄存器复位默认全 0,
     *         不配则 EtherCAT 事件永不到达 PB1、SSC 的 PDI_Isr 从不执行,
     *         bEcatFirstOutputsReceived 恒 FALSE 使 SAFEOP->OP 被无限挂起。 */
    static void enableEcatIrqOutput();

    static bool s_busReady;  /**< init 完整成功(EXMC+IDX 探针+BYTE_TEST)后置位。 */
    static bool s_coreReady; /**< EEPROM 加载完成、EtherCAT 核心使能后置位(1.5.39)。 */
    static bool s_resetDone; /**< hardwareReset 已执行门控(防二次复位清掉 SSC 配置)。 */
};

#endif /* COMM_ESC_LAN9252_H */