1*83d290c5STom Rini // SPDX-License-Identifier: GPL-2.0+ 2de31213fSSimon Glass /* 3de31213fSSimon Glass * (C) Copyright 2015 Google, Inc 4de31213fSSimon Glass * Written by Simon Glass <sjg@chromium.org> 5de31213fSSimon Glass * 60566e240SSimon Glass * usb_match_device() modified from Linux kernel v4.0. 7de31213fSSimon Glass */ 8de31213fSSimon Glass 9de31213fSSimon Glass #include <common.h> 10de31213fSSimon Glass #include <dm.h> 11de31213fSSimon Glass #include <errno.h> 12cf92e05cSSimon Glass #include <memalign.h> 13de31213fSSimon Glass #include <usb.h> 14de31213fSSimon Glass #include <dm/device-internal.h> 15de31213fSSimon Glass #include <dm/lists.h> 16de31213fSSimon Glass #include <dm/uclass-internal.h> 17de31213fSSimon Glass 18de31213fSSimon Glass extern bool usb_started; /* flag for the started/stopped USB status */ 19de31213fSSimon Glass static bool asynch_allowed; 20de31213fSSimon Glass 21e253637bSHans de Goede struct usb_uclass_priv { 22e253637bSHans de Goede int companion_device_count; 23e253637bSHans de Goede }; 24e253637bSHans de Goede 25de31213fSSimon Glass int usb_disable_asynch(int disable) 26de31213fSSimon Glass { 27de31213fSSimon Glass int old_value = asynch_allowed; 28de31213fSSimon Glass 29de31213fSSimon Glass asynch_allowed = !disable; 30de31213fSSimon Glass return old_value; 31de31213fSSimon Glass } 32de31213fSSimon Glass 33de31213fSSimon Glass int submit_int_msg(struct usb_device *udev, unsigned long pipe, void *buffer, 34de31213fSSimon Glass int length, int interval) 35de31213fSSimon Glass { 36de31213fSSimon Glass struct udevice *bus = udev->controller_dev; 37de31213fSSimon Glass struct dm_usb_ops *ops = usb_get_ops(bus); 38de31213fSSimon Glass 39de31213fSSimon Glass if (!ops->interrupt) 40de31213fSSimon Glass return -ENOSYS; 41de31213fSSimon Glass 42de31213fSSimon Glass return ops->interrupt(bus, udev, pipe, buffer, length, interval); 43de31213fSSimon Glass } 44de31213fSSimon Glass 45de31213fSSimon Glass int submit_control_msg(struct usb_device *udev, unsigned long pipe, 46de31213fSSimon Glass void *buffer, int length, struct devrequest *setup) 47de31213fSSimon Glass { 48de31213fSSimon Glass struct udevice *bus = udev->controller_dev; 49de31213fSSimon Glass struct dm_usb_ops *ops = usb_get_ops(bus); 50e253637bSHans de Goede struct usb_uclass_priv *uc_priv = bus->uclass->priv; 51e253637bSHans de Goede int err; 52de31213fSSimon Glass 53de31213fSSimon Glass if (!ops->control) 54de31213fSSimon Glass return -ENOSYS; 55de31213fSSimon Glass 56e253637bSHans de Goede err = ops->control(bus, udev, pipe, buffer, length, setup); 57e253637bSHans de Goede if (setup->request == USB_REQ_SET_FEATURE && 58e253637bSHans de Goede setup->requesttype == USB_RT_PORT && 59e253637bSHans de Goede setup->value == cpu_to_le16(USB_PORT_FEAT_RESET) && 60e253637bSHans de Goede err == -ENXIO) { 61e253637bSHans de Goede /* Device handed over to companion after port reset */ 62e253637bSHans de Goede uc_priv->companion_device_count++; 63e253637bSHans de Goede } 64e253637bSHans de Goede 65e253637bSHans de Goede return err; 66de31213fSSimon Glass } 67de31213fSSimon Glass 68de31213fSSimon Glass int submit_bulk_msg(struct usb_device *udev, unsigned long pipe, void *buffer, 69de31213fSSimon Glass int length) 70de31213fSSimon Glass { 71de31213fSSimon Glass struct udevice *bus = udev->controller_dev; 72de31213fSSimon Glass struct dm_usb_ops *ops = usb_get_ops(bus); 73de31213fSSimon Glass 74de31213fSSimon Glass if (!ops->bulk) 75de31213fSSimon Glass return -ENOSYS; 76de31213fSSimon Glass 77de31213fSSimon Glass return ops->bulk(bus, udev, pipe, buffer, length); 78de31213fSSimon Glass } 79de31213fSSimon Glass 808a5f0665SHans de Goede struct int_queue *create_int_queue(struct usb_device *udev, 818a5f0665SHans de Goede unsigned long pipe, int queuesize, int elementsize, 828a5f0665SHans de Goede void *buffer, int interval) 838a5f0665SHans de Goede { 848a5f0665SHans de Goede struct udevice *bus = udev->controller_dev; 858a5f0665SHans de Goede struct dm_usb_ops *ops = usb_get_ops(bus); 868a5f0665SHans de Goede 878a5f0665SHans de Goede if (!ops->create_int_queue) 888a5f0665SHans de Goede return NULL; 898a5f0665SHans de Goede 908a5f0665SHans de Goede return ops->create_int_queue(bus, udev, pipe, queuesize, elementsize, 918a5f0665SHans de Goede buffer, interval); 928a5f0665SHans de Goede } 938a5f0665SHans de Goede 948a5f0665SHans de Goede void *poll_int_queue(struct usb_device *udev, struct int_queue *queue) 958a5f0665SHans de Goede { 968a5f0665SHans de Goede struct udevice *bus = udev->controller_dev; 978a5f0665SHans de Goede struct dm_usb_ops *ops = usb_get_ops(bus); 988a5f0665SHans de Goede 998a5f0665SHans de Goede if (!ops->poll_int_queue) 1008a5f0665SHans de Goede return NULL; 1018a5f0665SHans de Goede 1028a5f0665SHans de Goede return ops->poll_int_queue(bus, udev, queue); 1038a5f0665SHans de Goede } 1048a5f0665SHans de Goede 1058a5f0665SHans de Goede int destroy_int_queue(struct usb_device *udev, struct int_queue *queue) 1068a5f0665SHans de Goede { 1078a5f0665SHans de Goede struct udevice *bus = udev->controller_dev; 1088a5f0665SHans de Goede struct dm_usb_ops *ops = usb_get_ops(bus); 1098a5f0665SHans de Goede 1108a5f0665SHans de Goede if (!ops->destroy_int_queue) 1118a5f0665SHans de Goede return -ENOSYS; 1128a5f0665SHans de Goede 1138a5f0665SHans de Goede return ops->destroy_int_queue(bus, udev, queue); 1148a5f0665SHans de Goede } 1158a5f0665SHans de Goede 116de31213fSSimon Glass int usb_alloc_device(struct usb_device *udev) 117de31213fSSimon Glass { 118de31213fSSimon Glass struct udevice *bus = udev->controller_dev; 119de31213fSSimon Glass struct dm_usb_ops *ops = usb_get_ops(bus); 120de31213fSSimon Glass 121de31213fSSimon Glass /* This is only requird by some controllers - current XHCI */ 122de31213fSSimon Glass if (!ops->alloc_device) 123de31213fSSimon Glass return 0; 124de31213fSSimon Glass 125de31213fSSimon Glass return ops->alloc_device(bus, udev); 126de31213fSSimon Glass } 127de31213fSSimon Glass 128b2f219b0SHans de Goede int usb_reset_root_port(struct usb_device *udev) 129b2f219b0SHans de Goede { 130b2f219b0SHans de Goede struct udevice *bus = udev->controller_dev; 131b2f219b0SHans de Goede struct dm_usb_ops *ops = usb_get_ops(bus); 132b2f219b0SHans de Goede 133b2f219b0SHans de Goede if (!ops->reset_root_port) 134b2f219b0SHans de Goede return -ENOSYS; 135b2f219b0SHans de Goede 136b2f219b0SHans de Goede return ops->reset_root_port(bus, udev); 137b2f219b0SHans de Goede } 138b2f219b0SHans de Goede 1399ca1b4baSBin Meng int usb_update_hub_device(struct usb_device *udev) 1409ca1b4baSBin Meng { 1419ca1b4baSBin Meng struct udevice *bus = udev->controller_dev; 1429ca1b4baSBin Meng struct dm_usb_ops *ops = usb_get_ops(bus); 1439ca1b4baSBin Meng 1449ca1b4baSBin Meng if (!ops->update_hub_device) 1459ca1b4baSBin Meng return -ENOSYS; 1469ca1b4baSBin Meng 1479ca1b4baSBin Meng return ops->update_hub_device(bus, udev); 1489ca1b4baSBin Meng } 1499ca1b4baSBin Meng 1503e59f590SBin Meng int usb_get_max_xfer_size(struct usb_device *udev, size_t *size) 1513e59f590SBin Meng { 1523e59f590SBin Meng struct udevice *bus = udev->controller_dev; 1533e59f590SBin Meng struct dm_usb_ops *ops = usb_get_ops(bus); 1543e59f590SBin Meng 1553e59f590SBin Meng if (!ops->get_max_xfer_size) 1563e59f590SBin Meng return -ENOSYS; 1573e59f590SBin Meng 1583e59f590SBin Meng return ops->get_max_xfer_size(bus, size); 1593e59f590SBin Meng } 1603e59f590SBin Meng 161de31213fSSimon Glass int usb_stop(void) 162de31213fSSimon Glass { 163de31213fSSimon Glass struct udevice *bus; 164d4efefe3SBin Meng struct udevice *rh; 165de31213fSSimon Glass struct uclass *uc; 166e253637bSHans de Goede struct usb_uclass_priv *uc_priv; 167de31213fSSimon Glass int err = 0, ret; 168de31213fSSimon Glass 169de31213fSSimon Glass /* De-activate any devices that have been activated */ 170de31213fSSimon Glass ret = uclass_get(UCLASS_USB, &uc); 171de31213fSSimon Glass if (ret) 172de31213fSSimon Glass return ret; 173e253637bSHans de Goede 174e253637bSHans de Goede uc_priv = uc->priv; 175e253637bSHans de Goede 176de31213fSSimon Glass uclass_foreach_dev(bus, uc) { 177706865afSStefan Roese ret = device_remove(bus, DM_REMOVE_NORMAL); 178de31213fSSimon Glass if (ret && !err) 179de31213fSSimon Glass err = ret; 180d4efefe3SBin Meng 181d4efefe3SBin Meng /* Locate root hub device */ 182d4efefe3SBin Meng device_find_first_child(bus, &rh); 183d4efefe3SBin Meng if (rh) { 184d4efefe3SBin Meng /* 185d4efefe3SBin Meng * All USB devices are children of root hub. 186d4efefe3SBin Meng * Unbinding root hub will unbind all of its children. 187d4efefe3SBin Meng */ 188d4efefe3SBin Meng ret = device_unbind(rh); 189d4efefe3SBin Meng if (ret && !err) 190d4efefe3SBin Meng err = ret; 191d4efefe3SBin Meng } 192de31213fSSimon Glass } 193ad0a9378SBin Meng 1940fa5999bSPaul Kocialkowski #ifdef CONFIG_USB_STORAGE 195de31213fSSimon Glass usb_stor_reset(); 1960fa5999bSPaul Kocialkowski #endif 197e253637bSHans de Goede uc_priv->companion_device_count = 0; 198de31213fSSimon Glass usb_started = 0; 199de31213fSSimon Glass 200de31213fSSimon Glass return err; 201de31213fSSimon Glass } 202de31213fSSimon Glass 203a24a0e91SHans de Goede static void usb_scan_bus(struct udevice *bus, bool recurse) 204de31213fSSimon Glass { 205de31213fSSimon Glass struct usb_bus_priv *priv; 206de31213fSSimon Glass struct udevice *dev; 207de31213fSSimon Glass int ret; 208de31213fSSimon Glass 209de31213fSSimon Glass priv = dev_get_uclass_priv(bus); 210de31213fSSimon Glass 211de31213fSSimon Glass assert(recurse); /* TODO: Support non-recusive */ 212de31213fSSimon Glass 213a24a0e91SHans de Goede printf("scanning bus %d for devices... ", bus->seq); 214a24a0e91SHans de Goede debug("\n"); 215de31213fSSimon Glass ret = usb_scan_device(bus, 0, USB_SPEED_FULL, &dev); 216de31213fSSimon Glass if (ret) 217a24a0e91SHans de Goede printf("failed, error %d\n", ret); 218a24a0e91SHans de Goede else if (priv->next_addr == 0) 219a24a0e91SHans de Goede printf("No USB Device found\n"); 220a24a0e91SHans de Goede else 221a24a0e91SHans de Goede printf("%d USB Device(s) found\n", priv->next_addr); 222de31213fSSimon Glass } 223de31213fSSimon Glass 224eae11becSSimon Glass static void remove_inactive_children(struct uclass *uc, struct udevice *bus) 225eae11becSSimon Glass { 226eae11becSSimon Glass uclass_foreach_dev(bus, uc) { 227eae11becSSimon Glass struct udevice *dev, *next; 228eae11becSSimon Glass 229eae11becSSimon Glass if (!device_active(bus)) 230eae11becSSimon Glass continue; 231eae11becSSimon Glass device_foreach_child_safe(dev, next, bus) { 232eae11becSSimon Glass if (!device_active(dev)) 233eae11becSSimon Glass device_unbind(dev); 234eae11becSSimon Glass } 235eae11becSSimon Glass } 236eae11becSSimon Glass } 237eae11becSSimon Glass 238de31213fSSimon Glass int usb_init(void) 239de31213fSSimon Glass { 240de31213fSSimon Glass int controllers_initialized = 0; 241e253637bSHans de Goede struct usb_uclass_priv *uc_priv; 242b6de4d10SHans de Goede struct usb_bus_priv *priv; 243de31213fSSimon Glass struct udevice *bus; 244de31213fSSimon Glass struct uclass *uc; 245de31213fSSimon Glass int count = 0; 246de31213fSSimon Glass int ret; 247de31213fSSimon Glass 248de31213fSSimon Glass asynch_allowed = 1; 249de31213fSSimon Glass 250de31213fSSimon Glass ret = uclass_get(UCLASS_USB, &uc); 251de31213fSSimon Glass if (ret) 252de31213fSSimon Glass return ret; 253de31213fSSimon Glass 254e253637bSHans de Goede uc_priv = uc->priv; 255e253637bSHans de Goede 256de31213fSSimon Glass uclass_foreach_dev(bus, uc) { 257de31213fSSimon Glass /* init low_level USB */ 258134692afSHans de Goede printf("USB%d: ", count); 259de31213fSSimon Glass count++; 260d4efefe3SBin Meng 261d4efefe3SBin Meng #ifdef CONFIG_SANDBOX 262d4efefe3SBin Meng /* 263d4efefe3SBin Meng * For Sandbox, we need scan the device tree each time when we 264d4efefe3SBin Meng * start the USB stack, in order to re-create the emulated USB 265d4efefe3SBin Meng * devices and bind drivers for them before we actually do the 266d4efefe3SBin Meng * driver probe. 267d4efefe3SBin Meng */ 268d4efefe3SBin Meng ret = dm_scan_fdt_dev(bus); 269d4efefe3SBin Meng if (ret) { 270d4efefe3SBin Meng printf("Sandbox USB device scan failed (%d)\n", ret); 271d4efefe3SBin Meng continue; 272d4efefe3SBin Meng } 273d4efefe3SBin Meng #endif 274d4efefe3SBin Meng 275de31213fSSimon Glass ret = device_probe(bus); 276de31213fSSimon Glass if (ret == -ENODEV) { /* No such device. */ 277de31213fSSimon Glass puts("Port not available.\n"); 278de31213fSSimon Glass controllers_initialized++; 279de31213fSSimon Glass continue; 280de31213fSSimon Glass } 281de31213fSSimon Glass 282de31213fSSimon Glass if (ret) { /* Other error. */ 283de31213fSSimon Glass printf("probe failed, error %d\n", ret); 284de31213fSSimon Glass continue; 285de31213fSSimon Glass } 286de31213fSSimon Glass controllers_initialized++; 287de31213fSSimon Glass usb_started = true; 288de31213fSSimon Glass } 289de31213fSSimon Glass 290b6de4d10SHans de Goede /* 291b6de4d10SHans de Goede * lowlevel init done, now scan the bus for devices i.e. search HUBs 292b6de4d10SHans de Goede * and configure them, first scan primary controllers. 293b6de4d10SHans de Goede */ 294b6de4d10SHans de Goede uclass_foreach_dev(bus, uc) { 295b6de4d10SHans de Goede if (!device_active(bus)) 296b6de4d10SHans de Goede continue; 297b6de4d10SHans de Goede 298b6de4d10SHans de Goede priv = dev_get_uclass_priv(bus); 299b6de4d10SHans de Goede if (!priv->companion) 300b6de4d10SHans de Goede usb_scan_bus(bus, true); 301b6de4d10SHans de Goede } 302b6de4d10SHans de Goede 303b6de4d10SHans de Goede /* 304b6de4d10SHans de Goede * Now that the primary controllers have been scanned and have handed 305b6de4d10SHans de Goede * over any devices they do not understand to their companions, scan 306e253637bSHans de Goede * the companions if necessary. 307b6de4d10SHans de Goede */ 308e253637bSHans de Goede if (uc_priv->companion_device_count) { 309b6de4d10SHans de Goede uclass_foreach_dev(bus, uc) { 310b6de4d10SHans de Goede if (!device_active(bus)) 311b6de4d10SHans de Goede continue; 312b6de4d10SHans de Goede 313b6de4d10SHans de Goede priv = dev_get_uclass_priv(bus); 314b6de4d10SHans de Goede if (priv->companion) 315b6de4d10SHans de Goede usb_scan_bus(bus, true); 316b6de4d10SHans de Goede } 317e253637bSHans de Goede } 318b6de4d10SHans de Goede 319de31213fSSimon Glass debug("scan end\n"); 320eae11becSSimon Glass 321eae11becSSimon Glass /* Remove any devices that were not found on this scan */ 322eae11becSSimon Glass remove_inactive_children(uc, bus); 323eae11becSSimon Glass 324eae11becSSimon Glass ret = uclass_get(UCLASS_USB_HUB, &uc); 325eae11becSSimon Glass if (ret) 326eae11becSSimon Glass return ret; 327eae11becSSimon Glass remove_inactive_children(uc, bus); 328eae11becSSimon Glass 329de31213fSSimon Glass /* if we were not able to find at least one working bus, bail out */ 330de31213fSSimon Glass if (!count) 331de31213fSSimon Glass printf("No controllers found\n"); 332de31213fSSimon Glass else if (controllers_initialized == 0) 333de31213fSSimon Glass printf("USB error: all controllers failed lowlevel init\n"); 334de31213fSSimon Glass 335de31213fSSimon Glass return usb_started ? 0 : -1; 336de31213fSSimon Glass } 337de31213fSSimon Glass 338e8ea5e8cSSimon Glass /* 339e8ea5e8cSSimon Glass * TODO(sjg@chromium.org): Remove this legacy function. At present it is needed 340e8ea5e8cSSimon Glass * to support boards which use driver model for USB but not Ethernet, and want 341e8ea5e8cSSimon Glass * to use USB Ethernet. 342e8ea5e8cSSimon Glass * 343e8ea5e8cSSimon Glass * The #if clause is here to ensure that remains the only case. 344e8ea5e8cSSimon Glass */ 345e8ea5e8cSSimon Glass #if !defined(CONFIG_DM_ETH) && defined(CONFIG_USB_HOST_ETHER) 346de31213fSSimon Glass static struct usb_device *find_child_devnum(struct udevice *parent, int devnum) 347de31213fSSimon Glass { 348de31213fSSimon Glass struct usb_device *udev; 349de31213fSSimon Glass struct udevice *dev; 350de31213fSSimon Glass 351de31213fSSimon Glass if (!device_active(parent)) 352de31213fSSimon Glass return NULL; 353bcbe3d15SSimon Glass udev = dev_get_parent_priv(parent); 354de31213fSSimon Glass if (udev->devnum == devnum) 355de31213fSSimon Glass return udev; 356de31213fSSimon Glass 357de31213fSSimon Glass for (device_find_first_child(parent, &dev); 358de31213fSSimon Glass dev; 359de31213fSSimon Glass device_find_next_child(&dev)) { 360de31213fSSimon Glass udev = find_child_devnum(dev, devnum); 361de31213fSSimon Glass if (udev) 362de31213fSSimon Glass return udev; 363de31213fSSimon Glass } 364de31213fSSimon Glass 365de31213fSSimon Glass return NULL; 366de31213fSSimon Glass } 367de31213fSSimon Glass 368de31213fSSimon Glass struct usb_device *usb_get_dev_index(struct udevice *bus, int index) 369de31213fSSimon Glass { 370fd1bd21bSHans de Goede struct udevice *dev; 371de31213fSSimon Glass int devnum = index + 1; /* Addresses are allocated from 1 on USB */ 372de31213fSSimon Glass 373fd1bd21bSHans de Goede device_find_first_child(bus, &dev); 374fd1bd21bSHans de Goede if (!dev) 375de31213fSSimon Glass return NULL; 376fd1bd21bSHans de Goede 377fd1bd21bSHans de Goede return find_child_devnum(dev, devnum); 378de31213fSSimon Glass } 379e8ea5e8cSSimon Glass #endif 380de31213fSSimon Glass 381fbeceb26SSimon Glass int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp) 382fbeceb26SSimon Glass { 383fbeceb26SSimon Glass struct usb_platdata *plat; 384fbeceb26SSimon Glass struct udevice *dev; 385fbeceb26SSimon Glass int ret; 386fbeceb26SSimon Glass 387fbeceb26SSimon Glass /* Find the old device and remove it */ 388fbeceb26SSimon Glass ret = uclass_find_device_by_seq(UCLASS_USB, 0, true, &dev); 389fbeceb26SSimon Glass if (ret) 390fbeceb26SSimon Glass return ret; 391706865afSStefan Roese ret = device_remove(dev, DM_REMOVE_NORMAL); 392fbeceb26SSimon Glass if (ret) 393fbeceb26SSimon Glass return ret; 394fbeceb26SSimon Glass 395fbeceb26SSimon Glass plat = dev_get_platdata(dev); 396fbeceb26SSimon Glass plat->init_type = USB_INIT_DEVICE; 397fbeceb26SSimon Glass ret = device_probe(dev); 398fbeceb26SSimon Glass if (ret) 399fbeceb26SSimon Glass return ret; 400fbeceb26SSimon Glass *ctlrp = dev_get_priv(dev); 401fbeceb26SSimon Glass 402fbeceb26SSimon Glass return 0; 403fbeceb26SSimon Glass } 404fbeceb26SSimon Glass 4050566e240SSimon Glass /* returns 0 if no match, 1 if match */ 406121a4d13SMasahiro Yamada static int usb_match_device(const struct usb_device_descriptor *desc, 4070566e240SSimon Glass const struct usb_device_id *id) 4080566e240SSimon Glass { 4090566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) && 4100566e240SSimon Glass id->idVendor != le16_to_cpu(desc->idVendor)) 4110566e240SSimon Glass return 0; 4120566e240SSimon Glass 4130566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) && 4140566e240SSimon Glass id->idProduct != le16_to_cpu(desc->idProduct)) 4150566e240SSimon Glass return 0; 4160566e240SSimon Glass 4170566e240SSimon Glass /* No need to test id->bcdDevice_lo != 0, since 0 is never 4180566e240SSimon Glass greater than any unsigned number. */ 4190566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) && 4200566e240SSimon Glass (id->bcdDevice_lo > le16_to_cpu(desc->bcdDevice))) 4210566e240SSimon Glass return 0; 4220566e240SSimon Glass 4230566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) && 4240566e240SSimon Glass (id->bcdDevice_hi < le16_to_cpu(desc->bcdDevice))) 4250566e240SSimon Glass return 0; 4260566e240SSimon Glass 4270566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) && 4280566e240SSimon Glass (id->bDeviceClass != desc->bDeviceClass)) 4290566e240SSimon Glass return 0; 4300566e240SSimon Glass 4310566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) && 4320566e240SSimon Glass (id->bDeviceSubClass != desc->bDeviceSubClass)) 4330566e240SSimon Glass return 0; 4340566e240SSimon Glass 4350566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) && 4360566e240SSimon Glass (id->bDeviceProtocol != desc->bDeviceProtocol)) 4370566e240SSimon Glass return 0; 4380566e240SSimon Glass 4390566e240SSimon Glass return 1; 4400566e240SSimon Glass } 4410566e240SSimon Glass 4420566e240SSimon Glass /* returns 0 if no match, 1 if match */ 443121a4d13SMasahiro Yamada static int usb_match_one_id_intf(const struct usb_device_descriptor *desc, 4440566e240SSimon Glass const struct usb_interface_descriptor *int_desc, 4450566e240SSimon Glass const struct usb_device_id *id) 4460566e240SSimon Glass { 4470566e240SSimon Glass /* The interface class, subclass, protocol and number should never be 4480566e240SSimon Glass * checked for a match if the device class is Vendor Specific, 4490566e240SSimon Glass * unless the match record specifies the Vendor ID. */ 4500566e240SSimon Glass if (desc->bDeviceClass == USB_CLASS_VENDOR_SPEC && 4510566e240SSimon Glass !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) && 4520566e240SSimon Glass (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS | 4530566e240SSimon Glass USB_DEVICE_ID_MATCH_INT_SUBCLASS | 4540566e240SSimon Glass USB_DEVICE_ID_MATCH_INT_PROTOCOL | 4550566e240SSimon Glass USB_DEVICE_ID_MATCH_INT_NUMBER))) 4560566e240SSimon Glass return 0; 4570566e240SSimon Glass 4580566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) && 4590566e240SSimon Glass (id->bInterfaceClass != int_desc->bInterfaceClass)) 4600566e240SSimon Glass return 0; 4610566e240SSimon Glass 4620566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) && 4630566e240SSimon Glass (id->bInterfaceSubClass != int_desc->bInterfaceSubClass)) 4640566e240SSimon Glass return 0; 4650566e240SSimon Glass 4660566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) && 4670566e240SSimon Glass (id->bInterfaceProtocol != int_desc->bInterfaceProtocol)) 4680566e240SSimon Glass return 0; 4690566e240SSimon Glass 4700566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) && 4710566e240SSimon Glass (id->bInterfaceNumber != int_desc->bInterfaceNumber)) 4720566e240SSimon Glass return 0; 4730566e240SSimon Glass 4740566e240SSimon Glass return 1; 4750566e240SSimon Glass } 4760566e240SSimon Glass 4770566e240SSimon Glass /* returns 0 if no match, 1 if match */ 478121a4d13SMasahiro Yamada static int usb_match_one_id(struct usb_device_descriptor *desc, 4790566e240SSimon Glass struct usb_interface_descriptor *int_desc, 4800566e240SSimon Glass const struct usb_device_id *id) 4810566e240SSimon Glass { 4820566e240SSimon Glass if (!usb_match_device(desc, id)) 4830566e240SSimon Glass return 0; 4840566e240SSimon Glass 4850566e240SSimon Glass return usb_match_one_id_intf(desc, int_desc, id); 4860566e240SSimon Glass } 4870566e240SSimon Glass 4880566e240SSimon Glass /** 4890566e240SSimon Glass * usb_find_and_bind_driver() - Find and bind the right USB driver 4900566e240SSimon Glass * 4910566e240SSimon Glass * This only looks at certain fields in the descriptor. 4920566e240SSimon Glass */ 4930566e240SSimon Glass static int usb_find_and_bind_driver(struct udevice *parent, 4940566e240SSimon Glass struct usb_device_descriptor *desc, 4950566e240SSimon Glass struct usb_interface_descriptor *iface, 4960566e240SSimon Glass int bus_seq, int devnum, 4970566e240SSimon Glass struct udevice **devp) 4980566e240SSimon Glass { 4990566e240SSimon Glass struct usb_driver_entry *start, *entry; 5000566e240SSimon Glass int n_ents; 5010566e240SSimon Glass int ret; 5020566e240SSimon Glass char name[30], *str; 5030566e240SSimon Glass 5040566e240SSimon Glass *devp = NULL; 5050566e240SSimon Glass debug("%s: Searching for driver\n", __func__); 5060566e240SSimon Glass start = ll_entry_start(struct usb_driver_entry, usb_driver_entry); 5070566e240SSimon Glass n_ents = ll_entry_count(struct usb_driver_entry, usb_driver_entry); 5080566e240SSimon Glass for (entry = start; entry != start + n_ents; entry++) { 5090566e240SSimon Glass const struct usb_device_id *id; 5100566e240SSimon Glass struct udevice *dev; 5110566e240SSimon Glass const struct driver *drv; 5120566e240SSimon Glass struct usb_dev_platdata *plat; 5130566e240SSimon Glass 5140566e240SSimon Glass for (id = entry->match; id->match_flags; id++) { 5150566e240SSimon Glass if (!usb_match_one_id(desc, iface, id)) 5160566e240SSimon Glass continue; 5170566e240SSimon Glass 5180566e240SSimon Glass drv = entry->driver; 5190566e240SSimon Glass /* 5200566e240SSimon Glass * We could pass the descriptor to the driver as 5210566e240SSimon Glass * platdata (instead of NULL) and allow its bind() 5220566e240SSimon Glass * method to return -ENOENT if it doesn't support this 5230566e240SSimon Glass * device. That way we could continue the search to 5240566e240SSimon Glass * find another driver. For now this doesn't seem 5250566e240SSimon Glass * necesssary, so just bind the first match. 5260566e240SSimon Glass */ 5270566e240SSimon Glass ret = device_bind(parent, drv, drv->name, NULL, -1, 5280566e240SSimon Glass &dev); 5290566e240SSimon Glass if (ret) 5300566e240SSimon Glass goto error; 5310566e240SSimon Glass debug("%s: Match found: %s\n", __func__, drv->name); 5320566e240SSimon Glass dev->driver_data = id->driver_info; 5330566e240SSimon Glass plat = dev_get_parent_platdata(dev); 5340566e240SSimon Glass plat->id = *id; 5350566e240SSimon Glass *devp = dev; 5360566e240SSimon Glass return 0; 5370566e240SSimon Glass } 5380566e240SSimon Glass } 5390566e240SSimon Glass 540449230f0SSimon Glass /* Bind a generic driver so that the device can be used */ 541449230f0SSimon Glass snprintf(name, sizeof(name), "generic_bus_%x_dev_%x", bus_seq, devnum); 542449230f0SSimon Glass str = strdup(name); 543449230f0SSimon Glass if (!str) 544449230f0SSimon Glass return -ENOMEM; 545449230f0SSimon Glass ret = device_bind_driver(parent, "usb_dev_generic_drv", str, devp); 546449230f0SSimon Glass 5470566e240SSimon Glass error: 5480566e240SSimon Glass debug("%s: No match found: %d\n", __func__, ret); 5490566e240SSimon Glass return ret; 5500566e240SSimon Glass } 5510566e240SSimon Glass 5520566e240SSimon Glass /** 5531b6a1dffSSimon Glass * usb_find_child() - Find an existing device which matches our needs 5541b6a1dffSSimon Glass * 5551b6a1dffSSimon Glass * 5560566e240SSimon Glass */ 5571b6a1dffSSimon Glass static int usb_find_child(struct udevice *parent, 5580566e240SSimon Glass struct usb_device_descriptor *desc, 5590566e240SSimon Glass struct usb_interface_descriptor *iface, 5600566e240SSimon Glass struct udevice **devp) 5610566e240SSimon Glass { 5620566e240SSimon Glass struct udevice *dev; 5630566e240SSimon Glass 5640566e240SSimon Glass *devp = NULL; 5650566e240SSimon Glass for (device_find_first_child(parent, &dev); 5660566e240SSimon Glass dev; 5670566e240SSimon Glass device_find_next_child(&dev)) { 5680566e240SSimon Glass struct usb_dev_platdata *plat = dev_get_parent_platdata(dev); 5690566e240SSimon Glass 5700566e240SSimon Glass /* If this device is already in use, skip it */ 5710566e240SSimon Glass if (device_active(dev)) 5720566e240SSimon Glass continue; 5730566e240SSimon Glass debug(" %s: name='%s', plat=%d, desc=%d\n", __func__, 5740566e240SSimon Glass dev->name, plat->id.bDeviceClass, desc->bDeviceClass); 5750566e240SSimon Glass if (usb_match_one_id(desc, iface, &plat->id)) { 5760566e240SSimon Glass *devp = dev; 5770566e240SSimon Glass return 0; 5780566e240SSimon Glass } 5790566e240SSimon Glass } 5801b6a1dffSSimon Glass 5810566e240SSimon Glass return -ENOENT; 5820566e240SSimon Glass } 5830566e240SSimon Glass 584de31213fSSimon Glass int usb_scan_device(struct udevice *parent, int port, 585de31213fSSimon Glass enum usb_device_speed speed, struct udevice **devp) 586de31213fSSimon Glass { 587de31213fSSimon Glass struct udevice *dev; 588de31213fSSimon Glass bool created = false; 589de31213fSSimon Glass struct usb_dev_platdata *plat; 590de31213fSSimon Glass struct usb_bus_priv *priv; 591de31213fSSimon Glass struct usb_device *parent_udev; 592de31213fSSimon Glass int ret; 593de31213fSSimon Glass ALLOC_CACHE_ALIGN_BUFFER(struct usb_device, udev, 1); 594de31213fSSimon Glass struct usb_interface_descriptor *iface = &udev->config.if_desc[0].desc; 595de31213fSSimon Glass 596de31213fSSimon Glass *devp = NULL; 597de31213fSSimon Glass memset(udev, '\0', sizeof(*udev)); 598f78a5c07SHans de Goede udev->controller_dev = usb_get_bus(parent); 599de31213fSSimon Glass priv = dev_get_uclass_priv(udev->controller_dev); 600de31213fSSimon Glass 601de31213fSSimon Glass /* 602de31213fSSimon Glass * Somewhat nasty, this. We create a local device and use the normal 603de31213fSSimon Glass * USB stack to read its descriptor. Then we know what type of device 604de31213fSSimon Glass * to create for real. 605de31213fSSimon Glass * 606de31213fSSimon Glass * udev->dev is set to the parent, since we don't have a real device 607de31213fSSimon Glass * yet. The USB stack should not access udev.dev anyway, except perhaps 608de31213fSSimon Glass * to find the controller, and the controller will either be @parent, 609de31213fSSimon Glass * or some parent of @parent. 610de31213fSSimon Glass * 611de31213fSSimon Glass * Another option might be to create the device as a generic USB 612de31213fSSimon Glass * device, then morph it into the correct one when we know what it 613de31213fSSimon Glass * should be. This means that a generic USB device would morph into 614de31213fSSimon Glass * a network controller, or a USB flash stick, for example. However, 615de31213fSSimon Glass * we don't support such morphing and it isn't clear that it would 616de31213fSSimon Glass * be easy to do. 617de31213fSSimon Glass * 618de31213fSSimon Glass * Yet another option is to split out the USB stack parts of udev 619de31213fSSimon Glass * into something like a 'struct urb' (as Linux does) which can exist 620de31213fSSimon Glass * independently of any device. This feels cleaner, but calls for quite 621de31213fSSimon Glass * a big change to the USB stack. 622de31213fSSimon Glass * 623de31213fSSimon Glass * For now, the approach is to set up an empty udev, read its 624de31213fSSimon Glass * descriptor and assign it an address, then bind a real device and 625de31213fSSimon Glass * stash the resulting information into the device's parent 626de31213fSSimon Glass * platform data. Then when we probe it, usb_child_pre_probe() is called 627de31213fSSimon Glass * and it will pull the information out of the stash. 628de31213fSSimon Glass */ 629de31213fSSimon Glass udev->dev = parent; 630de31213fSSimon Glass udev->speed = speed; 631de31213fSSimon Glass udev->devnum = priv->next_addr + 1; 632de31213fSSimon Glass udev->portnr = port; 633de31213fSSimon Glass debug("Calling usb_setup_device(), portnr=%d\n", udev->portnr); 634de31213fSSimon Glass parent_udev = device_get_uclass_id(parent) == UCLASS_USB_HUB ? 635bcbe3d15SSimon Glass dev_get_parent_priv(parent) : NULL; 6369eb72dd1SHans de Goede ret = usb_setup_device(udev, priv->desc_before_addr, parent_udev); 637de31213fSSimon Glass debug("read_descriptor for '%s': ret=%d\n", parent->name, ret); 638de31213fSSimon Glass if (ret) 639de31213fSSimon Glass return ret; 6401b6a1dffSSimon Glass ret = usb_find_child(parent, &udev->descriptor, iface, &dev); 6411b6a1dffSSimon Glass debug("** usb_find_child returns %d\n", ret); 6420566e240SSimon Glass if (ret) { 6430566e240SSimon Glass if (ret != -ENOENT) 6440566e240SSimon Glass return ret; 6450566e240SSimon Glass ret = usb_find_and_bind_driver(parent, &udev->descriptor, iface, 6460566e240SSimon Glass udev->controller_dev->seq, 6470566e240SSimon Glass udev->devnum, &dev); 6480566e240SSimon Glass if (ret) 6490566e240SSimon Glass return ret; 6500566e240SSimon Glass created = true; 6510566e240SSimon Glass } 6520566e240SSimon Glass plat = dev_get_parent_platdata(dev); 6530566e240SSimon Glass debug("%s: Probing '%s', plat=%p\n", __func__, dev->name, plat); 6540566e240SSimon Glass plat->devnum = udev->devnum; 6557f1a0753SHans de Goede plat->udev = udev; 6560566e240SSimon Glass priv->next_addr++; 6570566e240SSimon Glass ret = device_probe(dev); 6580566e240SSimon Glass if (ret) { 6590566e240SSimon Glass debug("%s: Device '%s' probe failed\n", __func__, dev->name); 6600566e240SSimon Glass priv->next_addr--; 6610566e240SSimon Glass if (created) 6620566e240SSimon Glass device_unbind(dev); 6630566e240SSimon Glass return ret; 6640566e240SSimon Glass } 6650566e240SSimon Glass *devp = dev; 666de31213fSSimon Glass 6670566e240SSimon Glass return 0; 668de31213fSSimon Glass } 669de31213fSSimon Glass 6700c5dd9aeSSimon Glass /* 6710c5dd9aeSSimon Glass * Detect if a USB device has been plugged or unplugged. 6720c5dd9aeSSimon Glass */ 6730c5dd9aeSSimon Glass int usb_detect_change(void) 6740c5dd9aeSSimon Glass { 6750c5dd9aeSSimon Glass struct udevice *hub; 6760c5dd9aeSSimon Glass struct uclass *uc; 6770c5dd9aeSSimon Glass int change = 0; 6780c5dd9aeSSimon Glass int ret; 6790c5dd9aeSSimon Glass 6800c5dd9aeSSimon Glass ret = uclass_get(UCLASS_USB_HUB, &uc); 6810c5dd9aeSSimon Glass if (ret) 6820c5dd9aeSSimon Glass return ret; 6830c5dd9aeSSimon Glass 6840c5dd9aeSSimon Glass uclass_foreach_dev(hub, uc) { 6850c5dd9aeSSimon Glass struct usb_device *udev; 6860c5dd9aeSSimon Glass struct udevice *dev; 6870c5dd9aeSSimon Glass 6880c5dd9aeSSimon Glass if (!device_active(hub)) 6890c5dd9aeSSimon Glass continue; 6900c5dd9aeSSimon Glass for (device_find_first_child(hub, &dev); 6910c5dd9aeSSimon Glass dev; 6920c5dd9aeSSimon Glass device_find_next_child(&dev)) { 6930c5dd9aeSSimon Glass struct usb_port_status status; 6940c5dd9aeSSimon Glass 6950c5dd9aeSSimon Glass if (!device_active(dev)) 6960c5dd9aeSSimon Glass continue; 6970c5dd9aeSSimon Glass 698bcbe3d15SSimon Glass udev = dev_get_parent_priv(dev); 6990c5dd9aeSSimon Glass if (usb_get_port_status(udev, udev->portnr, &status) 7000c5dd9aeSSimon Glass < 0) 7010c5dd9aeSSimon Glass /* USB request failed */ 7020c5dd9aeSSimon Glass continue; 7030c5dd9aeSSimon Glass 7040c5dd9aeSSimon Glass if (le16_to_cpu(status.wPortChange) & 7050c5dd9aeSSimon Glass USB_PORT_STAT_C_CONNECTION) 7060c5dd9aeSSimon Glass change++; 7070c5dd9aeSSimon Glass } 7080c5dd9aeSSimon Glass } 7090c5dd9aeSSimon Glass 7100c5dd9aeSSimon Glass return change; 7110c5dd9aeSSimon Glass } 7120c5dd9aeSSimon Glass 713121a4d13SMasahiro Yamada static int usb_child_post_bind(struct udevice *dev) 714de31213fSSimon Glass { 715de31213fSSimon Glass struct usb_dev_platdata *plat = dev_get_parent_platdata(dev); 716de31213fSSimon Glass int val; 717de31213fSSimon Glass 718d20fd27dSSimon Glass if (!dev_of_valid(dev)) 719de31213fSSimon Glass return 0; 720de31213fSSimon Glass 721de31213fSSimon Glass /* We only support matching a few things */ 722d20fd27dSSimon Glass val = dev_read_u32_default(dev, "usb,device-class", -1); 723de31213fSSimon Glass if (val != -1) { 724de31213fSSimon Glass plat->id.match_flags |= USB_DEVICE_ID_MATCH_DEV_CLASS; 725de31213fSSimon Glass plat->id.bDeviceClass = val; 726de31213fSSimon Glass } 727d20fd27dSSimon Glass val = dev_read_u32_default(dev, "usb,interface-class", -1); 728de31213fSSimon Glass if (val != -1) { 729de31213fSSimon Glass plat->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS; 730de31213fSSimon Glass plat->id.bInterfaceClass = val; 731de31213fSSimon Glass } 732de31213fSSimon Glass 733de31213fSSimon Glass return 0; 734de31213fSSimon Glass } 735de31213fSSimon Glass 736f78a5c07SHans de Goede struct udevice *usb_get_bus(struct udevice *dev) 737de31213fSSimon Glass { 738de31213fSSimon Glass struct udevice *bus; 739de31213fSSimon Glass 740de31213fSSimon Glass for (bus = dev; bus && device_get_uclass_id(bus) != UCLASS_USB; ) 741de31213fSSimon Glass bus = bus->parent; 742de31213fSSimon Glass if (!bus) { 743de31213fSSimon Glass /* By design this cannot happen */ 744de31213fSSimon Glass assert(bus); 745de31213fSSimon Glass debug("USB HUB '%s' does not have a controller\n", dev->name); 746de31213fSSimon Glass } 747de31213fSSimon Glass 748f78a5c07SHans de Goede return bus; 749de31213fSSimon Glass } 750de31213fSSimon Glass 751de31213fSSimon Glass int usb_child_pre_probe(struct udevice *dev) 752de31213fSSimon Glass { 753bcbe3d15SSimon Glass struct usb_device *udev = dev_get_parent_priv(dev); 754de31213fSSimon Glass struct usb_dev_platdata *plat = dev_get_parent_platdata(dev); 755de31213fSSimon Glass int ret; 756de31213fSSimon Glass 7577f1a0753SHans de Goede if (plat->udev) { 7587f1a0753SHans de Goede /* 7597f1a0753SHans de Goede * Copy over all the values set in the on stack struct 7607f1a0753SHans de Goede * usb_device in usb_scan_device() to our final struct 7617f1a0753SHans de Goede * usb_device for this dev. 7627f1a0753SHans de Goede */ 7637f1a0753SHans de Goede *udev = *(plat->udev); 7647f1a0753SHans de Goede /* And clear plat->udev as it will not be valid for long */ 7657f1a0753SHans de Goede plat->udev = NULL; 766de31213fSSimon Glass udev->dev = dev; 7677f1a0753SHans de Goede } else { 7687f1a0753SHans de Goede /* 7697f1a0753SHans de Goede * This happens with devices which are explicitly bound 7707f1a0753SHans de Goede * instead of being discovered through usb_scan_device() 7717f1a0753SHans de Goede * such as sandbox emul devices. 7727f1a0753SHans de Goede */ 7737f1a0753SHans de Goede udev->dev = dev; 7747f1a0753SHans de Goede udev->controller_dev = usb_get_bus(dev); 775de31213fSSimon Glass udev->devnum = plat->devnum; 776de31213fSSimon Glass 7777f1a0753SHans de Goede /* 7787f1a0753SHans de Goede * udev did not go through usb_scan_device(), so we need to 7797f1a0753SHans de Goede * select the config and read the config descriptors. 7807f1a0753SHans de Goede */ 781de31213fSSimon Glass ret = usb_select_config(udev); 782de31213fSSimon Glass if (ret) 783de31213fSSimon Glass return ret; 7847f1a0753SHans de Goede } 785de31213fSSimon Glass 786de31213fSSimon Glass return 0; 787de31213fSSimon Glass } 788de31213fSSimon Glass 789de31213fSSimon Glass UCLASS_DRIVER(usb) = { 790de31213fSSimon Glass .id = UCLASS_USB, 791de31213fSSimon Glass .name = "usb", 792de31213fSSimon Glass .flags = DM_UC_FLAG_SEQ_ALIAS, 79391195485SSimon Glass .post_bind = dm_scan_fdt_dev, 794e253637bSHans de Goede .priv_auto_alloc_size = sizeof(struct usb_uclass_priv), 795de31213fSSimon Glass .per_child_auto_alloc_size = sizeof(struct usb_device), 796de31213fSSimon Glass .per_device_auto_alloc_size = sizeof(struct usb_bus_priv), 797de31213fSSimon Glass .child_post_bind = usb_child_post_bind, 798de31213fSSimon Glass .child_pre_probe = usb_child_pre_probe, 799de31213fSSimon Glass .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata), 800de31213fSSimon Glass }; 801449230f0SSimon Glass 802449230f0SSimon Glass UCLASS_DRIVER(usb_dev_generic) = { 803449230f0SSimon Glass .id = UCLASS_USB_DEV_GENERIC, 804449230f0SSimon Glass .name = "usb_dev_generic", 805449230f0SSimon Glass }; 806449230f0SSimon Glass 807449230f0SSimon Glass U_BOOT_DRIVER(usb_dev_generic_drv) = { 808449230f0SSimon Glass .id = UCLASS_USB_DEV_GENERIC, 809449230f0SSimon Glass .name = "usb_dev_generic_drv", 810449230f0SSimon Glass }; 811