summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Vetter <daniel.vetter@ffwll.ch>2016-07-27 14:34:59 +0200
committerDaniel Vetter <daniel.vetter@ffwll.ch>2016-07-27 15:43:25 +0200
commit9315399e6d0f99ef52a2b14385ce0bc1f2fac1b8 (patch)
treee757e3828a64d5ce64d7a8385f4f26b6f86ac329
parentded9958cd1dd49e2204a94d39ff55019fd89befb (diff)
docs: minimal docs for igt_vgem.c
Feeling somewhat lazy right now ;-) Cc: Chris Wilson <chris@chris-wilson.co.uk> Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
-rw-r--r--docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml1
-rw-r--r--lib/igt_vgem.c12
2 files changed, 13 insertions, 0 deletions
diff --git a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
index fab806cd..c862f2ad 100644
--- a/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
+++ b/docs/reference/intel-gpu-tools/intel-gpu-tools-docs.xml
@@ -31,6 +31,7 @@
<xi:include href="xml/intel_chipset.xml"/>
<xi:include href="xml/intel_io.xml"/>
<xi:include href="xml/igt_vc4.xml"/>
+ <xi:include href="xml/igt_vgem.xml"/>
</chapter>
<xi:include href="xml/igt_test_programs.xml"/>
diff --git a/lib/igt_vgem.c b/lib/igt_vgem.c
index 81c5a3b7..21cccb37 100644
--- a/lib/igt_vgem.c
+++ b/lib/igt_vgem.c
@@ -28,6 +28,18 @@
#include <sys/mman.h>
+/**
+ * SECTION:igt_vgem
+ * @short_description: VGEM support library
+ * @title: VGEM
+ * @include: igt.h
+ *
+ * This library provides various auxiliary helper functions for writing VGEM
+ * tests. VGEM is especially useful as a virtual dma-buf import and exporter and
+ * for testing cross driver synchronization (either using epxlicit dma-fences or
+ * using implicit fences attached to dma-bufs).
+ */
+
int __vgem_create(int fd, struct vgem_bo *bo)
{
struct drm_mode_create_dumb arg;