diff options
Diffstat (limited to 'docs/flashing.md')
| -rw-r--r-- | docs/flashing.md | 45 |
1 files changed, 38 insertions, 7 deletions
diff --git a/docs/flashing.md b/docs/flashing.md index a61634d215..5b3c1a4447 100644 --- a/docs/flashing.md +++ b/docs/flashing.md @@ -1,12 +1,20 @@ -# Flashing Intrustructions +# Flashing Intrustructions / Bootloader Information There are quite a few different types of bootloaders that keyboards use, and just about all of the use a different flashing method. Luckily, projects like the [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) aim to be compatible with all the different types without having to think about it much, but this article will describe the different types of bootloaders, and available methods for flashing them. +If you have a bootloader selected with the `BOOTLOADER` variable in your `rules.mk`, QMK will automatically calculate if your .hex file is the right size to be flashed to the device, and output the total size it bytes (along with the max). To run this process manually, compile with the target `check-size`, eg `make planck/rev4:default:check-size`. + ## DFU Atmel's DFU bootloader comes on all atmega32u4 chips by default, and is used by many keyboards that have their own ICs on their PCBs (Older OLKB boards, Clueboards). Some keyboards may also use LUFA's DFU bootloader (or QMK's fork) (Newer OLKB boards) that adds in additional features specific to that hardware. -These bootloaders are usually 4096 bytes for the atmega32u4 chip. +To ensure compatability with the DFU bootloader, make sure this block is present your `rules.mk` (optionally with `lufa-dfu` or `qmk-dfu` instead): + + # 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 = atmel-dfu Compatible flashers: @@ -26,15 +34,32 @@ or: make <keyboard>:<keymap>:dfu +### QMK DFU + +QMK has a fork of the LUFA DFU bootloader that allows for a simple matrix scan for exiting the bootloader and returning to the application, as well as flashing an LED/making a ticking noise with a speaker when things are happening. To enable these features, use this block in your `config.h` (The key that exits the bootloader needs to be hooked-up to the INPUT and OUTPUT defined here): + + #define QMK_ESC_OUTPUT F1 // usually COL + #define QMK_ESC_INPUT D5 // usually ROW + #define QMK_LED E6 + #define QMK_SPEAKER C6 + +The Manufacturer and Product names are automatically pulled from your `config.h`, and "Bootloader" is added to the product. + +To generate this bootloader, use the `bootloader` target, eg `make planck/rev4:default:bootloader`. + +To generate a production-ready .hex file (containing the application and the bootloader), use the `production` target, eg `make planck/rev4:default:production`. + ## Caterina Arduino boards and their clones use the [Caterina bootloader](https://github.com/arduino/Arduino/tree/master/hardware/arduino/avr/bootloaders/caterina) (any keyboard built with a Pro Micro, or clone), and uses the avr109 protocol to communicate through virtual serial. Bootloaders like [A-Star](https://www.pololu.com/docs/0J61/9) are based on Caterina. -This block of code allows for Caterina compatibility in QMK: +To ensure compatability with the Caterina bootloader, make sure this block is present your `rules.mk`: - #define CATERINA_BOOTLOADER - -These bootloaders are usually 4096 bytes for the atmega32u4 chip. + # 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 = caterina Compatible flashers: @@ -57,7 +82,13 @@ or Halfkay is a super-slim protocol developed by PJRC that uses HID, and come on all Teensys (namely the 2.0). -This bootloader is 512 bytes. +To ensure compatability with the Halfkay 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 = halfkay Compatible flashers: |