2 * Atmel DataFlash probing
4 * Copyright (C) 2004-2009, 2015 Freescale Semiconductor, Inc.
5 * Haikun Wang (haikun.wang@freescale.com)
7 * 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 */
72 unsigned short page_offset; /* offset in flash address */
75 /* Return the status of the DataFlash device */
76 static inline int dataflash_status(struct spi_slave *spi)
81 * NOTE: at45db321c over 25 MHz wants to write
82 * a dummy byte after the opcode...
84 ret = spi_flash_cmd(spi, OP_READ_STATUS, &status, 1);
85 return ret ? -EIO : status;
89 * Poll the DataFlash device until it is READY.
90 * This usually takes 5-20 msec or so; more for sector erase.
93 static int dataflash_waitready(struct spi_slave *spi)
96 int timeout = 2 * CONFIG_SYS_HZ;
99 timebase = get_timer(0);
101 status = dataflash_status(spi);
105 if (status & (1 << 7)) /* RDY/nBSY */
109 } while (get_timer(timebase) < timeout);
114 /* Erase pages of flash */
115 static int spi_dataflash_erase(struct udevice *dev, u32 offset, size_t len)
117 struct dataflash *dataflash;
118 struct spi_flash *spi_flash;
119 struct spi_slave *spi;
125 dataflash = dev_get_priv(dev);
126 spi_flash = dev_get_uclass_priv(dev);
127 spi = spi_flash->spi;
129 blocksize = spi_flash->page_size << 3;
131 memset(dataflash->command, 0 , sizeof(dataflash->command));
132 command = dataflash->command;
134 debug("%s: erase addr=0x%x len 0x%x\n", dev->name, offset, len);
136 div_u64_rem(len, spi_flash->page_size, &rem);
138 printf("%s: len(0x%x) isn't the multiple of page size(0x%x)\n",
139 dev->name, len, spi_flash->page_size);
142 div_u64_rem(offset, spi_flash->page_size, &rem);
144 printf("%s: offset(0x%x) isn't the multiple of page size(0x%x)\n",
145 dev->name, offset, spi_flash->page_size);
149 status = spi_claim_bus(spi);
151 debug("dataflash: unable to claim SPI bus\n");
156 unsigned int pageaddr;
159 * Calculate flash page address; use block erase (for speed) if
160 * we're at a block boundary and need to erase the whole block.
162 pageaddr = div_u64(offset, spi_flash->page_size);
163 do_block = (pageaddr & 0x7) == 0 && len >= blocksize;
164 pageaddr = pageaddr << dataflash->page_offset;
166 command[0] = do_block ? OP_ERASE_BLOCK : OP_ERASE_PAGE;
167 command[1] = (uint8_t)(pageaddr >> 16);
168 command[2] = (uint8_t)(pageaddr >> 8);
171 debug("%s ERASE %s: (%x) %x %x %x [%d]\n",
172 dev->name, do_block ? "block" : "page",
173 command[0], command[1], command[2], command[3],
176 status = spi_flash_cmd_write(spi, command, 4, NULL, 0);
178 debug("%s: erase send command error!\n", dev->name);
182 status = dataflash_waitready(spi);
184 debug("%s: erase waitready error!\n", dev->name);
192 offset += spi_flash->page_size;
193 len -= spi_flash->page_size;
197 spi_release_bus(spi);
203 * Read from the DataFlash device.
204 * offset : Start offset in flash device
205 * len : Amount to read
206 * buf : Buffer containing the data
208 static int spi_dataflash_read(struct udevice *dev, u32 offset, size_t len,
211 struct dataflash *dataflash;
212 struct spi_flash *spi_flash;
213 struct spi_slave *spi;
218 dataflash = dev_get_priv(dev);
219 spi_flash = dev_get_uclass_priv(dev);
220 spi = spi_flash->spi;
222 memset(dataflash->command, 0 , sizeof(dataflash->command));
223 command = dataflash->command;
225 debug("%s: erase addr=0x%x len 0x%x\n", dev->name, offset, len);
226 debug("READ: (%x) %x %x %x\n",
227 command[0], command[1], command[2], command[3]);
229 /* Calculate flash page/byte address */
230 addr = (((unsigned)offset / spi_flash->page_size)
231 << dataflash->page_offset)
232 + ((unsigned)offset % spi_flash->page_size);
234 status = spi_claim_bus(spi);
236 debug("dataflash: unable to claim SPI bus\n");
241 * Continuous read, max clock = f(car) which may be less than
242 * the peak rate available. Some chips support commands with
243 * fewer "don't care" bytes. Both buffers stay unchanged.
245 command[0] = OP_READ_CONTINUOUS;
246 command[1] = (uint8_t)(addr >> 16);
247 command[2] = (uint8_t)(addr >> 8);
248 command[3] = (uint8_t)(addr >> 0);
250 /* plus 4 "don't care" bytes, command len: 4 + 4 "don't care" bytes */
251 status = spi_flash_cmd_read(spi, command, 8, buf, len);
253 spi_release_bus(spi);
259 * Write to the DataFlash device.
260 * offset : Start offset in flash device
261 * len : Amount to write
262 * buf : Buffer containing the data
264 int spi_dataflash_write(struct udevice *dev, u32 offset, size_t len,
267 struct dataflash *dataflash;
268 struct spi_flash *spi_flash;
269 struct spi_slave *spi;
271 unsigned int pageaddr, addr, to, writelen;
272 size_t remaining = len;
273 u_char *writebuf = (u_char *)buf;
274 int status = -EINVAL;
276 dataflash = dev_get_priv(dev);
277 spi_flash = dev_get_uclass_priv(dev);
278 spi = spi_flash->spi;
280 memset(dataflash->command, 0 , sizeof(dataflash->command));
281 command = dataflash->command;
283 debug("%s: write 0x%x..0x%x\n", dev->name, offset, (offset + len));
285 pageaddr = ((unsigned)offset / spi_flash->page_size);
286 to = ((unsigned)offset % spi_flash->page_size);
287 if (to + len > spi_flash->page_size)
288 writelen = spi_flash->page_size - to;
292 status = spi_claim_bus(spi);
294 debug("dataflash: unable to claim SPI bus\n");
298 while (remaining > 0) {
299 debug("write @ %d:%d len=%d\n", pageaddr, to, writelen);
303 * (a) each page in a sector must be rewritten at least
304 * once every 10K sibling erase/program operations.
305 * (b) for pages that are already erased, we could
306 * use WRITE+MWRITE not PROGRAM for ~30% speedup.
307 * (c) WRITE to buffer could be done while waiting for
308 * a previous MWRITE/MWERASE to complete ...
309 * (d) error handling here seems to be mostly missing.
311 * Two persistent bits per page, plus a per-sector counter,
312 * could support (a) and (b) ... we might consider using
313 * the second half of sector zero, which is just one block,
314 * to track that state. (On AT91, that sector should also
315 * support boot-from-DataFlash.)
318 addr = pageaddr << dataflash->page_offset;
320 /* (1) Maybe transfer partial page to Buffer1 */
321 if (writelen != spi_flash->page_size) {
322 command[0] = OP_TRANSFER_BUF1;
323 command[1] = (addr & 0x00FF0000) >> 16;
324 command[2] = (addr & 0x0000FF00) >> 8;
327 debug("TRANSFER: (%x) %x %x %x\n",
328 command[0], command[1], command[2], command[3]);
330 status = spi_flash_cmd_write(spi, command, 4, NULL, 0);
332 debug("%s: write(<pagesize) command error!\n",
337 status = dataflash_waitready(spi);
339 debug("%s: write(<pagesize) waitready error!\n",
345 /* (2) Program full page via Buffer1 */
347 command[0] = OP_PROGRAM_VIA_BUF1;
348 command[1] = (addr & 0x00FF0000) >> 16;
349 command[2] = (addr & 0x0000FF00) >> 8;
350 command[3] = (addr & 0x000000FF);
352 debug("PROGRAM: (%x) %x %x %x\n",
353 command[0], command[1], command[2], command[3]);
355 status = spi_flash_cmd_write(spi, command,
356 4, writebuf, writelen);
358 debug("%s: write send command error!\n", dev->name);
362 status = dataflash_waitready(spi);
364 debug("%s: write waitready error!\n", dev->name);
368 #ifdef CONFIG_SPI_DATAFLASH_WRITE_VERIFY
369 /* (3) Compare to Buffer1 */
370 addr = pageaddr << dataflash->page_offset;
371 command[0] = OP_COMPARE_BUF1;
372 command[1] = (addr & 0x00FF0000) >> 16;
373 command[2] = (addr & 0x0000FF00) >> 8;
376 debug("COMPARE: (%x) %x %x %x\n",
377 command[0], command[1], command[2], command[3]);
379 status = spi_flash_cmd_write(spi, command,
380 4, writebuf, writelen);
382 debug("%s: write(compare) send command error!\n",
387 status = dataflash_waitready(spi);
389 /* Check result of the compare operation */
390 if (status & (1 << 6)) {
391 printf("dataflash: write compare page %u, err %d\n",
400 #endif /* CONFIG_SPI_DATAFLASH_WRITE_VERIFY */
401 remaining = remaining - writelen;
404 writebuf += writelen;
406 if (remaining > spi_flash->page_size)
407 writelen = spi_flash->page_size;
409 writelen = remaining;
412 spi_release_bus(spi);
417 static int add_dataflash(struct udevice *dev, char *name, int nr_pages,
418 int pagesize, int pageoffset, char revision)
420 struct spi_flash *spi_flash;
421 struct dataflash *dataflash;
423 dataflash = dev_get_priv(dev);
424 spi_flash = dev_get_uclass_priv(dev);
426 dataflash->page_offset = pageoffset;
428 spi_flash->name = name;
429 spi_flash->page_size = pagesize;
430 spi_flash->size = nr_pages * pagesize;
431 spi_flash->erase_size = pagesize;
433 #ifndef CONFIG_SPL_BUILD
434 printf("SPI DataFlash: Detected %s with page size ", spi_flash->name);
435 print_size(spi_flash->page_size, ", erase size ");
436 print_size(spi_flash->erase_size, ", total ");
437 print_size(spi_flash->size, "");
438 printf(", revision %c", revision);
449 * JEDEC id has a high byte of zero plus three data bytes:
450 * the manufacturer id, then a two byte device id.
454 /* The size listed here is what works with OP_ERASE_PAGE. */
460 #define SUP_POW2PS 0x0002 /* supports 2^N byte pages */
461 #define IS_POW2PS 0x0001 /* uses 2^N byte pages */
464 static struct flash_info dataflash_data[] = {
466 * NOTE: chips with SUP_POW2PS (rev D and up) need two entries,
467 * one with IS_POW2PS and the other without. The entry with the
468 * non-2^N byte page size can't name exact chip revisions without
469 * losing backwards compatibility for cmdlinepart.
471 * Those two entries have different name spelling format in order to
472 * show their difference obviously.
473 * The upper case refer to the chip isn't in normal 2^N bytes page-size
475 * The lower case refer to the chip is in normal 2^N bytes page-size
478 * These newer chips also support 128-byte security registers (with
479 * 64 bytes one-time-programmable) and software write-protection.
481 { "AT45DB011B", 0x1f2200, 512, 264, 9, SUP_POW2PS},
482 { "at45db011d", 0x1f2200, 512, 256, 8, SUP_POW2PS | IS_POW2PS},
484 { "AT45DB021B", 0x1f2300, 1024, 264, 9, SUP_POW2PS},
485 { "at45db021d", 0x1f2300, 1024, 256, 8, SUP_POW2PS | IS_POW2PS},
487 { "AT45DB041x", 0x1f2400, 2048, 264, 9, SUP_POW2PS},
488 { "at45db041d", 0x1f2400, 2048, 256, 8, SUP_POW2PS | IS_POW2PS},
490 { "AT45DB081B", 0x1f2500, 4096, 264, 9, SUP_POW2PS},
491 { "at45db081d", 0x1f2500, 4096, 256, 8, SUP_POW2PS | IS_POW2PS},
493 { "AT45DB161x", 0x1f2600, 4096, 528, 10, SUP_POW2PS},
494 { "at45db161d", 0x1f2600, 4096, 512, 9, SUP_POW2PS | IS_POW2PS},
496 { "AT45DB321x", 0x1f2700, 8192, 528, 10, 0}, /* rev C */
498 { "AT45DB321x", 0x1f2701, 8192, 528, 10, SUP_POW2PS},
499 { "at45db321d", 0x1f2701, 8192, 512, 9, SUP_POW2PS | IS_POW2PS},
501 { "AT45DB642x", 0x1f2800, 8192, 1056, 11, SUP_POW2PS},
502 { "at45db642d", 0x1f2800, 8192, 1024, 10, SUP_POW2PS | IS_POW2PS},
505 static struct flash_info *jedec_probe(struct spi_slave *spi)
510 struct flash_info *info;
514 * JEDEC also defines an optional "extended device information"
515 * string for after vendor-specific data, after the three bytes
516 * we use here. Supporting some chips might require using it.
518 * If the vendor ID isn't Atmel's (0x1f), assume this call failed.
519 * That's not an error; only rev C and newer chips handle it, and
520 * only Atmel sells these chips.
522 tmp = spi_flash_cmd(spi, CMD_READ_ID, id, sizeof(id));
524 printf("dataflash: error %d reading JEDEC ID\n", tmp);
536 for (tmp = 0, info = dataflash_data;
537 tmp < ARRAY_SIZE(dataflash_data);
539 if (info->jedec_id == jedec) {
540 if (info->flags & SUP_POW2PS) {
541 status = dataflash_status(spi);
543 debug("dataflash: status error %d\n",
548 if (info->flags & IS_POW2PS)
551 if (!(info->flags & IS_POW2PS))
561 * Treat other chips as errors ... we won't know the right page
562 * size (it might be binary) even when we can tell which density
563 * class is involved (legacy chip id scheme).
565 printf("dataflash: JEDEC id %06x not handled\n", jedec);
566 return ERR_PTR(-ENODEV);
570 * Detect and initialize DataFlash device, using JEDEC IDs on newer chips
571 * or else the ID code embedded in the status bits:
573 * Device Density ID code #Pages PageSize Offset
574 * AT45DB011B 1Mbit (128K) xx0011xx (0x0c) 512 264 9
575 * AT45DB021B 2Mbit (256K) xx0101xx (0x14) 1024 264 9
576 * AT45DB041B 4Mbit (512K) xx0111xx (0x1c) 2048 264 9
577 * AT45DB081B 8Mbit (1M) xx1001xx (0x24) 4096 264 9
578 * AT45DB0161B 16Mbit (2M) xx1011xx (0x2c) 4096 528 10
579 * AT45DB0321B 32Mbit (4M) xx1101xx (0x34) 8192 528 10
580 * AT45DB0642 64Mbit (8M) xx111xxx (0x3c) 8192 1056 11
581 * AT45DB1282 128Mbit (16M) xx0100xx (0x10) 16384 1056 11
583 static int spi_dataflash_probe(struct udevice *dev)
585 struct spi_slave *spi = dev_get_parent_priv(dev);
586 struct spi_flash *spi_flash;
587 struct flash_info *info;
590 spi_flash = dev_get_uclass_priv(dev);
591 spi_flash->spi = spi;
592 spi_flash->dev = dev;
594 status = spi_claim_bus(spi);
599 * Try to detect dataflash by JEDEC ID.
600 * If it succeeds we know we have either a C or D part.
601 * D will support power of 2 pagesize option.
602 * Both support the security register, though with different
605 info = jedec_probe(spi);
607 goto err_jedec_probe;
609 status = add_dataflash(dev, info->name, info->nr_pages,
610 info->pagesize, info->pageoffset,
611 (info->flags & SUP_POW2PS) ? 'd' : 'c');
617 * Older chips support only legacy commands, identifing
618 * capacity using bits in the status byte.
620 status = dataflash_status(spi);
621 if (status <= 0 || status == 0xff) {
622 printf("dataflash: read status error %d\n", status);
623 if (status == 0 || status == 0xff)
625 goto err_jedec_probe;
629 * if there's a device there, assume it's dataflash.
630 * board setup should have set spi->max_speed_max to
631 * match f(car) for continuous reads, mode 0 or 3.
633 switch (status & 0x3c) {
634 case 0x0c: /* 0 0 1 1 x x */
635 status = add_dataflash(dev, "AT45DB011B", 512, 264, 9, 0);
637 case 0x14: /* 0 1 0 1 x x */
638 status = add_dataflash(dev, "AT45DB021B", 1024, 264, 9, 0);
640 case 0x1c: /* 0 1 1 1 x x */
641 status = add_dataflash(dev, "AT45DB041x", 2048, 264, 9, 0);
643 case 0x24: /* 1 0 0 1 x x */
644 status = add_dataflash(dev, "AT45DB081B", 4096, 264, 9, 0);
646 case 0x2c: /* 1 0 1 1 x x */
647 status = add_dataflash(dev, "AT45DB161x", 4096, 528, 10, 0);
649 case 0x34: /* 1 1 0 1 x x */
650 status = add_dataflash(dev, "AT45DB321x", 8192, 528, 10, 0);
652 case 0x38: /* 1 1 1 x x x */
654 status = add_dataflash(dev, "AT45DB642x", 8192, 1056, 11, 0);
656 /* obsolete AT45DB1282 not (yet?) supported */
658 printf("dataflash: unsupported device (%x)\n", status & 0x3c);
668 spi_release_bus(spi);
672 static const struct dm_spi_flash_ops spi_dataflash_ops = {
673 .read = spi_dataflash_read,
674 .write = spi_dataflash_write,
675 .erase = spi_dataflash_erase,
678 static const struct udevice_id spi_dataflash_ids[] = {
679 { .compatible = "atmel,at45", },
680 { .compatible = "atmel,dataflash", },
684 U_BOOT_DRIVER(spi_dataflash) = {
685 .name = "spi_dataflash",
686 .id = UCLASS_SPI_FLASH,
687 .of_match = spi_dataflash_ids,
688 .probe = spi_dataflash_probe,
689 .priv_auto_alloc_size = sizeof(struct dataflash),
690 .ops = &spi_dataflash_ops,