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

GPIO: Add gpio_get_io_config(). (IDFGH-14117) #14923

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

IhorNehrutsa
Copy link
Contributor

Add to API:

void gpio_get_io_config(uint32_t gpio_num,
                        bool *pu, bool *pd, bool *ie, bool *oe, bool *od, uint32_t *drv,
                        uint32_t *fun_sel, uint32_t *sig_out, bool *slp_sel);
bool gpio_pullup_is_enabled(uint32_t gpio_num);
bool gpio_pulldown_is_enabled(uint32_t gpio_num);
bool gpio_sleep_sel_is_enabled(uint32_t gpio_num);
bool gpio_sleep_pullup_is_enabled(uint32_t gpio_num);
bool gpio_sleep_pulldown_is_enabled(uint32_t gpio_num);

This PR is a continuation of
GPIO feature: Add gpio_get_direction() and gpio_get_pull_mode() (IDFGH-10987) #12176

Copy link

github-actions bot commented Nov 22, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "GPIO: Add gpio_get_io_config().":
    • summary should not end with a period (full stop)
    • type/action should start with a lowercase letter
    • type/action should be one of [change, ci, docs, feat, fix, refactor, remove, revert, test]

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,test
  • 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).

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


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for 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.
- 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 via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

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 synchronize it into our internal git repository.
4. In the internal git repository 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.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 43d21d3

@espressif-bot espressif-bot added the Status: Opened Issue is new label Nov 22, 2024
@github-actions github-actions bot changed the title GPIO: Add gpio_get_io_config() and xxx_is_enabled(). GPIO: Add gpio_get_io_config() and xxx_is_enabled(). (IDFGH-14117) Nov 22, 2024
@songruo
Copy link
Collaborator

songruo commented Nov 26, 2024

We already provided gpio_dump_io_configuration API to check IO configurations. Usually, ESP-IDF drivers won't offer two similar APIs or APIs that are too trivial.

You can always call HAL APIs directly to fulfill your own request in such case.

@IhorNehrutsa
Copy link
Contributor Author

I don't need text format dump in the stream. The pin state is not for human reading, it will be analyzed by the program. I need raw state of pin. You can remove gpio_dump_io_configuration() or move to an example but add gpio_get_io_config.

@IhorNehrutsa
Copy link
Contributor Author

Also gpio_dump_io_configuration has bug, please see #14931.

@IhorNehrutsa
Copy link
Contributor Author

You can always call HAL APIs directly to fulfill your own request in such case.

You can't call HAL APIs directly because GPIO HAL gpio_context object is static inside the driver

static gpio_context_t gpio_context = {
.gpio_hal = &_gpio_hal,
.gpio_spinlock = portMUX_INITIALIZER_UNLOCKED,
.isr_core_id = GPIO_ISR_CORE_ID_UNINIT,
.gpio_isr_func = NULL,
.isr_clr_on_entry_mask = 0,
};

and inaccessible directly in HAL functions as parameter.
gpio_ll_get_io_config(gpio_dev_t *hw, ...)
gpio_hal_get_io_config(hal, ...)

@IhorNehrutsa
Copy link
Contributor Author

@songruo
Copy link
Collaborator

songruo commented Nov 27, 2024

Ok, we can add gpio_get_io_config. Please remove the other trivial getters, then we can go through the PR procedure.

Signed-off-by: IhorNehrutsa <Ihor.Nehrutsa@gmail.com>
@IhorNehrutsa IhorNehrutsa changed the title GPIO: Add gpio_get_io_config() and xxx_is_enabled(). (IDFGH-14117) GPIO: Add gpio_get_io_config(). (IDFGH-14117) Nov 27, 2024
@songruo songruo added the PR-Sync-Merge Pull request sync as merge commit label Nov 28, 2024
@songruo
Copy link
Collaborator

songruo commented Nov 28, 2024

sha=43d21d335484bf1a9a87e63397969a0a9aefa5e3

@espressif-bot espressif-bot added Status: In Progress Work is in progress and removed Status: Opened Issue is new labels Dec 10, 2024
@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable and removed Status: In Progress Work is in progress labels Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR-Sync-Merge Pull request sync as merge commit Resolution: NA Issue resolution is unavailable Status: Done Issue is done internally
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants