drivers/mtd/devices/m25p80.c

   1 /*
   2  * MTD SPI driver for ST M25Pxx (and similar) serial flash chips
   3  *
   4  * Author: Mike Lavender, mike@steroidmicros.com
   5  *
   6  * Copyright (c) 2005, Intec Automation Inc.
   7  *
   8  * Some parts are based on lart.c by Abraham Van Der Merwe
   9  *
  10  * Cleaned up and generalized based on mtd_dataflash.c
  11  *
  12  * This code is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License version 2 as
  14  * published by the Free Software Foundation.
  15  *
  16  */
  17
  18 #include <linux/init.h>
  19 #include <linux/err.h>
  20 #include <linux/errno.h>
  21 #include <linux/module.h>
  22 #include <linux/device.h>
  23 #include <linux/interrupt.h>
  24 #include <linux/mutex.h>
  25 #include <linux/math64.h>
  26 #include <linux/slab.h>
  27 #include <linux/sched.h>
  28 #include <linux/mod_devicetable.h>
  29
  30 #include <linux/mtd/cfi.h>
  31 #include <linux/mtd/mtd.h>
  32 #include <linux/mtd/partitions.h>
  33 #include <linux/of_platform.h>
  34
  35 #include <linux/spi/spi.h>
  36 #include <linux/spi/flash.h>
  37
  38 /* Flash opcodes. */
  39 #define OPCODE_WREN             0x06    /* Write enable */
  40 #define OPCODE_RDSR             0x05    /* Read status register */
  41 #define OPCODE_WRSR             0x01    /* Write status register 1 byte */
  42 #define OPCODE_NORM_READ        0x03    /* Read data bytes (low frequency) */
  43 #define OPCODE_FAST_READ        0x0b    /* Read data bytes (high frequency) */
  44 #define OPCODE_PP               0x02    /* Page program (up to 256 bytes) */
  45 #define OPCODE_BE_4K            0x20    /* Erase 4KiB block */
  46 #define OPCODE_BE_32K           0x52    /* Erase 32KiB block */
  47 #define OPCODE_CHIP_ERASE       0xc7    /* Erase whole flash chip */
  48 #define OPCODE_SE               0xd8    /* Sector erase (usually 64KiB) */
  49 #define OPCODE_RDID             0x9f    /* Read JEDEC ID */
  50
  51 /* Used for SST flashes only. */
  52 #define OPCODE_BP               0x02    /* Byte program */
  53 #define OPCODE_WRDI             0x04    /* Write disable */
  54 #define OPCODE_AAI_WP           0xad    /* Auto address increment word program */
  55
  56 /* Used for Macronix flashes only. */
  57 #define OPCODE_EN4B             0xb7    /* Enter 4-byte mode */
  58 #define OPCODE_EX4B             0xe9    /* Exit 4-byte mode */
  59
  60 /* Used for Spansion flashes only. */
  61 #define OPCODE_BRWR             0x17    /* Bank register write */
  62
  63 /* Status Register bits. */
  64 #define SR_WIP                  1       /* Write in progress */
  65 #define SR_WEL                  2       /* Write enable latch */
  66 /* meaning of other SR_* bits may differ between vendors */
  67 #define SR_BP0                  4       /* Block protect 0 */
  68 #define SR_BP1                  8       /* Block protect 1 */
  69 #define SR_BP2                  0x10    /* Block protect 2 */
  70 #define SR_SRWD                 0x80    /* SR write protect */
  71
  72 /* Define max times to check status register before we give up. */
  73 #define MAX_READY_WAIT_JIFFIES  (40 * HZ)       /* M25P16 specs 40s max chip erase */
  74 #define MAX_CMD_SIZE            5
  75
  76 #ifdef CONFIG_M25PXX_USE_FAST_READ
  77 #define OPCODE_READ     OPCODE_FAST_READ
  78 #define FAST_READ_DUMMY_BYTE 1
  79 #else
  80 #define OPCODE_READ     OPCODE_NORM_READ
  81 #define FAST_READ_DUMMY_BYTE 0
  82 #endif
  83
  84 #define JEDEC_MFR(_jedec_id)    ((_jedec_id) >> 16)
  85
  86 /****************************************************************************/
  87
  88 struct m25p {
  89         struct spi_device       *spi;
  90         struct mutex            lock;
  91         struct mtd_info         mtd;
  92         u16                     page_size;
  93         u16                     addr_width;
  94         u8                      erase_opcode;
  95         u8                      *command;
  96 };
  97
  98 static inline struct m25p *mtd_to_m25p(struct mtd_info *mtd)
  99 {
 100         return container_of(mtd, struct m25p, mtd);
 101 }
 102
 103 /****************************************************************************/
 104
 105 /*
 106  * Internal helper functions
 107  */
 108
 109 /*
 110  * Read the status register, returning its value in the location
 111  * Return the status register value.
 112  * Returns negative if error occurred.
 113  */
 114 static int read_sr(struct m25p *flash)
 115 {
 116         ssize_t retval;
 117         u8 code = OPCODE_RDSR;
 118         u8 val;
 119
 120         retval = spi_write_then_read(flash->spi, &code, 1, &val, 1);
 121
 122         if (retval < 0) {
 123                 dev_err(&flash->spi->dev, "error %d reading SR\n",
 124                                 (int) retval);
 125                 return retval;
 126         }
 127
 128         return val;
 129 }
 130
 131 /*
 132  * Write status register 1 byte
 133  * Returns negative if error occurred.
 134  */
 135 static int write_sr(struct m25p *flash, u8 val)
 136 {
 137         flash->command[0] = OPCODE_WRSR;
 138         flash->command[1] = val;
 139
 140         return spi_write(flash->spi, flash->command, 2);
 141 }
 142
 143 /*
 144  * Set write enable latch with Write Enable command.
 145  * Returns negative if error occurred.
 146  */
 147 static inline int write_enable(struct m25p *flash)
 148 {
 149         u8      code = OPCODE_WREN;
 150
 151         return spi_write_then_read(flash->spi, &code, 1, NULL, 0);
 152 }
 153
 154 /*
 155  * Send write disble instruction to the chip.
 156  */
 157 static inline int write_disable(struct m25p *flash)
 158 {
 159         u8      code = OPCODE_WRDI;
 160
 161         return spi_write_then_read(flash->spi, &code, 1, NULL, 0);
 162 }
 163
 164 /*
 165  * Enable/disable 4-byte addressing mode.
 166  */
 167 static inline int set_4byte(struct m25p *flash, u32 jedec_id, int enable)
 168 {
 169         switch (JEDEC_MFR(jedec_id)) {
 170         case CFI_MFR_MACRONIX:
 171                 flash->command[0] = enable ? OPCODE_EN4B : OPCODE_EX4B;
 172                 return spi_write(flash->spi, flash->command, 1);
 173         default:
 174                 /* Spansion style */
 175                 flash->command[0] = OPCODE_BRWR;
 176                 flash->command[1] = enable << 7;
 177                 return spi_write(flash->spi, flash->command, 2);
 178         }
 179 }
 180
 181 /*
 182  * Service routine to read status register until ready, or timeout occurs.
 183  * Returns non-zero if error.
 184  */
 185 static int wait_till_ready(struct m25p *flash)
 186 {
 187         unsigned long deadline;
 188         int sr;
 189
 190         deadline = jiffies + MAX_READY_WAIT_JIFFIES;
 191
 192         do {
 193                 if ((sr = read_sr(flash)) < 0)
 194                         break;
 195                 else if (!(sr & SR_WIP))
 196                         return 0;
 197
 198                 cond_resched();
 199
 200         } while (!time_after_eq(jiffies, deadline));
 201
 202         return 1;
 203 }
 204
 205 /*
 206  * Erase the whole flash memory
 207  *
 208  * Returns 0 if successful, non-zero otherwise.
 209  */
 210 static int erase_chip(struct m25p *flash)
 211 {
 212         pr_debug("%s: %s %lldKiB\n", dev_name(&flash->spi->dev), __func__,
 213                         (long long)(flash->mtd.size >> 10));
 214
 215         /* Wait until finished previous write command. */
 216         if (wait_till_ready(flash))
 217                 return 1;
 218
 219         /* Send write enable, then erase commands. */
 220         write_enable(flash);
 221
 222         /* Set up command buffer. */
 223         flash->command[0] = OPCODE_CHIP_ERASE;
 224
 225         spi_write(flash->spi, flash->command, 1);
 226
 227         return 0;
 228 }
 229
 230 static void m25p_addr2cmd(struct m25p *flash, unsigned int addr, u8 *cmd)
 231 {
 232         /* opcode is in cmd[0] */
 233         cmd[1] = addr >> (flash->addr_width * 8 -  8);
 234         cmd[2] = addr >> (flash->addr_width * 8 - 16);
 235         cmd[3] = addr >> (flash->addr_width * 8 - 24);
 236         cmd[4] = addr >> (flash->addr_width * 8 - 32);
 237 }
 238
 239 static int m25p_cmdsz(struct m25p *flash)
 240 {
 241         return 1 + flash->addr_width;
 242 }
 243
 244 /*
 245  * Erase one sector of flash memory at offset ``offset'' which is any
 246  * address within the sector which should be erased.
 247  *
 248  * Returns 0 if successful, non-zero otherwise.
 249  */
 250 static int erase_sector(struct m25p *flash, u32 offset)
 251 {
 252         pr_debug("%s: %s %dKiB at 0x%08x\n", dev_name(&flash->spi->dev),
 253                         __func__, flash->mtd.erasesize / 1024, offset);
 254
 255         /* Wait until finished previous write command. */
 256         if (wait_till_ready(flash))
 257                 return 1;
 258
 259         /* Send write enable, then erase commands. */
 260         write_enable(flash);
 261
 262         /* Set up command buffer. */
 263         flash->command[0] = flash->erase_opcode;
 264         m25p_addr2cmd(flash, offset, flash->command);
 265
 266         spi_write(flash->spi, flash->command, m25p_cmdsz(flash));
 267
 268         return 0;
 269 }
 270
 271 /****************************************************************************/
 272
 273 /*
 274  * MTD implementation
 275  */
 276
 277 /*
 278  * Erase an address range on the flash chip.  The address range may extend
 279  * one or more erase sectors.  Return an error is there is a problem erasing.
 280  */
 281 static int m25p80_erase(struct mtd_info *mtd, struct erase_info *instr)
 282 {
 283         struct m25p *flash = mtd_to_m25p(mtd);
 284         u32 addr,len;
 285         uint32_t rem;
 286
 287         pr_debug("%s: %s at 0x%llx, len %lld\n", dev_name(&flash->spi->dev),
 288                         __func__, (long long)instr->addr,
 289                         (long long)instr->len);
 290
 291         div_u64_rem(instr->len, mtd->erasesize, &rem);
 292         if (rem)
 293                 return -EINVAL;
 294
 295         addr = instr->addr;
 296         len = instr->len;
 297
 298         mutex_lock(&flash->lock);
 299
 300         /* whole-chip erase? */
 301         if (len == flash->mtd.size) {
 302                 if (erase_chip(flash)) {
 303                         instr->state = MTD_ERASE_FAILED;
 304                         mutex_unlock(&flash->lock);
 305                         return -EIO;
 306                 }
 307
 308         /* REVISIT in some cases we could speed up erasing large regions
 309          * by using OPCODE_SE instead of OPCODE_BE_4K.  We may have set up
 310          * to use "small sector erase", but that's not always optimal.
 311          */
 312
 313         /* "sector"-at-a-time erase */
 314         } else {
 315                 while (len) {
 316                         if (erase_sector(flash, addr)) {
 317                                 instr->state = MTD_ERASE_FAILED;
 318                                 mutex_unlock(&flash->lock);
 319                                 return -EIO;
 320                         }
 321
 322                         addr += mtd->erasesize;
 323                         len -= mtd->erasesize;
 324                 }
 325         }
 326
 327         mutex_unlock(&flash->lock);
 328
 329         instr->state = MTD_ERASE_DONE;
 330         mtd_erase_callback(instr);
 331
 332         return 0;
 333 }
 334
 335 /*
 336  * Read an address range from the flash chip.  The address range
 337  * may be any size provided it is within the physical boundaries.
 338  */
 339 static int m25p80_read(struct mtd_info *mtd, loff_t from, size_t len,
 340         size_t *retlen, u_char *buf)
 341 {
 342         struct m25p *flash = mtd_to_m25p(mtd);
 343         struct spi_transfer t[2];
 344         struct spi_message m;
 345
 346         pr_debug("%s: %s from 0x%08x, len %zd\n", dev_name(&flash->spi->dev),
 347                         __func__, (u32)from, len);
 348
 349         /* sanity checks */
 350         if (!len)
 351                 return 0;
 352
 353         spi_message_init(&m);
 354         memset(t, 0, (sizeof t));
 355
 356         /* NOTE:
 357          * OPCODE_FAST_READ (if available) is faster.
 358          * Should add 1 byte DUMMY_BYTE.
 359          */
 360         t[0].tx_buf = flash->command;
 361         t[0].len = m25p_cmdsz(flash) + FAST_READ_DUMMY_BYTE;
 362         spi_message_add_tail(&t[0], &m);
 363
 364         t[1].rx_buf = buf;
 365         t[1].len = len;
 366         spi_message_add_tail(&t[1], &m);
 367
 368         /* Byte count starts at zero. */
 369         *retlen = 0;
 370
 371         mutex_lock(&flash->lock);
 372
 373         /* Wait till previous write/erase is done. */
 374         if (wait_till_ready(flash)) {
 375                 /* REVISIT status return?? */
 376                 mutex_unlock(&flash->lock);
 377                 return 1;
 378         }
 379
 380         /* FIXME switch to OPCODE_FAST_READ.  It's required for higher
 381          * clocks; and at this writing, every chip this driver handles
 382          * supports that opcode.
 383          */
 384
 385         /* Set up the write data buffer. */
 386         flash->command[0] = OPCODE_READ;
 387         m25p_addr2cmd(flash, from, flash->command);
 388
 389         spi_sync(flash->spi, &m);
 390
 391         *retlen = m.actual_length - m25p_cmdsz(flash) - FAST_READ_DUMMY_BYTE;
 392
 393         mutex_unlock(&flash->lock);
 394
 395         return 0;
 396 }
 397
 398 /*
 399  * Write an address range to the flash chip.  Data must be written in
 400  * FLASH_PAGESIZE chunks.  The address range may be any size provided
 401  * it is within the physical boundaries.
 402  */
 403 static int m25p80_write(struct mtd_info *mtd, loff_t to, size_t len,
 404         size_t *retlen, const u_char *buf)
 405 {
 406         struct m25p *flash = mtd_to_m25p(mtd);
 407         u32 page_offset, page_size;
 408         struct spi_transfer t[2];
 409         struct spi_message m;
 410
 411         pr_debug("%s: %s to 0x%08x, len %zd\n", dev_name(&flash->spi->dev),
 412                         __func__, (u32)to, len);
 413
 414         *retlen = 0;
 415
 416         /* sanity checks */
 417         if (!len)
 418                 return(0);
 419
 420         spi_message_init(&m);
 421         memset(t, 0, (sizeof t));
 422
 423         t[0].tx_buf = flash->command;
 424         t[0].len = m25p_cmdsz(flash);
 425         spi_message_add_tail(&t[0], &m);
 426
 427         t[1].tx_buf = buf;
 428         spi_message_add_tail(&t[1], &m);
 429
 430         mutex_lock(&flash->lock);
 431
 432         /* Wait until finished previous write command. */
 433         if (wait_till_ready(flash)) {
 434                 mutex_unlock(&flash->lock);
 435                 return 1;
 436         }
 437
 438         write_enable(flash);
 439
 440         /* Set up the opcode in the write buffer. */
 441         flash->command[0] = OPCODE_PP;
 442         m25p_addr2cmd(flash, to, flash->command);
 443
 444         page_offset = to & (flash->page_size - 1);
 445
 446         /* do all the bytes fit onto one page? */
 447         if (page_offset + len <= flash->page_size) {
 448                 t[1].len = len;
 449
 450                 spi_sync(flash->spi, &m);
 451
 452                 *retlen = m.actual_length - m25p_cmdsz(flash);
 453         } else {
 454                 u32 i;
 455
 456                 /* the size of data remaining on the first page */
 457                 page_size = flash->page_size - page_offset;
 458
 459                 t[1].len = page_size;
 460                 spi_sync(flash->spi, &m);
 461
 462                 *retlen = m.actual_length - m25p_cmdsz(flash);
 463
 464                 /* write everything in flash->page_size chunks */
 465                 for (i = page_size; i < len; i += page_size) {
 466                         page_size = len - i;
 467                         if (page_size > flash->page_size)
 468                                 page_size = flash->page_size;
 469
 470                         /* write the next page to flash */
 471                         m25p_addr2cmd(flash, to + i, flash->command);
 472
 473                         t[1].tx_buf = buf + i;
 474                         t[1].len = page_size;
 475
 476                         wait_till_ready(flash);
 477
 478                         write_enable(flash);
 479
 480                         spi_sync(flash->spi, &m);
 481
 482                         *retlen += m.actual_length - m25p_cmdsz(flash);
 483                 }
 484         }
 485
 486         mutex_unlock(&flash->lock);
 487
 488         return 0;
 489 }
 490
 491 static int sst_write(struct mtd_info *mtd, loff_t to, size_t len,
 492                 size_t *retlen, const u_char *buf)
 493 {
 494         struct m25p *flash = mtd_to_m25p(mtd);
 495         struct spi_transfer t[2];
 496         struct spi_message m;
 497         size_t actual;
 498         int cmd_sz, ret;
 499
 500         pr_debug("%s: %s to 0x%08x, len %zd\n", dev_name(&flash->spi->dev),
 501                         __func__, (u32)to, len);
 502
 503         *retlen = 0;
 504
 505         /* sanity checks */
 506         if (!len)
 507                 return 0;
 508
 509         spi_message_init(&m);
 510         memset(t, 0, (sizeof t));
 511
 512         t[0].tx_buf = flash->command;
 513         t[0].len = m25p_cmdsz(flash);
 514         spi_message_add_tail(&t[0], &m);
 515
 516         t[1].tx_buf = buf;
 517         spi_message_add_tail(&t[1], &m);
 518
 519         mutex_lock(&flash->lock);
 520
 521         /* Wait until finished previous write command. */
 522         ret = wait_till_ready(flash);
 523         if (ret)
 524                 goto time_out;
 525
 526         write_enable(flash);
 527
 528         actual = to % 2;
 529         /* Start write from odd address. */
 530         if (actual) {
 531                 flash->command[0] = OPCODE_BP;
 532                 m25p_addr2cmd(flash, to, flash->command);
 533
 534                 /* write one byte. */
 535                 t[1].len = 1;
 536                 spi_sync(flash->spi, &m);
 537                 ret = wait_till_ready(flash);
 538                 if (ret)
 539                         goto time_out;
 540                 *retlen += m.actual_length - m25p_cmdsz(flash);
 541         }
 542         to += actual;
 543
 544         flash->command[0] = OPCODE_AAI_WP;
 545         m25p_addr2cmd(flash, to, flash->command);
 546
 547         /* Write out most of the data here. */
 548         cmd_sz = m25p_cmdsz(flash);
 549         for (; actual < len - 1; actual += 2) {
 550                 t[0].len = cmd_sz;
 551                 /* write two bytes. */
 552                 t[1].len = 2;
 553                 t[1].tx_buf = buf + actual;
 554
 555                 spi_sync(flash->spi, &m);
 556                 ret = wait_till_ready(flash);
 557                 if (ret)
 558                         goto time_out;
 559                 *retlen += m.actual_length - cmd_sz;
 560                 cmd_sz = 1;
 561                 to += 2;
 562         }
 563         write_disable(flash);
 564         ret = wait_till_ready(flash);
 565         if (ret)
 566                 goto time_out;
 567
 568         /* Write out trailing byte if it exists. */
 569         if (actual != len) {
 570                 write_enable(flash);
 571                 flash->command[0] = OPCODE_BP;
 572                 m25p_addr2cmd(flash, to, flash->command);
 573                 t[0].len = m25p_cmdsz(flash);
 574                 t[1].len = 1;
 575                 t[1].tx_buf = buf + actual;
 576
 577                 spi_sync(flash->spi, &m);
 578                 ret = wait_till_ready(flash);
 579                 if (ret)
 580                         goto time_out;
 581                 *retlen += m.actual_length - m25p_cmdsz(flash);
 582                 write_disable(flash);
 583         }
 584
 585 time_out:
 586         mutex_unlock(&flash->lock);
 587         return ret;
 588 }
 589
 590 /****************************************************************************/
 591
 592 /*
 593  * SPI device driver setup and teardown
 594  */
 595
 596 struct flash_info {
 597         /* JEDEC id zero means "no ID" (most older chips); otherwise it has
 598          * a high byte of zero plus three data bytes: the manufacturer id,
 599          * then a two byte device id.
 600          */
 601         u32             jedec_id;
 602         u16             ext_id;
 603
 604         /* The size listed here is what works with OPCODE_SE, which isn't
 605          * necessarily called a "sector" by the vendor.
 606          */
 607         unsigned        sector_size;
 608         u16             n_sectors;
 609
 610         u16             page_size;
 611         u16             addr_width;
 612
 613         u16             flags;
 614 #define SECT_4K         0x01            /* OPCODE_BE_4K works uniformly */
 615 #define M25P_NO_ERASE   0x02            /* No erase command needed */
 616 };
 617
 618 #define INFO(_jedec_id, _ext_id, _sector_size, _n_sectors, _flags)      \
 619         ((kernel_ulong_t)&(struct flash_info) {                         \
 620                 .jedec_id = (_jedec_id),                                \
 621                 .ext_id = (_ext_id),                                    \
 622                 .sector_size = (_sector_size),                          \
 623                 .n_sectors = (_n_sectors),                              \
 624                 .page_size = 256,                                       \
 625                 .flags = (_flags),                                      \
 626         })
 627
 628 #define CAT25_INFO(_sector_size, _n_sectors, _page_size, _addr_width)   \
 629         ((kernel_ulong_t)&(struct flash_info) {                         \
 630                 .sector_size = (_sector_size),                          \
 631                 .n_sectors = (_n_sectors),                              \
 632                 .page_size = (_page_size),                              \
 633                 .addr_width = (_addr_width),                            \
 634                 .flags = M25P_NO_ERASE,                                 \
 635         })
 636
 637 /* NOTE: double check command sets and memory organization when you add
 638  * more flash chips.  This current list focusses on newer chips, which
 639  * have been converging on command sets which including JEDEC ID.
 640  */
 641 static const struct spi_device_id m25p_ids[] = {
 642         /* Atmel -- some are (confusingly) marketed as "DataFlash" */
 643         { "at25fs010",  INFO(0x1f6601, 0, 32 * 1024,   4, SECT_4K) },
 644         { "at25fs040",  INFO(0x1f6604, 0, 64 * 1024,   8, SECT_4K) },
 645
 646         { "at25df041a", INFO(0x1f4401, 0, 64 * 1024,   8, SECT_4K) },
 647         { "at25df321a", INFO(0x1f4701, 0, 64 * 1024,  64, SECT_4K) },
 648         { "at25df641",  INFO(0x1f4800, 0, 64 * 1024, 128, SECT_4K) },
 649
 650         { "at26f004",   INFO(0x1f0400, 0, 64 * 1024,  8, SECT_4K) },
 651         { "at26df081a", INFO(0x1f4501, 0, 64 * 1024, 16, SECT_4K) },
 652         { "at26df161a", INFO(0x1f4601, 0, 64 * 1024, 32, SECT_4K) },
 653         { "at26df321",  INFO(0x1f4700, 0, 64 * 1024, 64, SECT_4K) },
 654
 655         /* EON -- en25xxx */
 656         { "en25f32", INFO(0x1c3116, 0, 64 * 1024,  64, SECT_4K) },
 657         { "en25p32", INFO(0x1c2016, 0, 64 * 1024,  64, 0) },
 658         { "en25q32b", INFO(0x1c3016, 0, 64 * 1024,  64, 0) },
 659         { "en25p64", INFO(0x1c2017, 0, 64 * 1024, 128, 0) },
 660
 661         /* Intel/Numonyx -- xxxs33b */
 662         { "160s33b",  INFO(0x898911, 0, 64 * 1024,  32, 0) },
 663         { "320s33b",  INFO(0x898912, 0, 64 * 1024,  64, 0) },
 664         { "640s33b",  INFO(0x898913, 0, 64 * 1024, 128, 0) },
 665
 666         /* Macronix */
 667         { "mx25l4005a",  INFO(0xc22013, 0, 64 * 1024,   8, SECT_4K) },
 668         { "mx25l8005",   INFO(0xc22014, 0, 64 * 1024,  16, 0) },
 669         { "mx25l1606e",  INFO(0xc22015, 0, 64 * 1024,  32, SECT_4K) },
 670         { "mx25l3205d",  INFO(0xc22016, 0, 64 * 1024,  64, 0) },
 671         { "mx25l6405d",  INFO(0xc22017, 0, 64 * 1024, 128, 0) },
 672         { "mx25l12805d", INFO(0xc22018, 0, 64 * 1024, 256, 0) },
 673         { "mx25l12855e", INFO(0xc22618, 0, 64 * 1024, 256, 0) },
 674         { "mx25l25635e", INFO(0xc22019, 0, 64 * 1024, 512, 0) },
 675         { "mx25l25655e", INFO(0xc22619, 0, 64 * 1024, 512, 0) },
 676
 677         /* Spansion -- single (large) sector size only, at least
 678          * for the chips listed here (without boot sectors).
 679          */
 680         { "s25sl004a",  INFO(0x010212,      0,  64 * 1024,   8, 0) },
 681         { "s25sl008a",  INFO(0x010213,      0,  64 * 1024,  16, 0) },
 682         { "s25sl016a",  INFO(0x010214,      0,  64 * 1024,  32, 0) },
 683         { "s25sl032a",  INFO(0x010215,      0,  64 * 1024,  64, 0) },
 684         { "s25sl032p",  INFO(0x010215, 0x4d00,  64 * 1024,  64, SECT_4K) },
 685         { "s25sl064a",  INFO(0x010216,      0,  64 * 1024, 128, 0) },
 686         { "s25fl256s0", INFO(0x010219, 0x4d00, 256 * 1024, 128, 0) },
 687         { "s25fl256s1", INFO(0x010219, 0x4d01,  64 * 1024, 512, 0) },
 688         { "s25fl512s",  INFO(0x010220, 0x4d00, 256 * 1024, 256, 0) },
 689         { "s70fl01gs",  INFO(0x010221, 0x4d00, 256 * 1024, 256, 0) },
 690         { "s25sl12800", INFO(0x012018, 0x0300, 256 * 1024,  64, 0) },
 691         { "s25sl12801", INFO(0x012018, 0x0301,  64 * 1024, 256, 0) },
 692         { "s25fl129p0", INFO(0x012018, 0x4d00, 256 * 1024,  64, 0) },
 693         { "s25fl129p1", INFO(0x012018, 0x4d01,  64 * 1024, 256, 0) },
 694         { "s25fl016k",  INFO(0xef4015,      0,  64 * 1024,  32, SECT_4K) },
 695         { "s25fl064k",  INFO(0xef4017,      0,  64 * 1024, 128, SECT_4K) },
 696
 697         /* SST -- large erase sizes are "overlays", "sectors" are 4K */
 698         { "sst25vf040b", INFO(0xbf258d, 0, 64 * 1024,  8, SECT_4K) },
 699         { "sst25vf080b", INFO(0xbf258e, 0, 64 * 1024, 16, SECT_4K) },
 700         { "sst25vf016b", INFO(0xbf2541, 0, 64 * 1024, 32, SECT_4K) },
 701         { "sst25vf032b", INFO(0xbf254a, 0, 64 * 1024, 64, SECT_4K) },
 702         { "sst25wf512",  INFO(0xbf2501, 0, 64 * 1024,  1, SECT_4K) },
 703         { "sst25wf010",  INFO(0xbf2502, 0, 64 * 1024,  2, SECT_4K) },
 704         { "sst25wf020",  INFO(0xbf2503, 0, 64 * 1024,  4, SECT_4K) },
 705         { "sst25wf040",  INFO(0xbf2504, 0, 64 * 1024,  8, SECT_4K) },
 706
 707         /* ST Microelectronics -- newer production may have feature updates */
 708         { "m25p05",  INFO(0x202010,  0,  32 * 1024,   2, 0) },
 709         { "m25p10",  INFO(0x202011,  0,  32 * 1024,   4, 0) },
 710         { "m25p20",  INFO(0x202012,  0,  64 * 1024,   4, 0) },
 711         { "m25p40",  INFO(0x202013,  0,  64 * 1024,   8, 0) },
 712         { "m25p80",  INFO(0x202014,  0,  64 * 1024,  16, 0) },
 713         { "m25p16",  INFO(0x202015,  0,  64 * 1024,  32, 0) },
 714         { "m25p32",  INFO(0x202016,  0,  64 * 1024,  64, 0) },
 715         { "m25p64",  INFO(0x202017,  0,  64 * 1024, 128, 0) },
 716         { "m25p128", INFO(0x202018,  0, 256 * 1024,  64, 0) },
 717
 718         { "m25p05-nonjedec",  INFO(0, 0,  32 * 1024,   2, 0) },
 719         { "m25p10-nonjedec",  INFO(0, 0,  32 * 1024,   4, 0) },
 720         { "m25p20-nonjedec",  INFO(0, 0,  64 * 1024,   4, 0) },
 721         { "m25p40-nonjedec",  INFO(0, 0,  64 * 1024,   8, 0) },
 722         { "m25p80-nonjedec",  INFO(0, 0,  64 * 1024,  16, 0) },
 723         { "m25p16-nonjedec",  INFO(0, 0,  64 * 1024,  32, 0) },
 724         { "m25p32-nonjedec",  INFO(0, 0,  64 * 1024,  64, 0) },
 725         { "m25p64-nonjedec",  INFO(0, 0,  64 * 1024, 128, 0) },
 726         { "m25p128-nonjedec", INFO(0, 0, 256 * 1024,  64, 0) },
 727
 728         { "m45pe10", INFO(0x204011,  0, 64 * 1024,    2, 0) },
 729         { "m45pe80", INFO(0x204014,  0, 64 * 1024,   16, 0) },
 730         { "m45pe16", INFO(0x204015,  0, 64 * 1024,   32, 0) },
 731
 732         { "m25pe80", INFO(0x208014,  0, 64 * 1024, 16,       0) },
 733         { "m25pe16", INFO(0x208015,  0, 64 * 1024, 32, SECT_4K) },
 734
 735         { "m25px32",    INFO(0x207116,  0, 64 * 1024, 64, SECT_4K) },
 736         { "m25px32-s0", INFO(0x207316,  0, 64 * 1024, 64, SECT_4K) },
 737         { "m25px32-s1", INFO(0x206316,  0, 64 * 1024, 64, SECT_4K) },
 738         { "m25px64",    INFO(0x207117,  0, 64 * 1024, 128, 0) },
 739
 740         /* Winbond -- w25x "blocks" are 64K, "sectors" are 4KiB */
 741         { "w25x10", INFO(0xef3011, 0, 64 * 1024,  2,  SECT_4K) },
 742         { "w25x20", INFO(0xef3012, 0, 64 * 1024,  4,  SECT_4K) },
 743         { "w25x40", INFO(0xef3013, 0, 64 * 1024,  8,  SECT_4K) },
 744         { "w25x80", INFO(0xef3014, 0, 64 * 1024,  16, SECT_4K) },
 745         { "w25x16", INFO(0xef3015, 0, 64 * 1024,  32, SECT_4K) },
 746         { "w25x32", INFO(0xef3016, 0, 64 * 1024,  64, SECT_4K) },
 747         { "w25q32", INFO(0xef4016, 0, 64 * 1024,  64, SECT_4K) },
 748         { "w25x64", INFO(0xef3017, 0, 64 * 1024, 128, SECT_4K) },
 749         { "w25q64", INFO(0xef4017, 0, 64 * 1024, 128, SECT_4K) },
 750
 751         /* Catalyst / On Semiconductor -- non-JEDEC */
 752         { "cat25c11", CAT25_INFO(  16, 8, 16, 1) },
 753         { "cat25c03", CAT25_INFO(  32, 8, 16, 2) },
 754         { "cat25c09", CAT25_INFO( 128, 8, 32, 2) },
 755         { "cat25c17", CAT25_INFO( 256, 8, 32, 2) },
 756         { "cat25128", CAT25_INFO(2048, 8, 64, 2) },
 757         { },
 758 };
 759 MODULE_DEVICE_TABLE(spi, m25p_ids);
 760
 761 static const struct spi_device_id *__devinit jedec_probe(struct spi_device *spi)
 762 {
 763         int                     tmp;
 764         u8                      code = OPCODE_RDID;
 765         u8                      id[5];
 766         u32                     jedec;
 767         u16                     ext_jedec;
 768         struct flash_info       *info;
 769
 770         /* JEDEC also defines an optional "extended device information"
 771          * string for after vendor-specific data, after the three bytes
 772          * we use here.  Supporting some chips might require using it.
 773          */
 774         tmp = spi_write_then_read(spi, &code, 1, id, 5);
 775         if (tmp < 0) {
 776                 pr_debug("%s: error %d reading JEDEC ID\n",
 777                                 dev_name(&spi->dev), tmp);
 778                 return ERR_PTR(tmp);
 779         }
 780         jedec = id[0];
 781         jedec = jedec << 8;
 782         jedec |= id[1];
 783         jedec = jedec << 8;
 784         jedec |= id[2];
 785
 786         ext_jedec = id[3] << 8 | id[4];
 787
 788         for (tmp = 0; tmp < ARRAY_SIZE(m25p_ids) - 1; tmp++) {
 789                 info = (void *)m25p_ids[tmp].driver_data;
 790                 if (info->jedec_id == jedec) {
 791                         if (info->ext_id != 0 && info->ext_id != ext_jedec)
 792                                 continue;
 793                         return &m25p_ids[tmp];
 794                 }
 795         }
 796         dev_err(&spi->dev, "unrecognized JEDEC id %06x\n", jedec);
 797         return ERR_PTR(-ENODEV);
 798 }
 799
 800
 801 /*
 802  * board specific setup should have ensured the SPI clock used here
 803  * matches what the READ command supports, at least until this driver
 804  * understands FAST_READ (for clocks over 25 MHz).
 805  */
 806 static int __devinit m25p_probe(struct spi_device *spi)
 807 {
 808         const struct spi_device_id      *id = spi_get_device_id(spi);
 809         struct flash_platform_data      *data;
 810         struct m25p                     *flash;
 811         struct flash_info               *info;
 812         unsigned                        i;
 813         struct mtd_part_parser_data     ppdata;
 814
 815 #ifdef CONFIG_MTD_OF_PARTS
 816         if (!of_device_is_available(spi->dev.of_node))
 817                 return -ENODEV;
 818 #endif
 819
 820         /* Platform data helps sort out which chip type we have, as
 821          * well as how this board partitions it.  If we don't have
 822          * a chip ID, try the JEDEC id commands; they'll work for most
 823          * newer chips, even if we don't recognize the particular chip.
 824          */
 825         data = spi->dev.platform_data;
 826         if (data && data->type) {
 827                 const struct spi_device_id *plat_id;
 828
 829                 for (i = 0; i < ARRAY_SIZE(m25p_ids) - 1; i++) {
 830                         plat_id = &m25p_ids[i];
 831                         if (strcmp(data->type, plat_id->name))
 832                                 continue;
 833                         break;
 834                 }
 835
 836                 if (i < ARRAY_SIZE(m25p_ids) - 1)
 837                         id = plat_id;
 838                 else
 839                         dev_warn(&spi->dev, "unrecognized id %s\n", data->type);
 840         }
 841
 842         info = (void *)id->driver_data;
 843
 844         if (info->jedec_id) {
 845                 const struct spi_device_id *jid;
 846
 847                 jid = jedec_probe(spi);
 848                 if (IS_ERR(jid)) {
 849                         return PTR_ERR(jid);
 850                 } else if (jid != id) {
 851                         /*
 852                          * JEDEC knows better, so overwrite platform ID. We
 853                          * can't trust partitions any longer, but we'll let
 854                          * mtd apply them anyway, since some partitions may be
 855                          * marked read-only, and we don't want to lose that
 856                          * information, even if it's not 100% accurate.
 857                          */
 858                         dev_warn(&spi->dev, "found %s, expected %s\n",
 859                                  jid->name, id->name);
 860                         id = jid;
 861                         info = (void *)jid->driver_data;
 862                 }
 863         }
 864
 865         flash = kzalloc(sizeof *flash, GFP_KERNEL);
 866         if (!flash)
 867                 return -ENOMEM;
 868         flash->command = kmalloc(MAX_CMD_SIZE + FAST_READ_DUMMY_BYTE, GFP_KERNEL);
 869         if (!flash->command) {
 870                 kfree(flash);
 871                 return -ENOMEM;
 872         }
 873
 874         flash->spi = spi;
 875         mutex_init(&flash->lock);
 876         dev_set_drvdata(&spi->dev, flash);
 877
 878         /*
 879          * Atmel, SST and Intel/Numonyx serial flash tend to power
 880          * up with the software protection bits set
 881          */
 882
 883         if (JEDEC_MFR(info->jedec_id) == CFI_MFR_ATMEL ||
 884             JEDEC_MFR(info->jedec_id) == CFI_MFR_INTEL ||
 885             JEDEC_MFR(info->jedec_id) == CFI_MFR_SST) {
 886                 write_enable(flash);
 887                 write_sr(flash, 0);
 888         }
 889
 890         if (data && data->name)
 891                 flash->mtd.name = data->name;
 892         else
 893                 flash->mtd.name = dev_name(&spi->dev);
 894
 895         flash->mtd.type = MTD_NORFLASH;
 896         flash->mtd.writesize = 1;
 897         flash->mtd.flags = MTD_CAP_NORFLASH;
 898         flash->mtd.size = info->sector_size * info->n_sectors;
 899         flash->mtd._erase = m25p80_erase;
 900         flash->mtd._read = m25p80_read;
 901
 902         /* sst flash chips use AAI word program */
 903         if (JEDEC_MFR(info->jedec_id) == CFI_MFR_SST)
 904                 flash->mtd._write = sst_write;
 905         else
 906                 flash->mtd._write = m25p80_write;
 907
 908         /* prefer "small sector" erase if possible */
 909         if (info->flags & SECT_4K) {
 910                 flash->erase_opcode = OPCODE_BE_4K;
 911                 flash->mtd.erasesize = 4096;
 912         } else {
 913                 flash->erase_opcode = OPCODE_SE;
 914                 flash->mtd.erasesize = info->sector_size;
 915         }
 916
 917         if (info->flags & M25P_NO_ERASE)
 918                 flash->mtd.flags |= MTD_NO_ERASE;
 919
 920         ppdata.of_node = spi->dev.of_node;
 921         flash->mtd.dev.parent = &spi->dev;
 922         flash->page_size = info->page_size;
 923         flash->mtd.writebufsize = flash->page_size;
 924
 925         if (info->addr_width)
 926                 flash->addr_width = info->addr_width;
 927         else {
 928                 /* enable 4-byte addressing if the device exceeds 16MiB */
 929                 if (flash->mtd.size > 0x1000000) {
 930                         flash->addr_width = 4;
 931                         set_4byte(flash, info->jedec_id, 1);
 932                 } else
 933                         flash->addr_width = 3;
 934         }
 935
 936         dev_info(&spi->dev, "%s (%lld Kbytes)\n", id->name,
 937                         (long long)flash->mtd.size >> 10);
 938
 939         pr_debug("mtd .name = %s, .size = 0x%llx (%lldMiB) "
 940                         ".erasesize = 0x%.8x (%uKiB) .numeraseregions = %d\n",
 941                 flash->mtd.name,
 942                 (long long)flash->mtd.size, (long long)(flash->mtd.size >> 20),
 943                 flash->mtd.erasesize, flash->mtd.erasesize / 1024,
 944                 flash->mtd.numeraseregions);
 945
 946         if (flash->mtd.numeraseregions)
 947                 for (i = 0; i < flash->mtd.numeraseregions; i++)
 948                         pr_debug("mtd.eraseregions[%d] = { .offset = 0x%llx, "
 949                                 ".erasesize = 0x%.8x (%uKiB), "
 950                                 ".numblocks = %d }\n",
 951                                 i, (long long)flash->mtd.eraseregions[i].offset,
 952                                 flash->mtd.eraseregions[i].erasesize,
 953                                 flash->mtd.eraseregions[i].erasesize / 1024,
 954                                 flash->mtd.eraseregions[i].numblocks);
 955
 956
 957         /* partitions should match sector boundaries; and it may be good to
 958          * use readonly partitions for writeprotected sectors (BP2..BP0).
 959          */
 960         return mtd_device_parse_register(&flash->mtd, NULL, &ppdata,
 961                         data ? data->parts : NULL,
 962                         data ? data->nr_parts : 0);
 963 }
 964
 965
 966 static int __devexit m25p_remove(struct spi_device *spi)
 967 {
 968         struct m25p     *flash = dev_get_drvdata(&spi->dev);
 969         int             status;
 970
 971         /* Clean up MTD stuff. */
 972         status = mtd_device_unregister(&flash->mtd);
 973         if (status == 0) {
 974                 kfree(flash->command);
 975                 kfree(flash);
 976         }
 977         return 0;
 978 }
 979
 980
 981 static struct spi_driver m25p80_driver = {
 982         .driver = {
 983                 .name   = "m25p80",
 984                 .owner  = THIS_MODULE,
 985         },
 986         .id_table       = m25p_ids,
 987         .probe  = m25p_probe,
 988         .remove = __devexit_p(m25p_remove),
 989
 990         /* REVISIT: many of these chips have deep power-down modes, which
 991          * should clearly be entered on suspend() to minimize power use.
 992          * And also when they're otherwise idle...
 993          */
 994 };
 995
 996 module_spi_driver(m25p80_driver);
 997
 998 MODULE_LICENSE("GPL");
 999 MODULE_AUTHOR("Mike Lavender");
1000 MODULE_DESCRIPTION("MTD SPI driver for ST M25Pxx flash chips");