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.

Sign up for GitHub

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

Jump to bottom

Improve Log Messages in GPIO HAL #9011

Merged
merged 4 commits into from
Dec 19, 2023
Merged

Improve Log Messages in GPIO HAL #9011

merged 4 commits into from
Dec 19, 2023

Conversation

SuGlider
Copy link
Collaborator

Description of Change

Improves the log messages by adding the GPIO number that has triggered the error message for better debugging.

Tests scenarios

Tested with ESP32-C3.

Related links

Fixes #9008

@SuGlider SuGlider self-assigned this Dec 17, 2023
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 17, 2023 •
edited
Loading

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Improve Log Messages":
    • summary looks empty
    • type/action looks empty
  • the commit message "Uses IO # in messages":
    • summary looks empty
    • type/action looks empty
  • the commit message "uses pin# in log messages":
    • summary looks empty
    • type/action looks empty

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).
Messages
📖 You might consider squashing your 4 commits (simplifying branch history).

👋 Hello SuGlider, we appreciate your contribution to this project!

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 65df2b7

@SuGlider SuGlider mentioned this pull request Dec 17, 2023
Closed
1 task
@SuGlider SuGlider added this to the 3.0.0-RC1 milestone Dec 17, 2023
P-R-O-C-H-Y
P-R-O-C-H-Y approved these changes Dec 18, 2023
View reviewed changes
Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

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

Just suggested small change, else looks good. :)

cores/esp32/esp32-hal-gpio.c Outdated
return;
}

if(perimanGetPinBus(pin, ESP32_BUS_TYPE_GPIO) == NULL){
perimanSetBusDeinit(ESP32_BUS_TYPE_GPIO, gpioDetachBus);
if(!perimanClearPinBus(pin)){
log_e("Deinit of previous bus failed");
log_e("Deinit of previous bus from GPIO %i failed", pin);
Copy link
Member

Choose a reason for hiding this comment

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

Pin is not set as GPIO yet, so better to use "pin" instead of "GPIO".

Copy link
Member

Choose a reason for hiding this comment

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

Pin: usually the physical pin number on a chip or module
GPIO: usually the hardware IO+IOBUS number inside the chip. Do not apply for special purpose IOs
IO: usually wider sense, which includes GPIO and special purpose IOs

BUT because we are special and have IO mode = GPIO and all our IOs can be GPIOs, let's use IO from now on for when we want to specify something on the hardware level that might not be in GPIO mode.

If we are in pinMode or going through the matrix, then we are in GPIO mode. If we are using something analog (ADC, DAC, Touch, etc.) we are in RTC mode. Else we are in special mode (I'm pretty sure we don't currently use it, but UART0 starts that way, Flash/PSRAM are that way also and if IO numbers match SPI, we could use it there too for better 80MHz support)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I have changed the message in this and other places. Let me know if you agree.

lucasssvaz
lucasssvaz approved these changes Dec 18, 2023
View reviewed changes
Copy link
Collaborator

@lucasssvaz lucasssvaz left a comment

Choose a reason for hiding this comment

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

LGTM

@SuGlider
Copy link
Collaborator Author

@me-no-dev - Ready for final review.

P-R-O-C-H-Y
P-R-O-C-H-Y approved these changes Dec 19, 2023
View reviewed changes
Copy link
Member

@P-R-O-C-H-Y P-R-O-C-H-Y left a comment

Choose a reason for hiding this comment

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

LGTM!

@me-no-dev me-no-dev merged commit e9ee9c1 into espressif:master Dec 19, 2023
39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@P-R-O-C-H-Y P-R-O-C-H-Y P-R-O-C-H-Y approved these changes

@me-no-dev me-no-dev Awaiting requested review from me-no-dev

@lucasssvaz lucasssvaz Awaiting requested review from lucasssvaz

Assignees

@SuGlider SuGlider

Labels
None yet
Projects
Arduino ESP32 Core Project Roadmap
Status: Done
Milestone
3.0.0-RC1
Development

Successfully merging this pull request may close these issues.

log expansion
4 participants
@SuGlider @me-no-dev @lucasssvaz @P-R-O-C-H-Y