STM32756G_EVAL BSP User Manual: stm32756g_eval_nor.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32756g_eval_nor.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 stm32756g_eval_nor.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 /* Define to prevent recursive inclusion -------------------------------------*/
00040 #ifndef __STM32756G_EVAL_NOR_H
00041 #define __STM32756G_EVAL_NOR_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif 
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 #include "stm32f7xx_hal.h"
00049 
00050 /** @addtogroup BSP
00051   * @{
00052   */ 
00053 
00054 /** @addtogroup STM32756G_EVAL
00055   * @{
00056   */
00057     
00058 /** @addtogroup STM32756G_EVAL_NOR
00059   * @{
00060   */    
00061 
00062 /** @defgroup STM32756G_EVAL_NOR_Exported_Types NOR Exported Types
00063   * @{
00064   */
00065 /**
00066   * @}
00067   */ 
00068     
00069 /** 
00070   * @brief  NOR status structure definition  
00071   */     
00072 #define   NOR_STATUS_OK         ((uint8_t)0x00)
00073 #define   NOR_STATUS_ERROR      ((uint8_t)0x01)
00074 
00075 /** @defgroup STM32756G_EVAL_NOR_Exported_Constants NOR Exported Constants
00076   * @{
00077   */  
00078 #define NOR_DEVICE_ADDR  ((uint32_t)0x60000000)  
00079   
00080 /* #define NOR_MEMORY_WIDTH    FMC_NORSRAM_MEM_BUS_WIDTH_8  */
00081 #define NOR_MEMORY_WIDTH    FMC_NORSRAM_MEM_BUS_WIDTH_16
00082 
00083 #define NOR_BURSTACCESS    FMC_BURST_ACCESS_MODE_DISABLE  
00084 /* #define NOR_BURSTACCESS    FMC_BURST_ACCESS_MODE_ENABLE*/
00085   
00086 #define NOR_WRITEBURST    FMC_WRITE_BURST_DISABLE  
00087 /* #define NOR_WRITEBURST   FMC_WRITE_BURST_ENABLE */
00088  
00089 #define CONTINUOUSCLOCK_FEATURE    FMC_CONTINUOUS_CLOCK_SYNC_ONLY 
00090 /* #define CONTINUOUSCLOCK_FEATURE     FMC_CONTINUOUS_CLOCK_SYNC_ASYNC */ 
00091 
00092 /* NOR operations Timeout definitions */
00093 #define BLOCKERASE_TIMEOUT   ((uint32_t)0x00A00000)  /* NOR block erase timeout */
00094 #define CHIPERASE_TIMEOUT    ((uint32_t)0x30000000)  /* NOR chip erase timeout  */ 
00095 #define PROGRAM_TIMEOUT      ((uint32_t)0x00004400)  /* NOR program timeout     */ 
00096 
00097 /* NOR Ready/Busy signal GPIO definitions */
00098 #define NOR_READY_BUSY_PIN    GPIO_PIN_6 
00099 #define NOR_READY_BUSY_GPIO   GPIOD
00100 #define NOR_READY_STATE       GPIO_PIN_SET
00101 #define NOR_BUSY_STATE        GPIO_PIN_RESET 
00102 /**
00103   * @}
00104   */ 
00105     
00106 /** @defgroup STM32756G_EVAL_NOR_Exported_Macro NOR Exported Macro
00107   * @{
00108   */ 
00109 /**
00110   * @}
00111   */ 
00112     
00113 /** @defgroup STM32756G_EVAL_NOR_Exported_Functions NOR Exported Functions
00114   * @{
00115   */  
00116 uint8_t BSP_NOR_Init(void);
00117 uint8_t BSP_NOR_DeInit(void);
00118 uint8_t BSP_NOR_ReadData(uint32_t uwStartAddress, uint16_t *pData, uint32_t uwDataSize);
00119 uint8_t BSP_NOR_WriteData(uint32_t uwStartAddress, uint16_t *pData, uint32_t uwDataSize);
00120 uint8_t BSP_NOR_ProgramData(uint32_t uwStartAddress, uint16_t *pData, uint32_t uwDataSize);
00121 uint8_t BSP_NOR_Erase_Block(uint32_t BlockAddress);
00122 uint8_t BSP_NOR_Erase_Chip(void);
00123 uint8_t BSP_NOR_Read_ID(NOR_IDTypeDef *pNOR_ID);
00124 void BSP_NOR_ReturnToReadMode(void);  
00125    
00126 /* These functions can be modified in case the current settings (e.g. DMA stream)
00127    need to be changed for specific application needs */
00128 void    BSP_NOR_MspInit(NOR_HandleTypeDef  *hnor, void *Params);
00129 void    BSP_NOR_MspDeInit(NOR_HandleTypeDef  *hnor, void *Params);
00130 
00131 /**
00132   * @}
00133   */ 
00134 
00135 /**
00136   * @}
00137   */ 
00138 
00139 /**
00140   * @}
00141   */ 
00142 
00143 /**
00144   * @}
00145   */ 
00146 
00147 #ifdef __cplusplus
00148 }
00149 #endif
00150 
00151 #endif /* __STM32756G_EVAL_NOR_H */
00152 
00153 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/