mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/lp_ticker_api.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
187:0387e8f68319 
mbed library release version 165

Who changed what in which revision?

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