From patchwork Tue Aug 15 18:57:10 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Andr=C3=A9_Almeida?= X-Patchwork-Id: 136162 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b82d:0:b0:3f2:4152:657d with SMTP id z13csp2085353vqi; Sat, 19 Aug 2023 08:47:30 -0700 (PDT) X-Google-Smtp-Source: AGHT+IFNfrxJ+tQ9ddu8BXkj/mSusLnURNMlhr8CyHhEFgJwCXwrtmz97uTeDPYsVUjky/XyL230 X-Received: by 2002:a17:902:da81:b0:1b8:7e53:704 with SMTP id j1-20020a170902da8100b001b87e530704mr3315609plx.27.1692460049869; Sat, 19 Aug 2023 08:47:29 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1692460049; cv=none; d=google.com; s=arc-20160816; b=LGAXbSpdjj2Iz3/rzJFk+Zsa/yJqCPHVhnPuFxZAdjty7pAtYiYF191m2iM0HIQAmU BmjpUXEvNW356Yjnto0Jp1iBviZAC+a437C8Ap+1p5cLU5QZDrFWAfgOri5Pg46ZkUYV vz/yZ/zzKXROyyFrMruX5ueL+OqvprHaxBNGW6YDFiBX4WqYeiveyogVLy9wPD/PrIcB YNGexLSOKR3Br4zxeQ0AgPptFGeMihDkFm64dA79DBIR5vDGtY1lT4jWRwajK8/ObQL6 VnmyxNUSqM9mKiNCEG1tDxAlcTH52QJ/gLkikYBepOLloMmsr1d8FsAHvo3iaEPwm5SP Ks+g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=lYbxQgfILVH8fA/tTFGSpqiJIGXYZvMVa/QdVn3ynTY=; fh=LjT+njuVizWTSzr6iuglUnPxawOqQbLOR7Ym8u+3GU0=; b=fMw07iF7tZatGqRfYe4gMnfUAbGMUalCPQa1QUTzCjjUYpL9wC0fxUwc2OmG/PSf1q navgSJaJDwXt08KoQKDk2b8xB6ED/6DPo/L2Q4BCmOUKc9nuYFbquNCGN12qPyqhl4cb wLrW9GIHyLM/Ko8XqR1eJbH84WIceCUuMmJW6MYbk4D02QW0a93EobN8PDhREXM5bnly 92l+BW1B0Gi0TiMarsjrANAYvxT00yAHcQwOJEq35hIFcOLVVm06RQ4C0NxmJBkWiqzc 8a3KWaK3otGNeqkrU/VtAfqLNZRaIgc8oC34WndDdZzkOfciOoIkR/eRF9zir8OIkr70 IV3Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@igalia.com header.s=20170329 header.b=MbS0ON8N; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from lindbergh.monkeyblade.net (lindbergh.monkeyblade.net. [2620:137:e000::1:18]) by mx.google.com with ESMTPS id l11-20020a170903120b00b001bba8a9e29dsi3893383plh.100.2023.08.19.08.47.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 19 Aug 2023 08:47:29 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) client-ip=2620:137:e000::1:18; Authentication-Results: mx.google.com; dkim=fail header.i=@igalia.com header.s=20170329 header.b=MbS0ON8N; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id 3DE79F2990; Sat, 19 Aug 2023 01:48:39 -0700 (PDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239703AbjHOS6t (ORCPT + 99 others); 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_Almeida?= 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?b?J01hcmVrIE9sxaHDoWsn?= , Dave Airlie , =?utf-8?q?Michel_D=C3=A4nzer?= , Randy Dunlap , hwentlan@amd.com, joshua@froggi.es, ville.syrjala@linux.intel.com, Pekka Paalanen , =?utf-8?q?Andr=C3=A9_Almeida?= 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 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1774672988792122828 X-GMAIL-MSGID: 1774672988792122828 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é 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. .. kernel-doc:: include/uapi/drm/drm_mode.h :internal: + +KMS atomic state +================ + +An atomic commit can change multiple KMS properties in an atomic fashion, +without ever applying intermediate or partial state changes. Either the whole +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 which is +referred to as the "legacy API". Applying intermediate state could unexpectedly +fail, cause visible glitches, or delay reaching the final state. + +An atomic commit can be flagged with DRM_MODE_ATOMIC_TEST_ONLY, which means 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 configurations +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 state in +the kernel. Hence, the complete new KMS state is the complete old KMS state 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 property +settings. However, not every situation allows for no-op changes, due to the +need to acquire locks for some attributes. Userspace needs to be aware that some +redundant information might result in oversynchronization issues. No-operation +changes do not count towards actually needed changes, e.g. setting MODE_ID 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 temporarily +disrupt the emitted video signal, possibly causing visible glitches on screen. 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 end +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 changes +are ignored as always. Changing any other property will cause the commit to be +rejected.