The documentation for drm_sched_backend_ops.run_job() mentions a certain
function called drm_sched_job_recovery(). This function does not exist.
What's actually meant is drm_sched_resubmit_jobs(), which is by now also
deprecated.
Remove the mention of the removed function.
Discourage the behavior of drm_sched_backend_ops.run_job() being called
multiple times for the same job.
Signed-off-by: Philipp Stanner <phasta@xxxxxxxxxx>
---
Folks, I need input for those "refcount" rules. I say that we either
delete that section or someone (Christian?) should provide details about
what those rules are, as Danilo requested.
P.
---
include/drm/gpu_scheduler.h | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h
index d5cd2a78f27c..cf40fdb55541 100644
--- a/include/drm/gpu_scheduler.h
+++ b/include/drm/gpu_scheduler.h
@@ -421,14 +421,19 @@ struct drm_sched_backend_ops {
/**
* @run_job: Called to execute the job once all of the dependencies
- * have been resolved. This may be called multiple times, if
- * timedout_job() has happened and drm_sched_job_recovery() decides to
- * try it again.
+ * have been resolved.
+ *
+ * The deprecated drm_sched_resubmit_jobs() (called from
+ * drm_sched_backend_ops.timedout_job()) can invoke this again with the
+ * same parameters. Doing this is strongly discouraged because it
+ * violates dma_fence rules.
*
* @sched_job: the job to run
*
- * Returns: dma_fence the driver must signal once the hardware has
- * completed the job ("hardware fence").
+ * Returns:
+ * On success: dma_fence the driver must signal once the hardware has
+ * completed the job ("hardware fence").
+ * On failure: NULL or an ERR_PTR.
*
* Note that the scheduler expects to 'inherit' its own reference to
* this fence from the callback. It does not invoke an extra
--
2.47.1
