aboutsummaryrefslogtreecommitdiff
path: root/docs/flashing.md
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2019-08-24 16:35:11 +0100
committerDrashna Jaelre <drashna@live.com>2019-08-24 08:35:11 -0700
commit51bcadf38cfccc08b287554ab17e21624abf55b8 (patch)
treecf01c2e084befb908b6b4fb7ffa2002e4e4015b5 /docs/flashing.md
parentfb7c65dc34b3001617635e6afd10480f2770522d (diff)
downloadqmk_firmware-51bcadf38cfccc08b287554ab17e21624abf55b8.tar.gz
qmk_firmware-51bcadf38cfccc08b287554ab17e21624abf55b8.zip
Add 'bootloadHID' flash target (#5587)
* Add 'bootloadHID' flash target * Prep for flash target * Add :flash support * Align bootloader wait messages Co-Authored-By: Drashna Jaelre <drashna@live.com> * Update template to suggest use of :flash
Diffstat (limited to 'docs/flashing.md')
-rw-r--r--docs/flashing.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/flashing.md b/docs/flashing.md
index d11dbdf15..b47a5ebf8 100644
--- a/docs/flashing.md
+++ b/docs/flashing.md
@@ -144,6 +144,36 @@ Flashing sequence:
1443. Flash a .hex file 1443. Flash a .hex file
1454. Reset the device into application mode (may be done automatically) 1454. Reset the device into application mode (may be done automatically)
146 146
147## BootloadHID
148
149BootloadHID is a USB bootloader for AVR microcontrollers. The uploader tool requires no kernel level driver on Windows and can therefore be run without installing any DLLs.
150
151To ensure compatibility with the bootloadHID bootloader, make sure this block is present your `rules.mk`:
152
153 # Bootloader
154 # This definition is optional, and if your keyboard supports multiple bootloaders of
155 # different sizes, comment this out, and the correct address will be loaded
156 # automatically (+60). See bootloader.mk for all options.
157 BOOTLOADER = bootloadHID
158
159Compatible flashers:
160
161* [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash) (recommended Windows GUI)
162* [bootloadhid Command Line](https://www.obdev.at/products/vusb/bootloadhid.html) / `:BootloadHID` in QMK (recommended command line)
163
164Flashing sequence:
165
1661. Enter the bootloader using any of the following methods:
167 * Tap the `RESET` keycode (may not work on all devices)
168 * Hold the salt key while plugging the keyboard in (usually documented within keyboard readme)
1692. Wait for the OS to detect the device
1703. Flash a .hex file
1714. Reset the device into application mode (may be done automatically)
172
173or:
174
175 make <keyboard>:<keymap>:bootloadHID
176
147## STM32 177## STM32
148 178
149All STM32 chips come preloaded with a factory bootloader that cannot be modified nor deleted. Some STM32 chips have bootloaders that do not come with USB programming (e.g. STM32F103) but the process is still the same. 179All STM32 chips come preloaded with a factory bootloader that cannot be modified nor deleted. Some STM32 chips have bootloaders that do not come with USB programming (e.g. STM32F103) but the process is still the same.