81 lines
3.8 KiB
Plaintext
81 lines
3.8 KiB
Plaintext
|
/**
|
||
|
|
@page Templates Description of the Templates example
|
||
|
|
|
||
|
|
@verbatim
|
||
|
|
******************** (C) COPYRIGHT 2016 STMicroelectronics *******************
|
||
|
|
* @file Templates/readme.txt
|
||
|
|
* @author MCD Application Team
|
||
|
|
* @brief Description of the Templates 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 projects provides a reference template that can be used to build any firmware application.
|
||
|
|
|
||
|
|
This project can be used for STM32F334C8 devices using STM32CubeF3 HAL and running on STM32F3348-Discovery board
|
||
|
|
from STMicroelectronics.
|
||
|
|
|
||
|
|
@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
|
||
|
|
|
||
|
|
- Templates/Src/main.c Main program
|
||
|
|
- Templates/Src/system_stm32f3xx.c STM32F3xx system clock configuration file
|
||
|
|
- Templates/Src/stm32f3xx_it.c Interrupt handlers
|
||
|
|
- Templates/Src/stm32f3xx_hal_msp.c HAL MSP module
|
||
|
|
- Templates/Inc/main.h Main program header file
|
||
|
|
- Templates/Inc/stm32f3xx_hal_conf.h HAL Configuration file
|
||
|
|
- Templates/Inc/stm32f3xx_it.h Interrupt handlers header file
|
||
|
|
|
||
|
|
|
||
|
|
@par Hardware and Software environment
|
||
|
|
|
||
|
|
- This example runs on STM32F334C8 devices.
|
||
|
|
|
||
|
|
- This example has been tested with STMicroelectronics STM32F3348-Discovery RevB
|
||
|
|
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
|
||
|
|
|
||
|
|
* <h3><center>© COPYRIGHT STMicroelectronics</center></h3>
|
||
|
|
*/
|