stm32h7xx_hal_flash.c File Reference

Detailed Description

FLASH HAL module driver. This file provides firmware functions to manage the following functionalities of the internal FLASH memory:

Author

MCD Application Team

• Program operations functions
• Memory Control functions
• Peripheral Errors functions

 ==============================================================================
                       ##### FLASH peripheral features #####
 ==============================================================================

 [..] The Flash memory interface manages CPU AXI I-Code and D-Code accesses
      to the Flash memory. It implements the erase and program Flash memory operations
      and the read and write protection mechanisms.

 [..] The FLASH main features are:
     (+) Flash memory read operations
     (+) Flash memory program/erase operations
     (+) Read / write protections
     (+) Option bytes programming
     (+) Error code correction (ECC) : Data in flash are 266-bits word
         (10 bits added per flash word)

                       ##### How to use this driver #####
==============================================================================
   [..]
     This driver provides functions and macros to configure and program the FLASH
     memory of all STM32H7xx devices.

     (#) FLASH Memory IO Programming functions:
          (++) Lock and Unlock the FLASH interface using HAL_FLASH_Unlock() and
               HAL_FLASH_Lock() functions
          (++) Program functions: 256-bit word only
          (++) There Two modes of programming :
           (+++) Polling mode using HAL_FLASH_Program() function
           (+++) Interrupt mode using HAL_FLASH_Program_IT() function

     (#) Interrupts and flags management functions :
          (++) Handle FLASH interrupts by calling HAL_FLASH_IRQHandler()
          (++) Callback functions are called when the flash operations are finished :
               HAL_FLASH_EndOfOperationCallback() when everything is ok, otherwise
               HAL_FLASH_OperationErrorCallback()
          (++) Get error flag status by calling HAL_FLASH_GetError()

     (#) Option bytes management functions :
          (++) Lock and Unlock the option bytes using HAL_FLASH_OB_Unlock() and
               HAL_FLASH_OB_Lock() functions
          (++) Launch the reload of the option bytes using HAL_FLASH_OB_Launch() function.
               In this case, a reset is generated
   [..]
     In addition to these functions, this driver includes a set of macros allowing
     to handle the following operations:
      (+) Set the latency
      (+) Enable/Disable the FLASH interrupts
      (+) Monitor the FLASH flags status
    [..]
   (@) For any Flash memory program operation (erase or program), the CPU clock frequency
       (HCLK) must be at least 1MHz.
   (@) The contents of the Flash memory are not guaranteed if a device reset occurs during
       a Flash memory operation.
   (@) The application can simultaneously request a read and a write operation through each AXI
       interface.
       As the Flash memory is divided into two independent banks, the embedded Flash
       memory interface can drive different operations at the same time on each bank. For
       example a read, write or erase operation can be executed on bank 1 while another read,
       write or erase operation is executed on bank 2.

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 stm32h7xx_hal_flash.c.

Functions
HAL_StatusTypeDef	HAL_FLASH_Program (uint32_t TypeProgram, uint32_t FlashAddress, uint32_t DataAddress)
	Program flash word at a specified address.
HAL_StatusTypeDef	HAL_FLASH_Program_IT (uint32_t TypeProgram, uint32_t FlashAddress, uint32_t DataAddress)
	Program flash words of 256 bits at a specified address with interrupt enabled.
void	HAL_FLASH_IRQHandler (void)
	This function handles FLASH interrupt request.
__weak void	HAL_FLASH_EndOfOperationCallback (uint32_t ReturnValue)
	FLASH end of operation interrupt callback.
__weak void	HAL_FLASH_OperationErrorCallback (uint32_t ReturnValue)
	FLASH operation error interrupt callback.
HAL_StatusTypeDef	HAL_FLASH_Unlock (void)
	Unlock the FLASH control register access.
HAL_StatusTypeDef	HAL_FLASH_Lock (void)
	Locks the FLASH control register access.
HAL_StatusTypeDef	HAL_FLASH_OB_Unlock (void)
	Unlock the FLASH Option Control Registers access.
HAL_StatusTypeDef	HAL_FLASH_OB_Lock (void)
	Lock the FLASH Option Control Registers access.
HAL_StatusTypeDef	HAL_FLASH_OB_Launch (void)
	Launch the option byte loading.
uint32_t	HAL_FLASH_GetError (void)
	Get the specific FLASH error flag.
HAL_StatusTypeDef	FLASH_WaitForLastOperation (uint32_t Timeout, uint32_t Bank)
	Wait for a FLASH operation to complete.
HAL_StatusTypeDef	FLASH_OB_WaitForLastOperation (uint32_t Timeout)
	Wait for a FLASH Option Bytes change operation to complete.
HAL_StatusTypeDef	FLASH_CRC_WaitForLastOperation (uint32_t Timeout, uint32_t Bank)
	Wait for a FLASH CRC computation to complete.

Variables
FLASH_ProcessTypeDef	pFlash

Go to the source code of this file.