Commit 7ce9dd5e authored by Randy Dunlap's avatar Randy Dunlap Committed by Dmitry Baryshkov
Browse files

drm/msm/dpu: dpu_hw_lm.h: fix all kernel-doc warnings 



Correct or add kernel-doc comments to eliminate all warnings:

Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:27 Cannot find
 identifier on line: *
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:52 Incorrect use of
 kernel-doc format: * Clear layer mixer to pipe configuration
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:59 Incorrect use of
 kernel-doc format: * Configure layer mixer to pipe configuration
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:69 Incorrect use of
 kernel-doc format: * setup_border_color : enable/disable border color
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:76 Incorrect use of
 kernel-doc format: * setup_misr: Enable/disable MISR
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:81 Incorrect use of
 kernel-doc format: * collect_misr: Read MISR signature

Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:84 struct member
 'setup_mixer_out' not described in 'dpu_hw_lm_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:84 struct member
 'setup_blend_config' not described in 'dpu_hw_lm_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:84 struct member
 'setup_alpha_out' not described in 'dpu_hw_lm_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:84 struct member
 'clear_all_blendstages' not described in 'dpu_hw_lm_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:84 struct member
 'setup_blendstage' not described in 'dpu_hw_lm_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:84 struct member
 'setup_border_color' not described in 'dpu_hw_lm_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:84 struct member
 'setup_misr' not described in 'dpu_hw_lm_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h:84 struct member
 'collect_misr' not described in 'dpu_hw_lm_ops'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reviewed-by: default avatarDmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>
Patchwork: https://patchwork.freedesktop.org/patch/695648/
Link: https://lore.kernel.org/r/20251219184638.1813181-10-rdunlap@infradead.org


Signed-off-by: default avatarDmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>
parent f6d75455

drivers/gpu/drm/msm/disp/dpu1/dpu_hw_lm.h

+11 −12
Original line number Diff line number Diff line
@@ -25,39 +25,38 @@ struct dpu_hw_color3_cfg { 
};



/**

 *

 * struct dpu_hw_lm_ops : Interface to the mixer Hw driver functions

 *  Assumption is these functions will be called after clocks are enabled

 */

struct dpu_hw_lm_ops {

	/*

	 * Sets up mixer output width and height

	/**

	 * @setup_mixer_out: Sets up mixer output width and height

	 * and border color if enabled

	 */

	void (*setup_mixer_out)(struct dpu_hw_mixer *ctx,

		struct dpu_hw_mixer_cfg *cfg);



	/*

	 * Alpha blending configuration

	/**

	 * @setup_blend_config: Alpha blending configuration

	 * for the specified stage

	 */

	void (*setup_blend_config)(struct dpu_hw_mixer *ctx, uint32_t stage,

		uint32_t fg_alpha, uint32_t bg_alpha, uint32_t blend_op);



	/*

	 * Alpha color component selection from either fg or bg

	/**

	 * @setup_alpha_out: Alpha color component selection from either fg or bg

	 */

	void (*setup_alpha_out)(struct dpu_hw_mixer *ctx, uint32_t mixer_op);



	/**

	 * Clear layer mixer to pipe configuration

	 * @clear_all_blendstages: Clear layer mixer to pipe configuration

	 * @ctx		: mixer ctx pointer

	 * Returns: 0 on success or -error

	 */

	int (*clear_all_blendstages)(struct dpu_hw_mixer *ctx);



	/**

	 * Configure layer mixer to pipe configuration

	 * @setup_blendstage: Configure layer mixer to pipe configuration

	 * @ctx		: mixer ctx pointer

	 * @lm		: layer mixer enumeration

	 * @stage_cfg	: blend stage configuration
@@ -67,19 +66,19 @@ struct dpu_hw_lm_ops { 
				struct dpu_hw_stage_cfg *stage_cfg);



	/**

	 * setup_border_color : enable/disable border color

	 * @setup_border_color : enable/disable border color

	 */

	void (*setup_border_color)(struct dpu_hw_mixer *ctx,

		struct dpu_mdss_color *color,

		u8 border_en);



	/**

	 * setup_misr: Enable/disable MISR

	 * @setup_misr: Enable/disable MISR

	 */

	void (*setup_misr)(struct dpu_hw_mixer *ctx);



	/**

	 * collect_misr: Read MISR signature

	 * @collect_misr: Read MISR signature

	 */

	int (*collect_misr)(struct dpu_hw_mixer *ctx, u32 *misr_value);

};