ST / BSP_DISCO_F469NI

STM32F469NI Discovery board drivers

Dependents:   DISCO-F469NI_LCDTS_GUI_demo Configurable_Robots DISCO-F469NI_LCD_demo DISCO-F469NI_SD_demo ... more

Drivers/BSP/Components/n25q128a/n25q128a.h@4:27609b3a44ed, 2021-06-09 (annotated)

Committer:
aa6164
Date:
Wed Jun 09 12:45:23 2021 +0000
Revision:
4:27609b3a44ed
Parent:
2:123b894b49dd 
Updated wait_ms() to thread_sleep_for() for Mbed OS 6+

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jerome Coutant 2:123b894b49dd 1 /**
Jerome Coutant 2:123b894b49dd 2 ******************************************************************************
Jerome Coutant 2:123b894b49dd 3 * @file n25q128a.h
Jerome Coutant 2:123b894b49dd 4 * @author MCD Application Team
Jerome Coutant 2:123b894b49dd 5 * @version V1.0.0
Jerome Coutant 2:123b894b49dd 6 * @date 29-May-2015
Jerome Coutant 2:123b894b49dd 7 * @brief This file contains all the description of the N25Q128A QSPI memory.
Jerome Coutant 2:123b894b49dd 8 ******************************************************************************
Jerome Coutant 2:123b894b49dd 9 * @attention
Jerome Coutant 2:123b894b49dd 10 *
Jerome Coutant 2:123b894b49dd 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Jerome Coutant 2:123b894b49dd 12 *
Jerome Coutant 2:123b894b49dd 13 * Redistribution and use in source and binary forms, with or without modification,
Jerome Coutant 2:123b894b49dd 14 * are permitted provided that the following conditions are met:
Jerome Coutant 2:123b894b49dd 15 * 1. Redistributions of source code must retain the above copyright notice,
Jerome Coutant 2:123b894b49dd 16 * this list of conditions and the following disclaimer.
Jerome Coutant 2:123b894b49dd 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Jerome Coutant 2:123b894b49dd 18 * this list of conditions and the following disclaimer in the documentation
Jerome Coutant 2:123b894b49dd 19 * and/or other materials provided with the distribution.
Jerome Coutant 2:123b894b49dd 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Jerome Coutant 2:123b894b49dd 21 * may be used to endorse or promote products derived from this software
Jerome Coutant 2:123b894b49dd 22 * without specific prior written permission.
Jerome Coutant 2:123b894b49dd 23 *
Jerome Coutant 2:123b894b49dd 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Jerome Coutant 2:123b894b49dd 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Jerome Coutant 2:123b894b49dd 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Jerome Coutant 2:123b894b49dd 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Jerome Coutant 2:123b894b49dd 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Jerome Coutant 2:123b894b49dd 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Jerome Coutant 2:123b894b49dd 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Jerome Coutant 2:123b894b49dd 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Jerome Coutant 2:123b894b49dd 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Jerome Coutant 2:123b894b49dd 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Jerome Coutant 2:123b894b49dd 34 *
Jerome Coutant 2:123b894b49dd 35 ******************************************************************************
Jerome Coutant 2:123b894b49dd 36 */
Jerome Coutant 2:123b894b49dd 37
Jerome Coutant 2:123b894b49dd 38 /* Define to prevent recursive inclusion -------------------------------------*/
Jerome Coutant 2:123b894b49dd 39 #ifndef __N25Q128A_H
Jerome Coutant 2:123b894b49dd 40 #define __N25Q128A_H
Jerome Coutant 2:123b894b49dd 41
Jerome Coutant 2:123b894b49dd 42 #ifdef __cplusplus
Jerome Coutant 2:123b894b49dd 43 extern "C" {
Jerome Coutant 2:123b894b49dd 44 #endif
Jerome Coutant 2:123b894b49dd 45
Jerome Coutant 2:123b894b49dd 46 /* Includes ------------------------------------------------------------------*/
Jerome Coutant 2:123b894b49dd 47
Jerome Coutant 2:123b894b49dd 48 /** @addtogroup BSP
Jerome Coutant 2:123b894b49dd 49 * @{
Jerome Coutant 2:123b894b49dd 50 */
Jerome Coutant 2:123b894b49dd 51
Jerome Coutant 2:123b894b49dd 52 /** @addtogroup Components
Jerome Coutant 2:123b894b49dd 53 * @{
Jerome Coutant 2:123b894b49dd 54 */
Jerome Coutant 2:123b894b49dd 55
Jerome Coutant 2:123b894b49dd 56 /** @addtogroup n25q128a
Jerome Coutant 2:123b894b49dd 57 * @{
Jerome Coutant 2:123b894b49dd 58 */
Jerome Coutant 2:123b894b49dd 59
Jerome Coutant 2:123b894b49dd 60 /** @defgroup N25Q128A_Exported_Types
Jerome Coutant 2:123b894b49dd 61 * @{
Jerome Coutant 2:123b894b49dd 62 */
Jerome Coutant 2:123b894b49dd 63
Jerome Coutant 2:123b894b49dd 64 /**
Jerome Coutant 2:123b894b49dd 65 * @}
Jerome Coutant 2:123b894b49dd 66 */
Jerome Coutant 2:123b894b49dd 67
Jerome Coutant 2:123b894b49dd 68 /** @defgroup N25Q128A_Exported_Constants
Jerome Coutant 2:123b894b49dd 69 * @{
Jerome Coutant 2:123b894b49dd 70 */
Jerome Coutant 2:123b894b49dd 71
Jerome Coutant 2:123b894b49dd 72 /**
Jerome Coutant 2:123b894b49dd 73 * @brief N25Q128A Configuration
Jerome Coutant 2:123b894b49dd 74 */
Jerome Coutant 2:123b894b49dd 75 #define N25Q128A_FLASH_SIZE 0x1000000 /* 128 MBits => 16MBytes */
Jerome Coutant 2:123b894b49dd 76 #define N25Q128A_SECTOR_SIZE 0x10000 /* 256 sectors of 64KBytes */
Jerome Coutant 2:123b894b49dd 77 #define N25Q128A_SUBSECTOR_SIZE 0x1000 /* 4096 subsectors of 4kBytes */
Jerome Coutant 2:123b894b49dd 78 #define N25Q128A_PAGE_SIZE 0x100 /* 65536 pages of 256 bytes */
Jerome Coutant 2:123b894b49dd 79
Jerome Coutant 2:123b894b49dd 80 #define N25Q128A_DUMMY_CYCLES_READ 8
Jerome Coutant 2:123b894b49dd 81 #define N25Q128A_DUMMY_CYCLES_READ_QUAD 10
Jerome Coutant 2:123b894b49dd 82
Jerome Coutant 2:123b894b49dd 83 #define N25Q128A_BULK_ERASE_MAX_TIME 250000
Jerome Coutant 2:123b894b49dd 84 #define N25Q128A_SECTOR_ERASE_MAX_TIME 3000
Jerome Coutant 2:123b894b49dd 85 #define N25Q128A_SUBSECTOR_ERASE_MAX_TIME 800
Jerome Coutant 2:123b894b49dd 86
Jerome Coutant 2:123b894b49dd 87 /**
Jerome Coutant 2:123b894b49dd 88 * @brief N25Q128A Commands
Jerome Coutant 2:123b894b49dd 89 */
Jerome Coutant 2:123b894b49dd 90 /* Reset Operations */
Jerome Coutant 2:123b894b49dd 91 #define RESET_ENABLE_CMD 0x66
Jerome Coutant 2:123b894b49dd 92 #define RESET_MEMORY_CMD 0x99
Jerome Coutant 2:123b894b49dd 93
Jerome Coutant 2:123b894b49dd 94 /* Identification Operations */
Jerome Coutant 2:123b894b49dd 95 #define READ_ID_CMD 0x9E
Jerome Coutant 2:123b894b49dd 96 #define READ_ID_CMD2 0x9F
Jerome Coutant 2:123b894b49dd 97 #define MULTIPLE_IO_READ_ID_CMD 0xAF
Jerome Coutant 2:123b894b49dd 98 #define READ_SERIAL_FLASH_DISCO_PARAM_CMD 0x5A
Jerome Coutant 2:123b894b49dd 99
Jerome Coutant 2:123b894b49dd 100 /* Read Operations */
Jerome Coutant 2:123b894b49dd 101 #define READ_CMD 0x03
Jerome Coutant 2:123b894b49dd 102 #define FAST_READ_CMD 0x0B
Jerome Coutant 2:123b894b49dd 103 #define DUAL_OUT_FAST_READ_CMD 0x3B
Jerome Coutant 2:123b894b49dd 104 #define DUAL_INOUT_FAST_READ_CMD 0xBB
Jerome Coutant 2:123b894b49dd 105 #define QUAD_OUT_FAST_READ_CMD 0x6B
Jerome Coutant 2:123b894b49dd 106 #define QUAD_INOUT_FAST_READ_CMD 0xEB
Jerome Coutant 2:123b894b49dd 107
Jerome Coutant 2:123b894b49dd 108 /* Write Operations */
Jerome Coutant 2:123b894b49dd 109 #define WRITE_ENABLE_CMD 0x06
Jerome Coutant 2:123b894b49dd 110 #define WRITE_DISABLE_CMD 0x04
Jerome Coutant 2:123b894b49dd 111
Jerome Coutant 2:123b894b49dd 112 /* Register Operations */
Jerome Coutant 2:123b894b49dd 113 #define READ_STATUS_REG_CMD 0x05
Jerome Coutant 2:123b894b49dd 114 #define WRITE_STATUS_REG_CMD 0x01
Jerome Coutant 2:123b894b49dd 115
Jerome Coutant 2:123b894b49dd 116 #define READ_LOCK_REG_CMD 0xE8
Jerome Coutant 2:123b894b49dd 117 #define WRITE_LOCK_REG_CMD 0xE5
Jerome Coutant 2:123b894b49dd 118
Jerome Coutant 2:123b894b49dd 119 #define READ_FLAG_STATUS_REG_CMD 0x70
Jerome Coutant 2:123b894b49dd 120 #define CLEAR_FLAG_STATUS_REG_CMD 0x50
Jerome Coutant 2:123b894b49dd 121
Jerome Coutant 2:123b894b49dd 122 #define READ_NONVOL_CFG_REG_CMD 0xB5
Jerome Coutant 2:123b894b49dd 123 #define WRITE_NONVOL_CFG_REG_CMD 0xB1
Jerome Coutant 2:123b894b49dd 124
Jerome Coutant 2:123b894b49dd 125 #define READ_VOL_CFG_REG_CMD 0x85
Jerome Coutant 2:123b894b49dd 126 #define WRITE_VOL_CFG_REG_CMD 0x81
Jerome Coutant 2:123b894b49dd 127
Jerome Coutant 2:123b894b49dd 128 #define READ_ENHANCED_VOL_CFG_REG_CMD 0x65
Jerome Coutant 2:123b894b49dd 129 #define WRITE_ENHANCED_VOL_CFG_REG_CMD 0x61
Jerome Coutant 2:123b894b49dd 130
Jerome Coutant 2:123b894b49dd 131 /* Program Operations */
Jerome Coutant 2:123b894b49dd 132 #define PAGE_PROG_CMD 0x02
Jerome Coutant 2:123b894b49dd 133 #define DUAL_IN_FAST_PROG_CMD 0xA2
Jerome Coutant 2:123b894b49dd 134 #define EXT_DUAL_IN_FAST_PROG_CMD 0xD2
Jerome Coutant 2:123b894b49dd 135 #define QUAD_IN_FAST_PROG_CMD 0x32
Jerome Coutant 2:123b894b49dd 136 #define EXT_QUAD_IN_FAST_PROG_CMD 0x12
Jerome Coutant 2:123b894b49dd 137
Jerome Coutant 2:123b894b49dd 138 /* Erase Operations */
Jerome Coutant 2:123b894b49dd 139 #define SUBSECTOR_ERASE_CMD 0x20
Jerome Coutant 2:123b894b49dd 140 #define SECTOR_ERASE_CMD 0xD8
Jerome Coutant 2:123b894b49dd 141 #define BULK_ERASE_CMD 0xC7
Jerome Coutant 2:123b894b49dd 142
Jerome Coutant 2:123b894b49dd 143 #define PROG_ERASE_RESUME_CMD 0x7A
Jerome Coutant 2:123b894b49dd 144 #define PROG_ERASE_SUSPEND_CMD 0x75
Jerome Coutant 2:123b894b49dd 145
Jerome Coutant 2:123b894b49dd 146 /* One-Time Programmable Operations */
Jerome Coutant 2:123b894b49dd 147 #define READ_OTP_ARRAY_CMD 0x4B
Jerome Coutant 2:123b894b49dd 148 #define PROG_OTP_ARRAY_CMD 0x42
Jerome Coutant 2:123b894b49dd 149
Jerome Coutant 2:123b894b49dd 150 /**
Jerome Coutant 2:123b894b49dd 151 * @brief N25Q128A Registers
Jerome Coutant 2:123b894b49dd 152 */
Jerome Coutant 2:123b894b49dd 153 /* Status Register */
Jerome Coutant 2:123b894b49dd 154 #define N25Q128A_SR_WIP ((uint8_t)0x01) /*!< Write in progress */
Jerome Coutant 2:123b894b49dd 155 #define N25Q128A_SR_WREN ((uint8_t)0x02) /*!< Write enable latch */
Jerome Coutant 2:123b894b49dd 156 #define N25Q128A_SR_BLOCKPR ((uint8_t)0x5C) /*!< Block protected against program and erase operations */
Jerome Coutant 2:123b894b49dd 157 #define N25Q128A_SR_PRBOTTOM ((uint8_t)0x20) /*!< Protected memory area defined by BLOCKPR starts from top or bottom */
Jerome Coutant 2:123b894b49dd 158 #define N25Q128A_SR_SRWREN ((uint8_t)0x80) /*!< Status register write enable/disable */
Jerome Coutant 2:123b894b49dd 159
Jerome Coutant 2:123b894b49dd 160 /* Nonvolatile Configuration Register */
Jerome Coutant 2:123b894b49dd 161 #define N25Q128A_NVCR_LOCK ((uint16_t)0x0001) /*!< Lock nonvolatile configuration register */
Jerome Coutant 2:123b894b49dd 162 #define N25Q128A_NVCR_DUAL ((uint16_t)0x0004) /*!< Dual I/O protocol */
Jerome Coutant 2:123b894b49dd 163 #define N25Q128A_NVCR_QUAB ((uint16_t)0x0008) /*!< Quad I/O protocol */
Jerome Coutant 2:123b894b49dd 164 #define N25Q128A_NVCR_RH ((uint16_t)0x0010) /*!< Reset/hold */
Jerome Coutant 2:123b894b49dd 165 #define N25Q128A_NVCR_ODS ((uint16_t)0x01C0) /*!< Output driver strength */
Jerome Coutant 2:123b894b49dd 166 #define N25Q128A_NVCR_XIP ((uint16_t)0x0E00) /*!< XIP mode at power-on reset */
Jerome Coutant 2:123b894b49dd 167 #define N25Q128A_NVCR_NB_DUMMY ((uint16_t)0xF000) /*!< Number of dummy clock cycles */
Jerome Coutant 2:123b894b49dd 168
Jerome Coutant 2:123b894b49dd 169 /* Volatile Configuration Register */
Jerome Coutant 2:123b894b49dd 170 #define N25Q128A_VCR_WRAP ((uint8_t)0x03) /*!< Wrap */
Jerome Coutant 2:123b894b49dd 171 #define N25Q128A_VCR_XIP ((uint8_t)0x08) /*!< XIP */
Jerome Coutant 2:123b894b49dd 172 #define N25Q128A_VCR_NB_DUMMY ((uint8_t)0xF0) /*!< Number of dummy clock cycles */
Jerome Coutant 2:123b894b49dd 173
Jerome Coutant 2:123b894b49dd 174 /* Enhanced Volatile Configuration Register */
Jerome Coutant 2:123b894b49dd 175 #define N25Q128A_EVCR_ODS ((uint8_t)0x07) /*!< Output driver strength */
Jerome Coutant 2:123b894b49dd 176 #define N25Q128A_EVCR_VPPA ((uint8_t)0x08) /*!< Vpp accelerator */
Jerome Coutant 2:123b894b49dd 177 #define N25Q128A_EVCR_RH ((uint8_t)0x10) /*!< Reset/hold */
Jerome Coutant 2:123b894b49dd 178 #define N25Q128A_EVCR_DUAL ((uint8_t)0x40) /*!< Dual I/O protocol */
Jerome Coutant 2:123b894b49dd 179 #define N25Q128A_EVCR_QUAD ((uint8_t)0x80) /*!< Quad I/O protocol */
Jerome Coutant 2:123b894b49dd 180
Jerome Coutant 2:123b894b49dd 181 /* Flag Status Register */
Jerome Coutant 2:123b894b49dd 182 #define N25Q128A_FSR_PRERR ((uint8_t)0x02) /*!< Protection error */
Jerome Coutant 2:123b894b49dd 183 #define N25Q128A_FSR_PGSUS ((uint8_t)0x04) /*!< Program operation suspended */
Jerome Coutant 2:123b894b49dd 184 #define N25Q128A_FSR_VPPERR ((uint8_t)0x08) /*!< Invalid voltage during program or erase */
Jerome Coutant 2:123b894b49dd 185 #define N25Q128A_FSR_PGERR ((uint8_t)0x10) /*!< Program error */
Jerome Coutant 2:123b894b49dd 186 #define N25Q128A_FSR_ERERR ((uint8_t)0x20) /*!< Erase error */
Jerome Coutant 2:123b894b49dd 187 #define N25Q128A_FSR_ERSUS ((uint8_t)0x40) /*!< Erase operation suspended */
Jerome Coutant 2:123b894b49dd 188 #define N25Q128A_FSR_READY ((uint8_t)0x80) /*!< Ready or command in progress */
Jerome Coutant 2:123b894b49dd 189
Jerome Coutant 2:123b894b49dd 190 /**
Jerome Coutant 2:123b894b49dd 191 * @}
Jerome Coutant 2:123b894b49dd 192 */
Jerome Coutant 2:123b894b49dd 193
Jerome Coutant 2:123b894b49dd 194 /** @defgroup N25Q128A_Exported_Functions
Jerome Coutant 2:123b894b49dd 195 * @{
Jerome Coutant 2:123b894b49dd 196 */
Jerome Coutant 2:123b894b49dd 197 /**
Jerome Coutant 2:123b894b49dd 198 * @}
Jerome Coutant 2:123b894b49dd 199 */
Jerome Coutant 2:123b894b49dd 200
Jerome Coutant 2:123b894b49dd 201 /**
Jerome Coutant 2:123b894b49dd 202 * @}
Jerome Coutant 2:123b894b49dd 203 */
Jerome Coutant 2:123b894b49dd 204
Jerome Coutant 2:123b894b49dd 205 /**
Jerome Coutant 2:123b894b49dd 206 * @}
Jerome Coutant 2:123b894b49dd 207 */
Jerome Coutant 2:123b894b49dd 208
Jerome Coutant 2:123b894b49dd 209 /**
Jerome Coutant 2:123b894b49dd 210 * @}
Jerome Coutant 2:123b894b49dd 211 */
Jerome Coutant 2:123b894b49dd 212
Jerome Coutant 2:123b894b49dd 213 #ifdef __cplusplus
Jerome Coutant 2:123b894b49dd 214 }
Jerome Coutant 2:123b894b49dd 215 #endif
Jerome Coutant 2:123b894b49dd 216
Jerome Coutant 2:123b894b49dd 217 #endif /* __N25Q128A_H */
Jerome Coutant 2:123b894b49dd 218
Jerome Coutant 2:123b894b49dd 219 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/