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

Runtime ISR binding and simple public API docs for assist-debug #1395

Merged
merged 4 commits into from
Apr 4, 2024

Conversation

JurajSadel
Copy link
Contributor

@JurajSadel JurajSadel commented Apr 4, 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).
  • My changes were added to the CHANGELOG.md in the proper section.

Extra:

Pull Request Details 📖

Description

Use runtime ISR binding for assist_debug and adds docs for public API.

Testing

Run modified debug_assist example.

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.

Thanks, this all LGTM from a code perspective!

I have a question about adding a MODE param to a driver that would (correct me if I'm wrong) never have an async version. If a driver won't ever support async, then the mode param seems redundant. We could just drop the parameter here, and assume that it's always in "blocking" mode. 🤔

@bjoernQ
Copy link
Contributor

bjoernQ commented Apr 4, 2024

Thanks, this all LGTM from a code perspective!

I have a question about adding a MODE param to a driver that would (correct me if I'm wrong) never have an async version. If a driver won't ever support async, then the mode param seems redundant. We could just drop the parameter here, and assume that it's always in "blocking" mode. 🤔

Good question! Would debug_assist ever make sense to be async? I think technically we could do that but will we do that? 🤔

@bjoernQ
Copy link
Contributor

bjoernQ commented Apr 4, 2024

I somehow thought GitHub lets me comment on non-changed lines but either it doesn't, it doesn't work or I don't know how. Anyways ....

The example shouldn't use #[interrupt] and pass None for the interrupt handler. It should use #[handler] and pass the handler to the constructor

Copy link
Contributor

@bjoernQ bjoernQ left a comment

Choose a reason for hiding this comment

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

We probably just need to decide if this will never be async and then remove the mode ... or decide it might become async and keep it 🤷‍♂️

@JurajSadel
Copy link
Contributor Author

Thanks, this all LGTM from a code perspective!

I have a question about adding a MODE param to a driver that would (correct me if I'm wrong) never have an async version. If a driver won't ever support async, then the mode param seems redundant. We could just drop the parameter here, and assume that it's always in "blocking" mode. 🤔

That's really good question! I think adding async doesn't make too much sense .. so if we all agree on not having async version, I'm happy to remove the MODE generic.

@jessebraham
Copy link
Member

jessebraham commented Apr 4, 2024

If there is currently no async support, I do not think we should speculate about the possibility of it at some unknown point in the future. If the mode is not necessary then IMO it should not be a generic parameter, if we ever (for whatever reason) add async support here it's easy enough to change it at that time.

@JurajSadel JurajSadel force-pushed the debug-assist-isr-binding branch from 4ceb931 to 8cd2843 Compare April 4, 2024 14:50
@JurajSadel
Copy link
Contributor Author

I reverted MODE generic changes.

@JurajSadel JurajSadel force-pushed the debug-assist-isr-binding branch from 8cd2843 to 1a3cddd Compare April 4, 2024 14:54
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 making those changes, I think this LGTM now.

@jessebraham jessebraham added this pull request to the merge queue Apr 4, 2024
Merged via the queue into esp-rs:main with commit 215573a Apr 4, 2024
21 checks passed
@JurajSadel JurajSadel deleted the debug-assist-isr-binding branch April 10, 2024 15:27
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.

4 participants