pan/decode: Split public.h out

We want a defined ABI for tracing; this set of functions should be as
small as strictly necessary to minimize panwrap shenanigans.

Signed-off-by: Alyssa Rosenzweig <[email protected]>

2 files changed, 53 insertions, 12 deletions

diff --git a/src/panfrost/pandecode/decode.h b/src/panfrost/pandecode/decode.h
index 293203b1472..7d29ae80bff 100644
--- a/src/panfrost/pandecode/decode.h
+++ b/src/panfrost/pandecode/decode.h
@@ -26,10 +26,7 @@
 #ifndef __PAN_DECODE_H__
 #define __PAN_DECODE_H__
 
-#include <stdio.h>
-#include <stdlib.h>
-#include <stddef.h>
-#include <inttypes.h>
+#include "public.h"
 #include "util/list.h"
 
 struct pandecode_mapped_memory {
@@ -43,15 +40,10 @@ struct pandecode_mapped_memory {
         char name[32];
 };
 
-void pandecode_initialize(void);
-
 char *pointer_as_memory_reference(uint64_t ptr);
 
 struct pandecode_mapped_memory *pandecode_find_mapped_gpu_mem_containing(uint64_t addr);
 
-void
-pandecode_inject_mmap(uint64_t gpu_va, void *cpu, unsigned sz, const char *name);
-
 static inline void *
 __pandecode_fetch_gpu_mem(const struct pandecode_mapped_memory *mem,
                           uint64_t gpu_va, size_t size,
@@ -87,7 +79,4 @@ __pandecode_fetch_gpu_mem(const struct pandecode_mapped_memory *mem,
 	name = __pandecode_fetch_gpu_mem(mem, gpu_va, sizeof(*name), \
 				       __LINE__, __FILE__)
 
-/* Common entrypoint */
-int pandecode_jc(uint64_t jc_gpu_va, bool bifrost);
-
 #endif /* __MMAP_TRACE_H__ */
diff --git a/src/panfrost/pandecode/public.h b/src/panfrost/pandecode/public.h
new file mode 100644
index 00000000000..b52324c784d
--- /dev/null
+++ b/src/panfrost/pandecode/public.h
@@ -0,0 +1,52 @@
+
+/*
+ * Copyright (C) 2017-2019 Lyude Paul
+ * Copyright (C) 2017-2019 Alyssa Rosenzweig
+ *
+ * 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 __PAN_DECODE_PUBLIC_H__
+#define __PAN_DECODE_PUBLIC_H__
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <stddef.h>
+#include <stdbool.h>
+#include <inttypes.h>
+
+/* Public entrypoints for the tracing infrastructure. This API should be kept
+ * more or less stable. Don't feel bad if you have to change it; just feel
+ * slightly guilty about creating more work for me later. -Alyssa <3
+ *
+ * I'm joking. Mostly. panwrap (out-of-tree) includes this, so update that if
+ * you need to change something here. panwrap is open-source but cannot be
+ * included in-tree.
+ */
+
+void pandecode_initialize(void);
+
+void
+pandecode_inject_mmap(uint64_t gpu_va, void *cpu, unsigned sz, const char *name);
+
+int pandecode_jc(uint64_t jc_gpu_va, bool bifrost);
+
+#endif /* __MMAP_TRACE_H__ */