STM32F413H-Discovery BSP User Manual: stm32f413h_discovery_psram.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32f413H_discovery_psram.h
00004   * @author  MCD Application Team
00005   * @version V1.0.0
00006   * @date    27-January-2017
00007   * @brief   This file contains the common defines and functions prototypes for
00008   *          the stm32f413h_discovery_psram.c driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
00013   *
00014   * Redistribution and use in source and binary forms, with or without modification,
00015   * are permitted provided that the following conditions are met:
00016   *   1. Redistributions of source code must retain the above copyright notice,
00017   *      this list of conditions and the following disclaimer.
00018   *   2. Redistributions in binary form must reproduce the above copyright notice,
00019   *      this list of conditions and the following disclaimer in the documentation
00020   *      and/or other materials provided with the distribution.
00021   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00022   *      may be used to endorse or promote products derived from this software
00023   *      without specific prior written permission.
00024   *
00025   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00026   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00028   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00029   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00030   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00031   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00032   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00033   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00034   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035   *
00036   ******************************************************************************
00037   */ 
00038 
00039 /* Define to prevent recursive inclusion -------------------------------------*/
00040 #ifndef __STM32F413H_DISCOVERY_PSRAM_H
00041 #define __STM32F413H_DISCOVERY_PSRAM_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif 
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 #include "stm32f4xx_hal.h"
00049 
00050 /** @addtogroup BSP
00051   * @{
00052   */ 
00053 
00054 /** @addtogroup STM32F413H_DISCOVERY
00055   * @{
00056   */
00057     
00058 /** @addtogroup STM32F413H_DISCOVERY_PSRAM
00059   * @{
00060   */    
00061 
00062 /** @defgroup STM32F413H_DISCOVERY_PSRAM_Exported_Constants STM32F413H DISCOVERY PSRAM Exported Constants
00063   * @{
00064   */
00065 
00066 /** 
00067   * @brief  PSRAM status structure definition  
00068   */     
00069 #define   PSRAM_OK         ((uint8_t)0x00)
00070 #define   PSRAM_ERROR      ((uint8_t)0x01)
00071 
00072 #define PSRAM_DEVICE_ADDR  ((uint32_t)0x60000000)
00073 #define PSRAM_DEVICE_SIZE  ((uint32_t)0x80000)  /* SRAM device size in Bytes */  
00074   
00075 #define PSRAM_MEMORY_WIDTH         FSMC_NORSRAM_MEM_BUS_WIDTH_16
00076 #define PSRAM_BURSTACCESS          FSMC_BURST_ACCESS_MODE_DISABLE  
00077 #define PSRAM_WRITEBURST           FSMC_WRITE_BURST_DISABLE
00078 #define CONTINUOUSCLOCK_FEATURE    FSMC_CONTINUOUS_CLOCK_SYNC_ONLY 
00079 
00080 /* DMA definitions for SRAM DMA transfer */
00081 #define PSRAM_DMAx_CLK_ENABLE      __HAL_RCC_DMA2_CLK_ENABLE
00082 #define PSRAM_DMAx_CLK_DISABLE     __HAL_RCC_DMA2_CLK_DISABLE
00083 #define PSRAM_DMAx_CHANNEL         DMA_CHANNEL_0
00084 #define PSRAM_DMAx_STREAM          DMA2_Stream5  
00085 #define PSRAM_DMAx_IRQn            DMA2_Stream5_IRQn
00086 #define BSP_PSRAM_DMA_IRQHandler   DMA2_Stream5_IRQHandler   
00087  
00088 /**
00089   * @}
00090   */ 
00091    
00092 /** @defgroup STM32F413H_DISCOVERY_PSRAM_Exported_Functions STM32F413H DISCOVERY PSRAM Exported Functions
00093   * @{
00094   */  
00095 uint8_t BSP_PSRAM_Init(void);
00096 uint8_t BSP_PSRAM_DeInit(void);
00097 uint8_t BSP_PSRAM_ReadData(uint32_t uwStartAddress, uint16_t *pData, uint32_t uwDataSize);
00098 uint8_t BSP_PSRAM_ReadData_DMA(uint32_t uwStartAddress, uint16_t *pData, uint32_t uwDataSize);
00099 uint8_t BSP_PSRAM_WriteData(uint32_t uwStartAddress, uint16_t *pData, uint32_t uwDataSize);
00100 uint8_t BSP_PSRAM_WriteData_DMA(uint32_t uwStartAddress, uint16_t *pData, uint32_t uwDataSize);
00101    
00102 /* These functions can be modified in case the current settings (e.g. DMA stream)
00103    need to be changed for specific application needs */
00104 void    BSP_PSRAM_MspInit(SRAM_HandleTypeDef  *hsram, void *Params);
00105 void    BSP_PSRAM_MspDeInit(SRAM_HandleTypeDef  *hsram, void *Params);
00106 
00107 /**
00108   * @}
00109   */ 
00110 
00111 /**
00112   * @}
00113   */ 
00114 
00115 /**
00116   * @}
00117   */ 
00118 
00119 /**
00120   * @}
00121   */ 
00122 
00123 #ifdef __cplusplus
00124 }
00125 #endif
00126 
00127 #endif /* __STM32F413H_DISCOVERY_PSRAM_H */
00128 
00129 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/