Greg Steiert / maxim_dev

Dependents:   sensomed

hal/rtc_api.h@0:0e018d759a2a, 2016-11-08 (annotated)

Committer:
switches
Date:
Tue Nov 08 18:27:11 2016 +0000
Revision:
0:0e018d759a2a
Initial commit

Who changed what in which revision?

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