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