Tomonori Kuroki / MuWatchdog

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of Watchdog by David Smart

Watchdog.cpp@17:ccd155378a9b, 2018-03-15 (annotated)

Committer:
mutech
Date:
Thu Mar 15 10:31:54 2018 +0000
Revision:
17:ccd155378a9b
Parent:
15:e0e4c2268558
Child:
18:edfbf294c9e2
MuWatchdog

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mutech 11:a1611543c454 1 /// @file Watchdog.cpp provides the interface to the Watchdog module
WiredHome 2:2873f068f325 2 ///
WiredHome 2:2873f068f325 3 /// This provides basic Watchdog service for the mbed. You can configure
WiredHome 2:2873f068f325 4 /// various timeout intervals that meet your system needs. Additionally,
WiredHome 2:2873f068f325 5 /// it is possible to identify if the Watchdog was the cause of any
WiredHome 2:2873f068f325 6 /// system restart.
WiredHome 2:2873f068f325 7 ///
WiredHome 2:2873f068f325 8 /// Adapted from Simon's Watchdog code from http://mbed.org/forum/mbed/topic/508/
WiredHome 2:2873f068f325 9 ///
WiredHome 2:2873f068f325 10 /// @note Copyright © 2011 by Smartware Computing, all rights reserved.
WiredHome 2:2873f068f325 11 /// This software may be used to derive new software, as long as
WiredHome 2:2873f068f325 12 /// this copyright statement remains in the source file.
WiredHome 2:2873f068f325 13 /// @author David Smart
WiredHome 2:2873f068f325 14 ///
mutech 7:3814d72b8166 15 /// \li v2.10 - 20160914: Changed TARGET_STM by mutech, t.kuroki
mutech 7:3814d72b8166 16
WiredHome 0:7a316f14da9c 17 #include "Watchdog.h"
WiredHome 0:7a316f14da9c 18
WiredHome 5:2dad2a78ffbd 19 #if defined( TARGET_LPC1768 )
WiredHome 0:7a316f14da9c 20 /// Watchdog gets instantiated at the module level
WiredHome 0:7a316f14da9c 21 Watchdog::Watchdog() {
mutech 15:e0e4c2268558 22 _wdreset = (LPC_WDT->WDMOD >> 2) & 1; // capture the cause of the previous reset
WiredHome 0:7a316f14da9c 23 }
WiredHome 0:7a316f14da9c 24
WiredHome 0:7a316f14da9c 25 /// Load timeout value in watchdog timer and enable
WiredHome 0:7a316f14da9c 26 void Watchdog::Configure(float s) {
WiredHome 0:7a316f14da9c 27 LPC_WDT->WDCLKSEL = 0x1; // Set CLK src to PCLK
WiredHome 0:7a316f14da9c 28 uint32_t clk = SystemCoreClock / 16; // WD has a fixed /4 prescaler, PCLK default is /4
WiredHome 2:2873f068f325 29 LPC_WDT->WDTC = (uint32_t)(s * (float)clk);
WiredHome 0:7a316f14da9c 30 LPC_WDT->WDMOD = 0x3; // Enabled and Reset
WiredHome 0:7a316f14da9c 31 Service();
WiredHome 0:7a316f14da9c 32 }
WiredHome 0:7a316f14da9c 33
mutech 7:3814d72b8166 34 void Watchdog::Configure(int ms) {
mutech 7:3814d72b8166 35 LPC_WDT->WDCLKSEL = 0x1; // Set CLK src to PCLK
mutech 7:3814d72b8166 36 uint32_t clk = SystemCoreClock / 1000; //
mutech 7:3814d72b8166 37 LPC_WDT->WDTC = (ms * clk) / 16; // WD has a fixed /4 prescaler, PCLK default is /4
mutech 7:3814d72b8166 38 LPC_WDT->WDMOD = 0x3; // Enabled and Reset
mutech 7:3814d72b8166 39 Service();
mutech 7:3814d72b8166 40 }
mutech 7:3814d72b8166 41
WiredHome 0:7a316f14da9c 42 /// "Service", "kick" or "feed" the dog - reset the watchdog timer
WiredHome 0:7a316f14da9c 43 /// by writing this required bit pattern
WiredHome 0:7a316f14da9c 44 void Watchdog::Service() {
WiredHome 0:7a316f14da9c 45 LPC_WDT->WDFEED = 0xAA;
WiredHome 0:7a316f14da9c 46 LPC_WDT->WDFEED = 0x55;
WiredHome 0:7a316f14da9c 47 }
WiredHome 0:7a316f14da9c 48
WiredHome 0:7a316f14da9c 49 /// get the flag to indicate if the watchdog causes the reset
WiredHome 0:7a316f14da9c 50 bool Watchdog::WatchdogCausedReset() {
mutech 15:e0e4c2268558 51 return _wdreset;
WiredHome 0:7a316f14da9c 52 }
WiredHome 5:2dad2a78ffbd 53 #elif defined( TARGET_LPC4088 )
WiredHome 5:2dad2a78ffbd 54 // from Gesotec Gesotec
WiredHome 5:2dad2a78ffbd 55 /// Watchdog gets instantiated at the module level
WiredHome 5:2dad2a78ffbd 56 Watchdog::Watchdog() {
mutech 15:e0e4c2268558 57 _wdreset = (LPC_WDT->MOD >> 2) & 1; // capture the cause of the previous reset
WiredHome 5:2dad2a78ffbd 58 }
WiredHome 5:2dad2a78ffbd 59
WiredHome 5:2dad2a78ffbd 60 /// Load timeout value in watchdog timer and enable
WiredHome 5:2dad2a78ffbd 61 void Watchdog::Configure(float s) {
WiredHome 5:2dad2a78ffbd 62 //LPC_WDT->CLKSEL = 0x1; // Set CLK src to PCLK
WiredHome 5:2dad2a78ffbd 63 uint32_t clk = 500000 / 4; // WD has a fixed /4 prescaler, and a 500khz oscillator
WiredHome 5:2dad2a78ffbd 64 LPC_WDT->TC = (uint32_t)(s * (float)clk);
WiredHome 5:2dad2a78ffbd 65 LPC_WDT->MOD = 0x3; // Enabled and Reset
WiredHome 5:2dad2a78ffbd 66 Service();
WiredHome 5:2dad2a78ffbd 67 }
mutech 7:3814d72b8166 68
mutech 7:3814d72b8166 69 void Watchdog::Configure(int ms) {
mutech 7:3814d72b8166 70 //LPC_WDT->CLKSEL = 0x1; // Set CLK src to PCLK
mutech 7:3814d72b8166 71 uint32_t clk = 500000 / 4; // WD has a fixed /4 prescaler, and a 500khz oscillator
mutech 7:3814d72b8166 72 LPC_WDT->TC = (ms * clk) / 1000;
mutech 7:3814d72b8166 73 LPC_WDT->MOD = 0x3; // Enabled and Reset
mutech 7:3814d72b8166 74 Service();
mutech 7:3814d72b8166 75 }
mutech 7:3814d72b8166 76
WiredHome 5:2dad2a78ffbd 77 /// "Service", "kick" or "feed" the dog - reset the watchdog timer
WiredHome 5:2dad2a78ffbd 78 /// by writing this required bit pattern
WiredHome 5:2dad2a78ffbd 79 void Watchdog::Service() {
WiredHome 5:2dad2a78ffbd 80 LPC_WDT->FEED = 0xAA;
WiredHome 5:2dad2a78ffbd 81 LPC_WDT->FEED = 0x55;
WiredHome 5:2dad2a78ffbd 82 }
WiredHome 5:2dad2a78ffbd 83
WiredHome 5:2dad2a78ffbd 84 /// get the flag to indicate if the watchdog causes the reset
WiredHome 5:2dad2a78ffbd 85 bool Watchdog::WatchdogCausedReset() {
mutech 15:e0e4c2268558 86 return _wdreset;
WiredHome 5:2dad2a78ffbd 87 }
mutech 17:ccd155378a9b 88
mutech 17:ccd155378a9b 89 #elif defined(TARGET_LPC81X) || defined(TARGET_LPC82X)
mutech 17:ccd155378a9b 90 // from Gesotec Gesotec
mutech 17:ccd155378a9b 91 /// Watchdog gets instantiated at the module level
mutech 17:ccd155378a9b 92 Watchdog::Watchdog()
mutech 17:ccd155378a9b 93 {
mutech 17:ccd155378a9b 94 _wdreset = (LPC_WWDT->MOD >> 2) & 1; // capture the cause of the previous reset
mutech 17:ccd155378a9b 95 }
mutech 17:ccd155378a9b 96
mutech 17:ccd155378a9b 97 /// Load timeout value in watchdog timer and enable
mutech 17:ccd155378a9b 98 void Watchdog::Configure(float s)
mutech 17:ccd155378a9b 99 {
mutech 17:ccd155378a9b 100 Configure((int)(s * 1000));
mutech 17:ccd155378a9b 101 }
mutech 17:ccd155378a9b 102
mutech 17:ccd155378a9b 103 void Watchdog::Configure(int ms)
mutech 17:ccd155378a9b 104 {
mutech 17:ccd155378a9b 105 uint32_t wdt_osc = 0;
mutech 17:ccd155378a9b 106
mutech 17:ccd155378a9b 107 /* Determine clock frequency according to clock register values */
mutech 17:ccd155378a9b 108 switch ((LPC_SYSCON->WDTOSCCTRL >> 5) & 0x0F)
mutech 17:ccd155378a9b 109 {
mutech 17:ccd155378a9b 110 case 0: wdt_osc = 0; break;
mutech 17:ccd155378a9b 111 case 1: wdt_osc = 500000; break;
mutech 17:ccd155378a9b 112 case 2: wdt_osc = 800000; break;
mutech 17:ccd155378a9b 113 case 3: wdt_osc = 1100000; break;
mutech 17:ccd155378a9b 114 case 4: wdt_osc = 1400000; break;
mutech 17:ccd155378a9b 115 case 5: wdt_osc = 1600000; break;
mutech 17:ccd155378a9b 116 case 6: wdt_osc = 1800000; break;
mutech 17:ccd155378a9b 117 case 7: wdt_osc = 2000000; break;
mutech 17:ccd155378a9b 118 case 8: wdt_osc = 2200000; break;
mutech 17:ccd155378a9b 119 case 9: wdt_osc = 2400000; break;
mutech 17:ccd155378a9b 120 case 10: wdt_osc = 2600000; break;
mutech 17:ccd155378a9b 121 case 11: wdt_osc = 2700000; break;
mutech 17:ccd155378a9b 122 case 12: wdt_osc = 2900000; break;
mutech 17:ccd155378a9b 123 case 13: wdt_osc = 3100000; break;
mutech 17:ccd155378a9b 124 case 14: wdt_osc = 3200000; break;
mutech 17:ccd155378a9b 125 case 15: wdt_osc = 3400000; break;
mutech 17:ccd155378a9b 126 }
mutech 17:ccd155378a9b 127 wdt_osc /= ((LPC_SYSCON->WDTOSCCTRL & 0x1F) << 1) + 2;
mutech 17:ccd155378a9b 128
mutech 17:ccd155378a9b 129 uint32_t clk = wdt_osc / 4; // WD has a fixed /4 prescaler, and a 500khz oscillator
mutech 17:ccd155378a9b 130 LPC_WWDT->TC = (ms * clk) / 1000;
mutech 17:ccd155378a9b 131 LPC_WWDT->MOD = 0x3; // Enabled and Reset
mutech 17:ccd155378a9b 132 Service();
mutech 17:ccd155378a9b 133 }
mutech 17:ccd155378a9b 134
mutech 17:ccd155378a9b 135 /// "Service", "kick" or "feed" the dog - reset the watchdog timer
mutech 17:ccd155378a9b 136 /// by writing this required bit pattern
mutech 17:ccd155378a9b 137 void Watchdog::Service()
mutech 17:ccd155378a9b 138 {
mutech 17:ccd155378a9b 139 LPC_WWDT->FEED = 0xAA;
mutech 17:ccd155378a9b 140 LPC_WWDT->FEED = 0x55;
mutech 17:ccd155378a9b 141 }
mutech 17:ccd155378a9b 142
mutech 17:ccd155378a9b 143 /// get the flag to indicate if the watchdog causes the reset
mutech 17:ccd155378a9b 144 bool Watchdog::WatchdogCausedReset()
mutech 17:ccd155378a9b 145 {
mutech 17:ccd155378a9b 146 return _wdreset;
mutech 17:ccd155378a9b 147 }
mutech 17:ccd155378a9b 148
mutech 7:3814d72b8166 149 #elif defined(TARGET_STM)
mutech 7:3814d72b8166 150 Watchdog::Watchdog()
mutech 7:3814d72b8166 151 {
mutech 15:e0e4c2268558 152 _rcc_csr = RCC->CSR;
mutech 15:e0e4c2268558 153 RCC->CSR |= RCC_CSR_RMVF; // clear reset flag
WiredHome 5:2dad2a78ffbd 154 }
WiredHome 0:7a316f14da9c 155
mutech 11:a1611543c454 156 // 整数Xを含む最小のべき乗指数
mutech 11:a1611543c454 157 int Watchdog::calcExponent16bit(uint16_t v)
mutech 11:a1611543c454 158 {
mutech 11:a1611543c454 159 // return (v == 0) ? 0 : MSB16bit(v - 1) + 1;
mutech 11:a1611543c454 160 if (!v)
mutech 11:a1611543c454 161 return 0;
mutech 11:a1611543c454 162 --v;
mutech 7:3814d72b8166 163 // 最大有効ビット数（MSB：Most Significant Bit）
mutech 7:3814d72b8166 164 v |= (v >> 1);
mutech 7:3814d72b8166 165 v |= (v >> 2);
mutech 7:3814d72b8166 166 v |= (v >> 4);
mutech 7:3814d72b8166 167 v |= (v >> 8);
mutech 7:3814d72b8166 168 // return count16bit(v) - 1;
mutech 7:3814d72b8166 169 // 立っているビットの数を数える
mutech 7:3814d72b8166 170 v = (v & 0x5555) + ((v >> 1) & 0x5555);
mutech 7:3814d72b8166 171 v = (v & 0x3333) + ((v >> 2) & 0x3333);
mutech 7:3814d72b8166 172 v = (v & 0x0f0f) + ((v >> 4) & 0x0f0f);
mutech 11:a1611543c454 173 return (v & 0x00ff) + ((v >> 8) & 0x00ff);
mutech 7:3814d72b8166 174 }
mutech 7:3814d72b8166 175
mutech 14:30665d9afe68 176 #if defined(TARGET_STM32F0)
mutech 14:30665d9afe68 177 #define WDT_CLOCK 40000U // 40 kHz
mutech 14:30665d9afe68 178 #else
mutech 14:30665d9afe68 179 #define WDT_CLOCK 32768U // 32.768 kHz
mutech 14:30665d9afe68 180 #endif
mutech 7:3814d72b8166 181
WiredHome 5:2dad2a78ffbd 182 /// Load timeout value in watchdog timer and enable
mutech 7:3814d72b8166 183 void Watchdog::Configure(float s)
mutech 7:3814d72b8166 184 {
WiredHome 5:2dad2a78ffbd 185 // http://www.st.com/web/en/resource/technical/document/reference_manual/CD00171190.pdf
mutech 7:3814d72b8166 186
mutech 11:a1611543c454 187 // Newer Nucleo boards have 32.768 kHz crystal. Without it, the internal
mutech 7:3814d72b8166 188 // RC clock would have an average frequency of 40 kHz (variable between 30 and 60 kHz)
mutech 11:a1611543c454 189 uint32_t tick = (uint32_t)(s * WDT_CLOCK + 0.5f);
mutech 11:a1611543c454 190 // The RLR register is 12 bits and beyond that a prescaler should be used
mutech 11:a1611543c454 191 int scale = calcExponent16bit((tick + 4095) >> 12);
mutech 7:3814d72b8166 192 if (scale < 2)
mutech 7:3814d72b8166 193 scale = 2;
mutech 10:673dff2b0ee6 194 else if (scale > 8) // STM32 allows a maximum time of around 26.2 seconds for the Watchdog timer
mutech 7:3814d72b8166 195 scale = 8;
mutech 11:a1611543c454 196
mutech 11:a1611543c454 197 int residual = tick / (1 << scale); // The value for the RLR register
mutech 11:a1611543c454 198 if (residual < 1)
mutech 11:a1611543c454 199 residual = 1;
mutech 11:a1611543c454 200 else if (residual > 4096)
mutech 7:3814d72b8166 201 residual = 4096;
mutech 7:3814d72b8166 202
WiredHome 5:2dad2a78ffbd 203 IWDG->KR = 0x5555; // enable write to PR, RLR
mutech 7:3814d72b8166 204 IWDG->PR = scale - 2; // Prescaler has values of multiples of 4 (i.e. 2 ^2), page 486 Reference Manual
mutech 7:3814d72b8166 205 IWDG->RLR = residual - 1; // Init RLR
mutech 7:3814d72b8166 206 IWDG->KR = 0xAAAA; // Reload the watchdog
mutech 7:3814d72b8166 207 IWDG->KR = 0xCCCC; // Starts the WD
mutech 7:3814d72b8166 208 }
mutech 7:3814d72b8166 209
mutech 7:3814d72b8166 210 void Watchdog::Configure(int ms)
mutech 7:3814d72b8166 211 {
mutech 7:3814d72b8166 212 // http://www.st.com/web/en/resource/technical/document/reference_manual/CD00171190.pdf
mutech 7:3814d72b8166 213
mutech 11:a1611543c454 214 // Newer Nucleo boards have 32.768 kHz crystal. Without it, the internal
mutech 11:a1611543c454 215 // RC clock would have an average frequency of 40 kHz (variable between 30 and 60 kHz)
mutech 11:a1611543c454 216 // tick = (ms / (1/WDT_CLOCK))/1000;
mutech 11:a1611543c454 217 uint32_t tick = ((uint32_t)ms * WDT_CLOCK + 500U) / 1000U;
mutech 11:a1611543c454 218 // The RLR register is 12 bits and beyond that a prescaler should be used
mutech 11:a1611543c454 219 int scale = calcExponent16bit((tick + 4095) >> 12);
mutech 11:a1611543c454 220 if (scale < 2)
mutech 11:a1611543c454 221 scale = 2;
mutech 11:a1611543c454 222 else if (scale > 8) // STM32 allows a maximum time of around 26.2 seconds for the Watchdog timer
mutech 11:a1611543c454 223 scale = 8;
mutech 10:673dff2b0ee6 224
mutech 11:a1611543c454 225 int residual = tick / (1 << scale); // The value for the RLR register
mutech 11:a1611543c454 226 if (residual < 1)
mutech 7:3814d72b8166 227 residual = 1;
mutech 11:a1611543c454 228 else if (residual > 4096)
mutech 7:3814d72b8166 229 residual = 4096;
mutech 7:3814d72b8166 230
mutech 7:3814d72b8166 231 IWDG->KR = 0x5555; // enable write to PR, RLR
mutech 7:3814d72b8166 232 IWDG->PR = scale - 2; // Prescaler has values of multiples of 4 (i.e. 2 ^2), page 486 Reference Manual
mutech 7:3814d72b8166 233 IWDG->RLR = residual - 1; // Init RLR
WiredHome 5:2dad2a78ffbd 234 IWDG->KR = 0xAAAA; // Reload the watchdog
WiredHome 5:2dad2a78ffbd 235 IWDG->KR = 0xCCCC; // Starts the WD
WiredHome 5:2dad2a78ffbd 236 }
WiredHome 0:7a316f14da9c 237
WiredHome 5:2dad2a78ffbd 238 /// "Service", "kick" or "feed" the dog - reset the watchdog timer
mutech 7:3814d72b8166 239 void Watchdog::Service()
mutech 7:3814d72b8166 240 {
WiredHome 5:2dad2a78ffbd 241 IWDG->KR = 0xAAAA;
WiredHome 5:2dad2a78ffbd 242 }
WiredHome 5:2dad2a78ffbd 243
WiredHome 5:2dad2a78ffbd 244 /// get the flag to indicate if the watchdog causes the reset
mutech 7:3814d72b8166 245 bool Watchdog::WatchdogCausedReset()
mutech 7:3814d72b8166 246 {
mutech 15:e0e4c2268558 247 return (_rcc_csr & (RCC_CSR_IWDGRSTF | RCC_CSR_WWDGRSTF)) != 0; // read the IWDGRSTF (Independent WD, not the windows WD)
WiredHome 5:2dad2a78ffbd 248 }
WiredHome 5:2dad2a78ffbd 249 #endif