add bsp_spi

2026-07-24 03:27:45 +08:00 · 2025-11-03 22:08:14 +08:00
parent 38ecee9603
commit 7a113a32dd
6 changed files with 385 additions and 150 deletions
--- a/User_Code/bsp/spi/bsp_spi.c
+++ b/User_Code/bsp/spi/bsp_spi.c
@@ -1,5 +1,131 @@
-//
-// Created by tuxmonkey on 2025/10/28.
-//
+#include "bsp_spi.h"
+#include "memory.h"
+#include "stdlib.h"

-#include "bsp_spi.h"
+/* 所有的spi instance保存于此,用于callback时判断中断来源*/
+static SPIInstance *spi_instance[SPI_DEVICE_CNT] = {NULL};
+static uint8_t idx = 0; // 配合中断以及初始化
+
+SPIInstance *SPIRegister(SPI_Init_Config_s *conf) {
+    if (idx >= MX_SPI_BUS_SLAVE_CNT) // 超过最大实例数
+        while (1);
+    SPIInstance *instance = (SPIInstance *) malloc(sizeof(SPIInstance));
+    memset(instance, 0, sizeof(SPIInstance));
+
+    instance->spi_handle = conf->spi_handle;
+    instance->GPIOx = conf->GPIOx;
+    instance->cs_pin = conf->cs_pin;
+    instance->spi_work_mode = conf->spi_work_mode;
+    instance->callback = conf->callback;
+    instance->id = conf->id;
+
+    spi_instance[idx++] = instance;
+    return instance;
+}
+
+void SPITransmit(SPIInstance *spi_ins, uint8_t *ptr_data, uint8_t len) {
+    // 拉低片选,开始传输(选中从机)
+    HAL_GPIO_WritePin(spi_ins->GPIOx, spi_ins->cs_pin, GPIO_PIN_RESET);
+    switch (spi_ins->spi_work_mode) {
+        case SPI_DMA_MODE:
+            HAL_SPI_Transmit_DMA(spi_ins->spi_handle, ptr_data, len);
+            break;
+        case SPI_IT_MODE:
+            HAL_SPI_Transmit_IT(spi_ins->spi_handle, ptr_data, len);
+            break;
+        case SPI_BLOCK_MODE:
+            HAL_SPI_Transmit(spi_ins->spi_handle, ptr_data, len, 1000); // 默认50ms超时
+            // 阻塞模式不会调用回调函数,传输完成后直接拉高片选结束
+            HAL_GPIO_WritePin(spi_ins->GPIOx, spi_ins->cs_pin, GPIO_PIN_SET);
+            break;
+        default:
+            while (1); // error mode! 请查看是否正确设置模式，或出现指针越界导致模式被异常修改的情况
+            break;
+    }
+}
+
+void SPIRecv(SPIInstance *spi_ins, uint8_t *ptr_data, uint8_t len) {
+    // 用于稍后回调使用
+    spi_ins->rx_size = len;
+    spi_ins->rx_buffer = ptr_data;
+    // 拉低片选,开始传输
+    HAL_GPIO_WritePin(spi_ins->GPIOx, spi_ins->cs_pin, GPIO_PIN_RESET);
+    switch (spi_ins->spi_work_mode) {
+        case SPI_DMA_MODE:
+            HAL_SPI_Receive_DMA(spi_ins->spi_handle, ptr_data, len);
+            break;
+        case SPI_IT_MODE:
+            HAL_SPI_Receive_IT(spi_ins->spi_handle, ptr_data, len);
+            break;
+        case SPI_BLOCK_MODE:
+            HAL_SPI_Receive(spi_ins->spi_handle, ptr_data, len, 1000);
+            // 阻塞模式不会调用回调函数,传输完成后直接拉高片选结束
+            HAL_GPIO_WritePin(spi_ins->GPIOx, spi_ins->cs_pin, GPIO_PIN_SET);
+            break;
+        default:
+            while (1); // error mode! 请查看是否正确设置模式，或出现指针越界导致模式被异常修改的情况
+            break;
+    }
+}
+
+void SPITransRecv(SPIInstance *spi_ins, uint8_t *ptr_data_rx, uint8_t *ptr_data_tx, uint8_t len) {
+    // 用于稍后回调使用,请保证ptr_data_rx在回调函数被调用之前仍然在作用域内,否则析构之后的行为是未定义的!!!
+    spi_ins->rx_size = len;
+    spi_ins->rx_buffer = ptr_data_rx;
+    // 拉低片选,开始传输
+    HAL_GPIO_WritePin(spi_ins->GPIOx, spi_ins->cs_pin, GPIO_PIN_RESET);
+    switch (spi_ins->spi_work_mode) {
+        case SPI_DMA_MODE:
+            HAL_SPI_TransmitReceive_DMA(spi_ins->spi_handle, ptr_data_tx, ptr_data_rx, len);
+            break;
+        case SPI_IT_MODE:
+            HAL_SPI_TransmitReceive_IT(spi_ins->spi_handle, ptr_data_tx, ptr_data_rx, len);
+            break;
+        case SPI_BLOCK_MODE:
+            HAL_SPI_TransmitReceive(spi_ins->spi_handle, ptr_data_tx, ptr_data_rx, len, 1000); // 默认50ms超时
+            // 阻塞模式不会调用回调函数,传输完成后直接拉高片选结束
+            HAL_GPIO_WritePin(spi_ins->GPIOx, spi_ins->cs_pin, GPIO_PIN_SET);
+            break;
+        default:
+            while (1); // error mode! 请查看是否正确设置模式，或出现指针越界导致模式被异常修改的情况
+            break;
+    }
+}
+
+void SPISetMode(SPIInstance *spi_ins, SPI_TXRX_MODE_e spi_mode) {
+    if (spi_mode != SPI_DMA_MODE && spi_mode != SPI_IT_MODE && spi_mode != SPI_BLOCK_MODE)
+        while (1); // error mode! 请查看是否正确设置模式，或出现指针越界导致模式被异常修改的情况
+
+    if (spi_ins->spi_work_mode != spi_mode) {
+        spi_ins->spi_work_mode = spi_mode;
+    }
+}
+
+/**
+ * @brief 当SPI接收完成,将会调用此回调函数,可以进行协议解析或其他必须的数据处理等
+ *
+ * @param hspi spi handle
+ */
+void HAL_SPI_RxCpltCallback(SPI_HandleTypeDef *hspi) {
+    for (size_t i = 0; i < idx; i++) {
+        // 如果是当前spi硬件发出的complete,且cs_pin为低电平(说明正在传输),则尝试调用回调函数
+        if (spi_instance[i]->spi_handle == hspi && // 显然同一时间一条总线只能有一个从机在接收数据
+            HAL_GPIO_ReadPin(spi_instance[i]->GPIOx, spi_instance[i]->cs_pin) == GPIO_PIN_RESET) {
+            // 先拉高片选,结束传输,在判断是否有回调函数,如果有则调用回调函数
+            HAL_GPIO_WritePin(spi_instance[i]->GPIOx, spi_instance[i]->cs_pin, GPIO_PIN_SET);
+            // @todo 后续添加holdon模式,由用户自行决定何时释放片选,允许进行连续传输
+            if (spi_instance[i]->callback != NULL) // 回调函数不为空, 则调用回调函数
+                spi_instance[i]->callback(spi_instance[i]);
+            return;
+        }
+    }
+}
+
+/**
+ * @brief 和RxCpltCallback共用解析即可,这里只是形式上封装一下,不用重复写
+ *        这是对HAL库的__weak函数的重写,传输使用IT或DMA模式,在传输完成时会调用此函数
+ * @param hspi spi handle
+ */
+void HAL_SPI_TxRxCpltCallback(SPI_HandleTypeDef *hspi) {
+    HAL_SPI_RxCpltCallback(hspi); // 直接调用接收完成的回调函数
+}
--- a/User_Code/bsp/spi/bsp_spi.h
+++ b/User_Code/bsp/spi/bsp_spi.h
@@ -1,8 +1,94 @@
-//
-// Created by tuxmonkey on 2025/10/28.
-//
+#include "spi.h"
+#include "stdint.h"
+#include "gpio.h"

-#ifndef TRONONEH7_SCAFFOLD_BSP_SPI_H
-#define TRONONEH7_SCAFFOLD_BSP_SPI_H
+/* 根据开发板引出的spi引脚以及CubeMX中的初始化配置设定 */
+#define SPI_DEVICE_CNT 2       // C型开发板引出两路spi,分别连接BMI088/作为扩展IO在8pin牛角座引出
+#define MX_SPI_BUS_SLAVE_CNT 4 // 单个spi总线上挂载的从机数目

-#endif //TRONONEH7_SCAFFOLD_BSP_SPI_H
+/* spi transmit recv mode enumerate*/
+typedef enum {
+    SPI_BLOCK_MODE = 0, // 默认使用阻塞模式
+    SPI_IT_MODE,
+    SPI_DMA_MODE,
+} SPI_TXRX_MODE_e;
+
+/* SPI实例结构体定义 */
+typedef struct spi_ins_temp {
+    SPI_HandleTypeDef *spi_handle; // SPI外设handle
+    GPIO_TypeDef *GPIOx; // 片选信号对应的GPIO,如GPIOA,GPIOB等等
+    uint16_t cs_pin; // 片选信号对应的引脚号,GPIO_PIN_1,GPIO_PIN_2等等
+
+    SPI_TXRX_MODE_e spi_work_mode; // 传输工作模式
+    uint8_t rx_size; // 本次接收的数据长度
+    uint8_t *rx_buffer; // 本次接收的数据缓冲区
+
+    void (*callback)(struct spi_ins_temp *); // 接收回调函数
+    void *id; // 模块指针
+} SPIInstance;
+
+/* 接收回调函数定义,包含SPI的module按照此格式构建回调函数 */
+typedef void (*spi_rx_callback)(SPIInstance *);
+
+// @todo: 这里可以将GPIO_TypeDef *GPIOx; uint16_t cs_pin合并为bsp_gpio以简化代码实现
+/* SPI初始化配置,其实基本和SPIIstance一模一样,为了代码风格统一因此再次定义 */
+typedef struct {
+    SPI_HandleTypeDef *spi_handle; // SPI外设handle
+    GPIO_TypeDef *GPIOx; // 片选信号对应的GPIO,如GPIOA,GPIOB等等
+    uint16_t cs_pin; // 片选信号对应的引脚号,GPIO_PIN_1,GPIO_PIN_2等等
+
+    SPI_TXRX_MODE_e spi_work_mode; // 传输工作模式
+
+    spi_rx_callback callback; // 接收回调函数
+    void *id; // 模块指针
+} SPI_Init_Config_s;
+
+/**
+ * @brief 注册一个spi instance
+ *
+ * @param conf 传入spi配置
+ * @return SPIInstance* 返回一个spi实例指针,之后通过该指针操作spi外设
+ */
+SPIInstance *SPIRegister(SPI_Init_Config_s *conf);
+
+/**
+ * @brief 通过spi向对应从机发送数据
+ * @todo  后续加入阻塞模式下的timeout参数
+ *
+ * @param spi_ins spi实例指针
+ * @param ptr_data 要发送的数据
+ * @param len 待发送的数据长度
+ */
+void SPITransmit(SPIInstance *spi_ins, uint8_t *ptr_data, uint8_t len);
+
+/**
+ * @brief 通过spi从从机获取数据
+ * @attention 特别注意:请保证ptr_data在回调函数被调用之前仍然在作用域内,否则析构之后的行为是未定义的!!!
+ *
+ * @param spi_ins spi实例指针
+ * @param ptr_data 接受数据buffer的首地址
+ * @param len 待接收的长度
+ */
+void SPIRecv(SPIInstance *spi_ins, uint8_t *ptr_data, uint8_t len);
+
+/**
+ * @brief 通过spi利用移位寄存器同时收发数据
+ * @todo  后续加入阻塞模式下的timeout参数
+ * @attention 特别注意:请保证ptr_data_rx在回调函数被调用之前仍然在作用域内,否则析构之后的行为是未定义的!!!
+ *
+ * @param spi_ins spi实例指针
+ * @param ptr_data_rx 接收数据地址
+ * @param ptr_data_tx 发送数据地址
+ * @param len 接收&发送的长度
+ */
+void SPITransRecv(SPIInstance *spi_ins, uint8_t *ptr_data_rx, uint8_t *ptr_data_tx, uint8_t len);
+
+/**
+ * @brief 设定spi收发的工作模式
+ *
+ * @param spi_ins spi实例指针
+ * @param spi_mode 工作模式,包括阻塞模式(block),中断模式(IT),DMA模式.详见SPI_TXRX_MODE_e的定义
+ *
+ * @todo 是否直接将mode作为transmit/recv的参数,而不是作为spi实例的属性?两者各有优劣
+ */
+void SPISetMode(SPIInstance *spi_ins, SPI_TXRX_MODE_e spi_mode);
--- a/User_Code/bsp/spi/bsp_spi.md
+++ b/User_Code/bsp/spi/bsp_spi.md
@@ -0,0 +1,11 @@
+# bsp_spi.c/bsp_spi.h
+
+> 预计增加模拟spi
+
+初始化传入参数中的GPIOx（GPIOA，GPIOB，...）和cs_pin（GPIO_PIN_1,GPIO_PIN_2,
+...）都是HAL库内建的宏，在CubeMX初始化的时候若有给gpio分配标签则填入对应名字即可，否则填入原本的宏。
+
+注意，如果你没有在CubeMX中为spi分配dma通道，请不要使用dma模式
+
+（后续添加安全检查，通过判断hspi的dma handler是否为空来选择模式，如果为空，则自动将DMA转为IT模式以继续传输，并通过log warning
+提醒用户）