Re: [PATCH] drm/scheduler: fix param documentation
On Thu, Aug 9, 2018 at 5:48 AM, Nayan Deshmukh wrote: > We no longer have sched parameter so remove its description > as well > > Signed-off-by: Nayan Deshmukh Applied. Thanks! Alex > --- > drivers/gpu/drm/scheduler/gpu_scheduler.c | 4 > 1 file changed, 4 deletions(-) > > diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c > b/drivers/gpu/drm/scheduler/gpu_scheduler.c > index bfa86d5eb8ac..da2da8d85035 100644 > --- a/drivers/gpu/drm/scheduler/gpu_scheduler.c > +++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c > @@ -281,7 +281,6 @@ static void drm_sched_entity_kill_jobs_cb(struct > dma_fence *f, > /** > * drm_sched_entity_flush - Flush a context entity > * > - * @sched: scheduler instance > * @entity: scheduler entity > * @timeout: time to wait in for Q to become empty in jiffies. > * > @@ -324,7 +323,6 @@ EXPORT_SYMBOL(drm_sched_entity_flush); > /** > * drm_sched_entity_cleanup - Destroy a context entity > * > - * @sched: scheduler instance > * @entity: scheduler entity > * > * This should be called after @drm_sched_entity_do_release. It goes over the > @@ -389,7 +387,6 @@ EXPORT_SYMBOL(drm_sched_entity_fini); > /** > * drm_sched_entity_fini - Destroy a context entity > * > - * @sched: scheduler instance > * @entity: scheduler entity > * > * Calls drm_sched_entity_do_release() and drm_sched_entity_cleanup() > @@ -781,7 +778,6 @@ EXPORT_SYMBOL(drm_sched_job_recovery); > * drm_sched_job_init - init a scheduler job > * > * @job: scheduler job to init > - * @sched: scheduler instance > * @entity: scheduler entity to use > * @owner: job owner for debugging > * > -- > 2.14.3 > > ___ > dri-devel mailing list > dri-devel@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/dri-devel ___ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel
[PATCH] drm/scheduler: fix param documentation
We no longer have sched parameter so remove its description as well Signed-off-by: Nayan Deshmukh --- drivers/gpu/drm/scheduler/gpu_scheduler.c | 4 1 file changed, 4 deletions(-) diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c b/drivers/gpu/drm/scheduler/gpu_scheduler.c index bfa86d5eb8ac..da2da8d85035 100644 --- a/drivers/gpu/drm/scheduler/gpu_scheduler.c +++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c @@ -281,7 +281,6 @@ static void drm_sched_entity_kill_jobs_cb(struct dma_fence *f, /** * drm_sched_entity_flush - Flush a context entity * - * @sched: scheduler instance * @entity: scheduler entity * @timeout: time to wait in for Q to become empty in jiffies. * @@ -324,7 +323,6 @@ EXPORT_SYMBOL(drm_sched_entity_flush); /** * drm_sched_entity_cleanup - Destroy a context entity * - * @sched: scheduler instance * @entity: scheduler entity * * This should be called after @drm_sched_entity_do_release. It goes over the @@ -389,7 +387,6 @@ EXPORT_SYMBOL(drm_sched_entity_fini); /** * drm_sched_entity_fini - Destroy a context entity * - * @sched: scheduler instance * @entity: scheduler entity * * Calls drm_sched_entity_do_release() and drm_sched_entity_cleanup() @@ -781,7 +778,6 @@ EXPORT_SYMBOL(drm_sched_job_recovery); * drm_sched_job_init - init a scheduler job * * @job: scheduler job to init - * @sched: scheduler instance * @entity: scheduler entity to use * @owner: job owner for debugging * -- 2.14.3 ___ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel
Re: [PATCH] drm/scheduler: fix param documentation
On Thu, Mar 29, 2018 at 8:56 PM, Alex Deucher wrote: > On Tue, Mar 27, 2018 at 1:29 PM, Nayan Deshmukh > wrote: >> On Tue, Mar 27, 2018 at 1:47 PM, Daniel Vetter wrote: >>> On Mon, Mar 26, 2018 at 08:51:14PM +0530, Nayan Deshmukh wrote: Signed-off-by: Nayan Deshmukh >>> >>> You might want to add a kerneldoc page in Documentation/gpu/scheduler.rst, >>> which pulls in all the nice kerneldoc you have here + has a short intro >>> text what this is all about. >>> >> Yeah Sure. I'll send a patch for this in a while. > > FWIW, I started improving the documentation in the GPU scheduler last > week, but ran out of time to finish it. Here's the WIP patch. Feel > free to run with it. > This will be useful. I'll go over it during the weekend and probably send a patch early next week. Thanks > Alex > >> >> Cheers, >> Nayan >>> Cheers, Daniel >>> --- drivers/gpu/drm/scheduler/gpu_scheduler.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c b/drivers/gpu/drm/scheduler/gpu_scheduler.c index 0d95888ccc3e..1d368bc66ac2 100644 --- a/drivers/gpu/drm/scheduler/gpu_scheduler.c +++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c @@ -117,8 +117,9 @@ drm_sched_rq_select_entity(struct drm_sched_rq *rq) * @schedThe pointer to the scheduler * @entity The pointer to a valid drm_sched_entity * @rq The run queue this entity belongs - * @kernel If this is an entity for the kernel * @jobs The max number of jobs in the job queue + * @guilty atomic_t set to 1 when a job on this queue + * is found to be guilty causing a timeout * * return 0 if succeed. negative error code on failure */ -- 2.14.3 ___ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel >>> >>> -- >>> Daniel Vetter >>> Software Engineer, Intel Corporation >>> http://blog.ffwll.ch >> ___ >> dri-devel mailing list >> dri-devel@lists.freedesktop.org >> https://lists.freedesktop.org/mailman/listinfo/dri-devel ___ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel
Re: [PATCH] drm/scheduler: fix param documentation
On Tue, Mar 27, 2018 at 1:29 PM, Nayan Deshmukh
wrote:
> On Tue, Mar 27, 2018 at 1:47 PM, Daniel Vetter wrote:
>> On Mon, Mar 26, 2018 at 08:51:14PM +0530, Nayan Deshmukh wrote:
>>> Signed-off-by: Nayan Deshmukh
>>
>> You might want to add a kerneldoc page in Documentation/gpu/scheduler.rst,
>> which pulls in all the nice kerneldoc you have here + has a short intro
>> text what this is all about.
>>
> Yeah Sure. I'll send a patch for this in a while.
FWIW, I started improving the documentation in the GPU scheduler last
week, but ran out of time to finish it. Here's the WIP patch. Feel
free to run with it.
Alex
>
> Cheers,
> Nayan
>> Cheers, Daniel
>>
>>> ---
>>> drivers/gpu/drm/scheduler/gpu_scheduler.c | 3 ++-
>>> 1 file changed, 2 insertions(+), 1 deletion(-)
>>>
>>> diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c
>>> b/drivers/gpu/drm/scheduler/gpu_scheduler.c
>>> index 0d95888ccc3e..1d368bc66ac2 100644
>>> --- a/drivers/gpu/drm/scheduler/gpu_scheduler.c
>>> +++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c
>>> @@ -117,8 +117,9 @@ drm_sched_rq_select_entity(struct drm_sched_rq *rq)
>>> * @schedThe pointer to the scheduler
>>> * @entity The pointer to a valid drm_sched_entity
>>> * @rq The run queue this entity belongs
>>> - * @kernel If this is an entity for the kernel
>>> * @jobs The max number of jobs in the job queue
>>> + * @guilty atomic_t set to 1 when a job on this queue
>>> + * is found to be guilty causing a timeout
>>> *
>>> * return 0 if succeed. negative error code on failure
>>> */
>>> --
>>> 2.14.3
>>>
>>> ___
>>> dri-devel mailing list
>>> dri-devel@lists.freedesktop.org
>>> https://lists.freedesktop.org/mailman/listinfo/dri-devel
>>
>> --
>> Daniel Vetter
>> Software Engineer, Intel Corporation
>> http://blog.ffwll.ch
> ___
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
From 1b98337276bb86e0e6aeacffc4cf7ccfa06d7b55 Mon Sep 17 00:00:00 2001
From: Alex Deucher
Date: Tue, 20 Mar 2018 23:03:48 -0500
Subject: [PATCH] XXX: wip gpu scheduler documentation
Signed-off-by: Alex Deucher
---
drivers/gpu/drm/scheduler/gpu_scheduler.c | 160 ++
1 file changed, 121 insertions(+), 39 deletions(-)
diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c b/drivers/gpu/drm/scheduler/gpu_scheduler.c
index 0d95888ccc3e..635aec73d5f0 100644
--- a/drivers/gpu/drm/scheduler/gpu_scheduler.c
+++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c
@@ -39,7 +39,13 @@ static bool drm_sched_entity_is_ready(struct drm_sched_entity *entity);
static void drm_sched_wakeup(struct drm_gpu_scheduler *sched);
static void drm_sched_process_job(struct dma_fence *f, struct dma_fence_cb *cb);
-/* Initialize a given run queue struct */
+/**
+ * drm_sched_rq_init - initialize a given run queue struct
+ *
+ * @rq: scheduler run queue
+ *
+ * This function initializes a scheduler runqueue.
+ */
static void drm_sched_rq_init(struct drm_sched_rq *rq)
{
spin_lock_init(&rq->lock);
@@ -47,6 +53,14 @@ static void drm_sched_rq_init(struct drm_sched_rq *rq)
rq->current_entity = NULL;
}
+/**
+ * drm_sched_rq_add_entity - add an entity
+ *
+ * @rq: scheduler run queue
+ * @entity: scheduler entity
+ *
+ * This function adds a scheduling entity to the run queue.
+ */
static void drm_sched_rq_add_entity(struct drm_sched_rq *rq,
struct drm_sched_entity *entity)
{
@@ -57,6 +71,14 @@ static void drm_sched_rq_add_entity(struct drm_sched_rq *rq,
spin_unlock(&rq->lock);
}
+/**
+ * drm_sched_rq_remove_entity - remove an entity
+ *
+ * @rq: scheduler run queue
+ * @entity: scheduler entity
+ *
+ * This function removes a scheduling entity from the run queue.
+ */
static void drm_sched_rq_remove_entity(struct drm_sched_rq *rq,
struct drm_sched_entity *entity)
{
@@ -70,9 +92,9 @@ static void drm_sched_rq_remove_entity(struct drm_sched_rq *rq,
}
/**
- * Select an entity which could provide a job to run
+ * drm_sched_rq_select_entity - Select an entity which could provide a job to run
*
- * @rq The run queue to check.
+ * @rq: scheduler run queue to check.
*
* Try to find a ready entity, returns NULL if none found.
*/
@@ -112,16 +134,17 @@ drm_sched_rq_select_entity(struct drm_sched_rq *rq)
}
/**
- * Init a context entity used by scheduler when submit to HW ring.
+ * drm_sched_entity_init - init a context entity used by scheduler when submit to HW queue
*
- * @sched The pointer to the scheduler
- * @entity The pointer to a valid drm_sched_entity
- * @rq The run queue this entity belongs
- * @kernel If this is an entity for the kernel
- * @jobs The max number of jobs in the job queue
+ * @sched: scheduler instance
+ * @entity: scheduler entity
+ * @rq: scheduler run queue to which this entity belongs
+ * @kernel: if this is an entity for the kern
Re: [PATCH] drm/scheduler: fix param documentation
On Tue, Mar 27, 2018 at 1:47 PM, Daniel Vetter wrote: > On Mon, Mar 26, 2018 at 08:51:14PM +0530, Nayan Deshmukh wrote: >> Signed-off-by: Nayan Deshmukh > > You might want to add a kerneldoc page in Documentation/gpu/scheduler.rst, > which pulls in all the nice kerneldoc you have here + has a short intro > text what this is all about. > Yeah Sure. I'll send a patch for this in a while. Cheers, Nayan > Cheers, Daniel > >> --- >> drivers/gpu/drm/scheduler/gpu_scheduler.c | 3 ++- >> 1 file changed, 2 insertions(+), 1 deletion(-) >> >> diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c >> b/drivers/gpu/drm/scheduler/gpu_scheduler.c >> index 0d95888ccc3e..1d368bc66ac2 100644 >> --- a/drivers/gpu/drm/scheduler/gpu_scheduler.c >> +++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c >> @@ -117,8 +117,9 @@ drm_sched_rq_select_entity(struct drm_sched_rq *rq) >> * @schedThe pointer to the scheduler >> * @entity The pointer to a valid drm_sched_entity >> * @rq The run queue this entity belongs >> - * @kernel If this is an entity for the kernel >> * @jobs The max number of jobs in the job queue >> + * @guilty atomic_t set to 1 when a job on this queue >> + * is found to be guilty causing a timeout >> * >> * return 0 if succeed. negative error code on failure >> */ >> -- >> 2.14.3 >> >> ___ >> dri-devel mailing list >> dri-devel@lists.freedesktop.org >> https://lists.freedesktop.org/mailman/listinfo/dri-devel > > -- > Daniel Vetter > Software Engineer, Intel Corporation > http://blog.ffwll.ch ___ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel
Re: [PATCH] drm/scheduler: fix param documentation
On Mon, Mar 26, 2018 at 08:51:14PM +0530, Nayan Deshmukh wrote: > Signed-off-by: Nayan Deshmukh You might want to add a kerneldoc page in Documentation/gpu/scheduler.rst, which pulls in all the nice kerneldoc you have here + has a short intro text what this is all about. Cheers, Daniel > --- > drivers/gpu/drm/scheduler/gpu_scheduler.c | 3 ++- > 1 file changed, 2 insertions(+), 1 deletion(-) > > diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c > b/drivers/gpu/drm/scheduler/gpu_scheduler.c > index 0d95888ccc3e..1d368bc66ac2 100644 > --- a/drivers/gpu/drm/scheduler/gpu_scheduler.c > +++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c > @@ -117,8 +117,9 @@ drm_sched_rq_select_entity(struct drm_sched_rq *rq) > * @schedThe pointer to the scheduler > * @entity The pointer to a valid drm_sched_entity > * @rq The run queue this entity belongs > - * @kernel If this is an entity for the kernel > * @jobs The max number of jobs in the job queue > + * @guilty atomic_t set to 1 when a job on this queue > + * is found to be guilty causing a timeout > * > * return 0 if succeed. negative error code on failure > */ > -- > 2.14.3 > > ___ > dri-devel mailing list > dri-devel@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/dri-devel -- Daniel Vetter Software Engineer, Intel Corporation http://blog.ffwll.ch ___ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel
[PATCH] drm/scheduler: fix param documentation
There is no @kernel parameter anymore and document the @guilty parameter Signed-off-by: Nayan Deshmukh --- drivers/gpu/drm/scheduler/gpu_scheduler.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c b/drivers/gpu/drm/scheduler/gpu_scheduler.c index 0d95888ccc3e..1d368bc66ac2 100644 --- a/drivers/gpu/drm/scheduler/gpu_scheduler.c +++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c @@ -117,8 +117,9 @@ drm_sched_rq_select_entity(struct drm_sched_rq *rq) * @sched The pointer to the scheduler * @entity The pointer to a valid drm_sched_entity * @rq The run queue this entity belongs - * @kernel If this is an entity for the kernel * @jobs The max number of jobs in the job queue + * @guilty atomic_t set to 1 when a job on this queue + * is found to be guilty causing a timeout * * return 0 if succeed. negative error code on failure */ -- 2.14.3 ___ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel
Re: [PATCH] drm/scheduler: fix param documentation
A bit more commit message would be nice to have, like "There is no more @kernel parameter and document the new @guilty parameter". Am 26.03.2018 um 17:21 schrieb Nayan Deshmukh: Signed-off-by: Nayan Deshmukh With the commit message fixed the patch is Reviewed-by: Christian König . Christian. --- drivers/gpu/drm/scheduler/gpu_scheduler.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c b/drivers/gpu/drm/scheduler/gpu_scheduler.c index 0d95888ccc3e..1d368bc66ac2 100644 --- a/drivers/gpu/drm/scheduler/gpu_scheduler.c +++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c @@ -117,8 +117,9 @@ drm_sched_rq_select_entity(struct drm_sched_rq *rq) * @sched The pointer to the scheduler * @entityThe pointer to a valid drm_sched_entity * @rqThe run queue this entity belongs - * @kernel If this is an entity for the kernel * @jobs The max number of jobs in the job queue + * @guilty atomic_t set to 1 when a job on this queue + * is found to be guilty causing a timeout * * return 0 if succeed. negative error code on failure */ ___ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel
[PATCH] drm/scheduler: fix param documentation
Signed-off-by: Nayan Deshmukh --- drivers/gpu/drm/scheduler/gpu_scheduler.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/drivers/gpu/drm/scheduler/gpu_scheduler.c b/drivers/gpu/drm/scheduler/gpu_scheduler.c index 0d95888ccc3e..1d368bc66ac2 100644 --- a/drivers/gpu/drm/scheduler/gpu_scheduler.c +++ b/drivers/gpu/drm/scheduler/gpu_scheduler.c @@ -117,8 +117,9 @@ drm_sched_rq_select_entity(struct drm_sched_rq *rq) * @sched The pointer to the scheduler * @entity The pointer to a valid drm_sched_entity * @rq The run queue this entity belongs - * @kernel If this is an entity for the kernel * @jobs The max number of jobs in the job queue + * @guilty atomic_t set to 1 when a job on this queue + * is found to be guilty causing a timeout * * return 0 if succeed. negative error code on failure */ -- 2.14.3 ___ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel
