From patchwork Thu Dec 14 10:09:16 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Maxime Ripard X-Patchwork-Id: 13492700 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 gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id DA734C4167B for ; Thu, 14 Dec 2023 10:09:47 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 138D010E906; Thu, 14 Dec 2023 10:09:47 +0000 (UTC) Received: from dfw.source.kernel.org (dfw.source.kernel.org [IPv6:2604:1380:4641:c500::1]) by gabe.freedesktop.org (Postfix) with ESMTPS id C515F10E906 for ; Thu, 14 Dec 2023 10:09:33 +0000 (UTC) Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id 1922E6216A; Thu, 14 Dec 2023 10:09:33 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 69114C433C7; Thu, 14 Dec 2023 10:09:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1702548572; bh=sj83K/4JenSCs5c0jZW5byPMqZx5MToX9bHZtccVSfU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=X5gtxfxYXKYydFks9OeLo6P5GxcARPpatR86VYI94yIYRwJdpaviZ3/dvu2eHDIx/ VUCkWdO0n0EZECaOLGnPgSM1JgSIBSfdwTz0iJWJlAslSbtk7yexUy0H4mjRTsgPKC BeROysdCui/NoI+LyG0QkVqoRtgPMFsF30j3ZxImiv64H+Axo+O16W3DYTHFTtpt0G vxM2MTouohUqYgTIgJej3wPxJOm0okSt9yFXt+KWUEpYxYXSBWwkgIuBNQmVJEqDCo VBRMF8PA9y9iBt8nxluqRWTXQvkRQOW16QIcoznID140ehWM5PvAkt5vZ5k2z16AjP odm+C7vOVyqGg== From: Maxime Ripard To: Daniel Vetter , David Airlie , Maarten Lankhorst , Thomas Zimmermann , Maxime Ripard Subject: [PATCH v2 5/5] drm/todo: Add entry to rename drm_atomic_state Date: Thu, 14 Dec 2023 11:09:16 +0100 Message-ID: <20231214100917.277842-5-mripard@kernel.org> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20231214100917.277842-1-mripard@kernel.org> References: <20231214100917.277842-1-mripard@kernel.org> MIME-Version: 1.0 X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Pekka Paalanen , dri-devel@lists.freedesktop.org Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" The name of the structure drm_atomic_state is confusing. Let's add an entry to our todo list to rename it. Reviewed-by: Daniel Vetter Signed-off-by: Maxime Ripard --- Documentation/gpu/todo.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/Documentation/gpu/todo.rst b/Documentation/gpu/todo.rst index 41a264bf84ce..fb9ad120b141 100644 --- a/Documentation/gpu/todo.rst +++ b/Documentation/gpu/todo.rst @@ -120,6 +120,29 @@ Contact: Daniel Vetter, respective driver maintainers Level: Advanced +Rename drm_atomic_state +----------------------- + +The KMS framework uses two slightly different definitions for the ``state`` +concept. For a given object (plane, CRTC, encoder, etc., so +``drm_$OBJECT_state``), the state is the entire state of that object. However, +at the device level, ``drm_atomic_state`` refers to a state update for a +limited number of objects. + +The state isn't the entire device state, but only the full state of some +objects in that device. This is confusing to newcomers, and +``drm_atomic_state`` should be renamed to something clearer like +``drm_atomic_commit``. + +In addition to renaming the structure itself, it would also imply renaming some +related functions (``drm_atomic_state_alloc``, ``drm_atomic_state_get``, +``drm_atomic_state_put``, ``drm_atomic_state_init``, +``__drm_atomic_state_free``, etc.). + +Contact: Maxime Ripard + +Level: Advanced + Fallout from atomic KMS -----------------------