drm/amd/display: fix kernel-doc issues in dc.h
authorRandy Dunlap <rdunlap@infradead.org>
Thu, 17 Nov 2022 17:20:09 +0000 (09:20 -0800)
committerAlex Deucher <alexander.deucher@amd.com>
Thu, 17 Nov 2022 23:09:07 +0000 (18:09 -0500)
Fix these kernel-doc complaints:

drivers/gpu/drm/amd/display/dc/dc.h:505: warning: cannot understand function prototype: 'struct dc_clocks '
dc.h:472: warning: Enum value 'MPC_SPLIT_AVOID' not described in enum 'pipe_split_policy'
dc.h:472: warning: Enum value 'MPC_SPLIT_AVOID_MULT_DISP' not described in enum 'pipe_split_policy'
dc.h:532: warning: Incorrect use of kernel-doc format:          * @fw_based_mclk_switching

Fixes: ea76895ffab1 ("drm/amd/display: Document pipe split policy")
Fixes: 1682bd1a6b5f ("drm/amd/display: Expand kernel doc for DC")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: Harry Wentland <harry.wentland@amd.com>
Cc: Leo Li <sunpeng.li@amd.com>
Cc: amd-gfx@lists.freedesktop.org
Cc: David Airlie <airlied@gmail.com>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: dri-devel@lists.freedesktop.org
Reviewed-by: Harry Wentland <harry.wentland@amd.com>
Signed-off-by: Alex Deucher <alexander.deucher@amd.com>
drivers/gpu/drm/amd/display/dc/dc.h

index b02d1f3..57fc919 100644 (file)
@@ -458,15 +458,15 @@ enum pipe_split_policy {
        MPC_SPLIT_DYNAMIC = 0,
 
        /**
-        * @MPC_SPLIT_DYNAMIC: Avoid pipe split, which means that DC will not
+        * @MPC_SPLIT_AVOID: Avoid pipe split, which means that DC will not
         * try any sort of split optimization.
         */
        MPC_SPLIT_AVOID = 1,
 
        /**
-        * @MPC_SPLIT_DYNAMIC: With this option, DC will only try to optimize
-        * the pipe utilization when using a single display; if the user
-        * connects to a second display, DC will avoid pipe split.
+        * @MPC_SPLIT_AVOID_MULT_DISP: With this option, DC will only try to
+        * optimize the pipe utilization when using a single display; if the
+        * user connects to a second display, DC will avoid pipe split.
         */
        MPC_SPLIT_AVOID_MULT_DISP = 2,
 };
@@ -497,7 +497,7 @@ enum dcn_zstate_support_state {
 };
 
 /**
- * dc_clocks - DC pipe clocks
+ * struct dc_clocks - DC pipe clocks
  *
  * For any clocks that may differ per pipe only the max is stored in this
  * structure
@@ -528,7 +528,7 @@ struct dc_clocks {
        bool fclk_prev_p_state_change_support;
        int num_ways;
 
-       /**
+       /*
         * @fw_based_mclk_switching
         *
         * DC has a mechanism that leverage the variable refresh rate to switch