From 080b4929b7452dc1fea32ac1d32e7e571e7fb38b Mon Sep 17 00:00:00 2001 From: =?utf8?q?Kristian=20H=C3=B8gsberg?= Date: Sat, 28 Feb 2015 09:31:58 -0800 Subject: [PATCH] intel: Fix documentation for drm_intel_gem_bo_wait() MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit 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 Reviewed-by: Daniel Vetter --- intel/intel_bufmgr_gem.c | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/intel/intel_bufmgr_gem.c b/intel/intel_bufmgr_gem.c index 78875fd3..33d8fbc4 100644 --- a/intel/intel_bufmgr_gem.c +++ b/intel/intel_bufmgr_gem.c @@ -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 -- 2.11.0