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_F411RE/stm32f4xx_hal_sram.h@99:7f6c6de930c0, 2015-05-03 (annotated)

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

Who changed what in which revision?

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