diff options
Diffstat (limited to 'docs/flashing.md')
-rw-r--r-- | docs/flashing.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/flashing.md b/docs/flashing.md index 7804a6bad..83c97444e 100644 --- a/docs/flashing.md +++ b/docs/flashing.md | |||
@@ -249,3 +249,29 @@ Flashing sequence: | |||
249 | 2. Wait for the OS to detect the device | 249 | 2. Wait for the OS to detect the device |
250 | 3. Flash a .bin file | 250 | 3. Flash a .bin file |
251 | 4. Reset the device into application mode (may be done automatically) | 251 | 4. Reset the device into application mode (may be done automatically) |
252 | |||
253 | ## tinyuf2 | ||
254 | |||
255 | Keyboards may opt into supporting the tinyuf2 bootloader. This is currently only supported on the F411 blackpill. | ||
256 | |||
257 | The `rules.mk` setting for this bootloader is `tinyuf2`, and can be specified at the keymap or user level. | ||
258 | |||
259 | To ensure compatibility with the tinyuf2 bootloader, make sure this block is present in your `rules.mk`: | ||
260 | |||
261 | ```make | ||
262 | # Bootloader selection | ||
263 | BOOTLOADER = tinyuf2 | ||
264 | ``` | ||
265 | |||
266 | Compatible flashers: | ||
267 | |||
268 | * Any application able to copy a file from one place to another, such as _macOS Finder_ or _Windows Explorer_. | ||
269 | |||
270 | Flashing sequence: | ||
271 | |||
272 | 1. Enter the bootloader using any of the following methods: | ||
273 | * Tap the `RESET` keycode | ||
274 | * Double-tap the `nRST` button on the PCB. | ||
275 | 2. Wait for the OS to detect the device | ||
276 | 3. Copy the .uf2 file to the new USB disk | ||
277 | 4. Wait for the keyboard to become available | ||