Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/hal/rtc_api.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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