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

docs(deep-sleep-stub.rst): Added documentation about re-entering deep sleep from wake stub (IDFGH-12569) #13571

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

Conversation

Lupindakaas
Copy link

@Lupindakaas Lupindakaas commented Apr 9, 2024

This PR adds documentation to the deep sleep wake stub docs detailing how to re-enter deep sleep from the wake stub.

Copy link

github-actions bot commented Apr 9, 2024

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello Lupindakaas, 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.
- 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 7d81a6a

@espressif-bot espressif-bot added the Status: Opened Issue is new label Apr 9, 2024
@github-actions github-actions bot changed the title docs(deep-sleep-stub.rst): Added documentation about re-entering deep sleep from wake stub docs(deep-sleep-stub.rst): Added documentation about re-entering deep sleep from wake stub (IDFGH-12569) Apr 9, 2024

Before going back to deep-sleep you must set a wake up source. This can be a timer, GPIO pin or the ULP. This has to be set using `REG_SET_FIELD(RTC_CNTL_WAKEUP_STATE_REG, RTC_CNTL_WAKEUP_ENA, WAKEUP_MASK)`, where `WAKEUP_MASK` is a byte containing true on all enabled wakeup reasons. These reasons are defined in: https://github.com/espressif/esp-idf/blob/master/components/esp_rom/include/esp32/rom/rtc.h.

.. note:: When using ULP wakeup, it is probably best to leave the wakeup state and just start the RTC timer using `REG_SET_FIELD(RTC_CNTL_STATE0_REG, RTC_CNTL_ULP_CP_SLP_TIMER_EN, 1)`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

REG_SET_FIELD(RTC_CNTL_STATE0_REG, RTC_CNTL_ULP_CP_SLP_TIMER_EN, 1) is for enabling the timer wake-up source for the ULP coprocessor, which is independent of the deep-sleep-stub
feature is not a universal usage method, I think it is not necessary to explain it.

@esp-wzh
Copy link
Collaborator

esp-wzh commented Apr 10, 2024

@Lupindakaas
Thank you for pointing out this flaw in the IDF deepsleep stub example! The configuration of the wake-up source in the example is hidden in the call to the esp_sleep_enable_timer_wakeup function and sleep process in the main core app main, and then subsequent wake-ups in the stub inherit this enablement. If the wake-up source needs to be changed while the stub is running, other users is hard to obtain relevant information.

But the description in this file should be applicable to all esp chips. For some other esp32 series chips, the registers name and function have changed. Do you mind if I restart an update to this doc internally?

@Lupindakaas
Copy link
Author

Lupindakaas commented Apr 10, 2024

Hi, that would be awesome! I also send an email on the feedback form with some more documentation is missed whist working on our wake stub code, maybe you could check that out too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Opened Issue is new
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants