Gan likun / mbed-dev

00

targets/TARGET_STM/rtc_api_hal.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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