2 * Based on m25p80.c, by Mike Lavender (mike@steroidmicros.com), with
3 * influence from lart.c (Abraham Van Der Merwe) and mtd_dataflash.c
5 * Copyright (C) 2005, Intec Automation Inc.
6 * Copyright (C) 2014, Freescale Semiconductor, Inc.
8 * This code is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/err.h>
14 #include <linux/errno.h>
15 #include <linux/module.h>
16 #include <linux/device.h>
17 #include <linux/mutex.h>
18 #include <linux/math64.h>
20 #include <linux/mtd/cfi.h>
21 #include <linux/mtd/mtd.h>
22 #include <linux/of_platform.h>
23 #include <linux/spi/flash.h>
24 #include <linux/mtd/spi-nor.h>
26 /* Define max times to check status register before we give up. */
27 #define MAX_READY_WAIT_JIFFIES (40 * HZ) /* M25P16 specs 40s max chip erase */
29 #define SPI_NOR_MAX_ID_LEN 6
33 * This array stores the ID bytes.
34 * The first three bytes are the JEDIC ID.
35 * JEDEC ID zero means "no ID" (mostly older chips).
37 u8 id[SPI_NOR_MAX_ID_LEN];
40 /* The size listed here is what works with SPINOR_OP_SE, which isn't
41 * necessarily called a "sector" by the vendor.
50 #define SECT_4K 0x01 /* SPINOR_OP_BE_4K works uniformly */
51 #define SPI_NOR_NO_ERASE 0x02 /* No erase command needed */
52 #define SST_WRITE 0x04 /* use SST byte programming */
53 #define SPI_NOR_NO_FR 0x08 /* Can't do fastread */
54 #define SECT_4K_PMC 0x10 /* SPINOR_OP_BE_4K_PMC works uniformly */
55 #define SPI_NOR_DUAL_READ 0x20 /* Flash supports Dual Read */
56 #define SPI_NOR_QUAD_READ 0x40 /* Flash supports Quad Read */
57 #define USE_FSR 0x80 /* use flag status register */
60 #define JEDEC_MFR(info) ((info)->id[0])
62 static const struct spi_device_id *spi_nor_match_id(const char *name);
65 * Read the status register, returning its value in the location
66 * Return the status register value.
67 * Returns negative if error occurred.
69 static int read_sr(struct spi_nor *nor)
74 ret = nor->read_reg(nor, SPINOR_OP_RDSR, &val, 1);
76 pr_err("error %d reading SR\n", (int) ret);
84 * Read the flag status register, returning its value in the location
85 * Return the status register value.
86 * Returns negative if error occurred.
88 static int read_fsr(struct spi_nor *nor)
93 ret = nor->read_reg(nor, SPINOR_OP_RDFSR, &val, 1);
95 pr_err("error %d reading FSR\n", ret);
103 * Read configuration register, returning its value in the
104 * location. Return the configuration register value.
105 * Returns negative if error occured.
107 static int read_cr(struct spi_nor *nor)
112 ret = nor->read_reg(nor, SPINOR_OP_RDCR, &val, 1);
114 dev_err(nor->dev, "error %d reading CR\n", ret);
122 * Dummy Cycle calculation for different type of read.
123 * It can be used to support more commands with
124 * different dummy cycle requirements.
126 static inline int spi_nor_read_dummy_cycles(struct spi_nor *nor)
128 switch (nor->flash_read) {
140 * Write status register 1 byte
141 * Returns negative if error occurred.
143 static inline int write_sr(struct spi_nor *nor, u8 val)
145 nor->cmd_buf[0] = val;
146 return nor->write_reg(nor, SPINOR_OP_WRSR, nor->cmd_buf, 1, 0);
150 * Set write enable latch with Write Enable command.
151 * Returns negative if error occurred.
153 static inline int write_enable(struct spi_nor *nor)
155 return nor->write_reg(nor, SPINOR_OP_WREN, NULL, 0, 0);
159 * Send write disble instruction to the chip.
161 static inline int write_disable(struct spi_nor *nor)
163 return nor->write_reg(nor, SPINOR_OP_WRDI, NULL, 0, 0);
166 static inline struct spi_nor *mtd_to_spi_nor(struct mtd_info *mtd)
171 /* Enable/disable 4-byte addressing mode. */
172 static inline int set_4byte(struct spi_nor *nor, struct flash_info *info,
176 bool need_wren = false;
179 switch (JEDEC_MFR(info)) {
180 case CFI_MFR_ST: /* Micron, actually */
181 /* Some Micron need WREN command; all will accept it */
183 case CFI_MFR_MACRONIX:
184 case 0xEF /* winbond */:
188 cmd = enable ? SPINOR_OP_EN4B : SPINOR_OP_EX4B;
189 status = nor->write_reg(nor, cmd, NULL, 0, 0);
196 nor->cmd_buf[0] = enable << 7;
197 return nor->write_reg(nor, SPINOR_OP_BRWR, nor->cmd_buf, 1, 0);
200 static inline int spi_nor_sr_ready(struct spi_nor *nor)
202 int sr = read_sr(nor);
206 return !(sr & SR_WIP);
209 static inline int spi_nor_fsr_ready(struct spi_nor *nor)
211 int fsr = read_fsr(nor);
215 return fsr & FSR_READY;
218 static int spi_nor_ready(struct spi_nor *nor)
221 sr = spi_nor_sr_ready(nor);
224 fsr = nor->flags & SNOR_F_USE_FSR ? spi_nor_fsr_ready(nor) : 1;
231 * Service routine to read status register until ready, or timeout occurs.
232 * Returns non-zero if error.
234 static int spi_nor_wait_till_ready(struct spi_nor *nor)
236 unsigned long deadline;
237 int timeout = 0, ret;
239 deadline = jiffies + MAX_READY_WAIT_JIFFIES;
242 if (time_after_eq(jiffies, deadline))
245 ret = spi_nor_ready(nor);
254 dev_err(nor->dev, "flash operation timed out\n");
260 * Erase the whole flash memory
262 * Returns 0 if successful, non-zero otherwise.
264 static int erase_chip(struct spi_nor *nor)
266 dev_dbg(nor->dev, " %lldKiB\n", (long long)(nor->mtd->size >> 10));
268 /* Send write enable, then erase commands. */
271 return nor->write_reg(nor, SPINOR_OP_CHIP_ERASE, NULL, 0, 0);
274 static int spi_nor_lock_and_prep(struct spi_nor *nor, enum spi_nor_ops ops)
278 mutex_lock(&nor->lock);
281 ret = nor->prepare(nor, ops);
283 dev_err(nor->dev, "failed in the preparation.\n");
284 mutex_unlock(&nor->lock);
291 static void spi_nor_unlock_and_unprep(struct spi_nor *nor, enum spi_nor_ops ops)
294 nor->unprepare(nor, ops);
295 mutex_unlock(&nor->lock);
299 * Erase an address range on the nor chip. The address range may extend
300 * one or more erase sectors. Return an error is there is a problem erasing.
302 static int spi_nor_erase(struct mtd_info *mtd, struct erase_info *instr)
304 struct spi_nor *nor = mtd_to_spi_nor(mtd);
309 dev_dbg(nor->dev, "at 0x%llx, len %lld\n", (long long)instr->addr,
310 (long long)instr->len);
312 div_u64_rem(instr->len, mtd->erasesize, &rem);
319 ret = spi_nor_lock_and_prep(nor, SPI_NOR_OPS_ERASE);
323 /* whole-chip erase? */
324 if (len == mtd->size) {
325 if (erase_chip(nor)) {
330 ret = spi_nor_wait_till_ready(nor);
334 /* REVISIT in some cases we could speed up erasing large regions
335 * by using SPINOR_OP_SE instead of SPINOR_OP_BE_4K. We may have set up
336 * to use "small sector erase", but that's not always optimal.
339 /* "sector"-at-a-time erase */
342 if (nor->erase(nor, addr)) {
347 addr += mtd->erasesize;
348 len -= mtd->erasesize;
350 ret = spi_nor_wait_till_ready(nor);
356 spi_nor_unlock_and_unprep(nor, SPI_NOR_OPS_ERASE);
358 instr->state = MTD_ERASE_DONE;
359 mtd_erase_callback(instr);
364 spi_nor_unlock_and_unprep(nor, SPI_NOR_OPS_ERASE);
365 instr->state = MTD_ERASE_FAILED;
369 static int spi_nor_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
371 struct spi_nor *nor = mtd_to_spi_nor(mtd);
372 uint32_t offset = ofs;
373 uint8_t status_old, status_new;
376 ret = spi_nor_lock_and_prep(nor, SPI_NOR_OPS_LOCK);
380 status_old = read_sr(nor);
382 if (offset < mtd->size - (mtd->size / 2))
383 status_new = status_old | SR_BP2 | SR_BP1 | SR_BP0;
384 else if (offset < mtd->size - (mtd->size / 4))
385 status_new = (status_old & ~SR_BP0) | SR_BP2 | SR_BP1;
386 else if (offset < mtd->size - (mtd->size / 8))
387 status_new = (status_old & ~SR_BP1) | SR_BP2 | SR_BP0;
388 else if (offset < mtd->size - (mtd->size / 16))
389 status_new = (status_old & ~(SR_BP0 | SR_BP1)) | SR_BP2;
390 else if (offset < mtd->size - (mtd->size / 32))
391 status_new = (status_old & ~SR_BP2) | SR_BP1 | SR_BP0;
392 else if (offset < mtd->size - (mtd->size / 64))
393 status_new = (status_old & ~(SR_BP2 | SR_BP0)) | SR_BP1;
395 status_new = (status_old & ~(SR_BP2 | SR_BP1)) | SR_BP0;
397 /* Only modify protection if it will not unlock other areas */
398 if ((status_new & (SR_BP2 | SR_BP1 | SR_BP0)) >
399 (status_old & (SR_BP2 | SR_BP1 | SR_BP0))) {
401 ret = write_sr(nor, status_new);
407 spi_nor_unlock_and_unprep(nor, SPI_NOR_OPS_LOCK);
411 static int spi_nor_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
413 struct spi_nor *nor = mtd_to_spi_nor(mtd);
414 uint32_t offset = ofs;
415 uint8_t status_old, status_new;
418 ret = spi_nor_lock_and_prep(nor, SPI_NOR_OPS_UNLOCK);
422 status_old = read_sr(nor);
424 if (offset+len > mtd->size - (mtd->size / 64))
425 status_new = status_old & ~(SR_BP2 | SR_BP1 | SR_BP0);
426 else if (offset+len > mtd->size - (mtd->size / 32))
427 status_new = (status_old & ~(SR_BP2 | SR_BP1)) | SR_BP0;
428 else if (offset+len > mtd->size - (mtd->size / 16))
429 status_new = (status_old & ~(SR_BP2 | SR_BP0)) | SR_BP1;
430 else if (offset+len > mtd->size - (mtd->size / 8))
431 status_new = (status_old & ~SR_BP2) | SR_BP1 | SR_BP0;
432 else if (offset+len > mtd->size - (mtd->size / 4))
433 status_new = (status_old & ~(SR_BP0 | SR_BP1)) | SR_BP2;
434 else if (offset+len > mtd->size - (mtd->size / 2))
435 status_new = (status_old & ~SR_BP1) | SR_BP2 | SR_BP0;
437 status_new = (status_old & ~SR_BP0) | SR_BP2 | SR_BP1;
439 /* Only modify protection if it will not lock other areas */
440 if ((status_new & (SR_BP2 | SR_BP1 | SR_BP0)) <
441 (status_old & (SR_BP2 | SR_BP1 | SR_BP0))) {
443 ret = write_sr(nor, status_new);
449 spi_nor_unlock_and_unprep(nor, SPI_NOR_OPS_UNLOCK);
453 /* Used when the "_ext_id" is two bytes at most */
454 #define INFO(_jedec_id, _ext_id, _sector_size, _n_sectors, _flags) \
455 ((kernel_ulong_t)&(struct flash_info) { \
457 ((_jedec_id) >> 16) & 0xff, \
458 ((_jedec_id) >> 8) & 0xff, \
459 (_jedec_id) & 0xff, \
460 ((_ext_id) >> 8) & 0xff, \
463 .id_len = (!(_jedec_id) ? 0 : (3 + ((_ext_id) ? 2 : 0))), \
464 .sector_size = (_sector_size), \
465 .n_sectors = (_n_sectors), \
470 #define CAT25_INFO(_sector_size, _n_sectors, _page_size, _addr_width, _flags) \
471 ((kernel_ulong_t)&(struct flash_info) { \
472 .sector_size = (_sector_size), \
473 .n_sectors = (_n_sectors), \
474 .page_size = (_page_size), \
475 .addr_width = (_addr_width), \
479 /* NOTE: double check command sets and memory organization when you add
480 * more nor chips. This current list focusses on newer chips, which
481 * have been converging on command sets which including JEDEC ID.
483 static const struct spi_device_id spi_nor_ids[] = {
484 /* Atmel -- some are (confusingly) marketed as "DataFlash" */
485 { "at25fs010", INFO(0x1f6601, 0, 32 * 1024, 4, SECT_4K) },
486 { "at25fs040", INFO(0x1f6604, 0, 64 * 1024, 8, SECT_4K) },
488 { "at25df041a", INFO(0x1f4401, 0, 64 * 1024, 8, SECT_4K) },
489 { "at25df321a", INFO(0x1f4701, 0, 64 * 1024, 64, SECT_4K) },
490 { "at25df641", INFO(0x1f4800, 0, 64 * 1024, 128, SECT_4K) },
492 { "at26f004", INFO(0x1f0400, 0, 64 * 1024, 8, SECT_4K) },
493 { "at26df081a", INFO(0x1f4501, 0, 64 * 1024, 16, SECT_4K) },
494 { "at26df161a", INFO(0x1f4601, 0, 64 * 1024, 32, SECT_4K) },
495 { "at26df321", INFO(0x1f4700, 0, 64 * 1024, 64, SECT_4K) },
497 { "at45db081d", INFO(0x1f2500, 0, 64 * 1024, 16, SECT_4K) },
500 { "en25f32", INFO(0x1c3116, 0, 64 * 1024, 64, SECT_4K) },
501 { "en25p32", INFO(0x1c2016, 0, 64 * 1024, 64, 0) },
502 { "en25q32b", INFO(0x1c3016, 0, 64 * 1024, 64, 0) },
503 { "en25p64", INFO(0x1c2017, 0, 64 * 1024, 128, 0) },
504 { "en25q64", INFO(0x1c3017, 0, 64 * 1024, 128, SECT_4K) },
505 { "en25qh128", INFO(0x1c7018, 0, 64 * 1024, 256, 0) },
506 { "en25qh256", INFO(0x1c7019, 0, 64 * 1024, 512, 0) },
509 { "f25l32pa", INFO(0x8c2016, 0, 64 * 1024, 64, SECT_4K) },
512 { "mr25h256", CAT25_INFO( 32 * 1024, 1, 256, 2, SPI_NOR_NO_ERASE | SPI_NOR_NO_FR) },
513 { "mr25h10", CAT25_INFO(128 * 1024, 1, 256, 3, SPI_NOR_NO_ERASE | SPI_NOR_NO_FR) },
516 { "mb85rs1mt", INFO(0x047f27, 0, 128 * 1024, 1, SPI_NOR_NO_ERASE) },
519 { "gd25q32", INFO(0xc84016, 0, 64 * 1024, 64, SECT_4K) },
520 { "gd25q64", INFO(0xc84017, 0, 64 * 1024, 128, SECT_4K) },
522 /* Intel/Numonyx -- xxxs33b */
523 { "160s33b", INFO(0x898911, 0, 64 * 1024, 32, 0) },
524 { "320s33b", INFO(0x898912, 0, 64 * 1024, 64, 0) },
525 { "640s33b", INFO(0x898913, 0, 64 * 1024, 128, 0) },
528 { "mx25l2005a", INFO(0xc22012, 0, 64 * 1024, 4, SECT_4K) },
529 { "mx25l4005a", INFO(0xc22013, 0, 64 * 1024, 8, SECT_4K) },
530 { "mx25l8005", INFO(0xc22014, 0, 64 * 1024, 16, 0) },
531 { "mx25l1606e", INFO(0xc22015, 0, 64 * 1024, 32, SECT_4K) },
532 { "mx25l3205d", INFO(0xc22016, 0, 64 * 1024, 64, 0) },
533 { "mx25l3255e", INFO(0xc29e16, 0, 64 * 1024, 64, SECT_4K) },
534 { "mx25l6405d", INFO(0xc22017, 0, 64 * 1024, 128, 0) },
535 { "mx25l12805d", INFO(0xc22018, 0, 64 * 1024, 256, 0) },
536 { "mx25l12855e", INFO(0xc22618, 0, 64 * 1024, 256, 0) },
537 { "mx25l25635e", INFO(0xc22019, 0, 64 * 1024, 512, 0) },
538 { "mx25l25655e", INFO(0xc22619, 0, 64 * 1024, 512, 0) },
539 { "mx66l51235l", INFO(0xc2201a, 0, 64 * 1024, 1024, SPI_NOR_QUAD_READ) },
540 { "mx66l1g55g", INFO(0xc2261b, 0, 64 * 1024, 2048, SPI_NOR_QUAD_READ) },
543 { "n25q032", INFO(0x20ba16, 0, 64 * 1024, 64, 0) },
544 { "n25q064", INFO(0x20ba17, 0, 64 * 1024, 128, 0) },
545 { "n25q128a11", INFO(0x20bb18, 0, 64 * 1024, 256, 0) },
546 { "n25q128a13", INFO(0x20ba18, 0, 64 * 1024, 256, 0) },
547 { "n25q256a", INFO(0x20ba19, 0, 64 * 1024, 512, SECT_4K) },
548 { "n25q512a", INFO(0x20bb20, 0, 64 * 1024, 1024, SECT_4K) },
549 { "n25q512ax3", INFO(0x20ba20, 0, 64 * 1024, 1024, USE_FSR) },
550 { "n25q00", INFO(0x20ba21, 0, 64 * 1024, 2048, USE_FSR) },
553 { "pm25lv512", INFO(0, 0, 32 * 1024, 2, SECT_4K_PMC) },
554 { "pm25lv010", INFO(0, 0, 32 * 1024, 4, SECT_4K_PMC) },
555 { "pm25lq032", INFO(0x7f9d46, 0, 64 * 1024, 64, SECT_4K) },
557 /* Spansion -- single (large) sector size only, at least
558 * for the chips listed here (without boot sectors).
560 { "s25sl032p", INFO(0x010215, 0x4d00, 64 * 1024, 64, SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ) },
561 { "s25sl064p", INFO(0x010216, 0x4d00, 64 * 1024, 128, 0) },
562 { "s25fl256s0", INFO(0x010219, 0x4d00, 256 * 1024, 128, 0) },
563 { "s25fl256s1", INFO(0x010219, 0x4d01, 64 * 1024, 512, SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ) },
564 { "s25fl512s", INFO(0x010220, 0x4d00, 256 * 1024, 256, SPI_NOR_DUAL_READ | SPI_NOR_QUAD_READ) },
565 { "s70fl01gs", INFO(0x010221, 0x4d00, 256 * 1024, 256, 0) },
566 { "s25sl12800", INFO(0x012018, 0x0300, 256 * 1024, 64, 0) },
567 { "s25sl12801", INFO(0x012018, 0x0301, 64 * 1024, 256, 0) },
568 { "s25fl129p0", INFO(0x012018, 0x4d00, 256 * 1024, 64, 0) },
569 { "s25fl129p1", INFO(0x012018, 0x4d01, 64 * 1024, 256, 0) },
570 { "s25sl004a", INFO(0x010212, 0, 64 * 1024, 8, 0) },
571 { "s25sl008a", INFO(0x010213, 0, 64 * 1024, 16, 0) },
572 { "s25sl016a", INFO(0x010214, 0, 64 * 1024, 32, 0) },
573 { "s25sl032a", INFO(0x010215, 0, 64 * 1024, 64, 0) },
574 { "s25sl064a", INFO(0x010216, 0, 64 * 1024, 128, 0) },
575 { "s25fl008k", INFO(0xef4014, 0, 64 * 1024, 16, SECT_4K) },
576 { "s25fl016k", INFO(0xef4015, 0, 64 * 1024, 32, SECT_4K) },
577 { "s25fl064k", INFO(0xef4017, 0, 64 * 1024, 128, SECT_4K) },
578 { "s25fl132k", INFO(0x014016, 0, 64 * 1024, 64, 0) },
580 /* SST -- large erase sizes are "overlays", "sectors" are 4K */
581 { "sst25vf040b", INFO(0xbf258d, 0, 64 * 1024, 8, SECT_4K | SST_WRITE) },
582 { "sst25vf080b", INFO(0xbf258e, 0, 64 * 1024, 16, SECT_4K | SST_WRITE) },
583 { "sst25vf016b", INFO(0xbf2541, 0, 64 * 1024, 32, SECT_4K | SST_WRITE) },
584 { "sst25vf032b", INFO(0xbf254a, 0, 64 * 1024, 64, SECT_4K | SST_WRITE) },
585 { "sst25vf064c", INFO(0xbf254b, 0, 64 * 1024, 128, SECT_4K) },
586 { "sst25wf512", INFO(0xbf2501, 0, 64 * 1024, 1, SECT_4K | SST_WRITE) },
587 { "sst25wf010", INFO(0xbf2502, 0, 64 * 1024, 2, SECT_4K | SST_WRITE) },
588 { "sst25wf020", INFO(0xbf2503, 0, 64 * 1024, 4, SECT_4K | SST_WRITE) },
589 { "sst25wf040", INFO(0xbf2504, 0, 64 * 1024, 8, SECT_4K | SST_WRITE) },
590 { "sst25wf080", INFO(0xbf2505, 0, 64 * 1024, 16, SECT_4K | SST_WRITE) },
592 /* ST Microelectronics -- newer production may have feature updates */
593 { "m25p05", INFO(0x202010, 0, 32 * 1024, 2, 0) },
594 { "m25p10", INFO(0x202011, 0, 32 * 1024, 4, 0) },
595 { "m25p20", INFO(0x202012, 0, 64 * 1024, 4, 0) },
596 { "m25p40", INFO(0x202013, 0, 64 * 1024, 8, 0) },
597 { "m25p80", INFO(0x202014, 0, 64 * 1024, 16, 0) },
598 { "m25p16", INFO(0x202015, 0, 64 * 1024, 32, 0) },
599 { "m25p32", INFO(0x202016, 0, 64 * 1024, 64, 0) },
600 { "m25p64", INFO(0x202017, 0, 64 * 1024, 128, 0) },
601 { "m25p128", INFO(0x202018, 0, 256 * 1024, 64, 0) },
603 { "m25p05-nonjedec", INFO(0, 0, 32 * 1024, 2, 0) },
604 { "m25p10-nonjedec", INFO(0, 0, 32 * 1024, 4, 0) },
605 { "m25p20-nonjedec", INFO(0, 0, 64 * 1024, 4, 0) },
606 { "m25p40-nonjedec", INFO(0, 0, 64 * 1024, 8, 0) },
607 { "m25p80-nonjedec", INFO(0, 0, 64 * 1024, 16, 0) },
608 { "m25p16-nonjedec", INFO(0, 0, 64 * 1024, 32, 0) },
609 { "m25p32-nonjedec", INFO(0, 0, 64 * 1024, 64, 0) },
610 { "m25p64-nonjedec", INFO(0, 0, 64 * 1024, 128, 0) },
611 { "m25p128-nonjedec", INFO(0, 0, 256 * 1024, 64, 0) },
613 { "m45pe10", INFO(0x204011, 0, 64 * 1024, 2, 0) },
614 { "m45pe80", INFO(0x204014, 0, 64 * 1024, 16, 0) },
615 { "m45pe16", INFO(0x204015, 0, 64 * 1024, 32, 0) },
617 { "m25pe20", INFO(0x208012, 0, 64 * 1024, 4, 0) },
618 { "m25pe80", INFO(0x208014, 0, 64 * 1024, 16, 0) },
619 { "m25pe16", INFO(0x208015, 0, 64 * 1024, 32, SECT_4K) },
621 { "m25px16", INFO(0x207115, 0, 64 * 1024, 32, SECT_4K) },
622 { "m25px32", INFO(0x207116, 0, 64 * 1024, 64, SECT_4K) },
623 { "m25px32-s0", INFO(0x207316, 0, 64 * 1024, 64, SECT_4K) },
624 { "m25px32-s1", INFO(0x206316, 0, 64 * 1024, 64, SECT_4K) },
625 { "m25px64", INFO(0x207117, 0, 64 * 1024, 128, 0) },
626 { "m25px80", INFO(0x207114, 0, 64 * 1024, 16, 0) },
628 /* Winbond -- w25x "blocks" are 64K, "sectors" are 4KiB */
629 { "w25x10", INFO(0xef3011, 0, 64 * 1024, 2, SECT_4K) },
630 { "w25x20", INFO(0xef3012, 0, 64 * 1024, 4, SECT_4K) },
631 { "w25x40", INFO(0xef3013, 0, 64 * 1024, 8, SECT_4K) },
632 { "w25x80", INFO(0xef3014, 0, 64 * 1024, 16, SECT_4K) },
633 { "w25x16", INFO(0xef3015, 0, 64 * 1024, 32, SECT_4K) },
634 { "w25x32", INFO(0xef3016, 0, 64 * 1024, 64, SECT_4K) },
635 { "w25q32", INFO(0xef4016, 0, 64 * 1024, 64, SECT_4K) },
636 { "w25q32dw", INFO(0xef6016, 0, 64 * 1024, 64, SECT_4K) },
637 { "w25x64", INFO(0xef3017, 0, 64 * 1024, 128, SECT_4K) },
638 { "w25q64", INFO(0xef4017, 0, 64 * 1024, 128, SECT_4K) },
639 { "w25q80", INFO(0xef5014, 0, 64 * 1024, 16, SECT_4K) },
640 { "w25q80bl", INFO(0xef4014, 0, 64 * 1024, 16, SECT_4K) },
641 { "w25q128", INFO(0xef4018, 0, 64 * 1024, 256, SECT_4K) },
642 { "w25q256", INFO(0xef4019, 0, 64 * 1024, 512, SECT_4K) },
644 /* Catalyst / On Semiconductor -- non-JEDEC */
645 { "cat25c11", CAT25_INFO( 16, 8, 16, 1, SPI_NOR_NO_ERASE | SPI_NOR_NO_FR) },
646 { "cat25c03", CAT25_INFO( 32, 8, 16, 2, SPI_NOR_NO_ERASE | SPI_NOR_NO_FR) },
647 { "cat25c09", CAT25_INFO( 128, 8, 32, 2, SPI_NOR_NO_ERASE | SPI_NOR_NO_FR) },
648 { "cat25c17", CAT25_INFO( 256, 8, 32, 2, SPI_NOR_NO_ERASE | SPI_NOR_NO_FR) },
649 { "cat25128", CAT25_INFO(2048, 8, 64, 2, SPI_NOR_NO_ERASE | SPI_NOR_NO_FR) },
653 static const struct spi_device_id *spi_nor_read_id(struct spi_nor *nor)
656 u8 id[SPI_NOR_MAX_ID_LEN];
657 struct flash_info *info;
659 tmp = nor->read_reg(nor, SPINOR_OP_RDID, id, SPI_NOR_MAX_ID_LEN);
661 dev_dbg(nor->dev, " error %d reading JEDEC ID\n", tmp);
665 for (tmp = 0; tmp < ARRAY_SIZE(spi_nor_ids) - 1; tmp++) {
666 info = (void *)spi_nor_ids[tmp].driver_data;
668 if (!memcmp(info->id, id, info->id_len))
669 return &spi_nor_ids[tmp];
672 dev_err(nor->dev, "unrecognized JEDEC id bytes: %02x, %2x, %2x\n",
673 id[0], id[1], id[2]);
674 return ERR_PTR(-ENODEV);
677 static int spi_nor_read(struct mtd_info *mtd, loff_t from, size_t len,
678 size_t *retlen, u_char *buf)
680 struct spi_nor *nor = mtd_to_spi_nor(mtd);
683 dev_dbg(nor->dev, "from 0x%08x, len %zd\n", (u32)from, len);
685 ret = spi_nor_lock_and_prep(nor, SPI_NOR_OPS_READ);
689 ret = nor->read(nor, from, len, retlen, buf);
691 spi_nor_unlock_and_unprep(nor, SPI_NOR_OPS_READ);
695 static int sst_write(struct mtd_info *mtd, loff_t to, size_t len,
696 size_t *retlen, const u_char *buf)
698 struct spi_nor *nor = mtd_to_spi_nor(mtd);
702 dev_dbg(nor->dev, "to 0x%08x, len %zd\n", (u32)to, len);
704 ret = spi_nor_lock_and_prep(nor, SPI_NOR_OPS_WRITE);
710 nor->sst_write_second = false;
713 /* Start write from odd address. */
715 nor->program_opcode = SPINOR_OP_BP;
717 /* write one byte. */
718 nor->write(nor, to, 1, retlen, buf);
719 ret = spi_nor_wait_till_ready(nor);
725 /* Write out most of the data here. */
726 for (; actual < len - 1; actual += 2) {
727 nor->program_opcode = SPINOR_OP_AAI_WP;
729 /* write two bytes. */
730 nor->write(nor, to, 2, retlen, buf + actual);
731 ret = spi_nor_wait_till_ready(nor);
735 nor->sst_write_second = true;
737 nor->sst_write_second = false;
740 ret = spi_nor_wait_till_ready(nor);
744 /* Write out trailing byte if it exists. */
748 nor->program_opcode = SPINOR_OP_BP;
749 nor->write(nor, to, 1, retlen, buf + actual);
751 ret = spi_nor_wait_till_ready(nor);
757 spi_nor_unlock_and_unprep(nor, SPI_NOR_OPS_WRITE);
762 * Write an address range to the nor chip. Data must be written in
763 * FLASH_PAGESIZE chunks. The address range may be any size provided
764 * it is within the physical boundaries.
766 static int spi_nor_write(struct mtd_info *mtd, loff_t to, size_t len,
767 size_t *retlen, const u_char *buf)
769 struct spi_nor *nor = mtd_to_spi_nor(mtd);
770 u32 page_offset, page_size, i;
773 dev_dbg(nor->dev, "to 0x%08x, len %zd\n", (u32)to, len);
775 ret = spi_nor_lock_and_prep(nor, SPI_NOR_OPS_WRITE);
781 page_offset = to & (nor->page_size - 1);
783 /* do all the bytes fit onto one page? */
784 if (page_offset + len <= nor->page_size) {
785 nor->write(nor, to, len, retlen, buf);
787 /* the size of data remaining on the first page */
788 page_size = nor->page_size - page_offset;
789 nor->write(nor, to, page_size, retlen, buf);
791 /* write everything in nor->page_size chunks */
792 for (i = page_size; i < len; i += page_size) {
794 if (page_size > nor->page_size)
795 page_size = nor->page_size;
797 ret = spi_nor_wait_till_ready(nor);
803 nor->write(nor, to + i, page_size, retlen, buf + i);
807 ret = spi_nor_wait_till_ready(nor);
809 spi_nor_unlock_and_unprep(nor, SPI_NOR_OPS_WRITE);
813 static int macronix_quad_enable(struct spi_nor *nor)
820 nor->cmd_buf[0] = val | SR_QUAD_EN_MX;
821 nor->write_reg(nor, SPINOR_OP_WRSR, nor->cmd_buf, 1, 0);
823 if (spi_nor_wait_till_ready(nor))
827 if (!(ret > 0 && (ret & SR_QUAD_EN_MX))) {
828 dev_err(nor->dev, "Macronix Quad bit not set\n");
836 * Write status Register and configuration register with 2 bytes
837 * The first byte will be written to the status register, while the
838 * second byte will be written to the configuration register.
839 * Return negative if error occured.
841 static int write_sr_cr(struct spi_nor *nor, u16 val)
843 nor->cmd_buf[0] = val & 0xff;
844 nor->cmd_buf[1] = (val >> 8);
846 return nor->write_reg(nor, SPINOR_OP_WRSR, nor->cmd_buf, 2, 0);
849 static int spansion_quad_enable(struct spi_nor *nor)
852 int quad_en = CR_QUAD_EN_SPAN << 8;
856 ret = write_sr_cr(nor, quad_en);
859 "error while writing configuration register\n");
863 /* read back and check it */
865 if (!(ret > 0 && (ret & CR_QUAD_EN_SPAN))) {
866 dev_err(nor->dev, "Spansion Quad bit not set\n");
873 static int set_quad_mode(struct spi_nor *nor, struct flash_info *info)
877 switch (JEDEC_MFR(info)) {
878 case CFI_MFR_MACRONIX:
879 status = macronix_quad_enable(nor);
881 dev_err(nor->dev, "Macronix quad-read not enabled\n");
886 status = spansion_quad_enable(nor);
888 dev_err(nor->dev, "Spansion quad-read not enabled\n");
895 static int spi_nor_check(struct spi_nor *nor)
897 if (!nor->dev || !nor->read || !nor->write ||
898 !nor->read_reg || !nor->write_reg || !nor->erase) {
899 pr_err("spi-nor: please fill all the necessary fields!\n");
906 int spi_nor_scan(struct spi_nor *nor, const char *name, enum read_mode mode)
908 const struct spi_device_id *id = NULL;
909 struct flash_info *info;
910 struct device *dev = nor->dev;
911 struct mtd_info *mtd = nor->mtd;
912 struct device_node *np = dev->of_node;
916 ret = spi_nor_check(nor);
920 id = spi_nor_match_id(name);
924 info = (void *)id->driver_data;
927 const struct spi_device_id *jid;
929 jid = spi_nor_read_id(nor);
932 } else if (jid != id) {
934 * JEDEC knows better, so overwrite platform ID. We
935 * can't trust partitions any longer, but we'll let
936 * mtd apply them anyway, since some partitions may be
937 * marked read-only, and we don't want to lose that
938 * information, even if it's not 100% accurate.
940 dev_warn(dev, "found %s, expected %s\n",
941 jid->name, id->name);
943 info = (void *)jid->driver_data;
947 mutex_init(&nor->lock);
950 * Atmel, SST and Intel/Numonyx serial nor tend to power
951 * up with the software protection bits set
954 if (JEDEC_MFR(info) == CFI_MFR_ATMEL ||
955 JEDEC_MFR(info) == CFI_MFR_INTEL ||
956 JEDEC_MFR(info) == CFI_MFR_SST) {
962 mtd->name = dev_name(dev);
963 mtd->type = MTD_NORFLASH;
965 mtd->flags = MTD_CAP_NORFLASH;
966 mtd->size = info->sector_size * info->n_sectors;
967 mtd->_erase = spi_nor_erase;
968 mtd->_read = spi_nor_read;
970 /* nor protection support for STmicro chips */
971 if (JEDEC_MFR(info) == CFI_MFR_ST) {
972 mtd->_lock = spi_nor_lock;
973 mtd->_unlock = spi_nor_unlock;
976 /* sst nor chips use AAI word program */
977 if (info->flags & SST_WRITE)
978 mtd->_write = sst_write;
980 mtd->_write = spi_nor_write;
982 if (info->flags & USE_FSR)
983 nor->flags |= SNOR_F_USE_FSR;
985 #ifdef CONFIG_MTD_SPI_NOR_USE_4K_SECTORS
986 /* prefer "small sector" erase if possible */
987 if (info->flags & SECT_4K) {
988 nor->erase_opcode = SPINOR_OP_BE_4K;
989 mtd->erasesize = 4096;
990 } else if (info->flags & SECT_4K_PMC) {
991 nor->erase_opcode = SPINOR_OP_BE_4K_PMC;
992 mtd->erasesize = 4096;
996 nor->erase_opcode = SPINOR_OP_SE;
997 mtd->erasesize = info->sector_size;
1000 if (info->flags & SPI_NOR_NO_ERASE)
1001 mtd->flags |= MTD_NO_ERASE;
1003 mtd->dev.parent = dev;
1004 nor->page_size = info->page_size;
1005 mtd->writebufsize = nor->page_size;
1008 /* If we were instantiated by DT, use it */
1009 if (of_property_read_bool(np, "m25p,fast-read"))
1010 nor->flash_read = SPI_NOR_FAST;
1012 nor->flash_read = SPI_NOR_NORMAL;
1014 /* If we weren't instantiated by DT, default to fast-read */
1015 nor->flash_read = SPI_NOR_FAST;
1018 /* Some devices cannot do fast-read, no matter what DT tells us */
1019 if (info->flags & SPI_NOR_NO_FR)
1020 nor->flash_read = SPI_NOR_NORMAL;
1022 /* Quad/Dual-read mode takes precedence over fast/normal */
1023 if (mode == SPI_NOR_QUAD && info->flags & SPI_NOR_QUAD_READ) {
1024 ret = set_quad_mode(nor, info);
1026 dev_err(dev, "quad mode not supported\n");
1029 nor->flash_read = SPI_NOR_QUAD;
1030 } else if (mode == SPI_NOR_DUAL && info->flags & SPI_NOR_DUAL_READ) {
1031 nor->flash_read = SPI_NOR_DUAL;
1034 /* Default commands */
1035 switch (nor->flash_read) {
1037 nor->read_opcode = SPINOR_OP_READ_1_1_4;
1040 nor->read_opcode = SPINOR_OP_READ_1_1_2;
1043 nor->read_opcode = SPINOR_OP_READ_FAST;
1045 case SPI_NOR_NORMAL:
1046 nor->read_opcode = SPINOR_OP_READ;
1049 dev_err(dev, "No Read opcode defined\n");
1053 nor->program_opcode = SPINOR_OP_PP;
1055 if (info->addr_width)
1056 nor->addr_width = info->addr_width;
1057 else if (mtd->size > 0x1000000) {
1058 /* enable 4-byte addressing if the device exceeds 16MiB */
1059 nor->addr_width = 4;
1060 if (JEDEC_MFR(info) == CFI_MFR_AMD) {
1061 /* Dedicated 4-byte command set */
1062 switch (nor->flash_read) {
1064 nor->read_opcode = SPINOR_OP_READ4_1_1_4;
1067 nor->read_opcode = SPINOR_OP_READ4_1_1_2;
1070 nor->read_opcode = SPINOR_OP_READ4_FAST;
1072 case SPI_NOR_NORMAL:
1073 nor->read_opcode = SPINOR_OP_READ4;
1076 nor->program_opcode = SPINOR_OP_PP_4B;
1077 /* No small sector erase for 4-byte command set */
1078 nor->erase_opcode = SPINOR_OP_SE_4B;
1079 mtd->erasesize = info->sector_size;
1081 set_4byte(nor, info, 1);
1083 nor->addr_width = 3;
1086 nor->read_dummy = spi_nor_read_dummy_cycles(nor);
1088 dev_info(dev, "%s (%lld Kbytes)\n", id->name,
1089 (long long)mtd->size >> 10);
1092 "mtd .name = %s, .size = 0x%llx (%lldMiB), "
1093 ".erasesize = 0x%.8x (%uKiB) .numeraseregions = %d\n",
1094 mtd->name, (long long)mtd->size, (long long)(mtd->size >> 20),
1095 mtd->erasesize, mtd->erasesize / 1024, mtd->numeraseregions);
1097 if (mtd->numeraseregions)
1098 for (i = 0; i < mtd->numeraseregions; i++)
1100 "mtd.eraseregions[%d] = { .offset = 0x%llx, "
1101 ".erasesize = 0x%.8x (%uKiB), "
1102 ".numblocks = %d }\n",
1103 i, (long long)mtd->eraseregions[i].offset,
1104 mtd->eraseregions[i].erasesize,
1105 mtd->eraseregions[i].erasesize / 1024,
1106 mtd->eraseregions[i].numblocks);
1109 EXPORT_SYMBOL_GPL(spi_nor_scan);
1111 static const struct spi_device_id *spi_nor_match_id(const char *name)
1113 const struct spi_device_id *id = spi_nor_ids;
1115 while (id->name[0]) {
1116 if (!strcmp(name, id->name))
1123 MODULE_LICENSE("GPL");
1124 MODULE_AUTHOR("Huang Shijie <shijie8@gmail.com>");
1125 MODULE_AUTHOR("Mike Lavender");
1126 MODULE_DESCRIPTION("framework for SPI NOR");