STM32L4R9I_EVAL BSP User Manual
|
stm32l4r9i_eval_ospi_nor.h
Go to the documentation of this file.
00001 /** 00002 ****************************************************************************** 00003 * @file stm32l4r9i_eval_ospi_nor.h 00004 * @author MCD Application Team 00005 * @brief This file contains the common defines and functions prototypes for 00006 * the stm32l4r9i_eval_ospi_nor.c driver. 00007 ****************************************************************************** 00008 * @attention 00009 * 00010 * <h2><center>© 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 /* Define to prevent recursive inclusion -------------------------------------*/ 00038 #ifndef __STM32L4R9I_EVAL_OSPI_NOR_H 00039 #define __STM32L4R9I_EVAL_OSPI_NOR_H 00040 00041 #ifdef __cplusplus 00042 extern "C" { 00043 #endif 00044 00045 /* Includes ------------------------------------------------------------------*/ 00046 #include "stm32l4xx_hal.h" 00047 #include "../Components/mx25lm51245g/mx25lm51245g.h" 00048 00049 /** @addtogroup BSP 00050 * @{ 00051 */ 00052 00053 /** @addtogroup STM32L4R9I_EVAL 00054 * @{ 00055 */ 00056 00057 /** @addtogroup STM32L4R9I_EVAL_OSPI_NOR 00058 * @{ 00059 */ 00060 00061 /* Exported constants --------------------------------------------------------*/ 00062 /** @defgroup STM32L4R9I_EVAL_OSPI_NOR_Exported_Constants Exported Constants 00063 * @{ 00064 */ 00065 /* OSPI Error codes */ 00066 #define OSPI_NOR_OK ((uint8_t)0x00) 00067 #define OSPI_NOR_ERROR ((uint8_t)0x01) 00068 #define OSPI_NOR_BUSY ((uint8_t)0x02) 00069 #define OSPI_NOR_NOT_SUPPORTED ((uint8_t)0x04) 00070 #define OSPI_NOR_SUSPENDED ((uint8_t)0x08) 00071 00072 /** 00073 * @} 00074 */ 00075 00076 /* Exported types ------------------------------------------------------------*/ 00077 /** @defgroup STM32L4R9I_EVAL_OSPI_NOR_Exported_Types Exported Types 00078 * @{ 00079 */ 00080 /* OSPI Info */ 00081 typedef struct { 00082 uint32_t FlashSize; /*!< Size of the flash */ 00083 uint32_t EraseSectorSize; /*!< Size of sectors for the erase operation */ 00084 uint32_t EraseSectorsNumber; /*!< Number of sectors for the erase operation */ 00085 uint32_t ProgPageSize; /*!< Size of pages for the program operation */ 00086 uint32_t ProgPagesNumber; /*!< Number of pages for the program operation */ 00087 } OSPI_NOR_Info; 00088 00089 /** 00090 * @} 00091 */ 00092 00093 /* Exported functions --------------------------------------------------------*/ 00094 /** @defgroup STM32L4R9I_EVAL_OSPI_NOR_Exported_Functions Exported Functions 00095 * @{ 00096 */ 00097 uint8_t BSP_OSPI_NOR_Init (void); 00098 uint8_t BSP_OSPI_NOR_DeInit (void); 00099 uint8_t BSP_OSPI_NOR_Read (uint8_t* pData, uint32_t ReadAddr, uint32_t Size); 00100 uint8_t BSP_OSPI_NOR_Write (uint8_t* pData, uint32_t WriteAddr, uint32_t Size); 00101 uint8_t BSP_OSPI_NOR_Erase_Block (uint32_t BlockAddress); 00102 uint8_t BSP_OSPI_NOR_Erase_Sector (uint32_t Sector); 00103 uint8_t BSP_OSPI_NOR_Erase_Chip (void); 00104 uint8_t BSP_OSPI_NOR_GetStatus (void); 00105 uint8_t BSP_OSPI_NOR_GetInfo (OSPI_NOR_Info* pInfo); 00106 uint8_t BSP_OSPI_NOR_EnableMemoryMappedMode(void); 00107 uint8_t BSP_OSPI_NOR_SuspendErase (void); 00108 uint8_t BSP_OSPI_NOR_ResumeErase (void); 00109 uint8_t BSP_OSPI_NOR_EnterDeepPowerDown (void); 00110 uint8_t BSP_OSPI_NOR_LeaveDeepPowerDown (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 /* __STM32L4R9I_EVAL_OSPI_NOR_H */ 00133 00134 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Generated on Thu Oct 12 2017 10:53:59 for STM32L4R9I_EVAL BSP User Manual by
![doxygen](doxygen.png)