t
Fork of mbed-dev by
targets/TARGET_STM/rtc_api_hal.h@178:c26431f84b0d, 2017-11-09 (annotated)
- Committer:
- amithy
- Date:
- Thu Nov 09 22:14:37 2017 +0000
- Revision:
- 178:c26431f84b0d
- Parent:
- 154:37f96f9d4de2
test export
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
<> | 154:37f96f9d4de2 | 1 | /* mbed Microcontroller Library |
<> | 154:37f96f9d4de2 | 2 | ******************************************************************************* |
<> | 154:37f96f9d4de2 | 3 | * Copyright (c) 2016, STMicroelectronics |
<> | 154:37f96f9d4de2 | 4 | * All rights reserved. |
<> | 154:37f96f9d4de2 | 5 | * |
<> | 154:37f96f9d4de2 | 6 | * Redistribution and use in source and binary forms, with or without |
<> | 154:37f96f9d4de2 | 7 | * modification, are permitted provided that the following conditions are met: |
<> | 154:37f96f9d4de2 | 8 | * |
<> | 154:37f96f9d4de2 | 9 | * 1. Redistributions of source code must retain the above copyright notice, |
<> | 154:37f96f9d4de2 | 10 | * this list of conditions and the following disclaimer. |
<> | 154:37f96f9d4de2 | 11 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
<> | 154:37f96f9d4de2 | 12 | * this list of conditions and the following disclaimer in the documentation |
<> | 154:37f96f9d4de2 | 13 | * and/or other materials provided with the distribution. |
<> | 154:37f96f9d4de2 | 14 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
<> | 154:37f96f9d4de2 | 15 | * may be used to endorse or promote products derived from this software |
<> | 154:37f96f9d4de2 | 16 | * without specific prior written permission. |
<> | 154:37f96f9d4de2 | 17 | * |
<> | 154:37f96f9d4de2 | 18 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
<> | 154:37f96f9d4de2 | 19 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
<> | 154:37f96f9d4de2 | 20 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
<> | 154:37f96f9d4de2 | 21 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
<> | 154:37f96f9d4de2 | 22 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
<> | 154:37f96f9d4de2 | 23 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
<> | 154:37f96f9d4de2 | 24 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
<> | 154:37f96f9d4de2 | 25 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
<> | 154:37f96f9d4de2 | 26 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
<> | 154:37f96f9d4de2 | 27 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
<> | 154:37f96f9d4de2 | 28 | ******************************************************************************* |
<> | 154:37f96f9d4de2 | 29 | */ |
<> | 154:37f96f9d4de2 | 30 | |
<> | 154:37f96f9d4de2 | 31 | #ifndef MBED_RTC_API_HAL_H |
<> | 154:37f96f9d4de2 | 32 | #define MBED_RTC_API_HAL_H |
<> | 154:37f96f9d4de2 | 33 | |
<> | 154:37f96f9d4de2 | 34 | #include <stdint.h> |
<> | 154:37f96f9d4de2 | 35 | #include "rtc_api.h" |
<> | 154:37f96f9d4de2 | 36 | |
<> | 154:37f96f9d4de2 | 37 | #ifdef __cplusplus |
<> | 154:37f96f9d4de2 | 38 | extern "C" { |
<> | 154:37f96f9d4de2 | 39 | #endif |
<> | 154:37f96f9d4de2 | 40 | /* |
<> | 154:37f96f9d4de2 | 41 | * Extend rtc_api.h |
<> | 154:37f96f9d4de2 | 42 | */ |
<> | 154:37f96f9d4de2 | 43 | |
<> | 154:37f96f9d4de2 | 44 | /** Set the given function as handler of wakeup timer event. |
<> | 154:37f96f9d4de2 | 45 | * |
<> | 154:37f96f9d4de2 | 46 | * @param handler The function to set as handler |
<> | 154:37f96f9d4de2 | 47 | */ |
<> | 154:37f96f9d4de2 | 48 | void rtc_set_irq_handler(uint32_t handler); |
<> | 154:37f96f9d4de2 | 49 | |
<> | 154:37f96f9d4de2 | 50 | /** Read the subsecond register. |
<> | 154:37f96f9d4de2 | 51 | * |
<> | 154:37f96f9d4de2 | 52 | * @return The remaining time as microseconds (0-999999) |
<> | 154:37f96f9d4de2 | 53 | */ |
<> | 154:37f96f9d4de2 | 54 | uint32_t rtc_read_subseconds(void); |
<> | 154:37f96f9d4de2 | 55 | |
<> | 154:37f96f9d4de2 | 56 | /** Program a wake up timer event in delta microseconds. |
<> | 154:37f96f9d4de2 | 57 | * |
<> | 154:37f96f9d4de2 | 58 | * @param delta The time to wait |
<> | 154:37f96f9d4de2 | 59 | */ |
<> | 154:37f96f9d4de2 | 60 | void rtc_set_wake_up_timer(uint32_t delta); |
<> | 154:37f96f9d4de2 | 61 | |
<> | 154:37f96f9d4de2 | 62 | /** Disable the wake up timer event. |
<> | 154:37f96f9d4de2 | 63 | * |
<> | 154:37f96f9d4de2 | 64 | * The wake up timer use auto reload, you have to deactivate it manually. |
<> | 154:37f96f9d4de2 | 65 | */ |
<> | 154:37f96f9d4de2 | 66 | void rtc_deactivate_wake_up_timer(void); |
<> | 154:37f96f9d4de2 | 67 | |
<> | 154:37f96f9d4de2 | 68 | /** Synchronise the RTC shadow registers. |
<> | 154:37f96f9d4de2 | 69 | * |
<> | 154:37f96f9d4de2 | 70 | * Must be called after a deepsleep. |
<> | 154:37f96f9d4de2 | 71 | */ |
<> | 154:37f96f9d4de2 | 72 | void rtc_synchronize(void); |
<> | 154:37f96f9d4de2 | 73 | |
<> | 154:37f96f9d4de2 | 74 | |
<> | 154:37f96f9d4de2 | 75 | #ifdef __cplusplus |
<> | 154:37f96f9d4de2 | 76 | } |
<> | 154:37f96f9d4de2 | 77 | #endif |
<> | 154:37f96f9d4de2 | 78 | |
<> | 154:37f96f9d4de2 | 79 | #endif |