2019-07-15 15:37:15 +01:00

105 lines
4.9 KiB
Plaintext

/**
@page TIM_TimeBase Time Base example
@verbatim
******************** (C) COPYRIGHT 2016 STMicroelectronics *******************
* @file TIM/TIM_TimeBase/readme.txt
* @author MCD Application Team
* @brief Description of the TIM Time Base example
******************************************************************************
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of STMicroelectronics nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
******************************************************************************
@endverbatim
@par Example Description
This example shows how to configure the TIM peripheral to generate a time base of
one second with the corresponding Interrupt request.
In this example TIM2 input clock (TIM2CLK) is set to 2 * APB1 clock (PCLK1),
since APB1 prescaler is different from 1.
TIM2CLK = 2 * PCLK1
PCLK1 = HCLK / 2
=> TIM2CLK = HCLK = SystemCoreClock (Hz)
To get TIM2 counter clock at 10 KHz, the Prescaler is computed as following:
Prescaler = (TIM2CLK / TIM2 counter clock) - 1
Prescaler = (SystemCoreClock /10 KHz) - 1
SystemCoreClock is set to 64 MHz for STM32F3xx Devices.
The TIM2 ARR register value is equal to 10000 - 1,
Update rate = TIM2 counter clock / (Period + 1) = 1 Hz,
So the TIM2 generates an interrupt each 1 s
When the counter value reaches the auto-reload register value, the TIM update
interrupt is generated and, in the handler routine, pin GPIOB.0 (connected to LED1 on board STM32F303ZE-Nucleo Rev B)
is toggled at the following frequency: 0.5Hz.
In case of error, LED2 is turned ON.
@note Care must be taken when using HAL_Delay(), this function provides accurate delay (in milliseconds)
based on variable incremented in SysTick ISR. This implies that if HAL_Delay() is called from
a peripheral ISR process, then the SysTick interrupt must have higher priority (numerically lower)
than the peripheral interrupt. Otherwise the caller ISR process will be blocked.
To change the SysTick interrupt priority you have to use HAL_NVIC_SetPriority() function.
@note The application need to ensure that the SysTick time base is always set to 1 millisecond
to have correct HAL operation.
@par Directory contents
- TIM/TIM_TimeBase/Inc/stm32f3xx_hal_conf.h HAL configuration file
- TIM/TIM_TimeBase/Inc/stm32f3xx_it.h Interrupt handlers header file
- TIM/TIM_TimeBase/Inc/main.h Header for main.c module
- TIM/TIM_TimeBase/Src/stm32f3xx_it.c Interrupt handlers
- TIM/TIM_TimeBase/Src/main.c Main program
- TIM/TIM_TimeBase/Src/stm32f3xx_hal_msp.c HAL MSP file
- TIM/TIM_TimeBase/Src/system_stm32f3xx.c STM32F3xx system source file
@par Hardware and Software environment
- This example runs on STM32F303ZE devices.
- In this example, the clock is set to 64 MHz.
- This example has been tested with STMicroelectronics STM32F303ZE-Nucleo Rev B
board and can be easily tailored to any other supported device
and development board.
- STM32F303ZE-Nucleo Rev B Set-up
- Use LED1 connected to GPIOB.0 pin (connected to pin 31 on CN10 Connector) and connect it on an oscilloscope
to show the Time Base signal.
@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
* <h3><center>&copy; COPYRIGHT STMicroelectronics</center></h3>
*/