Dave Van Wagner / USBHOST

ST/USBHOST forked to add another HID handler for raw keyboard data to get more detail not available with current handlers (all pressed keys, all releases, and periodic updates)

Dependents:   C64-stm429_discovery

USBHostHID/USBHostMouse.cpp@7:9dc1cb9d5e12, 2020-04-13 (annotated)

Committer:
davervw
Date:
Mon Apr 13 05:25:10 2020 +0000
Revision:
7:9dc1cb9d5e12
Parent:
5:fc157e6bd5a5 
Added handler to USBHostHID/USBHostKeyboard.cpp:;    void (*onKeyData)(uint8_t len, uint8_t* data);; so can get raw keyboard data for all keys simultaneously pressed, and all releases and periodic data

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 1 /* mbed USBHost Library
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 2 * Copyright (c) 2006-2013 ARM Limited
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 3 *
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 4 * Licensed under the Apache License, Version 2.0 (the "License");
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 5 * you may not use this file except in compliance with the License.
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 6 * You may obtain a copy of the License at
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 7 *
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 8 * http://www.apache.org/licenses/LICENSE-2.0
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 9 *
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 10 * Unless required by applicable law or agreed to in writing, software
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 11 * distributed under the License is distributed on an "AS IS" BASIS,
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 13 * See the License for the specific language governing permissions and
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 14 * limitations under the License.
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 15 */
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 16
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 17 #include "USBHostMouse.h"
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 18
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 19 #if USBHOST_MOUSE
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 20
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 21 USBHostMouse::USBHostMouse() {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 22 host = USBHost::getHostInst();
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 23 init();
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 24 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 25
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 26 void USBHostMouse::init() {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 27 dev = NULL;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 28 int_in = NULL;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 29 onUpdate = NULL;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 30 onButtonUpdate = NULL;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 31 onXUpdate = NULL;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 32 onYUpdate = NULL;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 33 onZUpdate = NULL;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 34 report_id = 0;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 35 dev_connected = false;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 36 mouse_device_found = false;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 37 mouse_intf = -1;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 38
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 39 buttons = 0;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 40 x = 0;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 41 y = 0;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 42 z = 0;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 43 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 44
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 45 bool USBHostMouse::connected() {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 46 return dev_connected;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 47 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 48
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 49 bool USBHostMouse::connect()
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 50 {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 51 int len_listen;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 52
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 53 if (dev_connected) {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 54 return true;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 55 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 56
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 57 for (uint8_t i = 0; i < MAX_DEVICE_CONNECTED; i++) {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 58 if ((dev = host->getDevice(i)) != NULL) {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 59
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 60 if(host->enumerate(dev, this))
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 61 break;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 62 if (mouse_device_found) {
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 63 {
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 64 /* As this is done in a specific thread
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 65 * this lock is taken to avoid to process the device
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 66 * disconnect in usb process during the device registering */
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 67 USBHost::Lock Lock(host);
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 68 int_in = dev->getEndpoint(mouse_intf, INTERRUPT_ENDPOINT, IN);
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 69 if (!int_in)
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 70 break;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 71
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 72 USB_INFO("New Mouse device: VID:%04x PID:%04x [dev: %p - intf: %d]", dev->getVid(), dev->getPid(), dev, mouse_intf);
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 73 dev->setName("Mouse", mouse_intf);
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 74 host->registerDriver(dev, mouse_intf, this, &USBHostMouse::init);
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 75
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 76 int_in->attach(this, &USBHostMouse::rxHandler);
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 77 len_listen = int_in->getSize();
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 78 if (len_listen > sizeof(report)) {
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 79 len_listen = sizeof(report);
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 80 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 81 }
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 82 int ret=host->interruptRead(dev, int_in, report, len_listen, false);
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 83 MBED_ASSERT((ret==USB_TYPE_OK) || (ret ==USB_TYPE_PROCESSING) || (ret == USB_TYPE_FREE));
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 84 if ((ret==USB_TYPE_OK) || (ret ==USB_TYPE_PROCESSING))
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 85 dev_connected = true;
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 86 if (ret == USB_TYPE_FREE)
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 87 dev_connected = false;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 88 return true;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 89 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 90 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 91 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 92 init();
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 93 return false;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 94 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 95
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 96 void USBHostMouse::rxHandler() {
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 97 int len_listen = int_in->getLengthTransferred();
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 98 if (len_listen !=0) {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 99
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 100 if (onUpdate) {
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 101 (*onUpdate)(report[0] & 0x07, report[1], report[2], report[3]);
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 102 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 103
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 104 if (onButtonUpdate && (buttons != (report[0] & 0x07))) {
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 105 (*onButtonUpdate)(report[0] & 0x07);
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 106 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 107
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 108 if (onXUpdate && (x != report[1])) {
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 109 (*onXUpdate)(report[1]);
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 110 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 111
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 112 if (onYUpdate && (y != report[2])) {
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 113 (*onYUpdate)(report[2]);
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 114 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 115
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 116 if (onZUpdate && (z != report[3])) {
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 117 (*onZUpdate)(report[3]);
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 118 }
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 119
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 120 // update mouse state
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 121 buttons = report[0] & 0x07;
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 122 x = report[1];
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 123 y = report[2];
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 124 z = report[3];
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 125 }
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 126 /* set again the maximum value */
frq08711@LMECWL0871.LME.ST.COM 5:fc157e6bd5a5 127 len_listen = int_in->getSize();
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 128
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 129 if (len_listen > sizeof(report)) {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 130 len_listen = sizeof(report);
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 131 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 132
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 133 if (dev)
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 134 host->interruptRead(dev, int_in, report, len_listen, false);
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 135 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 136
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 137 /*virtual*/ void USBHostMouse::setVidPid(uint16_t vid, uint16_t pid)
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 138 {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 139 // we don't check VID/PID for mouse driver
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 140 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 141
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 142 /*virtual*/ bool USBHostMouse::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
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 143 {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 144 if ((mouse_intf == -1) &&
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 145 (intf_class == HID_CLASS) &&
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 146 (intf_subclass == 0x01) &&
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 147 (intf_protocol == 0x02)) {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 148 mouse_intf = intf_nb;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 149 return true;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 150 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 151 return false;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 152 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 153
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 154 /*virtual*/ bool USBHostMouse::useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir) //Must return true if the endpoint will be used
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 155 {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 156 if (intf_nb == mouse_intf) {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 157 if (type == INTERRUPT_ENDPOINT && dir == IN) {
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 158 mouse_device_found = true;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 159 return true;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 160 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 161 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 162 return false;
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 163 }
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 164
frq08711@LMECWL0871.LME.ST.COM 1:ab240722d7ef 165 #endif