Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

hal/rtc_api.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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