4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 * Copyright(c) 2013 6WIND.
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
41 * * Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * * Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in
45 * the documentation and/or other materials provided with the
47 * * Neither the name of 6WIND S.A. nor the names of its
48 * contributors may be used to endorse or promote products derived
49 * from this software without specific prior written permission.
51 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
57 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
61 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
64 #ifndef _RTE_CYCLES_H_
65 #define _RTE_CYCLES_H_
70 * Simple Time Reference Functions (Cycles and HPET).
74 #include <rte_debug.h>
75 #include <rte_atomic.h>
78 #define US_PER_S 1000000
79 #define NS_PER_S 1000000000
85 extern enum timer_source eal_timer_source;
88 * Get the measured frequency of the RDTSC counter
91 * The TSC frequency for this lcore
97 * Return the number of TSC cycles since boot
100 * the number of cycles
102 static inline uint64_t
103 rte_get_tsc_cycles(void);
105 #ifdef RTE_LIBEAL_USE_HPET
107 * Return the number of HPET cycles since boot
109 * This counter is global for all execution units. The number of
110 * cycles in one second can be retrieved using rte_get_hpet_hz().
113 * the number of cycles
116 rte_get_hpet_cycles(void);
119 * Get the number of HPET cycles in one second.
122 * The number of cycles in one second.
125 rte_get_hpet_hz(void);
128 * Initialise the HPET for use. This must be called before the rte_get_hpet_hz
129 * and rte_get_hpet_cycles APIs are called. If this function does not succeed,
130 * then the HPET functions are unavailable and should not be called.
132 * @param make_default
133 * If set, the hpet timer becomes the default timer whose values are
134 * returned by the rte_get_timer_hz/cycles API calls
138 * -1 on error, and the make_default parameter is ignored.
140 int rte_eal_hpet_init(int make_default);
145 * Get the number of cycles since boot from the default timer.
148 * The number of cycles
150 static inline uint64_t
151 rte_get_timer_cycles(void)
153 switch(eal_timer_source) {
155 return rte_get_tsc_cycles();
157 #ifdef RTE_LIBEAL_USE_HPET
158 return rte_get_hpet_cycles();
160 default: rte_panic("Invalid timer source specified\n");
165 * Get the number of cycles in one second for the default timer.
168 * The number of cycles in one second.
170 static inline uint64_t
171 rte_get_timer_hz(void)
173 switch(eal_timer_source) {
175 return rte_get_tsc_hz();
177 #ifdef RTE_LIBEAL_USE_HPET
178 return rte_get_hpet_hz();
180 default: rte_panic("Invalid timer source specified\n");
185 * Wait at least us microseconds.
188 * The number of microseconds to wait.
191 rte_delay_us(unsigned us);
194 * Wait at least ms milliseconds.
197 * The number of milliseconds to wait.
200 rte_delay_ms(unsigned ms)
202 rte_delay_us(ms * 1000);
205 #endif /* _RTE_CYCLES_H_ */