drm/msm/dpu: dpu_hw_pingpong.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_pingpong.h:36 Cannot find
 identifier on line: *
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:46 Incorrect use
 of kernel-doc format: * enables vysnc generation and sets up init value of
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:53 Incorrect use
 of kernel-doc format: * disables tear check block
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:58 Incorrect use
 of kernel-doc format: * read, modify, write to either set or clear
 listening to external TE
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:65 Incorrect use
 of kernel-doc format: * Obtain current vertical line counter
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:70 Incorrect use
 of kernel-doc format: * Disable autorefresh if enabled
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:75 Incorrect use
 of kernel-doc format: * Setup dither matix for pingpong block
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:80 Incorrect use
 of kernel-doc format: * Enable DSC
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:85 Incorrect use
 of kernel-doc format: * Disable DSC
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:90 Incorrect use
 of kernel-doc format: * Setup DSC
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:93 struct member
 'connect_external_te' not described in 'dpu_hw_pingpong_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:93 struct member
 'disable_autorefresh' not described in 'dpu_hw_pingpong_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:93 struct member
 'enable_dsc' not described in 'dpu_hw_pingpong_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:93 struct member
 'disable_dsc' not described in 'dpu_hw_pingpong_ops'
Warning: drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h:93 struct member
 'setup_dsc' not described in 'dpu_hw_pingpong_ops'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Dmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>
Patchwork: https://patchwork.freedesktop.org/patch/695659/
Link: https://lore.kernel.org/r/20251219184638.1813181-12-rdunlap@infradead.org
Signed-off-by: Dmitry Baryshkov <dmitry.baryshkov@oss.qualcomm.com>

diff --git a/drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h b/drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h
index dd99e1c21a1eee146a17399e928ad43323d52bb1..effd012d864afb6af4933e7dcd28102ecd432a01 100644 (file)
--- a/drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h
+++ b/drivers/gpu/drm/msm/disp/dpu1/dpu_hw_pingpong.h
@@ -34,7 +34,6 @@ struct dpu_hw_dither_cfg {
 };
 
 /**
- *
  * struct dpu_hw_pingpong_ops : Interface to the pingpong Hw driver functions
  *  Assumption is these functions will be called after clocks are enabled
  *  @enable_tearcheck: program and enable tear check block
@@ -44,51 +43,52 @@ struct dpu_hw_dither_cfg {
  */
 struct dpu_hw_pingpong_ops {
        /**
-        * enables vysnc generation and sets up init value of
+        * @enable_tearcheck: enables vysnc generation and sets up init value of
         * read pointer and programs the tear check cofiguration
         */
        int (*enable_tearcheck)(struct dpu_hw_pingpong *pp,
                        struct dpu_hw_tear_check *cfg);
 
        /**
-        * disables tear check block
+        * @disable_tearcheck: disables tear check block
         */
        int (*disable_tearcheck)(struct dpu_hw_pingpong *pp);
 
        /**
-        * read, modify, write to either set or clear listening to external TE
+        * @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
         */
        int (*connect_external_te)(struct dpu_hw_pingpong *pp,
                        bool enable_external_te);
 
        /**
-        * Obtain current vertical line counter
+        * @get_line_count: Obtain current vertical line counter
         */
        u32 (*get_line_count)(struct dpu_hw_pingpong *pp);
 
        /**
-        * Disable autorefresh if enabled
+        * @disable_autorefresh: Disable autorefresh if enabled
         */
        void (*disable_autorefresh)(struct dpu_hw_pingpong *pp, uint32_t encoder_id, u16 vdisplay);
 
        /**
-        * Setup dither matix for pingpong block
+        * @setup_dither: Setup dither matix for pingpong block
         */
        void (*setup_dither)(struct dpu_hw_pingpong *pp,
                        struct dpu_hw_dither_cfg *cfg);
        /**
-        * Enable DSC
+        * @enable_dsc: Enable DSC
         */
        int (*enable_dsc)(struct dpu_hw_pingpong *pp);
 
        /**
-        * Disable DSC
+        * @disable_dsc: Disable DSC
         */
        void (*disable_dsc)(struct dpu_hw_pingpong *pp);
 
        /**
-        * Setup DSC
+        * @setup_dsc: Setup DSC
         */
        int (*setup_dsc)(struct dpu_hw_pingpong *pp);
 };