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_F746ZG/stm32f7xx_hal_sdram.h@121:672067c3ada4, 2016-04-14 (annotated)

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
116:c0f6e94411f5 
.

Who changed what in which revision?

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