# arm-software/cmsis-dap architecture

> Architecture diagram of the GitHub repository arm-software/cmsis-dap, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/arm-software/cmsis-dap
- Repository: https://github.com/arm-software/cmsis-dap

## Overview

CMSIS-DAP is a protocol specification and embedded firmware for standardized debugger access to an Arm CoreSight Debug Access Port. The principal workflow is a debugger sending USB packets to a firmware transport, which signals the DAP runtime to interpret commands and perform SWD or JTAG operations against a target; responses return through the transport. The firmware also supports SWO trace and UART-related functionality, and the repository documents firmware adaptation and USB commands. Some runtime dispatch and peripheral wiring is not visible in the excerpts, so those links are omitted.

Main entry points: [`Firmware/Source/DAP.c`](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Source/DAP.c) (DAP command engine), [`Firmware/Config/DAP_config.h`](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Config/DAP_config.h) (Board configuration), [`Firmware/Template/MDK5/main.c`](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Template/MDK5/main.c) (Firmware startup), [`Firmware/Template/MDK5/USBD_User_HID_0.c`](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Template/MDK5/USBD_User_HID_0.c) (USB HID transport)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_usb["USB transports"]
  node_hid["USB HID transport<br/>[USBD_User_HID_0.c]"]
  node_custom["USB custom transport"]
  node_cdc["CDC UART bridge"]
end

subgraph group_runtime["DAP runtime"]
  node_main["Firmware startup<br/>[main.c]"]
  node_objects["RTOS objects<br/>[osObjects.h]"]
  node_engine["DAP command engine<br/>[DAP.c]"]
  node_api["DAP protocol API<br/>[DAP.h]"]
  node_config["Board configuration<br/>[DAP_config.h]"]
  node_vendor["Vendor commands<br/>[DAP_vendor.c]"]
end

subgraph group_debug["Debug interfaces"]
  node_swd["SWD operations<br/>[SW_DP.c]"]
  node_jtag["JTAG operations<br/>[JTAG_DP.c]"]
  node_target(("Debug target"))
end

subgraph group_trace["Trace and UART"]
  node_swo["SWO capture<br/>[SWO.c]"]
  node_uart["UART services<br/>[UART.c]"]
end

subgraph group_reference["Protocol reference"]
  node_docs["Protocol and adaptation docs<br/>[mainpage.md]"]
end

node_debugger(("Debugger host"))

node_debugger -->|"sends packets"| node_hid
node_debugger -->|"sends packets"| node_custom
node_debugger -->|"sends UART data"| node_cdc
node_main -->|"starts thread"| node_engine
node_main -->|"starts thread"| node_swo
node_objects -->|"declares threads"| node_main
node_hid -->|"signals requests"| node_engine
node_custom -->|"signals requests"| node_engine
node_engine -->|"calls transfers"| node_swd
node_engine -->|"calls transfers"| node_jtag
node_swd -.->|"accesses target"| node_target
node_jtag -.->|"accesses target"| node_target
node_engine -->|"uses commands"| node_api
node_engine -->|"uses settings"| node_config
node_vendor -->|"uses command IDs"| node_api
node_swo -->|"uses settings"| node_config
node_uart -->|"uses settings"| node_config
node_cdc -->|"uses settings"| node_config
node_docs -.->|"describes protocol"| node_debugger

click node_hid "https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Template/MDK5/USBD_User_HID_0.c"
click node_custom "https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Template/MDK5/USBD_User_CustomClass_0.c"
click node_cdc "https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Template/MDK5/USBD_User_CDC_ACM_UART_0.c"
click node_main "https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Template/MDK5/main.c"
click node_objects "https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Template/MDK5/osObjects.h"
click node_engine "https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Source/DAP.c"
click node_api "https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Include/DAP.h"
click node_config "https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Config/DAP_config.h"
click node_vendor "https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Source/DAP_vendor.c"
click node_swd "https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Source/SW_DP.c"
click node_jtag "https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Source/JTAG_DP.c"
click node_swo "https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Source/SWO.c"
click node_uart "https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Source/UART.c"
click node_docs "https://github.com/arm-software/cmsis-dap/blob/main/Documentation/Doxygen/src/mainpage.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_hid,node_custom,node_cdc toneBlue
class node_main,node_objects,node_engine,node_api,node_config,node_vendor toneAmber
class node_swd,node_jtag,node_target toneMint
class node_swo,node_uart toneRose
class node_docs,node_debugger toneIndigo
```

## Components

### USB transports

- [USB HID transport](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Template/MDK5/USBD_User_HID_0.c): `Firmware/Template/MDK5/USBD_User_HID_0.c`
- [USB custom transport](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Template/MDK5/USBD_User_CustomClass_0.c): `Firmware/Template/MDK5/USBD_User_CustomClass_0.c`
- [CDC UART bridge](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Template/MDK5/USBD_User_CDC_ACM_UART_0.c): `Firmware/Template/MDK5/USBD_User_CDC_ACM_UART_0.c`

### DAP runtime

- [Firmware startup](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Template/MDK5/main.c): `Firmware/Template/MDK5/main.c`
- [RTOS objects](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Template/MDK5/osObjects.h): `Firmware/Template/MDK5/osObjects.h`
- [DAP command engine](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Source/DAP.c): `Firmware/Source/DAP.c`
- [DAP protocol API](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Include/DAP.h): `Firmware/Include/DAP.h`
- [Board configuration](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Config/DAP_config.h): `Firmware/Config/DAP_config.h`
- [Vendor commands](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Source/DAP_vendor.c): `Firmware/Source/DAP_vendor.c`

### Debug interfaces

- [SWD operations](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Source/SW_DP.c): `Firmware/Source/SW_DP.c`
- [JTAG operations](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Source/JTAG_DP.c): `Firmware/Source/JTAG_DP.c`
- **Debug target**

### Trace and UART

- [SWO capture](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Source/SWO.c): `Firmware/Source/SWO.c`
- [UART services](https://github.com/arm-software/cmsis-dap/blob/main/Firmware/Source/UART.c): `Firmware/Source/UART.c`

### Protocol reference

- [Protocol and adaptation docs](https://github.com/arm-software/cmsis-dap/blob/main/Documentation/Doxygen/src/mainpage.md): `Documentation/Doxygen/src/mainpage.md`

### Other components

- **Debugger host**

## Connections

- Debugger host → USB HID transport: sends packets (evidence: `Firmware/Template/MDK5/USBD_User_HID_0.c`)
- Debugger host → USB custom transport: sends packets (evidence: `Firmware/Template/MDK5/USBD_User_CustomClass_0.c`)
- Debugger host → CDC UART bridge: sends UART data (evidence: `Firmware/Template/MDK5/USBD_User_CDC_ACM_UART_0.c`)
- Firmware startup → DAP command engine: starts thread (evidence: `Firmware/Template/MDK5/main.c`)
- Firmware startup → SWO capture: starts thread (evidence: `Firmware/Template/MDK5/main.c`)
- RTOS objects → Firmware startup: declares threads (evidence: `Firmware/Template/MDK5/main.c`)
- USB HID transport → DAP command engine: signals requests (evidence: `Firmware/Template/MDK5/USBD_User_HID_0.c`)
- USB custom transport → DAP command engine: signals requests (evidence: `Firmware/Template/MDK5/USBD_User_CustomClass_0.c`)
- DAP command engine → SWD operations: calls transfers (evidence: `Firmware/Source/DAP.c`)
- DAP command engine → JTAG operations: calls transfers (evidence: `Firmware/Source/DAP.c`)
- SWD operations → Debug target: accesses target
- JTAG operations → Debug target: accesses target
- DAP command engine → DAP protocol API: uses commands (evidence: `Firmware/Source/DAP.c`)
- DAP command engine → Board configuration: uses settings (evidence: `Firmware/Source/DAP.c`)
- Vendor commands → DAP protocol API: uses command IDs (evidence: `Firmware/Source/DAP_vendor.c`)
- SWO capture → Board configuration: uses settings (evidence: `Firmware/Source/SWO.c`)
- UART services → Board configuration: uses settings (evidence: `Firmware/Source/UART.c`)
- CDC UART bridge → Board configuration: uses settings (evidence: `Firmware/Template/MDK5/USBD_User_CDC_ACM_UART_0.c`)
- Protocol and adaptation docs → Debugger host: describes protocol
