aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorPetri Savolainen <petri.savolainen@linaro.org>2018-10-30 16:27:24 +0200
committerMaxim Uvarov <maxim.uvarov@linaro.org>2018-11-28 17:16:39 +0300
commit7b23d26816a334804277a87e5ea93f2958e5a6ec (patch)
tree8cb600ea7f7d119416a431b4caac9277dc79df20 /include
parent9e1d151f2f308c16ed542a7fa1ab0f0cf1e7a0fc (diff)
api: sched: favor priority functions over macros
Priority macros will be deprecated, function calls should be used instead. Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org> Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'include')
-rw-r--r--include/odp/api/spec/schedule_types.h16
1 files changed, 9 insertions, 7 deletions
diff --git a/include/odp/api/spec/schedule_types.h b/include/odp/api/spec/schedule_types.h
index 24663f695..76afc6dd4 100644
--- a/include/odp/api/spec/schedule_types.h
+++ b/include/odp/api/spec/schedule_types.h
@@ -24,24 +24,26 @@ extern "C" {
/**
* @def ODP_SCHED_PRIO_HIGHEST
- * Highest scheduling priority
+ * This macro is equivalent of calling odp_schedule_max_prio() and will be
+ * deprecated. Use direct function call instead.
*/
/**
* @def ODP_SCHED_PRIO_NORMAL
- * Normal scheduling priority
+ * This macro is equivalent of calling odp_schedule_default_prio() and will be
+ * deprecated. Use direct function call instead.
*/
/**
* @def ODP_SCHED_PRIO_LOWEST
- * Lowest scheduling priority
+ * This macro is equivalent of calling odp_schedule_min_prio() and will be
+ * deprecated. Use direct function call instead.
*/
/**
* @def ODP_SCHED_PRIO_DEFAULT
- * Default scheduling priority. User does not care about the selected priority
- * level - throughput, load balancing and synchronization features are more
- * important than priority scheduling.
+ * This macro is equivalent of calling odp_schedule_default_prio() and will be
+ * deprecated. Use direct function call instead.
*/
/**
@@ -144,7 +146,7 @@ typedef int odp_schedule_prio_t;
typedef struct odp_schedule_param_t {
/** Priority level
*
- * Default value is ODP_SCHED_PRIO_DEFAULT. */
+ * Default value is returned by odp_schedule_default_prio(). */
odp_schedule_prio_t prio;
/** Synchronization method