Elijah Orr / mbed-renbed

Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

TARGET_NUCLEO_F411RE/stm32f4xx_hal_sram.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
110:165afa46840b 
.

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