Message ID | 20220404213040.12912-1-rdunlap@infradead.org (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | [v2] drm/scheduler: quieten kernel-doc warnings | expand |
Reviewed-by: Andrey Grodzovsky <andrey.grodzovsky@amd.com> Andrey On 2022-04-04 17:30, Randy Dunlap wrote: > Fix kernel-doc warnings in gpu_scheduler.h and sched_main.c. > > Quashes these warnings: > > 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 <rdunlap@infradead.org> > Cc: David Airlie <airlied@linux.ie> > Cc: Daniel Vetter <daniel@ffwll.ch> > Cc: Andrey Grodzovsky <andrey.grodzovsky@amd.com> > Cc: Nayan Deshmukh <nayan26deshmukh@gmail.com> > Cc: Alex Deucher <alexander.deucher@amd.com> > Cc: Christian König <christian.koenig@amd.com> > Cc: Jiawei Gu <Jiawei.Gu@amd.com> > Cc: dri-devel@lists.freedesktop.org > Acked-by: Christian König <christian.koenig@amd.com> > --- > Feel free to make changes or suggest changes... > > v2: drop @work description (already done by Andrey) > > drivers/gpu/drm/scheduler/sched_main.c | 3 ++- > include/drm/gpu_scheduler.h | 9 +++++---- > 2 files changed, 7 insertions(+), 5 deletions(-) > > --- linux-next-20220404.orig/drivers/gpu/drm/scheduler/sched_main.c > +++ linux-next-20220404/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 &struct device > * > * Return 0 on success, otherwise error code. > */ > --- linux-next-20220404.orig/include/drm/gpu_scheduler.h > +++ linux-next-20220404/include/drm/gpu_scheduler.h > @@ -328,10 +328,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 +408,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 +434,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 &struct device > * > * One scheduler is implemented for each hardware ring. > */
ping? On 4/4/22 14:58, Andrey Grodzovsky wrote: > Reviewed-by: Andrey Grodzovsky <andrey.grodzovsky@amd.com> > Andrey > > On 2022-04-04 17:30, Randy Dunlap wrote: >> Fix kernel-doc warnings in gpu_scheduler.h and sched_main.c. >> >> Quashes these warnings: >> >> 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 <rdunlap@infradead.org> >> Cc: David Airlie <airlied@linux.ie> >> Cc: Daniel Vetter <daniel@ffwll.ch> >> Cc: Andrey Grodzovsky <andrey.grodzovsky@amd.com> >> Cc: Nayan Deshmukh <nayan26deshmukh@gmail.com> >> Cc: Alex Deucher <alexander.deucher@amd.com> >> Cc: Christian König <christian.koenig@amd.com> >> Cc: Jiawei Gu <Jiawei.Gu@amd.com> >> Cc: dri-devel@lists.freedesktop.org >> Acked-by: Christian König <christian.koenig@amd.com> >> --- >> Feel free to make changes or suggest changes... >> >> v2: drop @work description (already done by Andrey) >> >> drivers/gpu/drm/scheduler/sched_main.c | 3 ++- >> include/drm/gpu_scheduler.h | 9 +++++---- >> 2 files changed, 7 insertions(+), 5 deletions(-) >> >> --- linux-next-20220404.orig/drivers/gpu/drm/scheduler/sched_main.c >> +++ linux-next-20220404/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 &struct device >> * >> * Return 0 on success, otherwise error code. >> */ >> --- linux-next-20220404.orig/include/drm/gpu_scheduler.h >> +++ linux-next-20220404/include/drm/gpu_scheduler.h >> @@ -328,10 +328,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 +408,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 +434,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 &struct device >> * >> * One scheduler is implemented for each hardware ring. >> */
I RBed, see bellow. Andrey On 2022-08-31 14:34, Randy Dunlap wrote: > ping? > > On 4/4/22 14:58, Andrey Grodzovsky wrote: >> Reviewed-by: Andrey Grodzovsky <andrey.grodzovsky@amd.com> >> Andrey >> >> On 2022-04-04 17:30, Randy Dunlap wrote: >>> Fix kernel-doc warnings in gpu_scheduler.h and sched_main.c. >>> >>> Quashes these warnings: >>> >>> 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 <rdunlap@infradead.org> >>> Cc: David Airlie <airlied@linux.ie> >>> Cc: Daniel Vetter <daniel@ffwll.ch> >>> Cc: Andrey Grodzovsky <andrey.grodzovsky@amd.com> >>> Cc: Nayan Deshmukh <nayan26deshmukh@gmail.com> >>> Cc: Alex Deucher <alexander.deucher@amd.com> >>> Cc: Christian König <christian.koenig@amd.com> >>> Cc: Jiawei Gu <Jiawei.Gu@amd.com> >>> Cc: dri-devel@lists.freedesktop.org >>> Acked-by: Christian König <christian.koenig@amd.com> >>> --- >>> Feel free to make changes or suggest changes... >>> >>> v2: drop @work description (already done by Andrey) >>> >>> drivers/gpu/drm/scheduler/sched_main.c | 3 ++- >>> include/drm/gpu_scheduler.h | 9 +++++---- >>> 2 files changed, 7 insertions(+), 5 deletions(-) >>> >>> --- linux-next-20220404.orig/drivers/gpu/drm/scheduler/sched_main.c >>> +++ linux-next-20220404/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 &struct device >>> * >>> * Return 0 on success, otherwise error code. >>> */ >>> --- linux-next-20220404.orig/include/drm/gpu_scheduler.h >>> +++ linux-next-20220404/include/drm/gpu_scheduler.h >>> @@ -328,10 +328,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 +408,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 +434,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 &struct device >>> * >>> * One scheduler is implemented for each hardware ring. >>> */
On Tue, Sep 6, 2022 at 1:38 PM Andrey Grodzovsky <andrey.grodzovsky@amd.com> wrote: > > I RBed, see bellow. Can you push the patch to drm-misc? Alex > > Andrey > > On 2022-08-31 14:34, Randy Dunlap wrote: > > ping? > > > > On 4/4/22 14:58, Andrey Grodzovsky wrote: > >> Reviewed-by: Andrey Grodzovsky <andrey.grodzovsky@amd.com> > >> Andrey > >> > >> On 2022-04-04 17:30, Randy Dunlap wrote: > >>> Fix kernel-doc warnings in gpu_scheduler.h and sched_main.c. > >>> > >>> Quashes these warnings: > >>> > >>> 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 <rdunlap@infradead.org> > >>> Cc: David Airlie <airlied@linux.ie> > >>> Cc: Daniel Vetter <daniel@ffwll.ch> > >>> Cc: Andrey Grodzovsky <andrey.grodzovsky@amd.com> > >>> Cc: Nayan Deshmukh <nayan26deshmukh@gmail.com> > >>> Cc: Alex Deucher <alexander.deucher@amd.com> > >>> Cc: Christian König <christian.koenig@amd.com> > >>> Cc: Jiawei Gu <Jiawei.Gu@amd.com> > >>> Cc: dri-devel@lists.freedesktop.org > >>> Acked-by: Christian König <christian.koenig@amd.com> > >>> --- > >>> Feel free to make changes or suggest changes... > >>> > >>> v2: drop @work description (already done by Andrey) > >>> > >>> drivers/gpu/drm/scheduler/sched_main.c | 3 ++- > >>> include/drm/gpu_scheduler.h | 9 +++++---- > >>> 2 files changed, 7 insertions(+), 5 deletions(-) > >>> > >>> --- linux-next-20220404.orig/drivers/gpu/drm/scheduler/sched_main.c > >>> +++ linux-next-20220404/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 &struct device > >>> * > >>> * Return 0 on success, otherwise error code. > >>> */ > >>> --- linux-next-20220404.orig/include/drm/gpu_scheduler.h > >>> +++ linux-next-20220404/include/drm/gpu_scheduler.h > >>> @@ -328,10 +328,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 +408,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 +434,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 &struct device > >>> * > >>> * One scheduler is implemented for each hardware ring. > >>> */
Pushed to drm-misc-next Andrey On 2022-09-06 13:57, Alex Deucher wrote: > On Tue, Sep 6, 2022 at 1:38 PM Andrey Grodzovsky > <andrey.grodzovsky@amd.com> wrote: >> I RBed, see bellow. > Can you push the patch to drm-misc? > > Alex > >> Andrey >> >> On 2022-08-31 14:34, Randy Dunlap wrote: >>> ping? >>> >>> On 4/4/22 14:58, Andrey Grodzovsky wrote: >>>> Reviewed-by: Andrey Grodzovsky <andrey.grodzovsky@amd.com> >>>> Andrey >>>> >>>> On 2022-04-04 17:30, Randy Dunlap wrote: >>>>> Fix kernel-doc warnings in gpu_scheduler.h and sched_main.c. >>>>> >>>>> Quashes these warnings: >>>>> >>>>> 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 <rdunlap@infradead.org> >>>>> Cc: David Airlie <airlied@linux.ie> >>>>> Cc: Daniel Vetter <daniel@ffwll.ch> >>>>> Cc: Andrey Grodzovsky <andrey.grodzovsky@amd.com> >>>>> Cc: Nayan Deshmukh <nayan26deshmukh@gmail.com> >>>>> Cc: Alex Deucher <alexander.deucher@amd.com> >>>>> Cc: Christian König <christian.koenig@amd.com> >>>>> Cc: Jiawei Gu <Jiawei.Gu@amd.com> >>>>> Cc: dri-devel@lists.freedesktop.org >>>>> Acked-by: Christian König <christian.koenig@amd.com> >>>>> --- >>>>> Feel free to make changes or suggest changes... >>>>> >>>>> v2: drop @work description (already done by Andrey) >>>>> >>>>> drivers/gpu/drm/scheduler/sched_main.c | 3 ++- >>>>> include/drm/gpu_scheduler.h | 9 +++++---- >>>>> 2 files changed, 7 insertions(+), 5 deletions(-) >>>>> >>>>> --- linux-next-20220404.orig/drivers/gpu/drm/scheduler/sched_main.c >>>>> +++ linux-next-20220404/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 &struct device >>>>> * >>>>> * Return 0 on success, otherwise error code. >>>>> */ >>>>> --- linux-next-20220404.orig/include/drm/gpu_scheduler.h >>>>> +++ linux-next-20220404/include/drm/gpu_scheduler.h >>>>> @@ -328,10 +328,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 +408,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 +434,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 &struct device >>>>> * >>>>> * One scheduler is implemented for each hardware ring. >>>>> */
--- linux-next-20220404.orig/drivers/gpu/drm/scheduler/sched_main.c +++ linux-next-20220404/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 &struct device * * Return 0 on success, otherwise error code. */ --- linux-next-20220404.orig/include/drm/gpu_scheduler.h +++ linux-next-20220404/include/drm/gpu_scheduler.h @@ -328,10 +328,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 +408,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 +434,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 &struct device * * One scheduler is implemented for each hardware ring. */