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

drm/msm/dpu: dpu_hw_intf.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_intf.h:76 duplicate section
 name 'Return'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_intf.h:112 Incorrect use of
 kernel-doc format: * Disable autorefresh if enabled
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_intf.h:118 struct member
 'setup_timing_gen' not described in 'dpu_hw_intf_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_intf.h:118 struct member
 'setup_prg_fetch' not described in 'dpu_hw_intf_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_intf.h:118 struct member
 'enable_timing' not described in 'dpu_hw_intf_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_intf.h:118 struct member
 'get_status' not described in 'dpu_hw_intf_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_intf.h:118 struct member
 'get_line_count' not described in 'dpu_hw_intf_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_intf.h:118 struct member
 'disable_autorefresh' not described in 'dpu_hw_intf_ops'
dpu_hw_intf.h:119: warning: Excess struct member 'get_vsync_info'
 description in 'dpu_hw_intf_ops'
dpu_hw_intf.h:119: warning: Excess struct member 'setup_autorefresh'
 description in 'dpu_hw_intf_ops'
dpu_hw_intf.h:119: warning: Excess struct member 'get_autorefresh'
 description in 'dpu_hw_intf_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/695646/
Link: https://lore.kernel.org/r/20251219184638.1813181-9-rdunlap@infradead.org


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

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

+7 −13
Original line number Diff line number Diff line
@@ -58,7 +58,7 @@ struct dpu_hw_intf_cmd_mode_cfg { 
 * struct dpu_hw_intf_ops : Interface to the interface Hw driver functions

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

 * @setup_timing_gen : programs the timing engine

 * @ setup_prog_fetch : enables/disables the programmable fetch logic

 * @setup_prg_fetch  : enables/disables the programmable fetch logic

 * @enable_timing: enable/disable timing engine

 * @get_status: returns if timing engine is enabled or not

 * @get_line_count: reads current vertical line counter
@@ -70,12 +70,9 @@ struct dpu_hw_intf_cmd_mode_cfg { 
 *                              pointer and programs the tear check configuration

 * @disable_tearcheck:          Disables tearcheck block

 * @connect_external_te:        Read, modify, write to either set or clear listening to external TE

 *                              Return: 1 if TE was originally connected, 0 if not, or -ERROR

 * @get_vsync_info:             Provides the programmed and current line_count

 * @setup_autorefresh:          Configure and enable the autorefresh config

 * @get_autorefresh:            Retrieve autorefresh config from hardware

 *                              Return: 0 on success, -ETIMEDOUT on timeout

 *                              Returns 1 if TE was originally connected, 0 if not, or -ERROR

 * @vsync_sel:                  Select vsync signal for tear-effect configuration

 * @disable_autorefresh:        Disable autorefresh if enabled

 * @program_intf_cmd_cfg:       Program the DPU to interface datapath for command mode

 */

struct dpu_hw_intf_ops {
@@ -109,9 +106,6 @@ struct dpu_hw_intf_ops { 


	void (*vsync_sel)(struct dpu_hw_intf *intf, enum dpu_vsync_source vsync_source);



	/**

	 * Disable autorefresh if enabled

	 */

	void (*disable_autorefresh)(struct dpu_hw_intf *intf, uint32_t encoder_id, u16 vdisplay);



	void (*program_intf_cmd_cfg)(struct dpu_hw_intf *intf,