STM32F10x Standard Peripherals Library  3.5.0
/opt/STM32F10x_StdPeriph_Lib_V3.5.0/Libraries/STM32F10x_StdPeriph_Driver/inc/stm32f10x_flash.h File Reference

This file contains all the functions prototypes for the FLASH firmware library. More...

#include "stm32f10x.h"

Go to the source code of this file.

Defines

#define FLASH_Latency_0   ((uint32_t)0x00000000)
#define FLASH_Latency_1   ((uint32_t)0x00000001)
#define FLASH_Latency_2   ((uint32_t)0x00000002)
#define IS_FLASH_LATENCY(LATENCY)
#define FLASH_HalfCycleAccess_Enable   ((uint32_t)0x00000008)
#define FLASH_HalfCycleAccess_Disable   ((uint32_t)0x00000000)
#define IS_FLASH_HALFCYCLEACCESS_STATE(STATE)
#define FLASH_PrefetchBuffer_Enable   ((uint32_t)0x00000010)
#define FLASH_PrefetchBuffer_Disable   ((uint32_t)0x00000000)
#define IS_FLASH_PREFETCHBUFFER_STATE(STATE)
#define FLASH_WRProt_Pages0to3   ((uint32_t)0x00000001)
#define FLASH_WRProt_Pages4to7   ((uint32_t)0x00000002)
#define FLASH_WRProt_Pages8to11   ((uint32_t)0x00000004)
#define FLASH_WRProt_Pages12to15   ((uint32_t)0x00000008)
#define FLASH_WRProt_Pages16to19   ((uint32_t)0x00000010)
#define FLASH_WRProt_Pages20to23   ((uint32_t)0x00000020)
#define FLASH_WRProt_Pages24to27   ((uint32_t)0x00000040)
#define FLASH_WRProt_Pages28to31   ((uint32_t)0x00000080)
#define FLASH_WRProt_Pages32to35   ((uint32_t)0x00000100)
#define FLASH_WRProt_Pages36to39   ((uint32_t)0x00000200)
#define FLASH_WRProt_Pages40to43   ((uint32_t)0x00000400)
#define FLASH_WRProt_Pages44to47   ((uint32_t)0x00000800)
#define FLASH_WRProt_Pages48to51   ((uint32_t)0x00001000)
#define FLASH_WRProt_Pages52to55   ((uint32_t)0x00002000)
#define FLASH_WRProt_Pages56to59   ((uint32_t)0x00004000)
#define FLASH_WRProt_Pages60to63   ((uint32_t)0x00008000)
#define FLASH_WRProt_Pages64to67   ((uint32_t)0x00010000)
#define FLASH_WRProt_Pages68to71   ((uint32_t)0x00020000)
#define FLASH_WRProt_Pages72to75   ((uint32_t)0x00040000)
#define FLASH_WRProt_Pages76to79   ((uint32_t)0x00080000)
#define FLASH_WRProt_Pages80to83   ((uint32_t)0x00100000)
#define FLASH_WRProt_Pages84to87   ((uint32_t)0x00200000)
#define FLASH_WRProt_Pages88to91   ((uint32_t)0x00400000)
#define FLASH_WRProt_Pages92to95   ((uint32_t)0x00800000)
#define FLASH_WRProt_Pages96to99   ((uint32_t)0x01000000)
#define FLASH_WRProt_Pages100to103   ((uint32_t)0x02000000)
#define FLASH_WRProt_Pages104to107   ((uint32_t)0x04000000)
#define FLASH_WRProt_Pages108to111   ((uint32_t)0x08000000)
#define FLASH_WRProt_Pages112to115   ((uint32_t)0x10000000)
#define FLASH_WRProt_Pages116to119   ((uint32_t)0x20000000)
#define FLASH_WRProt_Pages120to123   ((uint32_t)0x40000000)
#define FLASH_WRProt_Pages124to127   ((uint32_t)0x80000000)
#define FLASH_WRProt_Pages0to1   ((uint32_t)0x00000001)
#define FLASH_WRProt_Pages2to3   ((uint32_t)0x00000002)
#define FLASH_WRProt_Pages4to5   ((uint32_t)0x00000004)
#define FLASH_WRProt_Pages6to7   ((uint32_t)0x00000008)
#define FLASH_WRProt_Pages8to9   ((uint32_t)0x00000010)
#define FLASH_WRProt_Pages10to11   ((uint32_t)0x00000020)
#define FLASH_WRProt_Pages12to13   ((uint32_t)0x00000040)
#define FLASH_WRProt_Pages14to15   ((uint32_t)0x00000080)
#define FLASH_WRProt_Pages16to17   ((uint32_t)0x00000100)
#define FLASH_WRProt_Pages18to19   ((uint32_t)0x00000200)
#define FLASH_WRProt_Pages20to21   ((uint32_t)0x00000400)
#define FLASH_WRProt_Pages22to23   ((uint32_t)0x00000800)
#define FLASH_WRProt_Pages24to25   ((uint32_t)0x00001000)
#define FLASH_WRProt_Pages26to27   ((uint32_t)0x00002000)
#define FLASH_WRProt_Pages28to29   ((uint32_t)0x00004000)
#define FLASH_WRProt_Pages30to31   ((uint32_t)0x00008000)
#define FLASH_WRProt_Pages32to33   ((uint32_t)0x00010000)
#define FLASH_WRProt_Pages34to35   ((uint32_t)0x00020000)
#define FLASH_WRProt_Pages36to37   ((uint32_t)0x00040000)
#define FLASH_WRProt_Pages38to39   ((uint32_t)0x00080000)
#define FLASH_WRProt_Pages40to41   ((uint32_t)0x00100000)
#define FLASH_WRProt_Pages42to43   ((uint32_t)0x00200000)
#define FLASH_WRProt_Pages44to45   ((uint32_t)0x00400000)
#define FLASH_WRProt_Pages46to47   ((uint32_t)0x00800000)
#define FLASH_WRProt_Pages48to49   ((uint32_t)0x01000000)
#define FLASH_WRProt_Pages50to51   ((uint32_t)0x02000000)
#define FLASH_WRProt_Pages52to53   ((uint32_t)0x04000000)
#define FLASH_WRProt_Pages54to55   ((uint32_t)0x08000000)
#define FLASH_WRProt_Pages56to57   ((uint32_t)0x10000000)
#define FLASH_WRProt_Pages58to59   ((uint32_t)0x20000000)
#define FLASH_WRProt_Pages60to61   ((uint32_t)0x40000000)
#define FLASH_WRProt_Pages62to127   ((uint32_t)0x80000000)
#define FLASH_WRProt_Pages62to255   ((uint32_t)0x80000000)
#define FLASH_WRProt_Pages62to511   ((uint32_t)0x80000000)
#define FLASH_WRProt_AllPages   ((uint32_t)0xFFFFFFFF)
#define IS_FLASH_WRPROT_PAGE(PAGE)   (((PAGE) != 0x00000000))
#define IS_FLASH_ADDRESS(ADDRESS)   (((ADDRESS) >= 0x08000000) && ((ADDRESS) < 0x080FFFFF))
#define IS_OB_DATA_ADDRESS(ADDRESS)   (((ADDRESS) == 0x1FFFF804) || ((ADDRESS) == 0x1FFFF806))
#define OB_IWDG_SW   ((uint16_t)0x0001)
#define OB_IWDG_HW   ((uint16_t)0x0000)
#define IS_OB_IWDG_SOURCE(SOURCE)   (((SOURCE) == OB_IWDG_SW) || ((SOURCE) == OB_IWDG_HW))
#define OB_STOP_NoRST   ((uint16_t)0x0002)
#define OB_STOP_RST   ((uint16_t)0x0000)
#define IS_OB_STOP_SOURCE(SOURCE)   (((SOURCE) == OB_STOP_NoRST) || ((SOURCE) == OB_STOP_RST))
#define OB_STDBY_NoRST   ((uint16_t)0x0004)
#define OB_STDBY_RST   ((uint16_t)0x0000)
#define IS_OB_STDBY_SOURCE(SOURCE)   (((SOURCE) == OB_STDBY_NoRST) || ((SOURCE) == OB_STDBY_RST))
#define FLASH_IT_ERROR   ((uint32_t)0x00000400)
#define FLASH_IT_EOP   ((uint32_t)0x00001000)
#define FLASH_IT_BANK1_ERROR   FLASH_IT_ERROR
#define FLASH_IT_BANK1_EOP   FLASH_IT_EOP
#define IS_FLASH_IT(IT)   ((((IT) & (uint32_t)0xFFFFEBFF) == 0x00000000) && (((IT) != 0x00000000)))
#define FLASH_FLAG_BSY   ((uint32_t)0x00000001)
#define FLASH_FLAG_EOP   ((uint32_t)0x00000020)
#define FLASH_FLAG_PGERR   ((uint32_t)0x00000004)
#define FLASH_FLAG_WRPRTERR   ((uint32_t)0x00000010)
#define FLASH_FLAG_OPTERR   ((uint32_t)0x00000001)
#define FLASH_FLAG_BANK1_BSY   FLASH_FLAG_BSY
#define FLASH_FLAG_BANK1_EOP   FLASH_FLAG_EOP
#define FLASH_FLAG_BANK1_PGERR   FLASH_FLAG_PGERR
#define FLASH_FLAG_BANK1_WRPRTERR   FLASH_FLAG_WRPRTERR
#define IS_FLASH_CLEAR_FLAG(FLAG)   ((((FLAG) & (uint32_t)0xFFFFFFCA) == 0x00000000) && ((FLAG) != 0x00000000))
#define IS_FLASH_GET_FLAG(FLAG)

Enumerations

enum  FLASH_Status {
  FLASH_BUSY = 1, FLASH_ERROR_PG, FLASH_ERROR_WRP, FLASH_COMPLETE,
  FLASH_TIMEOUT
}
 FLASH Status. More...

Functions

void FLASH_SetLatency (uint32_t FLASH_Latency)
 Sets the code latency value.
void FLASH_HalfCycleAccessCmd (uint32_t FLASH_HalfCycleAccess)
 Enables or disables the Half cycle flash access.
void FLASH_PrefetchBufferCmd (uint32_t FLASH_PrefetchBuffer)
 Enables or disables the Prefetch Buffer.
void FLASH_Unlock (void)
 Unlocks the FLASH Program Erase Controller.
void FLASH_Lock (void)
 Locks the FLASH Program Erase Controller.
FLASH_Status FLASH_ErasePage (uint32_t Page_Address)
 Erases a specified FLASH page.
FLASH_Status FLASH_EraseAllPages (void)
 Erases all FLASH pages.
FLASH_Status FLASH_EraseOptionBytes (void)
 Erases the FLASH option bytes.
FLASH_Status FLASH_ProgramWord (uint32_t Address, uint32_t Data)
 Programs a word at a specified address.
FLASH_Status FLASH_ProgramHalfWord (uint32_t Address, uint16_t Data)
 Programs a half word at a specified address.
FLASH_Status FLASH_ProgramOptionByteData (uint32_t Address, uint8_t Data)
 Programs a half word at a specified Option Byte Data address.
FLASH_Status FLASH_EnableWriteProtection (uint32_t FLASH_Pages)
 Write protects the desired pages.
FLASH_Status FLASH_ReadOutProtection (FunctionalState NewState)
 Enables or disables the read out protection.
FLASH_Status FLASH_UserOptionByteConfig (uint16_t OB_IWDG, uint16_t OB_STOP, uint16_t OB_STDBY)
 Programs the FLASH User Option Byte: IWDG_SW / RST_STOP / RST_STDBY.
uint32_t FLASH_GetUserOptionByte (void)
 Returns the FLASH User Option Bytes values.
uint32_t FLASH_GetWriteProtectionOptionByte (void)
 Returns the FLASH Write Protection Option Bytes Register value.
FlagStatus FLASH_GetReadOutProtectionStatus (void)
 Checks whether the FLASH Read Out Protection Status is set or not.
FlagStatus FLASH_GetPrefetchBufferStatus (void)
 Checks whether the FLASH Prefetch Buffer status is set or not.
void FLASH_ITConfig (uint32_t FLASH_IT, FunctionalState NewState)
 Enables or disables the specified FLASH interrupts.
FlagStatus FLASH_GetFlagStatus (uint32_t FLASH_FLAG)
 Checks whether the specified FLASH flag is set or not.
void FLASH_ClearFlag (uint32_t FLASH_FLAG)
 Clears the FLASH's pending flags.
FLASH_Status FLASH_GetStatus (void)
 Returns the FLASH Status.
FLASH_Status FLASH_WaitForLastOperation (uint32_t Timeout)
 Waits for a Flash operation to complete or a TIMEOUT to occur.
void FLASH_UnlockBank1 (void)
 Unlocks the FLASH Bank1 Program Erase Controller.
void FLASH_LockBank1 (void)
 Locks the FLASH Bank1 Program Erase Controller.
FLASH_Status FLASH_EraseAllBank1Pages (void)
 Erases all Bank1 FLASH pages.
FLASH_Status FLASH_GetBank1Status (void)
 Returns the FLASH Bank1 Status.
FLASH_Status FLASH_WaitForLastBank1Operation (uint32_t Timeout)
 Waits for a Flash operation on Bank1 to complete or a TIMEOUT to occur.

Detailed Description

This file contains all the functions prototypes for the FLASH firmware library.

Author:
MCD Application Team
Version:
V3.5.0
Date:
11-March-2011
Attention:

THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.

© COPYRIGHT 2011 STMicroelectronics

Definition in file stm32f10x_flash.h.