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+
18 #include <spi_flash.h>
21 #include "sf_internal.h"
23 DECLARE_GLOBAL_DATA_PTR
;
25 /* Read commands array */
26 static u8 spi_read_cmds_array
[] = {
29 CMD_READ_DUAL_OUTPUT_FAST
,
30 CMD_READ_DUAL_IO_FAST
,
31 CMD_READ_QUAD_OUTPUT_FAST
,
32 CMD_READ_QUAD_IO_FAST
,
35 #ifdef CONFIG_SPI_FLASH_MACRONIX
36 static int spi_flash_set_qeb_mxic(struct spi_flash
*flash
)
41 ret
= spi_flash_cmd_read_status(flash
, &qeb_status
);
45 if (qeb_status
& STATUS_QEB_MXIC
) {
46 debug("SF: mxic: QEB is already set\n");
48 ret
= spi_flash_cmd_write_status(flash
, STATUS_QEB_MXIC
);
57 #if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
58 static int spi_flash_set_qeb_winspan(struct spi_flash
*flash
)
63 ret
= spi_flash_cmd_read_config(flash
, &qeb_status
);
67 if (qeb_status
& STATUS_QEB_WINSPAN
) {
68 debug("SF: winspan: QEB is already set\n");
70 ret
= spi_flash_cmd_write_config(flash
, STATUS_QEB_WINSPAN
);
79 static int spi_flash_set_qeb(struct spi_flash
*flash
, u8 idcode0
)
82 #ifdef CONFIG_SPI_FLASH_MACRONIX
83 case SPI_FLASH_CFI_MFR_MACRONIX
:
84 return spi_flash_set_qeb_mxic(flash
);
86 #if defined(CONFIG_SPI_FLASH_SPANSION) || defined(CONFIG_SPI_FLASH_WINBOND)
87 case SPI_FLASH_CFI_MFR_SPANSION
:
88 case SPI_FLASH_CFI_MFR_WINBOND
:
89 return spi_flash_set_qeb_winspan(flash
);
91 #ifdef CONFIG_SPI_FLASH_STMICRO
92 case SPI_FLASH_CFI_MFR_STMICRO
:
93 debug("SF: QEB is volatile for %02x flash\n", idcode0
);
97 printf("SF: Need set QEB func for %02x flash\n", idcode0
);
102 static int spi_flash_validate_params(struct spi_slave
*spi
, u8
*idcode
,
103 struct spi_flash
*flash
)
105 const struct spi_flash_params
*params
;
107 u16 jedec
= idcode
[1] << 8 | idcode
[2];
108 u16 ext_jedec
= idcode
[3] << 8 | idcode
[4];
110 /* Validate params from spi_flash_params table */
111 params
= spi_flash_params_table
;
112 for (; params
->name
!= NULL
; params
++) {
113 if ((params
->jedec
>> 16) == idcode
[0]) {
114 if ((params
->jedec
& 0xFFFF) == jedec
) {
115 if (params
->ext_jedec
== 0)
117 else if (params
->ext_jedec
== ext_jedec
)
124 printf("SF: Unsupported flash IDs: ");
125 printf("manuf %02x, jedec %04x, ext_jedec %04x\n",
126 idcode
[0], jedec
, ext_jedec
);
127 return -EPROTONOSUPPORT
;
130 /* Assign spi data */
132 flash
->name
= params
->name
;
133 flash
->memory_map
= spi
->memory_map
;
134 flash
->dual_flash
= flash
->spi
->option
;
136 /* Assign spi_flash ops */
137 #ifndef CONFIG_DM_SPI_FLASH
138 flash
->write
= spi_flash_cmd_write_ops
;
139 #if defined(CONFIG_SPI_FLASH_SST)
140 if (params
->flags
& SST_WR
) {
141 if (flash
->spi
->op_mode_tx
& SPI_OPM_TX_BP
)
142 flash
->write
= sst_write_bp
;
144 flash
->write
= sst_write_wp
;
147 flash
->erase
= spi_flash_cmd_erase_ops
;
148 flash
->read
= spi_flash_cmd_read_ops
;
151 /* Compute the flash size */
152 flash
->shift
= (flash
->dual_flash
& SF_DUAL_PARALLEL_FLASH
) ? 1 : 0;
154 * The Spansion S25FL032P and S25FL064P have 256b pages, yet use the
155 * 0x4d00 Extended JEDEC code. The rest of the Spansion flashes with
156 * the 0x4d00 Extended JEDEC code have 512b pages. All of the others
159 if (ext_jedec
== 0x4d00) {
160 if ((jedec
== 0x0215) || (jedec
== 0x216))
161 flash
->page_size
= 256;
163 flash
->page_size
= 512;
165 flash
->page_size
= 256;
167 flash
->page_size
<<= flash
->shift
;
168 flash
->sector_size
= params
->sector_size
<< flash
->shift
;
169 flash
->size
= flash
->sector_size
* params
->nr_sectors
<< flash
->shift
;
170 #ifdef CONFIG_SF_DUAL_FLASH
171 if (flash
->dual_flash
& SF_DUAL_STACKED_FLASH
)
175 /* Compute erase sector and command */
176 if (params
->flags
& SECT_4K
) {
177 flash
->erase_cmd
= CMD_ERASE_4K
;
178 flash
->erase_size
= 4096 << flash
->shift
;
179 } else if (params
->flags
& SECT_32K
) {
180 flash
->erase_cmd
= CMD_ERASE_32K
;
181 flash
->erase_size
= 32768 << flash
->shift
;
183 flash
->erase_cmd
= CMD_ERASE_64K
;
184 flash
->erase_size
= flash
->sector_size
;
187 /* Look for the fastest read cmd */
188 cmd
= fls(params
->e_rd_cmd
& flash
->spi
->op_mode_rx
);
190 cmd
= spi_read_cmds_array
[cmd
- 1];
191 flash
->read_cmd
= cmd
;
193 /* Go for default supported read cmd */
194 flash
->read_cmd
= CMD_READ_ARRAY_FAST
;
197 /* Not require to look for fastest only two write cmds yet */
198 if (params
->flags
& WR_QPP
&& flash
->spi
->op_mode_tx
& SPI_OPM_TX_QPP
)
199 flash
->write_cmd
= CMD_QUAD_PAGE_PROGRAM
;
201 /* Go for default supported write cmd */
202 flash
->write_cmd
= CMD_PAGE_PROGRAM
;
204 /* Read dummy_byte: dummy byte is determined based on the
205 * dummy cycles of a particular command.
206 * Fast commands - dummy_byte = dummy_cycles/8
207 * I/O commands- dummy_byte = (dummy_cycles * no.of lines)/8
208 * For I/O commands except cmd[0] everything goes on no.of lines
209 * based on particular command but incase of fast commands except
210 * data all go on single line irrespective of command.
212 switch (flash
->read_cmd
) {
213 case CMD_READ_QUAD_IO_FAST
:
214 flash
->dummy_byte
= 2;
216 case CMD_READ_ARRAY_SLOW
:
217 flash
->dummy_byte
= 0;
220 flash
->dummy_byte
= 1;
223 /* Poll cmd selection */
224 flash
->poll_cmd
= CMD_READ_STATUS
;
225 #ifdef CONFIG_SPI_FLASH_STMICRO
226 if (params
->flags
& E_FSR
)
227 flash
->poll_cmd
= CMD_FLAG_STATUS
;
230 /* Configure the BAR - discover bank cmds and read current bank */
231 #ifdef CONFIG_SPI_FLASH_BAR
233 if (flash
->size
> SPI_FLASH_16MB_BOUN
) {
236 flash
->bank_read_cmd
= (idcode
[0] == 0x01) ?
237 CMD_BANKADDR_BRRD
: CMD_EXTNADDR_RDEAR
;
238 flash
->bank_write_cmd
= (idcode
[0] == 0x01) ?
239 CMD_BANKADDR_BRWR
: CMD_EXTNADDR_WREAR
;
241 ret
= spi_flash_read_common(flash
, &flash
->bank_read_cmd
, 1,
244 debug("SF: fail to read bank addr register\n");
247 flash
->bank_curr
= curr_bank
;
249 flash
->bank_curr
= curr_bank
;
253 /* Flash powers up read-only, so clear BP# bits */
254 #if defined(CONFIG_SPI_FLASH_ATMEL) || \
255 defined(CONFIG_SPI_FLASH_MACRONIX) || \
256 defined(CONFIG_SPI_FLASH_SST)
257 spi_flash_cmd_write_status(flash
, 0);
263 #ifdef CONFIG_OF_CONTROL
264 int spi_flash_decode_fdt(const void *blob
, struct spi_flash
*flash
)
270 /* If there is no node, do nothing */
271 node
= fdtdec_next_compatible(blob
, 0, COMPAT_GENERIC_SPI_FLASH
);
275 addr
= fdtdec_get_addr_size(blob
, node
, "memory-map", &size
);
276 if (addr
== FDT_ADDR_T_NONE
) {
277 debug("%s: Cannot decode address\n", __func__
);
281 if (flash
->size
!= size
) {
282 debug("%s: Memory map must cover entire device\n", __func__
);
285 flash
->memory_map
= map_sysmem(addr
, size
);
289 #endif /* CONFIG_OF_CONTROL */
292 * spi_flash_probe_slave() - Probe for a SPI flash device on a bus
295 * @flashp: Pointer to place to put flash info, which may be NULL if the
296 * space should be allocated
298 int spi_flash_probe_slave(struct spi_slave
*spi
, struct spi_flash
*flash
)
303 /* Setup spi_slave */
305 printf("SF: Failed to set up slave\n");
310 ret
= spi_claim_bus(spi
);
312 debug("SF: Failed to claim SPI bus: %d\n", ret
);
316 /* Read the ID codes */
317 ret
= spi_flash_cmd(spi
, CMD_READ_ID
, idcode
, sizeof(idcode
));
319 printf("SF: Failed to get idcodes\n");
324 printf("SF: Got idcodes\n");
325 print_buffer(0, idcode
, 1, sizeof(idcode
), 0);
328 if (spi_flash_validate_params(spi
, idcode
, flash
)) {
333 /* Set the quad enable bit - only for quad commands */
334 if ((flash
->read_cmd
== CMD_READ_QUAD_OUTPUT_FAST
) ||
335 (flash
->read_cmd
== CMD_READ_QUAD_IO_FAST
) ||
336 (flash
->write_cmd
== CMD_QUAD_PAGE_PROGRAM
)) {
337 if (spi_flash_set_qeb(flash
, idcode
[0])) {
338 debug("SF: Fail to set QEB for %02x\n", idcode
[0]);
344 #ifdef CONFIG_OF_CONTROL
345 if (spi_flash_decode_fdt(gd
->fdt_blob
, flash
)) {
346 debug("SF: FDT decode error\n");
351 #ifndef CONFIG_SPL_BUILD
352 printf("SF: Detected %s with page size ", flash
->name
);
353 print_size(flash
->page_size
, ", erase size ");
354 print_size(flash
->erase_size
, ", total ");
355 print_size(flash
->size
, "");
356 if (flash
->memory_map
)
357 printf(", mapped at %p", flash
->memory_map
);
360 #ifndef CONFIG_SPI_FLASH_BAR
361 if (((flash
->dual_flash
== SF_SINGLE_FLASH
) &&
362 (flash
->size
> SPI_FLASH_16MB_BOUN
)) ||
363 ((flash
->dual_flash
> SF_SINGLE_FLASH
) &&
364 (flash
->size
> SPI_FLASH_16MB_BOUN
<< 1))) {
365 puts("SF: Warning - Only lower 16MiB accessible,");
366 puts(" Full access #define CONFIG_SPI_FLASH_BAR\n");
370 /* Release spi bus */
371 spi_release_bus(spi
);
376 spi_release_bus(spi
);
380 #ifndef CONFIG_DM_SPI_FLASH
381 struct spi_flash
*spi_flash_probe_tail(struct spi_slave
*bus
)
383 struct spi_flash
*flash
;
385 /* Allocate space if needed (not used by sf-uclass */
386 flash
= calloc(1, sizeof(*flash
));
388 debug("SF: Failed to allocate spi_flash\n");
392 if (spi_flash_probe_slave(bus
, flash
)) {
401 struct spi_flash
*spi_flash_probe(unsigned int busnum
, unsigned int cs
,
402 unsigned int max_hz
, unsigned int spi_mode
)
404 struct spi_slave
*bus
;
406 bus
= spi_setup_slave(busnum
, cs
, max_hz
, spi_mode
);
409 return spi_flash_probe_tail(bus
);
412 #ifdef CONFIG_OF_SPI_FLASH
413 struct spi_flash
*spi_flash_probe_fdt(const void *blob
, int slave_node
,
416 struct spi_slave
*bus
;
418 bus
= spi_setup_slave_fdt(blob
, slave_node
, spi_node
);
421 return spi_flash_probe_tail(bus
);
425 void spi_flash_free(struct spi_flash
*flash
)
427 spi_free_slave(flash
->spi
);
431 #else /* defined CONFIG_DM_SPI_FLASH */
433 static int spi_flash_std_read(struct udevice
*dev
, u32 offset
, size_t len
,
436 struct spi_flash
*flash
= dev_get_uclass_priv(dev
);
438 return spi_flash_cmd_read_ops(flash
, offset
, len
, buf
);
441 int spi_flash_std_write(struct udevice
*dev
, u32 offset
, size_t len
,
444 struct spi_flash
*flash
= dev_get_uclass_priv(dev
);
446 return spi_flash_cmd_write_ops(flash
, offset
, len
, buf
);
449 int spi_flash_std_erase(struct udevice
*dev
, u32 offset
, size_t len
)
451 struct spi_flash
*flash
= dev_get_uclass_priv(dev
);
453 return spi_flash_cmd_erase_ops(flash
, offset
, len
);
456 int spi_flash_std_probe(struct udevice
*dev
)
458 struct spi_slave
*slave
= dev_get_parentdata(dev
);
459 struct dm_spi_slave_platdata
*plat
= dev_get_parent_platdata(dev
);
460 struct spi_flash
*flash
;
462 flash
= dev_get_uclass_priv(dev
);
464 debug("%s: slave=%p, cs=%d\n", __func__
, slave
, plat
->cs
);
465 return spi_flash_probe_slave(slave
, flash
);
468 static const struct dm_spi_flash_ops spi_flash_std_ops
= {
469 .read
= spi_flash_std_read
,
470 .write
= spi_flash_std_write
,
471 .erase
= spi_flash_std_erase
,
474 static const struct udevice_id spi_flash_std_ids
[] = {
475 { .compatible
= "spi-flash" },
479 U_BOOT_DRIVER(spi_flash_std
) = {
480 .name
= "spi_flash_std",
481 .id
= UCLASS_SPI_FLASH
,
482 .of_match
= spi_flash_std_ids
,
483 .probe
= spi_flash_std_probe
,
484 .priv_auto_alloc_size
= sizeof(struct spi_flash
),
485 .ops
= &spi_flash_std_ops
,
488 #endif /* CONFIG_DM_SPI_FLASH */