public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Louis Chauvet <louis.chauvet@bootlin.com>
To: Haneen Mohammed <hamohammed.sa@gmail.com>,
	 Simona Vetter <simona@ffwll.ch>,
	Melissa Wen <melissa.srw@gmail.com>,
	 Maarten Lankhorst <maarten.lankhorst@linux.intel.com>,
	 Maxime Ripard <mripard@kernel.org>,
	Thomas Zimmermann <tzimmermann@suse.de>,
	 David Airlie <airlied@gmail.com>,
	jose.exposito89@gmail.com,  Jonathan Corbet <corbet@lwn.net>,
	Shuah Khan <skhan@linuxfoundation.org>,
	 Miguel Ojeda <ojeda@kernel.org>,
	Nathan Chancellor <nathan@kernel.org>,
	 Nick Desaulniers <nick.desaulniers+lkml@gmail.com>,
	 Bill Wendling <morbo@google.com>,
	Justin Stitt <justinstitt@google.com>
Cc: victoria@system76.com, sebastian.wick@redhat.com,
	victoria@system76.com,  airlied@gmail.com,
	thomas.petazzoni@bootlin.com,  dri-devel@lists.freedesktop.org,
	linux-kernel@vger.kernel.org,  linux-doc@vger.kernel.org,
	Louis Chauvet <louis.chauvet@bootlin.com>,
	 llvm@lists.linux.dev
Subject: [PATCH v4 07/37] Documentation: ABI: vkms: Add current VKMS ABI documentation
Date: Wed, 22 Apr 2026 18:48:04 +0200	[thread overview]
Message-ID: <20260422-vkms-all-config-v4-7-dbb52e9aadc3@bootlin.com> (raw)
In-Reply-To: <20260422-vkms-all-config-v4-0-dbb52e9aadc3@bootlin.com>

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..a1a3e186e50a
--- /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.54.0


  parent reply	other threads:[~2026-04-22 16:49 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-22 16:47 [PATCH v4 00/37] VKMS: Introduce multiple configFS attributes Louis Chauvet
2026-04-22 16:47 ` [PATCH v4 01/37] drm/drm_mode_config: Add helper to get plane type name Louis Chauvet
2026-04-22 16:47 ` [PATCH v4 02/37] drm/blend: Get a rotation name from it's bitfield Louis Chauvet
2026-04-22 16:52   ` Ville Syrjälä
2026-04-22 16:48 ` [PATCH v4 03/37] drm/drm_color_mgmt: Expose drm_get_color_encoding_name Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 04/37] drm/drm_color_mgmt: Expose drm_get_color_range_name Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 05/37] drm/connector: Export drm_get_colorspace_name Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 06/37] drm/drm_atomic_state_helper: Properly load default value for rotation Louis Chauvet
2026-04-22 16:48 ` Louis Chauvet [this message]
2026-04-22 16:48 ` [PATCH v4 08/37] drm/vkms: Add error handling in plane config creation Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 09/37] drm/vkms: Simplify plane_release code Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 10/37] drm/vkms: Explicitly display plane type Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 11/37] drm/vkms: Use enabled/disabled instead of 1/0 for debug Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 12/37] drm/vkms: Explicitly display connector status Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 13/37] drm/vkms: Introduce config for plane name Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 14/37] drm/vkms: Introduce configfs " Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 15/37] drm/vkms: Introduce config for plane rotation Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 16/37] drm/vkms: Introduce configfs " Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 17/37] drm/vkms: Introduce config for plane color encoding Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 18/37] drm/vkms: Introduce configfs " Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 19/37] drm/vkms: Introduce config for plane color range Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 20/37] drm/vkms: Introduce configfs " Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 21/37] drm/vkms: Introduce config for plane format Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 22/37] drm/vkms: Introduce configfs " Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 23/37] drm/vkms: Properly render plane using their zpos Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 24/37] drm/vkms: Introduce config for plane zpos property Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 25/37] drm/vkms: Introduce configfs " Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 26/37] drm/vkms: Introduce config for connector type Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 27/37] drm/vkms: Introduce configfs " Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 28/37] drm/vkms: Rename vkms_connector_init to vkms_connector_init_static Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 29/37] drm/vkms: Introduce config for connector supported colorspace Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 30/37] drm/vkms: Introduce configfs " Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 31/37] drm/vkms: Introduce config for connector EDID Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 32/37] drm/vkms: Introduce configfs " Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 33/37] drm/vkms: Store the enabled/disabled status for connector Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 34/37] drm/vkms: Allow to hot-add connectors Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 35/37] drm/vkms: Introduce configfs for dynamic connector creation Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 36/37] drm/vkms: Add connector parent configuration in vkms_config Louis Chauvet
2026-04-22 16:48 ` [PATCH v4 37/37] drm/vkms: Add ConfigFS interface for connector parent and port_id Louis Chauvet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260422-vkms-all-config-v4-7-dbb52e9aadc3@bootlin.com \
    --to=louis.chauvet@bootlin.com \
    --cc=airlied@gmail.com \
    --cc=corbet@lwn.net \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=hamohammed.sa@gmail.com \
    --cc=jose.exposito89@gmail.com \
    --cc=justinstitt@google.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=llvm@lists.linux.dev \
    --cc=maarten.lankhorst@linux.intel.com \
    --cc=melissa.srw@gmail.com \
    --cc=morbo@google.com \
    --cc=mripard@kernel.org \
    --cc=nathan@kernel.org \
    --cc=nick.desaulniers+lkml@gmail.com \
    --cc=ojeda@kernel.org \
    --cc=sebastian.wick@redhat.com \
    --cc=simona@ffwll.ch \
    --cc=skhan@linuxfoundation.org \
    --cc=thomas.petazzoni@bootlin.com \
    --cc=tzimmermann@suse.de \
    --cc=victoria@system76.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox