diff options
| author | Joel Challis <git@zvecr.com> | 2019-08-24 16:35:11 +0100 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2019-08-24 08:35:11 -0700 |
| commit | 51bcadf38cfccc08b287554ab17e21624abf55b8 (patch) | |
| tree | cf01c2e084befb908b6b4fb7ffa2002e4e4015b5 /docs/flashing.md | |
| parent | fb7c65dc34b3001617635e6afd10480f2770522d (diff) | |
| download | firmware-51bcadf38cfccc08b287554ab17e21624abf55b8.tar.gz firmware-51bcadf38cfccc08b287554ab17e21624abf55b8.tar.bz2 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.md | 30 |
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: 3. Flash a .hex file 4. Reset the device into application mode (may be done automatically) +## BootloadHID + +BootloadHID 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. + +To ensure compatibility with the bootloadHID bootloader, make sure this block is present your `rules.mk`: + + # Bootloader + # This definition is optional, and if your keyboard supports multiple bootloaders of + # different sizes, comment this out, and the correct address will be loaded + # automatically (+60). See bootloader.mk for all options. + BOOTLOADER = bootloadHID + +Compatible flashers: + +* [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash) (recommended Windows GUI) +* [bootloadhid Command Line](https://www.obdev.at/products/vusb/bootloadhid.html) / `:BootloadHID` in QMK (recommended command line) + +Flashing sequence: + +1. Enter the bootloader using any of the following methods: + * Tap the `RESET` keycode (may not work on all devices) + * Hold the salt key while plugging the keyboard in (usually documented within keyboard readme) +2. Wait for the OS to detect the device +3. Flash a .hex file +4. Reset the device into application mode (may be done automatically) + +or: + + make <keyboard>:<keymap>:bootloadHID + ## STM32 All 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. |