comparison Common/Drivers/STM32F4xx_HAL_DRIVER_v120/Inc/stm32f4xx_hal_sram.h @ 38:5f11787b4f42

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