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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
/*
ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/*
Concepts and parts of this file have been contributed by Uladzimir Pylinsky
aka barthess.
*/
/**
* @file hal_rtc.c
* @brief RTC Driver code.
*
* @addtogroup RTC
* @{
*/
#include "hal.h"
#if (HAL_USE_RTC == TRUE) || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver local definitions. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver exported variables. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver local variables and types. */
/*===========================================================================*/
/*
* Lookup table with months' length
*/
static const uint8_t month_len[12] = {
31, 30, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
};
/*===========================================================================*/
/* Driver local functions. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver exported functions. */
/*===========================================================================*/
/**
* @brief RTC Driver initialization.
* @note This function is implicitly invoked by @p halInit(), there is
* no need to explicitly initialize the driver.
*
* @init
*/
void rtcInit(void) {
rtc_lld_init();
}
/**
* @brief Initializes a generic RTC driver object.
* @details The HW dependent part of the initialization has to be performed
* outside, usually in the hardware initialization code.
*
* @param[out] rtcp pointer to RTC driver structure
*
* @init
*/
void rtcObjectInit(RTCDriver *rtcp) {
#if RTC_HAS_STORAGE == TRUE
rtcp->vmt = &_rtc_lld_vmt;
#else
(void)rtcp;
#endif
}
/**
* @brief Set current time.
* @note This function can be called from any context but limitations
* could be imposed by the low level implementation. It is
* guaranteed that the function can be called from thread
* context.
* @note The function can be reentrant or not reentrant depending on
* the low level implementation.
*
* @param[in] rtcp pointer to RTC driver structure
* @param[in] timespec pointer to a @p RTCDateTime structure
*
* @special
*/
void rtcSetTime(RTCDriver *rtcp, const RTCDateTime *timespec) {
osalDbgCheck((rtcp != NULL) && (timespec != NULL));
rtc_lld_set_time(rtcp, timespec);
}
/**
* @brief Get current time.
* @note This function can be called from any context but limitations
* could be imposed by the low level implementation. It is
* guaranteed that the function can be called from thread
* context.
* @note The function can be reentrant or not reentrant depending on
* the low level implementation.
*
* @param[in] rtcp pointer to RTC driver structure
* @param[out] timespec pointer to a @p RTCDateTime structure
*
* @special
*/
void rtcGetTime(RTCDriver *rtcp, RTCDateTime *timespec) {
osalDbgCheck((rtcp != NULL) && (timespec != NULL));
rtc_lld_get_time(rtcp, timespec);
}
#if (RTC_ALARMS > 0) || defined(__DOXYGEN__)
/**
* @brief Set alarm time.
* @note This function can be called from any context but limitations
* could be imposed by the low level implementation. It is
* guaranteed that the function can be called from thread
* context.
* @note The function can be reentrant or not reentrant depending on
* the low level implementation.
*
* @param[in] rtcp pointer to RTC driver structure
* @param[in] alarm alarm identifier
* @param[in] alarmspec pointer to a @p RTCAlarm structure or @p NULL
*
* @special
*/
void rtcSetAlarm(RTCDriver *rtcp,
rtcalarm_t alarm,
const RTCAlarm *alarmspec) {
osalDbgCheck((rtcp != NULL) && (alarm < (rtcalarm_t)RTC_ALARMS));
rtc_lld_set_alarm(rtcp, alarm, alarmspec);
}
/**
* @brief Get current alarm.
* @note If an alarm has not been set then the returned alarm specification
* is not meaningful.
* @note This function can be called from any context but limitations
* could be imposed by the low level implementation. It is
* guaranteed that the function can be called from thread
* context.
* @note The function can be reentrant or not reentrant depending on
* the low level implementation.
*
* @param[in] rtcp pointer to RTC driver structure
* @param[in] alarm alarm identifier
* @param[out] alarmspec pointer to a @p RTCAlarm structure
*
* @special
*/
void rtcGetAlarm(RTCDriver *rtcp,
rtcalarm_t alarm,
RTCAlarm *alarmspec) {
osalDbgCheck((rtcp != NULL) &&
(alarm < (rtcalarm_t)RTC_ALARMS) &&
(alarmspec != NULL));
rtc_lld_get_alarm(rtcp, alarm, alarmspec);
}
#endif /* RTC_ALARMS > 0 */
#if (RTC_SUPPORTS_CALLBACKS == TRUE) || defined(__DOXYGEN__)
/**
* @brief Enables or disables RTC callbacks.
* @details This function enables or disables the callback, use a @p NULL
* pointer in order to disable it.
* @note This function can be called from any context but limitations
* could be imposed by the low level implementation. It is
* guaranteed that the function can be called from thread
* context.
* @note The function can be reentrant or not reentrant depending on
* the low level implementation.
*
* @param[in] rtcp pointer to RTC driver structure
* @param[in] callback callback function pointer or @p NULL
*
* @special
*/
void rtcSetCallback(RTCDriver *rtcp, rtccb_t callback) {
osalDbgCheck(rtcp != NULL);
rtc_lld_set_callback(rtcp, callback);
}
#endif /* RTC_SUPPORTS_CALLBACKS == TRUE */
/**
* @brief Convert @p RTCDateTime to broken-down time structure.
*
* @param[in] timespec pointer to a @p RTCDateTime structure
* @param[out] timp pointer to a broken-down time structure
* @param[out] tv_msec pointer to milliseconds value or @p NULL
*
* @api
*/
void rtcConvertDateTimeToStructTm(const RTCDateTime *timespec,
struct tm *timp,
uint32_t *tv_msec) {
int sec;
timp->tm_year = (int)timespec->year + (1980 - 1900);
timp->tm_mon = (int)timespec->month - 1;
timp->tm_mday = (int)timespec->day;
timp->tm_isdst = (int)timespec->dstflag;
timp->tm_wday = (int)timespec->dayofweek - 1;
sec = (int)timespec->millisecond / 1000;
timp->tm_hour = sec / 3600;
sec %= 3600;
timp->tm_min = sec / 60;
timp->tm_sec = sec % 60;
if (NULL != tv_msec) {
*tv_msec = (uint32_t)timespec->millisecond % 1000U;
}
}
/**
* @brief Convert broken-down time structure to @p RTCDateTime.
*
* @param[in] timp pointer to a broken-down time structure
* @param[in] tv_msec milliseconds value
* @param[out] timespec pointer to a @p RTCDateTime structure
*
* @api
*/
void rtcConvertStructTmToDateTime(const struct tm *timp,
uint32_t tv_msec,
RTCDateTime *timespec) {
/*lint -save -e9034 [10.4] Verified assignments to bit fields.*/
timespec->year = (uint32_t)timp->tm_year - (1980U - 1900U);
timespec->month = (uint32_t)timp->tm_mon + 1U;
timespec->day = (uint32_t)timp->tm_mday;
timespec->dayofweek = (uint32_t)timp->tm_wday + 1U;
if (-1 == timp->tm_isdst) {
timespec->dstflag = 0U; /* set zero if dst is unknown */
}
else {
timespec->dstflag = (uint32_t)timp->tm_isdst;
}
/*lint -restore*/
/*lint -save -e9033 [10.8] Verified assignments to bit fields.*/
timespec->millisecond = tv_msec + (uint32_t)(((timp->tm_hour * 3600) +
(timp->tm_min * 60) +
timp->tm_sec) * 1000);
/*lint -restore*/
}
/**
* @brief Get current time in format suitable for usage in FAT file system.
* @note The information about day of week and DST is lost in DOS
* format, the second field loses its least significant bit.
*
* @param[out] timespec pointer to a @p RTCDateTime structure
* @return FAT date/time value.
*
* @api
*/
uint32_t rtcConvertDateTimeToFAT(const RTCDateTime *timespec) {
uint32_t fattime;
uint32_t sec, min, hour, day, month;
sec = timespec->millisecond / 1000U;
hour = sec / 3600U;
sec %= 3600U;
min = sec / 60U;
sec %= 60U;
day = timespec->day;
month = timespec->month;
/* handle DST flag */
if (1U == timespec->dstflag) {
hour += 1U;
if (hour == 24U) {
hour = 0U;
day += 1U;
if (day > month_len[month - 1U]) {
day = 1U;
month += 1U;
}
}
}
fattime = sec >> 1U;
fattime |= min << 5U;
fattime |= hour << 11U;
fattime |= day << 16U;
fattime |= month << 21U;
fattime |= (uint32_t)timespec->year << 25U;
return fattime;
}
#endif /* HAL_USE_RTC == TRUE */
/** @} */
|
