mbed library sources. Supersedes mbed-src.
Dependents: Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more
targets/TARGET_NUVOTON/TARGET_NANO100/lp_ticker.c@188:bcfe06ba3d64, 2018-11-08 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 08 11:46:34 2018 +0000
- Revision:
- 188:bcfe06ba3d64
- Parent:
- 187:0387e8f68319
mbed-dev library. Release version 164
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 174:b96e65c34a4d | 1 | /* mbed Microcontroller Library |
AnnaBridge | 174:b96e65c34a4d | 2 | * Copyright (c) 2015-2017 Nuvoton |
AnnaBridge | 174:b96e65c34a4d | 3 | * |
AnnaBridge | 174:b96e65c34a4d | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
AnnaBridge | 174:b96e65c34a4d | 5 | * you may not use this file except in compliance with the License. |
AnnaBridge | 174:b96e65c34a4d | 6 | * You may obtain a copy of the License at |
AnnaBridge | 174:b96e65c34a4d | 7 | * |
AnnaBridge | 174:b96e65c34a4d | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
AnnaBridge | 174:b96e65c34a4d | 9 | * |
AnnaBridge | 174:b96e65c34a4d | 10 | * Unless required by applicable law or agreed to in writing, software |
AnnaBridge | 174:b96e65c34a4d | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
AnnaBridge | 174:b96e65c34a4d | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
AnnaBridge | 174:b96e65c34a4d | 13 | * See the License for the specific language governing permissions and |
AnnaBridge | 174:b96e65c34a4d | 14 | * limitations under the License. |
AnnaBridge | 174:b96e65c34a4d | 15 | */ |
AnnaBridge | 182:a56a73fd2a6f | 16 | |
AnnaBridge | 174:b96e65c34a4d | 17 | #include "lp_ticker_api.h" |
AnnaBridge | 174:b96e65c34a4d | 18 | |
Anna Bridge |
186:707f6e361f3e | 19 | #if DEVICE_LPTICKER |
AnnaBridge | 174:b96e65c34a4d | 20 | |
AnnaBridge | 174:b96e65c34a4d | 21 | #include "sleep_api.h" |
AnnaBridge | 182:a56a73fd2a6f | 22 | #include "mbed_assert.h" |
AnnaBridge | 174:b96e65c34a4d | 23 | #include "nu_modutil.h" |
AnnaBridge | 188:bcfe06ba3d64 | 24 | #include "nu_timer.h" |
AnnaBridge | 174:b96e65c34a4d | 25 | #include "nu_miscutil.h" |
AnnaBridge | 174:b96e65c34a4d | 26 | |
AnnaBridge | 182:a56a73fd2a6f | 27 | /* Micro seconds per second */ |
AnnaBridge | 182:a56a73fd2a6f | 28 | #define NU_US_PER_SEC 1000000 |
AnnaBridge | 182:a56a73fd2a6f | 29 | /* Timer clock per lp_ticker tick */ |
AnnaBridge | 182:a56a73fd2a6f | 30 | #define NU_TMRCLK_PER_TICK 1 |
AnnaBridge | 182:a56a73fd2a6f | 31 | /* Timer clock per second */ |
AnnaBridge | 182:a56a73fd2a6f | 32 | #define NU_TMRCLK_PER_SEC (__LXT) |
AnnaBridge | 182:a56a73fd2a6f | 33 | /* Timer max counter bit size */ |
AnnaBridge | 182:a56a73fd2a6f | 34 | #define NU_TMR_MAXCNT_BITSIZE 24 |
AnnaBridge | 182:a56a73fd2a6f | 35 | /* Timer max counter */ |
AnnaBridge | 182:a56a73fd2a6f | 36 | #define NU_TMR_MAXCNT ((1 << NU_TMR_MAXCNT_BITSIZE) - 1) |
AnnaBridge | 174:b96e65c34a4d | 37 | |
AnnaBridge | 182:a56a73fd2a6f | 38 | /* NOTE: Don't add static modifier here. These IRQ handler symbols are for linking. |
AnnaBridge | 182:a56a73fd2a6f | 39 | Vector table relocation is not actually supported for low-resource target. */ |
AnnaBridge | 182:a56a73fd2a6f | 40 | void TMR1_IRQHandler(void); |
AnnaBridge | 174:b96e65c34a4d | 41 | |
AnnaBridge | 182:a56a73fd2a6f | 42 | /* NOTE: To wake the system from power down mode, timer clock source must be ether LXT or LIRC. */ |
AnnaBridge | 182:a56a73fd2a6f | 43 | static const struct nu_modinit_s timer1_modinit = {TIMER_1, TMR1_MODULE, CLK_CLKSEL1_TMR1_S_LXT, 0, TMR1_RST, TMR1_IRQn, (void *) TMR1_IRQHandler}; |
AnnaBridge | 182:a56a73fd2a6f | 44 | |
AnnaBridge | 182:a56a73fd2a6f | 45 | #define TIMER_MODINIT timer1_modinit |
AnnaBridge | 182:a56a73fd2a6f | 46 | |
AnnaBridge | 187:0387e8f68319 | 47 | /* Timer interrupt enable/disable |
AnnaBridge | 187:0387e8f68319 | 48 | * |
AnnaBridge | 187:0387e8f68319 | 49 | * Because Timer interrupt enable/disable (TIMER_EnableInt/TIMER_DisableInt) needs wait for lp_ticker, |
AnnaBridge | 187:0387e8f68319 | 50 | * we call NVIC_DisableIRQ/NVIC_EnableIRQ instead. |
AnnaBridge | 187:0387e8f68319 | 51 | */ |
AnnaBridge | 187:0387e8f68319 | 52 | |
AnnaBridge | 187:0387e8f68319 | 53 | /* Track ticker status */ |
AnnaBridge | 187:0387e8f68319 | 54 | static volatile uint16_t ticker_inited = 0; |
AnnaBridge | 174:b96e65c34a4d | 55 | |
AnnaBridge | 174:b96e65c34a4d | 56 | #define TMR_CMP_MIN 2 |
AnnaBridge | 174:b96e65c34a4d | 57 | #define TMR_CMP_MAX 0xFFFFFFu |
AnnaBridge | 174:b96e65c34a4d | 58 | |
AnnaBridge | 187:0387e8f68319 | 59 | /* Synchronization issue with LXT/LIRC-clocked Timer |
AnnaBridge | 187:0387e8f68319 | 60 | * |
AnnaBridge | 187:0387e8f68319 | 61 | * PCLK : typical HCLK/2 |
AnnaBridge | 187:0387e8f68319 | 62 | * ECLK (engine clock) : LXT/LIRC for Timer used to implement lp_ticker |
AnnaBridge | 187:0387e8f68319 | 63 | * |
AnnaBridge | 187:0387e8f68319 | 64 | * When system clock is higher than Timer clock (LXT/LIRC), we need to add delay for ECLK |
AnnaBridge | 187:0387e8f68319 | 65 | * domain to take effect: |
AnnaBridge | 187:0387e8f68319 | 66 | * 1. Write : typical 1PCLK + 2ECLK |
AnnaBridge | 187:0387e8f68319 | 67 | * Read-check doesn't work because it just checks PCLK domain and doesn't check into |
AnnaBridge | 187:0387e8f68319 | 68 | * ECLK domain. |
AnnaBridge | 187:0387e8f68319 | 69 | * 2. Clear interrupt flag : typical 2PCLK |
AnnaBridge | 187:0387e8f68319 | 70 | * It is very rare that we would meet dummy interrupt and get stuck in ISR until |
AnnaBridge | 187:0387e8f68319 | 71 | * 'clear interrupt flag' takes effect. The issue is ignorable because the pending |
AnnaBridge | 187:0387e8f68319 | 72 | * time is very short (at most 1 dummy interrupt). We won't take special handling for it. |
AnnaBridge | 187:0387e8f68319 | 73 | */ |
AnnaBridge | 184:08ed48f1de7f | 74 | |
AnnaBridge | 174:b96e65c34a4d | 75 | void lp_ticker_init(void) |
AnnaBridge | 174:b96e65c34a4d | 76 | { |
AnnaBridge | 182:a56a73fd2a6f | 77 | if (ticker_inited) { |
AnnaBridge | 187:0387e8f68319 | 78 | /* By HAL spec, ticker_init allows the ticker to keep counting and disables the |
AnnaBridge | 187:0387e8f68319 | 79 | * ticker interrupt. */ |
AnnaBridge | 187:0387e8f68319 | 80 | lp_ticker_disable_interrupt(); |
AnnaBridge | 174:b96e65c34a4d | 81 | return; |
AnnaBridge | 174:b96e65c34a4d | 82 | } |
AnnaBridge | 182:a56a73fd2a6f | 83 | ticker_inited = 1; |
AnnaBridge | 174:b96e65c34a4d | 84 | |
AnnaBridge | 174:b96e65c34a4d | 85 | // Reset module |
AnnaBridge | 182:a56a73fd2a6f | 86 | SYS_ResetModule(TIMER_MODINIT.rsetidx); |
AnnaBridge | 182:a56a73fd2a6f | 87 | |
AnnaBridge | 174:b96e65c34a4d | 88 | // Select IP clock source |
AnnaBridge | 182:a56a73fd2a6f | 89 | CLK_SetModuleClock(TIMER_MODINIT.clkidx, TIMER_MODINIT.clksrc, TIMER_MODINIT.clkdiv); |
AnnaBridge | 182:a56a73fd2a6f | 90 | |
AnnaBridge | 174:b96e65c34a4d | 91 | // Enable IP clock |
AnnaBridge | 182:a56a73fd2a6f | 92 | CLK_EnableModuleClock(TIMER_MODINIT.clkidx); |
AnnaBridge | 174:b96e65c34a4d | 93 | |
AnnaBridge | 184:08ed48f1de7f | 94 | TIMER_T *timer_base = (TIMER_T *) NU_MODBASE(TIMER_MODINIT.modname); |
AnnaBridge | 184:08ed48f1de7f | 95 | |
AnnaBridge | 174:b96e65c34a4d | 96 | // Configure clock |
AnnaBridge | 184:08ed48f1de7f | 97 | uint32_t clk_timer = TIMER_GetModuleClock(timer_base); |
AnnaBridge | 182:a56a73fd2a6f | 98 | uint32_t prescale_timer = clk_timer / NU_TMRCLK_PER_SEC - 1; |
AnnaBridge | 182:a56a73fd2a6f | 99 | MBED_ASSERT((prescale_timer != (uint32_t) -1) && prescale_timer <= 127); |
AnnaBridge | 182:a56a73fd2a6f | 100 | MBED_ASSERT((clk_timer % NU_TMRCLK_PER_SEC) == 0); |
AnnaBridge | 182:a56a73fd2a6f | 101 | uint32_t cmp_timer = TMR_CMP_MAX; |
AnnaBridge | 182:a56a73fd2a6f | 102 | MBED_ASSERT(cmp_timer >= TMR_CMP_MIN && cmp_timer <= TMR_CMP_MAX); |
AnnaBridge | 174:b96e65c34a4d | 103 | // Continuous mode |
AnnaBridge | 184:08ed48f1de7f | 104 | timer_base->CTL = TIMER_CONTINUOUS_MODE; |
AnnaBridge | 188:bcfe06ba3d64 | 105 | nu_busy_wait_us((NU_US_PER_SEC / NU_TMRCLK_PER_SEC) * 3); |
AnnaBridge | 184:08ed48f1de7f | 106 | |
AnnaBridge | 184:08ed48f1de7f | 107 | timer_base->PRECNT = prescale_timer; |
AnnaBridge | 188:bcfe06ba3d64 | 108 | nu_busy_wait_us((NU_US_PER_SEC / NU_TMRCLK_PER_SEC) * 3); |
AnnaBridge | 184:08ed48f1de7f | 109 | |
AnnaBridge | 184:08ed48f1de7f | 110 | timer_base->CMPR = cmp_timer; |
AnnaBridge | 188:bcfe06ba3d64 | 111 | nu_busy_wait_us((NU_US_PER_SEC / NU_TMRCLK_PER_SEC) * 3); |
AnnaBridge | 182:a56a73fd2a6f | 112 | |
AnnaBridge | 174:b96e65c34a4d | 113 | // Set vector |
AnnaBridge | 182:a56a73fd2a6f | 114 | NVIC_SetVector(TIMER_MODINIT.irq_n, (uint32_t) TIMER_MODINIT.var); |
AnnaBridge | 182:a56a73fd2a6f | 115 | |
AnnaBridge | 187:0387e8f68319 | 116 | NVIC_DisableIRQ(TIMER_MODINIT.irq_n); |
AnnaBridge | 174:b96e65c34a4d | 117 | |
AnnaBridge | 184:08ed48f1de7f | 118 | TIMER_EnableInt(timer_base); |
AnnaBridge | 188:bcfe06ba3d64 | 119 | nu_busy_wait_us((NU_US_PER_SEC / NU_TMRCLK_PER_SEC) * 3); |
AnnaBridge | 184:08ed48f1de7f | 120 | |
AnnaBridge | 184:08ed48f1de7f | 121 | TIMER_EnableWakeup(timer_base); |
AnnaBridge | 188:bcfe06ba3d64 | 122 | nu_busy_wait_us((NU_US_PER_SEC / NU_TMRCLK_PER_SEC) * 3); |
AnnaBridge | 184:08ed48f1de7f | 123 | |
AnnaBridge | 184:08ed48f1de7f | 124 | TIMER_Start(timer_base); |
AnnaBridge | 188:bcfe06ba3d64 | 125 | nu_busy_wait_us((NU_US_PER_SEC / NU_TMRCLK_PER_SEC) * 3); |
AnnaBridge | 184:08ed48f1de7f | 126 | |
AnnaBridge | 184:08ed48f1de7f | 127 | /* Wait for timer to start counting and raise active flag */ |
AnnaBridge | 184:08ed48f1de7f | 128 | while(! (timer_base->CTL & TIMER_CTL_TMR_ACT_Msk)); |
AnnaBridge | 174:b96e65c34a4d | 129 | } |
AnnaBridge | 174:b96e65c34a4d | 130 | |
AnnaBridge | 187:0387e8f68319 | 131 | void lp_ticker_free(void) |
AnnaBridge | 187:0387e8f68319 | 132 | { |
AnnaBridge | 187:0387e8f68319 | 133 | /* Disable interrupt */ |
AnnaBridge | 187:0387e8f68319 | 134 | NVIC_DisableIRQ(TIMER_MODINIT.irq_n); |
AnnaBridge | 187:0387e8f68319 | 135 | |
AnnaBridge | 187:0387e8f68319 | 136 | /* Disable IP clock */ |
AnnaBridge | 187:0387e8f68319 | 137 | CLK_DisableModuleClock(TIMER_MODINIT.clkidx); |
AnnaBridge | 187:0387e8f68319 | 138 | |
AnnaBridge | 187:0387e8f68319 | 139 | ticker_inited = 0; |
AnnaBridge | 187:0387e8f68319 | 140 | } |
AnnaBridge | 187:0387e8f68319 | 141 | |
AnnaBridge | 174:b96e65c34a4d | 142 | timestamp_t lp_ticker_read() |
AnnaBridge | 182:a56a73fd2a6f | 143 | { |
AnnaBridge | 182:a56a73fd2a6f | 144 | if (! ticker_inited) { |
AnnaBridge | 174:b96e65c34a4d | 145 | lp_ticker_init(); |
AnnaBridge | 174:b96e65c34a4d | 146 | } |
AnnaBridge | 174:b96e65c34a4d | 147 | |
AnnaBridge | 184:08ed48f1de7f | 148 | TIMER_T *timer_base = (TIMER_T *) NU_MODBASE(TIMER_MODINIT.modname); |
AnnaBridge | 182:a56a73fd2a6f | 149 | |
AnnaBridge | 182:a56a73fd2a6f | 150 | return (TIMER_GetCounter(timer_base) / NU_TMRCLK_PER_TICK); |
AnnaBridge | 174:b96e65c34a4d | 151 | } |
AnnaBridge | 174:b96e65c34a4d | 152 | |
AnnaBridge | 174:b96e65c34a4d | 153 | void lp_ticker_set_interrupt(timestamp_t timestamp) |
AnnaBridge | 174:b96e65c34a4d | 154 | { |
AnnaBridge | 188:bcfe06ba3d64 | 155 | /* Clear any previously pending interrupts */ |
AnnaBridge | 188:bcfe06ba3d64 | 156 | lp_ticker_clear_interrupt(); |
AnnaBridge | 188:bcfe06ba3d64 | 157 | NVIC_ClearPendingIRQ(TIMER_MODINIT.irq_n); |
AnnaBridge | 188:bcfe06ba3d64 | 158 | |
AnnaBridge | 182:a56a73fd2a6f | 159 | /* In continuous mode, counter will be reset to zero with the following sequence: |
AnnaBridge | 182:a56a73fd2a6f | 160 | * 1. Stop counting |
AnnaBridge | 182:a56a73fd2a6f | 161 | * 2. Configure new CMP value |
AnnaBridge | 182:a56a73fd2a6f | 162 | * 3. Restart counting |
AnnaBridge | 182:a56a73fd2a6f | 163 | * |
AnnaBridge | 182:a56a73fd2a6f | 164 | * This behavior is not what we want. To fix it, we could configure new CMP value |
AnnaBridge | 182:a56a73fd2a6f | 165 | * without stopping counting first. |
AnnaBridge | 182:a56a73fd2a6f | 166 | */ |
AnnaBridge | 184:08ed48f1de7f | 167 | TIMER_T *timer_base = (TIMER_T *) NU_MODBASE(TIMER_MODINIT.modname); |
AnnaBridge | 174:b96e65c34a4d | 168 | |
AnnaBridge | 182:a56a73fd2a6f | 169 | /* NOTE: Because H/W timer requests min compare value, our implementation would have alarm delay of |
AnnaBridge | 182:a56a73fd2a6f | 170 | * (TMR_CMP_MIN - interval_clk) clocks when interval_clk is between [1, TMR_CMP_MIN). */ |
AnnaBridge | 182:a56a73fd2a6f | 171 | uint32_t cmp_timer = timestamp * NU_TMRCLK_PER_TICK; |
AnnaBridge | 182:a56a73fd2a6f | 172 | cmp_timer = NU_CLAMP(cmp_timer, TMR_CMP_MIN, TMR_CMP_MAX); |
AnnaBridge | 184:08ed48f1de7f | 173 | |
AnnaBridge | 187:0387e8f68319 | 174 | /* NOTE: Rely on LPTICKER_DELAY_TICKS to be non-blocking. */ |
AnnaBridge | 182:a56a73fd2a6f | 175 | timer_base->CMPR = cmp_timer; |
AnnaBridge | 187:0387e8f68319 | 176 | |
AnnaBridge | 187:0387e8f68319 | 177 | /* We can call ticker_irq_handler now. */ |
AnnaBridge | 187:0387e8f68319 | 178 | NVIC_EnableIRQ(TIMER_MODINIT.irq_n); |
AnnaBridge | 174:b96e65c34a4d | 179 | } |
AnnaBridge | 174:b96e65c34a4d | 180 | |
AnnaBridge | 174:b96e65c34a4d | 181 | void lp_ticker_disable_interrupt(void) |
AnnaBridge | 174:b96e65c34a4d | 182 | { |
AnnaBridge | 187:0387e8f68319 | 183 | /* We cannot call ticker_irq_handler now. */ |
AnnaBridge | 187:0387e8f68319 | 184 | NVIC_DisableIRQ(TIMER_MODINIT.irq_n); |
AnnaBridge | 174:b96e65c34a4d | 185 | } |
AnnaBridge | 174:b96e65c34a4d | 186 | |
AnnaBridge | 174:b96e65c34a4d | 187 | void lp_ticker_clear_interrupt(void) |
AnnaBridge | 174:b96e65c34a4d | 188 | { |
AnnaBridge | 187:0387e8f68319 | 189 | /* To avoid sync issue, we clear TIF/TWKF simultaneously rather than call separate |
AnnaBridge | 187:0387e8f68319 | 190 | * driver API: |
AnnaBridge | 187:0387e8f68319 | 191 | * |
AnnaBridge | 187:0387e8f68319 | 192 | * TIMER_ClearIntFlag((TIMER_T *) NU_MODBASE(TIMER_MODINIT.modname)); |
AnnaBridge | 187:0387e8f68319 | 193 | * TIMER_ClearWakeupFlag((TIMER_T *) NU_MODBASE(TIMER_MODINIT.modname)); |
AnnaBridge | 187:0387e8f68319 | 194 | */ |
AnnaBridge | 187:0387e8f68319 | 195 | TIMER_T *timer_base = (TIMER_T *) NU_MODBASE(TIMER_MODINIT.modname); |
AnnaBridge | 187:0387e8f68319 | 196 | timer_base->ISR = TIMER_ISR_TMR_IS_Msk | TIMER_ISR_TMR_WAKE_STS_Msk; |
AnnaBridge | 174:b96e65c34a4d | 197 | } |
AnnaBridge | 174:b96e65c34a4d | 198 | |
AnnaBridge | 182:a56a73fd2a6f | 199 | void lp_ticker_fire_interrupt(void) |
AnnaBridge | 174:b96e65c34a4d | 200 | { |
AnnaBridge | 182:a56a73fd2a6f | 201 | // NOTE: This event was in the past. Set the interrupt as pending, but don't process it here. |
AnnaBridge | 182:a56a73fd2a6f | 202 | // This prevents a recursive loop under heavy load which can lead to a stack overflow. |
AnnaBridge | 182:a56a73fd2a6f | 203 | NVIC_SetPendingIRQ(TIMER_MODINIT.irq_n); |
AnnaBridge | 187:0387e8f68319 | 204 | |
AnnaBridge | 187:0387e8f68319 | 205 | /* We can call ticker_irq_handler now. */ |
AnnaBridge | 187:0387e8f68319 | 206 | NVIC_EnableIRQ(TIMER_MODINIT.irq_n); |
AnnaBridge | 174:b96e65c34a4d | 207 | } |
AnnaBridge | 174:b96e65c34a4d | 208 | |
AnnaBridge | 182:a56a73fd2a6f | 209 | const ticker_info_t* lp_ticker_get_info() |
AnnaBridge | 174:b96e65c34a4d | 210 | { |
AnnaBridge | 182:a56a73fd2a6f | 211 | static const ticker_info_t info = { |
AnnaBridge | 182:a56a73fd2a6f | 212 | NU_TMRCLK_PER_SEC / NU_TMRCLK_PER_TICK, |
AnnaBridge | 182:a56a73fd2a6f | 213 | NU_TMR_MAXCNT_BITSIZE |
AnnaBridge | 182:a56a73fd2a6f | 214 | }; |
AnnaBridge | 182:a56a73fd2a6f | 215 | return &info; |
AnnaBridge | 182:a56a73fd2a6f | 216 | } |
AnnaBridge | 182:a56a73fd2a6f | 217 | |
AnnaBridge | 182:a56a73fd2a6f | 218 | void TMR1_IRQHandler(void) |
AnnaBridge | 182:a56a73fd2a6f | 219 | { |
AnnaBridge | 187:0387e8f68319 | 220 | lp_ticker_clear_interrupt(); |
AnnaBridge | 184:08ed48f1de7f | 221 | |
AnnaBridge | 182:a56a73fd2a6f | 222 | // NOTE: lp_ticker_set_interrupt() may get called in lp_ticker_irq_handler(); |
AnnaBridge | 182:a56a73fd2a6f | 223 | lp_ticker_irq_handler(); |
AnnaBridge | 174:b96e65c34a4d | 224 | } |
AnnaBridge | 182:a56a73fd2a6f | 225 | |
AnnaBridge | 174:b96e65c34a4d | 226 | #endif |