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 #ifdef CONFIG_SPI_FLASH_MACRONIX
32 static int spi_flash_set_qeb_mxic(struct spi_flash *flash)
37 ret = spi_flash_cmd_read_status(flash, &qeb_status);
41 if (qeb_status & STATUS_QEB_MXIC) {
42 debug("SF: mxic: QEB is already set\n");
44 ret = spi_flash_cmd_write_status(flash, STATUS_QEB_MXIC);
53 #if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
54 static int spi_flash_set_qeb_winspan(struct spi_flash *flash)
59 ret = spi_flash_cmd_read_config(flash, &qeb_status);
63 if (qeb_status & STATUS_QEB_WINSPAN) {
64 debug("SF: winspan: QEB is already set\n");
66 ret = spi_flash_cmd_write_config(flash, STATUS_QEB_WINSPAN);
75 static int spi_flash_set_qeb(struct spi_flash *flash, u8 idcode0)
78 #ifdef CONFIG_SPI_FLASH_MACRONIX
79 case SPI_FLASH_CFI_MFR_MACRONIX:
80 return spi_flash_set_qeb_mxic(flash);
82 #if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
83 case SPI_FLASH_CFI_MFR_SPANSION:
84 case SPI_FLASH_CFI_MFR_WINBOND:
85 return spi_flash_set_qeb_winspan(flash);
87 #ifdef CONFIG_SPI_FLASH_STMICRO
88 case SPI_FLASH_CFI_MFR_STMICRO:
89 debug("SF: QEB is volatile for %02x flash\n", idcode0);
93 printf("SF: Need set QEB func for %02x flash\n", idcode0);
98 static struct spi_flash *spi_flash_validate_params(struct spi_slave *spi,
101 const struct spi_flash_params *params;
102 struct spi_flash *flash;
104 u16 jedec = idcode[1] << 8 | idcode[2];
105 u16 ext_jedec = idcode[3] << 8 | idcode[4];
107 params = spi_flash_params_table;
108 for (; params->name != NULL; params++) {
109 if ((params->jedec >> 16) == idcode[0]) {
110 if ((params->jedec & 0xFFFF) == jedec) {
111 if (params->ext_jedec == 0)
113 else if (params->ext_jedec == ext_jedec)
120 printf("SF: Unsupported flash IDs: ");
121 printf("manuf %02x, jedec %04x, ext_jedec %04x\n",
122 idcode[0], jedec, ext_jedec);
126 flash = calloc(1, sizeof(*flash));
128 debug("SF: Failed to allocate spi_flash\n");
132 /* Assign spi data */
134 flash->name = params->name;
135 flash->memory_map = spi->memory_map;
136 flash->dual_flash = flash->spi->option;
138 /* Assign spi_flash ops */
139 flash->write = spi_flash_cmd_write_ops;
140 #ifdef CONFIG_SPI_FLASH_SST
141 if (params->flags & SST_WP)
142 flash->write = sst_write_wp;
144 flash->erase = spi_flash_cmd_erase_ops;
145 flash->read = spi_flash_cmd_read_ops;
147 /* Compute the flash size */
148 flash->shift = (flash->dual_flash & SF_DUAL_PARALLEL_FLASH) ? 1 : 0;
149 flash->page_size = ((ext_jedec == 0x4d00) ? 512 : 256) << flash->shift;
150 flash->sector_size = params->sector_size << flash->shift;
151 flash->size = flash->sector_size * params->nr_sectors << flash->shift;
152 #ifdef CONFIG_SF_DUAL_FLASH
153 if (flash->dual_flash & SF_DUAL_STACKED_FLASH)
157 /* Compute erase sector and command */
158 if (params->flags & SECT_4K) {
159 flash->erase_cmd = CMD_ERASE_4K;
160 flash->erase_size = 4096 << flash->shift;
161 } else if (params->flags & SECT_32K) {
162 flash->erase_cmd = CMD_ERASE_32K;
163 flash->erase_size = 32768 << flash->shift;
165 flash->erase_cmd = CMD_ERASE_64K;
166 flash->erase_size = flash->sector_size;
169 /* Look for the fastest read cmd */
170 cmd = fls(params->e_rd_cmd & flash->spi->op_mode_rx);
172 cmd = spi_read_cmds_array[cmd - 1];
173 flash->read_cmd = cmd;
175 /* Go for default supported read cmd */
176 flash->read_cmd = CMD_READ_ARRAY_FAST;
179 /* Not require to look for fastest only two write cmds yet */
180 if (params->flags & WR_QPP && flash->spi->op_mode_tx & SPI_OPM_TX_QPP)
181 flash->write_cmd = CMD_QUAD_PAGE_PROGRAM;
183 /* Go for default supported write cmd */
184 flash->write_cmd = CMD_PAGE_PROGRAM;
186 /* Set the quad enable bit - only for quad commands */
187 if ((flash->read_cmd == CMD_READ_QUAD_OUTPUT_FAST) ||
188 (flash->read_cmd == CMD_READ_QUAD_IO_FAST) ||
189 (flash->write_cmd == CMD_QUAD_PAGE_PROGRAM)) {
190 if (spi_flash_set_qeb(flash, idcode[0])) {
191 debug("SF: Fail to set QEB for %02x\n", idcode[0]);
196 /* Read dummy_byte: dummy byte is determined based on the
197 * dummy cycles of a particular command.
198 * Fast commands - dummy_byte = dummy_cycles/8
199 * I/O commands- dummy_byte = (dummy_cycles * no.of lines)/8
200 * For I/O commands except cmd[0] everything goes on no.of lines
201 * based on particular command but incase of fast commands except
202 * data all go on single line irrespective of command.
204 switch (flash->read_cmd) {
205 case CMD_READ_QUAD_IO_FAST:
206 flash->dummy_byte = 2;
208 case CMD_READ_ARRAY_SLOW:
209 flash->dummy_byte = 0;
212 flash->dummy_byte = 1;
215 /* Poll cmd selection */
216 flash->poll_cmd = CMD_READ_STATUS;
217 #ifdef CONFIG_SPI_FLASH_STMICRO
218 if (params->flags & E_FSR)
219 flash->poll_cmd = CMD_FLAG_STATUS;
222 /* Configure the BAR - discover bank cmds and read current bank */
223 #ifdef CONFIG_SPI_FLASH_BAR
225 if (flash->size > SPI_FLASH_16MB_BOUN) {
226 flash->bank_read_cmd = (idcode[0] == 0x01) ?
227 CMD_BANKADDR_BRRD : CMD_EXTNADDR_RDEAR;
228 flash->bank_write_cmd = (idcode[0] == 0x01) ?
229 CMD_BANKADDR_BRWR : CMD_EXTNADDR_WREAR;
231 if (spi_flash_read_common(flash, &flash->bank_read_cmd, 1,
233 debug("SF: fail to read bank addr register\n");
236 flash->bank_curr = curr_bank;
238 flash->bank_curr = curr_bank;
242 /* Flash powers up read-only, so clear BP# bits */
243 #if defined(CONFIG_SPI_FLASH_ATMEL) || \
244 defined(CONFIG_SPI_FLASH_MACRONIX) || \
245 defined(CONFIG_SPI_FLASH_SST)
246 spi_flash_cmd_write_status(flash, 0);
252 #ifdef CONFIG_OF_CONTROL
253 int spi_flash_decode_fdt(const void *blob, struct spi_flash *flash)
259 /* If there is no node, do nothing */
260 node = fdtdec_next_compatible(blob, 0, COMPAT_GENERIC_SPI_FLASH);
264 addr = fdtdec_get_addr_size(blob, node, "memory-map", &size);
265 if (addr == FDT_ADDR_T_NONE) {
266 debug("%s: Cannot decode address\n", __func__);
270 if (flash->size != size) {
271 debug("%s: Memory map must cover entire device\n", __func__);
274 flash->memory_map = map_sysmem(addr, size);
278 #endif /* CONFIG_OF_CONTROL */
280 static struct spi_flash *spi_flash_probe_slave(struct spi_slave *spi)
282 struct spi_flash *flash = NULL;
286 /* Setup spi_slave */
288 printf("SF: Failed to set up slave\n");
293 ret = spi_claim_bus(spi);
295 debug("SF: Failed to claim SPI bus: %d\n", ret);
299 /* Read the ID codes */
300 ret = spi_flash_cmd(spi, CMD_READ_ID, idcode, sizeof(idcode));
302 printf("SF: Failed to get idcodes\n");
307 printf("SF: Got idcodes\n");
308 print_buffer(0, idcode, 1, sizeof(idcode), 0);
311 /* Validate params from spi_flash_params table */
312 flash = spi_flash_validate_params(spi, idcode);
316 #ifdef CONFIG_OF_CONTROL
317 if (spi_flash_decode_fdt(gd->fdt_blob, flash)) {
318 debug("SF: FDT decode error\n");
322 #ifndef CONFIG_SPL_BUILD
323 printf("SF: Detected %s with page size ", flash->name);
324 print_size(flash->page_size, ", erase size ");
325 print_size(flash->erase_size, ", total ");
326 print_size(flash->size, "");
327 if (flash->memory_map)
328 printf(", mapped at %p", flash->memory_map);
331 #ifndef CONFIG_SPI_FLASH_BAR
332 if (((flash->dual_flash == SF_SINGLE_FLASH) &&
333 (flash->size > SPI_FLASH_16MB_BOUN)) ||
334 ((flash->dual_flash > SF_SINGLE_FLASH) &&
335 (flash->size > SPI_FLASH_16MB_BOUN << 1))) {
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 struct spi_flash *spi_flash_probe(unsigned int bus, unsigned int cs,
354 unsigned int max_hz, unsigned int spi_mode)
356 struct spi_slave *spi;
358 spi = spi_setup_slave(bus, cs, max_hz, spi_mode);
359 return spi_flash_probe_slave(spi);
362 #ifdef CONFIG_OF_SPI_FLASH
363 struct spi_flash *spi_flash_probe_fdt(const void *blob, int slave_node,
366 struct spi_slave *spi;
368 spi = spi_setup_slave_fdt(blob, slave_node, spi_node);
369 return spi_flash_probe_slave(spi);
373 void spi_flash_free(struct spi_flash *flash)
375 spi_free_slave(flash->spi);