Zachary Russell / USBHost_Modified

USBHost library with fixes

Dependencies:   mbed-rtos FATFileSystem

Dependents:   mbedica

USBHostHID/USBHostKeyboard.cpp@0:b176d95bb38f, 2018-12-13 (annotated)

Committer:
zrussell3
Date:
Thu Dec 13 19:24:21 2018 +0000
Revision:
0:b176d95bb38f
Modified USBHost library to fix modifier input

Who changed what in which revision?

UserRevisionLine numberNew contents of line
zrussell3 0:b176d95bb38f 1 /* mbed USBHost Library
zrussell3 0:b176d95bb38f 2 * Copyright (c) 2006-2013 ARM Limited
zrussell3 0:b176d95bb38f 3 *
zrussell3 0:b176d95bb38f 4 * Licensed under the Apache License, Version 2.0 (the "License");
zrussell3 0:b176d95bb38f 5 * you may not use this file except in compliance with the License.
zrussell3 0:b176d95bb38f 6 * You may obtain a copy of the License at
zrussell3 0:b176d95bb38f 7 *
zrussell3 0:b176d95bb38f 8 * http://www.apache.org/licenses/LICENSE-2.0
zrussell3 0:b176d95bb38f 9 *
zrussell3 0:b176d95bb38f 10 * Unless required by applicable law or agreed to in writing, software
zrussell3 0:b176d95bb38f 11 * distributed under the License is distributed on an "AS IS" BASIS,
zrussell3 0:b176d95bb38f 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
zrussell3 0:b176d95bb38f 13 * See the License for the specific language governing permissions and
zrussell3 0:b176d95bb38f 14 * limitations under the License.
zrussell3 0:b176d95bb38f 15 */
zrussell3 0:b176d95bb38f 16
zrussell3 0:b176d95bb38f 17 #include "USBHostKeyboard.h"
zrussell3 0:b176d95bb38f 18
zrussell3 0:b176d95bb38f 19 #if USBHOST_KEYBOARD
zrussell3 0:b176d95bb38f 20
zrussell3 0:b176d95bb38f 21 static uint8_t keymap[4][0x39] = {
zrussell3 0:b176d95bb38f 22 { 0, 0, 0, 0, 'a', 'b' /*0x05*/,
zrussell3 0:b176d95bb38f 23 'c', 'd', 'e', 'f', 'g' /*0x0a*/,
zrussell3 0:b176d95bb38f 24 'h', 'i', 'j', 'k', 'l'/*0x0f*/,
zrussell3 0:b176d95bb38f 25 'm', 'n', 'o', 'p', 'q'/*0x14*/,
zrussell3 0:b176d95bb38f 26 'r', 's', 't', 'u', 'v'/*0x19*/,
zrussell3 0:b176d95bb38f 27 'w', 'x', 'y', 'z', '1'/*0x1E*/,
zrussell3 0:b176d95bb38f 28 '2', '3', '4', '5', '6'/*0x23*/,
zrussell3 0:b176d95bb38f 29 '7', '8', '9', '0', 0x0A /*enter*/, /*0x28*/
zrussell3 0:b176d95bb38f 30 0x1B /*escape*/, 0x08 /*backspace*/, 0x09/*tab*/, 0x20/*space*/, '-', /*0x2d*/
zrussell3 0:b176d95bb38f 31 '=', '[', ']', '\\', '#', /*0x32*/
zrussell3 0:b176d95bb38f 32 ';', '\'', 0, ',', '.', /*0x37*/
zrussell3 0:b176d95bb38f 33 '/'},
zrussell3 0:b176d95bb38f 34
zrussell3 0:b176d95bb38f 35 /* CTRL MODIFIER */
zrussell3 0:b176d95bb38f 36 { 0, 0, 0, 0, 0, 0 /*0x05*/,
zrussell3 0:b176d95bb38f 37 0, 0, 0, 0, 0 /*0x0a*/,
zrussell3 0:b176d95bb38f 38 0, 0, 0, 0, 0/*0x0f*/,
zrussell3 0:b176d95bb38f 39 0, 0, 0, 0, 0/*0x14*/,
zrussell3 0:b176d95bb38f 40 0, 0, 0, 0, 0/*0x19*/,
zrussell3 0:b176d95bb38f 41 0, 0, 0, 0, 0/*0x1E*/,
zrussell3 0:b176d95bb38f 42 0, 0, 0, 0, 0/*0x23*/,
zrussell3 0:b176d95bb38f 43 0, 0, 0, 0, 0 /*enter*/, /*0x28*/
zrussell3 0:b176d95bb38f 44 0, 0, 0, 0, 0, /*0x2d*/
zrussell3 0:b176d95bb38f 45 0, 0, 0, 0, 0, /*0x32*/
zrussell3 0:b176d95bb38f 46 0, 0, 0, 0, 0, /*0x37*/
zrussell3 0:b176d95bb38f 47 0},
zrussell3 0:b176d95bb38f 48
zrussell3 0:b176d95bb38f 49 /* SHIFT MODIFIER */
zrussell3 0:b176d95bb38f 50 { 0, 0, 0, 0, 'A', 'B' /*0x05*/,
zrussell3 0:b176d95bb38f 51 'C', 'D', 'E', 'F', 'G' /*0x0a*/,
zrussell3 0:b176d95bb38f 52 'H', 'I', 'J', 'K', 'L'/*0x0f*/,
zrussell3 0:b176d95bb38f 53 'M', 'N', 'O', 'P', 'Q'/*0x14*/,
zrussell3 0:b176d95bb38f 54 'R', 'S', 'T', 'U', 'V'/*0x19*/,
zrussell3 0:b176d95bb38f 55 'W', 'X', 'Y', 'Z', '!'/*0x1E*/,
zrussell3 0:b176d95bb38f 56 '@', '#', '$', '%', '^'/*0x23*/,
zrussell3 0:b176d95bb38f 57 '&', '*', '(', ')', 0, /*0x28*/
zrussell3 0:b176d95bb38f 58 0, 0, 0, 0, 0, /*0x2d*/
zrussell3 0:b176d95bb38f 59 '+', '{', '}', '|', '~', /*0x32*/
zrussell3 0:b176d95bb38f 60 ':', '"', 0, '<', '>', /*0x37*/
zrussell3 0:b176d95bb38f 61 '?'},
zrussell3 0:b176d95bb38f 62
zrussell3 0:b176d95bb38f 63 /* ALT MODIFIER */
zrussell3 0:b176d95bb38f 64 { 0, 0, 0, 0, 0, 0 /*0x05*/,
zrussell3 0:b176d95bb38f 65 0, 0, 0, 0, 0 /*0x0a*/,
zrussell3 0:b176d95bb38f 66 0, 0, 0, 0, 0/*0x0f*/,
zrussell3 0:b176d95bb38f 67 0, 0, 0, 0, 0/*0x14*/,
zrussell3 0:b176d95bb38f 68 0, 0, 0, 0, 0/*0x19*/,
zrussell3 0:b176d95bb38f 69 0, 0, 0, 0, 0/*0x1E*/,
zrussell3 0:b176d95bb38f 70 0, 0, 0, 0, 0/*0x23*/,
zrussell3 0:b176d95bb38f 71 0, 0, 0, 0, 0 /*enter*/, /*0x28*/
zrussell3 0:b176d95bb38f 72 0, 0, 0, 0, 0, /*0x2d*/
zrussell3 0:b176d95bb38f 73 0, 0, 0, 0, 0, /*0x32*/
zrussell3 0:b176d95bb38f 74 0, 0, 0, 0, 0, /*0x37*/
zrussell3 0:b176d95bb38f 75 0}
zrussell3 0:b176d95bb38f 76
zrussell3 0:b176d95bb38f 77 };
zrussell3 0:b176d95bb38f 78
zrussell3 0:b176d95bb38f 79
zrussell3 0:b176d95bb38f 80 USBHostKeyboard::USBHostKeyboard() {
zrussell3 0:b176d95bb38f 81 host = USBHost::getHostInst();
zrussell3 0:b176d95bb38f 82 init();
zrussell3 0:b176d95bb38f 83 }
zrussell3 0:b176d95bb38f 84
zrussell3 0:b176d95bb38f 85
zrussell3 0:b176d95bb38f 86 void USBHostKeyboard::init() {
zrussell3 0:b176d95bb38f 87 dev = NULL;
zrussell3 0:b176d95bb38f 88 int_in = NULL;
zrussell3 0:b176d95bb38f 89 report_id = 0;
zrussell3 0:b176d95bb38f 90 onKey = NULL;
zrussell3 0:b176d95bb38f 91 onKeyCode = NULL;
zrussell3 0:b176d95bb38f 92 dev_connected = false;
zrussell3 0:b176d95bb38f 93 keyboard_intf = -1;
zrussell3 0:b176d95bb38f 94 keyboard_device_found = false;
zrussell3 0:b176d95bb38f 95 }
zrussell3 0:b176d95bb38f 96
zrussell3 0:b176d95bb38f 97 bool USBHostKeyboard::connected() {
zrussell3 0:b176d95bb38f 98 return dev_connected;
zrussell3 0:b176d95bb38f 99 }
zrussell3 0:b176d95bb38f 100
zrussell3 0:b176d95bb38f 101
zrussell3 0:b176d95bb38f 102 bool USBHostKeyboard::connect() {
zrussell3 0:b176d95bb38f 103
zrussell3 0:b176d95bb38f 104 if (dev_connected) {
zrussell3 0:b176d95bb38f 105 return true;
zrussell3 0:b176d95bb38f 106 }
zrussell3 0:b176d95bb38f 107
zrussell3 0:b176d95bb38f 108 for (uint8_t i = 0; i < MAX_DEVICE_CONNECTED; i++) {
zrussell3 0:b176d95bb38f 109 if ((dev = host->getDevice(i)) != NULL) {
zrussell3 0:b176d95bb38f 110
zrussell3 0:b176d95bb38f 111 if (host->enumerate(dev, this))
zrussell3 0:b176d95bb38f 112 break;
zrussell3 0:b176d95bb38f 113
zrussell3 0:b176d95bb38f 114 if (keyboard_device_found) {
zrussell3 0:b176d95bb38f 115 int_in = dev->getEndpoint(keyboard_intf, INTERRUPT_ENDPOINT, IN);
zrussell3 0:b176d95bb38f 116
zrussell3 0:b176d95bb38f 117 if (!int_in)
zrussell3 0:b176d95bb38f 118 break;
zrussell3 0:b176d95bb38f 119
zrussell3 0:b176d95bb38f 120 USB_INFO("New Keyboard device: VID:%04x PID:%04x [dev: %p - intf: %d]", dev->getVid(), dev->getPid(), dev, keyboard_intf);
zrussell3 0:b176d95bb38f 121 dev->setName("Keyboard", keyboard_intf);
zrussell3 0:b176d95bb38f 122 host->registerDriver(dev, keyboard_intf, this, &USBHostKeyboard::init);
zrussell3 0:b176d95bb38f 123
zrussell3 0:b176d95bb38f 124 int_in->attach(this, &USBHostKeyboard::rxHandler);
zrussell3 0:b176d95bb38f 125 host->interruptRead(dev, int_in, report, int_in->getSize(), false);
zrussell3 0:b176d95bb38f 126
zrussell3 0:b176d95bb38f 127 dev_connected = true;
zrussell3 0:b176d95bb38f 128 return true;
zrussell3 0:b176d95bb38f 129 }
zrussell3 0:b176d95bb38f 130 }
zrussell3 0:b176d95bb38f 131 }
zrussell3 0:b176d95bb38f 132 init();
zrussell3 0:b176d95bb38f 133 return false;
zrussell3 0:b176d95bb38f 134 }
zrussell3 0:b176d95bb38f 135
zrussell3 0:b176d95bb38f 136 void USBHostKeyboard::rxHandler() {
zrussell3 0:b176d95bb38f 137 int len = int_in->getLengthTransferred();
zrussell3 0:b176d95bb38f 138 int index = (len == 9) ? 1 : 0;
zrussell3 0:b176d95bb38f 139 int len_listen = int_in->getSize();
zrussell3 0:b176d95bb38f 140 uint8_t key = 0;
zrussell3 0:b176d95bb38f 141 if (len == 8 || len == 9) {
zrussell3 0:b176d95bb38f 142 uint8_t modifier = (report[index] == 4) ? 3 : report[index];
zrussell3 0:b176d95bb38f 143 len_listen = len;
zrussell3 0:b176d95bb38f 144 key = keymap[modifier][report[index + 2]];
zrussell3 0:b176d95bb38f 145 if (key && onKey) {
zrussell3 0:b176d95bb38f 146 (*onKey)(key);
zrussell3 0:b176d95bb38f 147 }
zrussell3 0:b176d95bb38f 148 if ((report[index + 2] || modifier) && onKeyCode) {
zrussell3 0:b176d95bb38f 149 //(*onKeyCode)(report[index + 2], modifier);
zrussell3 0:b176d95bb38f 150 (*onKeyCode)(key, modifier);
zrussell3 0:b176d95bb38f 151 }
zrussell3 0:b176d95bb38f 152 }
zrussell3 0:b176d95bb38f 153 if (dev && int_in)
zrussell3 0:b176d95bb38f 154 host->interruptRead(dev, int_in, report, len_listen, false);
zrussell3 0:b176d95bb38f 155 }
zrussell3 0:b176d95bb38f 156
zrussell3 0:b176d95bb38f 157 /*virtual*/ void USBHostKeyboard::setVidPid(uint16_t vid, uint16_t pid)
zrussell3 0:b176d95bb38f 158 {
zrussell3 0:b176d95bb38f 159 // we don't check VID/PID for keyboard driver
zrussell3 0:b176d95bb38f 160 }
zrussell3 0:b176d95bb38f 161
zrussell3 0:b176d95bb38f 162 /*virtual*/ bool USBHostKeyboard::parseInterface(uint8_t intf_nb, uint8_t intf_class, uint8_t intf_subclass, uint8_t intf_protocol) //Must return true if the interface should be parsed
zrussell3 0:b176d95bb38f 163 {
zrussell3 0:b176d95bb38f 164 if ((keyboard_intf == -1) &&
zrussell3 0:b176d95bb38f 165 (intf_class == HID_CLASS) &&
zrussell3 0:b176d95bb38f 166 (intf_subclass == 0x01) &&
zrussell3 0:b176d95bb38f 167 (intf_protocol == 0x01)) {
zrussell3 0:b176d95bb38f 168 keyboard_intf = intf_nb;
zrussell3 0:b176d95bb38f 169 return true;
zrussell3 0:b176d95bb38f 170 }
zrussell3 0:b176d95bb38f 171 return false;
zrussell3 0:b176d95bb38f 172 }
zrussell3 0:b176d95bb38f 173
zrussell3 0:b176d95bb38f 174 /*virtual*/ bool USBHostKeyboard::useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir) //Must return true if the endpoint will be used
zrussell3 0:b176d95bb38f 175 {
zrussell3 0:b176d95bb38f 176 if (intf_nb == keyboard_intf) {
zrussell3 0:b176d95bb38f 177 if (type == INTERRUPT_ENDPOINT && dir == IN) {
zrussell3 0:b176d95bb38f 178 keyboard_device_found = true;
zrussell3 0:b176d95bb38f 179 return true;
zrussell3 0:b176d95bb38f 180 }
zrussell3 0:b176d95bb38f 181 }
zrussell3 0:b176d95bb38f 182 return false;
zrussell3 0:b176d95bb38f 183 }
zrussell3 0:b176d95bb38f 184
zrussell3 0:b176d95bb38f 185 #endif