tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F3/stm32f3xx_hal_flash_ex.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f3xx_hal_flash_ex.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    12-Sept-2014
   7   * @brief   Header file of Flash HAL Extended module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F3xx_HAL_FLASH_EX_H
  40 #define __STM32F3xx_HAL_FLASH_EX_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f3xx_hal_def.h"
  48
  49 /** @addtogroup STM32F3xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup FLASHEx FLASH Extended HAL module driver
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58 /* Exported constants --------------------------------------------------------*/
  59 /** @defgroup FLASHEx_Exported_Constants FLASH Extended Exported Constants
  60   * @{
  61   */
  62 #define FLASH_SIZE_DATA_REGISTER ((uint32_t)0x1FFFF7CC)
  63 #define FLASH_PAGE_SIZE          0x800
  64 /**
  65   * @}
  66   */
  67
  68 /** @defgroup FLASHEx_Address FLASH Extended Address
  69   * @{
  70   */
  71 #if defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx) || \
  72     defined(STM32F373xC) || defined(STM32F378xx)
  73 #define IS_FLASH_PROGRAM_ADDRESS(ADDRESS) (((ADDRESS) >= 0x08000000) && (((*((uint16_t *)FLASH_SIZE_DATA_REGISTER)) == 0x100) ? \
  74                                            ((ADDRESS) <= 0x0803FFFF) :  (((*((uint16_t *)FLASH_SIZE_DATA_REGISTER)) == 0x80) ? \
  75                                            ((ADDRESS) <= 0x0801FFFF) :  ((ADDRESS) <= 0x0800FFFF))))
  76 #endif /* STM32F302xC || STM32F303xC || STM32F358xx || */
  77        /* STM32F373xC || STM32F378xx */
  78
  79 #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx)
  80 #define IS_FLASH_PROGRAM_ADDRESS(ADDRESS) (((ADDRESS) >= 0x08000000) && ((ADDRESS) <= 0x0807FFFF))
  81 #endif /* STM32F302xE || STM32F303xE || STM32F398xx */
  82
  83 #if defined(STM32F301x8) || defined(STM32F302x8) || defined(STM32F318xx) || \
  84     defined(STM32F303x8) || defined(STM32F334x8) || defined(STM32F328xx)
  85 #define IS_FLASH_PROGRAM_ADDRESS(ADDRESS) (((ADDRESS) >= 0x08000000) && (((*((uint16_t *)FLASH_SIZE_DATA_REGISTER)) == 0x40) ? \
  86                                            ((ADDRESS) <= 0x0800FFFF) :  (((*((uint16_t *)FLASH_SIZE_DATA_REGISTER)) == 0x20) ? \
  87                                            ((ADDRESS) <= 0x08007FFF) :  ((ADDRESS) <= 0x08003FFF))))
  88 #endif /* STM32F301x8 || STM32F302x8 || STM32F318xx || */
  89        /* STM32F303x8 || STM32F334x8 || STM32F328xx */
  90 /**
  91   * @}
  92   */
  93
  94 /** @defgroup FLASHEx_Nb_Pages FLASH Extended Nb Pages
  95   * @{
  96   */
  97 #if defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx) || \
  98     defined(STM32F373xC) || defined(STM32F378xx)
  99 #define IS_FLASH_NB_PAGES(ADDRESS,NBPAGES) (((*((uint16_t *)FLASH_SIZE_DATA_REGISTER)) == 0x100) ? ((ADDRESS)+((NBPAGES)*FLASH_PAGE_SIZE)-1 <= 0x0803FFFF) : \
 100                                            (((*((uint16_t *)FLASH_SIZE_DATA_REGISTER)) == 0x80)  ? ((ADDRESS)+((NBPAGES)*FLASH_PAGE_SIZE)-1 <= 0x0801FFFF) : \
 101                                             ((ADDRESS)+((NBPAGES)*FLASH_PAGE_SIZE)-1 <= 0x0800FFFF)))
 102 #endif /* STM32F302xC || STM32F303xC || STM32F358xx || */
 103        /* STM32F373xC || STM32F378xx */
 104
 105 #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx)
 106 #define IS_FLASH_NB_PAGES(ADDRESS,NBPAGES) ((ADDRESS)+((NBPAGES)*FLASH_PAGE_SIZE)-1 <= 0x0807FFFF)
 107 #endif /* STM32F302xE || STM32F303xE || STM32F398xx */
 108
 109 #if defined(STM32F301x8) || defined(STM32F302x8) || defined(STM32F318xx) || \
 110     defined(STM32F303x8) || defined(STM32F334x8) || defined(STM32F328xx)
 111 #define IS_FLASH_NB_PAGES(ADDRESS,NBPAGES) (((*((uint16_t *)FLASH_SIZE_DATA_REGISTER)) == 0x40) ? ((ADDRESS)+((NBPAGES)*FLASH_PAGE_SIZE)-1 <= 0x0800FFFF) : \
 112                                            (((*((uint16_t *)FLASH_SIZE_DATA_REGISTER)) == 0x20) ? ((ADDRESS)+((NBPAGES)*FLASH_PAGE_SIZE)-1 <= 0x08007FFF) : \
 113                                             ((ADDRESS)+((NBPAGES)*FLASH_PAGE_SIZE)-1 <= 0x08003FFF)))
 114 #endif /* STM32F301x8 || STM32F302x8 || STM32F318xx || */
 115        /* STM32F303x8 || STM32F334x8 || STM32F328xx */
 116 /**
 117   * @}
 118   */
 119
 120 /** @defgroup FLASHEx_OB_Write_Protection FLASH Extended Option Bytes Write Protection
 121   * @{
 122   */
 123 #define OB_WRP_PAGES0TO1               ((uint32_t)0x00000001) /* Write protection of page 0 to 1 */
 124 #define OB_WRP_PAGES2TO3               ((uint32_t)0x00000002) /* Write protection of page 2 to 3 */
 125 #define OB_WRP_PAGES4TO5               ((uint32_t)0x00000004) /* Write protection of page 4 to 5 */
 126 #define OB_WRP_PAGES6TO7               ((uint32_t)0x00000008) /* Write protection of page 6 to 7 */
 127 #define OB_WRP_PAGES8TO9               ((uint32_t)0x00000010) /* Write protection of page 8 to 9 */
 128 #define OB_WRP_PAGES10TO11             ((uint32_t)0x00000020) /* Write protection of page 10 to 11 */
 129 #define OB_WRP_PAGES12TO13             ((uint32_t)0x00000040) /* Write protection of page 12 to 13 */
 130 #define OB_WRP_PAGES14TO15             ((uint32_t)0x00000080) /* Write protection of page 14 to 15 */
 131 #define OB_WRP_PAGES16TO17             ((uint32_t)0x00000100) /* Write protection of page 16 to 17 */
 132 #define OB_WRP_PAGES18TO19             ((uint32_t)0x00000200) /* Write protection of page 18 to 19 */
 133 #define OB_WRP_PAGES20TO21             ((uint32_t)0x00000400) /* Write protection of page 20 to 21 */
 134 #define OB_WRP_PAGES22TO23             ((uint32_t)0x00000800) /* Write protection of page 22 to 23 */
 135 #define OB_WRP_PAGES24TO25             ((uint32_t)0x00001000) /* Write protection of page 24 to 25 */
 136 #define OB_WRP_PAGES26TO27             ((uint32_t)0x00002000) /* Write protection of page 26 to 27 */
 137 #define OB_WRP_PAGES28TO29             ((uint32_t)0x00004000) /* Write protection of page 28 to 29 */
 138 #define OB_WRP_PAGES30TO31             ((uint32_t)0x00008000) /* Write protection of page 30 to 31 */
 139
 140 #if defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx) || \
 141     defined(STM32F373xC) || defined(STM32F378xx)
 142 #define OB_WRP_PAGES32TO33             ((uint32_t)0x00010000) /* Write protection of page 32 to 33 */
 143 #define OB_WRP_PAGES34TO35             ((uint32_t)0x00020000) /* Write protection of page 34 to 35 */
 144 #define OB_WRP_PAGES36TO37             ((uint32_t)0x00040000) /* Write protection of page 36 to 37 */
 145 #define OB_WRP_PAGES38TO39             ((uint32_t)0x00080000) /* Write protection of page 38 to 39 */
 146 #define OB_WRP_PAGES40TO41             ((uint32_t)0x00100000) /* Write protection of page 40 to 41 */
 147 #define OB_WRP_PAGES42TO43             ((uint32_t)0x00200000) /* Write protection of page 42 to 43 */
 148 #define OB_WRP_PAGES44TO45             ((uint32_t)0x00400000) /* Write protection of page 44 to 45 */
 149 #define OB_WRP_PAGES46TO47             ((uint32_t)0x00800000) /* Write protection of page 46 to 47 */
 150 #define OB_WRP_PAGES48TO49             ((uint32_t)0x01000000) /* Write protection of page 48 to 49 */
 151 #define OB_WRP_PAGES50TO51             ((uint32_t)0x02000000) /* Write protection of page 50 to 51 */
 152 #define OB_WRP_PAGES52TO53             ((uint32_t)0x04000000) /* Write protection of page 52 to 53 */
 153 #define OB_WRP_PAGES54TO55             ((uint32_t)0x08000000) /* Write protection of page 54 to 55 */
 154 #define OB_WRP_PAGES56TO57             ((uint32_t)0x10000000) /* Write protection of page 56 to 57 */
 155 #define OB_WRP_PAGES58TO59             ((uint32_t)0x20000000) /* Write protection of page 58 to 59 */
 156 #define OB_WRP_PAGES60TO61             ((uint32_t)0x40000000) /* Write protection of page 60 to 61 */
 157 #define OB_WRP_PAGES62TO127            ((uint32_t)0x80000000) /* Write protection of page 62 to 127 */
 158 #endif /* STM32F302xC || STM32F303xC || STM32F358xx || */
 159        /* STM32F373xC || STM32F378xx                   */
 160
 161 #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx)
 162 #define OB_WRP_PAGES32TO33             ((uint32_t)0x00010000) /* Write protection of page 32 to 33 */
 163 #define OB_WRP_PAGES34TO35             ((uint32_t)0x00020000) /* Write protection of page 34 to 35 */
 164 #define OB_WRP_PAGES36TO37             ((uint32_t)0x00040000) /* Write protection of page 36 to 37 */
 165 #define OB_WRP_PAGES38TO39             ((uint32_t)0x00080000) /* Write protection of page 38 to 39 */
 166 #define OB_WRP_PAGES40TO41             ((uint32_t)0x00100000) /* Write protection of page 40 to 41 */
 167 #define OB_WRP_PAGES42TO43             ((uint32_t)0x00200000) /* Write protection of page 42 to 43 */
 168 #define OB_WRP_PAGES44TO45             ((uint32_t)0x00400000) /* Write protection of page 44 to 45 */
 169 #define OB_WRP_PAGES46TO47             ((uint32_t)0x00800000) /* Write protection of page 46 to 47 */
 170 #define OB_WRP_PAGES48TO49             ((uint32_t)0x01000000) /* Write protection of page 48 to 49 */
 171 #define OB_WRP_PAGES50TO51             ((uint32_t)0x02000000) /* Write protection of page 50 to 51 */
 172 #define OB_WRP_PAGES52TO53             ((uint32_t)0x04000000) /* Write protection of page 52 to 53 */
 173 #define OB_WRP_PAGES54TO55             ((uint32_t)0x08000000) /* Write protection of page 54 to 55 */
 174 #define OB_WRP_PAGES56TO57             ((uint32_t)0x10000000) /* Write protection of page 56 to 57 */
 175 #define OB_WRP_PAGES58TO59             ((uint32_t)0x20000000) /* Write protection of page 58 to 59 */
 176 #define OB_WRP_PAGES60TO61             ((uint32_t)0x40000000) /* Write protection of page 60 to 61 */
 177 #define OB_WRP_PAGES62TO255            ((uint32_t)0x80000000) /* Write protection of page 62 to 255 */
 178 #endif /* STM32F302xE || STM32F303xE || STM32F398xx */
 179
 180 #define OB_WRP_PAGES0TO15MASK          ((uint32_t)0x000000FF)
 181 #define OB_WRP_PAGES16TO31MASK         ((uint32_t)0x0000FF00)
 182
 183 #if defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx) || \
 184     defined(STM32F373xC) || defined(STM32F378xx)
 185 #define OB_WRP_PAGES32TO47MASK         ((uint32_t)0x00FF0000)
 186 #define OB_WRP_PAGES48TO127MASK        ((uint32_t)0xFF000000)
 187 #endif /* STM32F302xC || STM32F303xC || STM32F358xx || */
 188        /* STM32F373xC || STM32F378xx                   */
 189
 190 #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx)
 191 #define OB_WRP_PAGES32TO47MASK         ((uint32_t)0x00FF0000)
 192 #define OB_WRP_PAGES48TO255MASK        ((uint32_t)0xFF000000)
 193 #endif /* STM32F302xE || STM32F303xE || STM32F398xx */
 194
 195 #if defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx) || \
 196     defined(STM32F373xC) || defined(STM32F378xx)
 197 #define OB_WRP_PAGES32TO47MASK         ((uint32_t)0x00FF0000)
 198 #define OB_WRP_PAGES48TO127MASK        ((uint32_t)0xFF000000)
 199 #endif /* STM32F302xC || STM32F303xC || STM32F358xx || */
 200        /* STM32F373xC || STM32F378xx                   */
 201
 202 #if defined(STM32F302xE) || defined(STM32F303xE) || defined(STM32F398xx) || \
 203     defined(STM32F302xC) || defined(STM32F303xC) || defined(STM32F358xx) || \
 204     defined(STM32F373xC) || defined(STM32F378xx)
 205 #define OB_WRP_ALLPAGES                ((uint32_t)0xFFFFFFFF) /*!< Write protection of all pages */
 206 #endif /* STM32F302xE || STM32F303xE || STM32F398xx || */
 207        /* STM32F302xC || STM32F303xC || STM32F358xx || */
 208        /* STM32F373xC || STM32F378xx                   */
 209
 210 #if defined(STM32F301x8) || defined(STM32F302x8) || defined(STM32F318xx) || \
 211     defined(STM32F303x8) || defined(STM32F334x8) || defined(STM32F328xx)
 212 #define OB_WRP_ALLPAGES                ((uint32_t)0x0000FFFF) /*!< Write protection of all pages */
 213 #endif /* STM32F301x8 || STM32F302x8 || STM32F318xx || */
 214        /* STM32F303x8 || STM32F334x8 || STM32F328xx    */
 215
 216 #define IS_OB_WRP(PAGE) (((PAGE) != 0x0000000))
 217 /**
 218   * @}
 219   */
 220
 221 #if defined(STM32F373xC) || defined(STM32F378xx)
 222 /** @defgroup FLASHEx_OB_SDADC12_VDD_MONITOR FLASH Extended Option Bytes SDADC12 VDD MONITOR
 223   * @{
 224   */
 225 #define OB_SDACD_VDD_MONITOR_RESET           ((uint8_t)0x00) /*!< SDADC VDD Monitor reset */
 226 #define OB_SDACD_VDD_MONITOR_SET             ((uint8_t)0x80) /*!< SDADC VDD Monitor set */
 227
 228 #define IS_OB_SDACD_VDD_MONITOR(VDD_MONITOR) (((VDD_MONITOR) == OB_SDACD_VDD_MONITOR_SET) || \
 229                                               ((VDD_MONITOR) == OB_SDACD_VDD_MONITOR_RESET))
 230 /**
 231   * @}
 232   */
 233 #endif /* STM32F373xC || STM32F378xx */
 234
 235
 236 /* Exported macro ------------------------------------------------------------*/
 237
 238 /* Exported functions --------------------------------------------------------*/
 239 /** @addtogroup FLASHEx_Exported_Functions FLASH Extended Exported Functions
 240   * @{
 241   */
 242
 243 /** @addtogroup FLASHEx_Exported_Functions_Group1 Extended Input and Output operation functions
 244   * @{
 245   */
 246 /* IO operation functions *****************************************************/
 247 HAL_StatusTypeDef  HAL_FLASHEx_Erase(FLASH_EraseInitTypeDef *pEraseInit, uint32_t *PageError);
 248 HAL_StatusTypeDef  HAL_FLASHEx_Erase_IT(FLASH_EraseInitTypeDef *pEraseInit);
 249
 250 /**
 251   * @}
 252   */
 253
 254 /** @addtogroup FLASHEx_Exported_Functions_Group2 Extended Peripheral Control functions
 255   * @{
 256   */
 257 /* Peripheral Control functions ***********************************************/
 258 HAL_StatusTypeDef  HAL_FLASHEx_OBErase(void);
 259 HAL_StatusTypeDef  HAL_FLASHEx_OBProgram(FLASH_OBProgramInitTypeDef *pOBInit);
 260 void               HAL_FLASHEx_OBGetConfig(FLASH_OBProgramInitTypeDef *pOBInit);
 261
 262 /**
 263   * @}
 264   */
 265
 266 /**
 267   * @}
 268   */
 269
 270 /**
 271   * @}
 272   */
 273
 274 /**
 275   * @}
 276   */
 277 #ifdef __cplusplus
 278 }
 279 #endif
 280
 281 #endif /* __STM32F3xx_HAL_FLASH_EX_H */
 282
 283 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/