Skip to content

Conversation

@floitsch
Copy link
Contributor

@floitsch floitsch commented Dec 8, 2025

Description

The symbols parameter given to the RMT encoder's callback function may be a hardware buffer which can't be used as target for memcpy.

Related

https://esp32.com/viewtopic.php?t=47324

Testing


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

Note

Clarifies in rmt_encoder.h that the symbols buffer in the simple encoder callback may be a hardware buffer and must not be used with memcpy.

Written by Cursor Bugbot for commit 9eb0f81. This will update automatically on new commits. Configure here.

@CLAassistant
Copy link

CLAassistant commented Dec 8, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions
Copy link

github-actions bot commented Dec 8, 2025

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello floitsch, 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 9eb0f81

@github-actions github-actions bot changed the title docs: encoder's 'symbols' parameter may be a hw buffer docs: encoder's 'symbols' parameter may be a hw buffer (IDFGH-16932) Dec 8, 2025
@espressif-bot espressif-bot added the Status: Opened Issue is new label Dec 8, 2025
@suda-morris
Copy link
Collaborator

sha=9eb0f81517681712006bd3bbf3dbdb2f42f4ff71

@suda-morris suda-morris added the PR-Sync-Merge Pull request sync as merge commit label Dec 8, 2025
@espressif-bot espressif-bot added Status: In Progress Work is in progress Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable Resolution: Done Issue is done internally and removed Status: Opened Issue is new Status: In Progress Work is in progress Resolution: NA Issue resolution is unavailable labels Dec 8, 2025
@espressif-bot espressif-bot merged commit d18019d into espressif:master Dec 10, 2025
20 checks passed
@floitsch floitsch deleted the symbols-doc branch December 11, 2025 07:24
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: Done Issue is done internally Status: Done Issue is done internally

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants