diff --git a/docs/drvnodedev.html.in b/docs/drvnodedev.html.in index 0823c1888d..639f58d8ce 100644 --- a/docs/drvnodedev.html.in +++ b/docs/drvnodedev.html.in @@ -144,7 +144,7 @@ types on the physical device, along with the type attributes available through sysfs. A detailed description of the XML format for the mdev_types capability can be found - here. + here.

The following example shows how we might represent an NVIDIA GPU device diff --git a/docs/formatnode.html.in b/docs/formatnode.html.in index 6928bdd69c..3fad842c53 100644 --- a/docs/formatnode.html.in +++ b/docs/formatnode.html.in @@ -159,35 +159,10 @@

mdev_types
- This device is capable of creating mediated devices, and - the capability will contain a list of type - elements, which list all mdev types supported on the - physical device. Since 3.4.0 - Each type element has a single id - attribute that holds an official vendor-supplied identifier - for the type. It supports the following sub-elements: -
-
name
-
- The name element holds a vendor-supplied - code name for the given mediated device type. This is - an optional element. -
-
deviceAPI
-
- The value of this element describes how an instance of - the given type will be presented to the guest by the - VFIO framework. -
-
availableInstances
-
- This element reports the current state of resource - allocation. In other words, how many instances of the - given type can still be successfully created on the - physical device. -
-
-
+ This device is capable of creating mediated devices. + The sub-elements are summarized in + mdev_types capability. + @@ -445,6 +420,42 @@ +

mdev_types capability

+ +

+ PCI devices can be capable of + creating mediated devices. If they indeed are capable, + then the parent capability element for + mdev_types type will contain a list of + type elements, which list all mdev types supported + on the physical device. Since 3.4.0 + Each type element has a single id + attribute that holds an official vendor-supplied identifier + for the type. It supports the following sub-elements: +

+
name
+
+ The name element holds a vendor-supplied + code name for the given mediated device type. This is + an optional element. +
+
deviceAPI
+
+ The value of this element describes how an instance of + the given type will be presented to the guest by the + VFIO framework. +
+
availableInstances
+
+ This element reports the current state of resource + allocation. In other words, how many instances of the + given type can still be successfully created on the + physical device. +
+
+

+ +

Examples

The following are some example node device XML outputs: