diff mbox

[API-NEXT,PATCHv4,01/10] api: schedule: rename order lock APIs

Message ID 1440796737-8636-2-git-send-email-bill.fischofer@linaro.org
State Accepted
Commit f80a55e5cf2b56c732fbc0758286ec07700145c0
Headers show

Commit Message

Bill Fischofer Aug. 28, 2015, 9:18 p.m. UTC 
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
---
 include/odp/api/schedule.h | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)
diff mbox

Patch

diff --git a/include/odp/api/schedule.h b/include/odp/api/schedule.h
index 36e52cd..7c5955b 100644
--- a/include/odp/api/schedule.h
+++ b/include/odp/api/schedule.h
@@ -31,7 +31,7 @@  extern "C" {
  */
 
 /**
- * @typedef odp_schedule_olock_t
+ * @typedef odp_schedule_order_lock_t
  * Scheduler ordered context lock
  */
 
@@ -225,13 +225,17 @@  int odp_schedule_group_destroy(odp_schedule_group_t group);
  * Initialize an ordered queue context lock. The lock can be associated only
  * with ordered queues and used only within an ordered synchronization context.
  *
- * @param queue   Ordered queue
  * @param lock    Ordered context lock
+ * @param queue   Ordered queue
  *
  * @retval 0 on success
  * @retval <0 on failure
+ *
+ * @note At present a thread may only use a single ordered lock. Attempts to
+ * use multiple ordered locks within an order context are undefined.
  */
-int odp_schedule_olock_init(odp_queue_t queue, odp_schedule_olock_t *lock);
+int odp_schedule_order_lock_init(odp_schedule_order_lock_t *lock,
+				 odp_queue_t queue);
 
 /**
  * Acquire ordered context lock
@@ -244,7 +248,7 @@  int odp_schedule_olock_init(odp_queue_t queue, odp_schedule_olock_t *lock);
  *
  * @param lock    Ordered context lock
  */
-void odp_schedule_olock_lock(odp_schedule_olock_t *lock);
+void odp_schedule_order_lock(odp_schedule_order_lock_t *lock);
 
 /**
  * Release ordered context lock
@@ -254,7 +258,7 @@  void odp_schedule_olock_lock(odp_schedule_olock_t *lock);
  *
  * @param lock    Ordered context lock
  */
-void odp_schedule_olock_unlock(odp_schedule_olock_t *lock);
+void odp_schedule_order_unlock(odp_schedule_order_lock_t *lock);
 
 /**
  * @}