Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/hal/us_ticker_api.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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