Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/platform/mbed_mktime.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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