Re: [PATCH] drm/scheduler: quieten kernel-doc warnings
Seems to me better this way to avoid merge conflicts ?
Andrey
On 2022-04-04 11:33, Randy Dunlap wrote:
On 4/4/22 07:34, Andrey Grodzovsky wrote:
On 2022-04-04 00:25, Randy Dunlap wrote:
Fix kernel-doc warnings in gpu_scheduler.h and sched_main.c.
Quashes these warnings:
include/drm/gpu_scheduler.h:316: warning: Function parameter or member 'work'
not described in 'drm_sched_job'
Looks good to me except one point is that I already commited a fix for the
above warning to drm-misc-next.
OK. Do I need to send a v2 without the header file fix?
thanks.
include/drm/gpu_scheduler.h:332: warning: missing initial short description on
line:
* struct drm_sched_backend_ops
include/drm/gpu_scheduler.h:412: warning: missing initial short description on
line:
* struct drm_gpu_scheduler
include/drm/gpu_scheduler.h:461: warning: Function parameter or member 'dev'
not described in 'drm_gpu_scheduler'
drivers/gpu/drm/scheduler/sched_main.c:201: warning: missing initial short
description on line:
* drm_sched_dependency_optimized
drivers/gpu/drm/scheduler/sched_main.c:995: warning: Function parameter or
member 'dev' not described in 'drm_sched_init'
Fixes: 2d33948e4e00 ("drm/scheduler: add documentation")
Fixes: 8ab62eda177b ("drm/sched: Add device pointer to drm_gpu_scheduler")
Fixes: 542cff7893a3 ("drm/sched: Avoid lockdep spalt on killing a processes")
Signed-off-by: Randy Dunlap
Cc: David Airlie
Cc: Daniel Vetter
Cc: Andrey Grodzovsky
Cc: Nayan Deshmukh
Cc: Alex Deucher
Cc: Christian König
Cc: Jiawei Gu
Cc: dri-devel@lists.freedesktop.org
---
Feel free to make changes or suggest changes...
drivers/gpu/drm/scheduler/sched_main.c | 3 ++-
include/drm/gpu_scheduler.h | 10 ++
2 files changed, 8 insertions(+), 5 deletions(-)
--- linux-next-20220401.orig/drivers/gpu/drm/scheduler/sched_main.c
+++ linux-next-20220401/drivers/gpu/drm/scheduler/sched_main.c
@@ -198,7 +198,7 @@ static void drm_sched_job_done_cb(struct
}
/**
- * drm_sched_dependency_optimized
+ * drm_sched_dependency_optimized - test if the dependency can be optimized
*
* @fence: the dependency fence
* @entity: the entity which depends on the above fence
@@ -984,6 +984,7 @@ static int drm_sched_main(void *param)
* used
* @score: optional score atomic shared with other schedulers
* @name: name used for debugging
+ * @dev: target device
*
* Return 0 on success, otherwise error code.
*/
--- linux-next-20220401.orig/include/drm/gpu_scheduler.h
+++ linux-next-20220401/include/drm/gpu_scheduler.h
@@ -270,6 +270,7 @@ struct drm_sched_fence *to_drm_sched_fen
* @sched: the scheduler instance on which this job is scheduled.
* @s_fence: contains the fences for the scheduling of job.
* @finish_cb: the callback for the finished fence.
+ * @work: scheduler work queue
* @id: a unique id assigned to each job scheduled on the scheduler.
* @karma: increment on every hang caused by this job. If this exceeds the
hang
* limit of the scheduler then the job is marked guilty and will not
@@ -328,10 +329,10 @@ enum drm_gpu_sched_stat {
};
/**
- * struct drm_sched_backend_ops
+ * struct drm_sched_backend_ops - Define the backend operations
+ * called by the scheduler
*
- * Define the backend operations called by the scheduler,
- * these functions should be implemented in driver side.
+ * These functions should be implemented in the driver side.
*/
struct drm_sched_backend_ops {
/**
@@ -408,7 +409,7 @@ struct drm_sched_backend_ops {
};
/**
- * struct drm_gpu_scheduler
+ * struct drm_gpu_scheduler - scheduler instance-specific data
*
* @ops: backend operations provided by the driver.
* @hw_submission_limit: the max size of the hardware queue.
@@ -434,6 +435,7 @@ struct drm_sched_backend_ops {
* @_score: score used when the driver doesn't provide one
* @ready: marks if the underlying HW is ready to work
* @free_guilty: A hit to time out handler to free the guilty job.
+ * @dev: system device
*
* One scheduler is implemented for each hardware ring.
*/
Re: [PATCH] drm/scheduler: quieten kernel-doc warnings
On 4/4/22 07:34, Andrey Grodzovsky wrote:
> On 2022-04-04 00:25, Randy Dunlap wrote:
>> Fix kernel-doc warnings in gpu_scheduler.h and sched_main.c.
>>
>> Quashes these warnings:
>>
>> include/drm/gpu_scheduler.h:316: warning: Function parameter or member
>> 'work' not described in 'drm_sched_job'
>
> Looks good to me except one point is that I already commited a fix for the
> above warning to drm-misc-next.
>
OK. Do I need to send a v2 without the header file fix?
thanks.
>
>> include/drm/gpu_scheduler.h:332: warning: missing initial short description
>> on line:
>> * struct drm_sched_backend_ops
>> include/drm/gpu_scheduler.h:412: warning: missing initial short description
>> on line:
>> * struct drm_gpu_scheduler
>>
>> include/drm/gpu_scheduler.h:461: warning: Function parameter or member 'dev'
>> not described in 'drm_gpu_scheduler'
>> drivers/gpu/drm/scheduler/sched_main.c:201: warning: missing initial short
>> description on line:
>> * drm_sched_dependency_optimized
>> drivers/gpu/drm/scheduler/sched_main.c:995: warning: Function parameter or
>> member 'dev' not described in 'drm_sched_init'
>>
>> Fixes: 2d33948e4e00 ("drm/scheduler: add documentation")
>> Fixes: 8ab62eda177b ("drm/sched: Add device pointer to drm_gpu_scheduler")
>> Fixes: 542cff7893a3 ("drm/sched: Avoid lockdep spalt on killing a processes")
>> Signed-off-by: Randy Dunlap
>> Cc: David Airlie
>> Cc: Daniel Vetter
>> Cc: Andrey Grodzovsky
>> Cc: Nayan Deshmukh
>> Cc: Alex Deucher
>> Cc: Christian König
>> Cc: Jiawei Gu
>> Cc: dri-devel@lists.freedesktop.org
>> ---
>> Feel free to make changes or suggest changes...
>>
>> drivers/gpu/drm/scheduler/sched_main.c | 3 ++-
>> include/drm/gpu_scheduler.h | 10 ++
>> 2 files changed, 8 insertions(+), 5 deletions(-)
>>
>> --- linux-next-20220401.orig/drivers/gpu/drm/scheduler/sched_main.c
>> +++ linux-next-20220401/drivers/gpu/drm/scheduler/sched_main.c
>> @@ -198,7 +198,7 @@ static void drm_sched_job_done_cb(struct
>> }
>> /**
>> - * drm_sched_dependency_optimized
>> + * drm_sched_dependency_optimized - test if the dependency can be optimized
>> *
>> * @fence: the dependency fence
>> * @entity: the entity which depends on the above fence
>> @@ -984,6 +984,7 @@ static int drm_sched_main(void *param)
>> * used
>> * @score: optional score atomic shared with other schedulers
>> * @name: name used for debugging
>> + * @dev: target device
>> *
>> * Return 0 on success, otherwise error code.
>> */
>> --- linux-next-20220401.orig/include/drm/gpu_scheduler.h
>> +++ linux-next-20220401/include/drm/gpu_scheduler.h
>> @@ -270,6 +270,7 @@ struct drm_sched_fence *to_drm_sched_fen
>> * @sched: the scheduler instance on which this job is scheduled.
>> * @s_fence: contains the fences for the scheduling of job.
>> * @finish_cb: the callback for the finished fence.
>> + * @work: scheduler work queue
>> * @id: a unique id assigned to each job scheduled on the scheduler.
>> * @karma: increment on every hang caused by this job. If this exceeds the
>> hang
>> * limit of the scheduler then the job is marked guilty and will
>> not
>> @@ -328,10 +329,10 @@ enum drm_gpu_sched_stat {
>> };
>> /**
>> - * struct drm_sched_backend_ops
>> + * struct drm_sched_backend_ops - Define the backend operations
>> + * called by the scheduler
>> *
>> - * Define the backend operations called by the scheduler,
>> - * these functions should be implemented in driver side.
>> + * These functions should be implemented in the driver side.
>> */
>> struct drm_sched_backend_ops {
>> /**
>> @@ -408,7 +409,7 @@ struct drm_sched_backend_ops {
>> };
>> /**
>> - * struct drm_gpu_scheduler
>> + * struct drm_gpu_scheduler - scheduler instance-specific data
>> *
>> * @ops: backend operations provided by the driver.
>> * @hw_submission_limit: the max size of the hardware queue.
>> @@ -434,6 +435,7 @@ struct drm_sched_backend_ops {
>> * @_score: score used when the driver doesn't provide one
>> * @ready: marks if the underlying HW is ready to work
>> * @free_guilty: A hit to time out handler to free the guilty job.
>> + * @dev: system device
>> *
>> * One scheduler is implemented for each hardware ring.
>> */
--
~Randy
Re: [PATCH] drm/scheduler: quieten kernel-doc warnings
On 2022-04-04 00:25, Randy Dunlap wrote:
Fix kernel-doc warnings in gpu_scheduler.h and sched_main.c.
Quashes these warnings:
include/drm/gpu_scheduler.h:316: warning: Function parameter or member 'work'
not described in 'drm_sched_job'
Looks good to me except one point is that I already commited a fix for
the above warning to drm-misc-next.
Andrey
include/drm/gpu_scheduler.h:332: warning: missing initial short description on
line:
* struct drm_sched_backend_ops
include/drm/gpu_scheduler.h:412: warning: missing initial short description on
line:
* struct drm_gpu_scheduler
include/drm/gpu_scheduler.h:461: warning: Function parameter or member 'dev'
not described in 'drm_gpu_scheduler'
drivers/gpu/drm/scheduler/sched_main.c:201: warning: missing initial short
description on line:
* drm_sched_dependency_optimized
drivers/gpu/drm/scheduler/sched_main.c:995: warning: Function parameter or
member 'dev' not described in 'drm_sched_init'
Fixes: 2d33948e4e00 ("drm/scheduler: add documentation")
Fixes: 8ab62eda177b ("drm/sched: Add device pointer to drm_gpu_scheduler")
Fixes: 542cff7893a3 ("drm/sched: Avoid lockdep spalt on killing a processes")
Signed-off-by: Randy Dunlap
Cc: David Airlie
Cc: Daniel Vetter
Cc: Andrey Grodzovsky
Cc: Nayan Deshmukh
Cc: Alex Deucher
Cc: Christian König
Cc: Jiawei Gu
Cc: dri-devel@lists.freedesktop.org
---
Feel free to make changes or suggest changes...
drivers/gpu/drm/scheduler/sched_main.c |3 ++-
include/drm/gpu_scheduler.h| 10 ++
2 files changed, 8 insertions(+), 5 deletions(-)
--- linux-next-20220401.orig/drivers/gpu/drm/scheduler/sched_main.c
+++ linux-next-20220401/drivers/gpu/drm/scheduler/sched_main.c
@@ -198,7 +198,7 @@ static void drm_sched_job_done_cb(struct
}
/**
- * drm_sched_dependency_optimized
+ * drm_sched_dependency_optimized - test if the dependency can be optimized
*
* @fence: the dependency fence
* @entity: the entity which depends on the above fence
@@ -984,6 +984,7 @@ static int drm_sched_main(void *param)
*used
* @score: optional score atomic shared with other schedulers
* @name: name used for debugging
+ * @dev: target device
*
* Return 0 on success, otherwise error code.
*/
--- linux-next-20220401.orig/include/drm/gpu_scheduler.h
+++ linux-next-20220401/include/drm/gpu_scheduler.h
@@ -270,6 +270,7 @@ struct drm_sched_fence *to_drm_sched_fen
* @sched: the scheduler instance on which this job is scheduled.
* @s_fence: contains the fences for the scheduling of job.
* @finish_cb: the callback for the finished fence.
+ * @work: scheduler work queue
* @id: a unique id assigned to each job scheduled on the scheduler.
* @karma: increment on every hang caused by this job. If this exceeds the
hang
* limit of the scheduler then the job is marked guilty and will not
@@ -328,10 +329,10 @@ enum drm_gpu_sched_stat {
};
/**
- * struct drm_sched_backend_ops
+ * struct drm_sched_backend_ops - Define the backend operations
+ * called by the scheduler
*
- * Define the backend operations called by the scheduler,
- * these functions should be implemented in driver side.
+ * These functions should be implemented in the driver side.
*/
struct drm_sched_backend_ops {
/**
@@ -408,7 +409,7 @@ struct drm_sched_backend_ops {
};
/**
- * struct drm_gpu_scheduler
+ * struct drm_gpu_scheduler - scheduler instance-specific data
*
* @ops: backend operations provided by the driver.
* @hw_submission_limit: the max size of the hardware queue.
@@ -434,6 +435,7 @@ struct drm_sched_backend_ops {
* @_score: score used when the driver doesn't provide one
* @ready: marks if the underlying HW is ready to work
* @free_guilty: A hit to time out handler to free the guilty job.
+ * @dev: system device
*
* One scheduler is implemented for each hardware ring.
*/
Re: [PATCH] drm/scheduler: quieten kernel-doc warnings
Am 04.04.22 um 06:25 schrieb Randy Dunlap:
Fix kernel-doc warnings in gpu_scheduler.h and sched_main.c.
Quashes these warnings:
include/drm/gpu_scheduler.h:316: warning: Function parameter or member 'work'
not described in 'drm_sched_job'
include/drm/gpu_scheduler.h:332: warning: missing initial short description on
line:
* struct drm_sched_backend_ops
include/drm/gpu_scheduler.h:412: warning: missing initial short description on
line:
* struct drm_gpu_scheduler
include/drm/gpu_scheduler.h:461: warning: Function parameter or member 'dev'
not described in 'drm_gpu_scheduler'
drivers/gpu/drm/scheduler/sched_main.c:201: warning: missing initial short
description on line:
* drm_sched_dependency_optimized
drivers/gpu/drm/scheduler/sched_main.c:995: warning: Function parameter or
member 'dev' not described in 'drm_sched_init'
Fixes: 2d33948e4e00 ("drm/scheduler: add documentation")
Fixes: 8ab62eda177b ("drm/sched: Add device pointer to drm_gpu_scheduler")
Fixes: 542cff7893a3 ("drm/sched: Avoid lockdep spalt on killing a processes")
Signed-off-by: Randy Dunlap
Cc: David Airlie
Cc: Daniel Vetter
Cc: Andrey Grodzovsky
Cc: Nayan Deshmukh
Cc: Alex Deucher
Cc: Christian König
Cc: Jiawei Gu
Cc: dri-devel@lists.freedesktop.org
Acked-by: Christian König , but Andrey should
take a look as well.
---
Feel free to make changes or suggest changes...
drivers/gpu/drm/scheduler/sched_main.c |3 ++-
include/drm/gpu_scheduler.h| 10 ++
2 files changed, 8 insertions(+), 5 deletions(-)
--- linux-next-20220401.orig/drivers/gpu/drm/scheduler/sched_main.c
+++ linux-next-20220401/drivers/gpu/drm/scheduler/sched_main.c
@@ -198,7 +198,7 @@ static void drm_sched_job_done_cb(struct
}
/**
- * drm_sched_dependency_optimized
+ * drm_sched_dependency_optimized - test if the dependency can be optimized
*
* @fence: the dependency fence
* @entity: the entity which depends on the above fence
@@ -984,6 +984,7 @@ static int drm_sched_main(void *param)
*used
* @score: optional score atomic shared with other schedulers
* @name: name used for debugging
+ * @dev: target device
*
* Return 0 on success, otherwise error code.
*/
--- linux-next-20220401.orig/include/drm/gpu_scheduler.h
+++ linux-next-20220401/include/drm/gpu_scheduler.h
@@ -270,6 +270,7 @@ struct drm_sched_fence *to_drm_sched_fen
* @sched: the scheduler instance on which this job is scheduled.
* @s_fence: contains the fences for the scheduling of job.
* @finish_cb: the callback for the finished fence.
+ * @work: scheduler work queue
* @id: a unique id assigned to each job scheduled on the scheduler.
* @karma: increment on every hang caused by this job. If this exceeds the
hang
* limit of the scheduler then the job is marked guilty and will not
@@ -328,10 +329,10 @@ enum drm_gpu_sched_stat {
};
/**
- * struct drm_sched_backend_ops
+ * struct drm_sched_backend_ops - Define the backend operations
+ * called by the scheduler
*
- * Define the backend operations called by the scheduler,
- * these functions should be implemented in driver side.
+ * These functions should be implemented in the driver side.
*/
struct drm_sched_backend_ops {
/**
@@ -408,7 +409,7 @@ struct drm_sched_backend_ops {
};
/**
- * struct drm_gpu_scheduler
+ * struct drm_gpu_scheduler - scheduler instance-specific data
*
* @ops: backend operations provided by the driver.
* @hw_submission_limit: the max size of the hardware queue.
@@ -434,6 +435,7 @@ struct drm_sched_backend_ops {
* @_score: score used when the driver doesn't provide one
* @ready: marks if the underlying HW is ready to work
* @free_guilty: A hit to time out handler to free the guilty job.
+ * @dev: system device
*
* One scheduler is implemented for each hardware ring.
*/
