John Karatka / mbed

mbed

Fork of mbed-dev by mbed official

targets/TARGET_STM/rtc_api_hal.h@182:57724642e740, 2018-02-16 (annotated)

Committer:
AnnaBridge
Date:
Fri Feb 16 16:09:33 2018 +0000
Revision:
182:57724642e740
Parent:
181:96ed750bd169 
mbed-dev library. Release version 159.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 154:37f96f9d4de2 1 /* mbed Microcontroller Library
<> 154:37f96f9d4de2 2 *******************************************************************************
Anna Bridge 181: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 181:96ed750bd169 36 #include "ticker_api.h"
Anna Bridge 181:96ed750bd169 37 #include "lp_ticker_api.h"
AnnaBridge 182:57724642e740 38 #include "us_ticker_api.h"
AnnaBridge 182:57724642e740 39 #include "hal_tick.h"
AnnaBridge 182:57724642e740 40 #include "mbed_critical.h"
AnnaBridge 182:57724642e740 41 #include "mbed_error.h"
AnnaBridge 182:57724642e740 42 #include "mbed_debug.h"
<> 154:37f96f9d4de2 43
<> 154:37f96f9d4de2 44 #ifdef __cplusplus
<> 154:37f96f9d4de2 45 extern "C" {
<> 154:37f96f9d4de2 46 #endif
<> 154:37f96f9d4de2 47
Anna Bridge 181:96ed750bd169 48 #if MBED_CONF_TARGET_LSE_AVAILABLE
Anna Bridge 181:96ed750bd169 49 #define RTC_CLOCK LSE_VALUE
Anna Bridge 181:96ed750bd169 50 #else
Anna Bridge 181:96ed750bd169 51 #define RTC_CLOCK LSI_VALUE
Anna Bridge 181:96ed750bd169 52 #endif
<> 154:37f96f9d4de2 53
AnnaBridge 182:57724642e740 54 /** Read RTC time with subsecond precision.
<> 154:37f96f9d4de2 55 *
AnnaBridge 182:57724642e740 56 * @return Time is microsecond
<> 154:37f96f9d4de2 57 */
AnnaBridge 182:57724642e740 58 uint32_t rtc_read_us(void);
<> 154:37f96f9d4de2 59
<> 154:37f96f9d4de2 60 /** Program a wake up timer event in delta microseconds.
<> 154:37f96f9d4de2 61 *
<> 154:37f96f9d4de2 62 * @param delta The time to wait
<> 154:37f96f9d4de2 63 */
<> 154:37f96f9d4de2 64 void rtc_set_wake_up_timer(uint32_t delta);
<> 154:37f96f9d4de2 65
<> 154:37f96f9d4de2 66 /** Disable the wake up timer event.
<> 154:37f96f9d4de2 67 *
<> 154:37f96f9d4de2 68 * The wake up timer use auto reload, you have to deactivate it manually.
<> 154:37f96f9d4de2 69 */
<> 154:37f96f9d4de2 70 void rtc_deactivate_wake_up_timer(void);
<> 154:37f96f9d4de2 71
<> 154:37f96f9d4de2 72 /** Synchronise the RTC shadow registers.
<> 154:37f96f9d4de2 73 *
<> 154:37f96f9d4de2 74 * Must be called after a deepsleep.
<> 154:37f96f9d4de2 75 */
<> 154:37f96f9d4de2 76 void rtc_synchronize(void);
<> 154:37f96f9d4de2 77
<> 154:37f96f9d4de2 78
<> 154:37f96f9d4de2 79 #ifdef __cplusplus
<> 154:37f96f9d4de2 80 }
<> 154:37f96f9d4de2 81 #endif
<> 154:37f96f9d4de2 82
<> 154:37f96f9d4de2 83 #endif