Added config, added factory reset functionality

doc/04_macro_system.md

@@ -1,66 +1,87 @@
 # Makro-System
 
-**Dateien:** `config/macro_config.h`, `config/macro_config.cpp`, `CMainController.cpp`
+Dateien:
+
+- `config/macro_config.h`
+- `config/macro_config.cpp`
+- `CMainController.cpp`
 
 ## Datenstruktur
 
 ```cpp
 struct __attribute__((packed)) SMacroStep {
-    uint8_t keycode;    // HID Keyboard Usage (0x00 = leer → Step überspringen)
-    uint8_t modifier;   // HID Modifier: Ctrl=0x01, Shift=0x02, Alt=0x04, GUI=0x08
+    uint8_t keycode;
+    uint8_t modifier;
 };
 
 #define MACRO_SLOTS      32
 #define MACRO_MAX_STEPS   8
 
 struct __attribute__((packed)) SMacroTable {
-    SMacroStep steps[MACRO_SLOTS][MACRO_MAX_STEPS];   // 32 × 8 × 2 = 512 Byte
+    SMacroStep steps[MACRO_SLOTS][MACRO_MAX_STEPS];
 };
 ```
 
-Beide Structs sind `packed` (kein Padding). `sizeof(SMacroTable) == 512 == zwei NVM-Rows`.
+Gesamtgroesse:
 
-## NVM-Speicherort
+- `32 * 8 * 2 = 512` Byte
+- verteilt auf zwei NVM-Rows
+
+## Speicherort
 
 | Row | Adresse | Inhalt |
 |---|---|---|
-| Macro Row 0 | `0x1FB00` | SMacroTable Bytes 0–255 |
-| Macro Row 1 | `0x1FC00` | SMacroTable Bytes 256–511 |
+| Macro Row 0 | `0x1FB00` | Bytes `0..255` |
+| Macro Row 1 | `0x1FC00` | Bytes `256..511` |
 
-Beide Rows sind im Linkerscript reserviert. Gelöschter Flash (`0xFF`-Bytes) → `macro_config_load()` gibt `false` zurück → leere Tabelle (alle Keycodes 0).
+## Slot-Konvention
 
-## Slot-Zuweisung (Konvention, Board speichert blind)
+Das Board speichert die Slots blind, die GUI verwendet dabei diese Zuordnung:
 
-| Slots | Verwendung |
+| Slots | Bedeutung |
 |---|---|
-| 0–19 | MX-Button `mx_idx` (entspricht key_id − 5) |
-| 20–31 | Encoder-Aktionen (`enc * 3 + act_idx`, 0=SW / 1=CW / 2=CCW) |
+| `0..19` | MX-Buttons |
+| `20..31` | Encoder-Aktionen (`enc * 3 + act_idx`) |
 
-## Laden und Speichern
+## Laden
 
-**Laden** (`macro_config_load`):
-- `memcpy` direkt aus Flash-Adresse in RAM-Struct
-- Kein Magic/CRC — leere Tabelle (alle 0xFF) ist ein akzeptabler Zustand
+`macro_config_load()`:
 
-**Speichern** (`macro_config_save`) — gibt `bool` zurück:
-- SMacroTable in `uint8_t aligned_buf[512] __attribute__((aligned(4)))` kopieren (Pflicht!)
-- `NVMCTRL->CTRLB.bit.MANW = 1` (manueller Schreib-Modus)
-- Beide Rows löschen (`nvm_erase_row`) — bei NVM-Timeout: `return false`
-- 8 Pages à 64 Byte schreiben (`nvm_write_page`) — bei NVM-Timeout: `return false`
-- `return true`
+- kopiert 512 Byte aus NVM in `SMacroTable`
+- erkennt komplett geloeschten Flash (`0xFF`) als "noch nie beschrieben"
+- setzt dann eine leere Tabelle
 
-> **Warum aligned_buf?** `nvm_write_page` castet den Pointer zu `volatile uint32_t*`. Wenn `&tbl` nicht 4-Byte-aligned ist (möglich bei packed struct), entsteht ein HardFault auf Cortex-M0+ (kein unaligned 32-Bit-Zugriff auf Peripherie-Adressen).
+Eine leere Tabelle ist also ein gueltiger Default-Zustand.
 
-## Ausführung (in execute_action_down, ActionType::MACRO)
+## Speichern
 
-```
-slot = action.data  (0–31)
-für Step 0–7:
-    if step.keycode == 0: abbrechen
-    HID Key-Down (keycode, modifier)
-    delay(10 ms)
-    HID Key-Up
-    delay(20 ms)
-```
+`macro_config_save()`:
 
-Die Makro-Tabelle liegt nach `setup()` im RAM (`m_macros` in CMainController). Kein NVM-Zugriff während der Ausführung.
+1. Tabelle in einen 4-Byte-aligned Puffer kopieren
+2. beide Rows loeschen
+3. 8 Pages zu je 64 Byte schreiben
+
+Rueckgabewert:
+
+- `true` bei Erfolg
+- `false` bei NVM-Timeout
+
+## Ausfuehrung
+
+Beim Triggern eines Makros:
+
+- Slot aus `action.data`
+- bis zu 8 Steps abarbeiten
+- `keycode == 0` beendet das Makro vorzeitig
+- pro Step:
+  - HID key down
+  - 10 ms warten
+  - HID key up
+  - 20 ms warten
+
+Die Ausfuehrung laeuft aus `m_macros` im RAM, nicht direkt aus NVM.
+
+## Zusammenhang mit Werksreset
+
+Beim Werksreset wird die komplette `SMacroTable` auf 0 gesetzt und in beide Makro-Rows zurueckgeschrieben.
+Danach sind alle 32 Slots leer.