1 // SPDX-License-Identifier: GPL-2.0
3 * (C) Copyright 2002-2004 Greg Kroah-Hartman <greg@kroah.com>
4 * (C) Copyright 2002-2004 IBM Corp.
5 * (C) Copyright 2003 Matthew Wilcox
6 * (C) Copyright 2003 Hewlett-Packard
7 * (C) Copyright 2004 Jon Smirl <jonsmirl@yahoo.com>
8 * (C) Copyright 2004 Silicon Graphics, Inc. Jesse Barnes <jbarnes@sgi.com>
10 * File attributes for PCI devices
12 * Modeled after usb's driverfs.c
16 #include <linux/kernel.h>
17 #include <linux/sched.h>
18 #include <linux/pci.h>
19 #include <linux/stat.h>
20 #include <linux/export.h>
21 #include <linux/topology.h>
24 #include <linux/capability.h>
25 #include <linux/security.h>
26 #include <linux/slab.h>
27 #include <linux/vgaarb.h>
28 #include <linux/pm_runtime.h>
32 static int sysfs_initialized; /* = 0 */
34 /* show configuration fields */
35 #define pci_config_attr(field, format_string) \
37 field##_show(struct device *dev, struct device_attribute *attr, char *buf) \
39 struct pci_dev *pdev; \
41 pdev = to_pci_dev(dev); \
42 return sprintf(buf, format_string, pdev->field); \
44 static DEVICE_ATTR_RO(field)
46 pci_config_attr(vendor, "0x%04x\n");
47 pci_config_attr(device, "0x%04x\n");
48 pci_config_attr(subsystem_vendor, "0x%04x\n");
49 pci_config_attr(subsystem_device, "0x%04x\n");
50 pci_config_attr(revision, "0x%02x\n");
51 pci_config_attr(class, "0x%06x\n");
52 pci_config_attr(irq, "%u\n");
54 static ssize_t broken_parity_status_show(struct device *dev,
55 struct device_attribute *attr,
58 struct pci_dev *pdev = to_pci_dev(dev);
59 return sprintf(buf, "%u\n", pdev->broken_parity_status);
62 static ssize_t broken_parity_status_store(struct device *dev,
63 struct device_attribute *attr,
64 const char *buf, size_t count)
66 struct pci_dev *pdev = to_pci_dev(dev);
69 if (kstrtoul(buf, 0, &val) < 0)
72 pdev->broken_parity_status = !!val;
76 static DEVICE_ATTR_RW(broken_parity_status);
78 static ssize_t pci_dev_show_local_cpu(struct device *dev, bool list,
79 struct device_attribute *attr, char *buf)
81 const struct cpumask *mask;
84 mask = (dev_to_node(dev) == -1) ? cpu_online_mask :
85 cpumask_of_node(dev_to_node(dev));
87 mask = cpumask_of_pcibus(to_pci_dev(dev)->bus);
89 return cpumap_print_to_pagebuf(list, buf, mask);
92 static ssize_t local_cpus_show(struct device *dev,
93 struct device_attribute *attr, char *buf)
95 return pci_dev_show_local_cpu(dev, false, attr, buf);
97 static DEVICE_ATTR_RO(local_cpus);
99 static ssize_t local_cpulist_show(struct device *dev,
100 struct device_attribute *attr, char *buf)
102 return pci_dev_show_local_cpu(dev, true, attr, buf);
104 static DEVICE_ATTR_RO(local_cpulist);
107 * PCI Bus Class Devices
109 static ssize_t cpuaffinity_show(struct device *dev,
110 struct device_attribute *attr, char *buf)
112 const struct cpumask *cpumask = cpumask_of_pcibus(to_pci_bus(dev));
114 return cpumap_print_to_pagebuf(false, buf, cpumask);
116 static DEVICE_ATTR_RO(cpuaffinity);
118 static ssize_t cpulistaffinity_show(struct device *dev,
119 struct device_attribute *attr, char *buf)
121 const struct cpumask *cpumask = cpumask_of_pcibus(to_pci_bus(dev));
123 return cpumap_print_to_pagebuf(true, buf, cpumask);
125 static DEVICE_ATTR_RO(cpulistaffinity);
128 static ssize_t resource_show(struct device *dev, struct device_attribute *attr,
131 struct pci_dev *pci_dev = to_pci_dev(dev);
135 resource_size_t start, end;
137 if (pci_dev->subordinate)
138 max = DEVICE_COUNT_RESOURCE;
140 max = PCI_BRIDGE_RESOURCES;
142 for (i = 0; i < max; i++) {
143 struct resource *res = &pci_dev->resource[i];
144 pci_resource_to_user(pci_dev, i, res, &start, &end);
145 str += sprintf(str, "0x%016llx 0x%016llx 0x%016llx\n",
146 (unsigned long long)start,
147 (unsigned long long)end,
148 (unsigned long long)res->flags);
152 static DEVICE_ATTR_RO(resource);
154 static ssize_t max_link_speed_show(struct device *dev,
155 struct device_attribute *attr, char *buf)
157 struct pci_dev *pdev = to_pci_dev(dev);
159 return sprintf(buf, "%s\n",
160 pci_speed_string(pcie_get_speed_cap(pdev)));
162 static DEVICE_ATTR_RO(max_link_speed);
164 static ssize_t max_link_width_show(struct device *dev,
165 struct device_attribute *attr, char *buf)
167 struct pci_dev *pdev = to_pci_dev(dev);
169 return sprintf(buf, "%u\n", pcie_get_width_cap(pdev));
171 static DEVICE_ATTR_RO(max_link_width);
173 static ssize_t current_link_speed_show(struct device *dev,
174 struct device_attribute *attr, char *buf)
176 struct pci_dev *pci_dev = to_pci_dev(dev);
179 enum pci_bus_speed speed;
181 err = pcie_capability_read_word(pci_dev, PCI_EXP_LNKSTA, &linkstat);
185 speed = pcie_link_speed[linkstat & PCI_EXP_LNKSTA_CLS];
187 return sprintf(buf, "%s\n", pci_speed_string(speed));
189 static DEVICE_ATTR_RO(current_link_speed);
191 static ssize_t current_link_width_show(struct device *dev,
192 struct device_attribute *attr, char *buf)
194 struct pci_dev *pci_dev = to_pci_dev(dev);
198 err = pcie_capability_read_word(pci_dev, PCI_EXP_LNKSTA, &linkstat);
202 return sprintf(buf, "%u\n",
203 (linkstat & PCI_EXP_LNKSTA_NLW) >> PCI_EXP_LNKSTA_NLW_SHIFT);
205 static DEVICE_ATTR_RO(current_link_width);
207 static ssize_t secondary_bus_number_show(struct device *dev,
208 struct device_attribute *attr,
211 struct pci_dev *pci_dev = to_pci_dev(dev);
215 err = pci_read_config_byte(pci_dev, PCI_SECONDARY_BUS, &sec_bus);
219 return sprintf(buf, "%u\n", sec_bus);
221 static DEVICE_ATTR_RO(secondary_bus_number);
223 static ssize_t subordinate_bus_number_show(struct device *dev,
224 struct device_attribute *attr,
227 struct pci_dev *pci_dev = to_pci_dev(dev);
231 err = pci_read_config_byte(pci_dev, PCI_SUBORDINATE_BUS, &sub_bus);
235 return sprintf(buf, "%u\n", sub_bus);
237 static DEVICE_ATTR_RO(subordinate_bus_number);
239 static ssize_t ari_enabled_show(struct device *dev,
240 struct device_attribute *attr,
243 struct pci_dev *pci_dev = to_pci_dev(dev);
245 return sprintf(buf, "%u\n", pci_ari_enabled(pci_dev->bus));
247 static DEVICE_ATTR_RO(ari_enabled);
249 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
252 struct pci_dev *pci_dev = to_pci_dev(dev);
254 return sprintf(buf, "pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X\n",
255 pci_dev->vendor, pci_dev->device,
256 pci_dev->subsystem_vendor, pci_dev->subsystem_device,
257 (u8)(pci_dev->class >> 16), (u8)(pci_dev->class >> 8),
258 (u8)(pci_dev->class));
260 static DEVICE_ATTR_RO(modalias);
262 static ssize_t enable_store(struct device *dev, struct device_attribute *attr,
263 const char *buf, size_t count)
265 struct pci_dev *pdev = to_pci_dev(dev);
267 ssize_t result = kstrtoul(buf, 0, &val);
272 /* this can crash the machine when done on the "wrong" device */
273 if (!capable(CAP_SYS_ADMIN))
280 result = pci_enable_device(pdev);
281 else if (pci_is_enabled(pdev))
282 pci_disable_device(pdev);
287 return result < 0 ? result : count;
290 static ssize_t enable_show(struct device *dev, struct device_attribute *attr,
293 struct pci_dev *pdev;
295 pdev = to_pci_dev(dev);
296 return sprintf(buf, "%u\n", atomic_read(&pdev->enable_cnt));
298 static DEVICE_ATTR_RW(enable);
301 static ssize_t numa_node_store(struct device *dev,
302 struct device_attribute *attr, const char *buf,
305 struct pci_dev *pdev = to_pci_dev(dev);
308 if (!capable(CAP_SYS_ADMIN))
311 ret = kstrtoint(buf, 0, &node);
315 if ((node < 0 && node != NUMA_NO_NODE) || node >= MAX_NUMNODES)
318 if (node != NUMA_NO_NODE && !node_online(node))
321 add_taint(TAINT_FIRMWARE_WORKAROUND, LOCKDEP_STILL_OK);
322 pci_alert(pdev, FW_BUG "Overriding NUMA node to %d. Contact your vendor for updates.",
325 dev->numa_node = node;
329 static ssize_t numa_node_show(struct device *dev, struct device_attribute *attr,
332 return sprintf(buf, "%d\n", dev->numa_node);
334 static DEVICE_ATTR_RW(numa_node);
337 static ssize_t dma_mask_bits_show(struct device *dev,
338 struct device_attribute *attr, char *buf)
340 struct pci_dev *pdev = to_pci_dev(dev);
342 return sprintf(buf, "%d\n", fls64(pdev->dma_mask));
344 static DEVICE_ATTR_RO(dma_mask_bits);
346 static ssize_t consistent_dma_mask_bits_show(struct device *dev,
347 struct device_attribute *attr,
350 return sprintf(buf, "%d\n", fls64(dev->coherent_dma_mask));
352 static DEVICE_ATTR_RO(consistent_dma_mask_bits);
354 static ssize_t msi_bus_show(struct device *dev, struct device_attribute *attr,
357 struct pci_dev *pdev = to_pci_dev(dev);
358 struct pci_bus *subordinate = pdev->subordinate;
360 return sprintf(buf, "%u\n", subordinate ?
361 !(subordinate->bus_flags & PCI_BUS_FLAGS_NO_MSI)
365 static ssize_t msi_bus_store(struct device *dev, struct device_attribute *attr,
366 const char *buf, size_t count)
368 struct pci_dev *pdev = to_pci_dev(dev);
369 struct pci_bus *subordinate = pdev->subordinate;
372 if (kstrtoul(buf, 0, &val) < 0)
375 if (!capable(CAP_SYS_ADMIN))
379 * "no_msi" and "bus_flags" only affect what happens when a driver
380 * requests MSI or MSI-X. They don't affect any drivers that have
381 * already requested MSI or MSI-X.
385 pci_info(pdev, "MSI/MSI-X %s for future drivers\n",
386 val ? "allowed" : "disallowed");
391 subordinate->bus_flags &= ~PCI_BUS_FLAGS_NO_MSI;
393 subordinate->bus_flags |= PCI_BUS_FLAGS_NO_MSI;
395 dev_info(&subordinate->dev, "MSI/MSI-X %s for future drivers of devices on this bus\n",
396 val ? "allowed" : "disallowed");
399 static DEVICE_ATTR_RW(msi_bus);
401 static ssize_t rescan_store(struct bus_type *bus, const char *buf, size_t count)
404 struct pci_bus *b = NULL;
406 if (kstrtoul(buf, 0, &val) < 0)
410 pci_lock_rescan_remove();
411 while ((b = pci_find_next_bus(b)) != NULL)
413 pci_unlock_rescan_remove();
417 static BUS_ATTR_WO(rescan);
419 static struct attribute *pci_bus_attrs[] = {
420 &bus_attr_rescan.attr,
424 static const struct attribute_group pci_bus_group = {
425 .attrs = pci_bus_attrs,
428 const struct attribute_group *pci_bus_groups[] = {
433 static ssize_t dev_rescan_store(struct device *dev,
434 struct device_attribute *attr, const char *buf,
438 struct pci_dev *pdev = to_pci_dev(dev);
440 if (kstrtoul(buf, 0, &val) < 0)
444 pci_lock_rescan_remove();
445 pci_rescan_bus(pdev->bus);
446 pci_unlock_rescan_remove();
450 static struct device_attribute dev_attr_dev_rescan = __ATTR(rescan, 0200, NULL,
453 static ssize_t remove_store(struct device *dev, struct device_attribute *attr,
454 const char *buf, size_t count)
458 if (kstrtoul(buf, 0, &val) < 0)
461 if (val && device_remove_file_self(dev, attr))
462 pci_stop_and_remove_bus_device_locked(to_pci_dev(dev));
465 static DEVICE_ATTR_IGNORE_LOCKDEP(remove, 0220, NULL,
468 static ssize_t bus_rescan_store(struct device *dev,
469 struct device_attribute *attr,
470 const char *buf, size_t count)
473 struct pci_bus *bus = to_pci_bus(dev);
475 if (kstrtoul(buf, 0, &val) < 0)
479 pci_lock_rescan_remove();
480 if (!pci_is_root_bus(bus) && list_empty(&bus->devices))
481 pci_rescan_bus_bridge_resize(bus->self);
484 pci_unlock_rescan_remove();
488 static struct device_attribute dev_attr_bus_rescan = __ATTR(rescan, 0200, NULL,
491 #if defined(CONFIG_PM) && defined(CONFIG_ACPI)
492 static ssize_t d3cold_allowed_store(struct device *dev,
493 struct device_attribute *attr,
494 const char *buf, size_t count)
496 struct pci_dev *pdev = to_pci_dev(dev);
499 if (kstrtoul(buf, 0, &val) < 0)
502 pdev->d3cold_allowed = !!val;
503 pci_bridge_d3_update(pdev);
505 pm_runtime_resume(dev);
510 static ssize_t d3cold_allowed_show(struct device *dev,
511 struct device_attribute *attr, char *buf)
513 struct pci_dev *pdev = to_pci_dev(dev);
514 return sprintf(buf, "%u\n", pdev->d3cold_allowed);
516 static DEVICE_ATTR_RW(d3cold_allowed);
520 static ssize_t devspec_show(struct device *dev,
521 struct device_attribute *attr, char *buf)
523 struct pci_dev *pdev = to_pci_dev(dev);
524 struct device_node *np = pci_device_to_OF_node(pdev);
528 return sprintf(buf, "%pOF", np);
530 static DEVICE_ATTR_RO(devspec);
533 static ssize_t driver_override_store(struct device *dev,
534 struct device_attribute *attr,
535 const char *buf, size_t count)
537 struct pci_dev *pdev = to_pci_dev(dev);
538 char *driver_override, *old, *cp;
540 /* We need to keep extra room for a newline */
541 if (count >= (PAGE_SIZE - 1))
544 driver_override = kstrndup(buf, count, GFP_KERNEL);
545 if (!driver_override)
548 cp = strchr(driver_override, '\n');
553 old = pdev->driver_override;
554 if (strlen(driver_override)) {
555 pdev->driver_override = driver_override;
557 kfree(driver_override);
558 pdev->driver_override = NULL;
567 static ssize_t driver_override_show(struct device *dev,
568 struct device_attribute *attr, char *buf)
570 struct pci_dev *pdev = to_pci_dev(dev);
574 len = scnprintf(buf, PAGE_SIZE, "%s\n", pdev->driver_override);
578 static DEVICE_ATTR_RW(driver_override);
580 static struct attribute *pci_dev_attrs[] = {
581 &dev_attr_resource.attr,
582 &dev_attr_vendor.attr,
583 &dev_attr_device.attr,
584 &dev_attr_subsystem_vendor.attr,
585 &dev_attr_subsystem_device.attr,
586 &dev_attr_revision.attr,
587 &dev_attr_class.attr,
589 &dev_attr_local_cpus.attr,
590 &dev_attr_local_cpulist.attr,
591 &dev_attr_modalias.attr,
593 &dev_attr_numa_node.attr,
595 &dev_attr_dma_mask_bits.attr,
596 &dev_attr_consistent_dma_mask_bits.attr,
597 &dev_attr_enable.attr,
598 &dev_attr_broken_parity_status.attr,
599 &dev_attr_msi_bus.attr,
600 #if defined(CONFIG_PM) && defined(CONFIG_ACPI)
601 &dev_attr_d3cold_allowed.attr,
604 &dev_attr_devspec.attr,
606 &dev_attr_driver_override.attr,
607 &dev_attr_ari_enabled.attr,
611 static struct attribute *pci_bridge_attrs[] = {
612 &dev_attr_subordinate_bus_number.attr,
613 &dev_attr_secondary_bus_number.attr,
617 static struct attribute *pcie_dev_attrs[] = {
618 &dev_attr_current_link_speed.attr,
619 &dev_attr_current_link_width.attr,
620 &dev_attr_max_link_width.attr,
621 &dev_attr_max_link_speed.attr,
625 static struct attribute *pcibus_attrs[] = {
626 &dev_attr_bus_rescan.attr,
627 &dev_attr_cpuaffinity.attr,
628 &dev_attr_cpulistaffinity.attr,
632 static const struct attribute_group pcibus_group = {
633 .attrs = pcibus_attrs,
636 const struct attribute_group *pcibus_groups[] = {
641 static ssize_t boot_vga_show(struct device *dev, struct device_attribute *attr,
644 struct pci_dev *pdev = to_pci_dev(dev);
645 struct pci_dev *vga_dev = vga_default_device();
648 return sprintf(buf, "%u\n", (pdev == vga_dev));
650 return sprintf(buf, "%u\n",
651 !!(pdev->resource[PCI_ROM_RESOURCE].flags &
652 IORESOURCE_ROM_SHADOW));
654 static DEVICE_ATTR_RO(boot_vga);
656 static ssize_t pci_read_config(struct file *filp, struct kobject *kobj,
657 struct bin_attribute *bin_attr, char *buf,
658 loff_t off, size_t count)
660 struct pci_dev *dev = to_pci_dev(kobj_to_dev(kobj));
661 unsigned int size = 64;
662 loff_t init_off = off;
663 u8 *data = (u8 *) buf;
665 /* Several chips lock up trying to read undefined config space */
666 if (file_ns_capable(filp, &init_user_ns, CAP_SYS_ADMIN))
667 size = dev->cfg_size;
668 else if (dev->hdr_type == PCI_HEADER_TYPE_CARDBUS)
673 if (off + count > size) {
680 pci_config_pm_runtime_get(dev);
682 if ((off & 1) && size) {
684 pci_user_read_config_byte(dev, off, &val);
685 data[off - init_off] = val;
690 if ((off & 3) && size > 2) {
692 pci_user_read_config_word(dev, off, &val);
693 data[off - init_off] = val & 0xff;
694 data[off - init_off + 1] = (val >> 8) & 0xff;
701 pci_user_read_config_dword(dev, off, &val);
702 data[off - init_off] = val & 0xff;
703 data[off - init_off + 1] = (val >> 8) & 0xff;
704 data[off - init_off + 2] = (val >> 16) & 0xff;
705 data[off - init_off + 3] = (val >> 24) & 0xff;
713 pci_user_read_config_word(dev, off, &val);
714 data[off - init_off] = val & 0xff;
715 data[off - init_off + 1] = (val >> 8) & 0xff;
722 pci_user_read_config_byte(dev, off, &val);
723 data[off - init_off] = val;
728 pci_config_pm_runtime_put(dev);
733 static ssize_t pci_write_config(struct file *filp, struct kobject *kobj,
734 struct bin_attribute *bin_attr, char *buf,
735 loff_t off, size_t count)
737 struct pci_dev *dev = to_pci_dev(kobj_to_dev(kobj));
738 unsigned int size = count;
739 loff_t init_off = off;
740 u8 *data = (u8 *) buf;
743 ret = security_locked_down(LOCKDOWN_PCI_ACCESS);
747 if (off > dev->cfg_size)
749 if (off + count > dev->cfg_size) {
750 size = dev->cfg_size - off;
754 pci_config_pm_runtime_get(dev);
756 if ((off & 1) && size) {
757 pci_user_write_config_byte(dev, off, data[off - init_off]);
762 if ((off & 3) && size > 2) {
763 u16 val = data[off - init_off];
764 val |= (u16) data[off - init_off + 1] << 8;
765 pci_user_write_config_word(dev, off, val);
771 u32 val = data[off - init_off];
772 val |= (u32) data[off - init_off + 1] << 8;
773 val |= (u32) data[off - init_off + 2] << 16;
774 val |= (u32) data[off - init_off + 3] << 24;
775 pci_user_write_config_dword(dev, off, val);
781 u16 val = data[off - init_off];
782 val |= (u16) data[off - init_off + 1] << 8;
783 pci_user_write_config_word(dev, off, val);
789 pci_user_write_config_byte(dev, off, data[off - init_off]);
794 pci_config_pm_runtime_put(dev);
799 #ifdef HAVE_PCI_LEGACY
801 * pci_read_legacy_io - read byte(s) from legacy I/O port space
802 * @filp: open sysfs file
803 * @kobj: kobject corresponding to file to read from
804 * @bin_attr: struct bin_attribute for this file
805 * @buf: buffer to store results
806 * @off: offset into legacy I/O port space
807 * @count: number of bytes to read
809 * Reads 1, 2, or 4 bytes from legacy I/O port space using an arch specific
810 * callback routine (pci_legacy_read).
812 static ssize_t pci_read_legacy_io(struct file *filp, struct kobject *kobj,
813 struct bin_attribute *bin_attr, char *buf,
814 loff_t off, size_t count)
816 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
818 /* Only support 1, 2 or 4 byte accesses */
819 if (count != 1 && count != 2 && count != 4)
822 return pci_legacy_read(bus, off, (u32 *)buf, count);
826 * pci_write_legacy_io - write byte(s) to legacy I/O port space
827 * @filp: open sysfs file
828 * @kobj: kobject corresponding to file to read from
829 * @bin_attr: struct bin_attribute for this file
830 * @buf: buffer containing value to be written
831 * @off: offset into legacy I/O port space
832 * @count: number of bytes to write
834 * Writes 1, 2, or 4 bytes from legacy I/O port space using an arch specific
835 * callback routine (pci_legacy_write).
837 static ssize_t pci_write_legacy_io(struct file *filp, struct kobject *kobj,
838 struct bin_attribute *bin_attr, char *buf,
839 loff_t off, size_t count)
841 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
843 /* Only support 1, 2 or 4 byte accesses */
844 if (count != 1 && count != 2 && count != 4)
847 return pci_legacy_write(bus, off, *(u32 *)buf, count);
851 * pci_mmap_legacy_mem - map legacy PCI memory into user memory space
852 * @filp: open sysfs file
853 * @kobj: kobject corresponding to device to be mapped
854 * @attr: struct bin_attribute for this file
855 * @vma: struct vm_area_struct passed to mmap
857 * Uses an arch specific callback, pci_mmap_legacy_mem_page_range, to mmap
858 * legacy memory space (first meg of bus space) into application virtual
861 static int pci_mmap_legacy_mem(struct file *filp, struct kobject *kobj,
862 struct bin_attribute *attr,
863 struct vm_area_struct *vma)
865 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
867 return pci_mmap_legacy_page_range(bus, vma, pci_mmap_mem);
871 * pci_mmap_legacy_io - map legacy PCI IO into user memory space
872 * @filp: open sysfs file
873 * @kobj: kobject corresponding to device to be mapped
874 * @attr: struct bin_attribute for this file
875 * @vma: struct vm_area_struct passed to mmap
877 * Uses an arch specific callback, pci_mmap_legacy_io_page_range, to mmap
878 * legacy IO space (first meg of bus space) into application virtual
879 * memory space. Returns -ENOSYS if the operation isn't supported
881 static int pci_mmap_legacy_io(struct file *filp, struct kobject *kobj,
882 struct bin_attribute *attr,
883 struct vm_area_struct *vma)
885 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
887 return pci_mmap_legacy_page_range(bus, vma, pci_mmap_io);
891 * pci_adjust_legacy_attr - adjustment of legacy file attributes
892 * @b: bus to create files under
893 * @mmap_type: I/O port or memory
895 * Stub implementation. Can be overridden by arch if necessary.
897 void __weak pci_adjust_legacy_attr(struct pci_bus *b,
898 enum pci_mmap_state mmap_type)
903 * pci_create_legacy_files - create legacy I/O port and memory files
904 * @b: bus to create files under
906 * Some platforms allow access to legacy I/O port and ISA memory space on
907 * a per-bus basis. This routine creates the files and ties them into
908 * their associated read, write and mmap files from pci-sysfs.c
910 * On error unwind, but don't propagate the error to the caller
911 * as it is ok to set up the PCI bus without these files.
913 void pci_create_legacy_files(struct pci_bus *b)
917 b->legacy_io = kcalloc(2, sizeof(struct bin_attribute),
922 sysfs_bin_attr_init(b->legacy_io);
923 b->legacy_io->attr.name = "legacy_io";
924 b->legacy_io->size = 0xffff;
925 b->legacy_io->attr.mode = 0600;
926 b->legacy_io->read = pci_read_legacy_io;
927 b->legacy_io->write = pci_write_legacy_io;
928 b->legacy_io->mmap = pci_mmap_legacy_io;
929 pci_adjust_legacy_attr(b, pci_mmap_io);
930 error = device_create_bin_file(&b->dev, b->legacy_io);
934 /* Allocated above after the legacy_io struct */
935 b->legacy_mem = b->legacy_io + 1;
936 sysfs_bin_attr_init(b->legacy_mem);
937 b->legacy_mem->attr.name = "legacy_mem";
938 b->legacy_mem->size = 1024*1024;
939 b->legacy_mem->attr.mode = 0600;
940 b->legacy_mem->mmap = pci_mmap_legacy_mem;
941 pci_adjust_legacy_attr(b, pci_mmap_mem);
942 error = device_create_bin_file(&b->dev, b->legacy_mem);
949 device_remove_bin_file(&b->dev, b->legacy_io);
954 dev_warn(&b->dev, "could not create legacy I/O port and ISA memory resources in sysfs\n");
957 void pci_remove_legacy_files(struct pci_bus *b)
960 device_remove_bin_file(&b->dev, b->legacy_io);
961 device_remove_bin_file(&b->dev, b->legacy_mem);
962 kfree(b->legacy_io); /* both are allocated here */
965 #endif /* HAVE_PCI_LEGACY */
967 #if defined(HAVE_PCI_MMAP) || defined(ARCH_GENERIC_PCI_MMAP_RESOURCE)
969 int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vma,
970 enum pci_mmap_api mmap_api)
972 unsigned long nr, start, size;
973 resource_size_t pci_start = 0, pci_end;
975 if (pci_resource_len(pdev, resno) == 0)
978 start = vma->vm_pgoff;
979 size = ((pci_resource_len(pdev, resno) - 1) >> PAGE_SHIFT) + 1;
980 if (mmap_api == PCI_MMAP_PROCFS) {
981 pci_resource_to_user(pdev, resno, &pdev->resource[resno],
982 &pci_start, &pci_end);
983 pci_start >>= PAGE_SHIFT;
985 if (start >= pci_start && start < pci_start + size &&
986 start + nr <= pci_start + size)
992 * pci_mmap_resource - map a PCI resource into user memory space
993 * @kobj: kobject for mapping
994 * @attr: struct bin_attribute for the file being mapped
995 * @vma: struct vm_area_struct passed into the mmap
996 * @write_combine: 1 for write_combine mapping
998 * Use the regular PCI mapping routines to map a PCI resource into userspace.
1000 static int pci_mmap_resource(struct kobject *kobj, struct bin_attribute *attr,
1001 struct vm_area_struct *vma, int write_combine)
1003 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1004 int bar = (unsigned long)attr->private;
1005 enum pci_mmap_state mmap_type;
1006 struct resource *res = &pdev->resource[bar];
1009 ret = security_locked_down(LOCKDOWN_PCI_ACCESS);
1013 if (res->flags & IORESOURCE_MEM && iomem_is_exclusive(res->start))
1016 if (!pci_mmap_fits(pdev, bar, vma, PCI_MMAP_SYSFS))
1019 mmap_type = res->flags & IORESOURCE_MEM ? pci_mmap_mem : pci_mmap_io;
1021 return pci_mmap_resource_range(pdev, bar, vma, mmap_type, write_combine);
1024 static int pci_mmap_resource_uc(struct file *filp, struct kobject *kobj,
1025 struct bin_attribute *attr,
1026 struct vm_area_struct *vma)
1028 return pci_mmap_resource(kobj, attr, vma, 0);
1031 static int pci_mmap_resource_wc(struct file *filp, struct kobject *kobj,
1032 struct bin_attribute *attr,
1033 struct vm_area_struct *vma)
1035 return pci_mmap_resource(kobj, attr, vma, 1);
1038 static ssize_t pci_resource_io(struct file *filp, struct kobject *kobj,
1039 struct bin_attribute *attr, char *buf,
1040 loff_t off, size_t count, bool write)
1042 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1043 int bar = (unsigned long)attr->private;
1044 unsigned long port = off;
1046 port += pci_resource_start(pdev, bar);
1048 if (port > pci_resource_end(pdev, bar))
1051 if (port + count - 1 > pci_resource_end(pdev, bar))
1057 outb(*(u8 *)buf, port);
1059 *(u8 *)buf = inb(port);
1063 outw(*(u16 *)buf, port);
1065 *(u16 *)buf = inw(port);
1069 outl(*(u32 *)buf, port);
1071 *(u32 *)buf = inl(port);
1077 static ssize_t pci_read_resource_io(struct file *filp, struct kobject *kobj,
1078 struct bin_attribute *attr, char *buf,
1079 loff_t off, size_t count)
1081 return pci_resource_io(filp, kobj, attr, buf, off, count, false);
1084 static ssize_t pci_write_resource_io(struct file *filp, struct kobject *kobj,
1085 struct bin_attribute *attr, char *buf,
1086 loff_t off, size_t count)
1090 ret = security_locked_down(LOCKDOWN_PCI_ACCESS);
1094 return pci_resource_io(filp, kobj, attr, buf, off, count, true);
1098 * pci_remove_resource_files - cleanup resource files
1099 * @pdev: dev to cleanup
1101 * If we created resource files for @pdev, remove them from sysfs and
1102 * free their resources.
1104 static void pci_remove_resource_files(struct pci_dev *pdev)
1108 for (i = 0; i < PCI_STD_NUM_BARS; i++) {
1109 struct bin_attribute *res_attr;
1111 res_attr = pdev->res_attr[i];
1113 sysfs_remove_bin_file(&pdev->dev.kobj, res_attr);
1117 res_attr = pdev->res_attr_wc[i];
1119 sysfs_remove_bin_file(&pdev->dev.kobj, res_attr);
1125 static int pci_create_attr(struct pci_dev *pdev, int num, int write_combine)
1127 /* allocate attribute structure, piggyback attribute name */
1128 int name_len = write_combine ? 13 : 10;
1129 struct bin_attribute *res_attr;
1130 char *res_attr_name;
1133 res_attr = kzalloc(sizeof(*res_attr) + name_len, GFP_ATOMIC);
1137 res_attr_name = (char *)(res_attr + 1);
1139 sysfs_bin_attr_init(res_attr);
1140 if (write_combine) {
1141 sprintf(res_attr_name, "resource%d_wc", num);
1142 res_attr->mmap = pci_mmap_resource_wc;
1144 sprintf(res_attr_name, "resource%d", num);
1145 if (pci_resource_flags(pdev, num) & IORESOURCE_IO) {
1146 res_attr->read = pci_read_resource_io;
1147 res_attr->write = pci_write_resource_io;
1148 if (arch_can_pci_mmap_io())
1149 res_attr->mmap = pci_mmap_resource_uc;
1151 res_attr->mmap = pci_mmap_resource_uc;
1154 res_attr->attr.name = res_attr_name;
1155 res_attr->attr.mode = 0600;
1156 res_attr->size = pci_resource_len(pdev, num);
1157 res_attr->private = (void *)(unsigned long)num;
1158 retval = sysfs_create_bin_file(&pdev->dev.kobj, res_attr);
1165 pdev->res_attr_wc[num] = res_attr;
1167 pdev->res_attr[num] = res_attr;
1173 * pci_create_resource_files - create resource files in sysfs for @dev
1174 * @pdev: dev in question
1176 * Walk the resources in @pdev creating files for each resource available.
1178 static int pci_create_resource_files(struct pci_dev *pdev)
1183 /* Expose the PCI resources from this device as files */
1184 for (i = 0; i < PCI_STD_NUM_BARS; i++) {
1186 /* skip empty resources */
1187 if (!pci_resource_len(pdev, i))
1190 retval = pci_create_attr(pdev, i, 0);
1191 /* for prefetchable resources, create a WC mappable file */
1192 if (!retval && arch_can_pci_mmap_wc() &&
1193 pdev->resource[i].flags & IORESOURCE_PREFETCH)
1194 retval = pci_create_attr(pdev, i, 1);
1196 pci_remove_resource_files(pdev);
1202 #else /* !(defined(HAVE_PCI_MMAP) || defined(ARCH_GENERIC_PCI_MMAP_RESOURCE)) */
1203 int __weak pci_create_resource_files(struct pci_dev *dev) { return 0; }
1204 void __weak pci_remove_resource_files(struct pci_dev *dev) { return; }
1208 * pci_write_rom - used to enable access to the PCI ROM display
1210 * @kobj: kernel object handle
1211 * @bin_attr: struct bin_attribute for this file
1214 * @count: number of byte in input
1216 * writing anything except 0 enables it
1218 static ssize_t pci_write_rom(struct file *filp, struct kobject *kobj,
1219 struct bin_attribute *bin_attr, char *buf,
1220 loff_t off, size_t count)
1222 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1224 if ((off == 0) && (*buf == '0') && (count == 2))
1225 pdev->rom_attr_enabled = 0;
1227 pdev->rom_attr_enabled = 1;
1233 * pci_read_rom - read a PCI ROM
1235 * @kobj: kernel object handle
1236 * @bin_attr: struct bin_attribute for this file
1237 * @buf: where to put the data we read from the ROM
1239 * @count: number of bytes to read
1241 * Put @count bytes starting at @off into @buf from the ROM in the PCI
1242 * device corresponding to @kobj.
1244 static ssize_t pci_read_rom(struct file *filp, struct kobject *kobj,
1245 struct bin_attribute *bin_attr, char *buf,
1246 loff_t off, size_t count)
1248 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1252 if (!pdev->rom_attr_enabled)
1255 rom = pci_map_rom(pdev, &size); /* size starts out as PCI window size */
1262 if (off + count > size)
1265 memcpy_fromio(buf, rom + off, count);
1267 pci_unmap_rom(pdev, rom);
1272 static const struct bin_attribute pci_config_attr = {
1277 .size = PCI_CFG_SPACE_SIZE,
1278 .read = pci_read_config,
1279 .write = pci_write_config,
1282 static const struct bin_attribute pcie_config_attr = {
1287 .size = PCI_CFG_SPACE_EXP_SIZE,
1288 .read = pci_read_config,
1289 .write = pci_write_config,
1292 static ssize_t reset_store(struct device *dev, struct device_attribute *attr,
1293 const char *buf, size_t count)
1295 struct pci_dev *pdev = to_pci_dev(dev);
1297 ssize_t result = kstrtoul(buf, 0, &val);
1305 pm_runtime_get_sync(dev);
1306 result = pci_reset_function(pdev);
1307 pm_runtime_put(dev);
1314 static DEVICE_ATTR(reset, 0200, NULL, reset_store);
1316 static int pci_create_capabilities_sysfs(struct pci_dev *dev)
1320 pcie_vpd_create_sysfs_dev_files(dev);
1322 if (dev->reset_fn) {
1323 retval = device_create_file(&dev->dev, &dev_attr_reset);
1330 pcie_vpd_remove_sysfs_dev_files(dev);
1334 int __must_check pci_create_sysfs_dev_files(struct pci_dev *pdev)
1338 struct bin_attribute *attr;
1340 if (!sysfs_initialized)
1343 if (pdev->cfg_size > PCI_CFG_SPACE_SIZE)
1344 retval = sysfs_create_bin_file(&pdev->dev.kobj, &pcie_config_attr);
1346 retval = sysfs_create_bin_file(&pdev->dev.kobj, &pci_config_attr);
1350 retval = pci_create_resource_files(pdev);
1352 goto err_config_file;
1354 /* If the device has a ROM, try to expose it in sysfs. */
1355 rom_size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
1357 attr = kzalloc(sizeof(*attr), GFP_ATOMIC);
1360 goto err_resource_files;
1362 sysfs_bin_attr_init(attr);
1363 attr->size = rom_size;
1364 attr->attr.name = "rom";
1365 attr->attr.mode = 0600;
1366 attr->read = pci_read_rom;
1367 attr->write = pci_write_rom;
1368 retval = sysfs_create_bin_file(&pdev->dev.kobj, attr);
1371 goto err_resource_files;
1373 pdev->rom_attr = attr;
1376 /* add sysfs entries for various capabilities */
1377 retval = pci_create_capabilities_sysfs(pdev);
1381 pci_create_firmware_label_files(pdev);
1386 if (pdev->rom_attr) {
1387 sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr);
1388 kfree(pdev->rom_attr);
1389 pdev->rom_attr = NULL;
1392 pci_remove_resource_files(pdev);
1394 if (pdev->cfg_size > PCI_CFG_SPACE_SIZE)
1395 sysfs_remove_bin_file(&pdev->dev.kobj, &pcie_config_attr);
1397 sysfs_remove_bin_file(&pdev->dev.kobj, &pci_config_attr);
1402 static void pci_remove_capabilities_sysfs(struct pci_dev *dev)
1404 pcie_vpd_remove_sysfs_dev_files(dev);
1405 if (dev->reset_fn) {
1406 device_remove_file(&dev->dev, &dev_attr_reset);
1412 * pci_remove_sysfs_dev_files - cleanup PCI specific sysfs files
1413 * @pdev: device whose entries we should free
1415 * Cleanup when @pdev is removed from sysfs.
1417 void pci_remove_sysfs_dev_files(struct pci_dev *pdev)
1419 if (!sysfs_initialized)
1422 pci_remove_capabilities_sysfs(pdev);
1424 if (pdev->cfg_size > PCI_CFG_SPACE_SIZE)
1425 sysfs_remove_bin_file(&pdev->dev.kobj, &pcie_config_attr);
1427 sysfs_remove_bin_file(&pdev->dev.kobj, &pci_config_attr);
1429 pci_remove_resource_files(pdev);
1431 if (pdev->rom_attr) {
1432 sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr);
1433 kfree(pdev->rom_attr);
1434 pdev->rom_attr = NULL;
1437 pci_remove_firmware_label_files(pdev);
1440 static int __init pci_sysfs_init(void)
1442 struct pci_dev *pdev = NULL;
1445 sysfs_initialized = 1;
1446 for_each_pci_dev(pdev) {
1447 retval = pci_create_sysfs_dev_files(pdev);
1456 late_initcall(pci_sysfs_init);
1458 static struct attribute *pci_dev_dev_attrs[] = {
1459 &dev_attr_boot_vga.attr,
1463 static umode_t pci_dev_attrs_are_visible(struct kobject *kobj,
1464 struct attribute *a, int n)
1466 struct device *dev = kobj_to_dev(kobj);
1467 struct pci_dev *pdev = to_pci_dev(dev);
1469 if (a == &dev_attr_boot_vga.attr)
1470 if ((pdev->class >> 8) != PCI_CLASS_DISPLAY_VGA)
1476 static struct attribute *pci_dev_hp_attrs[] = {
1477 &dev_attr_remove.attr,
1478 &dev_attr_dev_rescan.attr,
1482 static umode_t pci_dev_hp_attrs_are_visible(struct kobject *kobj,
1483 struct attribute *a, int n)
1485 struct device *dev = kobj_to_dev(kobj);
1486 struct pci_dev *pdev = to_pci_dev(dev);
1488 if (pdev->is_virtfn)
1494 static umode_t pci_bridge_attrs_are_visible(struct kobject *kobj,
1495 struct attribute *a, int n)
1497 struct device *dev = kobj_to_dev(kobj);
1498 struct pci_dev *pdev = to_pci_dev(dev);
1500 if (pci_is_bridge(pdev))
1506 static umode_t pcie_dev_attrs_are_visible(struct kobject *kobj,
1507 struct attribute *a, int n)
1509 struct device *dev = kobj_to_dev(kobj);
1510 struct pci_dev *pdev = to_pci_dev(dev);
1512 if (pci_is_pcie(pdev))
1518 static const struct attribute_group pci_dev_group = {
1519 .attrs = pci_dev_attrs,
1522 const struct attribute_group *pci_dev_groups[] = {
1527 static const struct attribute_group pci_dev_hp_attr_group = {
1528 .attrs = pci_dev_hp_attrs,
1529 .is_visible = pci_dev_hp_attrs_are_visible,
1532 static const struct attribute_group pci_dev_attr_group = {
1533 .attrs = pci_dev_dev_attrs,
1534 .is_visible = pci_dev_attrs_are_visible,
1537 static const struct attribute_group pci_bridge_attr_group = {
1538 .attrs = pci_bridge_attrs,
1539 .is_visible = pci_bridge_attrs_are_visible,
1542 static const struct attribute_group pcie_dev_attr_group = {
1543 .attrs = pcie_dev_attrs,
1544 .is_visible = pcie_dev_attrs_are_visible,
1547 static const struct attribute_group *pci_dev_attr_groups[] = {
1548 &pci_dev_attr_group,
1549 &pci_dev_hp_attr_group,
1550 #ifdef CONFIG_PCI_IOV
1551 &sriov_dev_attr_group,
1553 &pci_bridge_attr_group,
1554 &pcie_dev_attr_group,
1555 #ifdef CONFIG_PCIEAER
1556 &aer_stats_attr_group,
1558 #ifdef CONFIG_PCIEASPM
1559 &aspm_ctrl_attr_group,
1564 const struct device_type pci_dev_type = {
1565 .groups = pci_dev_attr_groups,