takashi kadono / Mbed OS Nucleo446_SSD1331

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/platform/mbed_mktime.h@3:f3764f852aa8, 2018-10-11 (annotated)

Committer:
kadonotakashi
Date:
Thu Oct 11 02:27:46 2018 +0000
Revision:
3:f3764f852aa8
Parent:
0:8fdf9a60065b 
Nucreo 446 + SSD1331 test version;

Who changed what in which revision?

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