Ben Katz / mbed-dev_spine

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   SPIne CH_Communicatuin_Test CH_Communicatuin_Test2 MCP_SPIne ... more

Fork of mbed-dev-f303 by Ben Katz

targets/cmsis/TARGET_STM/TARGET_STM32F1/stm32f1xx_hal_flash.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Child:
124:6a4a5b7d7324
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 0:9b334a45a8ff 1 /**
bogdanm 0:9b334a45a8ff 2 ******************************************************************************
bogdanm 0:9b334a45a8ff 3 * @file stm32f1xx_hal_flash.h
bogdanm 0:9b334a45a8ff 4 * @author MCD Application Team
bogdanm 0:9b334a45a8ff 5 * @version V1.0.0
bogdanm 0:9b334a45a8ff 6 * @date 15-December-2014
bogdanm 0:9b334a45a8ff 7 * @brief Header file of Flash HAL module.
bogdanm 0:9b334a45a8ff 8 ******************************************************************************
bogdanm 0:9b334a45a8ff 9 * @attention
bogdanm 0:9b334a45a8ff 10 *
bogdanm 0:9b334a45a8ff 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
bogdanm 0:9b334a45a8ff 12 *
bogdanm 0:9b334a45a8ff 13 * Redistribution and use in source and binary forms, with or without modification,
bogdanm 0:9b334a45a8ff 14 * are permitted provided that the following conditions are met:
bogdanm 0:9b334a45a8ff 15 * 1. Redistributions of source code must retain the above copyright notice,
bogdanm 0:9b334a45a8ff 16 * this list of conditions and the following disclaimer.
bogdanm 0:9b334a45a8ff 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
bogdanm 0:9b334a45a8ff 18 * this list of conditions and the following disclaimer in the documentation
bogdanm 0:9b334a45a8ff 19 * and/or other materials provided with the distribution.
bogdanm 0:9b334a45a8ff 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
bogdanm 0:9b334a45a8ff 21 * may be used to endorse or promote products derived from this software
bogdanm 0:9b334a45a8ff 22 * without specific prior written permission.
bogdanm 0:9b334a45a8ff 23 *
bogdanm 0:9b334a45a8ff 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
bogdanm 0:9b334a45a8ff 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
bogdanm 0:9b334a45a8ff 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
bogdanm 0:9b334a45a8ff 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
bogdanm 0:9b334a45a8ff 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
bogdanm 0:9b334a45a8ff 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
bogdanm 0:9b334a45a8ff 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
bogdanm 0:9b334a45a8ff 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
bogdanm 0:9b334a45a8ff 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
bogdanm 0:9b334a45a8ff 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bogdanm 0:9b334a45a8ff 34 *
bogdanm 0:9b334a45a8ff 35 ******************************************************************************
bogdanm 0:9b334a45a8ff 36 */
bogdanm 0:9b334a45a8ff 37
bogdanm 0:9b334a45a8ff 38 /* Define to prevent recursive inclusion -------------------------------------*/
bogdanm 0:9b334a45a8ff 39 #ifndef __STM32F1xx_HAL_FLASH_H
bogdanm 0:9b334a45a8ff 40 #define __STM32F1xx_HAL_FLASH_H
bogdanm 0:9b334a45a8ff 41
bogdanm 0:9b334a45a8ff 42 #ifdef __cplusplus
bogdanm 0:9b334a45a8ff 43 extern "C" {
bogdanm 0:9b334a45a8ff 44 #endif
bogdanm 0:9b334a45a8ff 45
bogdanm 0:9b334a45a8ff 46 /* Includes ------------------------------------------------------------------*/
bogdanm 0:9b334a45a8ff 47 #include "stm32f1xx_hal_def.h"
bogdanm 0:9b334a45a8ff 48
bogdanm 0:9b334a45a8ff 49 /** @addtogroup STM32F1xx_HAL_Driver
bogdanm 0:9b334a45a8ff 50 * @{
bogdanm 0:9b334a45a8ff 51 */
bogdanm 0:9b334a45a8ff 52
bogdanm 0:9b334a45a8ff 53 /** @addtogroup FLASH
bogdanm 0:9b334a45a8ff 54 * @{
bogdanm 0:9b334a45a8ff 55 */
bogdanm 0:9b334a45a8ff 56
bogdanm 0:9b334a45a8ff 57 /** @addtogroup FLASH_Private_Constants
bogdanm 0:9b334a45a8ff 58 * @{
bogdanm 0:9b334a45a8ff 59 */
bogdanm 0:9b334a45a8ff 60 #define FLASH_TIMEOUT_VALUE ((uint32_t)50000)/* 50 s */
bogdanm 0:9b334a45a8ff 61 /**
bogdanm 0:9b334a45a8ff 62 * @}
bogdanm 0:9b334a45a8ff 63 */
bogdanm 0:9b334a45a8ff 64
bogdanm 0:9b334a45a8ff 65 /** @addtogroup FLASH_Private_Macros
bogdanm 0:9b334a45a8ff 66 * @{
bogdanm 0:9b334a45a8ff 67 */
bogdanm 0:9b334a45a8ff 68
bogdanm 0:9b334a45a8ff 69 #define IS_FLASH_TYPEPROGRAM(VALUE) (((VALUE) == FLASH_TYPEPROGRAM_HALFWORD) || \
bogdanm 0:9b334a45a8ff 70 ((VALUE) == FLASH_TYPEPROGRAM_WORD) || \
bogdanm 0:9b334a45a8ff 71 ((VALUE) == FLASH_TYPEPROGRAM_DOUBLEWORD))
bogdanm 0:9b334a45a8ff 72
bogdanm 0:9b334a45a8ff 73 /**
bogdanm 0:9b334a45a8ff 74 * @}
bogdanm 0:9b334a45a8ff 75 */
bogdanm 0:9b334a45a8ff 76
bogdanm 0:9b334a45a8ff 77 /* Exported types ------------------------------------------------------------*/
bogdanm 0:9b334a45a8ff 78 /** @defgroup FLASH_Exported_Types FLASH Exported Types
bogdanm 0:9b334a45a8ff 79 * @{
bogdanm 0:9b334a45a8ff 80 */
bogdanm 0:9b334a45a8ff 81
bogdanm 0:9b334a45a8ff 82
bogdanm 0:9b334a45a8ff 83 /**
bogdanm 0:9b334a45a8ff 84 * @brief FLASH Procedure structure definition
bogdanm 0:9b334a45a8ff 85 */
bogdanm 0:9b334a45a8ff 86 typedef enum
bogdanm 0:9b334a45a8ff 87 {
bogdanm 0:9b334a45a8ff 88 FLASH_PROC_NONE = 0,
bogdanm 0:9b334a45a8ff 89 FLASH_PROC_PAGEERASE = 1,
bogdanm 0:9b334a45a8ff 90 FLASH_PROC_MASSERASE = 2,
bogdanm 0:9b334a45a8ff 91 FLASH_PROC_PROGRAMHALFWORD = 3,
bogdanm 0:9b334a45a8ff 92 FLASH_PROC_PROGRAMWORD = 4,
bogdanm 0:9b334a45a8ff 93 FLASH_PROC_PROGRAMDOUBLEWORD = 5
bogdanm 0:9b334a45a8ff 94 } FLASH_ProcedureTypeDef;
bogdanm 0:9b334a45a8ff 95
bogdanm 0:9b334a45a8ff 96 /**
bogdanm 0:9b334a45a8ff 97 * @brief FLASH handle Structure definition
bogdanm 0:9b334a45a8ff 98 */
bogdanm 0:9b334a45a8ff 99 typedef struct
bogdanm 0:9b334a45a8ff 100 {
bogdanm 0:9b334a45a8ff 101 __IO FLASH_ProcedureTypeDef ProcedureOnGoing; /* Internal variable to indicate which procedure is ongoing or not in IT context */
bogdanm 0:9b334a45a8ff 102
bogdanm 0:9b334a45a8ff 103 __IO uint32_t DataRemaining; /* Internal variable to save the remaining pages to erase or half-word to program in IT context */
bogdanm 0:9b334a45a8ff 104
bogdanm 0:9b334a45a8ff 105 __IO uint32_t Address; /* Internal variable to save address selected for program or erase */
bogdanm 0:9b334a45a8ff 106
bogdanm 0:9b334a45a8ff 107 __IO uint64_t Data; /* Internal variable to save data to be programmed */
bogdanm 0:9b334a45a8ff 108
bogdanm 0:9b334a45a8ff 109 HAL_LockTypeDef Lock; /* FLASH locking object */
bogdanm 0:9b334a45a8ff 110
bogdanm 0:9b334a45a8ff 111 __IO uint32_t ErrorCode; /* FLASH error code */
bogdanm 0:9b334a45a8ff 112
bogdanm 0:9b334a45a8ff 113 } FLASH_ProcessTypeDef;
bogdanm 0:9b334a45a8ff 114
bogdanm 0:9b334a45a8ff 115 /**
bogdanm 0:9b334a45a8ff 116 * @}
bogdanm 0:9b334a45a8ff 117 */
bogdanm 0:9b334a45a8ff 118
bogdanm 0:9b334a45a8ff 119 /* Exported constants --------------------------------------------------------*/
bogdanm 0:9b334a45a8ff 120 /** @defgroup FLASH_Exported_Constants FLASH Exported Constants
bogdanm 0:9b334a45a8ff 121 * @{
bogdanm 0:9b334a45a8ff 122 */
bogdanm 0:9b334a45a8ff 123
bogdanm 0:9b334a45a8ff 124 /** @defgroup FLASH_Error_Codes FLASH Error Codes
bogdanm 0:9b334a45a8ff 125 * @{
bogdanm 0:9b334a45a8ff 126 */
bogdanm 0:9b334a45a8ff 127
bogdanm 0:9b334a45a8ff 128 #define HAL_FLASH_ERROR_NONE ((uint32_t)0x00)
bogdanm 0:9b334a45a8ff 129 #define HAL_FLASH_ERROR_PROG ((uint32_t)0x01)
bogdanm 0:9b334a45a8ff 130 #define HAL_FLASH_ERROR_WRP ((uint32_t)0x02)
bogdanm 0:9b334a45a8ff 131 #define HAL_FLASH_ERROR_OPTV ((uint32_t)0x04)
bogdanm 0:9b334a45a8ff 132
bogdanm 0:9b334a45a8ff 133 /**
bogdanm 0:9b334a45a8ff 134 * @}
bogdanm 0:9b334a45a8ff 135 */
bogdanm 0:9b334a45a8ff 136
bogdanm 0:9b334a45a8ff 137
bogdanm 0:9b334a45a8ff 138 /** @defgroup FLASH_Type_Program Type Program
bogdanm 0:9b334a45a8ff 139 * @{
bogdanm 0:9b334a45a8ff 140 */
bogdanm 0:9b334a45a8ff 141 #define FLASH_TYPEPROGRAM_HALFWORD ((uint32_t)0x01) /*!<Program a half-word (16-bit) at a specified address.*/
bogdanm 0:9b334a45a8ff 142 #define FLASH_TYPEPROGRAM_WORD ((uint32_t)0x02) /*!<Program a word (32-bit) at a specified address.*/
bogdanm 0:9b334a45a8ff 143 #define FLASH_TYPEPROGRAM_DOUBLEWORD ((uint32_t)0x03) /*!<Program a double word (64-bit) at a specified address*/
bogdanm 0:9b334a45a8ff 144
bogdanm 0:9b334a45a8ff 145 /**
bogdanm 0:9b334a45a8ff 146 * @}
bogdanm 0:9b334a45a8ff 147 */
bogdanm 0:9b334a45a8ff 148
bogdanm 0:9b334a45a8ff 149 /**
bogdanm 0:9b334a45a8ff 150 * @}
bogdanm 0:9b334a45a8ff 151 */
bogdanm 0:9b334a45a8ff 152
bogdanm 0:9b334a45a8ff 153 /* Exported macro ------------------------------------------------------------*/
bogdanm 0:9b334a45a8ff 154
bogdanm 0:9b334a45a8ff 155 /** @defgroup FLASH_Exported_Macros FLASH Exported Macros
bogdanm 0:9b334a45a8ff 156 * @brief macros to control FLASH features
bogdanm 0:9b334a45a8ff 157 * @{
bogdanm 0:9b334a45a8ff 158 */
bogdanm 0:9b334a45a8ff 159
bogdanm 0:9b334a45a8ff 160 /**
bogdanm 0:9b334a45a8ff 161 * @brief Enable the FLASH half cycle access.
bogdanm 0:9b334a45a8ff 162 * @note halfcycle access can only be used with a low-frequency clock of less than
bogdanm 0:9b334a45a8ff 163 8 MHz that can be obtained with the use of HSI or HSE but not of PLL.
bogdanm 0:9b334a45a8ff 164 * @retval None
bogdanm 0:9b334a45a8ff 165 */
bogdanm 0:9b334a45a8ff 166 #define __HAL_FLASH_HALF_CYCLE_ACCESS_ENABLE() (FLASH->ACR |= FLASH_ACR_HLFCYA)
bogdanm 0:9b334a45a8ff 167
bogdanm 0:9b334a45a8ff 168 /**
bogdanm 0:9b334a45a8ff 169 * @brief Disable the FLASH half cycle access.
bogdanm 0:9b334a45a8ff 170 * @note halfcycle access can only be used with a low-frequency clock of less than
bogdanm 0:9b334a45a8ff 171 8 MHz that can be obtained with the use of HSI or HSE but not of PLL.
bogdanm 0:9b334a45a8ff 172 * @retval None
bogdanm 0:9b334a45a8ff 173 */
bogdanm 0:9b334a45a8ff 174 #define __HAL_FLASH_HALF_CYCLE_ACCESS_DISABLE() (FLASH->ACR &= (~FLASH_ACR_HLFCYA))
bogdanm 0:9b334a45a8ff 175
bogdanm 0:9b334a45a8ff 176 /**
bogdanm 0:9b334a45a8ff 177 * @}
bogdanm 0:9b334a45a8ff 178 */
bogdanm 0:9b334a45a8ff 179
bogdanm 0:9b334a45a8ff 180 /* Include FLASH HAL Extended module */
bogdanm 0:9b334a45a8ff 181 #include "stm32f1xx_hal_flash_ex.h"
bogdanm 0:9b334a45a8ff 182
bogdanm 0:9b334a45a8ff 183 /* Exported functions --------------------------------------------------------*/
bogdanm 0:9b334a45a8ff 184 /** @addtogroup FLASH_Exported_Functions
bogdanm 0:9b334a45a8ff 185 * @{
bogdanm 0:9b334a45a8ff 186 */
bogdanm 0:9b334a45a8ff 187
bogdanm 0:9b334a45a8ff 188 /** @addtogroup FLASH_Exported_Functions_Group1
bogdanm 0:9b334a45a8ff 189 * @{
bogdanm 0:9b334a45a8ff 190 */
bogdanm 0:9b334a45a8ff 191 /* IO operation functions *****************************************************/
bogdanm 0:9b334a45a8ff 192 HAL_StatusTypeDef HAL_FLASH_Program(uint32_t TypeProgram, uint32_t Address, uint64_t Data);
bogdanm 0:9b334a45a8ff 193 HAL_StatusTypeDef HAL_FLASH_Program_IT(uint32_t TypeProgram, uint32_t Address, uint64_t Data);
bogdanm 0:9b334a45a8ff 194
bogdanm 0:9b334a45a8ff 195 /* FLASH IRQ handler method */
bogdanm 0:9b334a45a8ff 196 void HAL_FLASH_IRQHandler(void);
bogdanm 0:9b334a45a8ff 197 /* Callbacks in non blocking modes */
bogdanm 0:9b334a45a8ff 198 void HAL_FLASH_EndOfOperationCallback(uint32_t ReturnValue);
bogdanm 0:9b334a45a8ff 199 void HAL_FLASH_OperationErrorCallback(uint32_t ReturnValue);
bogdanm 0:9b334a45a8ff 200
bogdanm 0:9b334a45a8ff 201 /**
bogdanm 0:9b334a45a8ff 202 * @}
bogdanm 0:9b334a45a8ff 203 */
bogdanm 0:9b334a45a8ff 204
bogdanm 0:9b334a45a8ff 205 /** @addtogroup FLASH_Exported_Functions_Group2
bogdanm 0:9b334a45a8ff 206 * @{
bogdanm 0:9b334a45a8ff 207 */
bogdanm 0:9b334a45a8ff 208 /* Peripheral Control functions ***********************************************/
bogdanm 0:9b334a45a8ff 209 HAL_StatusTypeDef HAL_FLASH_Unlock(void);
bogdanm 0:9b334a45a8ff 210 HAL_StatusTypeDef HAL_FLASH_Lock(void);
bogdanm 0:9b334a45a8ff 211 HAL_StatusTypeDef HAL_FLASH_OB_Unlock(void);
bogdanm 0:9b334a45a8ff 212 HAL_StatusTypeDef HAL_FLASH_OB_Lock(void);
bogdanm 0:9b334a45a8ff 213 HAL_StatusTypeDef HAL_FLASH_OB_Launch(void);
bogdanm 0:9b334a45a8ff 214
bogdanm 0:9b334a45a8ff 215 /**
bogdanm 0:9b334a45a8ff 216 * @}
bogdanm 0:9b334a45a8ff 217 */
bogdanm 0:9b334a45a8ff 218
bogdanm 0:9b334a45a8ff 219 /** @addtogroup FLASH_Exported_Functions_Group3
bogdanm 0:9b334a45a8ff 220 * @{
bogdanm 0:9b334a45a8ff 221 */
bogdanm 0:9b334a45a8ff 222 /* Peripheral State and Error functions ***************************************/
bogdanm 0:9b334a45a8ff 223 uint32_t HAL_FLASH_GetError(void);
bogdanm 0:9b334a45a8ff 224
bogdanm 0:9b334a45a8ff 225 /**
bogdanm 0:9b334a45a8ff 226 * @}
bogdanm 0:9b334a45a8ff 227 */
bogdanm 0:9b334a45a8ff 228
bogdanm 0:9b334a45a8ff 229 /**
bogdanm 0:9b334a45a8ff 230 * @}
bogdanm 0:9b334a45a8ff 231 */
bogdanm 0:9b334a45a8ff 232
bogdanm 0:9b334a45a8ff 233 /* Private function -------------------------------------------------*/
bogdanm 0:9b334a45a8ff 234 /** @addtogroup FLASH_Private_Functions
bogdanm 0:9b334a45a8ff 235 * @{
bogdanm 0:9b334a45a8ff 236 */
bogdanm 0:9b334a45a8ff 237 void FLASH_PageErase(uint32_t PageAddress);
bogdanm 0:9b334a45a8ff 238 HAL_StatusTypeDef FLASH_WaitForLastOperation(uint32_t Timeout);
bogdanm 0:9b334a45a8ff 239 void FLASH_SetErrorCode(void);
bogdanm 0:9b334a45a8ff 240 void FLASH_Program_HalfWord(uint32_t Address, uint16_t Data);
bogdanm 0:9b334a45a8ff 241
bogdanm 0:9b334a45a8ff 242 /**
bogdanm 0:9b334a45a8ff 243 * @}
bogdanm 0:9b334a45a8ff 244 */
bogdanm 0:9b334a45a8ff 245
bogdanm 0:9b334a45a8ff 246 /**
bogdanm 0:9b334a45a8ff 247 * @}
bogdanm 0:9b334a45a8ff 248 */
bogdanm 0:9b334a45a8ff 249
bogdanm 0:9b334a45a8ff 250 /**
bogdanm 0:9b334a45a8ff 251 * @}
bogdanm 0:9b334a45a8ff 252 */
bogdanm 0:9b334a45a8ff 253
bogdanm 0:9b334a45a8ff 254 #ifdef __cplusplus
bogdanm 0:9b334a45a8ff 255 }
bogdanm 0:9b334a45a8ff 256 #endif
bogdanm 0:9b334a45a8ff 257
bogdanm 0:9b334a45a8ff 258 #endif /* __STM32F1xx_HAL_FLASH_H */
bogdanm 0:9b334a45a8ff 259
bogdanm 0:9b334a45a8ff 260 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
bogdanm 0:9b334a45a8ff 261