mbed official / mbed

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@167:84c0a372a020, 2018-05-11 (annotated)

Committer:
AnnaBridge
Date:
Fri May 11 16:51:14 2018 +0100
Revision:
167:84c0a372a020
Parent:
161:aa5281ff4a02
Child:
169:a7c7b631e539
mbed library. Release version 162

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Anna Bridge 160:5571c4ff569f 1 /* mbed Microcontroller Library
Anna Bridge 160:5571c4ff569f 2 *******************************************************************************
Anna Bridge 160:5571c4ff569f 3 * Copyright (c) 2017, 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 <stdint.h>
Anna Bridge 160:5571c4ff569f 35 #include "rtc_api.h"
Anna Bridge 160:5571c4ff569f 36 #include "ticker_api.h"
Anna Bridge 160:5571c4ff569f 37 #include "lp_ticker_api.h"
AnnaBridge 161:aa5281ff4a02 38 #include "us_ticker_api.h"
AnnaBridge 161:aa5281ff4a02 39 #include "hal_tick.h"
AnnaBridge 161:aa5281ff4a02 40 #include "mbed_critical.h"
AnnaBridge 161:aa5281ff4a02 41 #include "mbed_error.h"
AnnaBridge 161:aa5281ff4a02 42 #include "mbed_debug.h"
Anna Bridge 160:5571c4ff569f 43
Anna Bridge 160:5571c4ff569f 44 #ifdef __cplusplus
Anna Bridge 160:5571c4ff569f 45 extern "C" {
Anna Bridge 160:5571c4ff569f 46 #endif
Anna Bridge 160:5571c4ff569f 47
Anna Bridge 160:5571c4ff569f 48 #if MBED_CONF_TARGET_LSE_AVAILABLE
Anna Bridge 160:5571c4ff569f 49 #define RTC_CLOCK LSE_VALUE
Anna Bridge 160:5571c4ff569f 50 #else
Anna Bridge 160:5571c4ff569f 51 #define RTC_CLOCK LSI_VALUE
Anna Bridge 160:5571c4ff569f 52 #endif
Anna Bridge 160:5571c4ff569f 53
AnnaBridge 167:84c0a372a020 54 /* PREDIV_A : 7-bit asynchronous prescaler */
AnnaBridge 167:84c0a372a020 55 /* PREDIV_S : 15-bit synchronous prescaler */
AnnaBridge 167:84c0a372a020 56 /* PREDIV_S is set in order to get a 1 Hz clock */
AnnaBridge 167:84c0a372a020 57 #if DEVICE_LOWPOWERTIMER && !MBED_CONF_TARGET_LOWPOWERTIMER_LPTIM
AnnaBridge 167:84c0a372a020 58 /* PREDIV_A is set to a small value to improve the SubSeconds resolution */
AnnaBridge 167:84c0a372a020 59 /* with a 32768Hz clock, PREDIV_A=7 gives a precision of 244us */
AnnaBridge 167:84c0a372a020 60 #define PREDIV_A_VALUE 7
AnnaBridge 167:84c0a372a020 61 #else /* DEVICE_LPTICKER && !MBED_CONF_TARGET_LPTICKER_LPTIM */
AnnaBridge 167:84c0a372a020 62 /* PREDIV_A is set to the maximum value to improve the consumption */
AnnaBridge 167:84c0a372a020 63 #define PREDIV_A_VALUE 127
AnnaBridge 167:84c0a372a020 64 #endif /* DEVICE_LPTICKER && !MBED_CONF_TARGET_LPTICKER_LPTIM */
AnnaBridge 167:84c0a372a020 65
AnnaBridge 167:84c0a372a020 66 #define PREDIV_S_VALUE RTC_CLOCK / (PREDIV_A_VALUE + 1) - 1
AnnaBridge 167:84c0a372a020 67
AnnaBridge 161:aa5281ff4a02 68 /** Read RTC time with subsecond precision.
Anna Bridge 160:5571c4ff569f 69 *
AnnaBridge 161:aa5281ff4a02 70 * @return Time is microsecond
Anna Bridge 160:5571c4ff569f 71 */
AnnaBridge 161:aa5281ff4a02 72 uint32_t rtc_read_us(void);
Anna Bridge 160:5571c4ff569f 73
Anna Bridge 160:5571c4ff569f 74 /** Program a wake up timer event in delta microseconds.
Anna Bridge 160:5571c4ff569f 75 *
Anna Bridge 160:5571c4ff569f 76 * @param delta The time to wait
Anna Bridge 160:5571c4ff569f 77 */
Anna Bridge 160:5571c4ff569f 78 void rtc_set_wake_up_timer(uint32_t delta);
Anna Bridge 160:5571c4ff569f 79
Anna Bridge 160:5571c4ff569f 80 /** Disable the wake up timer event.
Anna Bridge 160:5571c4ff569f 81 *
Anna Bridge 160:5571c4ff569f 82 * The wake up timer use auto reload, you have to deactivate it manually.
Anna Bridge 160:5571c4ff569f 83 */
Anna Bridge 160:5571c4ff569f 84 void rtc_deactivate_wake_up_timer(void);
Anna Bridge 160:5571c4ff569f 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
Anna Bridge 160:5571c4ff569f 93 #ifdef __cplusplus
Anna Bridge 160:5571c4ff569f 94 }
Anna Bridge 160:5571c4ff569f 95 #endif
Anna Bridge 160:5571c4ff569f 96
Anna Bridge 160:5571c4ff569f 97 #endif