rtc_api.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef MBED_RTC_API_H
00017 #define MBED_RTC_API_H
00018 
00019 #include "device.h"
00020 
00021 #if DEVICE_RTC
00022 
00023 #include <time.h>
00024 
00025 #ifdef __cplusplus
00026 extern "C" {
00027 #endif
00028 
00029 /**
00030  * \defgroup hal_rtc RTC hal functions
00031  * @{
00032  */
00033 
00034 /** Initialize the RTC peripheral
00035  *
00036  */
00037 void rtc_init(void);
00038 
00039 /** Deinitialize RTC
00040  *
00041  * TODO: The function is not used by rtc api in mbed-drivers.
00042  */
00043 void rtc_free(void);
00044 
00045 /** Get the RTC enable status
00046  *
00047  * @retval 0 disabled
00048  * @retval 1 enabled
00049  */
00050 int rtc_isenabled(void);
00051 
00052 /** Get the current time from the RTC peripheral
00053  *
00054  * @return The current time
00055  */
00056 time_t rtc_read(void);
00057 
00058 /** Set the current time to the RTC peripheral
00059  *
00060  * @param t The current time to be set
00061  */
00062 void rtc_write(time_t t);
00063 
00064 /**@}*/
00065 
00066 #ifdef __cplusplus
00067 }
00068 #endif
00069 
00070 #endif
00071 
00072 #endif