diff mbox series

[v4,5/6] Documentation/ABI/testing/sysfs-bus-vfio-mdev: Update for vfio/mdev aggregation support

Message ID 20181126084856.25061-6-zhenyuw@linux.intel.com (mailing list archive)
State New, archived
Headers show
Series VFIO mdev aggregated resources handling | expand

Commit Message

Zhenyu Wang Nov. 26, 2018, 8:48 a.m. UTC
Update vfio/mdev ABI description for new aggregation attributes.

Cc: Kirti Wankhede <kwankhede@nvidia.com>
Cc: Alex Williamson <alex.williamson@redhat.com>
Cc: Kevin Tian <kevin.tian@intel.com>
Cc: Cornelia Huck <cohuck@redhat.com>
Signed-off-by: Zhenyu Wang <zhenyuw@linux.intel.com>
---
 Documentation/ABI/testing/sysfs-bus-vfio-mdev | 25 +++++++++++++++++++
 1 file changed, 25 insertions(+)

Comments

Cornelia Huck Nov. 26, 2018, 12:56 p.m. UTC | #1
On Mon, 26 Nov 2018 16:48:55 +0800
Zhenyu Wang <zhenyuw@linux.intel.com> wrote:

> Update vfio/mdev ABI description for new aggregation attributes.
> 
> Cc: Kirti Wankhede <kwankhede@nvidia.com>
> Cc: Alex Williamson <alex.williamson@redhat.com>
> Cc: Kevin Tian <kevin.tian@intel.com>
> Cc: Cornelia Huck <cohuck@redhat.com>
> Signed-off-by: Zhenyu Wang <zhenyuw@linux.intel.com>
> ---
>  Documentation/ABI/testing/sysfs-bus-vfio-mdev | 25 +++++++++++++++++++
>  1 file changed, 25 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-vfio-mdev b/Documentation/ABI/testing/sysfs-bus-vfio-mdev
> index 452dbe39270e..192fe06e60d0 100644
> --- a/Documentation/ABI/testing/sysfs-bus-vfio-mdev
> +++ b/Documentation/ABI/testing/sysfs-bus-vfio-mdev
> @@ -85,6 +85,24 @@ Users:
>  		a particular <type-id> that can help in understanding the
>  		features provided by that type of mediated device.
>  
> +What:           /sys/.../mdev_supported_types/<type-id>/aggregation
> +Date:           October 2018

You'll probably need to tweak that :)

> +Contact:        Zhenyu Wang <zhenyuw@linux.intel.com>
> +Description:
> +		Reading this attribute will show number of mdev instances
> +		that can be aggregated to assign for one mdev device.
> +		This is optional attribute. If this attribute exists that

s/optional attribute/an optional attribute/

> +		means driver supports to aggregate target mdev type's
> +		resources assigned for one mdev device.

"If this attribute exits, the driver supports aggregating..."

> +Users:
> +		Userspace applications interested in creating mediated
> +		device with aggregated type instances. Userspace application
> +		should check the number of aggregation instances that could
> +		be created before creating mediated device by applying this,
> +		e.g
> +		# echo "83b8f4f2-509f-382f-3c1e-e6bfe0fa1001,aggregate=XX" > \
> +		       /sys/devices/foo/mdev_supported_types/foo-1/create
> +
>  What:           /sys/.../<device>/<UUID>/
>  Date:           October 2016
>  Contact:        Kirti Wankhede <kwankhede@nvidia.com>
> @@ -109,3 +127,10 @@ Description:
>  		is active and the vendor driver doesn't support hot unplug.
>  		Example:
>  		# echo 1 > /sys/bus/mdev/devices/<UUID>/remove
> +
> +What:           /sys/.../<device>/<UUID>/aggregated_instances
> +Date:           October 2018

ditto

> +Contact:        Zhenyu Wang <zhenyuw@linux.intel.com>
> +Description:
> +		This attributes shows number of aggregated instances if this
> +		mediated device was created with "aggregate" parameter.
> \ No newline at end of file
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-vfio-mdev b/Documentation/ABI/testing/sysfs-bus-vfio-mdev
index 452dbe39270e..192fe06e60d0 100644
--- a/Documentation/ABI/testing/sysfs-bus-vfio-mdev
+++ b/Documentation/ABI/testing/sysfs-bus-vfio-mdev
@@ -85,6 +85,24 @@  Users:
 		a particular <type-id> that can help in understanding the
 		features provided by that type of mediated device.
 
+What:           /sys/.../mdev_supported_types/<type-id>/aggregation
+Date:           October 2018
+Contact:        Zhenyu Wang <zhenyuw@linux.intel.com>
+Description:
+		Reading this attribute will show number of mdev instances
+		that can be aggregated to assign for one mdev device.
+		This is optional attribute. If this attribute exists that
+		means driver supports to aggregate target mdev type's
+		resources assigned for one mdev device.
+Users:
+		Userspace applications interested in creating mediated
+		device with aggregated type instances. Userspace application
+		should check the number of aggregation instances that could
+		be created before creating mediated device by applying this,
+		e.g
+		# echo "83b8f4f2-509f-382f-3c1e-e6bfe0fa1001,aggregate=XX" > \
+		       /sys/devices/foo/mdev_supported_types/foo-1/create
+
 What:           /sys/.../<device>/<UUID>/
 Date:           October 2016
 Contact:        Kirti Wankhede <kwankhede@nvidia.com>
@@ -109,3 +127,10 @@  Description:
 		is active and the vendor driver doesn't support hot unplug.
 		Example:
 		# echo 1 > /sys/bus/mdev/devices/<UUID>/remove
+
+What:           /sys/.../<device>/<UUID>/aggregated_instances
+Date:           October 2018
+Contact:        Zhenyu Wang <zhenyuw@linux.intel.com>
+Description:
+		This attributes shows number of aggregated instances if this
+		mediated device was created with "aggregate" parameter.
\ No newline at end of file