1 /**
2 ******************************************************************************
3 * @file stm32f3xx_hal_timebase_rtc_wakeup_template.c
4 * @brief HAL time base based on the hardware RTC_WAKEUP Template.
5 *
6 * This file overrides the native HAL time base functions (defined as weak)
7 * to use the RTC WAKEUP for the time base generation:
8 * + Initializes the RTC peripheral and configures the wakeup timer to be
9 * incremented each 1ms
10 * + The wakeup feature is configured to assert an interrupt each 1ms
11 * + HAL_IncTick is called inside the HAL_RTCEx_WakeUpTimerEventCallback
12 * + HSE (default), LSE or LSI can be selected as RTC clock source
13 *
14 ******************************************************************************
15 * @attention
16 *
17 * Copyright (c) 2016 STMicroelectronics.
18 * All rights reserved.
19 *
20 * This software is licensed under terms that can be found in the LICENSE file
21 * in the root directory of this software component.
22 * If no LICENSE file comes with this software, it is provided AS-IS.
23 *
24 ******************************************************************************
25 @verbatim
26 ==============================================================================
27 ##### How to use this driver #####
28 ==============================================================================
29 [..]
30 This file must be copied to the application folder and modified as follows:
31 (#) Rename it to 'stm32f3xx_hal_timebase_rtc_wakeup.c'
32 (#) Add this file and the RTC HAL drivers to your project and uncomment
33 HAL_RTC_MODULE_ENABLED define in stm32f3xx_hal_conf.h
34
35 [..]
36 (@) HAL RTC alarm and HAL RTC wakeup drivers can�t be used with low power modes:
37 The wake up capability of the RTC may be intrusive in case of prior low power mode
38 configuration requiring different wake up sources.
39 Application/Example behavior is no more guaranteed
40 (@) The stm32f3xx_hal_timebase_tim use is recommended for the Applications/Examples
41 requiring low power modes
42
43 @endverbatim
44 ******************************************************************************
45 */
46
47 /* Includes ------------------------------------------------------------------*/
48 #include "stm32f3xx_hal.h"
49 /** @addtogroup STM32F3xx_HAL_Driver
50 * @{
51 */
52
53 /** @defgroup HAL_TimeBase_RTC_WakeUp_Template HAL TimeBase RTC WakeUp Template
54 * @{
55 */
56
57 /* Private typedef -----------------------------------------------------------*/
58 /* Private define ------------------------------------------------------------*/
59
60 /* Uncomment the line below to select the appropriate RTC Clock source for your application:
61 + RTC_CLOCK_SOURCE_HSE: can be selected for applications requiring timing precision.
62 + RTC_CLOCK_SOURCE_LSE: can be selected for applications with low constraint on timing
63 precision.
64 + RTC_CLOCK_SOURCE_LSI: can be selected for applications with low constraint on timing
65 precision.
66 */
67 #define RTC_CLOCK_SOURCE_HSE
68 /* #define RTC_CLOCK_SOURCE_LSE */
69 /* #define RTC_CLOCK_SOURCE_LSI */
70
71 #if defined(RTC_CLOCK_SOURCE_HSE)
72 #define RTC_ASYNCH_PREDIV 49U
73 #define RTC_SYNCH_PREDIV 4U
74 #elif define(RTC_CLOCK_SOURCE_LSE)
75 #define RTC_ASYNCH_PREDIV 0U
76 #define RTC_SYNCH_PREDIV 31U
77 #else /* RTC_CLOCK_SOURCE_LSI */
78 #define RTC_ASYNCH_PREDIV 0U
79 #define RTC_SYNCH_PREDIV 39U
80 #endif /* RTC_CLOCK_SOURCE_HSE */
81
82 /* Private macro -------------------------------------------------------------*/
83 /* Private variables ---------------------------------------------------------*/
84 RTC_HandleTypeDef hRTC_Handle;
85
86 /* Private function prototypes -----------------------------------------------*/
87 void RTC_WKUP_IRQHandler(void);
88
89 /* Private functions ---------------------------------------------------------*/
90
91 /**
92 * @brief This function configures the RTC_WKUP as a time base source.
93 * The time source is configured to have 1ms time base with a dedicated
94 * Tick interrupt priority.
95 * Wakeup Time base = ((RTC_ASYNCH_PREDIV + 1) * (RTC_SYNCH_PREDIV + 1)) / RTC_CLOCK
96 = 1ms
97 * Wakeup Time = WakeupTimebase * WakeUpCounter (0 + 1)
98 = 1 ms
99 * @note This function is called automatically at the beginning of program after
100 * reset by HAL_Init() or at any time when clock is configured, by HAL_RCC_ClockConfig().
101 * @param TickPriority Tick interrupt priority.
102 * @retval HAL status
103 */
HAL_InitTick(uint32_t TickPriority)104 HAL_StatusTypeDef HAL_InitTick(uint32_t TickPriority)
105 {
106 __IO uint32_t counter = 0U;
107
108 RCC_OscInitTypeDef RCC_OscInitStruct;
109 RCC_PeriphCLKInitTypeDef PeriphClkInitStruct;
110 HAL_StatusTypeDef status;
111
112 #ifdef RTC_CLOCK_SOURCE_LSE
113 /* Configue LSE as RTC clock soucre */
114 RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_LSE;
115 RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
116 RCC_OscInitStruct.LSEState = RCC_LSE_ON;
117 PeriphClkInitStruct.RTCClockSelection = RCC_RTCCLKSOURCE_LSE;
118 #elif defined (RTC_CLOCK_SOURCE_LSI)
119 /* Configue LSI as RTC clock soucre */
120 RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_LSI;
121 RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
122 RCC_OscInitStruct.LSIState = RCC_LSI_ON;
123 PeriphClkInitStruct.RTCClockSelection = RCC_RTCCLKSOURCE_LSI;
124 #elif defined (RTC_CLOCK_SOURCE_HSE)
125 /* Configue HSE as RTC clock soucre */
126 RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSE;
127 RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
128 RCC_OscInitStruct.HSEState = RCC_HSE_ON;
129 PeriphClkInitStruct.RTCClockSelection = RCC_RTCCLKSOURCE_HSE_DIV32;
130 #else
131 #error Please select the RTC Clock source
132 #endif /* RTC_CLOCK_SOURCE_LSE */
133
134 status = HAL_RCC_OscConfig(&RCC_OscInitStruct);
135 if (status == HAL_OK)
136 {
137 PeriphClkInitStruct.PeriphClockSelection = RCC_PERIPHCLK_RTC;
138 status = (HAL_RCCEx_PeriphCLKConfig(&PeriphClkInitStruct));
139 }
140 if (status == HAL_OK)
141 {
142 /* Enable RTC Clock */
143 __HAL_RCC_RTC_ENABLE();
144
145 /* The time base should be 1ms
146 Time base = ((RTC_ASYNCH_PREDIV + 1U) * (RTC_SYNCH_PREDIV + 1U)) / RTC_CLOCK
147 HSE/32 as RTC clock and HSE 8MHz
148 Time base = ((49U + 1U) * (4U + 1U)) / 250kHz
149 = 1ms
150 LSE as RTC clock
151 Time base = ((31U + 1U) * (0U + 1U)) / 32.768Khz
152 = ~1ms
153 LSI as RTC clock
154 Time base = ((39U + 1U) * (0U + 1U)) / 40Khz
155 = 1ms
156 */
157 hRTC_Handle.Instance = RTC;
158 hRTC_Handle.Init.HourFormat = RTC_HOURFORMAT_24;
159 hRTC_Handle.Init.AsynchPrediv = RTC_ASYNCH_PREDIV;
160 hRTC_Handle.Init.SynchPrediv = RTC_SYNCH_PREDIV;
161 hRTC_Handle.Init.OutPut = RTC_OUTPUT_DISABLE;
162 hRTC_Handle.Init.OutPutPolarity = RTC_OUTPUT_POLARITY_HIGH;
163 hRTC_Handle.Init.OutPutType = RTC_OUTPUT_TYPE_OPENDRAIN;
164 status = HAL_RTC_Init(&hRTC_Handle);
165 }
166 if (status == HAL_OK)
167 {
168 /* Disable the write protection for RTC registers */
169 __HAL_RTC_WRITEPROTECTION_DISABLE(&hRTC_Handle);
170
171 /* Disable the Wake-up Timer */
172 __HAL_RTC_WAKEUPTIMER_DISABLE(&hRTC_Handle);
173
174 /* In case of interrupt mode is used, the interrupt source must disabled */
175 __HAL_RTC_WAKEUPTIMER_DISABLE_IT(&hRTC_Handle, RTC_IT_WUT);
176
177 /* Wait till RTC WUTWF flag is set */
178 while(__HAL_RTC_WAKEUPTIMER_GET_FLAG(&hRTC_Handle, RTC_FLAG_WUTWF) == RESET)
179 {
180 if(counter++ == (SystemCoreClock / 48U))
181 {
182 status = HAL_ERROR;
183 }
184 }
185 }
186 if (status == HAL_OK)
187 {
188
189 /* Clear PWR wake up Flag */
190 __HAL_PWR_CLEAR_FLAG(PWR_FLAG_WU);
191
192 /* Clear RTC Wake Up timer Flag */
193 __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG(&hRTC_Handle, RTC_FLAG_WUTF);
194
195 /* Configure the Wake-up Timer counter */
196 hRTC_Handle.Instance->WUTR = 0U;
197
198 /* Clear the Wake-up Timer clock source bits in CR register */
199 hRTC_Handle.Instance->CR &= (uint32_t)~RTC_CR_WUCKSEL;
200
201 /* Configure the clock source */
202 hRTC_Handle.Instance->CR |= (uint32_t)RTC_WAKEUPCLOCK_CK_SPRE_16BITS;
203
204 /* RTC WakeUpTimer Interrupt Configuration: EXTI configuration */
205 __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT();
206
207 __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE();
208
209 /* Configure the Interrupt in the RTC_CR register */
210 __HAL_RTC_WAKEUPTIMER_ENABLE_IT(&hRTC_Handle,RTC_IT_WUT);
211
212 /* Enable the Wake-up Timer */
213 __HAL_RTC_WAKEUPTIMER_ENABLE(&hRTC_Handle);
214
215 /* Enable the write protection for RTC registers */
216 __HAL_RTC_WRITEPROTECTION_ENABLE(&hRTC_Handle);
217
218 /* Enable the RTC global Interrupt */
219 HAL_NVIC_EnableIRQ(RTC_WKUP_IRQn);
220
221 /* Configure the SysTick IRQ priority */
222 if (TickPriority < (1UL << __NVIC_PRIO_BITS))
223 {
224 HAL_NVIC_SetPriority(RTC_WKUP_IRQn, TickPriority, 0U);
225 uwTickPrio = TickPriority;
226 }
227 else
228 {
229 status = HAL_ERROR;
230 }
231 }
232 return status;
233 }
234
235 /**
236 * @brief Suspend Tick increment.
237 * @note Disable the tick increment by disabling RTC_WKUP interrupt.
238 * @param None
239 * @retval None
240 */
HAL_SuspendTick(void)241 void HAL_SuspendTick(void)
242 {
243 /* Disable the write protection for RTC registers */
244 __HAL_RTC_WRITEPROTECTION_DISABLE(&hRTC_Handle);
245 /* Disable WAKE UP TIMER Interrupt */
246 __HAL_RTC_WAKEUPTIMER_DISABLE_IT(&hRTC_Handle, RTC_IT_WUT);
247 /* Enable the write protection for RTC registers */
248 __HAL_RTC_WRITEPROTECTION_ENABLE(&hRTC_Handle);
249 }
250
251 /**
252 * @brief Resume Tick increment.
253 * @note Enable the tick increment by Enabling RTC_WKUP interrupt.
254 * @param None
255 * @retval None
256 */
HAL_ResumeTick(void)257 void HAL_ResumeTick(void)
258 {
259 /* Disable the write protection for RTC registers */
260 __HAL_RTC_WRITEPROTECTION_DISABLE(&hRTC_Handle);
261 /* Enable WAKE UP TIMER interrupt */
262 __HAL_RTC_WAKEUPTIMER_ENABLE_IT(&hRTC_Handle, RTC_IT_WUT);
263 /* Enable the write protection for RTC registers */
264 __HAL_RTC_WRITEPROTECTION_ENABLE(&hRTC_Handle);
265 }
266
267 /**
268 * @brief Wake Up Timer Event Callback in non blocking mode
269 * @note This function is called when RTC_WKUP interrupt took place, inside
270 * RTC_WKUP_IRQHandler(). It makes a direct call to HAL_IncTick() to increment
271 * a global variable "uwTick" used as application time base.
272 * @param hrtc RTC handle
273 * @retval None
274 */
HAL_RTCEx_WakeUpTimerEventCallback(RTC_HandleTypeDef * hrtc)275 void HAL_RTCEx_WakeUpTimerEventCallback(RTC_HandleTypeDef *hrtc)
276 {
277 HAL_IncTick();
278 }
279
280 /**
281 * @brief This function handles WAKE UP TIMER interrupt request.
282 * @param None
283 * @retval None
284 */
RTC_WKUP_IRQHandler(void)285 void RTC_WKUP_IRQHandler(void)
286 {
287 HAL_RTCEx_WakeUpTimerIRQHandler(&hRTC_Handle);
288 }
289
290 /**
291 * @}
292 */
293
294 /**
295 * @}
296 */
297
298
