diff options
| author | Joel Challis <git@zvecr.com> | 2023-01-15 15:04:32 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-15 15:04:32 +0000 |
| commit | 0730740add19d3afe3d96ead50ba7d29e5dcb109 (patch) | |
| tree | 2831363e9c2bd7d683bc60ce7ba5b32c5ee2302e /docs/flashing.md | |
| parent | a92071494a95175b44a1a3912110c9432f63f3ed (diff) | |
Add mmoskal/uf2-stm32f103 bootloader support (#19594)
Diffstat (limited to 'docs/flashing.md')
| -rw-r--r-- | docs/flashing.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/flashing.md b/docs/flashing.md index b3f055f6cb..a636f19c72 100644 --- a/docs/flashing.md +++ b/docs/flashing.md | |||
| @@ -363,6 +363,47 @@ CLI Flashing sequence: | |||
| 363 | 363 | ||
| 364 | * `:uf2-split-left` and `:uf2-split-right`: Flashes the firmware but also sets the handedness setting in EEPROM by generating a side specific firmware. | 364 | * `:uf2-split-left` and `:uf2-split-right`: Flashes the firmware but also sets the handedness setting in EEPROM by generating a side specific firmware. |
| 365 | 365 | ||
| 366 | ## uf2boot | ||
| 367 | |||
| 368 | Keyboards may opt into supporting the uf2boot bootloader. This is currently only supported on the F103 bluepill. | ||
| 369 | |||
| 370 | The `rules.mk` setting for this bootloader is `uf2boot`, and can be specified at the keymap or user level. | ||
| 371 | |||
| 372 | To ensure compatibility with the uf2boot bootloader, make sure this block is present in your `rules.mk`: | ||
| 373 | |||
| 374 | ```make | ||
| 375 | # Bootloader selection | ||
| 376 | BOOTLOADER = uf2boot | ||
| 377 | ``` | ||
| 378 | |||
| 379 | Compatible flashers: | ||
| 380 | |||
| 381 | * Any application able to copy a file from one place to another, such as _macOS Finder_ or _Windows Explorer_. | ||
| 382 | |||
| 383 | Flashing sequence: | ||
| 384 | |||
| 385 | 1. Enter the bootloader using any of the following methods: | ||
| 386 | * Tap the `QK_BOOT` keycode | ||
| 387 | * Double-tap the `nRST` button on the PCB. | ||
| 388 | 2. Wait for the OS to detect the device | ||
| 389 | 3. Copy the .uf2 file to the new USB disk | ||
| 390 | 4. Wait for the keyboard to become available | ||
| 391 | |||
| 392 | or | ||
| 393 | |||
| 394 | CLI Flashing sequence: | ||
| 395 | |||
| 396 | 1. Enter the bootloader using any of the following methods: | ||
| 397 | * Tap the `QK_BOOT` keycode | ||
| 398 | * Double-tap the `nRST` button on the PCB. | ||
| 399 | 2. Wait for the OS to detect the device | ||
| 400 | 3. Flash via QMK CLI eg. `qmk flash --keyboard handwired/onekey/bluepill_uf2boot --keymap default` | ||
| 401 | 4. Wait for the keyboard to become available | ||
| 402 | |||
| 403 | ### `make` Targets | ||
| 404 | |||
| 405 | * `:uf2-split-left` and `:uf2-split-right`: Flashes the firmware but also sets the handedness setting in EEPROM by generating a side specific firmware. | ||
| 406 | |||
| 366 | ## Raspberry Pi RP2040 UF2 | 407 | ## Raspberry Pi RP2040 UF2 |
| 367 | 408 | ||
| 368 | The `rules.mk` setting for this bootloader is `rp2040`, and can be specified at the keymap or user level. | 409 | The `rules.mk` setting for this bootloader is `rp2040`, and can be specified at the keymap or user level. |
