Vladimir Vana / mbed

pro vyuku PSS v Jecne

TARGET_NUCLEO_F103RB/stm32f1xx_hal_flash.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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