BA / Mbed OS BaBoRo1

Erste version der Software für der Prototyp

mbed-os/hal/rtc_api.h@0:380207fcb5c1, 2018-03-29 (annotated)

Committer:
borlanic
Date:
Thu Mar 29 07:02:09 2018 +0000
Revision:
0:380207fcb5c1
Encoder, IMU --> OK; Controller --> in bearbeitung

Who changed what in which revision?

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