stm32469i_discovery_qspi.h

00001 /**
00002   ******************************************************************************
00003   * @file    stm32469i_discovery_qspi.h
00004   * @author  MCD Application Team
00005   * @brief   This file contains the common defines and functions prototypes for
00006   *          the stm32469i_discovery_qspi.c driver.
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
00011   *
00012   * Redistribution and use in source and binary forms, with or without modification,
00013   * are permitted provided that the following conditions are met:
00014   *   1. Redistributions of source code must retain the above copyright notice,
00015   *      this list of conditions and the following disclaimer.
00016   *   2. Redistributions in binary form must reproduce the above copyright notice,
00017   *      this list of conditions and the following disclaimer in the documentation
00018   *      and/or other materials provided with the distribution.
00019   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00020   *      may be used to endorse or promote products derived from this software
00021   *      without specific prior written permission.
00022   *
00023   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00026   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00027   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00028   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00029   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00031   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00032   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033   *
00034   ******************************************************************************
00035   */
00036 
00037 /** @addtogroup BSP
00038   * @{
00039   */
00040 
00041 /** @addtogroup STM32469I_Discovery
00042   * @{
00043   */
00044 
00045 /* Define to prevent recursive inclusion -------------------------------------*/
00046 #ifndef __STM32469I_DISCOVERY_QSPI_H
00047 #define __STM32469I_DISCOVERY_QSPI_H
00048 
00049 #ifdef __cplusplus
00050  extern "C" {
00051 #endif
00052 
00053 /* Includes ------------------------------------------------------------------*/
00054 #include "stm32f4xx_hal.h"
00055 #include "../Components/n25q128a/n25q128a.h"
00056 
00057 
00058 /** @addtogroup STM32469I_Discovery_QSPI
00059   * @{
00060   */
00061 
00062 
00063 /* Exported constants --------------------------------------------------------*/
00064 /** @defgroup STM32469I_Discovery_QSPI_Exported_Constants STM32469I Discovery QSPI Exported Constants
00065   * @{
00066   */
00067 /* QSPI Error codes */
00068 #define QSPI_OK            ((uint8_t)0x00)
00069 #define QSPI_ERROR         ((uint8_t)0x01)
00070 #define QSPI_BUSY          ((uint8_t)0x02)
00071 #define QSPI_NOT_SUPPORTED ((uint8_t)0x04)
00072 #define QSPI_SUSPENDED     ((uint8_t)0x08)
00073 
00074 
00075 /* Definition for QSPI clock resources */
00076 #define QSPI_CLK_ENABLE()             __HAL_RCC_QSPI_CLK_ENABLE()
00077 #define QSPI_CLK_DISABLE()            __HAL_RCC_QSPI_CLK_DISABLE()
00078 #define QSPI_CS_GPIO_CLK_ENABLE()     __HAL_RCC_GPIOB_CLK_ENABLE()
00079 #define QSPI_CS_GPIO_CLK_DISABLE()  __HAL_RCC_GPIOB_CLK_DISABLE()
00080 #define QSPI_DX_CLK_GPIO_CLK_ENABLE() __HAL_RCC_GPIOF_CLK_ENABLE()
00081 #define QSPI_DX_CLK_GPIO_CLK_DISABLE()  __HAL_RCC_GPIOF_CLK_DISABLE()
00082 
00083 #define QSPI_FORCE_RESET()            __HAL_RCC_QSPI_FORCE_RESET()
00084 #define QSPI_RELEASE_RESET()          __HAL_RCC_QSPI_RELEASE_RESET()
00085 
00086 /* Definition for QSPI Pins */
00087 #define QSPI_CS_PIN                GPIO_PIN_6
00088 #define QSPI_CS_GPIO_PORT          GPIOB
00089 #define QSPI_CLK_PIN               GPIO_PIN_10
00090 #define QSPI_CLK_GPIO_PORT         GPIOF
00091 #define QSPI_D0_PIN                GPIO_PIN_8
00092 #define QSPI_D1_PIN                GPIO_PIN_9
00093 #define QSPI_D2_PIN                GPIO_PIN_7
00094 #define QSPI_D3_PIN                GPIO_PIN_6
00095 #define QSPI_DX_GPIO_PORT          GPIOF
00096 
00097 
00098 /**
00099   * @}
00100   */
00101 
00102 /* Exported types ------------------------------------------------------------*/
00103 /** @defgroup STM32469I_Discovery_QSPI_Exported_Types STM32469I Discovery QSPI Exported Types
00104   * @{
00105   */
00106 /**
00107  * @brief QSPI Info
00108  * */
00109 typedef struct {
00110   uint32_t FlashSize;          /*!< Size of the flash                         */
00111   uint32_t EraseSectorSize;    /*!< Size of sectors for the erase operation   */
00112   uint32_t EraseSectorsNumber; /*!< Number of sectors for the erase operation */
00113   uint32_t ProgPageSize;       /*!< Size of pages for the program operation   */
00114   uint32_t ProgPagesNumber;    /*!< Number of pages for the program operation */
00115 } QSPI_InfoTypeDef;
00116 
00117 /**
00118   * @}
00119   */
00120 
00121 
00122 /* Exported functions --------------------------------------------------------*/
00123 /** @addtogroup STM32469I_Discovery_QSPI_Exported_Functions STM32469I Discovery QSPI Exported Functions
00124   * @{
00125   */
00126 uint8_t BSP_QSPI_Init       (void);
00127 uint8_t BSP_QSPI_DeInit     (void);
00128 uint8_t BSP_QSPI_Read       (uint8_t* pData, uint32_t ReadAddr, uint32_t Size);
00129 uint8_t BSP_QSPI_Write      (uint8_t* pData, uint32_t WriteAddr, uint32_t Size);
00130 uint8_t BSP_QSPI_Erase_Block(uint32_t BlockAddress);
00131 uint8_t BSP_QSPI_Erase_Chip (void);
00132 uint8_t BSP_QSPI_GetStatus  (void);
00133 uint8_t BSP_QSPI_GetInfo    (QSPI_InfoTypeDef* pInfo);
00134 uint8_t BSP_QSPI_EnableMemoryMappedMode(void);
00135 /* BSP Aliased function maintained for legacy purpose */
00136 #define BSP_QSPI_MemoryMappedMode      BSP_QSPI_EnableMemoryMappedMode
00137 
00138 /* These function can be modified in case the current settings (e.g. DMA stream)
00139    need to be changed for specific application needs */
00140 void BSP_QSPI_MspInit(QSPI_HandleTypeDef *hqspi, void *Params);
00141 void BSP_QSPI_MspDeInit(QSPI_HandleTypeDef *hqspi, void *Params);
00142 
00143 /**
00144   * @}
00145   */
00146 
00147 /**
00148   * @}
00149   */
00150 
00151 #ifdef __cplusplus
00152 }
00153 #endif
00154 
00155 #endif /* __STM32469I_DISCOVERY_QSPI_H */
00156 /**
00157   * @}
00158   */
00159 
00160 /**
00161   * @}
00162   */
00163 
00164 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/