greatscottgadgets / greatscottgadgets/hackrf
Running `hackrf_cpldjtag` should warn that it is no longer required
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 8.1k
- Forks
- 1.7k
- Avg merge
- 15d 7h
- Merged PRs (30d)
- 1
Description
The documentation notes that running hackrf_cpldjtag to update the CPLD is no longer required since the 2021.03.1 release. However if someone does want to run a custom CPLD bitstream and runs hackrf_cpldjtag to flash it, there is no warning that the bitstream will be silently ignored. This came up in #1140.
We could perhaps remove the hackrf_cpldjtag utility entirely, but it may still be wanted for working with older or customised firmware versions. If it's going to remain though, then it should probably at least print a message to warn that the standard firmware will now override the bitstream written with it.
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 at the hackrf_cpldjtag utility entry point and inspect how it reports successful flashing, then read the firmware/CPLD update documentation referenced in the issue. Done means invoking the utility prints a clear warning that standard firmware overrides the written bitstream while preserving support for older or customised firmware versions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- embedded-iot
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100