1 files changed, 126 insertions, 0 deletions
diff --git a/platform/linux-generic/include/api/odp/shared_memory.h b/platform/linux-generic/include/api/odp/shared_memory.h
new file mode 100644
index 0000000..222fcd3
--- /dev/null
+++ b/platform/linux-generic/include/api/odp/shared_memory.h
@@ -0,0 +1,126 @@
+/* Copyright (c) 2013-2014, Linaro Limited
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier:     BSD-3-Clause
+ */
+
+
+/**
+ * @file
+ *
+ * ODP shared memory
+ */
+
+#ifndef ODP_SHARED_MEMORY_H_
+#define ODP_SHARED_MEMORY_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+#include <odp/std_types.h>
+#include <odp/platform_types.h>
+
+/** @defgroup odp_shared_memory ODP SHARED MEMORY
+ *  Operations on shared memory.
+ *  @{
+ */
+
+/** Maximum shared memory block name length in chars */
+#define ODP_SHM_NAME_LEN 32
+
+/*
+ * Shared memory flags
+ */
+
+/* Share level */
+#define ODP_SHM_SW_ONLY 0x1 /**< Application SW only, no HW access */
+#define ODP_SHM_PROC    0x2 /**< Share with external processes */
+
+/**
+ * Shared memory block info
+ */
+typedef struct odp_shm_info_t {
+	const char *name;      /**< Block name */
+	void       *addr;      /**< Block address */
+	uint64_t    size;      /**< Block size in bytes */
+	uint64_t    page_size; /**< Memory page size */
+	uint32_t    flags;     /**< ODP_SHM_* flags */
+} odp_shm_info_t;
+
+
+/**
+ * Reserve a contiguous block of shared memory
+ *
+ * @param[in] name   Name of the block (maximum ODP_SHM_NAME_LEN - 1 chars)
+ * @param[in] size   Block size in bytes
+ * @param[in] align  Block alignment in bytes
+ * @param[in] flags  Shared memory parameter flags (ODP_SHM_*).
+ *                   Default value is 0.
+ *
+ * @return Pointer to the reserved block, or NULL
+ */
+odp_shm_t odp_shm_reserve(const char *name, uint64_t size, uint64_t align,
+			  uint32_t flags);
+
+/**
+ * Free a contiguous block of shared memory
+ *
+ * Frees a previously reserved block of shared memory.
+ * @note Freeing memory that is in use will result in UNDEFINED behavior
+ *
+ * @param[in] shm Block handle
+ *
+ * @retval 0 if the handle is already free
+ * @retval 0 if the handle free succeeds
+ * @retval -1 on failure to free the handle
+ */
+int odp_shm_free(odp_shm_t shm);
+
+/**
+ * Lookup for a block of shared memory
+ *
+ * @param[in] name   Name of the block
+ *
+ * @return A handle to the block if it is found by name
+ * @retval #ODP_SHM_INVALID if the block is not found
+ */
+odp_shm_t odp_shm_lookup(const char *name);
+
+
+/**
+ * Shared memory block address
+ *
+ * @param[in] shm   Block handle
+ *
+ * @return Memory block address, or NULL on error
+ */
+void *odp_shm_addr(odp_shm_t shm);
+
+
+/**
+ * Shared memory block info
+ *
+ * @param[in]  shm   Block handle
+ * @param[out] info  Block info pointer for output
+ *
+ * @return 0 on success, otherwise non-zero
+ */
+int odp_shm_info(odp_shm_t shm, odp_shm_info_t *info);
+
+
+/**
+ * Print all shared memory blocks
+ */
+void odp_shm_print_all(void);
+
+/**
+ * @}
+ */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif