0001 What: /sys/.../<device>/mdev_supported_types/
0002 Date: October 2016
0003 Contact: Kirti Wankhede <kwankhede@nvidia.com>
0004 Description:
0005 This directory contains list of directories of currently
0006 supported mediated device types and their details for
0007 <device>. Supported type attributes are defined by the
0008 vendor driver who registers with Mediated device framework.
0009 Each supported type is a directory whose name is created
0010 by adding the device driver string as a prefix to the
0011 string provided by the vendor driver.
0012
0013 What: /sys/.../<device>/mdev_supported_types/<type-id>/
0014 Date: October 2016
0015 Contact: Kirti Wankhede <kwankhede@nvidia.com>
0016 Description:
0017 This directory gives details of supported type, like name,
0018 description, available_instances, device_api etc.
0019 'device_api' and 'available_instances' are mandatory
0020 attributes to be provided by vendor driver. 'name',
0021 'description' and other vendor driver specific attributes
0022 are optional.
0023
0024 What: /sys/.../mdev_supported_types/<type-id>/create
0025 Date: October 2016
0026 Contact: Kirti Wankhede <kwankhede@nvidia.com>
0027 Description:
0028 Writing UUID to this file will create mediated device of
0029 type <type-id> for parent device <device>. This is a
0030 write-only file.
0031 For example::
0032
0033 # echo "83b8f4f2-509f-382f-3c1e-e6bfe0fa1001" > \
0034 /sys/devices/foo/mdev_supported_types/foo-1/create
0035
0036 What: /sys/.../mdev_supported_types/<type-id>/devices/
0037 Date: October 2016
0038 Contact: Kirti Wankhede <kwankhede@nvidia.com>
0039 Description:
0040 This directory contains symbolic links pointing to mdev
0041 devices sysfs entries which are created of this <type-id>.
0042
0043 What: /sys/.../mdev_supported_types/<type-id>/available_instances
0044 Date: October 2016
0045 Contact: Kirti Wankhede <kwankhede@nvidia.com>
0046 Description:
0047 Reading this attribute will show the number of mediated
0048 devices of type <type-id> that can be created. This is a
0049 readonly file.
0050 Users:
0051 Userspace applications interested in creating mediated
0052 device of that type. Userspace application should check
0053 the number of available instances could be created before
0054 creating mediated device of this type.
0055
0056 What: /sys/.../mdev_supported_types/<type-id>/device_api
0057 Date: October 2016
0058 Contact: Kirti Wankhede <kwankhede@nvidia.com>
0059 Description:
0060 Reading this attribute will show VFIO device API supported
0061 by this type. For example, "vfio-pci" for a PCI device,
0062 "vfio-platform" for platform device.
0063
0064 What: /sys/.../mdev_supported_types/<type-id>/name
0065 Date: October 2016
0066 Contact: Kirti Wankhede <kwankhede@nvidia.com>
0067 Description:
0068 Reading this attribute will show human readable name of the
0069 mediated device that will get created of type <type-id>.
0070 This is optional attribute. For example: "Grid M60-0Q"
0071 Users:
0072 Userspace applications interested in knowing the name of
0073 a particular <type-id> that can help in understanding the
0074 type of mediated device.
0075
0076 What: /sys/.../mdev_supported_types/<type-id>/description
0077 Date: October 2016
0078 Contact: Kirti Wankhede <kwankhede@nvidia.com>
0079 Description:
0080 Reading this attribute will show description of the type of
0081 mediated device that will get created of type <type-id>.
0082 This is optional attribute. For example:
0083 "2 heads, 512M FB, 2560x1600 maximum resolution"
0084 Users:
0085 Userspace applications interested in knowing the details of
0086 a particular <type-id> that can help in understanding the
0087 features provided by that type of mediated device.
0088
0089 What: /sys/.../<device>/<UUID>/
0090 Date: October 2016
0091 Contact: Kirti Wankhede <kwankhede@nvidia.com>
0092 Description:
0093 This directory represents device directory of mediated
0094 device. It contains all the attributes related to mediated
0095 device.
0096
0097 What: /sys/.../<device>/<UUID>/mdev_type
0098 Date: October 2016
0099 Contact: Kirti Wankhede <kwankhede@nvidia.com>
0100 Description:
0101 This is symbolic link pointing to supported type, <type-id>
0102 directory of which this mediated device is created.
0103
0104 What: /sys/.../<device>/<UUID>/remove
0105 Date: October 2016
0106 Contact: Kirti Wankhede <kwankhede@nvidia.com>
0107 Description:
0108 Writing '1' to this file destroys the mediated device. The
0109 vendor driver can fail the remove() callback if that device
0110 is active and the vendor driver doesn't support hot unplug.
0111 Example::
0112
0113 # echo 1 > /sys/bus/mdev/devices/<UUID>/remove
