1 /* 2 * Copyright 2003-2006, Haiku Inc. All rights reserved. 3 * Distributed under the terms of the MIT License. 4 * 5 * Authors: 6 * Michael Lotz <mmlr@mlotz.ch> 7 * Niels S. Reedijk 8 */ 9 10 11 #include "usb_private.h" 12 13 #include <stdio.h> 14 15 #include <algorithm> 16 17 18 Hub::Hub(Object *parent, int8 hubAddress, uint8 hubPort, 19 usb_device_descriptor &desc, int8 deviceAddress, usb_speed speed, 20 bool isRootHub, void *controllerCookie) 21 : Device(parent, hubAddress, hubPort, desc, deviceAddress, speed, 22 isRootHub, controllerCookie), 23 fInterruptPipe(NULL) 24 { 25 TRACE("creating hub\n"); 26 27 memset(&fHubDescriptor, 0, sizeof(fHubDescriptor)); 28 for (int32 i = 0; i < USB_MAX_PORT_COUNT; i++) 29 fChildren[i] = NULL; 30 31 if (!fInitOK) { 32 TRACE_ERROR("device failed to initialize\n"); 33 return; 34 } 35 36 // Set to false again for the hub init. 37 fInitOK = false; 38 39 if (fDeviceDescriptor.device_class != 9) { 40 TRACE_ERROR("wrong class! bailing out\n"); 41 return; 42 } 43 44 TRACE("getting hub descriptor...\n"); 45 size_t actualLength; 46 status_t status = GetDescriptor(USB_DESCRIPTOR_HUB, 0, 0, 47 (void *)&fHubDescriptor, sizeof(usb_hub_descriptor), &actualLength); 48 49 // we need at least 8 bytes 50 if (status < B_OK || actualLength < 8) { 51 TRACE_ERROR("error getting hub descriptor\n"); 52 return; 53 } 54 55 TRACE("hub descriptor (%ld bytes):\n", actualLength); 56 TRACE("\tlength:..............%d\n", fHubDescriptor.length); 57 TRACE("\tdescriptor_type:.....0x%02x\n", fHubDescriptor.descriptor_type); 58 TRACE("\tnum_ports:...........%d\n", fHubDescriptor.num_ports); 59 TRACE("\tcharacteristics:.....0x%04x\n", fHubDescriptor.characteristics); 60 TRACE("\tpower_on_to_power_g:.%d\n", fHubDescriptor.power_on_to_power_good); 61 TRACE("\tdevice_removeable:...0x%02x\n", fHubDescriptor.device_removeable); 62 TRACE("\tpower_control_mask:..0x%02x\n", fHubDescriptor.power_control_mask); 63 64 if (fHubDescriptor.num_ports > USB_MAX_PORT_COUNT) { 65 TRACE_ALWAYS("hub supports more ports than we do (%d vs. %d)\n", 66 fHubDescriptor.num_ports, USB_MAX_PORT_COUNT); 67 fHubDescriptor.num_ports = USB_MAX_PORT_COUNT; 68 } 69 70 usb_interface_list *list = Configuration()->interface; 71 Object *object = GetStack()->GetObject(list->active->endpoint[0].handle); 72 if (object && (object->Type() & USB_OBJECT_INTERRUPT_PIPE) != 0) { 73 fInterruptPipe = (InterruptPipe *)object; 74 fInterruptPipe->QueueInterrupt(fInterruptStatus, 75 sizeof(fInterruptStatus), InterruptCallback, this); 76 } else { 77 TRACE_ALWAYS("no interrupt pipe found\n"); 78 } 79 80 // Wait some time before powering up the ports 81 if (!isRootHub) 82 snooze(USB_DELAY_HUB_POWER_UP); 83 84 // Enable port power on all ports 85 for (int32 i = 0; i < fHubDescriptor.num_ports; i++) { 86 status = DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 87 USB_REQUEST_SET_FEATURE, PORT_POWER, i + 1, 0, NULL, 0, NULL); 88 89 if (status < B_OK) 90 TRACE_ERROR("power up failed on port %" B_PRId32 "\n", i); 91 } 92 93 // Wait for power to stabilize 94 snooze(fHubDescriptor.power_on_to_power_good * 2000); 95 96 fInitOK = true; 97 TRACE("initialised ok\n"); 98 } 99 100 101 Hub::~Hub() 102 { 103 delete fInterruptPipe; 104 } 105 106 107 status_t 108 Hub::Changed(change_item **changeList, bool added) 109 { 110 status_t result = Device::Changed(changeList, added); 111 if (added || result < B_OK) 112 return result; 113 114 for (int32 i = 0; i < fHubDescriptor.num_ports; i++) { 115 if (fChildren[i] == NULL) 116 continue; 117 118 fChildren[i]->Changed(changeList, false); 119 fChildren[i] = NULL; 120 } 121 122 return B_OK; 123 } 124 125 126 status_t 127 Hub::UpdatePortStatus(uint8 index) 128 { 129 // get the current port status 130 size_t actualLength = 0; 131 status_t result = DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_IN, 132 USB_REQUEST_GET_STATUS, 0, index + 1, sizeof(usb_port_status), 133 (void *)&fPortStatus[index], sizeof(usb_port_status), &actualLength); 134 135 if (result < B_OK || actualLength < sizeof(usb_port_status)) { 136 TRACE_ERROR("error updating port status\n"); 137 return B_ERROR; 138 } 139 140 return B_OK; 141 } 142 143 144 status_t 145 Hub::ResetPort(uint8 index) 146 { 147 status_t result = DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 148 USB_REQUEST_SET_FEATURE, PORT_RESET, index + 1, 0, NULL, 0, NULL); 149 150 if (result < B_OK) 151 return result; 152 153 for (int32 i = 0; i < 10; i++) { 154 snooze(USB_DELAY_PORT_RESET); 155 156 result = UpdatePortStatus(index); 157 if (result < B_OK) 158 return result; 159 160 if ((fPortStatus[index].change & PORT_STATUS_RESET) != 0 161 || (fPortStatus[index].status & PORT_STATUS_RESET) == 0) { 162 // reset is done 163 break; 164 } 165 } 166 167 if ((fPortStatus[index].change & PORT_STATUS_RESET) == 0 168 && (fPortStatus[index].status & PORT_STATUS_RESET) != 0) { 169 TRACE_ERROR("port %d won't reset (%#x, %#x)\n", index, 170 fPortStatus[index].change, fPortStatus[index].status); 171 return B_ERROR; 172 } 173 174 // clear the reset change 175 result = DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 176 USB_REQUEST_CLEAR_FEATURE, C_PORT_RESET, index + 1, 0, NULL, 0, NULL); 177 if (result < B_OK) 178 return result; 179 180 // wait for reset recovery 181 snooze(USB_DELAY_PORT_RESET_RECOVERY); 182 TRACE("port %d was reset successfully\n", index); 183 return B_OK; 184 } 185 186 187 status_t 188 Hub::DisablePort(uint8 index) 189 { 190 return DefaultPipe()->SendRequest(USB_REQTYPE_CLASS 191 | USB_REQTYPE_OTHER_OUT, USB_REQUEST_CLEAR_FEATURE, PORT_ENABLE, 192 index + 1, 0, NULL, 0, NULL); 193 } 194 195 196 197 void 198 Hub::Explore(change_item **changeList) 199 { 200 for (int32 i = 0; i < fHubDescriptor.num_ports; i++) { 201 status_t result = UpdatePortStatus(i); 202 if (result < B_OK) 203 continue; 204 205 #ifdef TRACE_USB 206 if (fPortStatus[i].change) { 207 TRACE("port %" B_PRId32 ": status: 0x%04x; change: 0x%04x\n", i, 208 fPortStatus[i].status, fPortStatus[i].change); 209 TRACE("device at port %" B_PRId32 ": %p (%" B_PRId32 ")\n", i, 210 fChildren[i], fChildren[i] != NULL 211 ? fChildren[i]->USBID() : 0); 212 } 213 #endif 214 215 if (fPortStatus[i].change & PORT_STATUS_CONNECTION) { 216 // clear status change 217 DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 218 USB_REQUEST_CLEAR_FEATURE, C_PORT_CONNECTION, i + 1, 219 0, NULL, 0, NULL); 220 221 if (fPortStatus[i].status & PORT_STATUS_CONNECTION) { 222 // new device attached! 223 TRACE_ALWAYS("port %" B_PRId32 ": new device connected\n", i); 224 225 int32 retry = 2; 226 while (retry--) { 227 // wait for stable device power 228 result = _DebouncePort(i); 229 if (result != B_OK) { 230 TRACE_ERROR("debouncing port %" B_PRId32 231 " failed: %s\n", i, strerror(result)); 232 break; 233 } 234 235 // reset the port, this will also enable it 236 result = ResetPort(i); 237 if (result < B_OK) { 238 TRACE_ERROR("resetting port %" B_PRId32 " failed\n", 239 i); 240 break; 241 } 242 243 result = UpdatePortStatus(i); 244 if (result < B_OK) 245 break; 246 247 if ((fPortStatus[i].status & PORT_STATUS_CONNECTION) == 0) { 248 // device has vanished after reset, ignore 249 TRACE("device disappeared on reset\n"); 250 break; 251 } 252 253 if (fChildren[i] != NULL) { 254 TRACE_ERROR("new device on a port that is already in " 255 "use\n"); 256 fChildren[i]->Changed(changeList, false); 257 fChildren[i] = NULL; 258 } 259 260 usb_speed speed = USB_SPEED_FULLSPEED; 261 // Hack - We currently do not support USB3.0 Hubs 262 // This is for XHCI, which anyway rechecks the port speed 263 // This will in no way work for non-root USB3.0 Hubs 264 if (fDeviceDescriptor.usb_version == 0x300) 265 speed = USB_SPEED_SUPER; 266 else if (fPortStatus[i].status & PORT_STATUS_LOW_SPEED) 267 speed = USB_SPEED_LOWSPEED; 268 else if (fPortStatus[i].status & PORT_STATUS_HIGH_SPEED) 269 speed = USB_SPEED_HIGHSPEED; 270 271 // either let the device inherit our addresses (if we are 272 // already potentially using a transaction translator) or 273 // set ourselfs as the hub when we might become the 274 // transaction translator for the device. 275 int8 hubAddress = HubAddress(); 276 uint8 hubPort = HubPort(); 277 if (Speed() == USB_SPEED_HIGHSPEED || fDeviceDescriptor.usb_version == 0x300) { 278 hubAddress = DeviceAddress(); 279 hubPort = i + 1; 280 } 281 282 Device *newDevice = GetBusManager()->AllocateDevice(this, 283 hubAddress, hubPort, speed); 284 285 if (newDevice) { 286 newDevice->Changed(changeList, true); 287 fChildren[i] = newDevice; 288 break; 289 } else { 290 // the device failed to setup correctly, disable the 291 // port so that the device doesn't get in the way of 292 // future addressing. 293 DisablePort(i); 294 } 295 } 296 } else { 297 // Device removed... 298 TRACE_ALWAYS("port %" B_PRId32 ": device removed\n", i); 299 if (fChildren[i] != NULL) { 300 TRACE("removing device %p\n", fChildren[i]); 301 fChildren[i]->Changed(changeList, false); 302 fChildren[i] = NULL; 303 } 304 } 305 } 306 307 // other port changes we do not really handle, report and clear them 308 if (fPortStatus[i].change & PORT_STATUS_ENABLE) { 309 TRACE_ALWAYS("port %" B_PRId32 " %sabled\n", i, 310 (fPortStatus[i].status & PORT_STATUS_ENABLE) ? "en" : "dis"); 311 DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 312 USB_REQUEST_CLEAR_FEATURE, C_PORT_ENABLE, i + 1, 313 0, NULL, 0, NULL); 314 } 315 316 if (fPortStatus[i].change & PORT_STATUS_SUSPEND) { 317 TRACE_ALWAYS("port %" B_PRId32 " is %ssuspended\n", i, 318 (fPortStatus[i].status & PORT_STATUS_SUSPEND) ? "" : "not "); 319 DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 320 USB_REQUEST_CLEAR_FEATURE, C_PORT_SUSPEND, i + 1, 321 0, NULL, 0, NULL); 322 } 323 324 if (fPortStatus[i].change & PORT_STATUS_OVER_CURRENT) { 325 TRACE_ALWAYS("port %" B_PRId32 " is %sin an over current state\n", 326 i, (fPortStatus[i].status & PORT_STATUS_OVER_CURRENT) ? "" : "not "); 327 DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 328 USB_REQUEST_CLEAR_FEATURE, C_PORT_OVER_CURRENT, i + 1, 329 0, NULL, 0, NULL); 330 } 331 332 if (fPortStatus[i].change & PORT_STATUS_RESET) { 333 TRACE_ALWAYS("port %" B_PRId32 " was reset\n", i); 334 DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 335 USB_REQUEST_CLEAR_FEATURE, C_PORT_RESET, i + 1, 336 0, NULL, 0, NULL); 337 } 338 339 if (fPortStatus[i].change & PORT_CHANGE_LINK_STATE) { 340 TRACE_ALWAYS("port %" B_PRId32 " link state changed\n", i); 341 DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 342 USB_REQUEST_CLEAR_FEATURE, C_PORT_LINK_STATE, i + 1, 343 0, NULL, 0, NULL); 344 } 345 346 if (fPortStatus[i].change & PORT_CHANGE_BH_PORT_RESET) { 347 TRACE_ALWAYS("port %" B_PRId32 " was warm reset\n", i); 348 DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 349 USB_REQUEST_CLEAR_FEATURE, C_PORT_BH_PORT_RESET, i + 1, 350 0, NULL, 0, NULL); 351 } 352 353 } 354 355 // explore down the tree if we have hubs connected 356 for (int32 i = 0; i < fHubDescriptor.num_ports; i++) { 357 if (!fChildren[i] || (fChildren[i]->Type() & USB_OBJECT_HUB) == 0) 358 continue; 359 360 ((Hub *)fChildren[i])->Explore(changeList); 361 } 362 } 363 364 365 void 366 Hub::InterruptCallback(void *cookie, status_t status, void *data, 367 size_t actualLength) 368 { 369 TRACE_STATIC((Hub *)cookie, "interrupt callback!\n"); 370 } 371 372 373 status_t 374 Hub::GetDescriptor(uint8 descriptorType, uint8 index, uint16 languageID, 375 void *data, size_t dataLength, size_t *actualLength) 376 { 377 return DefaultPipe()->SendRequest( 378 USB_REQTYPE_DEVICE_IN | USB_REQTYPE_CLASS, // type 379 USB_REQUEST_GET_DESCRIPTOR, // request 380 (descriptorType << 8) | index, // value 381 languageID, // index 382 dataLength, // length 383 data, // buffer 384 dataLength, // buffer length 385 actualLength); // actual length 386 } 387 388 389 status_t 390 Hub::ReportDevice(usb_support_descriptor *supportDescriptors, 391 uint32 supportDescriptorCount, const usb_notify_hooks *hooks, 392 usb_driver_cookie **cookies, bool added, bool recursive) 393 { 394 status_t result = B_UNSUPPORTED; 395 396 if (added) { 397 // Report hub before children when adding devices 398 TRACE("reporting hub before children\n"); 399 result = Device::ReportDevice(supportDescriptors, 400 supportDescriptorCount, hooks, cookies, added, recursive); 401 } 402 403 for (int32 i = 0; recursive && i < fHubDescriptor.num_ports; i++) { 404 if (!fChildren[i]) 405 continue; 406 407 if (fChildren[i]->ReportDevice(supportDescriptors, 408 supportDescriptorCount, hooks, cookies, added, true) == B_OK) 409 result = B_OK; 410 } 411 412 if (!added) { 413 // Report hub after children when removing devices 414 TRACE("reporting hub after children\n"); 415 if (Device::ReportDevice(supportDescriptors, supportDescriptorCount, 416 hooks, cookies, added, recursive) == B_OK) 417 result = B_OK; 418 } 419 420 return result; 421 } 422 423 424 status_t 425 Hub::BuildDeviceName(char *string, uint32 *index, size_t bufferSize, 426 Device *device) 427 { 428 status_t result = Device::BuildDeviceName(string, index, bufferSize, device); 429 if (result < B_OK) { 430 // recursion to parent failed, we're at the root(hub) 431 if (*index < bufferSize) { 432 int32 managerIndex = GetStack()->IndexOfBusManager(GetBusManager()); 433 size_t totalBytes = snprintf(string + *index, bufferSize - *index, 434 "%" B_PRId32, managerIndex); 435 *index += std::min(totalBytes, (size_t)(bufferSize - *index - 1)); 436 } 437 } 438 439 if (!device) { 440 // no device was specified - report the hub 441 if (*index < bufferSize) { 442 size_t totalBytes = snprintf(string + *index, bufferSize - *index, 443 "/hub"); 444 *index += std::min(totalBytes, (size_t)(bufferSize - *index - 1)); 445 } 446 } else { 447 // find out where the requested device sitts 448 for (int32 i = 0; i < fHubDescriptor.num_ports; i++) { 449 if (fChildren[i] == device) { 450 if (*index < bufferSize) { 451 size_t totalBytes = snprintf(string + *index, 452 bufferSize - *index, "/%" B_PRId32, i); 453 *index += std::min(totalBytes, 454 (size_t)(bufferSize - *index - 1)); 455 } 456 break; 457 } 458 } 459 } 460 461 return B_OK; 462 } 463 464 465 status_t 466 Hub::_DebouncePort(uint8 index) 467 { 468 uint32 timeout = 0; 469 uint32 stableTime = 0; 470 while (timeout < USB_DEBOUNCE_TIMEOUT) { 471 snooze(USB_DEBOUNCE_CHECK_INTERVAL); 472 timeout += USB_DEBOUNCE_CHECK_INTERVAL; 473 474 status_t result = UpdatePortStatus(index); 475 if (result != B_OK) 476 return result; 477 478 if ((fPortStatus[index].change & PORT_STATUS_CONNECTION) == 0) { 479 stableTime += USB_DEBOUNCE_CHECK_INTERVAL; 480 if (stableTime >= USB_DEBOUNCE_STABLE_TIME) 481 return B_OK; 482 continue; 483 } 484 485 // clear the connection change and reset stable time 486 result = DefaultPipe()->SendRequest(USB_REQTYPE_CLASS 487 | USB_REQTYPE_OTHER_OUT, USB_REQUEST_CLEAR_FEATURE, 488 C_PORT_CONNECTION, index + 1, 0, NULL, 0, NULL); 489 if (result != B_OK) 490 return result; 491 492 TRACE("got connection change during debounce, resetting stable time\n"); 493 stableTime = 0; 494 } 495 496 return B_TIMED_OUT; 497 } 498