* [PATCH] drm: Fix documentation warning for read_mpcc_state in mpc.h
@ 2024-07-12 17:45 Abhishek Tamboli
2024-07-15 21:46 ` Aurabindo Pillai
0 siblings, 1 reply; 3+ messages in thread
From: Abhishek Tamboli @ 2024-07-12 17:45 UTC (permalink / raw)
To: airlied, daniel, harry.wentland, sunpeng.li, Rodrigo.Siqueira,
alexander.deucher, christian.koenig, Xinhui.Pan
Cc: amd-gfx, dri-devel, linux-kernel, skhan, rbmarliere,
linux-kernel-mentees
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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] drm: Fix documentation warning for read_mpcc_state in mpc.h
2024-07-12 17:45 [PATCH] drm: Fix documentation warning for read_mpcc_state in mpc.h Abhishek Tamboli
@ 2024-07-15 21:46 ` Aurabindo Pillai
2024-07-17 16:30 ` Abhishek Tamboli
0 siblings, 1 reply; 3+ messages in thread
From: Aurabindo Pillai @ 2024-07-15 21:46 UTC (permalink / raw)
To: Abhishek Tamboli, airlied, daniel, harry.wentland, sunpeng.li,
Rodrigo.Siqueira, alexander.deucher, christian.koenig, Xinhui.Pan
Cc: amd-gfx, dri-devel, linux-kernel, skhan, rbmarliere,
linux-kernel-mentees
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] drm: Fix documentation warning for read_mpcc_state in mpc.h
2024-07-15 21:46 ` Aurabindo Pillai
@ 2024-07-17 16:30 ` Abhishek Tamboli
0 siblings, 0 replies; 3+ messages in thread
From: Abhishek Tamboli @ 2024-07-17 16:30 UTC (permalink / raw)
To: Aurabindo Pillai
Cc: airlied, daniel, harry.wentland, sunpeng.li, Rodrigo.Siqueira,
alexander.deucher, christian.koenig, Xinhui.Pan, amd-gfx,
dri-devel, linux-kernel, skhan, rbmarliere, linux-kernel-mentees
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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2024-07-17 16:31 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-07-12 17:45 [PATCH] drm: Fix documentation warning for read_mpcc_state in mpc.h Abhishek Tamboli
2024-07-15 21:46 ` Aurabindo Pillai
2024-07-17 16:30 ` Abhishek Tamboli
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox