Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

targets/TARGET_STM/rtc_api_hal.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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