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>
29 #include <linux/msi.h>
31 #include <linux/aperture.h>
34 static int sysfs_initialized; /* = 0 */
36 /* show configuration fields */
37 #define pci_config_attr(field, format_string) \
39 field##_show(struct device *dev, struct device_attribute *attr, char *buf) \
41 struct pci_dev *pdev; \
43 pdev = to_pci_dev(dev); \
44 return sysfs_emit(buf, format_string, pdev->field); \
46 static DEVICE_ATTR_RO(field)
48 pci_config_attr(vendor, "0x%04x\n");
49 pci_config_attr(device, "0x%04x\n");
50 pci_config_attr(subsystem_vendor, "0x%04x\n");
51 pci_config_attr(subsystem_device, "0x%04x\n");
52 pci_config_attr(revision, "0x%02x\n");
53 pci_config_attr(class, "0x%06x\n");
55 static ssize_t irq_show(struct device *dev,
56 struct device_attribute *attr,
59 struct pci_dev *pdev = to_pci_dev(dev);
63 * For MSI, show the first MSI IRQ; for all other cases including
64 * MSI-X, show the legacy INTx IRQ.
66 if (pdev->msi_enabled)
67 return sysfs_emit(buf, "%u\n", pci_irq_vector(pdev, 0));
70 return sysfs_emit(buf, "%u\n", pdev->irq);
72 static DEVICE_ATTR_RO(irq);
74 static ssize_t broken_parity_status_show(struct device *dev,
75 struct device_attribute *attr,
78 struct pci_dev *pdev = to_pci_dev(dev);
79 return sysfs_emit(buf, "%u\n", pdev->broken_parity_status);
82 static ssize_t broken_parity_status_store(struct device *dev,
83 struct device_attribute *attr,
84 const char *buf, size_t count)
86 struct pci_dev *pdev = to_pci_dev(dev);
89 if (kstrtoul(buf, 0, &val) < 0)
92 pdev->broken_parity_status = !!val;
96 static DEVICE_ATTR_RW(broken_parity_status);
98 static ssize_t pci_dev_show_local_cpu(struct device *dev, bool list,
99 struct device_attribute *attr, char *buf)
101 const struct cpumask *mask;
104 if (dev_to_node(dev) == NUMA_NO_NODE)
105 mask = cpu_online_mask;
107 mask = cpumask_of_node(dev_to_node(dev));
109 mask = cpumask_of_pcibus(to_pci_dev(dev)->bus);
111 return cpumap_print_to_pagebuf(list, buf, mask);
114 static ssize_t local_cpus_show(struct device *dev,
115 struct device_attribute *attr, char *buf)
117 return pci_dev_show_local_cpu(dev, false, attr, buf);
119 static DEVICE_ATTR_RO(local_cpus);
121 static ssize_t local_cpulist_show(struct device *dev,
122 struct device_attribute *attr, char *buf)
124 return pci_dev_show_local_cpu(dev, true, attr, buf);
126 static DEVICE_ATTR_RO(local_cpulist);
129 * PCI Bus Class Devices
131 static ssize_t cpuaffinity_show(struct device *dev,
132 struct device_attribute *attr, char *buf)
134 const struct cpumask *cpumask = cpumask_of_pcibus(to_pci_bus(dev));
136 return cpumap_print_to_pagebuf(false, buf, cpumask);
138 static DEVICE_ATTR_RO(cpuaffinity);
140 static ssize_t cpulistaffinity_show(struct device *dev,
141 struct device_attribute *attr, char *buf)
143 const struct cpumask *cpumask = cpumask_of_pcibus(to_pci_bus(dev));
145 return cpumap_print_to_pagebuf(true, buf, cpumask);
147 static DEVICE_ATTR_RO(cpulistaffinity);
149 static ssize_t power_state_show(struct device *dev,
150 struct device_attribute *attr, char *buf)
152 struct pci_dev *pdev = to_pci_dev(dev);
154 return sysfs_emit(buf, "%s\n", pci_power_name(pdev->current_state));
156 static DEVICE_ATTR_RO(power_state);
159 static ssize_t resource_show(struct device *dev, struct device_attribute *attr,
162 struct pci_dev *pci_dev = to_pci_dev(dev);
165 resource_size_t start, end;
168 if (pci_dev->subordinate)
169 max = DEVICE_COUNT_RESOURCE;
171 max = PCI_BRIDGE_RESOURCES;
173 for (i = 0; i < max; i++) {
174 struct resource *res = &pci_dev->resource[i];
175 pci_resource_to_user(pci_dev, i, res, &start, &end);
176 len += sysfs_emit_at(buf, len, "0x%016llx 0x%016llx 0x%016llx\n",
177 (unsigned long long)start,
178 (unsigned long long)end,
179 (unsigned long long)res->flags);
183 static DEVICE_ATTR_RO(resource);
185 static ssize_t max_link_speed_show(struct device *dev,
186 struct device_attribute *attr, char *buf)
188 struct pci_dev *pdev = to_pci_dev(dev);
190 return sysfs_emit(buf, "%s\n",
191 pci_speed_string(pcie_get_speed_cap(pdev)));
193 static DEVICE_ATTR_RO(max_link_speed);
195 static ssize_t max_link_width_show(struct device *dev,
196 struct device_attribute *attr, char *buf)
198 struct pci_dev *pdev = to_pci_dev(dev);
200 return sysfs_emit(buf, "%u\n", pcie_get_width_cap(pdev));
202 static DEVICE_ATTR_RO(max_link_width);
204 static ssize_t current_link_speed_show(struct device *dev,
205 struct device_attribute *attr, char *buf)
207 struct pci_dev *pci_dev = to_pci_dev(dev);
210 enum pci_bus_speed speed;
212 err = pcie_capability_read_word(pci_dev, PCI_EXP_LNKSTA, &linkstat);
216 speed = pcie_link_speed[linkstat & PCI_EXP_LNKSTA_CLS];
218 return sysfs_emit(buf, "%s\n", pci_speed_string(speed));
220 static DEVICE_ATTR_RO(current_link_speed);
222 static ssize_t current_link_width_show(struct device *dev,
223 struct device_attribute *attr, char *buf)
225 struct pci_dev *pci_dev = to_pci_dev(dev);
229 err = pcie_capability_read_word(pci_dev, PCI_EXP_LNKSTA, &linkstat);
233 return sysfs_emit(buf, "%u\n",
234 (linkstat & PCI_EXP_LNKSTA_NLW) >> PCI_EXP_LNKSTA_NLW_SHIFT);
236 static DEVICE_ATTR_RO(current_link_width);
238 static ssize_t secondary_bus_number_show(struct device *dev,
239 struct device_attribute *attr,
242 struct pci_dev *pci_dev = to_pci_dev(dev);
246 err = pci_read_config_byte(pci_dev, PCI_SECONDARY_BUS, &sec_bus);
250 return sysfs_emit(buf, "%u\n", sec_bus);
252 static DEVICE_ATTR_RO(secondary_bus_number);
254 static ssize_t subordinate_bus_number_show(struct device *dev,
255 struct device_attribute *attr,
258 struct pci_dev *pci_dev = to_pci_dev(dev);
262 err = pci_read_config_byte(pci_dev, PCI_SUBORDINATE_BUS, &sub_bus);
266 return sysfs_emit(buf, "%u\n", sub_bus);
268 static DEVICE_ATTR_RO(subordinate_bus_number);
270 static ssize_t ari_enabled_show(struct device *dev,
271 struct device_attribute *attr,
274 struct pci_dev *pci_dev = to_pci_dev(dev);
276 return sysfs_emit(buf, "%u\n", pci_ari_enabled(pci_dev->bus));
278 static DEVICE_ATTR_RO(ari_enabled);
280 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
283 struct pci_dev *pci_dev = to_pci_dev(dev);
285 return sysfs_emit(buf, "pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X\n",
286 pci_dev->vendor, pci_dev->device,
287 pci_dev->subsystem_vendor, pci_dev->subsystem_device,
288 (u8)(pci_dev->class >> 16), (u8)(pci_dev->class >> 8),
289 (u8)(pci_dev->class));
291 static DEVICE_ATTR_RO(modalias);
293 static ssize_t enable_store(struct device *dev, struct device_attribute *attr,
294 const char *buf, size_t count)
296 struct pci_dev *pdev = to_pci_dev(dev);
300 /* this can crash the machine when done on the "wrong" device */
301 if (!capable(CAP_SYS_ADMIN))
304 if (kstrtoul(buf, 0, &val) < 0)
311 result = pci_enable_device(pdev);
312 else if (pci_is_enabled(pdev))
313 pci_disable_device(pdev);
318 return result < 0 ? result : count;
321 static ssize_t enable_show(struct device *dev, struct device_attribute *attr,
324 struct pci_dev *pdev;
326 pdev = to_pci_dev(dev);
327 return sysfs_emit(buf, "%u\n", atomic_read(&pdev->enable_cnt));
329 static DEVICE_ATTR_RW(enable);
332 static ssize_t numa_node_store(struct device *dev,
333 struct device_attribute *attr, const char *buf,
336 struct pci_dev *pdev = to_pci_dev(dev);
339 if (!capable(CAP_SYS_ADMIN))
342 if (kstrtoint(buf, 0, &node) < 0)
345 if ((node < 0 && node != NUMA_NO_NODE) || node >= MAX_NUMNODES)
348 if (node != NUMA_NO_NODE && !node_online(node))
351 add_taint(TAINT_FIRMWARE_WORKAROUND, LOCKDEP_STILL_OK);
352 pci_alert(pdev, FW_BUG "Overriding NUMA node to %d. Contact your vendor for updates.",
355 dev->numa_node = node;
359 static ssize_t numa_node_show(struct device *dev, struct device_attribute *attr,
362 return sysfs_emit(buf, "%d\n", dev->numa_node);
364 static DEVICE_ATTR_RW(numa_node);
367 static ssize_t dma_mask_bits_show(struct device *dev,
368 struct device_attribute *attr, char *buf)
370 struct pci_dev *pdev = to_pci_dev(dev);
372 return sysfs_emit(buf, "%d\n", fls64(pdev->dma_mask));
374 static DEVICE_ATTR_RO(dma_mask_bits);
376 static ssize_t consistent_dma_mask_bits_show(struct device *dev,
377 struct device_attribute *attr,
380 return sysfs_emit(buf, "%d\n", fls64(dev->coherent_dma_mask));
382 static DEVICE_ATTR_RO(consistent_dma_mask_bits);
384 static ssize_t msi_bus_show(struct device *dev, struct device_attribute *attr,
387 struct pci_dev *pdev = to_pci_dev(dev);
388 struct pci_bus *subordinate = pdev->subordinate;
390 return sysfs_emit(buf, "%u\n", subordinate ?
391 !(subordinate->bus_flags & PCI_BUS_FLAGS_NO_MSI)
395 static ssize_t msi_bus_store(struct device *dev, struct device_attribute *attr,
396 const char *buf, size_t count)
398 struct pci_dev *pdev = to_pci_dev(dev);
399 struct pci_bus *subordinate = pdev->subordinate;
402 if (!capable(CAP_SYS_ADMIN))
405 if (kstrtoul(buf, 0, &val) < 0)
409 * "no_msi" and "bus_flags" only affect what happens when a driver
410 * requests MSI or MSI-X. They don't affect any drivers that have
411 * already requested MSI or MSI-X.
415 pci_info(pdev, "MSI/MSI-X %s for future drivers\n",
416 val ? "allowed" : "disallowed");
421 subordinate->bus_flags &= ~PCI_BUS_FLAGS_NO_MSI;
423 subordinate->bus_flags |= PCI_BUS_FLAGS_NO_MSI;
425 dev_info(&subordinate->dev, "MSI/MSI-X %s for future drivers of devices on this bus\n",
426 val ? "allowed" : "disallowed");
429 static DEVICE_ATTR_RW(msi_bus);
431 static ssize_t rescan_store(struct bus_type *bus, const char *buf, size_t count)
434 struct pci_bus *b = NULL;
436 if (kstrtoul(buf, 0, &val) < 0)
440 pci_lock_rescan_remove();
441 while ((b = pci_find_next_bus(b)) != NULL)
443 pci_unlock_rescan_remove();
447 static BUS_ATTR_WO(rescan);
449 static struct attribute *pci_bus_attrs[] = {
450 &bus_attr_rescan.attr,
454 static const struct attribute_group pci_bus_group = {
455 .attrs = pci_bus_attrs,
458 const struct attribute_group *pci_bus_groups[] = {
463 static ssize_t dev_rescan_store(struct device *dev,
464 struct device_attribute *attr, const char *buf,
468 struct pci_dev *pdev = to_pci_dev(dev);
470 if (kstrtoul(buf, 0, &val) < 0)
474 pci_lock_rescan_remove();
475 pci_rescan_bus(pdev->bus);
476 pci_unlock_rescan_remove();
480 static struct device_attribute dev_attr_dev_rescan = __ATTR(rescan, 0200, NULL,
483 static ssize_t remove_store(struct device *dev, struct device_attribute *attr,
484 const char *buf, size_t count)
488 if (kstrtoul(buf, 0, &val) < 0)
491 if (val && device_remove_file_self(dev, attr))
492 pci_stop_and_remove_bus_device_locked(to_pci_dev(dev));
495 static DEVICE_ATTR_IGNORE_LOCKDEP(remove, 0220, NULL,
498 static ssize_t bus_rescan_store(struct device *dev,
499 struct device_attribute *attr,
500 const char *buf, size_t count)
503 struct pci_bus *bus = to_pci_bus(dev);
505 if (kstrtoul(buf, 0, &val) < 0)
509 pci_lock_rescan_remove();
510 if (!pci_is_root_bus(bus) && list_empty(&bus->devices))
511 pci_rescan_bus_bridge_resize(bus->self);
514 pci_unlock_rescan_remove();
518 static struct device_attribute dev_attr_bus_rescan = __ATTR(rescan, 0200, NULL,
521 #if defined(CONFIG_PM) && defined(CONFIG_ACPI)
522 static ssize_t d3cold_allowed_store(struct device *dev,
523 struct device_attribute *attr,
524 const char *buf, size_t count)
526 struct pci_dev *pdev = to_pci_dev(dev);
529 if (kstrtoul(buf, 0, &val) < 0)
532 pdev->d3cold_allowed = !!val;
533 if (pdev->d3cold_allowed)
534 pci_d3cold_enable(pdev);
536 pci_d3cold_disable(pdev);
538 pm_runtime_resume(dev);
543 static ssize_t d3cold_allowed_show(struct device *dev,
544 struct device_attribute *attr, char *buf)
546 struct pci_dev *pdev = to_pci_dev(dev);
547 return sysfs_emit(buf, "%u\n", pdev->d3cold_allowed);
549 static DEVICE_ATTR_RW(d3cold_allowed);
553 static ssize_t devspec_show(struct device *dev,
554 struct device_attribute *attr, char *buf)
556 struct pci_dev *pdev = to_pci_dev(dev);
557 struct device_node *np = pci_device_to_OF_node(pdev);
561 return sysfs_emit(buf, "%pOF\n", np);
563 static DEVICE_ATTR_RO(devspec);
566 static ssize_t driver_override_store(struct device *dev,
567 struct device_attribute *attr,
568 const char *buf, size_t count)
570 struct pci_dev *pdev = to_pci_dev(dev);
573 ret = driver_set_override(dev, &pdev->driver_override, buf, count);
580 static ssize_t driver_override_show(struct device *dev,
581 struct device_attribute *attr, char *buf)
583 struct pci_dev *pdev = to_pci_dev(dev);
587 len = sysfs_emit(buf, "%s\n", pdev->driver_override);
591 static DEVICE_ATTR_RW(driver_override);
593 static struct attribute *pci_dev_attrs[] = {
594 &dev_attr_power_state.attr,
595 &dev_attr_resource.attr,
596 &dev_attr_vendor.attr,
597 &dev_attr_device.attr,
598 &dev_attr_subsystem_vendor.attr,
599 &dev_attr_subsystem_device.attr,
600 &dev_attr_revision.attr,
601 &dev_attr_class.attr,
603 &dev_attr_local_cpus.attr,
604 &dev_attr_local_cpulist.attr,
605 &dev_attr_modalias.attr,
607 &dev_attr_numa_node.attr,
609 &dev_attr_dma_mask_bits.attr,
610 &dev_attr_consistent_dma_mask_bits.attr,
611 &dev_attr_enable.attr,
612 &dev_attr_broken_parity_status.attr,
613 &dev_attr_msi_bus.attr,
614 #if defined(CONFIG_PM) && defined(CONFIG_ACPI)
615 &dev_attr_d3cold_allowed.attr,
618 &dev_attr_devspec.attr,
620 &dev_attr_driver_override.attr,
621 &dev_attr_ari_enabled.attr,
625 static struct attribute *pci_bridge_attrs[] = {
626 &dev_attr_subordinate_bus_number.attr,
627 &dev_attr_secondary_bus_number.attr,
631 static struct attribute *pcie_dev_attrs[] = {
632 &dev_attr_current_link_speed.attr,
633 &dev_attr_current_link_width.attr,
634 &dev_attr_max_link_width.attr,
635 &dev_attr_max_link_speed.attr,
639 static struct attribute *pcibus_attrs[] = {
640 &dev_attr_bus_rescan.attr,
641 &dev_attr_cpuaffinity.attr,
642 &dev_attr_cpulistaffinity.attr,
646 static const struct attribute_group pcibus_group = {
647 .attrs = pcibus_attrs,
650 const struct attribute_group *pcibus_groups[] = {
655 static ssize_t boot_vga_show(struct device *dev, struct device_attribute *attr,
658 struct pci_dev *pdev = to_pci_dev(dev);
659 struct pci_dev *vga_dev = vga_default_device();
662 return sysfs_emit(buf, "%u\n", (pdev == vga_dev));
664 return sysfs_emit(buf, "%u\n",
665 !!(pdev->resource[PCI_ROM_RESOURCE].flags &
666 IORESOURCE_ROM_SHADOW));
668 static DEVICE_ATTR_RO(boot_vga);
670 static ssize_t pci_read_config(struct file *filp, struct kobject *kobj,
671 struct bin_attribute *bin_attr, char *buf,
672 loff_t off, size_t count)
674 struct pci_dev *dev = to_pci_dev(kobj_to_dev(kobj));
675 unsigned int size = 64;
676 loff_t init_off = off;
677 u8 *data = (u8 *) buf;
679 /* Several chips lock up trying to read undefined config space */
680 if (file_ns_capable(filp, &init_user_ns, CAP_SYS_ADMIN))
681 size = dev->cfg_size;
682 else if (dev->hdr_type == PCI_HEADER_TYPE_CARDBUS)
687 if (off + count > size) {
694 pci_config_pm_runtime_get(dev);
696 if ((off & 1) && size) {
698 pci_user_read_config_byte(dev, off, &val);
699 data[off - init_off] = val;
704 if ((off & 3) && size > 2) {
706 pci_user_read_config_word(dev, off, &val);
707 data[off - init_off] = val & 0xff;
708 data[off - init_off + 1] = (val >> 8) & 0xff;
715 pci_user_read_config_dword(dev, off, &val);
716 data[off - init_off] = val & 0xff;
717 data[off - init_off + 1] = (val >> 8) & 0xff;
718 data[off - init_off + 2] = (val >> 16) & 0xff;
719 data[off - init_off + 3] = (val >> 24) & 0xff;
727 pci_user_read_config_word(dev, off, &val);
728 data[off - init_off] = val & 0xff;
729 data[off - init_off + 1] = (val >> 8) & 0xff;
736 pci_user_read_config_byte(dev, off, &val);
737 data[off - init_off] = val;
740 pci_config_pm_runtime_put(dev);
745 static ssize_t pci_write_config(struct file *filp, struct kobject *kobj,
746 struct bin_attribute *bin_attr, char *buf,
747 loff_t off, size_t count)
749 struct pci_dev *dev = to_pci_dev(kobj_to_dev(kobj));
750 unsigned int size = count;
751 loff_t init_off = off;
752 u8 *data = (u8 *) buf;
755 ret = security_locked_down(LOCKDOWN_PCI_ACCESS);
759 if (off > dev->cfg_size)
761 if (off + count > dev->cfg_size) {
762 size = dev->cfg_size - off;
766 pci_config_pm_runtime_get(dev);
768 if ((off & 1) && size) {
769 pci_user_write_config_byte(dev, off, data[off - init_off]);
774 if ((off & 3) && size > 2) {
775 u16 val = data[off - init_off];
776 val |= (u16) data[off - init_off + 1] << 8;
777 pci_user_write_config_word(dev, off, val);
783 u32 val = data[off - init_off];
784 val |= (u32) data[off - init_off + 1] << 8;
785 val |= (u32) data[off - init_off + 2] << 16;
786 val |= (u32) data[off - init_off + 3] << 24;
787 pci_user_write_config_dword(dev, off, val);
793 u16 val = data[off - init_off];
794 val |= (u16) data[off - init_off + 1] << 8;
795 pci_user_write_config_word(dev, off, val);
801 pci_user_write_config_byte(dev, off, data[off - init_off]);
803 pci_config_pm_runtime_put(dev);
807 static BIN_ATTR(config, 0644, pci_read_config, pci_write_config, 0);
809 static struct bin_attribute *pci_dev_config_attrs[] = {
814 static umode_t pci_dev_config_attr_is_visible(struct kobject *kobj,
815 struct bin_attribute *a, int n)
817 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
819 a->size = PCI_CFG_SPACE_SIZE;
820 if (pdev->cfg_size > PCI_CFG_SPACE_SIZE)
821 a->size = PCI_CFG_SPACE_EXP_SIZE;
826 static const struct attribute_group pci_dev_config_attr_group = {
827 .bin_attrs = pci_dev_config_attrs,
828 .is_bin_visible = pci_dev_config_attr_is_visible,
831 #ifdef HAVE_PCI_LEGACY
833 * pci_read_legacy_io - read byte(s) from legacy I/O port space
834 * @filp: open sysfs file
835 * @kobj: kobject corresponding to file to read from
836 * @bin_attr: struct bin_attribute for this file
837 * @buf: buffer to store results
838 * @off: offset into legacy I/O port space
839 * @count: number of bytes to read
841 * Reads 1, 2, or 4 bytes from legacy I/O port space using an arch specific
842 * callback routine (pci_legacy_read).
844 static ssize_t pci_read_legacy_io(struct file *filp, struct kobject *kobj,
845 struct bin_attribute *bin_attr, char *buf,
846 loff_t off, size_t count)
848 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
850 /* Only support 1, 2 or 4 byte accesses */
851 if (count != 1 && count != 2 && count != 4)
854 return pci_legacy_read(bus, off, (u32 *)buf, count);
858 * pci_write_legacy_io - write byte(s) to legacy I/O port space
859 * @filp: open sysfs file
860 * @kobj: kobject corresponding to file to read from
861 * @bin_attr: struct bin_attribute for this file
862 * @buf: buffer containing value to be written
863 * @off: offset into legacy I/O port space
864 * @count: number of bytes to write
866 * Writes 1, 2, or 4 bytes from legacy I/O port space using an arch specific
867 * callback routine (pci_legacy_write).
869 static ssize_t pci_write_legacy_io(struct file *filp, struct kobject *kobj,
870 struct bin_attribute *bin_attr, char *buf,
871 loff_t off, size_t count)
873 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
875 /* Only support 1, 2 or 4 byte accesses */
876 if (count != 1 && count != 2 && count != 4)
879 return pci_legacy_write(bus, off, *(u32 *)buf, count);
883 * pci_mmap_legacy_mem - map legacy PCI memory into user memory space
884 * @filp: open sysfs file
885 * @kobj: kobject corresponding to device to be mapped
886 * @attr: struct bin_attribute for this file
887 * @vma: struct vm_area_struct passed to mmap
889 * Uses an arch specific callback, pci_mmap_legacy_mem_page_range, to mmap
890 * legacy memory space (first meg of bus space) into application virtual
893 static int pci_mmap_legacy_mem(struct file *filp, struct kobject *kobj,
894 struct bin_attribute *attr,
895 struct vm_area_struct *vma)
897 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
899 return pci_mmap_legacy_page_range(bus, vma, pci_mmap_mem);
903 * pci_mmap_legacy_io - map legacy PCI IO into user memory space
904 * @filp: open sysfs file
905 * @kobj: kobject corresponding to device to be mapped
906 * @attr: struct bin_attribute for this file
907 * @vma: struct vm_area_struct passed to mmap
909 * Uses an arch specific callback, pci_mmap_legacy_io_page_range, to mmap
910 * legacy IO space (first meg of bus space) into application virtual
911 * memory space. Returns -ENOSYS if the operation isn't supported
913 static int pci_mmap_legacy_io(struct file *filp, struct kobject *kobj,
914 struct bin_attribute *attr,
915 struct vm_area_struct *vma)
917 struct pci_bus *bus = to_pci_bus(kobj_to_dev(kobj));
919 return pci_mmap_legacy_page_range(bus, vma, pci_mmap_io);
923 * pci_adjust_legacy_attr - adjustment of legacy file attributes
924 * @b: bus to create files under
925 * @mmap_type: I/O port or memory
927 * Stub implementation. Can be overridden by arch if necessary.
929 void __weak pci_adjust_legacy_attr(struct pci_bus *b,
930 enum pci_mmap_state mmap_type)
935 * pci_create_legacy_files - create legacy I/O port and memory files
936 * @b: bus to create files under
938 * Some platforms allow access to legacy I/O port and ISA memory space on
939 * a per-bus basis. This routine creates the files and ties them into
940 * their associated read, write and mmap files from pci-sysfs.c
942 * On error unwind, but don't propagate the error to the caller
943 * as it is ok to set up the PCI bus without these files.
945 void pci_create_legacy_files(struct pci_bus *b)
949 if (!sysfs_initialized)
952 b->legacy_io = kcalloc(2, sizeof(struct bin_attribute),
957 sysfs_bin_attr_init(b->legacy_io);
958 b->legacy_io->attr.name = "legacy_io";
959 b->legacy_io->size = 0xffff;
960 b->legacy_io->attr.mode = 0600;
961 b->legacy_io->read = pci_read_legacy_io;
962 b->legacy_io->write = pci_write_legacy_io;
963 b->legacy_io->mmap = pci_mmap_legacy_io;
964 b->legacy_io->f_mapping = iomem_get_mapping;
965 pci_adjust_legacy_attr(b, pci_mmap_io);
966 error = device_create_bin_file(&b->dev, b->legacy_io);
970 /* Allocated above after the legacy_io struct */
971 b->legacy_mem = b->legacy_io + 1;
972 sysfs_bin_attr_init(b->legacy_mem);
973 b->legacy_mem->attr.name = "legacy_mem";
974 b->legacy_mem->size = 1024*1024;
975 b->legacy_mem->attr.mode = 0600;
976 b->legacy_mem->mmap = pci_mmap_legacy_mem;
977 b->legacy_mem->f_mapping = iomem_get_mapping;
978 pci_adjust_legacy_attr(b, pci_mmap_mem);
979 error = device_create_bin_file(&b->dev, b->legacy_mem);
986 device_remove_bin_file(&b->dev, b->legacy_io);
991 dev_warn(&b->dev, "could not create legacy I/O port and ISA memory resources in sysfs\n");
994 void pci_remove_legacy_files(struct pci_bus *b)
997 device_remove_bin_file(&b->dev, b->legacy_io);
998 device_remove_bin_file(&b->dev, b->legacy_mem);
999 kfree(b->legacy_io); /* both are allocated here */
1002 #endif /* HAVE_PCI_LEGACY */
1004 #if defined(HAVE_PCI_MMAP) || defined(ARCH_GENERIC_PCI_MMAP_RESOURCE)
1006 int pci_mmap_fits(struct pci_dev *pdev, int resno, struct vm_area_struct *vma,
1007 enum pci_mmap_api mmap_api)
1009 unsigned long nr, start, size;
1010 resource_size_t pci_start = 0, pci_end;
1012 if (pci_resource_len(pdev, resno) == 0)
1014 nr = vma_pages(vma);
1015 start = vma->vm_pgoff;
1016 size = ((pci_resource_len(pdev, resno) - 1) >> PAGE_SHIFT) + 1;
1017 if (mmap_api == PCI_MMAP_PROCFS) {
1018 pci_resource_to_user(pdev, resno, &pdev->resource[resno],
1019 &pci_start, &pci_end);
1020 pci_start >>= PAGE_SHIFT;
1022 if (start >= pci_start && start < pci_start + size &&
1023 start + nr <= pci_start + size)
1029 * pci_mmap_resource - map a PCI resource into user memory space
1030 * @kobj: kobject for mapping
1031 * @attr: struct bin_attribute for the file being mapped
1032 * @vma: struct vm_area_struct passed into the mmap
1033 * @write_combine: 1 for write_combine mapping
1035 * Use the regular PCI mapping routines to map a PCI resource into userspace.
1037 static int pci_mmap_resource(struct kobject *kobj, struct bin_attribute *attr,
1038 struct vm_area_struct *vma, int write_combine)
1040 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1041 int bar = (unsigned long)attr->private;
1042 enum pci_mmap_state mmap_type;
1043 struct resource *res = &pdev->resource[bar];
1046 ret = security_locked_down(LOCKDOWN_PCI_ACCESS);
1050 if (res->flags & IORESOURCE_MEM && iomem_is_exclusive(res->start))
1053 if (!pci_mmap_fits(pdev, bar, vma, PCI_MMAP_SYSFS))
1056 mmap_type = res->flags & IORESOURCE_MEM ? pci_mmap_mem : pci_mmap_io;
1058 return pci_mmap_resource_range(pdev, bar, vma, mmap_type, write_combine);
1061 static int pci_mmap_resource_uc(struct file *filp, struct kobject *kobj,
1062 struct bin_attribute *attr,
1063 struct vm_area_struct *vma)
1065 return pci_mmap_resource(kobj, attr, vma, 0);
1068 static int pci_mmap_resource_wc(struct file *filp, struct kobject *kobj,
1069 struct bin_attribute *attr,
1070 struct vm_area_struct *vma)
1072 return pci_mmap_resource(kobj, attr, vma, 1);
1075 static ssize_t pci_resource_io(struct file *filp, struct kobject *kobj,
1076 struct bin_attribute *attr, char *buf,
1077 loff_t off, size_t count, bool write)
1079 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1080 int bar = (unsigned long)attr->private;
1081 unsigned long port = off;
1083 port += pci_resource_start(pdev, bar);
1085 if (port > pci_resource_end(pdev, bar))
1088 if (port + count - 1 > pci_resource_end(pdev, bar))
1094 outb(*(u8 *)buf, port);
1096 *(u8 *)buf = inb(port);
1100 outw(*(u16 *)buf, port);
1102 *(u16 *)buf = inw(port);
1106 outl(*(u32 *)buf, port);
1108 *(u32 *)buf = inl(port);
1114 static ssize_t pci_read_resource_io(struct file *filp, struct kobject *kobj,
1115 struct bin_attribute *attr, char *buf,
1116 loff_t off, size_t count)
1118 return pci_resource_io(filp, kobj, attr, buf, off, count, false);
1121 static ssize_t pci_write_resource_io(struct file *filp, struct kobject *kobj,
1122 struct bin_attribute *attr, char *buf,
1123 loff_t off, size_t count)
1127 ret = security_locked_down(LOCKDOWN_PCI_ACCESS);
1131 return pci_resource_io(filp, kobj, attr, buf, off, count, true);
1135 * pci_remove_resource_files - cleanup resource files
1136 * @pdev: dev to cleanup
1138 * If we created resource files for @pdev, remove them from sysfs and
1139 * free their resources.
1141 static void pci_remove_resource_files(struct pci_dev *pdev)
1145 for (i = 0; i < PCI_STD_NUM_BARS; i++) {
1146 struct bin_attribute *res_attr;
1148 res_attr = pdev->res_attr[i];
1150 sysfs_remove_bin_file(&pdev->dev.kobj, res_attr);
1154 res_attr = pdev->res_attr_wc[i];
1156 sysfs_remove_bin_file(&pdev->dev.kobj, res_attr);
1162 static int pci_create_attr(struct pci_dev *pdev, int num, int write_combine)
1164 /* allocate attribute structure, piggyback attribute name */
1165 int name_len = write_combine ? 13 : 10;
1166 struct bin_attribute *res_attr;
1167 char *res_attr_name;
1170 res_attr = kzalloc(sizeof(*res_attr) + name_len, GFP_ATOMIC);
1174 res_attr_name = (char *)(res_attr + 1);
1176 sysfs_bin_attr_init(res_attr);
1177 if (write_combine) {
1178 pdev->res_attr_wc[num] = res_attr;
1179 sprintf(res_attr_name, "resource%d_wc", num);
1180 res_attr->mmap = pci_mmap_resource_wc;
1182 pdev->res_attr[num] = res_attr;
1183 sprintf(res_attr_name, "resource%d", num);
1184 if (pci_resource_flags(pdev, num) & IORESOURCE_IO) {
1185 res_attr->read = pci_read_resource_io;
1186 res_attr->write = pci_write_resource_io;
1187 if (arch_can_pci_mmap_io())
1188 res_attr->mmap = pci_mmap_resource_uc;
1190 res_attr->mmap = pci_mmap_resource_uc;
1194 res_attr->f_mapping = iomem_get_mapping;
1195 res_attr->attr.name = res_attr_name;
1196 res_attr->attr.mode = 0600;
1197 res_attr->size = pci_resource_len(pdev, num);
1198 res_attr->private = (void *)(unsigned long)num;
1199 retval = sysfs_create_bin_file(&pdev->dev.kobj, res_attr);
1207 * pci_create_resource_files - create resource files in sysfs for @dev
1208 * @pdev: dev in question
1210 * Walk the resources in @pdev creating files for each resource available.
1212 static int pci_create_resource_files(struct pci_dev *pdev)
1217 /* Expose the PCI resources from this device as files */
1218 for (i = 0; i < PCI_STD_NUM_BARS; i++) {
1220 /* skip empty resources */
1221 if (!pci_resource_len(pdev, i))
1224 retval = pci_create_attr(pdev, i, 0);
1225 /* for prefetchable resources, create a WC mappable file */
1226 if (!retval && arch_can_pci_mmap_wc() &&
1227 pdev->resource[i].flags & IORESOURCE_PREFETCH)
1228 retval = pci_create_attr(pdev, i, 1);
1230 pci_remove_resource_files(pdev);
1236 #else /* !(defined(HAVE_PCI_MMAP) || defined(ARCH_GENERIC_PCI_MMAP_RESOURCE)) */
1237 int __weak pci_create_resource_files(struct pci_dev *dev) { return 0; }
1238 void __weak pci_remove_resource_files(struct pci_dev *dev) { return; }
1242 * pci_write_rom - used to enable access to the PCI ROM display
1244 * @kobj: kernel object handle
1245 * @bin_attr: struct bin_attribute for this file
1248 * @count: number of byte in input
1250 * writing anything except 0 enables it
1252 static ssize_t pci_write_rom(struct file *filp, struct kobject *kobj,
1253 struct bin_attribute *bin_attr, char *buf,
1254 loff_t off, size_t count)
1256 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1258 if ((off == 0) && (*buf == '0') && (count == 2))
1259 pdev->rom_attr_enabled = 0;
1261 pdev->rom_attr_enabled = 1;
1267 * pci_read_rom - read a PCI ROM
1269 * @kobj: kernel object handle
1270 * @bin_attr: struct bin_attribute for this file
1271 * @buf: where to put the data we read from the ROM
1273 * @count: number of bytes to read
1275 * Put @count bytes starting at @off into @buf from the ROM in the PCI
1276 * device corresponding to @kobj.
1278 static ssize_t pci_read_rom(struct file *filp, struct kobject *kobj,
1279 struct bin_attribute *bin_attr, char *buf,
1280 loff_t off, size_t count)
1282 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1286 if (!pdev->rom_attr_enabled)
1289 rom = pci_map_rom(pdev, &size); /* size starts out as PCI window size */
1296 if (off + count > size)
1299 memcpy_fromio(buf, rom + off, count);
1301 pci_unmap_rom(pdev, rom);
1305 static BIN_ATTR(rom, 0600, pci_read_rom, pci_write_rom, 0);
1307 static struct bin_attribute *pci_dev_rom_attrs[] = {
1312 static umode_t pci_dev_rom_attr_is_visible(struct kobject *kobj,
1313 struct bin_attribute *a, int n)
1315 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1318 /* If the device has a ROM, try to expose it in sysfs. */
1319 rom_size = pci_resource_len(pdev, PCI_ROM_RESOURCE);
1325 return a->attr.mode;
1328 static const struct attribute_group pci_dev_rom_attr_group = {
1329 .bin_attrs = pci_dev_rom_attrs,
1330 .is_bin_visible = pci_dev_rom_attr_is_visible,
1333 static ssize_t reset_store(struct device *dev, struct device_attribute *attr,
1334 const char *buf, size_t count)
1336 struct pci_dev *pdev = to_pci_dev(dev);
1340 if (kstrtoul(buf, 0, &val) < 0)
1346 pm_runtime_get_sync(dev);
1347 result = pci_reset_function(pdev);
1348 pm_runtime_put(dev);
1354 static DEVICE_ATTR_WO(reset);
1356 static struct attribute *pci_dev_reset_attrs[] = {
1357 &dev_attr_reset.attr,
1361 static umode_t pci_dev_reset_attr_is_visible(struct kobject *kobj,
1362 struct attribute *a, int n)
1364 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1366 if (!pci_reset_supported(pdev))
1372 static const struct attribute_group pci_dev_reset_attr_group = {
1373 .attrs = pci_dev_reset_attrs,
1374 .is_visible = pci_dev_reset_attr_is_visible,
1377 #define pci_dev_resource_resize_attr(n) \
1378 static ssize_t resource##n##_resize_show(struct device *dev, \
1379 struct device_attribute *attr, \
1382 struct pci_dev *pdev = to_pci_dev(dev); \
1385 pci_config_pm_runtime_get(pdev); \
1387 ret = sysfs_emit(buf, "%016llx\n", \
1388 (u64)pci_rebar_get_possible_sizes(pdev, n)); \
1390 pci_config_pm_runtime_put(pdev); \
1395 static ssize_t resource##n##_resize_store(struct device *dev, \
1396 struct device_attribute *attr,\
1397 const char *buf, size_t count)\
1399 struct pci_dev *pdev = to_pci_dev(dev); \
1400 unsigned long size, flags; \
1404 if (kstrtoul(buf, 0, &size) < 0) \
1408 if (dev->driver) { \
1413 pci_config_pm_runtime_get(pdev); \
1415 if ((pdev->class >> 8) == PCI_CLASS_DISPLAY_VGA) { \
1416 ret = aperture_remove_conflicting_pci_devices(pdev, \
1417 "resourceN_resize"); \
1422 pci_read_config_word(pdev, PCI_COMMAND, &cmd); \
1423 pci_write_config_word(pdev, PCI_COMMAND, \
1424 cmd & ~PCI_COMMAND_MEMORY); \
1426 flags = pci_resource_flags(pdev, n); \
1428 pci_remove_resource_files(pdev); \
1430 for (i = 0; i < PCI_STD_NUM_BARS; i++) { \
1431 if (pci_resource_len(pdev, i) && \
1432 pci_resource_flags(pdev, i) == flags) \
1433 pci_release_resource(pdev, i); \
1436 ret = pci_resize_resource(pdev, n, size); \
1438 pci_assign_unassigned_bus_resources(pdev->bus); \
1440 if (pci_create_resource_files(pdev)) \
1441 pci_warn(pdev, "Failed to recreate resource files after BAR resizing\n");\
1443 pci_write_config_word(pdev, PCI_COMMAND, cmd); \
1445 pci_config_pm_runtime_put(pdev); \
1447 device_unlock(dev); \
1449 return ret ? ret : count; \
1451 static DEVICE_ATTR_RW(resource##n##_resize)
1453 pci_dev_resource_resize_attr(0);
1454 pci_dev_resource_resize_attr(1);
1455 pci_dev_resource_resize_attr(2);
1456 pci_dev_resource_resize_attr(3);
1457 pci_dev_resource_resize_attr(4);
1458 pci_dev_resource_resize_attr(5);
1460 static struct attribute *resource_resize_attrs[] = {
1461 &dev_attr_resource0_resize.attr,
1462 &dev_attr_resource1_resize.attr,
1463 &dev_attr_resource2_resize.attr,
1464 &dev_attr_resource3_resize.attr,
1465 &dev_attr_resource4_resize.attr,
1466 &dev_attr_resource5_resize.attr,
1470 static umode_t resource_resize_is_visible(struct kobject *kobj,
1471 struct attribute *a, int n)
1473 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
1475 return pci_rebar_get_current_size(pdev, n) < 0 ? 0 : a->mode;
1478 static const struct attribute_group pci_dev_resource_resize_group = {
1479 .attrs = resource_resize_attrs,
1480 .is_visible = resource_resize_is_visible,
1483 int __must_check pci_create_sysfs_dev_files(struct pci_dev *pdev)
1485 if (!sysfs_initialized)
1488 return pci_create_resource_files(pdev);
1492 * pci_remove_sysfs_dev_files - cleanup PCI specific sysfs files
1493 * @pdev: device whose entries we should free
1495 * Cleanup when @pdev is removed from sysfs.
1497 void pci_remove_sysfs_dev_files(struct pci_dev *pdev)
1499 if (!sysfs_initialized)
1502 pci_remove_resource_files(pdev);
1505 static int __init pci_sysfs_init(void)
1507 struct pci_dev *pdev = NULL;
1508 struct pci_bus *pbus = NULL;
1511 sysfs_initialized = 1;
1512 for_each_pci_dev(pdev) {
1513 retval = pci_create_sysfs_dev_files(pdev);
1520 while ((pbus = pci_find_next_bus(pbus)))
1521 pci_create_legacy_files(pbus);
1525 late_initcall(pci_sysfs_init);
1527 static struct attribute *pci_dev_dev_attrs[] = {
1528 &dev_attr_boot_vga.attr,
1532 static umode_t pci_dev_attrs_are_visible(struct kobject *kobj,
1533 struct attribute *a, int n)
1535 struct device *dev = kobj_to_dev(kobj);
1536 struct pci_dev *pdev = to_pci_dev(dev);
1538 if (a == &dev_attr_boot_vga.attr)
1539 if ((pdev->class >> 8) != PCI_CLASS_DISPLAY_VGA)
1545 static struct attribute *pci_dev_hp_attrs[] = {
1546 &dev_attr_remove.attr,
1547 &dev_attr_dev_rescan.attr,
1551 static umode_t pci_dev_hp_attrs_are_visible(struct kobject *kobj,
1552 struct attribute *a, int n)
1554 struct device *dev = kobj_to_dev(kobj);
1555 struct pci_dev *pdev = to_pci_dev(dev);
1557 if (pdev->is_virtfn)
1563 static umode_t pci_bridge_attrs_are_visible(struct kobject *kobj,
1564 struct attribute *a, int n)
1566 struct device *dev = kobj_to_dev(kobj);
1567 struct pci_dev *pdev = to_pci_dev(dev);
1569 if (pci_is_bridge(pdev))
1575 static umode_t pcie_dev_attrs_are_visible(struct kobject *kobj,
1576 struct attribute *a, int n)
1578 struct device *dev = kobj_to_dev(kobj);
1579 struct pci_dev *pdev = to_pci_dev(dev);
1581 if (pci_is_pcie(pdev))
1587 static const struct attribute_group pci_dev_group = {
1588 .attrs = pci_dev_attrs,
1591 const struct attribute_group *pci_dev_groups[] = {
1593 &pci_dev_config_attr_group,
1594 &pci_dev_rom_attr_group,
1595 &pci_dev_reset_attr_group,
1596 &pci_dev_reset_method_attr_group,
1597 &pci_dev_vpd_attr_group,
1599 &pci_dev_smbios_attr_group,
1602 &pci_dev_acpi_attr_group,
1604 &pci_dev_resource_resize_group,
1608 static const struct attribute_group pci_dev_hp_attr_group = {
1609 .attrs = pci_dev_hp_attrs,
1610 .is_visible = pci_dev_hp_attrs_are_visible,
1613 static const struct attribute_group pci_dev_attr_group = {
1614 .attrs = pci_dev_dev_attrs,
1615 .is_visible = pci_dev_attrs_are_visible,
1618 static const struct attribute_group pci_bridge_attr_group = {
1619 .attrs = pci_bridge_attrs,
1620 .is_visible = pci_bridge_attrs_are_visible,
1623 static const struct attribute_group pcie_dev_attr_group = {
1624 .attrs = pcie_dev_attrs,
1625 .is_visible = pcie_dev_attrs_are_visible,
1628 static const struct attribute_group *pci_dev_attr_groups[] = {
1629 &pci_dev_attr_group,
1630 &pci_dev_hp_attr_group,
1631 #ifdef CONFIG_PCI_IOV
1632 &sriov_pf_dev_attr_group,
1633 &sriov_vf_dev_attr_group,
1635 &pci_bridge_attr_group,
1636 &pcie_dev_attr_group,
1637 #ifdef CONFIG_PCIEAER
1638 &aer_stats_attr_group,
1640 #ifdef CONFIG_PCIEASPM
1641 &aspm_ctrl_attr_group,
1646 const struct device_type pci_dev_type = {
1647 .groups = pci_dev_attr_groups,