STM32L4xx_HAL_Driver  1.14.0
stm32l4xx_hal_flash.h File Reference

Header file of FLASH HAL module. More...

Go to the source code of this file.

Data Structures

struct  FLASH_OBProgramInitTypeDef
 FLASH Option Bytes Program structure definition. More...
 
struct  FLASH_ProcessTypeDef
 FLASH handle Structure definition. More...
 

Enumerations

enum  FLASH_ProcedureTypeDef {
  FLASH_PROC_NONE = 0, FLASH_PROC_PAGE_ERASE, FLASH_PROC_MASS_ERASE, FLASH_PROC_PROGRAM,
  FLASH_PROC_PROGRAM_LAST
}
 FLASH Procedure structure definition. More...
 
enum  FLASH_CacheTypeDef { FLASH_CACHE_DISABLED = 0, FLASH_CACHE_ICACHE_ENABLED, FLASH_CACHE_DCACHE_ENABLED, FLASH_CACHE_ICACHE_DCACHE_ENABLED }
 FLASH Cache structure definition. More...
 

Functions

HAL_StatusTypeDef HAL_FLASH_Program (uint32_t TypeProgram, uint32_t Address, uint64_t Data)
 Program double word or fast program of a row at a specified address. More...
 
HAL_StatusTypeDef HAL_FLASH_Program_IT (uint32_t TypeProgram, uint32_t Address, uint64_t Data)
 Program double word or fast program of a row at a specified address with interrupt enabled. More...
 
void HAL_FLASH_IRQHandler (void)
 Handle FLASH interrupt request. More...
 
void HAL_FLASH_EndOfOperationCallback (uint32_t ReturnValue)
 FLASH end of operation interrupt callback. More...
 
void HAL_FLASH_OperationErrorCallback (uint32_t ReturnValue)
 FLASH operation error interrupt callback. More...
 
HAL_StatusTypeDef HAL_FLASH_Unlock (void)
 Unlock the FLASH control register access. More...
 
HAL_StatusTypeDef HAL_FLASH_Lock (void)
 Lock the FLASH control register access. More...
 
HAL_StatusTypeDef HAL_FLASH_OB_Unlock (void)
 Unlock the FLASH Option Bytes Registers access. More...
 
HAL_StatusTypeDef HAL_FLASH_OB_Lock (void)
 Lock the FLASH Option Bytes Registers access. More...
 
HAL_StatusTypeDef HAL_FLASH_OB_Launch (void)
 Launch the option byte loading. More...
 
uint32_t HAL_FLASH_GetError (void)
 Get the specific FLASH error flag. More...
 
HAL_StatusTypeDef FLASH_WaitForLastOperation (uint32_t Timeout)
 Wait for a FLASH operation to complete. More...
 

Variables

 C
 
FLASH_ProcessTypeDef pFlash
 Variable used for Program/Erase sectors under interruption. More...
 

Detailed Description

Header file of FLASH HAL module.

Author
MCD Application Team
Attention

© 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

Definition in file stm32l4xx_hal_flash.h.


Data Structure Documentation

◆ FLASH_OBProgramInitTypeDef

struct FLASH_OBProgramInitTypeDef

FLASH Option Bytes Program structure definition.

Definition at line 64 of file stm32l4xx_hal_flash.h.

Data Fields
uint32_t OptionType

Option byte to be configured. This parameter can be a combination of the values of FLASH Option Bytes Type

uint32_t PCROPConfig

Configuration of the PCROP (used for OPTIONBYTE_PCROP). This parameter must be a combination of FLASH Banks (except FLASH_BANK_BOTH) and FLASH Option Bytes PCROP On RDP Level Type

uint32_t PCROPEndAddr

PCROP End address (used for OPTIONBYTE_PCROP). This parameter must be a value between PCROP Start address and end of bank

uint32_t PCROPStartAddr

PCROP Start address (used for OPTIONBYTE_PCROP). This parameter must be a value between begin and end of bank => Be careful of the bank swapping for the address

uint32_t RDPLevel

Set the read protection level.. (used for OPTIONBYTE_RDP). This parameter can be a value of FLASH Option Bytes Read Protection

uint32_t USERConfig

Value of the user option byte (used for OPTIONBYTE_USER). This parameter can be a combination of FLASH Option Bytes User BOR Level, FLASH Option Bytes User Reset On Stop, FLASH Option Bytes User Reset On Standby, FLASH Option Bytes User Reset On Shutdown, FLASH Option Bytes User IWDG Type, FLASH Option Bytes User IWDG Mode On Stop, FLASH Option Bytes User IWDG Mode On Standby, FLASH Option Bytes User WWDG Type, FLASH Option Bytes User BFB2 Mode, FLASH Option Bytes User Dual-bank Type, FLASH Option Bytes User BOOT1 Type, FLASH Option Bytes User SRAM2 Parity Check Type and FLASH Option Bytes User SRAM2 Erase On Reset Type

uint32_t USERType

User option byte(s) to be configured (used for OPTIONBYTE_USER). This parameter can be a combination of FLASH Option Bytes User Type

uint32_t WRPArea

Write protection area to be programmed (used for OPTIONBYTE_WRP). Only one WRP area could be programmed at the same time. This parameter can be value of FLASH WRP Area

uint32_t WRPEndOffset

Write protection end offset (used for OPTIONBYTE_WRP). This parameter must be a value between WRPStartOffset and (max number of pages in the bank - 1)

uint32_t WRPStartOffset

Write protection start offset (used for OPTIONBYTE_WRP). This parameter must be a value between 0 and (max number of pages in the bank - 1) (eg : 25 for 1MB dual bank)

◆ FLASH_ProcessTypeDef

struct FLASH_ProcessTypeDef

FLASH handle Structure definition.

Definition at line 124 of file stm32l4xx_hal_flash.h.

Data Fields
__IO uint32_t Address
__IO uint32_t Bank
__IO FLASH_CacheTypeDef CacheToReactivate
__IO uint32_t ErrorCode
HAL_LockTypeDef Lock
__IO uint32_t NbPagesToErase
__IO uint32_t Page
__IO FLASH_ProcedureTypeDef ProcedureOnGoing

Enumeration Type Documentation

◆ FLASH_CacheTypeDef

FLASH Cache structure definition.

Enumerator
FLASH_CACHE_DISABLED 
FLASH_CACHE_ICACHE_ENABLED 
FLASH_CACHE_DCACHE_ENABLED 
FLASH_CACHE_ICACHE_DCACHE_ENABLED 

Definition at line 113 of file stm32l4xx_hal_flash.h.

◆ FLASH_ProcedureTypeDef

FLASH Procedure structure definition.

Enumerator
FLASH_PROC_NONE 
FLASH_PROC_PAGE_ERASE 
FLASH_PROC_MASS_ERASE 
FLASH_PROC_PROGRAM 
FLASH_PROC_PROGRAM_LAST 

Definition at line 101 of file stm32l4xx_hal_flash.h.

Variable Documentation

◆ C

C
Initial value:
{
#endif
typedef struct
{
uint32_t TypeErase;
uint32_t Banks;
uint32_t Page;
uint32_t NbPages;
} FLASH_EraseInitTypeDef
This file contains HAL common defines, enumeration, macros and structures definitions.