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