From patchwork Thu May 16 00:26:52 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13665614 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 3F5D0C25B75 for ; Thu, 16 May 2024 00:26:56 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 2326310E31F; Thu, 16 May 2024 00:26:55 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=fail reason="signature verification failed" (2048-bit key; secure) header.d=infradead.org header.i=@infradead.org header.b="f1pUyeJj"; dkim-atps=neutral Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) by gabe.freedesktop.org (Postfix) with ESMTPS id 6FE7D10E31F for ; Thu, 16 May 2024 00:26:53 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=FEW5zQ+hFPy/mi8dp5190371bnzWd+5sgKI+/QgL0ew=; b=f1pUyeJj5GE3RZNc3HPEN/ZQRL ViRVKB0d2tKy9s4vccrYzgUral2xS9MSAWEwzBBQb5dLANG4cO73g0e+osAw0WQ3pIRjMKspxVXDR WFB61uRJmJdRuX6YICXtzD+DV72HgWngf0685fzGR7cfzmlkTdg6B10TJiKrZR/Pqwwe7+uQ/BjZB XFjSDQ6vnC5XfRyZoaZXvEZDf7lHW6hLbPA4ywHaaLObGou6gHtTKu0LqyhyksWRZ9VS//qdGerNR B/pSoKhwrgEITMQgIJXaU43eBQcsYLQxcRFRbL/1VbJbbgY+Apyw9oNbzhJG800Pgt/2AGA6LDwav TpjoF6ZA==; Received: from [50.53.4.147] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.97.1 #2 (Red Hat Linux)) id 1s7OxQ-00000003Fxa-3mhw; Thu, 16 May 2024 00:26:53 +0000 From: Randy Dunlap To: dri-devel@lists.freedesktop.org Cc: Randy Dunlap , David Airlie , Daniel Vetter , Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann Subject: [PATCH] drm/mode: fix all kernel-doc warnings Date: Wed, 15 May 2024 17:26:52 -0700 Message-ID: <20240516002652.6674-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.45.0 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: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" Add @width and @height descriptions for &struct drm_plane_size_hint along with a reference to more info. Add a short description for &struct drm_mode_closefb. Change 7 macros not to be marked as kernel-doc notation to prevent warnings. Fixes these kernel-doc warnings: drm_mode.h:877: warning: Function parameter or struct member 'width' not described in 'drm_plane_size_hint' drm_mode.h:877: warning: Function parameter or struct member 'height' not described in 'drm_plane_size_hint' drm_mode.h:969: warning: missing initial short description on line: * DRM_MODE_PAGE_FLIP_EVENT drm_mode.h:977: warning: missing initial short description on line: * DRM_MODE_PAGE_FLIP_ASYNC drm_mode.h:998: warning: missing initial short description on line: * DRM_MODE_PAGE_FLIP_FLAGS drm_mode.h:1108: warning: missing initial short description on line: * DRM_MODE_ATOMIC_TEST_ONLY drm_mode.h:1118: warning: missing initial short description on line: * DRM_MODE_ATOMIC_NONBLOCK drm_mode.h:1127: warning: missing initial short description on line: * DRM_MODE_ATOMIC_ALLOW_MODESET drm_mode.h:1149: warning: missing initial short description on line: * DRM_MODE_ATOMIC_FLAGS drm_mode.h:1358: warning: missing initial short description on line: * struct drm_mode_closefb Signed-off-by: Randy Dunlap --- Cc: David Airlie Cc: Daniel Vetter Cc: dri-devel@lists.freedesktop.org Cc: Maarten Lankhorst Cc: Maxime Ripard Cc: Thomas Zimmermann include/uapi/drm/drm_mode.h | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff -- a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h --- a/include/uapi/drm/drm_mode.h +++ b/include/uapi/drm/drm_mode.h @@ -867,9 +867,12 @@ struct drm_color_lut { /** * struct drm_plane_size_hint - Plane size hints + * @width: recommended plane width (no scaling) + * @height: recommended plane height (no scaling) * * The plane SIZE_HINTS property blob contains an - * array of struct drm_plane_size_hint. + * array of struct drm_plane_size_hint as described in + * "DOC: standard plane properties". */ struct drm_plane_size_hint { __u16 width; @@ -962,7 +965,7 @@ struct hdr_output_metadata { }; }; -/** +/* * DRM_MODE_PAGE_FLIP_EVENT * * Request that the kernel sends back a vblank event (see @@ -970,7 +973,7 @@ struct hdr_output_metadata { * page-flip is done. */ #define DRM_MODE_PAGE_FLIP_EVENT 0x01 -/** +/* * DRM_MODE_PAGE_FLIP_ASYNC * * Request that the page-flip is performed as soon as possible, ie. with no @@ -991,7 +994,7 @@ struct hdr_output_metadata { #define DRM_MODE_PAGE_FLIP_TARGET_RELATIVE 0x8 #define DRM_MODE_PAGE_FLIP_TARGET (DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE | \ DRM_MODE_PAGE_FLIP_TARGET_RELATIVE) -/** +/* * DRM_MODE_PAGE_FLIP_FLAGS * * Bitmask of flags suitable for &drm_mode_crtc_page_flip_target.flags. @@ -1101,7 +1104,7 @@ struct drm_mode_destroy_dumb { __u32 handle; }; -/** +/* * DRM_MODE_ATOMIC_TEST_ONLY * * Do not apply the atomic commit, instead check whether the hardware supports @@ -1111,7 +1114,7 @@ struct drm_mode_destroy_dumb { * commits. */ #define DRM_MODE_ATOMIC_TEST_ONLY 0x0100 -/** +/* * DRM_MODE_ATOMIC_NONBLOCK * * Do not block while applying the atomic commit. The &DRM_IOCTL_MODE_ATOMIC @@ -1120,7 +1123,7 @@ struct drm_mode_destroy_dumb { * applied before retuning. */ #define DRM_MODE_ATOMIC_NONBLOCK 0x0200 -/** +/* * DRM_MODE_ATOMIC_ALLOW_MODESET * * Allow the update to result in temporary or transient visible artifacts while @@ -1142,7 +1145,7 @@ struct drm_mode_destroy_dumb { */ #define DRM_MODE_ATOMIC_ALLOW_MODESET 0x0400 -/** +/* * DRM_MODE_ATOMIC_FLAGS * * Bitfield of flags accepted by the &DRM_IOCTL_MODE_ATOMIC IOCTL in @@ -1352,7 +1355,7 @@ struct drm_mode_rect { }; /** - * struct drm_mode_closefb + * struct drm_mode_closefb - ioctl struct to close a framebuffer * @fb_id: Framebuffer ID. * @pad: Must be zero. */