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", PCIE_SPEED2STR(pcie_get_speed_cap(pdev)));
161 static DEVICE_ATTR_RO(max_link_speed);
163 static ssize_t max_link_width_show(struct device *dev,
164 struct device_attribute *attr, char *buf)
166 struct pci_dev *pdev = to_pci_dev(dev);
168 return sprintf(buf, "%u\n", pcie_get_width_cap(pdev));
170 static DEVICE_ATTR_RO(max_link_width);
172 static ssize_t current_link_speed_show(struct device *dev,
173 struct device_attribute *attr, char *buf)
175 struct pci_dev *pci_dev = to_pci_dev(dev);
180 err = pcie_capability_read_word(pci_dev, PCI_EXP_LNKSTA, &linkstat);
184 switch (linkstat & PCI_EXP_LNKSTA_CLS) {
185 case PCI_EXP_LNKSTA_CLS_32_0GB:
188 case PCI_EXP_LNKSTA_CLS_16_0GB:
191 case PCI_EXP_LNKSTA_CLS_8_0GB:
194 case PCI_EXP_LNKSTA_CLS_5_0GB:
197 case PCI_EXP_LNKSTA_CLS_2_5GB:
201 speed = "Unknown speed";
204 return sprintf(buf, "%s\n", speed);
206 static DEVICE_ATTR_RO(current_link_speed);
208 static ssize_t current_link_width_show(struct device *dev,
209 struct device_attribute *attr, char *buf)
211 struct pci_dev *pci_dev = to_pci_dev(dev);
215 err = pcie_capability_read_word(pci_dev, PCI_EXP_LNKSTA, &linkstat);
219 return sprintf(buf, "%u\n",
220 (linkstat & PCI_EXP_LNKSTA_NLW) >> PCI_EXP_LNKSTA_NLW_SHIFT);
222 static DEVICE_ATTR_RO(current_link_width);
224 static ssize_t secondary_bus_number_show(struct device *dev,
225 struct device_attribute *attr,
228 struct pci_dev *pci_dev = to_pci_dev(dev);
232 err = pci_read_config_byte(pci_dev, PCI_SECONDARY_BUS, &sec_bus);
236 return sprintf(buf, "%u\n", sec_bus);
238 static DEVICE_ATTR_RO(secondary_bus_number);
240 static ssize_t subordinate_bus_number_show(struct device *dev,
241 struct device_attribute *attr,
244 struct pci_dev *pci_dev = to_pci_dev(dev);
248 err = pci_read_config_byte(pci_dev, PCI_SUBORDINATE_BUS, &sub_bus);
252 return sprintf(buf, "%u\n", sub_bus);
254 static DEVICE_ATTR_RO(subordinate_bus_number);
256 static ssize_t ari_enabled_show(struct device *dev,
257 struct device_attribute *attr,
260 struct pci_dev *pci_dev = to_pci_dev(dev);
262 return sprintf(buf, "%u\n", pci_ari_enabled(pci_dev->bus));
264 static DEVICE_ATTR_RO(ari_enabled);
266 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
269 struct pci_dev *pci_dev = to_pci_dev(dev);
271 return sprintf(buf, "pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X\n",
272 pci_dev->vendor, pci_dev->device,
273 pci_dev->subsystem_vendor, pci_dev->subsystem_device,
274 (u8)(pci_dev->class >> 16), (u8)(pci_dev->class >> 8),
275 (u8)(pci_dev->class));
277 static DEVICE_ATTR_RO(modalias);
279 static ssize_t enable_store(struct device *dev, struct device_attribute *attr,
280 const char *buf, size_t count)
282 struct pci_dev *pdev = to_pci_dev(dev);
284 ssize_t result = kstrtoul(buf, 0, &val);
289 /* this can crash the machine when done on the "wrong" device */
290 if (!capable(CAP_SYS_ADMIN))
297 result = pci_enable_device(pdev);
298 else if (pci_is_enabled(pdev))
299 pci_disable_device(pdev);
304 return result < 0 ? result : count;
307 static ssize_t enable_show(struct device *dev, struct device_attribute *attr,
310 struct pci_dev *pdev;
312 pdev = to_pci_dev(dev);
313 return sprintf(buf, "%u\n", atomic_read(&pdev->enable_cnt));
315 static DEVICE_ATTR_RW(enable);
318 static ssize_t numa_node_store(struct device *dev,
319 struct device_attribute *attr, const char *buf,
322 struct pci_dev *pdev = to_pci_dev(dev);
325 if (!capable(CAP_SYS_ADMIN))
328 ret = kstrtoint(buf, 0, &node);
332 if ((node < 0 && node != NUMA_NO_NODE) || node >= MAX_NUMNODES)
335 if (node != NUMA_NO_NODE && !node_online(node))
338 add_taint(TAINT_FIRMWARE_WORKAROUND, LOCKDEP_STILL_OK);
339 pci_alert(pdev, FW_BUG "Overriding NUMA node to %d. Contact your vendor for updates.",
342 dev->numa_node = node;
346 static ssize_t numa_node_show(struct device *dev, struct device_attribute *attr,
349 return sprintf(buf, "%d\n", dev->numa_node);
351 static DEVICE_ATTR_RW(numa_node);
354 static ssize_t dma_mask_bits_show(struct device *dev,
355 struct device_attribute *attr, char *buf)
357 struct pci_dev *pdev = to_pci_dev(dev);
359 return sprintf(buf, "%d\n", fls64(pdev->dma_mask));
361 static DEVICE_ATTR_RO(dma_mask_bits);
363 static ssize_t consistent_dma_mask_bits_show(struct device *dev,
364 struct device_attribute *attr,
367 return sprintf(buf, "%d\n", fls64(dev->coherent_dma_mask));
369 static DEVICE_ATTR_RO(consistent_dma_mask_bits);
371 static ssize_t msi_bus_show(struct device *dev, struct device_attribute *attr,
374 struct pci_dev *pdev = to_pci_dev(dev);
375 struct pci_bus *subordinate = pdev->subordinate;
377 return sprintf(buf, "%u\n", subordinate ?
378 !(subordinate->bus_flags & PCI_BUS_FLAGS_NO_MSI)
382 static ssize_t msi_bus_store(struct device *dev, struct device_attribute *attr,
383 const char *buf, size_t count)
385 struct pci_dev *pdev = to_pci_dev(dev);
386 struct pci_bus *subordinate = pdev->subordinate;
389 if (kstrtoul(buf, 0, &val) < 0)
392 if (!capable(CAP_SYS_ADMIN))
396 * "no_msi" and "bus_flags" only affect what happens when a driver
397 * requests MSI or MSI-X. They don't affect any drivers that have
398 * already requested MSI or MSI-X.
402 pci_info(pdev, "MSI/MSI-X %s for future drivers\n",
403 val ? "allowed" : "disallowed");
408 subordinate->bus_flags &= ~PCI_BUS_FLAGS_NO_MSI;
410 subordinate->bus_flags |= PCI_BUS_FLAGS_NO_MSI;
412 dev_info(&subordinate->dev, "MSI/MSI-X %s for future drivers of devices on this bus\n",
413 val ? "allowed" : "disallowed");
416 static DEVICE_ATTR_RW(msi_bus);
418 static ssize_t rescan_store(struct bus_type *bus, const char *buf, size_t count)
421 struct pci_bus *b = NULL;
423 if (kstrtoul(buf, 0, &val) < 0)
427 pci_lock_rescan_remove();
428 while ((b = pci_find_next_bus(b)) != NULL)
430 pci_unlock_rescan_remove();
434 static BUS_ATTR_WO(rescan);
436 static struct attribute *pci_bus_attrs[] = {
437 &bus_attr_rescan.attr,
441 static const struct attribute_group pci_bus_group = {
442 .attrs = pci_bus_attrs,
445 const struct attribute_group *pci_bus_groups[] = {
450 static ssize_t dev_rescan_store(struct device *dev,
451 struct device_attribute *attr, const char *buf,
455 struct pci_dev *pdev = to_pci_dev(dev);
457 if (kstrtoul(buf, 0, &val) < 0)
461 pci_lock_rescan_remove();
462 pci_rescan_bus(pdev->bus);
463 pci_unlock_rescan_remove();
467 static DEVICE_ATTR_WO(dev_rescan);
469 static ssize_t remove_store(struct device *dev, struct device_attribute *attr,
470 const char *buf, size_t count)
474 if (kstrtoul(buf, 0, &val) < 0)
477 if (val && device_remove_file_self(dev, attr))
478 pci_stop_and_remove_bus_device_locked(to_pci_dev(dev));
481 static DEVICE_ATTR_IGNORE_LOCKDEP(remove, 0220, NULL,
484 static ssize_t bus_rescan_store(struct device *dev,
485 struct device_attribute *attr,
486 const char *buf, size_t count)
489 struct pci_bus *bus = to_pci_bus(dev);
491 if (kstrtoul(buf, 0, &val) < 0)
495 pci_lock_rescan_remove();
496 if (!pci_is_root_bus(bus) && list_empty(&bus->devices))
497 pci_rescan_bus_bridge_resize(bus->self);
500 pci_unlock_rescan_remove();
504 static DEVICE_ATTR_WO(bus_rescan);
506 #if defined(CONFIG_PM) && defined(CONFIG_ACPI)
507 static ssize_t d3cold_allowed_store(struct device *dev,
508 struct device_attribute *attr,
509 const char *buf, size_t count)
511 struct pci_dev *pdev = to_pci_dev(dev);
514 if (kstrtoul(buf, 0, &val) < 0)
517 pdev->d3cold_allowed = !!val;
518 if (pdev->d3cold_allowed)
519 pci_d3cold_enable(pdev);
521 pci_d3cold_disable(pdev);
523 pm_runtime_resume(dev);
528 static ssize_t d3cold_allowed_show(struct device *dev,
529 struct device_attribute *attr, char *buf)
531 struct pci_dev *pdev = to_pci_dev(dev);
532 return sprintf(buf, "%u\n", pdev->d3cold_allowed);
534 static DEVICE_ATTR_RW(d3cold_allowed);
538 static ssize_t devspec_show(struct device *dev,
539 struct device_attribute *attr, char *buf)
541 struct pci_dev *pdev = to_pci_dev(dev);
542 struct device_node *np = pci_device_to_OF_node(pdev);
546 return sprintf(buf, "%pOF", np);
548 static DEVICE_ATTR_RO(devspec);
551 static ssize_t driver_override_store(struct device *dev,
552 struct device_attribute *attr,
553 const char *buf, size_t count)
555 struct pci_dev *pdev = to_pci_dev(dev);
556 char *driver_override, *old, *cp;
558 /* We need to keep extra room for a newline */
559 if (count >= (PAGE_SIZE - 1))
562 driver_override = kstrndup(buf, count, GFP_KERNEL);
563 if (!driver_override)
566 cp = strchr(driver_override, '\n');
571 old = pdev->driver_override;
572 if (strlen(driver_override)) {
573 pdev->driver_override = driver_override;
575 kfree(driver_override);
576 pdev->driver_override = NULL;
585 static ssize_t driver_override_show(struct device *dev,
586 struct device_attribute *attr, char *buf)
588 struct pci_dev *pdev = to_pci_dev(dev);
592 len = snprintf(buf, PAGE_SIZE, "%s\n", pdev->driver_override);
596 static DEVICE_ATTR_RW(driver_override);
598 static struct attribute *pci_dev_attrs[] = {
599 &dev_attr_resource.attr,
600 &dev_attr_vendor.attr,
601 &dev_attr_device.attr,
602 &dev_attr_subsystem_vendor.attr,
603 &dev_attr_subsystem_device.attr,
604 &dev_attr_revision.attr,
605 &dev_attr_class.attr,
607 &dev_attr_local_cpus.attr,
608 &dev_attr_local_cpulist.attr,
609 &dev_attr_modalias.attr,
611 &dev_attr_numa_node.attr,
613 &dev_attr_dma_mask_bits.attr,
614 &dev_attr_consistent_dma_mask_bits.attr,
615 &dev_attr_enable.attr,
616 &dev_attr_broken_parity_status.attr,
617 &dev_attr_msi_bus.attr,
618 #if defined(CONFIG_PM) && defined(CONFIG_ACPI)
619 &dev_attr_d3cold_allowed.attr,
622 &dev_attr_devspec.attr,
624 &dev_attr_driver_override.attr,
625 &dev_attr_ari_enabled.attr,
629 static struct attribute *pci_bridge_attrs[] = {
630 &dev_attr_subordinate_bus_number.attr,
631 &dev_attr_secondary_bus_number.attr,
635 static struct attribute *pcie_dev_attrs[] = {
636 &dev_attr_current_link_speed.attr,
637 &dev_attr_current_link_width.attr,
638 &dev_attr_max_link_width.attr,
639 &dev_attr_max_link_speed.attr,
643 static struct attribute *pcibus_attrs[] = {
644 &dev_attr_bus_rescan.attr,
645 &dev_attr_cpuaffinity.attr,
646 &dev_attr_cpulistaffinity.attr,
650 static const struct attribute_group pcibus_group = {
651 .attrs = pcibus_attrs,
654 const struct attribute_group *pcibus_groups[] = {
659 static ssize_t boot_vga_show(struct device *dev, struct device_attribute *attr,
662 struct pci_dev *pdev = to_pci_dev(dev);
663 struct pci_dev *vga_dev = vga_default_device();
666 return sprintf(buf, "%u\n", (pdev == vga_dev));
668 return sprintf(buf, "%u\n",
669 !!(pdev->resource[PCI_ROM_RESOURCE].flags &
670 IORESOURCE_ROM_SHADOW));
672 static DEVICE_ATTR_RO(boot_vga);
674 static ssize_t pci_read_config(struct file *filp, struct kobject *kobj,
675 struct bin_attribute *bin_attr, char *buf,
676 loff_t off, size_t count)
678 struct pci_dev *dev = to_pci_dev(kobj_to_dev(kobj));
679 unsigned int size = 64;
680 loff_t init_off = off;
681 u8 *data = (u8 *) buf;
683 /* Several chips lock up trying to read undefined config space */
684 if (file_ns_capable(filp, &init_user_ns, CAP_SYS_ADMIN))
685 size = dev->cfg_size;
686 else if (dev->hdr_type == PCI_HEADER_TYPE_CARDBUS)
691 if (off + count > size) {
698 pci_config_pm_runtime_get(dev);
700 if ((off & 1) && size) {
702 pci_user_read_config_byte(dev, off, &val);
703 data[off - init_off] = val;
708 if ((off & 3) && size > 2) {
710 pci_user_read_config_word(dev, off, &val);
711 data[off - init_off] = val & 0xff;
712 data[off - init_off + 1] = (val >> 8) & 0xff;
719 pci_user_read_config_dword(dev, off, &val);
720 data[off - init_off] = val & 0xff;
721 data[off - init_off + 1] = (val >> 8) & 0xff;
722 data[off - init_off + 2] = (val >> 16) & 0xff;
723 data[off - init_off + 3] = (val >> 24) & 0xff;
730 pci_user_read_config_word(dev, off, &val);
731 data[off - init_off] = val & 0xff;
732 data[off - init_off + 1] = (val >> 8) & 0xff;
739 pci_user_read_config_byte(dev, off, &val);
740 data[off - init_off] = val;
745 pci_config_pm_runtime_put(dev);
750 static ssize_t pci_write_config(struct file *filp, struct kobject *kobj,
751 struct bin_attribute *bin_attr, char *buf,
752 loff_t off, size_t count)
754 struct pci_dev *dev = to_pci_dev(kobj_to_dev(kobj));
755 unsigned int size = count;
756 loff_t init_off = off;
757 u8 *data = (u8 *) buf;
760 ret = security_locked_down(LOCKDOWN_PCI_ACCESS);
764 if (off > dev->cfg_size)
766 if (off + count > dev->cfg_size) {
767 size = dev->cfg_size - off;
771 pci_config_pm_runtime_get(dev);
773 if ((off & 1) && size) {
774 pci_user_write_config_byte(dev, off, data[off - init_off]);
779 if ((off & 3) && size > 2) {
780 u16 val = data[off - init_off];
781 val |= (u16) data[off - init_off + 1] << 8;
782 pci_user_write_config_word(dev, off, val);
788 u32 val = data[off - init_off];
789 val |= (u32) data[off - init_off + 1] << 8;
790 val |= (u32) data[off - init_off + 2] << 16;
791 val |= (u32) data[off - init_off + 3] << 24;
792 pci_user_write_config_dword(dev, off, val);
798 u16 val = data[off - init_off];
799 val |= (u16) data[off - init_off + 1] << 8;
800 pci_user_write_config_word(dev, off, val);
806 pci_user_write_config_byte(dev, off, data[off - init_off]);
811 pci_config_pm_runtime_put(dev);
816 #ifdef HAVE_PCI_LEGACY
818 * pci_read_legacy_io - read byte(s) from legacy I/O port space
819 * @filp: open sysfs file
820 * @kobj: kobject corresponding to file to read from
821 * @bin_attr: struct bin_attribute for this file
822 * @buf: buffer to store results
823 * @off: offset into legacy I/O port space
824 * @count: number of bytes to read
826 * Reads 1, 2, or 4 bytes from legacy I/O port space using an arch specific
827 * callback routine (pci_legacy_read).
829 static ssize_t pci_read_legacy_io(struct file *filp, struct kobject *kobj,
830 struct bin_attribute *bin_attr, char *buf,
831 loff_t off, size_t count)
833 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
835 /* Only support 1, 2 or 4 byte accesses */
836 if (count != 1 && count != 2 && count != 4)
839 return pci_legacy_read(bus, off, (u32 *)buf, count);
843 * pci_write_legacy_io - write byte(s) to legacy I/O port space
844 * @filp: open sysfs file
845 * @kobj: kobject corresponding to file to read from
846 * @bin_attr: struct bin_attribute for this file
847 * @buf: buffer containing value to be written
848 * @off: offset into legacy I/O port space
849 * @count: number of bytes to write
851 * Writes 1, 2, or 4 bytes from legacy I/O port space using an arch specific
852 * callback routine (pci_legacy_write).
854 static ssize_t pci_write_legacy_io(struct file *filp, struct kobject *kobj,
855 struct bin_attribute *bin_attr, char *buf,
856 loff_t off, size_t count)
858 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
860 /* Only support 1, 2 or 4 byte accesses */
861 if (count != 1 && count != 2 && count != 4)
864 return pci_legacy_write(bus, off, *(u32 *)buf, count);
868 * pci_mmap_legacy_mem - map legacy PCI memory into user memory space
869 * @filp: open sysfs file
870 * @kobj: kobject corresponding to device to be mapped
871 * @attr: struct bin_attribute for this file
872 * @vma: struct vm_area_struct passed to mmap
874 * Uses an arch specific callback, pci_mmap_legacy_mem_page_range, to mmap
875 * legacy memory space (first meg of bus space) into application virtual
878 static int pci_mmap_legacy_mem(struct file *filp, struct kobject *kobj,
879 struct bin_attribute *attr,
880 struct vm_area_struct *vma)
882 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
884 return pci_mmap_legacy_page_range(bus, vma, pci_mmap_mem);
888 * pci_mmap_legacy_io - map legacy PCI IO into user memory space
889 * @filp: open sysfs file
890 * @kobj: kobject corresponding to device to be mapped
891 * @attr: struct bin_attribute for this file
892 * @vma: struct vm_area_struct passed to mmap
894 * Uses an arch specific callback, pci_mmap_legacy_io_page_range, to mmap
895 * legacy IO space (first meg of bus space) into application virtual
896 * memory space. Returns -ENOSYS if the operation isn't supported
898 static int pci_mmap_legacy_io(struct file *filp, struct kobject *kobj,
899 struct bin_attribute *attr,
900 struct vm_area_struct *vma)
902 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
904 return pci_mmap_legacy_page_range(bus, vma, pci_mmap_io);
908 * pci_adjust_legacy_attr - adjustment of legacy file attributes
909 * @b: bus to create files under
910 * @mmap_type: I/O port or memory
912 * Stub implementation. Can be overridden by arch if necessary.
914 void __weak pci_adjust_legacy_attr(struct pci_bus *b,
915 enum pci_mmap_state mmap_type)
920 * pci_create_legacy_files - create legacy I/O port and memory files
921 * @b: bus to create files under
923 * Some platforms allow access to legacy I/O port and ISA memory space on
924 * a per-bus basis. This routine creates the files and ties them into
925 * their associated read, write and mmap files from pci-sysfs.c
927 * On error unwind, but don't propagate the error to the caller
928 * as it is ok to set up the PCI bus without these files.
930 void pci_create_legacy_files(struct pci_bus *b)
934 b->legacy_io = kcalloc(2, sizeof(struct bin_attribute),
939 sysfs_bin_attr_init(b->legacy_io);
940 b->legacy_io->attr.name = "legacy_io";
941 b->legacy_io->size = 0xffff;
942 b->legacy_io->attr.mode = 0600;
943 b->legacy_io->read = pci_read_legacy_io;
944 b->legacy_io->write = pci_write_legacy_io;
945 b->legacy_io->mmap = pci_mmap_legacy_io;
946 pci_adjust_legacy_attr(b, pci_mmap_io);
947 error = device_create_bin_file(&b->dev, b->legacy_io);
951 /* Allocated above after the legacy_io struct */
952 b->legacy_mem = b->legacy_io + 1;
953 sysfs_bin_attr_init(b->legacy_mem);
954 b->legacy_mem->attr.name = "legacy_mem";
955 b->legacy_mem->size = 1024*1024;
956 b->legacy_mem->attr.mode = 0600;
957 b->legacy_mem->mmap = pci_mmap_legacy_mem;
958 pci_adjust_legacy_attr(b, pci_mmap_mem);
959 error = device_create_bin_file(&b->dev, b->legacy_mem);
966 device_remove_bin_file(&b->dev, b->legacy_io);
971 dev_warn(&b->dev, "could not create legacy I/O port and ISA memory resources in sysfs\n");
974 void pci_remove_legacy_files(struct pci_bus *b)
977 device_remove_bin_file(&b->dev, b->legacy_io);
978 device_remove_bin_file(&b->dev, b->legacy_mem);
979 kfree(b->legacy_io); /* both are allocated here */
982 #endif /* HAVE_PCI_LEGACY */
984 #if defined(HAVE_PCI_MMAP) || defined(ARCH_GENERIC_PCI_MMAP_RESOURCE)
986 int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vma,
987 enum pci_mmap_api mmap_api)
989 unsigned long nr, start, size;
990 resource_size_t pci_start = 0, pci_end;
992 if (pci_resource_len(pdev, resno) == 0)
995 start = vma->vm_pgoff;
996 size = ((pci_resource_len(pdev, resno) - 1) >> PAGE_SHIFT) + 1;
997 if (mmap_api == PCI_MMAP_PROCFS) {
998 pci_resource_to_user(pdev, resno, &pdev->resource[resno],
999 &pci_start, &pci_end);
1000 pci_start >>= PAGE_SHIFT;
1002 if (start >= pci_start && start < pci_start + size &&
1003 start + nr <= pci_start + size)
1009 * pci_mmap_resource - map a PCI resource into user memory space
1010 * @kobj: kobject for mapping
1011 * @attr: struct bin_attribute for the file being mapped
1012 * @vma: struct vm_area_struct passed into the mmap
1013 * @write_combine: 1 for write_combine mapping
1015 * Use the regular PCI mapping routines to map a PCI resource into userspace.
1017 static int pci_mmap_resource(struct kobject *kobj, struct bin_attribute *attr,
1018 struct vm_area_struct *vma, int write_combine)
1020 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1021 int bar = (unsigned long)attr->private;
1022 enum pci_mmap_state mmap_type;
1023 struct resource *res = &pdev->resource[bar];
1026 ret = security_locked_down(LOCKDOWN_PCI_ACCESS);
1030 if (res->flags & IORESOURCE_MEM && iomem_is_exclusive(res->start))
1033 if (!pci_mmap_fits(pdev, bar, vma, PCI_MMAP_SYSFS))
1036 mmap_type = res->flags & IORESOURCE_MEM ? pci_mmap_mem : pci_mmap_io;
1038 return pci_mmap_resource_range(pdev, bar, vma, mmap_type, write_combine);
1041 static int pci_mmap_resource_uc(struct file *filp, struct kobject *kobj,
1042 struct bin_attribute *attr,
1043 struct vm_area_struct *vma)
1045 return pci_mmap_resource(kobj, attr, vma, 0);
1048 static int pci_mmap_resource_wc(struct file *filp, struct kobject *kobj,
1049 struct bin_attribute *attr,
1050 struct vm_area_struct *vma)
1052 return pci_mmap_resource(kobj, attr, vma, 1);
1055 static ssize_t pci_resource_io(struct file *filp, struct kobject *kobj,
1056 struct bin_attribute *attr, char *buf,
1057 loff_t off, size_t count, bool write)
1059 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1060 int bar = (unsigned long)attr->private;
1061 unsigned long port = off;
1063 port += pci_resource_start(pdev, bar);
1065 if (port > pci_resource_end(pdev, bar))
1068 if (port + count - 1 > pci_resource_end(pdev, bar))
1074 outb(*(u8 *)buf, port);
1076 *(u8 *)buf = inb(port);
1080 outw(*(u16 *)buf, port);
1082 *(u16 *)buf = inw(port);
1086 outl(*(u32 *)buf, port);
1088 *(u32 *)buf = inl(port);
1094 static ssize_t pci_read_resource_io(struct file *filp, struct kobject *kobj,
1095 struct bin_attribute *attr, char *buf,
1096 loff_t off, size_t count)
1098 return pci_resource_io(filp, kobj, attr, buf, off, count, false);
1101 static ssize_t pci_write_resource_io(struct file *filp, struct kobject *kobj,
1102 struct bin_attribute *attr, char *buf,
1103 loff_t off, size_t count)
1107 ret = security_locked_down(LOCKDOWN_PCI_ACCESS);
1111 return pci_resource_io(filp, kobj, attr, buf, off, count, true);
1115 * pci_remove_resource_files - cleanup resource files
1116 * @pdev: dev to cleanup
1118 * If we created resource files for @pdev, remove them from sysfs and
1119 * free their resources.
1121 static void pci_remove_resource_files(struct pci_dev *pdev)
1125 for (i = 0; i < PCI_STD_NUM_BARS; i++) {
1126 struct bin_attribute *res_attr;
1128 res_attr = pdev->res_attr[i];
1130 sysfs_remove_bin_file(&pdev->dev.kobj, res_attr);
1134 res_attr = pdev->res_attr_wc[i];
1136 sysfs_remove_bin_file(&pdev->dev.kobj, res_attr);
1142 static int pci_create_attr(struct pci_dev *pdev, int num, int write_combine)
1144 /* allocate attribute structure, piggyback attribute name */
1145 int name_len = write_combine ? 13 : 10;
1146 struct bin_attribute *res_attr;
1147 char *res_attr_name;
1150 res_attr = kzalloc(sizeof(*res_attr) + name_len, GFP_ATOMIC);
1154 res_attr_name = (char *)(res_attr + 1);
1156 sysfs_bin_attr_init(res_attr);
1157 if (write_combine) {
1158 pdev->res_attr_wc[num] = res_attr;
1159 sprintf(res_attr_name, "resource%d_wc", num);
1160 res_attr->mmap = pci_mmap_resource_wc;
1162 pdev->res_attr[num] = res_attr;
1163 sprintf(res_attr_name, "resource%d", num);
1164 if (pci_resource_flags(pdev, num) & IORESOURCE_IO) {
1165 res_attr->read = pci_read_resource_io;
1166 res_attr->write = pci_write_resource_io;
1167 if (arch_can_pci_mmap_io())
1168 res_attr->mmap = pci_mmap_resource_uc;
1170 res_attr->mmap = pci_mmap_resource_uc;
1173 res_attr->attr.name = res_attr_name;
1174 res_attr->attr.mode = 0600;
1175 res_attr->size = pci_resource_len(pdev, num);
1176 res_attr->private = (void *)(unsigned long)num;
1177 retval = sysfs_create_bin_file(&pdev->dev.kobj, res_attr);
1185 * pci_create_resource_files - create resource files in sysfs for @dev
1186 * @pdev: dev in question
1188 * Walk the resources in @pdev creating files for each resource available.
1190 static int pci_create_resource_files(struct pci_dev *pdev)
1195 /* Expose the PCI resources from this device as files */
1196 for (i = 0; i < PCI_STD_NUM_BARS; i++) {
1198 /* skip empty resources */
1199 if (!pci_resource_len(pdev, i))
1202 retval = pci_create_attr(pdev, i, 0);
1203 /* for prefetchable resources, create a WC mappable file */
1204 if (!retval && arch_can_pci_mmap_wc() &&
1205 pdev->resource[i].flags & IORESOURCE_PREFETCH)
1206 retval = pci_create_attr(pdev, i, 1);
1208 pci_remove_resource_files(pdev);
1214 #else /* !HAVE_PCI_MMAP */
1215 int __weak pci_create_resource_files(struct pci_dev *dev) { return 0; }
1216 void __weak pci_remove_resource_files(struct pci_dev *dev) { return; }
1217 #endif /* HAVE_PCI_MMAP */
1220 * pci_write_rom - used to enable access to the PCI ROM display
1222 * @kobj: kernel object handle
1223 * @bin_attr: struct bin_attribute for this file
1226 * @count: number of byte in input
1228 * writing anything except 0 enables it
1230 static ssize_t pci_write_rom(struct file *filp, struct kobject *kobj,
1231 struct bin_attribute *bin_attr, char *buf,
1232 loff_t off, size_t count)
1234 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1236 if ((off == 0) && (*buf == '0') && (count == 2))
1237 pdev->rom_attr_enabled = 0;
1239 pdev->rom_attr_enabled = 1;
1245 * pci_read_rom - read a PCI ROM
1247 * @kobj: kernel object handle
1248 * @bin_attr: struct bin_attribute for this file
1249 * @buf: where to put the data we read from the ROM
1251 * @count: number of bytes to read
1253 * Put @count bytes starting at @off into @buf from the ROM in the PCI
1254 * device corresponding to @kobj.
1256 static ssize_t pci_read_rom(struct file *filp, struct kobject *kobj,
1257 struct bin_attribute *bin_attr, char *buf,
1258 loff_t off, size_t count)
1260 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1264 if (!pdev->rom_attr_enabled)
1267 rom = pci_map_rom(pdev, &size); /* size starts out as PCI window size */
1274 if (off + count > size)
1277 memcpy_fromio(buf, rom + off, count);
1279 pci_unmap_rom(pdev, rom);
1284 static const struct bin_attribute pci_config_attr = {
1289 .size = PCI_CFG_SPACE_SIZE,
1290 .read = pci_read_config,
1291 .write = pci_write_config,
1294 static const struct bin_attribute pcie_config_attr = {
1299 .size = PCI_CFG_SPACE_EXP_SIZE,
1300 .read = pci_read_config,
1301 .write = pci_write_config,
1304 static ssize_t reset_store(struct device *dev, struct device_attribute *attr,
1305 const char *buf, size_t count)
1307 struct pci_dev *pdev = to_pci_dev(dev);
1309 ssize_t result = kstrtoul(buf, 0, &val);
1317 pm_runtime_get_sync(dev);
1318 result = pci_reset_function(pdev);
1319 pm_runtime_put(dev);
1326 static DEVICE_ATTR(reset, 0200, NULL, reset_store);
1328 static int pci_create_capabilities_sysfs(struct pci_dev *dev)
1332 pcie_vpd_create_sysfs_dev_files(dev);
1334 if (dev->reset_fn) {
1335 retval = device_create_file(&dev->dev, &dev_attr_reset);
1342 pcie_vpd_remove_sysfs_dev_files(dev);
1346 int __must_check pci_create_sysfs_dev_files(struct pci_dev *pdev)
1350 struct bin_attribute *attr;
1352 if (!sysfs_initialized)
1355 if (pdev->cfg_size > PCI_CFG_SPACE_SIZE)
1356 retval = sysfs_create_bin_file(&pdev->dev.kobj, &pcie_config_attr);
1358 retval = sysfs_create_bin_file(&pdev->dev.kobj, &pci_config_attr);
1362 retval = pci_create_resource_files(pdev);
1364 goto err_config_file;
1366 /* If the device has a ROM, try to expose it in sysfs. */
1367 rom_size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
1369 attr = kzalloc(sizeof(*attr), GFP_ATOMIC);
1372 goto err_resource_files;
1374 sysfs_bin_attr_init(attr);
1375 attr->size = rom_size;
1376 attr->attr.name = "rom";
1377 attr->attr.mode = 0600;
1378 attr->read = pci_read_rom;
1379 attr->write = pci_write_rom;
1380 retval = sysfs_create_bin_file(&pdev->dev.kobj, attr);
1383 goto err_resource_files;
1385 pdev->rom_attr = attr;
1388 /* add sysfs entries for various capabilities */
1389 retval = pci_create_capabilities_sysfs(pdev);
1393 pci_create_firmware_label_files(pdev);
1398 if (pdev->rom_attr) {
1399 sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr);
1400 kfree(pdev->rom_attr);
1401 pdev->rom_attr = NULL;
1404 pci_remove_resource_files(pdev);
1406 if (pdev->cfg_size > PCI_CFG_SPACE_SIZE)
1407 sysfs_remove_bin_file(&pdev->dev.kobj, &pcie_config_attr);
1409 sysfs_remove_bin_file(&pdev->dev.kobj, &pci_config_attr);
1414 static void pci_remove_capabilities_sysfs(struct pci_dev *dev)
1416 pcie_vpd_remove_sysfs_dev_files(dev);
1417 if (dev->reset_fn) {
1418 device_remove_file(&dev->dev, &dev_attr_reset);
1424 * pci_remove_sysfs_dev_files - cleanup PCI specific sysfs files
1425 * @pdev: device whose entries we should free
1427 * Cleanup when @pdev is removed from sysfs.
1429 void pci_remove_sysfs_dev_files(struct pci_dev *pdev)
1431 if (!sysfs_initialized)
1434 pci_remove_capabilities_sysfs(pdev);
1436 if (pdev->cfg_size > PCI_CFG_SPACE_SIZE)
1437 sysfs_remove_bin_file(&pdev->dev.kobj, &pcie_config_attr);
1439 sysfs_remove_bin_file(&pdev->dev.kobj, &pci_config_attr);
1441 pci_remove_resource_files(pdev);
1443 if (pdev->rom_attr) {
1444 sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr);
1445 kfree(pdev->rom_attr);
1446 pdev->rom_attr = NULL;
1449 pci_remove_firmware_label_files(pdev);
1452 static int __init pci_sysfs_init(void)
1454 struct pci_dev *pdev = NULL;
1457 sysfs_initialized = 1;
1458 for_each_pci_dev(pdev) {
1459 retval = pci_create_sysfs_dev_files(pdev);
1468 late_initcall(pci_sysfs_init);
1470 static struct attribute *pci_dev_dev_attrs[] = {
1471 &dev_attr_boot_vga.attr,
1475 static umode_t pci_dev_attrs_are_visible(struct kobject *kobj,
1476 struct attribute *a, int n)
1478 struct device *dev = kobj_to_dev(kobj);
1479 struct pci_dev *pdev = to_pci_dev(dev);
1481 if (a == &dev_attr_boot_vga.attr)
1482 if ((pdev->class >> 8) != PCI_CLASS_DISPLAY_VGA)
1488 static struct attribute *pci_dev_hp_attrs[] = {
1489 &dev_attr_remove.attr,
1490 &dev_attr_dev_rescan.attr,
1494 static umode_t pci_dev_hp_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 (pdev->is_virtfn)
1506 static umode_t pci_bridge_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_bridge(pdev))
1518 static umode_t pcie_dev_attrs_are_visible(struct kobject *kobj,
1519 struct attribute *a, int n)
1521 struct device *dev = kobj_to_dev(kobj);
1522 struct pci_dev *pdev = to_pci_dev(dev);
1524 if (pci_is_pcie(pdev))
1530 static const struct attribute_group pci_dev_group = {
1531 .attrs = pci_dev_attrs,
1534 const struct attribute_group *pci_dev_groups[] = {
1539 static const struct attribute_group pci_dev_hp_attr_group = {
1540 .attrs = pci_dev_hp_attrs,
1541 .is_visible = pci_dev_hp_attrs_are_visible,
1544 static const struct attribute_group pci_dev_attr_group = {
1545 .attrs = pci_dev_dev_attrs,
1546 .is_visible = pci_dev_attrs_are_visible,
1549 static const struct attribute_group pci_bridge_attr_group = {
1550 .attrs = pci_bridge_attrs,
1551 .is_visible = pci_bridge_attrs_are_visible,
1554 static const struct attribute_group pcie_dev_attr_group = {
1555 .attrs = pcie_dev_attrs,
1556 .is_visible = pcie_dev_attrs_are_visible,
1559 static const struct attribute_group *pci_dev_attr_groups[] = {
1560 &pci_dev_attr_group,
1561 &pci_dev_hp_attr_group,
1562 #ifdef CONFIG_PCI_IOV
1563 &sriov_dev_attr_group,
1565 &pci_bridge_attr_group,
1566 &pcie_dev_attr_group,
1567 #ifdef CONFIG_PCIEAER
1568 &aer_stats_attr_group,
1570 #ifdef CONFIG_PCIEASPM
1571 &aspm_ctrl_attr_group,
1576 const struct device_type pci_dev_type = {
1577 .groups = pci_dev_attr_groups,