aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2021-09-10 17:17:54 +1000
committerGitHub <noreply@github.com>2021-09-10 17:17:54 +1000
commitd5cb7de5e4ea60dce69764a627358d534af1f666 (patch)
tree5835a4448bbb4e946495aad393145aca39305c75 /docs
parent7eea780a7da2d9197b78b62b7294a6b2bc2fa572 (diff)
downloadqmk_firmware-d5cb7de5e4ea60dce69764a627358d534af1f666.tar.gz
qmk_firmware-d5cb7de5e4ea60dce69764a627358d534af1f666.zip
Change USBasp and bootloadHID bootloaders to lowercase (#14354)
Diffstat (limited to 'docs')
-rw-r--r--docs/config_options.md4
-rw-r--r--docs/driver_installation_zadig.md56
-rw-r--r--docs/flashing.md6
-rw-r--r--docs/flashing_bootloadhid.md4
-rw-r--r--docs/getting_started_make_guide.md2
5 files changed, 36 insertions, 36 deletions
diff --git a/docs/config_options.md b/docs/config_options.md
index 94f99e74c..7584d3584 100644
--- a/docs/config_options.md
+++ b/docs/config_options.md
@@ -397,8 +397,8 @@ However, this will automatically disable the legacy TMK Macros and Functions fea
397 * `qmk-dfu` 397 * `qmk-dfu`
398 * `halfkay` 398 * `halfkay`
399 * `caterina` 399 * `caterina`
400 * `bootloadHID` 400 * `bootloadhid`
401 * `USBasp` 401 * `usbasploader`
402 402
403## Feature Options :id=feature-options 403## Feature Options :id=feature-options
404 404
diff --git a/docs/driver_installation_zadig.md b/docs/driver_installation_zadig.md
index 137ec8ad6..9155e56e3 100644
--- a/docs/driver_installation_zadig.md
+++ b/docs/driver_installation_zadig.md
@@ -68,31 +68,31 @@ This is a list of known bootloader devices and their USB vendor and product IDs,
68 68
69The device name here is the name that appears in Zadig, and may not be what the Device Manager or QMK Toolbox displays. 69The device name here is the name that appears in Zadig, and may not be what the Device Manager or QMK Toolbox displays.
70 70
71|Bootloader |Device Name |VID/PID |Driver | 71|Bootloader |Device Name |VID/PID |Driver |
72|-------------|------------------------------|--------------|-------| 72|--------------|------------------------------|--------------|-------|
73|`atmel-dfu` |ATmega16u2 DFU |`03EB:2FEF` |libusb0| 73|`atmel-dfu` |ATmega16u2 DFU |`03EB:2FEF` |libusb0|
74|`atmel-dfu` |ATmega32U2 DFU |`03EB:2FF0` |libusb0| 74|`atmel-dfu` |ATmega32U2 DFU |`03EB:2FF0` |libusb0|
75|`atmel-dfu` |ATm16U4 DFU V1.0.2 |`03EB:2FF3` |libusb0| 75|`atmel-dfu` |ATm16U4 DFU V1.0.2 |`03EB:2FF3` |libusb0|
76|`atmel-dfu` |ATm32U4DFU |`03EB:2FF4` |libusb0| 76|`atmel-dfu` |ATm32U4DFU |`03EB:2FF4` |libusb0|
77|`atmel-dfu` |*none* (AT90USB64) |`03EB:2FF9` |libusb0| 77|`atmel-dfu` |*none* (AT90USB64) |`03EB:2FF9` |libusb0|
78|`atmel-dfu` |AT90USB128 DFU |`03EB:2FFB` |libusb0| 78|`atmel-dfu` |AT90USB128 DFU |`03EB:2FFB` |libusb0|
79|`qmk-dfu` |(keyboard name) Bootloader |As `atmel-dfu`|libusb0| 79|`qmk-dfu` |(keyboard name) Bootloader |As `atmel-dfu`|libusb0|
80|`halfkay` |*none* |`16C0:0478` |HidUsb | 80|`halfkay` |*none* |`16C0:0478` |HidUsb |
81|`caterina` |Pro Micro 3.3V |`1B4F:9203` |usbser | 81|`caterina` |Pro Micro 3.3V |`1B4F:9203` |usbser |
82|`caterina` |Pro Micro 5V |`1B4F:9205` |usbser | 82|`caterina` |Pro Micro 5V |`1B4F:9205` |usbser |
83|`caterina` |LilyPadUSB |`1B4F:9207` |usbser | 83|`caterina` |LilyPadUSB |`1B4F:9207` |usbser |
84|`caterina` |Pololu A-Star 32U4 Bootloader |`1FFB:0101` |usbser | 84|`caterina` |Pololu A-Star 32U4 Bootloader |`1FFB:0101` |usbser |
85|`caterina` |Arduino Leonardo |`2341:0036` |usbser | 85|`caterina` |Arduino Leonardo |`2341:0036` |usbser |
86|`caterina` |Arduino Micro |`2341:0037` |usbser | 86|`caterina` |Arduino Micro |`2341:0037` |usbser |
87|`caterina` |Adafruit Feather 32u4 |`239A:000C` |usbser | 87|`caterina` |Adafruit Feather 32u4 |`239A:000C` |usbser |
88|`caterina` |Adafruit ItsyBitsy 32u4 3V |`239A:000D` |usbser | 88|`caterina` |Adafruit ItsyBitsy 32u4 3V |`239A:000D` |usbser |
89|`caterina` |Adafruit ItsyBitsy 32u4 5V |`239A:000E` |usbser | 89|`caterina` |Adafruit ItsyBitsy 32u4 5V |`239A:000E` |usbser |
90|`caterina` |Arduino Leonardo |`2A03:0036` |usbser | 90|`caterina` |Arduino Leonardo |`2A03:0036` |usbser |
91|`caterina` |Arduino Micro |`2A03:0037` |usbser | 91|`caterina` |Arduino Micro |`2A03:0037` |usbser |
92|`bootloadHID`|HIDBoot |`16C0:05DF` |HidUsb | 92|`bootloadhid` |HIDBoot |`16C0:05DF` |HidUsb |
93|`USBasp` |USBasp |`16C0:05DC` |libusbK| 93|`usbasploader`|USBasp |`16C0:05DC` |libusbK|
94|`apm32-dfu` |APM32 DFU ISP Mode |`314B:0106` |WinUSB | 94|`apm32-dfu` |APM32 DFU ISP Mode |`314B:0106` |WinUSB |
95|`stm32-dfu` |STM32 BOOTLOADER |`0483:DF11` |WinUSB | 95|`stm32-dfu` |STM32 BOOTLOADER |`0483:DF11` |WinUSB |
96|`kiibohd` |Kiibohd DFU Bootloader |`1C11:B007` |WinUSB | 96|`kiibohd` |Kiibohd DFU Bootloader |`1C11:B007` |WinUSB |
97|`stm32duino` |Maple 003 |`1EAF:0003` |WinUSB | 97|`stm32duino` |Maple 003 |`1EAF:0003` |WinUSB |
98|`qmk-hid` |(keyboard name) Bootloader |`03EB:2067` |HidUsb | 98|`qmk-hid` |(keyboard name) Bootloader |`03EB:2067` |HidUsb |
diff --git a/docs/flashing.md b/docs/flashing.md
index 7b7fe956f..2e69f246a 100644
--- a/docs/flashing.md
+++ b/docs/flashing.md
@@ -127,7 +127,7 @@ To ensure compatibility with the USBasploader bootloader, make sure this block i
127 127
128```make 128```make
129# Bootloader selection 129# Bootloader selection
130BOOTLOADER = USBasp 130BOOTLOADER = usbasploader
131``` 131```
132 132
133Compatible flashers: 133Compatible flashers:
@@ -153,13 +153,13 @@ To ensure compatibility with the bootloadHID bootloader, make sure this block is
153 153
154```make 154```make
155# Bootloader selection 155# Bootloader selection
156BOOTLOADER = bootloadHID 156BOOTLOADER = bootloadhid
157``` 157```
158 158
159Compatible flashers: 159Compatible flashers:
160 160
161* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (recommended GUI) 161* [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases) (recommended GUI)
162* [bootloadHID CLI](https://www.obdev.at/products/vusb/bootloadhid.html) / `:bootloadHID` target in QMK (recommended command line) 162* [bootloadHID CLI](https://www.obdev.at/products/vusb/bootloadhid.html) / `:bootloadhid` target in QMK (recommended command line)
163* [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash) 163* [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash)
164 164
165Flashing sequence: 165Flashing sequence:
diff --git a/docs/flashing_bootloadhid.md b/docs/flashing_bootloadhid.md
index 731d92772..9879ec999 100644
--- a/docs/flashing_bootloadhid.md
+++ b/docs/flashing_bootloadhid.md
@@ -15,9 +15,9 @@ General flashing sequence:
15 15
16?> Using the QMK installation script, detailed [here](newbs_getting_started.md), the required bootloadHID tools should be automatically installed. 16?> Using the QMK installation script, detailed [here](newbs_getting_started.md), the required bootloadHID tools should be automatically installed.
17 17
18To flash via the command line, use the target `:bootloadHID` by executing the following command: 18To flash via the command line, use the target `:bootloadhid` by executing the following command:
19 19
20 make <keyboard>:<keymap>:bootloadHID 20 make <keyboard>:<keymap>:bootloadhid
21 21
22## GUI Flashing 22## GUI Flashing
23 23
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md
index 02216875c..70390a510 100644
--- a/docs/getting_started_make_guide.md
+++ b/docs/getting_started_make_guide.md
@@ -14,7 +14,7 @@ The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`,
14The `<target>` means the following 14The `<target>` means the following
15* If no target is given, then it's the same as `all` below 15* If no target is given, then it's the same as `all` below
16* `all` compiles as many keyboard/revision/keymap combinations as specified. For example, `make planck/rev4:default` will generate a single .hex, while `make planck/rev4:all` will generate a hex for every keymap available to the planck. 16* `all` compiles as many keyboard/revision/keymap combinations as specified. For example, `make planck/rev4:default` will generate a single .hex, while `make planck/rev4:all` will generate a hex for every keymap available to the planck.
17* `flash`, `dfu`, `teensy`, `avrdude`, `dfu-util`, or `bootloadHID` compile and upload the firmware to the keyboard. If the compilation fails, then nothing will be uploaded. The programmer to use depends on the keyboard. For most keyboards it's `dfu`, but for ChibiOS keyboards you should use `dfu-util`, and `teensy` for standard Teensys. To find out which command you should use for your keyboard, check the keyboard specific readme. 17* `flash`, `dfu`, `teensy`, `avrdude`, `dfu-util`, or `bootloadhid` compile and upload the firmware to the keyboard. If the compilation fails, then nothing will be uploaded. The programmer to use depends on the keyboard. For most keyboards it's `dfu`, but for ChibiOS keyboards you should use `dfu-util`, and `teensy` for standard Teensys. To find out which command you should use for your keyboard, check the keyboard specific readme.
18 Visit the [Flashing Firmware](flashing.md) guide for more details of the available bootloaders. 18 Visit the [Flashing Firmware](flashing.md) guide for more details of the available bootloaders.
19 * **Note**: some operating systems need privileged access for these commands to work. This means that you may need to setup [`udev rules`](faq_build.md#linux-udev-rules) to access these without root access, or to run the command with root access (`sudo make planck/rev4:default:flash`). 19 * **Note**: some operating systems need privileged access for these commands to work. This means that you may need to setup [`udev rules`](faq_build.md#linux-udev-rules) to access these without root access, or to run the command with root access (`sudo make planck/rev4:default:flash`).
20* `clean`, cleans the build output folders to make sure that everything is built from scratch. Run this before normal compilation if you have some unexplainable problems. 20* `clean`, cleans the build output folders to make sure that everything is built from scratch. Run this before normal compilation if you have some unexplainable problems.