mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/TARGET_DISCO_L072CZ_LRWAN1/TOOLCHAIN_IAR/rtc_api_hal.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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