diff options
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: | |||
| 144 | 3. Flash a .hex file | 144 | 3. Flash a .hex file |
| 145 | 4. Reset the device into application mode (may be done automatically) | 145 | 4. Reset the device into application mode (may be done automatically) |
| 146 | 146 | ||
| 147 | ## BootloadHID | ||
| 148 | |||
| 149 | 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. | ||
| 150 | |||
| 151 | To 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 | |||
| 159 | Compatible 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 | |||
| 164 | Flashing sequence: | ||
| 165 | |||
| 166 | 1. 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) | ||
| 169 | 2. Wait for the OS to detect the device | ||
| 170 | 3. Flash a .hex file | ||
| 171 | 4. Reset the device into application mode (may be done automatically) | ||
| 172 | |||
| 173 | or: | ||
| 174 | |||
| 175 | make <keyboard>:<keymap>:bootloadHID | ||
| 176 | |||
| 147 | ## STM32 | 177 | ## STM32 |
| 148 | 178 | ||
| 149 | 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. | 179 | 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. |
