lib: Add some syncobj helpers (v2)

[airlied: added some initial gtk-doc for the helper library.]

Reviewed-by: Dave Airlie <airlied@redhat.com>
Signed-off-by: Jason Ekstrand <jason@jlekstrand.net>

1 files changed, 71 insertions, 0 deletions

diff --git a/lib/igt_syncobj.h b/lib/igt_syncobj.h
new file mode 100644
index 00000000..44d1378d
--- /dev/null
+++ b/lib/igt_syncobj.h
@@ -0,0 +1,71 @@
+/*
+ * Copyright © 2017 Intel Corporation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+
+#ifndef IGT_SYNCOBJ_H
+#define IGT_SYNCOBJ_H
+
+#include <stdint.h>
+#include <stdbool.h>
+#include <drm.h>
+
+#define LOCAL_SYNCOBJ_CREATE_SIGNALED (1 << 0)
+
+#define LOCAL_SYNCOBJ_WAIT_FLAGS_WAIT_ALL (1 << 0)
+#define LOCAL_SYNCOBJ_WAIT_FLAGS_WAIT_FOR_SUBMIT (1 << 1)
+struct local_syncobj_wait {
+       __u64 handles;
+       /* absolute timeout */
+       __s64 timeout_nsec;
+       __u32 count_handles;
+       __u32 flags;
+       __u32 first_signaled; /* only valid when not waiting all */
+       __u32 pad;
+};
+
+struct local_syncobj_array {
+       __u64 handles;
+       __u32 count_handles;
+       __u32 pad;
+};
+
+#define LOCAL_IOCTL_SYNCOBJ_WAIT	DRM_IOWR(0xC3, struct local_syncobj_wait)
+#define LOCAL_IOCTL_SYNCOBJ_RESET	DRM_IOWR(0xC4, struct local_syncobj_array)
+#define LOCAL_IOCTL_SYNCOBJ_SIGNAL	DRM_IOWR(0xC5, struct local_syncobj_array)
+
+uint32_t syncobj_create(int fd, uint32_t flags);
+void syncobj_destroy(int fd, uint32_t handle);
+int __syncobj_handle_to_fd(int fd, struct drm_syncobj_handle *args);
+int __syncobj_fd_to_handle(int fd, struct drm_syncobj_handle *args);
+int syncobj_handle_to_fd(int fd, uint32_t handle, uint32_t flags);
+uint32_t syncobj_fd_to_handle(int fd, int syncobj_fd, uint32_t flags);
+void syncobj_import_sync_file(int fd, uint32_t handle, int sync_file);
+int __syncobj_wait(int fd, struct local_syncobj_wait *args);
+int syncobj_wait_err(int fd, uint32_t *handles, uint32_t count,
+		     uint64_t abs_timeout_nsec, uint32_t flags);
+bool syncobj_wait(int fd, uint32_t *handles, uint32_t count,
+		  uint64_t abs_timeout_nsec, uint32_t flags,
+		  uint32_t *first_signaled);
+void syncobj_reset(int fd, uint32_t *handles, uint32_t count);
+void syncobj_signal(int fd, uint32_t *handles, uint32_t count);
+
+#endif /* IGT_SYNCOBJ_H */