USBHost library with fixes

Dependencies:   mbed-rtos FATFileSystem

Dependents:   mbedica

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 "USBHostHub.h"
zrussell3 0:b176d95bb38f 18
zrussell3 0:b176d95bb38f 19 #if MAX_HUB_NB
zrussell3 0:b176d95bb38f 20
zrussell3 0:b176d95bb38f 21 #include "USBHost.h"
zrussell3 0:b176d95bb38f 22 #include "dbg.h"
zrussell3 0:b176d95bb38f 23
zrussell3 0:b176d95bb38f 24 #define GET_STATUS 0x00
zrussell3 0:b176d95bb38f 25 #define CLEAR_FEATURE 0x01
zrussell3 0:b176d95bb38f 26 #define GET_STATE 0x02
zrussell3 0:b176d95bb38f 27 #define SET_FEATURE 0x03
zrussell3 0:b176d95bb38f 28 #define GET_DESCRIPTOR 0x06
zrussell3 0:b176d95bb38f 29
zrussell3 0:b176d95bb38f 30 #define PORT_CONNECTION_FEATURE (0x00)
zrussell3 0:b176d95bb38f 31 #define PORT_ENABLE_FEATURE (0x01)
zrussell3 0:b176d95bb38f 32 #define PORT_RESET_FEATURE (0x04)
zrussell3 0:b176d95bb38f 33 #define PORT_POWER_FEATURE (0x08)
zrussell3 0:b176d95bb38f 34
zrussell3 0:b176d95bb38f 35 #define C_PORT_CONNECTION_FEATURE (16)
zrussell3 0:b176d95bb38f 36 #define C_PORT_ENABLE_FEATURE (17)
zrussell3 0:b176d95bb38f 37 #define C_PORT_RESET_FEATURE (20)
zrussell3 0:b176d95bb38f 38
zrussell3 0:b176d95bb38f 39 #define PORT_CONNECTION (1 << 0)
zrussell3 0:b176d95bb38f 40 #define PORT_ENABLE (1 << 1)
zrussell3 0:b176d95bb38f 41 #define PORT_SUSPEND (1 << 2)
zrussell3 0:b176d95bb38f 42 #define PORT_OVER_CURRENT (1 << 3)
zrussell3 0:b176d95bb38f 43 #define PORT_RESET (1 << 4)
zrussell3 0:b176d95bb38f 44 #define PORT_POWER (1 << 8)
zrussell3 0:b176d95bb38f 45 #define PORT_LOW_SPEED (1 << 9)
zrussell3 0:b176d95bb38f 46
zrussell3 0:b176d95bb38f 47 #define C_PORT_CONNECTION (1 << 16)
zrussell3 0:b176d95bb38f 48 #define C_PORT_ENABLE (1 << 17)
zrussell3 0:b176d95bb38f 49 #define C_PORT_SUSPEND (1 << 18)
zrussell3 0:b176d95bb38f 50 #define C_PORT_OVER_CURRENT (1 << 19)
zrussell3 0:b176d95bb38f 51 #define C_PORT_RESET (1 << 20)
zrussell3 0:b176d95bb38f 52
zrussell3 0:b176d95bb38f 53 USBHostHub::USBHostHub() {
zrussell3 0:b176d95bb38f 54 host = NULL;
zrussell3 0:b176d95bb38f 55 init();
zrussell3 0:b176d95bb38f 56 }
zrussell3 0:b176d95bb38f 57
zrussell3 0:b176d95bb38f 58 void USBHostHub::init() {
zrussell3 0:b176d95bb38f 59 dev_connected = false;
zrussell3 0:b176d95bb38f 60 dev = NULL;
zrussell3 0:b176d95bb38f 61 int_in = NULL;
zrussell3 0:b176d95bb38f 62 dev_connected = false;
zrussell3 0:b176d95bb38f 63 hub_intf = -1;
zrussell3 0:b176d95bb38f 64 hub_device_found = false;
zrussell3 0:b176d95bb38f 65 nb_port = 0;
zrussell3 0:b176d95bb38f 66 hub_characteristics = 0;
zrussell3 0:b176d95bb38f 67
zrussell3 0:b176d95bb38f 68 for (int i = 0; i < MAX_HUB_PORT; i++) {
zrussell3 0:b176d95bb38f 69 device_children[i] = NULL;
zrussell3 0:b176d95bb38f 70 }
zrussell3 0:b176d95bb38f 71 }
zrussell3 0:b176d95bb38f 72
zrussell3 0:b176d95bb38f 73 void USBHostHub::setHost(USBHost * host_) {
zrussell3 0:b176d95bb38f 74 host = host_;
zrussell3 0:b176d95bb38f 75 }
zrussell3 0:b176d95bb38f 76
zrussell3 0:b176d95bb38f 77 bool USBHostHub::connected()
zrussell3 0:b176d95bb38f 78 {
zrussell3 0:b176d95bb38f 79 return dev_connected;
zrussell3 0:b176d95bb38f 80 }
zrussell3 0:b176d95bb38f 81
zrussell3 0:b176d95bb38f 82 bool USBHostHub::connect(USBDeviceConnected * dev)
zrussell3 0:b176d95bb38f 83 {
zrussell3 0:b176d95bb38f 84 if (dev_connected) {
zrussell3 0:b176d95bb38f 85 return true;
zrussell3 0:b176d95bb38f 86 }
zrussell3 0:b176d95bb38f 87
zrussell3 0:b176d95bb38f 88 if(host->enumerate(dev, this)) {
zrussell3 0:b176d95bb38f 89 init();
zrussell3 0:b176d95bb38f 90 return false;
zrussell3 0:b176d95bb38f 91 }
zrussell3 0:b176d95bb38f 92
zrussell3 0:b176d95bb38f 93 if (hub_device_found) {
zrussell3 0:b176d95bb38f 94 this->dev = dev;
zrussell3 0:b176d95bb38f 95
zrussell3 0:b176d95bb38f 96 int_in = dev->getEndpoint(hub_intf, INTERRUPT_ENDPOINT, IN);
zrussell3 0:b176d95bb38f 97
zrussell3 0:b176d95bb38f 98 if (!int_in) {
zrussell3 0:b176d95bb38f 99 init();
zrussell3 0:b176d95bb38f 100 return false;
zrussell3 0:b176d95bb38f 101 }
zrussell3 0:b176d95bb38f 102
zrussell3 0:b176d95bb38f 103 USB_INFO("New HUB: VID:%04x PID:%04x [dev: %p - intf: %d]", dev->getVid(), dev->getPid(), dev, hub_intf);
zrussell3 0:b176d95bb38f 104 dev->setName("Hub", hub_intf);
zrussell3 0:b176d95bb38f 105 host->registerDriver(dev, hub_intf, this, &USBHostHub::disconnect);
zrussell3 0:b176d95bb38f 106
zrussell3 0:b176d95bb38f 107 int_in->attach(this, &USBHostHub::rxHandler);
zrussell3 0:b176d95bb38f 108
zrussell3 0:b176d95bb38f 109 // get HUB descriptor
zrussell3 0:b176d95bb38f 110 host->controlRead( dev,
zrussell3 0:b176d95bb38f 111 USB_DEVICE_TO_HOST | USB_REQUEST_TYPE_CLASS,
zrussell3 0:b176d95bb38f 112 GET_DESCRIPTOR,
zrussell3 0:b176d95bb38f 113 0x29 << 8, 0, buf, sizeof(HubDescriptor));
zrussell3 0:b176d95bb38f 114 nb_port = buf[2];
zrussell3 0:b176d95bb38f 115 hub_characteristics = buf[3];
zrussell3 0:b176d95bb38f 116
zrussell3 0:b176d95bb38f 117 USB_DBG("Hub has %d port", nb_port);
zrussell3 0:b176d95bb38f 118
zrussell3 0:b176d95bb38f 119 for (uint8_t j = 1; j <= nb_port; j++) {
zrussell3 0:b176d95bb38f 120 setPortFeature(PORT_POWER_FEATURE, j);
zrussell3 0:b176d95bb38f 121 }
zrussell3 0:b176d95bb38f 122 wait_ms(buf[5]*2);
zrussell3 0:b176d95bb38f 123
zrussell3 0:b176d95bb38f 124 host->interruptRead(dev, int_in, buf, 1, false);
zrussell3 0:b176d95bb38f 125 dev_connected = true;
zrussell3 0:b176d95bb38f 126 return true;
zrussell3 0:b176d95bb38f 127 }
zrussell3 0:b176d95bb38f 128
zrussell3 0:b176d95bb38f 129 return false;
zrussell3 0:b176d95bb38f 130 }
zrussell3 0:b176d95bb38f 131
zrussell3 0:b176d95bb38f 132 void USBHostHub::disconnect() {
zrussell3 0:b176d95bb38f 133 init();
zrussell3 0:b176d95bb38f 134 }
zrussell3 0:b176d95bb38f 135
zrussell3 0:b176d95bb38f 136 /*virtual*/ void USBHostHub::setVidPid(uint16_t vid, uint16_t pid)
zrussell3 0:b176d95bb38f 137 {
zrussell3 0:b176d95bb38f 138 // we don't check VID/PID for MSD driver
zrussell3 0:b176d95bb38f 139 }
zrussell3 0:b176d95bb38f 140
zrussell3 0:b176d95bb38f 141 /*virtual*/ bool USBHostHub::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 142 {
zrussell3 0:b176d95bb38f 143 if ((hub_intf == -1) &&
zrussell3 0:b176d95bb38f 144 (intf_class == HUB_CLASS) &&
zrussell3 0:b176d95bb38f 145 (intf_subclass == 0) &&
zrussell3 0:b176d95bb38f 146 (intf_protocol == 0)) {
zrussell3 0:b176d95bb38f 147 hub_intf = intf_nb;
zrussell3 0:b176d95bb38f 148 return true;
zrussell3 0:b176d95bb38f 149 }
zrussell3 0:b176d95bb38f 150 return false;
zrussell3 0:b176d95bb38f 151 }
zrussell3 0:b176d95bb38f 152
zrussell3 0:b176d95bb38f 153 /*virtual*/ bool USBHostHub::useEndpoint(uint8_t intf_nb, ENDPOINT_TYPE type, ENDPOINT_DIRECTION dir) //Must return true if the endpoint will be used
zrussell3 0:b176d95bb38f 154 {
zrussell3 0:b176d95bb38f 155 if (intf_nb == hub_intf) {
zrussell3 0:b176d95bb38f 156 if ((type == INTERRUPT_ENDPOINT) && (dir == IN)) {
zrussell3 0:b176d95bb38f 157 hub_device_found = true;
zrussell3 0:b176d95bb38f 158 return true;
zrussell3 0:b176d95bb38f 159 }
zrussell3 0:b176d95bb38f 160 }
zrussell3 0:b176d95bb38f 161 return false;
zrussell3 0:b176d95bb38f 162 }
zrussell3 0:b176d95bb38f 163
zrussell3 0:b176d95bb38f 164 void USBHostHub::deviceConnected(USBDeviceConnected * dev) {
zrussell3 0:b176d95bb38f 165 device_children[dev->getPort() - 1] = dev;
zrussell3 0:b176d95bb38f 166 }
zrussell3 0:b176d95bb38f 167
zrussell3 0:b176d95bb38f 168 void USBHostHub::deviceDisconnected(USBDeviceConnected * dev) {
zrussell3 0:b176d95bb38f 169 device_children[dev->getPort() - 1] = NULL;
zrussell3 0:b176d95bb38f 170 }
zrussell3 0:b176d95bb38f 171
zrussell3 0:b176d95bb38f 172 void USBHostHub::hubDisconnected() {
zrussell3 0:b176d95bb38f 173 for (uint8_t i = 0; i < MAX_HUB_PORT; i++) {
zrussell3 0:b176d95bb38f 174 if (device_children[i] != NULL) {
zrussell3 0:b176d95bb38f 175 host->freeDevice(device_children[i]);
zrussell3 0:b176d95bb38f 176 }
zrussell3 0:b176d95bb38f 177 }
zrussell3 0:b176d95bb38f 178 }
zrussell3 0:b176d95bb38f 179
zrussell3 0:b176d95bb38f 180 void USBHostHub::rxHandler() {
zrussell3 0:b176d95bb38f 181 uint32_t status;
zrussell3 0:b176d95bb38f 182 if (int_in) {
zrussell3 0:b176d95bb38f 183 if (int_in->getState() == USB_TYPE_IDLE) {
zrussell3 0:b176d95bb38f 184 for (int port = 1; port <= nb_port; port++) {
zrussell3 0:b176d95bb38f 185 status = getPortStatus(port);
zrussell3 0:b176d95bb38f 186 USB_DBG("[hub handler hub: %d] status port %d [hub: %p]: 0x%X", dev->getHub(), port, dev, status);
zrussell3 0:b176d95bb38f 187
zrussell3 0:b176d95bb38f 188 // if connection status has changed
zrussell3 0:b176d95bb38f 189 if (status & C_PORT_CONNECTION) {
zrussell3 0:b176d95bb38f 190 if (status & PORT_CONNECTION) {
zrussell3 0:b176d95bb38f 191 USB_DBG("[hub handler hub: %d - port: %d] new device connected", dev->getHub(), port);
zrussell3 0:b176d95bb38f 192 host->deviceConnected(dev->getHub() + 1, port, status & PORT_LOW_SPEED, this);
zrussell3 0:b176d95bb38f 193 } else {
zrussell3 0:b176d95bb38f 194 USB_DBG("[hub handler hub: %d - port: %d] device disconnected", dev->getHub(), port);
zrussell3 0:b176d95bb38f 195 host->deviceDisconnected(dev->getHub() + 1, port, this, 0);
zrussell3 0:b176d95bb38f 196 }
zrussell3 0:b176d95bb38f 197
zrussell3 0:b176d95bb38f 198 clearPortFeature(C_PORT_CONNECTION_FEATURE, port);
zrussell3 0:b176d95bb38f 199 }
zrussell3 0:b176d95bb38f 200
zrussell3 0:b176d95bb38f 201 if (status & C_PORT_RESET) {
zrussell3 0:b176d95bb38f 202 clearPortFeature(C_PORT_RESET_FEATURE, port);
zrussell3 0:b176d95bb38f 203 }
zrussell3 0:b176d95bb38f 204
zrussell3 0:b176d95bb38f 205 if (status & C_PORT_ENABLE) {
zrussell3 0:b176d95bb38f 206 clearPortFeature(C_PORT_ENABLE_FEATURE, port);
zrussell3 0:b176d95bb38f 207 }
zrussell3 0:b176d95bb38f 208
zrussell3 0:b176d95bb38f 209 if ((status & PORT_OVER_CURRENT)) {
zrussell3 0:b176d95bb38f 210 USB_ERR("OVER CURRENT DETECTED\r\n");
zrussell3 0:b176d95bb38f 211 clearPortFeature(PORT_OVER_CURRENT, port);
zrussell3 0:b176d95bb38f 212 host->deviceDisconnected(dev->getHub() + 1, port, this, 0);
zrussell3 0:b176d95bb38f 213 }
zrussell3 0:b176d95bb38f 214 }
zrussell3 0:b176d95bb38f 215 }
zrussell3 0:b176d95bb38f 216 host->interruptRead(dev, int_in, buf, 1, false);
zrussell3 0:b176d95bb38f 217 }
zrussell3 0:b176d95bb38f 218 }
zrussell3 0:b176d95bb38f 219
zrussell3 0:b176d95bb38f 220 void USBHostHub::portReset(uint8_t port) {
zrussell3 0:b176d95bb38f 221 // reset port
zrussell3 0:b176d95bb38f 222 uint32_t status;
zrussell3 0:b176d95bb38f 223 USB_DBG("reset port %d on hub: %p [this: %p]", port, dev, this)
zrussell3 0:b176d95bb38f 224 setPortFeature(PORT_RESET_FEATURE, port);
zrussell3 0:b176d95bb38f 225 while(1) {
zrussell3 0:b176d95bb38f 226 status = getPortStatus(port);
zrussell3 0:b176d95bb38f 227 if (status & (PORT_ENABLE | PORT_RESET))
zrussell3 0:b176d95bb38f 228 break;
zrussell3 0:b176d95bb38f 229 if (status & PORT_OVER_CURRENT) {
zrussell3 0:b176d95bb38f 230 USB_ERR("OVER CURRENT DETECTED\r\n");
zrussell3 0:b176d95bb38f 231 clearPortFeature(PORT_OVER_CURRENT, port);
zrussell3 0:b176d95bb38f 232 host->deviceDisconnected(dev->getHub() + 1, port, this, 0);
zrussell3 0:b176d95bb38f 233 break;
zrussell3 0:b176d95bb38f 234 }
zrussell3 0:b176d95bb38f 235 Thread::wait(10);
zrussell3 0:b176d95bb38f 236 }
zrussell3 0:b176d95bb38f 237 }
zrussell3 0:b176d95bb38f 238
zrussell3 0:b176d95bb38f 239 void USBHostHub::setPortFeature(uint32_t feature, uint8_t port) {
zrussell3 0:b176d95bb38f 240 host->controlWrite( dev,
zrussell3 0:b176d95bb38f 241 USB_HOST_TO_DEVICE | USB_REQUEST_TYPE_CLASS | USB_RECIPIENT_INTERFACE | USB_RECIPIENT_ENDPOINT,
zrussell3 0:b176d95bb38f 242 SET_FEATURE,
zrussell3 0:b176d95bb38f 243 feature,
zrussell3 0:b176d95bb38f 244 port,
zrussell3 0:b176d95bb38f 245 NULL,
zrussell3 0:b176d95bb38f 246 0);
zrussell3 0:b176d95bb38f 247 }
zrussell3 0:b176d95bb38f 248
zrussell3 0:b176d95bb38f 249 void USBHostHub::clearPortFeature(uint32_t feature, uint8_t port) {
zrussell3 0:b176d95bb38f 250 host->controlWrite( dev,
zrussell3 0:b176d95bb38f 251 USB_HOST_TO_DEVICE | USB_REQUEST_TYPE_CLASS | USB_RECIPIENT_INTERFACE | USB_RECIPIENT_ENDPOINT,
zrussell3 0:b176d95bb38f 252 CLEAR_FEATURE,
zrussell3 0:b176d95bb38f 253 feature,
zrussell3 0:b176d95bb38f 254 port,
zrussell3 0:b176d95bb38f 255 NULL,
zrussell3 0:b176d95bb38f 256 0);
zrussell3 0:b176d95bb38f 257 }
zrussell3 0:b176d95bb38f 258
zrussell3 0:b176d95bb38f 259 uint32_t USBHostHub::getPortStatus(uint8_t port) {
zrussell3 0:b176d95bb38f 260 uint32_t st;
zrussell3 0:b176d95bb38f 261 host->controlRead( dev,
zrussell3 0:b176d95bb38f 262 USB_DEVICE_TO_HOST | USB_REQUEST_TYPE_CLASS | USB_RECIPIENT_INTERFACE | USB_RECIPIENT_ENDPOINT,
zrussell3 0:b176d95bb38f 263 GET_STATUS,
zrussell3 0:b176d95bb38f 264 0,
zrussell3 0:b176d95bb38f 265 port,
zrussell3 0:b176d95bb38f 266 (uint8_t *)&st,
zrussell3 0:b176d95bb38f 267 4);
zrussell3 0:b176d95bb38f 268 return st;
zrussell3 0:b176d95bb38f 269 }
zrussell3 0:b176d95bb38f 270
zrussell3 0:b176d95bb38f 271 #endif