BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/platform/mbed_mktime.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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