1 /******************** (C) COPYRIGHT 2008 STMicroelectronics ********************
\r
2 * File Name : stm32f10x_flash.h
\r
3 * Author : MCD Application Team
\r
6 * Description : This file contains all the functions prototypes for the
\r
7 * FLASH firmware library.
\r
8 ********************************************************************************
\r
9 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
\r
10 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME.
\r
11 * AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT,
\r
12 * INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE
\r
13 * CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING
\r
14 * INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
\r
15 *******************************************************************************/
\r
17 /* Define to prevent recursive inclusion -------------------------------------*/
\r
18 #ifndef __STM32F10x_FLASH_H
\r
19 #define __STM32F10x_FLASH_H
\r
21 /* Includes ------------------------------------------------------------------*/
\r
22 #include "stm32f10x_map.h"
\r
24 /* Exported types ------------------------------------------------------------*/
\r
37 /* Flash Latency -------------------------------------------------------------*/
\r
38 #define FLASH_Latency_0 ((u32)0x00000000) /* FLASH Zero Latency cycle */
\r
39 #define FLASH_Latency_1 ((u32)0x00000001) /* FLASH One Latency cycle */
\r
40 #define FLASH_Latency_2 ((u32)0x00000002) /* FLASH Two Latency cycles */
\r
42 #define IS_FLASH_LATENCY(LATENCY) (((LATENCY) == FLASH_Latency_0) || \
\r
43 ((LATENCY) == FLASH_Latency_1) || \
\r
44 ((LATENCY) == FLASH_Latency_2))
\r
46 /* Half Cycle Enable/Disable -------------------------------------------------*/
\r
47 #define FLASH_HalfCycleAccess_Enable ((u32)0x00000008) /* FLASH Half Cycle Enable */
\r
48 #define FLASH_HalfCycleAccess_Disable ((u32)0x00000000) /* FLASH Half Cycle Disable */
\r
50 #define IS_FLASH_HALFCYCLEACCESS_STATE(STATE) (((STATE) == FLASH_HalfCycleAccess_Enable) || \
\r
51 ((STATE) == FLASH_HalfCycleAccess_Disable))
\r
54 /* Prefetch Buffer Enable/Disable --------------------------------------------*/
\r
55 #define FLASH_PrefetchBuffer_Enable ((u32)0x00000010) /* FLASH Prefetch Buffer Enable */
\r
56 #define FLASH_PrefetchBuffer_Disable ((u32)0x00000000) /* FLASH Prefetch Buffer Disable */
\r
58 #define IS_FLASH_PREFETCHBUFFER_STATE(STATE) (((STATE) == FLASH_PrefetchBuffer_Enable) || \
\r
59 ((STATE) == FLASH_PrefetchBuffer_Disable))
\r
62 /* Option Bytes Write Protection ---------------------------------------------*/
\r
63 /* Values to be used with STM32F10Xxx Medium-density devices: FLASH memory density
\r
64 ranges between 32 and 128 Kbytes with page size equal to 1 Kbytes */
\r
65 #define FLASH_WRProt_Pages0to3 ((u32)0x00000001) /* Write protection of page 0 to 3 */
\r
66 #define FLASH_WRProt_Pages4to7 ((u32)0x00000002) /* Write protection of page 4 to 7 */
\r
67 #define FLASH_WRProt_Pages8to11 ((u32)0x00000004) /* Write protection of page 8 to 11 */
\r
68 #define FLASH_WRProt_Pages12to15 ((u32)0x00000008) /* Write protection of page 12 to 15 */
\r
69 #define FLASH_WRProt_Pages16to19 ((u32)0x00000010) /* Write protection of page 16 to 19 */
\r
70 #define FLASH_WRProt_Pages20to23 ((u32)0x00000020) /* Write protection of page 20 to 23 */
\r
71 #define FLASH_WRProt_Pages24to27 ((u32)0x00000040) /* Write protection of page 24 to 27 */
\r
72 #define FLASH_WRProt_Pages28to31 ((u32)0x00000080) /* Write protection of page 28 to 31 */
\r
73 #define FLASH_WRProt_Pages32to35 ((u32)0x00000100) /* Write protection of page 32 to 35 */
\r
74 #define FLASH_WRProt_Pages36to39 ((u32)0x00000200) /* Write protection of page 36 to 39 */
\r
75 #define FLASH_WRProt_Pages40to43 ((u32)0x00000400) /* Write protection of page 40 to 43 */
\r
76 #define FLASH_WRProt_Pages44to47 ((u32)0x00000800) /* Write protection of page 44 to 47 */
\r
77 #define FLASH_WRProt_Pages48to51 ((u32)0x00001000) /* Write protection of page 48 to 51 */
\r
78 #define FLASH_WRProt_Pages52to55 ((u32)0x00002000) /* Write protection of page 52 to 55 */
\r
79 #define FLASH_WRProt_Pages56to59 ((u32)0x00004000) /* Write protection of page 56 to 59 */
\r
80 #define FLASH_WRProt_Pages60to63 ((u32)0x00008000) /* Write protection of page 60 to 63 */
\r
81 #define FLASH_WRProt_Pages64to67 ((u32)0x00010000) /* Write protection of page 64 to 67 */
\r
82 #define FLASH_WRProt_Pages68to71 ((u32)0x00020000) /* Write protection of page 68 to 71 */
\r
83 #define FLASH_WRProt_Pages72to75 ((u32)0x00040000) /* Write protection of page 72 to 75 */
\r
84 #define FLASH_WRProt_Pages76to79 ((u32)0x00080000) /* Write protection of page 76 to 79 */
\r
85 #define FLASH_WRProt_Pages80to83 ((u32)0x00100000) /* Write protection of page 80 to 83 */
\r
86 #define FLASH_WRProt_Pages84to87 ((u32)0x00200000) /* Write protection of page 84 to 87 */
\r
87 #define FLASH_WRProt_Pages88to91 ((u32)0x00400000) /* Write protection of page 88 to 91 */
\r
88 #define FLASH_WRProt_Pages92to95 ((u32)0x00800000) /* Write protection of page 92 to 95 */
\r
89 #define FLASH_WRProt_Pages96to99 ((u32)0x01000000) /* Write protection of page 96 to 99 */
\r
90 #define FLASH_WRProt_Pages100to103 ((u32)0x02000000) /* Write protection of page 100 to 103 */
\r
91 #define FLASH_WRProt_Pages104to107 ((u32)0x04000000) /* Write protection of page 104 to 107 */
\r
92 #define FLASH_WRProt_Pages108to111 ((u32)0x08000000) /* Write protection of page 108 to 111 */
\r
93 #define FLASH_WRProt_Pages112to115 ((u32)0x10000000) /* Write protection of page 112 to 115 */
\r
94 #define FLASH_WRProt_Pages116to119 ((u32)0x20000000) /* Write protection of page 115 to 119 */
\r
95 #define FLASH_WRProt_Pages120to123 ((u32)0x40000000) /* Write protection of page 120 to 123 */
\r
96 #define FLASH_WRProt_Pages124to127 ((u32)0x80000000) /* Write protection of page 124 to 127 */
\r
97 /* Values to be used with STM32F10Xxx High-density devices: FLASH memory density
\r
98 ranges between 256 and 512 Kbytes with page size equal to 2 Kbytes */
\r
99 #define FLASH_WRProt_Pages0to1 ((u32)0x00000001) /* Write protection of page 0 to 1 */
\r
100 #define FLASH_WRProt_Pages2to3 ((u32)0x00000002) /* Write protection of page 2 to 3 */
\r
101 #define FLASH_WRProt_Pages4to5 ((u32)0x00000004) /* Write protection of page 4 to 5 */
\r
102 #define FLASH_WRProt_Pages6to7 ((u32)0x00000008) /* Write protection of page 6 to 7 */
\r
103 #define FLASH_WRProt_Pages8to9 ((u32)0x00000010) /* Write protection of page 8 to 9 */
\r
104 #define FLASH_WRProt_Pages10to11 ((u32)0x00000020) /* Write protection of page 10 to 11 */
\r
105 #define FLASH_WRProt_Pages12to13 ((u32)0x00000040) /* Write protection of page 12 to 13 */
\r
106 #define FLASH_WRProt_Pages14to15 ((u32)0x00000080) /* Write protection of page 14 to 15 */
\r
107 #define FLASH_WRProt_Pages16to17 ((u32)0x00000100) /* Write protection of page 16 to 17 */
\r
108 #define FLASH_WRProt_Pages18to19 ((u32)0x00000200) /* Write protection of page 18 to 19 */
\r
109 #define FLASH_WRProt_Pages20to21 ((u32)0x00000400) /* Write protection of page 20 to 21 */
\r
110 #define FLASH_WRProt_Pages22to23 ((u32)0x00000800) /* Write protection of page 22 to 23 */
\r
111 #define FLASH_WRProt_Pages24to25 ((u32)0x00001000) /* Write protection of page 24 to 25 */
\r
112 #define FLASH_WRProt_Pages26to27 ((u32)0x00002000) /* Write protection of page 26 to 27 */
\r
113 #define FLASH_WRProt_Pages28to29 ((u32)0x00004000) /* Write protection of page 28 to 29 */
\r
114 #define FLASH_WRProt_Pages30to31 ((u32)0x00008000) /* Write protection of page 30 to 31 */
\r
115 #define FLASH_WRProt_Pages32to33 ((u32)0x00010000) /* Write protection of page 32 to 33 */
\r
116 #define FLASH_WRProt_Pages34to35 ((u32)0x00020000) /* Write protection of page 34 to 35 */
\r
117 #define FLASH_WRProt_Pages36to37 ((u32)0x00040000) /* Write protection of page 36 to 37 */
\r
118 #define FLASH_WRProt_Pages38to39 ((u32)0x00080000) /* Write protection of page 38 to 39 */
\r
119 #define FLASH_WRProt_Pages40to41 ((u32)0x00100000) /* Write protection of page 40 to 41 */
\r
120 #define FLASH_WRProt_Pages42to43 ((u32)0x00200000) /* Write protection of page 42 to 43 */
\r
121 #define FLASH_WRProt_Pages44to45 ((u32)0x00400000) /* Write protection of page 44 to 45 */
\r
122 #define FLASH_WRProt_Pages46to47 ((u32)0x00800000) /* Write protection of page 46 to 47 */
\r
123 #define FLASH_WRProt_Pages48to49 ((u32)0x01000000) /* Write protection of page 48 to 49 */
\r
124 #define FLASH_WRProt_Pages50to51 ((u32)0x02000000) /* Write protection of page 50 to 51 */
\r
125 #define FLASH_WRProt_Pages52to53 ((u32)0x04000000) /* Write protection of page 52 to 53 */
\r
126 #define FLASH_WRProt_Pages54to55 ((u32)0x08000000) /* Write protection of page 54 to 55 */
\r
127 #define FLASH_WRProt_Pages56to57 ((u32)0x10000000) /* Write protection of page 56 to 57 */
\r
128 #define FLASH_WRProt_Pages58to59 ((u32)0x20000000) /* Write protection of page 58 to 59 */
\r
129 #define FLASH_WRProt_Pages60to61 ((u32)0x40000000) /* Write protection of page 60 to 61 */
\r
130 #define FLASH_WRProt_Pages62to255 ((u32)0x80000000) /* Write protection of page 62 to 255 */
\r
131 #define FLASH_WRProt_AllPages ((u32)0xFFFFFFFF) /* Write protection of all Pages */
\r
133 #define IS_FLASH_WRPROT_PAGE(PAGE) (((PAGE) != 0x00000000))
\r
135 #define IS_FLASH_ADDRESS(ADDRESS) (((ADDRESS) >= 0x08000000) && ((ADDRESS) < 0x0807FFFF))
\r
136 #define IS_OB_DATA_ADDRESS(ADDRESS) (((ADDRESS) == 0x1FFFF804) || ((ADDRESS) == 0x1FFFF806))
\r
138 /* Option Bytes IWatchdog ----------------------------------------------------*/
\r
139 #define OB_IWDG_SW ((u16)0x0001) /* Software IWDG selected */
\r
140 #define OB_IWDG_HW ((u16)0x0000) /* Hardware IWDG selected */
\r
142 #define IS_OB_IWDG_SOURCE(SOURCE) (((SOURCE) == OB_IWDG_SW) || ((SOURCE) == OB_IWDG_HW))
\r
144 /* Option Bytes nRST_STOP ----------------------------------------------------*/
\r
145 #define OB_STOP_NoRST ((u16)0x0002) /* No reset generated when entering in STOP */
\r
146 #define OB_STOP_RST ((u16)0x0000) /* Reset generated when entering in STOP */
\r
148 #define IS_OB_STOP_SOURCE(SOURCE) (((SOURCE) == OB_STOP_NoRST) || ((SOURCE) == OB_STOP_RST))
\r
150 /* Option Bytes nRST_STDBY ---------------------------------------------------*/
\r
151 #define OB_STDBY_NoRST ((u16)0x0004) /* No reset generated when entering in STANDBY */
\r
152 #define OB_STDBY_RST ((u16)0x0000) /* Reset generated when entering in STANDBY */
\r
154 #define IS_OB_STDBY_SOURCE(SOURCE) (((SOURCE) == OB_STDBY_NoRST) || ((SOURCE) == OB_STDBY_RST))
\r
156 /* FLASH Interrupts ----------------------------------------------------------*/
\r
157 #define FLASH_IT_ERROR ((u32)0x00000400) /* FPEC error interrupt source */
\r
158 #define FLASH_IT_EOP ((u32)0x00001000) /* End of FLASH Operation Interrupt source */
\r
160 #define IS_FLASH_IT(IT) ((((IT) & (u32)0xFFFFEBFF) == 0x00000000) && (((IT) != 0x00000000)))
\r
162 /* FLASH Flags ---------------------------------------------------------------*/
\r
163 #define FLASH_FLAG_BSY ((u32)0x00000001) /* FLASH Busy flag */
\r
164 #define FLASH_FLAG_EOP ((u32)0x00000020) /* FLASH End of Operation flag */
\r
165 #define FLASH_FLAG_PGERR ((u32)0x00000004) /* FLASH Program error flag */
\r
166 #define FLASH_FLAG_WRPRTERR ((u32)0x00000010) /* FLASH Write protected error flag */
\r
167 #define FLASH_FLAG_OPTERR ((u32)0x00000001) /* FLASH Option Byte error flag */
\r
169 #define IS_FLASH_CLEAR_FLAG(FLAG) ((((FLAG) & (u32)0xFFFFFFCA) == 0x00000000) && ((FLAG) != 0x00000000))
\r
171 #define IS_FLASH_GET_FLAG(FLAG) (((FLAG) == FLASH_FLAG_BSY) || ((FLAG) == FLASH_FLAG_EOP) || \
\r
172 ((FLAG) == FLASH_FLAG_PGERR) || ((FLAG) == FLASH_FLAG_WRPRTERR) || \
\r
173 ((FLAG) == FLASH_FLAG_OPTERR))
\r
176 /* Exported constants --------------------------------------------------------*/
\r
177 /* Exported macro ------------------------------------------------------------*/
\r
178 /* Exported functions ------------------------------------------------------- */
\r
179 void FLASH_SetLatency(u32 FLASH_Latency);
\r
180 void FLASH_HalfCycleAccessCmd(u32 FLASH_HalfCycleAccess);
\r
181 void FLASH_PrefetchBufferCmd(u32 FLASH_PrefetchBuffer);
\r
184 void FLASH_Unlock(void);
\r
185 void FLASH_Lock(void);
\r
186 FLASH_Status FLASH_ErasePage(u32 Page_Address);
\r
187 FLASH_Status FLASH_EraseAllPages(void);
\r
188 FLASH_Status FLASH_EraseOptionBytes(void);
\r
189 FLASH_Status FLASH_ProgramWord(u32 Address, u32 Data);
\r
190 FLASH_Status FLASH_ProgramHalfWord(u32 Address, u16 Data);
\r
191 FLASH_Status FLASH_ProgramOptionByteData(u32 Address, u8 Data);
\r
192 FLASH_Status FLASH_EnableWriteProtection(u32 FLASH_Pages);
\r
193 FLASH_Status FLASH_ReadOutProtection(FunctionalState NewState);
\r
194 FLASH_Status FLASH_UserOptionByteConfig(u16 OB_IWDG, u16 OB_STOP, u16 OB_STDBY);
\r
195 u32 FLASH_GetUserOptionByte(void);
\r
196 u32 FLASH_GetWriteProtectionOptionByte(void);
\r
197 FlagStatus FLASH_GetReadOutProtectionStatus(void);
\r
198 FlagStatus FLASH_GetPrefetchBufferStatus(void);
\r
199 void FLASH_ITConfig(u16 FLASH_IT, FunctionalState NewState);
\r
200 FlagStatus FLASH_GetFlagStatus(u16 FLASH_FLAG);
\r
201 void FLASH_ClearFlag(u16 FLASH_FLAG);
\r
202 FLASH_Status FLASH_GetStatus(void);
\r
203 FLASH_Status FLASH_WaitForLastOperation(u32 Timeout);
\r
206 #endif /* __STM32F10x_FLASH_H */
\r
208 /******************* (C) COPYRIGHT 2008 STMicroelectronics *****END OF FILE****/
\r
projects / freertos / blob