intel: Fix documentation for drm_intel_gem_bo_wait()
The kernel doesn't actually wait indefinately when passed a negative, timeout, it returns immediately. Document this and suggest using INT64_MAX for indefinite waits. Signed-off-by: Kristian Høgsberg <krh@bitplanet.net> Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>main
parent
f799a527db
commit
080b4929b7
|
@ -1655,12 +1655,14 @@ drm_intel_gem_bo_wait_rendering(drm_intel_bo *bo)
|
|||
*
|
||||
* @bo: buffer object to wait for
|
||||
* @timeout_ns: amount of time to wait in nanoseconds.
|
||||
* If value is less than 0, an infinite wait will occur.
|
||||
* If value is less than or equal to 0, return immediately.
|
||||
*
|
||||
* Returns 0 if the wait was successful ie. the last batch referencing the
|
||||
* object has completed within the allotted time. Otherwise some negative return
|
||||
* value describes the error. Of particular interest is -ETIME when the wait has
|
||||
* failed to yield the desired result.
|
||||
* Returns 0 if the wait was successful ie. the last batch referencing
|
||||
* the object has completed within the allotted time. Otherwise some
|
||||
* negative return value describes the error. Of particular interest
|
||||
* is -ETIME when the wait has failed to yield the desired result.
|
||||
* Use a timeout of INT64_MAX to wait indefinitely (well, at least 292
|
||||
* years).
|
||||
*
|
||||
* Similar to drm_intel_gem_bo_wait_rendering except a timeout parameter allows
|
||||
* the operation to give up after a certain amount of time. Another subtle
|
||||
|
|
Loading…
Reference in New Issue