drivers/usb/core/sysfs.c

   1 /*
   2  * drivers/usb/core/sysfs.c
   3  *
   4  * (C) Copyright 2002 David Brownell
   5  * (C) Copyright 2002,2004 Greg Kroah-Hartman
   6  * (C) Copyright 2002,2004 IBM Corp.
   7  *
   8  * All of the sysfs file attributes for usb devices and interfaces.
   9  *
  10  */
  11
  12
  13 #include <linux/kernel.h>
  14 #include <linux/string.h>
  15 #include <linux/usb.h>
  16 #include <linux/usb/quirks.h>
  17 #include "usb.h"
  18
  19 /* Active configuration fields */
  20 #define usb_actconfig_show(field, format_string)                        \
  21 static ssize_t field##_show(struct device *dev,                         \
  22                             struct device_attribute *attr, char *buf)   \
  23 {                                                                       \
  24         struct usb_device *udev;                                        \
  25         struct usb_host_config *actconfig;                              \
  26         ssize_t rc;                                                     \
  27                                                                         \
  28         udev = to_usb_device(dev);                                      \
  29         rc = usb_lock_device_interruptible(udev);                       \
  30         if (rc < 0)                                                     \
  31                 return -EINTR;                                          \
  32         actconfig = udev->actconfig;                                    \
  33         if (actconfig)                                                  \
  34                 rc = sprintf(buf, format_string,                        \
  35                                 actconfig->desc.field);                 \
  36         usb_unlock_device(udev);                                        \
  37         return rc;                                                      \
  38 }                                                                       \
  39
  40 #define usb_actconfig_attr(field, format_string)                \
  41         usb_actconfig_show(field, format_string)                \
  42         static DEVICE_ATTR_RO(field)
  43
  44 usb_actconfig_attr(bNumInterfaces, "%2d\n");
  45 usb_actconfig_attr(bmAttributes, "%2x\n");
  46
  47 static ssize_t bMaxPower_show(struct device *dev,
  48                 struct device_attribute *attr, char *buf)
  49 {
  50         struct usb_device *udev;
  51         struct usb_host_config *actconfig;
  52         ssize_t rc;
  53
  54         udev = to_usb_device(dev);
  55         rc = usb_lock_device_interruptible(udev);
  56         if (rc < 0)
  57                 return -EINTR;
  58         actconfig = udev->actconfig;
  59         if (actconfig)
  60                 rc = sprintf(buf, "%dmA\n", usb_get_max_power(udev, actconfig));
  61         usb_unlock_device(udev);
  62         return rc;
  63 }
  64 static DEVICE_ATTR_RO(bMaxPower);
  65
  66 static ssize_t configuration_show(struct device *dev,
  67                 struct device_attribute *attr, char *buf)
  68 {
  69         struct usb_device *udev;
  70         struct usb_host_config *actconfig;
  71         ssize_t rc;
  72
  73         udev = to_usb_device(dev);
  74         rc = usb_lock_device_interruptible(udev);
  75         if (rc < 0)
  76                 return -EINTR;
  77         actconfig = udev->actconfig;
  78         if (actconfig && actconfig->string)
  79                 rc = sprintf(buf, "%s\n", actconfig->string);
  80         usb_unlock_device(udev);
  81         return rc;
  82 }
  83 static DEVICE_ATTR_RO(configuration);
  84
  85 /* configuration value is always present, and r/w */
  86 usb_actconfig_show(bConfigurationValue, "%u\n");
  87
  88 static ssize_t bConfigurationValue_store(struct device *dev,
  89                                          struct device_attribute *attr,
  90                                          const char *buf, size_t count)
  91 {
  92         struct usb_device       *udev = to_usb_device(dev);
  93         int                     config, value, rc;
  94
  95         if (sscanf(buf, "%d", &config) != 1 || config < -1 || config > 255)
  96                 return -EINVAL;
  97         rc = usb_lock_device_interruptible(udev);
  98         if (rc < 0)
  99                 return -EINTR;
 100         value = usb_set_configuration(udev, config);
 101         usb_unlock_device(udev);
 102         return (value < 0) ? value : count;
 103 }
 104 static DEVICE_ATTR_IGNORE_LOCKDEP(bConfigurationValue, S_IRUGO | S_IWUSR,
 105                 bConfigurationValue_show, bConfigurationValue_store);
 106
 107 /* String fields */
 108 #define usb_string_attr(name)                                           \
 109 static ssize_t  name##_show(struct device *dev,                         \
 110                 struct device_attribute *attr, char *buf)               \
 111 {                                                                       \
 112         struct usb_device *udev;                                        \
 113         int retval;                                                     \
 114                                                                         \
 115         udev = to_usb_device(dev);                                      \
 116         retval = usb_lock_device_interruptible(udev);                   \
 117         if (retval < 0)                                                 \
 118                 return -EINTR;                                          \
 119         retval = sprintf(buf, "%s\n", udev->name);                      \
 120         usb_unlock_device(udev);                                        \
 121         return retval;                                                  \
 122 }                                                                       \
 123 static DEVICE_ATTR_RO(name)
 124
 125 usb_string_attr(product);
 126 usb_string_attr(manufacturer);
 127 usb_string_attr(serial);
 128
 129 static ssize_t speed_show(struct device *dev, struct device_attribute *attr,
 130                           char *buf)
 131 {
 132         struct usb_device *udev;
 133         char *speed;
 134
 135         udev = to_usb_device(dev);
 136
 137         switch (udev->speed) {
 138         case USB_SPEED_LOW:
 139                 speed = "1.5";
 140                 break;
 141         case USB_SPEED_UNKNOWN:
 142         case USB_SPEED_FULL:
 143                 speed = "12";
 144                 break;
 145         case USB_SPEED_HIGH:
 146                 speed = "480";
 147                 break;
 148         case USB_SPEED_WIRELESS:
 149                 speed = "480";
 150                 break;
 151         case USB_SPEED_SUPER:
 152                 speed = "5000";
 153                 break;
 154         case USB_SPEED_SUPER_PLUS:
 155                 speed = "10000";
 156                 break;
 157         default:
 158                 speed = "unknown";
 159         }
 160         return sprintf(buf, "%s\n", speed);
 161 }
 162 static DEVICE_ATTR_RO(speed);
 163
 164 static ssize_t busnum_show(struct device *dev, struct device_attribute *attr,
 165                            char *buf)
 166 {
 167         struct usb_device *udev;
 168
 169         udev = to_usb_device(dev);
 170         return sprintf(buf, "%d\n", udev->bus->busnum);
 171 }
 172 static DEVICE_ATTR_RO(busnum);
 173
 174 static ssize_t devnum_show(struct device *dev, struct device_attribute *attr,
 175                            char *buf)
 176 {
 177         struct usb_device *udev;
 178
 179         udev = to_usb_device(dev);
 180         return sprintf(buf, "%d\n", udev->devnum);
 181 }
 182 static DEVICE_ATTR_RO(devnum);
 183
 184 static ssize_t devpath_show(struct device *dev, struct device_attribute *attr,
 185                             char *buf)
 186 {
 187         struct usb_device *udev;
 188
 189         udev = to_usb_device(dev);
 190         return sprintf(buf, "%s\n", udev->devpath);
 191 }
 192 static DEVICE_ATTR_RO(devpath);
 193
 194 static ssize_t version_show(struct device *dev, struct device_attribute *attr,
 195                             char *buf)
 196 {
 197         struct usb_device *udev;
 198         u16 bcdUSB;
 199
 200         udev = to_usb_device(dev);
 201         bcdUSB = le16_to_cpu(udev->descriptor.bcdUSB);
 202         return sprintf(buf, "%2x.%02x\n", bcdUSB >> 8, bcdUSB & 0xff);
 203 }
 204 static DEVICE_ATTR_RO(version);
 205
 206 static ssize_t maxchild_show(struct device *dev, struct device_attribute *attr,
 207                              char *buf)
 208 {
 209         struct usb_device *udev;
 210
 211         udev = to_usb_device(dev);
 212         return sprintf(buf, "%d\n", udev->maxchild);
 213 }
 214 static DEVICE_ATTR_RO(maxchild);
 215
 216 static ssize_t quirks_show(struct device *dev, struct device_attribute *attr,
 217                            char *buf)
 218 {
 219         struct usb_device *udev;
 220
 221         udev = to_usb_device(dev);
 222         return sprintf(buf, "0x%x\n", udev->quirks);
 223 }
 224 static DEVICE_ATTR_RO(quirks);
 225
 226 static ssize_t avoid_reset_quirk_show(struct device *dev,
 227                                       struct device_attribute *attr, char *buf)
 228 {
 229         struct usb_device *udev;
 230
 231         udev = to_usb_device(dev);
 232         return sprintf(buf, "%d\n", !!(udev->quirks & USB_QUIRK_RESET));
 233 }
 234
 235 static ssize_t avoid_reset_quirk_store(struct device *dev,
 236                                       struct device_attribute *attr,
 237                                       const char *buf, size_t count)
 238 {
 239         struct usb_device       *udev = to_usb_device(dev);
 240         int                     val, rc;
 241
 242         if (sscanf(buf, "%d", &val) != 1 || val < 0 || val > 1)
 243                 return -EINVAL;
 244         rc = usb_lock_device_interruptible(udev);
 245         if (rc < 0)
 246                 return -EINTR;
 247         if (val)
 248                 udev->quirks |= USB_QUIRK_RESET;
 249         else
 250                 udev->quirks &= ~USB_QUIRK_RESET;
 251         usb_unlock_device(udev);
 252         return count;
 253 }
 254 static DEVICE_ATTR_RW(avoid_reset_quirk);
 255
 256 static ssize_t urbnum_show(struct device *dev, struct device_attribute *attr,
 257                            char *buf)
 258 {
 259         struct usb_device *udev;
 260
 261         udev = to_usb_device(dev);
 262         return sprintf(buf, "%d\n", atomic_read(&udev->urbnum));
 263 }
 264 static DEVICE_ATTR_RO(urbnum);
 265
 266 static ssize_t removable_show(struct device *dev, struct device_attribute *attr,
 267                               char *buf)
 268 {
 269         struct usb_device *udev;
 270         char *state;
 271
 272         udev = to_usb_device(dev);
 273
 274         switch (udev->removable) {
 275         case USB_DEVICE_REMOVABLE:
 276                 state = "removable";
 277                 break;
 278         case USB_DEVICE_FIXED:
 279                 state = "fixed";
 280                 break;
 281         default:
 282                 state = "unknown";
 283         }
 284
 285         return sprintf(buf, "%s\n", state);
 286 }
 287 static DEVICE_ATTR_RO(removable);
 288
 289 static ssize_t ltm_capable_show(struct device *dev,
 290                                 struct device_attribute *attr, char *buf)
 291 {
 292         if (usb_device_supports_ltm(to_usb_device(dev)))
 293                 return sprintf(buf, "%s\n", "yes");
 294         return sprintf(buf, "%s\n", "no");
 295 }
 296 static DEVICE_ATTR_RO(ltm_capable);
 297
 298 #ifdef  CONFIG_PM
 299
 300 static ssize_t persist_show(struct device *dev, struct device_attribute *attr,
 301                             char *buf)
 302 {
 303         struct usb_device *udev = to_usb_device(dev);
 304
 305         return sprintf(buf, "%d\n", udev->persist_enabled);
 306 }
 307
 308 static ssize_t persist_store(struct device *dev, struct device_attribute *attr,
 309                              const char *buf, size_t count)
 310 {
 311         struct usb_device *udev = to_usb_device(dev);
 312         int value, rc;
 313
 314         /* Hubs are always enabled for USB_PERSIST */
 315         if (udev->descriptor.bDeviceClass == USB_CLASS_HUB)
 316                 return -EPERM;
 317
 318         if (sscanf(buf, "%d", &value) != 1)
 319                 return -EINVAL;
 320
 321         rc = usb_lock_device_interruptible(udev);
 322         if (rc < 0)
 323                 return -EINTR;
 324         udev->persist_enabled = !!value;
 325         usb_unlock_device(udev);
 326         return count;
 327 }
 328 static DEVICE_ATTR_RW(persist);
 329
 330 static int add_persist_attributes(struct device *dev)
 331 {
 332         int rc = 0;
 333
 334         if (is_usb_device(dev)) {
 335                 struct usb_device *udev = to_usb_device(dev);
 336
 337                 /* Hubs are automatically enabled for USB_PERSIST,
 338                  * no point in creating the attribute file.
 339                  */
 340                 if (udev->descriptor.bDeviceClass != USB_CLASS_HUB)
 341                         rc = sysfs_add_file_to_group(&dev->kobj,
 342                                         &dev_attr_persist.attr,
 343                                         power_group_name);
 344         }
 345         return rc;
 346 }
 347
 348 static void remove_persist_attributes(struct device *dev)
 349 {
 350         sysfs_remove_file_from_group(&dev->kobj,
 351                         &dev_attr_persist.attr,
 352                         power_group_name);
 353 }
 354
 355 static ssize_t connected_duration_show(struct device *dev,
 356                                        struct device_attribute *attr, char *buf)
 357 {
 358         struct usb_device *udev = to_usb_device(dev);
 359
 360         return sprintf(buf, "%u\n",
 361                         jiffies_to_msecs(jiffies - udev->connect_time));
 362 }
 363 static DEVICE_ATTR_RO(connected_duration);
 364
 365 /*
 366  * If the device is resumed, the last time the device was suspended has
 367  * been pre-subtracted from active_duration.  We add the current time to
 368  * get the duration that the device was actually active.
 369  *
 370  * If the device is suspended, the active_duration is up-to-date.
 371  */
 372 static ssize_t active_duration_show(struct device *dev,
 373                                     struct device_attribute *attr, char *buf)
 374 {
 375         struct usb_device *udev = to_usb_device(dev);
 376         int duration;
 377
 378         if (udev->state != USB_STATE_SUSPENDED)
 379                 duration = jiffies_to_msecs(jiffies + udev->active_duration);
 380         else
 381                 duration = jiffies_to_msecs(udev->active_duration);
 382         return sprintf(buf, "%u\n", duration);
 383 }
 384 static DEVICE_ATTR_RO(active_duration);
 385
 386 static ssize_t autosuspend_show(struct device *dev,
 387                                 struct device_attribute *attr, char *buf)
 388 {
 389         return sprintf(buf, "%d\n", dev->power.autosuspend_delay / 1000);
 390 }
 391
 392 static ssize_t autosuspend_store(struct device *dev,
 393                                  struct device_attribute *attr, const char *buf,
 394                                  size_t count)
 395 {
 396         int value;
 397
 398         if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/1000 ||
 399                         value <= -INT_MAX/1000)
 400                 return -EINVAL;
 401
 402         pm_runtime_set_autosuspend_delay(dev, value * 1000);
 403         return count;
 404 }
 405 static DEVICE_ATTR_RW(autosuspend);
 406
 407 static const char on_string[] = "on";
 408 static const char auto_string[] = "auto";
 409
 410 static void warn_level(void)
 411 {
 412         static int level_warned;
 413
 414         if (!level_warned) {
 415                 level_warned = 1;
 416                 printk(KERN_WARNING "WARNING! power/level is deprecated; "
 417                                 "use power/control instead\n");
 418         }
 419 }
 420
 421 static ssize_t level_show(struct device *dev, struct device_attribute *attr,
 422                           char *buf)
 423 {
 424         struct usb_device *udev = to_usb_device(dev);
 425         const char *p = auto_string;
 426
 427         warn_level();
 428         if (udev->state != USB_STATE_SUSPENDED && !udev->dev.power.runtime_auto)
 429                 p = on_string;
 430         return sprintf(buf, "%s\n", p);
 431 }
 432
 433 static ssize_t level_store(struct device *dev, struct device_attribute *attr,
 434                            const char *buf, size_t count)
 435 {
 436         struct usb_device *udev = to_usb_device(dev);
 437         int len = count;
 438         char *cp;
 439         int rc = count;
 440         int rv;
 441
 442         warn_level();
 443         cp = memchr(buf, '\n', count);
 444         if (cp)
 445                 len = cp - buf;
 446
 447         rv = usb_lock_device_interruptible(udev);
 448         if (rv < 0)
 449                 return -EINTR;
 450
 451         if (len == sizeof on_string - 1 &&
 452                         strncmp(buf, on_string, len) == 0)
 453                 usb_disable_autosuspend(udev);
 454
 455         else if (len == sizeof auto_string - 1 &&
 456                         strncmp(buf, auto_string, len) == 0)
 457                 usb_enable_autosuspend(udev);
 458
 459         else
 460                 rc = -EINVAL;
 461
 462         usb_unlock_device(udev);
 463         return rc;
 464 }
 465 static DEVICE_ATTR_RW(level);
 466
 467 static ssize_t usb2_hardware_lpm_show(struct device *dev,
 468                                       struct device_attribute *attr, char *buf)
 469 {
 470         struct usb_device *udev = to_usb_device(dev);
 471         const char *p;
 472
 473         if (udev->usb2_hw_lpm_allowed == 1)
 474                 p = "enabled";
 475         else
 476                 p = "disabled";
 477
 478         return sprintf(buf, "%s\n", p);
 479 }
 480
 481 static ssize_t usb2_hardware_lpm_store(struct device *dev,
 482                                        struct device_attribute *attr,
 483                                        const char *buf, size_t count)
 484 {
 485         struct usb_device *udev = to_usb_device(dev);
 486         bool value;
 487         int ret;
 488
 489         ret = usb_lock_device_interruptible(udev);
 490         if (ret < 0)
 491                 return -EINTR;
 492
 493         ret = strtobool(buf, &value);
 494
 495         if (!ret) {
 496                 udev->usb2_hw_lpm_allowed = value;
 497                 if (value)
 498                         ret = usb_enable_usb2_hardware_lpm(udev);
 499                 else
 500                         ret = usb_disable_usb2_hardware_lpm(udev);
 501         }
 502
 503         usb_unlock_device(udev);
 504
 505         if (!ret)
 506                 return count;
 507
 508         return ret;
 509 }
 510 static DEVICE_ATTR_RW(usb2_hardware_lpm);
 511
 512 static ssize_t usb2_lpm_l1_timeout_show(struct device *dev,
 513                                         struct device_attribute *attr,
 514                                         char *buf)
 515 {
 516         struct usb_device *udev = to_usb_device(dev);
 517         return sprintf(buf, "%d\n", udev->l1_params.timeout);
 518 }
 519
 520 static ssize_t usb2_lpm_l1_timeout_store(struct device *dev,
 521                                          struct device_attribute *attr,
 522                                          const char *buf, size_t count)
 523 {
 524         struct usb_device *udev = to_usb_device(dev);
 525         u16 timeout;
 526
 527         if (kstrtou16(buf, 0, &timeout))
 528                 return -EINVAL;
 529
 530         udev->l1_params.timeout = timeout;
 531
 532         return count;
 533 }
 534 static DEVICE_ATTR_RW(usb2_lpm_l1_timeout);
 535
 536 static ssize_t usb2_lpm_besl_show(struct device *dev,
 537                                   struct device_attribute *attr, char *buf)
 538 {
 539         struct usb_device *udev = to_usb_device(dev);
 540         return sprintf(buf, "%d\n", udev->l1_params.besl);
 541 }
 542
 543 static ssize_t usb2_lpm_besl_store(struct device *dev,
 544                                    struct device_attribute *attr,
 545                                    const char *buf, size_t count)
 546 {
 547         struct usb_device *udev = to_usb_device(dev);
 548         u8 besl;
 549
 550         if (kstrtou8(buf, 0, &besl) || besl > 15)
 551                 return -EINVAL;
 552
 553         udev->l1_params.besl = besl;
 554
 555         return count;
 556 }
 557 static DEVICE_ATTR_RW(usb2_lpm_besl);
 558
 559 static ssize_t usb3_hardware_lpm_u1_show(struct device *dev,
 560                                       struct device_attribute *attr, char *buf)
 561 {
 562         struct usb_device *udev = to_usb_device(dev);
 563         const char *p;
 564         int rc;
 565
 566         rc = usb_lock_device_interruptible(udev);
 567         if (rc < 0)
 568                 return -EINTR;
 569
 570         if (udev->usb3_lpm_u1_enabled)
 571                 p = "enabled";
 572         else
 573                 p = "disabled";
 574
 575         usb_unlock_device(udev);
 576
 577         return sprintf(buf, "%s\n", p);
 578 }
 579 static DEVICE_ATTR_RO(usb3_hardware_lpm_u1);
 580
 581 static ssize_t usb3_hardware_lpm_u2_show(struct device *dev,
 582                                       struct device_attribute *attr, char *buf)
 583 {
 584         struct usb_device *udev = to_usb_device(dev);
 585         const char *p;
 586         int rc;
 587
 588         rc = usb_lock_device_interruptible(udev);
 589         if (rc < 0)
 590                 return -EINTR;
 591
 592         if (udev->usb3_lpm_u2_enabled)
 593                 p = "enabled";
 594         else
 595                 p = "disabled";
 596
 597         usb_unlock_device(udev);
 598
 599         return sprintf(buf, "%s\n", p);
 600 }
 601 static DEVICE_ATTR_RO(usb3_hardware_lpm_u2);
 602
 603 static struct attribute *usb2_hardware_lpm_attr[] = {
 604         &dev_attr_usb2_hardware_lpm.attr,
 605         &dev_attr_usb2_lpm_l1_timeout.attr,
 606         &dev_attr_usb2_lpm_besl.attr,
 607         NULL,
 608 };
 609 static struct attribute_group usb2_hardware_lpm_attr_group = {
 610         .name   = power_group_name,
 611         .attrs  = usb2_hardware_lpm_attr,
 612 };
 613
 614 static struct attribute *usb3_hardware_lpm_attr[] = {
 615         &dev_attr_usb3_hardware_lpm_u1.attr,
 616         &dev_attr_usb3_hardware_lpm_u2.attr,
 617         NULL,
 618 };
 619 static struct attribute_group usb3_hardware_lpm_attr_group = {
 620         .name   = power_group_name,
 621         .attrs  = usb3_hardware_lpm_attr,
 622 };
 623
 624 static struct attribute *power_attrs[] = {
 625         &dev_attr_autosuspend.attr,
 626         &dev_attr_level.attr,
 627         &dev_attr_connected_duration.attr,
 628         &dev_attr_active_duration.attr,
 629         NULL,
 630 };
 631 static struct attribute_group power_attr_group = {
 632         .name   = power_group_name,
 633         .attrs  = power_attrs,
 634 };
 635
 636 static int add_power_attributes(struct device *dev)
 637 {
 638         int rc = 0;
 639
 640         if (is_usb_device(dev)) {
 641                 struct usb_device *udev = to_usb_device(dev);
 642                 rc = sysfs_merge_group(&dev->kobj, &power_attr_group);
 643                 if (udev->usb2_hw_lpm_capable == 1)
 644                         rc = sysfs_merge_group(&dev->kobj,
 645                                         &usb2_hardware_lpm_attr_group);
 646                 if (udev->speed == USB_SPEED_SUPER &&
 647                                 udev->lpm_capable == 1)
 648                         rc = sysfs_merge_group(&dev->kobj,
 649                                         &usb3_hardware_lpm_attr_group);
 650         }
 651
 652         return rc;
 653 }
 654
 655 static void remove_power_attributes(struct device *dev)
 656 {
 657         sysfs_unmerge_group(&dev->kobj, &usb2_hardware_lpm_attr_group);
 658         sysfs_unmerge_group(&dev->kobj, &power_attr_group);
 659 }
 660
 661 #else
 662
 663 #define add_persist_attributes(dev)     0
 664 #define remove_persist_attributes(dev)  do {} while (0)
 665
 666 #define add_power_attributes(dev)       0
 667 #define remove_power_attributes(dev)    do {} while (0)
 668
 669 #endif  /* CONFIG_PM */
 670
 671
 672 /* Descriptor fields */
 673 #define usb_descriptor_attr_le16(field, format_string)                  \
 674 static ssize_t                                                          \
 675 field##_show(struct device *dev, struct device_attribute *attr, \
 676                 char *buf)                                              \
 677 {                                                                       \
 678         struct usb_device *udev;                                        \
 679                                                                         \
 680         udev = to_usb_device(dev);                                      \
 681         return sprintf(buf, format_string,                              \
 682                         le16_to_cpu(udev->descriptor.field));           \
 683 }                                                                       \
 684 static DEVICE_ATTR_RO(field)
 685
 686 usb_descriptor_attr_le16(idVendor, "%04x\n");
 687 usb_descriptor_attr_le16(idProduct, "%04x\n");
 688 usb_descriptor_attr_le16(bcdDevice, "%04x\n");
 689
 690 #define usb_descriptor_attr(field, format_string)                       \
 691 static ssize_t                                                          \
 692 field##_show(struct device *dev, struct device_attribute *attr, \
 693                 char *buf)                                              \
 694 {                                                                       \
 695         struct usb_device *udev;                                        \
 696                                                                         \
 697         udev = to_usb_device(dev);                                      \
 698         return sprintf(buf, format_string, udev->descriptor.field);     \
 699 }                                                                       \
 700 static DEVICE_ATTR_RO(field)
 701
 702 usb_descriptor_attr(bDeviceClass, "%02x\n");
 703 usb_descriptor_attr(bDeviceSubClass, "%02x\n");
 704 usb_descriptor_attr(bDeviceProtocol, "%02x\n");
 705 usb_descriptor_attr(bNumConfigurations, "%d\n");
 706 usb_descriptor_attr(bMaxPacketSize0, "%d\n");
 707
 708
 709 /* show if the device is authorized (1) or not (0) */
 710 static ssize_t authorized_show(struct device *dev,
 711                                struct device_attribute *attr, char *buf)
 712 {
 713         struct usb_device *usb_dev = to_usb_device(dev);
 714         return snprintf(buf, PAGE_SIZE, "%u\n", usb_dev->authorized);
 715 }
 716
 717 /*
 718  * Authorize a device to be used in the system
 719  *
 720  * Writing a 0 deauthorizes the device, writing a 1 authorizes it.
 721  */
 722 static ssize_t authorized_store(struct device *dev,
 723                                 struct device_attribute *attr, const char *buf,
 724                                 size_t size)
 725 {
 726         ssize_t result;
 727         struct usb_device *usb_dev = to_usb_device(dev);
 728         unsigned val;
 729         result = sscanf(buf, "%u\n", &val);
 730         if (result != 1)
 731                 result = -EINVAL;
 732         else if (val == 0)
 733                 result = usb_deauthorize_device(usb_dev);
 734         else
 735                 result = usb_authorize_device(usb_dev);
 736         return result < 0 ? result : size;
 737 }
 738 static DEVICE_ATTR_IGNORE_LOCKDEP(authorized, S_IRUGO | S_IWUSR,
 739                                   authorized_show, authorized_store);
 740
 741 /* "Safely remove a device" */
 742 static ssize_t remove_store(struct device *dev, struct device_attribute *attr,
 743                             const char *buf, size_t count)
 744 {
 745         struct usb_device *udev = to_usb_device(dev);
 746         int rc = 0;
 747
 748         usb_lock_device(udev);
 749         if (udev->state != USB_STATE_NOTATTACHED) {
 750
 751                 /* To avoid races, first unconfigure and then remove */
 752                 usb_set_configuration(udev, -1);
 753                 rc = usb_remove_device(udev);
 754         }
 755         if (rc == 0)
 756                 rc = count;
 757         usb_unlock_device(udev);
 758         return rc;
 759 }
 760 static DEVICE_ATTR_IGNORE_LOCKDEP(remove, S_IWUSR, NULL, remove_store);
 761
 762
 763 static struct attribute *dev_attrs[] = {
 764         /* current configuration's attributes */
 765         &dev_attr_configuration.attr,
 766         &dev_attr_bNumInterfaces.attr,
 767         &dev_attr_bConfigurationValue.attr,
 768         &dev_attr_bmAttributes.attr,
 769         &dev_attr_bMaxPower.attr,
 770         /* device attributes */
 771         &dev_attr_urbnum.attr,
 772         &dev_attr_idVendor.attr,
 773         &dev_attr_idProduct.attr,
 774         &dev_attr_bcdDevice.attr,
 775         &dev_attr_bDeviceClass.attr,
 776         &dev_attr_bDeviceSubClass.attr,
 777         &dev_attr_bDeviceProtocol.attr,
 778         &dev_attr_bNumConfigurations.attr,
 779         &dev_attr_bMaxPacketSize0.attr,
 780         &dev_attr_speed.attr,
 781         &dev_attr_busnum.attr,
 782         &dev_attr_devnum.attr,
 783         &dev_attr_devpath.attr,
 784         &dev_attr_version.attr,
 785         &dev_attr_maxchild.attr,
 786         &dev_attr_quirks.attr,
 787         &dev_attr_avoid_reset_quirk.attr,
 788         &dev_attr_authorized.attr,
 789         &dev_attr_remove.attr,
 790         &dev_attr_removable.attr,
 791         &dev_attr_ltm_capable.attr,
 792         NULL,
 793 };
 794 static struct attribute_group dev_attr_grp = {
 795         .attrs = dev_attrs,
 796 };
 797
 798 /* When modifying this list, be sure to modify dev_string_attrs_are_visible()
 799  * accordingly.
 800  */
 801 static struct attribute *dev_string_attrs[] = {
 802         &dev_attr_manufacturer.attr,
 803         &dev_attr_product.attr,
 804         &dev_attr_serial.attr,
 805         NULL
 806 };
 807
 808 static umode_t dev_string_attrs_are_visible(struct kobject *kobj,
 809                 struct attribute *a, int n)
 810 {
 811         struct device *dev = container_of(kobj, struct device, kobj);
 812         struct usb_device *udev = to_usb_device(dev);
 813
 814         if (a == &dev_attr_manufacturer.attr) {
 815                 if (udev->manufacturer == NULL)
 816                         return 0;
 817         } else if (a == &dev_attr_product.attr) {
 818                 if (udev->product == NULL)
 819                         return 0;
 820         } else if (a == &dev_attr_serial.attr) {
 821                 if (udev->serial == NULL)
 822                         return 0;
 823         }
 824         return a->mode;
 825 }
 826
 827 static struct attribute_group dev_string_attr_grp = {
 828         .attrs =        dev_string_attrs,
 829         .is_visible =   dev_string_attrs_are_visible,
 830 };
 831
 832 const struct attribute_group *usb_device_groups[] = {
 833         &dev_attr_grp,
 834         &dev_string_attr_grp,
 835         NULL
 836 };
 837
 838 /* Binary descriptors */
 839
 840 static ssize_t
 841 read_descriptors(struct file *filp, struct kobject *kobj,
 842                 struct bin_attribute *attr,
 843                 char *buf, loff_t off, size_t count)
 844 {
 845         struct device *dev = container_of(kobj, struct device, kobj);
 846         struct usb_device *udev = to_usb_device(dev);
 847         size_t nleft = count;
 848         size_t srclen, n;
 849         int cfgno;
 850         void *src;
 851         int retval;
 852
 853         retval = usb_lock_device_interruptible(udev);
 854         if (retval < 0)
 855                 return -EINTR;
 856         /* The binary attribute begins with the device descriptor.
 857          * Following that are the raw descriptor entries for all the
 858          * configurations (config plus subsidiary descriptors).
 859          */
 860         for (cfgno = -1; cfgno < udev->descriptor.bNumConfigurations &&
 861                         nleft > 0; ++cfgno) {
 862                 if (cfgno < 0) {
 863                         src = &udev->descriptor;
 864                         srclen = sizeof(struct usb_device_descriptor);
 865                 } else {
 866                         src = udev->rawdescriptors[cfgno];
 867                         srclen = __le16_to_cpu(udev->config[cfgno].desc.
 868                                         wTotalLength);
 869                 }
 870                 if (off < srclen) {
 871                         n = min(nleft, srclen - (size_t) off);
 872                         memcpy(buf, src + off, n);
 873                         nleft -= n;
 874                         buf += n;
 875                         off = 0;
 876                 } else {
 877                         off -= srclen;
 878                 }
 879         }
 880         usb_unlock_device(udev);
 881         return count - nleft;
 882 }
 883
 884 static struct bin_attribute dev_bin_attr_descriptors = {
 885         .attr = {.name = "descriptors", .mode = 0444},
 886         .read = read_descriptors,
 887         .size = 18 + 65535,     /* dev descr + max-size raw descriptor */
 888 };
 889
 890 int usb_create_sysfs_dev_files(struct usb_device *udev)
 891 {
 892         struct device *dev = &udev->dev;
 893         int retval;
 894
 895         retval = device_create_bin_file(dev, &dev_bin_attr_descriptors);
 896         if (retval)
 897                 goto error;
 898
 899         retval = add_persist_attributes(dev);
 900         if (retval)
 901                 goto error;
 902
 903         retval = add_power_attributes(dev);
 904         if (retval)
 905                 goto error;
 906         return retval;
 907 error:
 908         usb_remove_sysfs_dev_files(udev);
 909         return retval;
 910 }
 911
 912 void usb_remove_sysfs_dev_files(struct usb_device *udev)
 913 {
 914         struct device *dev = &udev->dev;
 915
 916         remove_power_attributes(dev);
 917         remove_persist_attributes(dev);
 918         device_remove_bin_file(dev, &dev_bin_attr_descriptors);
 919 }
 920
 921 /* Interface Association Descriptor fields */
 922 #define usb_intf_assoc_attr(field, format_string)                       \
 923 static ssize_t                                                          \
 924 iad_##field##_show(struct device *dev, struct device_attribute *attr,   \
 925                 char *buf)                                              \
 926 {                                                                       \
 927         struct usb_interface *intf = to_usb_interface(dev);             \
 928                                                                         \
 929         return sprintf(buf, format_string,                              \
 930                         intf->intf_assoc->field);                       \
 931 }                                                                       \
 932 static DEVICE_ATTR_RO(iad_##field)
 933
 934 usb_intf_assoc_attr(bFirstInterface, "%02x\n");
 935 usb_intf_assoc_attr(bInterfaceCount, "%02d\n");
 936 usb_intf_assoc_attr(bFunctionClass, "%02x\n");
 937 usb_intf_assoc_attr(bFunctionSubClass, "%02x\n");
 938 usb_intf_assoc_attr(bFunctionProtocol, "%02x\n");
 939
 940 /* Interface fields */
 941 #define usb_intf_attr(field, format_string)                             \
 942 static ssize_t                                                          \
 943 field##_show(struct device *dev, struct device_attribute *attr,         \
 944                 char *buf)                                              \
 945 {                                                                       \
 946         struct usb_interface *intf = to_usb_interface(dev);             \
 947                                                                         \
 948         return sprintf(buf, format_string,                              \
 949                         intf->cur_altsetting->desc.field);              \
 950 }                                                                       \
 951 static DEVICE_ATTR_RO(field)
 952
 953 usb_intf_attr(bInterfaceNumber, "%02x\n");
 954 usb_intf_attr(bAlternateSetting, "%2d\n");
 955 usb_intf_attr(bNumEndpoints, "%02x\n");
 956 usb_intf_attr(bInterfaceClass, "%02x\n");
 957 usb_intf_attr(bInterfaceSubClass, "%02x\n");
 958 usb_intf_attr(bInterfaceProtocol, "%02x\n");
 959
 960 static ssize_t interface_show(struct device *dev, struct device_attribute *attr,
 961                               char *buf)
 962 {
 963         struct usb_interface *intf;
 964         char *string;
 965
 966         intf = to_usb_interface(dev);
 967         string = ACCESS_ONCE(intf->cur_altsetting->string);
 968         if (!string)
 969                 return 0;
 970         return sprintf(buf, "%s\n", string);
 971 }
 972 static DEVICE_ATTR_RO(interface);
 973
 974 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
 975                              char *buf)
 976 {
 977         struct usb_interface *intf;
 978         struct usb_device *udev;
 979         struct usb_host_interface *alt;
 980
 981         intf = to_usb_interface(dev);
 982         udev = interface_to_usbdev(intf);
 983         alt = ACCESS_ONCE(intf->cur_altsetting);
 984
 985         return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
 986                         "ic%02Xisc%02Xip%02Xin%02X\n",
 987                         le16_to_cpu(udev->descriptor.idVendor),
 988                         le16_to_cpu(udev->descriptor.idProduct),
 989                         le16_to_cpu(udev->descriptor.bcdDevice),
 990                         udev->descriptor.bDeviceClass,
 991                         udev->descriptor.bDeviceSubClass,
 992                         udev->descriptor.bDeviceProtocol,
 993                         alt->desc.bInterfaceClass,
 994                         alt->desc.bInterfaceSubClass,
 995                         alt->desc.bInterfaceProtocol,
 996                         alt->desc.bInterfaceNumber);
 997 }
 998 static DEVICE_ATTR_RO(modalias);
 999
1000 static ssize_t supports_autosuspend_show(struct device *dev,
1001                                          struct device_attribute *attr,
1002                                          char *buf)
1003 {
1004         int s;
1005
1006         s = device_lock_interruptible(dev);
1007         if (s < 0)
1008                 return -EINTR;
1009         /* Devices will be autosuspended even when an interface isn't claimed */
1010         s = (!dev->driver || to_usb_driver(dev->driver)->supports_autosuspend);
1011         device_unlock(dev);
1012
1013         return sprintf(buf, "%u\n", s);
1014 }
1015 static DEVICE_ATTR_RO(supports_autosuspend);
1016
1017 /*
1018  * interface_authorized_show - show authorization status of an USB interface
1019  * 1 is authorized, 0 is deauthorized
1020  */
1021 static ssize_t interface_authorized_show(struct device *dev,
1022                 struct device_attribute *attr, char *buf)
1023 {
1024         struct usb_interface *intf = to_usb_interface(dev);
1025
1026         return sprintf(buf, "%u\n", intf->authorized);
1027 }
1028
1029 /*
1030  * interface_authorized_store - authorize or deauthorize an USB interface
1031  */
1032 static ssize_t interface_authorized_store(struct device *dev,
1033                 struct device_attribute *attr, const char *buf, size_t count)
1034 {
1035         struct usb_interface *intf = to_usb_interface(dev);
1036         bool val;
1037
1038         if (strtobool(buf, &val) != 0)
1039                 return -EINVAL;
1040
1041         if (val)
1042                 usb_authorize_interface(intf);
1043         else
1044                 usb_deauthorize_interface(intf);
1045
1046         return count;
1047 }
1048 static struct device_attribute dev_attr_interface_authorized =
1049                 __ATTR(authorized, S_IRUGO | S_IWUSR,
1050                 interface_authorized_show, interface_authorized_store);
1051
1052 static struct attribute *intf_attrs[] = {
1053         &dev_attr_bInterfaceNumber.attr,
1054         &dev_attr_bAlternateSetting.attr,
1055         &dev_attr_bNumEndpoints.attr,
1056         &dev_attr_bInterfaceClass.attr,
1057         &dev_attr_bInterfaceSubClass.attr,
1058         &dev_attr_bInterfaceProtocol.attr,
1059         &dev_attr_modalias.attr,
1060         &dev_attr_supports_autosuspend.attr,
1061         &dev_attr_interface_authorized.attr,
1062         NULL,
1063 };
1064 static struct attribute_group intf_attr_grp = {
1065         .attrs = intf_attrs,
1066 };
1067
1068 static struct attribute *intf_assoc_attrs[] = {
1069         &dev_attr_iad_bFirstInterface.attr,
1070         &dev_attr_iad_bInterfaceCount.attr,
1071         &dev_attr_iad_bFunctionClass.attr,
1072         &dev_attr_iad_bFunctionSubClass.attr,
1073         &dev_attr_iad_bFunctionProtocol.attr,
1074         NULL,
1075 };
1076
1077 static umode_t intf_assoc_attrs_are_visible(struct kobject *kobj,
1078                 struct attribute *a, int n)
1079 {
1080         struct device *dev = container_of(kobj, struct device, kobj);
1081         struct usb_interface *intf = to_usb_interface(dev);
1082
1083         if (intf->intf_assoc == NULL)
1084                 return 0;
1085         return a->mode;
1086 }
1087
1088 static struct attribute_group intf_assoc_attr_grp = {
1089         .attrs =        intf_assoc_attrs,
1090         .is_visible =   intf_assoc_attrs_are_visible,
1091 };
1092
1093 const struct attribute_group *usb_interface_groups[] = {
1094         &intf_attr_grp,
1095         &intf_assoc_attr_grp,
1096         NULL
1097 };
1098
1099 void usb_create_sysfs_intf_files(struct usb_interface *intf)
1100 {
1101         struct usb_device *udev = interface_to_usbdev(intf);
1102         struct usb_host_interface *alt = intf->cur_altsetting;
1103
1104         if (intf->sysfs_files_created || intf->unregistering)
1105                 return;
1106
1107         if (!alt->string && !(udev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS))
1108                 alt->string = usb_cache_string(udev, alt->desc.iInterface);
1109         if (alt->string && device_create_file(&intf->dev, &dev_attr_interface))
1110                 ;       /* We don't actually care if the function fails. */
1111         intf->sysfs_files_created = 1;
1112 }
1113
1114 void usb_remove_sysfs_intf_files(struct usb_interface *intf)
1115 {
1116         if (!intf->sysfs_files_created)
1117                 return;
1118
1119         device_remove_file(&intf->dev, &dev_attr_interface);
1120         intf->sysfs_files_created = 0;
1121 }