2023-09-19 12:00:18

by swarup

Subject: [PATCH] gpu: drm: amd: display: fix kernel-doc warnings

Fix kernel-doc warnings discovered in AMD gpu display driver.
Fixes these warnings:
./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110: warning:
Function parameter or member 'overlap_only'
not described in 'mpcc_blnd_cfg'.

./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110: warning:
Function parameter or member 'bottom_gain_mode'
not described in 'mpcc_blnd_cfg'.

./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110: warning:
Function parameter or member 'background_color_bpc'
not described in 'mpcc_blnd_cfg'.

./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110:
warning: Function parameter or member 'top_gain'
not described in 'mpcc_blnd_cfg'.

./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110:
warning: Function parameter or member 'bottom_inside_gain'
not described in 'mpcc_blnd_cfg'.

./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110:
warning: Function parameter or member 'bottom_outside_gain'
not described in 'mpcc_blnd_cfg'.

Signed-off-by: Swarup Laxman Kotiaklapudi <[email protected]>
---
drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h | 6 ++++++
1 file changed, 6 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 8d86159d9de0..61a2406dcc53 100644
--- a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
+++ b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
@@ -91,6 +91,12 @@ enum mpcc_alpha_blend_mode {
* @global_gain: used when blend mode considers both pixel alpha and plane
* alpha value and assumes the global alpha value.
* @global_alpha: plane alpha value
+ * @overlap_only: whether overlapping of different planes is allowed
+ * @bottom_gain_mode: blend mode for bottom gain setting
+ * @background_color_bpc: background color for bpc
+ * @top_gain: top gain setting
+ * @bottom_inside_gain: blend mode for bottom inside
+ * @bottom_outside_gain: blend mode for bottom outside
*/
struct mpcc_blnd_cfg {
struct tg_color black_color; /* background color */
--
2.34.1

2023-09-19 22:57:12

by Randy Dunlap

Subject: Re: [PATCH] gpu: drm: amd: display: fix kernel-doc warnings

Hi,

On 9/19/23 02:33, Swarup Laxman Kotiaklapudi wrote:
> Fix kernel-doc warnings discovered in AMD gpu display driver.
> Fixes these warnings:
> ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110: warning:
> Function parameter or member 'overlap_only'
> not described in 'mpcc_blnd_cfg'.
>
> ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110: warning:
> Function parameter or member 'bottom_gain_mode'
> not described in 'mpcc_blnd_cfg'.
>
> ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110: warning:
> Function parameter or member 'background_color_bpc'
> not described in 'mpcc_blnd_cfg'.
>
> ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110:
> warning: Function parameter or member 'top_gain'
> not described in 'mpcc_blnd_cfg'.
>
> ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110:
> warning: Function parameter or member 'bottom_inside_gain'
> not described in 'mpcc_blnd_cfg'.
>
> ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110:
> warning: Function parameter or member 'bottom_outside_gain'
> not described in 'mpcc_blnd_cfg'.
>
> Signed-off-by: Swarup Laxman Kotiaklapudi <[email protected]>

Thanks for fixing these kernel-doc warnings.

Tested-by: Randy Dunlap <[email protected]>
Acked-by: Randy Dunlap <[email protected]>


> ---
> drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h | 6 ++++++
> 1 file changed, 6 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 8d86159d9de0..61a2406dcc53 100644
> --- a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> +++ b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> @@ -91,6 +91,12 @@ enum mpcc_alpha_blend_mode {
> * @global_gain: used when blend mode considers both pixel alpha and plane
> * alpha value and assumes the global alpha value.
> * @global_alpha: plane alpha value
> + * @overlap_only: whether overlapping of different planes is allowed
> + * @bottom_gain_mode: blend mode for bottom gain setting
> + * @background_color_bpc: background color for bpc
> + * @top_gain: top gain setting
> + * @bottom_inside_gain: blend mode for bottom inside
> + * @bottom_outside_gain: blend mode for bottom outside
> */
> struct mpcc_blnd_cfg {
> struct tg_color black_color; /* background color */

--
~Randy

2023-09-20 15:02:26

by Alex Deucher

Subject: Re: [PATCH] gpu: drm: amd: display: fix kernel-doc warnings

Applied. Thanks!

On Tue, Sep 19, 2023 at 5:54 PM Randy Dunlap <[email protected]> wrote:
>
> Hi,
>
> On 9/19/23 02:33, Swarup Laxman Kotiaklapudi wrote:
> > Fix kernel-doc warnings discovered in AMD gpu display driver.
> > Fixes these warnings:
> > ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110: warning:
> > Function parameter or member 'overlap_only'
> > not described in 'mpcc_blnd_cfg'.
> >
> > ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110: warning:
> > Function parameter or member 'bottom_gain_mode'
> > not described in 'mpcc_blnd_cfg'.
> >
> > ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110: warning:
> > Function parameter or member 'background_color_bpc'
> > not described in 'mpcc_blnd_cfg'.
> >
> > ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110:
> > warning: Function parameter or member 'top_gain'
> > not described in 'mpcc_blnd_cfg'.
> >
> > ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110:
> > warning: Function parameter or member 'bottom_inside_gain'
> > not described in 'mpcc_blnd_cfg'.
> >
> > ./drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h:110:
> > warning: Function parameter or member 'bottom_outside_gain'
> > not described in 'mpcc_blnd_cfg'.
> >
> > Signed-off-by: Swarup Laxman Kotiaklapudi <[email protected]>
>
> Thanks for fixing these kernel-doc warnings.
>
> Tested-by: Randy Dunlap <[email protected]>
> Acked-by: Randy Dunlap <[email protected]>
>
>
> > ---
> > drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h | 6 ++++++
> > 1 file changed, 6 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 8d86159d9de0..61a2406dcc53 100644
> > --- a/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> > +++ b/drivers/gpu/drm/amd/display/dc/inc/hw/mpc.h
> > @@ -91,6 +91,12 @@ enum mpcc_alpha_blend_mode {
> > * @global_gain: used when blend mode considers both pixel alpha and plane
> > * alpha value and assumes the global alpha value.
> > * @global_alpha: plane alpha value
> > + * @overlap_only: whether overlapping of different planes is allowed
> > + * @bottom_gain_mode: blend mode for bottom gain setting
> > + * @background_color_bpc: background color for bpc
> > + * @top_gain: top gain setting
> > + * @bottom_inside_gain: blend mode for bottom inside
> > + * @bottom_outside_gain: blend mode for bottom outside
> > */
> > struct mpcc_blnd_cfg {
> > struct tg_color black_color; /* background color */
>
> --
> ~Randy