Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

platform/mbed_rtc_time.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /* mbed Microcontroller Library
kenjiArai 1:9db0e321a9f4 2 * Copyright (c) 2006-2019 ARM Limited
kenjiArai 0:5b88d5760320 3 * SPDX-License-Identifier: Apache-2.0
kenjiArai 0:5b88d5760320 4 *
kenjiArai 0:5b88d5760320 5 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 0:5b88d5760320 6 * you may not use this file except in compliance with the License.
kenjiArai 0:5b88d5760320 7 * You may obtain a copy of the License at
kenjiArai 0:5b88d5760320 8 *
kenjiArai 0:5b88d5760320 9 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 0:5b88d5760320 10 *
kenjiArai 0:5b88d5760320 11 * Unless required by applicable law or agreed to in writing, software
kenjiArai 0:5b88d5760320 12 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 0:5b88d5760320 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 0:5b88d5760320 14 * See the License for the specific language governing permissions and
kenjiArai 0:5b88d5760320 15 * limitations under the License.
kenjiArai 0:5b88d5760320 16 */
kenjiArai 0:5b88d5760320 17
kenjiArai 1:9db0e321a9f4 18 #ifndef __MBED_RTC_TIME_H__
kenjiArai 1:9db0e321a9f4 19 #define __MBED_RTC_TIME_H__
kenjiArai 1:9db0e321a9f4 20
kenjiArai 0:5b88d5760320 21 #include <time.h>
kenjiArai 0:5b88d5760320 22
kenjiArai 0:5b88d5760320 23 #ifdef __cplusplus
kenjiArai 0:5b88d5760320 24 extern "C" {
kenjiArai 0:5b88d5760320 25 #endif
kenjiArai 0:5b88d5760320 26
kenjiArai 1:9db0e321a9f4 27 /** \addtogroup platform-public-api */
kenjiArai 1:9db0e321a9f4 28 /** @{*/
kenjiArai 1:9db0e321a9f4 29
kenjiArai 1:9db0e321a9f4 30 /**
kenjiArai 1:9db0e321a9f4 31 * \defgroup platform_rtc_time rtc_time functions
kenjiArai 1:9db0e321a9f4 32 * @{
kenjiArai 1:9db0e321a9f4 33 */
kenjiArai 1:9db0e321a9f4 34
kenjiArai 0:5b88d5760320 35 /* Timeval definition for non GCC_ARM toolchains */
kenjiArai 0:5b88d5760320 36 #if !defined(__GNUC__) || defined(__CC_ARM) || defined(__clang__)
kenjiArai 0:5b88d5760320 37 struct timeval {
kenjiArai 0:5b88d5760320 38 time_t tv_sec;
kenjiArai 0:5b88d5760320 39 int32_t tv_usec;
kenjiArai 0:5b88d5760320 40 };
kenjiArai 0:5b88d5760320 41 #endif
kenjiArai 0:5b88d5760320 42
kenjiArai 0:5b88d5760320 43 /** Implementation of the C time.h functions
kenjiArai 0:5b88d5760320 44 *
kenjiArai 0:5b88d5760320 45 * Provides mechanisms to set and read the current time, based
kenjiArai 0:5b88d5760320 46 * on the microcontroller Real-Time Clock (RTC), plus some
kenjiArai 0:5b88d5760320 47 * standard C manipulation and formatting functions.
kenjiArai 0:5b88d5760320 48 *
kenjiArai 0:5b88d5760320 49 * Example:
kenjiArai 0:5b88d5760320 50 * @code
kenjiArai 0:5b88d5760320 51 * #include "mbed.h"
kenjiArai 0:5b88d5760320 52 *
kenjiArai 0:5b88d5760320 53 * int main() {
kenjiArai 0:5b88d5760320 54 * set_time(1256729737); // Set RTC time to Wed, 28 Oct 2009 11:35:37
kenjiArai 0:5b88d5760320 55 *
kenjiArai 0:5b88d5760320 56 * while (true) {
kenjiArai 0:5b88d5760320 57 * time_t seconds = time(NULL);
kenjiArai 0:5b88d5760320 58 *
kenjiArai 0:5b88d5760320 59 * printf("Time as seconds since January 1, 1970 = %u\n", (unsigned int)seconds);
kenjiArai 0:5b88d5760320 60 *
kenjiArai 0:5b88d5760320 61 * printf("Time as a basic string = %s", ctime(&seconds));
kenjiArai 0:5b88d5760320 62 *
kenjiArai 0:5b88d5760320 63 * char buffer[32];
kenjiArai 0:5b88d5760320 64 * strftime(buffer, 32, "%I:%M %p\n", localtime(&seconds));
kenjiArai 0:5b88d5760320 65 * printf("Time as a custom formatted string = %s", buffer);
kenjiArai 0:5b88d5760320 66 *
kenjiArai 0:5b88d5760320 67 * wait(1);
kenjiArai 0:5b88d5760320 68 * }
kenjiArai 0:5b88d5760320 69 * }
kenjiArai 0:5b88d5760320 70 * @endcode
kenjiArai 0:5b88d5760320 71 */
kenjiArai 0:5b88d5760320 72
kenjiArai 0:5b88d5760320 73 /** Set the current time
kenjiArai 0:5b88d5760320 74 *
kenjiArai 0:5b88d5760320 75 * Initializes and sets the time of the microcontroller Real-Time Clock (RTC)
kenjiArai 0:5b88d5760320 76 * to the time represented by the number of seconds since January 1, 1970
kenjiArai 0:5b88d5760320 77 * (the UNIX timestamp).
kenjiArai 0:5b88d5760320 78 *
kenjiArai 0:5b88d5760320 79 * @param t Number of seconds since January 1, 1970 (the UNIX timestamp)
kenjiArai 0:5b88d5760320 80 *
kenjiArai 0:5b88d5760320 81 * @note Synchronization level: Thread safe
kenjiArai 0:5b88d5760320 82 *
kenjiArai 0:5b88d5760320 83 * Example:
kenjiArai 0:5b88d5760320 84 * @code
kenjiArai 0:5b88d5760320 85 * #include "mbed.h"
kenjiArai 0:5b88d5760320 86 *
kenjiArai 0:5b88d5760320 87 * int main() {
kenjiArai 0:5b88d5760320 88 * set_time(1256729737); // Set time to Wed, 28 Oct 2009 11:35:37
kenjiArai 0:5b88d5760320 89 * }
kenjiArai 0:5b88d5760320 90 * @endcode
kenjiArai 0:5b88d5760320 91 */
kenjiArai 0:5b88d5760320 92 void set_time(time_t t);
kenjiArai 0:5b88d5760320 93
kenjiArai 0:5b88d5760320 94 /** Attach an external RTC to be used for the C time functions
kenjiArai 0:5b88d5760320 95 *
kenjiArai 0:5b88d5760320 96 * @note Synchronization level: Thread safe
kenjiArai 0:5b88d5760320 97 *
kenjiArai 0:5b88d5760320 98 * @param read_rtc pointer to function which returns current UNIX timestamp
kenjiArai 0:5b88d5760320 99 * @param write_rtc pointer to function which sets current UNIX timestamp, can be NULL
kenjiArai 0:5b88d5760320 100 * @param init_rtc pointer to function which initializes RTC, can be NULL
kenjiArai 0:5b88d5760320 101 * @param isenabled_rtc pointer to function which returns if the RTC is enabled, can be NULL
kenjiArai 0:5b88d5760320 102 */
kenjiArai 0:5b88d5760320 103 void attach_rtc(time_t (*read_rtc)(void), void (*write_rtc)(time_t), void (*init_rtc)(void), int (*isenabled_rtc)(void));
kenjiArai 0:5b88d5760320 104
kenjiArai 0:5b88d5760320 105 /** Standard lib retarget, get time since Epoch
kenjiArai 0:5b88d5760320 106 *
kenjiArai 0:5b88d5760320 107 * @param tv Structure containing time_t seconds and useconds_t microseconds. Due to
kenjiArai 0:5b88d5760320 108 * separate target specific RTC implementations only the seconds component is used.
kenjiArai 0:5b88d5760320 109 * @param tz DEPRECATED IN THE STANDARD: This parameter is left in for legacy code. It is
kenjiArai 0:5b88d5760320 110 * not used.
kenjiArai 0:5b88d5760320 111 * @return 0 on success, -1 on a failure.
kenjiArai 0:5b88d5760320 112 * @note Synchronization level: Thread safe
kenjiArai 0:5b88d5760320 113 *
kenjiArai 0:5b88d5760320 114 */
kenjiArai 0:5b88d5760320 115 int gettimeofday(struct timeval *tv, void *tz);
kenjiArai 0:5b88d5760320 116
kenjiArai 0:5b88d5760320 117 /** Standard lib retarget, set time since Epoch
kenjiArai 0:5b88d5760320 118 *
kenjiArai 0:5b88d5760320 119 * @param tv Structure containing time_t seconds and useconds_t microseconds. Due to
kenjiArai 0:5b88d5760320 120 * separate target specific RTC implementations only the seconds component is used.
kenjiArai 0:5b88d5760320 121 * @param tz DEPRECATED IN THE STANDARD: This parameter is left in for legacy code. It is
kenjiArai 0:5b88d5760320 122 * not used.
kenjiArai 0:5b88d5760320 123 * @return Time in seconds on success, -1 on a failure.
kenjiArai 0:5b88d5760320 124 * @note Synchronization level: Thread safe
kenjiArai 0:5b88d5760320 125 *
kenjiArai 0:5b88d5760320 126 */
kenjiArai 0:5b88d5760320 127 int settimeofday(const struct timeval *tv, const struct timezone *tz);
kenjiArai 0:5b88d5760320 128
kenjiArai 0:5b88d5760320 129 #ifdef __cplusplus
kenjiArai 0:5b88d5760320 130 }
kenjiArai 0:5b88d5760320 131 #endif
kenjiArai 0:5b88d5760320 132
kenjiArai 0:5b88d5760320 133 /** @}*/
kenjiArai 0:5b88d5760320 134 /** @}*/
kenjiArai 1:9db0e321a9f4 135
kenjiArai 1:9db0e321a9f4 136 #endif /* __MBED_RTC_TIME_H__ */