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>
26 static int sysfs_initialized; /* = 0 */
28 /* show configuration fields */
29 #define pci_config_attr(field, format_string) \
31 field##_show(struct device *dev, struct device_attribute *attr, char *buf) \
33 struct pci_dev *pdev; \
35 pdev = to_pci_dev (dev); \
36 return sprintf (buf, format_string, pdev->field); \
39 pci_config_attr(vendor, "0x%04x\n");
40 pci_config_attr(device, "0x%04x\n");
41 pci_config_attr(subsystem_vendor, "0x%04x\n");
42 pci_config_attr(subsystem_device, "0x%04x\n");
43 pci_config_attr(class, "0x%06x\n");
44 pci_config_attr(irq, "%u\n");
46 static ssize_t broken_parity_status_show(struct device *dev,
47 struct device_attribute *attr,
50 struct pci_dev *pdev = to_pci_dev(dev);
51 return sprintf (buf, "%u\n", pdev->broken_parity_status);
54 static ssize_t broken_parity_status_store(struct device *dev,
55 struct device_attribute *attr,
56 const char *buf, size_t count)
58 struct pci_dev *pdev = to_pci_dev(dev);
59 ssize_t consumed = -EINVAL;
61 if ((count > 0) && (*buf == '0' || *buf == '1')) {
62 pdev->broken_parity_status = *buf == '1' ? 1 : 0;
68 static ssize_t local_cpus_show(struct device *dev,
69 struct device_attribute *attr, char *buf)
74 mask = pcibus_to_cpumask(to_pci_dev(dev)->bus);
75 len = cpumask_scnprintf(buf, PAGE_SIZE-2, mask);
82 resource_show(struct device * dev, struct device_attribute *attr, char * buf)
84 struct pci_dev * pci_dev = to_pci_dev(dev);
88 resource_size_t start, end;
90 if (pci_dev->subordinate)
91 max = DEVICE_COUNT_RESOURCE;
93 for (i = 0; i < max; i++) {
94 struct resource *res = &pci_dev->resource[i];
95 pci_resource_to_user(pci_dev, i, res, &start, &end);
96 str += sprintf(str,"0x%016llx 0x%016llx 0x%016llx\n",
97 (unsigned long long)start,
98 (unsigned long long)end,
99 (unsigned long long)res->flags);
104 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
106 struct pci_dev *pci_dev = to_pci_dev(dev);
108 return sprintf(buf, "pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02x\n",
109 pci_dev->vendor, pci_dev->device,
110 pci_dev->subsystem_vendor, pci_dev->subsystem_device,
111 (u8)(pci_dev->class >> 16), (u8)(pci_dev->class >> 8),
112 (u8)(pci_dev->class));
115 static ssize_t is_enabled_store(struct device *dev,
116 struct device_attribute *attr, const char *buf,
119 ssize_t result = -EINVAL;
120 struct pci_dev *pdev = to_pci_dev(dev);
122 /* this can crash the machine when done on the "wrong" device */
123 if (!capable(CAP_SYS_ADMIN))
127 if (atomic_read(&pdev->enable_cnt) != 0)
128 pci_disable_device(pdev);
131 } else if (*buf == '1')
132 result = pci_enable_device(pdev);
134 return result < 0 ? result : count;
137 static ssize_t is_enabled_show(struct device *dev,
138 struct device_attribute *attr, char *buf)
140 struct pci_dev *pdev;
142 pdev = to_pci_dev (dev);
143 return sprintf (buf, "%u\n", atomic_read(&pdev->enable_cnt));
148 numa_node_show(struct device *dev, struct device_attribute *attr, char *buf)
150 return sprintf (buf, "%d\n", dev->numa_node);
155 msi_bus_show(struct device *dev, struct device_attribute *attr, char *buf)
157 struct pci_dev *pdev = to_pci_dev(dev);
159 if (!pdev->subordinate)
162 return sprintf (buf, "%u\n",
163 !(pdev->subordinate->bus_flags & PCI_BUS_FLAGS_NO_MSI));
167 msi_bus_store(struct device *dev, struct device_attribute *attr,
168 const char *buf, size_t count)
170 struct pci_dev *pdev = to_pci_dev(dev);
172 /* bad things may happen if the no_msi flag is changed
173 * while some drivers are loaded */
174 if (!capable(CAP_SYS_ADMIN))
177 if (!pdev->subordinate)
181 pdev->subordinate->bus_flags |= PCI_BUS_FLAGS_NO_MSI;
182 dev_warn(&pdev->dev, "forced subordinate bus to not support MSI,"
183 " bad things could happen.\n");
187 pdev->subordinate->bus_flags &= ~PCI_BUS_FLAGS_NO_MSI;
188 dev_warn(&pdev->dev, "forced subordinate bus to support MSI,"
189 " bad things could happen.\n");
195 struct device_attribute pci_dev_attrs[] = {
199 __ATTR_RO(subsystem_vendor),
200 __ATTR_RO(subsystem_device),
203 __ATTR_RO(local_cpus),
206 __ATTR_RO(numa_node),
208 __ATTR(enable, 0600, is_enabled_show, is_enabled_store),
209 __ATTR(broken_parity_status,(S_IRUGO|S_IWUSR),
210 broken_parity_status_show,broken_parity_status_store),
211 __ATTR(msi_bus, 0644, msi_bus_show, msi_bus_store),
216 pci_read_config(struct kobject *kobj, struct bin_attribute *bin_attr,
217 char *buf, loff_t off, size_t count)
219 struct pci_dev *dev = to_pci_dev(container_of(kobj,struct device,kobj));
220 unsigned int size = 64;
221 loff_t init_off = off;
222 u8 *data = (u8*) buf;
224 /* Several chips lock up trying to read undefined config space */
225 if (capable(CAP_SYS_ADMIN)) {
226 size = dev->cfg_size;
227 } else if (dev->hdr_type == PCI_HEADER_TYPE_CARDBUS) {
233 if (off + count > size) {
240 if ((off & 1) && size) {
242 pci_user_read_config_byte(dev, off, &val);
243 data[off - init_off] = val;
248 if ((off & 3) && size > 2) {
250 pci_user_read_config_word(dev, off, &val);
251 data[off - init_off] = val & 0xff;
252 data[off - init_off + 1] = (val >> 8) & 0xff;
259 pci_user_read_config_dword(dev, off, &val);
260 data[off - init_off] = val & 0xff;
261 data[off - init_off + 1] = (val >> 8) & 0xff;
262 data[off - init_off + 2] = (val >> 16) & 0xff;
263 data[off - init_off + 3] = (val >> 24) & 0xff;
270 pci_user_read_config_word(dev, off, &val);
271 data[off - init_off] = val & 0xff;
272 data[off - init_off + 1] = (val >> 8) & 0xff;
279 pci_user_read_config_byte(dev, off, &val);
280 data[off - init_off] = val;
289 pci_write_config(struct kobject *kobj, struct bin_attribute *bin_attr,
290 char *buf, loff_t off, size_t count)
292 struct pci_dev *dev = to_pci_dev(container_of(kobj,struct device,kobj));
293 unsigned int size = count;
294 loff_t init_off = off;
295 u8 *data = (u8*) buf;
297 if (off > dev->cfg_size)
299 if (off + count > dev->cfg_size) {
300 size = dev->cfg_size - off;
304 if ((off & 1) && size) {
305 pci_user_write_config_byte(dev, off, data[off - init_off]);
310 if ((off & 3) && size > 2) {
311 u16 val = data[off - init_off];
312 val |= (u16) data[off - init_off + 1] << 8;
313 pci_user_write_config_word(dev, off, val);
319 u32 val = data[off - init_off];
320 val |= (u32) data[off - init_off + 1] << 8;
321 val |= (u32) data[off - init_off + 2] << 16;
322 val |= (u32) data[off - init_off + 3] << 24;
323 pci_user_write_config_dword(dev, off, val);
329 u16 val = data[off - init_off];
330 val |= (u16) data[off - init_off + 1] << 8;
331 pci_user_write_config_word(dev, off, val);
337 pci_user_write_config_byte(dev, off, data[off - init_off]);
345 #ifdef HAVE_PCI_LEGACY
347 * pci_read_legacy_io - read byte(s) from legacy I/O port space
348 * @kobj: kobject corresponding to file to read from
349 * @buf: buffer to store results
350 * @off: offset into legacy I/O port space
351 * @count: number of bytes to read
353 * Reads 1, 2, or 4 bytes from legacy I/O port space using an arch specific
354 * callback routine (pci_legacy_read).
357 pci_read_legacy_io(struct kobject *kobj, struct bin_attribute *bin_attr,
358 char *buf, loff_t off, size_t count)
360 struct pci_bus *bus = to_pci_bus(container_of(kobj,
364 /* Only support 1, 2 or 4 byte accesses */
365 if (count != 1 && count != 2 && count != 4)
368 return pci_legacy_read(bus, off, (u32 *)buf, count);
372 * pci_write_legacy_io - write byte(s) to legacy I/O port space
373 * @kobj: kobject corresponding to file to read from
374 * @buf: buffer containing value to be written
375 * @off: offset into legacy I/O port space
376 * @count: number of bytes to write
378 * Writes 1, 2, or 4 bytes from legacy I/O port space using an arch specific
379 * callback routine (pci_legacy_write).
382 pci_write_legacy_io(struct kobject *kobj, struct bin_attribute *bin_attr,
383 char *buf, loff_t off, size_t count)
385 struct pci_bus *bus = to_pci_bus(container_of(kobj,
388 /* Only support 1, 2 or 4 byte accesses */
389 if (count != 1 && count != 2 && count != 4)
392 return pci_legacy_write(bus, off, *(u32 *)buf, count);
396 * pci_mmap_legacy_mem - map legacy PCI memory into user memory space
397 * @kobj: kobject corresponding to device to be mapped
398 * @attr: struct bin_attribute for this file
399 * @vma: struct vm_area_struct passed to mmap
401 * Uses an arch specific callback, pci_mmap_legacy_page_range, to mmap
402 * legacy memory space (first meg of bus space) into application virtual
406 pci_mmap_legacy_mem(struct kobject *kobj, struct bin_attribute *attr,
407 struct vm_area_struct *vma)
409 struct pci_bus *bus = to_pci_bus(container_of(kobj,
413 return pci_mmap_legacy_page_range(bus, vma);
415 #endif /* HAVE_PCI_LEGACY */
419 * pci_mmap_resource - map a PCI resource into user memory space
420 * @kobj: kobject for mapping
421 * @attr: struct bin_attribute for the file being mapped
422 * @vma: struct vm_area_struct passed into the mmap
424 * Use the regular PCI mapping routines to map a PCI resource into userspace.
425 * FIXME: write combining? maybe automatic for prefetchable regions?
428 pci_mmap_resource(struct kobject *kobj, struct bin_attribute *attr,
429 struct vm_area_struct *vma)
431 struct pci_dev *pdev = to_pci_dev(container_of(kobj,
432 struct device, kobj));
433 struct resource *res = (struct resource *)attr->private;
434 enum pci_mmap_state mmap_type;
435 resource_size_t start, end;
438 for (i = 0; i < PCI_ROM_RESOURCE; i++)
439 if (res == &pdev->resource[i])
441 if (i >= PCI_ROM_RESOURCE)
444 /* pci_mmap_page_range() expects the same kind of entry as coming
445 * from /proc/bus/pci/ which is a "user visible" value. If this is
446 * different from the resource itself, arch will do necessary fixup.
448 pci_resource_to_user(pdev, i, res, &start, &end);
449 vma->vm_pgoff += start >> PAGE_SHIFT;
450 mmap_type = res->flags & IORESOURCE_MEM ? pci_mmap_mem : pci_mmap_io;
452 return pci_mmap_page_range(pdev, vma, mmap_type, 0);
456 * pci_remove_resource_files - cleanup resource files
457 * @dev: dev to cleanup
459 * If we created resource files for @dev, remove them from sysfs and
460 * free their resources.
463 pci_remove_resource_files(struct pci_dev *pdev)
467 for (i = 0; i < PCI_ROM_RESOURCE; i++) {
468 struct bin_attribute *res_attr;
470 res_attr = pdev->res_attr[i];
472 sysfs_remove_bin_file(&pdev->dev.kobj, res_attr);
479 * pci_create_resource_files - create resource files in sysfs for @dev
480 * @dev: dev in question
482 * Walk the resources in @dev creating files for each resource available.
484 static int pci_create_resource_files(struct pci_dev *pdev)
489 /* Expose the PCI resources from this device as files */
490 for (i = 0; i < PCI_ROM_RESOURCE; i++) {
491 struct bin_attribute *res_attr;
493 /* skip empty resources */
494 if (!pci_resource_len(pdev, i))
497 /* allocate attribute structure, piggyback attribute name */
498 res_attr = kzalloc(sizeof(*res_attr) + 10, GFP_ATOMIC);
500 char *res_attr_name = (char *)(res_attr + 1);
502 pdev->res_attr[i] = res_attr;
503 sprintf(res_attr_name, "resource%d", i);
504 res_attr->attr.name = res_attr_name;
505 res_attr->attr.mode = S_IRUSR | S_IWUSR;
506 res_attr->size = pci_resource_len(pdev, i);
507 res_attr->mmap = pci_mmap_resource;
508 res_attr->private = &pdev->resource[i];
509 retval = sysfs_create_bin_file(&pdev->dev.kobj, res_attr);
511 pci_remove_resource_files(pdev);
520 #else /* !HAVE_PCI_MMAP */
521 static inline int pci_create_resource_files(struct pci_dev *dev) { return 0; }
522 static inline void pci_remove_resource_files(struct pci_dev *dev) { return; }
523 #endif /* HAVE_PCI_MMAP */
526 * pci_write_rom - used to enable access to the PCI ROM display
527 * @kobj: kernel object handle
530 * @count: number of byte in input
532 * writing anything except 0 enables it
535 pci_write_rom(struct kobject *kobj, struct bin_attribute *bin_attr,
536 char *buf, loff_t off, size_t count)
538 struct pci_dev *pdev = to_pci_dev(container_of(kobj, struct device, kobj));
540 if ((off == 0) && (*buf == '0') && (count == 2))
541 pdev->rom_attr_enabled = 0;
543 pdev->rom_attr_enabled = 1;
549 * pci_read_rom - read a PCI ROM
550 * @kobj: kernel object handle
551 * @buf: where to put the data we read from the ROM
553 * @count: number of bytes to read
555 * Put @count bytes starting at @off into @buf from the ROM in the PCI
556 * device corresponding to @kobj.
559 pci_read_rom(struct kobject *kobj, struct bin_attribute *bin_attr,
560 char *buf, loff_t off, size_t count)
562 struct pci_dev *pdev = to_pci_dev(container_of(kobj, struct device, kobj));
566 if (!pdev->rom_attr_enabled)
569 rom = pci_map_rom(pdev, &size); /* size starts out as PCI window size */
576 if (off + count > size)
579 memcpy_fromio(buf, rom + off, count);
581 pci_unmap_rom(pdev, rom);
586 static struct bin_attribute pci_config_attr = {
589 .mode = S_IRUGO | S_IWUSR,
592 .read = pci_read_config,
593 .write = pci_write_config,
596 static struct bin_attribute pcie_config_attr = {
599 .mode = S_IRUGO | S_IWUSR,
602 .read = pci_read_config,
603 .write = pci_write_config,
606 int __attribute__ ((weak)) pcibios_add_platform_entries(struct pci_dev *dev)
611 int __must_check pci_create_sysfs_dev_files (struct pci_dev *pdev)
613 struct bin_attribute *rom_attr = NULL;
616 if (!sysfs_initialized)
619 if (pdev->cfg_size < 4096)
620 retval = sysfs_create_bin_file(&pdev->dev.kobj, &pci_config_attr);
622 retval = sysfs_create_bin_file(&pdev->dev.kobj, &pcie_config_attr);
626 retval = pci_create_resource_files(pdev);
630 /* If the device has a ROM, try to expose it in sysfs. */
631 if (pci_resource_len(pdev, PCI_ROM_RESOURCE) ||
632 (pdev->resource[PCI_ROM_RESOURCE].flags & IORESOURCE_ROM_SHADOW)) {
633 rom_attr = kzalloc(sizeof(*rom_attr), GFP_ATOMIC);
635 pdev->rom_attr = rom_attr;
636 rom_attr->size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
637 rom_attr->attr.name = "rom";
638 rom_attr->attr.mode = S_IRUSR;
639 rom_attr->read = pci_read_rom;
640 rom_attr->write = pci_write_rom;
641 retval = sysfs_create_bin_file(&pdev->dev.kobj, rom_attr);
646 goto err_resource_files;
649 /* add platform-specific attributes */
650 if (pcibios_add_platform_entries(pdev))
656 if (pci_resource_len(pdev, PCI_ROM_RESOURCE))
657 sysfs_remove_bin_file(&pdev->dev.kobj, rom_attr);
661 pci_remove_resource_files(pdev);
663 if (pdev->cfg_size < 4096)
664 sysfs_remove_bin_file(&pdev->dev.kobj, &pci_config_attr);
666 sysfs_remove_bin_file(&pdev->dev.kobj, &pcie_config_attr);
672 * pci_remove_sysfs_dev_files - cleanup PCI specific sysfs files
673 * @pdev: device whose entries we should free
675 * Cleanup when @pdev is removed from sysfs.
677 void pci_remove_sysfs_dev_files(struct pci_dev *pdev)
679 if (!sysfs_initialized)
682 if (pdev->cfg_size < 4096)
683 sysfs_remove_bin_file(&pdev->dev.kobj, &pci_config_attr);
685 sysfs_remove_bin_file(&pdev->dev.kobj, &pcie_config_attr);
687 pci_remove_resource_files(pdev);
689 if (pci_resource_len(pdev, PCI_ROM_RESOURCE)) {
690 if (pdev->rom_attr) {
691 sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr);
692 kfree(pdev->rom_attr);
697 static int __init pci_sysfs_init(void)
699 struct pci_dev *pdev = NULL;
702 sysfs_initialized = 1;
703 for_each_pci_dev(pdev) {
704 retval = pci_create_sysfs_dev_files(pdev);
714 late_initcall(pci_sysfs_init);