Update vfio/mdev doc on new "aggregate" create parameter, new "aggregation"
attribute and "aggregated_instances" attribute for mdev device.
Cc: Kirti Wankhede <kwankhede@xxxxxxxxxx>
Cc: Alex Williamson <alex.williamson@xxxxxxxxxx>
Cc: Kevin Tian <kevin.tian@xxxxxxxxx>
Cc: Cornelia Huck <cohuck@xxxxxxxxxx>
Signed-off-by: Zhenyu Wang <zhenyuw@xxxxxxxxxxxxxxx>
---
.../driver-api/vfio-mediated-device.rst | 23 +++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/Documentation/driver-api/vfio-mediated-device.rst b/Documentation/driver-api/vfio-mediated-device.rst
index 25eb7d5b834b..2881be654516 100644
--- a/Documentation/driver-api/vfio-mediated-device.rst
+++ b/Documentation/driver-api/vfio-mediated-device.rst
@@ -216,6 +216,7 @@ Directories and files under the sysfs for Each Physical Device
| |--- available_instances
| |--- device_api
| |--- description
+ | |--- <aggregation>
| |--- [devices]
* [mdev_supported_types]
@@ -260,6 +261,21 @@ Directories and files under the sysfs for Each Physical Device
This attribute should show brief features/description of the type. This is
optional attribute.
+* <aggregation>
+
+ <aggregation> is an optional attributes to show maximum number that the
+ instance resources of [<type-id>] can be aggregated to be assigned
+ for one mdev device. No <aggregation> attribute means driver doesn't
+ support to aggregate instance resoures for one mdev device.
+
+ Set number of instances by appending "aggregate=N" parameter for
+ create attribute. By default without "aggregate=N" parameter it
+ will create one instance as normal.
+
+Example::
+
+ # echo "<uuid>,aggregate=N" > create
+
Directories and Files Under the sysfs for Each mdev Device
----------------------------------------------------------
@@ -268,6 +284,7 @@ Directories and Files Under the sysfs for Each mdev Device
|- [parent phy device]
|--- [$MDEV_UUID]
|--- remove
+ |--- <aggregated_instances>
|--- mdev_type {link to its type}
|--- vendor-specific-attributes [optional]
@@ -281,6 +298,12 @@ Example::
# echo 1 > /sys/bus/mdev/devices/$mdev_UUID/remove
+* <aggregated_instances> (read only)
+
+For mdev created with aggregate parameter, this shows number of
+instances assigned for this mdev. For normal type this attribute will
+not exist.
+
Mediated device Hot plug
------------------------
--
2.24.0.rc0
