Skip to content

Commit f5a7145

Browse files
rddunlaplumag
authored andcommitted
drm/msm/dpu: dpu_hw_sspp.h: fix all kernel-doc warnings
Modify non-kernel-doc comments to begin with "/*" instead of "/**". Correct or add kernel-doc comments to eliminate all warnings: Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:17 missing initial short description on line: * Flags Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:19 expecting prototype for Flags(). Prototype was for DPU_SSPP_FLIP_LR() instead Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:26 This comment starts with '/**', but isn't a kernel-doc comment. * Component indices Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:47 cannot understand function prototype: 'enum dpu_sspp_multirect_index' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:152 struct member 'dst_rect' not described in 'dpu_sw_pipe_cfg' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:174 struct member 'multirect_index' not described in 'dpu_sw_pipe' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:174 struct member 'multirect_mode' not described in 'dpu_sw_pipe' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:183 Incorrect use of kernel-doc format: * setup_format - setup pixel format cropping rectangle, flip Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:192 Incorrect use of kernel-doc format: * setup_rects - setup pipe ROI rectangles Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:200 Incorrect use of kernel-doc format: * setup_pe - setup pipe pixel extension Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:208 Incorrect use of kernel-doc format: * setup_sourceaddress - setup pipe source addresses Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:216 Incorrect use of kernel-doc format: * setup_csc - setup color space coversion Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:223 Incorrect use of kernel-doc format: * setup_solidfill - enable/disable colorfill Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:231 Incorrect use of kernel-doc format: * setup_multirect - setup multirect configuration Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:238 Incorrect use of kernel-doc format: * setup_sharpening - setup sharpening Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:247 Incorrect use of kernel-doc format: * setup_qos_lut - setup QoS LUTs Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:255 Incorrect use of kernel-doc format: * setup_qos_ctrl - setup QoS control Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:263 Incorrect use of kernel-doc format: * setup_clk_force_ctrl - setup clock force control Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:271 Incorrect use of kernel-doc format: * setup_histogram - setup histograms Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:279 Incorrect use of kernel-doc format: * setup_scaler - setup scaler Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:288 Incorrect use of kernel-doc format: * setup_cdp - setup client driven prefetch Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_format' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_rects' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_pe' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_sourceaddress' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_csc' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_solidfill' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_multirect' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_sharpening' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_qos_lut' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_qos_ctrl' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_clk_force_ctrl' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_histogram' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_scaler' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:296 struct member 'setup_cdp' not described in 'dpu_hw_sspp_ops' Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h:320 struct member 'mdss_ver' not described in 'dpu_hw_sspp' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Dmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com> Patchwork: https://patchwork.freedesktop.org/patch/695661/ Link: https://lore.kernel.org/r/20251219184638.1813181-13-rdunlap@infradead.org Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>
1 parent abc287a commit f5a7145

1 file changed

Lines changed: 24 additions & 23 deletions

File tree

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

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ struct dpu_hw_sspp;
1414

1515
#define DPU_SSPP_MAX_PITCH_SIZE 0xffff
1616

17-
/**
17+
/*
1818
* Flags
1919
*/
2020
#define DPU_SSPP_FLIP_LR BIT(0)
@@ -23,7 +23,7 @@ struct dpu_hw_sspp;
2323
#define DPU_SSPP_ROT_90 BIT(3)
2424
#define DPU_SSPP_SOLID_FILL BIT(4)
2525

26-
/**
26+
/*
2727
* Component indices
2828
*/
2929
enum {
@@ -36,9 +36,10 @@ enum {
3636
};
3737

3838
/**
39-
* DPU_SSPP_RECT_SOLO - multirect disabled
40-
* DPU_SSPP_RECT_0 - rect0 of a multirect pipe
41-
* DPU_SSPP_RECT_1 - rect1 of a multirect pipe
39+
* enum dpu_sspp_multirect_index - multirect mode
40+
* @DPU_SSPP_RECT_SOLO: multirect disabled
41+
* @DPU_SSPP_RECT_0: rect0 of a multirect pipe
42+
* @DPU_SSPP_RECT_1: rect1 of a multirect pipe
4243
*
4344
* Note: HW supports multirect with either RECT0 or
4445
* RECT1. Considering no benefit of such configs over
@@ -143,7 +144,7 @@ struct dpu_hw_pixel_ext {
143144
* struct dpu_sw_pipe_cfg : software pipe configuration
144145
* @src_rect: src ROI, caller takes into account the different operations
145146
* such as decimation, flip etc to program this field
146-
* @dest_rect: destination ROI.
147+
* @dst_rect: destination ROI.
147148
* @rotation: simplified drm rotation hint
148149
*/
149150
struct dpu_sw_pipe_cfg {
@@ -165,8 +166,8 @@ struct dpu_hw_pipe_ts_cfg {
165166
/**
166167
* struct dpu_sw_pipe - software pipe description
167168
* @sspp: backing SSPP pipe
168-
* @index: index of the rectangle of SSPP
169-
* @mode: parallel or time multiplex multirect mode
169+
* @multirect_index: index of the rectangle of SSPP
170+
* @multirect_mode: parallel or time multiplex multirect mode
170171
*/
171172
struct dpu_sw_pipe {
172173
struct dpu_hw_sspp *sspp;
@@ -181,7 +182,7 @@ struct dpu_sw_pipe {
181182
*/
182183
struct dpu_hw_sspp_ops {
183184
/**
184-
* setup_format - setup pixel format cropping rectangle, flip
185+
* @setup_format: setup pixel format cropping rectangle, flip
185186
* @pipe: Pointer to software pipe context
186187
* @cfg: Pointer to pipe config structure
187188
* @flags: Extra flags for format config
@@ -190,94 +191,93 @@ struct dpu_hw_sspp_ops {
190191
const struct msm_format *fmt, u32 flags);
191192

192193
/**
193-
* setup_rects - setup pipe ROI rectangles
194+
* @setup_rects: setup pipe ROI rectangles
194195
* @pipe: Pointer to software pipe context
195196
* @cfg: Pointer to pipe config structure
196197
*/
197198
void (*setup_rects)(struct dpu_sw_pipe *pipe,
198199
struct dpu_sw_pipe_cfg *cfg);
199200

200201
/**
201-
* setup_pe - setup pipe pixel extension
202+
* @setup_pe: setup pipe pixel extension
202203
* @ctx: Pointer to pipe context
203204
* @pe_ext: Pointer to pixel ext settings
204205
*/
205206
void (*setup_pe)(struct dpu_hw_sspp *ctx,
206207
struct dpu_hw_pixel_ext *pe_ext);
207208

208209
/**
209-
* setup_sourceaddress - setup pipe source addresses
210+
* @setup_sourceaddress: setup pipe source addresses
210211
* @pipe: Pointer to software pipe context
211212
* @layout: format layout information for programming buffer to hardware
212213
*/
213214
void (*setup_sourceaddress)(struct dpu_sw_pipe *ctx,
214215
struct dpu_hw_fmt_layout *layout);
215216

216217
/**
217-
* setup_csc - setup color space coversion
218+
* @setup_csc: setup color space coversion
218219
* @ctx: Pointer to pipe context
219220
* @data: Pointer to config structure
220221
*/
221222
void (*setup_csc)(struct dpu_hw_sspp *ctx, const struct dpu_csc_cfg *data);
222223

223224
/**
224-
* setup_solidfill - enable/disable colorfill
225+
* @setup_solidfill: enable/disable colorfill
225226
* @pipe: Pointer to software pipe context
226227
* @const_color: Fill color value
227228
* @flags: Pipe flags
228229
*/
229230
void (*setup_solidfill)(struct dpu_sw_pipe *pipe, u32 color);
230231

231232
/**
232-
* setup_multirect - setup multirect configuration
233+
* @setup_multirect: setup multirect configuration
233234
* @pipe: Pointer to software pipe context
234235
*/
235236

236237
void (*setup_multirect)(struct dpu_sw_pipe *pipe);
237238

238239
/**
239-
* setup_sharpening - setup sharpening
240+
* @setup_sharpening: setup sharpening
240241
* @ctx: Pointer to pipe context
241242
* @cfg: Pointer to config structure
242243
*/
243244
void (*setup_sharpening)(struct dpu_hw_sspp *ctx,
244245
struct dpu_hw_sharp_cfg *cfg);
245246

246-
247247
/**
248-
* setup_qos_lut - setup QoS LUTs
248+
* @setup_qos_lut: setup QoS LUTs
249249
* @ctx: Pointer to pipe context
250250
* @cfg: LUT configuration
251251
*/
252252
void (*setup_qos_lut)(struct dpu_hw_sspp *ctx,
253253
struct dpu_hw_qos_cfg *cfg);
254254

255255
/**
256-
* setup_qos_ctrl - setup QoS control
256+
* @setup_qos_ctrl: setup QoS control
257257
* @ctx: Pointer to pipe context
258258
* @danger_safe_en: flags controlling enabling of danger/safe QoS/LUT
259259
*/
260260
void (*setup_qos_ctrl)(struct dpu_hw_sspp *ctx,
261261
bool danger_safe_en);
262262

263263
/**
264-
* setup_clk_force_ctrl - setup clock force control
264+
* @setup_clk_force_ctrl: setup clock force control
265265
* @ctx: Pointer to pipe context
266266
* @enable: enable clock force if true
267267
*/
268268
bool (*setup_clk_force_ctrl)(struct dpu_hw_sspp *ctx,
269269
bool enable);
270270

271271
/**
272-
* setup_histogram - setup histograms
272+
* @setup_histogram: setup histograms
273273
* @ctx: Pointer to pipe context
274274
* @cfg: Pointer to histogram configuration
275275
*/
276276
void (*setup_histogram)(struct dpu_hw_sspp *ctx,
277277
void *cfg);
278278

279279
/**
280-
* setup_scaler - setup scaler
280+
* @setup_scaler: setup scaler
281281
* @scaler3_cfg: Pointer to scaler configuration
282282
* @format: pixel format parameters
283283
*/
@@ -286,7 +286,7 @@ struct dpu_hw_sspp_ops {
286286
const struct msm_format *format);
287287

288288
/**
289-
* setup_cdp - setup client driven prefetch
289+
* @setup_cdp: setup client driven prefetch
290290
* @pipe: Pointer to software pipe context
291291
* @fmt: format used by the sw pipe
292292
* @enable: whether the CDP should be enabled for this pipe
@@ -303,6 +303,7 @@ struct dpu_hw_sspp_ops {
303303
* @ubwc: UBWC configuration data
304304
* @idx: pipe index
305305
* @cap: pointer to layer_cfg
306+
* @mdss_ver: MDSS version info to use for feature checks
306307
* @ops: pointer to operations possible for this pipe
307308
*/
308309
struct dpu_hw_sspp {

0 commit comments

Comments
 (0)