comparison Common/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_sram.h @ 160:e3ca52b8e7fa

Merge with FlipDisplay
author heinrichsweikamp
date Thu, 07 Mar 2019 15:06:43 +0100
parents c78bcbd5deda
children
comparison
equal deleted inserted replaced
80:cc2bb7bb8456 160:e3ca52b8e7fa
1 /**
2 ******************************************************************************
3 * @file stm32f4xx_hal_sram.h
4 * @author MCD Application Team
5 * @brief Header file of SRAM HAL 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 __STM32F4xx_HAL_SRAM_H
38 #define __STM32F4xx_HAL_SRAM_H
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 /* Includes ------------------------------------------------------------------*/
45 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F412Zx) ||\
46 defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F413xx) || defined(STM32F423xx)
47 #include "stm32f4xx_ll_fsmc.h"
48 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F412Zx || STM32F412Vx || STM32F412Rx || STM32F413xx || STM32F423xx */
49
50 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx) ||\
51 defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
52 #include "stm32f4xx_ll_fmc.h"
53 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx */
54
55
56 /** @addtogroup STM32F4xx_HAL_Driver
57 * @{
58 */
59
60 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) ||\
61 defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
62 defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx) || defined(STM32F412Zx) ||\
63 defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F413xx) || defined(STM32F423xx)
64
65 /** @addtogroup SRAM
66 * @{
67 */
68
69 /* Exported typedef ----------------------------------------------------------*/
70
71 /** @defgroup SRAM_Exported_Types SRAM Exported Types
72 * @{
73 */
74 /**
75 * @brief HAL SRAM State structures definition
76 */
77 typedef enum
78 {
79 HAL_SRAM_STATE_RESET = 0x00U, /*!< SRAM not yet initialized or disabled */
80 HAL_SRAM_STATE_READY = 0x01U, /*!< SRAM initialized and ready for use */
81 HAL_SRAM_STATE_BUSY = 0x02U, /*!< SRAM internal process is ongoing */
82 HAL_SRAM_STATE_ERROR = 0x03U, /*!< SRAM error state */
83 HAL_SRAM_STATE_PROTECTED = 0x04U /*!< SRAM peripheral NORSRAM device write protected */
84
85 }HAL_SRAM_StateTypeDef;
86
87 /**
88 * @brief SRAM handle Structure definition
89 */
90 typedef struct
91 {
92 FMC_NORSRAM_TypeDef *Instance; /*!< Register base address */
93
94 FMC_NORSRAM_EXTENDED_TypeDef *Extended; /*!< Extended mode register base address */
95
96 FMC_NORSRAM_InitTypeDef Init; /*!< SRAM device control configuration parameters */
97
98 HAL_LockTypeDef Lock; /*!< SRAM locking object */
99
100 __IO HAL_SRAM_StateTypeDef State; /*!< SRAM device access state */
101
102 DMA_HandleTypeDef *hdma; /*!< Pointer DMA handler */
103
104 }SRAM_HandleTypeDef;
105
106 /**
107 * @}
108 */
109
110 /* Exported constants --------------------------------------------------------*/
111 /* Exported macro ------------------------------------------------------------*/
112
113 /** @defgroup SRAM_Exported_Macros SRAM Exported Macros
114 * @{
115 */
116 /** @brief Reset SRAM handle state
117 * @param __HANDLE__ SRAM handle
118 * @retval None
119 */
120 #define __HAL_SRAM_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SRAM_STATE_RESET)
121
122 /**
123 * @}
124 */
125 /* Exported functions --------------------------------------------------------*/
126
127 /** @addtogroup SRAM_Exported_Functions
128 * @{
129 */
130
131 /** @addtogroup SRAM_Exported_Functions_Group1
132 * @{
133 */
134 /* Initialization/de-initialization functions **********************************/
135 HAL_StatusTypeDef HAL_SRAM_Init(SRAM_HandleTypeDef *hsram, FMC_NORSRAM_TimingTypeDef *Timing, FMC_NORSRAM_TimingTypeDef *ExtTiming);
136 HAL_StatusTypeDef HAL_SRAM_DeInit(SRAM_HandleTypeDef *hsram);
137 void HAL_SRAM_MspInit(SRAM_HandleTypeDef *hsram);
138 void HAL_SRAM_MspDeInit(SRAM_HandleTypeDef *hsram);
139
140 void HAL_SRAM_DMA_XferCpltCallback(DMA_HandleTypeDef *hdma);
141 void HAL_SRAM_DMA_XferErrorCallback(DMA_HandleTypeDef *hdma);
142 /**
143 * @}
144 */
145
146 /** @addtogroup SRAM_Exported_Functions_Group2
147 * @{
148 */
149 /* I/O operation functions *****************************************************/
150 HAL_StatusTypeDef HAL_SRAM_Read_8b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint8_t *pDstBuffer, uint32_t BufferSize);
151 HAL_StatusTypeDef HAL_SRAM_Write_8b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint8_t *pSrcBuffer, uint32_t BufferSize);
152 HAL_StatusTypeDef HAL_SRAM_Read_16b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint16_t *pDstBuffer, uint32_t BufferSize);
153 HAL_StatusTypeDef HAL_SRAM_Write_16b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint16_t *pSrcBuffer, uint32_t BufferSize);
154 HAL_StatusTypeDef HAL_SRAM_Read_32b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint32_t *pDstBuffer, uint32_t BufferSize);
155 HAL_StatusTypeDef HAL_SRAM_Write_32b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint32_t *pSrcBuffer, uint32_t BufferSize);
156 HAL_StatusTypeDef HAL_SRAM_Read_DMA(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint32_t *pDstBuffer, uint32_t BufferSize);
157 HAL_StatusTypeDef HAL_SRAM_Write_DMA(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint32_t *pSrcBuffer, uint32_t BufferSize);
158 /**
159 * @}
160 */
161
162 /** @addtogroup SRAM_Exported_Functions_Group3
163 * @{
164 */
165 /* SRAM Control functions ******************************************************/
166 HAL_StatusTypeDef HAL_SRAM_WriteOperation_Enable(SRAM_HandleTypeDef *hsram);
167 HAL_StatusTypeDef HAL_SRAM_WriteOperation_Disable(SRAM_HandleTypeDef *hsram);
168 /**
169 * @}
170 */
171
172 /** @addtogroup SRAM_Exported_Functions_Group4
173 * @{
174 */
175 /* SRAM State functions *********************************************************/
176 HAL_SRAM_StateTypeDef HAL_SRAM_GetState(SRAM_HandleTypeDef *hsram);
177 /**
178 * @}
179 */
180
181 /**
182 * @}
183 */
184
185 /* Private types -------------------------------------------------------------*/
186 /* Private variables ---------------------------------------------------------*/
187 /* Private constants ---------------------------------------------------------*/
188 /* Private macros ------------------------------------------------------------*/
189 /* Private functions ---------------------------------------------------------*/
190 /**
191 * @}
192 */
193
194 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx ||\
195 STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx || STM32F412Zx ||\
196 STM32F412Vx || STM32F412Rx || STM32F413xx || STM32F423xx */
197 /**
198 * @}
199 */
200 #ifdef __cplusplus
201 }
202 #endif
203
204 #endif /* __STM32F4xx_HAL_SRAM_H */
205
206 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/