4 * Copyright (C) 2008 Atmel Corporation
5 * Copyright (C) 2010 Reinhard Meyer, EMK Elektronik
6 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
8 * Licensed under the GPL-2 or later.
15 #include <spi_flash.h>
17 #include "spi_flash_internal.h"
19 DECLARE_GLOBAL_DATA_PTR;
22 * struct spi_flash_params - SPI/QSPI flash device params structure
24 * @name: Device name ([MANUFLETTER][DEVTYPE][DENSITY][EXTRAINFO])
25 * @jedec: Device jedec ID (0x[1byte_manuf_id][2byte_dev_id])
26 * @ext_jedec: Device ext_jedec ID
27 * @sector_size: Sector size of this device
28 * @nr_sectors: No.of sectors on this device
29 * @flags: Importent param, for flash specific behaviour
31 struct spi_flash_params {
40 static const struct spi_flash_params spi_flash_params_table[] = {
41 #ifdef CONFIG_SPI_FLASH_ATMEL /* ATMEL */
42 {"AT45DB011D", 0x1f2200, 0x0, 64 * 1024, 4, SECT_4K},
43 {"AT45DB021D", 0x1f2300, 0x0, 64 * 1024, 8, SECT_4K},
44 {"AT45DB041D", 0x1f2400, 0x0, 64 * 1024, 8, SECT_4K},
45 {"AT45DB081D", 0x1f2500, 0x0, 64 * 1024, 16, SECT_4K},
46 {"AT45DB161D", 0x1f2600, 0x0, 64 * 1024, 32, SECT_4K},
47 {"AT45DB321D", 0x1f2700, 0x0, 64 * 1024, 64, SECT_4K},
48 {"AT45DB641D", 0x1f2800, 0x0, 64 * 1024, 128, SECT_4K},
50 #ifdef CONFIG_SPI_FLASH_EON /* EON */
51 {"EN25Q32B", 0x1c3016, 0x0, 64 * 1024, 64, 0},
52 {"EN25Q64", 0x1c3017, 0x0, 64 * 1024, 128, SECT_4K},
53 {"EN25Q128B", 0x1c3018, 0x0, 64 * 1024, 256, 0},
55 #ifdef CONFIG_SPI_FLASH_GIGADEVICE /* GIGADEVICE */
56 {"GD25Q64B", 0xc84017, 0x0, 64 * 1024, 128, SECT_4K},
57 {"GD25LQ32", 0xc86016, 0x0, 64 * 1024, 64, SECT_4K},
59 #ifdef CONFIG_SPI_FLASH_MACRONIX /* MACRONIX */
60 {"MX25L4005", 0xc22013, 0x0, 64 * 1024, 8, 0},
61 {"MX25L8005", 0xc22014, 0x0, 64 * 1024, 16, 0},
62 {"MX25L1605D", 0xc22015, 0x0, 64 * 1024, 32, 0},
63 {"MX25L3205D", 0xc22016, 0x0, 64 * 1024, 64, 0},
64 {"MX25L6405D", 0xc22017, 0x0, 64 * 1024, 128, 0},
65 {"MX25L12805", 0xc22018, 0x0, 64 * 1024, 256, 0},
66 {"MX25L12855E", 0xc22618, 0x0, 64 * 1024, 256, 0},
68 #ifdef CONFIG_SPI_FLASH_SPANSION /* SPANSION */
69 {"S25FL008A", 0x010213, 0x0, 64 * 1024, 16, 0},
70 {"S25FL016A", 0x010214, 0x0, 64 * 1024, 32, 0},
71 {"S25FL032A", 0x010215, 0x0, 64 * 1024, 64, 0},
72 {"S25FL064A", 0x010216, 0x0, 64 * 1024, 128, 0},
73 {"S25FL128P_256K", 0x012018, 0x0300, 256 * 1024, 64, 0},
74 {"S25FL128P_64K", 0x012018, 0x0301, 64 * 1024, 256, 0},
75 {"S25FL032P", 0x010215, 0x4d00, 64 * 1024, 64, 0},
76 {"S25FL064P", 0x010216, 0x4d00, 64 * 1024, 128, 0},
77 {"S25FL128S_64K", 0x012018, 0x4d01, 64 * 1024, 256, 0},
78 {"S25FL256S_256K", 0x010219, 0x4d00, 64 * 1024, 512, 0},
79 {"S25FL256S_64K", 0x010219, 0x4d01, 64 * 1024, 512, 0},
80 {"S25FL512S_256K", 0x010220, 0x4d00, 64 * 1024, 1024, 0},
81 {"S25FL512S_64K", 0x010220, 0x4d01, 64 * 1024, 1024, 0},
83 #ifdef CONFIG_SPI_FLASH_STMICRO /* STMICRO */
84 {"M25P10", 0x202011, 0x0, 32 * 1024, 4, 0},
85 {"M25P20", 0x202012, 0x0, 64 * 1024, 4, 0},
86 {"M25P40", 0x202013, 0x0, 64 * 1024, 8, 0},
87 {"M25P80", 0x202014, 0x0, 64 * 1024, 16, 0},
88 {"M25P16", 0x202015, 0x0, 64 * 1024, 32, 0},
89 {"M25P32", 0x202016, 0x0, 64 * 1024, 64, 0},
90 {"M25P64", 0x202017, 0x0, 64 * 1024, 128, 0},
91 {"M25P128", 0x202018, 0x0, 256 * 1024, 64, 0},
92 {"N25Q32", 0x20ba16, 0x0, 64 * 1024, 64, SECT_4K},
93 {"N25Q32A", 0x20bb16, 0x0, 64 * 1024, 64, SECT_4K},
94 {"N25Q64", 0x20ba17, 0x0, 64 * 1024, 128, SECT_4K},
95 {"N25Q64A", 0x20bb17, 0x0, 64 * 1024, 128, SECT_4K},
96 {"N25Q128", 0x20ba18, 0x0, 64 * 1024, 256, SECT_4K},
97 {"N25Q128A", 0x20bb18, 0x0, 64 * 1024, 256, SECT_4K},
98 {"N25Q256", 0x20ba19, 0x0, 64 * 1024, 512, SECT_4K},
99 {"N25Q256A", 0x20bb19, 0x0, 64 * 1024, 512, SECT_4K},
100 {"N25Q512", 0x20ba20, 0x0, 64 * 1024, 1024, E_FSR | SECT_4K},
101 {"N25Q512A", 0x20bb20, 0x0, 64 * 1024, 1024, E_FSR | SECT_4K},
102 {"N25Q1024", 0x20ba21, 0x0, 64 * 1024, 2048, E_FSR | SECT_4K},
103 {"N25Q1024A", 0x20bb21, 0x0, 64 * 1024, 2048, E_FSR | SECT_4K},
105 #ifdef CONFIG_SPI_FLASH_SST /* SST */
106 {"SST25VF040B", 0xbf258d, 0x0, 64 * 1024, 8, SECT_4K | SST_WP},
107 {"SST25VF080B", 0xbf258e, 0x0, 64 * 1024, 16, SECT_4K | SST_WP},
108 {"SST25VF016B", 0xbf2541, 0x0, 64 * 1024, 32, SECT_4K | SST_WP},
109 {"SST25VF032B", 0xbf254a, 0x0, 64 * 1024, 64, SECT_4K | SST_WP},
110 {"SST25VF064C", 0xbf254b, 0x0, 64 * 1024, 128, SECT_4K},
111 {"SST25WF512", 0xbf2501, 0x0, 64 * 1024, 1, SECT_4K | SST_WP},
112 {"SST25WF010", 0xbf2502, 0x0, 64 * 1024, 2, SECT_4K | SST_WP},
113 {"SST25WF020", 0xbf2503, 0x0, 64 * 1024, 4, SECT_4K | SST_WP},
114 {"SST25WF040", 0xbf2504, 0x0, 64 * 1024, 8, SECT_4K | SST_WP},
115 {"SST25WF080", 0xbf2505, 0x0, 64 * 1024, 16, SECT_4K | SST_WP},
117 #ifdef CONFIG_SPI_FLASH_WINBOND /* WINBOND */
118 {"W25P80", 0xef2014, 0x0, 64 * 1024, 16, 0},
119 {"W25P16", 0xef2015, 0x0, 64 * 1024, 32, 0},
120 {"W25P32", 0xef2016, 0x0, 64 * 1024, 64, 0},
121 {"W25X40", 0xef3013, 0x0, 64 * 1024, 8, SECT_4K},
122 {"W25X16", 0xef3015, 0x0, 64 * 1024, 32, SECT_4K},
123 {"W25X32", 0xef3016, 0x0, 64 * 1024, 64, SECT_4K},
124 {"W25X64", 0xef3017, 0x0, 64 * 1024, 128, SECT_4K},
125 {"W25Q80BL", 0xef4014, 0x0, 64 * 1024, 16, SECT_4K},
126 {"W25Q16CL", 0xef4015, 0x0, 64 * 1024, 32, SECT_4K},
127 {"W25Q32BV", 0xef4016, 0x0, 64 * 1024, 64, SECT_4K},
128 {"W25Q64CV", 0xef4017, 0x0, 64 * 1024, 128, SECT_4K},
129 {"W25Q128BV", 0xef4018, 0x0, 64 * 1024, 256, SECT_4K},
130 {"W25Q256", 0xef4019, 0x0, 64 * 1024, 512, SECT_4K},
131 {"W25Q80BW", 0xef5014, 0x0, 64 * 1024, 16, SECT_4K},
132 {"W25Q16DW", 0xef6015, 0x0, 64 * 1024, 32, SECT_4K},
133 {"W25Q32DW", 0xef6016, 0x0, 64 * 1024, 64, SECT_4K},
134 {"W25Q64DW", 0xef6017, 0x0, 64 * 1024, 128, SECT_4K},
135 {"W25Q128FW", 0xef6018, 0x0, 64 * 1024, 256, SECT_4K},
139 * Below paired flash devices has similar spi_flash_params params.
140 * (S25FL129P_64K, S25FL128S_64K)
141 * (W25Q80BL, W25Q80BV)
142 * (W25Q16CL, W25Q16DV)
143 * (W25Q32BV, W25Q32FV_SPI)
144 * (W25Q64CV, W25Q64FV_SPI)
145 * (W25Q128BV, W25Q128FV_SPI)
146 * (W25Q32DW, W25Q32FV_QPI)
147 * (W25Q64DW, W25Q64FV_QPI)
148 * (W25Q128FW, W25Q128FV_QPI)
152 struct spi_flash *spi_flash_validate_ids(struct spi_slave *spi, u8 *idcode)
154 const struct spi_flash_params *params;
155 struct spi_flash *flash;
157 u16 jedec = idcode[1] << 8 | idcode[2];
158 u16 ext_jedec = idcode[3] << 8 | idcode[4];
160 /* Get the flash id (jedec = manuf_id + dev_id, ext_jedec) */
161 for (i = 0; i < ARRAY_SIZE(spi_flash_params_table); i++) {
162 params = &spi_flash_params_table[i];
163 if ((params->jedec >> 16) == idcode[0]) {
164 if ((params->jedec & 0xFFFF) == jedec) {
165 if (params->ext_jedec == 0)
167 else if (params->ext_jedec == ext_jedec)
173 if (i == ARRAY_SIZE(spi_flash_params_table)) {
174 printf("SF: Unsupported flash IDs: ");
175 printf("manuf %02x, jedec %04x, ext_jedec %04x\n",
176 idcode[0], jedec, ext_jedec);
180 flash = malloc(sizeof(*flash));
182 debug("SF: Failed to allocate spi_flash\n");
185 memset(flash, '\0', sizeof(*flash));
188 flash->name = params->name;
190 /* Assign spi_flash ops */
191 flash->write = spi_flash_cmd_write_multi;
192 #ifdef CONFIG_SPI_FLASH_SST
193 if (params->flags & SST_WP)
194 flash->write = sst_write_wp;
196 flash->erase = spi_flash_cmd_erase;
197 flash->read = spi_flash_cmd_read_fast;
199 /* Compute the flash size */
200 flash->page_size = (ext_jedec == 0x4d00) ? 512 : 256;
201 flash->sector_size = params->sector_size;
202 flash->size = flash->sector_size * params->nr_sectors;
204 /* Compute erase sector and command */
205 if (params->flags & SECT_4K) {
206 flash->erase_cmd = CMD_ERASE_4K;
207 flash->erase_size = 4096;
208 } else if (params->flags & SECT_32K) {
209 flash->erase_cmd = CMD_ERASE_32K;
210 flash->erase_size = 32768;
212 flash->erase_cmd = CMD_ERASE_64K;
213 flash->erase_size = flash->sector_size;
216 /* Poll cmd seclection */
217 flash->poll_cmd = CMD_READ_STATUS;
218 #ifdef CONFIG_SPI_FLASH_STMICRO
219 if (params->flags & E_FSR)
220 flash->poll_cmd = CMD_FLAG_STATUS;
223 #ifdef CONFIG_SPI_FLASH_BAR
224 /* Configure the BAR - discover bank cmds and read current bank */
226 if (flash->size > SPI_FLASH_16MB_BOUN) {
227 flash->bank_read_cmd = (idcode[0] == 0x01) ?
228 CMD_BANKADDR_BRRD : CMD_EXTNADDR_RDEAR;
229 flash->bank_write_cmd = (idcode[0] == 0x01) ?
230 CMD_BANKADDR_BRWR : CMD_EXTNADDR_WREAR;
232 if (spi_flash_read_common(flash, &flash->bank_read_cmd, 1,
234 debug("SF: fail to read bank addr register\n");
237 flash->bank_curr = curr_bank;
239 flash->bank_curr = curr_bank;
243 /* Flash powers up read-only, so clear BP# bits */
244 #if defined(CONFIG_SPI_FLASH_ATMEL) || \
245 defined(CONFIG_SPI_FLASH_MACRONIX) || \
246 defined(CONFIG_SPI_FLASH_SST)
247 spi_flash_cmd_write_status(flash, 0);
253 #ifdef CONFIG_OF_CONTROL
254 int spi_flash_decode_fdt(const void *blob, struct spi_flash *flash)
260 /* If there is no node, do nothing */
261 node = fdtdec_next_compatible(blob, 0, COMPAT_GENERIC_SPI_FLASH);
265 addr = fdtdec_get_addr_size(blob, node, "memory-map", &size);
266 if (addr == FDT_ADDR_T_NONE) {
267 debug("%s: Cannot decode address\n", __func__);
271 if (flash->size != size) {
272 debug("%s: Memory map must cover entire device\n", __func__);
275 flash->memory_map = (void *)addr;
279 #endif /* CONFIG_OF_CONTROL */
281 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
282 unsigned int max_hz, unsigned int spi_mode)
284 struct spi_slave *spi;
285 struct spi_flash *flash = NULL;
289 /* Setup spi_slave */
290 spi = spi_setup_slave(bus, cs, max_hz, spi_mode);
292 printf("SF: Failed to set up slave\n");
297 ret = spi_claim_bus(spi);
299 debug("SF: Failed to claim SPI bus: %d\n", ret);
303 /* Read the ID codes */
304 ret = spi_flash_cmd(spi, CMD_READ_ID, idcode, sizeof(idcode));
306 printf("SF: Failed to get idcodes\n");
311 printf("SF: Got idcodes\n");
312 print_buffer(0, idcode, 1, sizeof(idcode), 0);
315 /* Validate ID's from flash dev table */
316 flash = spi_flash_validate_ids(spi, idcode);
320 #ifdef CONFIG_OF_CONTROL
321 if (spi_flash_decode_fdt(gd->fdt_blob, flash)) {
322 debug("SF: FDT decode error\n");
326 #ifndef CONFIG_SPL_BUILD
327 printf("SF: Detected %s with page size ", flash->name);
328 print_size(flash->page_size, ", total ");
329 print_size(flash->size, "");
330 if (flash->memory_map)
331 printf(", mapped at %p", flash->memory_map);
334 #ifndef CONFIG_SPI_FLASH_BAR
335 if (flash->size > SPI_FLASH_16MB_BOUN) {
336 puts("SF: Warning - Only lower 16MiB accessible,");
337 puts(" Full access #define CONFIG_SPI_FLASH_BAR\n");
341 /* Release spi bus */
342 spi_release_bus(spi);
347 spi_release_bus(spi);
353 void spi_flash_free(struct spi_flash *flash)
355 spi_free_slave(flash->spi);