diff options
| author | Christian König <christian.koenig@amd.com> | 2021-07-21 11:01:04 +0200 |
|---|---|---|
| committer | Christian König <christian.koenig@amd.com> | 2021-09-03 10:11:18 +0200 |
| commit | b83dcd753dbe42d5e7467ab65124f3d0a6002dc3 (patch) | |
| tree | cdf2a34fe1f684688851eadaaa5cd8d4d3d2a2fc /include/linux/dma-fence.h | |
| parent | cba3ae8b3238a943ddd4d49952ab6917c009c3de (diff) | |
dma-buf: clarify dma_fence_ops->wait documentation
This callback is pretty much deprecated and should not be used by new implementations.
Clarify that in the documentation as well.
Signed-off-by: Christian König <christian.koenig@amd.com>
Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Link: https://patchwork.freedesktop.org/patch/msgid/20210901120240.7339-2-christian.koenig@amd.com
Diffstat (limited to 'include/linux/dma-fence.h')
| -rw-r--r-- | include/linux/dma-fence.h | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/include/linux/dma-fence.h b/include/linux/dma-fence.h index 4cc119ab272f..a706b7bf51d7 100644 --- a/include/linux/dma-fence.h +++ b/include/linux/dma-fence.h @@ -214,19 +214,15 @@ struct dma_fence_ops { * Custom wait implementation, defaults to dma_fence_default_wait() if * not set. * - * The dma_fence_default_wait implementation should work for any fence, as long - * as @enable_signaling works correctly. This hook allows drivers to - * have an optimized version for the case where a process context is - * already available, e.g. if @enable_signaling for the general case - * needs to set up a worker thread. + * Deprecated and should not be used by new implementations. Only used + * by existing implementations which need special handling for their + * hardware reset procedure. * * Must return -ERESTARTSYS if the wait is intr = true and the wait was * interrupted, and remaining jiffies if fence has signaled, or 0 if wait * timed out. Can also return other error values on custom implementations, * which should be treated as if the fence is signaled. For example a hardware * lockup could be reported like that. - * - * This callback is optional. */ signed long (*wait)(struct dma_fence *fence, bool intr, signed long timeout); |