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_F413ZH/TARGET_STM/rtc_api_hal.h@160:5571c4ff569f, 2018-01-17 (annotated)

Committer:
Anna Bridge
Date:
Wed Jan 17 16:13:02 2018 +0000
Revision:
160:5571c4ff569f
Child:
161:aa5281ff4a02
mbed library. Release version 158

Who changed what in which revision?

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