drivers/usb/core/generic.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * drivers/usb/generic.c - generic driver for USB devices (not interfaces)
   4  *
   5  * (C) Copyright 2005 Greg Kroah-Hartman <[email protected]>
   6  *
   7  * based on drivers/usb/usb.c which had the following copyrights:
   8  *      (C) Copyright Linus Torvalds 1999
   9  *      (C) Copyright Johannes Erdfelt 1999-2001
  10  *      (C) Copyright Andreas Gal 1999
  11  *      (C) Copyright Gregory P. Smith 1999
  12  *      (C) Copyright Deti Fliegl 1999 (new USB architecture)
  13  *      (C) Copyright Randy Dunlap 2000
  14  *      (C) Copyright David Brownell 2000-2004
  15  *      (C) Copyright Yggdrasil Computing, Inc. 2000
  16  *              (usb_device_id matching changes by Adam J. Richter)
  17  *      (C) Copyright Greg Kroah-Hartman 2002-2003
  18  *
  19  * Released under the GPLv2 only.
  20  */
  21
  22 #include <linux/usb.h>
  23 #include <linux/usb/hcd.h>
  24 #include <uapi/linux/usb/audio.h>
  25 #include "usb.h"
  26
  27 static inline const char *plural(int n)
  28 {
  29         return (n == 1 ? "" : "s");
  30 }
  31
  32 static int is_rndis(struct usb_interface_descriptor *desc)
  33 {
  34         return desc->bInterfaceClass == USB_CLASS_COMM
  35                 && desc->bInterfaceSubClass == 2
  36                 && desc->bInterfaceProtocol == 0xff;
  37 }
  38
  39 static int is_activesync(struct usb_interface_descriptor *desc)
  40 {
  41         return desc->bInterfaceClass == USB_CLASS_MISC
  42                 && desc->bInterfaceSubClass == 1
  43                 && desc->bInterfaceProtocol == 1;
  44 }
  45
  46 static bool is_audio(struct usb_interface_descriptor *desc)
  47 {
  48         return desc->bInterfaceClass == USB_CLASS_AUDIO;
  49 }
  50
  51 static bool is_uac3_config(struct usb_interface_descriptor *desc)
  52 {
  53         return desc->bInterfaceProtocol == UAC_VERSION_3;
  54 }
  55
  56 int usb_choose_configuration(struct usb_device *udev)
  57 {
  58         int i;
  59         int num_configs;
  60         int insufficient_power = 0;
  61         struct usb_host_config *c, *best;
  62
  63         if (usb_device_is_owned(udev))
  64                 return 0;
  65
  66         best = NULL;
  67         c = udev->config;
  68         num_configs = udev->descriptor.bNumConfigurations;
  69         for (i = 0; i < num_configs; (i++, c++)) {
  70                 struct usb_interface_descriptor *desc = NULL;
  71
  72                 /* It's possible that a config has no interfaces! */
  73                 if (c->desc.bNumInterfaces > 0)
  74                         desc = &c->intf_cache[0]->altsetting->desc;
  75
  76                 /*
  77                  * HP's USB bus-powered keyboard has only one configuration
  78                  * and it claims to be self-powered; other devices may have
  79                  * similar errors in their descriptors.  If the next test
  80                  * were allowed to execute, such configurations would always
  81                  * be rejected and the devices would not work as expected.
  82                  * In the meantime, we run the risk of selecting a config
  83                  * that requires external power at a time when that power
  84                  * isn't available.  It seems to be the lesser of two evils.
  85                  *
  86                  * Bugzilla #6448 reports a device that appears to crash
  87                  * when it receives a GET_DEVICE_STATUS request!  We don't
  88                  * have any other way to tell whether a device is self-powered,
  89                  * but since we don't use that information anywhere but here,
  90                  * the call has been removed.
  91                  *
  92                  * Maybe the GET_DEVICE_STATUS call and the test below can
  93                  * be reinstated when device firmwares become more reliable.
  94                  * Don't hold your breath.
  95                  */
  96 #if 0
  97                 /* Rule out self-powered configs for a bus-powered device */
  98                 if (bus_powered && (c->desc.bmAttributes &
  99                                         USB_CONFIG_ATT_SELFPOWER))
 100                         continue;
 101 #endif
 102
 103                 /*
 104                  * The next test may not be as effective as it should be.
 105                  * Some hubs have errors in their descriptor, claiming
 106                  * to be self-powered when they are really bus-powered.
 107                  * We will overestimate the amount of current such hubs
 108                  * make available for each port.
 109                  *
 110                  * This is a fairly benign sort of failure.  It won't
 111                  * cause us to reject configurations that we should have
 112                  * accepted.
 113                  */
 114
 115                 /* Rule out configs that draw too much bus current */
 116                 if (usb_get_max_power(udev, c) > udev->bus_mA) {
 117                         insufficient_power++;
 118                         continue;
 119                 }
 120
 121                 /* When the first config's first interface is one of Microsoft's
 122                  * pet nonstandard Ethernet-over-USB protocols, ignore it unless
 123                  * this kernel has enabled the necessary host side driver.
 124                  * But: Don't ignore it if it's the only config.
 125                  */
 126                 if (i == 0 && num_configs > 1 && desc &&
 127                                 (is_rndis(desc) || is_activesync(desc))) {
 128 #if !defined(CONFIG_USB_NET_RNDIS_HOST) && !defined(CONFIG_USB_NET_RNDIS_HOST_MODULE)
 129                         continue;
 130 #else
 131                         best = c;
 132 #endif
 133                 }
 134
 135                 /*
 136                  * Select first configuration as default for audio so that
 137                  * devices that don't comply with UAC3 protocol are supported.
 138                  * But, still iterate through other configurations and
 139                  * select UAC3 compliant config if present.
 140                  */
 141                 if (i == 0 && num_configs > 1 && desc && is_audio(desc)) {
 142                         best = c;
 143                         continue;
 144                 }
 145
 146                 if (i > 0 && desc && is_audio(desc) && is_uac3_config(desc)) {
 147                         best = c;
 148                         break;
 149                 }
 150
 151                 /* From the remaining configs, choose the first one whose
 152                  * first interface is for a non-vendor-specific class.
 153                  * Reason: Linux is more likely to have a class driver
 154                  * than a vendor-specific driver. */
 155                 else if (udev->descriptor.bDeviceClass !=
 156                                                 USB_CLASS_VENDOR_SPEC &&
 157                                 (desc && desc->bInterfaceClass !=
 158                                                 USB_CLASS_VENDOR_SPEC)) {
 159                         best = c;
 160                         break;
 161                 }
 162
 163                 /* If all the remaining configs are vendor-specific,
 164                  * choose the first one. */
 165                 else if (!best)
 166                         best = c;
 167         }
 168
 169         if (insufficient_power > 0)
 170                 dev_info(&udev->dev, "rejected %d configuration%s "
 171                         "due to insufficient available bus power\n",
 172                         insufficient_power, plural(insufficient_power));
 173
 174         if (best) {
 175                 i = best->desc.bConfigurationValue;
 176                 dev_dbg(&udev->dev,
 177                         "configuration #%d chosen from %d choice%s\n",
 178                         i, num_configs, plural(num_configs));
 179         } else {
 180                 i = -1;
 181                 dev_warn(&udev->dev,
 182                         "no configuration chosen from %d choice%s\n",
 183                         num_configs, plural(num_configs));
 184         }
 185         return i;
 186 }
 187 EXPORT_SYMBOL_GPL(usb_choose_configuration);
 188
 189 static int generic_probe(struct usb_device *udev)
 190 {
 191         int err, c;
 192
 193         /* Choose and set the configuration.  This registers the interfaces
 194          * with the driver core and lets interface drivers bind to them.
 195          */
 196         if (udev->authorized == 0)
 197                 dev_err(&udev->dev, "Device is not authorized for usage\n");
 198         else {
 199                 c = usb_choose_configuration(udev);
 200                 if (c >= 0) {
 201                         err = usb_set_configuration(udev, c);
 202                         if (err && err != -ENODEV) {
 203                                 dev_err(&udev->dev, "can't set config #%d, error %d\n",
 204                                         c, err);
 205                                 /* This need not be fatal.  The user can try to
 206                                  * set other configurations. */
 207                         }
 208                 }
 209         }
 210         /* USB device state == configured ... usable */
 211         usb_notify_add_device(udev);
 212
 213         return 0;
 214 }
 215
 216 static void generic_disconnect(struct usb_device *udev)
 217 {
 218         usb_notify_remove_device(udev);
 219
 220         /* if this is only an unbind, not a physical disconnect, then
 221          * unconfigure the device */
 222         if (udev->actconfig)
 223                 usb_set_configuration(udev, -1);
 224 }
 225
 226 #ifdef  CONFIG_PM
 227
 228 static int generic_suspend(struct usb_device *udev, pm_message_t msg)
 229 {
 230         int rc;
 231
 232         /* Normal USB devices suspend through their upstream port.
 233          * Root hubs don't have upstream ports to suspend,
 234          * so we have to shut down their downstream HC-to-USB
 235          * interfaces manually by doing a bus (or "global") suspend.
 236          */
 237         if (!udev->parent)
 238                 rc = hcd_bus_suspend(udev, msg);
 239
 240         /*
 241          * Non-root USB2 devices don't need to do anything for FREEZE
 242          * or PRETHAW. USB3 devices don't support global suspend and
 243          * needs to be selectively suspended.
 244          */
 245         else if ((msg.event == PM_EVENT_FREEZE || msg.event == PM_EVENT_PRETHAW)
 246                  && (udev->speed < USB_SPEED_SUPER))
 247                 rc = 0;
 248         else
 249                 rc = usb_port_suspend(udev, msg);
 250
 251         return rc;
 252 }
 253
 254 static int generic_resume(struct usb_device *udev, pm_message_t msg)
 255 {
 256         int rc;
 257
 258         /* Normal USB devices resume/reset through their upstream port.
 259          * Root hubs don't have upstream ports to resume or reset,
 260          * so we have to start up their downstream HC-to-USB
 261          * interfaces manually by doing a bus (or "global") resume.
 262          */
 263         if (!udev->parent)
 264                 rc = hcd_bus_resume(udev, msg);
 265         else
 266                 rc = usb_port_resume(udev, msg);
 267         return rc;
 268 }
 269
 270 #endif  /* CONFIG_PM */
 271
 272 struct usb_device_driver usb_generic_driver = {
 273         .name = "usb",
 274         .probe = generic_probe,
 275         .disconnect = generic_disconnect,
 276 #ifdef  CONFIG_PM
 277         .suspend = generic_suspend,
 278         .resume = generic_resume,
 279 #endif
 280         .supports_autosuspend = 1,
 281 };