Skip to content

Commit 6e945d5

Browse files
rddunlaplumag
authored andcommitted
drm/msm/dpu: dpu_hw_top.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_top.h:93 Incorrect use of kernel-doc format: * setup_traffic_shaper() : Setup traffic shaper control Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h:101 Incorrect use of kernel-doc format: * setup_clk_force_ctrl - set clock force control Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h:111 Incorrect use of kernel-doc format: * get_danger_status - get danger status Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h:119 Incorrect use of kernel-doc format: * setup_vsync_source - setup vsync source configuration details Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h:127 Incorrect use of kernel-doc format: * get_safe_status - get safe status Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h:135 Incorrect use of kernel-doc format: * dp_phy_intf_sel - configure intf to phy mapping Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h:142 Incorrect use of kernel-doc format: * intf_audio_select - select the external interface for audio Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h:146 struct member 'setup_clk_force_ctrl' not described in 'dpu_hw_mdp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h:146 struct member 'get_danger_status' not described in 'dpu_hw_mdp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h:146 struct member 'setup_vsync_source' not described in 'dpu_hw_mdp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h:146 struct member 'get_safe_status' not described in 'dpu_hw_mdp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h:146 struct member 'dp_phy_intf_sel' not described in 'dpu_hw_mdp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h:146 struct member 'intf_audio_select' not described in 'dpu_hw_mdp_ops' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Dmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com> Patchwork: https://patchwork.freedesktop.org/patch/695669/ Link: https://lore.kernel.org/r/20251219184638.1813181-14-rdunlap@infradead.org Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>
1 parent f5a7145 commit 6e945d5

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,11 @@ enum dpu_dp_phy_sel {
7777
/**
7878
* struct dpu_hw_mdp_ops - interface to the MDP TOP Hw driver functions
7979
* Assumption is these functions will be called after clocks are enabled.
80-
* @setup_split_pipe : Programs the pipe control registers
81-
* @setup_pp_split : Programs the pp split control registers
82-
* @setup_traffic_shaper : programs traffic shaper control
8380
*/
8481
struct dpu_hw_mdp_ops {
85-
/** setup_split_pipe() : Registers are not double buffered, thisk
82+
/**
83+
* @setup_split_pipe : Programs the pipe control registers.
84+
* Registers are not double buffered, this
8685
* function should be called before timing control enable
8786
* @mdp : mdp top context driver
8887
* @cfg : upper and lower part of pipe configuration
@@ -91,15 +90,15 @@ struct dpu_hw_mdp_ops {
9190
struct split_pipe_cfg *p);
9291

9392
/**
94-
* setup_traffic_shaper() : Setup traffic shaper control
93+
* @setup_traffic_shaper : programs traffic shaper control.
9594
* @mdp : mdp top context driver
9695
* @cfg : traffic shaper configuration
9796
*/
9897
void (*setup_traffic_shaper)(struct dpu_hw_mdp *mdp,
9998
struct traffic_shaper_cfg *cfg);
10099

101100
/**
102-
* setup_clk_force_ctrl - set clock force control
101+
* @setup_clk_force_ctrl: set clock force control
103102
* @mdp: mdp top context driver
104103
* @clk_ctrl: clock to be controlled
105104
* @enable: force on enable
@@ -109,38 +108,38 @@ struct dpu_hw_mdp_ops {
109108
enum dpu_clk_ctrl_type clk_ctrl, bool enable);
110109

111110
/**
112-
* get_danger_status - get danger status
111+
* @get_danger_status: get danger status
113112
* @mdp: mdp top context driver
114113
* @status: Pointer to danger safe status
115114
*/
116115
void (*get_danger_status)(struct dpu_hw_mdp *mdp,
117116
struct dpu_danger_safe_status *status);
118117

119118
/**
120-
* setup_vsync_source - setup vsync source configuration details
119+
* @setup_vsync_source: setup vsync source configuration details
121120
* @mdp: mdp top context driver
122121
* @cfg: vsync source selection configuration
123122
*/
124123
void (*setup_vsync_source)(struct dpu_hw_mdp *mdp,
125124
struct dpu_vsync_source_cfg *cfg);
126125

127126
/**
128-
* get_safe_status - get safe status
127+
* @get_safe_status: get safe status
129128
* @mdp: mdp top context driver
130129
* @status: Pointer to danger safe status
131130
*/
132131
void (*get_safe_status)(struct dpu_hw_mdp *mdp,
133132
struct dpu_danger_safe_status *status);
134133

135134
/**
136-
* dp_phy_intf_sel - configure intf to phy mapping
135+
* @dp_phy_intf_sel: configure intf to phy mapping
137136
* @mdp: mdp top context driver
138137
* @phys: list of phys the DP interfaces should be connected to. 0 disables the INTF.
139138
*/
140139
void (*dp_phy_intf_sel)(struct dpu_hw_mdp *mdp, enum dpu_dp_phy_sel phys[2]);
141140

142141
/**
143-
* intf_audio_select - select the external interface for audio
142+
* @intf_audio_select: select the external interface for audio
144143
* @mdp: mdp top context driver
145144
*/
146145
void (*intf_audio_select)(struct dpu_hw_mdp *mdp);

0 commit comments

Comments
 (0)