stm32746g_discovery_qspi.h

00001 /**
00002   ******************************************************************************
00003   * @file    stm32746g_discovery_qspi.h
00004   * @author  MCD Application Team
00005   * @version V2.0.0
00006   * @date    30-December-2016
00007   * @brief   This file contains the common defines and functions prototypes for
00008   *          the stm32746g_discovery_qspi.c driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2016 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 /** @addtogroup BSP
00040   * @{
00041   */ 
00042 
00043 /** @addtogroup STM32746G_DISCOVERY
00044   * @{
00045   */
00046     
00047 /* Define to prevent recursive inclusion -------------------------------------*/
00048 #ifndef __STM32746G_DISCOVERY_QSPI_H
00049 #define __STM32746G_DISCOVERY_QSPI_H
00050 
00051 #ifdef __cplusplus
00052  extern "C" {
00053 #endif 
00054 
00055 /* Includes ------------------------------------------------------------------*/
00056 #include "stm32f7xx_hal.h"
00057 #include "../Components/n25q128a/n25q128a.h"
00058 
00059 /** @addtogroup STM32746G_DISCOVERY_QSPI
00060   * @{
00061   */    
00062 
00063   
00064 /* Exported constants --------------------------------------------------------*/ 
00065 /** @defgroup STM32746G_DISCOVERY_QSPI_Exported_Constants STM32746G_DISCOVERY_QSPI Exported Constants
00066   * @{
00067   */
00068 /* QSPI Error codes */
00069 #define QSPI_OK            ((uint8_t)0x00)
00070 #define QSPI_ERROR         ((uint8_t)0x01)
00071 #define QSPI_BUSY          ((uint8_t)0x02)
00072 #define QSPI_NOT_SUPPORTED ((uint8_t)0x04)
00073 #define QSPI_SUSPENDED     ((uint8_t)0x08)
00074 
00075 
00076 /* Definition for QSPI clock resources */
00077 #define QSPI_CLK_ENABLE()          __HAL_RCC_QSPI_CLK_ENABLE()
00078 #define QSPI_CLK_DISABLE()         __HAL_RCC_QSPI_CLK_DISABLE()
00079 #define QSPI_CS_GPIO_CLK_ENABLE()  __HAL_RCC_GPIOB_CLK_ENABLE()
00080 #define QSPI_CLK_GPIO_CLK_ENABLE() __HAL_RCC_GPIOB_CLK_ENABLE()
00081 #define QSPI_D0_GPIO_CLK_ENABLE()  __HAL_RCC_GPIOD_CLK_ENABLE()
00082 #define QSPI_D1_GPIO_CLK_ENABLE()  __HAL_RCC_GPIOD_CLK_ENABLE()
00083 #define QSPI_D2_GPIO_CLK_ENABLE()  __HAL_RCC_GPIOE_CLK_ENABLE()
00084 #define QSPI_D3_GPIO_CLK_ENABLE()  __HAL_RCC_GPIOD_CLK_ENABLE()
00085 
00086 #define QSPI_FORCE_RESET()         __HAL_RCC_QSPI_FORCE_RESET()
00087 #define QSPI_RELEASE_RESET()       __HAL_RCC_QSPI_RELEASE_RESET()
00088 
00089 /* Definition for QSPI Pins */
00090 #define QSPI_CS_PIN                GPIO_PIN_6
00091 #define QSPI_CS_GPIO_PORT          GPIOB
00092 #define QSPI_CLK_PIN               GPIO_PIN_2
00093 #define QSPI_CLK_GPIO_PORT         GPIOB
00094 #define QSPI_D0_PIN                GPIO_PIN_11
00095 #define QSPI_D0_GPIO_PORT          GPIOD
00096 #define QSPI_D1_PIN                GPIO_PIN_12
00097 #define QSPI_D1_GPIO_PORT          GPIOD
00098 #define QSPI_D2_PIN                GPIO_PIN_2
00099 #define QSPI_D2_GPIO_PORT          GPIOE
00100 #define QSPI_D3_PIN                GPIO_PIN_13
00101 #define QSPI_D3_GPIO_PORT          GPIOD
00102 
00103 /* N25Q128A13EF840E Micron memory */
00104 /* Size of the flash */
00105 #define QSPI_FLASH_SIZE            23     /* Address bus width to access whole memory space */
00106 #define QSPI_PAGE_SIZE             256
00107 
00108 /* This alias is added as the name of Memory mapped fucntion changed */   
00109 #define BSP_QSPI_MemoryMappedMode  BSP_QSPI_EnableMemoryMappedMode   
00110 /**
00111   * @}
00112   */
00113 
00114 /* Exported types ------------------------------------------------------------*/
00115 /** @defgroup STM32746G_DISCOVERY_QSPI_Exported_Types STM32746G_DISCOVERY_QSPI Exported Types
00116   * @{
00117   */
00118 /* QSPI Info */
00119 typedef struct {
00120   uint32_t FlashSize;          /*!< Size of the flash */
00121   uint32_t EraseSectorSize;    /*!< Size of sectors for the erase operation */
00122   uint32_t EraseSectorsNumber; /*!< Number of sectors for the erase operation */
00123   uint32_t ProgPageSize;       /*!< Size of pages for the program operation */
00124   uint32_t ProgPagesNumber;    /*!< Number of pages for the program operation */
00125 } QSPI_Info;
00126 
00127 /**
00128   * @}
00129   */
00130 
00131   
00132 /* Exported functions --------------------------------------------------------*/
00133 /** @addtogroup STM32746G_DISCOVERY_QSPI_Exported_Functions
00134   * @{
00135   */  
00136 uint8_t BSP_QSPI_Init       (void);
00137 uint8_t BSP_QSPI_DeInit     (void);
00138 uint8_t BSP_QSPI_Read       (uint8_t* pData, uint32_t ReadAddr, uint32_t Size);
00139 uint8_t BSP_QSPI_Write      (uint8_t* pData, uint32_t WriteAddr, uint32_t Size);
00140 uint8_t BSP_QSPI_Erase_Block(uint32_t BlockAddress);
00141 uint8_t BSP_QSPI_Erase_Chip (void);
00142 uint8_t BSP_QSPI_GetStatus  (void);
00143 uint8_t BSP_QSPI_GetInfo    (QSPI_Info* pInfo);
00144 uint8_t BSP_QSPI_EnableMemoryMappedMode(void);
00145 
00146 /* These functions can be modified in case the current settings
00147    need to be changed for specific application needs */
00148 void BSP_QSPI_MspInit(QSPI_HandleTypeDef *hqspi, void *Params);
00149 void BSP_QSPI_MspDeInit(QSPI_HandleTypeDef *hqspi, void *Params);
00150 
00151 /**
00152   * @}
00153   */ 
00154 
00155 /**
00156   * @}
00157   */ 
00158 
00159 #ifdef __cplusplus
00160 }
00161 #endif
00162 
00163 #endif /* __STM32746G_DISCOVERY_QSPI_H */
00164 /**
00165   * @}
00166   */ 
00167 
00168 /**
00169   * @}
00170   */ 
00171 
00172 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/