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