2 * Copyright (C) 2012 Red Hat, Inc. All rights reserved.
3 * Author: Alex Williamson <alex.williamson@redhat.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Derived from original vfio:
10 * Copyright 2010 Cisco Systems, Inc. All rights reserved.
11 * Author: Tom Lyon, pugs@cisco.com
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
16 #include <linux/device.h>
17 #include <linux/eventfd.h>
18 #include <linux/file.h>
19 #include <linux/interrupt.h>
20 #include <linux/iommu.h>
21 #include <linux/module.h>
22 #include <linux/mutex.h>
23 #include <linux/notifier.h>
24 #include <linux/pci.h>
25 #include <linux/pm_runtime.h>
26 #include <linux/slab.h>
27 #include <linux/types.h>
28 #include <linux/uaccess.h>
29 #include <linux/vfio.h>
30 #include <linux/vgaarb.h>
32 #include "vfio_pci_private.h"
34 #define DRIVER_VERSION "0.2"
35 #define DRIVER_AUTHOR "Alex Williamson <alex.williamson@redhat.com>"
36 #define DRIVER_DESC "VFIO PCI - User Level meta-driver"
38 static char ids
[1024] __initdata
;
39 module_param_string(ids
, ids
, sizeof(ids
), 0);
40 MODULE_PARM_DESC(ids
, "Initial PCI IDs to add to the vfio driver, format is \"vendor:device[:subvendor[:subdevice[:class[:class_mask]]]]\" and multiple comma separated entries can be specified");
42 static bool nointxmask
;
43 module_param_named(nointxmask
, nointxmask
, bool, S_IRUGO
| S_IWUSR
);
44 MODULE_PARM_DESC(nointxmask
,
45 "Disable support for PCI 2.3 style INTx masking. If this resolves problems for specific devices, report lspci -vvvxxx to linux-pci@vger.kernel.org so the device can be fixed automatically via the broken_intx_masking flag.");
47 #ifdef CONFIG_VFIO_PCI_VGA
48 static bool disable_vga
;
49 module_param(disable_vga
, bool, S_IRUGO
);
50 MODULE_PARM_DESC(disable_vga
, "Disable VGA resource access through vfio-pci");
53 static bool disable_idle_d3
;
54 module_param(disable_idle_d3
, bool, S_IRUGO
| S_IWUSR
);
55 MODULE_PARM_DESC(disable_idle_d3
,
56 "Disable using the PCI D3 low power state for idle, unused devices");
58 static DEFINE_MUTEX(driver_lock
);
60 static inline bool vfio_vga_disabled(void)
62 #ifdef CONFIG_VFIO_PCI_VGA
70 * Our VGA arbiter participation is limited since we don't know anything
71 * about the device itself. However, if the device is the only VGA device
72 * downstream of a bridge and VFIO VGA support is disabled, then we can
73 * safely return legacy VGA IO and memory as not decoded since the user
74 * has no way to get to it and routing can be disabled externally at the
77 static unsigned int vfio_pci_set_vga_decode(void *opaque
, bool single_vga
)
79 struct vfio_pci_device
*vdev
= opaque
;
80 struct pci_dev
*tmp
= NULL
, *pdev
= vdev
->pdev
;
81 unsigned char max_busnr
;
84 if (single_vga
|| !vfio_vga_disabled() || pci_is_root_bus(pdev
->bus
))
85 return VGA_RSRC_NORMAL_IO
| VGA_RSRC_NORMAL_MEM
|
86 VGA_RSRC_LEGACY_IO
| VGA_RSRC_LEGACY_MEM
;
88 max_busnr
= pci_bus_max_busnr(pdev
->bus
);
89 decodes
= VGA_RSRC_NORMAL_IO
| VGA_RSRC_NORMAL_MEM
;
91 while ((tmp
= pci_get_class(PCI_CLASS_DISPLAY_VGA
<< 8, tmp
)) != NULL
) {
93 pci_domain_nr(tmp
->bus
) != pci_domain_nr(pdev
->bus
) ||
94 pci_is_root_bus(tmp
->bus
))
97 if (tmp
->bus
->number
>= pdev
->bus
->number
&&
98 tmp
->bus
->number
<= max_busnr
) {
100 decodes
|= VGA_RSRC_LEGACY_IO
| VGA_RSRC_LEGACY_MEM
;
108 static inline bool vfio_pci_is_vga(struct pci_dev
*pdev
)
110 return (pdev
->class >> 8) == PCI_CLASS_DISPLAY_VGA
;
113 static void vfio_pci_probe_mmaps(struct vfio_pci_device
*vdev
)
115 struct resource
*res
;
117 struct vfio_pci_dummy_resource
*dummy_res
;
119 INIT_LIST_HEAD(&vdev
->dummy_resources_list
);
121 for (bar
= PCI_STD_RESOURCES
; bar
<= PCI_STD_RESOURCE_END
; bar
++) {
122 res
= vdev
->pdev
->resource
+ bar
;
124 if (!IS_ENABLED(CONFIG_VFIO_PCI_MMAP
))
127 if (!(res
->flags
& IORESOURCE_MEM
))
131 * The PCI core shouldn't set up a resource with a
132 * type but zero size. But there may be bugs that
133 * cause us to do that.
135 if (!resource_size(res
))
138 if (resource_size(res
) >= PAGE_SIZE
) {
139 vdev
->bar_mmap_supported
[bar
] = true;
143 if (!(res
->start
& ~PAGE_MASK
)) {
145 * Add a dummy resource to reserve the remainder
146 * of the exclusive page in case that hot-add
147 * device's bar is assigned into it.
149 dummy_res
= kzalloc(sizeof(*dummy_res
), GFP_KERNEL
);
150 if (dummy_res
== NULL
)
153 dummy_res
->resource
.name
= "vfio sub-page reserved";
154 dummy_res
->resource
.start
= res
->end
+ 1;
155 dummy_res
->resource
.end
= res
->start
+ PAGE_SIZE
- 1;
156 dummy_res
->resource
.flags
= res
->flags
;
157 if (request_resource(res
->parent
,
158 &dummy_res
->resource
)) {
162 dummy_res
->index
= bar
;
163 list_add(&dummy_res
->res_next
,
164 &vdev
->dummy_resources_list
);
165 vdev
->bar_mmap_supported
[bar
] = true;
169 * Here we don't handle the case when the BAR is not page
170 * aligned because we can't expect the BAR will be
171 * assigned into the same location in a page in guest
172 * when we passthrough the BAR. And it's hard to access
173 * this BAR in userspace because we have no way to get
174 * the BAR's location in a page.
177 vdev
->bar_mmap_supported
[bar
] = false;
181 static void vfio_pci_try_bus_reset(struct vfio_pci_device
*vdev
);
182 static void vfio_pci_disable(struct vfio_pci_device
*vdev
);
185 * INTx masking requires the ability to disable INTx signaling via PCI_COMMAND
186 * _and_ the ability detect when the device is asserting INTx via PCI_STATUS.
187 * If a device implements the former but not the latter we would typically
188 * expect broken_intx_masking be set and require an exclusive interrupt.
189 * However since we do have control of the device's ability to assert INTx,
190 * we can instead pretend that the device does not implement INTx, virtualizing
191 * the pin register to report zero and maintaining DisINTx set on the host.
193 static bool vfio_pci_nointx(struct pci_dev
*pdev
)
195 switch (pdev
->vendor
) {
196 case PCI_VENDOR_ID_INTEL
:
197 switch (pdev
->device
) {
198 /* All i40e (XL710/X710) 10/20/40GbE NICs */
201 case 0x1580 ... 0x1581:
202 case 0x1583 ... 0x1589:
203 case 0x37d0 ... 0x37d2:
213 static int vfio_pci_enable(struct vfio_pci_device
*vdev
)
215 struct pci_dev
*pdev
= vdev
->pdev
;
220 pci_set_power_state(pdev
, PCI_D0
);
222 /* Don't allow our initial saved state to include busmaster */
223 pci_clear_master(pdev
);
225 ret
= pci_enable_device(pdev
);
229 vdev
->reset_works
= (pci_reset_function(pdev
) == 0);
230 pci_save_state(pdev
);
231 vdev
->pci_saved_state
= pci_store_saved_state(pdev
);
232 if (!vdev
->pci_saved_state
)
233 pr_debug("%s: Couldn't store %s saved state\n",
234 __func__
, dev_name(&pdev
->dev
));
236 if (likely(!nointxmask
)) {
237 if (vfio_pci_nointx(pdev
)) {
238 dev_info(&pdev
->dev
, "Masking broken INTx support\n");
242 vdev
->pci_2_3
= pci_intx_mask_supported(pdev
);
245 pci_read_config_word(pdev
, PCI_COMMAND
, &cmd
);
246 if (vdev
->pci_2_3
&& (cmd
& PCI_COMMAND_INTX_DISABLE
)) {
247 cmd
&= ~PCI_COMMAND_INTX_DISABLE
;
248 pci_write_config_word(pdev
, PCI_COMMAND
, cmd
);
251 ret
= vfio_config_init(vdev
);
253 kfree(vdev
->pci_saved_state
);
254 vdev
->pci_saved_state
= NULL
;
255 pci_disable_device(pdev
);
259 msix_pos
= pdev
->msix_cap
;
264 pci_read_config_word(pdev
, msix_pos
+ PCI_MSIX_FLAGS
, &flags
);
265 pci_read_config_dword(pdev
, msix_pos
+ PCI_MSIX_TABLE
, &table
);
267 vdev
->msix_bar
= table
& PCI_MSIX_TABLE_BIR
;
268 vdev
->msix_offset
= table
& PCI_MSIX_TABLE_OFFSET
;
269 vdev
->msix_size
= ((flags
& PCI_MSIX_FLAGS_QSIZE
) + 1) * 16;
271 vdev
->msix_bar
= 0xFF;
273 if (!vfio_vga_disabled() && vfio_pci_is_vga(pdev
))
274 vdev
->has_vga
= true;
277 if (vfio_pci_is_vga(pdev
) &&
278 pdev
->vendor
== PCI_VENDOR_ID_INTEL
&&
279 IS_ENABLED(CONFIG_VFIO_PCI_IGD
)) {
280 ret
= vfio_pci_igd_init(vdev
);
282 dev_warn(&vdev
->pdev
->dev
,
283 "Failed to setup Intel IGD regions\n");
284 vfio_pci_disable(vdev
);
289 vfio_pci_probe_mmaps(vdev
);
294 static void vfio_pci_disable(struct vfio_pci_device
*vdev
)
296 struct pci_dev
*pdev
= vdev
->pdev
;
297 struct vfio_pci_dummy_resource
*dummy_res
, *tmp
;
300 /* Stop the device from further DMA */
301 pci_clear_master(pdev
);
303 vfio_pci_set_irqs_ioctl(vdev
, VFIO_IRQ_SET_DATA_NONE
|
304 VFIO_IRQ_SET_ACTION_TRIGGER
,
305 vdev
->irq_type
, 0, 0, NULL
);
307 vdev
->virq_disabled
= false;
309 for (i
= 0; i
< vdev
->num_regions
; i
++)
310 vdev
->region
[i
].ops
->release(vdev
, &vdev
->region
[i
]);
312 vdev
->num_regions
= 0;
314 vdev
->region
= NULL
; /* don't krealloc a freed pointer */
316 vfio_config_free(vdev
);
318 for (bar
= PCI_STD_RESOURCES
; bar
<= PCI_STD_RESOURCE_END
; bar
++) {
319 if (!vdev
->barmap
[bar
])
321 pci_iounmap(pdev
, vdev
->barmap
[bar
]);
322 pci_release_selected_regions(pdev
, 1 << bar
);
323 vdev
->barmap
[bar
] = NULL
;
326 list_for_each_entry_safe(dummy_res
, tmp
,
327 &vdev
->dummy_resources_list
, res_next
) {
328 list_del(&dummy_res
->res_next
);
329 release_resource(&dummy_res
->resource
);
333 vdev
->needs_reset
= true;
336 * If we have saved state, restore it. If we can reset the device,
337 * even better. Resetting with current state seems better than
338 * nothing, but saving and restoring current state without reset
341 if (pci_load_and_free_saved_state(pdev
, &vdev
->pci_saved_state
)) {
342 pr_info("%s: Couldn't reload %s saved state\n",
343 __func__
, dev_name(&pdev
->dev
));
345 if (!vdev
->reset_works
)
348 pci_save_state(pdev
);
352 * Disable INTx and MSI, presumably to avoid spurious interrupts
353 * during reset. Stolen from pci_reset_function()
355 pci_write_config_word(pdev
, PCI_COMMAND
, PCI_COMMAND_INTX_DISABLE
);
358 * Try to reset the device. The success of this is dependent on
359 * being able to lock the device, which is not always possible.
361 if (vdev
->reset_works
&& !pci_try_reset_function(pdev
))
362 vdev
->needs_reset
= false;
364 pci_restore_state(pdev
);
366 pci_disable_device(pdev
);
368 vfio_pci_try_bus_reset(vdev
);
370 if (!disable_idle_d3
)
371 pci_set_power_state(pdev
, PCI_D3hot
);
374 static void vfio_pci_release(void *device_data
)
376 struct vfio_pci_device
*vdev
= device_data
;
378 mutex_lock(&driver_lock
);
380 if (!(--vdev
->refcnt
)) {
381 vfio_spapr_pci_eeh_release(vdev
->pdev
);
382 vfio_pci_disable(vdev
);
385 mutex_unlock(&driver_lock
);
387 module_put(THIS_MODULE
);
390 static int vfio_pci_open(void *device_data
)
392 struct vfio_pci_device
*vdev
= device_data
;
395 if (!try_module_get(THIS_MODULE
))
398 mutex_lock(&driver_lock
);
401 ret
= vfio_pci_enable(vdev
);
405 vfio_spapr_pci_eeh_open(vdev
->pdev
);
409 mutex_unlock(&driver_lock
);
411 module_put(THIS_MODULE
);
415 static int vfio_pci_get_irq_count(struct vfio_pci_device
*vdev
, int irq_type
)
417 if (irq_type
== VFIO_PCI_INTX_IRQ_INDEX
) {
419 pci_read_config_byte(vdev
->pdev
, PCI_INTERRUPT_PIN
, &pin
);
420 if (IS_ENABLED(CONFIG_VFIO_PCI_INTX
) && !vdev
->nointx
&& pin
)
423 } else if (irq_type
== VFIO_PCI_MSI_IRQ_INDEX
) {
427 pos
= vdev
->pdev
->msi_cap
;
429 pci_read_config_word(vdev
->pdev
,
430 pos
+ PCI_MSI_FLAGS
, &flags
);
431 return 1 << ((flags
& PCI_MSI_FLAGS_QMASK
) >> 1);
433 } else if (irq_type
== VFIO_PCI_MSIX_IRQ_INDEX
) {
437 pos
= vdev
->pdev
->msix_cap
;
439 pci_read_config_word(vdev
->pdev
,
440 pos
+ PCI_MSIX_FLAGS
, &flags
);
442 return (flags
& PCI_MSIX_FLAGS_QSIZE
) + 1;
444 } else if (irq_type
== VFIO_PCI_ERR_IRQ_INDEX
) {
445 if (pci_is_pcie(vdev
->pdev
))
447 } else if (irq_type
== VFIO_PCI_REQ_IRQ_INDEX
) {
454 static int vfio_pci_count_devs(struct pci_dev
*pdev
, void *data
)
460 struct vfio_pci_fill_info
{
463 struct vfio_pci_dependent_device
*devices
;
466 static int vfio_pci_fill_devs(struct pci_dev
*pdev
, void *data
)
468 struct vfio_pci_fill_info
*fill
= data
;
469 struct iommu_group
*iommu_group
;
471 if (fill
->cur
== fill
->max
)
472 return -EAGAIN
; /* Something changed, try again */
474 iommu_group
= iommu_group_get(&pdev
->dev
);
476 return -EPERM
; /* Cannot reset non-isolated devices */
478 fill
->devices
[fill
->cur
].group_id
= iommu_group_id(iommu_group
);
479 fill
->devices
[fill
->cur
].segment
= pci_domain_nr(pdev
->bus
);
480 fill
->devices
[fill
->cur
].bus
= pdev
->bus
->number
;
481 fill
->devices
[fill
->cur
].devfn
= pdev
->devfn
;
483 iommu_group_put(iommu_group
);
487 struct vfio_pci_group_entry
{
488 struct vfio_group
*group
;
492 struct vfio_pci_group_info
{
494 struct vfio_pci_group_entry
*groups
;
497 static int vfio_pci_validate_devs(struct pci_dev
*pdev
, void *data
)
499 struct vfio_pci_group_info
*info
= data
;
500 struct iommu_group
*group
;
503 group
= iommu_group_get(&pdev
->dev
);
507 id
= iommu_group_id(group
);
509 for (i
= 0; i
< info
->count
; i
++)
510 if (info
->groups
[i
].id
== id
)
513 iommu_group_put(group
);
515 return (i
== info
->count
) ? -EINVAL
: 0;
518 static bool vfio_pci_dev_below_slot(struct pci_dev
*pdev
, struct pci_slot
*slot
)
520 for (; pdev
; pdev
= pdev
->bus
->self
)
521 if (pdev
->bus
== slot
->bus
)
522 return (pdev
->slot
== slot
);
526 struct vfio_pci_walk_info
{
527 int (*fn
)(struct pci_dev
*, void *data
);
529 struct pci_dev
*pdev
;
534 static int vfio_pci_walk_wrapper(struct pci_dev
*pdev
, void *data
)
536 struct vfio_pci_walk_info
*walk
= data
;
538 if (!walk
->slot
|| vfio_pci_dev_below_slot(pdev
, walk
->pdev
->slot
))
539 walk
->ret
= walk
->fn(pdev
, walk
->data
);
544 static int vfio_pci_for_each_slot_or_bus(struct pci_dev
*pdev
,
545 int (*fn
)(struct pci_dev
*,
546 void *data
), void *data
,
549 struct vfio_pci_walk_info walk
= {
550 .fn
= fn
, .data
= data
, .pdev
= pdev
, .slot
= slot
, .ret
= 0,
553 pci_walk_bus(pdev
->bus
, vfio_pci_walk_wrapper
, &walk
);
558 static int msix_sparse_mmap_cap(struct vfio_pci_device
*vdev
,
559 struct vfio_info_cap
*caps
)
561 struct vfio_info_cap_header
*header
;
562 struct vfio_region_info_cap_sparse_mmap
*sparse
;
564 int nr_areas
= 2, i
= 0;
566 end
= pci_resource_len(vdev
->pdev
, vdev
->msix_bar
);
568 /* If MSI-X table is aligned to the start or end, only one area */
569 if (((vdev
->msix_offset
& PAGE_MASK
) == 0) ||
570 (PAGE_ALIGN(vdev
->msix_offset
+ vdev
->msix_size
) >= end
))
573 size
= sizeof(*sparse
) + (nr_areas
* sizeof(*sparse
->areas
));
575 header
= vfio_info_cap_add(caps
, size
,
576 VFIO_REGION_INFO_CAP_SPARSE_MMAP
, 1);
578 return PTR_ERR(header
);
580 sparse
= container_of(header
,
581 struct vfio_region_info_cap_sparse_mmap
, header
);
582 sparse
->nr_areas
= nr_areas
;
584 if (vdev
->msix_offset
& PAGE_MASK
) {
585 sparse
->areas
[i
].offset
= 0;
586 sparse
->areas
[i
].size
= vdev
->msix_offset
& PAGE_MASK
;
590 if (PAGE_ALIGN(vdev
->msix_offset
+ vdev
->msix_size
) < end
) {
591 sparse
->areas
[i
].offset
= PAGE_ALIGN(vdev
->msix_offset
+
593 sparse
->areas
[i
].size
= end
- sparse
->areas
[i
].offset
;
600 static int region_type_cap(struct vfio_pci_device
*vdev
,
601 struct vfio_info_cap
*caps
,
602 unsigned int type
, unsigned int subtype
)
604 struct vfio_info_cap_header
*header
;
605 struct vfio_region_info_cap_type
*cap
;
607 header
= vfio_info_cap_add(caps
, sizeof(*cap
),
608 VFIO_REGION_INFO_CAP_TYPE
, 1);
610 return PTR_ERR(header
);
612 cap
= container_of(header
, struct vfio_region_info_cap_type
, header
);
614 cap
->subtype
= subtype
;
619 int vfio_pci_register_dev_region(struct vfio_pci_device
*vdev
,
620 unsigned int type
, unsigned int subtype
,
621 const struct vfio_pci_regops
*ops
,
622 size_t size
, u32 flags
, void *data
)
624 struct vfio_pci_region
*region
;
626 region
= krealloc(vdev
->region
,
627 (vdev
->num_regions
+ 1) * sizeof(*region
),
632 vdev
->region
= region
;
633 vdev
->region
[vdev
->num_regions
].type
= type
;
634 vdev
->region
[vdev
->num_regions
].subtype
= subtype
;
635 vdev
->region
[vdev
->num_regions
].ops
= ops
;
636 vdev
->region
[vdev
->num_regions
].size
= size
;
637 vdev
->region
[vdev
->num_regions
].flags
= flags
;
638 vdev
->region
[vdev
->num_regions
].data
= data
;
645 static long vfio_pci_ioctl(void *device_data
,
646 unsigned int cmd
, unsigned long arg
)
648 struct vfio_pci_device
*vdev
= device_data
;
651 if (cmd
== VFIO_DEVICE_GET_INFO
) {
652 struct vfio_device_info info
;
654 minsz
= offsetofend(struct vfio_device_info
, num_irqs
);
656 if (copy_from_user(&info
, (void __user
*)arg
, minsz
))
659 if (info
.argsz
< minsz
)
662 info
.flags
= VFIO_DEVICE_FLAGS_PCI
;
664 if (vdev
->reset_works
)
665 info
.flags
|= VFIO_DEVICE_FLAGS_RESET
;
667 info
.num_regions
= VFIO_PCI_NUM_REGIONS
+ vdev
->num_regions
;
668 info
.num_irqs
= VFIO_PCI_NUM_IRQS
;
670 return copy_to_user((void __user
*)arg
, &info
, minsz
) ?
673 } else if (cmd
== VFIO_DEVICE_GET_REGION_INFO
) {
674 struct pci_dev
*pdev
= vdev
->pdev
;
675 struct vfio_region_info info
;
676 struct vfio_info_cap caps
= { .buf
= NULL
, .size
= 0 };
679 minsz
= offsetofend(struct vfio_region_info
, offset
);
681 if (copy_from_user(&info
, (void __user
*)arg
, minsz
))
684 if (info
.argsz
< minsz
)
687 switch (info
.index
) {
688 case VFIO_PCI_CONFIG_REGION_INDEX
:
689 info
.offset
= VFIO_PCI_INDEX_TO_OFFSET(info
.index
);
690 info
.size
= pdev
->cfg_size
;
691 info
.flags
= VFIO_REGION_INFO_FLAG_READ
|
692 VFIO_REGION_INFO_FLAG_WRITE
;
694 case VFIO_PCI_BAR0_REGION_INDEX
... VFIO_PCI_BAR5_REGION_INDEX
:
695 info
.offset
= VFIO_PCI_INDEX_TO_OFFSET(info
.index
);
696 info
.size
= pci_resource_len(pdev
, info
.index
);
702 info
.flags
= VFIO_REGION_INFO_FLAG_READ
|
703 VFIO_REGION_INFO_FLAG_WRITE
;
704 if (vdev
->bar_mmap_supported
[info
.index
]) {
705 info
.flags
|= VFIO_REGION_INFO_FLAG_MMAP
;
706 if (info
.index
== vdev
->msix_bar
) {
707 ret
= msix_sparse_mmap_cap(vdev
, &caps
);
714 case VFIO_PCI_ROM_REGION_INDEX
:
719 info
.offset
= VFIO_PCI_INDEX_TO_OFFSET(info
.index
);
722 /* Report the BAR size, not the ROM size */
723 info
.size
= pci_resource_len(pdev
, info
.index
);
725 /* Shadow ROMs appear as PCI option ROMs */
726 if (pdev
->resource
[PCI_ROM_RESOURCE
].flags
&
727 IORESOURCE_ROM_SHADOW
)
733 /* Is it really there? */
734 io
= pci_map_rom(pdev
, &size
);
739 pci_unmap_rom(pdev
, io
);
741 info
.flags
= VFIO_REGION_INFO_FLAG_READ
;
744 case VFIO_PCI_VGA_REGION_INDEX
:
748 info
.offset
= VFIO_PCI_INDEX_TO_OFFSET(info
.index
);
750 info
.flags
= VFIO_REGION_INFO_FLAG_READ
|
751 VFIO_REGION_INFO_FLAG_WRITE
;
756 VFIO_PCI_NUM_REGIONS
+ vdev
->num_regions
)
759 i
= info
.index
- VFIO_PCI_NUM_REGIONS
;
761 info
.offset
= VFIO_PCI_INDEX_TO_OFFSET(info
.index
);
762 info
.size
= vdev
->region
[i
].size
;
763 info
.flags
= vdev
->region
[i
].flags
;
765 ret
= region_type_cap(vdev
, &caps
,
766 vdev
->region
[i
].type
,
767 vdev
->region
[i
].subtype
);
773 info
.flags
|= VFIO_REGION_INFO_FLAG_CAPS
;
774 if (info
.argsz
< sizeof(info
) + caps
.size
) {
775 info
.argsz
= sizeof(info
) + caps
.size
;
778 vfio_info_cap_shift(&caps
, sizeof(info
));
779 if (copy_to_user((void __user
*)arg
+
780 sizeof(info
), caps
.buf
,
785 info
.cap_offset
= sizeof(info
);
791 return copy_to_user((void __user
*)arg
, &info
, minsz
) ?
794 } else if (cmd
== VFIO_DEVICE_GET_IRQ_INFO
) {
795 struct vfio_irq_info info
;
797 minsz
= offsetofend(struct vfio_irq_info
, count
);
799 if (copy_from_user(&info
, (void __user
*)arg
, minsz
))
802 if (info
.argsz
< minsz
|| info
.index
>= VFIO_PCI_NUM_IRQS
)
805 switch (info
.index
) {
806 case VFIO_PCI_INTX_IRQ_INDEX
... VFIO_PCI_MSIX_IRQ_INDEX
:
807 case VFIO_PCI_REQ_IRQ_INDEX
:
809 case VFIO_PCI_ERR_IRQ_INDEX
:
810 if (pci_is_pcie(vdev
->pdev
))
812 /* pass thru to return error */
817 info
.flags
= VFIO_IRQ_INFO_EVENTFD
;
819 info
.count
= vfio_pci_get_irq_count(vdev
, info
.index
);
821 if (info
.index
== VFIO_PCI_INTX_IRQ_INDEX
)
822 info
.flags
|= (VFIO_IRQ_INFO_MASKABLE
|
823 VFIO_IRQ_INFO_AUTOMASKED
);
825 info
.flags
|= VFIO_IRQ_INFO_NORESIZE
;
827 return copy_to_user((void __user
*)arg
, &info
, minsz
) ?
830 } else if (cmd
== VFIO_DEVICE_SET_IRQS
) {
831 struct vfio_irq_set hdr
;
835 minsz
= offsetofend(struct vfio_irq_set
, count
);
837 if (copy_from_user(&hdr
, (void __user
*)arg
, minsz
))
840 if (hdr
.argsz
< minsz
|| hdr
.index
>= VFIO_PCI_NUM_IRQS
||
841 hdr
.flags
& ~(VFIO_IRQ_SET_DATA_TYPE_MASK
|
842 VFIO_IRQ_SET_ACTION_TYPE_MASK
))
845 if (!(hdr
.flags
& VFIO_IRQ_SET_DATA_NONE
)) {
847 int max
= vfio_pci_get_irq_count(vdev
, hdr
.index
);
849 if (hdr
.flags
& VFIO_IRQ_SET_DATA_BOOL
)
850 size
= sizeof(uint8_t);
851 else if (hdr
.flags
& VFIO_IRQ_SET_DATA_EVENTFD
)
852 size
= sizeof(int32_t);
856 if (hdr
.argsz
- minsz
< hdr
.count
* size
||
857 hdr
.start
>= max
|| hdr
.start
+ hdr
.count
> max
)
860 data
= memdup_user((void __user
*)(arg
+ minsz
),
863 return PTR_ERR(data
);
866 mutex_lock(&vdev
->igate
);
868 ret
= vfio_pci_set_irqs_ioctl(vdev
, hdr
.flags
, hdr
.index
,
869 hdr
.start
, hdr
.count
, data
);
871 mutex_unlock(&vdev
->igate
);
876 } else if (cmd
== VFIO_DEVICE_RESET
) {
877 return vdev
->reset_works
?
878 pci_try_reset_function(vdev
->pdev
) : -EINVAL
;
880 } else if (cmd
== VFIO_DEVICE_GET_PCI_HOT_RESET_INFO
) {
881 struct vfio_pci_hot_reset_info hdr
;
882 struct vfio_pci_fill_info fill
= { 0 };
883 struct vfio_pci_dependent_device
*devices
= NULL
;
887 minsz
= offsetofend(struct vfio_pci_hot_reset_info
, count
);
889 if (copy_from_user(&hdr
, (void __user
*)arg
, minsz
))
892 if (hdr
.argsz
< minsz
)
897 /* Can we do a slot or bus reset or neither? */
898 if (!pci_probe_reset_slot(vdev
->pdev
->slot
))
900 else if (pci_probe_reset_bus(vdev
->pdev
->bus
))
903 /* How many devices are affected? */
904 ret
= vfio_pci_for_each_slot_or_bus(vdev
->pdev
,
910 WARN_ON(!fill
.max
); /* Should always be at least one */
913 * If there's enough space, fill it now, otherwise return
914 * -ENOSPC and the number of devices affected.
916 if (hdr
.argsz
< sizeof(hdr
) + (fill
.max
* sizeof(*devices
))) {
918 hdr
.count
= fill
.max
;
919 goto reset_info_exit
;
922 devices
= kcalloc(fill
.max
, sizeof(*devices
), GFP_KERNEL
);
926 fill
.devices
= devices
;
928 ret
= vfio_pci_for_each_slot_or_bus(vdev
->pdev
,
933 * If a device was removed between counting and filling,
934 * we may come up short of fill.max. If a device was
935 * added, we'll have a return of -EAGAIN above.
938 hdr
.count
= fill
.cur
;
941 if (copy_to_user((void __user
*)arg
, &hdr
, minsz
))
945 if (copy_to_user((void __user
*)(arg
+ minsz
), devices
,
946 hdr
.count
* sizeof(*devices
)))
953 } else if (cmd
== VFIO_DEVICE_PCI_HOT_RESET
) {
954 struct vfio_pci_hot_reset hdr
;
956 struct vfio_pci_group_entry
*groups
;
957 struct vfio_pci_group_info info
;
959 int i
, count
= 0, ret
= 0;
961 minsz
= offsetofend(struct vfio_pci_hot_reset
, count
);
963 if (copy_from_user(&hdr
, (void __user
*)arg
, minsz
))
966 if (hdr
.argsz
< minsz
|| hdr
.flags
)
969 /* Can we do a slot or bus reset or neither? */
970 if (!pci_probe_reset_slot(vdev
->pdev
->slot
))
972 else if (pci_probe_reset_bus(vdev
->pdev
->bus
))
976 * We can't let userspace give us an arbitrarily large
977 * buffer to copy, so verify how many we think there
978 * could be. Note groups can have multiple devices so
979 * one group per device is the max.
981 ret
= vfio_pci_for_each_slot_or_bus(vdev
->pdev
,
987 /* Somewhere between 1 and count is OK */
988 if (!hdr
.count
|| hdr
.count
> count
)
991 group_fds
= kcalloc(hdr
.count
, sizeof(*group_fds
), GFP_KERNEL
);
992 groups
= kcalloc(hdr
.count
, sizeof(*groups
), GFP_KERNEL
);
993 if (!group_fds
|| !groups
) {
999 if (copy_from_user(group_fds
, (void __user
*)(arg
+ minsz
),
1000 hdr
.count
* sizeof(*group_fds
))) {
1007 * For each group_fd, get the group through the vfio external
1008 * user interface and store the group and iommu ID. This
1009 * ensures the group is held across the reset.
1011 for (i
= 0; i
< hdr
.count
; i
++) {
1012 struct vfio_group
*group
;
1013 struct fd f
= fdget(group_fds
[i
]);
1019 group
= vfio_group_get_external_user(f
.file
);
1021 if (IS_ERR(group
)) {
1022 ret
= PTR_ERR(group
);
1026 groups
[i
].group
= group
;
1027 groups
[i
].id
= vfio_external_user_iommu_id(group
);
1032 /* release reference to groups on error */
1034 goto hot_reset_release
;
1036 info
.count
= hdr
.count
;
1037 info
.groups
= groups
;
1040 * Test whether all the affected devices are contained
1041 * by the set of groups provided by the user.
1043 ret
= vfio_pci_for_each_slot_or_bus(vdev
->pdev
,
1044 vfio_pci_validate_devs
,
1047 /* User has access, do the reset */
1048 ret
= slot
? pci_try_reset_slot(vdev
->pdev
->slot
) :
1049 pci_try_reset_bus(vdev
->pdev
->bus
);
1052 for (i
--; i
>= 0; i
--)
1053 vfio_group_put_external_user(groups
[i
].group
);
1062 static ssize_t
vfio_pci_rw(void *device_data
, char __user
*buf
,
1063 size_t count
, loff_t
*ppos
, bool iswrite
)
1065 unsigned int index
= VFIO_PCI_OFFSET_TO_INDEX(*ppos
);
1066 struct vfio_pci_device
*vdev
= device_data
;
1068 if (index
>= VFIO_PCI_NUM_REGIONS
+ vdev
->num_regions
)
1072 case VFIO_PCI_CONFIG_REGION_INDEX
:
1073 return vfio_pci_config_rw(vdev
, buf
, count
, ppos
, iswrite
);
1075 case VFIO_PCI_ROM_REGION_INDEX
:
1078 return vfio_pci_bar_rw(vdev
, buf
, count
, ppos
, false);
1080 case VFIO_PCI_BAR0_REGION_INDEX
... VFIO_PCI_BAR5_REGION_INDEX
:
1081 return vfio_pci_bar_rw(vdev
, buf
, count
, ppos
, iswrite
);
1083 case VFIO_PCI_VGA_REGION_INDEX
:
1084 return vfio_pci_vga_rw(vdev
, buf
, count
, ppos
, iswrite
);
1086 index
-= VFIO_PCI_NUM_REGIONS
;
1087 return vdev
->region
[index
].ops
->rw(vdev
, buf
,
1088 count
, ppos
, iswrite
);
1094 static ssize_t
vfio_pci_read(void *device_data
, char __user
*buf
,
1095 size_t count
, loff_t
*ppos
)
1100 return vfio_pci_rw(device_data
, buf
, count
, ppos
, false);
1103 static ssize_t
vfio_pci_write(void *device_data
, const char __user
*buf
,
1104 size_t count
, loff_t
*ppos
)
1109 return vfio_pci_rw(device_data
, (char __user
*)buf
, count
, ppos
, true);
1112 static int vfio_pci_mmap(void *device_data
, struct vm_area_struct
*vma
)
1114 struct vfio_pci_device
*vdev
= device_data
;
1115 struct pci_dev
*pdev
= vdev
->pdev
;
1117 u64 phys_len
, req_len
, pgoff
, req_start
;
1120 index
= vma
->vm_pgoff
>> (VFIO_PCI_OFFSET_SHIFT
- PAGE_SHIFT
);
1122 if (vma
->vm_end
< vma
->vm_start
)
1124 if ((vma
->vm_flags
& VM_SHARED
) == 0)
1126 if (index
>= VFIO_PCI_ROM_REGION_INDEX
)
1128 if (!vdev
->bar_mmap_supported
[index
])
1131 phys_len
= PAGE_ALIGN(pci_resource_len(pdev
, index
));
1132 req_len
= vma
->vm_end
- vma
->vm_start
;
1133 pgoff
= vma
->vm_pgoff
&
1134 ((1U << (VFIO_PCI_OFFSET_SHIFT
- PAGE_SHIFT
)) - 1);
1135 req_start
= pgoff
<< PAGE_SHIFT
;
1137 if (req_start
+ req_len
> phys_len
)
1140 if (index
== vdev
->msix_bar
) {
1142 * Disallow mmaps overlapping the MSI-X table; users don't
1143 * get to touch this directly. We could find somewhere
1144 * else to map the overlap, but page granularity is only
1145 * a recommendation, not a requirement, so the user needs
1146 * to know which bits are real. Requiring them to mmap
1147 * around the table makes that clear.
1150 /* If neither entirely above nor below, then it overlaps */
1151 if (!(req_start
>= vdev
->msix_offset
+ vdev
->msix_size
||
1152 req_start
+ req_len
<= vdev
->msix_offset
))
1157 * Even though we don't make use of the barmap for the mmap,
1158 * we need to request the region and the barmap tracks that.
1160 if (!vdev
->barmap
[index
]) {
1161 ret
= pci_request_selected_regions(pdev
,
1162 1 << index
, "vfio-pci");
1166 vdev
->barmap
[index
] = pci_iomap(pdev
, index
, 0);
1169 vma
->vm_private_data
= vdev
;
1170 vma
->vm_page_prot
= pgprot_noncached(vma
->vm_page_prot
);
1171 vma
->vm_pgoff
= (pci_resource_start(pdev
, index
) >> PAGE_SHIFT
) + pgoff
;
1173 return remap_pfn_range(vma
, vma
->vm_start
, vma
->vm_pgoff
,
1174 req_len
, vma
->vm_page_prot
);
1177 static void vfio_pci_request(void *device_data
, unsigned int count
)
1179 struct vfio_pci_device
*vdev
= device_data
;
1181 mutex_lock(&vdev
->igate
);
1183 if (vdev
->req_trigger
) {
1185 dev_notice_ratelimited(&vdev
->pdev
->dev
,
1186 "Relaying device request to user (#%u)\n",
1188 eventfd_signal(vdev
->req_trigger
, 1);
1189 } else if (count
== 0) {
1190 dev_warn(&vdev
->pdev
->dev
,
1191 "No device request channel registered, blocked until released by user\n");
1194 mutex_unlock(&vdev
->igate
);
1197 static const struct vfio_device_ops vfio_pci_ops
= {
1199 .open
= vfio_pci_open
,
1200 .release
= vfio_pci_release
,
1201 .ioctl
= vfio_pci_ioctl
,
1202 .read
= vfio_pci_read
,
1203 .write
= vfio_pci_write
,
1204 .mmap
= vfio_pci_mmap
,
1205 .request
= vfio_pci_request
,
1208 static int vfio_pci_probe(struct pci_dev
*pdev
, const struct pci_device_id
*id
)
1210 struct vfio_pci_device
*vdev
;
1211 struct iommu_group
*group
;
1214 if (pdev
->hdr_type
!= PCI_HEADER_TYPE_NORMAL
)
1217 group
= vfio_iommu_group_get(&pdev
->dev
);
1221 vdev
= kzalloc(sizeof(*vdev
), GFP_KERNEL
);
1223 vfio_iommu_group_put(group
, &pdev
->dev
);
1228 vdev
->irq_type
= VFIO_PCI_NUM_IRQS
;
1229 mutex_init(&vdev
->igate
);
1230 spin_lock_init(&vdev
->irqlock
);
1232 ret
= vfio_add_group_dev(&pdev
->dev
, &vfio_pci_ops
, vdev
);
1234 vfio_iommu_group_put(group
, &pdev
->dev
);
1239 if (vfio_pci_is_vga(pdev
)) {
1240 vga_client_register(pdev
, vdev
, NULL
, vfio_pci_set_vga_decode
);
1241 vga_set_legacy_decoding(pdev
,
1242 vfio_pci_set_vga_decode(vdev
, false));
1245 if (!disable_idle_d3
) {
1247 * pci-core sets the device power state to an unknown value at
1248 * bootup and after being removed from a driver. The only
1249 * transition it allows from this unknown state is to D0, which
1250 * typically happens when a driver calls pci_enable_device().
1251 * We're not ready to enable the device yet, but we do want to
1252 * be able to get to D3. Therefore first do a D0 transition
1253 * before going to D3.
1255 pci_set_power_state(pdev
, PCI_D0
);
1256 pci_set_power_state(pdev
, PCI_D3hot
);
1262 static void vfio_pci_remove(struct pci_dev
*pdev
)
1264 struct vfio_pci_device
*vdev
;
1266 vdev
= vfio_del_group_dev(&pdev
->dev
);
1270 vfio_iommu_group_put(pdev
->dev
.iommu_group
, &pdev
->dev
);
1271 kfree(vdev
->region
);
1274 if (vfio_pci_is_vga(pdev
)) {
1275 vga_client_register(pdev
, NULL
, NULL
, NULL
);
1276 vga_set_legacy_decoding(pdev
,
1277 VGA_RSRC_NORMAL_IO
| VGA_RSRC_NORMAL_MEM
|
1278 VGA_RSRC_LEGACY_IO
| VGA_RSRC_LEGACY_MEM
);
1281 if (!disable_idle_d3
)
1282 pci_set_power_state(pdev
, PCI_D0
);
1285 static pci_ers_result_t
vfio_pci_aer_err_detected(struct pci_dev
*pdev
,
1286 pci_channel_state_t state
)
1288 struct vfio_pci_device
*vdev
;
1289 struct vfio_device
*device
;
1291 device
= vfio_device_get_from_dev(&pdev
->dev
);
1293 return PCI_ERS_RESULT_DISCONNECT
;
1295 vdev
= vfio_device_data(device
);
1297 vfio_device_put(device
);
1298 return PCI_ERS_RESULT_DISCONNECT
;
1301 mutex_lock(&vdev
->igate
);
1303 if (vdev
->err_trigger
)
1304 eventfd_signal(vdev
->err_trigger
, 1);
1306 mutex_unlock(&vdev
->igate
);
1308 vfio_device_put(device
);
1310 return PCI_ERS_RESULT_CAN_RECOVER
;
1313 static const struct pci_error_handlers vfio_err_handlers
= {
1314 .error_detected
= vfio_pci_aer_err_detected
,
1317 static struct pci_driver vfio_pci_driver
= {
1319 .id_table
= NULL
, /* only dynamic ids */
1320 .probe
= vfio_pci_probe
,
1321 .remove
= vfio_pci_remove
,
1322 .err_handler
= &vfio_err_handlers
,
1325 struct vfio_devices
{
1326 struct vfio_device
**devices
;
1331 static int vfio_pci_get_devs(struct pci_dev
*pdev
, void *data
)
1333 struct vfio_devices
*devs
= data
;
1334 struct vfio_device
*device
;
1336 if (devs
->cur_index
== devs
->max_index
)
1339 device
= vfio_device_get_from_dev(&pdev
->dev
);
1343 if (pci_dev_driver(pdev
) != &vfio_pci_driver
) {
1344 vfio_device_put(device
);
1348 devs
->devices
[devs
->cur_index
++] = device
;
1353 * Attempt to do a bus/slot reset if there are devices affected by a reset for
1354 * this device that are needs_reset and all of the affected devices are unused
1355 * (!refcnt). Callers are required to hold driver_lock when calling this to
1356 * prevent device opens and concurrent bus reset attempts. We prevent device
1357 * unbinds by acquiring and holding a reference to the vfio_device.
1359 * NB: vfio-core considers a group to be viable even if some devices are
1360 * bound to drivers like pci-stub or pcieport. Here we require all devices
1361 * to be bound to vfio_pci since that's the only way we can be sure they
1364 static void vfio_pci_try_bus_reset(struct vfio_pci_device
*vdev
)
1366 struct vfio_devices devs
= { .cur_index
= 0 };
1367 int i
= 0, ret
= -EINVAL
;
1368 bool needs_reset
= false, slot
= false;
1369 struct vfio_pci_device
*tmp
;
1371 if (!pci_probe_reset_slot(vdev
->pdev
->slot
))
1373 else if (pci_probe_reset_bus(vdev
->pdev
->bus
))
1376 if (vfio_pci_for_each_slot_or_bus(vdev
->pdev
, vfio_pci_count_devs
,
1381 devs
.devices
= kcalloc(i
, sizeof(struct vfio_device
*), GFP_KERNEL
);
1385 if (vfio_pci_for_each_slot_or_bus(vdev
->pdev
,
1386 vfio_pci_get_devs
, &devs
, slot
))
1389 for (i
= 0; i
< devs
.cur_index
; i
++) {
1390 tmp
= vfio_device_data(devs
.devices
[i
]);
1391 if (tmp
->needs_reset
)
1398 ret
= slot
? pci_try_reset_slot(vdev
->pdev
->slot
) :
1399 pci_try_reset_bus(vdev
->pdev
->bus
);
1402 for (i
= 0; i
< devs
.cur_index
; i
++) {
1403 tmp
= vfio_device_data(devs
.devices
[i
]);
1405 tmp
->needs_reset
= false;
1407 if (!tmp
->refcnt
&& !disable_idle_d3
)
1408 pci_set_power_state(tmp
->pdev
, PCI_D3hot
);
1410 vfio_device_put(devs
.devices
[i
]);
1413 kfree(devs
.devices
);
1416 static void __exit
vfio_pci_cleanup(void)
1418 pci_unregister_driver(&vfio_pci_driver
);
1419 vfio_pci_uninit_perm_bits();
1422 static void __init
vfio_pci_fill_ids(void)
1427 /* no ids passed actually */
1431 /* add ids specified in the module parameter */
1433 while ((id
= strsep(&p
, ","))) {
1434 unsigned int vendor
, device
, subvendor
= PCI_ANY_ID
,
1435 subdevice
= PCI_ANY_ID
, class = 0, class_mask
= 0;
1441 fields
= sscanf(id
, "%x:%x:%x:%x:%x:%x",
1442 &vendor
, &device
, &subvendor
, &subdevice
,
1443 &class, &class_mask
);
1446 pr_warn("invalid id string \"%s\"\n", id
);
1450 rc
= pci_add_dynid(&vfio_pci_driver
, vendor
, device
,
1451 subvendor
, subdevice
, class, class_mask
, 0);
1453 pr_warn("failed to add dynamic id [%04hx:%04hx[%04hx:%04hx]] class %#08x/%08x (%d)\n",
1454 vendor
, device
, subvendor
, subdevice
,
1455 class, class_mask
, rc
);
1457 pr_info("add [%04hx:%04hx[%04hx:%04hx]] class %#08x/%08x\n",
1458 vendor
, device
, subvendor
, subdevice
,
1463 static int __init
vfio_pci_init(void)
1467 /* Allocate shared config space permision data used by all devices */
1468 ret
= vfio_pci_init_perm_bits();
1472 /* Register and scan for devices */
1473 ret
= pci_register_driver(&vfio_pci_driver
);
1477 vfio_pci_fill_ids();
1482 vfio_pci_uninit_perm_bits();
1486 module_init(vfio_pci_init
);
1487 module_exit(vfio_pci_cleanup
);
1489 MODULE_VERSION(DRIVER_VERSION
);
1490 MODULE_LICENSE("GPL v2");
1491 MODULE_AUTHOR(DRIVER_AUTHOR
);
1492 MODULE_DESCRIPTION(DRIVER_DESC
);