mirror of https://lore.kernel.org/lkml/
 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>,
	"Oarora Etimis" <oaroraetimis@gmail.com>,
	"Harry Wentland" <harry.wentland@amd.com>,
	"Lucas De Marchi" <demarchi@kernel.org>,
	"Ville Syrjälä" <ville.syrjala@linux.intel.com>,
	"Randy Dunlap" <rdunlap@infradead.org>,
	"Nick Desaulniers" <ndesaulniers@google.com>,
	"Louis Chauvet" <louis.chauvet@bootlin.com>,
	"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: Luca Ceresoli <luca.ceresoli@bootlin.com>,
	 Kory Maincent <kory.maincent@bootlin.com>,
	sebastian.wick@redhat.com,  victoria@system76.com,
	thomas.petazzoni@bootlin.com,  dri-devel@lists.freedesktop.org,
	linux-kernel@vger.kernel.org,  linux-doc@vger.kernel.org,
	Simona Vetter <simona.vetter@ffwll.ch>,
	 llvm@lists.linux.dev
Subject: [PATCH v6 11/43] Documentation: ABI: vkms: Add current VKMS ABI documentation
Date: Fri, 20 Nov 2026 18:58:53 +0100	[thread overview]
Message-ID: <20261120-vkms-all-config-v6-11-78ace90f4fc1@bootlin.com> (raw)
In-Reply-To: <20261120-vkms-all-config-v6-0-78ace90f4fc1@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 | 123 ++++++++++++++++++++++++++++++++
 1 file changed, 123 insertions(+)

diff --git a/Documentation/ABI/testing/configfs-vkms b/Documentation/ABI/testing/configfs-vkms
new file mode 100644
index 000000000000..26e7f81b5b7d
--- /dev/null
+++ b/Documentation/ABI/testing/configfs-vkms
@@ -0,0 +1,123 @@
+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. Creating a device named "vkms" fails with
+	-EINVAL: that name is reserved for the default device
+	created by the create_default_dev module parameter.
+
+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. Changing
+	the status triggers a connector hotplug if the device is
+	enabled.
+
+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. Enabling validates the device configuration
+	and fails with -EINVAL if it is invalid.

-- 
2.56.0


  parent reply	other threads:[~2026-11-20 18:03 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-20 17:58 [PATCH v6 00/43] VKMS: Introduce multiple configFS attributes Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 01/43] drm/vkms: Explicitly display connector status Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 02/43] drm/vkms: Lock the config dump against concurrent configfs changes Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 03/43] drm/vkms: Add new lines for configfs attributes Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 04/43] drm/drm_mode_config: Add helper to get plane type name Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 05/43] drm/blend: Get a rotation name from its bitfield Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 06/43] drm/tests: Add test cases for DRM rotation name Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 07/43] drm/drm_color_mgmt: Expose drm_get_color_encoding_name Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 08/43] drm/drm_color_mgmt: Expose drm_get_color_range_name Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 09/43] drm/connector: Export drm_get_colorspace_name Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 10/43] drm/drm_atomic_state_helper: Properly load default value for rotation Louis Chauvet
2026-11-20 17:58 ` Louis Chauvet [this message]
2026-11-20 17:58 ` [PATCH v6 12/43] drm/vkms: Reference-count vkms_config and vkms_config_connector Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 13/43] drm/vkms: Add KUnit test for device lifecycle Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 14/43] drm/vkms: Add error handling in plane config creation Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 15/43] drm/vkms: Simplify plane_release code Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 16/43] drm/vkms: Explicitly display plane type Louis Chauvet
2026-11-20 17:58 ` [PATCH v6 17/43] drm/vkms: Use enabled/disabled instead of 1/0 for debug Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 18/43] drm/vkms: Introduce config for plane name Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 19/43] drm/vkms: Use plane folder name as " Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 20/43] drm/vkms: Introduce config for plane rotation Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 21/43] drm/vkms: Introduce configfs " Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 22/43] drm/vkms: Introduce config for plane color encoding Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 23/43] drm/vkms: Introduce configfs " Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 24/43] drm/vkms: Introduce config for plane color range Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 25/43] drm/vkms: Introduce configfs " Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 26/43] drm/vkms: Introduce config for plane format Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 27/43] drm/vkms: Introduce configfs " Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 28/43] drm/vkms: Properly render plane using their zpos Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 29/43] drm/vkms: Introduce config for plane zpos property Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 30/43] drm/vkms: Introduce configfs " Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 31/43] drm/vkms: Introduce back pointer to connector Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 32/43] drm/vkms: Introduce connector type Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 33/43] drm/vkms: Introduce configfs for " Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 34/43] drm/vkms: Rename vkms_connector_init to vkms_connector_init_static Louis Chauvet
2026-11-20 17:59 ` [PATCH v6 35/43] drm/vkms: Introduce config for connector supported colorspace 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=20261120-vkms-all-config-v6-11-78ace90f4fc1@bootlin.com \
    --to=louis.chauvet@bootlin.com \
    --cc=airlied@gmail.com \
    --cc=corbet@lwn.net \
    --cc=demarchi@kernel.org \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=hamohammed.sa@gmail.com \
    --cc=harry.wentland@amd.com \
    --cc=jose.exposito89@gmail.com \
    --cc=justinstitt@google.com \
    --cc=kory.maincent@bootlin.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=llvm@lists.linux.dev \
    --cc=luca.ceresoli@bootlin.com \
    --cc=maarten.lankhorst@linux.intel.com \
    --cc=melissa.srw@gmail.com \
    --cc=morbo@google.com \
    --cc=mripard@kernel.org \
    --cc=nathan@kernel.org \
    --cc=ndesaulniers@google.com \
    --cc=nick.desaulniers+lkml@gmail.com \
    --cc=oaroraetimis@gmail.com \
    --cc=ojeda@kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=sebastian.wick@redhat.com \
    --cc=simona.vetter@ffwll.ch \
    --cc=simona@ffwll.ch \
    --cc=skhan@linuxfoundation.org \
    --cc=thomas.petazzoni@bootlin.com \
    --cc=tzimmermann@suse.de \
    --cc=victoria@system76.com \
    --cc=ville.syrjala@linux.intel.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

all inboxes | Powered by JetHome®