Andrew SaLoutos / mbed-dev-STM-lean

From Ben Katz mbed-dev library. Removed unnecessary target files to reduce the overall size by a factor of 10 to make it easier to import into the online IDE.

Dependents:   motor_driver motor_driver_screaming_fix

targets/TARGET_STM/rtc_api_hal.h@0:083111ae2a11, 2020-11-26 (annotated)

Committer:
saloutos
Date:
Thu Nov 26 04:08:56 2020 +0000
Revision:
0:083111ae2a11
first commit of leaned mbed dev lib

Who changed what in which revision?

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