From mboxrd@z Thu Jan 1 00:00:00 1970 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 D76C9C4167B for ; Tue, 5 Dec 2023 13:42:51 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 2446210E25B; Tue, 5 Dec 2023 13:42:51 +0000 (UTC) Received: from out-171.mta0.migadu.com (out-171.mta0.migadu.com [IPv6:2001:41d0:1004:224b::ab]) by gabe.freedesktop.org (Postfix) with ESMTPS id EB10F10E25B for ; Tue, 5 Dec 2023 13:42:48 +0000 (UTC) Message-ID: DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.dev; s=key1; t=1701783766; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=cbzJBuElDKHNwvMjlj7Qe9OKIqKVQdUCGjkp+yl3S0o=; b=k9Dy59XpjUWeLZIPnetcnZCIFoVIfb5omATiy7w001g7TgHl6uJrdG1F38uAtTtz8LXNPd PcewreqG+kut2G1icOI2Ob2gOlFxIjXmC6cQYa4/2iY4qvAREXiZKLXyOH76V2MRv4YdVy tcBn6xe122E+9+SPRh2PqY1Zfs9V6DE= Date: Tue, 5 Dec 2023 21:42:40 +0800 MIME-Version: 1.0 Subject: Re: [1/5] drm/atomic: Move the drm_atomic_state field doc inline Content-Language: en-US To: Maxime Ripard , Daniel Vetter , David Airlie , Maarten Lankhorst , Thomas Zimmermann References: <20231204121707.3647961-1-mripard@kernel.org> X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. From: Sui Jingfeng In-Reply-To: <20231204121707.3647961-1-mripard@kernel.org> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-Migadu-Flow: FLOW_OUT 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" Hi, On 2023/12/4 20:17, Maxime Ripard wrote: > Some fields of drm_atomic_state have been documented in-line, but some > were documented in the main kerneldoc block before the structure. > > Since the former is the preferred option in DRM, let's move all the > fields to an inline documentation. > > Signed-off-by: Maxime Ripard Acked-by: Sui Jingfeng Very nice cleanup, but I see a very very tiny concern, see below. > --- > include/drm/drm_atomic.h | 50 ++++++++++++++++++++++++++++++++-------- > 1 file changed, 40 insertions(+), 10 deletions(-) > > diff --git a/include/drm/drm_atomic.h b/include/drm/drm_atomic.h > index cf8e1220a4ac..2a08030fcd75 100644 > --- a/include/drm/drm_atomic.h > +++ b/include/drm/drm_atomic.h > @@ -347,24 +347,22 @@ struct __drm_private_objs_state { > > /** > * struct drm_atomic_state - the global state object for atomic updates > - * @ref: count of all references to this state (will not be freed until zero) > - * @dev: parent DRM device > - * @async_update: hint for asynchronous plane update > - * @planes: pointer to array of structures with per-plane data > - * @crtcs: pointer to array of CRTC pointers > - * @num_connector: size of the @connectors and @connector_states arrays > - * @connectors: pointer to array of structures with per-connector data > - * @num_private_objs: size of the @private_objs array > - * @private_objs: pointer to array of private object pointers > - * @acquire_ctx: acquire context for this atomic modeset state update > * > * States are added to an atomic update by calling drm_atomic_get_crtc_state(), > * drm_atomic_get_plane_state(), drm_atomic_get_connector_state(), or for > * private state structures, drm_atomic_get_private_obj_state(). > */ > struct drm_atomic_state { > + /** > + * @ref: > + * > + * Count of all references to this update (will not be freed until zero). > + */ > struct kref ref; > > + /** > + * @dev: Parent DRM Device. > + */ Well, I noticed that the first letter of 'Parent' get capitalized. Do we also need capitalize the reset of documentation to keep consistent? > struct drm_device *dev; > > /** > @@ -388,7 +386,12 @@ struct drm_atomic_state { > * flag are not allowed. > */ > bool legacy_cursor_update : 1; > + > + /** > + * @async_update: hint for asynchronous plane update > + */ > bool async_update : 1; > + > /** > * @duplicated: > * > @@ -398,13 +401,40 @@ struct drm_atomic_state { > * states. > */ > bool duplicated : 1; > + > + /** > + * @planes: pointer to array of structures with per-plane data > + */ > struct __drm_planes_state *planes; > + > + /** > + * @crtcs: pointer to array of CRTC pointers > + */ > struct __drm_crtcs_state *crtcs; > + > + /** > + * @num_connector: size of the @connectors and @connector_states arrays > + */ > int num_connector; > + > + /** > + * @connectors: pointer to array of structures with per-connector data > + */ > struct __drm_connnectors_state *connectors; > + > + /** > + * @num_private_objs: size of the @private_objs array > + */ > int num_private_objs; > + > + /** > + * @private_objs: pointer to array of private object pointers > + */ > struct __drm_private_objs_state *private_objs; > > + /** > + * @acquire_ctx: acquire context for this atomic modeset state update > + */ > struct drm_modeset_acquire_ctx *acquire_ctx; > > /**