Fawwaz Nadzmy / mbed-STM

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

targets/TARGET_STM/TARGET_STM32L1/rtc_api_hal.h@153:9398a535854b, 2016-12-22 (annotated)

Committer:
fwndz
Date:
Thu Dec 22 05:12:40 2016 +0000
Revision:
153:9398a535854b
Parent:
149:156823d33999 
device target maximize

Who changed what in which revision?

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