1 files changed, 268 insertions, 0 deletions
diff --git a/platform/linux-generic/include/api/odp/queue.h b/platform/linux-generic/include/api/odp/queue.h
new file mode 100644
index 000000000..9311eb419
--- /dev/null
+++ b/platform/linux-generic/include/api/odp/queue.h
@@ -0,0 +1,268 @@
+/* Copyright (c) 2013, Linaro Limited
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier:     BSD-3-Clause
+ */
+
+
+/**
+ * @file
+ *
+ * ODP queue
+ */
+
+#ifndef ODP_QUEUE_H_
+#define ODP_QUEUE_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+#include <odp/std_types.h>
+#include <odp/platform_types.h>
+
+/** @defgroup odp_queue ODP QUEUE
+ *  Macros and operation on a queue.
+ *  @{
+ */
+
+/**
+ * ODP queue
+ */
+typedef uint32_t odp_queue_t;
+
+/**
+ * Queue group instance type
+ */
+typedef uint32_t odp_queue_group_t;
+
+/** Invalid queue */
+#define ODP_QUEUE_INVALID  0
+
+/** Maximum queue name lenght in chars */
+#define ODP_QUEUE_NAME_LEN 32
+
+
+/**
+ * ODP queue type
+ */
+typedef int odp_queue_type_t;
+
+#define ODP_QUEUE_TYPE_SCHED  0  /**< Scheduled queue */
+#define ODP_QUEUE_TYPE_POLL   1  /**< Not scheduled queue */
+#define ODP_QUEUE_TYPE_PKTIN  2  /**< Packet input queue */
+#define ODP_QUEUE_TYPE_PKTOUT 3  /**< Packet output queue */
+
+/**
+ * ODP schedule priority
+ */
+typedef int odp_schedule_prio_t;
+
+/** Highest scheduling priority */
+#define ODP_SCHED_PRIO_HIGHEST  0
+
+/** Normal scheduling priority */
+#define ODP_SCHED_PRIO_NORMAL   (ODP_CONFIG_SCHED_PRIOS / 2)
+
+/** Lowest scheduling priority */
+#define ODP_SCHED_PRIO_LOWEST   (ODP_CONFIG_SCHED_PRIOS - 1)
+
+/** Default scheduling priority */
+#define ODP_SCHED_PRIO_DEFAULT  ODP_SCHED_PRIO_NORMAL
+
+
+/**
+ * ODP schedule synchronisation
+ */
+typedef int odp_schedule_sync_t;
+
+#define ODP_SCHED_SYNC_NONE     0  /**< Queue not synchronised */
+#define ODP_SCHED_SYNC_ATOMIC   1  /**< Atomic queue */
+#define ODP_SCHED_SYNC_ORDERED  2  /**< Ordered queue */
+
+/** Default queue synchronisation */
+#define ODP_SCHED_SYNC_DEFAULT  ODP_SCHED_SYNC_ATOMIC
+
+/**
+ * ODP schedule CPU group
+ */
+typedef int odp_schedule_group_t;
+
+/** Group of all CPUs */
+#define ODP_SCHED_GROUP_ALL     0
+
+/** Default CPU group */
+#define ODP_SCHED_GROUP_DEFAULT ODP_SCHED_GROUP_ALL
+
+
+/**
+ * ODP Queue parameters
+ */
+typedef struct odp_queue_param_t {
+	/** Scheduler parameters */
+	struct {
+		odp_schedule_prio_t  prio;
+		odp_schedule_sync_t  sync;
+		odp_schedule_group_t group;
+	} sched;
+	/** Queue context */
+	void *context;
+} odp_queue_param_t;
+
+
+/**
+ * Queue create
+ *
+ * @param name    Queue name
+ * @param type    Queue type
+ * @param param   Queue parameters. Uses defaults if NULL.
+ *
+ * @return Queue handle or ODP_QUEUE_INVALID
+ */
+odp_queue_t odp_queue_create(const char *name, odp_queue_type_t type,
+			     odp_queue_param_t *param);
+
+/**
+ * Destroy ODP queue
+ *
+ * Destroys ODP queue. The queue must be empty and detached from other
+ * ODP API (crypto, pktio, etc). Application must ensure that no other
+ * operations on this queue are invoked in parallel. Otherwise behavior
+ * is undefined.
+ *
+ * @param queue    Queue handle
+ *
+ * @return 0 if successful
+ */
+int odp_queue_destroy(odp_queue_t queue);
+
+/**
+ * Find a queue by name
+ *
+ * @param name    Queue name
+ *
+ * @return Queue handle or ODP_QUEUE_INVALID
+ */
+odp_queue_t odp_queue_lookup(const char *name);
+
+/**
+ * Set queue context
+ *
+ * Its the responsability of the interface user to make sure
+ * queue context allocation is done in an area reachable for
+ * all EOs accessing the context
+ *
+ * @param queue    Queue handle
+ * @param context  Address to the queue context
+ *
+ * @return 0 if successful
+ */
+int odp_queue_set_context(odp_queue_t queue, void *context);
+
+/**
+ * Get queue context
+ *
+ * @param queue    Queue handle
+ *
+ * @return If successful, a pointer to the queue context,
+ *         NULL for failure.
+ */
+void *odp_queue_get_context(odp_queue_t queue);
+
+/**
+ * Queue enqueue
+ *
+ * @param queue   Queue handle
+ * @param ev      Event handle
+ *
+ * @return 0 if succesful
+ */
+int odp_queue_enq(odp_queue_t queue, odp_event_t ev);
+
+/**
+ * Enqueue multiple events to a queue
+ *
+ * @param queue   Queue handle
+ * @param ev      Event handles
+ * @param num     Number of event handles
+ *
+ * @return 0 if succesful
+ */
+int odp_queue_enq_multi(odp_queue_t queue, odp_event_t ev[], int num);
+
+/**
+ * Queue dequeue
+ *
+ * Dequeues next event from head of the queue. Cannot be used for
+ * ODP_QUEUE_TYPE_SCHED type queues (use odp_schedule() instead).
+ *
+ * @param queue   Queue handle
+ *
+ * @return Event handle, or ODP_EVENT_INVALID
+ */
+odp_event_t odp_queue_deq(odp_queue_t queue);
+
+/**
+ * Dequeue multiple events from a queue
+ *
+ * Dequeues multiple events from head of the queue. Cannot be used for
+ * ODP_QUEUE_TYPE_SCHED type queues (use odp_schedule() instead).
+ *
+ * @param queue   Queue handle
+ * @param events  Event handle array for output
+ * @param num     Maximum number of event handles
+
+ * @return Number of events written (0 ... num)
+ */
+int odp_queue_deq_multi(odp_queue_t queue, odp_event_t events[], int num);
+
+/**
+ * Queue type
+ *
+ * @param queue   Queue handle
+ *
+ * @return Queue type
+ */
+odp_queue_type_t odp_queue_type(odp_queue_t queue);
+
+/**
+ * Queue schedule type
+ *
+ * @param queue   Queue handle
+ *
+ * @return Queue schedule synchronisation type
+ */
+odp_schedule_sync_t odp_queue_sched_type(odp_queue_t queue);
+
+/**
+ * Queue priority
+ *
+ * @note Passing an invalid queue_handle will result in UNDEFINED behavior
+ *
+ * @param queue   Queue handle
+ *
+ * @return Queue schedule priority
+ */
+odp_schedule_prio_t odp_queue_sched_prio(odp_queue_t queue);
+
+/**
+ * Queue group
+ *
+ * @note Passing an invalid queue_handle will result in UNDEFINED behavior
+ *
+ * @param queue   Queue handle
+ *
+ * @return Queue schedule group
+ */
+odp_schedule_group_t odp_queue_sched_group(odp_queue_t queue);
+
+/**
+ * @}
+ */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif