mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/rtc_api.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
186:707f6e361f3e 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 144:ef7eb2e8f9f7 1 /* mbed Microcontroller Library
<> 144:ef7eb2e8f9f7 2 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 189:f392fc9709a3 3 * SPDX-License-Identifier: Apache-2.0
<> 144:ef7eb2e8f9f7 4 *
<> 144:ef7eb2e8f9f7 5 * Licensed under the Apache License, Version 2.0 (the "License");
<> 144:ef7eb2e8f9f7 6 * you may not use this file except in compliance with the License.
<> 144:ef7eb2e8f9f7 7 * You may obtain a copy of the License at
<> 144:ef7eb2e8f9f7 8 *
<> 144:ef7eb2e8f9f7 9 * http://www.apache.org/licenses/LICENSE-2.0
<> 144:ef7eb2e8f9f7 10 *
<> 144:ef7eb2e8f9f7 11 * Unless required by applicable law or agreed to in writing, software
<> 144:ef7eb2e8f9f7 12 * distributed under the License is distributed on an "AS IS" BASIS,
<> 144:ef7eb2e8f9f7 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 144:ef7eb2e8f9f7 14 * See the License for the specific language governing permissions and
<> 144:ef7eb2e8f9f7 15 * limitations under the License.
<> 144:ef7eb2e8f9f7 16 */
Anna Bridge 186:707f6e361f3e 17
Anna Bridge 186:707f6e361f3e 18 /** \addtogroup hal */
Anna Bridge 186:707f6e361f3e 19 /** @{*/
Anna Bridge 186:707f6e361f3e 20
<> 144:ef7eb2e8f9f7 21 #ifndef MBED_RTC_API_H
<> 144:ef7eb2e8f9f7 22 #define MBED_RTC_API_H
<> 144:ef7eb2e8f9f7 23
<> 144:ef7eb2e8f9f7 24 #include "device.h"
<> 144:ef7eb2e8f9f7 25
<> 144:ef7eb2e8f9f7 26 #include <time.h>
<> 144:ef7eb2e8f9f7 27
<> 144:ef7eb2e8f9f7 28 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 29 extern "C" {
<> 144:ef7eb2e8f9f7 30 #endif
<> 144:ef7eb2e8f9f7 31
<> 144:ef7eb2e8f9f7 32 /**
Anna Bridge 186:707f6e361f3e 33 * \defgroup hal_rtc RTC hal
Anna Bridge 186:707f6e361f3e 34 *
Anna Bridge 186:707f6e361f3e 35 * The RTC hal provides a low level interface to the Real Time Counter (RTC) of a
Anna Bridge 186:707f6e361f3e 36 * target.
Anna Bridge 186:707f6e361f3e 37 *
Anna Bridge 186:707f6e361f3e 38 * # Defined behaviour
Anna Bridge 186:707f6e361f3e 39 * * The function ::rtc_init is safe to call repeatedly - Verified by test ::rtc_init_test.
Anna Bridge 186:707f6e361f3e 40 * * RTC accuracy is at least 10% - Verified by test ::rtc_accuracy_test.
Anna Bridge 186:707f6e361f3e 41 * * Init/free doesn't stop RTC from counting - Verified by test ::rtc_persist_test.
Anna Bridge 186:707f6e361f3e 42 * * Software reset doesn't stop RTC from counting - Verified by test ::rtc_reset_test.
Anna Bridge 186:707f6e361f3e 43 * * Sleep modes don't stop RTC from counting - Verified by test ::rtc_sleep_test.
Anna Bridge 186:707f6e361f3e 44 * * Shutdown mode doesn't stop RTC from counting - Not verified.
Anna Bridge 186:707f6e361f3e 45 * * The functions ::rtc_write/::rtc_read provides availability to set/get RTC time
Anna Bridge 186:707f6e361f3e 46 * - Verified by test ::rtc_write_read_test.
Anna Bridge 186:707f6e361f3e 47 * * The functions ::rtc_isenabled returns 1 if the RTC is counting and the time has been set,
Anna Bridge 186:707f6e361f3e 48 * 0 otherwise - Verified by test ::rtc_enabled_test.
Anna Bridge 186:707f6e361f3e 49 *
Anna Bridge 186:707f6e361f3e 50 * # Undefined behaviour
Anna Bridge 186:707f6e361f3e 51 * * Calling any function other than ::rtc_init before the initialisation of the RTC
Anna Bridge 186:707f6e361f3e 52 *
Anna Bridge 186:707f6e361f3e 53 * # Potential bugs
Anna Bridge 186:707f6e361f3e 54 * * Incorrect overflow handling - Verified by ::rtc_range_test
Anna Bridge 186:707f6e361f3e 55 * * Glitches due to ripple counter - Verified by ::rtc_glitch_test
Anna Bridge 186:707f6e361f3e 56 *
Anna Bridge 186:707f6e361f3e 57 * @see hal_rtc_tests
Anna Bridge 186:707f6e361f3e 58 *
<> 144:ef7eb2e8f9f7 59 * @{
<> 144:ef7eb2e8f9f7 60 */
<> 144:ef7eb2e8f9f7 61
Anna Bridge 186:707f6e361f3e 62 /**
Anna Bridge 186:707f6e361f3e 63 * \defgroup hal_rtc_tests RTC hal tests
Anna Bridge 186:707f6e361f3e 64 * The RTC test validate proper implementation of the RTC hal.
Anna Bridge 186:707f6e361f3e 65 *
Anna Bridge 186:707f6e361f3e 66 * To run the RTC hal tests use the command:
Anna Bridge 186:707f6e361f3e 67 *
Anna Bridge 186:707f6e361f3e 68 * mbed test -t <toolchain> -m <target> -n tests-mbed_hal-rtc*
Anna Bridge 186:707f6e361f3e 69 */
Anna Bridge 186:707f6e361f3e 70
Anna Bridge 186:707f6e361f3e 71
<> 144:ef7eb2e8f9f7 72 /** Initialize the RTC peripheral
<> 144:ef7eb2e8f9f7 73 *
Anna Bridge 186:707f6e361f3e 74 * Powerup the RTC in perpetration for access. This function must be called
Anna Bridge 186:707f6e361f3e 75 * before any other RTC functions ares called. This does not change the state
Anna Bridge 186:707f6e361f3e 76 * of the RTC. It just enables access to it.
Anna Bridge 186:707f6e361f3e 77 *
Anna Bridge 186:707f6e361f3e 78 * @note This function is safe to call repeatedly - Tested by ::rtc_init_test
Anna Bridge 186:707f6e361f3e 79 *
Anna Bridge 186:707f6e361f3e 80 * Example Implementation Pseudo Code:
Anna Bridge 186:707f6e361f3e 81 * @code
Anna Bridge 186:707f6e361f3e 82 * void rtc_init()
Anna Bridge 186:707f6e361f3e 83 * {
Anna Bridge 186:707f6e361f3e 84 * // Enable clock gate so processor can read RTC registers
Anna Bridge 186:707f6e361f3e 85 * POWER_CTRL |= POWER_CTRL_RTC_Msk;
Anna Bridge 186:707f6e361f3e 86 *
Anna Bridge 186:707f6e361f3e 87 * // See if the RTC is already setup
Anna Bridge 186:707f6e361f3e 88 * if (!(RTC_STATUS & RTC_STATUS_COUNTING_Msk)) {
Anna Bridge 186:707f6e361f3e 89 *
Anna Bridge 186:707f6e361f3e 90 * // Setup the RTC clock source
Anna Bridge 186:707f6e361f3e 91 * RTC_CTRL |= RTC_CTRL_CLK32_Msk;
Anna Bridge 186:707f6e361f3e 92 * }
Anna Bridge 186:707f6e361f3e 93 * }
Anna Bridge 186:707f6e361f3e 94 * @endcode
<> 144:ef7eb2e8f9f7 95 */
<> 144:ef7eb2e8f9f7 96 void rtc_init(void);
<> 144:ef7eb2e8f9f7 97
<> 144:ef7eb2e8f9f7 98 /** Deinitialize RTC
<> 144:ef7eb2e8f9f7 99 *
Anna Bridge 186:707f6e361f3e 100 * Powerdown the RTC in preparation for sleep, powerdown or reset. That should only
Anna Bridge 186:707f6e361f3e 101 * affect the CPU domain and not the time keeping logic.
Anna Bridge 186:707f6e361f3e 102 * After this function is called no other RTC functions should be called
Anna Bridge 186:707f6e361f3e 103 * except for ::rtc_init.
Anna Bridge 186:707f6e361f3e 104 *
Anna Bridge 186:707f6e361f3e 105 * @note This function does not stop the RTC from counting - Tested by ::rtc_persist_test
Anna Bridge 186:707f6e361f3e 106 *
Anna Bridge 186:707f6e361f3e 107 * Example Implementation Pseudo Code:
Anna Bridge 186:707f6e361f3e 108 * @code
Anna Bridge 186:707f6e361f3e 109 * void rtc_free()
Anna Bridge 186:707f6e361f3e 110 * {
Anna Bridge 186:707f6e361f3e 111 * // Disable clock gate since processor no longer needs to read RTC registers
Anna Bridge 186:707f6e361f3e 112 * POWER_CTRL &= ~POWER_CTRL_RTC_Msk;
Anna Bridge 186:707f6e361f3e 113 * }
Anna Bridge 186:707f6e361f3e 114 * @endcode
<> 144:ef7eb2e8f9f7 115 */
<> 144:ef7eb2e8f9f7 116 void rtc_free(void);
<> 144:ef7eb2e8f9f7 117
Anna Bridge 186:707f6e361f3e 118 /** Check if the RTC has the time set and is counting
Anna Bridge 186:707f6e361f3e 119 *
Anna Bridge 186:707f6e361f3e 120 * @retval 0 The time reported by the RTC is not valid
Anna Bridge 186:707f6e361f3e 121 * @retval 1 The time has been set the RTC is counting
<> 144:ef7eb2e8f9f7 122 *
Anna Bridge 186:707f6e361f3e 123 * Example Implementation Pseudo Code:
Anna Bridge 186:707f6e361f3e 124 * @code
Anna Bridge 186:707f6e361f3e 125 * int rtc_isenabled()
Anna Bridge 186:707f6e361f3e 126 * {
Anna Bridge 186:707f6e361f3e 127 * if (RTC_STATUS & RTC_STATUS_COUNTING_Msk) {
Anna Bridge 186:707f6e361f3e 128 * return 1;
Anna Bridge 186:707f6e361f3e 129 * } else {
Anna Bridge 186:707f6e361f3e 130 * return 0;
Anna Bridge 186:707f6e361f3e 131 * }
Anna Bridge 186:707f6e361f3e 132 * }
Anna Bridge 186:707f6e361f3e 133 * @endcode
<> 144:ef7eb2e8f9f7 134 */
<> 144:ef7eb2e8f9f7 135 int rtc_isenabled(void);
<> 144:ef7eb2e8f9f7 136
<> 144:ef7eb2e8f9f7 137 /** Get the current time from the RTC peripheral
<> 144:ef7eb2e8f9f7 138 *
Anna Bridge 186:707f6e361f3e 139 * @return The current time in seconds
Anna Bridge 186:707f6e361f3e 140 *
Anna Bridge 186:707f6e361f3e 141 * @note Some RTCs are not synchronized with the main clock. If
Anna Bridge 186:707f6e361f3e 142 * this is the case with your RTC then you must read the RTC time
Anna Bridge 186:707f6e361f3e 143 * in a loop to prevent reading the wrong time due to a glitch.
Anna Bridge 186:707f6e361f3e 144 * The test ::rtc_glitch_test is intended to catch this bug.
Anna Bridge 186:707f6e361f3e 145 *
Anna Bridge 186:707f6e361f3e 146 * Example implementation for an unsynchronized ripple counter:
Anna Bridge 186:707f6e361f3e 147 * @code
Anna Bridge 186:707f6e361f3e 148 * time_t rtc_read()
Anna Bridge 186:707f6e361f3e 149 * {
Anna Bridge 186:707f6e361f3e 150 * uint32_t val;
Anna Bridge 186:707f6e361f3e 151 * uint32_t last_val;
Anna Bridge 186:707f6e361f3e 152 *
Anna Bridge 186:707f6e361f3e 153 * // Loop until the same value is read twice
Anna Bridge 186:707f6e361f3e 154 * val = RTC_SECONDS;
Anna Bridge 186:707f6e361f3e 155 * do {
Anna Bridge 186:707f6e361f3e 156 * last_val = val;
Anna Bridge 186:707f6e361f3e 157 * val = RTC_SECONDS;
Anna Bridge 186:707f6e361f3e 158 * } while (last_val != val);
Anna Bridge 186:707f6e361f3e 159 *
Anna Bridge 186:707f6e361f3e 160 * return (time_t)val;
Anna Bridge 186:707f6e361f3e 161 * }
Anna Bridge 186:707f6e361f3e 162 * @endcode
<> 144:ef7eb2e8f9f7 163 */
<> 144:ef7eb2e8f9f7 164 time_t rtc_read(void);
<> 144:ef7eb2e8f9f7 165
Anna Bridge 186:707f6e361f3e 166 /** Write the current time in seconds to the RTC peripheral
Anna Bridge 186:707f6e361f3e 167 *
Anna Bridge 186:707f6e361f3e 168 * @param t The current time to be set in seconds.
<> 144:ef7eb2e8f9f7 169 *
Anna Bridge 186:707f6e361f3e 170 * Example Implementation Pseudo Code:
Anna Bridge 186:707f6e361f3e 171 * @code
Anna Bridge 186:707f6e361f3e 172 * void rtc_write(time_t t)
Anna Bridge 186:707f6e361f3e 173 * {
Anna Bridge 186:707f6e361f3e 174 * RTC_SECONDS = t;
Anna Bridge 186:707f6e361f3e 175 * }
Anna Bridge 186:707f6e361f3e 176 * @endcode
<> 144:ef7eb2e8f9f7 177 */
<> 144:ef7eb2e8f9f7 178 void rtc_write(time_t t);
<> 144:ef7eb2e8f9f7 179
<> 144:ef7eb2e8f9f7 180 /**@}*/
<> 144:ef7eb2e8f9f7 181
<> 144:ef7eb2e8f9f7 182 #ifdef __cplusplus
<> 144:ef7eb2e8f9f7 183 }
<> 144:ef7eb2e8f9f7 184 #endif
<> 144:ef7eb2e8f9f7 185
<> 144:ef7eb2e8f9f7 186 #endif
<> 144:ef7eb2e8f9f7 187
<> 149:156823d33999 188 /** @}*/