Add detail description for the read_mpcc_state function in the
mpc_funcs struct to resolve the documentation warning.

A kernel-doc warning was addressed:
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning:
Function parameter or struct member 'read_mpcc_state' 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, 16 insertions(+)

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 34a398f23fc6..9e65ecf1d3b0 100644
--- a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
+++ b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
@@ -282,6 +282,22 @@ struct mpcc_state {
  * struct mpc_funcs - funcs
  */
 struct mpc_funcs {
+	/**
+	 * @read_mpcc_state:
+	 *
+	 * Reads the state of a given MPCC instance.
+	 *
+	 * Parameters:
+	 *
+	 * - [in/out] mpc - MPC context.
+	 * - [in] mpcc_inst - MPCC Instance whose state is to be read.
+	 * - [out] mpcc_state - MPCC state structure where the state
+	 *                    of the MPCC instance will be stored.
+	 *
+	 * Return:
+	 *
+	 * void
+	 */
 	void (*read_mpcc_state)(
 			struct mpc *mpc,
 			int mpcc_inst,
-- 
2.34.1

On 7/12/24 1:45 PM, Abhishek Tamboli wrote:
> Add detail description for the read_mpcc_state function in the
> mpc_funcs struct to resolve the documentation warning.
> 
> A kernel-doc warning was addressed:
> ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning:
> Function parameter or struct member 'read_mpcc_state' 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, 16 insertions(+)
> 
> 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 34a398f23fc6..9e65ecf1d3b0 100644
> --- a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> +++ b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> @@ -282,6 +282,22 @@ struct mpcc_state {
>    * struct mpc_funcs - funcs
>    */
>   struct mpc_funcs {
> +	/**
> +	 * @read_mpcc_state:
> +	 *
> +	 * Reads the state of a given MPCC instance.
> +	 *
> +	 * Parameters:
> +	 *
> +	 * - [in/out] mpc - MPC context.
> +	 * - [in] mpcc_inst - MPCC Instance whose state is to be read.
> +	 * - [out] mpcc_state - MPCC state structure where the state
> +	 *                    of the MPCC instance will be stored.
> +	 *
> +	 * Return:
> +	 *
> +	 * void
> +	 */
>   	void (*read_mpcc_state)(
>   			struct mpc *mpc,
>   			int mpcc_inst,

Looks like fix for this has been already merged via a195f08636f9d7 
drm/amd/display: fix documentation warnings for mpc.h

--

Thanks & Regards,
Aurabindo Pillai

On Mon, Jul 15, 2024 at 05:46:38PM -0400, Aurabindo Pillai wrote:
> 
> 
> On 7/12/24 1:45 PM, Abhishek Tamboli wrote:
> > Add detail description for the read_mpcc_state function in the
> > mpc_funcs struct to resolve the documentation warning.
> > 
> > A kernel-doc warning was addressed:
> > ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:547: warning:
> > Function parameter or struct member 'read_mpcc_state' 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, 16 insertions(+)
> > 
> > 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 34a398f23fc6..9e65ecf1d3b0 100644
> > --- a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> > +++ b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> > @@ -282,6 +282,22 @@ struct mpcc_state {
> >    * struct mpc_funcs - funcs
> >    */
> >   struct mpc_funcs {
> > +	/**
> > +	 * @read_mpcc_state:
> > +	 *
> > +	 * Reads the state of a given MPCC instance.
> > +	 *
> > +	 * Parameters:
> > +	 *
> > +	 * - [in/out] mpc - MPC context.
> > +	 * - [in] mpcc_inst - MPCC Instance whose state is to be read.
> > +	 * - [out] mpcc_state - MPCC state structure where the state
> > +	 *                    of the MPCC instance will be stored.
> > +	 *
> > +	 * Return:
> > +	 *
> > +	 * void
> > +	 */
> >   	void (*read_mpcc_state)(
> >   			struct mpc *mpc,
> >   			int mpcc_inst,
> 
> Looks like fix for this has been already merged via a195f08636f9d7
> drm/amd/display: fix documentation warnings for mpc.h
> 
Thanks Aurabindo for pointing this out.

Regards,
Abhishek 	
> --
> 
> Thanks & Regards,
> Aurabindo Pillai