[uart] Document that TX and RX should be disabled when configuring loopbacks
Open
Component:Doc
IP:uart
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
### Description
I ran into a lot of trouble when testing the UART loopbacks because phantom bytes would appear if loopbacks were configured when TX and RX were still enabled. The problem was something to do with the TX and RX lines not being pinmuxed and therefore not being pulled high (idle). When the TX and RX were connected, this low signal became a `START` bit and an `0xff` byte appeared.
It's a user error to expect the UART to work before the lines are pinmuxed, but the loopback shouldn't need those lines so it was unexpected to me. We should document this to prevent others making the same mistake.
Opening this issue so I don't forget again.
Contributor guide
Assessment
This issue has not been assessed yet.