1 /**
2 ******************************************************************************
3 * @file stm32f7xx_hal_timebase_rtc_wakeup_template.c
4 * @author MCD Application Team
5 * @brief HAL time base based on the hardware RTC_WAKEUP Template.
6 *
7 * This file overrides the native HAL time base functions (defined as weak)
8 * to use the RTC WAKEUP for the time base generation:
9 * + Initializes the RTC peripheral and configures the wakeup timer to be
10 * incremented each 1ms
11 * + The wakeup feature is configured to assert an interrupt each 1ms
12 * + HAL_IncTick is called inside the HAL_RTCEx_WakeUpTimerEventCallback
13 * + HSE (default), LSE or LSI can be selected as RTC clock source
14 ******************************************************************************
15 * @attention
16 *
17 * Copyright (c) 2017 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 'stm32f7xx_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 stm32f7xx_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 stm32f7xx_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 "stm32f7xx_hal.h"
49 /** @addtogroup STM32F7xx_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 #ifdef RTC_CLOCK_SOURCE_HSE
72 #define RTC_ASYNCH_PREDIV 99U
73 #define RTC_SYNCH_PREDIV 9U
74 #define RCC_RTCCLKSOURCE_1MHZ ((uint32_t)((uint32_t)RCC_BDCR_RTCSEL | (uint32_t)((HSE_VALUE/1000000U) << 16U)))
75 #else /* RTC_CLOCK_SOURCE_LSE || RTC_CLOCK_SOURCE_LSI */
76 #define RTC_ASYNCH_PREDIV 0U
77 #define RTC_SYNCH_PREDIV 31U
78 #endif /* RTC_CLOCK_SOURCE_HSE */
79
80 /* Private macro -------------------------------------------------------------*/
81 /* Private variables ---------------------------------------------------------*/
82 RTC_HandleTypeDef hRTC_Handle;
83
84 /* Private function prototypes -----------------------------------------------*/
85 void RTC_WKUP_IRQHandler(void);
86
87 /* Private functions ---------------------------------------------------------*/
88
89 /**
90 * @brief This function configures the RTC_WKUP as a time base source.
91 * The time source is configured to have 1ms time base with a dedicated
92 * Tick interrupt priority.
93 * Wakeup Time base = ((RTC_ASYNCH_PREDIV + 1) * (RTC_SYNCH_PREDIV + 1)) / RTC_CLOCK
94 = 1ms
95 * Wakeup Time = WakeupTimebase * WakeUpCounter (0 + 1)
96 = 1 ms
97 * @note This function is called automatically at the beginning of program after
98 * reset by HAL_Init() or at any time when clock is configured, by HAL_RCC_ClockConfig().
99 * @param TickPriority Tick interrupt priority.
100 * @retval HAL status
101 */
HAL_InitTick(uint32_t TickPriority)102 HAL_StatusTypeDef HAL_InitTick (uint32_t TickPriority)
103 {
104 __IO uint32_t counter = 0U;
105
106 RCC_OscInitTypeDef RCC_OscInitStruct;
107 RCC_PeriphCLKInitTypeDef PeriphClkInitStruct;
108 HAL_StatusTypeDef status;
109
110 #ifdef RTC_CLOCK_SOURCE_LSE
111 /* Configure LSE as RTC clock source */
112 RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_LSE;
113 RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
114 RCC_OscInitStruct.LSEState = RCC_LSE_ON;
115 PeriphClkInitStruct.RTCClockSelection = RCC_RTCCLKSOURCE_LSE;
116 #elif defined (RTC_CLOCK_SOURCE_LSI)
117 /* Configure LSI as RTC clock source */
118 RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_LSI;
119 RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
120 RCC_OscInitStruct.LSIState = RCC_LSI_ON;
121 PeriphClkInitStruct.RTCClockSelection = RCC_RTCCLKSOURCE_LSI;
122 #elif defined (RTC_CLOCK_SOURCE_HSE)
123 /* Configure HSE as RTC clock source */
124 RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSE;
125 RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
126 RCC_OscInitStruct.HSEState = RCC_HSE_ON;
127 /* Ensure that RTC is clocked by 1MHz */
128 PeriphClkInitStruct.RTCClockSelection = RCC_RTCCLKSOURCE_1MHZ;
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 /* The time base should be 1ms
144 Time base = ((RTC_ASYNCH_PREDIV + 1) * (RTC_SYNCH_PREDIV + 1)) / RTC_CLOCK
145 HSE as RTC clock
146 Time base = ((99 + 1) * (9 + 1)) / 1Mhz
147 = 1ms
148 LSE as RTC clock
149 Time base = ((31 + 1) * (0 + 1)) / 32.768Khz
150 = ~1ms
151 LSI as RTC clock
152 Time base = ((31 + 1) * (0 + 1)) / 32Khz
153 = 1ms
154 */
155 hRTC_Handle.Instance = RTC;
156 hRTC_Handle.Init.HourFormat = RTC_HOURFORMAT_24;
157 hRTC_Handle.Init.AsynchPrediv = RTC_ASYNCH_PREDIV;
158 hRTC_Handle.Init.SynchPrediv = RTC_SYNCH_PREDIV;
159 hRTC_Handle.Init.OutPut = RTC_OUTPUT_DISABLE;
160 hRTC_Handle.Init.OutPutPolarity = RTC_OUTPUT_POLARITY_HIGH;
161 hRTC_Handle.Init.OutPutType = RTC_OUTPUT_TYPE_OPENDRAIN;
162 status = HAL_RTC_Init(&hRTC_Handle);
163 }
164 if (status == HAL_OK)
165 {
166 /* Disable the write protection for RTC registers */
167 __HAL_RTC_WRITEPROTECTION_DISABLE(&hRTC_Handle);
168
169 /* Disable the Wake-up Timer */
170 __HAL_RTC_WAKEUPTIMER_DISABLE(&hRTC_Handle);
171
172 /* In case of interrupt mode is used, the interrupt source must disabled */
173 __HAL_RTC_WAKEUPTIMER_DISABLE_IT(&hRTC_Handle, RTC_IT_WUT);
174
175 /* Wait till RTC WUTWF flag is set */
176 while (__HAL_RTC_WAKEUPTIMER_GET_FLAG(&hRTC_Handle, RTC_FLAG_WUTWF) == RESET)
177 {
178 if(counter++ == (SystemCoreClock / 48U))
179 {
180 status = HAL_ERROR;
181 }
182 }
183 }
184 if (status == HAL_OK)
185 {
186 /* Clear PWR wake up Flag */
187 __HAL_PWR_CLEAR_FLAG(PWR_FLAG_WU);
188
189 /* Clear RTC Wake Up timer Flag */
190 __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG(&hRTC_Handle, RTC_FLAG_WUTF);
191
192 /* Configure the Wake-up Timer counter */
193 hRTC_Handle.Instance->WUTR = (uint32_t)0U;
194
195 /* Clear the Wake-up Timer clock source bits in CR register */
196 hRTC_Handle.Instance->CR &= (uint32_t)~RTC_CR_WUCKSEL;
197
198 /* Configure the clock source */
199 hRTC_Handle.Instance->CR |= (uint32_t)RTC_WAKEUPCLOCK_CK_SPRE_16BITS;
200
201 /* RTC WakeUpTimer Interrupt Configuration: EXTI configuration */
202 __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT();
203
204 __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE();
205
206 /* Configure the Interrupt in the RTC_CR register */
207 __HAL_RTC_WAKEUPTIMER_ENABLE_IT(&hRTC_Handle, RTC_IT_WUT);
208
209 /* Enable the Wake-up Timer */
210 __HAL_RTC_WAKEUPTIMER_ENABLE(&hRTC_Handle);
211
212 /* Enable the write protection for RTC registers */
213 __HAL_RTC_WRITEPROTECTION_ENABLE(&hRTC_Handle);
214
215 /* Enable the RTC global Interrupt */
216 HAL_NVIC_EnableIRQ(RTC_WKUP_IRQn);
217
218 /* Configure the SysTick IRQ priority */
219 if (TickPriority < (1UL << __NVIC_PRIO_BITS))
220 {
221 HAL_NVIC_SetPriority(RTC_WKUP_IRQn, TickPriority, 0U);
222 uwTickPrio = TickPriority;
223 }
224 else
225 {
226 status = HAL_ERROR;
227 }
228 }
229
230 return status;
231 }
232
233 /**
234 * @brief Suspend Tick increment.
235 * @note Disable the tick increment by disabling RTC_WKUP interrupt.
236 * @retval None
237 */
HAL_SuspendTick(void)238 void HAL_SuspendTick(void)
239 {
240 /* Disable the write protection for RTC registers */
241 __HAL_RTC_WRITEPROTECTION_DISABLE(&hRTC_Handle);
242 /* Disable WAKE UP TIMER Interrupt */
243 __HAL_RTC_WAKEUPTIMER_DISABLE_IT(&hRTC_Handle, RTC_IT_WUT);
244 /* Enable the write protection for RTC registers */
245 __HAL_RTC_WRITEPROTECTION_ENABLE(&hRTC_Handle);
246 }
247
248 /**
249 * @brief Resume Tick increment.
250 * @note Enable the tick increment by Enabling RTC_WKUP interrupt.
251 * @retval None
252 */
HAL_ResumeTick(void)253 void HAL_ResumeTick(void)
254 {
255 /* Disable the write protection for RTC registers */
256 __HAL_RTC_WRITEPROTECTION_DISABLE(&hRTC_Handle);
257 /* Enable WAKE UP TIMER interrupt */
258 __HAL_RTC_WAKEUPTIMER_ENABLE_IT(&hRTC_Handle, RTC_IT_WUT);
259 /* Enable the write protection for RTC registers */
260 __HAL_RTC_WRITEPROTECTION_ENABLE(&hRTC_Handle);
261 }
262
263 /**
264 * @brief Wake Up Timer Event Callback in non blocking mode
265 * @note This function is called when RTC_WKUP interrupt took place, inside
266 * RTC_WKUP_IRQHandler(). It makes a direct call to HAL_IncTick() to increment
267 * a global variable "uwTick" used as application time base.
268 * @param hrtc RTC handle
269 * @retval None
270 */
HAL_RTCEx_WakeUpTimerEventCallback(RTC_HandleTypeDef * hrtc)271 void HAL_RTCEx_WakeUpTimerEventCallback(RTC_HandleTypeDef *hrtc)
272 {
273 HAL_IncTick();
274 }
275
276 /**
277 * @brief This function handles WAKE UP TIMER interrupt request.
278 * @retval None
279 */
RTC_WKUP_IRQHandler(void)280 void RTC_WKUP_IRQHandler(void)
281 {
282 HAL_RTCEx_WakeUpTimerIRQHandler(&hRTC_Handle);
283 }
284
285 /**
286 * @}
287 */
288
289 /**
290 * @}
291 */
292
293
