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

Fix I2S examples #2139

Merged
merged 3 commits into from
Sep 11, 2024
Merged

Fix I2S examples #2139

merged 3 commits into from
Sep 11, 2024

Conversation

bjoernQ
Copy link
Contributor

@bjoernQ bjoernQ commented Sep 11, 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 📖

Description

Well, this was a very easy one

The macros to conveniently create descriptors and buffers were changed to RX-TX but in the example code the requested buffer size wasn't swapped in the parameter list of the macro invocation

No changelog - just examples changed

Testing

The changed examples work, again

@bjoernQ bjoernQ added the skip-changelog No changelog modification needed label Sep 11, 2024
@bjoernQ bjoernQ linked an issue Sep 11, 2024 that may be closed by this pull request
Copy link
Contributor

@bugadani bugadani left a comment

Choose a reason for hiding this comment

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

I can see that in #2074 everything (as in, inputs and outputs of the macro defintion) got swapped except for these values. Good find!

@bugadani
Copy link
Contributor

bugadani commented Sep 11, 2024

Having said that, it looks like lcd_cam, lcd_i8080, parl_io and qspi_flash examples may be similarly affected, and the migration guide should include how to update code using the asymmetric macros.

Would you tackle these in this PR, or should we do them in a follow-up?

@bjoernQ
Copy link
Contributor Author

bjoernQ commented Sep 11, 2024

Having said that, it looks like lcd_cam, lcd_i8080, parl_io and qspi_flash examples may be similarly affected, and the migration guide should include how to update code using the asymmetric macros.

Oh yes 🙈 - good catch

Will address this in this PR

Copy link
Contributor

@JurajSadel JurajSadel left a comment

Choose a reason for hiding this comment

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

Thanks!

@JurajSadel JurajSadel added this pull request to the merge queue Sep 11, 2024
Merged via the queue into esp-rs:main with commit 312746f Sep 11, 2024
27 checks passed
@bjoernQ bjoernQ deleted the examples/fix-i2s-examples branch November 26, 2024 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No changelog modification needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

i2s examples broken with #2074
3 participants