From nobody Thu Dec 18 07:54:18 2025 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 82872C07E8E for ; Tue, 15 Aug 2023 18:59:03 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239707AbjHOS6t (ORCPT ); Tue, 15 Aug 2023 14:58:49 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59158 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239631AbjHOS6H (ORCPT ); Tue, 15 Aug 2023 14:58:07 -0400 Received: from fanzine2.igalia.com (fanzine2.igalia.com [213.97.179.56]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C56B01FF7 for ; Tue, 15 Aug 2023 11:58:00 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=igalia.com; s=20170329; h=Content-Transfer-Encoding:Content-Type:MIME-Version:References: In-Reply-To:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=lYbxQgfILVH8fA/tTFGSpqiJIGXYZvMVa/QdVn3ynTY=; b=MbS0ON8NVvJUCKFcJY9Pu7irDu pNSLG1yYzPcgi/N+p6PEWW2toQNFlmh9EYo4AfASgK8bdeYJi3tpyBBdJyPPgFbCeRfFnfNxu22Ok C/g3zzS/CROc/NbYC+z0k5+ORIae9Xu3hytcIj79OgyUAma7D4bZvCXwTVBD6SLKbllvmkC4bAZ3G CYBK7CTcbXecZsnwVra+s8Z9hWJCyV0Fknm7VNlvmFiVlH0FIDC3Hn2kLsRVdJueseU+qYeepxPzM OcbUWxg/YE0o5u/eagalUYp1gxAJiacmy5NQd2rxn5DdQ+sgHkZI3hySUGKgQaj+Vo9hHY3QZsU9t HJ9VvmFQ==; Received: from [191.193.179.209] (helo=steammachine.lan) by fanzine2.igalia.com with esmtpsa (Cipher TLS1.3:ECDHE_X25519__RSA_PSS_RSAE_SHA256__AES_256_GCM:256) (Exim) id 1qVzEr-001Ca3-By; Tue, 15 Aug 2023 20:57:57 +0200 From: =?UTF-8?q?Andr=C3=A9=20Almeida?= To: dri-devel@lists.freedesktop.org, amd-gfx@lists.freedesktop.org, linux-kernel@vger.kernel.org, wayland-devel@lists.freedesktop.org Cc: kernel-dev@igalia.com, alexander.deucher@amd.com, christian.koenig@amd.com, pierre-eric.pelloux-prayer@amd.com, Simon Ser , Rob Clark , Pekka Paalanen , Daniel Vetter , Daniel Stone , =?UTF-8?q?=27Marek=20Ol=C5=A1=C3=A1k=27?= , Dave Airlie , =?UTF-8?q?Michel=20D=C3=A4nzer?= , Randy Dunlap , hwentlan@amd.com, joshua@froggi.es, ville.syrjala@linux.intel.com, Pekka Paalanen , =?UTF-8?q?Andr=C3=A9=20Almeida?= Subject: [PATCH v6 6/6] drm/doc: Define KMS atomic state set Date: Tue, 15 Aug 2023 15:57:10 -0300 Message-ID: <20230815185710.159779-7-andrealmeid@igalia.com> X-Mailer: git-send-email 2.41.0 In-Reply-To: <20230815185710.159779-1-andrealmeid@igalia.com> References: <20230815185710.159779-1-andrealmeid@igalia.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org From: Pekka Paalanen Specify how the atomic state is maintained between userspace and kernel, plus the special case for async flips. Signed-off-by: Pekka Paalanen Signed-off-by: Andr=C3=A9 Almeida --- v5: Add note that not every redundant attribute will result in no-op v4: total rework by Pekka --- Documentation/gpu/drm-uapi.rst | 44 ++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/Documentation/gpu/drm-uapi.rst b/Documentation/gpu/drm-uapi.rst index 65fb3036a580..b91ccaddeeb9 100644 --- a/Documentation/gpu/drm-uapi.rst +++ b/Documentation/gpu/drm-uapi.rst @@ -486,3 +486,47 @@ and the CRTC index is its position in this array. =20 .. kernel-doc:: include/uapi/drm/drm_mode.h :internal: + +KMS atomic state +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +An atomic commit can change multiple KMS properties in an atomic fashion, +without ever applying intermediate or partial state changes. Either the w= hole +commit succeeds or fails, and it will never be applied partially. This is = the +fundamental improvement of the atomic API over the older non-atomic API wh= ich is +referred to as the "legacy API". Applying intermediate state could unexpe= ctedly +fail, cause visible glitches, or delay reaching the final state. + +An atomic commit can be flagged with DRM_MODE_ATOMIC_TEST_ONLY, which mean= s the +complete state change is validated but not applied. Userspace should use = this +flag to validate any state change before asking to apply it. If validation= fails +for any reason, userspace should attempt to fall back to another, perhaps +simpler, final state. This allows userspace to probe for various configur= ations +without causing visible glitches on screen and without the need to undo a +probing change. + +The changes recorded in an atomic commit apply on top the current KMS stat= e in +the kernel. Hence, the complete new KMS state is the complete old KMS stat= e with +the committed property settings done on top. The kernel will try to avoid +no-operation changes, so it is safe for userspace to send redundant proper= ty +settings. However, not every situation allows for no-op changes, due to t= he +need to acquire locks for some attributes. Userspace needs to be aware tha= t some +redundant information might result in oversynchronization issues. No-oper= ation +changes do not count towards actually needed changes, e.g. setting MODE_I= D to a +different blob with identical contents as the current KMS state shall not = be a +modeset on its own. + +A "modeset" is a change in KMS state that might enable, disable, or tempor= arily +disrupt the emitted video signal, possibly causing visible glitches on scr= een. A +modeset may also take considerably more time to complete than other kinds = of +changes, and the video sink might also need time to adapt to the new signal +properties. Therefore a modeset must be explicitly allowed with the flag +DRM_MODE_ATOMIC_ALLOW_MODESET. This in combination with +DRM_MODE_ATOMIC_TEST_ONLY allows userspace to determine if a state change = is +likely to cause visible disruption on screen and avoid such changes when e= nd +users do not expect them. + +An atomic commit with the flag DRM_MODE_PAGE_FLIP_ASYNC is allowed to +effectively change only the FB_ID property on any planes. No-operation cha= nges +are ignored as always. Changing any other property will cause the commit t= o be +rejected. --=20 2.41.0