Skip to content

refactor[STM32][DMA]: unify DMA helpers and descriptors for HAL drivers#11346

Open
wdfk-prog wants to merge 2 commits intoRT-Thread:masterfrom
wdfk-prog:pr/04-stm32-dma
Open

refactor[STM32][DMA]: unify DMA helpers and descriptors for HAL drivers#11346
wdfk-prog wants to merge 2 commits intoRT-Thread:masterfrom
wdfk-prog:pr/04-stm32-dma

Conversation

@wdfk-prog
Copy link
Copy Markdown
Contributor

拉取/合并请求描述:(PR description)

[

为什么提交这份PR (why to submit this PR)

当前 STM32 HAL_Drivers 中 DMA 相关实现分散在两层:

  1. 外设驱动层分别维护 DMA 初始化、时钟使能、IRQ 配置、回滚和反初始化逻辑;
  2. 各系列配置头文件分别维护 DMA 端点描述,存在大量重复字段展开和系列差异分支。

这种实现方式导致 DMA 接入路径和配置表达方式不统一,增加了维护成本,也不利于后续扩展更多 STM32 系列或外设 DMA 场景。

你的解决方案是什么 (what is your solution)

本次修改统一了驱动侧和配置侧两部分 DMA 逻辑:

  1. 在驱动侧新增 drv_dma.c / drv_dma.h,引入 stm32_dma_config 描述结构以及 stm32_dma_init()stm32_dma_setup()stm32_dma_deinit() 等公共 helper,用于统一处理 DMA 控制器时钟开启、DMAMUX 使能、HAL DMA 参数下发、NVIC 配置和反初始化流程。

  2. drv_hard_i2c.cdrv_spi.cdrv_usart.cdrv_usart_v2.cdrv_qspi.cdrv_sdio.c 中原有分散的 DMA 初始化和回滚逻辑切换为复用公共 helper,并将驱动内部相关 DMA 配置改为 const struct stm32_dma_config

  3. 在配置侧,将多个 STM32 系列下 SPI/UART/I2C/SDIO/QSPI 的 DMA 配置宏迁移为统一的描述符初始化宏,如 STM32_DMA_*_CONFIG_INIT_EXSTM32_DMA_CONFIG_INIT_FIFO_EX,并补充可覆写的 DMA_PRIORITYDMA_PREEMPT_PRIORITYDMA_SUB_PRIORITY 字段,以统一不同系列配置头的表达方式。

请提供验证的bsp和config (provide the config and bsp)

  • BSP:

    • 已验证F4 I2C SPI UART DMA RX TX可用
  • .config:

    • 需根据实际验证情况补充 DMA 相关配置项
    • 例如:BSP_SPIx_TX_USING_DMABSP_SPIx_RX_USING_DMABSP_UARTx_TX_USING_DMABSP_UARTx_RX_USING_DMABSP_I2Cx_TX_USING_DMABSP_I2Cx_RX_USING_DMABSP_QSPI_USING_DMABSP_USING_SDIO
  • action:

    • 当前未提供 PR 分支 action 编译成功链接,需提交者补充

]

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

  • 本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
  • 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality:

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

  • 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
  • 代码风格正确,包括缩进空格,命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
  • 没有垃圾代码,代码尽量精简,不包含#if 0代码,不包含已经被注释了的代码 All redundant code is removed and cleaned up
  • 所有变更均有原因及合理的,并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
  • 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
  • 代码是高质量的 Code in this PR is of high quality
  • 已经使用formatting 等源码格式化工具确保格式符合RT-Thread代码规范 This PR complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/ALL_BSP_COMPILE.json 详细请参考链接BSP自查

@github-actions
Copy link
Copy Markdown

👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread!

为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。
To ensure your code complies with RT-Thread's coding style, please run the code formatting workflow by following the steps below (If the formatting of CI fails to run).


🛠 操作步骤 | Steps

  1. 前往 Actions 页面 | Go to the Actions page
    点击进入工作流 → | Click to open workflow →

  2. 点击 Run workflow | Click Run workflow

  • 设置需排除的文件/目录(目录请以"/"结尾)
    Set files/directories to exclude (directories should end with "/")
  • 将目标分支设置为 \ Set the target branch to:pr/04-stm32-dma
  • 设置PR number为 \ Set the PR number to:11346
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将自动推送至你的分支。
    The formatted code will be automatically pushed to your branch.

完成后,提交将自动更新至 pr/04-stm32-dma 分支,关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the pr/04-stm32-dma branch automatically, and the related Pull Request will be updated.

如有问题欢迎联系我们,再次感谢您的贡献!💐
If you have any questions, feel free to reach out. Thanks again for your contribution!

@github-actions github-actions Bot added BSP: STM32 BSP related with ST/STM32 BSP labels Apr 27, 2026
@wdfk-prog
Copy link
Copy Markdown
Contributor Author

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 27, 2026

📌 Code Review Assignment

🏷️ Tag: bsp_stm32

Reviewers: @Liang1795 @hamburger-os @wdfk-prog

Changed Files (Click to expand)
  • bsp/stm32/libraries/HAL_Drivers/drivers/SConscript
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f0/spi_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f0/uart_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f1/dma_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f1/i2c_hard_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f1/sdio_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f1/spi_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f1/uart_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f2/sdio_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f2/spi_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f2/uart_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f3/uart_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f4/dma_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f4/i2c_hard_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f4/qspi_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f4/sdio_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f4/spi_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f4/uart_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f7/qspi_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f7/sdio_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f7/spi_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/f7/uart_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/g0/spi_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/g0/uart_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/g4/dma_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/g4/qspi_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/g4/sdio_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/g4/spi_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/g4/uart_config.h
  • bsp/stm32/libraries/HAL_Drivers/drivers/config/h5/uart_config.h

📊 Current Review Status (Last Updated: 2026-05-05 09:07 CST)


📝 Review Instructions

  1. 维护者可以通过单击此处来刷新审查状态: 🔄 刷新状态
    Maintainers can refresh the review status by clicking here: 🔄 Refresh Status

  2. 确认审核通过后评论 LGTM/lgtm
    Comment LGTM/lgtm after confirming approval

  3. PR合并前需至少一位维护者确认
    PR must be confirmed by at least one maintainer before merging

ℹ️ 刷新CI状态操作需要具备仓库写入权限。
ℹ️ Refresh CI status operation requires repository Write permission.

@wdfk-prog wdfk-prog force-pushed the pr/04-stm32-dma branch 2 times, most recently from eeb73be to d125ab3 Compare April 27, 2026 05:15
@Rbb666 Rbb666 requested review from Rbb666 and Copilot April 29, 2026 15:00
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refactors the STM32 HAL_Drivers DMA integration by introducing a shared DMA helper layer and migrating multiple peripheral drivers + per-series config headers to a unified stm32_dma_config descriptor style, reducing duplicated DMA init/NVIC/rollback logic across UART/SPI/I2C/SDIO/QSPI.

本次 PR 通过新增通用 DMA helper 层,并将多个外设驱动及各系列配置头文件迁移到统一的 stm32_dma_config 描述符风格,来减少 UART/SPI/I2C/SDIO/QSPI 等驱动中 DMA 初始化/NVIC/回滚逻辑的重复实现。

Changes:

  • Add common DMA helper module (drv_dma.c/.h) and wire it into the HAL_Drivers build.
  • Switch multiple driver config structs from legacy dma_config to stm32_dma_config (mostly const *) and route DMA init via shared helpers.
  • Update per-series config headers to use unified STM32_DMA_*_CONFIG_INIT_EX-style macros with overridable priority fields.

变更点:

  • 新增通用 DMA helper 模块(drv_dma.c/.h),并加入 HAL_Drivers 构建。
  • 多个驱动配置结构从旧 dma_config 切换到 stm32_dma_config(多为 const *),DMA 初始化流程复用公共 helper。
  • 各系列配置头迁移到统一的 STM32_DMA_*_CONFIG_INIT_EX 宏,并补充可覆写的优先级字段。

Reviewed changes

Copilot reviewed 75 out of 75 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
bsp/stm32/libraries/HAL_Drivers/drivers/SConscript Always builds the new common DMA helper module
bsp/stm32/libraries/HAL_Drivers/drivers/drv_dma.c New common DMA init/setup/deinit implementation (HAL-gated)
bsp/stm32/libraries/HAL_Drivers/drivers/drv_dma.h New unified DMA descriptor type + init macros + helper APIs
bsp/stm32/libraries/HAL_Drivers/drivers/drv_config.h Exposes DMA helper types to driver config headers
bsp/stm32/libraries/HAL_Drivers/drivers/drv_usart.h UART config now references stm32_dma_config pointers
bsp/stm32/libraries/HAL_Drivers/drivers/drv_usart_v2.h USART v2 config now references stm32_dma_config pointers
bsp/stm32/libraries/HAL_Drivers/drivers/drv_spi.h SPI config now references stm32_dma_config pointers
bsp/stm32/libraries/HAL_Drivers/drivers/drv_hard_i2c.h I2C config now references stm32_dma_config pointers
bsp/stm32/libraries/HAL_Drivers/drivers/drv_sdio.h SDIO embeds stm32_dma_config descriptors (rx/tx)
bsp/stm32/libraries/HAL_Drivers/drivers/drv_sdio.c SDIO DMA path moved to shared DMA helpers with rollback
bsp/stm32/libraries/HAL_Drivers/drivers/drv_qspi.c QSPI DMA init moved to stm32_dma_setup
bsp/stm32/libraries/HAL_Drivers/drivers/config/wl/uart_config.h WL UART DMA config migrated to unified init macros + overridable priorities
bsp/stm32/libraries/HAL_Drivers/drivers/config/l5/spi_config.h L5 SPI DMA config migrated to unified init macros + overridable priorities
bsp/stm32/libraries/HAL_Drivers/drivers/config/h7/dma_config.h Adds QSPI request fallback selection for H7
bsp/stm32/libraries/HAL_Drivers/drivers/config/mp1/dma_config.h Adds QSPI request fallback selection for MP1

Comment thread bsp/stm32/libraries/HAL_Drivers/drivers/SConscript
Comment thread bsp/stm32/libraries/HAL_Drivers/drivers/SConscript
Comment thread bsp/stm32/libraries/HAL_Drivers/drivers/drv_sdio.c Outdated
Comment thread bsp/stm32/libraries/HAL_Drivers/drivers/config/mp1/dma_config.h
Comment thread bsp/stm32/libraries/HAL_Drivers/drivers/config/h7/dma_config.h
Comment thread bsp/stm32/libraries/HAL_Drivers/drivers/SConscript
wdfk-prog added 2 commits May 5, 2026 09:06
- add drv_dma common helpers and stm32_dma_config descriptors for STM32 series
- refactor i2c, spi, usart, qspi, and sdio DMA setup and deinit paths to reuse the common layer
- unify DMA IRQ enable, rollback handling, and const board-level DMA configuration usage
- migrate STM32 HAL driver DMA config macros to shared descriptor init helpers
- add overridable DMA priority and NVIC priority fields for board-level configs
- align SPI, UART, I2C, SDIO, and QSPI DMA descriptors across visible STM32 series configs
- simplify per-series DMA config definitions and reduce duplicated field assignments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BSP: STM32 BSP related with ST/STM32 BSP

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants