drm/amd/display: Fix documentation warning for mpc.h

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

Posted by Abhishek Tamboli 1 year, 4 months ago

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@gmail.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

Re: [PATCH] drm/amd/display: Fix documentation warning for mpc.h

Posted by Ricardo B. Marliere 1 year, 4 months ago

On 24 Jul 24 23:24, Abhishek Tamboli wrote:
> 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@gmail.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
> +	 */

Reviewed-by: Ricardo B. Marliere <ricardo@marliere.net>


> +	 void (*program_3dlut_size)(struct mpc *mpc, bool is_17x17x17, int mpcc_id);
>  };
>  
>  #endif
> -- 
> 2.34.1
>

Re: [PATCH] drm/amd/display: Fix documentation warning for mpc.h

Posted by Alex Deucher 1 year, 4 months ago

This is already fixed in:
https://gitlab.freedesktop.org/agd5f/linux/-/commit/6e169c7e0f842c48c7bf683fb789dbf5a8b1dfd8

Alex

On Wed, Jul 24, 2024 at 3:55 PM Ricardo B. Marliere
<rbmarliere@gmail.com> wrote:
>
> On 24 Jul 24 23:24, Abhishek Tamboli wrote:
> > 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@gmail.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
> > +      */
>
> Reviewed-by: Ricardo B. Marliere <ricardo@marliere.net>
>
>
> > +      void (*program_3dlut_size)(struct mpc *mpc, bool is_17x17x17, int mpcc_id);
> >  };
> >
> >  #endif
> > --
> > 2.34.1
> >