summaryrefslogtreecommitdiff
path: root/examples/device/dfu_runtime/README.md
blob: 5709b266c09b808e5a2ff4db404ddc7bf6096510 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# DFU Runtime

A minimal device that exposes a DFU runtime interface, advertising to the host that it can be switched into DFU (bootloader) mode.

## What it does

- Exposes a single DFU runtime interface alongside normal operation.
- On a DFU_DETACH request, it does not actually reboot into a bootloader; instead it speeds up the LED blink as an indicator (this example is intentionally minimal).
- Provides a BOS / Microsoft OS 2.0 descriptor so Windows binds the WinUSB driver.
- LED blink rate indicates bus state (not mounted / mounted / suspended / DFU detach).

## USB Descriptors

| Interface | Class driver |
|-----------|--------------|
| 0 | DFU Runtime |

## Configuration

Notable `tusb_config.h` settings:

```c
#define CFG_TUD_DFU_RUNTIME 1
```

## Building

CMake:

```bash
mkdir build && cd build
cmake -DBOARD=raspberry_pi_pico ..
cmake --build .
```

Make:

```bash
make BOARD=raspberry_pi_pico all
```

## Try it

List the device; it appears in Runtime mode:

```bash
dfu-util -l
```

Request a switch to DFU mode:

```bash
dfu-util -e
```

This sends a DETACH request. Since the example is minimal it does not enter a real bootloader; it instead changes the LED to a fast blink as confirmation.