stm32l476g_discovery_qspi.h

00001 /**
00002   ******************************************************************************
00003   * @file    stm32l476g_discovery_qspi.h
00004   * @author  MCD Application Team
00005   * @version V1.0.0
00006   * @date    26-June-2015
00007   * @brief   This file contains the common defines and functions prototypes for
00008   *          the stm32l476g_discovery_qspi.c driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2015 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 __STM32L476G_DISCOVERY_QSPI_H
00041 #define __STM32L476G_DISCOVERY_QSPI_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif 
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 #include "stm32l4xx_hal.h"
00049 #include "n25q128a.h"
00050 
00051 /** @addtogroup BSP
00052   * @{
00053   */
00054 
00055 /** @addtogroup STM32L476G_DISCOVERY
00056   * @{
00057   */
00058 
00059 /** @addtogroup STM32L476G_DISCOVERY_QSPI
00060   * @{
00061   */
00062 
00063 /* Exported constants --------------------------------------------------------*/ 
00064 /** @defgroup STM32L476G_DISCOVERY_QSPI_Exported_Constants 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   * @}
00076   */
00077 
00078 /* Exported types ------------------------------------------------------------*/
00079 /** @defgroup STM32L476G_DISCOVERY_QSPI_Exported_Types Exported Types
00080   * @{
00081   */
00082 /* QSPI Info */
00083 typedef struct {
00084   uint32_t FlashSize;          /*!< Size of the flash */
00085   uint32_t EraseSectorSize;    /*!< Size of sectors for the erase operation */
00086   uint32_t EraseSectorsNumber; /*!< Number of sectors for the erase operation */
00087   uint32_t ProgPageSize;       /*!< Size of pages for the program operation */
00088   uint32_t ProgPagesNumber;    /*!< Number of pages for the program operation */
00089 } QSPI_Info;
00090 
00091 /**
00092   * @}
00093   */
00094 
00095 /* Exported functions --------------------------------------------------------*/
00096 /** @defgroup STM32L476G_DISCOVERY_QSPI_Exported_Functions Exported Functions
00097   * @{
00098   */
00099 uint8_t BSP_QSPI_Init        (void);
00100 uint8_t BSP_QSPI_DeInit      (void);
00101 uint8_t BSP_QSPI_Read        (uint8_t* pData, uint32_t ReadAddr, uint32_t Size);
00102 uint8_t BSP_QSPI_Write       (uint8_t* pData, uint32_t WriteAddr, uint32_t Size);
00103 uint8_t BSP_QSPI_Erase_Block (uint32_t BlockAddress);
00104 uint8_t BSP_QSPI_Erase_Sector(uint32_t Sector);
00105 uint8_t BSP_QSPI_Erase_Chip  (void);
00106 uint8_t BSP_QSPI_GetStatus   (void);
00107 uint8_t BSP_QSPI_GetInfo     (QSPI_Info* pInfo);
00108 uint8_t BSP_QSPI_EnableMemoryMappedMode(void);
00109 uint8_t BSP_QSPI_SuspendErase(void);
00110 uint8_t BSP_QSPI_ResumeErase (void);
00111 
00112 /**
00113   * @}
00114   */
00115 
00116 /**
00117   * @}
00118   */
00119 
00120 /**
00121   * @}
00122   */
00123 
00124 /**
00125   * @}
00126   */
00127 
00128 #ifdef __cplusplus
00129 }
00130 #endif
00131 
00132 #endif /* __STM32L476G_DISCOVERY_QSPI_H */
00133 
00134 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/