mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/rtc_api.h@147:a97add6d7e64, 2017-07-19 (annotated)

Committer:
Kojto
Date:
Wed Jul 19 16:46:19 2017 +0100
Revision:
147:a97add6d7e64
Parent:
128:9bcdf88f62b0
Child:
169:a7c7b631e539
Release 147 of the mbed library.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 128:9bcdf88f62b0 1
<> 128:9bcdf88f62b0 2 /** \addtogroup hal */
<> 128:9bcdf88f62b0 3 /** @{*/
<> 128:9bcdf88f62b0 4 /* mbed Microcontroller Library
<> 128:9bcdf88f62b0 5 * Copyright (c) 2006-2013 ARM Limited
<> 128:9bcdf88f62b0 6 *
<> 128:9bcdf88f62b0 7 * Licensed under the Apache License, Version 2.0 (the "License");
<> 128:9bcdf88f62b0 8 * you may not use this file except in compliance with the License.
<> 128:9bcdf88f62b0 9 * You may obtain a copy of the License at
<> 128:9bcdf88f62b0 10 *
<> 128:9bcdf88f62b0 11 * http://www.apache.org/licenses/LICENSE-2.0
<> 128:9bcdf88f62b0 12 *
<> 128:9bcdf88f62b0 13 * Unless required by applicable law or agreed to in writing, software
<> 128:9bcdf88f62b0 14 * distributed under the License is distributed on an "AS IS" BASIS,
<> 128:9bcdf88f62b0 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 128:9bcdf88f62b0 16 * See the License for the specific language governing permissions and
<> 128:9bcdf88f62b0 17 * limitations under the License.
<> 128:9bcdf88f62b0 18 */
<> 128:9bcdf88f62b0 19 #ifndef MBED_RTC_API_H
<> 128:9bcdf88f62b0 20 #define MBED_RTC_API_H
<> 128:9bcdf88f62b0 21
<> 128:9bcdf88f62b0 22 #include "device.h"
<> 128:9bcdf88f62b0 23
<> 128:9bcdf88f62b0 24 #if DEVICE_RTC
<> 128:9bcdf88f62b0 25
<> 128:9bcdf88f62b0 26 #include <time.h>
<> 128:9bcdf88f62b0 27
<> 128:9bcdf88f62b0 28 #ifdef __cplusplus
<> 128:9bcdf88f62b0 29 extern "C" {
<> 128:9bcdf88f62b0 30 #endif
<> 128:9bcdf88f62b0 31
<> 128:9bcdf88f62b0 32 /**
<> 128:9bcdf88f62b0 33 * \defgroup hal_rtc RTC hal functions
<> 128:9bcdf88f62b0 34 * @{
<> 128:9bcdf88f62b0 35 */
<> 128:9bcdf88f62b0 36
<> 128:9bcdf88f62b0 37 /** Initialize the RTC peripheral
<> 128:9bcdf88f62b0 38 *
<> 128:9bcdf88f62b0 39 */
<> 128:9bcdf88f62b0 40 void rtc_init(void);
<> 128:9bcdf88f62b0 41
<> 128:9bcdf88f62b0 42 /** Deinitialize RTC
<> 128:9bcdf88f62b0 43 *
<> 128:9bcdf88f62b0 44 * TODO: The function is not used by rtc api in mbed-drivers.
<> 128:9bcdf88f62b0 45 */
<> 128:9bcdf88f62b0 46 void rtc_free(void);
<> 128:9bcdf88f62b0 47
<> 128:9bcdf88f62b0 48 /** Get the RTC enable status
<> 128:9bcdf88f62b0 49 *
<> 128:9bcdf88f62b0 50 * @retval 0 disabled
<> 128:9bcdf88f62b0 51 * @retval 1 enabled
<> 128:9bcdf88f62b0 52 */
<> 128:9bcdf88f62b0 53 int rtc_isenabled(void);
<> 128:9bcdf88f62b0 54
<> 128:9bcdf88f62b0 55 /** Get the current time from the RTC peripheral
<> 128:9bcdf88f62b0 56 *
<> 128:9bcdf88f62b0 57 * @return The current time
<> 128:9bcdf88f62b0 58 */
<> 128:9bcdf88f62b0 59 time_t rtc_read(void);
<> 128:9bcdf88f62b0 60
<> 128:9bcdf88f62b0 61 /** Set the current time to the RTC peripheral
<> 128:9bcdf88f62b0 62 *
<> 128:9bcdf88f62b0 63 * @param t The current time to be set
<> 128:9bcdf88f62b0 64 */
<> 128:9bcdf88f62b0 65 void rtc_write(time_t t);
<> 128:9bcdf88f62b0 66
<> 128:9bcdf88f62b0 67 /**@}*/
<> 128:9bcdf88f62b0 68
<> 128:9bcdf88f62b0 69 #ifdef __cplusplus
<> 128:9bcdf88f62b0 70 }
<> 128:9bcdf88f62b0 71 #endif
<> 128:9bcdf88f62b0 72
<> 128:9bcdf88f62b0 73 #endif
<> 128:9bcdf88f62b0 74
<> 128:9bcdf88f62b0 75 #endif
<> 128:9bcdf88f62b0 76
<> 128:9bcdf88f62b0 77 /** @}*/