aboutsummaryrefslogtreecommitdiff
path: root/docs/flashing_bootloadhid.md
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2019-08-24 16:35:11 +0100
committerDrashna Jaelre <drashna@live.com>2019-08-24 08:35:11 -0700
commit51bcadf38cfccc08b287554ab17e21624abf55b8 (patch)
treecf01c2e084befb908b6b4fb7ffa2002e4e4015b5 /docs/flashing_bootloadhid.md
parentfb7c65dc34b3001617635e6afd10480f2770522d (diff)
downloadqmk_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.md70
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
3ps2avr(GB) boards use an ATmega32A microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
4
5General flashing sequence:
6
71. 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)
102. Wait for the OS to detect the device
113. Flash a .hex file
124. Reset the device into application mode (may be done automatically)
13
14## bootloadHID Flashing Target
15
16Using the QMK installation script, detailed [here](newbs_getting_started.md), the required bootloadHID tools should be automatically installed.
17
18To 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
251. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
262. Place your keyboard into reset.
273. Ensure the configured VendorID is `16c0` and ProductID is `05df`
284. Press the `Find Device` button and ensure that your keyboard is found.
295. Press the `Open .hex File` button and locate the `.hex` file you created.
306. Press the `Flash Device` button and wait for the process to complete.
31
32## Command Line Flashing
33
341. Place your keyboard into reset.
352. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
36
37### Windows Manual Installation
38For MSYS2:
391. Download the BootloadHID firmware package from https://www.obdev.at/downloads/vusb/bootloadHID.2012-12-08.tar.gz.
402. Extract contents using a compatible tool, for example 7-Zip.
413. Add to the MSYS path by copying `commandline/bootloadHID.exe` from the extracted archive to your MSYS2 installation, typically `C:\msys64\usr\bin`.
42
43For native Windows flashing, the `bootloadHID.exe` can be used outside of the MSYS2 environment.
44
45### Linux Manual Installation
461. Install libusb development dependency:
47 ```bash
48 # This depends on OS - for Debian the following works
49 sudo apt-get install libusb-dev
50 ```
512. 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 ```
553. 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
631. Install Homebrew by typing the following:
64 ```
65 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
66 ```
672. Install the following packages:
68 ```
69 brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
70 ```