Skip to content

[drivers][i2c] Serialize bus control with transfers - #11820

Open
manyangshen wants to merge 1 commit into
RT-Thread:masterfrom
manyangshen:fix/i2c-control-lock
Open

manyangshen wants to merge 1 commit into
RT-Thread:masterfrom
manyangshen:fix/i2c-control-lock

Conversation

@manyangshen

@manyangshen manyangshen commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor

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

rt_i2c_control() can change the controller configuration while rt_i2c_transfer() is using the bus. Take the same bus mutex around control commands, including SET_MAX_HZ, and release it through a common exit path. Error handling follows rt_i2c_transfer(); the API documentation now states that control requires thread context.

Fixes #11524.

Validation

GCC 16.1 compiled the complete I2C core and device wrapper against repository headers. Host tests with a pthread mutex adapter pass concurrent transfer/control combinations, control/control, max_hz updates, lock and callback errors, and a nested control-to-transfer call. The unpatched source fails the regression suite.

Configuration: RT_USING_I2C, RT_USING_DEVICE_OPS, RT_USING_MUTEX and RT_USING_SEMAPHORE. Changed-line clang-format and git diff --check pass. No target BSP, QEMU or I2C hardware test was run; the host adapter does not test RT-Thread priority inheritance.

当前拉取/合并请求的状态 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
  • 已经使用clang-format 源码格式化工具确保格式符合RT-Thread代码规范 This PR has been formatted with clang-format and complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/ALL_BSP_COMPILE.json 详细请参考链接BSP自查

Hold the bus mutex while dispatching control commands and changing max_hz. Use a common unlock path and propagate mutex errors as in rt_i2c_transfer. Document the thread-context requirement.

Fixes RT-Thread#11524
@CLAassistant

CLAassistant commented Sep 22, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@github-actions

github-actions Bot commented Sep 22, 2026 •

Copy link
Copy Markdown

📌 Code Review Assignment

🏷️ Tag: components

Reviewers: @Maihuanyi

Changed Files (Click to expand)
  • components/drivers/i2c/dev_i2c_core.c
  • components/drivers/include/drivers/dev_i2c.h

🏷️ Tag: components_driver_i2c

Reviewers: @wdfk-prog

Changed Files (Click to expand)
  • components/drivers/i2c/dev_i2c_core.c

📊 Current Review Status (Last Updated: 2026-09-22 18:48 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.

@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

  • Use workflow from 保持默认分支(通常为 master)
    Keep the default branch (usually master) in Use workflow from
  • 在 branch 输入框填写 PR 分支 fix/i2c-control-lock
    Enter PR branch fix/i2c-control-lock in the branch field
  • 设置需排除的文件/目录(目录请以"/"结尾)
    Set files/directories to exclude (directories should end with "/")
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将作为独立提交推送至你的分支。
    The formatting changes will be pushed to your branch as a separate commit.

完成后,提交将自动更新至 fix/i2c-control-lock 分支,关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the fix/i2c-control-lock 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!

@wdfk-prog wdfk-prog left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

  • 虽然不一定所有的BSP自定义的control都是需要互斥保护的;但是control确实是需要加锁的,由bsp内部加锁也不合适;所以是得加锁保护更好些

@manyangshen
manyangshen marked this pull request as ready for review September 26, 2026 08:10
@manyangshen

Copy link
Copy Markdown
Contributor Author

这组修复已准备好进入正式评审:本 PR 以及 #11821、#11822、#11823、#11824、#11825、#11826。

我重新检查了各 PR 的当前提交,7 组主机回归测试、修改行 clang-format 和 git diff --check 均通过;PM 覆盖 4 种配置,OpenAMP 覆盖两份 BSP 实现。#11823 的 static/局部缓冲区问题也已在对应评审线程回复并补做交错调用对照验证。目标板和上游完整 CI 的验证范围仍以各 PR 描述为准。

目前各 PR 的 CLA 均已通过,但上游 Actions 显示 action_required,等待维护者批准运行。烦请有权限的维护者批准这些待运行的工作流,并继续评审。如有测试失败或修改意见,我会继续跟进。谢谢!

@CYFS3 CYFS3 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

4 participants