Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

hal/rtc_api.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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