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