Kev Mann / mbed-dev-OS5_10_4

RTC auf true

hal/us_ticker_api.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kevman 0:38ceb79fef03 1
kevman 0:38ceb79fef03 2 /** \addtogroup hal */
kevman 0:38ceb79fef03 3 /** @{*/
kevman 0:38ceb79fef03 4 /* mbed Microcontroller Library
kevman 0:38ceb79fef03 5 * Copyright (c) 2006-2015 ARM Limited
kevman 0:38ceb79fef03 6 *
kevman 0:38ceb79fef03 7 * Licensed under the Apache License, Version 2.0 (the "License");
kevman 0:38ceb79fef03 8 * you may not use this file except in compliance with the License.
kevman 0:38ceb79fef03 9 * You may obtain a copy of the License at
kevman 0:38ceb79fef03 10 *
kevman 0:38ceb79fef03 11 * http://www.apache.org/licenses/LICENSE-2.0
kevman 0:38ceb79fef03 12 *
kevman 0:38ceb79fef03 13 * Unless required by applicable law or agreed to in writing, software
kevman 0:38ceb79fef03 14 * distributed under the License is distributed on an "AS IS" BASIS,
kevman 0:38ceb79fef03 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kevman 0:38ceb79fef03 16 * See the License for the specific language governing permissions and
kevman 0:38ceb79fef03 17 * limitations under the License.
kevman 0:38ceb79fef03 18 */
kevman 0:38ceb79fef03 19 #ifndef MBED_US_TICKER_API_H
kevman 0:38ceb79fef03 20 #define MBED_US_TICKER_API_H
kevman 0:38ceb79fef03 21
kevman 0:38ceb79fef03 22 #include <stdint.h>
kevman 0:38ceb79fef03 23 #include "hal/ticker_api.h"
kevman 0:38ceb79fef03 24
kevman 0:38ceb79fef03 25 #ifdef __cplusplus
kevman 0:38ceb79fef03 26 extern "C" {
kevman 0:38ceb79fef03 27 #endif
kevman 0:38ceb79fef03 28
kevman 0:38ceb79fef03 29 /**
kevman 0:38ceb79fef03 30 * \defgroup hal_us_ticker Microsecond Ticker
kevman 0:38ceb79fef03 31 * Low level interface to the microsecond ticker of a target
kevman 0:38ceb79fef03 32 *
kevman 0:38ceb79fef03 33 * # Defined behavior
kevman 0:38ceb79fef03 34 * * Has a reported frequency between 250KHz and 8MHz - Verified by test ::us_ticker_info_test
kevman 0:38ceb79fef03 35 * * Has a counter that is at least 16 bits wide - Verified by test ::us_ticker_info_test
kevman 0:38ceb79fef03 36 * * All behavior defined by the @ref hal_ticker_shared "ticker specification"
kevman 0:38ceb79fef03 37 *
kevman 0:38ceb79fef03 38 * # Undefined behavior
kevman 0:38ceb79fef03 39 * * See the @ref hal_ticker_shared "ticker specification"
kevman 0:38ceb79fef03 40 *
kevman 0:38ceb79fef03 41 * @see hal_us_ticker_tests
kevman 0:38ceb79fef03 42 *
kevman 0:38ceb79fef03 43 * @{
kevman 0:38ceb79fef03 44 */
kevman 0:38ceb79fef03 45
kevman 0:38ceb79fef03 46 /**
kevman 0:38ceb79fef03 47 * \defgroup hal_us_ticker_tests Microsecond Ticker tests
kevman 0:38ceb79fef03 48 * Tests to validate the proper implementation of the microsecond ticker
kevman 0:38ceb79fef03 49 *
kevman 0:38ceb79fef03 50 * To run the microsecond ticker hal tests use the command:
kevman 0:38ceb79fef03 51 *
kevman 0:38ceb79fef03 52 * mbed test -t <toolchain> -m <target> -n tests-mbed_hal-common_ticker*,tests-mbed_hal-us_ticker*
kevman 0:38ceb79fef03 53 *
kevman 0:38ceb79fef03 54 * @see hal_ticker_tests
kevman 0:38ceb79fef03 55 *
kevman 0:38ceb79fef03 56 */
kevman 0:38ceb79fef03 57
kevman 0:38ceb79fef03 58 /**
kevman 0:38ceb79fef03 59 * \defgroup hal_ticker_shared Ticker Hal
kevman 0:38ceb79fef03 60 * Low level interface to the ticker of a target
kevman 0:38ceb79fef03 61 *
kevman 0:38ceb79fef03 62 * # Defined behavior
kevman 0:38ceb79fef03 63 * * The function ticker_init is safe to call repeatedly - Verified by test ::ticker_init_test
kevman 0:38ceb79fef03 64 * * The function ticker_init allows the ticker to keep counting and disables the ticker interrupt - Verified by test ::ticker_init_test
kevman 0:38ceb79fef03 65 * * Ticker frequency is non-zero and counter is at least 8 bits - Verified by ::ticker_info_test
kevman 0:38ceb79fef03 66 * * The ticker rolls over at (1 << bits) and continues counting starting from 0 - Verified by ::ticker_overflow_test
kevman 0:38ceb79fef03 67 * * The ticker counts at the specified frequency +- 10% - Verified by ::ticker_frequency_test
kevman 0:38ceb79fef03 68 * * The ticker increments by 1 each tick - Verified by ::ticker_increment_test
kevman 0:38ceb79fef03 69 * * The ticker interrupt fires only when the ticker times increments to or past the value set by ticker_set_interrupt.
kevman 0:38ceb79fef03 70 * Verified by ::ticker_interrupt_test and ::ticker_past_test
kevman 0:38ceb79fef03 71 * * It is safe to call ticker_set_interrupt repeatedly before the handler is called - Verified by ::ticker_repeat_reschedule_test
kevman 0:38ceb79fef03 72 * * The function ticker_fire_interrupt causes ticker_irq_handler to be called immediately from interrupt context -
kevman 0:38ceb79fef03 73 * Verified by ::ticker_fire_now_test
kevman 0:38ceb79fef03 74 * * The ticker operations ticker_read, ticker_clear_interrupt, ticker_set_interrupt and ticker_fire_interrupt
kevman 0:38ceb79fef03 75 * take less than 20us to complete - Verified by ::ticker_speed_test
kevman 0:38ceb79fef03 76 *
kevman 0:38ceb79fef03 77 * # Undefined behavior
kevman 0:38ceb79fef03 78 * * Calling any function other than ticker_init before the initialization of the ticker
kevman 0:38ceb79fef03 79 * * Whether ticker_irq_handler is called a second time if the time wraps and matches the value set by ticker_set_interrupt again
kevman 0:38ceb79fef03 80 * * Calling ticker_set_interrupt with a value that has more than the supported number of bits
kevman 0:38ceb79fef03 81 * * Calling any function other than us_ticker_init after calling us_ticker_free
kevman 0:38ceb79fef03 82 *
kevman 0:38ceb79fef03 83 * # Potential bugs
kevman 0:38ceb79fef03 84 * * Drift due to reschedule - Verified by ::ticker_repeat_reschedule_test
kevman 0:38ceb79fef03 85 * * Incorrect overflow handling of timers - Verified by ::ticker_overflow_test
kevman 0:38ceb79fef03 86 * * Interrupting at a time of 0 - Verified by ::ticker_overflow_test
kevman 0:38ceb79fef03 87 * * Interrupt triggered more than once - Verified by ::ticker_interrupt_test
kevman 0:38ceb79fef03 88 *
kevman 0:38ceb79fef03 89 * @ingroup hal_us_ticker
kevman 0:38ceb79fef03 90 * @ingroup hal_lp_ticker
kevman 0:38ceb79fef03 91 */
kevman 0:38ceb79fef03 92
kevman 0:38ceb79fef03 93 /**
kevman 0:38ceb79fef03 94 * \defgroup hal_ticker_tests Ticker Tests
kevman 0:38ceb79fef03 95 * Tests to validate the proper implementation of a ticker
kevman 0:38ceb79fef03 96 *
kevman 0:38ceb79fef03 97 * To run the ticker hal tests use the command:
kevman 0:38ceb79fef03 98 *
kevman 0:38ceb79fef03 99 * mbed test -t <toolchain> -m <target> -n tests-mbed_hal-common_ticker*
kevman 0:38ceb79fef03 100 *
kevman 0:38ceb79fef03 101 * @ingroup hal_us_ticker
kevman 0:38ceb79fef03 102 * @ingroup hal_lp_ticker
kevman 0:38ceb79fef03 103 */
kevman 0:38ceb79fef03 104
kevman 0:38ceb79fef03 105
kevman 0:38ceb79fef03 106 typedef void (*ticker_irq_handler_type)(const ticker_data_t *const);
kevman 0:38ceb79fef03 107
kevman 0:38ceb79fef03 108 /** Set ticker IRQ handler
kevman 0:38ceb79fef03 109 *
kevman 0:38ceb79fef03 110 * @param ticker_irq_handler IRQ handler to be connected
kevman 0:38ceb79fef03 111 *
kevman 0:38ceb79fef03 112 * @return previous ticker IRQ handler
kevman 0:38ceb79fef03 113 *
kevman 0:38ceb79fef03 114 * @note by default IRQ handler is set to ::ticker_irq_handler
kevman 0:38ceb79fef03 115 * @note this function is primarily for testing purposes and it's not required part of HAL implementation
kevman 0:38ceb79fef03 116 *
kevman 0:38ceb79fef03 117 */
kevman 0:38ceb79fef03 118 ticker_irq_handler_type set_us_ticker_irq_handler(ticker_irq_handler_type ticker_irq_handler);
kevman 0:38ceb79fef03 119
kevman 0:38ceb79fef03 120 /** Get ticker's data
kevman 0:38ceb79fef03 121 *
kevman 0:38ceb79fef03 122 * @return The microsecond ticker data
kevman 0:38ceb79fef03 123 */
kevman 0:38ceb79fef03 124 const ticker_data_t *get_us_ticker_data(void);
kevman 0:38ceb79fef03 125
kevman 0:38ceb79fef03 126
kevman 0:38ceb79fef03 127 /** The wrapper for ticker_irq_handler, to pass us ticker's data
kevman 0:38ceb79fef03 128 *
kevman 0:38ceb79fef03 129 */
kevman 0:38ceb79fef03 130 void us_ticker_irq_handler(void);
kevman 0:38ceb79fef03 131
kevman 0:38ceb79fef03 132 /* HAL us ticker */
kevman 0:38ceb79fef03 133
kevman 0:38ceb79fef03 134 /** Initialize the ticker
kevman 0:38ceb79fef03 135 *
kevman 0:38ceb79fef03 136 * Initialize or re-initialize the ticker. This resets all the
kevman 0:38ceb79fef03 137 * clocking and prescaler registers, along with disabling
kevman 0:38ceb79fef03 138 * the compare interrupt.
kevman 0:38ceb79fef03 139 *
kevman 0:38ceb79fef03 140 * @note Initialization properties tested by ::ticker_init_test
kevman 0:38ceb79fef03 141 *
kevman 0:38ceb79fef03 142 * Pseudo Code:
kevman 0:38ceb79fef03 143 * @code
kevman 0:38ceb79fef03 144 * void us_ticker_init()
kevman 0:38ceb79fef03 145 * {
kevman 0:38ceb79fef03 146 * // Enable clock gate so processor can read TIMER registers
kevman 0:38ceb79fef03 147 * POWER_CTRL |= POWER_CTRL_TIMER_Msk;
kevman 0:38ceb79fef03 148 *
kevman 0:38ceb79fef03 149 * // Disable the timer and ensure it is powered down
kevman 0:38ceb79fef03 150 * TIMER_CTRL &= ~(TIMER_CTRL_ENABLE_Msk | TIMER_CTRL_COMPARE_ENABLE_Msk);
kevman 0:38ceb79fef03 151 *
kevman 0:38ceb79fef03 152 * // Configure divisors
kevman 0:38ceb79fef03 153 * uint32_t prescale = SystemCoreClock / 1000000;
kevman 0:38ceb79fef03 154 * TIMER_PRESCALE = prescale - 1;
kevman 0:38ceb79fef03 155 * TIMER_CTRL |= TIMER_CTRL_ENABLE_Msk;
kevman 0:38ceb79fef03 156 *
kevman 0:38ceb79fef03 157 * // Install the interrupt handler
kevman 0:38ceb79fef03 158 * NVIC_SetVector(TIMER_IRQn, (uint32_t)us_ticker_irq_handler);
kevman 0:38ceb79fef03 159 * NVIC_EnableIRQ(TIMER_IRQn);
kevman 0:38ceb79fef03 160 * }
kevman 0:38ceb79fef03 161 * @endcode
kevman 0:38ceb79fef03 162 */
kevman 0:38ceb79fef03 163 void us_ticker_init(void);
kevman 0:38ceb79fef03 164
kevman 0:38ceb79fef03 165 /** Deinitialize the us ticker
kevman 0:38ceb79fef03 166 *
kevman 0:38ceb79fef03 167 * Powerdown the us ticker in preparation for sleep, powerdown, or reset.
kevman 0:38ceb79fef03 168 *
kevman 0:38ceb79fef03 169 * After this function is called, no other ticker functions should be called
kevman 0:38ceb79fef03 170 * except us_ticker_init(), calling any function other than init is undefined.
kevman 0:38ceb79fef03 171 *
kevman 0:38ceb79fef03 172 * @note This function stops the ticker from counting.
kevman 0:38ceb79fef03 173 *
kevman 0:38ceb79fef03 174 * Pseudo Code:
kevman 0:38ceb79fef03 175 * @code
kevman 0:38ceb79fef03 176 * uint32_t us_ticker_free()
kevman 0:38ceb79fef03 177 * {
kevman 0:38ceb79fef03 178 * // Disable timer
kevman 0:38ceb79fef03 179 * TIMER_CTRL &= ~TIMER_CTRL_ENABLE_Msk;
kevman 0:38ceb79fef03 180 *
kevman 0:38ceb79fef03 181 * // Disable the compare interrupt
kevman 0:38ceb79fef03 182 * TIMER_CTRL &= ~TIMER_CTRL_COMPARE_ENABLE_Msk;
kevman 0:38ceb79fef03 183 *
kevman 0:38ceb79fef03 184 * // Disable timer interrupt
kevman 0:38ceb79fef03 185 * NVIC_DisableIRQ(TIMER_IRQn);
kevman 0:38ceb79fef03 186 *
kevman 0:38ceb79fef03 187 * // Disable clock gate so processor cannot read TIMER registers
kevman 0:38ceb79fef03 188 * POWER_CTRL &= ~POWER_CTRL_TIMER_Msk;
kevman 0:38ceb79fef03 189 * }
kevman 0:38ceb79fef03 190 * @endcode
kevman 0:38ceb79fef03 191 *
kevman 0:38ceb79fef03 192 */
kevman 0:38ceb79fef03 193 void us_ticker_free(void);
kevman 0:38ceb79fef03 194
kevman 0:38ceb79fef03 195 /** Read the current counter
kevman 0:38ceb79fef03 196 *
kevman 0:38ceb79fef03 197 * Read the current counter value without performing frequency conversions.
kevman 0:38ceb79fef03 198 * If no rollover has occurred, the seconds passed since us_ticker_init()
kevman 0:38ceb79fef03 199 * was called can be found by dividing the ticks returned by this function
kevman 0:38ceb79fef03 200 * by the frequency returned by ::us_ticker_get_info.
kevman 0:38ceb79fef03 201 *
kevman 0:38ceb79fef03 202 * @return The current timer's counter value in ticks
kevman 0:38ceb79fef03 203 *
kevman 0:38ceb79fef03 204 * Pseudo Code:
kevman 0:38ceb79fef03 205 * @code
kevman 0:38ceb79fef03 206 * uint32_t us_ticker_read()
kevman 0:38ceb79fef03 207 * {
kevman 0:38ceb79fef03 208 * return TIMER_COUNT;
kevman 0:38ceb79fef03 209 * }
kevman 0:38ceb79fef03 210 * @endcode
kevman 0:38ceb79fef03 211 */
kevman 0:38ceb79fef03 212 uint32_t us_ticker_read(void);
kevman 0:38ceb79fef03 213
kevman 0:38ceb79fef03 214 /** Set interrupt for specified timestamp
kevman 0:38ceb79fef03 215 *
kevman 0:38ceb79fef03 216 * @param timestamp The time in ticks to be set
kevman 0:38ceb79fef03 217 *
kevman 0:38ceb79fef03 218 * @note no special handling needs to be done for times in the past
kevman 0:38ceb79fef03 219 * as the common timer code will detect this and call
kevman 0:38ceb79fef03 220 * us_ticker_fire_interrupt() if this is the case
kevman 0:38ceb79fef03 221 *
kevman 0:38ceb79fef03 222 * @note calling this function with timestamp of more than the supported
kevman 0:38ceb79fef03 223 * number of bits returned by ::us_ticker_get_info results in undefined
kevman 0:38ceb79fef03 224 * behavior.
kevman 0:38ceb79fef03 225 *
kevman 0:38ceb79fef03 226 * Pseudo Code:
kevman 0:38ceb79fef03 227 * @code
kevman 0:38ceb79fef03 228 * void us_ticker_set_interrupt(timestamp_t timestamp)
kevman 0:38ceb79fef03 229 * {
kevman 0:38ceb79fef03 230 * TIMER_COMPARE = timestamp;
kevman 0:38ceb79fef03 231 * TIMER_CTRL |= TIMER_CTRL_COMPARE_ENABLE_Msk;
kevman 0:38ceb79fef03 232 * }
kevman 0:38ceb79fef03 233 * @endcode
kevman 0:38ceb79fef03 234 */
kevman 0:38ceb79fef03 235 void us_ticker_set_interrupt(timestamp_t timestamp);
kevman 0:38ceb79fef03 236
kevman 0:38ceb79fef03 237 /** Disable us ticker interrupt
kevman 0:38ceb79fef03 238 *
kevman 0:38ceb79fef03 239 * Pseudo Code:
kevman 0:38ceb79fef03 240 * @code
kevman 0:38ceb79fef03 241 * void us_ticker_disable_interrupt(void)
kevman 0:38ceb79fef03 242 * {
kevman 0:38ceb79fef03 243 * // Disable the compare interrupt
kevman 0:38ceb79fef03 244 * TIMER_CTRL &= ~TIMER_CTRL_COMPARE_ENABLE_Msk;
kevman 0:38ceb79fef03 245 * }
kevman 0:38ceb79fef03 246 * @endcode
kevman 0:38ceb79fef03 247 */
kevman 0:38ceb79fef03 248 void us_ticker_disable_interrupt(void);
kevman 0:38ceb79fef03 249
kevman 0:38ceb79fef03 250 /** Clear us ticker interrupt
kevman 0:38ceb79fef03 251 *
kevman 0:38ceb79fef03 252 * Pseudo Code:
kevman 0:38ceb79fef03 253 * @code
kevman 0:38ceb79fef03 254 * void us_ticker_clear_interrupt(void)
kevman 0:38ceb79fef03 255 * {
kevman 0:38ceb79fef03 256 * // Write to the ICR (interrupt clear register) of the TIMER
kevman 0:38ceb79fef03 257 * TIMER_ICR = TIMER_ICR_COMPARE_Msk;
kevman 0:38ceb79fef03 258 * }
kevman 0:38ceb79fef03 259 * @endcode
kevman 0:38ceb79fef03 260 */
kevman 0:38ceb79fef03 261 void us_ticker_clear_interrupt(void);
kevman 0:38ceb79fef03 262
kevman 0:38ceb79fef03 263 /** Set pending interrupt that should be fired right away.
kevman 0:38ceb79fef03 264 *
kevman 0:38ceb79fef03 265 * The ticker should be initialized prior calling this function.
kevman 0:38ceb79fef03 266 *
kevman 0:38ceb79fef03 267 * Pseudo Code:
kevman 0:38ceb79fef03 268 * @code
kevman 0:38ceb79fef03 269 * void us_ticker_fire_interrupt(void)
kevman 0:38ceb79fef03 270 * {
kevman 0:38ceb79fef03 271 * NVIC_SetPendingIRQ(TIMER_IRQn);
kevman 0:38ceb79fef03 272 * }
kevman 0:38ceb79fef03 273 * @endcode
kevman 0:38ceb79fef03 274 */
kevman 0:38ceb79fef03 275 void us_ticker_fire_interrupt(void);
kevman 0:38ceb79fef03 276
kevman 0:38ceb79fef03 277 /** Get frequency and counter bits of this ticker.
kevman 0:38ceb79fef03 278 *
kevman 0:38ceb79fef03 279 * Pseudo Code:
kevman 0:38ceb79fef03 280 * @code
kevman 0:38ceb79fef03 281 * const ticker_info_t* us_ticker_get_info()
kevman 0:38ceb79fef03 282 * {
kevman 0:38ceb79fef03 283 * static const ticker_info_t info = {
kevman 0:38ceb79fef03 284 * 1000000, // 1 MHz
kevman 0:38ceb79fef03 285 * 32 // 32 bit counter
kevman 0:38ceb79fef03 286 * };
kevman 0:38ceb79fef03 287 * return &info;
kevman 0:38ceb79fef03 288 * }
kevman 0:38ceb79fef03 289 * @endcode
kevman 0:38ceb79fef03 290 */
kevman 0:38ceb79fef03 291 const ticker_info_t *us_ticker_get_info(void);
kevman 0:38ceb79fef03 292
kevman 0:38ceb79fef03 293 /**@}*/
kevman 0:38ceb79fef03 294
kevman 0:38ceb79fef03 295 #ifdef __cplusplus
kevman 0:38ceb79fef03 296 }
kevman 0:38ceb79fef03 297 #endif
kevman 0:38ceb79fef03 298
kevman 0:38ceb79fef03 299 #endif
kevman 0:38ceb79fef03 300
kevman 0:38ceb79fef03 301 /** @}*/