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_DISCO_L496AG/TARGET_STM/rtc_api_hal.h@166:5aab5a7997ee, 2018-04-20 (annotated)

Committer:
Anna Bridge
Date:
Fri Apr 20 11:08:29 2018 +0100
Revision:
166:5aab5a7997ee
Parent:
165:d1b4690b3f8b
Child:
167:84c0a372a020
Updating mbed 2 version number

Who changed what in which revision?

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