stm32f1xx_hal_flash.h File Reference

Header file of Flash HAL module. More...

#include "stm32f1xx_hal_def.h"
#include "stm32f1xx_hal_flash_ex.h"

Go to the source code of this file.

Data Structures
struct	FLASH_ProcessTypeDef
	FLASH handle Structure definition. More...
Defines
#define	FLASH_TIMEOUT_VALUE   50000U /* 50 s */
#define	IS_FLASH_TYPEPROGRAM(VALUE)
#define	IS_FLASH_LATENCY(__LATENCY__)
#define	HAL_FLASH_ERROR_NONE   0x00U
#define	HAL_FLASH_ERROR_PROG   0x01U
#define	HAL_FLASH_ERROR_WRP   0x02U
#define	HAL_FLASH_ERROR_OPTV   0x04U
#define	FLASH_TYPEPROGRAM_HALFWORD   0x01U
#define	FLASH_TYPEPROGRAM_WORD   0x02U
#define	FLASH_TYPEPROGRAM_DOUBLEWORD   0x03U
#define	FLASH_LATENCY_0   0x00000000U
#define	FLASH_LATENCY_1   FLASH_ACR_LATENCY_0
#define	FLASH_LATENCY_2   FLASH_ACR_LATENCY_1
#define	__HAL_FLASH_HALF_CYCLE_ACCESS_ENABLE()   (FLASH->ACR |= FLASH_ACR_HLFCYA)
	Enable the FLASH half cycle access.
#define	__HAL_FLASH_HALF_CYCLE_ACCESS_DISABLE()   (FLASH->ACR &= (~FLASH_ACR_HLFCYA))
	Disable the FLASH half cycle access.
#define	__HAL_FLASH_SET_LATENCY(__LATENCY__)   (FLASH->ACR = (FLASH->ACR&(~FLASH_ACR_LATENCY)) | (__LATENCY__))
	Set the FLASH Latency.
#define	__HAL_FLASH_GET_LATENCY()   (READ_BIT((FLASH->ACR), FLASH_ACR_LATENCY))
	Get the FLASH Latency.
#define	__HAL_FLASH_PREFETCH_BUFFER_ENABLE()   (FLASH->ACR |= FLASH_ACR_PRFTBE)
	Enable the FLASH prefetch buffer.
#define	__HAL_FLASH_PREFETCH_BUFFER_DISABLE()   (FLASH->ACR &= (~FLASH_ACR_PRFTBE))
	Disable the FLASH prefetch buffer.
Enumerations
enum	FLASH_ProcedureTypeDef {   FLASH_PROC_NONE = 0U, FLASH_PROC_PAGEERASE = 1U, FLASH_PROC_MASSERASE = 2U, FLASH_PROC_PROGRAMHALFWORD = 3U,   FLASH_PROC_PROGRAMWORD = 4U, FLASH_PROC_PROGRAMDOUBLEWORD = 5U }
	FLASH Procedure structure definition. More...
Functions
HAL_StatusTypeDef	HAL_FLASH_Program (uint32_t TypeProgram, uint32_t Address, uint64_t Data)
	Program 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 halfword, word or double word 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.
void	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)
	Wait for a FLASH operation to complete.

---

Detailed Description

Header file of Flash HAL module.

Author:

MCD Application Team

Attention:

© Copyright (c) 2016 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 stm32f1xx_hal_flash.h.