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