1 |
|
---|
2 | /** \addtogroup platform */
|
---|
3 | /** @{*/
|
---|
4 | /* mbed Microcontroller Library
|
---|
5 | * Copyright (c) 2017-2017 ARM Limited
|
---|
6 | *
|
---|
7 | * Licensed under the Apache License, Version 2.0 (the "License");
|
---|
8 | * you may not use this file except in compliance with the License.
|
---|
9 | * You may obtain a copy of the License at
|
---|
10 | *
|
---|
11 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
12 | *
|
---|
13 | * Unless required by applicable law or agreed to in writing, software
|
---|
14 | * distributed under the License is distributed on an "AS IS" BASIS,
|
---|
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
16 | * See the License for the specific language governing permissions and
|
---|
17 | * limitations under the License.
|
---|
18 | */
|
---|
19 |
|
---|
20 | #ifndef MBED_MKTIME_H
|
---|
21 | #define MBED_MKTIME_H
|
---|
22 |
|
---|
23 | #include <time.h>
|
---|
24 | #include <stdbool.h>
|
---|
25 | #include <stdint.h>
|
---|
26 |
|
---|
27 | #ifdef __cplusplus
|
---|
28 | extern "C" {
|
---|
29 | #endif
|
---|
30 |
|
---|
31 | /**
|
---|
32 | * \defgroup platform_mktime mktime functions
|
---|
33 | * @{
|
---|
34 | */
|
---|
35 |
|
---|
36 | /* Time range across the whole 32-bit range should be supported which means that years in range 1970 - 2106 can be
|
---|
37 | * encoded. We have two types of RTC devices:
|
---|
38 | * a) RTCs which handles all leap years in the mentioned year range correctly. Leap year is determined by checking if
|
---|
39 | * the year counter value is divisible by 400, 100, and 4. No problem here.
|
---|
40 | * b) RTCs which handles leap years correctly up to 2100. The RTC does a simple bit comparison to see if the two
|
---|
41 | * lowest order bits of the year counter are zero. In this case 2100 year will be considered
|
---|
42 | * incorrectly as a leap year, so the last valid point in time will be 28.02.2100 23:59:59 and next day will be
|
---|
43 | * 29.02.2100 (invalid). So after 28.02.2100 the day counter will be off by a day.
|
---|
44 | */
|
---|
45 | typedef enum {
|
---|
46 | RTC_FULL_LEAP_YEAR_SUPPORT,
|
---|
47 | RTC_4_YEAR_LEAP_YEAR_SUPPORT
|
---|
48 | } rtc_leap_year_support_t;
|
---|
49 |
|
---|
50 | /** Compute if a year is a leap year or not.
|
---|
51 | *
|
---|
52 | * @param year The year to test it shall be in the range [70:206]. Year 0 is
|
---|
53 | * translated into year 1900 CE.
|
---|
54 | * @param leap_year_support use RTC_FULL_LEAP_YEAR_SUPPORT if RTC device is able
|
---|
55 | * to correctly detect all leap years in range [70:206] otherwise use RTC_4_YEAR_LEAP_YEAR_SUPPORT.
|
---|
56 | *
|
---|
57 | * @return true if the year in input is a leap year and false otherwise.
|
---|
58 | *
|
---|
59 | * @note For use by the HAL only
|
---|
60 | * @note Year 2100 is treated differently for devices with full leap year support and devices with
|
---|
61 | * partial leap year support. Devices with partial leap year support treats 2100 as a leap year.
|
---|
62 | */
|
---|
63 | bool _rtc_is_leap_year(int year, rtc_leap_year_support_t leap_year_support);
|
---|
64 |
|
---|
65 | /* Convert a calendar time into time since UNIX epoch as a time_t.
|
---|
66 | *
|
---|
67 | * This function is a thread safe (partial) replacement for mktime. It is
|
---|
68 | * tailored around RTC peripherals needs and is not by any mean a complete
|
---|
69 | * replacement of mktime.
|
---|
70 | *
|
---|
71 | * @param time The calendar time to convert into a time_t since epoch.
|
---|
72 | * The fields from tm used for the computation are:
|
---|
73 | * - tm_sec
|
---|
74 | * - tm_min
|
---|
75 | * - tm_hour
|
---|
76 | * - tm_mday
|
---|
77 | * - tm_mon
|
---|
78 | * - tm_year
|
---|
79 | * Other fields are ignored and won't be renormalized by a call to this function.
|
---|
80 | * A valid calendar time is comprised between:
|
---|
81 | * the 1st of January 1970 at 00:00:00 to the 7th of February 2106 at 06:28:15.
|
---|
82 | * @param leap_year_support use RTC_FULL_LEAP_YEAR_SUPPORT if RTC device is able
|
---|
83 | * to correctly detect all leap years in range [70:206] otherwise use RTC_4_YEAR_LEAP_YEAR_SUPPORT.
|
---|
84 | * @param seconds holder for the result - calendar time as seconds since UNIX epoch.
|
---|
85 | *
|
---|
86 | * @return true on success, false if conversion error occurred.
|
---|
87 | *
|
---|
88 | * @note Leap seconds are not supported.
|
---|
89 | * @note Values in output range from 0 to UINT_MAX.
|
---|
90 | * @note Full and partial leap years support.
|
---|
91 | * @note For use by the HAL only
|
---|
92 | */
|
---|
93 | bool _rtc_maketime(const struct tm *time, time_t *seconds, rtc_leap_year_support_t leap_year_support);
|
---|
94 |
|
---|
95 | /* Convert a given time in seconds since epoch into calendar time.
|
---|
96 | *
|
---|
97 | * This function is a thread safe (partial) replacement for localtime. It is
|
---|
98 | * tailored around RTC peripherals specification and is not by any means a
|
---|
99 | * complete of localtime.
|
---|
100 | *
|
---|
101 | * @param timestamp The time (in seconds) to convert into calendar time. Valid
|
---|
102 | * input are in the range [0 : UINT32_MAX].
|
---|
103 | * @param calendar_time Pointer to the object which will contain the result of
|
---|
104 | * the conversion. The tm fields filled by this function are:
|
---|
105 | * - tm_sec
|
---|
106 | * - tm_min
|
---|
107 | * - tm_hour
|
---|
108 | * - tm_mday
|
---|
109 | * - tm_mon
|
---|
110 | * - tm_year
|
---|
111 | * - tm_wday
|
---|
112 | * - tm_yday
|
---|
113 | * The object remains untouched if the time in input is invalid.
|
---|
114 | * @param leap_year_support use RTC_FULL_LEAP_YEAR_SUPPORT if RTC device is able
|
---|
115 | * to correctly detect all leap years in range [70:206] otherwise use RTC_4_YEAR_LEAP_YEAR_SUPPORT.
|
---|
116 | * @return true if the conversion was successful, false otherwise.
|
---|
117 | *
|
---|
118 | * @note For use by the HAL only.
|
---|
119 | * @note Full and partial leap years support.
|
---|
120 | */
|
---|
121 | bool _rtc_localtime(time_t timestamp, struct tm *time_info, rtc_leap_year_support_t leap_year_support);
|
---|
122 |
|
---|
123 | /** @}*/
|
---|
124 |
|
---|
125 | #ifdef __cplusplus
|
---|
126 | }
|
---|
127 | #endif
|
---|
128 |
|
---|
129 | #endif /* MBED_MKTIME_H */
|
---|
130 |
|
---|
131 | /** @}*/
|
---|