STM32F4-Base/Drivers/BSP/RS485/rs485.c

/*
 * 模块名称：RS-485 半双工通信驱动
 * 模块功能：RS-485 半双工通信驱动实现，封装任意 UART 外设实现 485 方向控制，
 *          提供阻塞发送、中断接收（IDLE 空闲帧检测）。DE 建立延时用 HAL_Delay(1)
 *          （HAL 时基 1ms，远大于收发器 50us 的 DE 建立时间），确保 DE 使能稳定。
 * 适用平台：STM32F4 系列
 * 作者：王建锋
 * 创建日期：2026-07-18
 * 修改记录：
 *     2026-07-18  王建锋  创建初始版本
 *     2026-07-20  王建锋  修复 DE 时序：添加 DE 建立延时替代 for 循环
 *     2026-07-20  王建锋  清理中文注释乱码，对齐代码规范
 *     2026-10-05  王建锋  模块描述订正为实际实现 HAL_Delay(1)
 *                         （原描述称 DWT CYCCNT 微秒延时，与代码不符）
 */

#include "rs485.h"

#include "sb_link.h"   /* 屏板链路 USART1：本文件是全局 UART 回调的唯一实现处，见下方回调段 */

/*
 * 函数功能：把 HAL 的状态码映射成项目统一的 bsp_err_t（边界映射，2026-10-22 试点）
 * 入口参数：status - HAL_* 返回的状态
 * 返回值：对应的 bsp_err_t；HAL_BUSY 归为 BSP_ERR_BUSY（可重试），HAL_OK 归 BSP_OK
 * 限定条件：仅本文件内部使用
 * 函数说明：HAL 的码**不在本模块之外出现**（见 bsp_err.h 边界纪律 1/2）；所以映射写在这里、
 *   写成 static，而不是往公共头里塞一个 include HAL 的 inline。
 */
static bsp_err_t rs485_err_from_hal(HAL_StatusTypeDef status) {
    switch (status) {
    case HAL_OK:
        return BSP_OK;
    case HAL_TIMEOUT:
        return BSP_ERR_TIMEOUT;
    case HAL_BUSY:
        return BSP_ERR_BUSY;
    default:
        return BSP_ERR_IO;
    }
}

/* ======================== 全局实例 ======================== */

/* RS-485 全局实例（接收缓冲内聚于句柄的 rx_buf 字段） */
rs485_handle_t g_rs485;

/* ======================== 方向控制宏 ======================== */

#define RS485_DIR_TX(h)  HAL_GPIO_WritePin((h)->dir_port, (h)->dir_pin, GPIO_PIN_SET)
#define RS485_DIR_RX(h)  HAL_GPIO_WritePin((h)->dir_port, (h)->dir_pin, GPIO_PIN_RESET)

/* ======================== 公共函数实现 ======================== */

/*
 * 函数功能：初始化 RS-485 句柄
 * 入口参数：p_handle - RS-485 句柄指针                                                 rs485_handle_t*（非空）
 *           p_huart  - UART 外设句柄指针（已由 CubeMX 初始化）                          UART_HandleTypeDef*（非空）
 *           p_dir_port - 方向控制 GPIO 端口（如 GPIOD）                                 GPIO_TypeDef*（非空）
 *           dir_pin  - 方向控制 GPIO 引脚号（如 GPIO_PIN_0）                            uint16_t
 * 返回值：无
 * 限定条件：UART 和 GPIO 须先由 CubeMX 完成初始化
 * 函数说明：初始化后默认处于接收状态（DE 引脚拉低），
 *          并自动启动 IDLE 中断接收，无需再手动调用 rs485_receive_start。
 */
void rs485_init(rs485_handle_t *p_handle,
                UART_HandleTypeDef *p_huart,
                GPIO_TypeDef *p_dir_port,
                uint16_t dir_pin) {
    p_handle->huart    = p_huart;
    p_handle->dir_port = p_dir_port;
    p_handle->dir_pin  = dir_pin;
    p_handle->rx_size  = 0;

    RS485_DIR_RX(p_handle);

    /* 自动开启 IDLE 中断接收（后续在回调中重新开启） */
    (void)rs485_receive_start(p_handle);
}

/*
 * 函数功能：阻塞方式发送数据
 * 入口参数：p_handle - RS-485 句柄指针                                                 rs485_handle_t*（非空）
 *           p_data   - 待发送数据缓冲区                                                uint8_t*（非空）
 *           len      - 待发送字节数                                                    uint16_t  1 - N
 *           timeout  - 发送超时（ms），传 0 使用 RS485_TIMEOUT_DEFAULT                uint32_t  0 / 1 - N
 * 返回值：BSP_OK - 发送成功                                                            bsp_err_t
 *         BSP_ERR_PARAM - 参数非法（空指针、长度 0 或超 RS485_TX_MAX_LEN）
 *         BSP_ERR_TIMEOUT - 发送超时（可重试：BSP_ERR_CAN_RETRY 为真）
 *         BSP_ERR_IO - HAL 报总线/状态错误
 * 限定条件：须在主循环或 FreeRTOS 任务中调用，不可在 UART 中断中调用
 * 函数说明：发送前拉高 DE，等待 HAL 时基延时确保 RS485 收发器驱动使能稳定后再启动
 *          UART 发送（HAL 时基最小粒度 1ms，此处延时 1ms，远大于 50us 的 DE 建立时间）。
 *          HAL_UART_Transmit 内部等待 TC（发送完成）标志，确保最后一字节完全移出后
 *          再拉低 DE 切回接收状态。
 */
bsp_err_t rs485_transmit(rs485_handle_t *p_handle,
                          const uint8_t *p_data,
                          uint16_t len,
                          uint32_t timeout) {
    HAL_StatusTypeDef status = HAL_OK;

    if (timeout == 0U) {
        timeout = RS485_TIMEOUT_DEFAULT;
    }

    /* 防御性边界（2026-09-24，UART 缓冲遍历类 HardFault 加固）：
     * 长度必须非零且不超过收发缓冲上限——脏长度交给 HAL 会变成"按长度遍历整片内存" */
    if ((p_handle == NULL) || (p_data == NULL) || (len == 0U) || (len > RS485_TX_MAX_LEN)) {
        return BSP_ERR_PARAM;
    }

    RS485_DIR_TX(p_handle);

    /* DE 建立延时：HAL 时基为 1ms 粒度，1ms 已充分覆盖收发器驱动使能稳定时间 */
    HAL_Delay(1);

    status = HAL_UART_Transmit(p_handle->huart,
                                (uint8_t *)p_data,
                                len,
                                timeout);

    RS485_DIR_RX(p_handle);


    return rs485_err_from_hal(status);
}

/*
 * 函数功能：启动中断方式接收（IDLE 空闲帧检测）
 * 入口参数：p_handle - RS-485 句柄指针                                                 rs485_handle_t*（非空）
 * 返回值：HAL_OK - 启动成功                                                           HAL_StatusTypeDef
 *         HAL_ERROR - 启动失败
 * 限定条件：UART 须已开启全局中断（NVIC 使能）
 * 函数说明：使用 HAL_UARTEx_ReceiveToIdle_IT 实现变长帧接收，
 *          接收缓冲固定使用句柄内部的 rx_buf（RS485_RX_BUF_SIZE）。
 *          当 UART 总线空闲超过 1 个字符时间后硬件触发 IDLE 中断，
 *          HAL 自动调用 HAL_UARTEx_RxEventCallback 并返回已接收字节数。
 *          用户须在回调中重新调用本函数重新开启接收。
 */
bsp_err_t rs485_receive_start(rs485_handle_t *p_handle) {
    HAL_StatusTypeDef status;

    if (p_handle == NULL) {
        return BSP_ERR_PARAM;
    }
    p_handle->rx_size = 0;
    status = HAL_UARTEx_ReceiveToIdle_IT(p_handle->huart, p_handle->rx_buf, RS485_RX_BUF_SIZE);

    return rs485_err_from_hal(status);
}

/*
 * 函数功能：缓存最近一次接收的字节数
 * 入口参数：p_handle - RS-485 句柄指针                                                 rs485_handle_t*（非空）
 *           size     - 本次接收到的字节数                                              uint16_t
 * 返回值：无
 * 限定条件：须在 HAL_UARTEx_RxEventCallback 中调用
 * 函数说明：将 HAL 回调中接收到的数据大小回写到句柄的 rx_size 字段
 */
void rs485_rx_set_size(rs485_handle_t *p_handle, uint16_t size) {
    p_handle->rx_size = size;
}

/*
 * 函数功能：获取最近一次接收的字节数
 * 入口参数：p_handle - RS-485 句柄指针                                                 const rs485_handle_t*（非空）
 * 返回值：最近一次接收的字节数                                                        uint16_t
 * 限定条件：须在 HAL_UARTEx_RxEventCallback 触发后调用
 * 函数说明：获取 rx_size 字段中缓存的接收字节数
 */
uint16_t rs485_rx_get_size(const rs485_handle_t *p_handle) {
    return p_handle->rx_size;
}

/* ==================== HAL 回调（本工程唯一实现处） ====================
 *
 * ⚠ 这两个回调是 HAL 的**全局单例**：一个工程只能有一份定义
 *   （Inc/stm32f4xx_hal_conf.h 的 USE_HAL_UART_REGISTER_CALLBACKS = 0，
 *   没法按句柄注册各自的回调）。所以新增通道时**在这里加一行转发**，
 *   不要在别处再定义一份 —— 重复定义是链接期的 multiple definition，编不过。
 *
 * 按句柄过滤放在各通道自己的模块里（如 sb_link_on_rx_event 内部判 p_huart），
 * 本文件不必知道别的通道用的是哪个 huart，也就不会因为它们换口而改动。
 */

/*
 * 应用层接收钩子默认实现（弱符号，可被应用重定义）。
 * 在中断上下文调用，仅做占位，业务解析由应用提供。
 */
__weak void rs485_on_rx(uint8_t *buf, uint16_t size) {
    (void)buf;
    (void)size;
}

/*
 * HAL UART 扩展接收回调（IDLE 空闲帧中断触发）。
 * 当 RS-485 总线空闲超过 1 个字符时间后触发，由 HAL 自动调用。
 * 注意：回调按实例分发，仅处理本驱动绑定的 UART，不写死 UART5。
 */
void HAL_UARTEx_RxEventCallback(UART_HandleTypeDef *huart, uint16_t Size) {
    if (huart == g_rs485.huart) {
        rs485_rx_set_size(&g_rs485, Size);

        /* 通知应用处理本次接收（中断上下文，应尽快返回） */
        rs485_on_rx(g_rs485.rx_buf, Size);

        /* 重新开启接收 */
        rs485_receive_start(&g_rs485);
    }

    /* 屏板链路（USART1）：非本链路的句柄在 sb_link 内部被忽略 */
    sb_link_on_rx_event(huart, Size);
}

/*
 * HAL UART 错误回调（ORE/NE/FE/PE 等）。
 * 读 SR + DR 清除错误标志后重新开启接收，避免中断锁死。
 */
void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart) {
    if (huart == g_rs485.huart) {
        /* STM32F4 通过读 SR + DR 清除 ORE/NE/FE/PE 错误标志 */
        (void)huart->Instance->SR;
        (void)huart->Instance->DR;
        /* 重新开启接收 */
        rs485_receive_start(&g_rs485);
    }

    /* 屏板链路（USART1）：清 ORE 并重挂接收（不清 ORE 会永久静默），见 sb_link.c */
    sb_link_on_error(huart);
}