public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH] drm/panthor: Fix kernel-doc warning in panthor_sched.c
@ 2026-04-05 19:23 Yicong Hui
  2026-04-07  6:58 ` Boris Brezillon
  2026-04-08  8:57 ` Steven Price
  0 siblings, 2 replies; 3+ messages in thread
From: Yicong Hui @ 2026-04-05 19:23 UTC (permalink / raw)
  To: boris.brezillon, steven.price
  Cc: dri-devel, linux-kernel, skhan, me, Yicong Hui

Fix the following W=1 kerneldoc warnings by adding the missing parameter
descriptions for @ptdev and @events in panthor_sched_report_fw_events()
and @ptdev in panthor_sched_report_mmu_fault()

Warning: drivers/gpu/drm/panthor/panthor_sched.c:1898 function parameter 'ptdev' not described in 'panthor_sched_report_fw_events'
Warning: drivers/gpu/drm/panthor/panthor_sched.c:1898 function parameter 'events' not described in 'panthor_sched_report_fw_events'
Warning: drivers/gpu/drm/panthor/panthor_sched.c:2783 function parameter 'ptdev' not described in 'panthor_sched_report_mmu_fault'

Fixes: de8548813824 ("drm/panthor: Add the scheduler logical block")
Signed-off-by: Yicong Hui <yiconghui@gmail.com>
---
 drivers/gpu/drm/panthor/panthor_sched.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/drivers/gpu/drm/panthor/panthor_sched.c b/drivers/gpu/drm/panthor/panthor_sched.c
index a70f1db0764e..2d6dc5db4148 100644
--- a/drivers/gpu/drm/panthor/panthor_sched.c
+++ b/drivers/gpu/drm/panthor/panthor_sched.c
@@ -1894,6 +1894,8 @@ static void process_fw_events_work(struct work_struct *work)
 
 /**
  * panthor_sched_report_fw_events() - Report FW events to the scheduler.
+ * @ptdev: Device.
+ * @events: Bitmask of pending FW events to report.
  */
 void panthor_sched_report_fw_events(struct panthor_device *ptdev, u32 events)
 {
@@ -2779,6 +2781,7 @@ static void panthor_group_start(struct panthor_group *group)
 
 /**
  * panthor_sched_report_mmu_fault() - Report MMU faults to the scheduler.
+ * @ptdev: Device.
  */
 void panthor_sched_report_mmu_fault(struct panthor_device *ptdev)
 {
-- 
2.53.0


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH] drm/panthor: Fix kernel-doc warning in panthor_sched.c
  2026-04-05 19:23 [PATCH] drm/panthor: Fix kernel-doc warning in panthor_sched.c Yicong Hui
@ 2026-04-07  6:58 ` Boris Brezillon
  2026-04-08  8:57 ` Steven Price
  1 sibling, 0 replies; 3+ messages in thread
From: Boris Brezillon @ 2026-04-07  6:58 UTC (permalink / raw)
  To: Yicong Hui; +Cc: steven.price, dri-devel, linux-kernel, skhan, me

On Sun,  5 Apr 2026 20:23:09 +0100
Yicong Hui <yiconghui@gmail.com> wrote:

> Fix the following W=1 kerneldoc warnings by adding the missing parameter
> descriptions for @ptdev and @events in panthor_sched_report_fw_events()
> and @ptdev in panthor_sched_report_mmu_fault()
> 
> Warning: drivers/gpu/drm/panthor/panthor_sched.c:1898 function parameter 'ptdev' not described in 'panthor_sched_report_fw_events'
> Warning: drivers/gpu/drm/panthor/panthor_sched.c:1898 function parameter 'events' not described in 'panthor_sched_report_fw_events'
> Warning: drivers/gpu/drm/panthor/panthor_sched.c:2783 function parameter 'ptdev' not described in 'panthor_sched_report_mmu_fault'
> 
> Fixes: de8548813824 ("drm/panthor: Add the scheduler logical block")
> Signed-off-by: Yicong Hui <yiconghui@gmail.com>

Reviewed-by: Boris Brezillon <boris.brezillon@collabora.com>

> ---
>  drivers/gpu/drm/panthor/panthor_sched.c | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/drivers/gpu/drm/panthor/panthor_sched.c b/drivers/gpu/drm/panthor/panthor_sched.c
> index a70f1db0764e..2d6dc5db4148 100644
> --- a/drivers/gpu/drm/panthor/panthor_sched.c
> +++ b/drivers/gpu/drm/panthor/panthor_sched.c
> @@ -1894,6 +1894,8 @@ static void process_fw_events_work(struct work_struct *work)
>  
>  /**
>   * panthor_sched_report_fw_events() - Report FW events to the scheduler.
> + * @ptdev: Device.
> + * @events: Bitmask of pending FW events to report.
>   */
>  void panthor_sched_report_fw_events(struct panthor_device *ptdev, u32 events)
>  {
> @@ -2779,6 +2781,7 @@ static void panthor_group_start(struct panthor_group *group)
>  
>  /**
>   * panthor_sched_report_mmu_fault() - Report MMU faults to the scheduler.
> + * @ptdev: Device.
>   */
>  void panthor_sched_report_mmu_fault(struct panthor_device *ptdev)
>  {


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] drm/panthor: Fix kernel-doc warning in panthor_sched.c
  2026-04-05 19:23 [PATCH] drm/panthor: Fix kernel-doc warning in panthor_sched.c Yicong Hui
  2026-04-07  6:58 ` Boris Brezillon
@ 2026-04-08  8:57 ` Steven Price
  1 sibling, 0 replies; 3+ messages in thread
From: Steven Price @ 2026-04-08  8:57 UTC (permalink / raw)
  To: Yicong Hui, boris.brezillon; +Cc: dri-devel, linux-kernel, skhan, me

On 05/04/2026 20:23, Yicong Hui wrote:
> Fix the following W=1 kerneldoc warnings by adding the missing parameter
> descriptions for @ptdev and @events in panthor_sched_report_fw_events()
> and @ptdev in panthor_sched_report_mmu_fault()
> 
> Warning: drivers/gpu/drm/panthor/panthor_sched.c:1898 function parameter 'ptdev' not described in 'panthor_sched_report_fw_events'
> Warning: drivers/gpu/drm/panthor/panthor_sched.c:1898 function parameter 'events' not described in 'panthor_sched_report_fw_events'
> Warning: drivers/gpu/drm/panthor/panthor_sched.c:2783 function parameter 'ptdev' not described in 'panthor_sched_report_mmu_fault'
> 
> Fixes: de8548813824 ("drm/panthor: Add the scheduler logical block")
> Signed-off-by: Yicong Hui <yiconghui@gmail.com>

Reviewed-by: Steven Price <steven.price@arm.com>

Thanks, I actually have a patch I've been meaning to send for this.
There's a few more kerneldoc issues in this file (documentation doesn't
get output but there's no warning) - I'll push this to drm-misc-next and
send a patch for the remaining issues.

Thanks,
Steve

> ---
>  drivers/gpu/drm/panthor/panthor_sched.c | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/drivers/gpu/drm/panthor/panthor_sched.c b/drivers/gpu/drm/panthor/panthor_sched.c
> index a70f1db0764e..2d6dc5db4148 100644
> --- a/drivers/gpu/drm/panthor/panthor_sched.c
> +++ b/drivers/gpu/drm/panthor/panthor_sched.c
> @@ -1894,6 +1894,8 @@ static void process_fw_events_work(struct work_struct *work)
>  
>  /**
>   * panthor_sched_report_fw_events() - Report FW events to the scheduler.
> + * @ptdev: Device.
> + * @events: Bitmask of pending FW events to report.
>   */
>  void panthor_sched_report_fw_events(struct panthor_device *ptdev, u32 events)
>  {
> @@ -2779,6 +2781,7 @@ static void panthor_group_start(struct panthor_group *group)
>  
>  /**
>   * panthor_sched_report_mmu_fault() - Report MMU faults to the scheduler.
> + * @ptdev: Device.
>   */
>  void panthor_sched_report_mmu_fault(struct panthor_device *ptdev)
>  {


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2026-04-08  8:57 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-04-05 19:23 [PATCH] drm/panthor: Fix kernel-doc warning in panthor_sched.c Yicong Hui
2026-04-07  6:58 ` Boris Brezillon
2026-04-08  8:57 ` Steven Price

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox