Elijah Stanger-Jones / mbed-dev-f303

test

targets/TARGET_STM/rtc_api_hal.h@2:4364577b5ad8, 2020-11-09 (annotated)

Committer:
elijahsj
Date:
Mon Nov 09 00:33:19 2020 -0500
Revision:
2:4364577b5ad8
Parent:
1:8a094db1347f 
copied mbed library

Who changed what in which revision?

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