Skip to contentSkip to conversation

vfio/igd: VFIOConfigMirrorQuirk for igd mirrored registers

PATCH Applied Tomita Moeko 3 participants 6 messages Jan 4, 2025 – Jan 16, 2025

lore
Share & tools
lore
#0 lore raw

v2 cover vfio/igd: VFIOConfigMirrorQuirk for igd mirrored registers

In commit 1a2623b5c9e7 ("vfio/igd: add macro for declaring mirrored registers"), I introduced a macro to handle mirrored registers in igd bar0. However, using the existing VFIOConfigMirrorQuirk should be a better approach I think after going through the vfio code.

This patch set introduces a new header file, pci-quirks.h, to hold generic quirk declarations, and extends VFIOConfigMirrorQuirk to support offsets in PCI config space. This eliminates the need for the previously introduced macro.

Changelog:
v2:
* Removed 'const Property' change, it was a mistake in rebasing.
* Removed unnecessary initializing config_offset explicitly.
* Separated GGC and BDSM mirror into 2 quirks.

Tomita Moeko (3):
vfio/pci: declare generic quirks in a new header file vfio/pci: introduce config_offset field in VFIOConfigMirrorQuirk vfio/igd: use VFIOConfigMirrorQuirk for mirrored registers

 hw/vfio/igd.c        | 125 +++++++++++--------------------------------
 hw/vfio/pci-quirks.c |  57 +++-----------------
 hw/vfio/pci-quirks.h |  72 +++++++++++++++++++++++++
 3 files changed, 109 insertions(+), 145 deletions(-)
 create mode 100644 hw/vfio/pci-quirks.h
Signature · 1 line
2.45.2
#1 lore raw

PATCH v2 1/3 vfio/pci: declare generic quirks in a new header file

Declare generic vfio_generic_{window_address,window_data,mirror}_quirk in newly created pci_quirks.h so that they can be used elsewhere, like igd.c.

---
 hw/vfio/pci-quirks.c | 55 +++-------------------------------
 hw/vfio/pci-quirks.h | 71 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 75 insertions(+), 51 deletions(-)
 create mode 100644 hw/vfio/pci-quirks.h
hw/vfio/pci-quirks.c +4 -51
index c8e60475d5..2258fdda5f 100644
@@ -25,6 +25,7 @@
 #include "hw/nvram/fw_cfg.h"
 #include "hw/qdev-properties.h"
 #include "pci.h"
+#include "pci-quirks.h"
 #include "trace.h"
 
 /*
@@ -66,40 +67,6 @@ bool vfio_opt_rom_in_denylist(VFIOPCIDevice *vdev)
  * Device specific region quirks (mostly backdoors to PCI config space)
  */
 
-/*
- * The generic window quirks operate on an address and data register,
- * vfio_generic_window_address_quirk handles the address register and
- * vfio_generic_window_data_quirk handles the data register.  These ops
- * pass reads and writes through to hardware until a value matching the
- * stored address match/mask is written.  When this occurs, the data
- * register access emulated PCI config space for the device rather than
- * passing through accesses.  This enables devices where PCI config space
- * is accessible behind a window register to maintain the virtualization
- * provided through vfio.
- */
-typedef struct VFIOConfigWindowMatch {
-    uint32_t match;
-    uint32_t mask;
-} VFIOConfigWindowMatch;
-
-typedef struct VFIOConfigWindowQuirk {
-    struct VFIOPCIDevice *vdev;
-
-    uint32_t address_val;
-
-    uint32_t address_offset;
-    uint32_t data_offset;
-
-    bool window_enabled;
-    uint8_t bar;
-
-    MemoryRegion *addr_mem;
-    MemoryRegion *data_mem;
-
-    uint32_t nr_matches;
-    VFIOConfigWindowMatch matches[];
-} VFIOConfigWindowQuirk;
-
 static uint64_t vfio_generic_window_quirk_address_read(void *opaque,
                                                        hwaddr addr,
                                                        unsigned size)
@@ -135,7 +102,7 @@ static void vfio_generic_window_quirk_address_write(void *opaque, hwaddr addr,
     }
 }
 
-static const MemoryRegionOps vfio_generic_window_address_quirk = {
+const MemoryRegionOps vfio_generic_window_address_quirk = {
     .read = vfio_generic_window_quirk_address_read,
     .write = vfio_generic_window_quirk_address_write,
     .endianness = DEVICE_LITTLE_ENDIAN,
@@ -178,26 +145,12 @@ static void vfio_generic_window_quirk_data_write(void *opaque, hwaddr addr,
                       addr + window->data_offset, data, size);
 }
 
-static const MemoryRegionOps vfio_generic_window_data_quirk = {
+const MemoryRegionOps vfio_generic_window_data_quirk = {
     .read = vfio_generic_window_quirk_data_read,
     .write = vfio_generic_window_quirk_data_write,
     .endianness = DEVICE_LITTLE_ENDIAN,
 };
 
-/*
- * The generic mirror quirk handles devices which expose PCI config space
- * through a region within a BAR.  When enabled, reads and writes are
- * redirected through to emulated PCI config space.  XXX if PCI config space
- * used memory regions, this could just be an alias.
- */
-typedef struct VFIOConfigMirrorQuirk {
-    struct VFIOPCIDevice *vdev;
-    uint32_t offset;
-    uint8_t bar;
-    MemoryRegion *mem;
-    uint8_t data[];
-} VFIOConfigMirrorQuirk;
-
 static uint64_t vfio_generic_quirk_mirror_read(void *opaque,
                                                hwaddr addr, unsigned size)
 {
@@ -228,7 +181,7 @@ static void vfio_generic_quirk_mirror_write(void *opaque, hwaddr addr,
                                           addr, data);
 }
 
-static const MemoryRegionOps vfio_generic_mirror_quirk = {
+const MemoryRegionOps vfio_generic_mirror_quirk = {
     .read = vfio_generic_quirk_mirror_read,
     .write = vfio_generic_quirk_mirror_write,
     .endianness = DEVICE_LITTLE_ENDIAN,
hw/vfio/pci-quirks.h new file +71 -0

71 lines not on this page · raw message

Signature · 1 line
2.45.2
#2 lore raw

PATCH v2 2/3 vfio/pci: introduce config_offset field in VFIOConfigMirrorQuirk

In reply to Tomita Moeko

Device may only expose a specific portion of PCI config space through a region in a BAR, such behavior is seen in igd GGC and BDSM mirrors in BAR0. To handle these, config_offset is introduced to allow mirroring arbitrary region in PCI config space.

---
 hw/vfio/pci-quirks.c | 2 ++
 hw/vfio/pci-quirks.h | 3 ++-
 2 files changed, 4 insertions(+), 1 deletion(-)
hw/vfio/pci-quirks.c +2 -0
index 2258fdda5f..fbe43b0a79 100644
@@ -162,6 +162,7 @@ static uint64_t vfio_generic_quirk_mirror_read(void *opaque,
     (void)vfio_region_read(&vdev->bars[mirror->bar].region,
                            addr + mirror->offset, size);
 
+    addr += mirror->config_offset;
     data = vfio_pci_read_config(&vdev->pdev, addr, size);
     trace_vfio_quirk_generic_mirror_read(vdev->vbasedev.name,
                                          memory_region_name(mirror->mem),
@@ -175,6 +176,7 @@ static void vfio_generic_quirk_mirror_write(void *opaque, hwaddr addr,
     VFIOConfigMirrorQuirk *mirror = opaque;
     VFIOPCIDevice *vdev = mirror->vdev;
 
+    addr += mirror->config_offset;
     vfio_pci_write_config(&vdev->pdev, addr, data, size);
     trace_vfio_quirk_generic_mirror_write(vdev->vbasedev.name,
                                           memory_region_name(mirror->mem),
hw/vfio/pci-quirks.h +2 -1
index c0e96a01cc..d1532e379b 100644
@@ -60,7 +60,8 @@ extern const MemoryRegionOps vfio_generic_window_data_quirk;
  */
 typedef struct VFIOConfigMirrorQuirk {
     struct VFIOPCIDevice *vdev;
-    uint32_t offset;
+    uint32_t offset; /* Offset in BAR */
+    uint32_t config_offset; /* Offset in PCI config space */
     uint8_t bar;
     MemoryRegion *mem;
     uint8_t data[];
Signature · 1 line
2.45.2
#3 lore raw

PATCH v2 3/3 vfio/igd: use VFIOConfigMirrorQuirk for mirrored registers

In reply to Tomita Moeko

With the introduction of config_offset field, VFIOConfigMirrorQuirk can now be used for those mirrored register in igd bar0. This eliminates the need for the macro intoduced in 1a2623b5c9e7 ("vfio/igd: add macro for declaring mirrored registers").

---
 hw/vfio/igd.c | 125 +++++++++++++-------------------------------------
 1 file changed, 31 insertions(+), 94 deletions(-)
hw/vfio/igd.c +31 -94
index f5414b0f8d..703e795715 100644
@@ -18,6 +18,7 @@
 #include "hw/hw.h"
 #include "hw/nvram/fw_cfg.h"
 #include "pci.h"
+#include "pci-quirks.h"
 #include "trace.h"
 
 /*
@@ -422,83 +423,13 @@ static const MemoryRegionOps vfio_igd_index_quirk = {
     .endianness = DEVICE_LITTLE_ENDIAN,
 };
 
-static uint64_t vfio_igd_pci_config_read(VFIOPCIDevice *vdev, uint64_t offset,
-                                         unsigned size)
-{
-    switch (size) {
-    case 1:
-        return pci_get_byte(vdev->pdev.config + offset);
-    case 2:
-        return pci_get_word(vdev->pdev.config + offset);
-    case 4:
-        return pci_get_long(vdev->pdev.config + offset);
-    case 8:
-        return pci_get_quad(vdev->pdev.config + offset);
-    default:
-        hw_error("igd: unsupported pci config read at %"PRIx64", size %u",
-                 offset, size);
-        break;
-    }
-
-    return 0;
-}
-
-static void vfio_igd_pci_config_write(VFIOPCIDevice *vdev, uint64_t offset,
-                                      uint64_t data, unsigned size)
-{
-    switch (size) {
-    case 1:
-        pci_set_byte(vdev->pdev.config + offset, data);
-        break;
-    case 2:
-        pci_set_word(vdev->pdev.config + offset, data);
-        break;
-    case 4:
-        pci_set_long(vdev->pdev.config + offset, data);
-        break;
-    case 8:
-        pci_set_quad(vdev->pdev.config + offset, data);
-        break;
-    default:
-        hw_error("igd: unsupported pci config write at %"PRIx64", size %u",
-                 offset, size);
-        break;
-    }
-}
-
-#define VFIO_IGD_QUIRK_MIRROR_REG(reg, name)                            \
-static uint64_t vfio_igd_quirk_read_##name(void *opaque,                \
-                                           hwaddr addr, unsigned size)  \
-{                                                                       \
-    VFIOPCIDevice *vdev = opaque;                                       \
-                                                                        \
-    return vfio_igd_pci_config_read(vdev, reg + addr, size);            \
-}                                                                       \
-                                                                        \
-static void vfio_igd_quirk_write_##name(void *opaque, hwaddr addr,      \
-                                        uint64_t data, unsigned size)   \
-{                                                                       \
-    VFIOPCIDevice *vdev = opaque;                                       \
-                                                                        \
-    vfio_igd_pci_config_write(vdev, reg + addr, data, size);            \
-}                                                                       \
-                                                                        \
-static const MemoryRegionOps vfio_igd_quirk_mirror_##name = {           \
-    .read = vfio_igd_quirk_read_##name,                                 \
-    .write = vfio_igd_quirk_write_##name,                               \
-    .endianness = DEVICE_LITTLE_ENDIAN,                                 \
-};
-
-VFIO_IGD_QUIRK_MIRROR_REG(IGD_GMCH, ggc)
-VFIO_IGD_QUIRK_MIRROR_REG(IGD_BDSM, bdsm)
-VFIO_IGD_QUIRK_MIRROR_REG(IGD_BDSM_GEN11, bdsm64)
-
 #define IGD_GGC_MMIO_OFFSET     0x108040
 #define IGD_BDSM_MMIO_OFFSET    0x1080C0
 
 void vfio_probe_igd_bar0_quirk(VFIOPCIDevice *vdev, int nr)
 {
-    VFIOQuirk *quirk;
+    VFIOQuirk *ggc_quirk, *bdsm_quirk;
+    VFIOConfigMirrorQuirk *ggc_mirror, *bdsm_mirror;
     int gen;
 
     /*
@@ -522,33 +453,39 @@ void vfio_probe_igd_bar0_quirk(VFIOPCIDevice *vdev, int nr)
         return;
     }
 
-    quirk = vfio_quirk_alloc(2);
-    quirk->data = vdev;
+    ggc_quirk = vfio_quirk_alloc(1);
+    ggc_mirror = ggc_quirk->data = g_malloc0(sizeof(*ggc_mirror));
+    ggc_mirror->mem = ggc_quirk->mem;
+    ggc_mirror->vdev = vdev;
+    ggc_mirror->bar = nr;
+    ggc_mirror->offset = IGD_GGC_MMIO_OFFSET;
+    ggc_mirror->config_offset = IGD_GMCH;
 
-    memory_region_init_io(&quirk->mem[0], OBJECT(vdev),
-                          &vfio_igd_quirk_mirror_ggc, vdev,
+    memory_region_init_io(ggc_mirror->mem, OBJECT(vdev),
+                          &vfio_generic_mirror_quirk, ggc_mirror,
                           "vfio-igd-ggc-quirk", 2);
-    memory_region_add_subregion_overlap(vdev->bars[0].region.mem,
-                                        IGD_GGC_MMIO_OFFSET, &quirk->mem[0],
+    memory_region_add_subregion_overlap(vdev->bars[nr].region.mem,
+                                        ggc_mirror->offset, ggc_mirror->mem,
                                         1);
 
-    if (gen < 11) {
-        memory_region_init_io(&quirk->mem[1], OBJECT(vdev),
-                              &vfio_igd_quirk_mirror_bdsm, vdev,
-                              "vfio-igd-bdsm-quirk", 4);
-        memory_region_add_subregion_overlap(vdev->bars[0].region.mem,
-                                            IGD_BDSM_MMIO_OFFSET,
-                                            &quirk->mem[1], 1);
-    } else {
-        memory_region_init_io(&quirk->mem[1], OBJECT(vdev),
-                              &vfio_igd_quirk_mirror_bdsm64, vdev,
-                              "vfio-igd-bdsm-quirk", 8);
-        memory_region_add_subregion_overlap(vdev->bars[0].region.mem,
-                                            IGD_BDSM_MMIO_OFFSET,
-                                            &quirk->mem[1], 1);
-    }
+    QLIST_INSERT_HEAD(&vdev->bars[nr].quirks, ggc_quirk, next);
 
-    QLIST_INSERT_HEAD(&vdev->bars[nr].quirks, quirk, next);
+    bdsm_quirk = vfio_quirk_alloc(1);
+    bdsm_mirror = bdsm_quirk->data = g_malloc0(sizeof(*bdsm_mirror));
+    bdsm_mirror->mem = bdsm_quirk->mem;
+    bdsm_mirror->vdev = vdev;
+    bdsm_mirror->bar = nr;
+    bdsm_mirror->offset = IGD_BDSM_MMIO_OFFSET;
+    bdsm_mirror->config_offset = (gen < 11) ? IGD_BDSM : IGD_BDSM_GEN11;
+
+    memory_region_init_io(bdsm_mirror->mem, OBJECT(vdev),
+                          &vfio_generic_mirror_quirk, bdsm_mirror,
+                          "vfio-igd-bdsm-quirk", (gen < 11) ? 4 : 8);
+    memory_region_add_subregion_overlap(vdev->bars[nr].region.mem,
+                                        bdsm_mirror->offset, bdsm_mirror->mem,
+                                        1);
+
+    QLIST_INSERT_HEAD(&vdev->bars[nr].quirks, bdsm_quirk, next);
 }
 
 void vfio_probe_igd_bar4_quirk(VFIOPCIDevice *vdev, int nr)
Signature · 1 line
2.45.2
Reviewed-by on the v2 series
#4 lore raw
In reply to Tomita Moeko
Quoted 22 lines · On Sat, 4 Jan 2025 23:42:15 +0800 Tomita Moeko <[email protected]> wrote:

In commit 1a2623b5c9e7 ("vfio/igd: add macro for declaring mirrored registers"), I introduced a macro to handle mirrored registers in igd bar0. However, using the existing VFIOConfigMirrorQuirk should be a better approach I think after going through the vfio code.

This patch set introduces a new header file, pci-quirks.h, to hold generic quirk declarations, and extends VFIOConfigMirrorQuirk to support offsets in PCI config space. This eliminates the need for the previously introduced macro.

Changelog:
v2:
* Removed 'const Property' change, it was a mistake in rebasing.
* Removed unnecessary initializing config_offset explicitly.
* Separated GGC and BDSM mirror into 2 quirks.

Tomita Moeko (3):
vfio/pci: declare generic quirks in a new header file vfio/pci: introduce config_offset field in VFIOConfigMirrorQuirk vfio/igd: use VFIOConfigMirrorQuirk for mirrored registers

Quoted 6 lines
 hw/vfio/igd.c        | 125 +++++++++++--------------------------------
 hw/vfio/pci-quirks.c |  57 +++-----------------
 hw/vfio/pci-quirks.h |  72 +++++++++++++++++++++++++
 3 files changed, 109 insertions(+), 145 deletions(-)
 create mode 100644 hw/vfio/pci-quirks.h
#5 lore raw
In reply to Tomita Moeko
Quoted 22 lines · Tomita Moeko

In commit 1a2623b5c9e7 ("vfio/igd: add macro for declaring mirrored registers"), I introduced a macro to handle mirrored registers in igd bar0. However, using the existing VFIOConfigMirrorQuirk should be a better approach I think after going through the vfio code.

This patch set introduces a new header file, pci-quirks.h, to hold generic quirk declarations, and extends VFIOConfigMirrorQuirk to support offsets in PCI config space. This eliminates the need for the previously introduced macro.

Changelog:
v2:
* Removed 'const Property' change, it was a mistake in rebasing.
* Removed unnecessary initializing config_offset explicitly.
* Separated GGC and BDSM mirror into 2 quirks.

Tomita Moeko (3):
vfio/pci: declare generic quirks in a new header file vfio/pci: introduce config_offset field in VFIOConfigMirrorQuirk vfio/igd: use VFIOConfigMirrorQuirk for mirrored registers

Quoted 6 lines
  hw/vfio/igd.c        | 125 +++++++++++--------------------------------
  hw/vfio/pci-quirks.c |  57 +++-----------------
  hw/vfio/pci-quirks.h |  72 +++++++++++++++++++++++++
  3 files changed, 109 insertions(+), 145 deletions(-)

create mode 100644 hw/vfio/pci-quirks.h

Applied to vfio-next.

Thanks,

C.