mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/rtc_api.h@181:57724642e740, 2018-02-16 (annotated)

Committer:
AnnaBridge
Date:
Fri Feb 16 16:09:33 2018 +0000
Revision:
181:57724642e740
Parent:
149:156823d33999
Child:
186:707f6e361f3e
mbed-dev library. Release version 159.

Who changed what in which revision?

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