keyboards/ps2avrGB/program

   1 #!/usr/bin/env python
   2 # Copyright 2017 Luiz Ribeiro <luizribeiro@gmail.com>, Sebastian Kaim <sebb@sebb767.de>
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation, either version 2 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 from __future__ import print_function
  18
  19 import os
  20 import sys
  21 import time
  22 import usb
  23
  24
  25 def checkForKeyboardInNormalMode():
  26     """Returns a device if a ps2avrGB device in normal made (that is in keyboard mode) or None if it is not found."""
  27     return usb.core.find(idVendor=0x20A0, idProduct=0x422D)
  28
  29 def checkForKeyboardInBootloaderMode():
  30     """Returns True if a ps2avrGB device in bootloader (flashable) mode is found and False otherwise."""
  31     return (usb.core.find(idVendor=0x16c0, idProduct=0x05df) is not None)
  32
  33 def flashKeyboard(firmware_file):
  34     """Calls bootloadHID to flash the given file to the device."""
  35     print('Flashing firmware to device ...')
  36     if os.system('bootloadHID -r "%s"' % firmware_file) == 0:
  37         print('\nDone!')
  38     else:
  39         print('\nbootloadHID returned an error.')
  40
  41 def printDeviceInfo(dev):
  42     """Prints all infos for a given USB device"""
  43     print('Device Information:')
  44     print('  idVendor: %d (0x%04x)' % (dev.idVendor, dev.idVendor))
  45     print('  idProduct: %d (0x%04x)' % (dev.idProduct, dev.idProduct))
  46     print('Manufacturer: %s' % (dev.iManufacturer))
  47     print('Serial: %s' % (dev.iSerialNumber))
  48     print('Product: %s' % (dev.iProduct), end='\n\n')
  49
  50 def sendDeviceToBootloaderMode(dev):
  51     """Tries to send a given ps2avrGB keyboard to bootloader mode to allow flashing."""
  52     try:
  53         dev.set_configuration()
  54
  55         request_type = usb.util.build_request_type(
  56                 usb.util.CTRL_OUT,
  57                 usb.util.CTRL_TYPE_CLASS,
  58                 usb.util.CTRL_RECIPIENT_DEVICE)
  59
  60         USBRQ_HID_SET_REPORT = 0x09
  61         HID_REPORT_OPTION = 0x0301
  62
  63         dev.ctrl_transfer(request_type, USBRQ_HID_SET_REPORT, HID_REPORT_OPTION, 0, [0, 0, 0xFF] + [0] * 5)
  64     except usb.core.USBError:
  65         # for some reason I keep getting USBError, but it works!
  66         pass
  67
  68
  69 if len(sys.argv) < 2:
  70     print('Usage: %s <firmware.hex>' % sys.argv[0])
  71     sys.exit(1)
  72
  73 kb = checkForKeyboardInNormalMode()
  74
  75 if kb is not None:
  76     print('Found a keyboad in normal mode. Attempting to send it to bootloader mode ...', end='')
  77     sendDeviceToBootloaderMode(kb)
  78     print(' done.')
  79     print("Hint: If your keyboard can't be set to bootloader mode automatically, plug it in while pressing left control to do so manually.")
  80
  81 attempts = 12  # 60 seconds
  82 found = False
  83 for attempt in range(1, attempts + 1):
  84     print("Searching for keyboard in bootloader mode (%i/%i) ... " % (attempt, attempts), end='')
  85
  86     if checkForKeyboardInBootloaderMode():
  87         print('Found', end='\n\n')
  88         flashKeyboard(sys.argv[1])
  89         found = True
  90         break
  91     else:
  92         print('Nothing.', end='')
  93
  94         if attempt != attempts:  # no need to wait on the last attempt
  95             print(' Sleeping 5 seconds.', end='')
  96             time.sleep(5)
  97
  98         # print a newline
  99         print()
 100
 101 if not found:
 102     print("Couldn't find a flashable keyboard. Aborting.")
 103     sys.exit(2)
 104