diff options
| author | Daniel Vetter <daniel.vetter@ffwll.ch> | 2016-05-11 17:06:28 +0200 |
|---|---|---|
| committer | Daniel Vetter <daniel.vetter@ffwll.ch> | 2016-05-12 11:37:21 +0200 |
| commit | d7050f9f79fee8fb7c790f355c984d9e5141e1c5 (patch) | |
| tree | ea1ff5b7b729b0fc22f29ee5af8df8860ae6c7e8 /lib/ioctl_wrappers.h | |
| parent | 701d8fdb363443453c4b613e9180f75ad36a7321 (diff) | |
lib/igt_aux: Polish docs for igt_interruptible
- Give __ prefix to internal funcstion and structs, only
igt_interruptible is used by tests.
- Move docs to igt_interruptible and adjust.
- Explain more clearly how the timeout is getting doubled each
iteration until no more interruptions happen. Also rename the
argument to give it a more meaningful name in the docs.
- Link from other functions to this one for cross-referencing.
- Rename to igt_do_interruptible to make it clearer it's a loop,
inspired by do {} while () loops.
v2: Rename instead to igt_while_interruptible and fix typos (Chris).
And add gtk-doc for igt_ioctl, too.
Acked-by: Chris Wilson <chris@chris-wilson.co.uk>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Diffstat (limited to 'lib/ioctl_wrappers.h')
| -rw-r--r-- | lib/ioctl_wrappers.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/ioctl_wrappers.h b/lib/ioctl_wrappers.h index 8fe35b0c..f3bd23f5 100644 --- a/lib/ioctl_wrappers.h +++ b/lib/ioctl_wrappers.h @@ -35,6 +35,15 @@ #include <intel_bufmgr.h> #include <i915_drm.h> +/** + * igt_ioctl: + * @fd: file descriptor + * @request: IOCTL request number + * @arg: argument pointer + * + * This is a wrapper around drmIoctl(), which can be augmented with special code + * blocks like #igt_while_interruptible. + */ extern int (*igt_ioctl)(int fd, unsigned long request, void *arg); /* libdrm interfacing */ |