[PATCH v3 01/33] Documentation: ABI: vkms: Add current VKMS ABI documentation

Louis Chauvet
2025-12-22T10:11:16Z

VKMS recently introduced a ConfigFS API to configure new devices.
Add proper ABI documentation.

Signed-off-by: Louis Chauvet <louis.chauvet@bootlin.com>
---
Documentation/ABI/testing/configfs-vkms | 118 ++++++++++++++++++++++++++++++++
1 file changed, 118 insertions(+)

diff --git a/Documentation/ABI/testing/configfs-vkms b/Documentation/ABI/testing/configfs-vkms
new file mode 100644
index 000000000000..0beaa25f30ba
--- /dev/null
+++ b/Documentation/ABI/testing/configfs-vkms
@@ -0,0 +1,118 @@
+What: /sys/kernel/config/vkms/
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ This group contains sub-groups corresponding to created
+ VKMS devices.
+
+What: /sys/kernel/config/vkms/<device>
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ This group contains sub-groups corresponding to the VKMS
+ device <device>.
+
+What: /sys/kernel/config/vkms/<device>/connectors
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ This group contains sub-groups corresponding to the
+ connectors of the VKMS device <device>.
+
+What: /sys/kernel/config/vkms/<device>/connectors/<connector>
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ This group contains attributes corresponding to the
+ connector <connector> of the VKMS device <device>.
+
+What: /sys/kernel/config/vkms/<device>/connectors/<connector>/status
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ Connection status of the connector. Possible values:
+ 1 - connected, 2 - disconnected, 3 - unknown.
+
+What: /sys/kernel/config/vkms/<device>/connectors/<connector>/possible_encoders
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ This group contains symbolic links to possible encoders
+ for this connector.
+
+What: /sys/kernel/config/vkms/<device>/crtcs
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ This group contains sub-groups corresponding to the
+ CRTCs of the VKMS device <device>.
+
+What: /sys/kernel/config/vkms/<device>/crtcs/<crtc>
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ This group contains attributes corresponding to the
+ CRTC <crtc> of the VKMS device <device>.
+
+What: /sys/kernel/config/vkms/<device>/crtcs/<crtc>/writeback
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ Enable or disable writeback connector support for this
+ CRTC. Value: 1 - enabled, 0 - disabled.
+
+What: /sys/kernel/config/vkms/<device>/encoders
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ This group contains sub-groups corresponding to the
+ encoders of the VKMS device <device>.
+
+What: /sys/kernel/config/vkms/<device>/encoders/<encoder>
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ This group contains attributes corresponding to the
+ encoder <encoder> of the VKMS device <device>.
+
+What: /sys/kernel/config/vkms/<device>/encoders/<encoder>/possible_crtcs
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ This group contains symbolic links to possible CRTCs
+ for this encoder.
+
+What: /sys/kernel/config/vkms/<device>/planes
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ This group contains sub-groups corresponding to the
+ planes of the VKMS device <device>.
+
+What: /sys/kernel/config/vkms/<device>/planes/<plane>
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ This group contains attributes corresponding to the
+ plane <plane> of the VKMS device <device>.
+
+What: /sys/kernel/config/vkms/<device>/planes/<plane>/type
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ Plane type. Possible values: 0 - overlay, 1 - primary,
+ 2 - cursor.
+
+What: /sys/kernel/config/vkms/<device>/planes/<plane>/possible_crtcs
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ This group contains symbolic links to possible CRTCs
+ for this plane.
+
+What: /sys/kernel/config/vkms/<device>/enabled
+Date: Nov 2025
+Contact: dri-devel@lists.freedesktop.org
+Description:
+ Enable or disable the VKMS device. Value: 1 - enabled,
+ 0 - disabled.

--
2.51.2