diff options
Diffstat (limited to 'Projects/NUCLEO-WB35CE/Examples/FLASH/FLASH_EraseProgram/readme.txt')
| -rw-r--r-- | Projects/NUCLEO-WB35CE/Examples/FLASH/FLASH_EraseProgram/readme.txt | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/Projects/NUCLEO-WB35CE/Examples/FLASH/FLASH_EraseProgram/readme.txt b/Projects/NUCLEO-WB35CE/Examples/FLASH/FLASH_EraseProgram/readme.txt new file mode 100644 index 000000000..9f7150e07 --- /dev/null +++ b/Projects/NUCLEO-WB35CE/Examples/FLASH/FLASH_EraseProgram/readme.txt @@ -0,0 +1,88 @@ +/** + @page FLASH_EraseProgram FLASH Erase and Program example + + @verbatim + ****************************************************************************** + * @file FLASH/FLASH_EraseProgram/readme.txt + * @author MCD Application Team + * @brief Description of the FLASH Erase and Program example. + ****************************************************************************** + * + * Copyright (c) 2019 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 + +How to configure and use the FLASH HAL API to erase and program the internal +Flash memory. + +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 64 MHz. + +After Reset, the Flash memory Program/Erase Controller is locked. A dedicated function +is used to enable the FLASH control register access. +Before programming the desired addresses, an erase operation is performed using +the flash erase feature. The erase procedure is done by filling the erase init +structure giving the starting erase and the number of s to erase. +At this stage, all these s will be erased one by one separately. + +@note: if problem occurs on a , erase will be stopped and faulty will +be returned to user (through variable 'PageError'). + +Once this operation is finished, double-word programming operation will be performed +in the Flash memory. The written data is then read back and checked. + +The NUCLEO-WB35CE board LEDs can be used to monitor the transfer status: + - LED2 is ON when there are no errors detected after data programming + - LED1 is ON when there are errors detected after data programming + - LED3 is ON when there is an issue during erase or program procedure + +@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 needs to ensure that the SysTick time base is always set to 1 millisecond + to have correct HAL operation. + +@par Keywords + +Memory, FLASH, Erase, Program, Sector, Mass Erase + +@par Directory contents + + - FLASH/FLASH_EraseProgram/Inc/stm32wbxx_hal_conf.h HAL Configuration file + - FLASH/FLASH_EraseProgram/Inc/stm32wbxx_it.h Header for stm32wbxx_it.c + - FLASH/FLASH_EraseProgram/Inc/main.h Header for main.c module + - FLASH/FLASH_EraseProgram/Src/stm32wbxx_it.c Interrupt handlers + - FLASH/FLASH_EraseProgram/Src/main.c Main program + - FLASH/FLASH_EraseProgram/Src/stm32wbxx_hal_msp.c MSP initialization and de-initialization + - FLASH/FLASH_EraseProgram/Src/system_stm32wbxx.c STM32WBxx system clock configuration file + +@par Hardware and Software environment + + - This example runs on STM32WB35CEUx devices. + + - This example has been tested with NUCLEO-WB35CE board 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> + */ |