Toyomasa Watarai / Mbed OS armcc_info

Describes predefine macros for mbed online compiler (armcc)

mbed/hal/rtc_api.h@6:40e873bbc5f7, 2017-03-16 (annotated)

Committer:
MACRUM
Date:
Thu Mar 16 21:58:09 2017 +0900
Revision:
6:40e873bbc5f7
Add licence header info

Who changed what in which revision?

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