1de31213fSSimon Glass /* 2de31213fSSimon Glass * (C) Copyright 2015 Google, Inc 3de31213fSSimon Glass * Written by Simon Glass <sjg@chromium.org> 4de31213fSSimon Glass * 50566e240SSimon Glass * usb_match_device() modified from Linux kernel v4.0. 60566e240SSimon Glass * 7de31213fSSimon Glass * SPDX-License-Identifier: GPL-2.0+ 8de31213fSSimon Glass */ 9de31213fSSimon Glass 10de31213fSSimon Glass #include <common.h> 11de31213fSSimon Glass #include <dm.h> 12de31213fSSimon Glass #include <errno.h> 13cf92e05cSSimon Glass #include <memalign.h> 14de31213fSSimon Glass #include <usb.h> 15de31213fSSimon Glass #include <dm/device-internal.h> 16de31213fSSimon Glass #include <dm/lists.h> 17de31213fSSimon Glass #include <dm/uclass-internal.h> 18de31213fSSimon Glass 19de31213fSSimon Glass DECLARE_GLOBAL_DATA_PTR; 20de31213fSSimon Glass 21de31213fSSimon Glass extern bool usb_started; /* flag for the started/stopped USB status */ 22de31213fSSimon Glass static bool asynch_allowed; 23de31213fSSimon Glass 24e253637bSHans de Goede struct usb_uclass_priv { 25e253637bSHans de Goede int companion_device_count; 26e253637bSHans de Goede }; 27e253637bSHans de Goede 28de31213fSSimon Glass int usb_disable_asynch(int disable) 29de31213fSSimon Glass { 30de31213fSSimon Glass int old_value = asynch_allowed; 31de31213fSSimon Glass 32de31213fSSimon Glass asynch_allowed = !disable; 33de31213fSSimon Glass return old_value; 34de31213fSSimon Glass } 35de31213fSSimon Glass 36de31213fSSimon Glass int submit_int_msg(struct usb_device *udev, unsigned long pipe, void *buffer, 37de31213fSSimon Glass int length, int interval) 38de31213fSSimon Glass { 39de31213fSSimon Glass struct udevice *bus = udev->controller_dev; 40de31213fSSimon Glass struct dm_usb_ops *ops = usb_get_ops(bus); 41de31213fSSimon Glass 42de31213fSSimon Glass if (!ops->interrupt) 43de31213fSSimon Glass return -ENOSYS; 44de31213fSSimon Glass 45de31213fSSimon Glass return ops->interrupt(bus, udev, pipe, buffer, length, interval); 46de31213fSSimon Glass } 47de31213fSSimon Glass 48de31213fSSimon Glass int submit_control_msg(struct usb_device *udev, unsigned long pipe, 49de31213fSSimon Glass void *buffer, int length, struct devrequest *setup) 50de31213fSSimon Glass { 51de31213fSSimon Glass struct udevice *bus = udev->controller_dev; 52de31213fSSimon Glass struct dm_usb_ops *ops = usb_get_ops(bus); 53e253637bSHans de Goede struct usb_uclass_priv *uc_priv = bus->uclass->priv; 54e253637bSHans de Goede int err; 55de31213fSSimon Glass 56de31213fSSimon Glass if (!ops->control) 57de31213fSSimon Glass return -ENOSYS; 58de31213fSSimon Glass 59e253637bSHans de Goede err = ops->control(bus, udev, pipe, buffer, length, setup); 60e253637bSHans de Goede if (setup->request == USB_REQ_SET_FEATURE && 61e253637bSHans de Goede setup->requesttype == USB_RT_PORT && 62e253637bSHans de Goede setup->value == cpu_to_le16(USB_PORT_FEAT_RESET) && 63e253637bSHans de Goede err == -ENXIO) { 64e253637bSHans de Goede /* Device handed over to companion after port reset */ 65e253637bSHans de Goede uc_priv->companion_device_count++; 66e253637bSHans de Goede } 67e253637bSHans de Goede 68e253637bSHans de Goede return err; 69de31213fSSimon Glass } 70de31213fSSimon Glass 71de31213fSSimon Glass int submit_bulk_msg(struct usb_device *udev, unsigned long pipe, void *buffer, 72de31213fSSimon Glass int length) 73de31213fSSimon Glass { 74de31213fSSimon Glass struct udevice *bus = udev->controller_dev; 75de31213fSSimon Glass struct dm_usb_ops *ops = usb_get_ops(bus); 76de31213fSSimon Glass 77de31213fSSimon Glass if (!ops->bulk) 78de31213fSSimon Glass return -ENOSYS; 79de31213fSSimon Glass 80de31213fSSimon Glass return ops->bulk(bus, udev, pipe, buffer, length); 81de31213fSSimon Glass } 82de31213fSSimon Glass 838a5f0665SHans de Goede struct int_queue *create_int_queue(struct usb_device *udev, 848a5f0665SHans de Goede unsigned long pipe, int queuesize, int elementsize, 858a5f0665SHans de Goede void *buffer, int interval) 868a5f0665SHans de Goede { 878a5f0665SHans de Goede struct udevice *bus = udev->controller_dev; 888a5f0665SHans de Goede struct dm_usb_ops *ops = usb_get_ops(bus); 898a5f0665SHans de Goede 908a5f0665SHans de Goede if (!ops->create_int_queue) 918a5f0665SHans de Goede return NULL; 928a5f0665SHans de Goede 938a5f0665SHans de Goede return ops->create_int_queue(bus, udev, pipe, queuesize, elementsize, 948a5f0665SHans de Goede buffer, interval); 958a5f0665SHans de Goede } 968a5f0665SHans de Goede 978a5f0665SHans de Goede void *poll_int_queue(struct usb_device *udev, struct int_queue *queue) 988a5f0665SHans de Goede { 998a5f0665SHans de Goede struct udevice *bus = udev->controller_dev; 1008a5f0665SHans de Goede struct dm_usb_ops *ops = usb_get_ops(bus); 1018a5f0665SHans de Goede 1028a5f0665SHans de Goede if (!ops->poll_int_queue) 1038a5f0665SHans de Goede return NULL; 1048a5f0665SHans de Goede 1058a5f0665SHans de Goede return ops->poll_int_queue(bus, udev, queue); 1068a5f0665SHans de Goede } 1078a5f0665SHans de Goede 1088a5f0665SHans de Goede int destroy_int_queue(struct usb_device *udev, struct int_queue *queue) 1098a5f0665SHans de Goede { 1108a5f0665SHans de Goede struct udevice *bus = udev->controller_dev; 1118a5f0665SHans de Goede struct dm_usb_ops *ops = usb_get_ops(bus); 1128a5f0665SHans de Goede 1138a5f0665SHans de Goede if (!ops->destroy_int_queue) 1148a5f0665SHans de Goede return -ENOSYS; 1158a5f0665SHans de Goede 1168a5f0665SHans de Goede return ops->destroy_int_queue(bus, udev, queue); 1178a5f0665SHans de Goede } 1188a5f0665SHans de Goede 119de31213fSSimon Glass int usb_alloc_device(struct usb_device *udev) 120de31213fSSimon Glass { 121de31213fSSimon Glass struct udevice *bus = udev->controller_dev; 122de31213fSSimon Glass struct dm_usb_ops *ops = usb_get_ops(bus); 123de31213fSSimon Glass 124de31213fSSimon Glass /* This is only requird by some controllers - current XHCI */ 125de31213fSSimon Glass if (!ops->alloc_device) 126de31213fSSimon Glass return 0; 127de31213fSSimon Glass 128de31213fSSimon Glass return ops->alloc_device(bus, udev); 129de31213fSSimon Glass } 130de31213fSSimon Glass 131b2f219b0SHans de Goede int usb_reset_root_port(struct usb_device *udev) 132b2f219b0SHans de Goede { 133b2f219b0SHans de Goede struct udevice *bus = udev->controller_dev; 134b2f219b0SHans de Goede struct dm_usb_ops *ops = usb_get_ops(bus); 135b2f219b0SHans de Goede 136b2f219b0SHans de Goede if (!ops->reset_root_port) 137b2f219b0SHans de Goede return -ENOSYS; 138b2f219b0SHans de Goede 139b2f219b0SHans de Goede return ops->reset_root_port(bus, udev); 140b2f219b0SHans de Goede } 141b2f219b0SHans de Goede 1429ca1b4baSBin Meng int usb_update_hub_device(struct usb_device *udev) 1439ca1b4baSBin Meng { 1449ca1b4baSBin Meng struct udevice *bus = udev->controller_dev; 1459ca1b4baSBin Meng struct dm_usb_ops *ops = usb_get_ops(bus); 1469ca1b4baSBin Meng 1479ca1b4baSBin Meng if (!ops->update_hub_device) 1489ca1b4baSBin Meng return -ENOSYS; 1499ca1b4baSBin Meng 1509ca1b4baSBin Meng return ops->update_hub_device(bus, udev); 1519ca1b4baSBin Meng } 1529ca1b4baSBin Meng 15351da7f21SBin Meng int usb_get_max_xfer_size(struct usb_device *udev, size_t *size) 15451da7f21SBin Meng { 15551da7f21SBin Meng struct udevice *bus = udev->controller_dev; 15651da7f21SBin Meng struct dm_usb_ops *ops = usb_get_ops(bus); 15751da7f21SBin Meng 15851da7f21SBin Meng if (!ops->get_max_xfer_size) 15951da7f21SBin Meng return -ENOSYS; 16051da7f21SBin Meng 16151da7f21SBin Meng return ops->get_max_xfer_size(bus, size); 16251da7f21SBin Meng } 16351da7f21SBin Meng 164de31213fSSimon Glass int usb_stop(void) 165de31213fSSimon Glass { 166de31213fSSimon Glass struct udevice *bus; 1674f46a20eSBin Meng struct udevice *rh; 168de31213fSSimon Glass struct uclass *uc; 169e253637bSHans de Goede struct usb_uclass_priv *uc_priv; 170de31213fSSimon Glass int err = 0, ret; 171de31213fSSimon Glass 172de31213fSSimon Glass /* De-activate any devices that have been activated */ 173de31213fSSimon Glass ret = uclass_get(UCLASS_USB, &uc); 174de31213fSSimon Glass if (ret) 175de31213fSSimon Glass return ret; 176e253637bSHans de Goede 177e253637bSHans de Goede uc_priv = uc->priv; 178e253637bSHans de Goede 179de31213fSSimon Glass uclass_foreach_dev(bus, uc) { 180706865afSStefan Roese ret = device_remove(bus, DM_REMOVE_NORMAL); 181de31213fSSimon Glass if (ret && !err) 182de31213fSSimon Glass err = ret; 1834f46a20eSBin Meng 1844f46a20eSBin Meng /* Locate root hub device */ 1854f46a20eSBin Meng device_find_first_child(bus, &rh); 1864f46a20eSBin Meng if (rh) { 1874f46a20eSBin Meng /* 1884f46a20eSBin Meng * All USB devices are children of root hub. 1894f46a20eSBin Meng * Unbinding root hub will unbind all of its children. 1904f46a20eSBin Meng */ 1914f46a20eSBin Meng ret = device_unbind(rh); 1924f46a20eSBin Meng if (ret && !err) 1934f46a20eSBin Meng err = ret; 1944f46a20eSBin Meng } 195de31213fSSimon Glass } 196*57058838SBin Meng 197095fdef0SSimon Glass #ifdef CONFIG_SANDBOX 198095fdef0SSimon Glass struct udevice *dev; 199095fdef0SSimon Glass 200095fdef0SSimon Glass /* Reset all enulation devices */ 201095fdef0SSimon Glass ret = uclass_get(UCLASS_USB_EMUL, &uc); 202095fdef0SSimon Glass if (ret) 203095fdef0SSimon Glass return ret; 204095fdef0SSimon Glass 205095fdef0SSimon Glass uclass_foreach_dev(dev, uc) 206095fdef0SSimon Glass usb_emul_reset(dev); 207095fdef0SSimon Glass #endif 2080fa5999bSPaul Kocialkowski #ifdef CONFIG_USB_STORAGE 209de31213fSSimon Glass usb_stor_reset(); 2100fa5999bSPaul Kocialkowski #endif 211e253637bSHans de Goede uc_priv->companion_device_count = 0; 212de31213fSSimon Glass usb_started = 0; 213de31213fSSimon Glass 214de31213fSSimon Glass return err; 215de31213fSSimon Glass } 216de31213fSSimon Glass 217a24a0e91SHans de Goede static void usb_scan_bus(struct udevice *bus, bool recurse) 218de31213fSSimon Glass { 219de31213fSSimon Glass struct usb_bus_priv *priv; 220de31213fSSimon Glass struct udevice *dev; 221de31213fSSimon Glass int ret; 222de31213fSSimon Glass 223de31213fSSimon Glass priv = dev_get_uclass_priv(bus); 224de31213fSSimon Glass 225de31213fSSimon Glass assert(recurse); /* TODO: Support non-recusive */ 226de31213fSSimon Glass 227a24a0e91SHans de Goede printf("scanning bus %d for devices... ", bus->seq); 228a24a0e91SHans de Goede debug("\n"); 229de31213fSSimon Glass ret = usb_scan_device(bus, 0, USB_SPEED_FULL, &dev); 230de31213fSSimon Glass if (ret) 231a24a0e91SHans de Goede printf("failed, error %d\n", ret); 232a24a0e91SHans de Goede else if (priv->next_addr == 0) 233a24a0e91SHans de Goede printf("No USB Device found\n"); 234a24a0e91SHans de Goede else 235a24a0e91SHans de Goede printf("%d USB Device(s) found\n", priv->next_addr); 236de31213fSSimon Glass } 237de31213fSSimon Glass 238eae11becSSimon Glass static void remove_inactive_children(struct uclass *uc, struct udevice *bus) 239eae11becSSimon Glass { 240eae11becSSimon Glass uclass_foreach_dev(bus, uc) { 241eae11becSSimon Glass struct udevice *dev, *next; 242eae11becSSimon Glass 243eae11becSSimon Glass if (!device_active(bus)) 244eae11becSSimon Glass continue; 245eae11becSSimon Glass device_foreach_child_safe(dev, next, bus) { 246eae11becSSimon Glass if (!device_active(dev)) 247eae11becSSimon Glass device_unbind(dev); 248eae11becSSimon Glass } 249eae11becSSimon Glass } 250eae11becSSimon Glass } 251eae11becSSimon Glass 252de31213fSSimon Glass int usb_init(void) 253de31213fSSimon Glass { 254de31213fSSimon Glass int controllers_initialized = 0; 255e253637bSHans de Goede struct usb_uclass_priv *uc_priv; 256b6de4d10SHans de Goede struct usb_bus_priv *priv; 257de31213fSSimon Glass struct udevice *bus; 258de31213fSSimon Glass struct uclass *uc; 259de31213fSSimon Glass int count = 0; 260de31213fSSimon Glass int ret; 261de31213fSSimon Glass 262de31213fSSimon Glass asynch_allowed = 1; 263de31213fSSimon Glass 264de31213fSSimon Glass ret = uclass_get(UCLASS_USB, &uc); 265de31213fSSimon Glass if (ret) 266de31213fSSimon Glass return ret; 267de31213fSSimon Glass 268e253637bSHans de Goede uc_priv = uc->priv; 269e253637bSHans de Goede 270de31213fSSimon Glass uclass_foreach_dev(bus, uc) { 271de31213fSSimon Glass /* init low_level USB */ 272134692afSHans de Goede printf("USB%d: ", count); 273de31213fSSimon Glass count++; 2744f46a20eSBin Meng 2754f46a20eSBin Meng #ifdef CONFIG_SANDBOX 2764f46a20eSBin Meng /* 2774f46a20eSBin Meng * For Sandbox, we need scan the device tree each time when we 2784f46a20eSBin Meng * start the USB stack, in order to re-create the emulated USB 2794f46a20eSBin Meng * devices and bind drivers for them before we actually do the 2804f46a20eSBin Meng * driver probe. 2814f46a20eSBin Meng */ 2824f46a20eSBin Meng ret = dm_scan_fdt_dev(bus); 2834f46a20eSBin Meng if (ret) { 2844f46a20eSBin Meng printf("Sandbox USB device scan failed (%d)\n", ret); 2854f46a20eSBin Meng continue; 2864f46a20eSBin Meng } 2874f46a20eSBin Meng #endif 2884f46a20eSBin Meng 289de31213fSSimon Glass ret = device_probe(bus); 290de31213fSSimon Glass if (ret == -ENODEV) { /* No such device. */ 291de31213fSSimon Glass puts("Port not available.\n"); 292de31213fSSimon Glass controllers_initialized++; 293de31213fSSimon Glass continue; 294de31213fSSimon Glass } 295de31213fSSimon Glass 296de31213fSSimon Glass if (ret) { /* Other error. */ 297de31213fSSimon Glass printf("probe failed, error %d\n", ret); 298de31213fSSimon Glass continue; 299de31213fSSimon Glass } 300de31213fSSimon Glass controllers_initialized++; 301de31213fSSimon Glass usb_started = true; 302de31213fSSimon Glass } 303de31213fSSimon Glass 304b6de4d10SHans de Goede /* 305b6de4d10SHans de Goede * lowlevel init done, now scan the bus for devices i.e. search HUBs 306b6de4d10SHans de Goede * and configure them, first scan primary controllers. 307b6de4d10SHans de Goede */ 308b6de4d10SHans de Goede uclass_foreach_dev(bus, uc) { 309b6de4d10SHans de Goede if (!device_active(bus)) 310b6de4d10SHans de Goede continue; 311b6de4d10SHans de Goede 312b6de4d10SHans de Goede priv = dev_get_uclass_priv(bus); 313b6de4d10SHans de Goede if (!priv->companion) 314b6de4d10SHans de Goede usb_scan_bus(bus, true); 315b6de4d10SHans de Goede } 316b6de4d10SHans de Goede 317b6de4d10SHans de Goede /* 318b6de4d10SHans de Goede * Now that the primary controllers have been scanned and have handed 319b6de4d10SHans de Goede * over any devices they do not understand to their companions, scan 320e253637bSHans de Goede * the companions if necessary. 321b6de4d10SHans de Goede */ 322e253637bSHans de Goede if (uc_priv->companion_device_count) { 323b6de4d10SHans de Goede uclass_foreach_dev(bus, uc) { 324b6de4d10SHans de Goede if (!device_active(bus)) 325b6de4d10SHans de Goede continue; 326b6de4d10SHans de Goede 327b6de4d10SHans de Goede priv = dev_get_uclass_priv(bus); 328b6de4d10SHans de Goede if (priv->companion) 329b6de4d10SHans de Goede usb_scan_bus(bus, true); 330b6de4d10SHans de Goede } 331e253637bSHans de Goede } 332b6de4d10SHans de Goede 333de31213fSSimon Glass debug("scan end\n"); 334eae11becSSimon Glass 335eae11becSSimon Glass /* Remove any devices that were not found on this scan */ 336eae11becSSimon Glass remove_inactive_children(uc, bus); 337eae11becSSimon Glass 338eae11becSSimon Glass ret = uclass_get(UCLASS_USB_HUB, &uc); 339eae11becSSimon Glass if (ret) 340eae11becSSimon Glass return ret; 341eae11becSSimon Glass remove_inactive_children(uc, bus); 342eae11becSSimon Glass 343de31213fSSimon Glass /* if we were not able to find at least one working bus, bail out */ 344de31213fSSimon Glass if (!count) 345de31213fSSimon Glass printf("No controllers found\n"); 346de31213fSSimon Glass else if (controllers_initialized == 0) 347de31213fSSimon Glass printf("USB error: all controllers failed lowlevel init\n"); 348de31213fSSimon Glass 349de31213fSSimon Glass return usb_started ? 0 : -1; 350de31213fSSimon Glass } 351de31213fSSimon Glass 352e8ea5e8cSSimon Glass /* 353e8ea5e8cSSimon Glass * TODO(sjg@chromium.org): Remove this legacy function. At present it is needed 354e8ea5e8cSSimon Glass * to support boards which use driver model for USB but not Ethernet, and want 355e8ea5e8cSSimon Glass * to use USB Ethernet. 356e8ea5e8cSSimon Glass * 357e8ea5e8cSSimon Glass * The #if clause is here to ensure that remains the only case. 358e8ea5e8cSSimon Glass */ 359e8ea5e8cSSimon Glass #if !defined(CONFIG_DM_ETH) && defined(CONFIG_USB_HOST_ETHER) 360de31213fSSimon Glass static struct usb_device *find_child_devnum(struct udevice *parent, int devnum) 361de31213fSSimon Glass { 362de31213fSSimon Glass struct usb_device *udev; 363de31213fSSimon Glass struct udevice *dev; 364de31213fSSimon Glass 365de31213fSSimon Glass if (!device_active(parent)) 366de31213fSSimon Glass return NULL; 367bcbe3d15SSimon Glass udev = dev_get_parent_priv(parent); 368de31213fSSimon Glass if (udev->devnum == devnum) 369de31213fSSimon Glass return udev; 370de31213fSSimon Glass 371de31213fSSimon Glass for (device_find_first_child(parent, &dev); 372de31213fSSimon Glass dev; 373de31213fSSimon Glass device_find_next_child(&dev)) { 374de31213fSSimon Glass udev = find_child_devnum(dev, devnum); 375de31213fSSimon Glass if (udev) 376de31213fSSimon Glass return udev; 377de31213fSSimon Glass } 378de31213fSSimon Glass 379de31213fSSimon Glass return NULL; 380de31213fSSimon Glass } 381de31213fSSimon Glass 382de31213fSSimon Glass struct usb_device *usb_get_dev_index(struct udevice *bus, int index) 383de31213fSSimon Glass { 384fd1bd21bSHans de Goede struct udevice *dev; 385de31213fSSimon Glass int devnum = index + 1; /* Addresses are allocated from 1 on USB */ 386de31213fSSimon Glass 387fd1bd21bSHans de Goede device_find_first_child(bus, &dev); 388fd1bd21bSHans de Goede if (!dev) 389de31213fSSimon Glass return NULL; 390fd1bd21bSHans de Goede 391fd1bd21bSHans de Goede return find_child_devnum(dev, devnum); 392de31213fSSimon Glass } 393e8ea5e8cSSimon Glass #endif 394de31213fSSimon Glass 395fbeceb26SSimon Glass int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp) 396fbeceb26SSimon Glass { 397fbeceb26SSimon Glass struct usb_platdata *plat; 398fbeceb26SSimon Glass struct udevice *dev; 399fbeceb26SSimon Glass int ret; 400fbeceb26SSimon Glass 401fbeceb26SSimon Glass /* Find the old device and remove it */ 402fbeceb26SSimon Glass ret = uclass_find_device_by_seq(UCLASS_USB, 0, true, &dev); 403fbeceb26SSimon Glass if (ret) 404fbeceb26SSimon Glass return ret; 405706865afSStefan Roese ret = device_remove(dev, DM_REMOVE_NORMAL); 406fbeceb26SSimon Glass if (ret) 407fbeceb26SSimon Glass return ret; 408fbeceb26SSimon Glass 409fbeceb26SSimon Glass plat = dev_get_platdata(dev); 410fbeceb26SSimon Glass plat->init_type = USB_INIT_DEVICE; 411fbeceb26SSimon Glass ret = device_probe(dev); 412fbeceb26SSimon Glass if (ret) 413fbeceb26SSimon Glass return ret; 414fbeceb26SSimon Glass *ctlrp = dev_get_priv(dev); 415fbeceb26SSimon Glass 416fbeceb26SSimon Glass return 0; 417fbeceb26SSimon Glass } 418fbeceb26SSimon Glass 4190566e240SSimon Glass /* returns 0 if no match, 1 if match */ 420121a4d13SMasahiro Yamada static int usb_match_device(const struct usb_device_descriptor *desc, 4210566e240SSimon Glass const struct usb_device_id *id) 4220566e240SSimon Glass { 4230566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) && 4240566e240SSimon Glass id->idVendor != le16_to_cpu(desc->idVendor)) 4250566e240SSimon Glass return 0; 4260566e240SSimon Glass 4270566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) && 4280566e240SSimon Glass id->idProduct != le16_to_cpu(desc->idProduct)) 4290566e240SSimon Glass return 0; 4300566e240SSimon Glass 4310566e240SSimon Glass /* No need to test id->bcdDevice_lo != 0, since 0 is never 4320566e240SSimon Glass greater than any unsigned number. */ 4330566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) && 4340566e240SSimon Glass (id->bcdDevice_lo > le16_to_cpu(desc->bcdDevice))) 4350566e240SSimon Glass return 0; 4360566e240SSimon Glass 4370566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) && 4380566e240SSimon Glass (id->bcdDevice_hi < le16_to_cpu(desc->bcdDevice))) 4390566e240SSimon Glass return 0; 4400566e240SSimon Glass 4410566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) && 4420566e240SSimon Glass (id->bDeviceClass != desc->bDeviceClass)) 4430566e240SSimon Glass return 0; 4440566e240SSimon Glass 4450566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) && 4460566e240SSimon Glass (id->bDeviceSubClass != desc->bDeviceSubClass)) 4470566e240SSimon Glass return 0; 4480566e240SSimon Glass 4490566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) && 4500566e240SSimon Glass (id->bDeviceProtocol != desc->bDeviceProtocol)) 4510566e240SSimon Glass return 0; 4520566e240SSimon Glass 4530566e240SSimon Glass return 1; 4540566e240SSimon Glass } 4550566e240SSimon Glass 4560566e240SSimon Glass /* returns 0 if no match, 1 if match */ 457121a4d13SMasahiro Yamada static int usb_match_one_id_intf(const struct usb_device_descriptor *desc, 4580566e240SSimon Glass const struct usb_interface_descriptor *int_desc, 4590566e240SSimon Glass const struct usb_device_id *id) 4600566e240SSimon Glass { 4610566e240SSimon Glass /* The interface class, subclass, protocol and number should never be 4620566e240SSimon Glass * checked for a match if the device class is Vendor Specific, 4630566e240SSimon Glass * unless the match record specifies the Vendor ID. */ 4640566e240SSimon Glass if (desc->bDeviceClass == USB_CLASS_VENDOR_SPEC && 4650566e240SSimon Glass !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) && 4660566e240SSimon Glass (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS | 4670566e240SSimon Glass USB_DEVICE_ID_MATCH_INT_SUBCLASS | 4680566e240SSimon Glass USB_DEVICE_ID_MATCH_INT_PROTOCOL | 4690566e240SSimon Glass USB_DEVICE_ID_MATCH_INT_NUMBER))) 4700566e240SSimon Glass return 0; 4710566e240SSimon Glass 4720566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) && 4730566e240SSimon Glass (id->bInterfaceClass != int_desc->bInterfaceClass)) 4740566e240SSimon Glass return 0; 4750566e240SSimon Glass 4760566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) && 4770566e240SSimon Glass (id->bInterfaceSubClass != int_desc->bInterfaceSubClass)) 4780566e240SSimon Glass return 0; 4790566e240SSimon Glass 4800566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) && 4810566e240SSimon Glass (id->bInterfaceProtocol != int_desc->bInterfaceProtocol)) 4820566e240SSimon Glass return 0; 4830566e240SSimon Glass 4840566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) && 4850566e240SSimon Glass (id->bInterfaceNumber != int_desc->bInterfaceNumber)) 4860566e240SSimon Glass return 0; 4870566e240SSimon Glass 4880566e240SSimon Glass return 1; 4890566e240SSimon Glass } 4900566e240SSimon Glass 4910566e240SSimon Glass /* returns 0 if no match, 1 if match */ 492121a4d13SMasahiro Yamada static int usb_match_one_id(struct usb_device_descriptor *desc, 4930566e240SSimon Glass struct usb_interface_descriptor *int_desc, 4940566e240SSimon Glass const struct usb_device_id *id) 4950566e240SSimon Glass { 4960566e240SSimon Glass if (!usb_match_device(desc, id)) 4970566e240SSimon Glass return 0; 4980566e240SSimon Glass 4990566e240SSimon Glass return usb_match_one_id_intf(desc, int_desc, id); 5000566e240SSimon Glass } 5010566e240SSimon Glass 5020566e240SSimon Glass /** 5030566e240SSimon Glass * usb_find_and_bind_driver() - Find and bind the right USB driver 5040566e240SSimon Glass * 5050566e240SSimon Glass * This only looks at certain fields in the descriptor. 5060566e240SSimon Glass */ 5070566e240SSimon Glass static int usb_find_and_bind_driver(struct udevice *parent, 5080566e240SSimon Glass struct usb_device_descriptor *desc, 5090566e240SSimon Glass struct usb_interface_descriptor *iface, 5100566e240SSimon Glass int bus_seq, int devnum, 5110566e240SSimon Glass struct udevice **devp) 5120566e240SSimon Glass { 5130566e240SSimon Glass struct usb_driver_entry *start, *entry; 5140566e240SSimon Glass int n_ents; 5150566e240SSimon Glass int ret; 5160566e240SSimon Glass char name[30], *str; 5170566e240SSimon Glass 5180566e240SSimon Glass *devp = NULL; 5190566e240SSimon Glass debug("%s: Searching for driver\n", __func__); 5200566e240SSimon Glass start = ll_entry_start(struct usb_driver_entry, usb_driver_entry); 5210566e240SSimon Glass n_ents = ll_entry_count(struct usb_driver_entry, usb_driver_entry); 5220566e240SSimon Glass for (entry = start; entry != start + n_ents; entry++) { 5230566e240SSimon Glass const struct usb_device_id *id; 5240566e240SSimon Glass struct udevice *dev; 5250566e240SSimon Glass const struct driver *drv; 5260566e240SSimon Glass struct usb_dev_platdata *plat; 5270566e240SSimon Glass 5280566e240SSimon Glass for (id = entry->match; id->match_flags; id++) { 5290566e240SSimon Glass if (!usb_match_one_id(desc, iface, id)) 5300566e240SSimon Glass continue; 5310566e240SSimon Glass 5320566e240SSimon Glass drv = entry->driver; 5330566e240SSimon Glass /* 5340566e240SSimon Glass * We could pass the descriptor to the driver as 5350566e240SSimon Glass * platdata (instead of NULL) and allow its bind() 5360566e240SSimon Glass * method to return -ENOENT if it doesn't support this 5370566e240SSimon Glass * device. That way we could continue the search to 5380566e240SSimon Glass * find another driver. For now this doesn't seem 5390566e240SSimon Glass * necesssary, so just bind the first match. 5400566e240SSimon Glass */ 5410566e240SSimon Glass ret = device_bind(parent, drv, drv->name, NULL, -1, 5420566e240SSimon Glass &dev); 5430566e240SSimon Glass if (ret) 5440566e240SSimon Glass goto error; 5450566e240SSimon Glass debug("%s: Match found: %s\n", __func__, drv->name); 5460566e240SSimon Glass dev->driver_data = id->driver_info; 5470566e240SSimon Glass plat = dev_get_parent_platdata(dev); 5480566e240SSimon Glass plat->id = *id; 5490566e240SSimon Glass *devp = dev; 5500566e240SSimon Glass return 0; 5510566e240SSimon Glass } 5520566e240SSimon Glass } 5530566e240SSimon Glass 554449230f0SSimon Glass /* Bind a generic driver so that the device can be used */ 555449230f0SSimon Glass snprintf(name, sizeof(name), "generic_bus_%x_dev_%x", bus_seq, devnum); 556449230f0SSimon Glass str = strdup(name); 557449230f0SSimon Glass if (!str) 558449230f0SSimon Glass return -ENOMEM; 559449230f0SSimon Glass ret = device_bind_driver(parent, "usb_dev_generic_drv", str, devp); 560449230f0SSimon Glass 5610566e240SSimon Glass error: 5620566e240SSimon Glass debug("%s: No match found: %d\n", __func__, ret); 5630566e240SSimon Glass return ret; 5640566e240SSimon Glass } 5650566e240SSimon Glass 5660566e240SSimon Glass /** 5671b6a1dffSSimon Glass * usb_find_child() - Find an existing device which matches our needs 5681b6a1dffSSimon Glass * 5691b6a1dffSSimon Glass * 5700566e240SSimon Glass */ 5711b6a1dffSSimon Glass static int usb_find_child(struct udevice *parent, 5720566e240SSimon Glass struct usb_device_descriptor *desc, 5730566e240SSimon Glass struct usb_interface_descriptor *iface, 5740566e240SSimon Glass struct udevice **devp) 5750566e240SSimon Glass { 5760566e240SSimon Glass struct udevice *dev; 5770566e240SSimon Glass 5780566e240SSimon Glass *devp = NULL; 5790566e240SSimon Glass for (device_find_first_child(parent, &dev); 5800566e240SSimon Glass dev; 5810566e240SSimon Glass device_find_next_child(&dev)) { 5820566e240SSimon Glass struct usb_dev_platdata *plat = dev_get_parent_platdata(dev); 5830566e240SSimon Glass 5840566e240SSimon Glass /* If this device is already in use, skip it */ 5850566e240SSimon Glass if (device_active(dev)) 5860566e240SSimon Glass continue; 5870566e240SSimon Glass debug(" %s: name='%s', plat=%d, desc=%d\n", __func__, 5880566e240SSimon Glass dev->name, plat->id.bDeviceClass, desc->bDeviceClass); 5890566e240SSimon Glass if (usb_match_one_id(desc, iface, &plat->id)) { 5900566e240SSimon Glass *devp = dev; 5910566e240SSimon Glass return 0; 5920566e240SSimon Glass } 5930566e240SSimon Glass } 5941b6a1dffSSimon Glass 5950566e240SSimon Glass return -ENOENT; 5960566e240SSimon Glass } 5970566e240SSimon Glass 598de31213fSSimon Glass int usb_scan_device(struct udevice *parent, int port, 599de31213fSSimon Glass enum usb_device_speed speed, struct udevice **devp) 600de31213fSSimon Glass { 601de31213fSSimon Glass struct udevice *dev; 602de31213fSSimon Glass bool created = false; 603de31213fSSimon Glass struct usb_dev_platdata *plat; 604de31213fSSimon Glass struct usb_bus_priv *priv; 605de31213fSSimon Glass struct usb_device *parent_udev; 606de31213fSSimon Glass int ret; 607de31213fSSimon Glass ALLOC_CACHE_ALIGN_BUFFER(struct usb_device, udev, 1); 608de31213fSSimon Glass struct usb_interface_descriptor *iface = &udev->config.if_desc[0].desc; 609de31213fSSimon Glass 610de31213fSSimon Glass *devp = NULL; 611de31213fSSimon Glass memset(udev, '\0', sizeof(*udev)); 612f78a5c07SHans de Goede udev->controller_dev = usb_get_bus(parent); 613de31213fSSimon Glass priv = dev_get_uclass_priv(udev->controller_dev); 614de31213fSSimon Glass 615de31213fSSimon Glass /* 616de31213fSSimon Glass * Somewhat nasty, this. We create a local device and use the normal 617de31213fSSimon Glass * USB stack to read its descriptor. Then we know what type of device 618de31213fSSimon Glass * to create for real. 619de31213fSSimon Glass * 620de31213fSSimon Glass * udev->dev is set to the parent, since we don't have a real device 621de31213fSSimon Glass * yet. The USB stack should not access udev.dev anyway, except perhaps 622de31213fSSimon Glass * to find the controller, and the controller will either be @parent, 623de31213fSSimon Glass * or some parent of @parent. 624de31213fSSimon Glass * 625de31213fSSimon Glass * Another option might be to create the device as a generic USB 626de31213fSSimon Glass * device, then morph it into the correct one when we know what it 627de31213fSSimon Glass * should be. This means that a generic USB device would morph into 628de31213fSSimon Glass * a network controller, or a USB flash stick, for example. However, 629de31213fSSimon Glass * we don't support such morphing and it isn't clear that it would 630de31213fSSimon Glass * be easy to do. 631de31213fSSimon Glass * 632de31213fSSimon Glass * Yet another option is to split out the USB stack parts of udev 633de31213fSSimon Glass * into something like a 'struct urb' (as Linux does) which can exist 634de31213fSSimon Glass * independently of any device. This feels cleaner, but calls for quite 635de31213fSSimon Glass * a big change to the USB stack. 636de31213fSSimon Glass * 637de31213fSSimon Glass * For now, the approach is to set up an empty udev, read its 638de31213fSSimon Glass * descriptor and assign it an address, then bind a real device and 639de31213fSSimon Glass * stash the resulting information into the device's parent 640de31213fSSimon Glass * platform data. Then when we probe it, usb_child_pre_probe() is called 641de31213fSSimon Glass * and it will pull the information out of the stash. 642de31213fSSimon Glass */ 643de31213fSSimon Glass udev->dev = parent; 644de31213fSSimon Glass udev->speed = speed; 645de31213fSSimon Glass udev->devnum = priv->next_addr + 1; 646de31213fSSimon Glass udev->portnr = port; 647de31213fSSimon Glass debug("Calling usb_setup_device(), portnr=%d\n", udev->portnr); 648de31213fSSimon Glass parent_udev = device_get_uclass_id(parent) == UCLASS_USB_HUB ? 649bcbe3d15SSimon Glass dev_get_parent_priv(parent) : NULL; 6509eb72dd1SHans de Goede ret = usb_setup_device(udev, priv->desc_before_addr, parent_udev); 651de31213fSSimon Glass debug("read_descriptor for '%s': ret=%d\n", parent->name, ret); 652de31213fSSimon Glass if (ret) 653de31213fSSimon Glass return ret; 6541b6a1dffSSimon Glass ret = usb_find_child(parent, &udev->descriptor, iface, &dev); 6551b6a1dffSSimon Glass debug("** usb_find_child returns %d\n", ret); 6560566e240SSimon Glass if (ret) { 6570566e240SSimon Glass if (ret != -ENOENT) 6580566e240SSimon Glass return ret; 6590566e240SSimon Glass ret = usb_find_and_bind_driver(parent, &udev->descriptor, iface, 6600566e240SSimon Glass udev->controller_dev->seq, 6610566e240SSimon Glass udev->devnum, &dev); 6620566e240SSimon Glass if (ret) 6630566e240SSimon Glass return ret; 6640566e240SSimon Glass created = true; 6650566e240SSimon Glass } 6660566e240SSimon Glass plat = dev_get_parent_platdata(dev); 6670566e240SSimon Glass debug("%s: Probing '%s', plat=%p\n", __func__, dev->name, plat); 6680566e240SSimon Glass plat->devnum = udev->devnum; 6697f1a0753SHans de Goede plat->udev = udev; 6700566e240SSimon Glass priv->next_addr++; 6710566e240SSimon Glass ret = device_probe(dev); 6720566e240SSimon Glass if (ret) { 6730566e240SSimon Glass debug("%s: Device '%s' probe failed\n", __func__, dev->name); 6740566e240SSimon Glass priv->next_addr--; 6750566e240SSimon Glass if (created) 6760566e240SSimon Glass device_unbind(dev); 6770566e240SSimon Glass return ret; 6780566e240SSimon Glass } 6790566e240SSimon Glass *devp = dev; 680de31213fSSimon Glass 6810566e240SSimon Glass return 0; 682de31213fSSimon Glass } 683de31213fSSimon Glass 6840c5dd9aeSSimon Glass /* 6850c5dd9aeSSimon Glass * Detect if a USB device has been plugged or unplugged. 6860c5dd9aeSSimon Glass */ 6870c5dd9aeSSimon Glass int usb_detect_change(void) 6880c5dd9aeSSimon Glass { 6890c5dd9aeSSimon Glass struct udevice *hub; 6900c5dd9aeSSimon Glass struct uclass *uc; 6910c5dd9aeSSimon Glass int change = 0; 6920c5dd9aeSSimon Glass int ret; 6930c5dd9aeSSimon Glass 6940c5dd9aeSSimon Glass ret = uclass_get(UCLASS_USB_HUB, &uc); 6950c5dd9aeSSimon Glass if (ret) 6960c5dd9aeSSimon Glass return ret; 6970c5dd9aeSSimon Glass 6980c5dd9aeSSimon Glass uclass_foreach_dev(hub, uc) { 6990c5dd9aeSSimon Glass struct usb_device *udev; 7000c5dd9aeSSimon Glass struct udevice *dev; 7010c5dd9aeSSimon Glass 7020c5dd9aeSSimon Glass if (!device_active(hub)) 7030c5dd9aeSSimon Glass continue; 7040c5dd9aeSSimon Glass for (device_find_first_child(hub, &dev); 7050c5dd9aeSSimon Glass dev; 7060c5dd9aeSSimon Glass device_find_next_child(&dev)) { 7070c5dd9aeSSimon Glass struct usb_port_status status; 7080c5dd9aeSSimon Glass 7090c5dd9aeSSimon Glass if (!device_active(dev)) 7100c5dd9aeSSimon Glass continue; 7110c5dd9aeSSimon Glass 712bcbe3d15SSimon Glass udev = dev_get_parent_priv(dev); 7130c5dd9aeSSimon Glass if (usb_get_port_status(udev, udev->portnr, &status) 7140c5dd9aeSSimon Glass < 0) 7150c5dd9aeSSimon Glass /* USB request failed */ 7160c5dd9aeSSimon Glass continue; 7170c5dd9aeSSimon Glass 7180c5dd9aeSSimon Glass if (le16_to_cpu(status.wPortChange) & 7190c5dd9aeSSimon Glass USB_PORT_STAT_C_CONNECTION) 7200c5dd9aeSSimon Glass change++; 7210c5dd9aeSSimon Glass } 7220c5dd9aeSSimon Glass } 7230c5dd9aeSSimon Glass 7240c5dd9aeSSimon Glass return change; 7250c5dd9aeSSimon Glass } 7260c5dd9aeSSimon Glass 727121a4d13SMasahiro Yamada static int usb_child_post_bind(struct udevice *dev) 728de31213fSSimon Glass { 729de31213fSSimon Glass struct usb_dev_platdata *plat = dev_get_parent_platdata(dev); 730de31213fSSimon Glass int val; 731de31213fSSimon Glass 732d20fd27dSSimon Glass if (!dev_of_valid(dev)) 733de31213fSSimon Glass return 0; 734de31213fSSimon Glass 735de31213fSSimon Glass /* We only support matching a few things */ 736d20fd27dSSimon Glass val = dev_read_u32_default(dev, "usb,device-class", -1); 737de31213fSSimon Glass if (val != -1) { 738de31213fSSimon Glass plat->id.match_flags |= USB_DEVICE_ID_MATCH_DEV_CLASS; 739de31213fSSimon Glass plat->id.bDeviceClass = val; 740de31213fSSimon Glass } 741d20fd27dSSimon Glass val = dev_read_u32_default(dev, "usb,interface-class", -1); 742de31213fSSimon Glass if (val != -1) { 743de31213fSSimon Glass plat->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS; 744de31213fSSimon Glass plat->id.bInterfaceClass = val; 745de31213fSSimon Glass } 746de31213fSSimon Glass 747de31213fSSimon Glass return 0; 748de31213fSSimon Glass } 749de31213fSSimon Glass 750f78a5c07SHans de Goede struct udevice *usb_get_bus(struct udevice *dev) 751de31213fSSimon Glass { 752de31213fSSimon Glass struct udevice *bus; 753de31213fSSimon Glass 754de31213fSSimon Glass for (bus = dev; bus && device_get_uclass_id(bus) != UCLASS_USB; ) 755de31213fSSimon Glass bus = bus->parent; 756de31213fSSimon Glass if (!bus) { 757de31213fSSimon Glass /* By design this cannot happen */ 758de31213fSSimon Glass assert(bus); 759de31213fSSimon Glass debug("USB HUB '%s' does not have a controller\n", dev->name); 760de31213fSSimon Glass } 761de31213fSSimon Glass 762f78a5c07SHans de Goede return bus; 763de31213fSSimon Glass } 764de31213fSSimon Glass 765de31213fSSimon Glass int usb_child_pre_probe(struct udevice *dev) 766de31213fSSimon Glass { 767bcbe3d15SSimon Glass struct usb_device *udev = dev_get_parent_priv(dev); 768de31213fSSimon Glass struct usb_dev_platdata *plat = dev_get_parent_platdata(dev); 769de31213fSSimon Glass int ret; 770de31213fSSimon Glass 7717f1a0753SHans de Goede if (plat->udev) { 7727f1a0753SHans de Goede /* 7737f1a0753SHans de Goede * Copy over all the values set in the on stack struct 7747f1a0753SHans de Goede * usb_device in usb_scan_device() to our final struct 7757f1a0753SHans de Goede * usb_device for this dev. 7767f1a0753SHans de Goede */ 7777f1a0753SHans de Goede *udev = *(plat->udev); 7787f1a0753SHans de Goede /* And clear plat->udev as it will not be valid for long */ 7797f1a0753SHans de Goede plat->udev = NULL; 780de31213fSSimon Glass udev->dev = dev; 7817f1a0753SHans de Goede } else { 7827f1a0753SHans de Goede /* 7837f1a0753SHans de Goede * This happens with devices which are explicitly bound 7847f1a0753SHans de Goede * instead of being discovered through usb_scan_device() 7857f1a0753SHans de Goede * such as sandbox emul devices. 7867f1a0753SHans de Goede */ 7877f1a0753SHans de Goede udev->dev = dev; 7887f1a0753SHans de Goede udev->controller_dev = usb_get_bus(dev); 789de31213fSSimon Glass udev->devnum = plat->devnum; 790de31213fSSimon Glass 7917f1a0753SHans de Goede /* 7927f1a0753SHans de Goede * udev did not go through usb_scan_device(), so we need to 7937f1a0753SHans de Goede * select the config and read the config descriptors. 7947f1a0753SHans de Goede */ 795de31213fSSimon Glass ret = usb_select_config(udev); 796de31213fSSimon Glass if (ret) 797de31213fSSimon Glass return ret; 7987f1a0753SHans de Goede } 799de31213fSSimon Glass 800de31213fSSimon Glass return 0; 801de31213fSSimon Glass } 802de31213fSSimon Glass 803de31213fSSimon Glass UCLASS_DRIVER(usb) = { 804de31213fSSimon Glass .id = UCLASS_USB, 805de31213fSSimon Glass .name = "usb", 806de31213fSSimon Glass .flags = DM_UC_FLAG_SEQ_ALIAS, 80791195485SSimon Glass .post_bind = dm_scan_fdt_dev, 808e253637bSHans de Goede .priv_auto_alloc_size = sizeof(struct usb_uclass_priv), 809de31213fSSimon Glass .per_child_auto_alloc_size = sizeof(struct usb_device), 810de31213fSSimon Glass .per_device_auto_alloc_size = sizeof(struct usb_bus_priv), 811de31213fSSimon Glass .child_post_bind = usb_child_post_bind, 812de31213fSSimon Glass .child_pre_probe = usb_child_pre_probe, 813de31213fSSimon Glass .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata), 814de31213fSSimon Glass }; 815449230f0SSimon Glass 816449230f0SSimon Glass UCLASS_DRIVER(usb_dev_generic) = { 817449230f0SSimon Glass .id = UCLASS_USB_DEV_GENERIC, 818449230f0SSimon Glass .name = "usb_dev_generic", 819449230f0SSimon Glass }; 820449230f0SSimon Glass 821449230f0SSimon Glass U_BOOT_DRIVER(usb_dev_generic_drv) = { 822449230f0SSimon Glass .id = UCLASS_USB_DEV_GENERIC, 823449230f0SSimon Glass .name = "usb_dev_generic_drv", 824449230f0SSimon Glass }; 825