aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorMatias Elo <matias.elo@nokia.com>2022-12-23 09:50:33 +0200
committerMatias Elo <matias.elo@nokia.com>2023-02-07 15:07:27 +0200
commit0bc1fae4fa50777932582ea72cb0167bd4e17878 (patch)
tree88d10fb00db87f899b0ccad493cce3d737c742a0 /include
parent8139d878964e34dc62242a27c33ef8043d430922 (diff)
api: timer: deprecate old timer set return values
Deprecate old timer set return values ODP_TIMER_TOOEARLY, ODP_TIMER_TOOLATE, and ODP_TIMER_NOEVENT, which have been replaced by ODP_TIMER_TOO_NEAR, ODP_TIMER_TOO_FAR, and ODP_TIMER_FAIL. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
Diffstat (limited to 'include')
-rw-r--r--include/odp/api/spec/timer_types.h23
1 files changed, 17 insertions, 6 deletions
diff --git a/include/odp/api/spec/timer_types.h b/include/odp/api/spec/timer_types.h
index bbc7ef8dc..d61992fba 100644
--- a/include/odp/api/spec/timer_types.h
+++ b/include/odp/api/spec/timer_types.h
@@ -523,17 +523,28 @@ typedef enum {
} odp_timer_set_t;
-/** For backwards compatibility, ODP_TIMER_TOOEARLY is synonym of ODP_TIMER_TOO_NEAR.
- * This will be deprecated in the future. */
+#if ODP_DEPRECATED_API
+/**
+ * For backwards compatibility, ODP_TIMER_TOOEARLY is synonym of ODP_TIMER_TOO_NEAR.
+ *
+ * @deprecated Use #ODP_TIMER_TOO_NEAR instead.
+ */
#define ODP_TIMER_TOOEARLY ODP_TIMER_TOO_NEAR
-/** For backwards compatibility, ODP_TIMER_TOOLATE is synonym of ODP_TIMER_TOO_FAR.
- * This will be deprecated in the future. */
+/**
+ * For backwards compatibility, ODP_TIMER_TOOLATE is synonym of ODP_TIMER_TOO_FAR.
+ *
+ * @deprecated Use #ODP_TIMER_TOO_FAR instead.
+ */
#define ODP_TIMER_TOOLATE ODP_TIMER_TOO_FAR
-/** For backwards compatibility, ODP_TIMER_NOEVENT is synonym of ODP_TIMER_FAIL.
- * This will be deprecated in the future. */
+/**
+ * For backwards compatibility, ODP_TIMER_NOEVENT is synonym of ODP_TIMER_FAIL.
+ *
+ * @deprecated Use #ODP_TIMER_FAIL instead.
+ */
#define ODP_TIMER_NOEVENT ODP_TIMER_FAIL
+#endif
/**
* Timer tick information