1 /* 2 * (C) Copyright 2015 Google, Inc 3 * Written by Simon Glass <sjg@chromium.org> 4 * 5 * usb_match_device() modified from Linux kernel v4.0. 6 * 7 * SPDX-License-Identifier: GPL-2.0+ 8 */ 9 10 #include <common.h> 11 #include <dm.h> 12 #include <errno.h> 13 #include <usb.h> 14 #include <dm/device-internal.h> 15 #include <dm/lists.h> 16 #include <dm/root.h> 17 #include <dm/uclass-internal.h> 18 19 DECLARE_GLOBAL_DATA_PTR; 20 21 extern bool usb_started; /* flag for the started/stopped USB status */ 22 static bool asynch_allowed; 23 24 int usb_disable_asynch(int disable) 25 { 26 int old_value = asynch_allowed; 27 28 asynch_allowed = !disable; 29 return old_value; 30 } 31 32 int submit_int_msg(struct usb_device *udev, unsigned long pipe, void *buffer, 33 int length, int interval) 34 { 35 struct udevice *bus = udev->controller_dev; 36 struct dm_usb_ops *ops = usb_get_ops(bus); 37 38 if (!ops->interrupt) 39 return -ENOSYS; 40 41 return ops->interrupt(bus, udev, pipe, buffer, length, interval); 42 } 43 44 int submit_control_msg(struct usb_device *udev, unsigned long pipe, 45 void *buffer, int length, struct devrequest *setup) 46 { 47 struct udevice *bus = udev->controller_dev; 48 struct dm_usb_ops *ops = usb_get_ops(bus); 49 50 if (!ops->control) 51 return -ENOSYS; 52 53 return ops->control(bus, udev, pipe, buffer, length, setup); 54 } 55 56 int submit_bulk_msg(struct usb_device *udev, unsigned long pipe, void *buffer, 57 int length) 58 { 59 struct udevice *bus = udev->controller_dev; 60 struct dm_usb_ops *ops = usb_get_ops(bus); 61 62 if (!ops->bulk) 63 return -ENOSYS; 64 65 return ops->bulk(bus, udev, pipe, buffer, length); 66 } 67 68 int usb_alloc_device(struct usb_device *udev) 69 { 70 struct udevice *bus = udev->controller_dev; 71 struct dm_usb_ops *ops = usb_get_ops(bus); 72 73 /* This is only requird by some controllers - current XHCI */ 74 if (!ops->alloc_device) 75 return 0; 76 77 return ops->alloc_device(bus, udev); 78 } 79 80 int usb_stop(void) 81 { 82 struct udevice *bus; 83 struct uclass *uc; 84 int err = 0, ret; 85 86 /* De-activate any devices that have been activated */ 87 ret = uclass_get(UCLASS_USB, &uc); 88 if (ret) 89 return ret; 90 uclass_foreach_dev(bus, uc) { 91 ret = device_remove(bus); 92 if (ret && !err) 93 err = ret; 94 } 95 96 usb_stor_reset(); 97 usb_hub_reset(); 98 usb_started = 0; 99 100 return err; 101 } 102 103 static int usb_scan_bus(struct udevice *bus, bool recurse) 104 { 105 struct usb_bus_priv *priv; 106 struct udevice *dev; 107 int ret; 108 109 priv = dev_get_uclass_priv(bus); 110 111 assert(recurse); /* TODO: Support non-recusive */ 112 113 ret = usb_scan_device(bus, 0, USB_SPEED_FULL, &dev); 114 if (ret) 115 return ret; 116 117 return priv->next_addr; 118 } 119 120 int usb_init(void) 121 { 122 int controllers_initialized = 0; 123 struct udevice *bus; 124 struct uclass *uc; 125 int count = 0; 126 int ret; 127 128 asynch_allowed = 1; 129 usb_hub_reset(); 130 131 ret = uclass_get(UCLASS_USB, &uc); 132 if (ret) 133 return ret; 134 135 uclass_foreach_dev(bus, uc) { 136 /* init low_level USB */ 137 count++; 138 printf("USB"); 139 printf("%d: ", bus->seq); 140 ret = device_probe(bus); 141 if (ret == -ENODEV) { /* No such device. */ 142 puts("Port not available.\n"); 143 controllers_initialized++; 144 continue; 145 } 146 147 if (ret) { /* Other error. */ 148 printf("probe failed, error %d\n", ret); 149 continue; 150 } 151 /* 152 * lowlevel init is OK, now scan the bus for devices 153 * i.e. search HUBs and configure them 154 */ 155 controllers_initialized++; 156 printf("scanning bus %d for devices... ", bus->seq); 157 debug("\n"); 158 ret = usb_scan_bus(bus, true); 159 if (ret < 0) 160 printf("failed, error %d\n", ret); 161 else if (!ret) 162 printf("No USB Device found\n"); 163 else 164 printf("%d USB Device(s) found\n", ret); 165 usb_started = true; 166 } 167 168 debug("scan end\n"); 169 /* if we were not able to find at least one working bus, bail out */ 170 if (!count) 171 printf("No controllers found\n"); 172 else if (controllers_initialized == 0) 173 printf("USB error: all controllers failed lowlevel init\n"); 174 175 return usb_started ? 0 : -1; 176 } 177 178 int usb_reset_root_port(void) 179 { 180 return -ENOSYS; 181 } 182 183 static struct usb_device *find_child_devnum(struct udevice *parent, int devnum) 184 { 185 struct usb_device *udev; 186 struct udevice *dev; 187 188 if (!device_active(parent)) 189 return NULL; 190 udev = dev_get_parentdata(parent); 191 if (udev->devnum == devnum) 192 return udev; 193 194 for (device_find_first_child(parent, &dev); 195 dev; 196 device_find_next_child(&dev)) { 197 udev = find_child_devnum(dev, devnum); 198 if (udev) 199 return udev; 200 } 201 202 return NULL; 203 } 204 205 struct usb_device *usb_get_dev_index(struct udevice *bus, int index) 206 { 207 struct udevice *hub; 208 int devnum = index + 1; /* Addresses are allocated from 1 on USB */ 209 210 device_find_first_child(bus, &hub); 211 if (device_get_uclass_id(hub) == UCLASS_USB_HUB) 212 return find_child_devnum(hub, devnum); 213 214 return NULL; 215 } 216 217 int usb_post_bind(struct udevice *dev) 218 { 219 /* Scan the bus for devices */ 220 return dm_scan_fdt_node(dev, gd->fdt_blob, dev->of_offset, false); 221 } 222 223 int usb_port_reset(struct usb_device *parent, int portnr) 224 { 225 unsigned short portstatus; 226 int ret; 227 228 debug("%s: start\n", __func__); 229 230 if (parent) { 231 /* reset the port for the second time */ 232 assert(portnr > 0); 233 debug("%s: reset %d\n", __func__, portnr - 1); 234 ret = legacy_hub_port_reset(parent, portnr - 1, &portstatus); 235 if (ret < 0) { 236 printf("\n Couldn't reset port %i\n", portnr); 237 return ret; 238 } 239 } else { 240 debug("%s: reset root\n", __func__); 241 usb_reset_root_port(); 242 } 243 244 return 0; 245 } 246 247 int usb_legacy_port_reset(struct usb_device *parent, int portnr) 248 { 249 return usb_port_reset(parent, portnr); 250 } 251 252 /* returns 0 if no match, 1 if match */ 253 int usb_match_device(const struct usb_device_descriptor *desc, 254 const struct usb_device_id *id) 255 { 256 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) && 257 id->idVendor != le16_to_cpu(desc->idVendor)) 258 return 0; 259 260 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) && 261 id->idProduct != le16_to_cpu(desc->idProduct)) 262 return 0; 263 264 /* No need to test id->bcdDevice_lo != 0, since 0 is never 265 greater than any unsigned number. */ 266 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) && 267 (id->bcdDevice_lo > le16_to_cpu(desc->bcdDevice))) 268 return 0; 269 270 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) && 271 (id->bcdDevice_hi < le16_to_cpu(desc->bcdDevice))) 272 return 0; 273 274 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) && 275 (id->bDeviceClass != desc->bDeviceClass)) 276 return 0; 277 278 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) && 279 (id->bDeviceSubClass != desc->bDeviceSubClass)) 280 return 0; 281 282 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) && 283 (id->bDeviceProtocol != desc->bDeviceProtocol)) 284 return 0; 285 286 return 1; 287 } 288 289 /* returns 0 if no match, 1 if match */ 290 int usb_match_one_id_intf(const struct usb_device_descriptor *desc, 291 const struct usb_interface_descriptor *int_desc, 292 const struct usb_device_id *id) 293 { 294 /* The interface class, subclass, protocol and number should never be 295 * checked for a match if the device class is Vendor Specific, 296 * unless the match record specifies the Vendor ID. */ 297 if (desc->bDeviceClass == USB_CLASS_VENDOR_SPEC && 298 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) && 299 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS | 300 USB_DEVICE_ID_MATCH_INT_SUBCLASS | 301 USB_DEVICE_ID_MATCH_INT_PROTOCOL | 302 USB_DEVICE_ID_MATCH_INT_NUMBER))) 303 return 0; 304 305 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) && 306 (id->bInterfaceClass != int_desc->bInterfaceClass)) 307 return 0; 308 309 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) && 310 (id->bInterfaceSubClass != int_desc->bInterfaceSubClass)) 311 return 0; 312 313 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) && 314 (id->bInterfaceProtocol != int_desc->bInterfaceProtocol)) 315 return 0; 316 317 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) && 318 (id->bInterfaceNumber != int_desc->bInterfaceNumber)) 319 return 0; 320 321 return 1; 322 } 323 324 /* returns 0 if no match, 1 if match */ 325 int usb_match_one_id(struct usb_device_descriptor *desc, 326 struct usb_interface_descriptor *int_desc, 327 const struct usb_device_id *id) 328 { 329 if (!usb_match_device(desc, id)) 330 return 0; 331 332 return usb_match_one_id_intf(desc, int_desc, id); 333 } 334 335 /** 336 * usb_find_and_bind_driver() - Find and bind the right USB driver 337 * 338 * This only looks at certain fields in the descriptor. 339 */ 340 static int usb_find_and_bind_driver(struct udevice *parent, 341 struct usb_device_descriptor *desc, 342 struct usb_interface_descriptor *iface, 343 int bus_seq, int devnum, 344 struct udevice **devp) 345 { 346 struct usb_driver_entry *start, *entry; 347 int n_ents; 348 int ret; 349 char name[30], *str; 350 351 *devp = NULL; 352 debug("%s: Searching for driver\n", __func__); 353 start = ll_entry_start(struct usb_driver_entry, usb_driver_entry); 354 n_ents = ll_entry_count(struct usb_driver_entry, usb_driver_entry); 355 for (entry = start; entry != start + n_ents; entry++) { 356 const struct usb_device_id *id; 357 struct udevice *dev; 358 const struct driver *drv; 359 struct usb_dev_platdata *plat; 360 361 for (id = entry->match; id->match_flags; id++) { 362 if (!usb_match_one_id(desc, iface, id)) 363 continue; 364 365 drv = entry->driver; 366 /* 367 * We could pass the descriptor to the driver as 368 * platdata (instead of NULL) and allow its bind() 369 * method to return -ENOENT if it doesn't support this 370 * device. That way we could continue the search to 371 * find another driver. For now this doesn't seem 372 * necesssary, so just bind the first match. 373 */ 374 ret = device_bind(parent, drv, drv->name, NULL, -1, 375 &dev); 376 if (ret) 377 goto error; 378 debug("%s: Match found: %s\n", __func__, drv->name); 379 dev->driver_data = id->driver_info; 380 plat = dev_get_parent_platdata(dev); 381 plat->id = *id; 382 *devp = dev; 383 return 0; 384 } 385 } 386 387 /* Bind a generic driver so that the device can be used */ 388 snprintf(name, sizeof(name), "generic_bus_%x_dev_%x", bus_seq, devnum); 389 str = strdup(name); 390 if (!str) 391 return -ENOMEM; 392 ret = device_bind_driver(parent, "usb_dev_generic_drv", str, devp); 393 394 error: 395 debug("%s: No match found: %d\n", __func__, ret); 396 return ret; 397 } 398 399 /** 400 * usb_find_child() - Find an existing device which matches our needs 401 * 402 * 403 */ 404 static int usb_find_child(struct udevice *parent, 405 struct usb_device_descriptor *desc, 406 struct usb_interface_descriptor *iface, 407 struct udevice **devp) 408 { 409 struct udevice *dev; 410 411 *devp = NULL; 412 for (device_find_first_child(parent, &dev); 413 dev; 414 device_find_next_child(&dev)) { 415 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev); 416 417 /* If this device is already in use, skip it */ 418 if (device_active(dev)) 419 continue; 420 debug(" %s: name='%s', plat=%d, desc=%d\n", __func__, 421 dev->name, plat->id.bDeviceClass, desc->bDeviceClass); 422 if (usb_match_one_id(desc, iface, &plat->id)) { 423 *devp = dev; 424 return 0; 425 } 426 } 427 428 return -ENOENT; 429 } 430 431 int usb_scan_device(struct udevice *parent, int port, 432 enum usb_device_speed speed, struct udevice **devp) 433 { 434 struct udevice *dev; 435 bool created = false; 436 struct usb_dev_platdata *plat; 437 struct usb_bus_priv *priv; 438 struct usb_device *parent_udev; 439 int ret; 440 ALLOC_CACHE_ALIGN_BUFFER(struct usb_device, udev, 1); 441 struct usb_interface_descriptor *iface = &udev->config.if_desc[0].desc; 442 443 *devp = NULL; 444 memset(udev, '\0', sizeof(*udev)); 445 ret = usb_get_bus(parent, &udev->controller_dev); 446 if (ret) 447 return ret; 448 priv = dev_get_uclass_priv(udev->controller_dev); 449 450 /* 451 * Somewhat nasty, this. We create a local device and use the normal 452 * USB stack to read its descriptor. Then we know what type of device 453 * to create for real. 454 * 455 * udev->dev is set to the parent, since we don't have a real device 456 * yet. The USB stack should not access udev.dev anyway, except perhaps 457 * to find the controller, and the controller will either be @parent, 458 * or some parent of @parent. 459 * 460 * Another option might be to create the device as a generic USB 461 * device, then morph it into the correct one when we know what it 462 * should be. This means that a generic USB device would morph into 463 * a network controller, or a USB flash stick, for example. However, 464 * we don't support such morphing and it isn't clear that it would 465 * be easy to do. 466 * 467 * Yet another option is to split out the USB stack parts of udev 468 * into something like a 'struct urb' (as Linux does) which can exist 469 * independently of any device. This feels cleaner, but calls for quite 470 * a big change to the USB stack. 471 * 472 * For now, the approach is to set up an empty udev, read its 473 * descriptor and assign it an address, then bind a real device and 474 * stash the resulting information into the device's parent 475 * platform data. Then when we probe it, usb_child_pre_probe() is called 476 * and it will pull the information out of the stash. 477 */ 478 udev->dev = parent; 479 udev->speed = speed; 480 udev->devnum = priv->next_addr + 1; 481 udev->portnr = port; 482 debug("Calling usb_setup_device(), portnr=%d\n", udev->portnr); 483 parent_udev = device_get_uclass_id(parent) == UCLASS_USB_HUB ? 484 dev_get_parentdata(parent) : NULL; 485 ret = usb_setup_device(udev, priv->desc_before_addr, parent_udev, port); 486 debug("read_descriptor for '%s': ret=%d\n", parent->name, ret); 487 if (ret) 488 return ret; 489 ret = usb_find_child(parent, &udev->descriptor, iface, &dev); 490 debug("** usb_find_child returns %d\n", ret); 491 if (ret) { 492 if (ret != -ENOENT) 493 return ret; 494 ret = usb_find_and_bind_driver(parent, &udev->descriptor, iface, 495 udev->controller_dev->seq, 496 udev->devnum, &dev); 497 if (ret) 498 return ret; 499 created = true; 500 } 501 plat = dev_get_parent_platdata(dev); 502 debug("%s: Probing '%s', plat=%p\n", __func__, dev->name, plat); 503 plat->devnum = udev->devnum; 504 plat->speed = udev->speed; 505 plat->slot_id = udev->slot_id; 506 plat->portnr = port; 507 debug("** device '%s': stashing slot_id=%d\n", dev->name, 508 plat->slot_id); 509 priv->next_addr++; 510 ret = device_probe(dev); 511 if (ret) { 512 debug("%s: Device '%s' probe failed\n", __func__, dev->name); 513 priv->next_addr--; 514 if (created) 515 device_unbind(dev); 516 return ret; 517 } 518 *devp = dev; 519 520 return 0; 521 } 522 523 int usb_child_post_bind(struct udevice *dev) 524 { 525 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev); 526 const void *blob = gd->fdt_blob; 527 int val; 528 529 if (dev->of_offset == -1) 530 return 0; 531 532 /* We only support matching a few things */ 533 val = fdtdec_get_int(blob, dev->of_offset, "usb,device-class", -1); 534 if (val != -1) { 535 plat->id.match_flags |= USB_DEVICE_ID_MATCH_DEV_CLASS; 536 plat->id.bDeviceClass = val; 537 } 538 val = fdtdec_get_int(blob, dev->of_offset, "usb,interface-class", -1); 539 if (val != -1) { 540 plat->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS; 541 plat->id.bInterfaceClass = val; 542 } 543 544 return 0; 545 } 546 547 int usb_get_bus(struct udevice *dev, struct udevice **busp) 548 { 549 struct udevice *bus; 550 551 *busp = NULL; 552 for (bus = dev; bus && device_get_uclass_id(bus) != UCLASS_USB; ) 553 bus = bus->parent; 554 if (!bus) { 555 /* By design this cannot happen */ 556 assert(bus); 557 debug("USB HUB '%s' does not have a controller\n", dev->name); 558 return -EXDEV; 559 } 560 *busp = bus; 561 562 return 0; 563 } 564 565 int usb_child_pre_probe(struct udevice *dev) 566 { 567 struct udevice *bus; 568 struct usb_device *udev = dev_get_parentdata(dev); 569 struct usb_dev_platdata *plat = dev_get_parent_platdata(dev); 570 int ret; 571 572 ret = usb_get_bus(dev, &bus); 573 if (ret) 574 return ret; 575 udev->controller_dev = bus; 576 udev->dev = dev; 577 udev->devnum = plat->devnum; 578 udev->slot_id = plat->slot_id; 579 udev->portnr = plat->portnr; 580 udev->speed = plat->speed; 581 debug("** device '%s': getting slot_id=%d\n", dev->name, plat->slot_id); 582 583 ret = usb_select_config(udev); 584 if (ret) 585 return ret; 586 587 return 0; 588 } 589 590 UCLASS_DRIVER(usb) = { 591 .id = UCLASS_USB, 592 .name = "usb", 593 .flags = DM_UC_FLAG_SEQ_ALIAS, 594 .post_bind = usb_post_bind, 595 .per_child_auto_alloc_size = sizeof(struct usb_device), 596 .per_device_auto_alloc_size = sizeof(struct usb_bus_priv), 597 .child_post_bind = usb_child_post_bind, 598 .child_pre_probe = usb_child_pre_probe, 599 .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata), 600 }; 601 602 UCLASS_DRIVER(usb_dev_generic) = { 603 .id = UCLASS_USB_DEV_GENERIC, 604 .name = "usb_dev_generic", 605 }; 606 607 U_BOOT_DRIVER(usb_dev_generic_drv) = { 608 .id = UCLASS_USB_DEV_GENERIC, 609 .name = "usb_dev_generic_drv", 610 }; 611