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