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) 21 : Device(parent, hubAddress, hubPort, desc, deviceAddress, speed, 22 isRootHub), 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 %ld\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) { 161 // reset is done 162 break; 163 } 164 } 165 166 if ((fPortStatus[index].change & PORT_STATUS_RESET) == 0) { 167 TRACE_ERROR("port %d won't reset\n", index); 168 return B_ERROR; 169 } 170 171 // clear the reset change 172 result = DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 173 USB_REQUEST_CLEAR_FEATURE, C_PORT_RESET, index + 1, 0, NULL, 0, NULL); 174 if (result < B_OK) 175 return result; 176 177 // wait for reset recovery 178 snooze(USB_DELAY_PORT_RESET_RECOVERY); 179 TRACE("port %d was reset successfully\n", index); 180 return B_OK; 181 } 182 183 184 status_t 185 Hub::DisablePort(uint8 index) 186 { 187 return DefaultPipe()->SendRequest(USB_REQTYPE_CLASS 188 | USB_REQTYPE_OTHER_OUT, USB_REQUEST_CLEAR_FEATURE, PORT_ENABLE, 189 index + 1, 0, NULL, 0, NULL); 190 } 191 192 193 194 void 195 Hub::Explore(change_item **changeList) 196 { 197 for (int32 i = 0; i < fHubDescriptor.num_ports; i++) { 198 status_t result = UpdatePortStatus(i); 199 if (result < B_OK) 200 continue; 201 202 #ifdef TRACE_USB 203 if (fPortStatus[i].change) { 204 TRACE("port %ld: status: 0x%04x; change: 0x%04x\n", i, 205 fPortStatus[i].status, fPortStatus[i].change); 206 TRACE("device at port %ld: %p (%ld)\n", i, fChildren[i], 207 fChildren[i] != NULL ? fChildren[i]->USBID() : 0); 208 } 209 #endif 210 211 if (fPortStatus[i].change & PORT_STATUS_CONNECTION) { 212 // clear status change 213 DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 214 USB_REQUEST_CLEAR_FEATURE, C_PORT_CONNECTION, i + 1, 215 0, NULL, 0, NULL); 216 217 if (fPortStatus[i].status & PORT_STATUS_CONNECTION) { 218 // new device attached! 219 TRACE_ALWAYS("port %ld: new device connected\n", i); 220 221 int32 retry = 2; 222 while (retry--) { 223 // wait some time for the device to power up 224 snooze(USB_DELAY_DEVICE_POWER_UP); 225 226 // reset the port, this will also enable it 227 result = ResetPort(i); 228 if (result < B_OK) { 229 TRACE_ERROR("resetting port %ld failed\n", i); 230 break; 231 } 232 233 result = UpdatePortStatus(i); 234 if (result < B_OK) 235 break; 236 237 if ((fPortStatus[i].status & PORT_STATUS_CONNECTION) == 0) { 238 // device has vanished after reset, ignore 239 TRACE("device disappeared on reset\n"); 240 break; 241 } 242 243 if (fChildren[i] != NULL) { 244 TRACE_ERROR("new device on a port that is already in " 245 "use\n"); 246 fChildren[i]->Changed(changeList, false); 247 fChildren[i] = NULL; 248 } 249 250 usb_speed speed = USB_SPEED_FULLSPEED; 251 if (fDeviceDescriptor.usb_version == 0x300) 252 speed = USB_SPEED_SUPER; 253 else if (fPortStatus[i].status & PORT_STATUS_LOW_SPEED) 254 speed = USB_SPEED_LOWSPEED; 255 else if (fPortStatus[i].status & PORT_STATUS_HIGH_SPEED) 256 speed = USB_SPEED_HIGHSPEED; 257 258 // either let the device inherit our addresses (if we are 259 // already potentially using a transaction translator) or 260 // set ourselfs as the hub when we might become the 261 // transaction translator for the device. 262 int8 hubAddress = HubAddress(); 263 uint8 hubPort = HubPort(); 264 if (Speed() == USB_SPEED_HIGHSPEED || fDeviceDescriptor.usb_version == 0x300) { 265 hubAddress = DeviceAddress(); 266 hubPort = i + 1; 267 } 268 269 Device *newDevice = GetBusManager()->AllocateDevice(this, 270 hubAddress, hubPort, speed); 271 272 if (newDevice) { 273 newDevice->Changed(changeList, true); 274 fChildren[i] = newDevice; 275 break; 276 } else { 277 // the device failed to setup correctly, disable the 278 // port so that the device doesn't get in the way of 279 // future addressing. 280 DisablePort(i); 281 } 282 } 283 } else { 284 // Device removed... 285 TRACE_ALWAYS("port %ld: device removed\n", i); 286 if (fChildren[i] != NULL) { 287 TRACE("removing device %p\n", fChildren[i]); 288 fChildren[i]->Changed(changeList, false); 289 fChildren[i] = NULL; 290 } 291 } 292 } 293 294 // other port changes we do not really handle, report and clear them 295 if (fPortStatus[i].change & PORT_STATUS_ENABLE) { 296 TRACE_ALWAYS("port %ld %sabled\n", i, (fPortStatus[i].status & PORT_STATUS_ENABLE) ? "en" : "dis"); 297 DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 298 USB_REQUEST_CLEAR_FEATURE, C_PORT_ENABLE, i + 1, 299 0, NULL, 0, NULL); 300 } 301 302 if (fPortStatus[i].change & PORT_STATUS_SUSPEND) { 303 TRACE_ALWAYS("port %ld is %ssuspended\n", i, (fPortStatus[i].status & PORT_STATUS_SUSPEND) ? "" : "not "); 304 DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 305 USB_REQUEST_CLEAR_FEATURE, C_PORT_SUSPEND, i + 1, 306 0, NULL, 0, NULL); 307 } 308 309 if (fPortStatus[i].change & PORT_STATUS_OVER_CURRENT) { 310 TRACE_ALWAYS("port %ld is %sin an over current state\n", i, (fPortStatus[i].status & PORT_STATUS_OVER_CURRENT) ? "" : "not "); 311 DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 312 USB_REQUEST_CLEAR_FEATURE, C_PORT_OVER_CURRENT, i + 1, 313 0, NULL, 0, NULL); 314 } 315 316 if (fPortStatus[i].change & PORT_STATUS_RESET) { 317 TRACE_ALWAYS("port %ld was reset\n", i); 318 DefaultPipe()->SendRequest(USB_REQTYPE_CLASS | USB_REQTYPE_OTHER_OUT, 319 USB_REQUEST_CLEAR_FEATURE, C_PORT_RESET, i + 1, 320 0, NULL, 0, NULL); 321 } 322 } 323 324 // explore down the tree if we have hubs connected 325 for (int32 i = 0; i < fHubDescriptor.num_ports; i++) { 326 if (!fChildren[i] || (fChildren[i]->Type() & USB_OBJECT_HUB) == 0) 327 continue; 328 329 ((Hub *)fChildren[i])->Explore(changeList); 330 } 331 } 332 333 334 void 335 Hub::InterruptCallback(void *cookie, status_t status, void *data, 336 size_t actualLength) 337 { 338 TRACE_STATIC((Hub *)cookie, "interrupt callback!\n"); 339 } 340 341 342 status_t 343 Hub::GetDescriptor(uint8 descriptorType, uint8 index, uint16 languageID, 344 void *data, size_t dataLength, size_t *actualLength) 345 { 346 return DefaultPipe()->SendRequest( 347 USB_REQTYPE_DEVICE_IN | USB_REQTYPE_CLASS, // type 348 USB_REQUEST_GET_DESCRIPTOR, // request 349 (descriptorType << 8) | index, // value 350 languageID, // index 351 dataLength, // length 352 data, // buffer 353 dataLength, // buffer length 354 actualLength); // actual length 355 } 356 357 358 status_t 359 Hub::ReportDevice(usb_support_descriptor *supportDescriptors, 360 uint32 supportDescriptorCount, const usb_notify_hooks *hooks, 361 usb_driver_cookie **cookies, bool added, bool recursive) 362 { 363 status_t result = B_UNSUPPORTED; 364 365 if (added) { 366 // Report hub before children when adding devices 367 TRACE("reporting hub before children\n"); 368 result = Device::ReportDevice(supportDescriptors, 369 supportDescriptorCount, hooks, cookies, added, recursive); 370 } 371 372 for (int32 i = 0; recursive && i < fHubDescriptor.num_ports; i++) { 373 if (!fChildren[i]) 374 continue; 375 376 if (fChildren[i]->ReportDevice(supportDescriptors, 377 supportDescriptorCount, hooks, cookies, added, true) == B_OK) 378 result = B_OK; 379 } 380 381 if (!added) { 382 // Report hub after children when removing devices 383 TRACE("reporting hub after children\n"); 384 if (Device::ReportDevice(supportDescriptors, supportDescriptorCount, 385 hooks, cookies, added, recursive) == B_OK) 386 result = B_OK; 387 } 388 389 return result; 390 } 391 392 393 status_t 394 Hub::BuildDeviceName(char *string, uint32 *index, size_t bufferSize, 395 Device *device) 396 { 397 status_t result = Device::BuildDeviceName(string, index, bufferSize, device); 398 if (result < B_OK) { 399 // recursion to parent failed, we're at the root(hub) 400 if (*index < bufferSize) { 401 int32 managerIndex = GetStack()->IndexOfBusManager(GetBusManager()); 402 size_t totalBytes = snprintf(string + *index, bufferSize - *index, 403 "%ld", managerIndex); 404 *index += std::min(totalBytes, bufferSize - *index - 1); 405 } 406 } 407 408 if (!device) { 409 // no device was specified - report the hub 410 if (*index < bufferSize) { 411 size_t totalBytes = snprintf(string + *index, bufferSize - *index, 412 "/hub"); 413 *index += std::min(totalBytes, bufferSize - *index - 1); 414 } 415 } else { 416 // find out where the requested device sitts 417 for (int32 i = 0; i < fHubDescriptor.num_ports; i++) { 418 if (fChildren[i] == device) { 419 if (*index < bufferSize) { 420 size_t totalBytes = snprintf(string + *index, 421 bufferSize - *index, "/%ld", i); 422 *index += std::min(totalBytes, bufferSize - *index - 1); 423 } 424 break; 425 } 426 } 427 } 428 429 return B_OK; 430 } 431