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_B96B_F446VE/TARGET_STM/TARGET_STM32F4/device/stm32f4xx_hal_sram.h@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
163:e59c8e839560 
mbed library. Release version 162

Who changed what in which revision?

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