Fold bootloader documentation into the main doc/ index
Adds doc/10_usb_bootloader.md as the primary reference for the UF2 bootloader (memory layout, key-based boot entry, build/flash steps, hardware test findings, known limitations), following the existing numbered-doc convention. Updates doc/INDEX.md, doc/09_known_limitations.md (bootloader is no longer "not supported", just scoped), and doc/08_development.md accordingly. Removes bootloader/TESTING.md (its findings now live in doc/10_usb_bootloader.md) and trims bootloader/README.md down to what belongs with that subproject specifically: upstream attribution/license and local build/flash commands, plus the OpenOCD manual-flashing warning since that's implementation-specific detail that would clutter the higher-level doc. Updates the top-level README.md (feature table, hardware table, quickstart, project tree, doc links) to reflect USB flashing as a supported path alongside SWD. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
parent
3986d2effe
commit
33d9e85992
7 changed files with 153 additions and 201 deletions
22
README.md
22
README.md
|
|
@ -15,6 +15,7 @@ ATSAMD21G17D mit PlatformIO und dem Arduino-SAMD-Framework.
|
|||
| LEDs | 20 WS2812B mit Base-/Override-Farbe und 7 Animationsmodi |
|
||||
| Persistenz | Config und Makros im internen Flash |
|
||||
| Recovery | Werksreset über zwei Tasten |
|
||||
| Firmware-Update | SWD (Atmel-ICE) oder USB (UF2-Bootloader, `bootloader/`) |
|
||||
|
||||
Die drei Fader-Pins sind im Board-Variant definiert, werden von der aktuellen
|
||||
Firmware aber noch nicht eingelesen.
|
||||
|
|
@ -29,7 +30,7 @@ Firmware aber noch nicht eingelesen.
|
|||
| Encoder | 4× Quadratur über EIC-Interrupts |
|
||||
| LEDs | 20× WS2812B an `PB22` |
|
||||
| USB | Native USB als HID + CDC Composite Device |
|
||||
| Programmer | Atmel-ICE/CMSIS-DAP über SWD, standardmäßig ohne Bootloader |
|
||||
| Programmer | Atmel-ICE/CMSIS-DAP über SWD, oder USB über den UF2-Bootloader |
|
||||
|
||||
## Schnellstart
|
||||
|
||||
|
|
@ -46,9 +47,17 @@ Das Standard-Environment `versapad` baut für `boards/versapad_nobl.json`. Der
|
|||
Upload wird durch `upload_openocd.py` über das von PlatformIO installierte
|
||||
OpenOCD ausgeführt.
|
||||
|
||||
Das in `platformio.ini` auskommentierte Bootloader-Environment ist derzeit
|
||||
nicht als Produktionsziel unterstützt. Details stehen unter
|
||||
[bekannte Einschränkungen](doc/09_known_limitations.md).
|
||||
Alternativ lässt sich die App-Firmware nach einem einmaligen
|
||||
SWD-Bootloader-Flash auch über USB aktualisieren, ganz ohne Atmel-ICE:
|
||||
|
||||
```bash
|
||||
cd bootloader && pio run -e versapad_bootloader --target upload # einmalig
|
||||
pio run -e versapad_usb --target upload # danach jedes App-Update
|
||||
```
|
||||
|
||||
Details, Speicherlayout und die Bootloader-Aktivierung (kein physischer
|
||||
Reset-Taster auf dieser Platine) stehen in
|
||||
[10_usb_bootloader.md](doc/10_usb_bootloader.md).
|
||||
|
||||
## Laufzeitmodell
|
||||
|
||||
|
|
@ -119,9 +128,13 @@ VersaMCU/
|
|||
|-- AGENTS.md # Kontext und Richtlinien für Coding-LLMs
|
||||
|-- README.md
|
||||
|-- platformio.ini
|
||||
|-- upload_openocd.py # SWD-Upload-Hook (env:versapad)
|
||||
|-- uf2conv.py # .bin -> .uf2 Konverter (App-Firmware)
|
||||
|-- upload_uf2.py # USB-Upload-Hook (env:versapad_usb)
|
||||
|-- boards/ # PlatformIO-Boarddefinitionen
|
||||
|-- variants/versapad/ # Pinmapping und Linker-Skripte
|
||||
|-- doc/ # Architektur- und Protokolldokumentation
|
||||
|-- bootloader/ # UF2-Bootloader (eigenes PlatformIO-Projekt)
|
||||
`-- src/
|
||||
|-- main.cpp
|
||||
|-- CMainController.* # Orchestrierung
|
||||
|
|
@ -157,3 +170,4 @@ Binärverträge, Änderungsregeln und die minimale Verifikation.
|
|||
- [CDC-Protokoll](doc/07_serial_protocol.md)
|
||||
- [Entwicklung und Einstieg](doc/08_development.md)
|
||||
- [Bekannte Einschränkungen](doc/09_known_limitations.md)
|
||||
- [USB-Bootloader](doc/10_usb_bootloader.md)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue