linux-kernel - [PATCH] drm/amd/display: Fix documentation warning for mpc.h

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20240724175423.18075-1-abhishektamboli9@gmail.com>
Date: Wed, 24 Jul 2024 23:24:23 +0530
From: Abhishek Tamboli <abhishektamboli9@...il.com>
To: airlied@...il.com,
	daniel@...ll.ch,
	harry.wentland@....com,
	sunpeng.li@....com,
	Rodrigo.Siqueira@....com,
	alexander.deucher@....com,
	christian.koenig@....com,
	Xinhui.Pan@....com
Cc: amd-gfx@...ts.freedesktop.org,
	dri-devel@...ts.freedesktop.org,
	linux-kernel@...r.kernel.org,
	skhan@...uxfoundation.org,
	rbmarliere@...il.com,
	marcelomspessoto@...il.com,
	aurabindo.pillai@....com,
	adnelson@....com,
	linux-kernel-mentees@...ts.linuxfoundation.org
Subject: [PATCH] drm/amd/display: Fix documentation warning for mpc.h

Fix documentation compile warning by adding description
for program_3dlut_size function.

Remove the following warning:
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:1043: warning: Function parameter or struct member 'program_3dlut_size' not described in 'mpc_funcs'

Signed-off-by: Abhishek Tamboli <abhishektamboli9@...il.com>
---
 drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
index 40a9b3471208..615c69d966e7 100644
--- a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
+++ b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
@@ -1039,7 +1039,21 @@ struct mpc_funcs {
 	*/
 	void (*program_lut_mode)(struct mpc *mpc, const enum MCM_LUT_ID id, const enum MCM_LUT_XABLE xable,
 			bool lut_bank_a, int mpcc_id);
-	void (*program_3dlut_size)(struct mpc *mpc, bool is_17x17x17, int mpcc_id);
+	/**
+	 * @program_3dlut_size:
+	 *
+	 * Program 3D LUT size.
+	 *
+	 * Parameters:
+	 * - [in/out] mpc - MPC context.
+	 * - [in] is_17x17x17 - Boolean Flag.
+	 * - [in] mpcc_id - MPCC physical instance.
+	 *
+	 * Return:
+	 *
+	 * void
+	 */
+	 void (*program_3dlut_size)(struct mpc *mpc, bool is_17x17x17, int mpcc_id);
 };
 
 #endif
-- 
2.34.1