mirror of
https://github.com/STMicroelectronics/STM32CubeF4.git
synced 2025-05-11 19:29:45 +08:00
76 lines
3.4 KiB
Plaintext
76 lines
3.4 KiB
Plaintext
/**
|
|
@page Templates Description of the Templates example
|
|
|
|
@verbatim
|
|
******************** (C) COPYRIGHT 2017 STMicroelectronics *******************
|
|
* @file Templates/readme.txt
|
|
* @author MCD Application Team
|
|
* @brief Description of the Templates example.
|
|
******************************************************************************
|
|
*
|
|
* Copyright (c) 2017 STMicroelectronics. All rights reserved.
|
|
*
|
|
* This software component is licensed by ST under BSD 3-Clause license,
|
|
* the "License"; You may not use this file except in compliance with the
|
|
* License. You may obtain a copy of the License at:
|
|
* opensource.org/licenses/BSD-3-Clause
|
|
*
|
|
******************************************************************************
|
|
@endverbatim
|
|
|
|
@par Example Description
|
|
|
|
This directory provides a reference template project that can be used to build any firmware application for
|
|
STM32F469xx devices using STM32CubeF4 HAL and running on STM32469I-DISCO board from STMicroelectronics.
|
|
|
|
A workspaces is provided for STM32469I-DISCO (STM32F469xx devices), which includes the right set
|
|
of peripherals, linker and startup files.
|
|
|
|
@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.
|
|
|
|
|
|
@note The connection of the LCD reset pin to a dedicated GPIO PH7 instead of the STM32F469 NRST pin may cause residual display on LCD with applications/examples that do not require display.
|
|
The LCD clear can be ensured by hardware through the board's power off/power on or by software calling the BSP_LCD_Reset() function.
|
|
|
|
@par Directory contents
|
|
|
|
- Templates/Src/main.c Main program
|
|
- Templates/Src/system_stm32f4xx.c STM32F4xx system clock configuration file
|
|
- Templates/Src/stm32f4xx_it.c Interrupt handlers
|
|
- Templates/Src/stm32f4xx_hal_msp.c HAL MSP module
|
|
- Templates/Inc/main.h Main program header file
|
|
- Templates/Inc/stm32f4xx_hal_conf.h HAL Configuration file
|
|
- Templates/Inc/stm32f4xx_it.h Interrupt handlers header file
|
|
|
|
|
|
@par Hardware and Software environment
|
|
|
|
- This example runs on STM32F469xx devices.
|
|
|
|
- This example has been tested with STMicroelectronics STM32469I-DISCO
|
|
boards and can be easily tailored to any other supported device
|
|
and development board.
|
|
|
|
- This example is configured to run by default on STM32469I-DISCO RevC board.
|
|
- In order to run this example on RevA or RevB boards, replace the flag
|
|
USE_STM32469I_DISCO_REVC, which is defined in the pre-processor options, by
|
|
either USE_STM32469I_DISCO_REVA or USE_STM32469I_DISCO_REVB respectively.
|
|
|
|
|
|
@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>
|
|
*/
|