/**
@page HAL_TimeBase_RTC_ALARM HAL TimeBase RTC Alarm example
@verbatim
******************************************************************************
* @file HAL/HAL_TimeBase_RTC_ALARM/readme.txt
* @author MCD Application Team
* @brief Description of the HAL TimeBase RTC Alarm example.
******************************************************************************
* @attention
*
* Copyright (c) 2016 STMicroelectronics.
* All rights reserved.
*
* This software is licensed under terms that can be found in the LICENSE file
* in the root directory of this software component.
* If no LICENSE file comes with this software, it is provided AS-IS.
*
******************************************************************************
@endverbatim
@par Example Description
This example describes how to customize the HAL time base using RTC alarm instead
of Systick as main source of time base. The User push-button (connected to EXTI Line[15:10])
will be used to Suspend or Resume tick increment.
Each time, the User push-button is pressed; EXTI15_10 interrupt is generated and in the ISR
the uwIncrementState is checked:
1- If the uwIncrementState = 0: the tick increment is suspended by calling
HAL_SuspendTick() API (RTC alarm interrupt is disabled).
2- If the uwIncrementState = 1: the tick increment is Resumed by calling
HAL_ResumeTick() API(RTC alarm interrupt is enabled).
The alarm is configured to assert an interrupt when the RTC reaches 1 ms
The example brings, in user file, a new implementation of the following HAL weak functions:
HAL_InitTick()
HAL_SuspendTick()
HAL_ResumeTick()
This implementation will overwrite native implementation in stm32f7xx_hal.c
and so user functions will be invoked instead when called.
The following time base functions are kept as implemented natively:
HAL_IncTick()
HAL_Delay()
When user pushes the User push-button, the Tick increment is suspended if it is already
enabled, else it will be resumed.
In an infinite loop, LED1 toggles spaced out over 1s delay.
@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
based on variable incremented in HAL time base ISR. This implies that if HAL_Delay() is called from
a peripheral ISR process, then the HAL time base interrupt must have higher priority (numerically lower)
than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
To change the HAL time base interrupt priority you have to use HAL_NVIC_SetPriority() function.
@note The application needs to ensure that the HAL time base is always set to 1 millisecond
to have correct HAL operation.
@par Keywords
System, RTC Alarm, Time base, HAL
@Note<74>If the user code size exceeds the DTCM-RAM size or starts from internal cacheable memories (SRAM1 and SRAM2),that is shared between several processors,
<20><><A0><A0><A0>then it is highly recommended to enable the CPU cache and maintain its coherence at application level.
<0A><><A0><A0><A0><A0>The address and the size of cacheable buffers (shared between CPU and other masters) must be properly updated to be aligned to cache line size (32 bytes).
@Note It is recommended to enable the cache and maintain its coherence, but depending on the use case
<0A><><A0><A0><A0> It is also possible to configure the MPU as "Write through", to guarantee the write access coherence.
<0A><><A0><A0><A0><A0>In that case, the MPU must be configured as Cacheable/Bufferable/Not Shareable.
<0A><><A0><A0><A0><A0>Even though the user must manage the cache coherence for read accesses.
<0A><><A0><A0><A0><A0>Please refer to the AN4838 <20>Managing memory protection unit (MPU) in STM32 MCUs<55>
<0A><><A0><A0><A0><A0>Please refer to the AN4839 <20>Level 1 cache on STM32F7 Series<65>
@par Directory contents
- HAL/HAL_TimeBase_RTC_ALARM/Inc/stm32f7xx_hal_conf.h HAL configuration file
- HAL/HAL_TimeBase_RTC_ALARM/Inc/stm32f7xx_it.h Interrupt handlers header file
- HAL/HAL_TimeBase_RTC_ALARM/Inc/main.h Header for main.c module
- HAL/HAL_TimeBase_RTC_ALARM/Src/stm32f7xx_it.c Interrupt handlers
- HAL/HAL_TimeBase_RTC_ALARM/Src/main.c Main program
- HAL/HAL_TimeBase_RTC_ALARM/Src/stm32f7xx_hal_timebase_rtc_alarm.c HAL time base functions
- HAL/HAL_TimeBase_RTC_ALARM/Src/system_stm32f7xx.c STM32F7xx system source file
@par Hardware and Software environment
- This example runs on STM32F723xx/STM32F722xx/STM32F732xx/STM32F733xx Devices.
- This example has been tested with STMicroelectronics STM32F722ZE-Nucleo board and can be
easily tailored to any other supported device and development board.
@par How to use it ?
In order to make the program work, you must do the following :
- Open your preferred toolchain
- Rebuild all files and load your image into target memory
- Run the example
*/
767d083e20