diff options
author | Drashna Jaelre <drashna@live.com> | 2019-03-18 14:22:02 -0700 |
---|---|---|
committer | MechMerlin <30334081+mechmerlin@users.noreply.github.com> | 2019-03-18 14:22:02 -0700 |
commit | c534a4c775098f2b6cc8e7f36d35cf642f4323a5 (patch) | |
tree | f025c6ade37e4fc6bc930e05fe9a734dd273c974 /docs/flashing.md | |
parent | 28e182bc8a2976562e0d76a1332527e0a4be81ea (diff) | |
download | qmk_firmware-c534a4c775098f2b6cc8e7f36d35cf642f4323a5.tar.gz qmk_firmware-c534a4c775098f2b6cc8e7f36d35cf642f4323a5.zip |
[Docs] Smallish overhaul of the docs (#5281)
* Fix up Common functions doc
* Add to extra commands to flashing doc
* Rearrange and touch up Macros
* Expand Newbs Flashing guide
* Update process_record documentation
* Add git to best practices name in sidebar
* Expand FAQ for build/flashing
* Add deprecated info to functions
* Update docs/feature_macros.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/feature_macros.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/flashing.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/flashing.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/keymap.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/newbs_flashing.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/newbs_flashing.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/custom_quantum_functions.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/faq_build.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/feature_macros.md
Co-Authored-By: drashna <drashna@live.com>
* Update docs/keymap.md
Co-Authored-By: drashna <drashna@live.com>
* Fix up Common functions doc
* Make pre-init example accurate
* Update docs/custom_quantum_functions.md
Co-Authored-By: drashna <drashna@live.com>
* Zadig Driver catchall
* Spelling Depriciated
* Completely remove fn_actions section
Diffstat (limited to 'docs/flashing.md')
-rw-r--r-- | docs/flashing.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/flashing.md b/docs/flashing.md index bc418c415..cafb43910 100644 --- a/docs/flashing.md +++ b/docs/flashing.md | |||
@@ -49,6 +49,15 @@ To generate this bootloader, use the `bootloader` target, eg `make planck/rev4:d | |||
49 | 49 | ||
50 | To generate a production-ready .hex file (containing the application and the bootloader), use the `production` target, eg `make planck/rev4:default:production`. | 50 | To generate a production-ready .hex file (containing the application and the bootloader), use the `production` target, eg `make planck/rev4:default:production`. |
51 | 51 | ||
52 | ### DFU commands | ||
53 | |||
54 | There are a number of DFU commands that you can use to flash firmware to a DFU device: | ||
55 | |||
56 | * `:dfu` - This is the normal option and waits until a DFU device is available, and then flashes the firmware. This will check every 5 seconds, to see if a DFU device has appeared. | ||
57 | * `:dfu-ee` - This flashes an `eep` file instead of the normal hex. This is uncommon. | ||
58 | * `:dfu-split-left` - This flashes the normal firmware, just like the default option (`:dfu`). However, this also flashes the "Left Side" EEPROM file for split keyboards. _This is ideal for Elite C based split keyboards._ | ||
59 | * `:dfu-split-right` - This flashes the normal firmware, just like the default option (`:dfu`). However, this also flashes the "Right Side" EEPROM file for split keyboards. _This is ideal for Elite C based split keyboards._ | ||
60 | |||
52 | ## Caterina | 61 | ## Caterina |
53 | 62 | ||
54 | 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. | 63 | 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. |
@@ -84,6 +93,7 @@ or if you want to flash multiple boards, use the following command | |||
84 | 93 | ||
85 | 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. | 94 | 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. |
86 | 95 | ||
96 | |||
87 | ## Halfkay | 97 | ## Halfkay |
88 | 98 | ||
89 | Halfkay is a super-slim protocol developed by PJRC that uses HID, and come on all Teensys (namely the 2.0). | 99 | Halfkay is a super-slim protocol developed by PJRC that uses HID, and come on all Teensys (namely the 2.0). |
@@ -131,3 +141,12 @@ Flashing sequence: | |||
131 | * You will receive a warning about the DFU signature; Just ignore it | 141 | * You will receive a warning about the DFU signature; Just ignore it |
132 | 4. Reset the device into application mode (may be done automatically) | 142 | 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 | 143 | * 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 |
144 | |||
145 | ### STM32 Commands | ||
146 | |||
147 | There are a number of DFU commands that you can use to flash firmware to a STM32 device: | ||
148 | |||
149 | * `:dfu-util` - The default command for flashing to STM32 devices. | ||
150 | * `: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. | ||
151 | * Eg: `make <keyboard>:<keymap>:dfu-util TIME_DELAY=5` | ||
152 | * `:st-link-cli` - This allows you to flash the firmware via ST-LINK's CLI utility, rather than dfu-util. | ||