ON Semiconductor / mbed-os

5.2.1 - Updated I2C files

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

hal/rtc_api.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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