new maxusb library

[goodfet] / client / USBKeyboard.py

diff --git a/client/USBKeyboard.py b/client/USBKeyboard.py
new file mode 100644 (file)
index 0000000..64f6ec0
--- /dev/null
+++ b/client/USBKeyboard.py
@@ -0,0 +1,93 @@
+# USBKeyboard.py
+#
+# Contains class definitions to implement a USB keyboard.
+
+from USB import *
+from USBDevice import *
+from USBConfiguration import *
+from USBInterface import *
+from USBEndpoint import *
+
+class USBKeyboardInterface(USBInterface):
+    name = "USB keyboard interface"
+
+    hid_descriptor = b'\x09\x21\x10\x01\x00\x01\x22\x2b\x00'
+    report_descriptor = b'\x05\x01\x09\x06\xA1\x01\x05\x07\x19\xE0\x29\xE7\x15\x00\x25\x01\x75\x01\x95\x08\x81\x02\x95\x01\x75\x08\x81\x01\x19\x00\x29\x65\x15\x00\x25\x65\x75\x08\x95\x01\x81\x00\xC0'
+
+    def __init__(self, verbose=0):
+        descriptors = { 
+                USB.desc_type_hid    : self.hid_descriptor,
+                USB.desc_type_report : self.report_descriptor
+        }
+
+        endpoint = USBEndpoint(
+                3,          # endpoint number
+                USBEndpoint.direction_in,
+                USBEndpoint.transfer_type_interrupt,
+                USBEndpoint.sync_type_none,
+                USBEndpoint.usage_type_data,
+                16384,      # max packet size
+                10,         # polling interval, see USB 2.0 spec Table 9-13
+                self.handle_buffer_available    # handler function
+        )
+
+        # TODO: un-hardcode string index (last arg before "verbose")
+        USBInterface.__init__(
+                self,
+                0,          # interface number
+                0,          # alternate setting
+                3,          # interface class
+                0,          # subclass
+                0,          # protocol
+                0,          # string index
+                verbose,
+                [ endpoint ],
+                descriptors
+        )
+
+        # "ls<ENTER><KEY UP>"
+        self.text = [ chr(x) for x in [ 0x0f, 0x16, 0x28, 0x00 ] ]
+
+    def handle_buffer_available(self):
+        if not self.text:
+            return
+
+        letter = self.text.pop(0)
+        self.type_letter(letter)
+
+    def type_letter(self, letter, modifiers=0):
+        data = bytes([ 0, 0, ord(letter) ])
+
+        if self.verbose > 2:
+            print(self.name, "sending keypress 0x%02x" % ord(letter))
+
+        self.device.maxusb_app.send_on_endpoint(3, data)
+
+
+class USBKeyboardDevice(USBDevice):
+    name = "USB keyboard device"
+
+    def __init__(self, maxusb_app, verbose=0):
+        config = USBConfiguration(
+                1,                                          # index
+                "Maxim Emulated Keyboard Configuration",    # string desc
+                [ USBKeyboardInterface() ]                  # interfaces
+        )
+
+        USBDevice.__init__(
+                self,
+                maxusb_app,
+                0,                      # device class
+                0,                      # device subclass
+                0,                      # protocol release number
+                64,                     # max packet size for endpoint 0
+                0x610b,                 # vendor id
+                0x4653,                 # product id
+                0x3412,                 # device revision
+                "Maxim",                # manufacturer string
+                "MAX3420E Enum Code",   # product string
+                "S/N3420E",             # serial number string
+                [ config ],
+                verbose=verbose
+        )
+