michele/DigiRadio
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Expand all README files for firmware 0.8.3.

Browse Source 
Align root, Software, and Firmware READMEs with security, CI, web UI, blob policy, and six-band EQ details.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
michele
2026-07-07 07:50:00 +02:00
co-authored by Cursor
parent 8439ec4055
commit 2f9f3ef9b3
5 changed files with 133 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Software/Firmware/README.md
+34 -11
View File
@@ -1,26 +1,49 @@
# DigiRadio — companion-chip firmware assets
Binary and SigmaStudio exports loaded by the ESP32 at every boot.
Binary and SigmaStudio exports loaded by the ESP32 at every boot (fw **0.8.3**).
| Directory | Chip | Contents |
|-----------|------|----------|
| `ADAU1701-Firmware/` | ADAU1701 SigmaDSP | SigmaStudio export (`DigiRadio_IC_1.h`, …) — RAM program |
| `Si4684-Firmware/` | Si4684 DAB+/FM tuner | ROM patch + DAB + FM application images (`.bin`) |
| Directory | Chip | In git? | Loaded by |
|-----------|------|---------|-----------|
| `ADAU1701-Firmware/` | ADAU1701 SigmaDSP | Yes (headers) | `Adau1701Driver` — RAM program every boot |
| `Si4684-Firmware/` | Si4684 DAB+/FM | README only | `Si4684Driver` — HOST_LOAD embedded blobs |
## Si4684 blobs
## Before first device build
Proprietary Skyworks images — **local only**, gitignored (`*.bin`). See
[`Si4684-Firmware/README.md`](Si4684-Firmware/README.md) for procurement and
legal notes. Populate with:
Si4684 application images are **proprietary** and **gitignored**. Populate locally:
```bash
cd Software
python3 tools/fetch_si4684_firmware.py --dab-only
python3 tools/fetch_si4684_firmware.py --si46xx-dir /path/to/si46xx_firmware
python3 tools/check_si4684_blobs.py
ls Firmware/Si4684-Firmware/*.bin # expect 3 files
```
Without blobs, `idf.py build` fails at embed/link time.
Full procurement and legal notes: [`Si4684-Firmware/README.md`](Si4684-Firmware/README.md).
## Si4684 blobs
| File | Role |
|------|------|
| `rom_patch_016.bin` | ROM patch (HOST_LOAD before main image) |
| `dab_firmware.bin` | DAB+ application (PE5PVB / Skyworks) |
| `fm_firmware.bin` | FM application (Skyworks eval or community source) |
Boot sequence: AN649 — POWER_UP → LOAD_INIT → HOST_LOAD(patch) → LOAD_INIT →
HOST_LOAD(image) → BOOT.
## ADAU1701 export
Generated by Analog Devices SigmaStudio for the DigiRadio DSP schematic.
Loaded on every boot (no self-boot EEPROM on this board).
SigmaStudio project **DigiRadio** — exported headers replayed over I2C on every
boot (no self-boot EEPROM). Runtime EQ/mixer/enhancements via safeload and the
Web UI **Audio** tab (`/api/audio/*`).
Details: [`ADAU1701-Firmware/README.md`](ADAU1701-Firmware/README.md) · manual:
`docs/manual/ch-adau1701.tex`, `docs/manual/ch-sigmastudio.tex`.
## Security note
User settings (Wi-Fi, presets, audio profiles) live in **encrypted NVS**, not in
this folder. See `docs/security-flash-nvs.md`.