Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 55
Expand file tree
/
Copy pathSTM32LowPower.cpp
More file actions
336 lines (303 loc) · 10 KB
/
Copy pathSTM32LowPower.cpp
File metadata and controls
336 lines (303 loc) · 10 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
/**
******************************************************************************
* @file STM32LowPower.cpp
* @author Frederic Pillon
* @brief Provides a STM32 Low Power interface with Arduino
*
******************************************************************************
* @attention
*
* <h2><center>© COPYRIGHT(c) 2020 STMicroelectronics</center></h2>
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of STMicroelectronics nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
******************************************************************************
*/
#include "STM32LowPower.h"
STM32LowPower LowPower;
STM32LowPower::STM32LowPower()
{
_configured = false;
_serial = NULL;
_rtc_wakeup = false;
}
/**
* @brief Initializes the low power mode
* @param None
* @retval None
*/
void STM32LowPower::begin(void)
{
LowPower_init();
_configured = true;
}
/**
* @brief Enable the idle low power mode (STM32 sleep). Exit this mode on
* interrupt or in n milliseconds.
* @param ms: optional delay before leave the idle mode (default: 0).
* @retval None
*/
void STM32LowPower::idle(uint32_t ms)
{
if ((ms != 0) || _rtc_wakeup) {
programRtcWakeUp(ms, IDLE_MODE);
}
#if defined(PWR_MAINREGULATOR_ON)
LowPower_sleep(PWR_MAINREGULATOR_ON);
#else
LowPower_sleep(0);
#endif
}
/**
* @brief Enable the sleep low power mode (STM32 sleep). Exit this mode on
* interrupt or in n milliseconds.
* @param ms: optional delay before leave the sleep mode (default: 0).
* @retval None
*/
void STM32LowPower::sleep(uint32_t ms)
{
if ((ms != 0) || _rtc_wakeup) {
programRtcWakeUp(ms, SLEEP_MODE);
}
#if defined(PWR_LOWPOWERREGULATOR_ON)
LowPower_sleep(PWR_LOWPOWERREGULATOR_ON);
#elif defined(PWR_MAINREGULATOR_ON)
LowPower_sleep(PWR_MAINREGULATOR_ON);
#else
LowPower_sleep(0);
#endif
}
/**
* @brief Enable the deepsleep low power mode (STM32 stop). Exit this mode on
* interrupt or in n milliseconds.
* @param ms: optional delay before leave the deepSleep mode (default: 0).
* @retval None
*/
void STM32LowPower::deepSleep(uint32_t ms)
{
if ((ms != 0) || _rtc_wakeup) {
programRtcWakeUp(ms, DEEP_SLEEP_MODE);
}
LowPower_stop(_serial);
}
/**
* @brief Enable the shutdown low power mode (STM32 shutdown or standby mode).
* Exit this mode on interrupt or in n milliseconds.
* @param ms: optional delay before leave the shutdown mode (default: 0).
* @retval None
*/
#if defined(STM32WB0x) || defined(STM32WL3x)
void STM32LowPower::shutdown(void)
{
LowPower_shutdown(false);
}
#else
void STM32LowPower::shutdown(uint32_t ms)
{
if ((ms != 0) || _rtc_wakeup) {
programRtcWakeUp(ms, SHUTDOWN_MODE);
}
/* Get the rtc object to know if it is configured */
STM32RTC &rtc = STM32RTC::getInstance();
LowPower_shutdown(rtc.isConfigured());
}
#endif
/**
* @brief Enable GPIO pin in interrupt mode. If the pin is a wakeup pin, it is
* configured as wakeup source.
* @param pin: pin number
* @param callback: pointer to callback function.
* @param mode: pin interrupt mode (HIGH, LOW, RISING, FALLING or CHANGE)
* @param LowPowerMode: Low power mode which will be used
* (IDLE_MODE, SLEEP_MODE, DEEP_SLEEP_MODE, SHUTDOWN_MODE)
* In case of SHUTDOWN_MODE only, Wakeup pin capability is activated
* @retval None
*/
void STM32LowPower::attachInterruptWakeup(uint32_t pin, voidFuncPtrVoid callback, uint32_t mode, LP_Mode LowPowerMode)
{
attachInterrupt(pin, callback, mode);
if ((LowPowerMode == SHUTDOWN_MODE)
#if defined(PWR_WAKEUP_PA0) || defined(PWR_WAKEUP_PORTA)
|| (LowPowerMode == DEEP_SLEEP_MODE)
#endif /* PWR_WAKEUP1_SOURCE_SELECTION_0 || PWR_WAKEUP_PORTA */
) {
// If Gpio is a Wake up pin activate it for shutdown (standby or shutdown stm32)
LowPower_EnableWakeUpPin(pin, mode);
}
}
/**
* @brief Enable a serial interface as a wakeup source.
* @param serial: pointer to a HardwareSerial
* @param callback: pointer to callback function called when leave the low power
* mode.
* @retval None
*/
void STM32LowPower::enableWakeupFrom(HardwareSerial *serial, voidFuncPtrVoid callback)
{
if (serial != NULL) {
_serial = &(serial->_serial);
// Reconfigure serial for low power mode (using HSI as clock source)
serial->configForLowPower();
LowPower_EnableWakeUpUart(_serial, callback);
}
}
/**
* @brief Attach a callback to a RTC alarm.
* @param rtc: pointer to a STM32RTC. Can be NULL as RTC is a Singleton.
* @param callback: pointer to callback function called when leave the low power
* mode.
* @param data: optional pointer to callback data parameters (default NULL).
* @retval None
*/
void STM32LowPower::enableWakeupFrom(STM32RTC *rtc, voidFuncPtr callback, void *data)
{
if (rtc == NULL) {
rtc = &(STM32RTC::getInstance());
}
_rtc_wakeup = true;
rtc->attachInterrupt(callback, data);
}
/**
* @brief Configure the RTC alarm
* @param ms: time of the alarm in milliseconds.
* @param lp_mode: low power mode targeted.
* @retval None
*/
void STM32LowPower::programRtcWakeUp(uint32_t ms, LP_Mode lp_mode)
{
STM32RTC &rtc = STM32RTC::getInstance();
STM32RTC::Source_Clock clkSrc = rtc.getClockSource();
switch (lp_mode) {
case IDLE_MODE:
case SLEEP_MODE:
break;
// LSI or LSE must be selected as clock source to wakeup the device.
case DEEP_SLEEP_MODE:
#if defined(RCC_RTC_WDG_BLEWKUP_CLKSOURCE_HSI64M_DIV2048) || defined(RCC_RTC_WDG_SUBG_LPAWUR_LCD_LCSC_CLKSOURCE_DIV512)
clkSrc = (clkSrc == STM32RTC::HSI_CLOCK) ? STM32RTC::LSI_CLOCK : clkSrc;
#else
clkSrc = (clkSrc == STM32RTC::HSE_CLOCK) ? STM32RTC::LSI_CLOCK : clkSrc;
#endif
break;
default:
case SHUTDOWN_MODE:
#if defined(PWR_CR1_LPMS)
// For shutdown mode LSE have to be used
clkSrc = STM32RTC::LSE_CLOCK;
#else
// LSE or LSI
clkSrc = (clkSrc == STM32RTC::HSE_CLOCK) ? STM32RTC::LSI_CLOCK : clkSrc;
#endif
break;
}
rtc.configForLowPower(clkSrc);
setAlarmTime(ms, rtc);
}
static bool isLeapYear(uint8_t year2k)
{
int year = year2k + 2000;
// if year not divisible by 4 - not a leap year
// else if year divisible by 4 and not by 100 - a leap year
// else if year divisible by 400 - a leap year
return (year % 4 != 0) ? false : (year % 100 != 0) ? true : year % 400 == 0;
}
void STM32LowPower::setAlarmTime(uint32_t ms, STM32RTC &rtc)
{
if (ms != 0) {
uint16_t subSecondsToAdd = ms % 1000;
ms = ms / 1000;
uint8_t daysToAdd = ms / 86400;
uint8_t hoursToAdd = (ms - daysToAdd * 86400) / 3600;
uint8_t minutesToAdd = (ms - daysToAdd * 86400 - hoursToAdd * 3600) / 60;
uint8_t secondsToAdd = (ms - daysToAdd * 86400 - hoursToAdd * 3600 - minutesToAdd * 60);
uint8_t hrCurrent, minCurrent, secCurrent;
uint32_t subSecondsCurrent;
STM32RTC::AM_PM period;
rtc.getTime(&hrCurrent, &minCurrent, &secCurrent, &subSecondsCurrent, &period);
uint8_t weekDay, currentDay, currentMonth, currentYear;
rtc.getDate(&weekDay, ¤tDay, ¤tMonth, ¤tYear);
uint32_t ss = subSecondsCurrent + subSecondsToAdd;
if (ss >= 1000) {
ss -= 1000;
secondsToAdd++;
}
if (secondsToAdd >= 60) {
secondsToAdd = 0;
minutesToAdd++;
}
uint8_t s = secCurrent + secondsToAdd;
if (s >= 60) {
s -= 60;
minutesToAdd++;
}
if (minutesToAdd >= 60) {
minutesToAdd -= 60;
hoursToAdd++;
}
uint8_t m = minCurrent + minutesToAdd;
if (m >= 60) {
m -= 60;
hoursToAdd++;
}
if (hoursToAdd >= 24) {
hoursToAdd -= 24;
daysToAdd++;
}
uint8_t h = hrCurrent + hoursToAdd;
if (rtc._format == STM32RTC::Hour_Format::HOUR_12) {
if (h >= 24) {
h -= 24;
daysToAdd++;
} else if (h >= 12) {
if (period == STM32RTC::AM_PM::AM) {
period = STM32RTC::AM_PM::PM;
} else {
period = STM32RTC::AM_PM::AM;
daysToAdd++;
}
if (h > 12) {
h -= 12;
}
}
} else if (h >= 24) {
h -= 24;
daysToAdd++;
}
// numbers of days in each month (february is calculated based on leap year)
static uint8_t daysInMonths[] = {31, 0, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31};
uint8_t endDay;
if (currentMonth == 2) {
endDay = isLeapYear(currentYear) ? 29 : 28;
} else {
endDay = daysInMonths[currentMonth - 1];
}
uint8_t d = currentDay + daysToAdd;
if (d > endDay) {
d -= endDay;
}
// month-year overflow isn't handled because its not supported by RTC's alarm
rtc.setAlarmTime(h, m, s, ss, period);
rtc.setAlarmDay(d);
rtc.enableAlarm(STM32RTC::Alarm_Match::MATCH_DHHMMSS);
}
}
You can’t perform that action at this time.