From: "Cédric Le Goater" <clg@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Alex Williamson" <alex.williamson@redhat.com>,
"Cédric Le Goater" <clg@redhat.com>,
"Tony Krowiak" <akrowiak@linux.ibm.com>,
"Eric Farman" <farman@linux.ibm.com>,
"Eric Auger" <eric.auger@redhat.com>
Subject: [PATCH] vfio: Add property documentation
Date: Thu, 13 Feb 2025 09:46:14 +0100 [thread overview]
Message-ID: <20250213084614.1340610-1-clg@redhat.com> (raw)
Investigate the git history to uncover when and why the VFIO
properties were introduced and update the models. This is mostly
targeting vfio-pci device, since vfio-plateform, vfio-ap and vfio-ccw
devices are simpler.
Fpr PCI, it would be great to have a way to organize the output by
topics : display, igd, nvidia, migration, debug, other
Cc: Tony Krowiak <akrowiak@linux.ibm.com>
Cc: Eric Farman <farman@linux.ibm.com>
Cc: Eric Auger <eric.auger@redhat.com>
Signed-off-by: Cédric Le Goater <clg@redhat.com>
---
hw/vfio/ap.c | 9 ++++
hw/vfio/ccw.c | 15 +++++++
hw/vfio/pci.c | 102 +++++++++++++++++++++++++++++++++++++++++++++
hw/vfio/platform.c | 23 ++++++++++
4 files changed, 149 insertions(+)
diff --git a/hw/vfio/ap.c b/hw/vfio/ap.c
index 30b08ad375d5ecae886c5000fbaa364799fe76d0..322bb0ed03e7a5c57f9d4ea33bd6eed4088b874b 100644
--- a/hw/vfio/ap.c
+++ b/hw/vfio/ap.c
@@ -257,6 +257,15 @@ static void vfio_ap_class_init(ObjectClass *klass, void *data)
dc->hotpluggable = true;
device_class_set_legacy_reset(dc, vfio_ap_reset);
dc->bus_type = TYPE_AP_BUS;
+
+ object_class_property_set_description(klass, /* 3.0 */
+ "sysfsdev",
+ "Host sysfs path of assigned device");
+#ifdef CONFIG_IOMMUFD
+ object_class_property_set_description(klass, /* 8.2 */
+ "iommufd",
+ "Set host IOMMUFD backend device ");
+#endif
}
static const TypeInfo vfio_ap_info = {
diff --git a/hw/vfio/ccw.c b/hw/vfio/ccw.c
index 67bc137f9be6d43c5970c6271f3cdbfffd8a32de..df9e48c1635fb23aa436ea29daadbdb49977e4d3 100644
--- a/hw/vfio/ccw.c
+++ b/hw/vfio/ccw.c
@@ -717,6 +717,21 @@ static void vfio_ccw_class_init(ObjectClass *klass, void *data)
cdc->handle_halt = vfio_ccw_handle_halt;
cdc->handle_clear = vfio_ccw_handle_clear;
cdc->handle_store = vfio_ccw_handle_store;
+
+ object_class_property_set_description(klass, /* 2.9 */
+ "sysfsdev",
+ "Host sysfs path of assigned device");
+ object_class_property_set_description(klass, /* 2.12 */
+ "force-orb-pfch",
+ "Force unlimited prefetch");
+#ifdef CONFIG_IOMMUFD
+ object_class_property_set_description(klass, /* 8.2 */
+ "iommufd",
+ "Set host IOMMUFD backend device ");
+ object_class_property_set_description(klass, /* 9.2 */
+ "loadparm",
+ "Define which devices that can be used for booting");
+#endif
}
static const TypeInfo vfio_ccw_info = {
diff --git a/hw/vfio/pci.c b/hw/vfio/pci.c
index 9a55e7b77324babf7295132b08e3ba23b482a291..8e12533c93c6f5c6f92cbcddb753d047e9fbd8f6 100644
--- a/hw/vfio/pci.c
+++ b/hw/vfio/pci.c
@@ -3433,6 +3433,108 @@ static void vfio_pci_dev_class_init(ObjectClass *klass, void *data)
pdc->exit = vfio_exitfn;
pdc->config_read = vfio_pci_read_config;
pdc->config_write = vfio_pci_write_config;
+
+ object_class_property_set_description(klass, /* 1.2 */
+ "host",
+ "Host PCI address [domain:]<bus:slot.function> of assigned device");
+ object_class_property_set_description(klass, /* 8.0 */
+ "vf-token",
+ "Add support for VF token among PF and VFs (Linux 5.7+)");
+ object_class_property_set_description(klass, /* 2.5 */
+ "sysfsdev",
+ "Host sysfs path of assigned device");
+ object_class_property_set_description(klass, /* 5.2 */
+ "x-pre-copy-dirty-page-tracking",
+ "Disable dirty pages tracking during iterative phase");
+ object_class_property_set_description(klass, /* 9.0 */
+ "x-device-dirty-page-tracking",
+ "Disable device dirty page tracking and use container-based dirty page tracking");
+ object_class_property_set_description(klass, /* 2.11 */
+ "display",
+ "Add display support");
+ object_class_property_set_description(klass, /* 3.1 */
+ "xres",
+ "Set X display resolution the vgpu should use");
+ object_class_property_set_description(klass, /* 3.1 */
+ "yres",
+ "Set Y display resolution the vgpu should use");
+ object_class_property_set_description(klass, /* 1.2 */
+ "x-intx-mmap-timeout-ms",
+ "Timeout value in milliseconds to re-enable BAR mapping when under "
+ "INTx interrupts. Improves performance");
+ object_class_property_set_description(klass, /* 1.4 */
+ "x-vga",
+ "Add support for VGA MMIO and I/O port access");
+ object_class_property_set_description(klass, /* 2.2 */
+ "x-req",
+ "Add device request notification support (Linux 4.0+)");
+ object_class_property_set_description(klass, /* 2.6 */
+ "x-igd-opregion",
+ "Add IGD OpRegion support for (headless system)");
+ object_class_property_set_description(klass, /* 5.2, 8.0 non-experimetal */
+ "enable-migration",
+ "Enale device migration. Also requires a host VFIO PCI variant "
+ "driver with migration support enabled");
+ object_class_property_set_description(klass, /* 9.0 */
+ "migration-events",
+ "Emit VFIO migration QAPI event when a VFIO device changes its migration "
+ "state. For management applications");
+ object_class_property_set_description(klass, /* 2.2 and 2.4 */
+ "x-no-mmap",
+ "Disable MMAP for device. Allows to trace MMIO accesses");
+ object_class_property_set_description(klass, /* 3.0 */
+ "x-balloon-allowed",
+ "Allow devices to opt-in for ballooning");
+ object_class_property_set_description(klass, /* 2.4 */
+ "x-no-kvm-intx",
+ "Bypass INTx interrupts. Allows interrupt tracing");
+ object_class_property_set_description(klass, /* 2.4 */
+ "x-no-kvm-msi",
+ "Bypass MSI interrupts. Allows interrupt tracing");
+ object_class_property_set_description(klass, /* 2.4 */
+ "x-no-kvm-msix",
+ "Bypass MSIx interrupts. Allows interrupt tracing");
+ object_class_property_set_description(klass, /* 2.11 */
+ "x-no-geforce-quirks",
+ "Disable GeForce quirks (for NVIDIA Quadro/GRID/Tesla). Improves performance");
+ object_class_property_set_description(klass, /* 2.12 */
+ "x-no-kvm-ioeventfd",
+ "Disable ioeventfd quirk (NVIDIA)");
+ object_class_property_set_description(klass, /* 2.12 */
+ "x-no-vfio-ioeventfd",
+ "Enable ioeventfd quirks to be handled by VFIO directly. Improves performance");
+ object_class_property_set_description(klass, /* 2.4 */
+ "x-pci-vendor-id",
+ "Set emulated PCI Vendor ID. Allows testing quirks");
+ object_class_property_set_description(klass, /* 2.4 */
+ "x-pci-device-id",
+ "Set emulated PCI device ID. Allows testing quirks");
+ object_class_property_set_description(klass, /* 2.4 */
+ "x-pci-sub-vendor-id",
+ "Set emulated PCI Sub-vendor ID");
+ object_class_property_set_description(klass, /* 2.4 */
+ "x-pci-sub-device-id",
+ "Set emulated PCI Sub-device ID");
+ object_class_property_set_description(klass, /* 2.6 (See c4c45e943e51) */
+ "x-igd-gms",
+ "Add Intel graphics legacy mode device assignment support. "
+ "Assign 00:02.0 from the host to 00:02.0 in the VM");
+ object_class_property_set_description(klass, /* 2.10 */
+ "x-nv-gpudirect-clique",
+ "Add NVIDIA GPUDirect Cliques support");
+ object_class_property_set_description(klass, /* 2.11 */
+ "x-msix-relocation",
+ "Allow relocating MSI-X MMIO on systems which page size is larger "
+ "than the PCI spec recommendation. Mostly for sPAPR");
+#ifdef CONFIG_IOMMUFD
+ object_class_property_set_description(klass, /* 8.2 */
+ "iommufd",
+ "Set host IOMMUFD backend device ");
+#endif
+ object_class_property_set_description(klass, /* 9.0 */
+ "skip-vsc-check",
+ "Skip config space check for Vendor Specific Capability. Useful for "
+ "NVIDIA vGPU driver migration");
}
static const TypeInfo vfio_pci_dev_info = {
diff --git a/hw/vfio/platform.c b/hw/vfio/platform.c
index 1070a2113a17edb9ebafb5066e51ee2bc52a767d..7c4baa593b858b1f9b06bc9485c1eb00ef82ceaa 100644
--- a/hw/vfio/platform.c
+++ b/hw/vfio/platform.c
@@ -674,6 +674,29 @@ static void vfio_platform_class_init(ObjectClass *klass, void *data)
set_bit(DEVICE_CATEGORY_MISC, dc->categories);
/* Supported by TYPE_VIRT_MACHINE */
dc->user_creatable = true;
+
+ object_class_property_set_description(klass, /* 2.3 */
+ "host",
+ "Host device name of assigned device");
+ object_class_property_set_description(klass, /* 2.3 */
+ "sysfsdev",
+ "Host sysfs path of assigned device");
+ object_class_property_set_description(klass, /* 2.3 and 2.4 */
+ "x-no-mmap",
+ "Disable MMAP for device. Allows to trace MMIO accesses");
+ object_class_property_set_description(klass, /* 2.3 */
+ "mmap-timeout-ms",
+ "Timeout value in milliseconds to re-enable BAR mapping");
+ object_class_property_set_description(klass, /* 2.3 */
+ "x-irqfd",
+ "Use irqfd for IRQ handling");
+
+#ifdef CONFIG_IOMMUFD
+ object_class_property_set_description(klass, /* 8.2 */
+ "iommufd",
+ "Set host IOMMUFD backend device ");
+#endif
+
}
static const TypeInfo vfio_platform_dev_info = {
--
2.48.1
reply other threads:[~2025-02-13 8:46 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250213084614.1340610-1-clg@redhat.com \
--to=clg@redhat.com \
--cc=akrowiak@linux.ibm.com \
--cc=alex.williamson@redhat.com \
--cc=eric.auger@redhat.com \
--cc=farman@linux.ibm.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).