BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/hal/rtc_api.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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