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