[PATCH] drm/amd/display: Address kdoc for eDP Panel Replay feature in 'amdgpu_dm_crtc_set_panel_sr_feature()'

[Chung, ChiaHsuan (Tom)]

Reviewed-by: Tom Chung <chiahsuan.chung at amd.com>

On 1/22/2024 12:14 PM, Srinivasan Shanmugam wrote:
> Fixes the below:
> drivers/gpu/drm/amd/amdgpu/../display/amdgpu_dm/amdgpu_dm_crtc.c:100: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>   * The DRM vblank counter enable/disable action is used as the trigger
>     to enable
>
> Cc: Sun peng Li<sunpeng.li at amd.com>
> Cc: Alex Hung<alex.hung at amd.com>
> Cc: Tom Chung<chiahsuan.chung at amd.com>
> Cc: Rodrigo Siqueira<Rodrigo.Siqueira at amd.com>
> Cc: Aurabindo Pillai<aurabindo.pillai at amd.com>
> Signed-off-by: Srinivasan Shanmugam<srinivasan.shanmugam at amd.com>
> ---
>   .../gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_crtc.c    | 11 +++++++++--
>   1 file changed, 9 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_crtc.c b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_crtc.c
> index f64c5ffed234..690b007805f6 100644
> --- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_crtc.c
> +++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm_crtc.c
> @@ -97,8 +97,9 @@ bool amdgpu_dm_crtc_vrr_active(struct dm_crtc_state *dm_state)
>   }
>   
>   /**
> - * The DRM vblank counter enable/disable action is used as the trigger to enable
> - * or disable various panel self-refresh features:
> + * amdgpu_dm_crtc_set_panel_sr_feature() - The DRM vblank counter
> + * enable/disable action is used as the trigger to enable or disable various
> + * panel self-refresh features:
>    *
>    * Panel Replay and PSR SU
>    * - Enable when:
> @@ -111,6 +112,12 @@ bool amdgpu_dm_crtc_vrr_active(struct dm_crtc_state *dm_state)
>    * PSR1
>    * - Enable condition same as above
>    * - Disable when vblank counter is enabled
> + *
> + * @vblank_work: is a pointer to a struct vblank_control_work object.
> + * @vblank_enabled: indicates whether the DRM vblank counter is currently
> + *                  enabled (true) or disabled (false).
> + * @allow_sr_entry: represents whether entry into the self-refresh mode is
> + *                  allowed (true) or not allowed (false).
>    */
>   static void amdgpu_dm_crtc_set_panel_sr_feature(
>   	struct vblank_control_work *vblank_work,
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.freedesktop.org/archives/amd-gfx/attachments/20240122/c49a34c0/attachment-0001.htm>