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> 13de31213fSSimon Glass #include <usb.h> 14de31213fSSimon Glass #include <dm/device-internal.h> 15de31213fSSimon Glass #include <dm/lists.h> 16de31213fSSimon Glass #include <dm/root.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 131de31213fSSimon Glass int usb_stop(void) 132de31213fSSimon Glass { 133de31213fSSimon Glass struct udevice *bus; 134de31213fSSimon Glass struct uclass *uc; 135e253637bSHans de Goede struct usb_uclass_priv *uc_priv; 136de31213fSSimon Glass int err = 0, ret; 137de31213fSSimon Glass 138de31213fSSimon Glass /* De-activate any devices that have been activated */ 139de31213fSSimon Glass ret = uclass_get(UCLASS_USB, &uc); 140de31213fSSimon Glass if (ret) 141de31213fSSimon Glass return ret; 142e253637bSHans de Goede 143e253637bSHans de Goede uc_priv = uc->priv; 144e253637bSHans de Goede 145de31213fSSimon Glass uclass_foreach_dev(bus, uc) { 146de31213fSSimon Glass ret = device_remove(bus); 147de31213fSSimon Glass if (ret && !err) 148de31213fSSimon Glass err = ret; 1496cda3695SHans de Goede ret = device_unbind_children(bus); 1506cda3695SHans de Goede if (ret && !err) 1516cda3695SHans de Goede err = ret; 152de31213fSSimon Glass } 153de31213fSSimon Glass 154095fdef0SSimon Glass #ifdef CONFIG_SANDBOX 155095fdef0SSimon Glass struct udevice *dev; 156095fdef0SSimon Glass 157095fdef0SSimon Glass /* Reset all enulation devices */ 158095fdef0SSimon Glass ret = uclass_get(UCLASS_USB_EMUL, &uc); 159095fdef0SSimon Glass if (ret) 160095fdef0SSimon Glass return ret; 161095fdef0SSimon Glass 162095fdef0SSimon Glass uclass_foreach_dev(dev, uc) 163095fdef0SSimon Glass usb_emul_reset(dev); 164095fdef0SSimon Glass #endif 165de31213fSSimon Glass usb_stor_reset(); 166de31213fSSimon Glass usb_hub_reset(); 167e253637bSHans de Goede uc_priv->companion_device_count = 0; 168de31213fSSimon Glass usb_started = 0; 169de31213fSSimon Glass 170de31213fSSimon Glass return err; 171de31213fSSimon Glass } 172de31213fSSimon Glass 173a24a0e91SHans de Goede static void usb_scan_bus(struct udevice *bus, bool recurse) 174de31213fSSimon Glass { 175de31213fSSimon Glass struct usb_bus_priv *priv; 176de31213fSSimon Glass struct udevice *dev; 177de31213fSSimon Glass int ret; 178de31213fSSimon Glass 179de31213fSSimon Glass priv = dev_get_uclass_priv(bus); 180de31213fSSimon Glass 181de31213fSSimon Glass assert(recurse); /* TODO: Support non-recusive */ 182de31213fSSimon Glass 183a24a0e91SHans de Goede printf("scanning bus %d for devices... ", bus->seq); 184a24a0e91SHans de Goede debug("\n"); 185de31213fSSimon Glass ret = usb_scan_device(bus, 0, USB_SPEED_FULL, &dev); 186de31213fSSimon Glass if (ret) 187a24a0e91SHans de Goede printf("failed, error %d\n", ret); 188a24a0e91SHans de Goede else if (priv->next_addr == 0) 189a24a0e91SHans de Goede printf("No USB Device found\n"); 190a24a0e91SHans de Goede else 191a24a0e91SHans de Goede printf("%d USB Device(s) found\n", priv->next_addr); 192de31213fSSimon Glass } 193de31213fSSimon Glass 194de31213fSSimon Glass int usb_init(void) 195de31213fSSimon Glass { 196de31213fSSimon Glass int controllers_initialized = 0; 197e253637bSHans de Goede struct usb_uclass_priv *uc_priv; 198b6de4d10SHans de Goede struct usb_bus_priv *priv; 199de31213fSSimon Glass struct udevice *bus; 200de31213fSSimon Glass struct uclass *uc; 201de31213fSSimon Glass int count = 0; 202de31213fSSimon Glass int ret; 203de31213fSSimon Glass 204de31213fSSimon Glass asynch_allowed = 1; 205de31213fSSimon Glass usb_hub_reset(); 206de31213fSSimon Glass 207de31213fSSimon Glass ret = uclass_get(UCLASS_USB, &uc); 208de31213fSSimon Glass if (ret) 209de31213fSSimon Glass return ret; 210de31213fSSimon Glass 211e253637bSHans de Goede uc_priv = uc->priv; 212e253637bSHans de Goede 213de31213fSSimon Glass uclass_foreach_dev(bus, uc) { 214de31213fSSimon Glass /* init low_level USB */ 215134692afSHans de Goede printf("USB%d: ", count); 216de31213fSSimon Glass count++; 217de31213fSSimon Glass ret = device_probe(bus); 218de31213fSSimon Glass if (ret == -ENODEV) { /* No such device. */ 219de31213fSSimon Glass puts("Port not available.\n"); 220de31213fSSimon Glass controllers_initialized++; 221de31213fSSimon Glass continue; 222de31213fSSimon Glass } 223de31213fSSimon Glass 224de31213fSSimon Glass if (ret) { /* Other error. */ 225de31213fSSimon Glass printf("probe failed, error %d\n", ret); 226de31213fSSimon Glass continue; 227de31213fSSimon Glass } 228de31213fSSimon Glass controllers_initialized++; 229de31213fSSimon Glass usb_started = true; 230de31213fSSimon Glass } 231de31213fSSimon Glass 232b6de4d10SHans de Goede /* 233b6de4d10SHans de Goede * lowlevel init done, now scan the bus for devices i.e. search HUBs 234b6de4d10SHans de Goede * and configure them, first scan primary controllers. 235b6de4d10SHans de Goede */ 236b6de4d10SHans de Goede uclass_foreach_dev(bus, uc) { 237b6de4d10SHans de Goede if (!device_active(bus)) 238b6de4d10SHans de Goede continue; 239b6de4d10SHans de Goede 240b6de4d10SHans de Goede priv = dev_get_uclass_priv(bus); 241b6de4d10SHans de Goede if (!priv->companion) 242b6de4d10SHans de Goede usb_scan_bus(bus, true); 243b6de4d10SHans de Goede } 244b6de4d10SHans de Goede 245b6de4d10SHans de Goede /* 246b6de4d10SHans de Goede * Now that the primary controllers have been scanned and have handed 247b6de4d10SHans de Goede * over any devices they do not understand to their companions, scan 248e253637bSHans de Goede * the companions if necessary. 249b6de4d10SHans de Goede */ 250e253637bSHans de Goede if (uc_priv->companion_device_count) { 251b6de4d10SHans de Goede uclass_foreach_dev(bus, uc) { 252b6de4d10SHans de Goede if (!device_active(bus)) 253b6de4d10SHans de Goede continue; 254b6de4d10SHans de Goede 255b6de4d10SHans de Goede priv = dev_get_uclass_priv(bus); 256b6de4d10SHans de Goede if (priv->companion) 257b6de4d10SHans de Goede usb_scan_bus(bus, true); 258b6de4d10SHans de Goede } 259e253637bSHans de Goede } 260b6de4d10SHans de Goede 261de31213fSSimon Glass debug("scan end\n"); 262de31213fSSimon Glass /* if we were not able to find at least one working bus, bail out */ 263de31213fSSimon Glass if (!count) 264de31213fSSimon Glass printf("No controllers found\n"); 265de31213fSSimon Glass else if (controllers_initialized == 0) 266de31213fSSimon Glass printf("USB error: all controllers failed lowlevel init\n"); 267de31213fSSimon Glass 268de31213fSSimon Glass return usb_started ? 0 : -1; 269de31213fSSimon Glass } 270de31213fSSimon Glass 2718802f563SHans de Goede int usb_reset_root_port(struct usb_device *udev) 272de31213fSSimon Glass { 273de31213fSSimon Glass return -ENOSYS; 274de31213fSSimon Glass } 275de31213fSSimon Glass 276de31213fSSimon Glass static struct usb_device *find_child_devnum(struct udevice *parent, int devnum) 277de31213fSSimon Glass { 278de31213fSSimon Glass struct usb_device *udev; 279de31213fSSimon Glass struct udevice *dev; 280de31213fSSimon Glass 281de31213fSSimon Glass if (!device_active(parent)) 282de31213fSSimon Glass return NULL; 283de31213fSSimon Glass udev = dev_get_parentdata(parent); 284de31213fSSimon Glass if (udev->devnum == devnum) 285de31213fSSimon Glass return udev; 286de31213fSSimon Glass 287de31213fSSimon Glass for (device_find_first_child(parent, &dev); 288de31213fSSimon Glass dev; 289de31213fSSimon Glass device_find_next_child(&dev)) { 290de31213fSSimon Glass udev = find_child_devnum(dev, devnum); 291de31213fSSimon Glass if (udev) 292de31213fSSimon Glass return udev; 293de31213fSSimon Glass } 294de31213fSSimon Glass 295de31213fSSimon Glass return NULL; 296de31213fSSimon Glass } 297de31213fSSimon Glass 298de31213fSSimon Glass struct usb_device *usb_get_dev_index(struct udevice *bus, int index) 299de31213fSSimon Glass { 300de31213fSSimon Glass struct udevice *hub; 301de31213fSSimon Glass int devnum = index + 1; /* Addresses are allocated from 1 on USB */ 302de31213fSSimon Glass 303de31213fSSimon Glass device_find_first_child(bus, &hub); 304de31213fSSimon Glass if (device_get_uclass_id(hub) == UCLASS_USB_HUB) 305de31213fSSimon Glass return find_child_devnum(hub, devnum); 306de31213fSSimon Glass 307de31213fSSimon Glass return NULL; 308de31213fSSimon Glass } 309de31213fSSimon Glass 310de31213fSSimon Glass int usb_post_bind(struct udevice *dev) 311de31213fSSimon Glass { 312de31213fSSimon Glass /* Scan the bus for devices */ 313de31213fSSimon Glass return dm_scan_fdt_node(dev, gd->fdt_blob, dev->of_offset, false); 314de31213fSSimon Glass } 315de31213fSSimon Glass 316fbeceb26SSimon Glass int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp) 317fbeceb26SSimon Glass { 318fbeceb26SSimon Glass struct usb_platdata *plat; 319fbeceb26SSimon Glass struct udevice *dev; 320fbeceb26SSimon Glass int ret; 321fbeceb26SSimon Glass 322fbeceb26SSimon Glass /* Find the old device and remove it */ 323fbeceb26SSimon Glass ret = uclass_find_device_by_seq(UCLASS_USB, 0, true, &dev); 324fbeceb26SSimon Glass if (ret) 325fbeceb26SSimon Glass return ret; 326fbeceb26SSimon Glass ret = device_remove(dev); 327fbeceb26SSimon Glass if (ret) 328fbeceb26SSimon Glass return ret; 329fbeceb26SSimon Glass 330fbeceb26SSimon Glass plat = dev_get_platdata(dev); 331fbeceb26SSimon Glass plat->init_type = USB_INIT_DEVICE; 332fbeceb26SSimon Glass ret = device_probe(dev); 333fbeceb26SSimon Glass if (ret) 334fbeceb26SSimon Glass return ret; 335fbeceb26SSimon Glass *ctlrp = dev_get_priv(dev); 336fbeceb26SSimon Glass 337fbeceb26SSimon Glass return 0; 338fbeceb26SSimon Glass } 339fbeceb26SSimon Glass 3400566e240SSimon Glass /* returns 0 if no match, 1 if match */ 3410566e240SSimon Glass int usb_match_device(const struct usb_device_descriptor *desc, 3420566e240SSimon Glass const struct usb_device_id *id) 3430566e240SSimon Glass { 3440566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) && 3450566e240SSimon Glass id->idVendor != le16_to_cpu(desc->idVendor)) 3460566e240SSimon Glass return 0; 3470566e240SSimon Glass 3480566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) && 3490566e240SSimon Glass id->idProduct != le16_to_cpu(desc->idProduct)) 3500566e240SSimon Glass return 0; 3510566e240SSimon Glass 3520566e240SSimon Glass /* No need to test id->bcdDevice_lo != 0, since 0 is never 3530566e240SSimon Glass greater than any unsigned number. */ 3540566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) && 3550566e240SSimon Glass (id->bcdDevice_lo > le16_to_cpu(desc->bcdDevice))) 3560566e240SSimon Glass return 0; 3570566e240SSimon Glass 3580566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) && 3590566e240SSimon Glass (id->bcdDevice_hi < le16_to_cpu(desc->bcdDevice))) 3600566e240SSimon Glass return 0; 3610566e240SSimon Glass 3620566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) && 3630566e240SSimon Glass (id->bDeviceClass != desc->bDeviceClass)) 3640566e240SSimon Glass return 0; 3650566e240SSimon Glass 3660566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) && 3670566e240SSimon Glass (id->bDeviceSubClass != desc->bDeviceSubClass)) 3680566e240SSimon Glass return 0; 3690566e240SSimon Glass 3700566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) && 3710566e240SSimon Glass (id->bDeviceProtocol != desc->bDeviceProtocol)) 3720566e240SSimon Glass return 0; 3730566e240SSimon Glass 3740566e240SSimon Glass return 1; 3750566e240SSimon Glass } 3760566e240SSimon Glass 3770566e240SSimon Glass /* returns 0 if no match, 1 if match */ 3780566e240SSimon Glass int usb_match_one_id_intf(const struct usb_device_descriptor *desc, 3790566e240SSimon Glass const struct usb_interface_descriptor *int_desc, 3800566e240SSimon Glass const struct usb_device_id *id) 3810566e240SSimon Glass { 3820566e240SSimon Glass /* The interface class, subclass, protocol and number should never be 3830566e240SSimon Glass * checked for a match if the device class is Vendor Specific, 3840566e240SSimon Glass * unless the match record specifies the Vendor ID. */ 3850566e240SSimon Glass if (desc->bDeviceClass == USB_CLASS_VENDOR_SPEC && 3860566e240SSimon Glass !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) && 3870566e240SSimon Glass (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS | 3880566e240SSimon Glass USB_DEVICE_ID_MATCH_INT_SUBCLASS | 3890566e240SSimon Glass USB_DEVICE_ID_MATCH_INT_PROTOCOL | 3900566e240SSimon Glass USB_DEVICE_ID_MATCH_INT_NUMBER))) 3910566e240SSimon Glass return 0; 3920566e240SSimon Glass 3930566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) && 3940566e240SSimon Glass (id->bInterfaceClass != int_desc->bInterfaceClass)) 3950566e240SSimon Glass return 0; 3960566e240SSimon Glass 3970566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) && 3980566e240SSimon Glass (id->bInterfaceSubClass != int_desc->bInterfaceSubClass)) 3990566e240SSimon Glass return 0; 4000566e240SSimon Glass 4010566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) && 4020566e240SSimon Glass (id->bInterfaceProtocol != int_desc->bInterfaceProtocol)) 4030566e240SSimon Glass return 0; 4040566e240SSimon Glass 4050566e240SSimon Glass if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_NUMBER) && 4060566e240SSimon Glass (id->bInterfaceNumber != int_desc->bInterfaceNumber)) 4070566e240SSimon Glass return 0; 4080566e240SSimon Glass 4090566e240SSimon Glass return 1; 4100566e240SSimon Glass } 4110566e240SSimon Glass 4120566e240SSimon Glass /* returns 0 if no match, 1 if match */ 4130566e240SSimon Glass int usb_match_one_id(struct usb_device_descriptor *desc, 4140566e240SSimon Glass struct usb_interface_descriptor *int_desc, 4150566e240SSimon Glass const struct usb_device_id *id) 4160566e240SSimon Glass { 4170566e240SSimon Glass if (!usb_match_device(desc, id)) 4180566e240SSimon Glass return 0; 4190566e240SSimon Glass 4200566e240SSimon Glass return usb_match_one_id_intf(desc, int_desc, id); 4210566e240SSimon Glass } 4220566e240SSimon Glass 4230566e240SSimon Glass /** 4240566e240SSimon Glass * usb_find_and_bind_driver() - Find and bind the right USB driver 4250566e240SSimon Glass * 4260566e240SSimon Glass * This only looks at certain fields in the descriptor. 4270566e240SSimon Glass */ 4280566e240SSimon Glass static int usb_find_and_bind_driver(struct udevice *parent, 4290566e240SSimon Glass struct usb_device_descriptor *desc, 4300566e240SSimon Glass struct usb_interface_descriptor *iface, 4310566e240SSimon Glass int bus_seq, int devnum, 4320566e240SSimon Glass struct udevice **devp) 4330566e240SSimon Glass { 4340566e240SSimon Glass struct usb_driver_entry *start, *entry; 4350566e240SSimon Glass int n_ents; 4360566e240SSimon Glass int ret; 4370566e240SSimon Glass char name[30], *str; 4380566e240SSimon Glass 4390566e240SSimon Glass *devp = NULL; 4400566e240SSimon Glass debug("%s: Searching for driver\n", __func__); 4410566e240SSimon Glass start = ll_entry_start(struct usb_driver_entry, usb_driver_entry); 4420566e240SSimon Glass n_ents = ll_entry_count(struct usb_driver_entry, usb_driver_entry); 4430566e240SSimon Glass for (entry = start; entry != start + n_ents; entry++) { 4440566e240SSimon Glass const struct usb_device_id *id; 4450566e240SSimon Glass struct udevice *dev; 4460566e240SSimon Glass const struct driver *drv; 4470566e240SSimon Glass struct usb_dev_platdata *plat; 4480566e240SSimon Glass 4490566e240SSimon Glass for (id = entry->match; id->match_flags; id++) { 4500566e240SSimon Glass if (!usb_match_one_id(desc, iface, id)) 4510566e240SSimon Glass continue; 4520566e240SSimon Glass 4530566e240SSimon Glass drv = entry->driver; 4540566e240SSimon Glass /* 4550566e240SSimon Glass * We could pass the descriptor to the driver as 4560566e240SSimon Glass * platdata (instead of NULL) and allow its bind() 4570566e240SSimon Glass * method to return -ENOENT if it doesn't support this 4580566e240SSimon Glass * device. That way we could continue the search to 4590566e240SSimon Glass * find another driver. For now this doesn't seem 4600566e240SSimon Glass * necesssary, so just bind the first match. 4610566e240SSimon Glass */ 4620566e240SSimon Glass ret = device_bind(parent, drv, drv->name, NULL, -1, 4630566e240SSimon Glass &dev); 4640566e240SSimon Glass if (ret) 4650566e240SSimon Glass goto error; 4660566e240SSimon Glass debug("%s: Match found: %s\n", __func__, drv->name); 4670566e240SSimon Glass dev->driver_data = id->driver_info; 4680566e240SSimon Glass plat = dev_get_parent_platdata(dev); 4690566e240SSimon Glass plat->id = *id; 4700566e240SSimon Glass *devp = dev; 4710566e240SSimon Glass return 0; 4720566e240SSimon Glass } 4730566e240SSimon Glass } 4740566e240SSimon Glass 475449230f0SSimon Glass /* Bind a generic driver so that the device can be used */ 476449230f0SSimon Glass snprintf(name, sizeof(name), "generic_bus_%x_dev_%x", bus_seq, devnum); 477449230f0SSimon Glass str = strdup(name); 478449230f0SSimon Glass if (!str) 479449230f0SSimon Glass return -ENOMEM; 480449230f0SSimon Glass ret = device_bind_driver(parent, "usb_dev_generic_drv", str, devp); 481449230f0SSimon Glass 4820566e240SSimon Glass error: 4830566e240SSimon Glass debug("%s: No match found: %d\n", __func__, ret); 4840566e240SSimon Glass return ret; 4850566e240SSimon Glass } 4860566e240SSimon Glass 4870566e240SSimon Glass /** 488*9b510df7SHans de Goede * usb_find_emul_child() - Find an existing device for emulated devices 4890566e240SSimon Glass */ 490*9b510df7SHans de Goede static int usb_find_emul_child(struct udevice *parent, 4910566e240SSimon Glass struct usb_device_descriptor *desc, 4920566e240SSimon Glass struct usb_interface_descriptor *iface, 4930566e240SSimon Glass struct udevice **devp) 4940566e240SSimon Glass { 495*9b510df7SHans de Goede #ifdef CONFIG_SANDBOX 4960566e240SSimon Glass struct udevice *dev; 4970566e240SSimon Glass 4980566e240SSimon Glass *devp = NULL; 4990566e240SSimon Glass for (device_find_first_child(parent, &dev); 5000566e240SSimon Glass dev; 5010566e240SSimon Glass device_find_next_child(&dev)) { 5020566e240SSimon Glass struct usb_dev_platdata *plat = dev_get_parent_platdata(dev); 5030566e240SSimon Glass 5040566e240SSimon Glass /* If this device is already in use, skip it */ 5050566e240SSimon Glass if (device_active(dev)) 5060566e240SSimon Glass continue; 5070566e240SSimon Glass debug(" %s: name='%s', plat=%d, desc=%d\n", __func__, 5080566e240SSimon Glass dev->name, plat->id.bDeviceClass, desc->bDeviceClass); 5090566e240SSimon Glass if (usb_match_one_id(desc, iface, &plat->id)) { 5100566e240SSimon Glass *devp = dev; 5110566e240SSimon Glass return 0; 5120566e240SSimon Glass } 5130566e240SSimon Glass } 514*9b510df7SHans de Goede #endif 5150566e240SSimon Glass return -ENOENT; 5160566e240SSimon Glass } 5170566e240SSimon Glass 518de31213fSSimon Glass int usb_scan_device(struct udevice *parent, int port, 519de31213fSSimon Glass enum usb_device_speed speed, struct udevice **devp) 520de31213fSSimon Glass { 521de31213fSSimon Glass struct udevice *dev; 522de31213fSSimon Glass bool created = false; 523de31213fSSimon Glass struct usb_dev_platdata *plat; 524de31213fSSimon Glass struct usb_bus_priv *priv; 525de31213fSSimon Glass struct usb_device *parent_udev; 526de31213fSSimon Glass int ret; 527de31213fSSimon Glass ALLOC_CACHE_ALIGN_BUFFER(struct usb_device, udev, 1); 528de31213fSSimon Glass struct usb_interface_descriptor *iface = &udev->config.if_desc[0].desc; 529de31213fSSimon Glass 530de31213fSSimon Glass *devp = NULL; 531de31213fSSimon Glass memset(udev, '\0', sizeof(*udev)); 532f78a5c07SHans de Goede udev->controller_dev = usb_get_bus(parent); 533de31213fSSimon Glass priv = dev_get_uclass_priv(udev->controller_dev); 534de31213fSSimon Glass 535de31213fSSimon Glass /* 536de31213fSSimon Glass * Somewhat nasty, this. We create a local device and use the normal 537de31213fSSimon Glass * USB stack to read its descriptor. Then we know what type of device 538de31213fSSimon Glass * to create for real. 539de31213fSSimon Glass * 540de31213fSSimon Glass * udev->dev is set to the parent, since we don't have a real device 541de31213fSSimon Glass * yet. The USB stack should not access udev.dev anyway, except perhaps 542de31213fSSimon Glass * to find the controller, and the controller will either be @parent, 543de31213fSSimon Glass * or some parent of @parent. 544de31213fSSimon Glass * 545de31213fSSimon Glass * Another option might be to create the device as a generic USB 546de31213fSSimon Glass * device, then morph it into the correct one when we know what it 547de31213fSSimon Glass * should be. This means that a generic USB device would morph into 548de31213fSSimon Glass * a network controller, or a USB flash stick, for example. However, 549de31213fSSimon Glass * we don't support such morphing and it isn't clear that it would 550de31213fSSimon Glass * be easy to do. 551de31213fSSimon Glass * 552de31213fSSimon Glass * Yet another option is to split out the USB stack parts of udev 553de31213fSSimon Glass * into something like a 'struct urb' (as Linux does) which can exist 554de31213fSSimon Glass * independently of any device. This feels cleaner, but calls for quite 555de31213fSSimon Glass * a big change to the USB stack. 556de31213fSSimon Glass * 557de31213fSSimon Glass * For now, the approach is to set up an empty udev, read its 558de31213fSSimon Glass * descriptor and assign it an address, then bind a real device and 559de31213fSSimon Glass * stash the resulting information into the device's parent 560de31213fSSimon Glass * platform data. Then when we probe it, usb_child_pre_probe() is called 561de31213fSSimon Glass * and it will pull the information out of the stash. 562de31213fSSimon Glass */ 563de31213fSSimon Glass udev->dev = parent; 564de31213fSSimon Glass udev->speed = speed; 565de31213fSSimon Glass udev->devnum = priv->next_addr + 1; 566de31213fSSimon Glass udev->portnr = port; 567de31213fSSimon Glass debug("Calling usb_setup_device(), portnr=%d\n", udev->portnr); 568de31213fSSimon Glass parent_udev = device_get_uclass_id(parent) == UCLASS_USB_HUB ? 569de31213fSSimon Glass dev_get_parentdata(parent) : NULL; 5709eb72dd1SHans de Goede ret = usb_setup_device(udev, priv->desc_before_addr, parent_udev); 571de31213fSSimon Glass debug("read_descriptor for '%s': ret=%d\n", parent->name, ret); 572de31213fSSimon Glass if (ret) 573de31213fSSimon Glass return ret; 574*9b510df7SHans de Goede ret = usb_find_emul_child(parent, &udev->descriptor, iface, &dev); 575*9b510df7SHans de Goede debug("** usb_find_emul_child returns %d\n", ret); 5760566e240SSimon Glass if (ret) { 5770566e240SSimon Glass if (ret != -ENOENT) 5780566e240SSimon Glass return ret; 5790566e240SSimon Glass ret = usb_find_and_bind_driver(parent, &udev->descriptor, iface, 5800566e240SSimon Glass udev->controller_dev->seq, 5810566e240SSimon Glass udev->devnum, &dev); 5820566e240SSimon Glass if (ret) 5830566e240SSimon Glass return ret; 5840566e240SSimon Glass created = true; 5850566e240SSimon Glass } 5860566e240SSimon Glass plat = dev_get_parent_platdata(dev); 5870566e240SSimon Glass debug("%s: Probing '%s', plat=%p\n", __func__, dev->name, plat); 5880566e240SSimon Glass plat->devnum = udev->devnum; 5897f1a0753SHans de Goede plat->udev = udev; 5900566e240SSimon Glass priv->next_addr++; 5910566e240SSimon Glass ret = device_probe(dev); 5920566e240SSimon Glass if (ret) { 5930566e240SSimon Glass debug("%s: Device '%s' probe failed\n", __func__, dev->name); 5940566e240SSimon Glass priv->next_addr--; 5950566e240SSimon Glass if (created) 5960566e240SSimon Glass device_unbind(dev); 5970566e240SSimon Glass return ret; 5980566e240SSimon Glass } 5990566e240SSimon Glass *devp = dev; 600de31213fSSimon Glass 6010566e240SSimon Glass return 0; 602de31213fSSimon Glass } 603de31213fSSimon Glass 6040c5dd9aeSSimon Glass /* 6050c5dd9aeSSimon Glass * Detect if a USB device has been plugged or unplugged. 6060c5dd9aeSSimon Glass */ 6070c5dd9aeSSimon Glass int usb_detect_change(void) 6080c5dd9aeSSimon Glass { 6090c5dd9aeSSimon Glass struct udevice *hub; 6100c5dd9aeSSimon Glass struct uclass *uc; 6110c5dd9aeSSimon Glass int change = 0; 6120c5dd9aeSSimon Glass int ret; 6130c5dd9aeSSimon Glass 6140c5dd9aeSSimon Glass ret = uclass_get(UCLASS_USB_HUB, &uc); 6150c5dd9aeSSimon Glass if (ret) 6160c5dd9aeSSimon Glass return ret; 6170c5dd9aeSSimon Glass 6180c5dd9aeSSimon Glass uclass_foreach_dev(hub, uc) { 6190c5dd9aeSSimon Glass struct usb_device *udev; 6200c5dd9aeSSimon Glass struct udevice *dev; 6210c5dd9aeSSimon Glass 6220c5dd9aeSSimon Glass if (!device_active(hub)) 6230c5dd9aeSSimon Glass continue; 6240c5dd9aeSSimon Glass for (device_find_first_child(hub, &dev); 6250c5dd9aeSSimon Glass dev; 6260c5dd9aeSSimon Glass device_find_next_child(&dev)) { 6270c5dd9aeSSimon Glass struct usb_port_status status; 6280c5dd9aeSSimon Glass 6290c5dd9aeSSimon Glass if (!device_active(dev)) 6300c5dd9aeSSimon Glass continue; 6310c5dd9aeSSimon Glass 6320c5dd9aeSSimon Glass udev = dev_get_parentdata(dev); 6330c5dd9aeSSimon Glass if (usb_get_port_status(udev, udev->portnr, &status) 6340c5dd9aeSSimon Glass < 0) 6350c5dd9aeSSimon Glass /* USB request failed */ 6360c5dd9aeSSimon Glass continue; 6370c5dd9aeSSimon Glass 6380c5dd9aeSSimon Glass if (le16_to_cpu(status.wPortChange) & 6390c5dd9aeSSimon Glass USB_PORT_STAT_C_CONNECTION) 6400c5dd9aeSSimon Glass change++; 6410c5dd9aeSSimon Glass } 6420c5dd9aeSSimon Glass } 6430c5dd9aeSSimon Glass 6440c5dd9aeSSimon Glass return change; 6450c5dd9aeSSimon Glass } 6460c5dd9aeSSimon Glass 647de31213fSSimon Glass int usb_child_post_bind(struct udevice *dev) 648de31213fSSimon Glass { 649de31213fSSimon Glass struct usb_dev_platdata *plat = dev_get_parent_platdata(dev); 650de31213fSSimon Glass const void *blob = gd->fdt_blob; 651de31213fSSimon Glass int val; 652de31213fSSimon Glass 653de31213fSSimon Glass if (dev->of_offset == -1) 654de31213fSSimon Glass return 0; 655de31213fSSimon Glass 656de31213fSSimon Glass /* We only support matching a few things */ 657de31213fSSimon Glass val = fdtdec_get_int(blob, dev->of_offset, "usb,device-class", -1); 658de31213fSSimon Glass if (val != -1) { 659de31213fSSimon Glass plat->id.match_flags |= USB_DEVICE_ID_MATCH_DEV_CLASS; 660de31213fSSimon Glass plat->id.bDeviceClass = val; 661de31213fSSimon Glass } 662de31213fSSimon Glass val = fdtdec_get_int(blob, dev->of_offset, "usb,interface-class", -1); 663de31213fSSimon Glass if (val != -1) { 664de31213fSSimon Glass plat->id.match_flags |= USB_DEVICE_ID_MATCH_INT_CLASS; 665de31213fSSimon Glass plat->id.bInterfaceClass = val; 666de31213fSSimon Glass } 667de31213fSSimon Glass 668de31213fSSimon Glass return 0; 669de31213fSSimon Glass } 670de31213fSSimon Glass 671f78a5c07SHans de Goede struct udevice *usb_get_bus(struct udevice *dev) 672de31213fSSimon Glass { 673de31213fSSimon Glass struct udevice *bus; 674de31213fSSimon Glass 675de31213fSSimon Glass for (bus = dev; bus && device_get_uclass_id(bus) != UCLASS_USB; ) 676de31213fSSimon Glass bus = bus->parent; 677de31213fSSimon Glass if (!bus) { 678de31213fSSimon Glass /* By design this cannot happen */ 679de31213fSSimon Glass assert(bus); 680de31213fSSimon Glass debug("USB HUB '%s' does not have a controller\n", dev->name); 681de31213fSSimon Glass } 682de31213fSSimon Glass 683f78a5c07SHans de Goede return bus; 684de31213fSSimon Glass } 685de31213fSSimon Glass 686de31213fSSimon Glass int usb_child_pre_probe(struct udevice *dev) 687de31213fSSimon Glass { 688de31213fSSimon Glass struct usb_device *udev = dev_get_parentdata(dev); 689de31213fSSimon Glass struct usb_dev_platdata *plat = dev_get_parent_platdata(dev); 690de31213fSSimon Glass int ret; 691de31213fSSimon Glass 6927f1a0753SHans de Goede if (plat->udev) { 6937f1a0753SHans de Goede /* 6947f1a0753SHans de Goede * Copy over all the values set in the on stack struct 6957f1a0753SHans de Goede * usb_device in usb_scan_device() to our final struct 6967f1a0753SHans de Goede * usb_device for this dev. 6977f1a0753SHans de Goede */ 6987f1a0753SHans de Goede *udev = *(plat->udev); 6997f1a0753SHans de Goede /* And clear plat->udev as it will not be valid for long */ 7007f1a0753SHans de Goede plat->udev = NULL; 701de31213fSSimon Glass udev->dev = dev; 7027f1a0753SHans de Goede } else { 7037f1a0753SHans de Goede /* 7047f1a0753SHans de Goede * This happens with devices which are explicitly bound 7057f1a0753SHans de Goede * instead of being discovered through usb_scan_device() 7067f1a0753SHans de Goede * such as sandbox emul devices. 7077f1a0753SHans de Goede */ 7087f1a0753SHans de Goede udev->dev = dev; 7097f1a0753SHans de Goede udev->controller_dev = usb_get_bus(dev); 710de31213fSSimon Glass udev->devnum = plat->devnum; 711de31213fSSimon Glass 7127f1a0753SHans de Goede /* 7137f1a0753SHans de Goede * udev did not go through usb_scan_device(), so we need to 7147f1a0753SHans de Goede * select the config and read the config descriptors. 7157f1a0753SHans de Goede */ 716de31213fSSimon Glass ret = usb_select_config(udev); 717de31213fSSimon Glass if (ret) 718de31213fSSimon Glass return ret; 7197f1a0753SHans de Goede } 720de31213fSSimon Glass 721de31213fSSimon Glass return 0; 722de31213fSSimon Glass } 723de31213fSSimon Glass 724de31213fSSimon Glass UCLASS_DRIVER(usb) = { 725de31213fSSimon Glass .id = UCLASS_USB, 726de31213fSSimon Glass .name = "usb", 727de31213fSSimon Glass .flags = DM_UC_FLAG_SEQ_ALIAS, 728de31213fSSimon Glass .post_bind = usb_post_bind, 729e253637bSHans de Goede .priv_auto_alloc_size = sizeof(struct usb_uclass_priv), 730de31213fSSimon Glass .per_child_auto_alloc_size = sizeof(struct usb_device), 731de31213fSSimon Glass .per_device_auto_alloc_size = sizeof(struct usb_bus_priv), 732de31213fSSimon Glass .child_post_bind = usb_child_post_bind, 733de31213fSSimon Glass .child_pre_probe = usb_child_pre_probe, 734de31213fSSimon Glass .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata), 735de31213fSSimon Glass }; 736449230f0SSimon Glass 737449230f0SSimon Glass UCLASS_DRIVER(usb_dev_generic) = { 738449230f0SSimon Glass .id = UCLASS_USB_DEV_GENERIC, 739449230f0SSimon Glass .name = "usb_dev_generic", 740449230f0SSimon Glass }; 741449230f0SSimon Glass 742449230f0SSimon Glass U_BOOT_DRIVER(usb_dev_generic_drv) = { 743449230f0SSimon Glass .id = UCLASS_USB_DEV_GENERIC, 744449230f0SSimon Glass .name = "usb_dev_generic_drv", 745449230f0SSimon Glass }; 746