diff options
| author | Joel Challis <git@zvecr.com> | 2019-08-24 16:35:11 +0100 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2019-08-24 08:35:11 -0700 |
| commit | 51bcadf38cfccc08b287554ab17e21624abf55b8 (patch) | |
| tree | cf01c2e084befb908b6b4fb7ffa2002e4e4015b5 /docs/flashing_bootloadhid.md | |
| parent | fb7c65dc34b3001617635e6afd10480f2770522d (diff) | |
| download | qmk_firmware-51bcadf38cfccc08b287554ab17e21624abf55b8.tar.gz qmk_firmware-51bcadf38cfccc08b287554ab17e21624abf55b8.zip | |
Add 'bootloadHID' flash target (#5587)
* Add 'bootloadHID' flash target
* Prep for flash target
* Add :flash support
* Align bootloader wait messages
Co-Authored-By: Drashna Jaelre <drashna@live.com>
* Update template to suggest use of :flash
Diffstat (limited to 'docs/flashing_bootloadhid.md')
| -rw-r--r-- | docs/flashing_bootloadhid.md | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/docs/flashing_bootloadhid.md b/docs/flashing_bootloadhid.md new file mode 100644 index 000000000..c51d8ce4b --- /dev/null +++ b/docs/flashing_bootloadhid.md | |||
| @@ -0,0 +1,70 @@ | |||
| 1 | # BootloadHID Flashing Instructions and Bootloader Information | ||
| 2 | |||
| 3 | ps2avr(GB) boards use an ATmega32A microcontroller and a different bootloader. It is not flashable using the regular QMK methods. | ||
| 4 | |||
| 5 | General flashing sequence: | ||
| 6 | |||
| 7 | 1. Enter the bootloader using any of the following methods: | ||
| 8 | * Tap the `RESET` keycode (may not work on all devices) | ||
| 9 | * Hold the salt key while plugging the keyboard in (usually documented within keyboard readme) | ||
| 10 | 2. Wait for the OS to detect the device | ||
| 11 | 3. Flash a .hex file | ||
| 12 | 4. Reset the device into application mode (may be done automatically) | ||
| 13 | |||
| 14 | ## bootloadHID Flashing Target | ||
| 15 | |||
| 16 | Using the QMK installation script, detailed [here](newbs_getting_started.md), the required bootloadHID tools should be automatically installed. | ||
| 17 | |||
| 18 | To flash via the command line, use the target `:bootloadHID` by executing the following command: | ||
| 19 | |||
| 20 | make <keyboard>:<keymap>:bootloadHID | ||
| 21 | |||
| 22 | ## GUI Flashing | ||
| 23 | |||
| 24 | ### Windows | ||
| 25 | 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash). | ||
| 26 | 2. Place your keyboard into reset. | ||
| 27 | 3. Ensure the configured VendorID is `16c0` and ProductID is `05df` | ||
| 28 | 4. Press the `Find Device` button and ensure that your keyboard is found. | ||
| 29 | 5. Press the `Open .hex File` button and locate the `.hex` file you created. | ||
| 30 | 6. Press the `Flash Device` button and wait for the process to complete. | ||
| 31 | |||
| 32 | ## Command Line Flashing | ||
| 33 | |||
| 34 | 1. Place your keyboard into reset. | ||
| 35 | 2. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. | ||
| 36 | |||
| 37 | ### Windows Manual Installation | ||
| 38 | For MSYS2: | ||
| 39 | 1. Download the BootloadHID firmware package from https://www.obdev.at/downloads/vusb/bootloadHID.2012-12-08.tar.gz. | ||
| 40 | 2. Extract contents using a compatible tool, for example 7-Zip. | ||
| 41 | 3. Add to the MSYS path by copying `commandline/bootloadHID.exe` from the extracted archive to your MSYS2 installation, typically `C:\msys64\usr\bin`. | ||
| 42 | |||
| 43 | For native Windows flashing, the `bootloadHID.exe` can be used outside of the MSYS2 environment. | ||
| 44 | |||
| 45 | ### Linux Manual Installation | ||
| 46 | 1. Install libusb development dependency: | ||
| 47 | ```bash | ||
| 48 | # This depends on OS - for Debian the following works | ||
| 49 | sudo apt-get install libusb-dev | ||
| 50 | ``` | ||
| 51 | 2. Download the BootloadHID firmware package: | ||
| 52 | ``` | ||
| 53 | wget https://www.obdev.at/downloads/vusb/bootloadHID.2012-12-08.tar.gz -O - | tar -xz -C /tmp | ||
| 54 | ``` | ||
| 55 | 3. Build the bootloadHID executable: | ||
| 56 | ``` | ||
| 57 | cd /tmp/bootloadHID.2012-12-08/commandline/ | ||
| 58 | make | ||
| 59 | sudo cp bootloadHID /usr/local/bin | ||
| 60 | ``` | ||
| 61 | |||
| 62 | ### MacOS Manual Installation | ||
| 63 | 1. Install Homebrew by typing the following: | ||
| 64 | ``` | ||
| 65 | /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" | ||
| 66 | ``` | ||
| 67 | 2. Install the following packages: | ||
| 68 | ``` | ||
| 69 | brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb | ||
| 70 | ``` | ||
