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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSAPICounter
*
* @brief This header file defines the Free-Running Counter and Busy Wait Delay
* API.
*/
/*
* Copyright (c) 2014, 2018 embedded brains GmbH. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _RTEMS_SAPI_COUNTER_H
#define _RTEMS_SAPI_COUNTER_H
#include <rtems/score/cpu.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* @defgroup RTEMSAPICounter Free-Running Counter and Busy Wait Delay
*
* @ingroup RTEMSAPI
*
* @brief Free-running counter and busy wait delay functions.
*
* The RTEMS counter is some free-running counter. It ticks usually with a
* frequency close to the CPU or system bus clock.
*
* The counter can be used in case the overhead of the
* rtems_clock_get_uptime_nanoseconds() is too high. The step from counter
* ticks to/from nanoseconds is explicit in this API unlike to
* rtems_clock_get_uptime_nanoseconds() which performs the conversion on each
* invocation.
*
* This counter works without a clock driver and during system initialization.
*
* The counter can be used to profile low-level operations like SMP locks or
* interrupt disabled critical sections. The counter can act also as an
* entropy source for a random number generator.
*
* The period of the counter depends on the actual hardware.
*
* @{
*/
/**
* @brief Unsigned integer type for counter values.
*/
typedef CPU_Counter_ticks rtems_counter_ticks;
/**
* @brief Returns the current counter frequency in Hz.
*
* @return The current counter frequency in Hz.
*/
static inline uint32_t rtems_counter_frequency( void )
{
return _CPU_Counter_frequency();
}
/**
* @brief Reads the current counter value.
*
* @return The current counter value.
*/
static inline rtems_counter_ticks rtems_counter_read( void )
{
return _CPU_Counter_read();
}
/**
* @brief Returns the difference between the second and first CPU counter
* value.
*
* This function is provided for backward compatibility.
* You may use "second - first" directly in the code.
*
* @param[in] second The second CPU counter value.
* @param[in] first The first CPU counter value.
*
* @return Returns second minus first.
*/
static inline rtems_counter_ticks rtems_counter_difference(
rtems_counter_ticks second,
rtems_counter_ticks first
)
{
return second - first;
}
/**
* @brief Converts counter ticks into nanoseconds.
*
* @param[in] ticks The counter ticks value to convert.
*
* @return The nanoseconds value corresponding to the counter ticks. The value
* is rounded up.
*/
uint64_t rtems_counter_ticks_to_nanoseconds(
rtems_counter_ticks ticks
);
/**
* @brief Converts nanoseconds into counter ticks.
*
* @param[in] nanoseconds The nanoseconds value to convert.
*
* @return The counter ticks value corresponding to the nanoseconds value. The
* value is rounded up.
*/
rtems_counter_ticks rtems_counter_nanoseconds_to_ticks(
uint32_t nanoseconds
);
/**
* @brief Converts counter ticks into signed binary time (sbintime_t).
*
* @param[in] ticks The counter ticks value to convert.
*
* @return The signed binary time value corresponding to the counter ticks
* value. The value is rounded up.
*/
int64_t rtems_counter_ticks_to_sbintime( rtems_counter_ticks ticks );
/**
* @brief Converts signed binary time (sbintime_t) into counter ticks.
*
* @param[in] sbt The signed binary time value to convert.
*
* @return The counter ticks value corresponding to the nanoseconds value. The
* value is rounded up.
*/
rtems_counter_ticks rtems_counter_sbintime_to_ticks( int64_t sbt );
/**
* @brief Initializes the counter ticks to/from nanoseconds converter functions.
*
* This function must be used to initialize the
* rtems_counter_ticks_to_nanoseconds() and
* rtems_counter_nanoseconds_to_ticks() functions. It should be called during
* system initialization by the board support package.
*
* @param[in] frequency The current counter frequency in Hz.
*/
void rtems_counter_initialize_converter( uint32_t frequency );
/**
* @brief Busy wait for some counter ticks.
*
* This function does not disable interrupts. Thus task switches and
* interrupts can interfere with this busy wait may prolong the delay. This
* function busy waits at least the specified time. Due to some overhead the
* actual delay may be longer.
*
* @param[in] ticks The minimum busy wait time in counter ticks.
*/
void rtems_counter_delay_ticks( rtems_counter_ticks ticks );
/**
* @brief Busy wait for some nanoseconds.
*
* This function does not disable interrupts. Thus task switches and
* interrupts can interfere with this busy wait may prolong the delay. This
* function busy waits at least the specified time. Due to some overhead the
* actual delay may be longer.
*
* @param[in] nanoseconds The minimum busy wait time in nanoseconds.
*/
void rtems_counter_delay_nanoseconds( uint32_t nanoseconds );
/** @} */
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* _RTEMS_SAPI_COUNTER_H */
|
