3 * Atmel DataFlash probing
5 * Copyright (C) 2004-2009, 2015 Freescale Semiconductor, Inc.
6 * Haikun Wang (haikun.wang@freescale.com)
8 * SPDX-License-Identifier: GPL-2.0+
15 #include <spi_flash.h>
17 #include <linux/err.h>
18 #include <linux/math64.h>
20 #include "sf_internal.h"
22 /* reads can bypass the buffers */
23 #define OP_READ_CONTINUOUS 0xE8
24 #define OP_READ_PAGE 0xD2
26 /* group B requests can run even while status reports "busy" */
27 #define OP_READ_STATUS 0xD7 /* group B */
29 /* move data between host and buffer */
30 #define OP_READ_BUFFER1 0xD4 /* group B */
31 #define OP_READ_BUFFER2 0xD6 /* group B */
32 #define OP_WRITE_BUFFER1 0x84 /* group B */
33 #define OP_WRITE_BUFFER2 0x87 /* group B */
36 #define OP_ERASE_PAGE 0x81
37 #define OP_ERASE_BLOCK 0x50
39 /* move data between buffer and flash */
40 #define OP_TRANSFER_BUF1 0x53
41 #define OP_TRANSFER_BUF2 0x55
42 #define OP_MREAD_BUFFER1 0xD4
43 #define OP_MREAD_BUFFER2 0xD6
44 #define OP_MWERASE_BUFFER1 0x83
45 #define OP_MWERASE_BUFFER2 0x86
46 #define OP_MWRITE_BUFFER1 0x88 /* sector must be pre-erased */
47 #define OP_MWRITE_BUFFER2 0x89 /* sector must be pre-erased */
49 /* write to buffer, then write-erase to flash */
50 #define OP_PROGRAM_VIA_BUF1 0x82
51 #define OP_PROGRAM_VIA_BUF2 0x85
53 /* compare buffer to flash */
54 #define OP_COMPARE_BUF1 0x60
55 #define OP_COMPARE_BUF2 0x61
57 /* read flash to buffer, then write-erase to flash */
58 #define OP_REWRITE_VIA_BUF1 0x58
59 #define OP_REWRITE_VIA_BUF2 0x59
62 * newer chips report JEDEC manufacturer and device IDs; chip
63 * serial number and OTP bits; and per-sector writeprotect.
65 #define OP_READ_ID 0x9F
66 #define OP_READ_SECURITY 0x77
67 #define OP_WRITE_SECURITY_REVC 0x9A
68 #define OP_WRITE_SECURITY 0x9B /* revision D */
73 unsigned short page_offset; /* offset in flash address */
77 * Return the status of the DataFlash device.
79 static inline int dataflash_status(struct spi_slave *spi)
84 * NOTE: at45db321c over 25 MHz wants to write
85 * a dummy byte after the opcode...
87 ret = spi_flash_cmd(spi, OP_READ_STATUS, &status, 1);
88 return ret ? -EIO : status;
92 * Poll the DataFlash device until it is READY.
93 * This usually takes 5-20 msec or so; more for sector erase.
96 static int dataflash_waitready(struct spi_slave *spi)
99 int timeout = 2 * CONFIG_SYS_HZ;
102 timebase = get_timer(0);
104 status = dataflash_status(spi);
108 if (status & (1 << 7)) /* RDY/nBSY */
112 } while (get_timer(timebase) < timeout);
118 * Erase pages of flash.
120 static int spi_dataflash_erase(struct udevice *dev, u32 offset, size_t len)
122 struct dataflash *dataflash;
123 struct spi_flash *spi_flash;
124 struct spi_slave *spi;
130 dataflash = dev_get_priv(dev);
131 spi_flash = dev_get_uclass_priv(dev);
132 spi = spi_flash->spi;
134 blocksize = spi_flash->page_size << 3;
136 memset(dataflash->command, 0 , sizeof(dataflash->command));
137 command = dataflash->command;
139 debug("%s: erase addr=0x%x len 0x%x\n", dev->name, offset, len);
141 div_u64_rem(len, spi_flash->page_size, &rem);
144 div_u64_rem(offset, spi_flash->page_size, &rem);
148 status = spi_claim_bus(spi);
150 debug("SPI DATAFLASH: unable to claim SPI bus\n");
155 unsigned int pageaddr;
158 * Calculate flash page address; use block erase (for speed) if
159 * we're at a block boundary and need to erase the whole block.
161 pageaddr = div_u64(offset, spi_flash->page_size);
162 do_block = (pageaddr & 0x7) == 0 && len >= blocksize;
163 pageaddr = pageaddr << dataflash->page_offset;
165 command[0] = do_block ? OP_ERASE_BLOCK : OP_ERASE_PAGE;
166 command[1] = (uint8_t)(pageaddr >> 16);
167 command[2] = (uint8_t)(pageaddr >> 8);
170 debug("%s ERASE %s: (%x) %x %x %x [%d]\n",
171 dev->name, do_block ? "block" : "page",
172 command[0], command[1], command[2], command[3],
175 status = spi_flash_cmd_write(spi, command, 4, NULL, 0);
177 debug("%s: erase send command error!\n", dev->name);
181 status = dataflash_waitready(spi);
183 debug("%s: erase waitready error!\n", dev->name);
191 offset += spi_flash->page_size;
192 len -= spi_flash->page_size;
196 spi_release_bus(spi);
202 * Read from the DataFlash device.
203 * offset : Start offset in flash device
204 * len : Amount to read
205 * buf : Buffer containing the data
207 static int spi_dataflash_read(struct udevice *dev, u32 offset, size_t len,
210 struct dataflash *dataflash;
211 struct spi_flash *spi_flash;
212 struct spi_slave *spi;
217 dataflash = dev_get_priv(dev);
218 spi_flash = dev_get_uclass_priv(dev);
219 spi = spi_flash->spi;
221 memset(dataflash->command, 0 , sizeof(dataflash->command));
222 command = dataflash->command;
224 debug("%s: erase addr=0x%x len 0x%x\n", dev->name, offset, len);
225 debug("READ: (%x) %x %x %x\n",
226 command[0], command[1], command[2], command[3]);
228 /* Calculate flash page/byte address */
229 addr = (((unsigned)offset / spi_flash->page_size)
230 << dataflash->page_offset)
231 + ((unsigned)offset % spi_flash->page_size);
233 status = spi_claim_bus(spi);
235 debug("SPI DATAFLASH: unable to claim SPI bus\n");
240 * Continuous read, max clock = f(car) which may be less than
241 * the peak rate available. Some chips support commands with
242 * fewer "don't care" bytes. Both buffers stay unchanged.
244 command[0] = OP_READ_CONTINUOUS;
245 command[1] = (uint8_t)(addr >> 16);
246 command[2] = (uint8_t)(addr >> 8);
247 command[3] = (uint8_t)(addr >> 0);
249 /* plus 4 "don't care" bytes, command len: 4 + 4 "don't care" bytes */
250 status = spi_flash_cmd_read(spi, command, 8, buf, len);
252 spi_release_bus(spi);
258 * Write to the DataFlash device.
259 * offset : Start offset in flash device
260 * len : Amount to write
261 * buf : Buffer containing the data
263 int spi_dataflash_write(struct udevice *dev, u32 offset, size_t len,
266 struct dataflash *dataflash;
267 struct spi_flash *spi_flash;
268 struct spi_slave *spi;
270 unsigned int pageaddr, addr, to, writelen;
271 size_t remaining = len;
272 u_char *writebuf = (u_char *)buf;
273 int status = -EINVAL;
275 dataflash = dev_get_priv(dev);
276 spi_flash = dev_get_uclass_priv(dev);
277 spi = spi_flash->spi;
279 memset(dataflash->command, 0 , sizeof(dataflash->command));
280 command = dataflash->command;
282 debug("%s: write 0x%x..0x%x\n", dev->name, offset, (offset + len));
284 pageaddr = ((unsigned)offset / spi_flash->page_size);
285 to = ((unsigned)offset % spi_flash->page_size);
286 if (to + len > spi_flash->page_size)
287 writelen = spi_flash->page_size - to;
291 status = spi_claim_bus(spi);
293 debug("SPI DATAFLASH: unable to claim SPI bus\n");
297 while (remaining > 0) {
298 debug("write @ %d:%d len=%d\n", pageaddr, to, writelen);
302 * (a) each page in a sector must be rewritten at least
303 * once every 10K sibling erase/program operations.
304 * (b) for pages that are already erased, we could
305 * use WRITE+MWRITE not PROGRAM for ~30% speedup.
306 * (c) WRITE to buffer could be done while waiting for
307 * a previous MWRITE/MWERASE to complete ...
308 * (d) error handling here seems to be mostly missing.
310 * Two persistent bits per page, plus a per-sector counter,
311 * could support (a) and (b) ... we might consider using
312 * the second half of sector zero, which is just one block,
313 * to track that state. (On AT91, that sector should also
314 * support boot-from-DataFlash.)
317 addr = pageaddr << dataflash->page_offset;
319 /* (1) Maybe transfer partial page to Buffer1 */
320 if (writelen != spi_flash->page_size) {
321 command[0] = OP_TRANSFER_BUF1;
322 command[1] = (addr & 0x00FF0000) >> 16;
323 command[2] = (addr & 0x0000FF00) >> 8;
326 debug("TRANSFER: (%x) %x %x %x\n",
327 command[0], command[1], command[2], command[3]);
329 status = spi_flash_cmd_write(spi, command, 4, NULL, 0);
331 debug("%s: write(<pagesize) command error!\n",
336 status = dataflash_waitready(spi);
338 debug("%s: write(<pagesize) waitready error!\n",
344 /* (2) Program full page via Buffer1 */
346 command[0] = OP_PROGRAM_VIA_BUF1;
347 command[1] = (addr & 0x00FF0000) >> 16;
348 command[2] = (addr & 0x0000FF00) >> 8;
349 command[3] = (addr & 0x000000FF);
351 debug("PROGRAM: (%x) %x %x %x\n",
352 command[0], command[1], command[2], command[3]);
354 status = spi_flash_cmd_write(spi, command,
355 4, writebuf, writelen);
357 debug("%s: write send command error!\n", dev->name);
361 status = dataflash_waitready(spi);
363 debug("%s: write waitready error!\n", dev->name);
367 #ifdef CONFIG_SPI_DATAFLASH_WRITE_VERIFY
368 /* (3) Compare to Buffer1 */
369 addr = pageaddr << dataflash->page_offset;
370 command[0] = OP_COMPARE_BUF1;
371 command[1] = (addr & 0x00FF0000) >> 16;
372 command[2] = (addr & 0x0000FF00) >> 8;
375 debug("COMPARE: (%x) %x %x %x\n",
376 command[0], command[1], command[2], command[3]);
378 status = spi_flash_cmd_write(spi, command,
379 4, writebuf, writelen);
381 debug("%s: write(compare) send command error!\n",
386 status = dataflash_waitready(spi);
388 /* Check result of the compare operation */
389 if (status & (1 << 6)) {
390 printf("SPI DataFlash: write compare page %u, err %d\n",
399 #endif /* CONFIG_SPI_DATAFLASH_WRITE_VERIFY */
400 remaining = remaining - writelen;
403 writebuf += writelen;
405 if (remaining > spi_flash->page_size)
406 writelen = spi_flash->page_size;
408 writelen = remaining;
411 spi_release_bus(spi);
416 static int add_dataflash(struct udevice *dev, char *name, int nr_pages,
417 int pagesize, int pageoffset, char revision)
419 struct spi_flash *spi_flash;
420 struct dataflash *dataflash;
422 dataflash = dev_get_priv(dev);
423 spi_flash = dev_get_uclass_priv(dev);
425 dataflash->page_offset = pageoffset;
427 spi_flash->name = name;
428 spi_flash->page_size = pagesize;
429 spi_flash->size = nr_pages * pagesize;
430 spi_flash->erase_size = pagesize;
432 #ifndef CONFIG_SPL_BUILD
433 printf("SPI DataFlash: Detected %s with page size ", spi_flash->name);
434 print_size(spi_flash->page_size, ", erase size ");
435 print_size(spi_flash->erase_size, ", total ");
436 print_size(spi_flash->size, "");
437 printf(", revision %c", revision);
448 * JEDEC id has a high byte of zero plus three data bytes:
449 * the manufacturer id, then a two byte device id.
453 /* The size listed here is what works with OP_ERASE_PAGE. */
459 #define SUP_POW2PS 0x0002 /* supports 2^N byte pages */
460 #define IS_POW2PS 0x0001 /* uses 2^N byte pages */
463 static struct flash_info dataflash_data[] = {
465 * NOTE: chips with SUP_POW2PS (rev D and up) need two entries,
466 * one with IS_POW2PS and the other without. The entry with the
467 * non-2^N byte page size can't name exact chip revisions without
468 * losing backwards compatibility for cmdlinepart.
470 * Those two entries have different name spelling format in order to
471 * show their difference obviously.
472 * The upper case refer to the chip isn't in normal 2^N bytes page-size
474 * The lower case refer to the chip is in normal 2^N bytes page-size
477 * These newer chips also support 128-byte security registers (with
478 * 64 bytes one-time-programmable) and software write-protection.
480 { "AT45DB011B", 0x1f2200, 512, 264, 9, SUP_POW2PS},
481 { "at45db011d", 0x1f2200, 512, 256, 8, SUP_POW2PS | IS_POW2PS},
483 { "AT45DB021B", 0x1f2300, 1024, 264, 9, SUP_POW2PS},
484 { "at45db021d", 0x1f2300, 1024, 256, 8, SUP_POW2PS | IS_POW2PS},
486 { "AT45DB041x", 0x1f2400, 2048, 264, 9, SUP_POW2PS},
487 { "at45db041d", 0x1f2400, 2048, 256, 8, SUP_POW2PS | IS_POW2PS},
489 { "AT45DB081B", 0x1f2500, 4096, 264, 9, SUP_POW2PS},
490 { "at45db081d", 0x1f2500, 4096, 256, 8, SUP_POW2PS | IS_POW2PS},
492 { "AT45DB161x", 0x1f2600, 4096, 528, 10, SUP_POW2PS},
493 { "at45db161d", 0x1f2600, 4096, 512, 9, SUP_POW2PS | IS_POW2PS},
495 { "AT45DB321x", 0x1f2700, 8192, 528, 10, 0}, /* rev C */
497 { "AT45DB321x", 0x1f2701, 8192, 528, 10, SUP_POW2PS},
498 { "at45db321d", 0x1f2701, 8192, 512, 9, SUP_POW2PS | IS_POW2PS},
500 { "AT45DB642x", 0x1f2800, 8192, 1056, 11, SUP_POW2PS},
501 { "at45db642d", 0x1f2800, 8192, 1024, 10, SUP_POW2PS | IS_POW2PS},
504 static struct flash_info *jedec_probe(struct spi_slave *spi)
509 struct flash_info *info;
513 * JEDEC also defines an optional "extended device information"
514 * string for after vendor-specific data, after the three bytes
515 * we use here. Supporting some chips might require using it.
517 * If the vendor ID isn't Atmel's (0x1f), assume this call failed.
518 * That's not an error; only rev C and newer chips handle it, and
519 * only Atmel sells these chips.
521 tmp = spi_flash_cmd(spi, CMD_READ_ID, id, sizeof(id));
523 printf("dataflash: error %d reading JEDEC ID\n", tmp);
535 for (tmp = 0, info = dataflash_data;
536 tmp < ARRAY_SIZE(dataflash_data);
538 if (info->jedec_id == jedec) {
539 if (info->flags & SUP_POW2PS) {
540 status = dataflash_status(spi);
542 debug("SPI DataFlash: status error %d\n",
547 if (info->flags & IS_POW2PS)
550 if (!(info->flags & IS_POW2PS))
560 * Treat other chips as errors ... we won't know the right page
561 * size (it might be binary) even when we can tell which density
562 * class is involved (legacy chip id scheme).
564 printf("SPI DataFlash: Unsupported flash IDs: ");
565 printf("manuf %02x, jedec %04x, ext_jedec %04x\n",
566 id[0], jedec, id[3] << 8 | id[4]);
571 * Detect and initialize DataFlash device, using JEDEC IDs on newer chips
572 * or else the ID code embedded in the status bits:
574 * Device Density ID code #Pages PageSize Offset
575 * AT45DB011B 1Mbit (128K) xx0011xx (0x0c) 512 264 9
576 * AT45DB021B 2Mbit (256K) xx0101xx (0x14) 1024 264 9
577 * AT45DB041B 4Mbit (512K) xx0111xx (0x1c) 2048 264 9
578 * AT45DB081B 8Mbit (1M) xx1001xx (0x24) 4096 264 9
579 * AT45DB0161B 16Mbit (2M) xx1011xx (0x2c) 4096 528 10
580 * AT45DB0321B 32Mbit (4M) xx1101xx (0x34) 8192 528 10
581 * AT45DB0642 64Mbit (8M) xx111xxx (0x3c) 8192 1056 11
582 * AT45DB1282 128Mbit (16M) xx0100xx (0x10) 16384 1056 11
584 static int spi_dataflash_probe(struct udevice *dev)
586 struct spi_slave *spi = dev_get_parent_priv(dev);
587 struct spi_flash *spi_flash;
588 struct flash_info *info;
591 spi_flash = dev_get_uclass_priv(dev);
592 spi_flash->spi = spi;
593 spi_flash->dev = dev;
595 ret = spi_claim_bus(spi);
600 * Try to detect dataflash by JEDEC ID.
601 * If it succeeds we know we have either a C or D part.
602 * D will support power of 2 pagesize option.
603 * Both support the security register, though with different
606 info = jedec_probe(spi);
608 return PTR_ERR(info);
610 add_dataflash(dev, info->name, info->nr_pages,
611 info->pagesize, info->pageoffset,
612 (info->flags & SUP_POW2PS) ? 'd' : 'c');
615 * Older chips support only legacy commands, identifing
616 * capacity using bits in the status byte.
618 status = dataflash_status(spi);
619 if (status <= 0 || status == 0xff) {
620 printf("SPI DataFlash: read status error %d\n", status);
621 if (status == 0 || status == 0xff)
626 * if there's a device there, assume it's dataflash.
627 * board setup should have set spi->max_speed_max to
628 * match f(car) for continuous reads, mode 0 or 3.
630 switch (status & 0x3c) {
631 case 0x0c: /* 0 0 1 1 x x */
632 status = add_dataflash(dev, "AT45DB011B",
635 case 0x14: /* 0 1 0 1 x x */
636 status = add_dataflash(dev, "AT45DB021B",
639 case 0x1c: /* 0 1 1 1 x x */
640 status = add_dataflash(dev, "AT45DB041x",
643 case 0x24: /* 1 0 0 1 x x */
644 status = add_dataflash(dev, "AT45DB081B",
647 case 0x2c: /* 1 0 1 1 x x */
648 status = add_dataflash(dev, "AT45DB161x",
651 case 0x34: /* 1 1 0 1 x x */
652 status = add_dataflash(dev, "AT45DB321x",
655 case 0x38: /* 1 1 1 x x x */
657 status = add_dataflash(dev, "AT45DB642x",
660 /* obsolete AT45DB1282 not (yet?) supported */
662 dev_info(&spi->dev, "unsupported device (%x)\n",
669 spi_release_bus(spi);
674 spi_release_bus(spi);
679 static const struct dm_spi_flash_ops spi_dataflash_ops = {
680 .read = spi_dataflash_read,
681 .write = spi_dataflash_write,
682 .erase = spi_dataflash_erase,
685 static const struct udevice_id spi_dataflash_ids[] = {
686 { .compatible = "atmel,at45", },
687 { .compatible = "atmel,dataflash", },
691 U_BOOT_DRIVER(spi_dataflash) = {
692 .name = "spi_dataflash",
693 .id = UCLASS_SPI_FLASH,
694 .of_match = spi_dataflash_ids,
695 .probe = spi_dataflash_probe,
696 .priv_auto_alloc_size = sizeof(struct dataflash),
697 .ops = &spi_dataflash_ops,