mirror of
https://github.com/STMicroelectronics/STM32CubeF7.git
synced 2025-05-03 22:17:13 +08:00
146 lines
6.7 KiB
Plaintext
146 lines
6.7 KiB
Plaintext
/**
|
||
@page BSP Example on how to use the BSP drivers
|
||
|
||
@verbatim
|
||
******************************************************************************
|
||
* @file BSP/readme.txt
|
||
* @author MCD Application Team
|
||
* @brief Description of the BSP 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 provides a description of how to use the different BSP drivers.
|
||
|
||
At the beginning of the main program the HAL_Init() function is called to reset
|
||
all the peripherals, initialize the Flash interface and the systick.
|
||
Then the SystemClock_Config() function is used to configure the system clock
|
||
(SYSCLK) to run at 216 MHz.
|
||
|
||
This example shows how to use the different functionalities of components
|
||
available on the board by switching between all tests using user button.
|
||
|
||
#### LCD ####
|
||
This example shows how to use the different LCD features to display strings
|
||
with different fonts, to display different shapes and to draw a bitmap.
|
||
|
||
#### Touchscreen demo1 ####
|
||
Use touchscreen functionality to select or activate colored circle inside a rectangle.
|
||
|
||
#### Touchscreen demo2 ####
|
||
Use touchscreen functionality to select 2 touch points, their positions will be
|
||
captured and displayed on the LCD.
|
||
|
||
#### Touchscreen demo3 ####
|
||
Use touchscreen functionality to select or activate one square in a grid and colore it.
|
||
|
||
#### LOG ####
|
||
This example show how to use the LCD log features.
|
||
|
||
#### PSRAM ####
|
||
This example shows how to use the IS66WV51216EBLL-55BLI PSRAM features(read/write/erase..).
|
||
|
||
#### PSRAM DMA ####
|
||
This example shows how to use the IS66WV51216EBLL-55BLI PSRAM features(read/write/erase..) in DMA mode.
|
||
|
||
#### QSPI ####
|
||
This example shows how to erase, write to and read from the external MX25R6435F Macronix
|
||
flash memory using QSPI communication.
|
||
|
||
#### AUDIO PLAY ####
|
||
|
||
This example shows how to play an audio file through the I2S peripheral
|
||
using the external codec WM8994 implemented on the STM32723E-DISCOVERY board. The I2S input
|
||
clock, provided by a dedicated PLL (PLLI2S), is configured initially to have an audio
|
||
sampling frequency at 48 KHz. The audio data is stored in the internal flash memory
|
||
(4 channels, 16-bit, 48 KHz). Following the instruction on the display, stream can be
|
||
paused and resumed, volume can be changed and sample frequency can be changed.
|
||
|
||
LED6(GREEN) remains toggling while no example is running.
|
||
At the end of all examples when pushing the user-button the application loops
|
||
to the beginning (first examples).
|
||
|
||
@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 Keywords
|
||
|
||
BSP, LCD, Touchscreen, PSRAM, DMA, QUADSPI, Erase, Read, Write, Audio play, Record, MEMS, Audio Codec, DFSDM,
|
||
I2S, Microphone, Headphones
|
||
|
||
@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><><EFBFBD><EFBFBD><EFBFBD>then it is highly recommended to enable the CPU cache and maintain its coherence at application level.
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>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
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> It is also possible to configure the MPU as "Write through", to guarantee the write access coherence.
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>In that case, the MPU must be configured as Cacheable/Bufferable/Not Shareable.
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Even though the user must manage the cache coherence for read accesses.
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Please refer to the AN4838 <20>Managing memory protection unit (MPU) in STM32 MCUs<55>
|
||
<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Please refer to the AN4839 <20>Level 1 cache on STM32F7 Series<65>
|
||
|
||
@par Directory contents
|
||
|
||
- BSP/Src/main.c Main program
|
||
- BSP/Src/system_stm32f7xx.c STM32f7xx system clock configuration file
|
||
- BSP/Src/stm32f7xx_it.c Interrupt handlers
|
||
- BSP/Src/lcd.c LCD drawing features
|
||
- BSP/Src/touchscreen.c Touch Screen features
|
||
- BSP/Src/log.c LCD Log firmware functions
|
||
- BSP/Src/sd.c SD features
|
||
- BSP/Src/eeprom.c EEPROM features
|
||
- BSP/Src/qspi.c QSPI features
|
||
- BSP/Src/audio.c Audio playback features
|
||
- BSP/Src/audio_rec_dfsdm.c DFSDM audio record features
|
||
- BSP/Inc/main.h Main program header file
|
||
- BSP/Inc/stm32f7xx_hal_conf.h HAL configuration file
|
||
- BSP/Inc/stm32f7xx_it.h Interrupt handlers header file
|
||
- BSP/Inc/lcd_log_conf.h lcd_log configuration template file
|
||
- BSP/Inc/stlogo.h Image used for BSP example
|
||
- BSP/Inc/perroquet.h Image used for BSP example
|
||
|
||
|
||
@par Hardware and Software environment
|
||
|
||
- This example runs on STM32F722xx/STM32F723xx/STM32F732xx/STM32F733xx devices.
|
||
|
||
- This example has been tested with STMicroelectronics STM32723E-DISCOVERY
|
||
board and can be easily tailored to any other supported device
|
||
and development board.
|
||
|
||
|
||
@par How to use it ?
|
||
|
||
- Use STLink utility, available on www.st.com or any other in-system programming
|
||
tool to load "BSP/Binary/audio_sample.bin" file to the STM32 internal flash
|
||
at the address 0x08040000.
|
||
|
||
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
|
||
@note Make sure that the tool flash loader does not erase or overwrite the
|
||
loaded audio file at address 0x08040000 by limiting the application
|
||
end address to 0x0803FFFF. This is already done for the example project
|
||
- Connect a headphone with a built-in microphone to the audio jack connector (CN5).
|
||
|
||
|
||
*/
|