diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config_options.md | 1 | ||||
| -rw-r--r-- | docs/feature_split_keyboard.md | 2 | ||||
| -rw-r--r-- | docs/flashing.md | 4 | ||||
| -rw-r--r-- | docs/newbs_flashing.md | 16 |
4 files changed, 19 insertions, 4 deletions
diff --git a/docs/config_options.md b/docs/config_options.md index 77e2368f3d..9e43f47c25 100644 --- a/docs/config_options.md +++ b/docs/config_options.md @@ -224,6 +224,7 @@ There are a few different ways to set handedness for split keyboards (listed in 2. Set `EE_HANDS` and flash `eeprom-lefthand.eep`/`eeprom-righthand.eep` to each half * For boards with DFU bootloader you can use `:dfu-split-left`/`:dfu-split-right` to flash these EEPROM files * For boards with Caterina bootloader (like stock Pro Micros), use `:avrdude-split-left`/`:avrdude-split-right` + * For boards with ARM DFU bootloader (like Proton C), use `:dfu-util-split-left`/`:dfu-util-split-right` 3. Set `MASTER_RIGHT`: Half that is plugged into the USB port is determined to be the master and right half (inverse of the default) 4. Default: The side that is plugged into the USB port is the master half and is assumed to be the left half. The slave side is the right half diff --git a/docs/feature_split_keyboard.md b/docs/feature_split_keyboard.md index 60e0d278c0..42dd838d0d 100644 --- a/docs/feature_split_keyboard.md +++ b/docs/feature_split_keyboard.md @@ -96,6 +96,8 @@ However, you'll have to flash the EEPROM files for the correct hand to each cont * `:avrdude-split-right` * `:dfu-split-left` * `:dfu-split-right` +* `:dfu-util-split-left` +* `:dfu-util-split-right` This setting is not changed when re-initializing the EEPROM using the `EEP_RST` key, or using the `eeconfig_init()` function. However, if you reset the EEPROM outside of the firmware's built in options (such as flashing a file that overwrites the `EEPROM`, like how the [QMK Toolbox]()'s "Reset EEPROM" button works), you'll need to re-flash the controller with the `EEPROM` files. diff --git a/docs/flashing.md b/docs/flashing.md index 00350b8406..18ae6364d4 100644 --- a/docs/flashing.md +++ b/docs/flashing.md @@ -232,4 +232,6 @@ Flashing sequence: There are a number of DFU commands that you can use to flash firmware to a STM32 device: * `:dfu-util` - The default command for flashing to STM32 devices. -* `:st-link-cli` - This allows you to flash the firmware via ST-LINK's CLI utility, rather than dfu-util. +* `:dfu-util-split-left` - This flashes the normal firmware, just like the default option (`:dfu-util`). However, this also configures the "Left Side" EEPROM setting for split keyboards. +* `:dfu-util-split-right` - This flashes the normal firmware, just like the default option (`:dfu-util`). However, this also configures the "Right Side" EEPROM setting for split keyboards. +* `:st-link-cli` - This allows you to flash the firmware via ST-LINK's CLI utility, rather than dfu-util. diff --git a/docs/newbs_flashing.md b/docs/newbs_flashing.md index 3bf582d7f6..4fb2f91d57 100644 --- a/docs/newbs_flashing.md +++ b/docs/newbs_flashing.md @@ -215,7 +215,7 @@ Additionally, if you want to flash multiple boards, use the following command: When you're done flashing boards, you'll need to hit Ctrl + C or whatever the correct keystroke is for your operating system to break the loop. -## HalfKay +### HalfKay For the PJRC devices (Teensy's), when you're ready to compile and flash your firmware, open up your terminal window and run the build command: @@ -248,7 +248,7 @@ Programming..................................................................... Booting ``` -## BootloadHID +### BootloadHID For Bootmapper Client(BMC)/bootloadHID/ATmega32A based boards, when you're ready to compile and flash your firmware, open up your terminal window and run the build command: @@ -284,7 +284,7 @@ Uploading 22016 (0x5600) bytes starting at 0 (0x0) 0x05580 ... 0x05600 ``` -## STM32 (ARM) +### STM32 (ARM) For a majority of ARM boards (including the Proton C, Planck Rev 6, and Preonic Rev 3), when you're ready to compile and flash your firmware, open up your terminal window and run the build command: @@ -334,6 +334,16 @@ File downloaded successfully Transitioning to dfuMANIFEST state ``` +#### STM32 Commands + +There are a number of DFU commands that you can use to flash firmware to a STM32 device: + +* `:dfu-util` - The default command for flashing to STM32 devices. +* `:dfu-util-wait` - This works like the default command, but it gives you a (configurable) 10 second timeout before it attempts to flash the firmware. You can use `TIME_DELAY=20` from the command line to change the timeout. + * Eg: `make <keyboard>:<keymap>:dfu-util TIME_DELAY=5` +* `:dfu-util-split-left` - This flashes the normal firmware, just like the default option (`:dfu-util`). However, this also configures the "Left Side" EEPROM setting for split keyboards. +* `:dfu-util-split-right` - This flashes the normal firmware, just like the default option (`:dfu-util`). However, this also configures the "Right Side" EEPROM setting for split keyboards. + ## Test It Out! Congrats! Your custom firmware has been programmed to your keyboard! |