drm/amd/display: Add function banner for idle_workqueue
Subsystems (3)
PATCH 1/1 drm/amd/display: Add function banner for idle_workqueue
From: Roman Li <[email protected]>
[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 <[email protected]>
Signed-off-by Roman Li <[email protected]>
--- drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 13 +++++++++++++ 1 file changed, 13 insertions(+)
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +13 -0
@@ -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;
Signature · 1 line
2.34.1
Reviewed-by Aurabindo Pillai <[email protected]>
Quoted 49 lines · On 7/15/24 4:57 PM, [email protected] wrote:
From: Roman Li <[email protected]>
[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 foridle_workqueuewith param description.Reported-by Stephen Rothwell <[email protected]>Signed-off-by Roman Li <[email protected]>--- drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 13 +++++++++++++ 1 file changed, 13 insertions(+)drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h +13
-0@@ -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;
Signature · 4 lines
-- Thanks & Regards, Aurabindo Pillai