sysfs-bus-vfio-mdev

  1What:           /sys/.../<device>/mdev_supported_types/
  2Date:           October 2016
  3Contact:        Kirti Wankhede <kwankhede@nvidia.com>
  4Description:
  5                This directory contains list of directories of currently
  6		supported mediated device types and their details for
  7		<device>. Supported type attributes are defined by the
  8		vendor driver who registers with Mediated device framework.
  9		Each supported type is a directory whose name is created
 10		by adding the device driver string as a prefix to the
 11		string provided by the vendor driver.
 12
 13What:           /sys/.../<device>/mdev_supported_types/<type-id>/
 14Date:           October 2016
 15Contact:        Kirti Wankhede <kwankhede@nvidia.com>
 16Description:
 17                This directory gives details of supported type, like name,
 18		description, available_instances, device_api etc.
 19		'device_api' and 'available_instances' are mandatory
 20		attributes to be provided by vendor driver. 'name',
 21		'description' and other vendor driver specific attributes
 22		are optional.
 23
 24What:           /sys/.../mdev_supported_types/<type-id>/create
 25Date:           October 2016
 26Contact:        Kirti Wankhede <kwankhede@nvidia.com>
 27Description:
 28		Writing UUID to this file will create mediated device of
 29		type <type-id> for parent device <device>. This is a
 30		write-only file.
 31		For example::
 32
 33		  # echo "83b8f4f2-509f-382f-3c1e-e6bfe0fa1001" >	\
 34		       /sys/devices/foo/mdev_supported_types/foo-1/create
 35
 36What:           /sys/.../mdev_supported_types/<type-id>/devices/
 37Date:           October 2016
 38Contact:        Kirti Wankhede <kwankhede@nvidia.com>
 39Description:
 40		This directory contains symbolic links pointing to mdev
 41		devices sysfs entries which are created of this <type-id>.
 42
 43What:           /sys/.../mdev_supported_types/<type-id>/available_instances
 44Date:           October 2016
 45Contact:        Kirti Wankhede <kwankhede@nvidia.com>
 46Description:
 47		Reading this attribute will show the number of mediated
 48		devices of type <type-id> that can be created. This is a
 49		readonly file.
 50Users:
 51		Userspace applications interested in creating mediated
 52		device of that type. Userspace application should check
 53		the number of available instances could be created before
 54		creating mediated device of this type.
 55
 56What:           /sys/.../mdev_supported_types/<type-id>/device_api
 57Date:           October 2016
 58Contact:        Kirti Wankhede <kwankhede@nvidia.com>
 59Description:
 60		Reading this attribute will show VFIO device API supported
 61		by this type. For example, "vfio-pci" for a PCI device,
 62		"vfio-platform" for platform device.
 63
 64What:           /sys/.../mdev_supported_types/<type-id>/name
 65Date:           October 2016
 66Contact:        Kirti Wankhede <kwankhede@nvidia.com>
 67Description:
 68		Reading this attribute will show human readable name of the
 69		mediated device that will get created of type <type-id>.
 70		This is optional attribute. For example: "Grid M60-0Q"
 71Users:
 72		Userspace applications interested in knowing the name of
 73		a particular <type-id> that can help in understanding the
 74		type of mediated device.
 75
 76What:           /sys/.../mdev_supported_types/<type-id>/description
 77Date:           October 2016
 78Contact:        Kirti Wankhede <kwankhede@nvidia.com>
 79Description:
 80		Reading this attribute will show description of the type of
 81		mediated device that will get created of type <type-id>.
 82		This is optional attribute. For example:
 83		"2 heads, 512M FB, 2560x1600 maximum resolution"
 84Users:
 85		Userspace applications interested in knowing the details of
 86		a particular <type-id> that can help in understanding the
 87		features provided by that type of mediated device.
 88
 89What:           /sys/.../<device>/<UUID>/
 90Date:           October 2016
 91Contact:        Kirti Wankhede <kwankhede@nvidia.com>
 92Description:
 93		This directory represents device directory of mediated
 94		device. It contains all the attributes related to mediated
 95		device.
 96
 97What:           /sys/.../<device>/<UUID>/mdev_type
 98Date:           October 2016
 99Contact:        Kirti Wankhede <kwankhede@nvidia.com>
100Description:
101		This is symbolic link pointing to supported type, <type-id>
102		directory of which this mediated device is created.
103
104What:           /sys/.../<device>/<UUID>/remove
105Date:           October 2016
106Contact:        Kirti Wankhede <kwankhede@nvidia.com>
107Description:
108		Writing '1' to this file destroys the mediated device. The
109		vendor driver can fail the remove() callback if that device
110		is active and the vendor driver doesn't support hot unplug.
111		Example::
112
113		  # echo 1 > /sys/bus/mdev/devices/<UUID>/remove