Nam Nguyen / Mbed 2 deprecated BSP_DISCO_F746NG

a

Dependencies:   mbed

Dependents:   a123

Drivers/BSP/Components/n25q128a/n25q128a.h@1:d4da8708dc0a, 2019-06-10 (annotated)

Committer:
nam3886
Date:
Mon Jun 10 10:45:06 2019 +0000
Revision:
1:d4da8708dc0a
Parent:
0:d05b765ea94c 
12

Who changed what in which revision?

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