Knight KE / Mbed OS Game_Master

游戏王对战板，目前code还是空的

mbed-os/hal/lp_ticker_api.h@0:9b3d4731edbb, 2018-06-21 (annotated)

Committer:
WFKnight
Date:
Thu Jun 21 13:51:43 2018 +0000
Revision:
0:9b3d4731edbb
UART, RTOS, LED

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WFKnight 0:9b3d4731edbb 1
WFKnight 0:9b3d4731edbb 2 /** \addtogroup hal */
WFKnight 0:9b3d4731edbb 3 /** @{*/
WFKnight 0:9b3d4731edbb 4 /* mbed Microcontroller Library
WFKnight 0:9b3d4731edbb 5 * Copyright (c) 2015 ARM Limited
WFKnight 0:9b3d4731edbb 6 *
WFKnight 0:9b3d4731edbb 7 * Licensed under the Apache License, Version 2.0 (the "License");
WFKnight 0:9b3d4731edbb 8 * you may not use this file except in compliance with the License.
WFKnight 0:9b3d4731edbb 9 * You may obtain a copy of the License at
WFKnight 0:9b3d4731edbb 10 *
WFKnight 0:9b3d4731edbb 11 * http://www.apache.org/licenses/LICENSE-2.0
WFKnight 0:9b3d4731edbb 12 *
WFKnight 0:9b3d4731edbb 13 * Unless required by applicable law or agreed to in writing, software
WFKnight 0:9b3d4731edbb 14 * distributed under the License is distributed on an "AS IS" BASIS,
WFKnight 0:9b3d4731edbb 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
WFKnight 0:9b3d4731edbb 16 * See the License for the specific language governing permissions and
WFKnight 0:9b3d4731edbb 17 * limitations under the License.
WFKnight 0:9b3d4731edbb 18 */
WFKnight 0:9b3d4731edbb 19 #ifndef MBED_LPTICKER_API_H
WFKnight 0:9b3d4731edbb 20 #define MBED_LPTICKER_API_H
WFKnight 0:9b3d4731edbb 21
WFKnight 0:9b3d4731edbb 22 #include "device.h"
WFKnight 0:9b3d4731edbb 23
WFKnight 0:9b3d4731edbb 24 #if DEVICE_LPTICKER
WFKnight 0:9b3d4731edbb 25
WFKnight 0:9b3d4731edbb 26 #include "hal/ticker_api.h"
WFKnight 0:9b3d4731edbb 27
WFKnight 0:9b3d4731edbb 28 #ifdef __cplusplus
WFKnight 0:9b3d4731edbb 29 extern "C" {
WFKnight 0:9b3d4731edbb 30 #endif
WFKnight 0:9b3d4731edbb 31
WFKnight 0:9b3d4731edbb 32 /**
WFKnight 0:9b3d4731edbb 33 * \defgroup hal_lp_ticker Low Power Ticker
WFKnight 0:9b3d4731edbb 34 * Low level interface to the low power ticker of a target
WFKnight 0:9b3d4731edbb 35 *
WFKnight 0:9b3d4731edbb 36 * # Defined behavior
WFKnight 0:9b3d4731edbb 37 * * Has a reported frequency between 4KHz and 64KHz - verified by ::lp_ticker_info_test
WFKnight 0:9b3d4731edbb 38 * * Has a counter that is at least 12 bits wide - verified by ::lp_ticker_info_test
WFKnight 0:9b3d4731edbb 39 * * Continues operating in deep sleep mode - verified by ::lp_ticker_deepsleep_test
WFKnight 0:9b3d4731edbb 40 * * All behavior defined by the @ref hal_ticker_shared "ticker specification"
WFKnight 0:9b3d4731edbb 41 *
WFKnight 0:9b3d4731edbb 42 * # Undefined behavior
WFKnight 0:9b3d4731edbb 43 * * See the @ref hal_ticker_shared "ticker specification"
WFKnight 0:9b3d4731edbb 44 * * Calling any function other than lp_ticker_init after calling lp_ticker_free
WFKnight 0:9b3d4731edbb 45 *
WFKnight 0:9b3d4731edbb 46 * # Potential bugs
WFKnight 0:9b3d4731edbb 47 * * Glitches due to ripple counter - Verified by ::lp_ticker_glitch_test
WFKnight 0:9b3d4731edbb 48 *
WFKnight 0:9b3d4731edbb 49 * @see hal_lp_ticker_tests
WFKnight 0:9b3d4731edbb 50 *
WFKnight 0:9b3d4731edbb 51 * @{
WFKnight 0:9b3d4731edbb 52 */
WFKnight 0:9b3d4731edbb 53
WFKnight 0:9b3d4731edbb 54 /**
WFKnight 0:9b3d4731edbb 55 * \defgroup hal_lp_ticker_tests Low Power Ticker tests
WFKnight 0:9b3d4731edbb 56 * Tests to validate the proper implementation of the low power ticker
WFKnight 0:9b3d4731edbb 57 *
WFKnight 0:9b3d4731edbb 58 * To run the low power ticker hal tests use the command:
WFKnight 0:9b3d4731edbb 59 *
WFKnight 0:9b3d4731edbb 60 * mbed test -t <toolchain> -m <target> -n tests-mbed_hal-common_ticker*,tests-mbed_hal-lp_ticker*
WFKnight 0:9b3d4731edbb 61 *
WFKnight 0:9b3d4731edbb 62 */
WFKnight 0:9b3d4731edbb 63
WFKnight 0:9b3d4731edbb 64 typedef void (*ticker_irq_handler_type)(const ticker_data_t *const);
WFKnight 0:9b3d4731edbb 65
WFKnight 0:9b3d4731edbb 66 /** Set low power ticker IRQ handler
WFKnight 0:9b3d4731edbb 67 *
WFKnight 0:9b3d4731edbb 68 * @param ticker_irq_handler IRQ handler to be connected
WFKnight 0:9b3d4731edbb 69 *
WFKnight 0:9b3d4731edbb 70 * @return previous ticker IRQ handler
WFKnight 0:9b3d4731edbb 71 *
WFKnight 0:9b3d4731edbb 72 * @note by default IRQ handler is set to ::ticker_irq_handler
WFKnight 0:9b3d4731edbb 73 * @note this function is primarily for testing purposes and it's not required part of HAL implementation
WFKnight 0:9b3d4731edbb 74 *
WFKnight 0:9b3d4731edbb 75 */
WFKnight 0:9b3d4731edbb 76 ticker_irq_handler_type set_lp_ticker_irq_handler(ticker_irq_handler_type ticker_irq_handler);
WFKnight 0:9b3d4731edbb 77
WFKnight 0:9b3d4731edbb 78 /** Get low power ticker's data
WFKnight 0:9b3d4731edbb 79 *
WFKnight 0:9b3d4731edbb 80 * @return The low power ticker data
WFKnight 0:9b3d4731edbb 81 */
WFKnight 0:9b3d4731edbb 82 const ticker_data_t* get_lp_ticker_data(void);
WFKnight 0:9b3d4731edbb 83
WFKnight 0:9b3d4731edbb 84 /** The wrapper for ticker_irq_handler, to pass lp ticker's data
WFKnight 0:9b3d4731edbb 85 *
WFKnight 0:9b3d4731edbb 86 */
WFKnight 0:9b3d4731edbb 87 void lp_ticker_irq_handler(void);
WFKnight 0:9b3d4731edbb 88
WFKnight 0:9b3d4731edbb 89 /* HAL lp ticker */
WFKnight 0:9b3d4731edbb 90
WFKnight 0:9b3d4731edbb 91 /** Initialize the low power ticker
WFKnight 0:9b3d4731edbb 92 *
WFKnight 0:9b3d4731edbb 93 * Initialize or re-initialize the ticker. This resets all the
WFKnight 0:9b3d4731edbb 94 * clocking and prescaler registers, along with disabling
WFKnight 0:9b3d4731edbb 95 * the compare interrupt.
WFKnight 0:9b3d4731edbb 96 *
WFKnight 0:9b3d4731edbb 97 * Pseudo Code:
WFKnight 0:9b3d4731edbb 98 * @code
WFKnight 0:9b3d4731edbb 99 * void lp_ticker_init()
WFKnight 0:9b3d4731edbb 100 * {
WFKnight 0:9b3d4731edbb 101 * // Enable clock gate so processor can read LPTMR registers
WFKnight 0:9b3d4731edbb 102 * POWER_CTRL |= POWER_CTRL_LPTMR_Msk;
WFKnight 0:9b3d4731edbb 103 *
WFKnight 0:9b3d4731edbb 104 * // Disable the timer and ensure it is powered down
WFKnight 0:9b3d4731edbb 105 * LPTMR_CTRL &= ~(LPTMR_CTRL_ENABLE_Msk | LPTMR_CTRL_COMPARE_ENABLE_Msk);
WFKnight 0:9b3d4731edbb 106 *
WFKnight 0:9b3d4731edbb 107 * // Configure divisors - no division necessary
WFKnight 0:9b3d4731edbb 108 * LPTMR_PRESCALE = 0;
WFKnight 0:9b3d4731edbb 109 * LPTMR_CTRL |= LPTMR_CTRL_ENABLE_Msk;
WFKnight 0:9b3d4731edbb 110 *
WFKnight 0:9b3d4731edbb 111 * // Install the interrupt handler
WFKnight 0:9b3d4731edbb 112 * NVIC_SetVector(LPTMR_IRQn, (uint32_t)lp_ticker_irq_handler);
WFKnight 0:9b3d4731edbb 113 * NVIC_EnableIRQ(LPTMR_IRQn);
WFKnight 0:9b3d4731edbb 114 * }
WFKnight 0:9b3d4731edbb 115 * @endcode
WFKnight 0:9b3d4731edbb 116 */
WFKnight 0:9b3d4731edbb 117 void lp_ticker_init(void);
WFKnight 0:9b3d4731edbb 118
WFKnight 0:9b3d4731edbb 119 /** Deinitialize the lower power ticker
WFKnight 0:9b3d4731edbb 120 *
WFKnight 0:9b3d4731edbb 121 * Powerdown the lp ticker in preparation for sleep, powerdown, or reset.
WFKnight 0:9b3d4731edbb 122 *
WFKnight 0:9b3d4731edbb 123 * After calling this function no other ticker functions should be called except
WFKnight 0:9b3d4731edbb 124 * lp_ticker_init(). Calling any function other than init after freeing is
WFKnight 0:9b3d4731edbb 125 * undefined.
WFKnight 0:9b3d4731edbb 126 *
WFKnight 0:9b3d4731edbb 127 * @note This function stops the ticker from counting.
WFKnight 0:9b3d4731edbb 128 */
WFKnight 0:9b3d4731edbb 129 void lp_ticker_free(void);
WFKnight 0:9b3d4731edbb 130
WFKnight 0:9b3d4731edbb 131 /** Read the current tick
WFKnight 0:9b3d4731edbb 132 *
WFKnight 0:9b3d4731edbb 133 * If no rollover has occurred, the seconds passed since lp_ticker_init()
WFKnight 0:9b3d4731edbb 134 * was called can be found by dividing the ticks returned by this function
WFKnight 0:9b3d4731edbb 135 * by the frequency returned by ::lp_ticker_get_info.
WFKnight 0:9b3d4731edbb 136 *
WFKnight 0:9b3d4731edbb 137 * @return The current timer's counter value in ticks
WFKnight 0:9b3d4731edbb 138 *
WFKnight 0:9b3d4731edbb 139 * Pseudo Code:
WFKnight 0:9b3d4731edbb 140 * @code
WFKnight 0:9b3d4731edbb 141 * uint32_t lp_ticker_read()
WFKnight 0:9b3d4731edbb 142 * {
WFKnight 0:9b3d4731edbb 143 * uint16_t count;
WFKnight 0:9b3d4731edbb 144 * uint16_t last_count;
WFKnight 0:9b3d4731edbb 145 *
WFKnight 0:9b3d4731edbb 146 * // Loop until the same tick is read twice since this
WFKnight 0:9b3d4731edbb 147 * // is ripple counter on a different clock domain.
WFKnight 0:9b3d4731edbb 148 * count = LPTMR_COUNT;
WFKnight 0:9b3d4731edbb 149 * do {
WFKnight 0:9b3d4731edbb 150 * last_count = count;
WFKnight 0:9b3d4731edbb 151 * count = LPTMR_COUNT;
WFKnight 0:9b3d4731edbb 152 * } while (last_count != count);
WFKnight 0:9b3d4731edbb 153 *
WFKnight 0:9b3d4731edbb 154 * return count;
WFKnight 0:9b3d4731edbb 155 * }
WFKnight 0:9b3d4731edbb 156 * @endcode
WFKnight 0:9b3d4731edbb 157 */
WFKnight 0:9b3d4731edbb 158 uint32_t lp_ticker_read(void);
WFKnight 0:9b3d4731edbb 159
WFKnight 0:9b3d4731edbb 160 /** Set interrupt for specified timestamp
WFKnight 0:9b3d4731edbb 161 *
WFKnight 0:9b3d4731edbb 162 * @param timestamp The time in ticks to be set
WFKnight 0:9b3d4731edbb 163 *
WFKnight 0:9b3d4731edbb 164 * @note no special handling needs to be done for times in the past
WFKnight 0:9b3d4731edbb 165 * as the common timer code will detect this and call
WFKnight 0:9b3d4731edbb 166 * lp_ticker_fire_interrupt() if this is the case
WFKnight 0:9b3d4731edbb 167 *
WFKnight 0:9b3d4731edbb 168 * @note calling this function with timestamp of more than the supported
WFKnight 0:9b3d4731edbb 169 * number of bits returned by ::lp_ticker_get_info results in undefined
WFKnight 0:9b3d4731edbb 170 * behavior.
WFKnight 0:9b3d4731edbb 171 *
WFKnight 0:9b3d4731edbb 172 * Pseudo Code:
WFKnight 0:9b3d4731edbb 173 * @code
WFKnight 0:9b3d4731edbb 174 * void lp_ticker_set_interrupt(timestamp_t timestamp)
WFKnight 0:9b3d4731edbb 175 * {
WFKnight 0:9b3d4731edbb 176 * LPTMR_COMPARE = timestamp;
WFKnight 0:9b3d4731edbb 177 * LPTMR_CTRL |= LPTMR_CTRL_COMPARE_ENABLE_Msk;
WFKnight 0:9b3d4731edbb 178 * }
WFKnight 0:9b3d4731edbb 179 * @endcode
WFKnight 0:9b3d4731edbb 180 */
WFKnight 0:9b3d4731edbb 181 void lp_ticker_set_interrupt(timestamp_t timestamp);
WFKnight 0:9b3d4731edbb 182
WFKnight 0:9b3d4731edbb 183 /** Disable low power ticker interrupt
WFKnight 0:9b3d4731edbb 184 *
WFKnight 0:9b3d4731edbb 185 * Pseudo Code:
WFKnight 0:9b3d4731edbb 186 * @code
WFKnight 0:9b3d4731edbb 187 * void lp_ticker_disable_interrupt(void)
WFKnight 0:9b3d4731edbb 188 * {
WFKnight 0:9b3d4731edbb 189 * // Disable the compare interrupt
WFKnight 0:9b3d4731edbb 190 * LPTMR_CTRL &= ~LPTMR_CTRL_COMPARE_ENABLE_Msk;
WFKnight 0:9b3d4731edbb 191 * }
WFKnight 0:9b3d4731edbb 192 * @endcode
WFKnight 0:9b3d4731edbb 193 */
WFKnight 0:9b3d4731edbb 194 void lp_ticker_disable_interrupt(void);
WFKnight 0:9b3d4731edbb 195
WFKnight 0:9b3d4731edbb 196 /** Clear the low power ticker interrupt
WFKnight 0:9b3d4731edbb 197 *
WFKnight 0:9b3d4731edbb 198 * Pseudo Code:
WFKnight 0:9b3d4731edbb 199 * @code
WFKnight 0:9b3d4731edbb 200 * void lp_ticker_clear_interrupt(void)
WFKnight 0:9b3d4731edbb 201 * {
WFKnight 0:9b3d4731edbb 202 * // Write to the ICR (interrupt clear register) of the LPTMR
WFKnight 0:9b3d4731edbb 203 * LPTMR_ICR = LPTMR_ICR_COMPARE_Msk;
WFKnight 0:9b3d4731edbb 204 * }
WFKnight 0:9b3d4731edbb 205 * @endcode
WFKnight 0:9b3d4731edbb 206 */
WFKnight 0:9b3d4731edbb 207 void lp_ticker_clear_interrupt(void);
WFKnight 0:9b3d4731edbb 208
WFKnight 0:9b3d4731edbb 209 /** Set pending interrupt that should be fired right away.
WFKnight 0:9b3d4731edbb 210 *
WFKnight 0:9b3d4731edbb 211 * Pseudo Code:
WFKnight 0:9b3d4731edbb 212 * @code
WFKnight 0:9b3d4731edbb 213 * void lp_ticker_fire_interrupt(void)
WFKnight 0:9b3d4731edbb 214 * {
WFKnight 0:9b3d4731edbb 215 * NVIC_SetPendingIRQ(LPTMR_IRQn);
WFKnight 0:9b3d4731edbb 216 * }
WFKnight 0:9b3d4731edbb 217 * @endcode
WFKnight 0:9b3d4731edbb 218 */
WFKnight 0:9b3d4731edbb 219 void lp_ticker_fire_interrupt(void);
WFKnight 0:9b3d4731edbb 220
WFKnight 0:9b3d4731edbb 221 /** Get frequency and counter bits of this ticker.
WFKnight 0:9b3d4731edbb 222 *
WFKnight 0:9b3d4731edbb 223 * Pseudo Code:
WFKnight 0:9b3d4731edbb 224 * @code
WFKnight 0:9b3d4731edbb 225 * const ticker_info_t* lp_ticker_get_info()
WFKnight 0:9b3d4731edbb 226 * {
WFKnight 0:9b3d4731edbb 227 * static const ticker_info_t info = {
WFKnight 0:9b3d4731edbb 228 * 32768, // 32KHz
WFKnight 0:9b3d4731edbb 229 * 16 // 16 bit counter
WFKnight 0:9b3d4731edbb 230 * };
WFKnight 0:9b3d4731edbb 231 * return &info;
WFKnight 0:9b3d4731edbb 232 * }
WFKnight 0:9b3d4731edbb 233 * @endcode
WFKnight 0:9b3d4731edbb 234 */
WFKnight 0:9b3d4731edbb 235 const ticker_info_t* lp_ticker_get_info(void);
WFKnight 0:9b3d4731edbb 236
WFKnight 0:9b3d4731edbb 237 /**@}*/
WFKnight 0:9b3d4731edbb 238
WFKnight 0:9b3d4731edbb 239 #ifdef __cplusplus
WFKnight 0:9b3d4731edbb 240 }
WFKnight 0:9b3d4731edbb 241 #endif
WFKnight 0:9b3d4731edbb 242
WFKnight 0:9b3d4731edbb 243 #endif
WFKnight 0:9b3d4731edbb 244
WFKnight 0:9b3d4731edbb 245 #endif
WFKnight 0:9b3d4731edbb 246
WFKnight 0:9b3d4731edbb 247 /** @}*/