Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

platform/mbed_rtc_time.h@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
Child:
1:9db0e321a9f4
mbed-os5 only for TYBLE16

Who changed what in which revision?

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