Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/hal/rtc_api.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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