The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
TARGET_SAKURAIO_EVB_01/TARGET_STM/rtc_api_hal.h@170:e95d10626187, 2018-09-06 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Sep 06 13:39:34 2018 +0100
- Revision:
- 170:e95d10626187
- Parent:
- 169:a7c7b631e539
mbed library. Release version 163
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Anna Bridge |
160:5571c4ff569f | 1 | /* mbed Microcontroller Library |
Anna Bridge |
160:5571c4ff569f | 2 | ******************************************************************************* |
Anna Bridge |
169:a7c7b631e539 | 3 | * Copyright (c) 2018, STMicroelectronics |
Anna Bridge |
160:5571c4ff569f | 4 | * All rights reserved. |
Anna Bridge |
160:5571c4ff569f | 5 | * |
Anna Bridge |
160:5571c4ff569f | 6 | * Redistribution and use in source and binary forms, with or without |
Anna Bridge |
160:5571c4ff569f | 7 | * modification, are permitted provided that the following conditions are met: |
Anna Bridge |
160:5571c4ff569f | 8 | * |
Anna Bridge |
160:5571c4ff569f | 9 | * 1. Redistributions of source code must retain the above copyright notice, |
Anna Bridge |
160:5571c4ff569f | 10 | * this list of conditions and the following disclaimer. |
Anna Bridge |
160:5571c4ff569f | 11 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
Anna Bridge |
160:5571c4ff569f | 12 | * this list of conditions and the following disclaimer in the documentation |
Anna Bridge |
160:5571c4ff569f | 13 | * and/or other materials provided with the distribution. |
Anna Bridge |
160:5571c4ff569f | 14 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
Anna Bridge |
160:5571c4ff569f | 15 | * may be used to endorse or promote products derived from this software |
Anna Bridge |
160:5571c4ff569f | 16 | * without specific prior written permission. |
Anna Bridge |
160:5571c4ff569f | 17 | * |
Anna Bridge |
160:5571c4ff569f | 18 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
Anna Bridge |
160:5571c4ff569f | 19 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
Anna Bridge |
160:5571c4ff569f | 20 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
Anna Bridge |
160:5571c4ff569f | 21 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
Anna Bridge |
160:5571c4ff569f | 22 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
Anna Bridge |
160:5571c4ff569f | 23 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
Anna Bridge |
160:5571c4ff569f | 24 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
Anna Bridge |
160:5571c4ff569f | 25 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
Anna Bridge |
160:5571c4ff569f | 26 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
Anna Bridge |
160:5571c4ff569f | 27 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
Anna Bridge |
160:5571c4ff569f | 28 | ******************************************************************************* |
Anna Bridge |
160:5571c4ff569f | 29 | */ |
Anna Bridge |
160:5571c4ff569f | 30 | |
Anna Bridge |
160:5571c4ff569f | 31 | #ifndef MBED_RTC_API_HAL_H |
Anna Bridge |
160:5571c4ff569f | 32 | #define MBED_RTC_API_HAL_H |
Anna Bridge |
160:5571c4ff569f | 33 | |
Anna Bridge |
160:5571c4ff569f | 34 | #include "rtc_api.h" |
Anna Bridge |
160:5571c4ff569f | 35 | #include "lp_ticker_api.h" |
Anna Bridge |
160:5571c4ff569f | 36 | |
Anna Bridge |
160:5571c4ff569f | 37 | #ifdef __cplusplus |
Anna Bridge |
160:5571c4ff569f | 38 | extern "C" { |
Anna Bridge |
160:5571c4ff569f | 39 | #endif |
Anna Bridge |
160:5571c4ff569f | 40 | |
Anna Bridge |
160:5571c4ff569f | 41 | #if MBED_CONF_TARGET_LSE_AVAILABLE |
Anna Bridge |
160:5571c4ff569f | 42 | #define RTC_CLOCK LSE_VALUE |
Anna Bridge |
160:5571c4ff569f | 43 | #else |
Anna Bridge |
160:5571c4ff569f | 44 | #define RTC_CLOCK LSI_VALUE |
Anna Bridge |
160:5571c4ff569f | 45 | #endif |
Anna Bridge |
160:5571c4ff569f | 46 | |
Anna Bridge |
169:a7c7b631e539 | 47 | #if DEVICE_LPTICKER && !MBED_CONF_TARGET_LPTICKER_LPTIM |
AnnaBridge | 167:84c0a372a020 | 48 | /* PREDIV_A : 7-bit asynchronous prescaler */ |
Anna Bridge |
169:a7c7b631e539 | 49 | /* PREDIV_A is set to set LPTICKER frequency to RTC_CLOCK/4 */ |
Anna Bridge |
169:a7c7b631e539 | 50 | #define PREDIV_A_VALUE 3 |
AnnaBridge | 167:84c0a372a020 | 51 | |
Anna Bridge |
169:a7c7b631e539 | 52 | /** Read RTC counter with sub second precision |
Anna Bridge |
160:5571c4ff569f | 53 | * |
Anna Bridge |
169:a7c7b631e539 | 54 | * @return LP ticker counter |
Anna Bridge |
160:5571c4ff569f | 55 | */ |
Anna Bridge |
169:a7c7b631e539 | 56 | uint32_t rtc_read_lp(void); |
Anna Bridge |
160:5571c4ff569f | 57 | |
Anna Bridge |
169:a7c7b631e539 | 58 | /** Program a wake up timer event |
Anna Bridge |
160:5571c4ff569f | 59 | * |
Anna Bridge |
169:a7c7b631e539 | 60 | * @param timestamp: counter to set |
Anna Bridge |
160:5571c4ff569f | 61 | */ |
Anna Bridge |
169:a7c7b631e539 | 62 | void rtc_set_wake_up_timer(timestamp_t timestamp); |
Anna Bridge |
169:a7c7b631e539 | 63 | |
Anna Bridge |
169:a7c7b631e539 | 64 | /** Call RTC Wake Up IT |
Anna Bridge |
169:a7c7b631e539 | 65 | */ |
Anna Bridge |
169:a7c7b631e539 | 66 | void rtc_fire_interrupt(void); |
Anna Bridge |
160:5571c4ff569f | 67 | |
Anna Bridge |
160:5571c4ff569f | 68 | /** Disable the wake up timer event. |
Anna Bridge |
160:5571c4ff569f | 69 | * |
Anna Bridge |
160:5571c4ff569f | 70 | * The wake up timer use auto reload, you have to deactivate it manually. |
Anna Bridge |
160:5571c4ff569f | 71 | */ |
Anna Bridge |
160:5571c4ff569f | 72 | void rtc_deactivate_wake_up_timer(void); |
Anna Bridge |
160:5571c4ff569f | 73 | |
Anna Bridge |
169:a7c7b631e539 | 74 | #else /* DEVICE_LPTICKER && !MBED_CONF_TARGET_LPTICKER_LPTIM */ |
Anna Bridge |
169:a7c7b631e539 | 75 | |
Anna Bridge |
169:a7c7b631e539 | 76 | /* PREDIV_A : 7-bit asynchronous prescaler */ |
Anna Bridge |
169:a7c7b631e539 | 77 | /* PREDIV_A is set to the maximum value to improve the consumption */ |
Anna Bridge |
169:a7c7b631e539 | 78 | #define PREDIV_A_VALUE 127 |
Anna Bridge |
169:a7c7b631e539 | 79 | |
Anna Bridge |
169:a7c7b631e539 | 80 | #endif /* DEVICE_LPTICKER && !MBED_CONF_TARGET_LPTICKER_LPTIM */ |
Anna Bridge |
169:a7c7b631e539 | 81 | |
Anna Bridge |
169:a7c7b631e539 | 82 | /* PREDIV_S : 15-bit synchronous prescaler */ |
Anna Bridge |
169:a7c7b631e539 | 83 | /* PREDIV_S is set in order to get a 1 Hz clock */ |
Anna Bridge |
169:a7c7b631e539 | 84 | #define PREDIV_S_VALUE RTC_CLOCK / (PREDIV_A_VALUE + 1) - 1 |
Anna Bridge |
169:a7c7b631e539 | 85 | |
Anna Bridge |
160:5571c4ff569f | 86 | /** Synchronise the RTC shadow registers. |
Anna Bridge |
160:5571c4ff569f | 87 | * |
Anna Bridge |
160:5571c4ff569f | 88 | * Must be called after a deepsleep. |
Anna Bridge |
160:5571c4ff569f | 89 | */ |
Anna Bridge |
160:5571c4ff569f | 90 | void rtc_synchronize(void); |
Anna Bridge |
160:5571c4ff569f | 91 | |
Anna Bridge |
160:5571c4ff569f | 92 | #ifdef __cplusplus |
Anna Bridge |
160:5571c4ff569f | 93 | } |
Anna Bridge |
160:5571c4ff569f | 94 | #endif |
Anna Bridge |
160:5571c4ff569f | 95 | |
Anna Bridge |
160:5571c4ff569f | 96 | #endif |