summaryrefslogtreecommitdiff
path: root/include/libcamera/base/private.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/libcamera/base/private.h')
-rw-r--r--include/libcamera/base/private.h22
1 files changed, 22 insertions, 0 deletions
diff --git a/include/libcamera/base/private.h b/include/libcamera/base/private.h
new file mode 100644
index 00000000..163012bf
--- /dev/null
+++ b/include/libcamera/base/private.h
@@ -0,0 +1,22 @@
+/* SPDX-License-Identifier: LGPL-2.1-or-later */
+/*
+ * Copyright (C) 2021, Google Inc.
+ *
+ * private.h - Private Header Validation
+ *
+ * A selection of internal libcamera headers are installed as part
+ * of the libcamera package to allow sharing of a select subset of
+ * internal functionality with IPA module only.
+ *
+ * This functionality is not considered part of the public libcamera
+ * API, and can therefore potentially face ABI instabilities which
+ * should not be exposed to applications. IPA modules however should be
+ * versioned and more closely matched to the libcamera installation.
+ *
+ * Components which include this file can not be included in any file
+ * which forms part of the libcamera API.
+ */
+
+#ifndef LIBCAMERA_BASE_PRIVATE
+#error "Private headers must not be included in the libcamera API"
+#endif