vfio/igd: Clear saved BDSM in legacy VBIOS ROM at load time
PATCH v6 1/1 vfio/igd: Clear saved BDSM in legacy VBIOS ROM at load time
IGD does not come with a ROM BAR [1], the ROM BAR read by default from kernel is actually the host VBIOS shadow RAM region that contains host modifications on boot. With AI-assisted reverse engineering on VBIOS binaries, it is observed that VBIOS saves BDSM register value on first access and uses saved value if present.
When the image is executed in guest, since there is already a saved HPA in VBIOS, it keeps using that value instead of the GPA programmed by SeaBIOS in BDSM register in PCI config space, causing VBIOS to program GTT entries with wrong address, resulting in garbled output in BIOS POST and the error below detected by i915 driver.
i915 0000:00:02.0: [drm] *ERROR* Initial plane programming using invalid range, dma_addr=0x00000000db200000 ((null) [0x00000000baf00000-0x00000000beefffff])
The previous solution, c4c45e943e51 ("vfio/pci: Intel graphics legacy mode assignment"), adjusts GTT entry addresses to (addr - host BDSM + guest BDSM) to workaround that. But it is removed in 5aed8b0f0be2 ("vfio/igd: Remove GTT write quirk in IO BAR 4") due to inconsistent values in MMIO BAR0 and IO BAR4.
Since it was a value latched into the VBIOS that breaks virtualization (QEMU does not map the GTT at the same address in the VM), a ROM quirk clearing the saved value in VBIOS image is introduced. It searches the BDSM accessor routine by matching a 19-byte signature anchored on the unique mov $0x105e,%ax instruction, then locates the offset of saved BDSM and clears it. This makes the routine fall through to the PCI config read on the first call inside the guest.
[1] 3.5.15, 4th Generation Intel Core Processor Family Datasheet Vol. 2
https://www.intel.com/content/dam/www/public/us/en/documents/datasheets/4th-gen-core-family-desktop-vol-2-datasheet.pdf
Resolves: https://gitlab.com/qemu-project/qemu/-/work_items/3093
---
Changelog:
v6:
* Make it a self-contained regression fix for the ROM read through vfio path only reported in the gitlab issue, per v5 comment from Alex.
* Reword the commit message.
* Cc stable as this is now a regression fix for QEMU 10.0+.
v5:
* Keep the current ID and checksum patching logic in vfio_pci_load_rom() since it is not IGD-specific, as pointed out by Alex. The IGD-specific quirk is now invoked after the generic patching. The ID and checksum patching is duplicated in vfio_igd_legacy_rom_quirk() to handle the romfile path, since the generic patching is not invoked on romfile.
* Picked up the Michael's Acked-by on patch 1.
* Reduced from 4 to 3 patches.
v4:
* Reworked per review feedback to keep IGD-specific workarounds out of the generic PCI code. Instead of recalculating the checksum in hw/pci/pci.c, a single generic romfile_fixup hook is added for device- specific ROM patching. Now both kernel ROM BAR and romfile paths share the same quirk, so the saved BDSM in user-provided romfile will also get cleared.
* Reduced from 7 to 4 patches.
v3:
* Refactor ROM checksum calculation and patching logic as Alex's comment
* Fix boundary checks as comments in v2.
v2:
* New patch 2/7 to fix regression with EFI option ROMs
* Refine logic in ROM ID and checksum patching
* Reorder patch 4 and 5 for cleaner bisection
* Address comments from v1
hw/vfio/igd-stubs.c | 5 ++ hw/vfio/igd.c | 115 +++++++++++++++++++++++++++++++++++++++++++ hw/vfio/pci-quirks.c | 5 ++ hw/vfio/pci.c | 2 + hw/vfio/pci.h | 3 ++ hw/vfio/trace-events | 1 + 6 files changed, 131 insertions(+)
hw/vfio/igd-stubs.c +5 -0
@@ -18,3 +18,8 @@ bool vfio_probe_igd_config_quirk(VFIOPCIDevice *vdev, Error **errp) {return true; } + +void vfio_igd_legacy_rom_quirk (VFIOPCIDevice *vdev) +{ +return ; +}
hw/vfio/igd.c +115 -0
118 lines not on this page · raw message
hw/vfio/pci-quirks.c +5 -0
@@ -1592,3 +1592,8 @@ bool vfio_add_virt_caps(VFIOPCIDevice *vdev, Error **errp)return true; } + +void vfio_rom_quirk_setup (VFIOPCIDevice *vdev) +{ +vfio_igd_legacy_rom_quirk (vdev); +}
hw/vfio/pci.c +2 -0
@@ -1119,6 +1119,8 @@ static bool vfio_pci_load_rom(VFIOPCIDevice *vdev, Error **errp) } } +vfio_rom_quirk_setup (vdev); +return true; }
hw/vfio/pci.h +3 -0
@@ -252,10 +252,13 @@ void vfio_bar_quirk_exit(VFIOPCIDevice *vdev, int nr);void vfio_bar_quirk_finalize (VFIOPCIDevice *vdev,int nr);void vfio_setup_resetfn_quirk (VFIOPCIDevice *vdev);bool vfio_add_virt_caps (VFIOPCIDevice *vdev,Error **errp); +void vfio_rom_quirk_setup (VFIOPCIDevice *vdev);void vfio_quirk_reset (VFIOPCIDevice *vdev);VFIOQuirk *vfio_quirk_alloc (int nr_mem); +void vfio_probe_igd_bar0_quirk (VFIOPCIDevice *vdev,int nr);bool vfio_probe_igd_config_quirk (VFIOPCIDevice *vdev,Error **errp); +void vfio_igd_legacy_rom_quirk (VFIOPCIDevice *vdev);extern const PropertyInfo qdev_prop_nv_gpudirect_clique;
hw/vfio/trace-events +1 -0
@@ -90,6 +90,7 @@ vfio_pci_igd_bar4_write(const char *name, uint32_t index, uint32_t data, uint32_ vfio_pci_igd_bdsm_enabled(const char *name, int size) "%s %dMB" vfio_pci_igd_host_bridge_enabled(const char *name) "%s" vfio_pci_igd_lpc_bridge_enabled(const char *name) "%s" +vfio_pci_igd_vbios_patched(const char *name) "%s" # listener.c vfio_iommu_map_notify(const char *op, uint64_t iova_start, uint64_t iova_end) "iommu %s @ 0x%"PRIx64" - 0x%"PRIx64
Signature · 1 line
2.53.0
Quoted 77 lines · On Wed, 8 Jul 2026 18:31:00 +0800 Tomita Moeko <[email protected]> wrote:
IGD does not come with a ROM BAR [1], the ROM BAR read by default from kernel is actually the host VBIOS shadow RAM region that contains host modifications on boot. With AI-assisted reverse engineering on VBIOS binaries, it is observed that VBIOS saves BDSM register value on first access and uses saved value if present.
When the image is executed in guest, since there is already a saved HPA in VBIOS, it keeps using that value instead of the GPA programmed by SeaBIOS in BDSM register in PCI config space, causing VBIOS to program GTT entries with wrong address, resulting in garbled output in BIOS POST and the error below detected by i915 driver.
i915 0000:00:02.0: [drm] *ERROR* Initial plane programming using invalid range, dma_addr=0x00000000db200000 ((null) [0x00000000baf00000-0x00000000beefffff])
The previous solution,
c4c45e943e51("vfio/pci: Intel graphics legacy mode assignment"), adjusts GTT entry addresses to (addr - host BDSM + guest BDSM) to workaround that. But it is removed in5aed8b0f0be2("vfio/igd: Remove GTT write quirk in IO BAR 4") due to inconsistent values in MMIO BAR0 and IO BAR4.Since it was a value latched into the VBIOS that breaks virtualization (QEMU does not map the GTT at the same address in the VM), a ROM quirk clearing the saved value in VBIOS image is introduced. It searches the BDSM accessor routine by matching a 19-byte signature anchored on the unique
mov $0x105e,%axinstruction, then locates the offset of saved BDSM and clears it. This makes the routine fall through to the PCI config read on the first call inside the guest.[1] 3.5.15, 4th Generation Intel Core Processor Family Datasheet Vol. 2
https://www.intel.com/content/dam/www/public/us/en/documents/datasheets/4th-gen-core-family-desktop-vol-2-datasheet.pdfFixes 5aed8b0f0be2 ("vfio/igd: Remove GTT write quirk in IO BAR 4")Resolves: https://gitlab.com/qemu-project/qemu/-/work_items/3093
Reported-by K S Maan <[email protected]>Signed-off-by Tomita Moeko <[email protected]>---
Changelog:
v6:
* Make it a self-contained regression fix for the ROM read through vfio path only reported in the gitlab issue, per v5 comment from Alex.
* Reword the commit message.
* Cc stable as this is now a regression fix for QEMU 10.0+.v5:
* Keep the current ID and checksum patching logic invfio_pci_load_rom()since it is not IGD-specific, as pointed out by Alex. The IGD-specific quirk is now invoked after the generic patching. The ID and checksum patching is duplicated invfio_igd_legacy_rom_quirk()to handle the romfile path, since the generic patching is not invoked on romfile.
* Picked up the Michael's Acked-by on patch 1.
* Reduced from 4 to 3 patches.v4:
* Reworked per review feedback to keep IGD-specific workarounds out of the generic PCI code. Instead of recalculating the checksum inhw/pci/pci.c, a single genericromfile_fixuphook is added for device- specific ROM patching. Now both kernel ROM BAR and romfile paths share the same quirk, so the saved BDSM in user-provided romfile will also get cleared.
* Reduced from 7 to 4 patches.v3:
* Refactor ROM checksum calculation and patching logic as Alex's comment
* Fix boundary checks as comments in v2.v2:
* New patch 2/7 to fix regression with EFI option ROMs
* Refine logic in ROM ID and checksum patching
* Reorder patch 4 and 5 for cleaner bisection
* Address comments from v1
Quoted 7 lines
hw/vfio/igd-stubs.c | 5 ++ hw/vfio/igd.c | 115 +++++++++++++++++++++++++++++++++++++++++++ hw/vfio/pci-quirks.c | 5 ++ hw/vfio/pci.c | 2 + hw/vfio/pci.h | 3 ++ hw/vfio/trace-events | 1 + 6 files changed, 131 insertions(+)
Thanks for the quick respin
Quoted 193 lines
hw/vfio/igd-stubs.c +5
-0@@ -18,3 +18,8 @@ bool vfio_probe_igd_config_quirk(VFIOPCIDevice *vdev, Error **errp) {return true; } + +void vfio_igd_legacy_rom_quirk (VFIOPCIDevice *vdev) +{ +return ; +}hw/vfio/igd.c +115
-0@@ -724,3 +724,118 @@ bool vfio_probe_igd_config_quirk(VFIOPCIDevice *vdev, Error **errp)return vfio_pci_igd_config_quirk (vdev, errp); } + +/* +* IGD ROM BAR read from kernel is actually the host VBIOS shadow RAM region, +* which contains host modifications. In Gen 6-9 VBIOS, the routine below is +* used to get BDSM value when programming the initial GTT. +* xx xx xx xx v: .long ? # saved value +* 66 53 push %ebx +* 66 2e 83 3e xx xx 00 cmpl $0x0,%cs:v # is saved value empty? +* 74 07 je 1f # if zero, go compute +* 66 2e a1 xx xx mov %cs:v,%eax # else return saved value +* eb 0f jmp 2f +* b8 5e 10 1: mov $0x105e,%ax # dev 00:02.0, offset 5E +* e8 xx xx call pci_read_cfg_word +* 66 c1 e0 10 shl $0x10,%eax # left shift 16 bits +* 66 2e a3 xx xx mov %eax,%cs:v # save the result +* 66 5b 2: pop %ebx +* c3 ret +* When running the VBIOS in guest, saved value still reflects the host stolen +* memory base address, which is not correct in guest. So we need to patch the +* VBIOS to clear the saved value. +* +* The unique 19-byte starts at `cmpl $0,%cs:v` and ends at `mov $0x105e,%ax` +* anchors the match to the routine. Both `cs:` displacements must reference +* the same offset. +*/ +static int igd_vbios_find_saved_bdsm (const uint8_t *rom,size_t rom_size, +uint16_t *bdsm_offset) +{ +static const uint8_t start[] = {0x66 ,0x2e ,0x83 ,0x3e }; +static const uint8_t middle[] = {0x00 ,0x74 ,0x07 ,0x66 ,0x2e ,0xa1 }; +static const uint8_t end[] = {0xeb ,0x0f ,0xb8 ,0x5e ,0x10 }; +uint16_t val; +size_t i; +bool found = false; + +if (rom_size <19 ) { +return -ENOENT ; + } + +for (i =0 ; i +19 <= rom_size; i++) { +if (memcmp (rom + i, start,sizeof (start)) !=0 || +memcmp (rom + i +6 , middle,sizeof (middle)) !=0 || +memcmp (rom + i +14 , end,sizeof (end)) !=0 ) { +continue ; + } + +/* same saved value address? */ +if (rom[i +4 ] != rom[i +12 ] || rom[i +5 ] != rom[i +13 ]) { +continue ; + } + +if (found) { +return -EEXIST ; + } + + val = rom[i +4 ] | ((uint16_t )rom[i +5 ] <<8 ); +if (val +sizeof (uint32_t ) <= rom_size) { + *bdsm_offset = val; + found = true; + } + } + +if (!found) { +return -ENOENT ; + } + +return 0 ; +} + +void vfio_igd_legacy_rom_quirk (VFIOPCIDevice *vdev) +{ +uint8_t *rom = vdev->rom; +int gen; +uint16_t pcir_offset; +uint16_t bdsm_offset =0 ; +uint8_t checksum =0 ; +uint32_t i; + +if (!vfio_pci_is (vdev,PCI_VENDOR_ID_INTEL ,PCI_ANY_ID ) || + !vfio_is_vga (vdev) || !vdev->vga) { +return ; + } + +/* Only Gen 6~9 devices have legacy VBIOS as Option ROM */ + gen =igd_gen (vdev); +if (gen <6 || gen >9 ) { +return ; + } + +if (pci_get_word (rom) !=0xaa55 ) { +return ; + } + +/* Must be a legacy ROM */ + pcir_offset =pci_get_word (rom +0x18 ); +if (pcir_offset +0x14 >= vdev->rom_size || +memcmp (rom + pcir_offset,"PCIR" ,4 ) || +pci_get_byte (rom + pcir_offset +0x14 ) !=0x00 ) { +return ; + } + +/* Search and clear the saved BDSM value */ +if (igd_vbios_find_saved_bdsm (rom, vdev->rom_size, &bdsm_offset)) { +return ; + } +memset (rom + bdsm_offset,0 ,sizeof (uint32_t )); + +/* Recalculate checksum and patch it. */ +for (i =0 ; i < vdev->rom_size; i++) { + checksum += rom[i]; + } + rom[6 ] -= checksum; + +trace_vfio_pci_igd_vbios_patched (vdev->vbasedev.name); +}hw/vfio/pci-quirks.c +5
-0@@ -1592,3 +1592,8 @@ bool vfio_add_virt_caps(VFIOPCIDevice *vdev, Error **errp)return true; } + +void vfio_rom_quirk_setup (VFIOPCIDevice *vdev) +{ +vfio_igd_legacy_rom_quirk (vdev); +}hw/vfio/pci.c +2
-0@@ -1119,6 +1119,8 @@ static bool vfio_pci_load_rom(VFIOPCIDevice *vdev, Error **errp) } } +vfio_rom_quirk_setup (vdev); +return true; }hw/vfio/pci.h +3
-0@@ -252,10 +252,13 @@ void vfio_bar_quirk_exit(VFIOPCIDevice *vdev, int nr);void vfio_bar_quirk_finalize (VFIOPCIDevice *vdev,int nr);void vfio_setup_resetfn_quirk (VFIOPCIDevice *vdev);bool vfio_add_virt_caps (VFIOPCIDevice *vdev,Error **errp); +void vfio_rom_quirk_setup (VFIOPCIDevice *vdev);void vfio_quirk_reset (VFIOPCIDevice *vdev);VFIOQuirk *vfio_quirk_alloc (int nr_mem); +void vfio_probe_igd_bar0_quirk (VFIOPCIDevice *vdev,int nr);bool vfio_probe_igd_config_quirk (VFIOPCIDevice *vdev,Error **errp); +void vfio_igd_legacy_rom_quirk (VFIOPCIDevice *vdev);extern const PropertyInfo qdev_prop_nv_gpudirect_clique;hw/vfio/trace-events +1
-0@@ -90,6 +90,7 @@ vfio_pci_igd_bar4_write(const char *name, uint32_t index, uint32_t data, uint32_ vfio_pci_igd_bdsm_enabled(const char *name, int size) "%s %dMB" vfio_pci_igd_host_bridge_enabled(const char *name) "%s" vfio_pci_igd_lpc_bridge_enabled(const char *name) "%s" +vfio_pci_igd_vbios_patched(const char *name) "%s" # listener.c vfio_iommu_map_notify(const char *op, uint64_t iova_start, uint64_t iova_end) "iommu %s @ 0x%"PRIx64" - 0x%"PRIx64
Quoted 277 lines · Tomita Moeko
IGD does not come with a ROM BAR [1], the ROM BAR read by default from kernel is actually the host VBIOS shadow RAM region that contains host modifications on boot. With AI-assisted reverse engineering on VBIOS binaries, it is observed that VBIOS saves BDSM register value on first access and uses saved value if present.
When the image is executed in guest, since there is already a saved HPA in VBIOS, it keeps using that value instead of the GPA programmed by SeaBIOS in BDSM register in PCI config space, causing VBIOS to program GTT entries with wrong address, resulting in garbled output in BIOS POST and the error below detected by i915 driver.
i915 0000:00:02.0: [drm] *ERROR* Initial plane programming using invalid range, dma_addr=0x00000000db200000 ((null) [0x00000000baf00000-0x00000000beefffff])
The previous solution,
c4c45e943e51("vfio/pci: Intel graphics legacy mode assignment"), adjusts GTT entry addresses to (addr - host BDSM + guest BDSM) to workaround that. But it is removed in5aed8b0f0be2("vfio/igd: Remove GTT write quirk in IO BAR 4") due to inconsistent values in MMIO BAR0 and IO BAR4.Since it was a value latched into the VBIOS that breaks virtualization (QEMU does not map the GTT at the same address in the VM), a ROM quirk clearing the saved value in VBIOS image is introduced. It searches the BDSM accessor routine by matching a 19-byte signature anchored on the unique
mov $0x105e,%axinstruction, then locates the offset of saved BDSM and clears it. This makes the routine fall through to the PCI config read on the first call inside the guest.[1] 3.5.15, 4th Generation Intel Core Processor Family Datasheet Vol. 2
https://www.intel.com/content/dam/www/public/us/en/documents/datasheets/4th-gen-core-family-desktop-vol-2-datasheet.pdfFixes 5aed8b0f0be2 ("vfio/igd: Remove GTT write quirk in IO BAR 4")Resolves: https://gitlab.com/qemu-project/qemu/-/work_items/3093
Reported-by K S Maan <[email protected]>Signed-off-by Tomita Moeko <[email protected]>---
Changelog:
v6:
* Make it a self-contained regression fix for the ROM read through vfio path only reported in the gitlab issue, per v5 comment from Alex.
* Reword the commit message.
* Cc stable as this is now a regression fix for QEMU 10.0+.v5:
* Keep the current ID and checksum patching logic invfio_pci_load_rom()since it is not IGD-specific, as pointed out by Alex. The IGD-specific quirk is now invoked after the generic patching. The ID and checksum patching is duplicated invfio_igd_legacy_rom_quirk()to handle the romfile path, since the generic patching is not invoked on romfile.
* Picked up the Michael's Acked-by on patch 1.
* Reduced from 4 to 3 patches.v4:
* Reworked per review feedback to keep IGD-specific workarounds out of the generic PCI code. Instead of recalculating the checksum inhw/pci/pci.c, a single genericromfile_fixuphook is added for device- specific ROM patching. Now both kernel ROM BAR and romfile paths share the same quirk, so the saved BDSM in user-provided romfile will also get cleared.
* Reduced from 7 to 4 patches.v3:
* Refactor ROM checksum calculation and patching logic as Alex's comment
* Fix boundary checks as comments in v2.v2:
* New patch 2/7 to fix regression with EFI option ROMs
* Refine logic in ROM ID and checksum patching
* Reorder patch 4 and 5 for cleaner bisection
* Address comments from v1hw/vfio/igd-stubs.c | 5 ++ hw/vfio/igd.c | 115 +++++++++++++++++++++++++++++++++++++++++++ hw/vfio/pci-quirks.c | 5 ++ hw/vfio/pci.c | 2 + hw/vfio/pci.h | 3 ++ hw/vfio/trace-events | 1 + 6 files changed, 131 insertions(+)hw/vfio/igd-stubs.c +5
-0@@ -18,3 +18,8 @@ bool vfio_probe_igd_config_quirk(VFIOPCIDevice *vdev, Error **errp) {return true; } + +void vfio_igd_legacy_rom_quirk (VFIOPCIDevice *vdev) +{ +return ; +}hw/vfio/igd.c +115
-0@@ -724,3 +724,118 @@ bool vfio_probe_igd_config_quirk(VFIOPCIDevice *vdev, Error **errp)return vfio_pci_igd_config_quirk (vdev, errp); } + +/* +* IGD ROM BAR read from kernel is actually the host VBIOS shadow RAM region, +* which contains host modifications. In Gen 6-9 VBIOS, the routine below is +* used to get BDSM value when programming the initial GTT. +* xx xx xx xx v: .long ? # saved value +* 66 53 push %ebx +* 66 2e 83 3e xx xx 00 cmpl $0x0,%cs:v # is saved value empty? +* 74 07 je 1f # if zero, go compute +* 66 2e a1 xx xx mov %cs:v,%eax # else return saved value +* eb 0f jmp 2f +* b8 5e 10 1: mov $0x105e,%ax # dev 00:02.0, offset 5E +* e8 xx xx call pci_read_cfg_word +* 66 c1 e0 10 shl $0x10,%eax # left shift 16 bits +* 66 2e a3 xx xx mov %eax,%cs:v # save the result +* 66 5b 2: pop %ebx +* c3 ret +* When running the VBIOS in guest, saved value still reflects the host stolen +* memory base address, which is not correct in guest. So we need to patch the +* VBIOS to clear the saved value. +* +* The unique 19-byte starts at `cmpl $0,%cs:v` and ends at `mov $0x105e,%ax` +* anchors the match to the routine. Both `cs:` displacements must reference +* the same offset. +*/ +static int igd_vbios_find_saved_bdsm (const uint8_t *rom,size_t rom_size, +uint16_t *bdsm_offset) +{ +static const uint8_t start[] = {0x66 ,0x2e ,0x83 ,0x3e }; +static const uint8_t middle[] = {0x00 ,0x74 ,0x07 ,0x66 ,0x2e ,0xa1 }; +static const uint8_t end[] = {0xeb ,0x0f ,0xb8 ,0x5e ,0x10 }; +uint16_t val; +size_t i; +bool found = false; + +if (rom_size <19 ) { +return -ENOENT ; + } + +for (i =0 ; i +19 <= rom_size; i++) { +if (memcmp (rom + i, start,sizeof (start)) !=0 || +memcmp (rom + i +6 , middle,sizeof (middle)) !=0 || +memcmp (rom + i +14 , end,sizeof (end)) !=0 ) { +continue ; + } + +/* same saved value address? */ +if (rom[i +4 ] != rom[i +12 ] || rom[i +5 ] != rom[i +13 ]) { +continue ; + } + +if (found) { +return -EEXIST ; + } + + val = rom[i +4 ] | ((uint16_t )rom[i +5 ] <<8 ); +if (val +sizeof (uint32_t ) <= rom_size) { + *bdsm_offset = val; + found = true; + } + } + +if (!found) { +return -ENOENT ; + } + +return 0 ; +} + +void vfio_igd_legacy_rom_quirk (VFIOPCIDevice *vdev) +{ +uint8_t *rom = vdev->rom; +int gen; +uint16_t pcir_offset; +uint16_t bdsm_offset =0 ; +uint8_t checksum =0 ; +uint32_t i; + +if (!vfio_pci_is (vdev,PCI_VENDOR_ID_INTEL ,PCI_ANY_ID ) || + !vfio_is_vga (vdev) || !vdev->vga) { +return ; + } + +/* Only Gen 6~9 devices have legacy VBIOS as Option ROM */ + gen =igd_gen (vdev); +if (gen <6 || gen >9 ) { +return ; + } + +if (pci_get_word (rom) !=0xaa55 ) { +return ; + } + +/* Must be a legacy ROM */ + pcir_offset =pci_get_word (rom +0x18 ); +if (pcir_offset +0x14 >= vdev->rom_size || +memcmp (rom + pcir_offset,"PCIR" ,4 ) || +pci_get_byte (rom + pcir_offset +0x14 ) !=0x00 ) { +return ; + } + +/* Search and clear the saved BDSM value */ +if (igd_vbios_find_saved_bdsm (rom, vdev->rom_size, &bdsm_offset)) { +return ; + } +memset (rom + bdsm_offset,0 ,sizeof (uint32_t )); + +/* Recalculate checksum and patch it. */ +for (i =0 ; i < vdev->rom_size; i++) { + checksum += rom[i]; + } + rom[6 ] -= checksum; + +trace_vfio_pci_igd_vbios_patched (vdev->vbasedev.name); +}hw/vfio/pci-quirks.c +5
-0@@ -1592,3 +1592,8 @@ bool vfio_add_virt_caps(VFIOPCIDevice *vdev, Error **errp)return true; } + +void vfio_rom_quirk_setup (VFIOPCIDevice *vdev) +{ +vfio_igd_legacy_rom_quirk (vdev); +}hw/vfio/pci.c +2
-0@@ -1119,6 +1119,8 @@ static bool vfio_pci_load_rom(VFIOPCIDevice *vdev, Error **errp) } } +vfio_rom_quirk_setup (vdev); +return true; }hw/vfio/pci.h +3
-0@@ -252,10 +252,13 @@ void vfio_bar_quirk_exit(VFIOPCIDevice *vdev, int nr);void vfio_bar_quirk_finalize (VFIOPCIDevice *vdev,int nr);void vfio_setup_resetfn_quirk (VFIOPCIDevice *vdev);bool vfio_add_virt_caps (VFIOPCIDevice *vdev,Error **errp); +void vfio_rom_quirk_setup (VFIOPCIDevice *vdev);void vfio_quirk_reset (VFIOPCIDevice *vdev);VFIOQuirk *vfio_quirk_alloc (int nr_mem); +void vfio_probe_igd_bar0_quirk (VFIOPCIDevice *vdev,int nr);bool vfio_probe_igd_config_quirk (VFIOPCIDevice *vdev,Error **errp); +void vfio_igd_legacy_rom_quirk (VFIOPCIDevice *vdev);extern const PropertyInfo qdev_prop_nv_gpudirect_clique;hw/vfio/trace-events +1
-0@@ -90,6 +90,7 @@ vfio_pci_igd_bar4_write(const char *name, uint32_t index, uint32_t data, uint32_ vfio_pci_igd_bdsm_enabled(const char *name, int size) "%s %dMB" vfio_pci_igd_host_bridge_enabled(const char *name) "%s" vfio_pci_igd_lpc_bridge_enabled(const char *name) "%s" +vfio_pci_igd_vbios_patched(const char *name) "%s" # listener.c vfio_iommu_map_notify(const char *op, uint64_t iova_start, uint64_t iova_end) "iommu %s @ 0x%"PRIx64" - 0x%"PRIx64
Quoted 270 lines · Tomita Moeko
IGD does not come with a ROM BAR [1], the ROM BAR read by default from kernel is actually the host VBIOS shadow RAM region that contains host modifications on boot. With AI-assisted reverse engineering on VBIOS binaries, it is observed that VBIOS saves BDSM register value on first access and uses saved value if present.
When the image is executed in guest, since there is already a saved HPA in VBIOS, it keeps using that value instead of the GPA programmed by SeaBIOS in BDSM register in PCI config space, causing VBIOS to program GTT entries with wrong address, resulting in garbled output in BIOS POST and the error below detected by i915 driver.
i915 0000:00:02.0: [drm] *ERROR* Initial plane programming using invalid range, dma_addr=0x00000000db200000 ((null) [0x00000000baf00000-0x00000000beefffff])
The previous solution,
c4c45e943e51("vfio/pci: Intel graphics legacy mode assignment"), adjusts GTT entry addresses to (addr - host BDSM + guest BDSM) to workaround that. But it is removed in5aed8b0f0be2("vfio/igd: Remove GTT write quirk in IO BAR 4") due to inconsistent values in MMIO BAR0 and IO BAR4.Since it was a value latched into the VBIOS that breaks virtualization (QEMU does not map the GTT at the same address in the VM), a ROM quirk clearing the saved value in VBIOS image is introduced. It searches the BDSM accessor routine by matching a 19-byte signature anchored on the unique
mov $0x105e,%axinstruction, then locates the offset of saved BDSM and clears it. This makes the routine fall through to the PCI config read on the first call inside the guest.[1] 3.5.15, 4th Generation Intel Core Processor Family Datasheet Vol. 2
https://www.intel.com/content/dam/www/public/us/en/documents/datasheets/4th-gen-core-family-desktop-vol-2-datasheet.pdfFixes 5aed8b0f0be2 ("vfio/igd: Remove GTT write quirk in IO BAR 4")Resolves: https://gitlab.com/qemu-project/qemu/-/work_items/3093
Reported-by K S Maan <[email protected]>Signed-off-by Tomita Moeko <[email protected]>---
Changelog:
v6:
* Make it a self-contained regression fix for the ROM read through vfio path only reported in the gitlab issue, per v5 comment from Alex.
* Reword the commit message.
* Cc stable as this is now a regression fix for QEMU 10.0+.v5:
* Keep the current ID and checksum patching logic invfio_pci_load_rom()since it is not IGD-specific, as pointed out by Alex. The IGD-specific quirk is now invoked after the generic patching. The ID and checksum patching is duplicated invfio_igd_legacy_rom_quirk()to handle the romfile path, since the generic patching is not invoked on romfile.
* Picked up the Michael's Acked-by on patch 1.
* Reduced from 4 to 3 patches.v4:
* Reworked per review feedback to keep IGD-specific workarounds out of the generic PCI code. Instead of recalculating the checksum inhw/pci/pci.c, a single genericromfile_fixuphook is added for device- specific ROM patching. Now both kernel ROM BAR and romfile paths share the same quirk, so the saved BDSM in user-provided romfile will also get cleared.
* Reduced from 7 to 4 patches.v3:
* Refactor ROM checksum calculation and patching logic as Alex's comment
* Fix boundary checks as comments in v2.v2:
* New patch 2/7 to fix regression with EFI option ROMs
* Refine logic in ROM ID and checksum patching
* Reorder patch 4 and 5 for cleaner bisection
* Address comments from v1hw/vfio/igd-stubs.c | 5 ++ hw/vfio/igd.c | 115 +++++++++++++++++++++++++++++++++++++++++++ hw/vfio/pci-quirks.c | 5 ++ hw/vfio/pci.c | 2 + hw/vfio/pci.h | 3 ++ hw/vfio/trace-events | 1 + 6 files changed, 131 insertions(+)hw/vfio/igd-stubs.c +5
-0@@ -18,3 +18,8 @@ bool vfio_probe_igd_config_quirk(VFIOPCIDevice *vdev, Error **errp) {return true; } + +void vfio_igd_legacy_rom_quirk (VFIOPCIDevice *vdev) +{ +return ; +}hw/vfio/igd.c +115
-0@@ -724,3 +724,118 @@ bool vfio_probe_igd_config_quirk(VFIOPCIDevice *vdev, Error **errp)return vfio_pci_igd_config_quirk (vdev, errp); } + +/* +* IGD ROM BAR read from kernel is actually the host VBIOS shadow RAM region, +* which contains host modifications. In Gen 6-9 VBIOS, the routine below is +* used to get BDSM value when programming the initial GTT. +* xx xx xx xx v: .long ? # saved value +* 66 53 push %ebx +* 66 2e 83 3e xx xx 00 cmpl $0x0,%cs:v # is saved value empty? +* 74 07 je 1f # if zero, go compute +* 66 2e a1 xx xx mov %cs:v,%eax # else return saved value +* eb 0f jmp 2f +* b8 5e 10 1: mov $0x105e,%ax # dev 00:02.0, offset 5E +* e8 xx xx call pci_read_cfg_word +* 66 c1 e0 10 shl $0x10,%eax # left shift 16 bits +* 66 2e a3 xx xx mov %eax,%cs:v # save the result +* 66 5b 2: pop %ebx +* c3 ret +* When running the VBIOS in guest, saved value still reflects the host stolen +* memory base address, which is not correct in guest. So we need to patch the +* VBIOS to clear the saved value. +* +* The unique 19-byte starts at `cmpl $0,%cs:v` and ends at `mov $0x105e,%ax` +* anchors the match to the routine. Both `cs:` displacements must reference +* the same offset. +*/ +static int igd_vbios_find_saved_bdsm (const uint8_t *rom,size_t rom_size, +uint16_t *bdsm_offset) +{ +static const uint8_t start[] = {0x66 ,0x2e ,0x83 ,0x3e }; +static const uint8_t middle[] = {0x00 ,0x74 ,0x07 ,0x66 ,0x2e ,0xa1 }; +static const uint8_t end[] = {0xeb ,0x0f ,0xb8 ,0x5e ,0x10 }; +uint16_t val; +size_t i; +bool found = false; + +if (rom_size <19 ) { +return -ENOENT ; + } + +for (i =0 ; i +19 <= rom_size; i++) { +if (memcmp (rom + i, start,sizeof (start)) !=0 || +memcmp (rom + i +6 , middle,sizeof (middle)) !=0 || +memcmp (rom + i +14 , end,sizeof (end)) !=0 ) { +continue ; + } + +/* same saved value address? */ +if (rom[i +4 ] != rom[i +12 ] || rom[i +5 ] != rom[i +13 ]) { +continue ; + } + +if (found) { +return -EEXIST ; + } + + val = rom[i +4 ] | ((uint16_t )rom[i +5 ] <<8 ); +if (val +sizeof (uint32_t ) <= rom_size) { + *bdsm_offset = val; + found = true; + } + } + +if (!found) { +return -ENOENT ; + } + +return 0 ; +} + +void vfio_igd_legacy_rom_quirk (VFIOPCIDevice *vdev) +{ +uint8_t *rom = vdev->rom; +int gen; +uint16_t pcir_offset; +uint16_t bdsm_offset =0 ; +uint8_t checksum =0 ; +uint32_t i; + +if (!vfio_pci_is (vdev,PCI_VENDOR_ID_INTEL ,PCI_ANY_ID ) || + !vfio_is_vga (vdev) || !vdev->vga) { +return ; + } + +/* Only Gen 6~9 devices have legacy VBIOS as Option ROM */ + gen =igd_gen (vdev); +if (gen <6 || gen >9 ) { +return ; + } + +if (pci_get_word (rom) !=0xaa55 ) { +return ; + } + +/* Must be a legacy ROM */ + pcir_offset =pci_get_word (rom +0x18 ); +if (pcir_offset +0x14 >= vdev->rom_size || +memcmp (rom + pcir_offset,"PCIR" ,4 ) || +pci_get_byte (rom + pcir_offset +0x14 ) !=0x00 ) { +return ; + } + +/* Search and clear the saved BDSM value */ +if (igd_vbios_find_saved_bdsm (rom, vdev->rom_size, &bdsm_offset)) { +return ; + } +memset (rom + bdsm_offset,0 ,sizeof (uint32_t )); + +/* Recalculate checksum and patch it. */ +for (i =0 ; i < vdev->rom_size; i++) { + checksum += rom[i]; + } + rom[6 ] -= checksum; + +trace_vfio_pci_igd_vbios_patched (vdev->vbasedev.name); +}hw/vfio/pci-quirks.c +5
-0@@ -1592,3 +1592,8 @@ bool vfio_add_virt_caps(VFIOPCIDevice *vdev, Error **errp)return true; } + +void vfio_rom_quirk_setup (VFIOPCIDevice *vdev) +{ +vfio_igd_legacy_rom_quirk (vdev); +}hw/vfio/pci.c +2
-0@@ -1119,6 +1119,8 @@ static bool vfio_pci_load_rom(VFIOPCIDevice *vdev, Error **errp) } } +vfio_rom_quirk_setup (vdev); +return true; }hw/vfio/pci.h +3
-0@@ -252,10 +252,13 @@ void vfio_bar_quirk_exit(VFIOPCIDevice *vdev, int nr);void vfio_bar_quirk_finalize (VFIOPCIDevice *vdev,int nr);void vfio_setup_resetfn_quirk (VFIOPCIDevice *vdev);bool vfio_add_virt_caps (VFIOPCIDevice *vdev,Error **errp); +void vfio_rom_quirk_setup (VFIOPCIDevice *vdev);void vfio_quirk_reset (VFIOPCIDevice *vdev);VFIOQuirk *vfio_quirk_alloc (int nr_mem); +void vfio_probe_igd_bar0_quirk (VFIOPCIDevice *vdev,int nr);bool vfio_probe_igd_config_quirk (VFIOPCIDevice *vdev,Error **errp); +void vfio_igd_legacy_rom_quirk (VFIOPCIDevice *vdev);extern const PropertyInfo qdev_prop_nv_gpudirect_clique;hw/vfio/trace-events +0
-0
hw/vfio/trace-events vfio_pci_igd_bar4_write(const char *name, uint32_t index, uint32_t data, uint32_ · line 96
Quoted 7 lines
hw/vfio/trace-events +1
-0@@ -90,6 +90,7 @@ vfio_pci_igd_bar4_write(const char *name, uint32_t index, uint32_t data, uint32_ vfio_pci_igd_bdsm_enabled(const char *name, int size) "%s %dMB" vfio_pci_igd_host_bridge_enabled(const char *name) "%s" vfio_pci_igd_lpc_bridge_enabled(const char *name) "%s" +vfio_pci_igd_vbios_patched(const char *name) "%s" # listener.c vfio_iommu_map_notify(const char *op, uint64_t iova_start, uint64_t iova_end) "iommu %s @ 0x%"PRIx64" - 0x%"PRIx64
Applied to
https://github.com/legoater/qemu vfio-next
Thanks,
C.