aboutsummaryrefslogtreecommitdiff
path: root/platform/linux-generic/include/api/odp/buffer.h
diff options
context:
space:
mode:
Diffstat (limited to 'platform/linux-generic/include/api/odp/buffer.h')
-rw-r--r--platform/linux-generic/include/api/odp/buffer.h107
1 files changed, 107 insertions, 0 deletions
diff --git a/platform/linux-generic/include/api/odp/buffer.h b/platform/linux-generic/include/api/odp/buffer.h
new file mode 100644
index 000000000..41d48a183
--- /dev/null
+++ b/platform/linux-generic/include/api/odp/buffer.h
@@ -0,0 +1,107 @@
+/* Copyright (c) 2013, Linaro Limited
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+
+/**
+ * @file
+ *
+ * ODP buffer descriptor
+ */
+
+#ifndef ODP_BUFFER_H_
+#define ODP_BUFFER_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+#include <odp/std_types.h>
+#include <odp/platform_types.h>
+#include <odp/event.h>
+
+/** @defgroup odp_buffer ODP BUFFER
+ * Operations on a buffer.
+ * @{
+ */
+
+
+/**
+ * Get buffer handle from event
+ *
+ * Converts an ODP_EVENT_BUFFER type event to a buffer.
+ *
+ * @param ev Event handle
+ *
+ * @return Buffer handle
+ *
+ * @see odp_event_type()
+ */
+odp_buffer_t odp_buffer_from_event(odp_event_t ev);
+
+/**
+ * Convert buffer handle to event
+ *
+ * @param buf Buffer handle
+ *
+ * @return Event handle
+ */
+odp_event_t odp_buffer_to_event(odp_buffer_t buf);
+
+/**
+ * Buffer start address
+ *
+ * @param buf Buffer handle
+ *
+ * @return Buffer start address
+ */
+void *odp_buffer_addr(odp_buffer_t buf);
+
+/**
+ * Buffer maximum data size
+ *
+ * @param buf Buffer handle
+ *
+ * @return Buffer maximum data size
+ */
+uint32_t odp_buffer_size(odp_buffer_t buf);
+
+/**
+ * Tests if buffer is valid
+ *
+ * @param buf Buffer handle
+ *
+ * @retval 1 Buffer handle represents a valid buffer.
+ * @retval 0 Buffer handle does not represent a valid buffer.
+ */
+int odp_buffer_is_valid(odp_buffer_t buf);
+
+/**
+ * Buffer pool of the buffer
+ *
+ * @param buf Buffer handle
+ *
+ * @return Handle of buffer pool buffer belongs to
+ */
+odp_pool_t odp_buffer_pool(odp_buffer_t buf);
+
+/**
+ * Print buffer metadata to STDOUT
+ *
+ * @param buf Buffer handle
+ *
+ */
+void odp_buffer_print(odp_buffer_t buf);
+
+/**
+ * @}
+ */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif