mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUCLEO_F413ZH/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_sram.h@160:5571c4ff569f, 2018-01-17 (annotated)

Committer:
Anna Bridge
Date:
Wed Jan 17 16:13:02 2018 +0000
Revision:
160:5571c4ff569f
Child:
163:e59c8e839560
mbed library. Release version 158

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Anna Bridge 160:5571c4ff569f 1 /**
Anna Bridge 160:5571c4ff569f 2 ******************************************************************************
Anna Bridge 160:5571c4ff569f 3 * @file stm32f4xx_hal_sram.h
Anna Bridge 160:5571c4ff569f 4 * @author MCD Application Team
Anna Bridge 160:5571c4ff569f 5 * @version V1.7.1
Anna Bridge 160:5571c4ff569f 6 * @date 14-April-2017
Anna Bridge 160:5571c4ff569f 7 * @brief Header file of SRAM HAL module.
Anna Bridge 160:5571c4ff569f 8 ******************************************************************************
Anna Bridge 160:5571c4ff569f 9 * @attention
Anna Bridge 160:5571c4ff569f 10 *
Anna Bridge 160:5571c4ff569f 11 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
Anna Bridge 160:5571c4ff569f 12 *
Anna Bridge 160:5571c4ff569f 13 * Redistribution and use in source and binary forms, with or without modification,
Anna Bridge 160:5571c4ff569f 14 * are permitted provided that the following conditions are met:
Anna Bridge 160:5571c4ff569f 15 * 1. Redistributions of source code must retain the above copyright notice,
Anna Bridge 160:5571c4ff569f 16 * this list of conditions and the following disclaimer.
Anna Bridge 160:5571c4ff569f 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Anna Bridge 160:5571c4ff569f 18 * this list of conditions and the following disclaimer in the documentation
Anna Bridge 160:5571c4ff569f 19 * and/or other materials provided with the distribution.
Anna Bridge 160:5571c4ff569f 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Anna Bridge 160:5571c4ff569f 21 * may be used to endorse or promote products derived from this software
Anna Bridge 160:5571c4ff569f 22 * without specific prior written permission.
Anna Bridge 160:5571c4ff569f 23 *
Anna Bridge 160:5571c4ff569f 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Anna Bridge 160:5571c4ff569f 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Anna Bridge 160:5571c4ff569f 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Anna Bridge 160:5571c4ff569f 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Anna Bridge 160:5571c4ff569f 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Anna Bridge 160:5571c4ff569f 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Anna Bridge 160:5571c4ff569f 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Anna Bridge 160:5571c4ff569f 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Anna Bridge 160:5571c4ff569f 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Anna Bridge 160:5571c4ff569f 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Anna Bridge 160:5571c4ff569f 34 *
Anna Bridge 160:5571c4ff569f 35 ******************************************************************************
Anna Bridge 160:5571c4ff569f 36 */
Anna Bridge 160:5571c4ff569f 37
Anna Bridge 160:5571c4ff569f 38 /* Define to prevent recursive inclusion -------------------------------------*/
Anna Bridge 160:5571c4ff569f 39 #ifndef __STM32F4xx_HAL_SRAM_H
Anna Bridge 160:5571c4ff569f 40 #define __STM32F4xx_HAL_SRAM_H
Anna Bridge 160:5571c4ff569f 41
Anna Bridge 160:5571c4ff569f 42 #ifdef __cplusplus
Anna Bridge 160:5571c4ff569f 43 extern "C" {
Anna Bridge 160:5571c4ff569f 44 #endif
Anna Bridge 160:5571c4ff569f 45
Anna Bridge 160:5571c4ff569f 46 /* Includes ------------------------------------------------------------------*/
Anna Bridge 160:5571c4ff569f 47 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) || defined(STM32F412Zx) ||\
Anna Bridge 160:5571c4ff569f 48 defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F413xx) || defined(STM32F423xx)
Anna Bridge 160:5571c4ff569f 49 #include "stm32f4xx_ll_fsmc.h"
Anna Bridge 160:5571c4ff569f 50 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F412Zx || STM32F412Vx || STM32F412Rx || STM32F413xx || STM32F423xx */
Anna Bridge 160:5571c4ff569f 51
Anna Bridge 160:5571c4ff569f 52 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx)|| defined(STM32F439xx) ||\
Anna Bridge 160:5571c4ff569f 53 defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
Anna Bridge 160:5571c4ff569f 54 #include "stm32f4xx_ll_fmc.h"
Anna Bridge 160:5571c4ff569f 55 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx */
Anna Bridge 160:5571c4ff569f 56
Anna Bridge 160:5571c4ff569f 57
Anna Bridge 160:5571c4ff569f 58 /** @addtogroup STM32F4xx_HAL_Driver
Anna Bridge 160:5571c4ff569f 59 * @{
Anna Bridge 160:5571c4ff569f 60 */
Anna Bridge 160:5571c4ff569f 61
Anna Bridge 160:5571c4ff569f 62 #if defined(STM32F405xx) || defined(STM32F415xx) || defined(STM32F407xx) || defined(STM32F417xx) ||\
Anna Bridge 160:5571c4ff569f 63 defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
Anna Bridge 160:5571c4ff569f 64 defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx) || defined(STM32F412Zx) ||\
Anna Bridge 160:5571c4ff569f 65 defined(STM32F412Vx) || defined(STM32F412Rx) || defined(STM32F413xx) || defined(STM32F423xx)
Anna Bridge 160:5571c4ff569f 66
Anna Bridge 160:5571c4ff569f 67 /** @addtogroup SRAM
Anna Bridge 160:5571c4ff569f 68 * @{
Anna Bridge 160:5571c4ff569f 69 */
Anna Bridge 160:5571c4ff569f 70
Anna Bridge 160:5571c4ff569f 71 /* Exported typedef ----------------------------------------------------------*/
Anna Bridge 160:5571c4ff569f 72
Anna Bridge 160:5571c4ff569f 73 /** @defgroup SRAM_Exported_Types SRAM Exported Types
Anna Bridge 160:5571c4ff569f 74 * @{
Anna Bridge 160:5571c4ff569f 75 */
Anna Bridge 160:5571c4ff569f 76 /**
Anna Bridge 160:5571c4ff569f 77 * @brief HAL SRAM State structures definition
Anna Bridge 160:5571c4ff569f 78 */
Anna Bridge 160:5571c4ff569f 79 typedef enum
Anna Bridge 160:5571c4ff569f 80 {
Anna Bridge 160:5571c4ff569f 81 HAL_SRAM_STATE_RESET = 0x00U, /*!< SRAM not yet initialized or disabled */
Anna Bridge 160:5571c4ff569f 82 HAL_SRAM_STATE_READY = 0x01U, /*!< SRAM initialized and ready for use */
Anna Bridge 160:5571c4ff569f 83 HAL_SRAM_STATE_BUSY = 0x02U, /*!< SRAM internal process is ongoing */
Anna Bridge 160:5571c4ff569f 84 HAL_SRAM_STATE_ERROR = 0x03U, /*!< SRAM error state */
Anna Bridge 160:5571c4ff569f 85 HAL_SRAM_STATE_PROTECTED = 0x04U /*!< SRAM peripheral NORSRAM device write protected */
Anna Bridge 160:5571c4ff569f 86
Anna Bridge 160:5571c4ff569f 87 }HAL_SRAM_StateTypeDef;
Anna Bridge 160:5571c4ff569f 88
Anna Bridge 160:5571c4ff569f 89 /**
Anna Bridge 160:5571c4ff569f 90 * @brief SRAM handle Structure definition
Anna Bridge 160:5571c4ff569f 91 */
Anna Bridge 160:5571c4ff569f 92 typedef struct
Anna Bridge 160:5571c4ff569f 93 {
Anna Bridge 160:5571c4ff569f 94 FMC_NORSRAM_TypeDef *Instance; /*!< Register base address */
Anna Bridge 160:5571c4ff569f 95
Anna Bridge 160:5571c4ff569f 96 FMC_NORSRAM_EXTENDED_TypeDef *Extended; /*!< Extended mode register base address */
Anna Bridge 160:5571c4ff569f 97
Anna Bridge 160:5571c4ff569f 98 FMC_NORSRAM_InitTypeDef Init; /*!< SRAM device control configuration parameters */
Anna Bridge 160:5571c4ff569f 99
Anna Bridge 160:5571c4ff569f 100 HAL_LockTypeDef Lock; /*!< SRAM locking object */
Anna Bridge 160:5571c4ff569f 101
Anna Bridge 160:5571c4ff569f 102 __IO HAL_SRAM_StateTypeDef State; /*!< SRAM device access state */
Anna Bridge 160:5571c4ff569f 103
Anna Bridge 160:5571c4ff569f 104 DMA_HandleTypeDef *hdma; /*!< Pointer DMA handler */
Anna Bridge 160:5571c4ff569f 105
Anna Bridge 160:5571c4ff569f 106 }SRAM_HandleTypeDef;
Anna Bridge 160:5571c4ff569f 107
Anna Bridge 160:5571c4ff569f 108 /**
Anna Bridge 160:5571c4ff569f 109 * @}
Anna Bridge 160:5571c4ff569f 110 */
Anna Bridge 160:5571c4ff569f 111
Anna Bridge 160:5571c4ff569f 112 /* Exported constants --------------------------------------------------------*/
Anna Bridge 160:5571c4ff569f 113 /* Exported macro ------------------------------------------------------------*/
Anna Bridge 160:5571c4ff569f 114
Anna Bridge 160:5571c4ff569f 115 /** @defgroup SRAM_Exported_Macros SRAM Exported Macros
Anna Bridge 160:5571c4ff569f 116 * @{
Anna Bridge 160:5571c4ff569f 117 */
Anna Bridge 160:5571c4ff569f 118 /** @brief Reset SRAM handle state
Anna Bridge 160:5571c4ff569f 119 * @param __HANDLE__: SRAM handle
Anna Bridge 160:5571c4ff569f 120 * @retval None
Anna Bridge 160:5571c4ff569f 121 */
Anna Bridge 160:5571c4ff569f 122 #define __HAL_SRAM_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SRAM_STATE_RESET)
Anna Bridge 160:5571c4ff569f 123
Anna Bridge 160:5571c4ff569f 124 /**
Anna Bridge 160:5571c4ff569f 125 * @}
Anna Bridge 160:5571c4ff569f 126 */
Anna Bridge 160:5571c4ff569f 127 /* Exported functions --------------------------------------------------------*/
Anna Bridge 160:5571c4ff569f 128
Anna Bridge 160:5571c4ff569f 129 /** @addtogroup SRAM_Exported_Functions
Anna Bridge 160:5571c4ff569f 130 * @{
Anna Bridge 160:5571c4ff569f 131 */
Anna Bridge 160:5571c4ff569f 132
Anna Bridge 160:5571c4ff569f 133 /** @addtogroup SRAM_Exported_Functions_Group1
Anna Bridge 160:5571c4ff569f 134 * @{
Anna Bridge 160:5571c4ff569f 135 */
Anna Bridge 160:5571c4ff569f 136 /* Initialization/de-initialization functions **********************************/
Anna Bridge 160:5571c4ff569f 137 HAL_StatusTypeDef HAL_SRAM_Init(SRAM_HandleTypeDef *hsram, FMC_NORSRAM_TimingTypeDef *Timing, FMC_NORSRAM_TimingTypeDef *ExtTiming);
Anna Bridge 160:5571c4ff569f 138 HAL_StatusTypeDef HAL_SRAM_DeInit(SRAM_HandleTypeDef *hsram);
Anna Bridge 160:5571c4ff569f 139 void HAL_SRAM_MspInit(SRAM_HandleTypeDef *hsram);
Anna Bridge 160:5571c4ff569f 140 void HAL_SRAM_MspDeInit(SRAM_HandleTypeDef *hsram);
Anna Bridge 160:5571c4ff569f 141
Anna Bridge 160:5571c4ff569f 142 void HAL_SRAM_DMA_XferCpltCallback(DMA_HandleTypeDef *hdma);
Anna Bridge 160:5571c4ff569f 143 void HAL_SRAM_DMA_XferErrorCallback(DMA_HandleTypeDef *hdma);
Anna Bridge 160:5571c4ff569f 144 /**
Anna Bridge 160:5571c4ff569f 145 * @}
Anna Bridge 160:5571c4ff569f 146 */
Anna Bridge 160:5571c4ff569f 147
Anna Bridge 160:5571c4ff569f 148 /** @addtogroup SRAM_Exported_Functions_Group2
Anna Bridge 160:5571c4ff569f 149 * @{
Anna Bridge 160:5571c4ff569f 150 */
Anna Bridge 160:5571c4ff569f 151 /* I/O operation functions *****************************************************/
Anna Bridge 160:5571c4ff569f 152 HAL_StatusTypeDef HAL_SRAM_Read_8b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint8_t *pDstBuffer, uint32_t BufferSize);
Anna Bridge 160:5571c4ff569f 153 HAL_StatusTypeDef HAL_SRAM_Write_8b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint8_t *pSrcBuffer, uint32_t BufferSize);
Anna Bridge 160:5571c4ff569f 154 HAL_StatusTypeDef HAL_SRAM_Read_16b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint16_t *pDstBuffer, uint32_t BufferSize);
Anna Bridge 160:5571c4ff569f 155 HAL_StatusTypeDef HAL_SRAM_Write_16b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint16_t *pSrcBuffer, uint32_t BufferSize);
Anna Bridge 160:5571c4ff569f 156 HAL_StatusTypeDef HAL_SRAM_Read_32b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint32_t *pDstBuffer, uint32_t BufferSize);
Anna Bridge 160:5571c4ff569f 157 HAL_StatusTypeDef HAL_SRAM_Write_32b(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint32_t *pSrcBuffer, uint32_t BufferSize);
Anna Bridge 160:5571c4ff569f 158 HAL_StatusTypeDef HAL_SRAM_Read_DMA(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint32_t *pDstBuffer, uint32_t BufferSize);
Anna Bridge 160:5571c4ff569f 159 HAL_StatusTypeDef HAL_SRAM_Write_DMA(SRAM_HandleTypeDef *hsram, uint32_t *pAddress, uint32_t *pSrcBuffer, uint32_t BufferSize);
Anna Bridge 160:5571c4ff569f 160 /**
Anna Bridge 160:5571c4ff569f 161 * @}
Anna Bridge 160:5571c4ff569f 162 */
Anna Bridge 160:5571c4ff569f 163
Anna Bridge 160:5571c4ff569f 164 /** @addtogroup SRAM_Exported_Functions_Group3
Anna Bridge 160:5571c4ff569f 165 * @{
Anna Bridge 160:5571c4ff569f 166 */
Anna Bridge 160:5571c4ff569f 167 /* SRAM Control functions ******************************************************/
Anna Bridge 160:5571c4ff569f 168 HAL_StatusTypeDef HAL_SRAM_WriteOperation_Enable(SRAM_HandleTypeDef *hsram);
Anna Bridge 160:5571c4ff569f 169 HAL_StatusTypeDef HAL_SRAM_WriteOperation_Disable(SRAM_HandleTypeDef *hsram);
Anna Bridge 160:5571c4ff569f 170 /**
Anna Bridge 160:5571c4ff569f 171 * @}
Anna Bridge 160:5571c4ff569f 172 */
Anna Bridge 160:5571c4ff569f 173
Anna Bridge 160:5571c4ff569f 174 /** @addtogroup SRAM_Exported_Functions_Group4
Anna Bridge 160:5571c4ff569f 175 * @{
Anna Bridge 160:5571c4ff569f 176 */
Anna Bridge 160:5571c4ff569f 177 /* SRAM State functions *********************************************************/
Anna Bridge 160:5571c4ff569f 178 HAL_SRAM_StateTypeDef HAL_SRAM_GetState(SRAM_HandleTypeDef *hsram);
Anna Bridge 160:5571c4ff569f 179 /**
Anna Bridge 160:5571c4ff569f 180 * @}
Anna Bridge 160:5571c4ff569f 181 */
Anna Bridge 160:5571c4ff569f 182
Anna Bridge 160:5571c4ff569f 183 /**
Anna Bridge 160:5571c4ff569f 184 * @}
Anna Bridge 160:5571c4ff569f 185 */
Anna Bridge 160:5571c4ff569f 186
Anna Bridge 160:5571c4ff569f 187 /* Private types -------------------------------------------------------------*/
Anna Bridge 160:5571c4ff569f 188 /* Private variables ---------------------------------------------------------*/
Anna Bridge 160:5571c4ff569f 189 /* Private constants ---------------------------------------------------------*/
Anna Bridge 160:5571c4ff569f 190 /* Private macros ------------------------------------------------------------*/
Anna Bridge 160:5571c4ff569f 191 /* Private functions ---------------------------------------------------------*/
Anna Bridge 160:5571c4ff569f 192 /**
Anna Bridge 160:5571c4ff569f 193 * @}
Anna Bridge 160:5571c4ff569f 194 */
Anna Bridge 160:5571c4ff569f 195
Anna Bridge 160:5571c4ff569f 196 #endif /* STM32F405xx || STM32F415xx || STM32F407xx || STM32F417xx || STM32F427xx || STM32F437xx ||\
Anna Bridge 160:5571c4ff569f 197 STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx || STM32F412Zx ||\
Anna Bridge 160:5571c4ff569f 198 STM32F412Vx || STM32F412Rx || STM32F413xx || STM32F423xx */
Anna Bridge 160:5571c4ff569f 199 /**
Anna Bridge 160:5571c4ff569f 200 * @}
Anna Bridge 160:5571c4ff569f 201 */
Anna Bridge 160:5571c4ff569f 202 #ifdef __cplusplus
Anna Bridge 160:5571c4ff569f 203 }
Anna Bridge 160:5571c4ff569f 204 #endif
Anna Bridge 160:5571c4ff569f 205
Anna Bridge 160:5571c4ff569f 206 #endif /* __STM32F4xx_HAL_SRAM_H */
Anna Bridge 160:5571c4ff569f 207
Anna Bridge 160:5571c4ff569f 208 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/