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