2 * SPI flash internal definitions
4 * Copyright (C) 2008 Atmel Corporation
5 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
7 * SPDX-License-Identifier: GPL-2.0+
10 #ifndef _SF_INTERNAL_H_
11 #define _SF_INTERNAL_H_
13 #include <linux/types.h>
14 #include <linux/compiler.h>
16 /* Dual SPI flash memories - see SPI_COMM_DUAL_... */
19 SF_DUAL_STACKED_FLASH = BIT(0),
20 SF_DUAL_PARALLEL_FLASH = BIT(1),
34 #define RD_FULL RD_QUAD | RD_DUAL | RD_QUADIO | RD_DUALIO
36 enum spi_nor_option_flags {
37 SNOR_F_SST_WR = BIT(0),
38 SNOR_F_USE_FSR = BIT(1),
41 #define SPI_FLASH_3B_ADDR_LEN 3
42 #define SPI_FLASH_CMD_LEN (1 + SPI_FLASH_3B_ADDR_LEN)
43 #define SPI_FLASH_16MB_BOUN 0x1000000
45 /* CFI Manufacture ID's */
46 #define SPI_FLASH_CFI_MFR_SPANSION 0x01
47 #define SPI_FLASH_CFI_MFR_STMICRO 0x20
48 #define SPI_FLASH_CFI_MFR_MACRONIX 0xc2
49 #define SPI_FLASH_CFI_MFR_SST 0xbf
50 #define SPI_FLASH_CFI_MFR_WINBOND 0xef
51 #define SPI_FLASH_CFI_MFR_ATMEL 0x1f
54 #define CMD_ERASE_4K 0x20
55 #define CMD_ERASE_CHIP 0xc7
56 #define CMD_ERASE_64K 0xd8
59 #define CMD_WRITE_STATUS 0x01
60 #define CMD_PAGE_PROGRAM 0x02
61 #define CMD_WRITE_DISABLE 0x04
62 #define CMD_WRITE_ENABLE 0x06
63 #define CMD_QUAD_PAGE_PROGRAM 0x32
64 #define CMD_WRITE_EVCR 0x61
67 #define CMD_READ_ARRAY_SLOW 0x03
68 #define CMD_READ_ARRAY_FAST 0x0b
69 #define CMD_READ_DUAL_OUTPUT_FAST 0x3b
70 #define CMD_READ_DUAL_IO_FAST 0xbb
71 #define CMD_READ_QUAD_OUTPUT_FAST 0x6b
72 #define CMD_READ_QUAD_IO_FAST 0xeb
73 #define CMD_READ_ID 0x9f
74 #define CMD_READ_STATUS 0x05
75 #define CMD_READ_STATUS1 0x35
76 #define CMD_READ_CONFIG 0x35
77 #define CMD_FLAG_STATUS 0x70
78 #define CMD_READ_EVCR 0x65
80 /* Bank addr access commands */
81 #ifdef CONFIG_SPI_FLASH_BAR
82 # define CMD_BANKADDR_BRWR 0x17
83 # define CMD_BANKADDR_BRRD 0x16
84 # define CMD_EXTNADDR_WREAR 0xC5
85 # define CMD_EXTNADDR_RDEAR 0xC8
89 #define STATUS_WIP BIT(0)
90 #define STATUS_QEB_WINSPAN BIT(1)
91 #define STATUS_QEB_MXIC BIT(6)
92 #define STATUS_PEC BIT(7)
93 #define STATUS_QEB_MICRON BIT(7)
94 #define SR_BP0 BIT(2) /* Block protect 0 */
95 #define SR_BP1 BIT(3) /* Block protect 1 */
96 #define SR_BP2 BIT(4) /* Block protect 2 */
98 /* Flash timeout values */
99 #define SPI_FLASH_PROG_TIMEOUT (2 * CONFIG_SYS_HZ)
100 #define SPI_FLASH_PAGE_ERASE_TIMEOUT (5 * CONFIG_SYS_HZ)
101 #define SPI_FLASH_SECTOR_ERASE_TIMEOUT (10 * CONFIG_SYS_HZ)
104 #ifdef CONFIG_SPI_FLASH_SST
105 # define CMD_SST_BP 0x02 /* Byte Program */
106 # define CMD_SST_AAI_WP 0xAD /* Auto Address Incr Word Program */
108 int sst_write_wp(struct spi_flash *flash, u32 offset, size_t len,
110 int sst_write_bp(struct spi_flash *flash, u32 offset, size_t len,
114 #ifdef CONFIG_SPI_FLASH_SPANSION
115 /* Used for Spansion S25FS-S family flash only. */
116 #define CMD_SPANSION_RDAR 0x65 /* Read any device register */
117 #define CMD_SPANSION_WRAR 0x71 /* Write any device register */
120 * struct spi_flash_params - SPI/QSPI flash device params structure
122 * @name: Device name ([MANUFLETTER][DEVTYPE][DENSITY][EXTRAINFO])
123 * @jedec: Device jedec ID (0x[1byte_manuf_id][2byte_dev_id])
124 * @ext_jedec: Device ext_jedec ID
125 * @sector_size: Isn't necessarily a sector size from vendor,
126 * the size listed here is what works with CMD_ERASE_64K
127 * @nr_sectors: No.of sectors on this device
128 * @flags: Important param, for flash specific behaviour
130 struct spi_flash_params {
139 extern const struct spi_flash_params spi_flash_params_table[];
141 /* Send a single-byte command to the device and read the response */
142 int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
145 * Send a multi-byte command to the device and read the response. Used
146 * for flash array reads, etc.
148 int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
149 size_t cmd_len, void *data, size_t data_len);
152 * Send a multi-byte command to the device followed by (optional)
153 * data. Used for programming the flash array, etc.
155 int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
156 const void *data, size_t data_len);
159 /* Flash erase(sectors) operation, support all possible erase commands */
160 int spi_flash_cmd_erase_ops(struct spi_flash *flash, u32 offset, size_t len);
162 /* Lock stmicro spi flash region */
163 int stm_lock(struct spi_flash *flash, u32 ofs, size_t len);
165 /* Unlock stmicro spi flash region */
166 int stm_unlock(struct spi_flash *flash, u32 ofs, size_t len);
168 /* Check if a stmicro spi flash region is completely locked */
169 int stm_is_locked(struct spi_flash *flash, u32 ofs, size_t len);
171 /* Enable writing on the SPI flash */
172 static inline int spi_flash_cmd_write_enable(struct spi_flash *flash)
174 return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0);
177 /* Disable writing on the SPI flash */
178 static inline int spi_flash_cmd_write_disable(struct spi_flash *flash)
180 return spi_flash_cmd(flash->spi, CMD_WRITE_DISABLE, NULL, 0);
184 * Used for spi_flash write operation
186 * - spi_flash_cmd_write_enable
187 * - spi_flash_cmd_write
188 * - spi_flash_cmd_wait_ready
191 int spi_flash_write_common(struct spi_flash *flash, const u8 *cmd,
192 size_t cmd_len, const void *buf, size_t buf_len);
195 * Flash write operation, support all possible write commands.
196 * Write the requested data out breaking it up into multiple write
197 * commands as needed per the write size.
199 int spi_flash_cmd_write_ops(struct spi_flash *flash, u32 offset,
200 size_t len, const void *buf);
203 * Same as spi_flash_cmd_read() except it also claims/releases the SPI
204 * bus. Used as common part of the ->read() operation.
206 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
207 size_t cmd_len, void *data, size_t data_len);
209 /* Flash read operation, support all possible read commands */
210 int spi_flash_cmd_read_ops(struct spi_flash *flash, u32 offset,
211 size_t len, void *data);
213 #ifdef CONFIG_SPI_FLASH_MTD
214 int spi_flash_mtd_register(struct spi_flash *flash);
215 void spi_flash_mtd_unregister(void);
219 * spi_flash_scan - scan the SPI FLASH
220 * @flash: the spi flash structure
222 * The drivers can use this fuction to scan the SPI FLASH.
223 * In the scanning, it will try to get all the necessary information to
224 * fill the spi_flash{}.
226 * Return: 0 for success, others for failure.
228 int spi_flash_scan(struct spi_flash *flash);
230 #endif /* _SF_INTERNAL_H_ */