1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/* Copyright (c) 2013, Linaro Limited
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @file
*
* ODP timer
*/
#ifndef ODP_TIMER_H_
#define ODP_TIMER_H_
#ifdef __cplusplus
extern "C" {
#endif
#include <odp_std_types.h>
#include <odp_buffer.h>
#include <odp_buffer_pool.h>
#include <odp_queue.h>
/** @defgroup odp_timer ODP TIMER
* @{
*/
/**
* ODP timer handle
*/
typedef uint32_t odp_timer_t;
/** Invalid timer */
#define ODP_TIMER_INVALID 0
/**
* ODP timeout handle
*/
typedef odp_buffer_t odp_timer_tmo_t;
/** Invalid timeout */
#define ODP_TIMER_TMO_INVALID 0
/**
* Timeout notification
*/
typedef odp_buffer_t odp_timeout_t;
/**
* Create a timer
*
* Creates a new timer with requested properties.
*
* @param name Name
* @param pool Buffer pool for allocating timeout notifications
* @param resolution Timeout resolution in nanoseconds
* @param min_tmo Minimum timeout duration in nanoseconds
* @param max_tmo Maximum timeout duration in nanoseconds
*
* @return Timer handle if successful, otherwise ODP_TIMER_INVALID
*/
odp_timer_t odp_timer_create(const char *name, odp_buffer_pool_t pool,
uint64_t resolution, uint64_t min_tmo,
uint64_t max_tmo);
/**
* Convert timer ticks to nanoseconds
*
* @param timer Timer
* @param ticks Timer ticks
*
* @return Nanoseconds
*/
uint64_t odp_timer_tick_to_ns(odp_timer_t timer, uint64_t ticks);
/**
* Convert nanoseconds to timer ticks
*
* @param timer Timer
* @param ns Nanoseconds
*
* @return Timer ticks
*/
uint64_t odp_timer_ns_to_tick(odp_timer_t timer, uint64_t ns);
/**
* Timer resolution in nanoseconds
*
* @param timer Timer
*
* @return Resolution in nanoseconds
*/
uint64_t odp_timer_resolution(odp_timer_t timer);
/**
* Maximum timeout in timer ticks
*
* @param timer Timer
*
* @return Maximum timeout in timer ticks
*/
uint64_t odp_timer_maximum_tmo(odp_timer_t timer);
/**
* Current timer tick
*
* @param timer Timer
*
* @return Current time in timer ticks
*/
uint64_t odp_timer_current_tick(odp_timer_t timer);
/**
* Request timeout with an absolute timer tick
*
* When tick reaches tmo_tick, the timer enqueues the timeout notification into
* the destination queue.
*
* @param timer Timer
* @param tmo_tick Absolute timer tick value which triggers the timeout
* @param queue Destination queue for the timeout notification
* @param buf User defined timeout notification buffer. When
* ODP_BUFFER_INVALID, default timeout notification is used.
*
* @return Timeout handle if successful, otherwise ODP_TIMER_TMO_INVALID
*/
odp_timer_tmo_t odp_timer_absolute_tmo(odp_timer_t timer, uint64_t tmo_tick,
odp_queue_t queue, odp_buffer_t buf);
/**
* Cancel a timeout
*
* @param timer Timer
* @param tmo Timeout to cancel
*
* @return 0 if successful
*/
int odp_timer_cancel_tmo(odp_timer_t timer, odp_timer_tmo_t tmo);
/**
* Convert buffer handle to timeout handle
*
* @param buf Buffer handle
*
* @return Timeout buffer handle
*/
odp_timeout_t odp_timeout_from_buffer(odp_buffer_t buf);
/**
* Return absolute timeout tick
*
* @param tmo Timeout buffer handle
*
* @return Absolute timeout tick
*/
uint64_t odp_timeout_tick(odp_timeout_t tmo);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif
|
