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>

diff --git a/drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h b/drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h
index 04efdcd21ceb0a703e6e8250c08635a79f0217e8..80279d87c2cde9904a4b4fbdc39c7771d912d841 100644 (file)
--- a/drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h
+++ b/drivers/gpu/drm/msm/disp/dpu1/dpu_hw_top.h
@@ -77,12 +77,11 @@ enum dpu_dp_phy_sel {
 /**
  * struct dpu_hw_mdp_ops - interface to the MDP TOP Hw driver functions
  * Assumption is these functions will be called after clocks are enabled.
- * @setup_split_pipe : Programs the pipe control registers
- * @setup_pp_split : Programs the pp split control registers
- * @setup_traffic_shaper : programs traffic shaper control
  */
 struct dpu_hw_mdp_ops {
-       /** setup_split_pipe() : Registers are not double buffered, thisk
+       /**
+        * @setup_split_pipe : Programs the pipe control registers.
+        * Registers are not double buffered, this
         * function should be called before timing control enable
         * @mdp  : mdp top context driver
         * @cfg  : upper and lower part of pipe configuration
@@ -91,7 +90,7 @@ struct dpu_hw_mdp_ops {
                        struct split_pipe_cfg *p);
 
        /**
-        * setup_traffic_shaper() : Setup traffic shaper control
+        * @setup_traffic_shaper : programs traffic shaper control.
         * @mdp  : mdp top context driver
         * @cfg  : traffic shaper configuration
         */
@@ -99,7 +98,7 @@ struct dpu_hw_mdp_ops {
                        struct traffic_shaper_cfg *cfg);
 
        /**
-        * setup_clk_force_ctrl - set clock force control
+        * @setup_clk_force_ctrl: set clock force control
         * @mdp: mdp top context driver
         * @clk_ctrl: clock to be controlled
         * @enable: force on enable
@@ -109,7 +108,7 @@ struct dpu_hw_mdp_ops {
                        enum dpu_clk_ctrl_type clk_ctrl, bool enable);
 
        /**
-        * get_danger_status - get danger status
+        * @get_danger_status: get danger status
         * @mdp: mdp top context driver
         * @status: Pointer to danger safe status
         */
@@ -117,7 +116,7 @@ struct dpu_hw_mdp_ops {
                        struct dpu_danger_safe_status *status);
 
        /**
-        * setup_vsync_source - setup vsync source configuration details
+        * @setup_vsync_source: setup vsync source configuration details
         * @mdp: mdp top context driver
         * @cfg: vsync source selection configuration
         */
@@ -125,7 +124,7 @@ struct dpu_hw_mdp_ops {
                                struct dpu_vsync_source_cfg *cfg);
 
        /**
-        * get_safe_status - get safe status
+        * @get_safe_status: get safe status
         * @mdp: mdp top context driver
         * @status: Pointer to danger safe status
         */
@@ -133,14 +132,14 @@ struct dpu_hw_mdp_ops {
                        struct dpu_danger_safe_status *status);
 
        /**
-        * dp_phy_intf_sel - configure intf to phy mapping
+        * @dp_phy_intf_sel: configure intf to phy mapping
         * @mdp: mdp top context driver
         * @phys: list of phys the DP interfaces should be connected to. 0 disables the INTF.
         */
        void (*dp_phy_intf_sel)(struct dpu_hw_mdp *mdp, enum dpu_dp_phy_sel phys[2]);
 
        /**
-        * intf_audio_select - select the external interface for audio
+        * @intf_audio_select: select the external interface for audio
         * @mdp: mdp top context driver
         */
        void (*intf_audio_select)(struct dpu_hw_mdp *mdp);