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_SAKURAIO_EVB_01/TARGET_STM/rtc_api_hal.h@159:7130f322cb7e, 2017-12-21 (annotated)

Committer:
mbed_official
Date:
Thu Dec 21 18:20:02 2017 +0000
Revision:
159:7130f322cb7e
mbed library version 157

Who changed what in which revision?

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