Umar Naeem / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by Umar Naeem

hal/rtc_api.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
Parent:
0:9b334a45a8ff
Child:
149:156823d33999
This updates the lib to the mbed lib v125

Who changed what in which revision?

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