[PATCH] drm/amd/display: Add function banner for idle_workqueue

[Aurabindo Pillai]

Reviewed-by: Aurabindo Pillai <aurabindo.pillai at amd.com>

On 7/15/24 4:57 PM, Roman.Li at amd.com wrote:
> From: Roman Li <Roman.Li at amd.com>
> 
> [Why]
> htmldocs warning:
> drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h: warning:
> Function parameter or struct member 'idle_workqueue' not described in
> 'amdgpu_display_manager'.
> 
> [How]
> Add comment section for idle_workqueue with param description.
> 
> Reported-by: Stephen Rothwell <sfr at canb.auug.org.au>
> Link: https://lore.kernel.org/dri-devel/20240715090211.736a9b4d@canb.auug.org.au/
> Signed-off-by: Roman Li <Roman.Li at amd.com>
> ---
>   drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 13 +++++++++++++
>   1 file changed, 13 insertions(+)
> 
> diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> index 369159c29bbe..2d7755e2b6c3 100644
> --- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> +++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> @@ -137,6 +137,13 @@ struct vblank_control_work {
>   	bool enable;
>   };
>   
> +/**
> + * struct idle_workqueue - Work data for periodic action in idle
> + * @work: Kernel work data for the work event
> + * @dm: amdgpu display manager device
> + * @enable: true if idle worker is enabled
> + * @running: true if idle worker is running
> + */
>   struct idle_workqueue {
>   	struct work_struct work;
>   	struct amdgpu_display_manager *dm;
> @@ -502,6 +509,12 @@ struct amdgpu_display_manager {
>   	 * Deferred work for vblank control events.
>   	 */
>   	struct workqueue_struct *vblank_control_workqueue;
> +
> +	/**
> +	 * @idle_workqueue:
> +	 *
> +	 * Periodic work for idle events.
> +	 */
>   	struct idle_workqueue *idle_workqueue;
>   
>   	struct drm_atomic_state *cached_state;

-- 
--

Thanks & Regards,
Aurabindo Pillai