From 0bc1fae4fa50777932582ea72cb0167bd4e17878 Mon Sep 17 00:00:00 2001 From: Matias Elo Date: Fri, 23 Dec 2022 09:50:33 +0200 Subject: api: timer: deprecate old timer set return values MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-by: Jere Leppänen Reviewed-by: Petri Savolainen --- include/odp/api/spec/timer_types.h | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) (limited to 'include') 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 -- cgit v1.2.3