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),
23 /* Enum list - Full read commands */
27 DUAL_OUTPUT_FAST = BIT(2),
28 QUAD_OUTPUT_FAST = BIT(3),
29 DUAL_IO_FAST = BIT(4),
30 QUAD_IO_FAST = BIT(5),
33 /* Normal - Extended - Full command set */
34 #define RD_NORM (ARRAY_SLOW | ARRAY_FAST)
35 #define RD_EXTN (RD_NORM | DUAL_OUTPUT_FAST | DUAL_IO_FAST)
36 #define RD_FULL (RD_EXTN | QUAD_OUTPUT_FAST | QUAD_IO_FAST)
40 #ifndef CONFIG_SPI_FLASH_USE_4K_SECTORS
51 enum spi_nor_option_flags {
52 SNOR_F_SST_WR = BIT(0),
53 SNOR_F_USE_FSR = BIT(1),
56 #define SPI_FLASH_3B_ADDR_LEN 3
57 #define SPI_FLASH_CMD_LEN (1 + SPI_FLASH_3B_ADDR_LEN)
58 #define SPI_FLASH_16MB_BOUN 0x1000000
60 /* CFI Manufacture ID's */
61 #define SPI_FLASH_CFI_MFR_SPANSION 0x01
62 #define SPI_FLASH_CFI_MFR_STMICRO 0x20
63 #define SPI_FLASH_CFI_MFR_MACRONIX 0xc2
64 #define SPI_FLASH_CFI_MFR_SST 0xbf
65 #define SPI_FLASH_CFI_MFR_WINBOND 0xef
66 #define SPI_FLASH_CFI_MFR_ATMEL 0x1f
69 #define CMD_ERASE_4K 0x20
70 #define CMD_ERASE_32K 0x52
71 #define CMD_ERASE_CHIP 0xc7
72 #define CMD_ERASE_64K 0xd8
75 #define CMD_WRITE_STATUS 0x01
76 #define CMD_PAGE_PROGRAM 0x02
77 #define CMD_WRITE_DISABLE 0x04
78 #define CMD_WRITE_ENABLE 0x06
79 #define CMD_QUAD_PAGE_PROGRAM 0x32
80 #define CMD_WRITE_EVCR 0x61
83 #define CMD_READ_ARRAY_SLOW 0x03
84 #define CMD_READ_ARRAY_FAST 0x0b
85 #define CMD_READ_DUAL_OUTPUT_FAST 0x3b
86 #define CMD_READ_DUAL_IO_FAST 0xbb
87 #define CMD_READ_QUAD_OUTPUT_FAST 0x6b
88 #define CMD_READ_QUAD_IO_FAST 0xeb
89 #define CMD_READ_ID 0x9f
90 #define CMD_READ_STATUS 0x05
91 #define CMD_READ_STATUS1 0x35
92 #define CMD_READ_CONFIG 0x35
93 #define CMD_FLAG_STATUS 0x70
94 #define CMD_READ_EVCR 0x65
96 /* Bank addr access commands */
97 #ifdef CONFIG_SPI_FLASH_BAR
98 # define CMD_BANKADDR_BRWR 0x17
99 # define CMD_BANKADDR_BRRD 0x16
100 # define CMD_EXTNADDR_WREAR 0xC5
101 # define CMD_EXTNADDR_RDEAR 0xC8
105 #define STATUS_WIP BIT(0)
106 #define STATUS_QEB_WINSPAN BIT(1)
107 #define STATUS_QEB_MXIC BIT(6)
108 #define STATUS_PEC BIT(7)
109 #define STATUS_QEB_MICRON BIT(7)
110 #define SR_BP0 BIT(2) /* Block protect 0 */
111 #define SR_BP1 BIT(3) /* Block protect 1 */
112 #define SR_BP2 BIT(4) /* Block protect 2 */
114 /* Flash timeout values */
115 #define SPI_FLASH_PROG_TIMEOUT (2 * CONFIG_SYS_HZ)
116 #define SPI_FLASH_PAGE_ERASE_TIMEOUT (5 * CONFIG_SYS_HZ)
117 #define SPI_FLASH_SECTOR_ERASE_TIMEOUT (10 * CONFIG_SYS_HZ)
120 #ifdef CONFIG_SPI_FLASH_SST
121 # define CMD_SST_BP 0x02 /* Byte Program */
122 # define CMD_SST_AAI_WP 0xAD /* Auto Address Incr Word Program */
124 int sst_write_wp(struct spi_flash *flash, u32 offset, size_t len,
126 int sst_write_bp(struct spi_flash *flash, u32 offset, size_t len,
130 #ifdef CONFIG_SPI_FLASH_SPANSION
131 /* Used for Spansion S25FS-S family flash only. */
132 #define CMD_SPANSION_RDAR 0x65 /* Read any device register */
133 #define CMD_SPANSION_WRAR 0x71 /* Write any device register */
136 * struct spi_flash_params - SPI/QSPI flash device params structure
138 * @name: Device name ([MANUFLETTER][DEVTYPE][DENSITY][EXTRAINFO])
139 * @jedec: Device jedec ID (0x[1byte_manuf_id][2byte_dev_id])
140 * @ext_jedec: Device ext_jedec ID
141 * @sector_size: Isn't necessarily a sector size from vendor,
142 * the size listed here is what works with CMD_ERASE_64K
143 * @nr_sectors: No.of sectors on this device
144 * @e_rd_cmd: Enum list for read commands
145 * @flags: Important param, for flash specific behaviour
147 struct spi_flash_params {
157 extern const struct spi_flash_params spi_flash_params_table[];
159 /* Send a single-byte command to the device and read the response */
160 int spi_flash_cmd(struct spi_slave *spi, u8 cmd, void *response, size_t len);
163 * Send a multi-byte command to the device and read the response. Used
164 * for flash array reads, etc.
166 int spi_flash_cmd_read(struct spi_slave *spi, const u8 *cmd,
167 size_t cmd_len, void *data, size_t data_len);
170 * Send a multi-byte command to the device followed by (optional)
171 * data. Used for programming the flash array, etc.
173 int spi_flash_cmd_write(struct spi_slave *spi, const u8 *cmd, size_t cmd_len,
174 const void *data, size_t data_len);
177 /* Flash erase(sectors) operation, support all possible erase commands */
178 int spi_flash_cmd_erase_ops(struct spi_flash *flash, u32 offset, size_t len);
180 /* Lock stmicro spi flash region */
181 int stm_lock(struct spi_flash *flash, u32 ofs, size_t len);
183 /* Unlock stmicro spi flash region */
184 int stm_unlock(struct spi_flash *flash, u32 ofs, size_t len);
186 /* Check if a stmicro spi flash region is completely locked */
187 int stm_is_locked(struct spi_flash *flash, u32 ofs, size_t len);
189 /* Enable writing on the SPI flash */
190 static inline int spi_flash_cmd_write_enable(struct spi_flash *flash)
192 return spi_flash_cmd(flash->spi, CMD_WRITE_ENABLE, NULL, 0);
195 /* Disable writing on the SPI flash */
196 static inline int spi_flash_cmd_write_disable(struct spi_flash *flash)
198 return spi_flash_cmd(flash->spi, CMD_WRITE_DISABLE, NULL, 0);
202 * Used for spi_flash write operation
204 * - spi_flash_cmd_write_enable
205 * - spi_flash_cmd_write
206 * - spi_flash_cmd_wait_ready
209 int spi_flash_write_common(struct spi_flash *flash, const u8 *cmd,
210 size_t cmd_len, const void *buf, size_t buf_len);
213 * Flash write operation, support all possible write commands.
214 * Write the requested data out breaking it up into multiple write
215 * commands as needed per the write size.
217 int spi_flash_cmd_write_ops(struct spi_flash *flash, u32 offset,
218 size_t len, const void *buf);
221 * Same as spi_flash_cmd_read() except it also claims/releases the SPI
222 * bus. Used as common part of the ->read() operation.
224 int spi_flash_read_common(struct spi_flash *flash, const u8 *cmd,
225 size_t cmd_len, void *data, size_t data_len);
227 /* Flash read operation, support all possible read commands */
228 int spi_flash_cmd_read_ops(struct spi_flash *flash, u32 offset,
229 size_t len, void *data);
231 #ifdef CONFIG_SPI_FLASH_MTD
232 int spi_flash_mtd_register(struct spi_flash *flash);
233 void spi_flash_mtd_unregister(void);
237 * spi_flash_scan - scan the SPI FLASH
238 * @flash: the spi flash structure
240 * The drivers can use this fuction to scan the SPI FLASH.
241 * In the scanning, it will try to get all the necessary information to
242 * fill the spi_flash{}.
244 * Return: 0 for success, others for failure.
246 int spi_flash_scan(struct spi_flash *flash);
248 #endif /* _SF_INTERNAL_H_ */