2 * drivers/pci/pci-sysfs.c
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>
11 * File attributes for PCI devices
13 * Modeled after usb's driverfs.c
18 #include <linux/kernel.h>
19 #include <linux/pci.h>
20 #include <linux/stat.h>
21 #include <linux/topology.h>
23 #include <linux/capability.h>
24 #include <linux/aspm.h>
27 static int sysfs_initialized; /* = 0 */
29 /* show configuration fields */
30 #define pci_config_attr(field, format_string) \
32 field##_show(struct device *dev, struct device_attribute *attr, char *buf) \
34 struct pci_dev *pdev; \
36 pdev = to_pci_dev (dev); \
37 return sprintf (buf, format_string, pdev->field); \
40 pci_config_attr(vendor, "0x%04x\n");
41 pci_config_attr(device, "0x%04x\n");
42 pci_config_attr(subsystem_vendor, "0x%04x\n");
43 pci_config_attr(subsystem_device, "0x%04x\n");
44 pci_config_attr(class, "0x%06x\n");
45 pci_config_attr(irq, "%u\n");
47 static ssize_t broken_parity_status_show(struct device *dev,
48 struct device_attribute *attr,
51 struct pci_dev *pdev = to_pci_dev(dev);
52 return sprintf (buf, "%u\n", pdev->broken_parity_status);
55 static ssize_t broken_parity_status_store(struct device *dev,
56 struct device_attribute *attr,
57 const char *buf, size_t count)
59 struct pci_dev *pdev = to_pci_dev(dev);
60 ssize_t consumed = -EINVAL;
62 if ((count > 0) && (*buf == '0' || *buf == '1')) {
63 pdev->broken_parity_status = *buf == '1' ? 1 : 0;
69 static ssize_t local_cpus_show(struct device *dev,
70 struct device_attribute *attr, char *buf)
75 mask = pcibus_to_cpumask(to_pci_dev(dev)->bus);
76 len = cpumask_scnprintf(buf, PAGE_SIZE-2, mask);
83 resource_show(struct device * dev, struct device_attribute *attr, char * buf)
85 struct pci_dev * pci_dev = to_pci_dev(dev);
89 resource_size_t start, end;
91 if (pci_dev->subordinate)
92 max = DEVICE_COUNT_RESOURCE;
94 for (i = 0; i < max; i++) {
95 struct resource *res = &pci_dev->resource[i];
96 pci_resource_to_user(pci_dev, i, res, &start, &end);
97 str += sprintf(str,"0x%016llx 0x%016llx 0x%016llx\n",
98 (unsigned long long)start,
99 (unsigned long long)end,
100 (unsigned long long)res->flags);
105 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
107 struct pci_dev *pci_dev = to_pci_dev(dev);
109 return sprintf(buf, "pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02x\n",
110 pci_dev->vendor, pci_dev->device,
111 pci_dev->subsystem_vendor, pci_dev->subsystem_device,
112 (u8)(pci_dev->class >> 16), (u8)(pci_dev->class >> 8),
113 (u8)(pci_dev->class));
116 static ssize_t is_enabled_store(struct device *dev,
117 struct device_attribute *attr, const char *buf,
120 ssize_t result = -EINVAL;
121 struct pci_dev *pdev = to_pci_dev(dev);
123 /* this can crash the machine when done on the "wrong" device */
124 if (!capable(CAP_SYS_ADMIN))
128 if (atomic_read(&pdev->enable_cnt) != 0)
129 pci_disable_device(pdev);
132 } else if (*buf == '1')
133 result = pci_enable_device(pdev);
135 return result < 0 ? result : count;
138 static ssize_t is_enabled_show(struct device *dev,
139 struct device_attribute *attr, char *buf)
141 struct pci_dev *pdev;
143 pdev = to_pci_dev (dev);
144 return sprintf (buf, "%u\n", atomic_read(&pdev->enable_cnt));
149 numa_node_show(struct device *dev, struct device_attribute *attr, char *buf)
151 return sprintf (buf, "%d\n", dev->numa_node);
156 msi_bus_show(struct device *dev, struct device_attribute *attr, char *buf)
158 struct pci_dev *pdev = to_pci_dev(dev);
160 if (!pdev->subordinate)
163 return sprintf (buf, "%u\n",
164 !(pdev->subordinate->bus_flags & PCI_BUS_FLAGS_NO_MSI));
168 msi_bus_store(struct device *dev, struct device_attribute *attr,
169 const char *buf, size_t count)
171 struct pci_dev *pdev = to_pci_dev(dev);
173 /* bad things may happen if the no_msi flag is changed
174 * while some drivers are loaded */
175 if (!capable(CAP_SYS_ADMIN))
178 if (!pdev->subordinate)
182 pdev->subordinate->bus_flags |= PCI_BUS_FLAGS_NO_MSI;
183 dev_warn(&pdev->dev, "forced subordinate bus to not support MSI,"
184 " bad things could happen.\n");
188 pdev->subordinate->bus_flags &= ~PCI_BUS_FLAGS_NO_MSI;
189 dev_warn(&pdev->dev, "forced subordinate bus to support MSI,"
190 " bad things could happen.\n");
196 struct device_attribute pci_dev_attrs[] = {
200 __ATTR_RO(subsystem_vendor),
201 __ATTR_RO(subsystem_device),
204 __ATTR_RO(local_cpus),
207 __ATTR_RO(numa_node),
209 __ATTR(enable, 0600, is_enabled_show, is_enabled_store),
210 __ATTR(broken_parity_status,(S_IRUGO|S_IWUSR),
211 broken_parity_status_show,broken_parity_status_store),
212 __ATTR(msi_bus, 0644, msi_bus_show, msi_bus_store),
217 pci_read_config(struct kobject *kobj, struct bin_attribute *bin_attr,
218 char *buf, loff_t off, size_t count)
220 struct pci_dev *dev = to_pci_dev(container_of(kobj,struct device,kobj));
221 unsigned int size = 64;
222 loff_t init_off = off;
223 u8 *data = (u8*) buf;
225 /* Several chips lock up trying to read undefined config space */
226 if (capable(CAP_SYS_ADMIN)) {
227 size = dev->cfg_size;
228 } else if (dev->hdr_type == PCI_HEADER_TYPE_CARDBUS) {
234 if (off + count > size) {
241 if ((off & 1) && size) {
243 pci_user_read_config_byte(dev, off, &val);
244 data[off - init_off] = val;
249 if ((off & 3) && size > 2) {
251 pci_user_read_config_word(dev, off, &val);
252 data[off - init_off] = val & 0xff;
253 data[off - init_off + 1] = (val >> 8) & 0xff;
260 pci_user_read_config_dword(dev, off, &val);
261 data[off - init_off] = val & 0xff;
262 data[off - init_off + 1] = (val >> 8) & 0xff;
263 data[off - init_off + 2] = (val >> 16) & 0xff;
264 data[off - init_off + 3] = (val >> 24) & 0xff;
271 pci_user_read_config_word(dev, off, &val);
272 data[off - init_off] = val & 0xff;
273 data[off - init_off + 1] = (val >> 8) & 0xff;
280 pci_user_read_config_byte(dev, off, &val);
281 data[off - init_off] = val;
290 pci_write_config(struct kobject *kobj, struct bin_attribute *bin_attr,
291 char *buf, loff_t off, size_t count)
293 struct pci_dev *dev = to_pci_dev(container_of(kobj,struct device,kobj));
294 unsigned int size = count;
295 loff_t init_off = off;
296 u8 *data = (u8*) buf;
298 if (off > dev->cfg_size)
300 if (off + count > dev->cfg_size) {
301 size = dev->cfg_size - off;
305 if ((off & 1) && size) {
306 pci_user_write_config_byte(dev, off, data[off - init_off]);
311 if ((off & 3) && size > 2) {
312 u16 val = data[off - init_off];
313 val |= (u16) data[off - init_off + 1] << 8;
314 pci_user_write_config_word(dev, off, val);
320 u32 val = data[off - init_off];
321 val |= (u32) data[off - init_off + 1] << 8;
322 val |= (u32) data[off - init_off + 2] << 16;
323 val |= (u32) data[off - init_off + 3] << 24;
324 pci_user_write_config_dword(dev, off, val);
330 u16 val = data[off - init_off];
331 val |= (u16) data[off - init_off + 1] << 8;
332 pci_user_write_config_word(dev, off, val);
338 pci_user_write_config_byte(dev, off, data[off - init_off]);
346 #ifdef HAVE_PCI_LEGACY
348 * pci_read_legacy_io - read byte(s) from legacy I/O port space
349 * @kobj: kobject corresponding to file to read from
350 * @buf: buffer to store results
351 * @off: offset into legacy I/O port space
352 * @count: number of bytes to read
354 * Reads 1, 2, or 4 bytes from legacy I/O port space using an arch specific
355 * callback routine (pci_legacy_read).
358 pci_read_legacy_io(struct kobject *kobj, struct bin_attribute *bin_attr,
359 char *buf, loff_t off, size_t count)
361 struct pci_bus *bus = to_pci_bus(container_of(kobj,
365 /* Only support 1, 2 or 4 byte accesses */
366 if (count != 1 && count != 2 && count != 4)
369 return pci_legacy_read(bus, off, (u32 *)buf, count);
373 * pci_write_legacy_io - write byte(s) to legacy I/O port space
374 * @kobj: kobject corresponding to file to read from
375 * @buf: buffer containing value to be written
376 * @off: offset into legacy I/O port space
377 * @count: number of bytes to write
379 * Writes 1, 2, or 4 bytes from legacy I/O port space using an arch specific
380 * callback routine (pci_legacy_write).
383 pci_write_legacy_io(struct kobject *kobj, struct bin_attribute *bin_attr,
384 char *buf, loff_t off, size_t count)
386 struct pci_bus *bus = to_pci_bus(container_of(kobj,
389 /* Only support 1, 2 or 4 byte accesses */
390 if (count != 1 && count != 2 && count != 4)
393 return pci_legacy_write(bus, off, *(u32 *)buf, count);
397 * pci_mmap_legacy_mem - map legacy PCI memory into user memory space
398 * @kobj: kobject corresponding to device to be mapped
399 * @attr: struct bin_attribute for this file
400 * @vma: struct vm_area_struct passed to mmap
402 * Uses an arch specific callback, pci_mmap_legacy_page_range, to mmap
403 * legacy memory space (first meg of bus space) into application virtual
407 pci_mmap_legacy_mem(struct kobject *kobj, struct bin_attribute *attr,
408 struct vm_area_struct *vma)
410 struct pci_bus *bus = to_pci_bus(container_of(kobj,
414 return pci_mmap_legacy_page_range(bus, vma);
416 #endif /* HAVE_PCI_LEGACY */
420 * pci_mmap_resource - map a PCI resource into user memory space
421 * @kobj: kobject for mapping
422 * @attr: struct bin_attribute for the file being mapped
423 * @vma: struct vm_area_struct passed into the mmap
425 * Use the regular PCI mapping routines to map a PCI resource into userspace.
426 * FIXME: write combining? maybe automatic for prefetchable regions?
429 pci_mmap_resource(struct kobject *kobj, struct bin_attribute *attr,
430 struct vm_area_struct *vma)
432 struct pci_dev *pdev = to_pci_dev(container_of(kobj,
433 struct device, kobj));
434 struct resource *res = (struct resource *)attr->private;
435 enum pci_mmap_state mmap_type;
436 resource_size_t start, end;
439 for (i = 0; i < PCI_ROM_RESOURCE; i++)
440 if (res == &pdev->resource[i])
442 if (i >= PCI_ROM_RESOURCE)
445 /* pci_mmap_page_range() expects the same kind of entry as coming
446 * from /proc/bus/pci/ which is a "user visible" value. If this is
447 * different from the resource itself, arch will do necessary fixup.
449 pci_resource_to_user(pdev, i, res, &start, &end);
450 vma->vm_pgoff += start >> PAGE_SHIFT;
451 mmap_type = res->flags & IORESOURCE_MEM ? pci_mmap_mem : pci_mmap_io;
453 return pci_mmap_page_range(pdev, vma, mmap_type, 0);
457 * pci_remove_resource_files - cleanup resource files
458 * @dev: dev to cleanup
460 * If we created resource files for @dev, remove them from sysfs and
461 * free their resources.
464 pci_remove_resource_files(struct pci_dev *pdev)
468 for (i = 0; i < PCI_ROM_RESOURCE; i++) {
469 struct bin_attribute *res_attr;
471 res_attr = pdev->res_attr[i];
473 sysfs_remove_bin_file(&pdev->dev.kobj, res_attr);
480 * pci_create_resource_files - create resource files in sysfs for @dev
481 * @dev: dev in question
483 * Walk the resources in @dev creating files for each resource available.
485 static int pci_create_resource_files(struct pci_dev *pdev)
490 /* Expose the PCI resources from this device as files */
491 for (i = 0; i < PCI_ROM_RESOURCE; i++) {
492 struct bin_attribute *res_attr;
494 /* skip empty resources */
495 if (!pci_resource_len(pdev, i))
498 /* allocate attribute structure, piggyback attribute name */
499 res_attr = kzalloc(sizeof(*res_attr) + 10, GFP_ATOMIC);
501 char *res_attr_name = (char *)(res_attr + 1);
503 pdev->res_attr[i] = res_attr;
504 sprintf(res_attr_name, "resource%d", i);
505 res_attr->attr.name = res_attr_name;
506 res_attr->attr.mode = S_IRUSR | S_IWUSR;
507 res_attr->size = pci_resource_len(pdev, i);
508 res_attr->mmap = pci_mmap_resource;
509 res_attr->private = &pdev->resource[i];
510 retval = sysfs_create_bin_file(&pdev->dev.kobj, res_attr);
512 pci_remove_resource_files(pdev);
521 #else /* !HAVE_PCI_MMAP */
522 static inline int pci_create_resource_files(struct pci_dev *dev) { return 0; }
523 static inline void pci_remove_resource_files(struct pci_dev *dev) { return; }
524 #endif /* HAVE_PCI_MMAP */
527 * pci_write_rom - used to enable access to the PCI ROM display
528 * @kobj: kernel object handle
531 * @count: number of byte in input
533 * writing anything except 0 enables it
536 pci_write_rom(struct kobject *kobj, struct bin_attribute *bin_attr,
537 char *buf, loff_t off, size_t count)
539 struct pci_dev *pdev = to_pci_dev(container_of(kobj, struct device, kobj));
541 if ((off == 0) && (*buf == '0') && (count == 2))
542 pdev->rom_attr_enabled = 0;
544 pdev->rom_attr_enabled = 1;
550 * pci_read_rom - read a PCI ROM
551 * @kobj: kernel object handle
552 * @buf: where to put the data we read from the ROM
554 * @count: number of bytes to read
556 * Put @count bytes starting at @off into @buf from the ROM in the PCI
557 * device corresponding to @kobj.
560 pci_read_rom(struct kobject *kobj, struct bin_attribute *bin_attr,
561 char *buf, loff_t off, size_t count)
563 struct pci_dev *pdev = to_pci_dev(container_of(kobj, struct device, kobj));
567 if (!pdev->rom_attr_enabled)
570 rom = pci_map_rom(pdev, &size); /* size starts out as PCI window size */
577 if (off + count > size)
580 memcpy_fromio(buf, rom + off, count);
582 pci_unmap_rom(pdev, rom);
587 static struct bin_attribute pci_config_attr = {
590 .mode = S_IRUGO | S_IWUSR,
593 .read = pci_read_config,
594 .write = pci_write_config,
597 static struct bin_attribute pcie_config_attr = {
600 .mode = S_IRUGO | S_IWUSR,
603 .read = pci_read_config,
604 .write = pci_write_config,
607 int __attribute__ ((weak)) pcibios_add_platform_entries(struct pci_dev *dev)
612 int __must_check pci_create_sysfs_dev_files (struct pci_dev *pdev)
614 struct bin_attribute *rom_attr = NULL;
617 if (!sysfs_initialized)
620 if (pdev->cfg_size < 4096)
621 retval = sysfs_create_bin_file(&pdev->dev.kobj, &pci_config_attr);
623 retval = sysfs_create_bin_file(&pdev->dev.kobj, &pcie_config_attr);
627 retval = pci_create_resource_files(pdev);
631 /* If the device has a ROM, try to expose it in sysfs. */
632 if (pci_resource_len(pdev, PCI_ROM_RESOURCE) ||
633 (pdev->resource[PCI_ROM_RESOURCE].flags & IORESOURCE_ROM_SHADOW)) {
634 rom_attr = kzalloc(sizeof(*rom_attr), GFP_ATOMIC);
636 pdev->rom_attr = rom_attr;
637 rom_attr->size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
638 rom_attr->attr.name = "rom";
639 rom_attr->attr.mode = S_IRUSR;
640 rom_attr->read = pci_read_rom;
641 rom_attr->write = pci_write_rom;
642 retval = sysfs_create_bin_file(&pdev->dev.kobj, rom_attr);
647 goto err_resource_files;
650 /* add platform-specific attributes */
651 if (pcibios_add_platform_entries(pdev))
654 pcie_aspm_create_sysfs_dev_files(pdev);
659 if (pci_resource_len(pdev, PCI_ROM_RESOURCE))
660 sysfs_remove_bin_file(&pdev->dev.kobj, rom_attr);
664 pci_remove_resource_files(pdev);
666 if (pdev->cfg_size < 4096)
667 sysfs_remove_bin_file(&pdev->dev.kobj, &pci_config_attr);
669 sysfs_remove_bin_file(&pdev->dev.kobj, &pcie_config_attr);
675 * pci_remove_sysfs_dev_files - cleanup PCI specific sysfs files
676 * @pdev: device whose entries we should free
678 * Cleanup when @pdev is removed from sysfs.
680 void pci_remove_sysfs_dev_files(struct pci_dev *pdev)
682 if (!sysfs_initialized)
685 pcie_aspm_remove_sysfs_dev_files(pdev);
687 if (pdev->cfg_size < 4096)
688 sysfs_remove_bin_file(&pdev->dev.kobj, &pci_config_attr);
690 sysfs_remove_bin_file(&pdev->dev.kobj, &pcie_config_attr);
692 pci_remove_resource_files(pdev);
694 if (pci_resource_len(pdev, PCI_ROM_RESOURCE)) {
695 if (pdev->rom_attr) {
696 sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr);
697 kfree(pdev->rom_attr);
702 static int __init pci_sysfs_init(void)
704 struct pci_dev *pdev = NULL;
707 sysfs_initialized = 1;
708 for_each_pci_dev(pdev) {
709 retval = pci_create_sysfs_dev_files(pdev);
719 late_initcall(pci_sysfs_init);