Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

hal/lp_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?

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