Egor Rumjantsev / mbed

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

Fork of mbed by mbed official

TARGET_NUCLEO_F303RE/stm32f3xx_hal_sram.h@99:7f6c6de930c0, 2015-05-03 (annotated)

Committer:
Mikchel
Date:
Sun May 03 16:04:42 2015 +0000
Revision:
99:7f6c6de930c0
Parent:
93:e188a91d3eaa 
12

Who changed what in which revision?

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