Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use small lock in following files: #15417

Merged
merged 1 commit into from
Jan 5, 2025
Merged

use small lock in following files: #15417

merged 1 commit into from
Jan 5, 2025

Conversation

wangzhi-art
Copy link
Contributor

Summary

use small lock in following files:

arch/arm64/src/a64/a64_twi.c
arch/arm64/src/imx9/imx9_gpioirq.c
arch/arm64/src/imx9/imx9_lpi2c.c
arch/arm64/src/imx9/imx9_usbdev.c
arch/arm64/src/imx9/imx9_usdhc.c

Impact

arch/arm64/src/a64/a64_twi.c
arch/arm64/src/imx9/imx9_gpioirq.c
arch/arm64/src/imx9/imx9_lpi2c.c
arch/arm64/src/imx9/imx9_usbdev.c
arch/arm64/src/imx9/imx9_usdhc.c

Testing

CI

@github-actions github-actions bot added Arch: arm64 Issues related to ARM64 (64-bit) architecture Size: S The size of the change in this PR is small labels Jan 3, 2025
@nuttxpr
Copy link

nuttxpr commented Jan 3, 2025

[Experimental Bot, please feedback here]

This PR appears to be missing crucial information to meet the NuttX requirements. While it lists the files changed, it lacks important details.

Here's a breakdown of what's missing and how to improve it:

Summary:

  • Missing "Why": The PR states what was changed (using a small lock), but not why. Is this for performance improvement? Deadlock avoidance? Explain the motivation for the change.
  • Missing "How": It's unclear what "small lock" means. What locking mechanism is being used? How does it differ from the previous locking? Provide more technical details.
  • Missing Issue References: Are there related NuttX issues this PR addresses? If so, link them.

Impact:

The current impact section simply repeats the list of files. This is insufficient. Address each impact point specifically:

  • New Feature/Changed Feature: Clarify if a new feature is introduced or if existing functionality is modified.
  • Impact on User: Will the user experience any changes? Likely no, but explicitly state that.
  • Impact on Build: Will the build process be affected? Likely no, but explicitly state that.
  • Impact on Hardware: This is relevant as it affects specific architecture and boards. Briefly explain why these changes are needed for the imx9.
  • Impact on Documentation: Does this change require documentation updates? If not, explicitly state "NO".
  • Impact on Security: Does using a smaller lock have security implications? If not, explicitly state "NO".
  • Impact on Compatibility: Are there backward compatibility concerns? If not, explicitly state "NO".

Testing:

Simply stating "CI" is not enough.

  • Build Host(s): Specify the environment used for testing (OS, CPU, Compiler).
  • Target(s): Be specific about the target architecture, board, and configuration used for testing.
  • Testing Logs: Provide actual logs demonstrating the behavior before and after the change. Show how the change addresses the original issue or improves performance. If logs are too extensive, provide a summary and link to a separate file or CI run.

Example of an Improved Summary:

This change replaces the existing mutex locks in the specified drivers with smaller, more efficient spinlocks. This is done to improve performance in interrupt context, where the previous mutex implementation could lead to unnecessary context switches. This addresses the performance regression observed in NuttX Issue #XXXX.

By providing these missing details, the PR will be much clearer, easier to review, and more likely to be accepted.

arch/arm64/src/a64/a64_twi.c
arch/arm64/src/imx9/imx9_gpioirq.c
arch/arm64/src/imx9/imx9_lpi2c.c
arch/arm64/src/imx9/imx9_usbdev.c
arch/arm64/src/imx9/imx9_usdhc.c

Signed-off-by: wangzhi16 <wangzhi16@xiaomi.com>
@github-actions github-actions bot added Size: M The size of the change in this PR is medium and removed Size: S The size of the change in this PR is small labels Jan 3, 2025
@acassis acassis merged commit bbaf1ff into apache:master Jan 5, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Arch: arm64 Issues related to ARM64 (64-bit) architecture Size: M The size of the change in this PR is medium
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants