release/src-rt/linux/linux-2.6/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 "usb.h"
  17
  18 /* Active configuration fields */
  19 #define usb_actconfig_show(field, multiplier, format_string)            \
  20 static ssize_t  show_##field(struct device *dev,                        \
  21                 struct device_attribute *attr, char *buf)               \
  22 {                                                                       \
  23         struct usb_device *udev;                                        \
  24         struct usb_host_config *actconfig;                              \
  25                                                                         \
  26         udev = to_usb_device(dev);                                      \
  27         actconfig = udev->actconfig;                                    \
  28         if (actconfig)                                                  \
  29                 return sprintf(buf, format_string,                      \
  30                                 actconfig->desc.field * multiplier);    \
  31         else                                                            \
  32                 return 0;                                               \
  33 }                                                                       \
  34
  35 #define usb_actconfig_attr(field, multiplier, format_string)            \
  36 usb_actconfig_show(field, multiplier, format_string)                    \
  37 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
  38
  39 usb_actconfig_attr(bNumInterfaces, 1, "%2d\n")
  40 usb_actconfig_attr(bmAttributes, 1, "%2x\n")
  41 usb_actconfig_attr(bMaxPower, 2, "%3dmA\n")
  42
  43 static ssize_t show_configuration_string(struct device *dev,
  44                 struct device_attribute *attr, char *buf)
  45 {
  46         struct usb_device *udev;
  47         struct usb_host_config *actconfig;
  48
  49         udev = to_usb_device(dev);
  50         actconfig = udev->actconfig;
  51         if ((!actconfig) || (!actconfig->string))
  52                 return 0;
  53         return sprintf(buf, "%s\n", actconfig->string);
  54 }
  55 static DEVICE_ATTR(configuration, S_IRUGO, show_configuration_string, NULL);
  56
  57 /* configuration value is always present, and r/w */
  58 usb_actconfig_show(bConfigurationValue, 1, "%u\n");
  59
  60 static ssize_t
  61 set_bConfigurationValue(struct device *dev, struct device_attribute *attr,
  62                 const char *buf, size_t count)
  63 {
  64         struct usb_device       *udev = to_usb_device(dev);
  65         int                     config, value;
  66
  67         if (sscanf(buf, "%d", &config) != 1 || config < -1 || config > 255)
  68                 return -EINVAL;
  69         usb_lock_device(udev);
  70         value = usb_set_configuration(udev, config);
  71         usb_unlock_device(udev);
  72         return (value < 0) ? value : count;
  73 }
  74
  75 static DEVICE_ATTR(bConfigurationValue, S_IRUGO | S_IWUSR,
  76                 show_bConfigurationValue, set_bConfigurationValue);
  77
  78 /* String fields */
  79 #define usb_string_attr(name)                                           \
  80 static ssize_t  show_##name(struct device *dev,                         \
  81                 struct device_attribute *attr, char *buf)               \
  82 {                                                                       \
  83         struct usb_device *udev;                                        \
  84                                                                         \
  85         udev = to_usb_device(dev);                                      \
  86         return sprintf(buf, "%s\n", udev->name);                        \
  87 }                                                                       \
  88 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL);
  89
  90 usb_string_attr(product);
  91 usb_string_attr(manufacturer);
  92 usb_string_attr(serial);
  93
  94 static ssize_t
  95 show_speed(struct device *dev, struct device_attribute *attr, char *buf)
  96 {
  97         struct usb_device *udev;
  98         char *speed;
  99
 100         udev = to_usb_device(dev);
 101
 102         switch (udev->speed) {
 103         case USB_SPEED_LOW:
 104                 speed = "1.5";
 105                 break;
 106         case USB_SPEED_UNKNOWN:
 107         case USB_SPEED_FULL:
 108                 speed = "12";
 109                 break;
 110         case USB_SPEED_HIGH:
 111                 speed = "480";
 112                 break;
 113         default:
 114                 speed = "unknown";
 115         }
 116         return sprintf(buf, "%s\n", speed);
 117 }
 118 static DEVICE_ATTR(speed, S_IRUGO, show_speed, NULL);
 119
 120 static ssize_t
 121 show_busnum(struct device *dev, struct device_attribute *attr, char *buf)
 122 {
 123         struct usb_device *udev;
 124
 125         udev = to_usb_device(dev);
 126         return sprintf(buf, "%d\n", udev->bus->busnum);
 127 }
 128 static DEVICE_ATTR(busnum, S_IRUGO, show_busnum, NULL);
 129
 130 static ssize_t
 131 show_devnum(struct device *dev, struct device_attribute *attr, char *buf)
 132 {
 133         struct usb_device *udev;
 134
 135         udev = to_usb_device(dev);
 136         return sprintf(buf, "%d\n", udev->devnum);
 137 }
 138 static DEVICE_ATTR(devnum, S_IRUGO, show_devnum, NULL);
 139
 140 static ssize_t
 141 show_devpath(struct device *dev, struct device_attribute *attr, char *buf)
 142 {
 143         struct usb_device *udev;
 144
 145         udev = to_usb_device(dev);
 146         return sprintf(buf, "%s\n", udev->devpath);
 147 }
 148 static DEVICE_ATTR(devpath, S_IRUGO, show_devpath, NULL);
 149
 150 static ssize_t
 151 show_version(struct device *dev, struct device_attribute *attr, char *buf)
 152 {
 153         struct usb_device *udev;
 154         u16 bcdUSB;
 155
 156         udev = to_usb_device(dev);
 157         bcdUSB = le16_to_cpu(udev->descriptor.bcdUSB);
 158         return sprintf(buf, "%2x.%02x\n", bcdUSB >> 8, bcdUSB & 0xff);
 159 }
 160 static DEVICE_ATTR(version, S_IRUGO, show_version, NULL);
 161
 162 static ssize_t
 163 show_maxchild(struct device *dev, struct device_attribute *attr, char *buf)
 164 {
 165         struct usb_device *udev;
 166
 167         udev = to_usb_device(dev);
 168         return sprintf(buf, "%d\n", udev->maxchild);
 169 }
 170 static DEVICE_ATTR(maxchild, S_IRUGO, show_maxchild, NULL);
 171
 172 static ssize_t
 173 show_quirks(struct device *dev, struct device_attribute *attr, char *buf)
 174 {
 175         struct usb_device *udev;
 176
 177         udev = to_usb_device(dev);
 178         return sprintf(buf, "0x%x\n", udev->quirks);
 179 }
 180 static DEVICE_ATTR(quirks, S_IRUGO, show_quirks, NULL);
 181
 182 #ifdef  CONFIG_USB_SUSPEND
 183
 184 static ssize_t
 185 show_autosuspend(struct device *dev, struct device_attribute *attr, char *buf)
 186 {
 187         struct usb_device *udev = to_usb_device(dev);
 188
 189         return sprintf(buf, "%d\n", udev->autosuspend_delay / HZ);
 190 }
 191
 192 static ssize_t
 193 set_autosuspend(struct device *dev, struct device_attribute *attr,
 194                 const char *buf, size_t count)
 195 {
 196         struct usb_device *udev = to_usb_device(dev);
 197         int value;
 198
 199         if (sscanf(buf, "%d", &value) != 1 || value >= INT_MAX/HZ ||
 200                         value <= - INT_MAX/HZ)
 201                 return -EINVAL;
 202         value *= HZ;
 203
 204         udev->autosuspend_delay = value;
 205         if (value >= 0)
 206                 usb_try_autosuspend_device(udev);
 207         else {
 208                 if (usb_autoresume_device(udev) == 0)
 209                         usb_autosuspend_device(udev);
 210         }
 211         return count;
 212 }
 213
 214 static DEVICE_ATTR(autosuspend, S_IRUGO | S_IWUSR,
 215                 show_autosuspend, set_autosuspend);
 216
 217 static const char on_string[] = "on";
 218 static const char auto_string[] = "auto";
 219 static const char suspend_string[] = "suspend";
 220
 221 static ssize_t
 222 show_level(struct device *dev, struct device_attribute *attr, char *buf)
 223 {
 224         struct usb_device *udev = to_usb_device(dev);
 225         const char *p = auto_string;
 226
 227         if (udev->state == USB_STATE_SUSPENDED) {
 228                 if (udev->autoresume_disabled)
 229                         p = suspend_string;
 230         } else {
 231                 if (udev->autosuspend_disabled)
 232                         p = on_string;
 233         }
 234         return sprintf(buf, "%s\n", p);
 235 }
 236
 237 static ssize_t
 238 set_level(struct device *dev, struct device_attribute *attr,
 239                 const char *buf, size_t count)
 240 {
 241         struct usb_device *udev = to_usb_device(dev);
 242         int len = count;
 243         char *cp;
 244         int rc = 0;
 245         int old_autosuspend_disabled, old_autoresume_disabled;
 246
 247         cp = memchr(buf, '\n', count);
 248         if (cp)
 249                 len = cp - buf;
 250
 251         usb_lock_device(udev);
 252         old_autosuspend_disabled = udev->autosuspend_disabled;
 253         old_autoresume_disabled = udev->autoresume_disabled;
 254
 255         /* Setting the flags without calling usb_pm_lock is a subject to
 256          * races, but who cares...
 257          */
 258         if (len == sizeof on_string - 1 &&
 259                         strncmp(buf, on_string, len) == 0) {
 260                 udev->autosuspend_disabled = 1;
 261                 udev->autoresume_disabled = 0;
 262                 rc = usb_external_resume_device(udev);
 263
 264         } else if (len == sizeof auto_string - 1 &&
 265                         strncmp(buf, auto_string, len) == 0) {
 266                 udev->autosuspend_disabled = 0;
 267                 udev->autoresume_disabled = 0;
 268                 rc = usb_external_resume_device(udev);
 269
 270         } else if (len == sizeof suspend_string - 1 &&
 271                         strncmp(buf, suspend_string, len) == 0) {
 272                 udev->autosuspend_disabled = 0;
 273                 udev->autoresume_disabled = 1;
 274                 rc = usb_external_suspend_device(udev, PMSG_SUSPEND);
 275
 276         } else
 277                 rc = -EINVAL;
 278
 279         if (rc) {
 280                 udev->autosuspend_disabled = old_autosuspend_disabled;
 281                 udev->autoresume_disabled = old_autoresume_disabled;
 282         }
 283         usb_unlock_device(udev);
 284         return (rc < 0 ? rc : count);
 285 }
 286
 287 static DEVICE_ATTR(level, S_IRUGO | S_IWUSR, show_level, set_level);
 288
 289 static char power_group[] = "power";
 290
 291 static int add_power_attributes(struct device *dev)
 292 {
 293         int rc = 0;
 294
 295         if (is_usb_device(dev)) {
 296                 rc = sysfs_add_file_to_group(&dev->kobj,
 297                                 &dev_attr_autosuspend.attr,
 298                                 power_group);
 299                 if (rc == 0)
 300                         rc = sysfs_add_file_to_group(&dev->kobj,
 301                                         &dev_attr_level.attr,
 302                                         power_group);
 303         }
 304         return rc;
 305 }
 306
 307 static void remove_power_attributes(struct device *dev)
 308 {
 309         sysfs_remove_file_from_group(&dev->kobj,
 310                         &dev_attr_level.attr,
 311                         power_group);
 312         sysfs_remove_file_from_group(&dev->kobj,
 313                         &dev_attr_autosuspend.attr,
 314                         power_group);
 315 }
 316
 317 #else
 318
 319 #define add_power_attributes(dev)       0
 320 #define remove_power_attributes(dev)    do {} while (0)
 321
 322 #endif  /* CONFIG_USB_SUSPEND */
 323
 324 /* Descriptor fields */
 325 #define usb_descriptor_attr_le16(field, format_string)                  \
 326 static ssize_t                                                          \
 327 show_##field(struct device *dev, struct device_attribute *attr, \
 328                 char *buf)                                              \
 329 {                                                                       \
 330         struct usb_device *udev;                                        \
 331                                                                         \
 332         udev = to_usb_device(dev);                                      \
 333         return sprintf(buf, format_string,                              \
 334                         le16_to_cpu(udev->descriptor.field));           \
 335 }                                                                       \
 336 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
 337
 338 usb_descriptor_attr_le16(idVendor, "%04x\n")
 339 usb_descriptor_attr_le16(idProduct, "%04x\n")
 340 usb_descriptor_attr_le16(bcdDevice, "%04x\n")
 341
 342 #define usb_descriptor_attr(field, format_string)                       \
 343 static ssize_t                                                          \
 344 show_##field(struct device *dev, struct device_attribute *attr, \
 345                 char *buf)                                              \
 346 {                                                                       \
 347         struct usb_device *udev;                                        \
 348                                                                         \
 349         udev = to_usb_device(dev);                                      \
 350         return sprintf(buf, format_string, udev->descriptor.field);     \
 351 }                                                                       \
 352 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
 353
 354 usb_descriptor_attr(bDeviceClass, "%02x\n")
 355 usb_descriptor_attr(bDeviceSubClass, "%02x\n")
 356 usb_descriptor_attr(bDeviceProtocol, "%02x\n")
 357 usb_descriptor_attr(bNumConfigurations, "%d\n")
 358 usb_descriptor_attr(bMaxPacketSize0, "%d\n")
 359
 360 static struct attribute *dev_attrs[] = {
 361         /* current configuration's attributes */
 362         &dev_attr_configuration.attr,
 363         &dev_attr_bNumInterfaces.attr,
 364         &dev_attr_bConfigurationValue.attr,
 365         &dev_attr_bmAttributes.attr,
 366         &dev_attr_bMaxPower.attr,
 367         /* device attributes */
 368         &dev_attr_idVendor.attr,
 369         &dev_attr_idProduct.attr,
 370         &dev_attr_bcdDevice.attr,
 371         &dev_attr_bDeviceClass.attr,
 372         &dev_attr_bDeviceSubClass.attr,
 373         &dev_attr_bDeviceProtocol.attr,
 374         &dev_attr_bNumConfigurations.attr,
 375         &dev_attr_bMaxPacketSize0.attr,
 376         &dev_attr_speed.attr,
 377         &dev_attr_busnum.attr,
 378         &dev_attr_devnum.attr,
 379         &dev_attr_devpath.attr,
 380         &dev_attr_version.attr,
 381         &dev_attr_maxchild.attr,
 382         &dev_attr_quirks.attr,
 383         NULL,
 384 };
 385 static struct attribute_group dev_attr_grp = {
 386         .attrs = dev_attrs,
 387 };
 388
 389 int usb_create_sysfs_dev_files(struct usb_device *udev)
 390 {
 391         struct device *dev = &udev->dev;
 392         int retval;
 393
 394         retval = sysfs_create_group(&dev->kobj, &dev_attr_grp);
 395         if (retval)
 396                 return retval;
 397
 398         retval = add_power_attributes(dev);
 399         if (retval)
 400                 goto error;
 401
 402         if (udev->manufacturer) {
 403                 retval = device_create_file(dev, &dev_attr_manufacturer);
 404                 if (retval)
 405                         goto error;
 406         }
 407         if (udev->product) {
 408                 retval = device_create_file(dev, &dev_attr_product);
 409                 if (retval)
 410                         goto error;
 411         }
 412         if (udev->serial) {
 413                 retval = device_create_file(dev, &dev_attr_serial);
 414                 if (retval)
 415                         goto error;
 416         }
 417         retval = usb_create_ep_files(dev, &udev->ep0, udev);
 418         if (retval)
 419                 goto error;
 420         return 0;
 421 error:
 422         usb_remove_sysfs_dev_files(udev);
 423         return retval;
 424 }
 425
 426 void usb_remove_sysfs_dev_files(struct usb_device *udev)
 427 {
 428         struct device *dev = &udev->dev;
 429
 430         usb_remove_ep_files(&udev->ep0);
 431         device_remove_file(dev, &dev_attr_manufacturer);
 432         device_remove_file(dev, &dev_attr_product);
 433         device_remove_file(dev, &dev_attr_serial);
 434         remove_power_attributes(dev);
 435         sysfs_remove_group(&dev->kobj, &dev_attr_grp);
 436 }
 437
 438 /* Interface fields */
 439 #define usb_intf_attr(field, format_string)                             \
 440 static ssize_t                                                          \
 441 show_##field(struct device *dev, struct device_attribute *attr, \
 442                 char *buf)                                              \
 443 {                                                                       \
 444         struct usb_interface *intf = to_usb_interface(dev);             \
 445                                                                         \
 446         return sprintf(buf, format_string,                              \
 447                         intf->cur_altsetting->desc.field);              \
 448 }                                                                       \
 449 static DEVICE_ATTR(field, S_IRUGO, show_##field, NULL);
 450
 451 usb_intf_attr(bInterfaceNumber, "%02x\n")
 452 usb_intf_attr(bAlternateSetting, "%2d\n")
 453 usb_intf_attr(bNumEndpoints, "%02x\n")
 454 usb_intf_attr(bInterfaceClass, "%02x\n")
 455 usb_intf_attr(bInterfaceSubClass, "%02x\n")
 456 usb_intf_attr(bInterfaceProtocol, "%02x\n")
 457
 458 static ssize_t show_interface_string(struct device *dev,
 459                 struct device_attribute *attr, char *buf)
 460 {
 461         struct usb_interface *intf;
 462         struct usb_device *udev;
 463         int len;
 464
 465         intf = to_usb_interface(dev);
 466         udev = interface_to_usbdev(intf);
 467         len = snprintf(buf, 256, "%s", intf->cur_altsetting->string);
 468         if (len < 0)
 469                 return 0;
 470         buf[len] = '\n';
 471         buf[len+1] = 0;
 472         return len+1;
 473 }
 474 static DEVICE_ATTR(interface, S_IRUGO, show_interface_string, NULL);
 475
 476 static ssize_t show_modalias(struct device *dev,
 477                 struct device_attribute *attr, char *buf)
 478 {
 479         struct usb_interface *intf;
 480         struct usb_device *udev;
 481         struct usb_host_interface *alt;
 482
 483         intf = to_usb_interface(dev);
 484         udev = interface_to_usbdev(intf);
 485         alt = intf->cur_altsetting;
 486
 487         return sprintf(buf, "usb:v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02X"
 488                         "ic%02Xisc%02Xip%02X\n",
 489                         le16_to_cpu(udev->descriptor.idVendor),
 490                         le16_to_cpu(udev->descriptor.idProduct),
 491                         le16_to_cpu(udev->descriptor.bcdDevice),
 492                         udev->descriptor.bDeviceClass,
 493                         udev->descriptor.bDeviceSubClass,
 494                         udev->descriptor.bDeviceProtocol,
 495                         alt->desc.bInterfaceClass,
 496                         alt->desc.bInterfaceSubClass,
 497                         alt->desc.bInterfaceProtocol);
 498 }
 499 static DEVICE_ATTR(modalias, S_IRUGO, show_modalias, NULL);
 500
 501 static struct attribute *intf_attrs[] = {
 502         &dev_attr_bInterfaceNumber.attr,
 503         &dev_attr_bAlternateSetting.attr,
 504         &dev_attr_bNumEndpoints.attr,
 505         &dev_attr_bInterfaceClass.attr,
 506         &dev_attr_bInterfaceSubClass.attr,
 507         &dev_attr_bInterfaceProtocol.attr,
 508         &dev_attr_modalias.attr,
 509         NULL,
 510 };
 511 static struct attribute_group intf_attr_grp = {
 512         .attrs = intf_attrs,
 513 };
 514
 515 static inline void usb_create_intf_ep_files(struct usb_interface *intf,
 516                 struct usb_device *udev)
 517 {
 518         struct usb_host_interface *iface_desc;
 519         int i;
 520
 521         iface_desc = intf->cur_altsetting;
 522         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i)
 523                 usb_create_ep_files(&intf->dev, &iface_desc->endpoint[i],
 524                                 udev);
 525 }
 526
 527 static inline void usb_remove_intf_ep_files(struct usb_interface *intf)
 528 {
 529         struct usb_host_interface *iface_desc;
 530         int i;
 531
 532         iface_desc = intf->cur_altsetting;
 533         for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i)
 534                 usb_remove_ep_files(&iface_desc->endpoint[i]);
 535 }
 536
 537 int usb_create_sysfs_intf_files(struct usb_interface *intf)
 538 {
 539         struct device *dev = &intf->dev;
 540         struct usb_device *udev = interface_to_usbdev(intf);
 541         struct usb_host_interface *alt = intf->cur_altsetting;
 542         int retval;
 543
 544         retval = sysfs_create_group(&dev->kobj, &intf_attr_grp);
 545         if (retval)
 546                 return retval;
 547
 548         if (alt->string == NULL)
 549                 alt->string = usb_cache_string(udev, alt->desc.iInterface);
 550         if (alt->string)
 551                 retval = device_create_file(dev, &dev_attr_interface);
 552         usb_create_intf_ep_files(intf, udev);
 553         return 0;
 554 }
 555
 556 void usb_remove_sysfs_intf_files(struct usb_interface *intf)
 557 {
 558         struct device *dev = &intf->dev;
 559
 560         usb_remove_intf_ep_files(intf);
 561         device_remove_file(dev, &dev_attr_interface);
 562         sysfs_remove_group(&dev->kobj, &intf_attr_grp);
 563 }