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@166:5aab5a7997ee, 2018-04-20 (annotated)

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

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 161:aa5281ff4a02 54 /** Read RTC time with subsecond precision.
AnnaBridge 156:ff21514d8981 55 *
AnnaBridge 161:aa5281ff4a02 56 * @return Time is microsecond
AnnaBridge 156:ff21514d8981 57 */
AnnaBridge 161:aa5281ff4a02 58 uint32_t rtc_read_us(void);
AnnaBridge 156:ff21514d8981 59
AnnaBridge 156:ff21514d8981 60 /** Program a wake up timer event in delta microseconds.
AnnaBridge 156:ff21514d8981 61 *
AnnaBridge 156:ff21514d8981 62 * @param delta The time to wait
AnnaBridge 156:ff21514d8981 63 */
AnnaBridge 156:ff21514d8981 64 void rtc_set_wake_up_timer(uint32_t delta);
AnnaBridge 156:ff21514d8981 65
AnnaBridge 156:ff21514d8981 66 /** Disable the wake up timer event.
AnnaBridge 156:ff21514d8981 67 *
AnnaBridge 156:ff21514d8981 68 * The wake up timer use auto reload, you have to deactivate it manually.
AnnaBridge 156:ff21514d8981 69 */
AnnaBridge 156:ff21514d8981 70 void rtc_deactivate_wake_up_timer(void);
AnnaBridge 156:ff21514d8981 71
AnnaBridge 156:ff21514d8981 72 /** Synchronise the RTC shadow registers.
AnnaBridge 156:ff21514d8981 73 *
AnnaBridge 156:ff21514d8981 74 * Must be called after a deepsleep.
AnnaBridge 156:ff21514d8981 75 */
AnnaBridge 156:ff21514d8981 76 void rtc_synchronize(void);
AnnaBridge 156:ff21514d8981 77
AnnaBridge 156:ff21514d8981 78
AnnaBridge 156:ff21514d8981 79 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 80 }
AnnaBridge 156:ff21514d8981 81 #endif
AnnaBridge 156:ff21514d8981 82
AnnaBridge 156:ff21514d8981 83 #endif