diff options
| author | Michael Pio <mfmayol@up.edu.ph> | 2018-11-04 01:08:05 +0800 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2018-11-03 13:08:05 -0400 |
| commit | 292a87ad0442293aadfe6910c9e5f19a53e54a81 (patch) | |
| tree | 3a57948994178b78376b71ee3e7a6aeda345bbcb | |
| parent | 0633eb027308f08331cb33f27ddbe7cb3a08cda8 (diff) | |
| download | qmk_firmware-292a87ad0442293aadfe6910c9e5f19a53e54a81.tar.gz qmk_firmware-292a87ad0442293aadfe6910c9e5f19a53e54a81.zip | |
Instructions on how to flash via STM32 bootloader (#4316)
* Add instructions on flashing ARM keyboards with default STM32 bootloader
* fixed typo; added note suggestion to step 4
| -rw-r--r-- | docs/flashing.md | 31 |
1 files changed, 27 insertions, 4 deletions
diff --git a/docs/flashing.md b/docs/flashing.md index 1edbe2225..bc418c415 100644 --- a/docs/flashing.md +++ b/docs/flashing.md | |||
| @@ -71,8 +71,8 @@ Flashing sequence: | |||
| 71 | 71 | ||
| 72 | 1. Press the `RESET` keycode, or short RST to GND quickly (you only have 7 seconds to flash once it enters) | 72 | 1. Press the `RESET` keycode, or short RST to GND quickly (you only have 7 seconds to flash once it enters) |
| 73 | 2. Wait for the OS to detect the device | 73 | 2. Wait for the OS to detect the device |
| 74 | 4. Flash a .hex file | 74 | 3. Flash a .hex file |
| 75 | 5. Wait for the device to reset automatically | 75 | 4. Wait for the device to reset automatically |
| 76 | 76 | ||
| 77 | or | 77 | or |
| 78 | 78 | ||
| @@ -106,5 +106,28 @@ Flashing sequence: | |||
| 106 | 106 | ||
| 107 | 1. Press the `RESET` keycode, or short RST to GND quickly (you only have 7 seconds to flash once it enters) | 107 | 1. Press the `RESET` keycode, or short RST to GND quickly (you only have 7 seconds to flash once it enters) |
| 108 | 2. Wait for the OS to detect the device | 108 | 2. Wait for the OS to detect the device |
| 109 | 4. Flash a .hex file | 109 | 3. Flash a .hex file |
| 110 | 5. Reset the device into application mode (may be done automatically) | 110 | 4. Reset the device into application mode (may be done automatically) |
| 111 | |||
| 112 | ## STM32 | ||
| 113 | |||
| 114 | 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. | ||
| 115 | |||
| 116 | At the moment, no `BOOTLOADER` variable is needed on `rules.mk` for STM32. | ||
| 117 | |||
| 118 | Compatible flashers: | ||
| 119 | |||
| 120 | * [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (recommended GUI) | ||
| 121 | * [dfu-util](https://github.com/Stefan-Schmidt/dfu-util) / `:dfu-util` (recommended command line) | ||
| 122 | |||
| 123 | Flashing sequence: | ||
| 124 | |||
| 125 | 1. Enter the bootloader using any of the following methods: | ||
| 126 | * Tap the `RESET` keycode (may not work on STM32F042 devices) | ||
| 127 | * If a reset circuit is present, tap the RESET button | ||
| 128 | * Otherwise, you need to bridge BOOT0 to VCC (via BOOT0 button or bridge), short RESET to GND (via RESET button or bridge), and then let go of the BOOT0 bridge | ||
| 129 | 2. Wait for the OS to detect the device | ||
| 130 | 3. Flash a .bin file | ||
| 131 | * You will receive a warning about the DFU signature; Just ignore it | ||
| 132 | 4. Reset the device into application mode (may be done automatically) | ||
| 133 | * If you are building from command line (e.g. `make planck/rev6:default:dfu-util`), make sure that `:leave` is passed to the `DFU_ARGS` variable inside your `rules.mk` (e.g. `DFU_ARGS = -d 0483:df11 -a 0 -s 0x08000000:leave`) so that your device resets after flashing | ||