Gan likun / mbed1-dev

001

hal/rtc_api.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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