Gan likun / mbed-dev11

hal/rtc_api.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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