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

SPI type erasure #2334

Merged
merged 19 commits into from
Oct 21, 2024
Merged

SPI type erasure #2334

merged 19 commits into from
Oct 21, 2024

Conversation

bugadani
Copy link
Contributor

@bugadani bugadani commented Oct 10, 2024

Thank you for your contribution!

We appreciate the time and effort you've put into this pull request.
To help us review it efficiently, please ensure you've gone through the following checklist:

Submission Checklist 📝

  • I have updated existing examples or added new ones (if applicable).
  • I have used cargo xtask fmt-packages command to ensure that all changed code is formatted correctly.
  • My changes were added to the CHANGELOG.md in the proper section.
  • I have added necessary changes to user code to the Migration Guide.
  • My changes are in accordance to the esp-rs API guidelines

Extra:

Pull Request Details 📖

Changes also include #2335

@bugadani bugadani marked this pull request as ready for review October 18, 2024 14:46
esp-hal/src/dma/pdma.rs Outdated Show resolved Hide resolved
Copy link
Member

@MabezDev MabezDev left a comment

Choose a reason for hiding this comment

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

Very excited to have this land! This PR LGTM, two notes though:

  • We should try and reorder (and maybe erase) every driver that has an instance to get that done in this release to avoid inconsistencies
  • We should add a note in the API-GUIDELINES (don't worry, not in this PR but I'll add to the boiler plate tracking issue) about the param ordering so that we put the instance last so we can do this trick.

@@ -38,8 +38,8 @@ crate::peripherals! {
HINF <= HINF,
I2C0 <= I2C0,
I2C1 <= I2C1,
I2S0 <= I2S0 (I2S0),
I2S1 <= I2S1 (I2S1),
[I2s0] I2S0 <= I2S0 (I2S0),
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you please elaborate what does this mean?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added a doc comment for the peripherals macro

esp-hal/src/lib.rs Outdated Show resolved Hide resolved
Copy link
Member

@jessebraham jessebraham left a comment

Choose a reason for hiding this comment

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

Thanks for addressing the comments. There's a lot to take in here, but overall I think it looks fine, CI and HIL are happy at least. 🤷🏻‍♂️

@bugadani bugadani added this pull request to the merge queue Oct 21, 2024
Merged via the queue into esp-rs:main with commit a754e41 Oct 21, 2024
28 checks passed
@bugadani bugadani deleted the utils branch October 21, 2024 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants