diff options
author | Nick Brassel <nick@tzarc.org> | 2024-11-27 21:29:12 +1100 |
---|---|---|
committer | Nick Brassel <nick@tzarc.org> | 2024-11-27 21:29:12 +1100 |
commit | 9f76541b29056150cf57d69569a14a59e13995c7 (patch) | |
tree | 66c7398d873fcda88aebe3090603aefe045ff52e /docs/flashing.md | |
parent | 57be4871616ee9a8fe042f6186010d436ec7d4b1 (diff) | |
parent | eb04b94eecbb9b3e64ca9c74f937b5f762440b17 (diff) |
Merge branch 'develop'
Diffstat (limited to 'docs/flashing.md')
-rw-r--r-- | docs/flashing.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/flashing.md b/docs/flashing.md index 2afb858860..29dc780aaf 100644 --- a/docs/flashing.md +++ b/docs/flashing.md @@ -345,6 +345,39 @@ Flashing sequence: 3. Flash a .bin file 4. Reset the device into application mode (may be done automatically) +## AT32 DFU + +All AT32 MCUs come preloaded with a factory bootloader that cannot be modified nor deleted. + +To ensure compatibility with the AT32-DFU bootloader, make sure this block is present in your `rules.mk`: + +```make +# Bootloader selection +BOOTLOADER = at32-dfu +``` + +Compatible flashers: + +* [dfu-util](https://dfu-util.sourceforge.net/) / `:dfu-util` target in QMK (recommended command line) + ``` + dfu-util -a 0 -d 2E3C:DF11 -s 0x8000000:leave -D <filename> + ``` + +Flashing sequence: + +1. Enter the bootloader using any of the following methods: + * Tap the `QK_BOOT` keycode + * 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 +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) + +### `make` Targets + +* `:dfu-util`: Waits until an AT32 bootloader device is available, and then flashes the firmware. +* `:dfu-util-split-left` and `:dfu-util-split-right`: Flashes the firmware as with `:dfu-util`, but also sets the handedness setting in EEPROM. + ## tinyuf2 Keyboards may opt into supporting the tinyuf2 bootloader. This is currently only supported on F303/F401/F411. |