STM32F439xx HAL User Manual: stm32f4xx_hal

SDRAM HAL module driver. This file provides a generic firmware to drive SDRAM memories mounted as external device. More...

#include "stm32f4xx_hal.h"

Go to the source code of this file.

Functions
HAL_StatusTypeDef	HAL_SDRAM_Init (SDRAM_HandleTypeDef hsdram, FMC_SDRAM_TimingTypeDef Timing)
	Performs the SDRAM device initialization sequence.
HAL_StatusTypeDef	HAL_SDRAM_DeInit (SDRAM_HandleTypeDef *hsdram)
	Perform the SDRAM device initialization sequence.
__weak void	HAL_SDRAM_MspInit (SDRAM_HandleTypeDef *hsdram)
	SDRAM MSP Init.
__weak void	HAL_SDRAM_MspDeInit (SDRAM_HandleTypeDef *hsdram)
	SDRAM MSP DeInit.
void	HAL_SDRAM_IRQHandler (SDRAM_HandleTypeDef *hsdram)
	This function handles SDRAM refresh error interrupt request.
__weak void	HAL_SDRAM_RefreshErrorCallback (SDRAM_HandleTypeDef *hsdram)
	SDRAM Refresh error callback.
__weak void	HAL_SDRAM_DMA_XferCpltCallback (DMA_HandleTypeDef *hdma)
	DMA transfer complete callback.
__weak void	HAL_SDRAM_DMA_XferErrorCallback (DMA_HandleTypeDef *hdma)
	DMA transfer complete error callback.
HAL_StatusTypeDef	HAL_SDRAM_Read_8b (SDRAM_HandleTypeDef hsdram, uint32_t pAddress, uint8_t *pDstBuffer, uint32_t BufferSize)
	Reads 8-bit data buffer from the SDRAM memory.
HAL_StatusTypeDef	HAL_SDRAM_Write_8b (SDRAM_HandleTypeDef hsdram, uint32_t pAddress, uint8_t *pSrcBuffer, uint32_t BufferSize)
	Writes 8-bit data buffer to SDRAM memory.
HAL_StatusTypeDef	HAL_SDRAM_Read_16b (SDRAM_HandleTypeDef hsdram, uint32_t pAddress, uint16_t *pDstBuffer, uint32_t BufferSize)
	Reads 16-bit data buffer from the SDRAM memory.
HAL_StatusTypeDef	HAL_SDRAM_Write_16b (SDRAM_HandleTypeDef hsdram, uint32_t pAddress, uint16_t *pSrcBuffer, uint32_t BufferSize)
	Writes 16-bit data buffer to SDRAM memory.
HAL_StatusTypeDef	HAL_SDRAM_Read_32b (SDRAM_HandleTypeDef hsdram, uint32_t pAddress, uint32_t *pDstBuffer, uint32_t BufferSize)
	Reads 32-bit data buffer from the SDRAM memory.
HAL_StatusTypeDef	HAL_SDRAM_Write_32b (SDRAM_HandleTypeDef hsdram, uint32_t pAddress, uint32_t *pSrcBuffer, uint32_t BufferSize)
	Writes 32-bit data buffer to SDRAM memory.
HAL_StatusTypeDef	HAL_SDRAM_Read_DMA (SDRAM_HandleTypeDef hsdram, uint32_t pAddress, uint32_t *pDstBuffer, uint32_t BufferSize)
	Reads a Words data from the SDRAM memory using DMA transfer.
HAL_StatusTypeDef	HAL_SDRAM_Write_DMA (SDRAM_HandleTypeDef hsdram, uint32_t pAddress, uint32_t *pSrcBuffer, uint32_t BufferSize)
	Writes a Words data buffer to SDRAM memory using DMA transfer.
HAL_StatusTypeDef	HAL_SDRAM_WriteProtection_Enable (SDRAM_HandleTypeDef *hsdram)
	Enables dynamically SDRAM write protection.
HAL_StatusTypeDef	HAL_SDRAM_WriteProtection_Disable (SDRAM_HandleTypeDef *hsdram)
	Disables dynamically SDRAM write protection.
HAL_StatusTypeDef	HAL_SDRAM_SendCommand (SDRAM_HandleTypeDef hsdram, FMC_SDRAM_CommandTypeDef Command, uint32_t Timeout)
	Sends Command to the SDRAM bank.
HAL_StatusTypeDef	HAL_SDRAM_ProgramRefreshRate (SDRAM_HandleTypeDef *hsdram, uint32_t RefreshRate)
	Programs the SDRAM Memory Refresh rate.
HAL_StatusTypeDef	HAL_SDRAM_SetAutoRefreshNumber (SDRAM_HandleTypeDef *hsdram, uint32_t AutoRefreshNumber)
	Sets the Number of consecutive SDRAM Memory auto Refresh commands.
uint32_t	HAL_SDRAM_GetModeStatus (SDRAM_HandleTypeDef *hsdram)
	Returns the SDRAM memory current mode.
HAL_SDRAM_StateTypeDef	HAL_SDRAM_GetState (SDRAM_HandleTypeDef *hsdram)
	Returns the SDRAM state.

Detailed Description

SDRAM HAL module driver. This file provides a generic firmware to drive SDRAM memories mounted as external device.

Author:

MCD Application Team

  ==============================================================================
                       ##### How to use this driver #####
  ============================================================================== 
  [..]
    This driver is a generic layered driver which contains a set of APIs used to 
    control SDRAM memories. It uses the FMC layer functions to interface 
    with SDRAM devices.  
    The following sequence should be followed to configure the FMC to interface
    with SDRAM memories: 
      
   (#) Declare a SDRAM_HandleTypeDef handle structure, for example:
          SDRAM_HandleTypeDef  hdsram 
          
       (++) Fill the SDRAM_HandleTypeDef handle "Init" field with the allowed 
            values of the structure member.
            
       (++) Fill the SDRAM_HandleTypeDef handle "Instance" field with a predefined 
            base register instance for NOR or SDRAM device 
             
   (#) Declare a FMC_SDRAM_TimingTypeDef structure; for example:
          FMC_SDRAM_TimingTypeDef  Timing;
      and fill its fields with the allowed values of the structure member.
      
   (#) Initialize the SDRAM Controller by calling the function HAL_SDRAM_Init(). This function
       performs the following sequence:
          
       (##) MSP hardware layer configuration using the function HAL_SDRAM_MspInit()
       (##) Control register configuration using the FMC SDRAM interface function 
            FMC_SDRAM_Init()
       (##) Timing register configuration using the FMC SDRAM interface function 
            FMC_SDRAM_Timing_Init()
       (##) Program the SDRAM external device by applying its initialization sequence
            according to the device plugged in your hardware. This step is mandatory
            for accessing the SDRAM device.   

   (#) At this stage you can perform read/write accesses from/to the memory connected 
       to the SDRAM Bank. You can perform either polling or DMA transfer using the
       following APIs:
       (++) HAL_SDRAM_Read()/HAL_SDRAM_Write() for polling read/write access
       (++) HAL_SDRAM_Read_DMA()/HAL_SDRAM_Write_DMA() for DMA read/write transfer
       
   (#) You can also control the SDRAM device by calling the control APIs HAL_SDRAM_WriteOperation_Enable()/
       HAL_SDRAM_WriteOperation_Disable() to respectively enable/disable the SDRAM write operation or 
       the function HAL_SDRAM_SendCommand() to send a specified command to the SDRAM
       device. The command to be sent must be configured with the FMC_SDRAM_CommandTypeDef 
       structure.   
       
   (#) You can continuously monitor the SDRAM device HAL state by calling the function
       HAL_SDRAM_GetState()

Attention:

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32f4xx_hal_sdram.c.

Functions

Detailed Description

© COPYRIGHT(c) 2017 STMicroelectronics