Welcome to mirror list, hosted at ThFree Co, Russian Federation.

readme.txt « FLASH_WriteProtection « FLASH « Examples « P-NUCLEO-WB55.Nucleo « Projects - github.com/Flipper-Zero/STM32CubeWB.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: d04522cd26b5fac91568a296af2515739da974a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/**
  @page FLASH_WriteProtection FLASH write protection

  @verbatim
  ******************************************************************************
  * @file    FLASH/FLASH_WriteProtection/readme.txt
  * @author  MCD Application Team
  * @brief   Description of the FLASH write protection example.
  ******************************************************************************
  *
  * Copyright (c) 2019-2021 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

How to configure and use the FLASH HAL API to enable and disable the write
protection of 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.

  - If WRITE_PROTECTION_ENABLE is selected, the write protection will be enabled
    for the defined pages.
    To load the new option byte values, a system Reset is necessary, for this, the
    function HAL_FLASH_OB_Launch() is used.

  - If WRITE_PROTECTION_DISABLE is selected, the write protection will be disabled
    for the defined pages.
    To load the new option byte values, a system Reset is necessary, for this, the
    function HAL_FLASH_OB_Launch() is used.

  - If FLASH_PAGE_PROGRAM is selected, then an erase operation is done by filling
    the erase init structure giving the starting erase page and the number of
    pages to erase. At this stage, all these pages will be erased one by one separately.

    @note: if problem occurs on a page, erase will be stopped and faulty page 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.

P-NUCLEO-WB55 board's LED can be used to monitor the transfer status:
 - LED2 is ON when there are no errors detected after programming
    => should be the case when WRITE_PROTECTION_DISABLE flag is enabled
 - LED1 is ON when there are errors detected after programming
    => should be the case when WRITE_PROTECTION_ENABLE flag is enabled
 - LED3 is ON when there is an issue during erase, program or OB 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 need to ensure that the SysTick time base is always set to 1 millisecond
      to have correct HAL operation.

@par Keywords

Memory, FLASH, write protection, AREA, Sector, Mass Erase

@par Directory contents

  - FLASH/FLASH_WriteProtection/Inc/stm32wbxx_hal_conf.h        HAL Configuration file
  - FLASH/FLASH_WriteProtection/Inc/stm32wbxx_it.h              Header for stm32wbxx_it.c
  - FLASH/FLASH_WriteProtection/Inc/main.h                      Header for main.c module
  - FLASH/FLASH_WriteProtection/Src/stm32wbxx_it.c              Interrupt handlers
  - FLASH/FLASH_WriteProtection/Src/main.c                      Main program
  - FLASH/FLASH_WriteProtection/Src/stm32wbxx_hal_msp.c         MSP initialization and de-initialization
  - FLASH/FLASH_WriteProtection/Src/system_stm32wbxx.c          STM32WBxx system clock configuration file

@par Hardware and Software environment

  - This example runs on STM32WB55xx devices.

  - This example has been tested with P-NUCLEO-WB55 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>&copy; COPYRIGHT STMicroelectronics</center></h3>
 */