EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

targets/TARGET_STM/rtc_api_hal.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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