mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

targets/TARGET_NUVOTON/TARGET_M2351/us_ticker.c@187:0387e8f68319, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:40:20 2018 +0100
Revision:
187:0387e8f68319
Child:
188:bcfe06ba3d64
mbed-dev library. Release version 163

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 187:0387e8f68319 1 /* mbed Microcontroller Library
AnnaBridge 187:0387e8f68319 2 * Copyright (c) 2017-2018 Nuvoton
AnnaBridge 187:0387e8f68319 3 *
AnnaBridge 187:0387e8f68319 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 187:0387e8f68319 5 * you may not use this file except in compliance with the License.
AnnaBridge 187:0387e8f68319 6 * You may obtain a copy of the License at
AnnaBridge 187:0387e8f68319 7 *
AnnaBridge 187:0387e8f68319 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 187:0387e8f68319 9 *
AnnaBridge 187:0387e8f68319 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 187:0387e8f68319 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 187:0387e8f68319 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 187:0387e8f68319 13 * See the License for the specific language governing permissions and
AnnaBridge 187:0387e8f68319 14 * limitations under the License.
AnnaBridge 187:0387e8f68319 15 */
AnnaBridge 187:0387e8f68319 16
AnnaBridge 187:0387e8f68319 17 #include "us_ticker_api.h"
AnnaBridge 187:0387e8f68319 18
AnnaBridge 187:0387e8f68319 19 #if DEVICE_USTICKER
AnnaBridge 187:0387e8f68319 20
AnnaBridge 187:0387e8f68319 21 #include "sleep_api.h"
AnnaBridge 187:0387e8f68319 22 #include "mbed_assert.h"
AnnaBridge 187:0387e8f68319 23 #include "nu_modutil.h"
AnnaBridge 187:0387e8f68319 24 #include "nu_miscutil.h"
AnnaBridge 187:0387e8f68319 25 #include "partition_M2351.h"
AnnaBridge 187:0387e8f68319 26
AnnaBridge 187:0387e8f68319 27 /* We have the following policy for configuring security state of TIMER for us_ticer/lp_ticker:
AnnaBridge 187:0387e8f68319 28 *
AnnaBridge 187:0387e8f68319 29 * TIMER0: Hard-wired to secure and used for secure us_ticer
AnnaBridge 187:0387e8f68319 30 * TIMER1: Hard-wired to secure and used for secure lp_ticer
AnnaBridge 187:0387e8f68319 31 * TIMER2: Configured to non-secure and used for non-secure us_ticer
AnnaBridge 187:0387e8f68319 32 * TIMER3: Configured to non-secure and used for non-secure lp_ticer
AnnaBridge 187:0387e8f68319 33 */
AnnaBridge 187:0387e8f68319 34 #if (! defined(SCU_INIT_PNSSET2_VAL)) || (! (SCU_INIT_PNSSET2_VAL & (1 << 17)))
AnnaBridge 187:0387e8f68319 35 #error("TIMER2/3 must be configured to non-secure for non-secure us_ticker/lp_ticker.")
AnnaBridge 187:0387e8f68319 36 #endif
AnnaBridge 187:0387e8f68319 37
AnnaBridge 187:0387e8f68319 38 /* Micro seconds per second */
AnnaBridge 187:0387e8f68319 39 #define NU_US_PER_SEC 1000000
AnnaBridge 187:0387e8f68319 40 /* Timer clock per us_ticker tick */
AnnaBridge 187:0387e8f68319 41 #define NU_TMRCLK_PER_TICK 1
AnnaBridge 187:0387e8f68319 42 /* Timer clock per second */
AnnaBridge 187:0387e8f68319 43 #define NU_TMRCLK_PER_SEC (1000 * 1000)
AnnaBridge 187:0387e8f68319 44 /* Timer max counter bit size */
AnnaBridge 187:0387e8f68319 45 #define NU_TMR_MAXCNT_BITSIZE 24
AnnaBridge 187:0387e8f68319 46 /* Timer max counter */
AnnaBridge 187:0387e8f68319 47 #define NU_TMR_MAXCNT ((1 << NU_TMR_MAXCNT_BITSIZE) - 1)
AnnaBridge 187:0387e8f68319 48
AnnaBridge 187:0387e8f68319 49 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U)
AnnaBridge 187:0387e8f68319 50
AnnaBridge 187:0387e8f68319 51 static void tmr0_vec(void);
AnnaBridge 187:0387e8f68319 52
AnnaBridge 187:0387e8f68319 53 static const struct nu_modinit_s timer0_modinit = {TIMER_0, TMR0_MODULE, CLK_CLKSEL1_TMR0SEL_PCLK0, 0, TMR0_RST, TMR0_IRQn, (void *) tmr0_vec};
AnnaBridge 187:0387e8f68319 54
AnnaBridge 187:0387e8f68319 55 #define TIMER_MODINIT timer0_modinit
AnnaBridge 187:0387e8f68319 56
AnnaBridge 187:0387e8f68319 57 #else
AnnaBridge 187:0387e8f68319 58
AnnaBridge 187:0387e8f68319 59 static void tmr2_vec(void);
AnnaBridge 187:0387e8f68319 60
AnnaBridge 187:0387e8f68319 61 static const struct nu_modinit_s timer2_modinit = {TIMER_2, TMR2_MODULE, CLK_CLKSEL1_TMR2SEL_PCLK1, 0, TMR2_RST, TMR2_IRQn, (void *) tmr2_vec};
AnnaBridge 187:0387e8f68319 62
AnnaBridge 187:0387e8f68319 63 #define TIMER_MODINIT timer2_modinit
AnnaBridge 187:0387e8f68319 64
AnnaBridge 187:0387e8f68319 65 #endif
AnnaBridge 187:0387e8f68319 66 /* Track ticker status */
AnnaBridge 187:0387e8f68319 67 static volatile uint16_t ticker_inited = 0;
AnnaBridge 187:0387e8f68319 68
AnnaBridge 187:0387e8f68319 69 #define TMR_CMP_MIN 2
AnnaBridge 187:0387e8f68319 70 #define TMR_CMP_MAX 0xFFFFFFu
AnnaBridge 187:0387e8f68319 71
AnnaBridge 187:0387e8f68319 72 void us_ticker_init(void)
AnnaBridge 187:0387e8f68319 73 {
AnnaBridge 187:0387e8f68319 74 if (ticker_inited) {
AnnaBridge 187:0387e8f68319 75 /* By HAL spec, ticker_init allows the ticker to keep counting and disables the
AnnaBridge 187:0387e8f68319 76 * ticker interrupt. */
AnnaBridge 187:0387e8f68319 77 us_ticker_disable_interrupt();
AnnaBridge 187:0387e8f68319 78 us_ticker_clear_interrupt();
AnnaBridge 187:0387e8f68319 79 NVIC_ClearPendingIRQ(TIMER_MODINIT.irq_n);
AnnaBridge 187:0387e8f68319 80 return;
AnnaBridge 187:0387e8f68319 81 }
AnnaBridge 187:0387e8f68319 82 ticker_inited = 1;
AnnaBridge 187:0387e8f68319 83
AnnaBridge 187:0387e8f68319 84 /* Reset module
AnnaBridge 187:0387e8f68319 85 *
AnnaBridge 187:0387e8f68319 86 * NOTE: We must call secure version (from non-secure domain) because SYS/CLK regions are secure.
AnnaBridge 187:0387e8f68319 87 */
AnnaBridge 187:0387e8f68319 88 SYS_ResetModule_S(TIMER_MODINIT.rsetidx);
AnnaBridge 187:0387e8f68319 89
AnnaBridge 187:0387e8f68319 90 /* Select IP clock source
AnnaBridge 187:0387e8f68319 91 *
AnnaBridge 187:0387e8f68319 92 * NOTE: We must call secure version (from non-secure domain) because SYS/CLK regions are secure.
AnnaBridge 187:0387e8f68319 93 */
AnnaBridge 187:0387e8f68319 94 CLK_SetModuleClock_S(TIMER_MODINIT.clkidx, TIMER_MODINIT.clksrc, TIMER_MODINIT.clkdiv);
AnnaBridge 187:0387e8f68319 95
AnnaBridge 187:0387e8f68319 96 /* Enable IP clock
AnnaBridge 187:0387e8f68319 97 *
AnnaBridge 187:0387e8f68319 98 * NOTE: We must call secure version (from non-secure domain) because SYS/CLK regions are secure.
AnnaBridge 187:0387e8f68319 99 */
AnnaBridge 187:0387e8f68319 100 CLK_EnableModuleClock_S(TIMER_MODINIT.clkidx);
AnnaBridge 187:0387e8f68319 101
AnnaBridge 187:0387e8f68319 102 TIMER_T *timer_base = (TIMER_T *) NU_MODBASE(TIMER_MODINIT.modname);
AnnaBridge 187:0387e8f68319 103
AnnaBridge 187:0387e8f68319 104 // Timer for normal counter
AnnaBridge 187:0387e8f68319 105 uint32_t clk_timer = TIMER_GetModuleClock(timer_base);
AnnaBridge 187:0387e8f68319 106 uint32_t prescale_timer = clk_timer / NU_TMRCLK_PER_SEC - 1;
AnnaBridge 187:0387e8f68319 107 MBED_ASSERT((prescale_timer != (uint32_t) -1) && prescale_timer <= 127);
AnnaBridge 187:0387e8f68319 108 MBED_ASSERT((clk_timer % NU_TMRCLK_PER_SEC) == 0);
AnnaBridge 187:0387e8f68319 109 uint32_t cmp_timer = TMR_CMP_MAX;
AnnaBridge 187:0387e8f68319 110 MBED_ASSERT(cmp_timer >= TMR_CMP_MIN && cmp_timer <= TMR_CMP_MAX);
AnnaBridge 187:0387e8f68319 111 // NOTE: TIMER_CTL_CNTDATEN_Msk exists in NUC472, but not in M451/M480/M2351. In M451/M480/M2351, TIMER_CNT is updated continuously by default.
AnnaBridge 187:0387e8f68319 112 timer_base->CTL = TIMER_CONTINUOUS_MODE | prescale_timer/* | TIMER_CTL_CNTDATEN_Msk*/;
AnnaBridge 187:0387e8f68319 113 timer_base->CMP = cmp_timer;
AnnaBridge 187:0387e8f68319 114
AnnaBridge 187:0387e8f68319 115 NVIC_SetVector(TIMER_MODINIT.irq_n, (uint32_t) TIMER_MODINIT.var);
AnnaBridge 187:0387e8f68319 116
AnnaBridge 187:0387e8f68319 117 NVIC_DisableIRQ(TIMER_MODINIT.irq_n);
AnnaBridge 187:0387e8f68319 118
AnnaBridge 187:0387e8f68319 119 TIMER_EnableInt(timer_base);
AnnaBridge 187:0387e8f68319 120
AnnaBridge 187:0387e8f68319 121 TIMER_Start(timer_base);
AnnaBridge 187:0387e8f68319 122 /* Wait for timer to start counting and raise active flag */
AnnaBridge 187:0387e8f68319 123 while(! (timer_base->CTL & TIMER_CTL_ACTSTS_Msk));
AnnaBridge 187:0387e8f68319 124 }
AnnaBridge 187:0387e8f68319 125
AnnaBridge 187:0387e8f68319 126 void us_ticker_free(void)
AnnaBridge 187:0387e8f68319 127 {
AnnaBridge 187:0387e8f68319 128 TIMER_T *timer_base = (TIMER_T *) NU_MODBASE(TIMER_MODINIT.modname);
AnnaBridge 187:0387e8f68319 129
AnnaBridge 187:0387e8f68319 130 /* Stop counting */
AnnaBridge 187:0387e8f68319 131 TIMER_Stop(timer_base);
AnnaBridge 187:0387e8f68319 132
AnnaBridge 187:0387e8f68319 133 /* Wait for timer to stop counting and unset active flag */
AnnaBridge 187:0387e8f68319 134 while((timer_base->CTL & TIMER_CTL_ACTSTS_Msk));
AnnaBridge 187:0387e8f68319 135
AnnaBridge 187:0387e8f68319 136 /* Disable interrupt */
AnnaBridge 187:0387e8f68319 137 TIMER_DisableInt(timer_base);
AnnaBridge 187:0387e8f68319 138 NVIC_DisableIRQ(TIMER_MODINIT.irq_n);
AnnaBridge 187:0387e8f68319 139
AnnaBridge 187:0387e8f68319 140 /* Disable IP clock
AnnaBridge 187:0387e8f68319 141 *
AnnaBridge 187:0387e8f68319 142 * NOTE: We must call secure version (from non-secure domain) because SYS/CLK regions are secure.
AnnaBridge 187:0387e8f68319 143 */
AnnaBridge 187:0387e8f68319 144 CLK_DisableModuleClock_S(TIMER_MODINIT.clkidx);
AnnaBridge 187:0387e8f68319 145
AnnaBridge 187:0387e8f68319 146 ticker_inited = 0;
AnnaBridge 187:0387e8f68319 147 }
AnnaBridge 187:0387e8f68319 148
AnnaBridge 187:0387e8f68319 149 uint32_t us_ticker_read()
AnnaBridge 187:0387e8f68319 150 {
AnnaBridge 187:0387e8f68319 151 if (! ticker_inited) {
AnnaBridge 187:0387e8f68319 152 us_ticker_init();
AnnaBridge 187:0387e8f68319 153 }
AnnaBridge 187:0387e8f68319 154
AnnaBridge 187:0387e8f68319 155 TIMER_T *timer_base = (TIMER_T *) NU_MODBASE(TIMER_MODINIT.modname);
AnnaBridge 187:0387e8f68319 156
AnnaBridge 187:0387e8f68319 157 return (TIMER_GetCounter(timer_base) / NU_TMRCLK_PER_TICK);
AnnaBridge 187:0387e8f68319 158 }
AnnaBridge 187:0387e8f68319 159
AnnaBridge 187:0387e8f68319 160 void us_ticker_set_interrupt(timestamp_t timestamp)
AnnaBridge 187:0387e8f68319 161 {
AnnaBridge 187:0387e8f68319 162 /* In continuous mode, counter will be reset to zero with the following sequence:
AnnaBridge 187:0387e8f68319 163 * 1. Stop counting
AnnaBridge 187:0387e8f68319 164 * 2. Configure new CMP value
AnnaBridge 187:0387e8f68319 165 * 3. Restart counting
AnnaBridge 187:0387e8f68319 166 *
AnnaBridge 187:0387e8f68319 167 * This behavior is not what we want. To fix it, we could configure new CMP value
AnnaBridge 187:0387e8f68319 168 * without stopping counting first.
AnnaBridge 187:0387e8f68319 169 */
AnnaBridge 187:0387e8f68319 170 TIMER_T *timer_base = (TIMER_T *) NU_MODBASE(TIMER_MODINIT.modname);
AnnaBridge 187:0387e8f68319 171
AnnaBridge 187:0387e8f68319 172 /* NOTE: Because H/W timer requests min compare value, our implementation would have alarm delay of
AnnaBridge 187:0387e8f68319 173 * (TMR_CMP_MIN - interval_clk) clocks when interval_clk is between [1, TMR_CMP_MIN). */
AnnaBridge 187:0387e8f68319 174 uint32_t cmp_timer = timestamp * NU_TMRCLK_PER_TICK;
AnnaBridge 187:0387e8f68319 175 cmp_timer = NU_CLAMP(cmp_timer, TMR_CMP_MIN, TMR_CMP_MAX);
AnnaBridge 187:0387e8f68319 176 timer_base->CMP = cmp_timer;
AnnaBridge 187:0387e8f68319 177
AnnaBridge 187:0387e8f68319 178 /* We can call ticker_irq_handler now. */
AnnaBridge 187:0387e8f68319 179 NVIC_EnableIRQ(TIMER_MODINIT.irq_n);
AnnaBridge 187:0387e8f68319 180 }
AnnaBridge 187:0387e8f68319 181
AnnaBridge 187:0387e8f68319 182 void us_ticker_disable_interrupt(void)
AnnaBridge 187:0387e8f68319 183 {
AnnaBridge 187:0387e8f68319 184 /* We cannot call ticker_irq_handler now. */
AnnaBridge 187:0387e8f68319 185 NVIC_DisableIRQ(TIMER_MODINIT.irq_n);
AnnaBridge 187:0387e8f68319 186 }
AnnaBridge 187:0387e8f68319 187
AnnaBridge 187:0387e8f68319 188 void us_ticker_clear_interrupt(void)
AnnaBridge 187:0387e8f68319 189 {
AnnaBridge 187:0387e8f68319 190 TIMER_ClearIntFlag((TIMER_T *) NU_MODBASE(TIMER_MODINIT.modname));
AnnaBridge 187:0387e8f68319 191 }
AnnaBridge 187:0387e8f68319 192
AnnaBridge 187:0387e8f68319 193 void us_ticker_fire_interrupt(void)
AnnaBridge 187:0387e8f68319 194 {
AnnaBridge 187:0387e8f68319 195 // NOTE: This event was in the past. Set the interrupt as pending, but don't process it here.
AnnaBridge 187:0387e8f68319 196 // This prevents a recursive loop under heavy load which can lead to a stack overflow.
AnnaBridge 187:0387e8f68319 197 NVIC_SetPendingIRQ(TIMER_MODINIT.irq_n);
AnnaBridge 187:0387e8f68319 198
AnnaBridge 187:0387e8f68319 199 /* We can call ticker_irq_handler now. */
AnnaBridge 187:0387e8f68319 200 NVIC_EnableIRQ(TIMER_MODINIT.irq_n);
AnnaBridge 187:0387e8f68319 201 }
AnnaBridge 187:0387e8f68319 202
AnnaBridge 187:0387e8f68319 203 const ticker_info_t* us_ticker_get_info()
AnnaBridge 187:0387e8f68319 204 {
AnnaBridge 187:0387e8f68319 205 static const ticker_info_t info = {
AnnaBridge 187:0387e8f68319 206 NU_TMRCLK_PER_SEC / NU_TMRCLK_PER_TICK,
AnnaBridge 187:0387e8f68319 207 NU_TMR_MAXCNT_BITSIZE
AnnaBridge 187:0387e8f68319 208 };
AnnaBridge 187:0387e8f68319 209 return &info;
AnnaBridge 187:0387e8f68319 210 }
AnnaBridge 187:0387e8f68319 211
AnnaBridge 187:0387e8f68319 212 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U)
AnnaBridge 187:0387e8f68319 213 static void tmr0_vec(void)
AnnaBridge 187:0387e8f68319 214 #else
AnnaBridge 187:0387e8f68319 215 static void tmr2_vec(void)
AnnaBridge 187:0387e8f68319 216 #endif
AnnaBridge 187:0387e8f68319 217 {
AnnaBridge 187:0387e8f68319 218 us_ticker_clear_interrupt();
AnnaBridge 187:0387e8f68319 219
AnnaBridge 187:0387e8f68319 220 // NOTE: us_ticker_set_interrupt() may get called in us_ticker_irq_handler();
AnnaBridge 187:0387e8f68319 221 us_ticker_irq_handler();
AnnaBridge 187:0387e8f68319 222 }
AnnaBridge 187:0387e8f68319 223
AnnaBridge 187:0387e8f68319 224 #endif