1 /**
2 ******************************************************************************
3 * @file stm32h7xx_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 ******************************************************************************
16 * @attention
17 *
18 * Copyright (c) 2017 STMicroelectronics.
19 * All rights reserved.
20 *
21 * This software is licensed under terms that can be found in the LICENSE file
22 * in the root directory of this software component.
23 * If no LICENSE file comes with this software, it is provided AS-IS.
24 *
25 ******************************************************************************
26 @verbatim
27 ==============================================================================
28 ##### How to use this driver #####
29 ==============================================================================
30 [..]
31 This file must be copied to the application folder and modified as follows:
32 (#) Rename it to 'stm32h7xx_hal_timebase_rtc_wakeup.c'
33 (#) Add this file and the RTC HAL drivers to your project and uncomment
34 HAL_RTC_MODULE_ENABLED define in stm32h7xx_hal_conf.h
35
36 [..]
37 (@) HAL RTC alarm and HAL RTC wakeup drivers can not be used with low power modes:
38 The wake up capability of the RTC may be intrusive in case of prior low power mode
39 configuration requiring different wake up sources.
40 Application/Example behavior is no more guaranteed
41 (@) The stm32h7xx_hal_timebase_tim use is recommended for the Applications/Examples
42 requiring low power modes
43
44 @endverbatim
45 ******************************************************************************
46 */
47
48 /* Includes ------------------------------------------------------------------*/
49 #include "stm32h7xx_hal.h"
50 /** @addtogroup STM32H7xx_HAL_Driver
51 * @{
52 */
53
54 /** @defgroup HAL_TimeBase_RTC_WakeUp_Template HAL TimeBase RTC WakeUp Template
55 * @{
56 */
57
58 /* Private typedef -----------------------------------------------------------*/
59 /* Private define ------------------------------------------------------------*/
60
61 /* Uncomment the line below to select the appropriate RTC Clock source for your application:
62 + RTC_CLOCK_SOURCE_HSE: can be selected for applications requiring timing precision.
63 + RTC_CLOCK_SOURCE_LSE: can be selected for applications with low constraint on timing
64 precision.
65 + RTC_CLOCK_SOURCE_LSI: can be selected for applications with low constraint on timing
66 precision.
67 */
68 #define RTC_CLOCK_SOURCE_HSE
69 /* #define RTC_CLOCK_SOURCE_LSE */
70 /* #define RTC_CLOCK_SOURCE_LSI */
71
72 #ifdef RTC_CLOCK_SOURCE_HSE
73 #define RTC_ASYNCH_PREDIV 99U
74 #define RTC_SYNCH_PREDIV 9U
75 #define RCC_RTCCLKSOURCE_1MHZ ((uint32_t)((uint32_t)RCC_BDCR_RTCSEL | (uint32_t)((HSE_VALUE/1000000U) << 12U)))
76 #else /* RTC_CLOCK_SOURCE_LSE || RTC_CLOCK_SOURCE_LSI */
77 #define RTC_ASYNCH_PREDIV 0U
78 #define RTC_SYNCH_PREDIV 31U
79 #endif /* RTC_CLOCK_SOURCE_HSE */
80
81 /* Private macro -------------------------------------------------------------*/
82 /* Private variables ---------------------------------------------------------*/
83 static 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 /* Configure LSE as RTC clock source */
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 /* Configure LSI as RTC clock source */
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 /* Configure HSE as RTC clock source */
125 RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSE;
126 RCC_OscInitStruct.PLL.PLLState = RCC_PLL_NONE;
127 RCC_OscInitStruct.HSEState = RCC_HSE_ON;
128 /* Ensure that RTC is clocked by 1MHz */
129 PeriphClkInitStruct.RTCClockSelection = RCC_RTCCLKSOURCE_1MHZ;
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 /* The time base should be 1ms
145 Time base = ((RTC_ASYNCH_PREDIV + 1) * (RTC_SYNCH_PREDIV + 1)) / RTC_CLOCK
146 HSE as RTC clock
147 Time base = ((99 + 1) * (9 + 1)) / 1Mhz
148 = 1ms
149 LSE as RTC clock
150 Time base = ((31 + 1) * (0 + 1)) / 32.768Khz
151 = ~1ms
152 LSI as RTC clock
153 Time base = ((31 + 1) * (0 + 1)) / 32Khz
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 #if defined(RTC_ICSR_WUTWF)
178 while (READ_BIT(hRTC_Handle.Instance->ICSR, RTC_FLAG_WUTWF) == (uint32_t)RESET)
179 #else
180 while (__HAL_RTC_WAKEUPTIMER_GET_FLAG(&hRTC_Handle, RTC_FLAG_WUTWF) == (uint32_t)RESET)
181 #endif /* RTC_ICSR_WUTWF */
182 {
183 if (counter++ == (SystemCoreClock / 48U))
184 {
185 status = HAL_ERROR;
186 }
187 }
188 }
189 if (status == HAL_OK)
190 {
191 /* Clear PWR wake up Flag */
192 __HAL_PWR_CLEAR_FLAG(PWR_FLAG_WU);
193
194 /* Clear RTC Wake Up timer Flag */
195 __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG(&hRTC_Handle, RTC_FLAG_WUTF);
196
197 /* Configure the Wake-up Timer counter */
198 hRTC_Handle.Instance->WUTR = (uint32_t)0U;
199
200 /* Clear the Wake-up Timer clock source bits in CR register */
201 hRTC_Handle.Instance->CR &= (uint32_t)~RTC_CR_WUCKSEL;
202
203 /* Configure the clock source */
204 hRTC_Handle.Instance->CR |= (uint32_t)RTC_WAKEUPCLOCK_CK_SPRE_16BITS;
205
206 /* RTC WakeUpTimer Interrupt Configuration: EXTI configuration */
207 __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT();
208
209 __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE();
210
211 /* Configure the Interrupt in the RTC_CR register */
212 __HAL_RTC_WAKEUPTIMER_ENABLE_IT(&hRTC_Handle,RTC_IT_WUT);
213
214 /* Enable the Wake-up Timer */
215 __HAL_RTC_WAKEUPTIMER_ENABLE(&hRTC_Handle);
216
217 /* Enable the write protection for RTC registers */
218 __HAL_RTC_WRITEPROTECTION_ENABLE(&hRTC_Handle);
219
220 /* Enable the RTC global Interrupt */
221 HAL_NVIC_EnableIRQ(RTC_WKUP_IRQn);
222
223 /* Configure the SysTick IRQ priority */
224 if (TickPriority < (1UL << __NVIC_PRIO_BITS))
225 {
226 HAL_NVIC_SetPriority(RTC_WKUP_IRQn, TickPriority, 0U);
227 uwTickPrio = TickPriority;
228 }
229 else
230 {
231 status = HAL_ERROR;
232 }
233 }
234 return status;
235 }
236
237 /**
238 * @brief Suspend Tick increment.
239 * @note Disable the tick increment by disabling RTC_WKUP interrupt.
240 * @retval None
241 */
HAL_SuspendTick(void)242 void HAL_SuspendTick(void)
243 {
244 /* Disable the write protection for RTC registers */
245 __HAL_RTC_WRITEPROTECTION_DISABLE(&hRTC_Handle);
246 /* Disable WAKE UP TIMER Interrupt */
247 __HAL_RTC_WAKEUPTIMER_DISABLE_IT(&hRTC_Handle, RTC_IT_WUT);
248 /* Enable the write protection for RTC registers */
249 __HAL_RTC_WRITEPROTECTION_ENABLE(&hRTC_Handle);
250 }
251
252 /**
253 * @brief Resume Tick increment.
254 * @note Enable the tick increment by Enabling RTC_WKUP interrupt.
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 /* Prevent unused argument(s) compilation warning */
278 UNUSED(hrtc);
279
280 HAL_IncTick();
281 }
282
283 /**
284 * @brief This function handles WAKE UP TIMER interrupt request.
285 * @retval None
286 */
RTC_WKUP_IRQHandler(void)287 void RTC_WKUP_IRQHandler(void)
288 {
289 HAL_RTCEx_WakeUpTimerIRQHandler(&hRTC_Handle);
290 }
291
292 /**
293 * @}
294 */
295
296 /**
297 * @}
298 */
299
300
