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

feat(uart): [IDF5.1] fixes HardwareSerial::updateBaudRate() using a baud rate higher 230400 - checks UART Clock Source #10642

Merged
merged 3 commits into from
Nov 25, 2024

Conversation

SuGlider
Copy link
Collaborator

EXCLUSIVE FOR IDF 5.1 - Arduino Core 3.0.x

Description of Change

ESP32 and ESP32S2 use REF_TICK as UART clock source whenever the baud rate is lower then 250,000.
This is done within HardwareSerial::begin(uint32_t baud)
This prevents issues with chaning the APB clock to lower than 40MHz, specially when achieving lower power consumpition.

This PR also fixes it for the HardwareSerial::updateBaudRate(uint32_t baud) by checking the target baud rate and adjusting the UART Clock Source that will make it work correctly.

Tests scenarios

Using this sketch (from the issue report) using ESP32 and ESP32S2

void setup() {
  // put your setup code here, to run once:
  Serial.begin(115200);
  delay(500);
  
  Serial1.begin(230400);
  Serial.printf("%d\n", Serial1.baudRate());
  // Clock is now UART_SCLK_REF_TICK

  Serial1.updateBaudRate(460800);
  Serial.printf("%d\n", Serial1.baudRate());
  // Clock is still UART_SCLK_REF_TICK

  Serial1.end();
  Serial1.begin(460800);
  Serial.printf("%d\n", Serial1.baudRate());
  // Clock is now UART_SCLK_APB <<---- FIXED by the PR
}

void loop() {
}

Related links

Closes #10641

Copy link
Contributor

github-actions bot commented Nov 23, 2024

Warnings
⚠️
	The **target branch** for this Pull Request **must be the default branch** of the project (`master`).

	If you would like to add this feature to a different branch, please state this in the PR description and we will consider it.
Messages
📖 You might consider squashing your 3 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 e57d7de

Copy link
Contributor

github-actions bot commented Nov 23, 2024

Test Results

 56 files   56 suites   4m 15s ⏱️
 21 tests  21 ✅ 0 💤 0 ❌
134 runs  134 ✅ 0 💤 0 ❌

Results for commit e57d7de.

♻️ This comment has been updated with latest results.

@SuGlider SuGlider changed the title feat(uart): fixes HardwareSerial::updateBaudRate() using a baud rate higher 230400 - checks UART Clock Source feat(uart): [IDF5.1] fixes HardwareSerial::updateBaudRate() using a baud rate higher 230400 - checks UART Clock Source Nov 23, 2024
@me-no-dev me-no-dev added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Nov 25, 2024
@me-no-dev me-no-dev changed the base branch from master to release/v3.0.x November 25, 2024 10:31
@me-no-dev me-no-dev merged commit fd2e31a into release/v3.0.x Nov 25, 2024
56 of 58 checks passed
@me-no-dev me-no-dev deleted the hwserial_update_baudrate_fix_idf_5_1 branch November 25, 2024 11:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Peripheral: UART Status: Pending Merge Pull Request is ready to be merged
Projects
Development

Successfully merging this pull request may close these issues.

(UART): ESP32 - Cannot change baud rate from 230400 to 460800 with Serial.updateBaudRate()
3 participants