git.sur5r.net Git - freertos/blob - Demo/Common/drivers/ST/STM32F10xFWLib/inc/stm32f10x_flash.h

   1 /**\r
   2   ******************************************************************************\r
   3   * @file  stm32f10x_flash.h\r
   4   * @author  MCD Application Team\r
   5   * @version  V3.0.0\r
   6   * @date  04/06/2009\r
   7   * @brief  This file contains all the functions prototypes for the FLASH \r
   8   *         firmware library.\r
   9   ******************************************************************************\r
  10   * @copy\r
  11   *\r
  12   * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS\r
  13   * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE\r
  14   * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY\r
  15   * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING\r
  16   * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE\r
  17   * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.\r
  18   *\r
  19   * <h2><center>&copy; COPYRIGHT 2009 STMicroelectronics</center></h2>\r
  20   */ \r
  21 \r
  22 /* Define to prevent recursive inclusion -------------------------------------*/\r
  23 #ifndef __STM32F10x_FLASH_H\r
  24 #define __STM32F10x_FLASH_H\r
  25 \r
  26 /* Includes ------------------------------------------------------------------*/\r
  27 #include "stm32f10x.h"\r
  28 \r
  29 /** @addtogroup StdPeriph_Driver\r
  30   * @{\r
  31   */\r
  32 \r
  33 /** @addtogroup FLASH\r
  34   * @{\r
  35   */\r
  36 \r
  37 /** @defgroup FLASH_Exported_Types\r
  38   * @{\r
  39   */\r
  40 \r
  41 /** \r
  42   * @brief  FLASH Status  \r
  43   */\r
  44 \r
  45 typedef enum\r
  46 { \r
  47   FLASH_BUSY = 1,\r
  48   FLASH_ERROR_PG,\r
  49   FLASH_ERROR_WRP,\r
  50   FLASH_COMPLETE,\r
  51   FLASH_TIMEOUT\r
  52 }FLASH_Status;\r
  53 \r
  54 /**\r
  55   * @}\r
  56   */\r
  57 \r
  58 /** @defgroup FLASH_Exported_Constants\r
  59   * @{\r
  60   */\r
  61 \r
  62 /** @defgroup Flash_Latency \r
  63   * @{\r
  64   */\r
  65 \r
  66 #define FLASH_Latency_0                ((uint32_t)0x00000000)  /* FLASH Zero Latency cycle */\r
  67 #define FLASH_Latency_1                ((uint32_t)0x00000001)  /* FLASH One Latency cycle */\r
  68 #define FLASH_Latency_2                ((uint32_t)0x00000002)  /* FLASH Two Latency cycles */\r
  69 #define IS_FLASH_LATENCY(LATENCY) (((LATENCY) == FLASH_Latency_0) || \\r
  70                                    ((LATENCY) == FLASH_Latency_1) || \\r
  71                                    ((LATENCY) == FLASH_Latency_2))\r
  72 /**\r
  73   * @}\r
  74   */\r
  75 \r
  76 /** @defgroup Half_Cycle_Enable_Disable \r
  77   * @{\r
  78   */\r
  79 \r
  80 #define FLASH_HalfCycleAccess_Enable   ((uint32_t)0x00000008)  /* FLASH Half Cycle Enable */\r
  81 #define FLASH_HalfCycleAccess_Disable  ((uint32_t)0x00000000)  /* FLASH Half Cycle Disable */\r
  82 #define IS_FLASH_HALFCYCLEACCESS_STATE(STATE) (((STATE) == FLASH_HalfCycleAccess_Enable) || \\r
  83                                                ((STATE) == FLASH_HalfCycleAccess_Disable)) \r
  84 /**\r
  85   * @}\r
  86   */\r
  87 \r
  88 /** @defgroup Prefetch_Buffer_Enable_Disable \r
  89   * @{\r
  90   */\r
  91 \r
  92 #define FLASH_PrefetchBuffer_Enable    ((uint32_t)0x00000010)  /* FLASH Prefetch Buffer Enable */\r
  93 #define FLASH_PrefetchBuffer_Disable   ((uint32_t)0x00000000)  /* FLASH Prefetch Buffer Disable */\r
  94 #define IS_FLASH_PREFETCHBUFFER_STATE(STATE) (((STATE) == FLASH_PrefetchBuffer_Enable) || \\r
  95                                               ((STATE) == FLASH_PrefetchBuffer_Disable)) \r
  96 /**\r
  97   * @}\r
  98   */\r
  99 \r
 100 /** @defgroup Option_Bytes_Write_Protection \r
 101   * @{\r
 102   */\r
 103 \r
 104 /* Values to be used with STM32F10Xxx Medium-density devices: FLASH memory density\r
 105    ranges between 32 and 128 Kbytes with page size equal to 1 Kbytes */\r
 106 #define FLASH_WRProt_Pages0to3         ((uint32_t)0x00000001) /* Write protection of page 0 to 3 */\r
 107 #define FLASH_WRProt_Pages4to7         ((uint32_t)0x00000002) /* Write protection of page 4 to 7 */\r
 108 #define FLASH_WRProt_Pages8to11        ((uint32_t)0x00000004) /* Write protection of page 8 to 11 */\r
 109 #define FLASH_WRProt_Pages12to15       ((uint32_t)0x00000008) /* Write protection of page 12 to 15 */\r
 110 #define FLASH_WRProt_Pages16to19       ((uint32_t)0x00000010) /* Write protection of page 16 to 19 */\r
 111 #define FLASH_WRProt_Pages20to23       ((uint32_t)0x00000020) /* Write protection of page 20 to 23 */\r
 112 #define FLASH_WRProt_Pages24to27       ((uint32_t)0x00000040) /* Write protection of page 24 to 27 */\r
 113 #define FLASH_WRProt_Pages28to31       ((uint32_t)0x00000080) /* Write protection of page 28 to 31 */\r
 114 #define FLASH_WRProt_Pages32to35       ((uint32_t)0x00000100) /* Write protection of page 32 to 35 */\r
 115 #define FLASH_WRProt_Pages36to39       ((uint32_t)0x00000200) /* Write protection of page 36 to 39 */\r
 116 #define FLASH_WRProt_Pages40to43       ((uint32_t)0x00000400) /* Write protection of page 40 to 43 */\r
 117 #define FLASH_WRProt_Pages44to47       ((uint32_t)0x00000800) /* Write protection of page 44 to 47 */\r
 118 #define FLASH_WRProt_Pages48to51       ((uint32_t)0x00001000) /* Write protection of page 48 to 51 */\r
 119 #define FLASH_WRProt_Pages52to55       ((uint32_t)0x00002000) /* Write protection of page 52 to 55 */\r
 120 #define FLASH_WRProt_Pages56to59       ((uint32_t)0x00004000) /* Write protection of page 56 to 59 */\r
 121 #define FLASH_WRProt_Pages60to63       ((uint32_t)0x00008000) /* Write protection of page 60 to 63 */\r
 122 #define FLASH_WRProt_Pages64to67       ((uint32_t)0x00010000) /* Write protection of page 64 to 67 */\r
 123 #define FLASH_WRProt_Pages68to71       ((uint32_t)0x00020000) /* Write protection of page 68 to 71 */\r
 124 #define FLASH_WRProt_Pages72to75       ((uint32_t)0x00040000) /* Write protection of page 72 to 75 */\r
 125 #define FLASH_WRProt_Pages76to79       ((uint32_t)0x00080000) /* Write protection of page 76 to 79 */\r
 126 #define FLASH_WRProt_Pages80to83       ((uint32_t)0x00100000) /* Write protection of page 80 to 83 */\r
 127 #define FLASH_WRProt_Pages84to87       ((uint32_t)0x00200000) /* Write protection of page 84 to 87 */\r
 128 #define FLASH_WRProt_Pages88to91       ((uint32_t)0x00400000) /* Write protection of page 88 to 91 */\r
 129 #define FLASH_WRProt_Pages92to95       ((uint32_t)0x00800000) /* Write protection of page 92 to 95 */\r
 130 #define FLASH_WRProt_Pages96to99       ((uint32_t)0x01000000) /* Write protection of page 96 to 99 */\r
 131 #define FLASH_WRProt_Pages100to103     ((uint32_t)0x02000000) /* Write protection of page 100 to 103 */\r
 132 #define FLASH_WRProt_Pages104to107     ((uint32_t)0x04000000) /* Write protection of page 104 to 107 */\r
 133 #define FLASH_WRProt_Pages108to111     ((uint32_t)0x08000000) /* Write protection of page 108 to 111 */\r
 134 #define FLASH_WRProt_Pages112to115     ((uint32_t)0x10000000) /* Write protection of page 112 to 115 */\r
 135 #define FLASH_WRProt_Pages116to119     ((uint32_t)0x20000000) /* Write protection of page 115 to 119 */\r
 136 #define FLASH_WRProt_Pages120to123     ((uint32_t)0x40000000) /* Write protection of page 120 to 123 */\r
 137 #define FLASH_WRProt_Pages124to127     ((uint32_t)0x80000000) /* Write protection of page 124 to 127 */\r
 138 \r
 139 /* Values to be used with STM32F10Xxx High-density devices: FLASH memory density\r
 140    ranges between 256 and 512 Kbytes with page size equal to 2 Kbytes */\r
 141 #define FLASH_WRProt_Pages0to1         ((uint32_t)0x00000001) /* Write protection of page 0 to 1 */\r
 142 #define FLASH_WRProt_Pages2to3         ((uint32_t)0x00000002) /* Write protection of page 2 to 3 */\r
 143 #define FLASH_WRProt_Pages4to5         ((uint32_t)0x00000004) /* Write protection of page 4 to 5 */\r
 144 #define FLASH_WRProt_Pages6to7         ((uint32_t)0x00000008) /* Write protection of page 6 to 7 */\r
 145 #define FLASH_WRProt_Pages8to9         ((uint32_t)0x00000010) /* Write protection of page 8 to 9 */\r
 146 #define FLASH_WRProt_Pages10to11       ((uint32_t)0x00000020) /* Write protection of page 10 to 11 */\r
 147 #define FLASH_WRProt_Pages12to13       ((uint32_t)0x00000040) /* Write protection of page 12 to 13 */\r
 148 #define FLASH_WRProt_Pages14to15       ((uint32_t)0x00000080) /* Write protection of page 14 to 15 */\r
 149 #define FLASH_WRProt_Pages16to17       ((uint32_t)0x00000100) /* Write protection of page 16 to 17 */\r
 150 #define FLASH_WRProt_Pages18to19       ((uint32_t)0x00000200) /* Write protection of page 18 to 19 */\r
 151 #define FLASH_WRProt_Pages20to21       ((uint32_t)0x00000400) /* Write protection of page 20 to 21 */\r
 152 #define FLASH_WRProt_Pages22to23       ((uint32_t)0x00000800) /* Write protection of page 22 to 23 */\r
 153 #define FLASH_WRProt_Pages24to25       ((uint32_t)0x00001000) /* Write protection of page 24 to 25 */\r
 154 #define FLASH_WRProt_Pages26to27       ((uint32_t)0x00002000) /* Write protection of page 26 to 27 */\r
 155 #define FLASH_WRProt_Pages28to29       ((uint32_t)0x00004000) /* Write protection of page 28 to 29 */\r
 156 #define FLASH_WRProt_Pages30to31       ((uint32_t)0x00008000) /* Write protection of page 30 to 31 */\r
 157 #define FLASH_WRProt_Pages32to33       ((uint32_t)0x00010000) /* Write protection of page 32 to 33 */\r
 158 #define FLASH_WRProt_Pages34to35       ((uint32_t)0x00020000) /* Write protection of page 34 to 35 */\r
 159 #define FLASH_WRProt_Pages36to37       ((uint32_t)0x00040000) /* Write protection of page 36 to 37 */\r
 160 #define FLASH_WRProt_Pages38to39       ((uint32_t)0x00080000) /* Write protection of page 38 to 39 */\r
 161 #define FLASH_WRProt_Pages40to41       ((uint32_t)0x00100000) /* Write protection of page 40 to 41 */\r
 162 #define FLASH_WRProt_Pages42to43       ((uint32_t)0x00200000) /* Write protection of page 42 to 43 */\r
 163 #define FLASH_WRProt_Pages44to45       ((uint32_t)0x00400000) /* Write protection of page 44 to 45 */\r
 164 #define FLASH_WRProt_Pages46to47       ((uint32_t)0x00800000) /* Write protection of page 46 to 47 */\r
 165 #define FLASH_WRProt_Pages48to49       ((uint32_t)0x01000000) /* Write protection of page 48 to 49 */\r
 166 #define FLASH_WRProt_Pages50to51       ((uint32_t)0x02000000) /* Write protection of page 50 to 51 */\r
 167 #define FLASH_WRProt_Pages52to53       ((uint32_t)0x04000000) /* Write protection of page 52 to 53 */\r
 168 #define FLASH_WRProt_Pages54to55       ((uint32_t)0x08000000) /* Write protection of page 54 to 55 */\r
 169 #define FLASH_WRProt_Pages56to57       ((uint32_t)0x10000000) /* Write protection of page 56 to 57 */\r
 170 #define FLASH_WRProt_Pages58to59       ((uint32_t)0x20000000) /* Write protection of page 58 to 59 */\r
 171 #define FLASH_WRProt_Pages60to61       ((uint32_t)0x40000000) /* Write protection of page 60 to 61 */\r
 172 #define FLASH_WRProt_Pages62to255      ((uint32_t)0x80000000) /* Write protection of page 62 to 255 */\r
 173 #define FLASH_WRProt_AllPages          ((uint32_t)0xFFFFFFFF) /* Write protection of all Pages */\r
 174 \r
 175 #define IS_FLASH_WRPROT_PAGE(PAGE) (((PAGE) != 0x00000000))\r
 176 \r
 177 #define IS_FLASH_ADDRESS(ADDRESS) (((ADDRESS) >= 0x08000000) && ((ADDRESS) < 0x0807FFFF))\r
 178 \r
 179 #define IS_OB_DATA_ADDRESS(ADDRESS) (((ADDRESS) == 0x1FFFF804) || ((ADDRESS) == 0x1FFFF806))\r
 180 \r
 181 /**\r
 182   * @}\r
 183   */\r
 184 \r
 185 /** @defgroup Option_Bytes_IWatchdog \r
 186   * @{\r
 187   */\r
 188 \r
 189 #define OB_IWDG_SW                     ((uint16_t)0x0001)  /* Software IWDG selected */\r
 190 #define OB_IWDG_HW                     ((uint16_t)0x0000)  /* Hardware IWDG selected */\r
 191 #define IS_OB_IWDG_SOURCE(SOURCE) (((SOURCE) == OB_IWDG_SW) || ((SOURCE) == OB_IWDG_HW))\r
 192 \r
 193 /**\r
 194   * @}\r
 195   */\r
 196 \r
 197 /** @defgroup Option_Bytes_nRST_STOP \r
 198   * @{\r
 199   */\r
 200 \r
 201 #define OB_STOP_NoRST                  ((uint16_t)0x0002) /* No reset generated when entering in STOP */\r
 202 #define OB_STOP_RST                    ((uint16_t)0x0000) /* Reset generated when entering in STOP */\r
 203 #define IS_OB_STOP_SOURCE(SOURCE) (((SOURCE) == OB_STOP_NoRST) || ((SOURCE) == OB_STOP_RST))\r
 204 \r
 205 /**\r
 206   * @}\r
 207   */\r
 208 \r
 209 /** @defgroup Option_Bytes_nRST_STDBY \r
 210   * @{\r
 211   */\r
 212 \r
 213 #define OB_STDBY_NoRST                 ((uint16_t)0x0004) /* No reset generated when entering in STANDBY */\r
 214 #define OB_STDBY_RST                   ((uint16_t)0x0000) /* Reset generated when entering in STANDBY */\r
 215 #define IS_OB_STDBY_SOURCE(SOURCE) (((SOURCE) == OB_STDBY_NoRST) || ((SOURCE) == OB_STDBY_RST))\r
 216 \r
 217 /**\r
 218   * @}\r
 219   */\r
 220 \r
 221 /** @defgroup FLASH_Interrupts \r
 222   * @{\r
 223   */\r
 224 \r
 225 #define FLASH_IT_ERROR                 ((uint32_t)0x00000400)  /* FPEC error interrupt source */\r
 226 #define FLASH_IT_EOP                   ((uint32_t)0x00001000)  /* End of FLASH Operation Interrupt source */\r
 227 #define IS_FLASH_IT(IT) ((((IT) & (uint32_t)0xFFFFEBFF) == 0x00000000) && (((IT) != 0x00000000)))\r
 228 \r
 229 /**\r
 230   * @}\r
 231   */\r
 232 \r
 233 /** @defgroup FLASH_Flags \r
 234   * @{\r
 235   */\r
 236 \r
 237 #define FLASH_FLAG_BSY                 ((uint32_t)0x00000001)  /* FLASH Busy flag */\r
 238 #define FLASH_FLAG_EOP                 ((uint32_t)0x00000020)  /* FLASH End of Operation flag */\r
 239 #define FLASH_FLAG_PGERR               ((uint32_t)0x00000004)  /* FLASH Program error flag */\r
 240 #define FLASH_FLAG_WRPRTERR            ((uint32_t)0x00000010)  /* FLASH Write protected error flag */\r
 241 #define FLASH_FLAG_OPTERR              ((uint32_t)0x00000001)  /* FLASH Option Byte error flag */\r
 242  \r
 243 #define IS_FLASH_CLEAR_FLAG(FLAG) ((((FLAG) & (uint32_t)0xFFFFFFCA) == 0x00000000) && ((FLAG) != 0x00000000))\r
 244 #define IS_FLASH_GET_FLAG(FLAG)  (((FLAG) == FLASH_FLAG_BSY) || ((FLAG) == FLASH_FLAG_EOP) || \\r
 245                                   ((FLAG) == FLASH_FLAG_PGERR) || ((FLAG) == FLASH_FLAG_WRPRTERR) || \\r
 246                                   ((FLAG) == FLASH_FLAG_OPTERR))\r
 247 \r
 248 /**\r
 249   * @}\r
 250   */\r
 251 \r
 252 /**\r
 253   * @}\r
 254   */\r
 255 \r
 256 /** @defgroup FLASH_Exported_Macros\r
 257   * @{\r
 258   */\r
 259 \r
 260 /**\r
 261   * @}\r
 262   */\r
 263 \r
 264 /** @defgroup FLASH_Exported_Functions\r
 265   * @{\r
 266   */\r
 267 \r
 268 void FLASH_SetLatency(uint32_t FLASH_Latency);\r
 269 void FLASH_HalfCycleAccessCmd(uint32_t FLASH_HalfCycleAccess);\r
 270 void FLASH_PrefetchBufferCmd(uint32_t FLASH_PrefetchBuffer);\r
 271 void FLASH_Unlock(void);\r
 272 void FLASH_Lock(void);\r
 273 FLASH_Status FLASH_ErasePage(uint32_t Page_Address);\r
 274 FLASH_Status FLASH_EraseAllPages(void);\r
 275 FLASH_Status FLASH_EraseOptionBytes(void);\r
 276 FLASH_Status FLASH_ProgramWord(uint32_t Address, uint32_t Data);\r
 277 FLASH_Status FLASH_ProgramHalfWord(uint32_t Address, uint16_t Data);\r
 278 FLASH_Status FLASH_ProgramOptionByteData(uint32_t Address, uint8_t Data);\r
 279 FLASH_Status FLASH_EnableWriteProtection(uint32_t FLASH_Pages);\r
 280 FLASH_Status FLASH_ReadOutProtection(FunctionalState NewState);\r
 281 FLASH_Status FLASH_UserOptionByteConfig(uint16_t OB_IWDG, uint16_t OB_STOP, uint16_t OB_STDBY);\r
 282 uint32_t FLASH_GetUserOptionByte(void);\r
 283 uint32_t FLASH_GetWriteProtectionOptionByte(void);\r
 284 FlagStatus FLASH_GetReadOutProtectionStatus(void);\r
 285 FlagStatus FLASH_GetPrefetchBufferStatus(void);\r
 286 void FLASH_ITConfig(uint16_t FLASH_IT, FunctionalState NewState);\r
 287 FlagStatus FLASH_GetFlagStatus(uint16_t FLASH_FLAG);\r
 288 void FLASH_ClearFlag(uint16_t FLASH_FLAG);\r
 289 FLASH_Status FLASH_GetStatus(void);\r
 290 FLASH_Status FLASH_WaitForLastOperation(uint32_t Timeout);\r
 291 \r
 292 #endif /* __STM32F10x_FLASH_H */\r
 293 /**\r
 294   * @}\r
 295   */\r
 296 \r
 297 /**\r
 298   * @}\r
 299   */\r
 300 \r
 301 /**\r
 302   * @}\r
 303   */\r
 304 \r
 305 /******************* (C) COPYRIGHT 2009 STMicroelectronics *****END OF FILE****/\r