Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

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