You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

70 lines
2.7 KiB

  1. # BootloadHID Flashing Instructions and Bootloader Information
  2. ps2avr(GB) boards use an ATmega32A microcontroller and a different bootloader. It is not flashable using the regular QMK methods.
  3. General flashing sequence:
  4. 1. Enter the bootloader using any of the following methods:
  5. * Tap the `QK_BOOT` keycode (may not work on all devices)
  6. * Hold the salt key while plugging the keyboard in (usually documented within keyboard readme)
  7. 2. Wait for the OS to detect the device
  8. 3. Flash a .hex file
  9. 4. Reset the device into application mode (may be done automatically)
  10. ## bootloadHID Flashing Target
  11. ?> Using the QMK installation script, detailed [here](newbs_getting_started.md), the required bootloadHID tools should be automatically installed.
  12. To flash via the command line, use the target `:bootloadhid` by executing the following command:
  13. make <keyboard>:<keymap>:bootloadhid
  14. ## GUI Flashing
  15. ### Windows
  16. 1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
  17. 2. Place your keyboard into reset.
  18. 3. Ensure the configured VendorID is `16c0` and ProductID is `05df`
  19. 4. Press the `Find Device` button and ensure that your keyboard is found.
  20. 5. Press the `Open .hex File` button and locate the `.hex` file you created.
  21. 6. Press the `Flash Device` button and wait for the process to complete.
  22. ## Command Line Flashing
  23. 1. Place your keyboard into reset.
  24. 2. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file.
  25. ### Windows Manual Installation
  26. For MSYS2:
  27. 1. Download the BootloadHID firmware package from https://www.obdev.at/downloads/vusb/bootloadHID.2012-12-08.tar.gz.
  28. 2. Extract contents using a compatible tool, for example 7-Zip.
  29. 3. Add to the MSYS path by copying `commandline/bootloadHID.exe` from the extracted archive to your MSYS2 installation, typically `C:\msys64\usr\bin`.
  30. For native Windows flashing, the `bootloadHID.exe` can be used outside of the MSYS2 environment.
  31. ### Linux Manual Installation
  32. 1. Install libusb development dependency:
  33. ```
  34. # This depends on OS - for Debian the following works
  35. sudo apt-get install libusb-dev
  36. ```
  37. 2. Download the BootloadHID firmware package:
  38. ```
  39. wget https://www.obdev.at/downloads/vusb/bootloadHID.2012-12-08.tar.gz -O - | tar -xz -C /tmp
  40. ```
  41. 3. Build the bootloadHID executable:
  42. ```
  43. cd /tmp/bootloadHID.2012-12-08/commandline/
  44. make
  45. sudo cp bootloadHID /usr/local/bin
  46. ```
  47. ### MacOS Manual Installation
  48. 1. Install Homebrew by typing the following:
  49. ```
  50. /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  51. ```
  52. 2. Install the following packages:
  53. ```
  54. brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
  55. ```