Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

hal/rtc_api.h@0:5c4d7b2438d3, 2016-11-11 (annotated)

Committer:
switches
Date:
Fri Nov 11 20:59:50 2016 +0000
Revision:
0:5c4d7b2438d3
Initial commit

Who changed what in which revision?

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