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>

diff --git a/drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h b/drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h
index bdac5c04bf7901b864d5999fb395aa5c90de82f5..3822094f85bc5b989b7e7a00a67a3358ab98787e 100644 (file)
--- a/drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h
+++ b/drivers/gpu/drm/msm/disp/dpu1/dpu_hw_sspp.h
@@ -14,7 +14,7 @@ struct dpu_hw_sspp;
 
 #define DPU_SSPP_MAX_PITCH_SIZE                0xffff
 
-/**
+/*
  * Flags
  */
 #define DPU_SSPP_FLIP_LR               BIT(0)
@@ -23,7 +23,7 @@ struct dpu_hw_sspp;
 #define DPU_SSPP_ROT_90                        BIT(3)
 #define DPU_SSPP_SOLID_FILL            BIT(4)
 
-/**
+/*
  * Component indices
  */
 enum {
@@ -36,9 +36,10 @@ enum {
 };
 
 /**
- * DPU_SSPP_RECT_SOLO - multirect disabled
- * DPU_SSPP_RECT_0 - rect0 of a multirect pipe
- * DPU_SSPP_RECT_1 - rect1 of a multirect pipe
+ * enum dpu_sspp_multirect_index - multirect mode
+ * @DPU_SSPP_RECT_SOLO: multirect disabled
+ * @DPU_SSPP_RECT_0: rect0 of a multirect pipe
+ * @DPU_SSPP_RECT_1: rect1 of a multirect pipe
  *
  * Note: HW supports multirect with either RECT0 or
  * RECT1. Considering no benefit of such configs over
@@ -143,7 +144,7 @@ struct dpu_hw_pixel_ext {
  * struct dpu_sw_pipe_cfg : software pipe configuration
  * @src_rect:  src ROI, caller takes into account the different operations
  *             such as decimation, flip etc to program this field
- * @dest_rect: destination ROI.
+ * @dst_rect: destination ROI.
  * @rotation: simplified drm rotation hint
  */
 struct dpu_sw_pipe_cfg {
@@ -165,8 +166,8 @@ struct dpu_hw_pipe_ts_cfg {
 /**
  * struct dpu_sw_pipe - software pipe description
  * @sspp:      backing SSPP pipe
- * @index:     index of the rectangle of SSPP
- * @mode:      parallel or time multiplex multirect mode
+ * @multirect_index:     index of the rectangle of SSPP
+ * @multirect_mode:      parallel or time multiplex multirect mode
  */
 struct dpu_sw_pipe {
        struct dpu_hw_sspp *sspp;
@@ -181,7 +182,7 @@ struct dpu_sw_pipe {
  */
 struct dpu_hw_sspp_ops {
        /**
-        * setup_format - setup pixel format cropping rectangle, flip
+        * @setup_format: setup pixel format cropping rectangle, flip
         * @pipe: Pointer to software pipe context
         * @cfg: Pointer to pipe config structure
         * @flags: Extra flags for format config
@@ -190,7 +191,7 @@ struct dpu_hw_sspp_ops {
                             const struct msm_format *fmt, u32 flags);
 
        /**
-        * setup_rects - setup pipe ROI rectangles
+        * @setup_rects: setup pipe ROI rectangles
         * @pipe: Pointer to software pipe context
         * @cfg: Pointer to pipe config structure
         */
@@ -198,7 +199,7 @@ struct dpu_hw_sspp_ops {
                            struct dpu_sw_pipe_cfg *cfg);
 
        /**
-        * setup_pe - setup pipe pixel extension
+        * @setup_pe: setup pipe pixel extension
         * @ctx: Pointer to pipe context
         * @pe_ext: Pointer to pixel ext settings
         */
@@ -206,7 +207,7 @@ struct dpu_hw_sspp_ops {
                        struct dpu_hw_pixel_ext *pe_ext);
 
        /**
-        * setup_sourceaddress - setup pipe source addresses
+        * @setup_sourceaddress: setup pipe source addresses
         * @pipe: Pointer to software pipe context
         * @layout: format layout information for programming buffer to hardware
         */
@@ -214,14 +215,14 @@ struct dpu_hw_sspp_ops {
                                    struct dpu_hw_fmt_layout *layout);
 
        /**
-        * setup_csc - setup color space coversion
+        * @setup_csc: setup color space coversion
         * @ctx: Pointer to pipe context
         * @data: Pointer to config structure
         */
        void (*setup_csc)(struct dpu_hw_sspp *ctx, const struct dpu_csc_cfg *data);
 
        /**
-        * setup_solidfill - enable/disable colorfill
+        * @setup_solidfill: enable/disable colorfill
         * @pipe: Pointer to software pipe context
         * @const_color: Fill color value
         * @flags: Pipe flags
@@ -229,23 +230,22 @@ struct dpu_hw_sspp_ops {
        void (*setup_solidfill)(struct dpu_sw_pipe *pipe, u32 color);
 
        /**
-        * setup_multirect - setup multirect configuration
+        * @setup_multirect: setup multirect configuration
         * @pipe: Pointer to software pipe context
         */
 
        void (*setup_multirect)(struct dpu_sw_pipe *pipe);
 
        /**
-        * setup_sharpening - setup sharpening
+        * @setup_sharpening: setup sharpening
         * @ctx: Pointer to pipe context
         * @cfg: Pointer to config structure
         */
        void (*setup_sharpening)(struct dpu_hw_sspp *ctx,
                        struct dpu_hw_sharp_cfg *cfg);
 
-
        /**
-        * setup_qos_lut - setup QoS LUTs
+        * @setup_qos_lut: setup QoS LUTs
         * @ctx: Pointer to pipe context
         * @cfg: LUT configuration
         */
@@ -253,7 +253,7 @@ struct dpu_hw_sspp_ops {
                        struct dpu_hw_qos_cfg *cfg);
 
        /**
-        * setup_qos_ctrl - setup QoS control
+        * @setup_qos_ctrl: setup QoS control
         * @ctx: Pointer to pipe context
         * @danger_safe_en: flags controlling enabling of danger/safe QoS/LUT
         */
@@ -261,7 +261,7 @@ struct dpu_hw_sspp_ops {
                               bool danger_safe_en);
 
        /**
-        * setup_clk_force_ctrl - setup clock force control
+        * @setup_clk_force_ctrl: setup clock force control
         * @ctx: Pointer to pipe context
         * @enable: enable clock force if true
         */
@@ -269,7 +269,7 @@ struct dpu_hw_sspp_ops {
                                     bool enable);
 
        /**
-        * setup_histogram - setup histograms
+        * @setup_histogram: setup histograms
         * @ctx: Pointer to pipe context
         * @cfg: Pointer to histogram configuration
         */
@@ -277,7 +277,7 @@ struct dpu_hw_sspp_ops {
                        void *cfg);
 
        /**
-        * setup_scaler - setup scaler
+        * @setup_scaler: setup scaler
         * @scaler3_cfg: Pointer to scaler configuration
         * @format: pixel format parameters
         */
@@ -286,7 +286,7 @@ struct dpu_hw_sspp_ops {
                const struct msm_format *format);
 
        /**
-        * setup_cdp - setup client driven prefetch
+        * @setup_cdp: setup client driven prefetch
         * @pipe: Pointer to software pipe context
         * @fmt: format used by the sw pipe
         * @enable: whether the CDP should be enabled for this pipe
@@ -303,6 +303,7 @@ struct dpu_hw_sspp_ops {
  * @ubwc: UBWC configuration data
  * @idx: pipe index
  * @cap: pointer to layer_cfg
+ * @mdss_ver: MDSS version info to use for feature checks
  * @ops: pointer to operations possible for this pipe
  */
 struct dpu_hw_sspp {