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_F410RB/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
Kojto 110:165afa46840b 1 /**
Kojto 110:165afa46840b 2 ******************************************************************************
Kojto 110:165afa46840b 3 * @file stm32f4xx_hal_sdram.h
Kojto 110:165afa46840b 4 * @author MCD Application Team
Kojto 110:165afa46840b 5 * @version V1.4.1
Kojto 110:165afa46840b 6 * @date 09-October-2015
Kojto 110:165afa46840b 7 * @brief Header file of SDRAM HAL module.
Kojto 110:165afa46840b 8 ******************************************************************************
Kojto 110:165afa46840b 9 * @attention
Kojto 110:165afa46840b 10 *
Kojto 110:165afa46840b 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Kojto 110:165afa46840b 12 *
Kojto 110:165afa46840b 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 110:165afa46840b 14 * are permitted provided that the following conditions are met:
Kojto 110:165afa46840b 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 110:165afa46840b 16 * this list of conditions and the following disclaimer.
Kojto 110:165afa46840b 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 110:165afa46840b 18 * this list of conditions and the following disclaimer in the documentation
Kojto 110:165afa46840b 19 * and/or other materials provided with the distribution.
Kojto 110:165afa46840b 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 110:165afa46840b 21 * may be used to endorse or promote products derived from this software
Kojto 110:165afa46840b 22 * without specific prior written permission.
Kojto 110:165afa46840b 23 *
Kojto 110:165afa46840b 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 110:165afa46840b 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 110:165afa46840b 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 110:165afa46840b 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 110:165afa46840b 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 110:165afa46840b 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 110:165afa46840b 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 110:165afa46840b 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 110:165afa46840b 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 110:165afa46840b 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 110:165afa46840b 34 *
Kojto 110:165afa46840b 35 ******************************************************************************
Kojto 110:165afa46840b 36 */
Kojto 110:165afa46840b 37
Kojto 110:165afa46840b 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 110:165afa46840b 39 #ifndef __STM32F4xx_HAL_SDRAM_H
Kojto 110:165afa46840b 40 #define __STM32F4xx_HAL_SDRAM_H
Kojto 110:165afa46840b 41
Kojto 110:165afa46840b 42 #ifdef __cplusplus
Kojto 110:165afa46840b 43 extern "C" {
Kojto 110:165afa46840b 44 #endif
Kojto 110:165afa46840b 45
Kojto 110:165afa46840b 46 #if defined(STM32F427xx) || defined(STM32F437xx) || defined(STM32F429xx) || defined(STM32F439xx) ||\
Kojto 110:165afa46840b 47 defined(STM32F446xx) || defined(STM32F469xx) || defined(STM32F479xx)
Kojto 110:165afa46840b 48
Kojto 110:165afa46840b 49 /* Includes ------------------------------------------------------------------*/
Kojto 110:165afa46840b 50 #include "stm32f4xx_ll_fmc.h"
Kojto 110:165afa46840b 51
Kojto 110:165afa46840b 52 /** @addtogroup STM32F4xx_HAL_Driver
Kojto 110:165afa46840b 53 * @{
Kojto 110:165afa46840b 54 */
Kojto 110:165afa46840b 55
Kojto 110:165afa46840b 56 /** @addtogroup SDRAM
Kojto 110:165afa46840b 57 * @{
Kojto 110:165afa46840b 58 */
Kojto 110:165afa46840b 59
Kojto 110:165afa46840b 60 /* Exported typedef ----------------------------------------------------------*/
Kojto 110:165afa46840b 61 /** @defgroup SDRAM_Exported_Types SDRAM Exported Types
Kojto 110:165afa46840b 62 * @{
Kojto 110:165afa46840b 63 */
Kojto 110:165afa46840b 64
Kojto 110:165afa46840b 65 /**
Kojto 110:165afa46840b 66 * @brief HAL SDRAM State structure definition
Kojto 110:165afa46840b 67 */
Kojto 110:165afa46840b 68 typedef enum
Kojto 110:165afa46840b 69 {
Kojto 110:165afa46840b 70 HAL_SDRAM_STATE_RESET = 0x00, /*!< SDRAM not yet initialized or disabled */
Kojto 110:165afa46840b 71 HAL_SDRAM_STATE_READY = 0x01, /*!< SDRAM initialized and ready for use */
Kojto 110:165afa46840b 72 HAL_SDRAM_STATE_BUSY = 0x02, /*!< SDRAM internal process is ongoing */
Kojto 110:165afa46840b 73 HAL_SDRAM_STATE_ERROR = 0x03, /*!< SDRAM error state */
Kojto 110:165afa46840b 74 HAL_SDRAM_STATE_WRITE_PROTECTED = 0x04, /*!< SDRAM device write protected */
Kojto 110:165afa46840b 75 HAL_SDRAM_STATE_PRECHARGED = 0x05 /*!< SDRAM device precharged */
Kojto 110:165afa46840b 76
Kojto 110:165afa46840b 77 }HAL_SDRAM_StateTypeDef;
Kojto 110:165afa46840b 78
Kojto 110:165afa46840b 79 /**
Kojto 110:165afa46840b 80 * @brief SDRAM handle Structure definition
Kojto 110:165afa46840b 81 */
Kojto 110:165afa46840b 82 typedef struct
Kojto 110:165afa46840b 83 {
Kojto 110:165afa46840b 84 FMC_SDRAM_TypeDef *Instance; /*!< Register base address */
Kojto 110:165afa46840b 85
Kojto 110:165afa46840b 86 FMC_SDRAM_InitTypeDef Init; /*!< SDRAM device configuration parameters */
Kojto 110:165afa46840b 87
Kojto 110:165afa46840b 88 __IO HAL_SDRAM_StateTypeDef State; /*!< SDRAM access state */
Kojto 110:165afa46840b 89
Kojto 110:165afa46840b 90 HAL_LockTypeDef Lock; /*!< SDRAM locking object */
Kojto 110:165afa46840b 91
Kojto 110:165afa46840b 92 DMA_HandleTypeDef *hdma; /*!< Pointer DMA handler */
Kojto 110:165afa46840b 93
Kojto 110:165afa46840b 94 }SDRAM_HandleTypeDef;
Kojto 110:165afa46840b 95 /**
Kojto 110:165afa46840b 96 * @}
Kojto 110:165afa46840b 97 */
Kojto 110:165afa46840b 98
Kojto 110:165afa46840b 99 /* Exported constants --------------------------------------------------------*/
Kojto 110:165afa46840b 100 /* Exported macro ------------------------------------------------------------*/
Kojto 110:165afa46840b 101 /** @defgroup SDRAM_Exported_Macros SDRAM Exported Macros
Kojto 110:165afa46840b 102 * @{
Kojto 110:165afa46840b 103 */
Kojto 110:165afa46840b 104
Kojto 110:165afa46840b 105 /** @brief Reset SDRAM handle state
Kojto 110:165afa46840b 106 * @param __HANDLE__: specifies the SDRAM handle.
Kojto 110:165afa46840b 107 * @retval None
Kojto 110:165afa46840b 108 */
Kojto 110:165afa46840b 109 #define __HAL_SDRAM_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SDRAM_STATE_RESET)
Kojto 110:165afa46840b 110 /**
Kojto 110:165afa46840b 111 * @}
Kojto 110:165afa46840b 112 */
Kojto 110:165afa46840b 113
Kojto 110:165afa46840b 114 /* Exported functions --------------------------------------------------------*/
Kojto 110:165afa46840b 115 /** @addtogroup SDRAM_Exported_Functions SDRAM Exported Functions
Kojto 110:165afa46840b 116 * @{
Kojto 110:165afa46840b 117 */
Kojto 110:165afa46840b 118
Kojto 110:165afa46840b 119 /** @addtogroup SDRAM_Exported_Functions_Group1
Kojto 110:165afa46840b 120 * @{
Kojto 110:165afa46840b 121 */
Kojto 110:165afa46840b 122
Kojto 110:165afa46840b 123 /* Initialization/de-initialization functions *********************************/
Kojto 110:165afa46840b 124 HAL_StatusTypeDef HAL_SDRAM_Init(SDRAM_HandleTypeDef *hsdram, FMC_SDRAM_TimingTypeDef *Timing);
Kojto 110:165afa46840b 125 HAL_StatusTypeDef HAL_SDRAM_DeInit(SDRAM_HandleTypeDef *hsdram);
Kojto 110:165afa46840b 126 void HAL_SDRAM_MspInit(SDRAM_HandleTypeDef *hsdram);
Kojto 110:165afa46840b 127 void HAL_SDRAM_MspDeInit(SDRAM_HandleTypeDef *hsdram);
Kojto 110:165afa46840b 128
Kojto 110:165afa46840b 129 void HAL_SDRAM_IRQHandler(SDRAM_HandleTypeDef *hsdram);
Kojto 110:165afa46840b 130 void HAL_SDRAM_RefreshErrorCallback(SDRAM_HandleTypeDef *hsdram);
Kojto 110:165afa46840b 131 void HAL_SDRAM_DMA_XferCpltCallback(DMA_HandleTypeDef *hdma);
Kojto 110:165afa46840b 132 void HAL_SDRAM_DMA_XferErrorCallback(DMA_HandleTypeDef *hdma);
Kojto 110:165afa46840b 133 /**
Kojto 110:165afa46840b 134 * @}
Kojto 110:165afa46840b 135 */
Kojto 110:165afa46840b 136
Kojto 110:165afa46840b 137 /** @addtogroup SDRAM_Exported_Functions_Group2
Kojto 110:165afa46840b 138 * @{
Kojto 110:165afa46840b 139 */
Kojto 110:165afa46840b 140 /* I/O operation functions ****************************************************/
Kojto 110:165afa46840b 141 HAL_StatusTypeDef HAL_SDRAM_Read_8b(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint8_t *pDstBuffer, uint32_t BufferSize);
Kojto 110:165afa46840b 142 HAL_StatusTypeDef HAL_SDRAM_Write_8b(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint8_t *pSrcBuffer, uint32_t BufferSize);
Kojto 110:165afa46840b 143 HAL_StatusTypeDef HAL_SDRAM_Read_16b(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint16_t *pDstBuffer, uint32_t BufferSize);
Kojto 110:165afa46840b 144 HAL_StatusTypeDef HAL_SDRAM_Write_16b(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint16_t *pSrcBuffer, uint32_t BufferSize);
Kojto 110:165afa46840b 145 HAL_StatusTypeDef HAL_SDRAM_Read_32b(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint32_t *pDstBuffer, uint32_t BufferSize);
Kojto 110:165afa46840b 146 HAL_StatusTypeDef HAL_SDRAM_Write_32b(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint32_t *pSrcBuffer, uint32_t BufferSize);
Kojto 110:165afa46840b 147
Kojto 110:165afa46840b 148 HAL_StatusTypeDef HAL_SDRAM_Read_DMA(SDRAM_HandleTypeDef *hsdram, uint32_t * pAddress, uint32_t *pDstBuffer, uint32_t BufferSize);
Kojto 110:165afa46840b 149 HAL_StatusTypeDef HAL_SDRAM_Write_DMA(SDRAM_HandleTypeDef *hsdram, uint32_t *pAddress, uint32_t *pSrcBuffer, uint32_t BufferSize);
Kojto 110:165afa46840b 150 /**
Kojto 110:165afa46840b 151 * @}
Kojto 110:165afa46840b 152 */
Kojto 110:165afa46840b 153
Kojto 110:165afa46840b 154 /** @addtogroup SDRAM_Exported_Functions_Group3
Kojto 110:165afa46840b 155 * @{
Kojto 110:165afa46840b 156 */
Kojto 110:165afa46840b 157 /* SDRAM Control functions *****************************************************/
Kojto 110:165afa46840b 158 HAL_StatusTypeDef HAL_SDRAM_WriteProtection_Enable(SDRAM_HandleTypeDef *hsdram);
Kojto 110:165afa46840b 159 HAL_StatusTypeDef HAL_SDRAM_WriteProtection_Disable(SDRAM_HandleTypeDef *hsdram);
Kojto 110:165afa46840b 160 HAL_StatusTypeDef HAL_SDRAM_SendCommand(SDRAM_HandleTypeDef *hsdram, FMC_SDRAM_CommandTypeDef *Command, uint32_t Timeout);
Kojto 110:165afa46840b 161 HAL_StatusTypeDef HAL_SDRAM_ProgramRefreshRate(SDRAM_HandleTypeDef *hsdram, uint32_t RefreshRate);
Kojto 110:165afa46840b 162 HAL_StatusTypeDef HAL_SDRAM_SetAutoRefreshNumber(SDRAM_HandleTypeDef *hsdram, uint32_t AutoRefreshNumber);
Kojto 110:165afa46840b 163 uint32_t HAL_SDRAM_GetModeStatus(SDRAM_HandleTypeDef *hsdram);
Kojto 110:165afa46840b 164 /**
Kojto 110:165afa46840b 165 * @}
Kojto 110:165afa46840b 166 */
Kojto 110:165afa46840b 167
Kojto 110:165afa46840b 168 /** @addtogroup SDRAM_Exported_Functions_Group4
Kojto 110:165afa46840b 169 * @{
Kojto 110:165afa46840b 170 */
Kojto 110:165afa46840b 171 /* SDRAM State functions ********************************************************/
Kojto 110:165afa46840b 172 HAL_SDRAM_StateTypeDef HAL_SDRAM_GetState(SDRAM_HandleTypeDef *hsdram);
Kojto 110:165afa46840b 173 /**
Kojto 110:165afa46840b 174 * @}
Kojto 110:165afa46840b 175 */
Kojto 110:165afa46840b 176
Kojto 110:165afa46840b 177 /**
Kojto 110:165afa46840b 178 * @}
Kojto 110:165afa46840b 179 */
Kojto 110:165afa46840b 180
Kojto 110:165afa46840b 181 /**
Kojto 110:165afa46840b 182 * @}
Kojto 110:165afa46840b 183 */
Kojto 110:165afa46840b 184
Kojto 110:165afa46840b 185 #endif /* STM32F427xx || STM32F437xx || STM32F429xx || STM32F439xx || STM32F446xx || STM32F469xx || STM32F479xx */
Kojto 110:165afa46840b 186
Kojto 110:165afa46840b 187 /**
Kojto 110:165afa46840b 188 * @}
Kojto 110:165afa46840b 189 */
Kojto 110:165afa46840b 190
Kojto 110:165afa46840b 191 #ifdef __cplusplus
Kojto 110:165afa46840b 192 }
Kojto 110:165afa46840b 193 #endif
Kojto 110:165afa46840b 194
Kojto 110:165afa46840b 195 #endif /* __STM32F4xx_HAL_SDRAM_H */
Kojto 110:165afa46840b 196
Kojto 110:165afa46840b 197 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/