2017-12-09 06:36:32 +01:00
# Flashing Instructions and Bootloader Information
2017-10-29 23:36:38 +01:00
2021-01-20 04:04:21 +01:00
There are quite a few different types of bootloaders that keyboards use, and almost all of them use their own flashing method and tools. Luckily, projects like the [QMK Toolbox ](https://github.com/qmk/qmk_toolbox/releases ) aim to support as many of them as possible, but this article will describe the different types of bootloaders, and available methods for flashing them.
2017-10-29 23:36:38 +01:00
2021-01-20 04:04:21 +01:00
For AVR-based keyboards, QMK will automatically calculate if your `.hex` file is the right size to be flashed to the device based on the `BOOTLOADER` value set in `rules.mk` , and output the total size in bytes (along with the max).
2017-11-28 05:08:21 +01:00
2021-01-20 04:04:21 +01:00
You will also be able to use the CLI to flash your keyboard, by running:
```
$ qmk flash -kb < keyboard > -km < keymap >
```
See the [`qmk flash` ](cli_commands.md#qmk-flash ) documentation for more information.
2017-10-29 23:36:38 +01:00
2021-01-20 04:04:21 +01:00
## Atmel DFU
2017-10-29 23:36:38 +01:00
2021-01-20 04:04:21 +01:00
Atmel's DFU bootloader comes on all USB AVRs by default (except for 16/32U4RC), 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 of it (newer OLKB boards), that adds in additional features specific to that hardware.
To ensure compatibility with the DFU bootloader, make sure this block is present in your `rules.mk` (optionally with `lufa-dfu` or `qmk-dfu` instead):
2017-11-28 05:08:21 +01:00
2019-09-21 07:06:32 +02:00
```make
# Bootloader selection
BOOTLOADER = atmel-dfu
```
2017-10-29 23:36:38 +01:00
Compatible flashers:
* [QMK Toolbox ](https://github.com/qmk/qmk_toolbox/releases ) (recommended GUI)
2021-01-20 04:04:21 +01:00
* [dfu-programmer ](https://github.com/dfu-programmer/dfu-programmer ) / `:dfu` target in QMK (recommended command line)
2017-10-29 23:36:38 +01:00
Flashing sequence:
2021-01-20 04:04:21 +01:00
1. Enter the bootloader using any of the following methods:
* Press the `RESET` keycode
* Press the `RESET` button on the PCB if available
* Short RST to GND quickly
2017-10-29 23:36:38 +01:00
2. Wait for the OS to detect the device
2021-01-20 04:04:21 +01:00
3. Erase the flash memory (will be done automatically if using the Toolbox or CLI/`make` command)
2017-10-29 23:36:38 +01:00
4. Flash a .hex file
2021-01-20 04:04:21 +01:00
5. Reset the device into application mode (will be done automatically as above)
2017-10-29 23:36:38 +01:00
2017-11-28 05:08:21 +01:00
### QMK DFU
2021-01-20 04:04:21 +01:00
QMK maintains [a fork of the LUFA DFU bootloader ](https://github.com/qmk/lufa/tree/master/Bootloaders/DFU ) that additionally performs 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, add the following defines to your `config.h` :
2017-11-28 05:08:21 +01:00
2021-01-20 04:04:21 +01:00
```c
#define QMK_ESC_OUTPUT F1 // COL pin if COL2ROW
#define QMK_ESC_INPUT D5 // ROW pin if COL2ROW
// Optional:
//#define QMK_LED E6
//#define QMK_SPEAKER C6
```
Currently we do not recommend making `QMK_ESC` the same key as the one designated for [Bootmagic Lite ](feature_bootmagic.md#bootmagic-lite ), as holding it down will cause the MCU to loop back and forth between entering and exiting the bootloader.
2017-11-28 05:08:21 +01:00
2021-01-20 04:04:21 +01:00
The manufacturer and product strings are automatically pulled from `config.h` , with " Bootloader" appended to the product string.
2017-11-28 05:08:21 +01:00
2021-01-20 04:04:21 +01:00
To generate this bootloader, use the `bootloader` target, eg. `make planck/rev4:default:bootloader` . To generate a production-ready .hex file (combining QMK and the bootloader), use the `production` target, eg. `make planck/rev4:default:production` .
2019-03-18 22:22:02 +01:00
2021-01-20 04:04:21 +01:00
### `make` Targets
2019-03-18 22:22:02 +01:00
2021-01-20 04:04:21 +01:00
* `:dfu` : Checks every 5 seconds until a DFU device is available, and then flashes the firmware.
* `:dfu-split-left` and `:dfu-split-right` : Flashes the firmware as with `:dfu` , but also sets the handedness setting in EEPROM. This is ideal for Elite-C-based split keyboards.
2019-03-18 22:22:02 +01:00
2017-10-29 23:36:38 +01:00
## Caterina
2021-01-20 04:04:21 +01:00
Arduino boards and their clones use the [Caterina bootloader ](https://github.com/arduino/ArduinoCore-avr/tree/master/bootloaders/caterina ) or a variant of it (any keyboard built with a Pro Micro or clone, and the Pololu A-Star), and uses the AVR109 protocol to communicate through virtual serial.
2017-10-29 23:36:38 +01:00
2021-01-20 04:04:21 +01:00
To ensure compatibility with the Caterina bootloader, make sure this block is present in your `rules.mk` :
2017-10-29 23:36:38 +01:00
2019-09-21 07:06:32 +02:00
```make
# Bootloader selection
BOOTLOADER = caterina
```
2017-10-29 23:36:38 +01:00
Compatible flashers:
* [QMK Toolbox ](https://github.com/qmk/qmk_toolbox/releases ) (recommended GUI)
2021-01-30 12:00:56 +01:00
* [avrdude ](https://www.nongnu.org/avrdude/ ) with the `avr109` programmer / `:avrdude` target in QMK (recommended command line)
2017-10-29 23:36:38 +01:00
* [AVRDUDESS ](https://github.com/zkemble/AVRDUDESS )
Flashing sequence:
2021-01-20 04:04:21 +01:00
1. Enter the bootloader using any of the following methods (you only have 7 seconds to flash once it enters; some variants may require you to reset twice within 750 milliseconds):
* Press the `RESET` keycode
* Press the `RESET` button on the PCB if available
* Short RST to GND quickly
2017-10-29 23:36:38 +01:00
2. Wait for the OS to detect the device
2018-11-03 18:08:05 +01:00
3. Flash a .hex file
4. Wait for the device to reset automatically
2017-10-29 23:36:38 +01:00
2021-01-20 04:04:21 +01:00
### `make` Targets
2018-09-28 04:02:12 +02:00
2021-01-20 04:04:21 +01:00
* `:avrdude` : Checks every 5 seconds until a Caterina device is available (by detecting a new COM port), and then flashes the firmware.
* `:avrdude-loop` : Flashes the firmware as with `:avrdude` , but after each device is flashed, will attempt to flash again. This is useful for bulk flashing. Hit Ctrl+C to escape the loop.
* `:avrdude-split-left` and `:avrdude-split-right` : Flashes the firmware as with `:avrdude` , but also sets the handedness setting in EEPROM. This is ideal for Pro Micro-based split keyboards.
2018-09-28 04:02:12 +02:00
2021-01-20 04:04:21 +01:00
## HalfKay
2019-03-18 22:22:02 +01:00
2021-01-20 04:04:21 +01:00
HalfKay is a super-slim bootloader developed by PJRC that presents itself as an HID device (which requires no additional driver), and comes preflashed on all Teensys, namely the 2.0. It is currently closed-source, and thus once overwritten (eg. via ISP flashing another bootloader), cannot be restored.
2017-10-29 23:36:38 +01:00
2021-01-20 04:04:21 +01:00
To ensure compatibility with the Halfkay bootloader, make sure this block is present in your `rules.mk` :
2017-11-28 05:08:21 +01:00
2019-09-21 07:06:32 +02:00
```make
# Bootloader selection
BOOTLOADER = halfkay
```
2017-10-29 23:36:38 +01:00
Compatible flashers:
* [QMK Toolbox ](https://github.com/qmk/qmk_toolbox/releases ) (recommended GUI)
2021-01-20 04:04:21 +01:00
* [Teensy Loader Command Line ](https://www.pjrc.com/teensy/loader_cli.html ) / `:teensy` target in QMK (recommended command line)
2017-10-29 23:36:38 +01:00
* [Teensy Loader ](https://www.pjrc.com/teensy/loader.html )
Flashing sequence:
2021-01-20 04:04:21 +01:00
1. Enter the bootloader using any of the following methods (you only have 7 seconds to flash once it enters):
* Press the `RESET` keycode
* Press the `RESET` button on the Teensy or PCB if available
* short RST to GND quickly
2017-10-29 23:36:38 +01:00
2. Wait for the OS to detect the device
2019-07-16 04:11:59 +02:00
3. Flash a .hex file
4. Reset the device into application mode (may be done automatically)
## USBasploader
2021-01-20 04:04:21 +01:00
USBasploader is a bootloader originally by [Objective Development ](https://www.obdev.at/products/vusb/usbasploader.html ). It emulates a USBasp ISP programmer and is used in some non-USB AVR chips such as the ATmega328P, which run V-USB.
2019-07-16 04:11:59 +02:00
To ensure compatibility with the USBasploader bootloader, make sure this block is present in your `rules.mk` :
2019-09-21 07:06:32 +02:00
```make
# Bootloader selection
BOOTLOADER = USBasp
```
2019-07-16 04:11:59 +02:00
Compatible flashers:
* [QMK Toolbox ](https://github.com/qmk/qmk_toolbox/releases ) (recommended GUI)
2021-01-30 12:00:56 +01:00
* [avrdude ](https://www.nongnu.org/avrdude/ ) with the `usbasp` programmer / `:usbasp` target in QMK (recommended command line)
2019-07-16 04:11:59 +02:00
* [AVRDUDESS ](https://github.com/zkemble/AVRDUDESS )
Flashing sequence:
2021-01-20 04:04:21 +01:00
1. Enter the bootloader using any of the following methods:
* Press the `RESET` keycode
* Keep the `BOOT` button held while quickly tapping the `RESET` button on the PCB
2019-07-16 04:11:59 +02:00
2. Wait for the OS to detect the device
2018-11-03 18:08:05 +01:00
3. Flash a .hex file
2021-01-20 04:04:21 +01:00
4. Press the `RESET` button on the PCB or short RST to GND
2018-11-03 18:08:05 +01:00
2019-08-24 17:35:11 +02:00
## BootloadHID
2021-01-20 04:04:21 +01:00
BootloadHID is a USB bootloader for AVR microcontrollers. It presents itself as an HID input device, much like HalfKay, and can therefore be run without installing any driver on Windows.
2019-08-24 17:35:11 +02:00
2021-01-20 04:04:21 +01:00
To ensure compatibility with the bootloadHID bootloader, make sure this block is present in your `rules.mk` :
2019-08-24 17:35:11 +02:00
2019-09-21 07:06:32 +02:00
```make
# Bootloader selection
BOOTLOADER = bootloadHID
```
2019-08-24 17:35:11 +02:00
Compatible flashers:
2021-01-20 04:04:21 +01:00
* [QMK Toolbox ](https://github.com/qmk/qmk_toolbox/releases ) (recommended GUI)
* [bootloadHID CLI ](https://www.obdev.at/products/vusb/bootloadhid.html ) / `:bootloadHID` target in QMK (recommended command line)
* [HIDBootFlash ](http://vusb.wikidot.com/project:hidbootflash )
2019-08-24 17:35:11 +02:00
Flashing sequence:
1. Enter the bootloader using any of the following methods:
2021-01-20 04:04:21 +01:00
* Tap the `RESET` keycode
* Hold the salt key while plugging the keyboard in - for PS2AVRGB boards, this is usually the key connected to MCU pins A0 and B0, otherwise it will be documented in your keyboard's readme
2019-08-24 17:35:11 +02:00
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)
2021-01-20 04:04:21 +01:00
## STM32/APM32 DFU
2019-08-24 17:35:11 +02:00
2021-01-20 04:04:21 +01:00
All STM32 and APM32 MCUs, except for F103 (see the [STM32duino section ](#stm32duino )) come preloaded with a factory bootloader that cannot be modified nor deleted.
2019-08-24 17:35:11 +02:00
2021-01-20 04:04:21 +01:00
To ensure compatibility with the STM32-DFU bootloader, make sure this block is present in your `rules.mk` (optionally with `apm32-dfu` instead):
2018-11-03 18:08:05 +01:00
2021-01-20 04:04:21 +01:00
```make
# Bootloader selection
BOOTLOADER = stm32-dfu
```
2018-11-03 18:08:05 +01:00
Compatible flashers:
* [QMK Toolbox ](https://github.com/qmk/qmk_toolbox/releases ) (recommended GUI)
2021-01-30 12:00:56 +01:00
* [dfu-util ](https://dfu-util.sourceforge.net/ ) / `:dfu-util` target in QMK (recommended command line)
2018-11-03 18:08:05 +01:00
Flashing sequence:
1. Enter the bootloader using any of the following methods:
* Tap the `RESET` keycode (may not work on STM32F042 devices)
2021-01-20 04:04:21 +01:00
* If a reset circuit is present, tap the `RESET` button on the PCB; some boards may also have a toggle switch that must be flipped
* Otherwise, you need to bridge `BOOT0` to VCC (via `BOOT0` button or jumper), short `RESET` to GND (via `RESET` button or jumper), and then let go of the `BOOT0` bridge
2018-11-03 18:08:05 +01:00
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)
2019-03-18 22:22:02 +01:00
2021-01-20 04:04:21 +01:00
### `make` Targets
* `:dfu-util` : Waits until an STM32 bootloader device is available, and then flashes the firmware.
* `:dfu-util-split-left` and `:dfu-util-split-right` : Flashes the firmware as with `:avrdude` , but also sets the handedness setting in EEPROM. This is ideal for Proton-C-based split keyboards.
* `:st-link-cli` : Allows you to flash the firmware via the ST-Link CLI utility, rather than dfu-util. Requires an ST-Link dongle.
* `:st-flash` : Allows you to flash the firmware via the `st-flash` utility from [STLink Tools ](https://github.com/stlink-org/stlink ), rather than dfu-util. Requires an ST-Link dongle.
## STM32duino
2019-03-18 22:22:02 +01:00
2021-01-20 04:04:21 +01:00
This bootloader is used almost exclusively for STM32F103 boards, as they do not come with a USB DFU bootloader. The source code and prebuilt binaries can be found [here ](https://github.com/rogerclarkmelbourne/STM32duino-bootloader ).
2019-03-18 22:22:02 +01:00
2021-01-20 04:04:21 +01:00
To ensure compatibility with the STM32duino bootloader, make sure this block is present in your `rules.mk` :
```make
# Bootloader selection
BOOTLOADER = stm32duino
```
Compatible flashers:
* [QMK Toolbox ](https://github.com/qmk/qmk_toolbox/releases ) (recommended GUI)
2021-01-30 12:00:56 +01:00
* [dfu-util ](https://dfu-util.sourceforge.net/ ) / `:dfu-util` target in QMK (recommended command line)
2021-01-20 04:04:21 +01:00
Flashing sequence:
1. Enter the bootloader using any of the following methods:
* Tap the `RESET` keycode
* If a reset circuit is present, tap the `RESET` button on the PCB
* Otherwise, you need to bridge `BOOT0` to VCC (via `BOOT0` button or jumper), short `RESET` to GND (via `RESET` button or jumper), and then let go of the `BOOT0` bridge
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)
## Kiibohd DFU
Keyboards produced by Input Club use NXP Kinetis microcontrollers rather than STM32, and come with their own [custom bootloader ](https://github.com/kiibohd/controller/tree/master/Bootloader ), however the process and protocol is largely the same.
The `rules.mk` setting for this bootloader is `kiibohd` , but since this bootloader is limited to Input Club boards, it should not be necessary to set at keymap or user level.
Compatible flashers:
* [QMK Toolbox ](https://github.com/qmk/qmk_toolbox/releases ) (recommended GUI)
2021-01-30 12:00:56 +01:00
* [dfu-util ](https://dfu-util.sourceforge.net/ ) / `:dfu-util` target in QMK (recommended command line)
2021-01-20 04:04:21 +01:00
Flashing sequence:
1. Enter the bootloader using any of the following methods:
* Tap the `RESET` keycode (this may only enter the MCU into a "secure" bootloader mode; see https://github.com/qmk/qmk_firmware/issues/6112)
* Press the `RESET` button on the PCB
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)
2021 May 29 Breaking Changes Update (#13034)
* Add Per Key functionality for AutoShift (#11536)
* LED Matrix: Reactive effect buffers & advanced indicators (#12588)
* [Keyboard] kint36: switch to sym_eager_pk debouncing (#12626)
* [Keyboard] kint2pp: reduce input latency by ≈10ms (#12625)
* LED Matrix: Split (#12633)
* [CI] Format code according to conventions (#12650)
* feat: infinite timeout for leader key (#6580)
* feat: implement leader_no_timeout logic
* docs(leader_key): infinite leader timeout docs
* Format code according to conventions (#12680)
* Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (#12403)
* Fix default ADC_RESOLUTION for ADCv3 (and ADCv4)
Recent ChibiOS update removed ADC_CFGR1_RES_10BIT from the ADCv3 headers
(that macro should not have been there, because ADCv3 has CFGR instead of
CFGR1). Fix the default value for ADC_RESOLUTION to use ADC_CFGR_RES_10BITS
if it is defined (that name is used for ADCv3 and ADCv4).
* Update ADC docs to match the actually used resolution
ADC driver for ChibiOS actually uses the 10-bit resolution by default
(probably to match AVR); fix the documentation accordingly. Also add
both ADC_CFGR_RES_10BITS and ADC_CFGR1_RES_10BIT constants (these names
differ according to the ADC implementation in the particular MCU).
* Fix pinToMux() for B12 and B13 on STM32F3xx
Testing on STM32F303CCT6 revealed that the ADC mux values for B12 and
B13 pins were wrong.
* Add support for all possible analog pins on STM32F1xx
Added ADC mux values for pins A0...A7, B0, B1, C0...C5 on STM32F1xx
(they are the same at least for STM32F103x8 and larger F103 devices, and
also F102, F105, F107 families). Actually tested on STM32F103C8T6
(therefore pins C0...C5 were not tested).
Pins F6...F10, which are present on STM32F103x[C-G] in 144-pin packages,
cannot be supported at the moment, because those pins are connected only
to ADC3, but the ChibiOS ADC driver for STM32F1xx supports only ADC1.
* Add support for all possible analog pins on STM32F4xx
Added ADC mux values for pins A0...A7, B0, B1, C0...C5 and optionally
F3...F10 (if STM32_ADC_USE_ADC3 is enabled). These mux values are
apparently the same for all F4xx devices, except some smaller devices may
not have ADC3.
Actually tested on STM32F401CCU6, STM32F401CEU6, STM32F411CEU6 (using
various WeAct “Blackpill” boards); only pins A0...A7, B0, B1 were tested.
Pins F3...F10 are inside `#if STM32_ADC_USE_ADC3` because some devices
which don't have ADC3 also don't have the GPIOF port, therefore the code
which refers to Fx pins does not compile.
* Fix STM32F3xx ADC mux table in documentation
The ADC driver documentation had some errors in the mux table for STM32F3xx.
Fix this table to match the datasheet and the actual code (mux settings for
B12 and B13 were also tested on a real STM32F303CCT6 chip).
* Add STM32F1xx ADC pins to the documentation
* Add STM32F4xx ADC pins to the documentation
* 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
* eeprom driver: Refactor where eeprom driver initialisation (and EEPROM emulation initialisation) occurs to make it non-target-specific. (#12671)
* Add support for MCU = STM32F446 (#12619)
* Add support for MCU = STM32F446
* Update platforms/chibios/GENERIC_STM32_F446XE/configs/config.h
* Restore mcuconf.h to the one used by RT-STM32F446RE-NUCLEO64
* stm32f446: update mcuconf.h and board.h for 16MHz operation, with USB enabled, and other peripherals disabled.
* Format code according to conventions (#12682)
* Format code according to conventions (#12687)
* Add STM32L433 and L443 support (#12063)
* initial L433 commit
* change to XC
* fix L433
* disable all peripherals
* update system and peripheral clocks
* 433 change
* use its own board files
* revert its own board files
* l433 specific change
* fix stm32l432xx define
* remove duplicate #define
* fix bootloader jump
* move to L443xx and add i2c2, spi2, usart3 to mcuconf.h
* move to L443
* move to L443
* fix sdmmc in mcuconf.h
* include STM32L443
* add L443
* Include L443 in compatible microcontrollers
* Include L443 in compatible microcontrollers
* Update config bootloader jump description
* Update ChibiOS define reasoning
* Update quantum/mcu_selection.mk
* fix git conflict
* Updated Function96 with V2 files and removed chconf.h and halconf.h (#12613)
* Fix bad PR merge for #6580. (#12721)
* Change RGB/LED Matrix to use a simple define for USB suspend (#12697)
* [CI] Format code according to conventions (#12731)
* Fixing transport's led/rgb matrix suspend state logic (#12770)
* [CI] Format code according to conventions (#12772)
* Fix comment parsing (#12750)
* Added OLED fade out support (#12086)
* fix some references to bin/qmk that slipped in (#12832)
* Resolve a number of warnings in `qmk generate-api` (#12833)
* New command: qmk console (#12828)
* stash poc
* stash
* tidy up implementation
* Tidy up slightly for review
* Tidy up slightly for review
* Bodge environment to make tests pass
* Refactor away from asyncio due to windows issues
* Filter devices
* align vid/pid printing
* Add hidapi to the installers
* start preparing for multiple hid_listeners
* udev rules for hid_listen
* refactor to move closer to end state
* very basic implementation of the threaded model
* refactor how vid/pid/index are supplied and parsed
* windows improvements
* read the report directly when usage page isn't available
* add per-device colors, the choice to show names or numbers, and refactor
* add timestamps
* Add support for showing bootloaders
* tweak the color for bootloaders
* Align bootloader disconnect with connect color
* add support for showing all bootloaders
* fix the pyusb check
* tweaks
* fix exception
* hide a stack trace behind -v
* add --no-bootloaders option
* add documentation for qmk console
* Apply suggestions from code review
* pyformat
* clean up and flesh out KNOWN_BOOTLOADERS
* Remove pointless SERIAL_LINK_ENABLE rules (#12846)
* Make Swap Hands use PROGMEM (#12284)
This converts the array that the Swap Hands feature uses to use PROGMEM,
and to read from that array, as such. Since this array never changes at
runtime, there is no reason to keep it in memory. Especially for AVR
boards, as memory is a precious resource.
* Fix another bin/qmk reference (#12856)
* [Keymap] Turn OLED off on suspend in soundmonster keymap (#10419)
* Fixup build errors on `develop` branch. (#12723)
* LED Matrix: Effects! (#12651)
* Fix syntax error when compiling for ARM (#12866)
* Remove KEYMAP and LAYOUT_kc (#12160)
* alias KEYMAP to LAYOUT
* remove KEYMAP and LAYOUT_kc
* Add setup, clone, and env to the list of commands we allow even with broken modules (#12868)
* Rename `point_t` -> `led_point_t` (#12864)
* [Keyboard] updated a vendor name / fixed minor keymap issues (#12881)
* Add missing LED Matrix suspend code to suspend.c (#12878)
* LED Matrix: Documentation (#12685)
* Deprecate `send_unicode_hex_string()` (#12602)
* Fix spelling mistake regarding LED Matrix in split_common. (#12888)
* [Keymap] Fix QWERTY/DVORAK status output for kzar keymap (#12895)
* Use milc.subcommand.config instead of qmk.cli.config (#12915)
* Use milc.subcommand.config instead
* pyformat
* remove the config test
* Add function to allow repeated blinking of one layer (#12237)
* Implement function rgblight_blink_layer_repeat to allow repeated blinking of one layer at a time
* Update doc
* Rework rgblight blinking according to requested change
* optimize storage
* Fixup housekeeping from being invoked twice per loop. (#12933)
* matrix: wait for row signal to go HIGH for every row (#12945)
I noticed this discrepancy (last row of the matrix treated differently than the
others) when optimizing the input latency of my keyboard controller, see also
https://michael.stapelberg.ch/posts/2021-05-08-keyboard-input-latency-qmk-kinesis/
Before this commit, when tuning the delays I noticed ghost key presses when
pressing the F2 key, which is on the last row of the keyboard matrix: the
dead_grave key, which is on the first row of the keyboard matrix, would be
incorrectly detected as pressed.
After this commit, all keyboard matrix rows are interpreted correctly.
I suspect that my setup is more susceptible to this nuance than others because I
use GPIO_INPUT_PIN_DELAY=0 and hence don’t have another delay that might mask
the problem.
* ensure we do not conflict with existing keymap aliases (#12976)
* Add support for up to 4 IS31FL3733 drivers (#12342)
* Convert Encoder callbacks to be boolean functions (#12805)
* [Keyboard] Fix Terrazzo build failure (#12977)
* Do not hard set config in CPTC files (#11864)
* [Keyboard] Corne - Remove legacy revision support (#12226)
* [Keymap] Update to Drashna keymap and user code (based on develop) (#12936)
* Add Full-duplex serial driver for ARM boards (#9842)
* Document LED_MATRIX_FRAMEBUFFER_EFFECTS (#12987)
* Backlight: add defines for default level and breathing state (#12560)
* Add dire message about LUFA mass storage bootloader (#13014)
* [Keyboard] Remove redundant legacy and common headers for crkbd (#13023)
Was causing compiler errors on some systems.
* Fix keyboards/keymaps for boolean encoder callback changes (#12985)
* `backlight.c`: include `eeprom.h` (#13024)
* Add changelog for 2021-05-29 Breaking Changes merge (#12939)
* Add ChangeLog for 2021-05-29 Breaking Changes Merge: initial version
* Add recent develop changes
* Sort recent develop changes
* Remove sections for ChibiOS changes per tzarc
No ChibiOS changes this round.
* Add and sort recent develop changes
* add notes about keyboard moves/deletions
* import changelog for PR 12172
Documents the change to BOOTMAGIC_ENABLE.
* update section headings
* re-sort changelog
* add additional note regarding Bootmagic changes
* remove changelog timestamp
* update dates in main Breaking Changes docs
* fix broken section anchors in previous changelogs
* add link to backlight/eeprom patch to changelog
* highlight some more changes
* link PRs from section headers
* Restore standard readme
* run: qmk cformat --core-only
2021-05-29 23:38:50 +02:00
## 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
