drivers/pci/pci-sysfs.c

   1 /*
   2  * drivers/pci/pci-sysfs.c
   3  *
   4  * (C) Copyright 2002-2004 Greg Kroah-Hartman <greg@kroah.com>
   5  * (C) Copyright 2002-2004 IBM Corp.
   6  * (C) Copyright 2003 Matthew Wilcox
   7  * (C) Copyright 2003 Hewlett-Packard
   8  * (C) Copyright 2004 Jon Smirl <jonsmirl@yahoo.com>
   9  * (C) Copyright 2004 Silicon Graphics, Inc. Jesse Barnes <jbarnes@sgi.com>
  10  *
  11  * File attributes for PCI devices
  12  *
  13  * Modeled after usb's driverfs.c
  14  *
  15  */
  16
  17
  18 #include <linux/kernel.h>
  19 #include <linux/sched.h>
  20 #include <linux/pci.h>
  21 #include <linux/stat.h>
  22 #include <linux/topology.h>
  23 #include <linux/mm.h>
  24 #include <linux/fs.h>
  25 #include <linux/capability.h>
  26 #include <linux/security.h>
  27 #include <linux/pci-aspm.h>
  28 #include <linux/slab.h>
  29 #include "pci.h"
  30
  31 static int sysfs_initialized;   /* = 0 */
  32
  33 /* show configuration fields */
  34 #define pci_config_attr(field, format_string)                           \
  35 static ssize_t                                                          \
  36 field##_show(struct device *dev, struct device_attribute *attr, char *buf)                              \
  37 {                                                                       \
  38         struct pci_dev *pdev;                                           \
  39                                                                         \
  40         pdev = to_pci_dev (dev);                                        \
  41         return sprintf (buf, format_string, pdev->field);               \
  42 }
  43
  44 pci_config_attr(vendor, "0x%04x\n");
  45 pci_config_attr(device, "0x%04x\n");
  46 pci_config_attr(subsystem_vendor, "0x%04x\n");
  47 pci_config_attr(subsystem_device, "0x%04x\n");
  48 pci_config_attr(class, "0x%06x\n");
  49 pci_config_attr(irq, "%u\n");
  50
  51 static ssize_t broken_parity_status_show(struct device *dev,
  52                                          struct device_attribute *attr,
  53                                          char *buf)
  54 {
  55         struct pci_dev *pdev = to_pci_dev(dev);
  56         return sprintf (buf, "%u\n", pdev->broken_parity_status);
  57 }
  58
  59 static ssize_t broken_parity_status_store(struct device *dev,
  60                                           struct device_attribute *attr,
  61                                           const char *buf, size_t count)
  62 {
  63         struct pci_dev *pdev = to_pci_dev(dev);
  64         unsigned long val;
  65
  66         if (strict_strtoul(buf, 0, &val) < 0)
  67                 return -EINVAL;
  68
  69         pdev->broken_parity_status = !!val;
  70
  71         return count;
  72 }
  73
  74 static ssize_t local_cpus_show(struct device *dev,
  75                         struct device_attribute *attr, char *buf)
  76 {
  77         const struct cpumask *mask;
  78         int len;
  79
  80 #ifdef CONFIG_NUMA
  81         mask = (dev_to_node(dev) == -1) ? cpu_online_mask :
  82                                           cpumask_of_node(dev_to_node(dev));
  83 #else
  84         mask = cpumask_of_pcibus(to_pci_dev(dev)->bus);
  85 #endif
  86         len = cpumask_scnprintf(buf, PAGE_SIZE-2, mask);
  87         buf[len++] = '\n';
  88         buf[len] = '\0';
  89         return len;
  90 }
  91
  92
  93 static ssize_t local_cpulist_show(struct device *dev,
  94                         struct device_attribute *attr, char *buf)
  95 {
  96         const struct cpumask *mask;
  97         int len;
  98
  99 #ifdef CONFIG_NUMA
 100         mask = (dev_to_node(dev) == -1) ? cpu_online_mask :
 101                                           cpumask_of_node(dev_to_node(dev));
 102 #else
 103         mask = cpumask_of_pcibus(to_pci_dev(dev)->bus);
 104 #endif
 105         len = cpulist_scnprintf(buf, PAGE_SIZE-2, mask);
 106         buf[len++] = '\n';
 107         buf[len] = '\0';
 108         return len;
 109 }
 110
 111 /* show resources */
 112 static ssize_t
 113 resource_show(struct device * dev, struct device_attribute *attr, char * buf)
 114 {
 115         struct pci_dev * pci_dev = to_pci_dev(dev);
 116         char * str = buf;
 117         int i;
 118         int max;
 119         resource_size_t start, end;
 120
 121         if (pci_dev->subordinate)
 122                 max = DEVICE_COUNT_RESOURCE;
 123         else
 124                 max = PCI_BRIDGE_RESOURCES;
 125
 126         for (i = 0; i < max; i++) {
 127                 struct resource *res =  &pci_dev->resource[i];
 128                 pci_resource_to_user(pci_dev, i, res, &start, &end);
 129                 str += sprintf(str,"0x%016llx 0x%016llx 0x%016llx\n",
 130                                (unsigned long long)start,
 131                                (unsigned long long)end,
 132                                (unsigned long long)res->flags);
 133         }
 134         return (str - buf);
 135 }
 136
 137 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
 138 {
 139         struct pci_dev *pci_dev = to_pci_dev(dev);
 140
 141         return sprintf(buf, "pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02x\n",
 142                        pci_dev->vendor, pci_dev->device,
 143                        pci_dev->subsystem_vendor, pci_dev->subsystem_device,
 144                        (u8)(pci_dev->class >> 16), (u8)(pci_dev->class >> 8),
 145                        (u8)(pci_dev->class));
 146 }
 147
 148 static ssize_t is_enabled_store(struct device *dev,
 149                                 struct device_attribute *attr, const char *buf,
 150                                 size_t count)
 151 {
 152         struct pci_dev *pdev = to_pci_dev(dev);
 153         unsigned long val;
 154         ssize_t result = strict_strtoul(buf, 0, &val);
 155
 156         if (result < 0)
 157                 return result;
 158
 159         /* this can crash the machine when done on the "wrong" device */
 160         if (!capable(CAP_SYS_ADMIN))
 161                 return -EPERM;
 162
 163         if (!val) {
 164                 if (pci_is_enabled(pdev))
 165                         pci_disable_device(pdev);
 166                 else
 167                         result = -EIO;
 168         } else
 169                 result = pci_enable_device(pdev);
 170
 171         return result < 0 ? result : count;
 172 }
 173
 174 static ssize_t is_enabled_show(struct device *dev,
 175                                struct device_attribute *attr, char *buf)
 176 {
 177         struct pci_dev *pdev;
 178
 179         pdev = to_pci_dev (dev);
 180         return sprintf (buf, "%u\n", atomic_read(&pdev->enable_cnt));
 181 }
 182
 183 #ifdef CONFIG_NUMA
 184 static ssize_t
 185 numa_node_show(struct device *dev, struct device_attribute *attr, char *buf)
 186 {
 187         return sprintf (buf, "%d\n", dev->numa_node);
 188 }
 189 #endif
 190
 191 static ssize_t
 192 dma_mask_bits_show(struct device *dev, struct device_attribute *attr, char *buf)
 193 {
 194         struct pci_dev *pdev = to_pci_dev(dev);
 195
 196         return sprintf (buf, "%d\n", fls64(pdev->dma_mask));
 197 }
 198
 199 static ssize_t
 200 consistent_dma_mask_bits_show(struct device *dev, struct device_attribute *attr,
 201                                  char *buf)
 202 {
 203         return sprintf (buf, "%d\n", fls64(dev->coherent_dma_mask));
 204 }
 205
 206 static ssize_t
 207 msi_bus_show(struct device *dev, struct device_attribute *attr, char *buf)
 208 {
 209         struct pci_dev *pdev = to_pci_dev(dev);
 210
 211         if (!pdev->subordinate)
 212                 return 0;
 213
 214         return sprintf (buf, "%u\n",
 215                         !(pdev->subordinate->bus_flags & PCI_BUS_FLAGS_NO_MSI));
 216 }
 217
 218 static ssize_t
 219 msi_bus_store(struct device *dev, struct device_attribute *attr,
 220               const char *buf, size_t count)
 221 {
 222         struct pci_dev *pdev = to_pci_dev(dev);
 223         unsigned long val;
 224
 225         if (strict_strtoul(buf, 0, &val) < 0)
 226                 return -EINVAL;
 227
 228         /* bad things may happen if the no_msi flag is changed
 229          * while some drivers are loaded */
 230         if (!capable(CAP_SYS_ADMIN))
 231                 return -EPERM;
 232
 233         /* Maybe pci devices without subordinate busses shouldn't even have this
 234          * attribute in the first place?  */
 235         if (!pdev->subordinate)
 236                 return count;
 237
 238         /* Is the flag going to change, or keep the value it already had? */
 239         if (!(pdev->subordinate->bus_flags & PCI_BUS_FLAGS_NO_MSI) ^
 240             !!val) {
 241                 pdev->subordinate->bus_flags ^= PCI_BUS_FLAGS_NO_MSI;
 242
 243                 dev_warn(&pdev->dev, "forced subordinate bus to%s support MSI,"
 244                          " bad things could happen\n", val ? "" : " not");
 245         }
 246
 247         return count;
 248 }
 249
 250 #ifdef CONFIG_HOTPLUG
 251 static DEFINE_MUTEX(pci_remove_rescan_mutex);
 252 static ssize_t bus_rescan_store(struct bus_type *bus, const char *buf,
 253                                 size_t count)
 254 {
 255         unsigned long val;
 256         struct pci_bus *b = NULL;
 257
 258         if (strict_strtoul(buf, 0, &val) < 0)
 259                 return -EINVAL;
 260
 261         if (val) {
 262                 mutex_lock(&pci_remove_rescan_mutex);
 263                 while ((b = pci_find_next_bus(b)) != NULL)
 264                         pci_rescan_bus(b);
 265                 mutex_unlock(&pci_remove_rescan_mutex);
 266         }
 267         return count;
 268 }
 269
 270 struct bus_attribute pci_bus_attrs[] = {
 271         __ATTR(rescan, (S_IWUSR|S_IWGRP), NULL, bus_rescan_store),
 272         __ATTR_NULL
 273 };
 274
 275 static ssize_t
 276 dev_rescan_store(struct device *dev, struct device_attribute *attr,
 277                  const char *buf, size_t count)
 278 {
 279         unsigned long val;
 280         struct pci_dev *pdev = to_pci_dev(dev);
 281
 282         if (strict_strtoul(buf, 0, &val) < 0)
 283                 return -EINVAL;
 284
 285         if (val) {
 286                 mutex_lock(&pci_remove_rescan_mutex);
 287                 pci_rescan_bus(pdev->bus);
 288                 mutex_unlock(&pci_remove_rescan_mutex);
 289         }
 290         return count;
 291 }
 292
 293 static void remove_callback(struct device *dev)
 294 {
 295         struct pci_dev *pdev = to_pci_dev(dev);
 296
 297         mutex_lock(&pci_remove_rescan_mutex);
 298         pci_remove_bus_device(pdev);
 299         mutex_unlock(&pci_remove_rescan_mutex);
 300 }
 301
 302 static ssize_t
 303 remove_store(struct device *dev, struct device_attribute *dummy,
 304              const char *buf, size_t count)
 305 {
 306         int ret = 0;
 307         unsigned long val;
 308
 309         if (strict_strtoul(buf, 0, &val) < 0)
 310                 return -EINVAL;
 311
 312         /* An attribute cannot be unregistered by one of its own methods,
 313          * so we have to use this roundabout approach.
 314          */
 315         if (val)
 316                 ret = device_schedule_callback(dev, remove_callback);
 317         if (ret)
 318                 count = ret;
 319         return count;
 320 }
 321
 322 static ssize_t
 323 dev_bus_rescan_store(struct device *dev, struct device_attribute *attr,
 324                  const char *buf, size_t count)
 325 {
 326         unsigned long val;
 327         struct pci_bus *bus = to_pci_bus(dev);
 328
 329         if (strict_strtoul(buf, 0, &val) < 0)
 330                 return -EINVAL;
 331
 332         if (val) {
 333                 mutex_lock(&pci_remove_rescan_mutex);
 334                 pci_rescan_bus(bus);
 335                 mutex_unlock(&pci_remove_rescan_mutex);
 336         }
 337         return count;
 338 }
 339
 340 #endif
 341
 342 struct device_attribute pci_dev_attrs[] = {
 343         __ATTR_RO(resource),
 344         __ATTR_RO(vendor),
 345         __ATTR_RO(device),
 346         __ATTR_RO(subsystem_vendor),
 347         __ATTR_RO(subsystem_device),
 348         __ATTR_RO(class),
 349         __ATTR_RO(irq),
 350         __ATTR_RO(local_cpus),
 351         __ATTR_RO(local_cpulist),
 352         __ATTR_RO(modalias),
 353 #ifdef CONFIG_NUMA
 354         __ATTR_RO(numa_node),
 355 #endif
 356         __ATTR_RO(dma_mask_bits),
 357         __ATTR_RO(consistent_dma_mask_bits),
 358         __ATTR(enable, 0600, is_enabled_show, is_enabled_store),
 359         __ATTR(broken_parity_status,(S_IRUGO|S_IWUSR),
 360                 broken_parity_status_show,broken_parity_status_store),
 361         __ATTR(msi_bus, 0644, msi_bus_show, msi_bus_store),
 362 #ifdef CONFIG_HOTPLUG
 363         __ATTR(remove, (S_IWUSR|S_IWGRP), NULL, remove_store),
 364         __ATTR(rescan, (S_IWUSR|S_IWGRP), NULL, dev_rescan_store),
 365 #endif
 366         __ATTR_NULL,
 367 };
 368
 369 struct device_attribute pcibus_dev_attrs[] = {
 370 #ifdef CONFIG_HOTPLUG
 371         __ATTR(rescan, (S_IWUSR|S_IWGRP), NULL, dev_bus_rescan_store),
 372 #endif
 373         __ATTR_NULL,
 374 };
 375
 376 static ssize_t
 377 boot_vga_show(struct device *dev, struct device_attribute *attr, char *buf)
 378 {
 379         struct pci_dev *pdev = to_pci_dev(dev);
 380
 381         return sprintf(buf, "%u\n",
 382                 !!(pdev->resource[PCI_ROM_RESOURCE].flags &
 383                    IORESOURCE_ROM_SHADOW));
 384 }
 385 struct device_attribute vga_attr = __ATTR_RO(boot_vga);
 386
 387 static ssize_t
 388 pci_read_config(struct file *filp, struct kobject *kobj,
 389                 struct bin_attribute *bin_attr,
 390                 char *buf, loff_t off, size_t count)
 391 {
 392         struct pci_dev *dev = to_pci_dev(container_of(kobj,struct device,kobj));
 393         unsigned int size = 64;
 394         loff_t init_off = off;
 395         u8 *data = (u8*) buf;
 396
 397         /* Several chips lock up trying to read undefined config space */
 398         if (security_capable(&init_user_ns, filp->f_cred, CAP_SYS_ADMIN) == 0) {
 399                 size = dev->cfg_size;
 400         } else if (dev->hdr_type == PCI_HEADER_TYPE_CARDBUS) {
 401                 size = 128;
 402         }
 403
 404         if (off > size)
 405                 return 0;
 406         if (off + count > size) {
 407                 size -= off;
 408                 count = size;
 409         } else {
 410                 size = count;
 411         }
 412
 413         if ((off & 1) && size) {
 414                 u8 val;
 415                 pci_user_read_config_byte(dev, off, &val);
 416                 data[off - init_off] = val;
 417                 off++;
 418                 size--;
 419         }
 420
 421         if ((off & 3) && size > 2) {
 422                 u16 val;
 423                 pci_user_read_config_word(dev, off, &val);
 424                 data[off - init_off] = val & 0xff;
 425                 data[off - init_off + 1] = (val >> 8) & 0xff;
 426                 off += 2;
 427                 size -= 2;
 428         }
 429
 430         while (size > 3) {
 431                 u32 val;
 432                 pci_user_read_config_dword(dev, off, &val);
 433                 data[off - init_off] = val & 0xff;
 434                 data[off - init_off + 1] = (val >> 8) & 0xff;
 435                 data[off - init_off + 2] = (val >> 16) & 0xff;
 436                 data[off - init_off + 3] = (val >> 24) & 0xff;
 437                 off += 4;
 438                 size -= 4;
 439         }
 440
 441         if (size >= 2) {
 442                 u16 val;
 443                 pci_user_read_config_word(dev, off, &val);
 444                 data[off - init_off] = val & 0xff;
 445                 data[off - init_off + 1] = (val >> 8) & 0xff;
 446                 off += 2;
 447                 size -= 2;
 448         }
 449
 450         if (size > 0) {
 451                 u8 val;
 452                 pci_user_read_config_byte(dev, off, &val);
 453                 data[off - init_off] = val;
 454                 off++;
 455                 --size;
 456         }
 457
 458         return count;
 459 }
 460
 461 static ssize_t
 462 pci_write_config(struct file* filp, struct kobject *kobj,
 463                  struct bin_attribute *bin_attr,
 464                  char *buf, loff_t off, size_t count)
 465 {
 466         struct pci_dev *dev = to_pci_dev(container_of(kobj,struct device,kobj));
 467         unsigned int size = count;
 468         loff_t init_off = off;
 469         u8 *data = (u8*) buf;
 470
 471         if (off > dev->cfg_size)
 472                 return 0;
 473         if (off + count > dev->cfg_size) {
 474                 size = dev->cfg_size - off;
 475                 count = size;
 476         }
 477
 478         if ((off & 1) && size) {
 479                 pci_user_write_config_byte(dev, off, data[off - init_off]);
 480                 off++;
 481                 size--;
 482         }
 483
 484         if ((off & 3) && size > 2) {
 485                 u16 val = data[off - init_off];
 486                 val |= (u16) data[off - init_off + 1] << 8;
 487                 pci_user_write_config_word(dev, off, val);
 488                 off += 2;
 489                 size -= 2;
 490         }
 491
 492         while (size > 3) {
 493                 u32 val = data[off - init_off];
 494                 val |= (u32) data[off - init_off + 1] << 8;
 495                 val |= (u32) data[off - init_off + 2] << 16;
 496                 val |= (u32) data[off - init_off + 3] << 24;
 497                 pci_user_write_config_dword(dev, off, val);
 498                 off += 4;
 499                 size -= 4;
 500         }
 501
 502         if (size >= 2) {
 503                 u16 val = data[off - init_off];
 504                 val |= (u16) data[off - init_off + 1] << 8;
 505                 pci_user_write_config_word(dev, off, val);
 506                 off += 2;
 507                 size -= 2;
 508         }
 509
 510         if (size) {
 511                 pci_user_write_config_byte(dev, off, data[off - init_off]);
 512                 off++;
 513                 --size;
 514         }
 515
 516         return count;
 517 }
 518
 519 static ssize_t
 520 read_vpd_attr(struct file *filp, struct kobject *kobj,
 521               struct bin_attribute *bin_attr,
 522               char *buf, loff_t off, size_t count)
 523 {
 524         struct pci_dev *dev =
 525                 to_pci_dev(container_of(kobj, struct device, kobj));
 526
 527         if (off > bin_attr->size)
 528                 count = 0;
 529         else if (count > bin_attr->size - off)
 530                 count = bin_attr->size - off;
 531
 532         return pci_read_vpd(dev, off, count, buf);
 533 }
 534
 535 static ssize_t
 536 write_vpd_attr(struct file *filp, struct kobject *kobj,
 537                struct bin_attribute *bin_attr,
 538                char *buf, loff_t off, size_t count)
 539 {
 540         struct pci_dev *dev =
 541                 to_pci_dev(container_of(kobj, struct device, kobj));
 542
 543         if (off > bin_attr->size)
 544                 count = 0;
 545         else if (count > bin_attr->size - off)
 546                 count = bin_attr->size - off;
 547
 548         return pci_write_vpd(dev, off, count, buf);
 549 }
 550
 551 #ifdef HAVE_PCI_LEGACY
 552 /**
 553  * pci_read_legacy_io - read byte(s) from legacy I/O port space
 554  * @filp: open sysfs file
 555  * @kobj: kobject corresponding to file to read from
 556  * @bin_attr: struct bin_attribute for this file
 557  * @buf: buffer to store results
 558  * @off: offset into legacy I/O port space
 559  * @count: number of bytes to read
 560  *
 561  * Reads 1, 2, or 4 bytes from legacy I/O port space using an arch specific
 562  * callback routine (pci_legacy_read).
 563  */
 564 static ssize_t
 565 pci_read_legacy_io(struct file *filp, struct kobject *kobj,
 566                    struct bin_attribute *bin_attr,
 567                    char *buf, loff_t off, size_t count)
 568 {
 569         struct pci_bus *bus = to_pci_bus(container_of(kobj,
 570                                                       struct device,
 571                                                       kobj));
 572
 573         /* Only support 1, 2 or 4 byte accesses */
 574         if (count != 1 && count != 2 && count != 4)
 575                 return -EINVAL;
 576
 577         return pci_legacy_read(bus, off, (u32 *)buf, count);
 578 }
 579
 580 /**
 581  * pci_write_legacy_io - write byte(s) to legacy I/O port space
 582  * @filp: open sysfs file
 583  * @kobj: kobject corresponding to file to read from
 584  * @bin_attr: struct bin_attribute for this file
 585  * @buf: buffer containing value to be written
 586  * @off: offset into legacy I/O port space
 587  * @count: number of bytes to write
 588  *
 589  * Writes 1, 2, or 4 bytes from legacy I/O port space using an arch specific
 590  * callback routine (pci_legacy_write).
 591  */
 592 static ssize_t
 593 pci_write_legacy_io(struct file *filp, struct kobject *kobj,
 594                     struct bin_attribute *bin_attr,
 595                     char *buf, loff_t off, size_t count)
 596 {
 597         struct pci_bus *bus = to_pci_bus(container_of(kobj,
 598                                                       struct device,
 599                                                       kobj));
 600         /* Only support 1, 2 or 4 byte accesses */
 601         if (count != 1 && count != 2 && count != 4)
 602                 return -EINVAL;
 603
 604         return pci_legacy_write(bus, off, *(u32 *)buf, count);
 605 }
 606
 607 /**
 608  * pci_mmap_legacy_mem - map legacy PCI memory into user memory space
 609  * @filp: open sysfs file
 610  * @kobj: kobject corresponding to device to be mapped
 611  * @attr: struct bin_attribute for this file
 612  * @vma: struct vm_area_struct passed to mmap
 613  *
 614  * Uses an arch specific callback, pci_mmap_legacy_mem_page_range, to mmap
 615  * legacy memory space (first meg of bus space) into application virtual
 616  * memory space.
 617  */
 618 static int
 619 pci_mmap_legacy_mem(struct file *filp, struct kobject *kobj,
 620                     struct bin_attribute *attr,
 621                     struct vm_area_struct *vma)
 622 {
 623         struct pci_bus *bus = to_pci_bus(container_of(kobj,
 624                                                       struct device,
 625                                                       kobj));
 626
 627         return pci_mmap_legacy_page_range(bus, vma, pci_mmap_mem);
 628 }
 629
 630 /**
 631  * pci_mmap_legacy_io - map legacy PCI IO into user memory space
 632  * @filp: open sysfs file
 633  * @kobj: kobject corresponding to device to be mapped
 634  * @attr: struct bin_attribute for this file
 635  * @vma: struct vm_area_struct passed to mmap
 636  *
 637  * Uses an arch specific callback, pci_mmap_legacy_io_page_range, to mmap
 638  * legacy IO space (first meg of bus space) into application virtual
 639  * memory space. Returns -ENOSYS if the operation isn't supported
 640  */
 641 static int
 642 pci_mmap_legacy_io(struct file *filp, struct kobject *kobj,
 643                    struct bin_attribute *attr,
 644                    struct vm_area_struct *vma)
 645 {
 646         struct pci_bus *bus = to_pci_bus(container_of(kobj,
 647                                                       struct device,
 648                                                       kobj));
 649
 650         return pci_mmap_legacy_page_range(bus, vma, pci_mmap_io);
 651 }
 652
 653 /**
 654  * pci_adjust_legacy_attr - adjustment of legacy file attributes
 655  * @b: bus to create files under
 656  * @mmap_type: I/O port or memory
 657  *
 658  * Stub implementation. Can be overridden by arch if necessary.
 659  */
 660 void __weak
 661 pci_adjust_legacy_attr(struct pci_bus *b, enum pci_mmap_state mmap_type)
 662 {
 663         return;
 664 }
 665
 666 /**
 667  * pci_create_legacy_files - create legacy I/O port and memory files
 668  * @b: bus to create files under
 669  *
 670  * Some platforms allow access to legacy I/O port and ISA memory space on
 671  * a per-bus basis.  This routine creates the files and ties them into
 672  * their associated read, write and mmap files from pci-sysfs.c
 673  *
 674  * On error unwind, but don't propagate the error to the caller
 675  * as it is ok to set up the PCI bus without these files.
 676  */
 677 void pci_create_legacy_files(struct pci_bus *b)
 678 {
 679         int error;
 680
 681         b->legacy_io = kzalloc(sizeof(struct bin_attribute) * 2,
 682                                GFP_ATOMIC);
 683         if (!b->legacy_io)
 684                 goto kzalloc_err;
 685
 686         sysfs_bin_attr_init(b->legacy_io);
 687         b->legacy_io->attr.name = "legacy_io";
 688         b->legacy_io->size = 0xffff;
 689         b->legacy_io->attr.mode = S_IRUSR | S_IWUSR;
 690         b->legacy_io->read = pci_read_legacy_io;
 691         b->legacy_io->write = pci_write_legacy_io;
 692         b->legacy_io->mmap = pci_mmap_legacy_io;
 693         pci_adjust_legacy_attr(b, pci_mmap_io);
 694         error = device_create_bin_file(&b->dev, b->legacy_io);
 695         if (error)
 696                 goto legacy_io_err;
 697
 698         /* Allocated above after the legacy_io struct */
 699         b->legacy_mem = b->legacy_io + 1;
 700         sysfs_bin_attr_init(b->legacy_mem);
 701         b->legacy_mem->attr.name = "legacy_mem";
 702         b->legacy_mem->size = 1024*1024;
 703         b->legacy_mem->attr.mode = S_IRUSR | S_IWUSR;
 704         b->legacy_mem->mmap = pci_mmap_legacy_mem;
 705         pci_adjust_legacy_attr(b, pci_mmap_mem);
 706         error = device_create_bin_file(&b->dev, b->legacy_mem);
 707         if (error)
 708                 goto legacy_mem_err;
 709
 710         return;
 711
 712 legacy_mem_err:
 713         device_remove_bin_file(&b->dev, b->legacy_io);
 714 legacy_io_err:
 715         kfree(b->legacy_io);
 716         b->legacy_io = NULL;
 717 kzalloc_err:
 718         printk(KERN_WARNING "pci: warning: could not create legacy I/O port "
 719                "and ISA memory resources to sysfs\n");
 720         return;
 721 }
 722
 723 void pci_remove_legacy_files(struct pci_bus *b)
 724 {
 725         if (b->legacy_io) {
 726                 device_remove_bin_file(&b->dev, b->legacy_io);
 727                 device_remove_bin_file(&b->dev, b->legacy_mem);
 728                 kfree(b->legacy_io); /* both are allocated here */
 729         }
 730 }
 731 #endif /* HAVE_PCI_LEGACY */
 732
 733 #ifdef HAVE_PCI_MMAP
 734
 735 int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vma,
 736                   enum pci_mmap_api mmap_api)
 737 {
 738         unsigned long nr, start, size, pci_start;
 739
 740         if (pci_resource_len(pdev, resno) == 0)
 741                 return 0;
 742         nr = (vma->vm_end - vma->vm_start) >> PAGE_SHIFT;
 743         start = vma->vm_pgoff;
 744         size = ((pci_resource_len(pdev, resno) - 1) >> PAGE_SHIFT) + 1;
 745         pci_start = (mmap_api == PCI_MMAP_PROCFS) ?
 746                         pci_resource_start(pdev, resno) >> PAGE_SHIFT : 0;
 747         if (start >= pci_start && start < pci_start + size &&
 748                         start + nr <= pci_start + size)
 749                 return 1;
 750         return 0;
 751 }
 752
 753 /**
 754  * pci_mmap_resource - map a PCI resource into user memory space
 755  * @kobj: kobject for mapping
 756  * @attr: struct bin_attribute for the file being mapped
 757  * @vma: struct vm_area_struct passed into the mmap
 758  * @write_combine: 1 for write_combine mapping
 759  *
 760  * Use the regular PCI mapping routines to map a PCI resource into userspace.
 761  */
 762 static int
 763 pci_mmap_resource(struct kobject *kobj, struct bin_attribute *attr,
 764                   struct vm_area_struct *vma, int write_combine)
 765 {
 766         struct pci_dev *pdev = to_pci_dev(container_of(kobj,
 767                                                        struct device, kobj));
 768         struct resource *res = attr->private;
 769         enum pci_mmap_state mmap_type;
 770         resource_size_t start, end;
 771         int i;
 772
 773         for (i = 0; i < PCI_ROM_RESOURCE; i++)
 774                 if (res == &pdev->resource[i])
 775                         break;
 776         if (i >= PCI_ROM_RESOURCE)
 777                 return -ENODEV;
 778
 779         if (!pci_mmap_fits(pdev, i, vma, PCI_MMAP_SYSFS)) {
 780                 WARN(1, "process \"%s\" tried to map 0x%08lx bytes "
 781                         "at page 0x%08lx on %s BAR %d (start 0x%16Lx, size 0x%16Lx)\n",
 782                         current->comm, vma->vm_end-vma->vm_start, vma->vm_pgoff,
 783                         pci_name(pdev), i,
 784                         (u64)pci_resource_start(pdev, i),
 785                         (u64)pci_resource_len(pdev, i));
 786                 return -EINVAL;
 787         }
 788
 789         /* pci_mmap_page_range() expects the same kind of entry as coming
 790          * from /proc/bus/pci/ which is a "user visible" value. If this is
 791          * different from the resource itself, arch will do necessary fixup.
 792          */
 793         pci_resource_to_user(pdev, i, res, &start, &end);
 794         vma->vm_pgoff += start >> PAGE_SHIFT;
 795         mmap_type = res->flags & IORESOURCE_MEM ? pci_mmap_mem : pci_mmap_io;
 796
 797         if (res->flags & IORESOURCE_MEM && iomem_is_exclusive(start))
 798                 return -EINVAL;
 799
 800         return pci_mmap_page_range(pdev, vma, mmap_type, write_combine);
 801 }
 802
 803 static int
 804 pci_mmap_resource_uc(struct file *filp, struct kobject *kobj,
 805                      struct bin_attribute *attr,
 806                      struct vm_area_struct *vma)
 807 {
 808         return pci_mmap_resource(kobj, attr, vma, 0);
 809 }
 810
 811 static int
 812 pci_mmap_resource_wc(struct file *filp, struct kobject *kobj,
 813                      struct bin_attribute *attr,
 814                      struct vm_area_struct *vma)
 815 {
 816         return pci_mmap_resource(kobj, attr, vma, 1);
 817 }
 818
 819 static ssize_t
 820 pci_resource_io(struct file *filp, struct kobject *kobj,
 821                 struct bin_attribute *attr, char *buf,
 822                 loff_t off, size_t count, bool write)
 823 {
 824         struct pci_dev *pdev = to_pci_dev(container_of(kobj,
 825                                                        struct device, kobj));
 826         struct resource *res = attr->private;
 827         unsigned long port = off;
 828         int i;
 829
 830         for (i = 0; i < PCI_ROM_RESOURCE; i++)
 831                 if (res == &pdev->resource[i])
 832                         break;
 833         if (i >= PCI_ROM_RESOURCE)
 834                 return -ENODEV;
 835
 836         port += pci_resource_start(pdev, i);
 837
 838         if (port > pci_resource_end(pdev, i))
 839                 return 0;
 840
 841         if (port + count - 1 > pci_resource_end(pdev, i))
 842                 return -EINVAL;
 843
 844         switch (count) {
 845         case 1:
 846                 if (write)
 847                         outb(*(u8 *)buf, port);
 848                 else
 849                         *(u8 *)buf = inb(port);
 850                 return 1;
 851         case 2:
 852                 if (write)
 853                         outw(*(u16 *)buf, port);
 854                 else
 855                         *(u16 *)buf = inw(port);
 856                 return 2;
 857         case 4:
 858                 if (write)
 859                         outl(*(u32 *)buf, port);
 860                 else
 861                         *(u32 *)buf = inl(port);
 862                 return 4;
 863         }
 864         return -EINVAL;
 865 }
 866
 867 static ssize_t
 868 pci_read_resource_io(struct file *filp, struct kobject *kobj,
 869                      struct bin_attribute *attr, char *buf,
 870                      loff_t off, size_t count)
 871 {
 872         return pci_resource_io(filp, kobj, attr, buf, off, count, false);
 873 }
 874
 875 static ssize_t
 876 pci_write_resource_io(struct file *filp, struct kobject *kobj,
 877                       struct bin_attribute *attr, char *buf,
 878                       loff_t off, size_t count)
 879 {
 880         return pci_resource_io(filp, kobj, attr, buf, off, count, true);
 881 }
 882
 883 /**
 884  * pci_remove_resource_files - cleanup resource files
 885  * @pdev: dev to cleanup
 886  *
 887  * If we created resource files for @pdev, remove them from sysfs and
 888  * free their resources.
 889  */
 890 static void
 891 pci_remove_resource_files(struct pci_dev *pdev)
 892 {
 893         int i;
 894
 895         for (i = 0; i < PCI_ROM_RESOURCE; i++) {
 896                 struct bin_attribute *res_attr;
 897
 898                 res_attr = pdev->res_attr[i];
 899                 if (res_attr) {
 900                         sysfs_remove_bin_file(&pdev->dev.kobj, res_attr);
 901                         kfree(res_attr);
 902                 }
 903
 904                 res_attr = pdev->res_attr_wc[i];
 905                 if (res_attr) {
 906                         sysfs_remove_bin_file(&pdev->dev.kobj, res_attr);
 907                         kfree(res_attr);
 908                 }
 909         }
 910 }
 911
 912 static int pci_create_attr(struct pci_dev *pdev, int num, int write_combine)
 913 {
 914         /* allocate attribute structure, piggyback attribute name */
 915         int name_len = write_combine ? 13 : 10;
 916         struct bin_attribute *res_attr;
 917         int retval;
 918
 919         res_attr = kzalloc(sizeof(*res_attr) + name_len, GFP_ATOMIC);
 920         if (res_attr) {
 921                 char *res_attr_name = (char *)(res_attr + 1);
 922
 923                 sysfs_bin_attr_init(res_attr);
 924                 if (write_combine) {
 925                         pdev->res_attr_wc[num] = res_attr;
 926                         sprintf(res_attr_name, "resource%d_wc", num);
 927                         res_attr->mmap = pci_mmap_resource_wc;
 928                 } else {
 929                         pdev->res_attr[num] = res_attr;
 930                         sprintf(res_attr_name, "resource%d", num);
 931                         res_attr->mmap = pci_mmap_resource_uc;
 932                 }
 933                 if (pci_resource_flags(pdev, num) & IORESOURCE_IO) {
 934                         res_attr->read = pci_read_resource_io;
 935                         res_attr->write = pci_write_resource_io;
 936                 }
 937                 res_attr->attr.name = res_attr_name;
 938                 res_attr->attr.mode = S_IRUSR | S_IWUSR;
 939                 res_attr->size = pci_resource_len(pdev, num);
 940                 res_attr->private = &pdev->resource[num];
 941                 retval = sysfs_create_bin_file(&pdev->dev.kobj, res_attr);
 942         } else
 943                 retval = -ENOMEM;
 944
 945         return retval;
 946 }
 947
 948 /**
 949  * pci_create_resource_files - create resource files in sysfs for @dev
 950  * @pdev: dev in question
 951  *
 952  * Walk the resources in @pdev creating files for each resource available.
 953  */
 954 static int pci_create_resource_files(struct pci_dev *pdev)
 955 {
 956         int i;
 957         int retval;
 958
 959         /* Expose the PCI resources from this device as files */
 960         for (i = 0; i < PCI_ROM_RESOURCE; i++) {
 961
 962                 /* skip empty resources */
 963                 if (!pci_resource_len(pdev, i))
 964                         continue;
 965
 966                 retval = pci_create_attr(pdev, i, 0);
 967                 /* for prefetchable resources, create a WC mappable file */
 968                 if (!retval && pdev->resource[i].flags & IORESOURCE_PREFETCH)
 969                         retval = pci_create_attr(pdev, i, 1);
 970
 971                 if (retval) {
 972                         pci_remove_resource_files(pdev);
 973                         return retval;
 974                 }
 975         }
 976         return 0;
 977 }
 978 #else /* !HAVE_PCI_MMAP */
 979 int __weak pci_create_resource_files(struct pci_dev *dev) { return 0; }
 980 void __weak pci_remove_resource_files(struct pci_dev *dev) { return; }
 981 #endif /* HAVE_PCI_MMAP */
 982
 983 /**
 984  * pci_write_rom - used to enable access to the PCI ROM display
 985  * @filp: sysfs file
 986  * @kobj: kernel object handle
 987  * @bin_attr: struct bin_attribute for this file
 988  * @buf: user input
 989  * @off: file offset
 990  * @count: number of byte in input
 991  *
 992  * writing anything except 0 enables it
 993  */
 994 static ssize_t
 995 pci_write_rom(struct file *filp, struct kobject *kobj,
 996               struct bin_attribute *bin_attr,
 997               char *buf, loff_t off, size_t count)
 998 {
 999         struct pci_dev *pdev = to_pci_dev(container_of(kobj, struct device, kobj));
1000
1001         if ((off ==  0) && (*buf == '0') && (count == 2))
1002                 pdev->rom_attr_enabled = 0;
1003         else
1004                 pdev->rom_attr_enabled = 1;
1005
1006         return count;
1007 }
1008
1009 /**
1010  * pci_read_rom - read a PCI ROM
1011  * @filp: sysfs file
1012  * @kobj: kernel object handle
1013  * @bin_attr: struct bin_attribute for this file
1014  * @buf: where to put the data we read from the ROM
1015  * @off: file offset
1016  * @count: number of bytes to read
1017  *
1018  * Put @count bytes starting at @off into @buf from the ROM in the PCI
1019  * device corresponding to @kobj.
1020  */
1021 static ssize_t
1022 pci_read_rom(struct file *filp, struct kobject *kobj,
1023              struct bin_attribute *bin_attr,
1024              char *buf, loff_t off, size_t count)
1025 {
1026         struct pci_dev *pdev = to_pci_dev(container_of(kobj, struct device, kobj));
1027         void __iomem *rom;
1028         size_t size;
1029
1030         if (!pdev->rom_attr_enabled)
1031                 return -EINVAL;
1032
1033         rom = pci_map_rom(pdev, &size); /* size starts out as PCI window size */
1034         if (!rom || !size)
1035                 return -EIO;
1036
1037         if (off >= size)
1038                 count = 0;
1039         else {
1040                 if (off + count > size)
1041                         count = size - off;
1042
1043                 memcpy_fromio(buf, rom + off, count);
1044         }
1045         pci_unmap_rom(pdev, rom);
1046
1047         return count;
1048 }
1049
1050 static struct bin_attribute pci_config_attr = {
1051         .attr = {
1052                 .name = "config",
1053                 .mode = S_IRUGO | S_IWUSR,
1054         },
1055         .size = PCI_CFG_SPACE_SIZE,
1056         .read = pci_read_config,
1057         .write = pci_write_config,
1058 };
1059
1060 static struct bin_attribute pcie_config_attr = {
1061         .attr = {
1062                 .name = "config",
1063                 .mode = S_IRUGO | S_IWUSR,
1064         },
1065         .size = PCI_CFG_SPACE_EXP_SIZE,
1066         .read = pci_read_config,
1067         .write = pci_write_config,
1068 };
1069
1070 int __attribute__ ((weak)) pcibios_add_platform_entries(struct pci_dev *dev)
1071 {
1072         return 0;
1073 }
1074
1075 static ssize_t reset_store(struct device *dev,
1076                            struct device_attribute *attr, const char *buf,
1077                            size_t count)
1078 {
1079         struct pci_dev *pdev = to_pci_dev(dev);
1080         unsigned long val;
1081         ssize_t result = strict_strtoul(buf, 0, &val);
1082
1083         if (result < 0)
1084                 return result;
1085
1086         if (val != 1)
1087                 return -EINVAL;
1088
1089         result = pci_reset_function(pdev);
1090         if (result < 0)
1091                 return result;
1092
1093         return count;
1094 }
1095
1096 static struct device_attribute reset_attr = __ATTR(reset, 0200, NULL, reset_store);
1097
1098 static int pci_create_capabilities_sysfs(struct pci_dev *dev)
1099 {
1100         int retval;
1101         struct bin_attribute *attr;
1102
1103         /* If the device has VPD, try to expose it in sysfs. */
1104         if (dev->vpd) {
1105                 attr = kzalloc(sizeof(*attr), GFP_ATOMIC);
1106                 if (!attr)
1107                         return -ENOMEM;
1108
1109                 sysfs_bin_attr_init(attr);
1110                 attr->size = dev->vpd->len;
1111                 attr->attr.name = "vpd";
1112                 attr->attr.mode = S_IRUSR | S_IWUSR;
1113                 attr->read = read_vpd_attr;
1114                 attr->write = write_vpd_attr;
1115                 retval = sysfs_create_bin_file(&dev->dev.kobj, attr);
1116                 if (retval) {
1117                         kfree(attr);
1118                         return retval;
1119                 }
1120                 dev->vpd->attr = attr;
1121         }
1122
1123         /* Active State Power Management */
1124         pcie_aspm_create_sysfs_dev_files(dev);
1125
1126         if (!pci_probe_reset_function(dev)) {
1127                 retval = device_create_file(&dev->dev, &reset_attr);
1128                 if (retval)
1129                         goto error;
1130                 dev->reset_fn = 1;
1131         }
1132         return 0;
1133
1134 error:
1135         pcie_aspm_remove_sysfs_dev_files(dev);
1136         if (dev->vpd && dev->vpd->attr) {
1137                 sysfs_remove_bin_file(&dev->dev.kobj, dev->vpd->attr);
1138                 kfree(dev->vpd->attr);
1139         }
1140
1141         return retval;
1142 }
1143
1144 int __must_check pci_create_sysfs_dev_files (struct pci_dev *pdev)
1145 {
1146         int retval;
1147         int rom_size = 0;
1148         struct bin_attribute *attr;
1149
1150         if (!sysfs_initialized)
1151                 return -EACCES;
1152
1153         if (pdev->cfg_size < PCI_CFG_SPACE_EXP_SIZE)
1154                 retval = sysfs_create_bin_file(&pdev->dev.kobj, &pci_config_attr);
1155         else
1156                 retval = sysfs_create_bin_file(&pdev->dev.kobj, &pcie_config_attr);
1157         if (retval)
1158                 goto err;
1159
1160         retval = pci_create_resource_files(pdev);
1161         if (retval)
1162                 goto err_config_file;
1163
1164         if (pci_resource_len(pdev, PCI_ROM_RESOURCE))
1165                 rom_size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
1166         else if (pdev->resource[PCI_ROM_RESOURCE].flags & IORESOURCE_ROM_SHADOW)
1167                 rom_size = 0x20000;
1168
1169         /* If the device has a ROM, try to expose it in sysfs. */
1170         if (rom_size) {
1171                 attr = kzalloc(sizeof(*attr), GFP_ATOMIC);
1172                 if (!attr) {
1173                         retval = -ENOMEM;
1174                         goto err_resource_files;
1175                 }
1176                 sysfs_bin_attr_init(attr);
1177                 attr->size = rom_size;
1178                 attr->attr.name = "rom";
1179                 attr->attr.mode = S_IRUSR | S_IWUSR;
1180                 attr->read = pci_read_rom;
1181                 attr->write = pci_write_rom;
1182                 retval = sysfs_create_bin_file(&pdev->dev.kobj, attr);
1183                 if (retval) {
1184                         kfree(attr);
1185                         goto err_resource_files;
1186                 }
1187                 pdev->rom_attr = attr;
1188         }
1189
1190         if ((pdev->class >> 8) == PCI_CLASS_DISPLAY_VGA) {
1191                 retval = device_create_file(&pdev->dev, &vga_attr);
1192                 if (retval)
1193                         goto err_rom_file;
1194         }
1195
1196         /* add platform-specific attributes */
1197         retval = pcibios_add_platform_entries(pdev);
1198         if (retval)
1199                 goto err_vga_file;
1200
1201         /* add sysfs entries for various capabilities */
1202         retval = pci_create_capabilities_sysfs(pdev);
1203         if (retval)
1204                 goto err_vga_file;
1205
1206         pci_create_firmware_label_files(pdev);
1207
1208         return 0;
1209
1210 err_vga_file:
1211         if ((pdev->class >> 8) == PCI_CLASS_DISPLAY_VGA)
1212                 device_remove_file(&pdev->dev, &vga_attr);
1213 err_rom_file:
1214         if (rom_size) {
1215                 sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr);
1216                 kfree(pdev->rom_attr);
1217                 pdev->rom_attr = NULL;
1218         }
1219 err_resource_files:
1220         pci_remove_resource_files(pdev);
1221 err_config_file:
1222         if (pdev->cfg_size < PCI_CFG_SPACE_EXP_SIZE)
1223                 sysfs_remove_bin_file(&pdev->dev.kobj, &pci_config_attr);
1224         else
1225                 sysfs_remove_bin_file(&pdev->dev.kobj, &pcie_config_attr);
1226 err:
1227         return retval;
1228 }
1229
1230 static void pci_remove_capabilities_sysfs(struct pci_dev *dev)
1231 {
1232         if (dev->vpd && dev->vpd->attr) {
1233                 sysfs_remove_bin_file(&dev->dev.kobj, dev->vpd->attr);
1234                 kfree(dev->vpd->attr);
1235         }
1236
1237         pcie_aspm_remove_sysfs_dev_files(dev);
1238         if (dev->reset_fn) {
1239                 device_remove_file(&dev->dev, &reset_attr);
1240                 dev->reset_fn = 0;
1241         }
1242 }
1243
1244 /**
1245  * pci_remove_sysfs_dev_files - cleanup PCI specific sysfs files
1246  * @pdev: device whose entries we should free
1247  *
1248  * Cleanup when @pdev is removed from sysfs.
1249  */
1250 void pci_remove_sysfs_dev_files(struct pci_dev *pdev)
1251 {
1252         int rom_size = 0;
1253
1254         if (!sysfs_initialized)
1255                 return;
1256
1257         pci_remove_capabilities_sysfs(pdev);
1258
1259         if (pdev->cfg_size < PCI_CFG_SPACE_EXP_SIZE)
1260                 sysfs_remove_bin_file(&pdev->dev.kobj, &pci_config_attr);
1261         else
1262                 sysfs_remove_bin_file(&pdev->dev.kobj, &pcie_config_attr);
1263
1264         pci_remove_resource_files(pdev);
1265
1266         if (pci_resource_len(pdev, PCI_ROM_RESOURCE))
1267                 rom_size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
1268         else if (pdev->resource[PCI_ROM_RESOURCE].flags & IORESOURCE_ROM_SHADOW)
1269                 rom_size = 0x20000;
1270
1271         if (rom_size && pdev->rom_attr) {
1272                 sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr);
1273                 kfree(pdev->rom_attr);
1274         }
1275
1276         pci_remove_firmware_label_files(pdev);
1277
1278 }
1279
1280 static int __init pci_sysfs_init(void)
1281 {
1282         struct pci_dev *pdev = NULL;
1283         int retval;
1284
1285         sysfs_initialized = 1;
1286         for_each_pci_dev(pdev) {
1287                 retval = pci_create_sysfs_dev_files(pdev);
1288                 if (retval) {
1289                         pci_dev_put(pdev);
1290                         return retval;
1291                 }
1292         }
1293
1294         return 0;
1295 }
1296
1297 late_initcall(pci_sysfs_init);