HACKRF_DEBUG(1)

💖 HACKRF_DEBUG(1) 💖

okay bestie, come sit with me, because this is the hackrf_debug page from section 1 of the manual and it is so much fun. it's a whole little toolkit for poking at the registers inside your HackRF and honestly? iconic.

---

✨ NAME ✨

hackrf_debug — register manipultion tool 🎀

---

🌸 DESCRIPTION 🌸

this is the tool you use when you wanna read registers, write registers, or just vibe check what the hardware is doing. it talks to several different chips and to the gateware, and you tell it which one you mean with the target flags. let's get into it fr fr.

🦋 Usage:

• -h, --help — prints this help. the classic. the moment you need it most. 💅
• -n, --register <n> — sets the register number that the read/write ops are gonna work on. it's the "which one tho" flag.
• -r, --read — reads the register you picked with the last -n, or if you never gave an -n, it reads all the registers. go off. ✨
• -w, --write <v> — writes the value <v> into the register picked by the last -n argument.
• -c, --config — prints out the SI5351C multisynth configuration information. very "let me see your settings" of it.
• -d, --device <s> — specify a particular device by serial number, so you're not accidentally chatting to the wrong one.
• -m, --max2837 — target MAX2837. 🎯
• -s, --si5351c — target SI5351C. 🎯
• -f, --rffc5072 — target RFFC5072. 🎯
• -g, --gateware — target gateware registers. 🎯
• -P, --fpga <n> — loads the n-th bitstream to the FPGA.
• -1, --p1 <n> — P1 control.
• -2, --p2 <n> — P2 control.
• -C, --clkin <0/1> — CLKIN control (0 for P1_CLKIN, 1 for P22_CLKIN).
• -N, --narrowband <0/1> — narrowband filter disable/enable.
• -S, --state — display M0 state. the M0 state reveal, if you will. 👀
• -T, --tx-underrun-limit <n> — set TX underrun limit in bytes (0 for no limit).
• -R, --rx-overrun-limit <n> — set RX overrun limit in bytes (0 for no limit).
• -u, --ui <1/0> — enable/disable UI.
• -l, --leds <state> — configure LED state (0 for all off, 1 for default).
• -t, --selftest — read self-test report. bestie said "check yourself". 💀
• -o, --rtc-osc — test 32.768kHz RTC oscillator.
• -a, --adc <channel> — read value from an ADC channel. Add 0x80 for alternate pin.

---

🌈 EXAMPLES 🌈

these are the little rituals, do them exactly, no cap:

hackrf_debug --si5351c -n 0 -r
# reads from si5351c register 0

hackrf_debug --si5351c -c
# displays si5351c multisynth configuration

hackrf_debug --rffc5072 -r
# reads all rffc5072 registers

hackrf_debug --max2837 -n 10 -w 22 # writes max2837 register 10 with 22 decimal

hackrf_debug --state               # displays M0 state

---

👑 SEE ALSO 👑

The primary source of documentation is the wiki on github:

https://github.com/mossmann/hackrf/wiki

fr fr, if you're lost, that wiki is your bestie. go read it. 🫶

---

okay that's the whole page, no notes. this one's the hackrf_debug manual page, source hackrf_debug, and it's dated July 2021 — shoutout to that July 2021 era, and yes it's still HACKRF_DEBUG(1) at the bottom of the page, periodt. 💖✨