aboutsummaryrefslogtreecommitdiff
path: root/include/odp/api
diff options
context:
space:
mode:
authorPetri Savolainen <petri.savolainen@nokia.com>2016-01-28 15:24:37 +0200
committerMaxim Uvarov <maxim.uvarov@linaro.org>2016-02-08 20:45:25 +0300
commit851d535641d8a037af0d0c7ca1466c901cf5001e (patch)
tree1efad4205afb2b347ef15caba4f0c3660ee59650 /include/odp/api
parent474d0e163c902aac32f4908d6da5c13764f412fa (diff)
api: queue: rename QUEUE_TYPE_POLL to _PLAIN
Term "poll" does not describe queue type accurately. Many resources can be polled. For example, application polls the scheduler to dequeue from "sched" type queues. Term "plain queues" describe better what these queues offer, a plain storage of events which application can directly dequeue (instead of using the scheduler). Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-and-tested-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'include/odp/api')
-rw-r--r--include/odp/api/queue.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/include/odp/api/queue.h b/include/odp/api/queue.h
index 3ee69fcfe..87dc4a10c 100644
--- a/include/odp/api/queue.h
+++ b/include/odp/api/queue.h
@@ -54,11 +54,17 @@ extern "C" {
/**
* @def ODP_QUEUE_TYPE_SCHED
* Scheduled queue
+ *
+ * Scheduled queues are connected to the scheduler. Application must not
+ * dequeue events directly from these queues but use the scheduler instead.
*/
/**
- * @def ODP_QUEUE_TYPE_POLL
- * Not scheduled queue
+ * @def ODP_QUEUE_TYPE_PLAIN
+ * Plain queue
+ *
+ * Plain queues offer simple FIFO storage of events. Application may dequeue
+ * directly from these queues.
*/
/**