/**
@page HAL_TimeBase HAL Time base example
@verbatim
******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
* @file HAL/HAL_TimeBase/readme.txt
* @author MCD Application Team
* @brief Description of the HAL time base example.
******************************************************************************
* @attention
*
* Copyright (c) 2017 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 a general
purpose timer(TIM5) instead of Systick as main source of time base.
Time base duration is kept unchanged: 1ms since PPP_TIMEOUT_VALUEs are defined
and handled in milliseconds basis.
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 stm32f4xx_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 Push-button Tick increment is suspended if it is already
enabled, else it will be resumed.
In an infinite loop, LED3, LED4 and LED6 toggles spaced out over 1s delay.
LED5 will turn ON, if any error is occurred.
@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
based on variable incremented in TIM5 ISR. This implies that if HAL_Delay() is called from
a peripheral ISR process, then the TIM5 interrupt must have higher priority (numerically lower)
than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
To change the TIM5 interrupt priority you have to use HAL_NVIC_SetPriority() function.
@note The application needs to ensure that the TIM5 time base is always set to 1 millisecond
to have correct HAL operation.
@par Keywords
System, General purpose Timer, Time base, HAL
@par Directory contents
- HAL/HAL_TimeBase/Inc/stm32f4xx_hal_conf.h HAL configuration file
- HAL/HAL_TimeBase/Inc/stm32f4xx_it.h Interrupt handlers header file
- HAL/HAL_TimeBase/Inc/main.h Main program header file
- HAL/HAL_TimeBase/Src/stm32f4xx_it.c Interrupt handlers
- HAL/HAL_TimeBase/Src/main.c Main program
- HAL/HAL_TimeBase/Src/system_stm32f4xx.c STM32F4xx system clock configuration file
@par Hardware and Software environment
- This example runs on STM32F401xCx devices.
- This example has been tested with STMicroelectronics STM32F401-Discovery RevB & RevC
boards 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
*/
3d6be4bd40