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/module.h>
  20 #include <linux/device.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/mutex.h>
  23 #include <linux/math64.h>
  24
  25 #include <linux/mtd/mtd.h>
  26 #include <linux/mtd/partitions.h>
  27
  28 #include <linux/spi/spi.h>
  29 #include <linux/spi/flash.h>
  30
  31
  32 #define FLASH_PAGESIZE          256
  33
  34 /* Flash opcodes. */
  35 #define OPCODE_WREN             0x06    /* Write enable */
  36 #define OPCODE_RDSR             0x05    /* Read status register */
  37 #define OPCODE_WRSR             0x01    /* Write status register 1 byte */
  38 #define OPCODE_NORM_READ        0x03    /* Read data bytes (low frequency) */
  39 #define OPCODE_FAST_READ        0x0b    /* Read data bytes (high frequency) */
  40 #define OPCODE_PP               0x02    /* Page program (up to 256 bytes) */
  41 #define OPCODE_BE_4K            0x20    /* Erase 4KiB block */
  42 #define OPCODE_BE_32K           0x52    /* Erase 32KiB block */
  43 #define OPCODE_CHIP_ERASE       0xc7    /* Erase whole flash chip */
  44 #define OPCODE_SE               0xd8    /* Sector erase (usually 64KiB) */
  45 #define OPCODE_RDID             0x9f    /* Read JEDEC ID */
  46
  47 /* Status Register bits. */
  48 #define SR_WIP                  1       /* Write in progress */
  49 #define SR_WEL                  2       /* Write enable latch */
  50 /* meaning of other SR_* bits may differ between vendors */
  51 #define SR_BP0                  4       /* Block protect 0 */
  52 #define SR_BP1                  8       /* Block protect 1 */
  53 #define SR_BP2                  0x10    /* Block protect 2 */
  54 #define SR_SRWD                 0x80    /* SR write protect */
  55
  56 /* Define max times to check status register before we give up. */
  57 #define MAX_READY_WAIT_COUNT    100000
  58 #define CMD_SIZE                4
  59
  60 #ifdef CONFIG_M25PXX_USE_FAST_READ
  61 #define OPCODE_READ     OPCODE_FAST_READ
  62 #define FAST_READ_DUMMY_BYTE 1
  63 #else
  64 #define OPCODE_READ     OPCODE_NORM_READ
  65 #define FAST_READ_DUMMY_BYTE 0
  66 #endif
  67
  68 #ifdef CONFIG_MTD_PARTITIONS
  69 #define mtd_has_partitions()    (1)
  70 #else
  71 #define mtd_has_partitions()    (0)
  72 #endif
  73
  74 /****************************************************************************/
  75
  76 struct m25p {
  77         struct spi_device       *spi;
  78         struct mutex            lock;
  79         struct mtd_info         mtd;
  80         unsigned                partitioned:1;
  81         u8                      erase_opcode;
  82         u8                      command[CMD_SIZE + FAST_READ_DUMMY_BYTE];
  83 };
  84
  85 static inline struct m25p *mtd_to_m25p(struct mtd_info *mtd)
  86 {
  87         return container_of(mtd, struct m25p, mtd);
  88 }
  89
  90 /****************************************************************************/
  91
  92 /*
  93  * Internal helper functions
  94  */
  95
  96 /*
  97  * Read the status register, returning its value in the location
  98  * Return the status register value.
  99  * Returns negative if error occurred.
 100  */
 101 static int read_sr(struct m25p *flash)
 102 {
 103         ssize_t retval;
 104         u8 code = OPCODE_RDSR;
 105         u8 val;
 106
 107         retval = spi_write_then_read(flash->spi, &code, 1, &val, 1);
 108
 109         if (retval < 0) {
 110                 dev_err(&flash->spi->dev, "error %d reading SR\n",
 111                                 (int) retval);
 112                 return retval;
 113         }
 114
 115         return val;
 116 }
 117
 118 /*
 119  * Write status register 1 byte
 120  * Returns negative if error occurred.
 121  */
 122 static int write_sr(struct m25p *flash, u8 val)
 123 {
 124         flash->command[0] = OPCODE_WRSR;
 125         flash->command[1] = val;
 126
 127         return spi_write(flash->spi, flash->command, 2);
 128 }
 129
 130 /*
 131  * Set write enable latch with Write Enable command.
 132  * Returns negative if error occurred.
 133  */
 134 static inline int write_enable(struct m25p *flash)
 135 {
 136         u8      code = OPCODE_WREN;
 137
 138         return spi_write_then_read(flash->spi, &code, 1, NULL, 0);
 139 }
 140
 141
 142 /*
 143  * Service routine to read status register until ready, or timeout occurs.
 144  * Returns non-zero if error.
 145  */
 146 static int wait_till_ready(struct m25p *flash)
 147 {
 148         int count;
 149         int sr;
 150
 151         /* one chip guarantees max 5 msec wait here after page writes,
 152          * but potentially three seconds (!) after page erase.
 153          */
 154         for (count = 0; count < MAX_READY_WAIT_COUNT; count++) {
 155                 if ((sr = read_sr(flash)) < 0)
 156                         break;
 157                 else if (!(sr & SR_WIP))
 158                         return 0;
 159
 160                 /* REVISIT sometimes sleeping would be best */
 161         }
 162
 163         return 1;
 164 }
 165
 166 /*
 167  * Erase the whole flash memory
 168  *
 169  * Returns 0 if successful, non-zero otherwise.
 170  */
 171 static int erase_chip(struct m25p *flash)
 172 {
 173         DEBUG(MTD_DEBUG_LEVEL3, "%s: %s %lldKiB\n",
 174               dev_name(&flash->spi->dev), __func__,
 175               (long long)(flash->mtd.size >> 10));
 176
 177         /* Wait until finished previous write command. */
 178         if (wait_till_ready(flash))
 179                 return 1;
 180
 181         /* Send write enable, then erase commands. */
 182         write_enable(flash);
 183
 184         /* Set up command buffer. */
 185         flash->command[0] = OPCODE_CHIP_ERASE;
 186
 187         spi_write(flash->spi, flash->command, 1);
 188
 189         return 0;
 190 }
 191
 192 /*
 193  * Erase one sector of flash memory at offset ``offset'' which is any
 194  * address within the sector which should be erased.
 195  *
 196  * Returns 0 if successful, non-zero otherwise.
 197  */
 198 static int erase_sector(struct m25p *flash, u32 offset)
 199 {
 200         DEBUG(MTD_DEBUG_LEVEL3, "%s: %s %dKiB at 0x%08x\n",
 201                         dev_name(&flash->spi->dev), __func__,
 202                         flash->mtd.erasesize / 1024, offset);
 203
 204         /* Wait until finished previous write command. */
 205         if (wait_till_ready(flash))
 206                 return 1;
 207
 208         /* Send write enable, then erase commands. */
 209         write_enable(flash);
 210
 211         /* Set up command buffer. */
 212         flash->command[0] = flash->erase_opcode;
 213         flash->command[1] = offset >> 16;
 214         flash->command[2] = offset >> 8;
 215         flash->command[3] = offset;
 216
 217         spi_write(flash->spi, flash->command, CMD_SIZE);
 218
 219         return 0;
 220 }
 221
 222 /****************************************************************************/
 223
 224 /*
 225  * MTD implementation
 226  */
 227
 228 /*
 229  * Erase an address range on the flash chip.  The address range may extend
 230  * one or more erase sectors.  Return an error is there is a problem erasing.
 231  */
 232 static int m25p80_erase(struct mtd_info *mtd, struct erase_info *instr)
 233 {
 234         struct m25p *flash = mtd_to_m25p(mtd);
 235         u32 addr,len;
 236         uint32_t rem;
 237
 238         DEBUG(MTD_DEBUG_LEVEL2, "%s: %s %s 0x%llx, len %lld\n",
 239               dev_name(&flash->spi->dev), __func__, "at",
 240               (long long)instr->addr, (long long)instr->len);
 241
 242         /* sanity checks */
 243         if (instr->addr + instr->len > flash->mtd.size)
 244                 return -EINVAL;
 245         div_u64_rem(instr->len, mtd->erasesize, &rem);
 246         if (rem)
 247                 return -EINVAL;
 248
 249         addr = instr->addr;
 250         len = instr->len;
 251
 252         mutex_lock(&flash->lock);
 253
 254         /* whole-chip erase? */
 255         if (len == flash->mtd.size && erase_chip(flash)) {
 256                 instr->state = MTD_ERASE_FAILED;
 257                 mutex_unlock(&flash->lock);
 258                 return -EIO;
 259
 260         /* REVISIT in some cases we could speed up erasing large regions
 261          * by using OPCODE_SE instead of OPCODE_BE_4K.  We may have set up
 262          * to use "small sector erase", but that's not always optimal.
 263          */
 264
 265         /* "sector"-at-a-time erase */
 266         } else {
 267                 while (len) {
 268                         if (erase_sector(flash, addr)) {
 269                                 instr->state = MTD_ERASE_FAILED;
 270                                 mutex_unlock(&flash->lock);
 271                                 return -EIO;
 272                         }
 273
 274                         addr += mtd->erasesize;
 275                         len -= mtd->erasesize;
 276                 }
 277         }
 278
 279         mutex_unlock(&flash->lock);
 280
 281         instr->state = MTD_ERASE_DONE;
 282         mtd_erase_callback(instr);
 283
 284         return 0;
 285 }
 286
 287 /*
 288  * Read an address range from the flash chip.  The address range
 289  * may be any size provided it is within the physical boundaries.
 290  */
 291 static int m25p80_read(struct mtd_info *mtd, loff_t from, size_t len,
 292         size_t *retlen, u_char *buf)
 293 {
 294         struct m25p *flash = mtd_to_m25p(mtd);
 295         struct spi_transfer t[2];
 296         struct spi_message m;
 297
 298         DEBUG(MTD_DEBUG_LEVEL2, "%s: %s %s 0x%08x, len %zd\n",
 299                         dev_name(&flash->spi->dev), __func__, "from",
 300                         (u32)from, len);
 301
 302         /* sanity checks */
 303         if (!len)
 304                 return 0;
 305
 306         if (from + len > flash->mtd.size)
 307                 return -EINVAL;
 308
 309         spi_message_init(&m);
 310         memset(t, 0, (sizeof t));
 311
 312         /* NOTE:
 313          * OPCODE_FAST_READ (if available) is faster.
 314          * Should add 1 byte DUMMY_BYTE.
 315          */
 316         t[0].tx_buf = flash->command;
 317         t[0].len = CMD_SIZE + FAST_READ_DUMMY_BYTE;
 318         spi_message_add_tail(&t[0], &m);
 319
 320         t[1].rx_buf = buf;
 321         t[1].len = len;
 322         spi_message_add_tail(&t[1], &m);
 323
 324         /* Byte count starts at zero. */
 325         if (retlen)
 326                 *retlen = 0;
 327
 328         mutex_lock(&flash->lock);
 329
 330         /* Wait till previous write/erase is done. */
 331         if (wait_till_ready(flash)) {
 332                 /* REVISIT status return?? */
 333                 mutex_unlock(&flash->lock);
 334                 return 1;
 335         }
 336
 337         /* FIXME switch to OPCODE_FAST_READ.  It's required for higher
 338          * clocks; and at this writing, every chip this driver handles
 339          * supports that opcode.
 340          */
 341
 342         /* Set up the write data buffer. */
 343         flash->command[0] = OPCODE_READ;
 344         flash->command[1] = from >> 16;
 345         flash->command[2] = from >> 8;
 346         flash->command[3] = from;
 347
 348         spi_sync(flash->spi, &m);
 349
 350         *retlen = m.actual_length - CMD_SIZE - FAST_READ_DUMMY_BYTE;
 351
 352         mutex_unlock(&flash->lock);
 353
 354         return 0;
 355 }
 356
 357 /*
 358  * Write an address range to the flash chip.  Data must be written in
 359  * FLASH_PAGESIZE chunks.  The address range may be any size provided
 360  * it is within the physical boundaries.
 361  */
 362 static int m25p80_write(struct mtd_info *mtd, loff_t to, size_t len,
 363         size_t *retlen, const u_char *buf)
 364 {
 365         struct m25p *flash = mtd_to_m25p(mtd);
 366         u32 page_offset, page_size;
 367         struct spi_transfer t[2];
 368         struct spi_message m;
 369
 370         DEBUG(MTD_DEBUG_LEVEL2, "%s: %s %s 0x%08x, len %zd\n",
 371                         dev_name(&flash->spi->dev), __func__, "to",
 372                         (u32)to, len);
 373
 374         if (retlen)
 375                 *retlen = 0;
 376
 377         /* sanity checks */
 378         if (!len)
 379                 return(0);
 380
 381         if (to + len > flash->mtd.size)
 382                 return -EINVAL;
 383
 384         spi_message_init(&m);
 385         memset(t, 0, (sizeof t));
 386
 387         t[0].tx_buf = flash->command;
 388         t[0].len = CMD_SIZE;
 389         spi_message_add_tail(&t[0], &m);
 390
 391         t[1].tx_buf = buf;
 392         spi_message_add_tail(&t[1], &m);
 393
 394         mutex_lock(&flash->lock);
 395
 396         /* Wait until finished previous write command. */
 397         if (wait_till_ready(flash)) {
 398                 mutex_unlock(&flash->lock);
 399                 return 1;
 400         }
 401
 402         write_enable(flash);
 403
 404         /* Set up the opcode in the write buffer. */
 405         flash->command[0] = OPCODE_PP;
 406         flash->command[1] = to >> 16;
 407         flash->command[2] = to >> 8;
 408         flash->command[3] = to;
 409
 410         /* what page do we start with? */
 411         page_offset = to % FLASH_PAGESIZE;
 412
 413         /* do all the bytes fit onto one page? */
 414         if (page_offset + len <= FLASH_PAGESIZE) {
 415                 t[1].len = len;
 416
 417                 spi_sync(flash->spi, &m);
 418
 419                 *retlen = m.actual_length - CMD_SIZE;
 420         } else {
 421                 u32 i;
 422
 423                 /* the size of data remaining on the first page */
 424                 page_size = FLASH_PAGESIZE - page_offset;
 425
 426                 t[1].len = page_size;
 427                 spi_sync(flash->spi, &m);
 428
 429                 *retlen = m.actual_length - CMD_SIZE;
 430
 431                 /* write everything in PAGESIZE chunks */
 432                 for (i = page_size; i < len; i += page_size) {
 433                         page_size = len - i;
 434                         if (page_size > FLASH_PAGESIZE)
 435                                 page_size = FLASH_PAGESIZE;
 436
 437                         /* write the next page to flash */
 438                         flash->command[1] = (to + i) >> 16;
 439                         flash->command[2] = (to + i) >> 8;
 440                         flash->command[3] = (to + i);
 441
 442                         t[1].tx_buf = buf + i;
 443                         t[1].len = page_size;
 444
 445                         wait_till_ready(flash);
 446
 447                         write_enable(flash);
 448
 449                         spi_sync(flash->spi, &m);
 450
 451                         if (retlen)
 452                                 *retlen += m.actual_length - CMD_SIZE;
 453                 }
 454         }
 455
 456         mutex_unlock(&flash->lock);
 457
 458         return 0;
 459 }
 460
 461
 462 /****************************************************************************/
 463
 464 /*
 465  * SPI device driver setup and teardown
 466  */
 467
 468 struct flash_info {
 469         char            *name;
 470
 471         /* JEDEC id zero means "no ID" (most older chips); otherwise it has
 472          * a high byte of zero plus three data bytes: the manufacturer id,
 473          * then a two byte device id.
 474          */
 475         u32             jedec_id;
 476         u16             ext_id;
 477
 478         /* The size listed here is what works with OPCODE_SE, which isn't
 479          * necessarily called a "sector" by the vendor.
 480          */
 481         unsigned        sector_size;
 482         u16             n_sectors;
 483
 484         u16             flags;
 485 #define SECT_4K         0x01            /* OPCODE_BE_4K works uniformly */
 486 };
 487
 488
 489 /* NOTE: double check command sets and memory organization when you add
 490  * more flash chips.  This current list focusses on newer chips, which
 491  * have been converging on command sets which including JEDEC ID.
 492  */
 493 static struct flash_info __devinitdata m25p_data [] = {
 494
 495         /* Atmel -- some are (confusingly) marketed as "DataFlash" */
 496         { "at25fs010",  0x1f6601, 0, 32 * 1024, 4, SECT_4K, },
 497         { "at25fs040",  0x1f6604, 0, 64 * 1024, 8, SECT_4K, },
 498
 499         { "at25df041a", 0x1f4401, 0, 64 * 1024, 8, SECT_4K, },
 500         { "at25df641",  0x1f4800, 0, 64 * 1024, 128, SECT_4K, },
 501
 502         { "at26f004",   0x1f0400, 0, 64 * 1024, 8, SECT_4K, },
 503         { "at26df081a", 0x1f4501, 0, 64 * 1024, 16, SECT_4K, },
 504         { "at26df161a", 0x1f4601, 0, 64 * 1024, 32, SECT_4K, },
 505         { "at26df321",  0x1f4701, 0, 64 * 1024, 64, SECT_4K, },
 506
 507         /* Spansion -- single (large) sector size only, at least
 508          * for the chips listed here (without boot sectors).
 509          */
 510         { "s25sl004a", 0x010212, 0, 64 * 1024, 8, },
 511         { "s25sl008a", 0x010213, 0, 64 * 1024, 16, },
 512         { "s25sl016a", 0x010214, 0, 64 * 1024, 32, },
 513         { "s25sl032a", 0x010215, 0, 64 * 1024, 64, },
 514         { "s25sl064a", 0x010216, 0, 64 * 1024, 128, },
 515         { "s25sl12800", 0x012018, 0x0300, 256 * 1024, 64, },
 516         { "s25sl12801", 0x012018, 0x0301, 64 * 1024, 256, },
 517
 518         /* SST -- large erase sizes are "overlays", "sectors" are 4K */
 519         { "sst25vf040b", 0xbf258d, 0, 64 * 1024, 8, SECT_4K, },
 520         { "sst25vf080b", 0xbf258e, 0, 64 * 1024, 16, SECT_4K, },
 521         { "sst25vf016b", 0xbf2541, 0, 64 * 1024, 32, SECT_4K, },
 522         { "sst25vf032b", 0xbf254a, 0, 64 * 1024, 64, SECT_4K, },
 523
 524         /* ST Microelectronics -- newer production may have feature updates */
 525         { "m25p05",  0x202010,  0, 32 * 1024, 2, },
 526         { "m25p10",  0x202011,  0, 32 * 1024, 4, },
 527         { "m25p20",  0x202012,  0, 64 * 1024, 4, },
 528         { "m25p40",  0x202013,  0, 64 * 1024, 8, },
 529         { "m25p80",         0,  0, 64 * 1024, 16, },
 530         { "m25p16",  0x202015,  0, 64 * 1024, 32, },
 531         { "m25p32",  0x202016,  0, 64 * 1024, 64, },
 532         { "m25p64",  0x202017,  0, 64 * 1024, 128, },
 533         { "m25p128", 0x202018, 0, 256 * 1024, 64, },
 534
 535         { "m45pe80", 0x204014,  0, 64 * 1024, 16, },
 536         { "m45pe16", 0x204015,  0, 64 * 1024, 32, },
 537
 538         { "m25pe80", 0x208014,  0, 64 * 1024, 16, },
 539         { "m25pe16", 0x208015,  0, 64 * 1024, 32, SECT_4K, },
 540
 541         /* Winbond -- w25x "blocks" are 64K, "sectors" are 4KiB */
 542         { "w25x10", 0xef3011, 0, 64 * 1024, 2, SECT_4K, },
 543         { "w25x20", 0xef3012, 0, 64 * 1024, 4, SECT_4K, },
 544         { "w25x40", 0xef3013, 0, 64 * 1024, 8, SECT_4K, },
 545         { "w25x80", 0xef3014, 0, 64 * 1024, 16, SECT_4K, },
 546         { "w25x16", 0xef3015, 0, 64 * 1024, 32, SECT_4K, },
 547         { "w25x32", 0xef3016, 0, 64 * 1024, 64, SECT_4K, },
 548         { "w25x64", 0xef3017, 0, 64 * 1024, 128, SECT_4K, },
 549 };
 550
 551 static struct flash_info *__devinit jedec_probe(struct spi_device *spi)
 552 {
 553         int                     tmp;
 554         u8                      code = OPCODE_RDID;
 555         u8                      id[5];
 556         u32                     jedec;
 557         u16                     ext_jedec;
 558         struct flash_info       *info;
 559
 560         /* JEDEC also defines an optional "extended device information"
 561          * string for after vendor-specific data, after the three bytes
 562          * we use here.  Supporting some chips might require using it.
 563          */
 564         tmp = spi_write_then_read(spi, &code, 1, id, 5);
 565         if (tmp < 0) {
 566                 DEBUG(MTD_DEBUG_LEVEL0, "%s: error %d reading JEDEC ID\n",
 567                         dev_name(&spi->dev), tmp);
 568                 return NULL;
 569         }
 570         jedec = id[0];
 571         jedec = jedec << 8;
 572         jedec |= id[1];
 573         jedec = jedec << 8;
 574         jedec |= id[2];
 575
 576         ext_jedec = id[3] << 8 | id[4];
 577
 578         for (tmp = 0, info = m25p_data;
 579                         tmp < ARRAY_SIZE(m25p_data);
 580                         tmp++, info++) {
 581                 if (info->jedec_id == jedec) {
 582                         if (info->ext_id != 0 && info->ext_id != ext_jedec)
 583                                 continue;
 584                         return info;
 585                 }
 586         }
 587         dev_err(&spi->dev, "unrecognized JEDEC id %06x\n", jedec);
 588         return NULL;
 589 }
 590
 591
 592 /*
 593  * board specific setup should have ensured the SPI clock used here
 594  * matches what the READ command supports, at least until this driver
 595  * understands FAST_READ (for clocks over 25 MHz).
 596  */
 597 static int __devinit m25p_probe(struct spi_device *spi)
 598 {
 599         struct flash_platform_data      *data;
 600         struct m25p                     *flash;
 601         struct flash_info               *info;
 602         unsigned                        i;
 603
 604         /* Platform data helps sort out which chip type we have, as
 605          * well as how this board partitions it.  If we don't have
 606          * a chip ID, try the JEDEC id commands; they'll work for most
 607          * newer chips, even if we don't recognize the particular chip.
 608          */
 609         data = spi->dev.platform_data;
 610         if (data && data->type) {
 611                 for (i = 0, info = m25p_data;
 612                                 i < ARRAY_SIZE(m25p_data);
 613                                 i++, info++) {
 614                         if (strcmp(data->type, info->name) == 0)
 615                                 break;
 616                 }
 617
 618                 /* unrecognized chip? */
 619                 if (i == ARRAY_SIZE(m25p_data)) {
 620                         DEBUG(MTD_DEBUG_LEVEL0, "%s: unrecognized id %s\n",
 621                                         dev_name(&spi->dev), data->type);
 622                         info = NULL;
 623
 624                 /* recognized; is that chip really what's there? */
 625                 } else if (info->jedec_id) {
 626                         struct flash_info       *chip = jedec_probe(spi);
 627
 628                         if (!chip || chip != info) {
 629                                 dev_warn(&spi->dev, "found %s, expected %s\n",
 630                                                 chip ? chip->name : "UNKNOWN",
 631                                                 info->name);
 632                                 info = NULL;
 633                         }
 634                 }
 635         } else
 636                 info = jedec_probe(spi);
 637
 638         if (!info)
 639                 return -ENODEV;
 640
 641         flash = kzalloc(sizeof *flash, GFP_KERNEL);
 642         if (!flash)
 643                 return -ENOMEM;
 644
 645         flash->spi = spi;
 646         mutex_init(&flash->lock);
 647         dev_set_drvdata(&spi->dev, flash);
 648
 649         /*
 650          * Atmel serial flash tend to power up
 651          * with the software protection bits set
 652          */
 653
 654         if (info->jedec_id >> 16 == 0x1f) {
 655                 write_enable(flash);
 656                 write_sr(flash, 0);
 657         }
 658
 659         if (data && data->name)
 660                 flash->mtd.name = data->name;
 661         else
 662                 flash->mtd.name = dev_name(&spi->dev);
 663
 664         flash->mtd.type = MTD_NORFLASH;
 665         flash->mtd.writesize = 1;
 666         flash->mtd.flags = MTD_CAP_NORFLASH;
 667         flash->mtd.size = info->sector_size * info->n_sectors;
 668         flash->mtd.erase = m25p80_erase;
 669         flash->mtd.read = m25p80_read;
 670         flash->mtd.write = m25p80_write;
 671
 672         /* prefer "small sector" erase if possible */
 673         if (info->flags & SECT_4K) {
 674                 flash->erase_opcode = OPCODE_BE_4K;
 675                 flash->mtd.erasesize = 4096;
 676         } else {
 677                 flash->erase_opcode = OPCODE_SE;
 678                 flash->mtd.erasesize = info->sector_size;
 679         }
 680
 681         dev_info(&spi->dev, "%s (%lld Kbytes)\n", info->name,
 682                         (long long)flash->mtd.size >> 10);
 683
 684         DEBUG(MTD_DEBUG_LEVEL2,
 685                 "mtd .name = %s, .size = 0x%llx (%lldMiB) "
 686                         ".erasesize = 0x%.8x (%uKiB) .numeraseregions = %d\n",
 687                 flash->mtd.name,
 688                 (long long)flash->mtd.size, (long long)(flash->mtd.size >> 20),
 689                 flash->mtd.erasesize, flash->mtd.erasesize / 1024,
 690                 flash->mtd.numeraseregions);
 691
 692         if (flash->mtd.numeraseregions)
 693                 for (i = 0; i < flash->mtd.numeraseregions; i++)
 694                         DEBUG(MTD_DEBUG_LEVEL2,
 695                                 "mtd.eraseregions[%d] = { .offset = 0x%llx, "
 696                                 ".erasesize = 0x%.8x (%uKiB), "
 697                                 ".numblocks = %d }\n",
 698                                 i, (long long)flash->mtd.eraseregions[i].offset,
 699                                 flash->mtd.eraseregions[i].erasesize,
 700                                 flash->mtd.eraseregions[i].erasesize / 1024,
 701                                 flash->mtd.eraseregions[i].numblocks);
 702
 703
 704         /* partitions should match sector boundaries; and it may be good to
 705          * use readonly partitions for writeprotected sectors (BP2..BP0).
 706          */
 707         if (mtd_has_partitions()) {
 708                 struct mtd_partition    *parts = NULL;
 709                 int                     nr_parts = 0;
 710
 711 #ifdef CONFIG_MTD_CMDLINE_PARTS
 712                 static const char *part_probes[] = { "cmdlinepart", NULL, };
 713
 714                 nr_parts = parse_mtd_partitions(&flash->mtd,
 715                                 part_probes, &parts, 0);
 716 #endif
 717
 718                 if (nr_parts <= 0 && data && data->parts) {
 719                         parts = data->parts;
 720                         nr_parts = data->nr_parts;
 721                 }
 722
 723                 if (nr_parts > 0) {
 724                         for (i = 0; i < nr_parts; i++) {
 725                                 DEBUG(MTD_DEBUG_LEVEL2, "partitions[%d] = "
 726                                         "{.name = %s, .offset = 0x%llx, "
 727                                                 ".size = 0x%llx (%lldKiB) }\n",
 728                                         i, parts[i].name,
 729                                         (long long)parts[i].offset,
 730                                         (long long)parts[i].size,
 731                                         (long long)(parts[i].size >> 10));
 732                         }
 733                         flash->partitioned = 1;
 734                         return add_mtd_partitions(&flash->mtd, parts, nr_parts);
 735                 }
 736         } else if (data->nr_parts)
 737                 dev_warn(&spi->dev, "ignoring %d default partitions on %s\n",
 738                                 data->nr_parts, data->name);
 739
 740         return add_mtd_device(&flash->mtd) == 1 ? -ENODEV : 0;
 741 }
 742
 743
 744 static int __devexit m25p_remove(struct spi_device *spi)
 745 {
 746         struct m25p     *flash = dev_get_drvdata(&spi->dev);
 747         int             status;
 748
 749         /* Clean up MTD stuff. */
 750         if (mtd_has_partitions() && flash->partitioned)
 751                 status = del_mtd_partitions(&flash->mtd);
 752         else
 753                 status = del_mtd_device(&flash->mtd);
 754         if (status == 0)
 755                 kfree(flash);
 756         return 0;
 757 }
 758
 759
 760 static struct spi_driver m25p80_driver = {
 761         .driver = {
 762                 .name   = "m25p80",
 763                 .bus    = &spi_bus_type,
 764                 .owner  = THIS_MODULE,
 765         },
 766         .probe  = m25p_probe,
 767         .remove = __devexit_p(m25p_remove),
 768
 769         /* REVISIT: many of these chips have deep power-down modes, which
 770          * should clearly be entered on suspend() to minimize power use.
 771          * And also when they're otherwise idle...
 772          */
 773 };
 774
 775
 776 static int m25p80_init(void)
 777 {
 778         return spi_register_driver(&m25p80_driver);
 779 }
 780
 781
 782 static void m25p80_exit(void)
 783 {
 784         spi_unregister_driver(&m25p80_driver);
 785 }
 786
 787
 788 module_init(m25p80_init);
 789 module_exit(m25p80_exit);
 790
 791 MODULE_LICENSE("GPL");
 792 MODULE_AUTHOR("Mike Lavender");
 793 MODULE_DESCRIPTION("MTD SPI driver for ST M25Pxx flash chips");