summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2021-04-25 13:40:56 +1000
committerGitHub <noreply@github.com>2021-04-25 13:40:56 +1000
commit891d18d3565090abd5f218a8787acc3e25349b73 (patch)
treea18a24e01c9fa0325d4574e7ff4975021cdaeb84 /docs
parent2a61a500de6fb286cedf644f56d70d05a0b96f0d (diff)
Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (#12600)
* Add support for jumping to tinyuf2 bootloader. Adds blackpill UF2 example. * Update flashing.md * Update chconf.h * Update config.h * Update halconf.h * Update mcuconf.h
Diffstat (limited to 'docs')
-rw-r--r--docs/flashing.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/flashing.md b/docs/flashing.md
index 7804a6bad8..83c97444e1 100644
--- a/docs/flashing.md
+++ b/docs/flashing.md
@@ -249,3 +249,29 @@ Flashing sequence:
2. Wait for the OS to detect the device
3. Flash a .bin file
4. Reset the device into application mode (may be done automatically)
+
+## tinyuf2
+
+Keyboards may opt into supporting the tinyuf2 bootloader. This is currently only supported on the F411 blackpill.
+
+The `rules.mk` setting for this bootloader is `tinyuf2`, and can be specified at the keymap or user level.
+
+To ensure compatibility with the tinyuf2 bootloader, make sure this block is present in your `rules.mk`:
+
+```make
+# Bootloader selection
+BOOTLOADER = tinyuf2
+```
+
+Compatible flashers:
+
+* Any application able to copy a file from one place to another, such as _macOS Finder_ or _Windows Explorer_.
+
+Flashing sequence:
+
+1. Enter the bootloader using any of the following methods:
+ * Tap the `RESET` keycode
+ * Double-tap the `nRST` button on the PCB.
+2. Wait for the OS to detect the device
+3. Copy the .uf2 file to the new USB disk
+4. Wait for the keyboard to become available