EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

hal/rtc_api.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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