-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrtc.h
138 lines (103 loc) · 4.1 KB
/
rtc.h
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
/*!
\file rtc.h
The MIT License (MIT)
Copyright (c) 2014 Andrej Manduch, Adrián Matejov, XLC Team
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
/*! \file
this RTC library is made for ATMega328p and uses Timer1 as source
of time.
*/
#include "config.h"
/*! \fn void rtc_init(void)
\brief initialize rtc
rtc_init should be used in the very beginig of your code.
*/
void rtc_init(void);
/*! \fn uint16_t get_rtc(void)
\brief will safelly return value of internal T1 counter
Basically this function will return internal timer
register without any changes but you should use this
and not use direct copy of TCNT1 register becouse
this function will return TCNT1 in thread safe way.
\return 16 bit unsigned value of current timer counter.
*/
uint16_t get_rtc(void);
#ifdef RTC_32_BIT
/*! \fn uint32_t get_full_rtc(void)
\brief function will return 32 bit value of rtc
This function will return you full 32 bit value which is
internal TCNT1 register plus 16 bit timer overflow counter.
This function is way slower than get_rtc() so if there is a
way to user get_rtc() instead you should use get_rtc().
\note this function is availible only if RTC_32_BIT macro is present
\return 32 bit unsigned value of current rtc value
*/
uint32_t get_full_rtc(void);
#endif /* RTC_32_BIT */
#ifdef RTC_32_BIT
/*! \fn uint32_t get_rtc_ms(void)
\brief it's used to messure time in miliseconds
Function internally read rtc timer and overflow var and
compute time in ms in most sufficient way.
\note if RTC_32_BIT macro is not pressent function will change
signature to: uint16_t get_rtc_ms(void)
\return 32 bit undigned value of current ms from start timer initialization
*/
uint32_t get_rtc_ms(void);
#else /* RTC_32_BIT */
uint16_t get_rtc_ms(void);
#endif /* RTC_32_BIT */
#ifdef RTC_32_BIT
/*! \fn uint32_t get_rtc_us(void)
\brief it's used to messure time in microseconds
Function internally read rtc timer and overflow var and
compute time in ms in most sufficient way.
\note if RTC_32_BIT macro is not pressent function will change
signature to: uint16_t get_rtc_us(void)
\return 32 bit undigned value of current ms from start timer initialization
*/
uint32_t get_rtc_us(void);
#else /* RTC_32_BIT */
uint16_t get_rtc_us(void);
#endif /* RTC_32_BIT */
#ifdef RTC_32_BIT
/*! \fn uint32_t ticks2ms(uint32_t)
\brief transform TC1 ticks to miliseconds
function translate get_rtc and get_full_rtc value in to
miliseconds. Is useful if you want to make high resolution
time diferrence with very small error.
\note if RTC_32_BIT macro is not pressent function will change
signature to: uint16_t ticks2ms(uint16_t)
\param ticks number of TC1 ticks.
\return unsigned 32 bit integer in miliseconds
*/
uint32_t ticks2ms(uint32_t);
#else /* RTC_32_BIT */
uint16_t ticks2ms(uint16_t);
#endif /* RTC_32_BIT */
#ifdef RTC_32_BIT
/*! \fn uint32_t ticks2us(uint32_t)
\brief transform TC1 ticks to microseconds
\note if RTC_32_BIT macro is not pressent function will change
signature to: uint16_t ticks2us(uint16_t)
see ticks2ms()
*/
uint32_t ticks2us(uint32_t);
#else /* RTC_32_BIT */
uint16_t ticks2us(uint16_t);
#endif /* RTC_32_BIT */