1 /**
2   ******************************************************************************
3   * @file    stm32l4xx_hal_flash_ex.h
4   * @author  MCD Application Team
5   * @brief   Header file of FLASH HAL Extended module.
6   ******************************************************************************
7   * @attention
8   *
9   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
10   *
11   * Redistribution and use in source and binary forms, with or without modification,
12   * are permitted provided that the following conditions are met:
13   *   1. Redistributions of source code must retain the above copyright notice,
14   *      this list of conditions and the following disclaimer.
15   *   2. Redistributions in binary form must reproduce the above copyright notice,
16   *      this list of conditions and the following disclaimer in the documentation
17   *      and/or other materials provided with the distribution.
18   *   3. Neither the name of STMicroelectronics nor the names of its contributors
19   *      may be used to endorse or promote products derived from this software
20   *      without specific prior written permission.
21   *
22   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32   *
33   ******************************************************************************
34   */
35 
36 /* Define to prevent recursive inclusion -------------------------------------*/
37 #ifndef __STM32L4xx_HAL_FLASH_EX_H
38 #define __STM32L4xx_HAL_FLASH_EX_H
39 
40 #ifdef __cplusplus
41  extern "C" {
42 #endif
43 
44 /* Includes ------------------------------------------------------------------*/
45 #include "stm32l4xx_hal_def.h"
46 
47 /** @addtogroup STM32L4xx_HAL_Driver
48   * @{
49   */
50 
51 /** @addtogroup FLASHEx
52   * @{
53   */
54 
55 /* Exported types ------------------------------------------------------------*/
56 
57 /* Exported constants --------------------------------------------------------*/
58 #if defined (FLASH_CFGR_LVEN)
59 /** @addtogroup FLASHEx_Exported_Constants
60   * @{
61   */
62 /** @defgroup FLASHEx_LVE_PIN_CFG FLASHEx LVE pin configuration
63   * @{
64   */
65 #define FLASH_LVE_PIN_CTRL     0x00000000U       /*!< LVE FLASH pin controlled by power controller       */
66 #define FLASH_LVE_PIN_FORCED   FLASH_CFGR_LVEN   /*!< LVE FLASH pin enforced to low (external SMPS used) */
67 /**
68   * @}
69   */
70 
71 /**
72   * @}
73   */
74 #endif /* FLASH_CFGR_LVEN */
75 
76 /* Exported macro ------------------------------------------------------------*/
77 
78 /* Exported functions --------------------------------------------------------*/
79 /** @addtogroup FLASHEx_Exported_Functions
80   * @{
81   */
82 
83 /* Extended Program operation functions  *************************************/
84 /** @addtogroup FLASHEx_Exported_Functions_Group1
85   * @{
86   */
87 HAL_StatusTypeDef HAL_FLASHEx_Erase(FLASH_EraseInitTypeDef *pEraseInit, uint32_t *PageError);
88 HAL_StatusTypeDef HAL_FLASHEx_Erase_IT(FLASH_EraseInitTypeDef *pEraseInit);
89 HAL_StatusTypeDef HAL_FLASHEx_OBProgram(FLASH_OBProgramInitTypeDef *pOBInit);
90 void              HAL_FLASHEx_OBGetConfig(FLASH_OBProgramInitTypeDef *pOBInit);
91 /**
92   * @}
93   */
94 
95 #if defined (FLASH_CFGR_LVEN)
96 /** @addtogroup FLASHEx_Exported_Functions_Group2
97   * @{
98   */
99 HAL_StatusTypeDef HAL_FLASHEx_ConfigLVEPin(uint32_t ConfigLVE);
100 /**
101   * @}
102   */
103 #endif /* FLASH_CFGR_LVEN */
104 
105 /**
106   * @}
107   */
108 
109 /* Private macros ------------------------------------------------------------*/
110 /**
111   @cond 0
112   */
113 #if defined (FLASH_CFGR_LVEN)
114 #define IS_FLASH_LVE_PIN(CFG)  (((CFG) == FLASH_LVE_PIN_CTRL) || ((CFG) == FLASH_LVE_PIN_FORCED))
115 #endif /* FLASH_CFGR_LVEN */
116 /**
117   @endcond
118   */
119 
120 /**
121   * @}
122   */
123 
124 /**
125   * @}
126   */
127 
128 #ifdef __cplusplus
129 }
130 #endif
131 
132 #endif /* __STM32L4xx_HAL_FLASH_EX_H */
133 
134 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
135