7
31
Fork
You've already forked blackmagic
23

Feature: Calculate and report real USART baudrate #1864

Merged
ALTracer merged 5 commits from feature/usart_get_baudrate into main 2024年08月24日 03:23:38 +02:00
ALTracer commented 2024年07月13日 11:43:06 +02:00 (Migrated from github.com)
Copy link

Detailed description

  • This is a small new feature.
  • The existing problem is BMP platforms parroting back whatever baudrate you set it to. The discrepancy gets significant at high baudrates, close to Pclk DIV16, effectively ruining communications to other boards +-5% (especially TraceSWO Async which is tuned by an integer(!) divisor off TraceClk).
  • This PR makes TI ICDI and STM32 platforms recompute real baudrate by reading back the programmed USART BRR divisors. It's a function missing from libopencm3 API, but to upstream this there OVER8 support would be required.

As I was compile-testing this, I also noticed some stray hardcoded 0x85 endpoints in ICDI and replaced them with new compile-time macros.
Runtime tested on blackpill-f411ce, swlink-bluepillplus, stlinkv3-minie (f723). I needed this for better TraceSWO Async UART diagnostics, to ensure TraceClk/SWO_PR is close enough to Pclk/BRR. I don't know how to visibly test how this positively affects aux_serial behaviour, I didn't see a difference in minicom, ckermit, tio. Only tio can reach non-standard baudrates because it uses a different API to set them (kinda like orbtrace serialFeeder), minicom can't (it uses B2000000 macros etc.)
Minor problem with this is I don't like that neither BMF nor libopencm3 has guardrails limiting BRR to 16 or more, so I could "set" and "read back" a baudrate equal to Pclk, which does not work.

Your checklist for this pull request

Closing issues

## Detailed description * This is a small new feature. * The existing problem is BMP platforms parroting back whatever baudrate you set it to. The discrepancy gets significant at high baudrates, close to Pclk DIV16, effectively ruining communications to other boards +-5% (especially TraceSWO Async which is tuned by an integer(!) divisor off TraceClk). * This PR makes TI ICDI and STM32 platforms recompute real baudrate by reading back the programmed USART BRR divisors. It's a function missing from libopencm3 API, but to upstream this there OVER8 support would be required. As I was compile-testing this, I also noticed some stray hardcoded 0x85 endpoints in ICDI and replaced them with new compile-time macros. Runtime tested on `blackpill-f411ce`, `swlink`-bluepillplus, stlinkv3-minie (f723). I needed this for better TraceSWO Async UART diagnostics, to ensure TraceClk/SWO_PR is close enough to Pclk/BRR. I don't know how to visibly test how this positively affects aux_serial behaviour, I didn't see a difference in minicom, ckermit, tio. Only tio can reach non-standard baudrates because it uses a different API to set them (kinda like orbtrace serialFeeder), minicom can't (it uses B2000000 macros etc.) Minor problem with this is I don't like that neither BMF nor libopencm3 has guardrails limiting BRR to 16 or more, so I could "set" and "read back" a baudrate equal to Pclk, which does not work. ## Your checklist for this pull request * [x] I've read the [Code of Conduct](https://github.com/blackmagic-debug/blackmagic/blob/main/CODE_OF_CONDUCT.md) * [x] I've read the [guidelines for contributing](https://github.com/blackmagic-debug/blackmagic/blob/main/CONTRIBUTING.md) to this repository * [x] It builds for hardware native (see [Building the firmware](https://github.com/blackmagic-debug/blackmagic?tab=readme-ov-file#building-black-magic-debug-firmware)) * [x] It builds as BMDA (see [Building the BMDA](https://github.com/blackmagic-debug/blackmagic?tab=readme-ov-file#building-black-magic-debug-app)) *and should not affect it* * [x] I've tested it to the best of my ability * [x] My commit messages provide a useful short description of what the commits do ## Closing issues
dragonmux left a comment
Copy link
No description provided.
This all LGTM, so we're happy to merge. Thank you for the contribution!
Sign in to join this conversation.
No reviewers
Labels
Clear labels
BMD App
Black Magic Debug App (aka. PC hosted) (not firmware)
BMP Firmware
Black Magic Probe Firmware (not PC hosted software)
Bug
Confirmed bug
Build system
Build system
Can't reproduce
Maintainers can't reproduce this problem
CI
Continuous Integration System
Contribution wanted
User contributions welcome
Documentation
Project documentation
Draft
Work in progress draft
Duplicate
This issue or pull request already exists
Enhancement
General project improvement
Feedback wanted
Requires additional submitter feedback
Foreign Host Board
Non Native hardware to runing Black Magic firmware on
GDB
Issue/PR related to GDB
Good first issue
Good for newcommers
HwIssue Mitigation
Solving or mitigating a Hardware issue in Software
Information Needed
Maintainers need more information
NativeHardware
Official Black Magic Debug Hardware
New Host Board
New hardware to run Black Magic firmware on
New Target
New debug target
Off Topic
Something that does not involve the project in any way
Potential Bug
A potential, unconfirmed or very special circumstance bug
Regression
Bug caused by a regression
User Interest Needed
More user interest required before consideration
User Testing Needed
Looking for user testing reports
Won't fix
Outside of the project scope or works as intended
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
blackmagic-debug/blackmagic!1864
Reference in a new issue
blackmagic-debug/blackmagic
No description provided.
Delete branch "feature/usart_get_baudrate"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?