4 * Copyright (C) 2008 Atmel Corporation
5 * Copyright (C) 2010 Reinhard Meyer, EMK Elektronik
6 * Copyright (C) 2013 Jagannadha Sutradharudu Teki, Xilinx Inc.
8 * SPDX-License-Identifier: GPL-2.0+
15 #include <spi_flash.h>
18 #include "sf_internal.h"
20 DECLARE_GLOBAL_DATA_PTR;
22 /* Read commands array */
23 static u8 spi_read_cmds_array[] = {
25 CMD_READ_DUAL_OUTPUT_FAST,
26 CMD_READ_DUAL_IO_FAST,
27 CMD_READ_QUAD_OUTPUT_FAST,
28 CMD_READ_QUAD_IO_FAST,
31 static int spi_flash_set_qeb(struct spi_flash *flash, u8 idcode0)
34 #ifdef CONFIG_SPI_FLASH_MACRONIX
35 case SPI_FLASH_CFI_MFR_MACRONIX:
36 return spi_flash_set_qeb_mxic(flash);
38 #if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
39 case SPI_FLASH_CFI_MFR_SPANSION:
40 case SPI_FLASH_CFI_MFR_WINBOND:
41 return spi_flash_set_qeb_winspan(flash);
43 #ifdef CONFIG_SPI_FLASH_STMICRO
44 case SPI_FLASH_CFI_MFR_STMICRO:
45 debug("SF: QEB is volatile for %02x flash\n", idcode0);
49 printf("SF: Need set QEB func for %02x flash\n", idcode0);
54 static struct spi_flash *spi_flash_validate_params(struct spi_slave *spi,
57 const struct spi_flash_params *params;
58 struct spi_flash *flash;
60 u16 jedec = idcode[1] << 8 | idcode[2];
61 u16 ext_jedec = idcode[3] << 8 | idcode[4];
63 params = spi_flash_params_table;
64 for (; params->name != NULL; params++) {
65 if ((params->jedec >> 16) == idcode[0]) {
66 if ((params->jedec & 0xFFFF) == jedec) {
67 if (params->ext_jedec == 0)
69 else if (params->ext_jedec == ext_jedec)
76 printf("SF: Unsupported flash IDs: ");
77 printf("manuf %02x, jedec %04x, ext_jedec %04x\n",
78 idcode[0], jedec, ext_jedec);
82 flash = malloc(sizeof(*flash));
84 debug("SF: Failed to allocate spi_flash\n");
87 memset(flash, '\0', sizeof(*flash));
91 flash->name = params->name;
92 flash->memory_map = spi->memory_map;
94 /* Assign spi_flash ops */
95 flash->write = spi_flash_cmd_write_ops;
96 #ifdef CONFIG_SPI_FLASH_SST
97 if (params->flags & SST_WP)
98 flash->write = sst_write_wp;
100 flash->erase = spi_flash_cmd_erase_ops;
101 flash->read = spi_flash_cmd_read_ops;
103 /* Compute the flash size */
104 flash->page_size = (ext_jedec == 0x4d00) ? 512 : 256;
105 flash->sector_size = params->sector_size;
106 flash->size = flash->sector_size * params->nr_sectors;
108 /* Compute erase sector and command */
109 if (params->flags & SECT_4K) {
110 flash->erase_cmd = CMD_ERASE_4K;
111 flash->erase_size = 4096;
112 } else if (params->flags & SECT_32K) {
113 flash->erase_cmd = CMD_ERASE_32K;
114 flash->erase_size = 32768;
116 flash->erase_cmd = CMD_ERASE_64K;
117 flash->erase_size = flash->sector_size;
120 /* Look for the fastest read cmd */
121 cmd = fls(params->e_rd_cmd & flash->spi->op_mode_rx);
123 cmd = spi_read_cmds_array[cmd - 1];
124 flash->read_cmd = cmd;
126 /* Go for for default supported read cmd */
127 flash->read_cmd = CMD_READ_ARRAY_FAST;
130 /* Not require to look for fastest only two write cmds yet */
131 if (params->flags & WR_QPP && flash->spi->op_mode_tx & SPI_OPM_TX_QPP)
132 flash->write_cmd = CMD_QUAD_PAGE_PROGRAM;
134 /* Go for default supported write cmd */
135 flash->write_cmd = CMD_PAGE_PROGRAM;
137 /* Set the quad enable bit - only for quad commands */
138 if ((flash->read_cmd == CMD_READ_QUAD_OUTPUT_FAST) ||
139 (flash->read_cmd == CMD_READ_QUAD_IO_FAST) ||
140 (flash->write_cmd == CMD_QUAD_PAGE_PROGRAM)) {
141 if (spi_flash_set_qeb(flash, idcode[0])) {
142 debug("SF: Fail to set QEB for %02x\n", idcode[0]);
147 /* Read dummy_byte: dummy byte is determined based on the
148 * dummy cycles of a particular command.
149 * Fast commands - dummy_byte = dummy_cycles/8
150 * I/O commands- dummy_byte = (dummy_cycles * no.of lines)/8
151 * For I/O commands except cmd[0] everything goes on no.of lines
152 * based on particular command but incase of fast commands except
153 * data all go on single line irrespective of command.
155 switch (flash->read_cmd) {
156 case CMD_READ_QUAD_IO_FAST:
157 flash->dummy_byte = 2;
159 case CMD_READ_ARRAY_SLOW:
160 flash->dummy_byte = 0;
163 flash->dummy_byte = 1;
166 /* Poll cmd seclection */
167 flash->poll_cmd = CMD_READ_STATUS;
168 #ifdef CONFIG_SPI_FLASH_STMICRO
169 if (params->flags & E_FSR)
170 flash->poll_cmd = CMD_FLAG_STATUS;
173 /* Configure the BAR - discover bank cmds and read current bank */
174 #ifdef CONFIG_SPI_FLASH_BAR
176 if (flash->size > SPI_FLASH_16MB_BOUN) {
177 flash->bank_read_cmd = (idcode[0] == 0x01) ?
178 CMD_BANKADDR_BRRD : CMD_EXTNADDR_RDEAR;
179 flash->bank_write_cmd = (idcode[0] == 0x01) ?
180 CMD_BANKADDR_BRWR : CMD_EXTNADDR_WREAR;
182 if (spi_flash_read_common(flash, &flash->bank_read_cmd, 1,
184 debug("SF: fail to read bank addr register\n");
187 flash->bank_curr = curr_bank;
189 flash->bank_curr = curr_bank;
193 /* Flash powers up read-only, so clear BP# bits */
194 #if defined(CONFIG_SPI_FLASH_ATMEL) || \
195 defined(CONFIG_SPI_FLASH_MACRONIX) || \
196 defined(CONFIG_SPI_FLASH_SST)
197 spi_flash_cmd_write_status(flash, 0);
203 #ifdef CONFIG_OF_CONTROL
204 int spi_flash_decode_fdt(const void *blob, struct spi_flash *flash)
210 /* If there is no node, do nothing */
211 node = fdtdec_next_compatible(blob, 0, COMPAT_GENERIC_SPI_FLASH);
215 addr = fdtdec_get_addr_size(blob, node, "memory-map", &size);
216 if (addr == FDT_ADDR_T_NONE) {
217 debug("%s: Cannot decode address\n", __func__);
221 if (flash->size != size) {
222 debug("%s: Memory map must cover entire device\n", __func__);
225 flash->memory_map = map_sysmem(addr, size);
229 #endif /* CONFIG_OF_CONTROL */
231 static struct spi_flash *spi_flash_probe_slave(struct spi_slave *spi)
233 struct spi_flash *flash = NULL;
237 /* Setup spi_slave */
239 printf("SF: Failed to set up slave\n");
244 ret = spi_claim_bus(spi);
246 debug("SF: Failed to claim SPI bus: %d\n", ret);
250 /* Read the ID codes */
251 ret = spi_flash_cmd(spi, CMD_READ_ID, idcode, sizeof(idcode));
253 printf("SF: Failed to get idcodes\n");
258 printf("SF: Got idcodes\n");
259 print_buffer(0, idcode, 1, sizeof(idcode), 0);
262 /* Validate params from spi_flash_params table */
263 flash = spi_flash_validate_params(spi, idcode);
267 #ifdef CONFIG_OF_CONTROL
268 if (spi_flash_decode_fdt(gd->fdt_blob, flash)) {
269 debug("SF: FDT decode error\n");
273 #ifndef CONFIG_SPL_BUILD
274 printf("SF: Detected %s with page size ", flash->name);
275 print_size(flash->page_size, ", erase size ");
276 print_size(flash->erase_size, ", total ");
277 print_size(flash->size, "");
278 if (flash->memory_map)
279 printf(", mapped at %p", flash->memory_map);
282 #ifndef CONFIG_SPI_FLASH_BAR
283 if (flash->size > SPI_FLASH_16MB_BOUN) {
284 puts("SF: Warning - Only lower 16MiB accessible,");
285 puts(" Full access #define CONFIG_SPI_FLASH_BAR\n");
289 /* Release spi bus */
290 spi_release_bus(spi);
295 spi_release_bus(spi);
301 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
302 unsigned int max_hz, unsigned int spi_mode)
304 struct spi_slave *spi;
306 spi = spi_setup_slave(bus, cs, max_hz, spi_mode);
307 return spi_flash_probe_slave(spi);
310 #ifdef CONFIG_OF_SPI_FLASH
311 struct spi_flash *spi_flash_probe_fdt(const void *blob, int slave_node,
314 struct spi_slave *spi;
316 spi = spi_setup_slave_fdt(blob, slave_node, spi_node);
317 return spi_flash_probe_slave(spi);
321 void spi_flash_free(struct spi_flash *flash)
323 spi_free_slave(flash->spi);