summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorDaniel Vetter <daniel.vetter@ffwll.ch>2015-02-06 11:06:11 +0100
committerDaniel Vetter <daniel.vetter@ffwll.ch>2015-02-13 09:35:35 +0100
commit15801b4dadfef1e754d415414ad931be639c85bf (patch)
treef1659a0db84368eb079cdd43ec55e79d639e6e0d /lib
parenta3e34ce258aae0602c38fd8020d49f1fd1c7a83f (diff)
igt/ioctls: doc for gem_mmap
Just spotted while driving around. gtkdoc needs the full parameter list otherwise it doesn't recognize it as a function. So add them. Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Diffstat (limited to 'lib')
-rw-r--r--lib/ioctl_wrappers.h11
1 files changed, 10 insertions, 1 deletions
diff --git a/lib/ioctl_wrappers.h b/lib/ioctl_wrappers.h
index 8d8fa46d..663b3da2 100644
--- a/lib/ioctl_wrappers.h
+++ b/lib/ioctl_wrappers.h
@@ -78,10 +78,19 @@ void *gem_mmap__wc(int fd, uint32_t handle, int offset, int size, int prot);
/**
* gem_mmap:
+ * @fd: open i915 drm file descriptor
+ * @handle: gem buffer object handle
+ * @size: size of the gem buffer
+ * @prot: memory protection bits as used by mmap()
+ *
+ * This functions wraps up procedure to establish a memory mapping through the
+ * GTT.
*
* This is a simple convenience alias to gem_mmap__gtt()
+ *
+ * Returns: A pointer to the created memory mapping.
*/
-#define gem_mmap gem_mmap__gtt
+#define gem_mmap(fd, handle, size, prot) gem_mmap__gtt(fd, handle, size, prot)
int gem_madvise(int fd, uint32_t handle, int state);