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);
127 static ssize_t power_state_show(struct device *dev,
128 struct device_attribute *attr, char *buf)
130 struct pci_dev *pdev = to_pci_dev(dev);
132 return sprintf(buf, "%s\n", pci_power_name(pdev->current_state));
134 static DEVICE_ATTR_RO(power_state);
137 static ssize_t resource_show(struct device *dev, struct device_attribute *attr,
140 struct pci_dev *pci_dev = to_pci_dev(dev);
144 resource_size_t start, end;
146 if (pci_dev->subordinate)
147 max = DEVICE_COUNT_RESOURCE;
149 max = PCI_BRIDGE_RESOURCES;
151 for (i = 0; i < max; i++) {
152 struct resource *res = &pci_dev->resource[i];
153 pci_resource_to_user(pci_dev, i, res, &start, &end);
154 str += sprintf(str, "0x%016llx 0x%016llx 0x%016llx\n",
155 (unsigned long long)start,
156 (unsigned long long)end,
157 (unsigned long long)res->flags);
161 static DEVICE_ATTR_RO(resource);
163 static ssize_t max_link_speed_show(struct device *dev,
164 struct device_attribute *attr, char *buf)
166 struct pci_dev *pdev = to_pci_dev(dev);
168 return sprintf(buf, "%s\n",
169 pci_speed_string(pcie_get_speed_cap(pdev)));
171 static DEVICE_ATTR_RO(max_link_speed);
173 static ssize_t max_link_width_show(struct device *dev,
174 struct device_attribute *attr, char *buf)
176 struct pci_dev *pdev = to_pci_dev(dev);
178 return sprintf(buf, "%u\n", pcie_get_width_cap(pdev));
180 static DEVICE_ATTR_RO(max_link_width);
182 static ssize_t current_link_speed_show(struct device *dev,
183 struct device_attribute *attr, char *buf)
185 struct pci_dev *pci_dev = to_pci_dev(dev);
188 enum pci_bus_speed speed;
190 err = pcie_capability_read_word(pci_dev, PCI_EXP_LNKSTA, &linkstat);
194 speed = pcie_link_speed[linkstat & PCI_EXP_LNKSTA_CLS];
196 return sprintf(buf, "%s\n", pci_speed_string(speed));
198 static DEVICE_ATTR_RO(current_link_speed);
200 static ssize_t current_link_width_show(struct device *dev,
201 struct device_attribute *attr, char *buf)
203 struct pci_dev *pci_dev = to_pci_dev(dev);
207 err = pcie_capability_read_word(pci_dev, PCI_EXP_LNKSTA, &linkstat);
211 return sprintf(buf, "%u\n",
212 (linkstat & PCI_EXP_LNKSTA_NLW) >> PCI_EXP_LNKSTA_NLW_SHIFT);
214 static DEVICE_ATTR_RO(current_link_width);
216 static ssize_t secondary_bus_number_show(struct device *dev,
217 struct device_attribute *attr,
220 struct pci_dev *pci_dev = to_pci_dev(dev);
224 err = pci_read_config_byte(pci_dev, PCI_SECONDARY_BUS, &sec_bus);
228 return sprintf(buf, "%u\n", sec_bus);
230 static DEVICE_ATTR_RO(secondary_bus_number);
232 static ssize_t subordinate_bus_number_show(struct device *dev,
233 struct device_attribute *attr,
236 struct pci_dev *pci_dev = to_pci_dev(dev);
240 err = pci_read_config_byte(pci_dev, PCI_SUBORDINATE_BUS, &sub_bus);
244 return sprintf(buf, "%u\n", sub_bus);
246 static DEVICE_ATTR_RO(subordinate_bus_number);
248 static ssize_t ari_enabled_show(struct device *dev,
249 struct device_attribute *attr,
252 struct pci_dev *pci_dev = to_pci_dev(dev);
254 return sprintf(buf, "%u\n", pci_ari_enabled(pci_dev->bus));
256 static DEVICE_ATTR_RO(ari_enabled);
258 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
261 struct pci_dev *pci_dev = to_pci_dev(dev);
263 return sprintf(buf, "pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X\n",
264 pci_dev->vendor, pci_dev->device,
265 pci_dev->subsystem_vendor, pci_dev->subsystem_device,
266 (u8)(pci_dev->class >> 16), (u8)(pci_dev->class >> 8),
267 (u8)(pci_dev->class));
269 static DEVICE_ATTR_RO(modalias);
271 static ssize_t enable_store(struct device *dev, struct device_attribute *attr,
272 const char *buf, size_t count)
274 struct pci_dev *pdev = to_pci_dev(dev);
276 ssize_t result = kstrtoul(buf, 0, &val);
281 /* this can crash the machine when done on the "wrong" device */
282 if (!capable(CAP_SYS_ADMIN))
289 result = pci_enable_device(pdev);
290 else if (pci_is_enabled(pdev))
291 pci_disable_device(pdev);
296 return result < 0 ? result : count;
299 static ssize_t enable_show(struct device *dev, struct device_attribute *attr,
302 struct pci_dev *pdev;
304 pdev = to_pci_dev(dev);
305 return sprintf(buf, "%u\n", atomic_read(&pdev->enable_cnt));
307 static DEVICE_ATTR_RW(enable);
310 static ssize_t numa_node_store(struct device *dev,
311 struct device_attribute *attr, const char *buf,
314 struct pci_dev *pdev = to_pci_dev(dev);
317 if (!capable(CAP_SYS_ADMIN))
320 ret = kstrtoint(buf, 0, &node);
324 if ((node < 0 && node != NUMA_NO_NODE) || node >= MAX_NUMNODES)
327 if (node != NUMA_NO_NODE && !node_online(node))
330 add_taint(TAINT_FIRMWARE_WORKAROUND, LOCKDEP_STILL_OK);
331 pci_alert(pdev, FW_BUG "Overriding NUMA node to %d. Contact your vendor for updates.",
334 dev->numa_node = node;
338 static ssize_t numa_node_show(struct device *dev, struct device_attribute *attr,
341 return sprintf(buf, "%d\n", dev->numa_node);
343 static DEVICE_ATTR_RW(numa_node);
346 static ssize_t dma_mask_bits_show(struct device *dev,
347 struct device_attribute *attr, char *buf)
349 struct pci_dev *pdev = to_pci_dev(dev);
351 return sprintf(buf, "%d\n", fls64(pdev->dma_mask));
353 static DEVICE_ATTR_RO(dma_mask_bits);
355 static ssize_t consistent_dma_mask_bits_show(struct device *dev,
356 struct device_attribute *attr,
359 return sprintf(buf, "%d\n", fls64(dev->coherent_dma_mask));
361 static DEVICE_ATTR_RO(consistent_dma_mask_bits);
363 static ssize_t msi_bus_show(struct device *dev, struct device_attribute *attr,
366 struct pci_dev *pdev = to_pci_dev(dev);
367 struct pci_bus *subordinate = pdev->subordinate;
369 return sprintf(buf, "%u\n", subordinate ?
370 !(subordinate->bus_flags & PCI_BUS_FLAGS_NO_MSI)
374 static ssize_t msi_bus_store(struct device *dev, struct device_attribute *attr,
375 const char *buf, size_t count)
377 struct pci_dev *pdev = to_pci_dev(dev);
378 struct pci_bus *subordinate = pdev->subordinate;
381 if (kstrtoul(buf, 0, &val) < 0)
384 if (!capable(CAP_SYS_ADMIN))
388 * "no_msi" and "bus_flags" only affect what happens when a driver
389 * requests MSI or MSI-X. They don't affect any drivers that have
390 * already requested MSI or MSI-X.
394 pci_info(pdev, "MSI/MSI-X %s for future drivers\n",
395 val ? "allowed" : "disallowed");
400 subordinate->bus_flags &= ~PCI_BUS_FLAGS_NO_MSI;
402 subordinate->bus_flags |= PCI_BUS_FLAGS_NO_MSI;
404 dev_info(&subordinate->dev, "MSI/MSI-X %s for future drivers of devices on this bus\n",
405 val ? "allowed" : "disallowed");
408 static DEVICE_ATTR_RW(msi_bus);
410 static ssize_t rescan_store(struct bus_type *bus, const char *buf, size_t count)
413 struct pci_bus *b = NULL;
415 if (kstrtoul(buf, 0, &val) < 0)
419 pci_lock_rescan_remove();
420 while ((b = pci_find_next_bus(b)) != NULL)
422 pci_unlock_rescan_remove();
426 static BUS_ATTR_WO(rescan);
428 static struct attribute *pci_bus_attrs[] = {
429 &bus_attr_rescan.attr,
433 static const struct attribute_group pci_bus_group = {
434 .attrs = pci_bus_attrs,
437 const struct attribute_group *pci_bus_groups[] = {
442 static ssize_t dev_rescan_store(struct device *dev,
443 struct device_attribute *attr, const char *buf,
447 struct pci_dev *pdev = to_pci_dev(dev);
449 if (kstrtoul(buf, 0, &val) < 0)
453 pci_lock_rescan_remove();
454 pci_rescan_bus(pdev->bus);
455 pci_unlock_rescan_remove();
459 static struct device_attribute dev_attr_dev_rescan = __ATTR(rescan, 0200, NULL,
462 static ssize_t remove_store(struct device *dev, struct device_attribute *attr,
463 const char *buf, size_t count)
467 if (kstrtoul(buf, 0, &val) < 0)
470 if (val && device_remove_file_self(dev, attr))
471 pci_stop_and_remove_bus_device_locked(to_pci_dev(dev));
474 static DEVICE_ATTR_IGNORE_LOCKDEP(remove, 0220, NULL,
477 static ssize_t bus_rescan_store(struct device *dev,
478 struct device_attribute *attr,
479 const char *buf, size_t count)
482 struct pci_bus *bus = to_pci_bus(dev);
484 if (kstrtoul(buf, 0, &val) < 0)
488 pci_lock_rescan_remove();
489 if (!pci_is_root_bus(bus) && list_empty(&bus->devices))
490 pci_rescan_bus_bridge_resize(bus->self);
493 pci_unlock_rescan_remove();
497 static struct device_attribute dev_attr_bus_rescan = __ATTR(rescan, 0200, NULL,
500 #if defined(CONFIG_PM) && defined(CONFIG_ACPI)
501 static ssize_t d3cold_allowed_store(struct device *dev,
502 struct device_attribute *attr,
503 const char *buf, size_t count)
505 struct pci_dev *pdev = to_pci_dev(dev);
508 if (kstrtoul(buf, 0, &val) < 0)
511 pdev->d3cold_allowed = !!val;
512 if (pdev->d3cold_allowed)
513 pci_d3cold_enable(pdev);
515 pci_d3cold_disable(pdev);
517 pm_runtime_resume(dev);
522 static ssize_t d3cold_allowed_show(struct device *dev,
523 struct device_attribute *attr, char *buf)
525 struct pci_dev *pdev = to_pci_dev(dev);
526 return sprintf(buf, "%u\n", pdev->d3cold_allowed);
528 static DEVICE_ATTR_RW(d3cold_allowed);
532 static ssize_t devspec_show(struct device *dev,
533 struct device_attribute *attr, char *buf)
535 struct pci_dev *pdev = to_pci_dev(dev);
536 struct device_node *np = pci_device_to_OF_node(pdev);
540 return sprintf(buf, "%pOF", np);
542 static DEVICE_ATTR_RO(devspec);
545 static ssize_t driver_override_store(struct device *dev,
546 struct device_attribute *attr,
547 const char *buf, size_t count)
549 struct pci_dev *pdev = to_pci_dev(dev);
550 char *driver_override, *old, *cp;
552 /* We need to keep extra room for a newline */
553 if (count >= (PAGE_SIZE - 1))
556 driver_override = kstrndup(buf, count, GFP_KERNEL);
557 if (!driver_override)
560 cp = strchr(driver_override, '\n');
565 old = pdev->driver_override;
566 if (strlen(driver_override)) {
567 pdev->driver_override = driver_override;
569 kfree(driver_override);
570 pdev->driver_override = NULL;
579 static ssize_t driver_override_show(struct device *dev,
580 struct device_attribute *attr, char *buf)
582 struct pci_dev *pdev = to_pci_dev(dev);
586 len = scnprintf(buf, PAGE_SIZE, "%s\n", pdev->driver_override);
590 static DEVICE_ATTR_RW(driver_override);
592 static struct attribute *pci_dev_attrs[] = {
593 &dev_attr_power_state.attr,
594 &dev_attr_resource.attr,
595 &dev_attr_vendor.attr,
596 &dev_attr_device.attr,
597 &dev_attr_subsystem_vendor.attr,
598 &dev_attr_subsystem_device.attr,
599 &dev_attr_revision.attr,
600 &dev_attr_class.attr,
602 &dev_attr_local_cpus.attr,
603 &dev_attr_local_cpulist.attr,
604 &dev_attr_modalias.attr,
606 &dev_attr_numa_node.attr,
608 &dev_attr_dma_mask_bits.attr,
609 &dev_attr_consistent_dma_mask_bits.attr,
610 &dev_attr_enable.attr,
611 &dev_attr_broken_parity_status.attr,
612 &dev_attr_msi_bus.attr,
613 #if defined(CONFIG_PM) && defined(CONFIG_ACPI)
614 &dev_attr_d3cold_allowed.attr,
617 &dev_attr_devspec.attr,
619 &dev_attr_driver_override.attr,
620 &dev_attr_ari_enabled.attr,
624 static struct attribute *pci_bridge_attrs[] = {
625 &dev_attr_subordinate_bus_number.attr,
626 &dev_attr_secondary_bus_number.attr,
630 static struct attribute *pcie_dev_attrs[] = {
631 &dev_attr_current_link_speed.attr,
632 &dev_attr_current_link_width.attr,
633 &dev_attr_max_link_width.attr,
634 &dev_attr_max_link_speed.attr,
638 static struct attribute *pcibus_attrs[] = {
639 &dev_attr_bus_rescan.attr,
640 &dev_attr_cpuaffinity.attr,
641 &dev_attr_cpulistaffinity.attr,
645 static const struct attribute_group pcibus_group = {
646 .attrs = pcibus_attrs,
649 const struct attribute_group *pcibus_groups[] = {
654 static ssize_t boot_vga_show(struct device *dev, struct device_attribute *attr,
657 struct pci_dev *pdev = to_pci_dev(dev);
658 struct pci_dev *vga_dev = vga_default_device();
661 return sprintf(buf, "%u\n", (pdev == vga_dev));
663 return sprintf(buf, "%u\n",
664 !!(pdev->resource[PCI_ROM_RESOURCE].flags &
665 IORESOURCE_ROM_SHADOW));
667 static DEVICE_ATTR_RO(boot_vga);
669 static ssize_t pci_read_config(struct file *filp, struct kobject *kobj,
670 struct bin_attribute *bin_attr, char *buf,
671 loff_t off, size_t count)
673 struct pci_dev *dev = to_pci_dev(kobj_to_dev(kobj));
674 unsigned int size = 64;
675 loff_t init_off = off;
676 u8 *data = (u8 *) buf;
678 /* Several chips lock up trying to read undefined config space */
679 if (file_ns_capable(filp, &init_user_ns, CAP_SYS_ADMIN))
680 size = dev->cfg_size;
681 else if (dev->hdr_type == PCI_HEADER_TYPE_CARDBUS)
686 if (off + count > size) {
693 pci_config_pm_runtime_get(dev);
695 if ((off & 1) && size) {
697 pci_user_read_config_byte(dev, off, &val);
698 data[off - init_off] = val;
703 if ((off & 3) && size > 2) {
705 pci_user_read_config_word(dev, off, &val);
706 data[off - init_off] = val & 0xff;
707 data[off - init_off + 1] = (val >> 8) & 0xff;
714 pci_user_read_config_dword(dev, off, &val);
715 data[off - init_off] = val & 0xff;
716 data[off - init_off + 1] = (val >> 8) & 0xff;
717 data[off - init_off + 2] = (val >> 16) & 0xff;
718 data[off - init_off + 3] = (val >> 24) & 0xff;
726 pci_user_read_config_word(dev, off, &val);
727 data[off - init_off] = val & 0xff;
728 data[off - init_off + 1] = (val >> 8) & 0xff;
735 pci_user_read_config_byte(dev, off, &val);
736 data[off - init_off] = val;
741 pci_config_pm_runtime_put(dev);
746 static ssize_t pci_write_config(struct file *filp, struct kobject *kobj,
747 struct bin_attribute *bin_attr, char *buf,
748 loff_t off, size_t count)
750 struct pci_dev *dev = to_pci_dev(kobj_to_dev(kobj));
751 unsigned int size = count;
752 loff_t init_off = off;
753 u8 *data = (u8 *) buf;
756 ret = security_locked_down(LOCKDOWN_PCI_ACCESS);
760 if (off > dev->cfg_size)
762 if (off + count > dev->cfg_size) {
763 size = dev->cfg_size - off;
767 pci_config_pm_runtime_get(dev);
769 if ((off & 1) && size) {
770 pci_user_write_config_byte(dev, off, data[off - init_off]);
775 if ((off & 3) && size > 2) {
776 u16 val = data[off - init_off];
777 val |= (u16) data[off - init_off + 1] << 8;
778 pci_user_write_config_word(dev, off, val);
784 u32 val = data[off - init_off];
785 val |= (u32) data[off - init_off + 1] << 8;
786 val |= (u32) data[off - init_off + 2] << 16;
787 val |= (u32) data[off - init_off + 3] << 24;
788 pci_user_write_config_dword(dev, off, val);
794 u16 val = data[off - init_off];
795 val |= (u16) data[off - init_off + 1] << 8;
796 pci_user_write_config_word(dev, off, val);
802 pci_user_write_config_byte(dev, off, data[off - init_off]);
807 pci_config_pm_runtime_put(dev);
812 #ifdef HAVE_PCI_LEGACY
814 * pci_read_legacy_io - read byte(s) from legacy I/O port space
815 * @filp: open sysfs file
816 * @kobj: kobject corresponding to file to read from
817 * @bin_attr: struct bin_attribute for this file
818 * @buf: buffer to store results
819 * @off: offset into legacy I/O port space
820 * @count: number of bytes to read
822 * Reads 1, 2, or 4 bytes from legacy I/O port space using an arch specific
823 * callback routine (pci_legacy_read).
825 static ssize_t pci_read_legacy_io(struct file *filp, struct kobject *kobj,
826 struct bin_attribute *bin_attr, char *buf,
827 loff_t off, size_t count)
829 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
831 /* Only support 1, 2 or 4 byte accesses */
832 if (count != 1 && count != 2 && count != 4)
835 return pci_legacy_read(bus, off, (u32 *)buf, count);
839 * pci_write_legacy_io - write byte(s) to legacy I/O port space
840 * @filp: open sysfs file
841 * @kobj: kobject corresponding to file to read from
842 * @bin_attr: struct bin_attribute for this file
843 * @buf: buffer containing value to be written
844 * @off: offset into legacy I/O port space
845 * @count: number of bytes to write
847 * Writes 1, 2, or 4 bytes from legacy I/O port space using an arch specific
848 * callback routine (pci_legacy_write).
850 static ssize_t pci_write_legacy_io(struct file *filp, struct kobject *kobj,
851 struct bin_attribute *bin_attr, char *buf,
852 loff_t off, size_t count)
854 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
856 /* Only support 1, 2 or 4 byte accesses */
857 if (count != 1 && count != 2 && count != 4)
860 return pci_legacy_write(bus, off, *(u32 *)buf, count);
864 * pci_mmap_legacy_mem - map legacy PCI memory into user memory space
865 * @filp: open sysfs file
866 * @kobj: kobject corresponding to device to be mapped
867 * @attr: struct bin_attribute for this file
868 * @vma: struct vm_area_struct passed to mmap
870 * Uses an arch specific callback, pci_mmap_legacy_mem_page_range, to mmap
871 * legacy memory space (first meg of bus space) into application virtual
874 static int pci_mmap_legacy_mem(struct file *filp, struct kobject *kobj,
875 struct bin_attribute *attr,
876 struct vm_area_struct *vma)
878 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
880 return pci_mmap_legacy_page_range(bus, vma, pci_mmap_mem);
884 * pci_mmap_legacy_io - map legacy PCI IO into user memory space
885 * @filp: open sysfs file
886 * @kobj: kobject corresponding to device to be mapped
887 * @attr: struct bin_attribute for this file
888 * @vma: struct vm_area_struct passed to mmap
890 * Uses an arch specific callback, pci_mmap_legacy_io_page_range, to mmap
891 * legacy IO space (first meg of bus space) into application virtual
892 * memory space. Returns -ENOSYS if the operation isn't supported
894 static int pci_mmap_legacy_io(struct file *filp, struct kobject *kobj,
895 struct bin_attribute *attr,
896 struct vm_area_struct *vma)
898 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
900 return pci_mmap_legacy_page_range(bus, vma, pci_mmap_io);
904 * pci_adjust_legacy_attr - adjustment of legacy file attributes
905 * @b: bus to create files under
906 * @mmap_type: I/O port or memory
908 * Stub implementation. Can be overridden by arch if necessary.
910 void __weak pci_adjust_legacy_attr(struct pci_bus *b,
911 enum pci_mmap_state mmap_type)
916 * pci_create_legacy_files - create legacy I/O port and memory files
917 * @b: bus to create files under
919 * Some platforms allow access to legacy I/O port and ISA memory space on
920 * a per-bus basis. This routine creates the files and ties them into
921 * their associated read, write and mmap files from pci-sysfs.c
923 * On error unwind, but don't propagate the error to the caller
924 * as it is ok to set up the PCI bus without these files.
926 void pci_create_legacy_files(struct pci_bus *b)
930 if (!sysfs_initialized)
933 b->legacy_io = kcalloc(2, sizeof(struct bin_attribute),
938 sysfs_bin_attr_init(b->legacy_io);
939 b->legacy_io->attr.name = "legacy_io";
940 b->legacy_io->size = 0xffff;
941 b->legacy_io->attr.mode = 0600;
942 b->legacy_io->read = pci_read_legacy_io;
943 b->legacy_io->write = pci_write_legacy_io;
944 b->legacy_io->mmap = pci_mmap_legacy_io;
945 b->legacy_io->mapping = iomem_get_mapping();
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 b->legacy_io->mapping = iomem_get_mapping();
959 pci_adjust_legacy_attr(b, pci_mmap_mem);
960 error = device_create_bin_file(&b->dev, b->legacy_mem);
967 device_remove_bin_file(&b->dev, b->legacy_io);
972 dev_warn(&b->dev, "could not create legacy I/O port and ISA memory resources in sysfs\n");
975 void pci_remove_legacy_files(struct pci_bus *b)
978 device_remove_bin_file(&b->dev, b->legacy_io);
979 device_remove_bin_file(&b->dev, b->legacy_mem);
980 kfree(b->legacy_io); /* both are allocated here */
983 #endif /* HAVE_PCI_LEGACY */
985 #if defined(HAVE_PCI_MMAP) || defined(ARCH_GENERIC_PCI_MMAP_RESOURCE)
987 int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vma,
988 enum pci_mmap_api mmap_api)
990 unsigned long nr, start, size;
991 resource_size_t pci_start = 0, pci_end;
993 if (pci_resource_len(pdev, resno) == 0)
996 start = vma->vm_pgoff;
997 size = ((pci_resource_len(pdev, resno) - 1) >> PAGE_SHIFT) + 1;
998 if (mmap_api == PCI_MMAP_PROCFS) {
999 pci_resource_to_user(pdev, resno, &pdev->resource[resno],
1000 &pci_start, &pci_end);
1001 pci_start >>= PAGE_SHIFT;
1003 if (start >= pci_start && start < pci_start + size &&
1004 start + nr <= pci_start + size)
1010 * pci_mmap_resource - map a PCI resource into user memory space
1011 * @kobj: kobject for mapping
1012 * @attr: struct bin_attribute for the file being mapped
1013 * @vma: struct vm_area_struct passed into the mmap
1014 * @write_combine: 1 for write_combine mapping
1016 * Use the regular PCI mapping routines to map a PCI resource into userspace.
1018 static int pci_mmap_resource(struct kobject *kobj, struct bin_attribute *attr,
1019 struct vm_area_struct *vma, int write_combine)
1021 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1022 int bar = (unsigned long)attr->private;
1023 enum pci_mmap_state mmap_type;
1024 struct resource *res = &pdev->resource[bar];
1027 ret = security_locked_down(LOCKDOWN_PCI_ACCESS);
1031 if (res->flags & IORESOURCE_MEM && iomem_is_exclusive(res->start))
1034 if (!pci_mmap_fits(pdev, bar, vma, PCI_MMAP_SYSFS))
1037 mmap_type = res->flags & IORESOURCE_MEM ? pci_mmap_mem : pci_mmap_io;
1039 return pci_mmap_resource_range(pdev, bar, vma, mmap_type, write_combine);
1042 static int pci_mmap_resource_uc(struct file *filp, struct kobject *kobj,
1043 struct bin_attribute *attr,
1044 struct vm_area_struct *vma)
1046 return pci_mmap_resource(kobj, attr, vma, 0);
1049 static int pci_mmap_resource_wc(struct file *filp, struct kobject *kobj,
1050 struct bin_attribute *attr,
1051 struct vm_area_struct *vma)
1053 return pci_mmap_resource(kobj, attr, vma, 1);
1056 static ssize_t pci_resource_io(struct file *filp, struct kobject *kobj,
1057 struct bin_attribute *attr, char *buf,
1058 loff_t off, size_t count, bool write)
1060 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1061 int bar = (unsigned long)attr->private;
1062 unsigned long port = off;
1064 port += pci_resource_start(pdev, bar);
1066 if (port > pci_resource_end(pdev, bar))
1069 if (port + count - 1 > pci_resource_end(pdev, bar))
1075 outb(*(u8 *)buf, port);
1077 *(u8 *)buf = inb(port);
1081 outw(*(u16 *)buf, port);
1083 *(u16 *)buf = inw(port);
1087 outl(*(u32 *)buf, port);
1089 *(u32 *)buf = inl(port);
1095 static ssize_t pci_read_resource_io(struct file *filp, struct kobject *kobj,
1096 struct bin_attribute *attr, char *buf,
1097 loff_t off, size_t count)
1099 return pci_resource_io(filp, kobj, attr, buf, off, count, false);
1102 static ssize_t pci_write_resource_io(struct file *filp, struct kobject *kobj,
1103 struct bin_attribute *attr, char *buf,
1104 loff_t off, size_t count)
1108 ret = security_locked_down(LOCKDOWN_PCI_ACCESS);
1112 return pci_resource_io(filp, kobj, attr, buf, off, count, true);
1116 * pci_remove_resource_files - cleanup resource files
1117 * @pdev: dev to cleanup
1119 * If we created resource files for @pdev, remove them from sysfs and
1120 * free their resources.
1122 static void pci_remove_resource_files(struct pci_dev *pdev)
1126 for (i = 0; i < PCI_STD_NUM_BARS; i++) {
1127 struct bin_attribute *res_attr;
1129 res_attr = pdev->res_attr[i];
1131 sysfs_remove_bin_file(&pdev->dev.kobj, res_attr);
1135 res_attr = pdev->res_attr_wc[i];
1137 sysfs_remove_bin_file(&pdev->dev.kobj, res_attr);
1143 static int pci_create_attr(struct pci_dev *pdev, int num, int write_combine)
1145 /* allocate attribute structure, piggyback attribute name */
1146 int name_len = write_combine ? 13 : 10;
1147 struct bin_attribute *res_attr;
1148 char *res_attr_name;
1151 res_attr = kzalloc(sizeof(*res_attr) + name_len, GFP_ATOMIC);
1155 res_attr_name = (char *)(res_attr + 1);
1157 sysfs_bin_attr_init(res_attr);
1158 if (write_combine) {
1159 pdev->res_attr_wc[num] = res_attr;
1160 sprintf(res_attr_name, "resource%d_wc", num);
1161 res_attr->mmap = pci_mmap_resource_wc;
1163 pdev->res_attr[num] = res_attr;
1164 sprintf(res_attr_name, "resource%d", num);
1165 if (pci_resource_flags(pdev, num) & IORESOURCE_IO) {
1166 res_attr->read = pci_read_resource_io;
1167 res_attr->write = pci_write_resource_io;
1168 if (arch_can_pci_mmap_io())
1169 res_attr->mmap = pci_mmap_resource_uc;
1171 res_attr->mmap = pci_mmap_resource_uc;
1175 res_attr->mapping = iomem_get_mapping();
1176 res_attr->attr.name = res_attr_name;
1177 res_attr->attr.mode = 0600;
1178 res_attr->size = pci_resource_len(pdev, num);
1179 res_attr->private = (void *)(unsigned long)num;
1180 retval = sysfs_create_bin_file(&pdev->dev.kobj, res_attr);
1188 * pci_create_resource_files - create resource files in sysfs for @dev
1189 * @pdev: dev in question
1191 * Walk the resources in @pdev creating files for each resource available.
1193 static int pci_create_resource_files(struct pci_dev *pdev)
1198 /* Expose the PCI resources from this device as files */
1199 for (i = 0; i < PCI_STD_NUM_BARS; i++) {
1201 /* skip empty resources */
1202 if (!pci_resource_len(pdev, i))
1205 retval = pci_create_attr(pdev, i, 0);
1206 /* for prefetchable resources, create a WC mappable file */
1207 if (!retval && arch_can_pci_mmap_wc() &&
1208 pdev->resource[i].flags & IORESOURCE_PREFETCH)
1209 retval = pci_create_attr(pdev, i, 1);
1211 pci_remove_resource_files(pdev);
1217 #else /* !(defined(HAVE_PCI_MMAP) || defined(ARCH_GENERIC_PCI_MMAP_RESOURCE)) */
1218 int __weak pci_create_resource_files(struct pci_dev *dev) { return 0; }
1219 void __weak pci_remove_resource_files(struct pci_dev *dev) { return; }
1223 * pci_write_rom - used to enable access to the PCI ROM display
1225 * @kobj: kernel object handle
1226 * @bin_attr: struct bin_attribute for this file
1229 * @count: number of byte in input
1231 * writing anything except 0 enables it
1233 static ssize_t pci_write_rom(struct file *filp, struct kobject *kobj,
1234 struct bin_attribute *bin_attr, char *buf,
1235 loff_t off, size_t count)
1237 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1239 if ((off == 0) && (*buf == '0') && (count == 2))
1240 pdev->rom_attr_enabled = 0;
1242 pdev->rom_attr_enabled = 1;
1248 * pci_read_rom - read a PCI ROM
1250 * @kobj: kernel object handle
1251 * @bin_attr: struct bin_attribute for this file
1252 * @buf: where to put the data we read from the ROM
1254 * @count: number of bytes to read
1256 * Put @count bytes starting at @off into @buf from the ROM in the PCI
1257 * device corresponding to @kobj.
1259 static ssize_t pci_read_rom(struct file *filp, struct kobject *kobj,
1260 struct bin_attribute *bin_attr, char *buf,
1261 loff_t off, size_t count)
1263 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1267 if (!pdev->rom_attr_enabled)
1270 rom = pci_map_rom(pdev, &size); /* size starts out as PCI window size */
1277 if (off + count > size)
1280 memcpy_fromio(buf, rom + off, count);
1282 pci_unmap_rom(pdev, rom);
1287 static const struct bin_attribute pci_config_attr = {
1292 .size = PCI_CFG_SPACE_SIZE,
1293 .read = pci_read_config,
1294 .write = pci_write_config,
1297 static const struct bin_attribute pcie_config_attr = {
1302 .size = PCI_CFG_SPACE_EXP_SIZE,
1303 .read = pci_read_config,
1304 .write = pci_write_config,
1307 static ssize_t reset_store(struct device *dev, struct device_attribute *attr,
1308 const char *buf, size_t count)
1310 struct pci_dev *pdev = to_pci_dev(dev);
1312 ssize_t result = kstrtoul(buf, 0, &val);
1320 pm_runtime_get_sync(dev);
1321 result = pci_reset_function(pdev);
1322 pm_runtime_put(dev);
1329 static DEVICE_ATTR(reset, 0200, NULL, reset_store);
1331 static int pci_create_capabilities_sysfs(struct pci_dev *dev)
1335 pcie_vpd_create_sysfs_dev_files(dev);
1337 if (dev->reset_fn) {
1338 retval = device_create_file(&dev->dev, &dev_attr_reset);
1345 pcie_vpd_remove_sysfs_dev_files(dev);
1349 int __must_check pci_create_sysfs_dev_files(struct pci_dev *pdev)
1353 struct bin_attribute *attr;
1355 if (!sysfs_initialized)
1358 if (pdev->cfg_size > PCI_CFG_SPACE_SIZE)
1359 retval = sysfs_create_bin_file(&pdev->dev.kobj, &pcie_config_attr);
1361 retval = sysfs_create_bin_file(&pdev->dev.kobj, &pci_config_attr);
1365 retval = pci_create_resource_files(pdev);
1367 goto err_config_file;
1369 /* If the device has a ROM, try to expose it in sysfs. */
1370 rom_size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
1372 attr = kzalloc(sizeof(*attr), GFP_ATOMIC);
1375 goto err_resource_files;
1377 sysfs_bin_attr_init(attr);
1378 attr->size = rom_size;
1379 attr->attr.name = "rom";
1380 attr->attr.mode = 0600;
1381 attr->read = pci_read_rom;
1382 attr->write = pci_write_rom;
1383 retval = sysfs_create_bin_file(&pdev->dev.kobj, attr);
1386 goto err_resource_files;
1388 pdev->rom_attr = attr;
1391 /* add sysfs entries for various capabilities */
1392 retval = pci_create_capabilities_sysfs(pdev);
1396 pci_create_firmware_label_files(pdev);
1401 if (pdev->rom_attr) {
1402 sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr);
1403 kfree(pdev->rom_attr);
1404 pdev->rom_attr = NULL;
1407 pci_remove_resource_files(pdev);
1409 if (pdev->cfg_size > PCI_CFG_SPACE_SIZE)
1410 sysfs_remove_bin_file(&pdev->dev.kobj, &pcie_config_attr);
1412 sysfs_remove_bin_file(&pdev->dev.kobj, &pci_config_attr);
1417 static void pci_remove_capabilities_sysfs(struct pci_dev *dev)
1419 pcie_vpd_remove_sysfs_dev_files(dev);
1420 if (dev->reset_fn) {
1421 device_remove_file(&dev->dev, &dev_attr_reset);
1427 * pci_remove_sysfs_dev_files - cleanup PCI specific sysfs files
1428 * @pdev: device whose entries we should free
1430 * Cleanup when @pdev is removed from sysfs.
1432 void pci_remove_sysfs_dev_files(struct pci_dev *pdev)
1434 if (!sysfs_initialized)
1437 pci_remove_capabilities_sysfs(pdev);
1439 if (pdev->cfg_size > PCI_CFG_SPACE_SIZE)
1440 sysfs_remove_bin_file(&pdev->dev.kobj, &pcie_config_attr);
1442 sysfs_remove_bin_file(&pdev->dev.kobj, &pci_config_attr);
1444 pci_remove_resource_files(pdev);
1446 if (pdev->rom_attr) {
1447 sysfs_remove_bin_file(&pdev->dev.kobj, pdev->rom_attr);
1448 kfree(pdev->rom_attr);
1449 pdev->rom_attr = NULL;
1452 pci_remove_firmware_label_files(pdev);
1455 static int __init pci_sysfs_init(void)
1457 struct pci_dev *pdev = NULL;
1458 struct pci_bus *pbus = NULL;
1461 sysfs_initialized = 1;
1462 for_each_pci_dev(pdev) {
1463 retval = pci_create_sysfs_dev_files(pdev);
1470 while ((pbus = pci_find_next_bus(pbus)))
1471 pci_create_legacy_files(pbus);
1475 late_initcall(pci_sysfs_init);
1477 static struct attribute *pci_dev_dev_attrs[] = {
1478 &dev_attr_boot_vga.attr,
1482 static umode_t pci_dev_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 (a == &dev_attr_boot_vga.attr)
1489 if ((pdev->class >> 8) != PCI_CLASS_DISPLAY_VGA)
1495 static struct attribute *pci_dev_hp_attrs[] = {
1496 &dev_attr_remove.attr,
1497 &dev_attr_dev_rescan.attr,
1501 static umode_t pci_dev_hp_attrs_are_visible(struct kobject *kobj,
1502 struct attribute *a, int n)
1504 struct device *dev = kobj_to_dev(kobj);
1505 struct pci_dev *pdev = to_pci_dev(dev);
1507 if (pdev->is_virtfn)
1513 static umode_t pci_bridge_attrs_are_visible(struct kobject *kobj,
1514 struct attribute *a, int n)
1516 struct device *dev = kobj_to_dev(kobj);
1517 struct pci_dev *pdev = to_pci_dev(dev);
1519 if (pci_is_bridge(pdev))
1525 static umode_t pcie_dev_attrs_are_visible(struct kobject *kobj,
1526 struct attribute *a, int n)
1528 struct device *dev = kobj_to_dev(kobj);
1529 struct pci_dev *pdev = to_pci_dev(dev);
1531 if (pci_is_pcie(pdev))
1537 static const struct attribute_group pci_dev_group = {
1538 .attrs = pci_dev_attrs,
1541 const struct attribute_group *pci_dev_groups[] = {
1546 static const struct attribute_group pci_dev_hp_attr_group = {
1547 .attrs = pci_dev_hp_attrs,
1548 .is_visible = pci_dev_hp_attrs_are_visible,
1551 static const struct attribute_group pci_dev_attr_group = {
1552 .attrs = pci_dev_dev_attrs,
1553 .is_visible = pci_dev_attrs_are_visible,
1556 static const struct attribute_group pci_bridge_attr_group = {
1557 .attrs = pci_bridge_attrs,
1558 .is_visible = pci_bridge_attrs_are_visible,
1561 static const struct attribute_group pcie_dev_attr_group = {
1562 .attrs = pcie_dev_attrs,
1563 .is_visible = pcie_dev_attrs_are_visible,
1566 static const struct attribute_group *pci_dev_attr_groups[] = {
1567 &pci_dev_attr_group,
1568 &pci_dev_hp_attr_group,
1569 #ifdef CONFIG_PCI_IOV
1570 &sriov_dev_attr_group,
1572 &pci_bridge_attr_group,
1573 &pcie_dev_attr_group,
1574 #ifdef CONFIG_PCIEAER
1575 &aer_stats_attr_group,
1577 #ifdef CONFIG_PCIEASPM
1578 &aspm_ctrl_attr_group,
1583 const struct device_type pci_dev_type = {
1584 .groups = pci_dev_attr_groups,