[RFC v2: vf-token 7/7] doc: doc and news
Update documentation and information about vf-token
Signed-off-by: Vivek Kashyap <vivek.kashyap(a)linux.intel.com>
---
NEWS.rst | 8 ++++++++
docs/formatdomain.rst | 4 ++++
2 files changed, 12 insertions(+)
diff --git a/NEWS.rst b/NEWS.rst
index f12734c2a1..3fb0230e71 100644
--- a/NEWS.rst
+++ b/NEWS.rst
@@ -22,6 +22,14 @@ v9.10.0 (unreleased)
The QEMU hypervisor driver now allows setting ``pipewire`` backend for
``<audio/>`` device.
+ * qemu: support VF tokens for vfio-pci
+
+ "vf-token",implemented as a UUID, is a shared secret between userspace
+ vfio-based PF and VF drivers. The token is set by the PF driver and is part
+ of the device matching by the VF driver. The vfio vf-token uuid is
+ included in the VM XML specification for the pci device, and the token is
+ passed in qemu commandline on VM launch.
+
* **Improvements**
* **Bug fixes**
diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 310d2bc427..08d7540de5 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -3744,6 +3744,10 @@ control where on the bus the device will be placed:
between 0x0001 and 0xffff, inclusive), and ``fid`` (a hex value between
0x00000000 and 0xffffffff, inclusive) used by PCI devices on S390 for
User-defined Identifiers and Function Identifiers.
+ :since:'Since 8.1.0`, the vf-token element is supported in uuid format. The
+ vf-token is a shared secret between userspace vfio-pci PF driver and VF
+ driver. The token is set by the PF driver, and must be provided for VF
+ access.
:since:`Since 1.3.5` , some hypervisor drivers may accept an
``<address type='pci'/>`` element with no other attributes as an
explicit
request to assign a PCI address for the device rather than some other type of
--
2.25.1