a752c7ab
 elopes
add first test an...
|
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
|
/*
* Copyright (C) 2014 Thomas Eichinger <thomas.eichinger@fu-berlin.de>
*
* This file is subject to the terms and conditions of the GNU Lesser General
* Public License v2.1. See the file LICENSE in the top level directory for more
* details.
*/
/**
* @defgroup drivers_periph_rtt RTT
* @ingroup drivers_periph
* @brief Low-level RTT (Real Time Timer) peripheral driver
*
* @{
* @file
* @brief Low-level RTT (Real Time Timer) peripheral driver interface
* definitions
*
* @author Thomas Eichinger <thomas.eichinger@fu-berlin.de>
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/
#ifndef PERIPH_RTT_H
#define PERIPH_RTT_H
#include "periph_conf.h"
#ifdef __cplusplus
extern "C" {
#endif
/* guard file in case no RTT device was specified */
#if RTT_NUMOF
#ifndef RTT_FREQUENCY
#warning "RTT_FREQUENCY undefined. Set RTT_FREQUENCY to the number of ticks" \
"per second for the current architecture."
#endif
/**
* @brief Convert microseconds to rtt ticks
* @param[in] us number of microseconds
* @return rtt ticks
*/
#define RTT_US_TO_TICKS(us) ((uint32_t)((uint64_t)(us) * RTT_FREQUENCY / 1000000UL))
/**
* @brief Convert milliseconds to rtt ticks
* @param[in] ms number of milliseconds
* @return rtt ticks
*/
#define RTT_MS_TO_TICKS(ms) ( RTT_US_TO_TICKS((ms) * 1000) )
/**
* @brief Convert seconds to rtt ticks
* @param[in] sec number of seconds
* @return rtt ticks
*/
#define RTT_SEC_TO_TICKS(sec) ( RTT_MS_TO_TICKS((sec) * 1000) )
/**
* @brief Convert minutes to rtt ticks
* @param[in] min number of minutes
* @return rtt ticks
*/
#define RTT_MIN_TO_TICKS(min) ( RTT_SEC_TO_TICKS((min) * 60) )
/**
* @brief Convert rtt ticks to microseconds
* @param[in] ticks rtt ticks
* @return number of microseconds
*/
#define RTT_TICKS_TO_US(ticks) ((uint32_t)((uint64_t)(ticks) * 1000000UL / RTT_FREQUENCY))
/**
* @brief Convert rtt ticks to milliseconds
* @param[in] ticks rtt ticks
* @return number of milliseconds
*/
#define RTT_TICKS_TO_MS(ticks) (RTT_TICKS_TO_US(ticks) / 1000)
/**
* @brief Convert rtt ticks to seconds
* @param[in] ticks rtt ticks
* @return number of seconds
*/
#define RTT_TICKS_TO_SEC(ticks) (RTT_TICKS_TO_MS(ticks) / 1000)
/**
* @brief Convert rtt ticks to minutes
* @param[in] ticks rtt ticks
* @return number of minutes
*/
#define RTT_TICKS_TO_MIN(ticks) (RTT_TICKS_TO_SEC(ticks) / 60)
/**
* @brief Signature for the alarm callback
*
* @param[in] arg Optional argument which is passed to the
* callback
*/
typedef void(*rtt_cb_t)(void *arg);
/**
* @brief Initialize RTT module
*/
void rtt_init(void);
/**
* @brief Set a callback for the counter overflow event
*
* @param[in] cb Callback to execute on overflow
* @param[in] arg Argument passed to the callback
*/
void rtt_set_overflow_cb(rtt_cb_t cb, void *arg);
/**
* @brief Clear the overflow callback
*/
void rtt_clear_overflow_cb(void);
/**
* @brief Get the current RTT counter.
*
* @return Current value of the RTT counter
*/
uint32_t rtt_get_counter(void);
/**
* @brief Set the RTT counter to a specified value.
*
* @param[in] counter The value to set the RTT to.
*/
void rtt_set_counter(uint32_t counter);
/**
* @brief Set an alarm for RTT to the specified value.
*
* @param[in] alarm The value to trigger an alarm when hit
* @param[in] cb Callback executed when alarm is hit
* @param[in] arg Argument passed to callback when alarm is hit
*/
void rtt_set_alarm(uint32_t alarm, rtt_cb_t cb, void *arg);
/**
* @brief Get the value of a set alarm.
*
* If no alarm is set, the return value is arbitrary.
*
* @return Value the alarm is set to
*/
uint32_t rtt_get_alarm(void);
/**
* @brief Clear any set alarm, do nothing if nothing set
*/
void rtt_clear_alarm(void);
/**
* @brief Turn the RTT hardware module on
*/
void rtt_poweron(void);
/**
* @brief Turn the RTT hardware module off
*/
void rtt_poweroff(void);
#endif /* RTT_NUMOF */
#ifdef __cplusplus
}
#endif
#endif /* PERIPH_RTT_H */
/** @} */
|