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

#include "stm32f4xx_hal.h"

Include dependency graph for stm32f4xx_hal_flash.c:

Macros
#define	FLASH_TIMEOUT_VALUE 50000U /* 50 s */

Functions
static void	FLASH_Program_DoubleWord (uint32_t Address, uint64_t Data)
	Program a double word (64-bit) at a specified address.

static void	FLASH_Program_Word (uint32_t Address, uint32_t Data)
	Program word (32-bit) at a specified address.

static void	FLASH_Program_HalfWord (uint32_t Address, uint16_t Data)
	Program a half-word (16-bit) at a specified address.

static void	FLASH_Program_Byte (uint32_t Address, uint8_t Data)
	Program byte (8-bit) at a specified address.

static void	FLASH_SetErrorCode (void)
	Set the specific FLASH error flag.

HAL_StatusTypeDef	FLASH_WaitForLastOperation (uint32_t Timeout)
	Wait for a FLASH operation to complete.

HAL_StatusTypeDef	HAL_FLASH_Program (uint32_t TypeProgram, uint32_t Address, uint64_t Data)
	Program byte, halfword, word or double word at a specified address.

HAL_StatusTypeDef	HAL_FLASH_Program_IT (uint32_t TypeProgram, uint32_t Address, uint64_t Data)
	Program byte, halfword, word or double word at a specified address with interrupt enabled.

void	HAL_FLASH_IRQHandler (void)
	This function handles FLASH interrupt request.

void	HAL_FLASH_EndOfOperationCallback (uint32_t ReturnValue)
	FLASH end of operation interrupt callback.

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.

Variables
FLASH_ProcessTypeDef	pFlash

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 AHB 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 memory interface accelerates code execution with a system of instruction
     prefetch and cache lines.

[..] The FLASH main features are:
    (+) Flash memory read operations
    (+) Flash memory program/erase operations
    (+) Read / write protections
    (+) Prefetch on I-Code
    (+) 64 cache lines of 128 bits on I-Code
    (+) 8 cache lines of 128 bits on D-Code


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

    (#) FLASH Memory IO Programming functions:
         (++) Lock and Unlock the FLASH interface using HAL_FLASH_Unlock() and
              HAL_FLASH_Lock() functions
         (++) Program functions: byte, half word, word and double word
         (++) 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()
         (++) Wait for last FLASH operation according to its status
         (++) Get error flag status by calling HAL_SetErrorCode()

  [..]
    In addition to these functions, this driver includes a set of macros allowing
    to handle the following operations:
     (+) Set the latency
     (+) Enable/Disable the prefetch buffer
     (+) Enable/Disable the Instruction cache and the Data cache
     (+) Reset the Instruction cache and the Data cache
     (+) Enable/Disable the FLASH interrupts
     (+) Monitor the FLASH flags status

Attention

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.

Definition in file stm32f4xx_hal_flash.c.

Macros

Functions

Variables

Detailed Description