Julian Appel
33d9e85992
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>
33 lines
2 KiB
Markdown
33 lines
2 KiB
Markdown
# VersaMCU – Dokumentationsindex
|
||
|
||
Die Dateien beschreiben den aktuellen Firmware-Stand von Config v3, drei
|
||
Profilen und 32×8 Makros. Bekannte Abweichungen oder noch nicht abgesicherte
|
||
Bereiche stehen ausdrücklich in
|
||
[09_known_limitations.md](09_known_limitations.md).
|
||
|
||
| Datei | Inhalt |
|
||
|---|---|
|
||
| [00_architecture.md](00_architecture.md) | Setup, Work-Loop, Datenfluss, Key-IDs, globale Invarianten |
|
||
| [01_matrix.md](01_matrix.md) | 5x5-Matrixscan, Debounce, Key-ID-Berechnung |
|
||
| [02_encoder.md](02_encoder.md) | Quadratur-Dekodierung, ISR-Pfad, Event-Erzeugung |
|
||
| [03_action_engine.md](03_action_engine.md) | `SAction`, `ActionType`, Hold/Tap-Verhalten, Profilwechsel, Reset-Sonderfall |
|
||
| [04_macro_system.md](04_macro_system.md) | `SMacroTable`, 32 Slots, 8 Steps, NVM-Layout, Ausfuehrung |
|
||
| [05_led_system.md](05_led_system.md) | LED-Schichten, Animationen, Render-Pipeline |
|
||
| [06_nvm_config.md](06_nvm_config.md) | Config v3, 3 Profile, CRC16, Defaults, Werksreset-Bezug |
|
||
| [07_serial_protocol.md](07_serial_protocol.md) | 8-Byte-Protokoll, Config-/Makro-Transfer, ACK/NACK |
|
||
| [08_development.md](08_development.md) | Setup, Build, Einstieg nach Änderungstyp, Verifikation |
|
||
| [09_known_limitations.md](09_known_limitations.md) | Aktuelle technische Einschränkungen und Risiken |
|
||
| [10_usb_bootloader.md](10_usb_bootloader.md) | UF2-Bootloader, Speicherlayout, Tastencheck-Einstieg, USB-Flashweg |
|
||
|
||
Die Repository-weiten Richtlinien und der kompakte LLM-Kontext stehen in
|
||
[`../AGENTS.md`](../AGENTS.md).
|
||
|
||
## Schnellreferenz
|
||
|
||
- aktuelle Config-Groesse: [06_nvm_config.md](06_nvm_config.md)
|
||
- aktuelle Makro-Groesse: [04_macro_system.md](04_macro_system.md)
|
||
- Work-Loop inkl. Werksreset: [00_architecture.md](00_architecture.md)
|
||
- Action-Semantik und HID-Hold: [03_action_engine.md](03_action_engine.md)
|
||
- CDC-Protokoll und Chunk-Zahlen: [07_serial_protocol.md](07_serial_protocol.md)
|
||
- bekannte Risiken vor strukturellen Änderungen: [09_known_limitations.md](09_known_limitations.md)
|
||
- Firmware per USB statt SWD flashen: [10_usb_bootloader.md](10_usb_bootloader.md)
|