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_NUCLEO_F303K8/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
AnnaBridge 156:ff21514d8981 1 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 2 *******************************************************************************
Anna Bridge 160:5571c4ff569f 3 * Copyright (c) 2017, STMicroelectronics
AnnaBridge 156:ff21514d8981 4 * All rights reserved.
AnnaBridge 156:ff21514d8981 5 *
AnnaBridge 156:ff21514d8981 6 * Redistribution and use in source and binary forms, with or without
AnnaBridge 156:ff21514d8981 7 * modification, are permitted provided that the following conditions are met:
AnnaBridge 156:ff21514d8981 8 *
AnnaBridge 156:ff21514d8981 9 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 156:ff21514d8981 10 * this list of conditions and the following disclaimer.
AnnaBridge 156:ff21514d8981 11 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 156:ff21514d8981 12 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 156:ff21514d8981 13 * and/or other materials provided with the distribution.
AnnaBridge 156:ff21514d8981 14 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 156:ff21514d8981 15 * may be used to endorse or promote products derived from this software
AnnaBridge 156:ff21514d8981 16 * without specific prior written permission.
AnnaBridge 156:ff21514d8981 17 *
AnnaBridge 156:ff21514d8981 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 156:ff21514d8981 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 156:ff21514d8981 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 156:ff21514d8981 21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 156:ff21514d8981 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 156:ff21514d8981 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 156:ff21514d8981 24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 156:ff21514d8981 25 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 156:ff21514d8981 26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 156:ff21514d8981 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 156:ff21514d8981 28 *******************************************************************************
AnnaBridge 156:ff21514d8981 29 */
AnnaBridge 156:ff21514d8981 30
AnnaBridge 156:ff21514d8981 31 #ifndef MBED_RTC_API_HAL_H
AnnaBridge 156:ff21514d8981 32 #define MBED_RTC_API_HAL_H
AnnaBridge 156:ff21514d8981 33
AnnaBridge 156:ff21514d8981 34 #include <stdint.h>
AnnaBridge 156:ff21514d8981 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"
AnnaBridge 156:ff21514d8981 43
AnnaBridge 156:ff21514d8981 44 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 45 extern "C" {
AnnaBridge 156:ff21514d8981 46 #endif
AnnaBridge 156:ff21514d8981 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
AnnaBridge 156:ff21514d8981 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.
AnnaBridge 156:ff21514d8981 69 *
AnnaBridge 161:aa5281ff4a02 70 * @return Time is microsecond
AnnaBridge 156:ff21514d8981 71 */
AnnaBridge 161:aa5281ff4a02 72 uint32_t rtc_read_us(void);
AnnaBridge 156:ff21514d8981 73
AnnaBridge 156:ff21514d8981 74 /** Program a wake up timer event in delta microseconds.
AnnaBridge 156:ff21514d8981 75 *
AnnaBridge 156:ff21514d8981 76 * @param delta The time to wait
AnnaBridge 156:ff21514d8981 77 */
AnnaBridge 156:ff21514d8981 78 void rtc_set_wake_up_timer(uint32_t delta);
AnnaBridge 156:ff21514d8981 79
AnnaBridge 156:ff21514d8981 80 /** Disable the wake up timer event.
AnnaBridge 156:ff21514d8981 81 *
AnnaBridge 156:ff21514d8981 82 * The wake up timer use auto reload, you have to deactivate it manually.
AnnaBridge 156:ff21514d8981 83 */
AnnaBridge 156:ff21514d8981 84 void rtc_deactivate_wake_up_timer(void);
AnnaBridge 156:ff21514d8981 85
AnnaBridge 156:ff21514d8981 86 /** Synchronise the RTC shadow registers.
AnnaBridge 156:ff21514d8981 87 *
AnnaBridge 156:ff21514d8981 88 * Must be called after a deepsleep.
AnnaBridge 156:ff21514d8981 89 */
AnnaBridge 156:ff21514d8981 90 void rtc_synchronize(void);
AnnaBridge 156:ff21514d8981 91
AnnaBridge 156:ff21514d8981 92
AnnaBridge 156:ff21514d8981 93 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 94 }
AnnaBridge 156:ff21514d8981 95 #endif
AnnaBridge 156:ff21514d8981 96
AnnaBridge 156:ff21514d8981 97 #endif