add mermaid diagrams

Author: TeoMahnic

flow-chart.md

@@ -1,7 +1,7 @@
 # Sequence diagrams for pyOCD sub-commands
 
 ## Erase
-- Sessions starts
+<!-- - Sessions starts
   - Set Debug enable
 - Discovery phase:
   - Use selected connect mode (normal, pre-reset, under reset)
@@ -22,11 +22,51 @@
 - Clean-up phase:
   - Put all cores in deadloops
 - Session ends:
-  - Remove Debug enable on device
+  - Remove Debug enable on device -->
+
+```mermaid
+flowchart TD
+  %% ERASE
+  A0([Session starts]) --> A1[Set Debug enable]
+
+  subgraph A_DISC[Discovery phase]
+    direction TB
+    A2[Select connect: mode normal , pre-reset , under-reset] --> A3{Debug sequence needed?}
+    A3 -- Yes --> A4[Execute debug sequence]
+    A3 -- No --> A5[Continue]
+  end
+  A1 --> A_DISC
+
+  subgraph A_ERASE[Erase phase]
+    direction TB
+    A6[Halt all cores] --> A7[Set vector catch on all cores]
+    A7 --> A8[Reset device using reset_type - primary core]
+    A8 --> A9[Clear vector catch on all cores]
+    A9 --> A10[Collect memory regions to erase]
+    A10 --> A11{Algorithms executable on primary core?}
+    A11 -- Yes --> A12{Erase mode?}
+    A11 -- No --> A15[Switch to required core and perform erase]
+    A15 --> A12
+    A12 -- Chip erase --> A13[Run chipErase else fall back to sector erase]
+    A12 -- Sector erase --> A14[Collect sectors and erase]
+    A13 --> A16[Erase successful]
+    A14 --> A16
+  end
+  A_DISC --> A_ERASE
+
+  subgraph A_CLEAN[Clean-up phase]
+    direction TB
+    A17[Put all cores in deadloops]
+  end
+  A_ERASE --> A_CLEAN
+
+  A18([Session ends]) --> A19[Remove Debug enable]
+  A_CLEAN --> A18
+```
 
 
 ## Load
-- Session starts
+<!-- - Session starts
   - Set Debug enable
 - Discovery phase:
   - Use selected connect mode (normal, pre-reset, under-reset)
@@ -50,11 +90,53 @@
     - Clean-up phase:
       - Put all cores in deadloops
   - Session ends:
-    - Remove Debug enable on device
+    - Remove Debug enable on device -->
+
+```mermaid
+flowchart TD
+  %% LOAD
+  B0([Session starts]) --> B1[Set Debug enable]
+
+  subgraph B_DISC[Discovery phase]
+    direction TB
+    B2[Select connect mode: normal, pre-reset, under-reset] --> B3{Debug sequence needed?}
+    B3 -- Yes --> B4[Execute debug sequence]
+    B3 -- No --> B5[Continue]
+  end
+  B1 --> B_DISC
 
+  subgraph B_FLASH[Flash phase]
+    direction TB
+    B6[Halt all cores] --> B7[Set vector catch on all cores]
+    B7 --> B8[Reset device using reset_type - primary core]
+    B8 --> B9[Clear vector catch on all cores]
+    B9 --> B10[Collect memory regions to program]
+    B10 --> B11{Algorithm usable on primary core?}
+    B11 -- Yes --> B12[Flash application]
+    B11 -- No --> B13[Switch to required core]
+    B12 --> B14[Flash successful]
+    B13 --> B12
+
+    B14 --> B15{Optional post-flash reset?}
+    B15 -- Yes --> B16[Set vector catch on all cores]
+    B16 --> B17[Hardware reset device]
+    B17 --> B18[Clear vector catch on all cores]
+    B15 -- No --> B19[Skip]
+  end
+  B_DISC --> B_FLASH
+
+  subgraph B_CLEAN[Clean-up phase]
+    direction TB
+    B20[Put all cores in deadloops]
+  end
+  B_FLASH --> B_CLEAN
+
+  B21([Session ends]) --> B22[Remove Debug enable]
+  B_CLEAN --> B21
+```
 
 ## GDBServer
-- Session start
+<!-- - Session start
   - Set Debug enable
 - Discovery phase:
   - Use selected connect mode (normal, pre-reset, under-reset)
@@ -68,4 +150,35 @@
   - Execute GDB init commands (monitor reset halt)
   - Debug..
 - Debug session ends
-  - Remove Debug enable on device
+  - Remove Debug enable on device -->
+
+```mermaid
+flowchart TD
+  %% GDBSERVER
+  C0([Session starts]) --> C1[Set Debug enable]
+
+  subgraph C_DISC[Discovery phase]
+    direction TB
+    C2[Select connect mode: normal, pre-reset, under-reset] --> C3{Debug sequence needed?}
+    C3 -- Yes --> C4[Execute debug sequence]
+    C3 -- No --> C5[Continue]
+  end
+  C1 --> C_DISC
+
+  subgraph C_GDB[GDB phase]
+    direction TB
+    C6[Halt all cores] --> C7[Create GDB servers for all cores]
+    C7 --> C8{reset-run option?}
+    C8 -- Yes --> C9[Reset device using reset_type - primary core]
+    C8 -- No --> C10[Skip reset]
+    C9 --> C11[Wait for GDB client]
+    C10 --> C11
+    C11 --> C12[Client connected]
+    C12 --> C13[Run GDB init commands - e.g., monitor reset halt]
+    C13 --> C14[Debugging in progress]
+  end
+  C_DISC --> C_GDB
+
+  C15([Debug session ends]) --> C16[Remove Debug enable]
+  C_GDB --> C15
+```