Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Option Bytes Programming functions
[FLASHEx Exported Functions]
Option Bytes Programming functions. More...
Functions | |
| HAL_StatusTypeDef | HAL_FLASHEx_OBErase (void) |
| Erases the FLASH option bytes. | |
| HAL_StatusTypeDef | HAL_FLASHEx_OBProgram (FLASH_OBProgramInitTypeDef *pOBInit) |
| Program option bytes. | |
| void | HAL_FLASHEx_OBGetConfig (FLASH_OBProgramInitTypeDef *pOBInit) |
| Get the Option byte configuration. | |
| uint32_t | HAL_FLASHEx_OBGetUserData (uint32_t DATAAdress) |
| Get the Option byte user data. | |
Detailed Description
Option Bytes Programming functions.
==============================================================================
##### Option Bytes Programming functions #####
==============================================================================
[..]
This subsection provides a set of functions allowing to control the FLASH
option bytes operations.
Function Documentation
| HAL_StatusTypeDef HAL_FLASHEx_OBErase | ( | void | ) |
Erases the FLASH option bytes.
- Note:
- This functions erases all option bytes except the Read protection (RDP). The function HAL_FLASH_Unlock() should be called before to unlock the FLASH interface The function HAL_FLASH_OB_Unlock() should be called before to unlock the options bytes The function HAL_FLASH_OB_Launch() should be called after to force the reload of the options bytes (system reset will occur)
- Return values:
-
HAL status
Definition at line 414 of file stm32f1xx_hal_flash_ex.c.
| void HAL_FLASHEx_OBGetConfig | ( | FLASH_OBProgramInitTypeDef * | pOBInit ) |
Get the Option byte configuration.
- Parameters:
-
pOBInit pointer to an FLASH_OBInitStruct structure that contains the configuration information for the programming.
- Return values:
-
None
Definition at line 544 of file stm32f1xx_hal_flash_ex.c.
| uint32_t HAL_FLASHEx_OBGetUserData | ( | uint32_t | DATAAdress ) |
Get the Option byte user data.
- Parameters:
-
DATAAdress Address of the option byte DATA This parameter can be one of the following values: - OB_DATA_ADDRESS_DATA0
- OB_DATA_ADDRESS_DATA1
- Return values:
-
Value programmed in USER data
Definition at line 566 of file stm32f1xx_hal_flash_ex.c.
| HAL_StatusTypeDef HAL_FLASHEx_OBProgram | ( | FLASH_OBProgramInitTypeDef * | pOBInit ) |
Program option bytes.
- Note:
- The function HAL_FLASH_Unlock() should be called before to unlock the FLASH interface The function HAL_FLASH_OB_Unlock() should be called before to unlock the options bytes The function HAL_FLASH_OB_Launch() should be called after to force the reload of the options bytes (system reset will occur)
- Parameters:
-
pOBInit pointer to an FLASH_OBInitStruct structure that contains the configuration information for the programming.
- Return values:
-
HAL_StatusTypeDef HAL Status
Definition at line 463 of file stm32f1xx_hal_flash_ex.c.
Generated on Tue Jul 12 2022 15:37:32 by
1.7.2