mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

targets/TARGET_STM/rtc_api_hal.h@180:96ed750bd169, 2018-01-17 (annotated)

Committer:
Anna Bridge
Date:
Wed Jan 17 15:23:54 2018 +0000
Revision:
180:96ed750bd169
Parent:
154:37f96f9d4de2
Child:
181:57724642e740
mbed-dev libray. Release version 158

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 154:37f96f9d4de2 1 /* mbed Microcontroller Library
<> 154:37f96f9d4de2 2 *******************************************************************************
Anna Bridge 180:96ed750bd169 3 * Copyright (c) 2017, STMicroelectronics
<> 154:37f96f9d4de2 4 * All rights reserved.
<> 154:37f96f9d4de2 5 *
<> 154:37f96f9d4de2 6 * Redistribution and use in source and binary forms, with or without
<> 154:37f96f9d4de2 7 * modification, are permitted provided that the following conditions are met:
<> 154:37f96f9d4de2 8 *
<> 154:37f96f9d4de2 9 * 1. Redistributions of source code must retain the above copyright notice,
<> 154:37f96f9d4de2 10 * this list of conditions and the following disclaimer.
<> 154:37f96f9d4de2 11 * 2. Redistributions in binary form must reproduce the above copyright notice,
<> 154:37f96f9d4de2 12 * this list of conditions and the following disclaimer in the documentation
<> 154:37f96f9d4de2 13 * and/or other materials provided with the distribution.
<> 154:37f96f9d4de2 14 * 3. Neither the name of STMicroelectronics nor the names of its contributors
<> 154:37f96f9d4de2 15 * may be used to endorse or promote products derived from this software
<> 154:37f96f9d4de2 16 * without specific prior written permission.
<> 154:37f96f9d4de2 17 *
<> 154:37f96f9d4de2 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
<> 154:37f96f9d4de2 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
<> 154:37f96f9d4de2 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
<> 154:37f96f9d4de2 21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
<> 154:37f96f9d4de2 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
<> 154:37f96f9d4de2 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
<> 154:37f96f9d4de2 24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
<> 154:37f96f9d4de2 25 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
<> 154:37f96f9d4de2 26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
<> 154:37f96f9d4de2 27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<> 154:37f96f9d4de2 28 *******************************************************************************
<> 154:37f96f9d4de2 29 */
<> 154:37f96f9d4de2 30
<> 154:37f96f9d4de2 31 #ifndef MBED_RTC_API_HAL_H
<> 154:37f96f9d4de2 32 #define MBED_RTC_API_HAL_H
<> 154:37f96f9d4de2 33
<> 154:37f96f9d4de2 34 #include <stdint.h>
<> 154:37f96f9d4de2 35 #include "rtc_api.h"
Anna Bridge 180:96ed750bd169 36 #include "ticker_api.h"
Anna Bridge 180:96ed750bd169 37 #include "lp_ticker_api.h"
<> 154:37f96f9d4de2 38
<> 154:37f96f9d4de2 39 #ifdef __cplusplus
<> 154:37f96f9d4de2 40 extern "C" {
<> 154:37f96f9d4de2 41 #endif
<> 154:37f96f9d4de2 42
Anna Bridge 180:96ed750bd169 43 #if MBED_CONF_TARGET_LSE_AVAILABLE
Anna Bridge 180:96ed750bd169 44 #define RTC_CLOCK LSE_VALUE
Anna Bridge 180:96ed750bd169 45 #else
Anna Bridge 180:96ed750bd169 46 #define RTC_CLOCK LSI_VALUE
Anna Bridge 180:96ed750bd169 47 #endif
<> 154:37f96f9d4de2 48
<> 154:37f96f9d4de2 49 /** Read the subsecond register.
<> 154:37f96f9d4de2 50 *
<> 154:37f96f9d4de2 51 * @return The remaining time as microseconds (0-999999)
<> 154:37f96f9d4de2 52 */
<> 154:37f96f9d4de2 53 uint32_t rtc_read_subseconds(void);
<> 154:37f96f9d4de2 54
<> 154:37f96f9d4de2 55 /** Program a wake up timer event in delta microseconds.
<> 154:37f96f9d4de2 56 *
<> 154:37f96f9d4de2 57 * @param delta The time to wait
<> 154:37f96f9d4de2 58 */
<> 154:37f96f9d4de2 59 void rtc_set_wake_up_timer(uint32_t delta);
<> 154:37f96f9d4de2 60
<> 154:37f96f9d4de2 61 /** Disable the wake up timer event.
<> 154:37f96f9d4de2 62 *
<> 154:37f96f9d4de2 63 * The wake up timer use auto reload, you have to deactivate it manually.
<> 154:37f96f9d4de2 64 */
<> 154:37f96f9d4de2 65 void rtc_deactivate_wake_up_timer(void);
<> 154:37f96f9d4de2 66
<> 154:37f96f9d4de2 67 /** Synchronise the RTC shadow registers.
<> 154:37f96f9d4de2 68 *
<> 154:37f96f9d4de2 69 * Must be called after a deepsleep.
<> 154:37f96f9d4de2 70 */
<> 154:37f96f9d4de2 71 void rtc_synchronize(void);
<> 154:37f96f9d4de2 72
<> 154:37f96f9d4de2 73
<> 154:37f96f9d4de2 74 #ifdef __cplusplus
<> 154:37f96f9d4de2 75 }
<> 154:37f96f9d4de2 76 #endif
<> 154:37f96f9d4de2 77
<> 154:37f96f9d4de2 78 #endif