Kev Mann / mbed-dev-OS5_10_4

RTC auf true

hal/lp_ticker_api.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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