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_sdram.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_sdram.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 SDRAM 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_SDRAM_H
bogdanm 86:04dd9b1680ae 40 #define __STM32F4xx_HAL_SDRAM_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
Kojto 110:165afa46840b 46 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
Kojto 110:165afa46840b 47 defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
bogdanm 86:04dd9b1680ae 48
bogdanm 86:04dd9b1680ae 49 /* Includes ------------------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 50 #include "stm32f4xx_ll_fmc.h"
bogdanm 86:04dd9b1680ae 51
bogdanm 86:04dd9b1680ae 52 /** @addtogroup STM32F4xx_HAL_Driver
bogdanm 86:04dd9b1680ae 53 * @{
bogdanm 86:04dd9b1680ae 54 */
bogdanm 86:04dd9b1680ae 55
bogdanm 86:04dd9b1680ae 56 /** @addtogroup SDRAM
bogdanm 86:04dd9b1680ae 57 * @{
bogdanm 86:04dd9b1680ae 58 */
bogdanm 86:04dd9b1680ae 59
bogdanm 86:04dd9b1680ae 60 /* Exported typedef ----------------------------------------------------------*/
Kojto 99:dbbf35b96557 61 /** @defgroup SDRAM_Exported_Types SDRAM Exported Types
Kojto 99:dbbf35b96557 62 * @{
Kojto 99:dbbf35b96557 63 */
bogdanm 86:04dd9b1680ae 64
bogdanm 86:04dd9b1680ae 65 /**
bogdanm 86:04dd9b1680ae 66 * @brief HAL SDRAM State structure definition
bogdanm 86:04dd9b1680ae 67 */
bogdanm 86:04dd9b1680ae 68 typedef enum
bogdanm 86:04dd9b1680ae 69 {
bogdanm 86:04dd9b1680ae 70 HAL_SDRAM_STATE_RESET = 0x00, /*!< SDRAM not yet initialized or disabled */
bogdanm 86:04dd9b1680ae 71 HAL_SDRAM_STATE_READY = 0x01, /*!< SDRAM initialized and ready for use */
bogdanm 86:04dd9b1680ae 72 HAL_SDRAM_STATE_BUSY = 0x02, /*!< SDRAM internal process is ongoing */
bogdanm 86:04dd9b1680ae 73 HAL_SDRAM_STATE_ERROR = 0x03, /*!< SDRAM error state */
bogdanm 86:04dd9b1680ae 74 HAL_SDRAM_STATE_WRITE_PROTECTED = 0x04, /*!< SDRAM device write protected */
bogdanm 86:04dd9b1680ae 75 HAL_SDRAM_STATE_PRECHARGED = 0x05 /*!< SDRAM device precharged */
bogdanm 86:04dd9b1680ae 76
bogdanm 86:04dd9b1680ae 77 }HAL_SDRAM_StateTypeDef;
bogdanm 86:04dd9b1680ae 78
bogdanm 86:04dd9b1680ae 79 /**
bogdanm 86:04dd9b1680ae 80 * @brief SDRAM handle Structure definition
bogdanm 86:04dd9b1680ae 81 */
bogdanm 86:04dd9b1680ae 82 typedef struct
bogdanm 86:04dd9b1680ae 83 {
bogdanm 86:04dd9b1680ae 84 FMC_SDRAM_TypeDef *Instance; /*!< Register base address */
bogdanm 86:04dd9b1680ae 85
bogdanm 86:04dd9b1680ae 86 FMC_SDRAM_InitTypeDef Init; /*!< SDRAM device configuration parameters */
bogdanm 86:04dd9b1680ae 87
bogdanm 86:04dd9b1680ae 88 __IO HAL_SDRAM_StateTypeDef State; /*!< SDRAM access state */
bogdanm 86:04dd9b1680ae 89
bogdanm 86:04dd9b1680ae 90 HAL_LockTypeDef Lock; /*!< SDRAM locking object */
bogdanm 86:04dd9b1680ae 91
bogdanm 86:04dd9b1680ae 92 DMA_HandleTypeDef *hdma; /*!< Pointer DMA handler */
bogdanm 86:04dd9b1680ae 93
bogdanm 86:04dd9b1680ae 94 }SDRAM_HandleTypeDef;
Kojto 99:dbbf35b96557 95 /**
Kojto 99:dbbf35b96557 96 * @}
Kojto 99:dbbf35b96557 97 */
Kojto 99:dbbf35b96557 98
Kojto 99:dbbf35b96557 99 /* Exported constants --------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 100 /* Exported macro ------------------------------------------------------------*/
Kojto 99:dbbf35b96557 101 /** @defgroup SDRAM_Exported_Macros SDRAM Exported Macros
Kojto 99:dbbf35b96557 102 * @{
Kojto 99:dbbf35b96557 103 */
bogdanm 86:04dd9b1680ae 104
bogdanm 86:04dd9b1680ae 105 /** @brief Reset SDRAM handle state
bogdanm 86:04dd9b1680ae 106 * @param __HANDLE__: specifies the SDRAM handle.
bogdanm 86:04dd9b1680ae 107 * @retval None
bogdanm 86:04dd9b1680ae 108 */
bogdanm 86:04dd9b1680ae 109 #define __HAL_SDRAM_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SDRAM_STATE_RESET)
Kojto 99:dbbf35b96557 110 /**
Kojto 99:dbbf35b96557 111 * @}
Kojto 99:dbbf35b96557 112 */
bogdanm 86:04dd9b1680ae 113
bogdanm 86:04dd9b1680ae 114 /* Exported functions --------------------------------------------------------*/
Kojto 99:dbbf35b96557 115 /** @addtogroup SDRAM_Exported_Functions SDRAM Exported Functions
Kojto 99:dbbf35b96557 116 * @{
Kojto 99:dbbf35b96557 117 */
bogdanm 86:04dd9b1680ae 118
Kojto 99:dbbf35b96557 119 /** @addtogroup SDRAM_Exported_Functions_Group1
Kojto 99:dbbf35b96557 120 * @{
Kojto 99:dbbf35b96557 121 */
Kojto 99:dbbf35b96557 122
Kojto 99:dbbf35b96557 123 /* Initialization/de-initialization functions *********************************/
bogdanm 86:04dd9b1680ae 124 HAL_StatusTypeDef HAL_SDRAM_Init(SDRAM_HandleTypeDef *hsdram, FMC_SDRAM_TimingTypeDef *Timing);
bogdanm 86:04dd9b1680ae 125 HAL_StatusTypeDef HAL_SDRAM_DeInit(SDRAM_HandleTypeDef *hsdram);
bogdanm 86:04dd9b1680ae 126 void HAL_SDRAM_MspInit(SDRAM_HandleTypeDef *hsdram);
bogdanm 86:04dd9b1680ae 127 void HAL_SDRAM_MspDeInit(SDRAM_HandleTypeDef *hsdram);
bogdanm 86:04dd9b1680ae 128
bogdanm 86:04dd9b1680ae 129 void HAL_SDRAM_IRQHandler(SDRAM_HandleTypeDef *hsdram);
bogdanm 86:04dd9b1680ae 130 void HAL_SDRAM_RefreshErrorCallback(SDRAM_HandleTypeDef *hsdram);
bogdanm 86:04dd9b1680ae 131 void HAL_SDRAM_DMA_XferCpltCallback(DMA_HandleTypeDef *hdma);
bogdanm 86:04dd9b1680ae 132 void HAL_SDRAM_DMA_XferErrorCallback(DMA_HandleTypeDef *hdma);
Kojto 99:dbbf35b96557 133 /**
Kojto 99:dbbf35b96557 134 * @}
Kojto 99:dbbf35b96557 135 */
bogdanm 86:04dd9b1680ae 136
Kojto 99:dbbf35b96557 137 /** @addtogroup SDRAM_Exported_Functions_Group2
Kojto 99:dbbf35b96557 138 * @{
Kojto 99:dbbf35b96557 139 */
Kojto 99:dbbf35b96557 140 /* I/O operation functions ****************************************************/
bogdanm 86:04dd9b1680ae 141 HAL_StatusTypeDef HAL_SDRAM_Read_8b(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint8_t *pDstBuffer, uint32_t BufferSize);
bogdanm 86:04dd9b1680ae 142 HAL_StatusTypeDef HAL_SDRAM_Write_8b(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint8_t *pSrcBuffer, uint32_t BufferSize);
bogdanm 86:04dd9b1680ae 143 HAL_StatusTypeDef HAL_SDRAM_Read_16b(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint16_t *pDstBuffer, uint32_t BufferSize);
bogdanm 86:04dd9b1680ae 144 HAL_StatusTypeDef HAL_SDRAM_Write_16b(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint16_t *pSrcBuffer, uint32_t BufferSize);
bogdanm 86:04dd9b1680ae 145 HAL_StatusTypeDef HAL_SDRAM_Read_32b(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint32_t *pDstBuffer, uint32_t BufferSize);
bogdanm 86:04dd9b1680ae 146 HAL_StatusTypeDef HAL_SDRAM_Write_32b(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint32_t *pSrcBuffer, uint32_t BufferSize);
bogdanm 86:04dd9b1680ae 147
bogdanm 86:04dd9b1680ae 148 HAL_StatusTypeDef HAL_SDRAM_Read_DMA(SDRAM_HandleTypeDef *hsdram, uint32_t * pAddress, uint32_t *pDstBuffer, uint32_t BufferSize);
bogdanm 86:04dd9b1680ae 149 HAL_StatusTypeDef HAL_SDRAM_Write_DMA(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint32_t *pSrcBuffer, uint32_t BufferSize);
Kojto 99:dbbf35b96557 150 /**
Kojto 99:dbbf35b96557 151 * @}
Kojto 99:dbbf35b96557 152 */
Kojto 99:dbbf35b96557 153
Kojto 99:dbbf35b96557 154 /** @addtogroup SDRAM_Exported_Functions_Group3
Kojto 99:dbbf35b96557 155 * @{
Kojto 99:dbbf35b96557 156 */
bogdanm 86:04dd9b1680ae 157 /* SDRAM Control functions *****************************************************/
bogdanm 86:04dd9b1680ae 158 HAL_StatusTypeDef HAL_SDRAM_WriteProtection_Enable(SDRAM_HandleTypeDef *hsdram);
bogdanm 86:04dd9b1680ae 159 HAL_StatusTypeDef HAL_SDRAM_WriteProtection_Disable(SDRAM_HandleTypeDef *hsdram);
bogdanm 86:04dd9b1680ae 160 HAL_StatusTypeDef HAL_SDRAM_SendCommand(SDRAM_HandleTypeDef *hsdram, FMC_SDRAM_CommandTypeDef *Command, uint32_t Timeout);
bogdanm 86:04dd9b1680ae 161 HAL_StatusTypeDef HAL_SDRAM_ProgramRefreshRate(SDRAM_HandleTypeDef *hsdram, uint32_t RefreshRate);
bogdanm 86:04dd9b1680ae 162 HAL_StatusTypeDef HAL_SDRAM_SetAutoRefreshNumber(SDRAM_HandleTypeDef *hsdram, uint32_t AutoRefreshNumber);
bogdanm 86:04dd9b1680ae 163 uint32_t HAL_SDRAM_GetModeStatus(SDRAM_HandleTypeDef *hsdram);
Kojto 99:dbbf35b96557 164 /**
Kojto 99:dbbf35b96557 165 * @}
Kojto 99:dbbf35b96557 166 */
bogdanm 86:04dd9b1680ae 167
Kojto 99:dbbf35b96557 168 /** @addtogroup SDRAM_Exported_Functions_Group4
Kojto 99:dbbf35b96557 169 * @{
Kojto 99:dbbf35b96557 170 */
bogdanm 86:04dd9b1680ae 171 /* SDRAM State functions ********************************************************/
bogdanm 86:04dd9b1680ae 172 HAL_SDRAM_StateTypeDef HAL_SDRAM_GetState(SDRAM_HandleTypeDef *hsdram);
Kojto 99:dbbf35b96557 173 /**
Kojto 99:dbbf35b96557 174 * @}
Kojto 99:dbbf35b96557 175 */
bogdanm 86:04dd9b1680ae 176
bogdanm 86:04dd9b1680ae 177 /**
bogdanm 86:04dd9b1680ae 178 * @}
Kojto 99:dbbf35b96557 179 */
Kojto 99:dbbf35b96557 180
Kojto 99:dbbf35b96557 181 /**
Kojto 99:dbbf35b96557 182 * @}
Kojto 99:dbbf35b96557 183 */
Kojto 99:dbbf35b96557 184
Kojto 110:165afa46840b 185 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx */
bogdanm 86:04dd9b1680ae 186
bogdanm 86:04dd9b1680ae 187 /**
bogdanm 86:04dd9b1680ae 188 * @}
bogdanm 86:04dd9b1680ae 189 */
bogdanm 86:04dd9b1680ae 190
bogdanm 86:04dd9b1680ae 191 #ifdef __cplusplus
bogdanm 86:04dd9b1680ae 192 }
bogdanm 86:04dd9b1680ae 193 #endif
bogdanm 86:04dd9b1680ae 194
bogdanm 86:04dd9b1680ae 195 #endif /* __STM32F4xx_HAL_SDRAM_H */
bogdanm 86:04dd9b1680ae 196
bogdanm 86:04dd9b1680ae 197 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/