UartPS interrupt example RX timeout setting is inconsistent with comment
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.2k
- Forks
- 1.1k
- PR merge metrics
- No merged PRs in 30d
Description
According to the comment:
the RX timeout is set to 8 x 4 = 32 character times while according to the SetRecvTimeout documentation it sets it to 4x the specified number of bit times
This will introduce bugs for users using the example as a starting point for their code. (or, maybe the SetRecvTimeout documentation is incorrect and the example is correct; I have not tested actual behavior)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with XilinxProcessorIPLib/drivers/uartps/examples/xuartps_intr_example.c at the RX timeout setting near line 247, then compare it with the SetRecvTimeout API documentation linked in the issue. Verify whether the timeout is measured in character or bit times, and update the example or documentation so the comment and behavior agree.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- embedded-iot
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100