drivers/mtd/devices/mtd_dataflash.c

   1 /*
   2  * Atmel AT45xxx DataFlash MTD driver for lightweight SPI framework
   3  *
   4  * Largely derived from at91_dataflash.c:
   5  *  Copyright (C) 2003-2005 SAN People (Pty) Ltd
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version
  10  * 2 of the License, or (at your option) any later version.
  11 */
  12 #include <linux/module.h>
  13 #include <linux/slab.h>
  14 #include <linux/delay.h>
  15 #include <linux/device.h>
  16 #include <linux/mutex.h>
  17 #include <linux/err.h>
  18 #include <linux/math64.h>
  19 #include <linux/of.h>
  20 #include <linux/of_device.h>
  21
  22 #include <linux/spi/spi.h>
  23 #include <linux/spi/flash.h>
  24
  25 #include <linux/mtd/mtd.h>
  26 #include <linux/mtd/partitions.h>
  27
  28 /*
  29  * DataFlash is a kind of SPI flash.  Most AT45 chips have two buffers in
  30  * each chip, which may be used for double buffered I/O; but this driver
  31  * doesn't (yet) use these for any kind of i/o overlap or prefetching.
  32  *
  33  * Sometimes DataFlash is packaged in MMC-format cards, although the
  34  * MMC stack can't (yet?) distinguish between MMC and DataFlash
  35  * protocols during enumeration.
  36  */
  37
  38 /* reads can bypass the buffers */
  39 #define OP_READ_CONTINUOUS      0xE8
  40 #define OP_READ_PAGE            0xD2
  41
  42 /* group B requests can run even while status reports "busy" */
  43 #define OP_READ_STATUS          0xD7    /* group B */
  44
  45 /* move data between host and buffer */
  46 #define OP_READ_BUFFER1         0xD4    /* group B */
  47 #define OP_READ_BUFFER2         0xD6    /* group B */
  48 #define OP_WRITE_BUFFER1        0x84    /* group B */
  49 #define OP_WRITE_BUFFER2        0x87    /* group B */
  50
  51 /* erasing flash */
  52 #define OP_ERASE_PAGE           0x81
  53 #define OP_ERASE_BLOCK          0x50
  54
  55 /* move data between buffer and flash */
  56 #define OP_TRANSFER_BUF1        0x53
  57 #define OP_TRANSFER_BUF2        0x55
  58 #define OP_MREAD_BUFFER1        0xD4
  59 #define OP_MREAD_BUFFER2        0xD6
  60 #define OP_MWERASE_BUFFER1      0x83
  61 #define OP_MWERASE_BUFFER2      0x86
  62 #define OP_MWRITE_BUFFER1       0x88    /* sector must be pre-erased */
  63 #define OP_MWRITE_BUFFER2       0x89    /* sector must be pre-erased */
  64
  65 /* write to buffer, then write-erase to flash */
  66 #define OP_PROGRAM_VIA_BUF1     0x82
  67 #define OP_PROGRAM_VIA_BUF2     0x85
  68
  69 /* compare buffer to flash */
  70 #define OP_COMPARE_BUF1         0x60
  71 #define OP_COMPARE_BUF2         0x61
  72
  73 /* read flash to buffer, then write-erase to flash */
  74 #define OP_REWRITE_VIA_BUF1     0x58
  75 #define OP_REWRITE_VIA_BUF2     0x59
  76
  77 /* newer chips report JEDEC manufacturer and device IDs; chip
  78  * serial number and OTP bits; and per-sector writeprotect.
  79  */
  80 #define OP_READ_ID              0x9F
  81 #define OP_READ_SECURITY        0x77
  82 #define OP_WRITE_SECURITY_REVC  0x9A
  83 #define OP_WRITE_SECURITY       0x9B    /* revision D */
  84
  85
  86 struct dataflash {
  87         uint8_t                 command[4];
  88         char                    name[24];
  89
  90         unsigned short          page_offset;    /* offset in flash address */
  91         unsigned int            page_size;      /* of bytes per page */
  92
  93         struct mutex            lock;
  94         struct spi_device       *spi;
  95
  96         struct mtd_info         mtd;
  97 };
  98
  99 #ifdef CONFIG_OF
 100 static const struct of_device_id dataflash_dt_ids[] = {
 101         { .compatible = "atmel,at45", },
 102         { .compatible = "atmel,dataflash", },
 103         { /* sentinel */ }
 104 };
 105 MODULE_DEVICE_TABLE(of, dataflash_dt_ids);
 106 #endif
 107
 108 /* ......................................................................... */
 109
 110 /*
 111  * Return the status of the DataFlash device.
 112  */
 113 static inline int dataflash_status(struct spi_device *spi)
 114 {
 115         /* NOTE:  at45db321c over 25 MHz wants to write
 116          * a dummy byte after the opcode...
 117          */
 118         return spi_w8r8(spi, OP_READ_STATUS);
 119 }
 120
 121 /*
 122  * Poll the DataFlash device until it is READY.
 123  * This usually takes 5-20 msec or so; more for sector erase.
 124  */
 125 static int dataflash_waitready(struct spi_device *spi)
 126 {
 127         int     status;
 128
 129         for (;;) {
 130                 status = dataflash_status(spi);
 131                 if (status < 0) {
 132                         pr_debug("%s: status %d?\n",
 133                                         dev_name(&spi->dev), status);
 134                         status = 0;
 135                 }
 136
 137                 if (status & (1 << 7))  /* RDY/nBSY */
 138                         return status;
 139
 140                 msleep(3);
 141         }
 142 }
 143
 144 /* ......................................................................... */
 145
 146 /*
 147  * Erase pages of flash.
 148  */
 149 static int dataflash_erase(struct mtd_info *mtd, struct erase_info *instr)
 150 {
 151         struct dataflash        *priv = mtd->priv;
 152         struct spi_device       *spi = priv->spi;
 153         struct spi_transfer     x = { };
 154         struct spi_message      msg;
 155         unsigned                blocksize = priv->page_size << 3;
 156         uint8_t                 *command;
 157         uint32_t                rem;
 158
 159         pr_debug("%s: erase addr=0x%llx len 0x%llx\n",
 160               dev_name(&spi->dev), (long long)instr->addr,
 161               (long long)instr->len);
 162
 163         div_u64_rem(instr->len, priv->page_size, &rem);
 164         if (rem)
 165                 return -EINVAL;
 166         div_u64_rem(instr->addr, priv->page_size, &rem);
 167         if (rem)
 168                 return -EINVAL;
 169
 170         spi_message_init(&msg);
 171
 172         x.tx_buf = command = priv->command;
 173         x.len = 4;
 174         spi_message_add_tail(&x, &msg);
 175
 176         mutex_lock(&priv->lock);
 177         while (instr->len > 0) {
 178                 unsigned int    pageaddr;
 179                 int             status;
 180                 int             do_block;
 181
 182                 /* Calculate flash page address; use block erase (for speed) if
 183                  * we're at a block boundary and need to erase the whole block.
 184                  */
 185                 pageaddr = div_u64(instr->addr, priv->page_size);
 186                 do_block = (pageaddr & 0x7) == 0 && instr->len >= blocksize;
 187                 pageaddr = pageaddr << priv->page_offset;
 188
 189                 command[0] = do_block ? OP_ERASE_BLOCK : OP_ERASE_PAGE;
 190                 command[1] = (uint8_t)(pageaddr >> 16);
 191                 command[2] = (uint8_t)(pageaddr >> 8);
 192                 command[3] = 0;
 193
 194                 pr_debug("ERASE %s: (%x) %x %x %x [%i]\n",
 195                         do_block ? "block" : "page",
 196                         command[0], command[1], command[2], command[3],
 197                         pageaddr);
 198
 199                 status = spi_sync(spi, &msg);
 200                 (void) dataflash_waitready(spi);
 201
 202                 if (status < 0) {
 203                         printk(KERN_ERR "%s: erase %x, err %d\n",
 204                                 dev_name(&spi->dev), pageaddr, status);
 205                         /* REVISIT:  can retry instr->retries times; or
 206                          * giveup and instr->fail_addr = instr->addr;
 207                          */
 208                         continue;
 209                 }
 210
 211                 if (do_block) {
 212                         instr->addr += blocksize;
 213                         instr->len -= blocksize;
 214                 } else {
 215                         instr->addr += priv->page_size;
 216                         instr->len -= priv->page_size;
 217                 }
 218         }
 219         mutex_unlock(&priv->lock);
 220
 221         /* Inform MTD subsystem that erase is complete */
 222         instr->state = MTD_ERASE_DONE;
 223         mtd_erase_callback(instr);
 224
 225         return 0;
 226 }
 227
 228 /*
 229  * Read from the DataFlash device.
 230  *   from   : Start offset in flash device
 231  *   len    : Amount to read
 232  *   retlen : About of data actually read
 233  *   buf    : Buffer containing the data
 234  */
 235 static int dataflash_read(struct mtd_info *mtd, loff_t from, size_t len,
 236                                size_t *retlen, u_char *buf)
 237 {
 238         struct dataflash        *priv = mtd->priv;
 239         struct spi_transfer     x[2] = { };
 240         struct spi_message      msg;
 241         unsigned int            addr;
 242         uint8_t                 *command;
 243         int                     status;
 244
 245         pr_debug("%s: read 0x%x..0x%x\n", dev_name(&priv->spi->dev),
 246                         (unsigned)from, (unsigned)(from + len));
 247
 248         /* Calculate flash page/byte address */
 249         addr = (((unsigned)from / priv->page_size) << priv->page_offset)
 250                 + ((unsigned)from % priv->page_size);
 251
 252         command = priv->command;
 253
 254         pr_debug("READ: (%x) %x %x %x\n",
 255                 command[0], command[1], command[2], command[3]);
 256
 257         spi_message_init(&msg);
 258
 259         x[0].tx_buf = command;
 260         x[0].len = 8;
 261         spi_message_add_tail(&x[0], &msg);
 262
 263         x[1].rx_buf = buf;
 264         x[1].len = len;
 265         spi_message_add_tail(&x[1], &msg);
 266
 267         mutex_lock(&priv->lock);
 268
 269         /* Continuous read, max clock = f(car) which may be less than
 270          * the peak rate available.  Some chips support commands with
 271          * fewer "don't care" bytes.  Both buffers stay unchanged.
 272          */
 273         command[0] = OP_READ_CONTINUOUS;
 274         command[1] = (uint8_t)(addr >> 16);
 275         command[2] = (uint8_t)(addr >> 8);
 276         command[3] = (uint8_t)(addr >> 0);
 277         /* plus 4 "don't care" bytes */
 278
 279         status = spi_sync(priv->spi, &msg);
 280         mutex_unlock(&priv->lock);
 281
 282         if (status >= 0) {
 283                 *retlen = msg.actual_length - 8;
 284                 status = 0;
 285         } else
 286                 pr_debug("%s: read %x..%x --> %d\n",
 287                         dev_name(&priv->spi->dev),
 288                         (unsigned)from, (unsigned)(from + len),
 289                         status);
 290         return status;
 291 }
 292
 293 /*
 294  * Write to the DataFlash device.
 295  *   to     : Start offset in flash device
 296  *   len    : Amount to write
 297  *   retlen : Amount of data actually written
 298  *   buf    : Buffer containing the data
 299  */
 300 static int dataflash_write(struct mtd_info *mtd, loff_t to, size_t len,
 301                                 size_t * retlen, const u_char * buf)
 302 {
 303         struct dataflash        *priv = mtd->priv;
 304         struct spi_device       *spi = priv->spi;
 305         struct spi_transfer     x[2] = { };
 306         struct spi_message      msg;
 307         unsigned int            pageaddr, addr, offset, writelen;
 308         size_t                  remaining = len;
 309         u_char                  *writebuf = (u_char *) buf;
 310         int                     status = -EINVAL;
 311         uint8_t                 *command;
 312
 313         pr_debug("%s: write 0x%x..0x%x\n",
 314                 dev_name(&spi->dev), (unsigned)to, (unsigned)(to + len));
 315
 316         spi_message_init(&msg);
 317
 318         x[0].tx_buf = command = priv->command;
 319         x[0].len = 4;
 320         spi_message_add_tail(&x[0], &msg);
 321
 322         pageaddr = ((unsigned)to / priv->page_size);
 323         offset = ((unsigned)to % priv->page_size);
 324         if (offset + len > priv->page_size)
 325                 writelen = priv->page_size - offset;
 326         else
 327                 writelen = len;
 328
 329         mutex_lock(&priv->lock);
 330         while (remaining > 0) {
 331                 pr_debug("write @ %i:%i len=%i\n",
 332                         pageaddr, offset, writelen);
 333
 334                 /* REVISIT:
 335                  * (a) each page in a sector must be rewritten at least
 336                  *     once every 10K sibling erase/program operations.
 337                  * (b) for pages that are already erased, we could
 338                  *     use WRITE+MWRITE not PROGRAM for ~30% speedup.
 339                  * (c) WRITE to buffer could be done while waiting for
 340                  *     a previous MWRITE/MWERASE to complete ...
 341                  * (d) error handling here seems to be mostly missing.
 342                  *
 343                  * Two persistent bits per page, plus a per-sector counter,
 344                  * could support (a) and (b) ... we might consider using
 345                  * the second half of sector zero, which is just one block,
 346                  * to track that state.  (On AT91, that sector should also
 347                  * support boot-from-DataFlash.)
 348                  */
 349
 350                 addr = pageaddr << priv->page_offset;
 351
 352                 /* (1) Maybe transfer partial page to Buffer1 */
 353                 if (writelen != priv->page_size) {
 354                         command[0] = OP_TRANSFER_BUF1;
 355                         command[1] = (addr & 0x00FF0000) >> 16;
 356                         command[2] = (addr & 0x0000FF00) >> 8;
 357                         command[3] = 0;
 358
 359                         pr_debug("TRANSFER: (%x) %x %x %x\n",
 360                                 command[0], command[1], command[2], command[3]);
 361
 362                         status = spi_sync(spi, &msg);
 363                         if (status < 0)
 364                                 pr_debug("%s: xfer %u -> %d\n",
 365                                         dev_name(&spi->dev), addr, status);
 366
 367                         (void) dataflash_waitready(priv->spi);
 368                 }
 369
 370                 /* (2) Program full page via Buffer1 */
 371                 addr += offset;
 372                 command[0] = OP_PROGRAM_VIA_BUF1;
 373                 command[1] = (addr & 0x00FF0000) >> 16;
 374                 command[2] = (addr & 0x0000FF00) >> 8;
 375                 command[3] = (addr & 0x000000FF);
 376
 377                 pr_debug("PROGRAM: (%x) %x %x %x\n",
 378                         command[0], command[1], command[2], command[3]);
 379
 380                 x[1].tx_buf = writebuf;
 381                 x[1].len = writelen;
 382                 spi_message_add_tail(x + 1, &msg);
 383                 status = spi_sync(spi, &msg);
 384                 spi_transfer_del(x + 1);
 385                 if (status < 0)
 386                         pr_debug("%s: pgm %u/%u -> %d\n",
 387                                 dev_name(&spi->dev), addr, writelen, status);
 388
 389                 (void) dataflash_waitready(priv->spi);
 390
 391
 392 #ifdef CONFIG_MTD_DATAFLASH_WRITE_VERIFY
 393
 394                 /* (3) Compare to Buffer1 */
 395                 addr = pageaddr << priv->page_offset;
 396                 command[0] = OP_COMPARE_BUF1;
 397                 command[1] = (addr & 0x00FF0000) >> 16;
 398                 command[2] = (addr & 0x0000FF00) >> 8;
 399                 command[3] = 0;
 400
 401                 pr_debug("COMPARE: (%x) %x %x %x\n",
 402                         command[0], command[1], command[2], command[3]);
 403
 404                 status = spi_sync(spi, &msg);
 405                 if (status < 0)
 406                         pr_debug("%s: compare %u -> %d\n",
 407                                 dev_name(&spi->dev), addr, status);
 408
 409                 status = dataflash_waitready(priv->spi);
 410
 411                 /* Check result of the compare operation */
 412                 if (status & (1 << 6)) {
 413                         printk(KERN_ERR "%s: compare page %u, err %d\n",
 414                                 dev_name(&spi->dev), pageaddr, status);
 415                         remaining = 0;
 416                         status = -EIO;
 417                         break;
 418                 } else
 419                         status = 0;
 420
 421 #endif  /* CONFIG_MTD_DATAFLASH_WRITE_VERIFY */
 422
 423                 remaining = remaining - writelen;
 424                 pageaddr++;
 425                 offset = 0;
 426                 writebuf += writelen;
 427                 *retlen += writelen;
 428
 429                 if (remaining > priv->page_size)
 430                         writelen = priv->page_size;
 431                 else
 432                         writelen = remaining;
 433         }
 434         mutex_unlock(&priv->lock);
 435
 436         return status;
 437 }
 438
 439 /* ......................................................................... */
 440
 441 #ifdef CONFIG_MTD_DATAFLASH_OTP
 442
 443 static int dataflash_get_otp_info(struct mtd_info *mtd, size_t len,
 444                                   size_t *retlen, struct otp_info *info)
 445 {
 446         /* Report both blocks as identical:  bytes 0..64, locked.
 447          * Unless the user block changed from all-ones, we can't
 448          * tell whether it's still writable; so we assume it isn't.
 449          */
 450         info->start = 0;
 451         info->length = 64;
 452         info->locked = 1;
 453         *retlen = sizeof(*info);
 454         return 0;
 455 }
 456
 457 static ssize_t otp_read(struct spi_device *spi, unsigned base,
 458                 uint8_t *buf, loff_t off, size_t len)
 459 {
 460         struct spi_message      m;
 461         size_t                  l;
 462         uint8_t                 *scratch;
 463         struct spi_transfer     t;
 464         int                     status;
 465
 466         if (off > 64)
 467                 return -EINVAL;
 468
 469         if ((off + len) > 64)
 470                 len = 64 - off;
 471
 472         spi_message_init(&m);
 473
 474         l = 4 + base + off + len;
 475         scratch = kzalloc(l, GFP_KERNEL);
 476         if (!scratch)
 477                 return -ENOMEM;
 478
 479         /* OUT: OP_READ_SECURITY, 3 don't-care bytes, zeroes
 480          * IN:  ignore 4 bytes, data bytes 0..N (max 127)
 481          */
 482         scratch[0] = OP_READ_SECURITY;
 483
 484         memset(&t, 0, sizeof t);
 485         t.tx_buf = scratch;
 486         t.rx_buf = scratch;
 487         t.len = l;
 488         spi_message_add_tail(&t, &m);
 489
 490         dataflash_waitready(spi);
 491
 492         status = spi_sync(spi, &m);
 493         if (status >= 0) {
 494                 memcpy(buf, scratch + 4 + base + off, len);
 495                 status = len;
 496         }
 497
 498         kfree(scratch);
 499         return status;
 500 }
 501
 502 static int dataflash_read_fact_otp(struct mtd_info *mtd,
 503                 loff_t from, size_t len, size_t *retlen, u_char *buf)
 504 {
 505         struct dataflash        *priv = mtd->priv;
 506         int                     status;
 507
 508         /* 64 bytes, from 0..63 ... start at 64 on-chip */
 509         mutex_lock(&priv->lock);
 510         status = otp_read(priv->spi, 64, buf, from, len);
 511         mutex_unlock(&priv->lock);
 512
 513         if (status < 0)
 514                 return status;
 515         *retlen = status;
 516         return 0;
 517 }
 518
 519 static int dataflash_read_user_otp(struct mtd_info *mtd,
 520                 loff_t from, size_t len, size_t *retlen, u_char *buf)
 521 {
 522         struct dataflash        *priv = mtd->priv;
 523         int                     status;
 524
 525         /* 64 bytes, from 0..63 ... start at 0 on-chip */
 526         mutex_lock(&priv->lock);
 527         status = otp_read(priv->spi, 0, buf, from, len);
 528         mutex_unlock(&priv->lock);
 529
 530         if (status < 0)
 531                 return status;
 532         *retlen = status;
 533         return 0;
 534 }
 535
 536 static int dataflash_write_user_otp(struct mtd_info *mtd,
 537                 loff_t from, size_t len, size_t *retlen, u_char *buf)
 538 {
 539         struct spi_message      m;
 540         const size_t            l = 4 + 64;
 541         uint8_t                 *scratch;
 542         struct spi_transfer     t;
 543         struct dataflash        *priv = mtd->priv;
 544         int                     status;
 545
 546         if (from >= 64) {
 547                 /*
 548                  * Attempting to write beyond the end of OTP memory,
 549                  * no data can be written.
 550                  */
 551                 *retlen = 0;
 552                 return 0;
 553         }
 554
 555         /* Truncate the write to fit into OTP memory. */
 556         if ((from + len) > 64)
 557                 len = 64 - from;
 558
 559         /* OUT: OP_WRITE_SECURITY, 3 zeroes, 64 data-or-zero bytes
 560          * IN:  ignore all
 561          */
 562         scratch = kzalloc(l, GFP_KERNEL);
 563         if (!scratch)
 564                 return -ENOMEM;
 565         scratch[0] = OP_WRITE_SECURITY;
 566         memcpy(scratch + 4 + from, buf, len);
 567
 568         spi_message_init(&m);
 569
 570         memset(&t, 0, sizeof t);
 571         t.tx_buf = scratch;
 572         t.len = l;
 573         spi_message_add_tail(&t, &m);
 574
 575         /* Write the OTP bits, if they've not yet been written.
 576          * This modifies SRAM buffer1.
 577          */
 578         mutex_lock(&priv->lock);
 579         dataflash_waitready(priv->spi);
 580         status = spi_sync(priv->spi, &m);
 581         mutex_unlock(&priv->lock);
 582
 583         kfree(scratch);
 584
 585         if (status >= 0) {
 586                 status = 0;
 587                 *retlen = len;
 588         }
 589         return status;
 590 }
 591
 592 static char *otp_setup(struct mtd_info *device, char revision)
 593 {
 594         device->_get_fact_prot_info = dataflash_get_otp_info;
 595         device->_read_fact_prot_reg = dataflash_read_fact_otp;
 596         device->_get_user_prot_info = dataflash_get_otp_info;
 597         device->_read_user_prot_reg = dataflash_read_user_otp;
 598
 599         /* rev c parts (at45db321c and at45db1281 only!) use a
 600          * different write procedure; not (yet?) implemented.
 601          */
 602         if (revision > 'c')
 603                 device->_write_user_prot_reg = dataflash_write_user_otp;
 604
 605         return ", OTP";
 606 }
 607
 608 #else
 609
 610 static char *otp_setup(struct mtd_info *device, char revision)
 611 {
 612         return " (OTP)";
 613 }
 614
 615 #endif
 616
 617 /* ......................................................................... */
 618
 619 /*
 620  * Register DataFlash device with MTD subsystem.
 621  */
 622 static int add_dataflash_otp(struct spi_device *spi, char *name, int nr_pages,
 623                              int pagesize, int pageoffset, char revision)
 624 {
 625         struct dataflash                *priv;
 626         struct mtd_info                 *device;
 627         struct mtd_part_parser_data     ppdata;
 628         struct flash_platform_data      *pdata = dev_get_platdata(&spi->dev);
 629         char                            *otp_tag = "";
 630         int                             err = 0;
 631
 632         priv = kzalloc(sizeof *priv, GFP_KERNEL);
 633         if (!priv)
 634                 return -ENOMEM;
 635
 636         mutex_init(&priv->lock);
 637         priv->spi = spi;
 638         priv->page_size = pagesize;
 639         priv->page_offset = pageoffset;
 640
 641         /* name must be usable with cmdlinepart */
 642         sprintf(priv->name, "spi%d.%d-%s",
 643                         spi->master->bus_num, spi->chip_select,
 644                         name);
 645
 646         device = &priv->mtd;
 647         device->name = (pdata && pdata->name) ? pdata->name : priv->name;
 648         device->size = nr_pages * pagesize;
 649         device->erasesize = pagesize;
 650         device->writesize = pagesize;
 651         device->type = MTD_DATAFLASH;
 652         device->flags = MTD_WRITEABLE;
 653         device->_erase = dataflash_erase;
 654         device->_read = dataflash_read;
 655         device->_write = dataflash_write;
 656         device->priv = priv;
 657
 658         device->dev.parent = &spi->dev;
 659
 660         if (revision >= 'c')
 661                 otp_tag = otp_setup(device, revision);
 662
 663         dev_info(&spi->dev, "%s (%lld KBytes) pagesize %d bytes%s\n",
 664                         name, (long long)((device->size + 1023) >> 10),
 665                         pagesize, otp_tag);
 666         spi_set_drvdata(spi, priv);
 667
 668         ppdata.of_node = spi->dev.of_node;
 669         err = mtd_device_parse_register(device, NULL, &ppdata,
 670                         pdata ? pdata->parts : NULL,
 671                         pdata ? pdata->nr_parts : 0);
 672
 673         if (!err)
 674                 return 0;
 675
 676         kfree(priv);
 677         return err;
 678 }
 679
 680 static inline int add_dataflash(struct spi_device *spi, char *name,
 681                                 int nr_pages, int pagesize, int pageoffset)
 682 {
 683         return add_dataflash_otp(spi, name, nr_pages, pagesize,
 684                         pageoffset, 0);
 685 }
 686
 687 struct flash_info {
 688         char            *name;
 689
 690         /* JEDEC id has a high byte of zero plus three data bytes:
 691          * the manufacturer id, then a two byte device id.
 692          */
 693         uint32_t        jedec_id;
 694
 695         /* The size listed here is what works with OP_ERASE_PAGE. */
 696         unsigned        nr_pages;
 697         uint16_t        pagesize;
 698         uint16_t        pageoffset;
 699
 700         uint16_t        flags;
 701 #define SUP_POW2PS      0x0002          /* supports 2^N byte pages */
 702 #define IS_POW2PS       0x0001          /* uses 2^N byte pages */
 703 };
 704
 705 static struct flash_info dataflash_data[] = {
 706
 707         /*
 708          * NOTE:  chips with SUP_POW2PS (rev D and up) need two entries,
 709          * one with IS_POW2PS and the other without.  The entry with the
 710          * non-2^N byte page size can't name exact chip revisions without
 711          * losing backwards compatibility for cmdlinepart.
 712          *
 713          * These newer chips also support 128-byte security registers (with
 714          * 64 bytes one-time-programmable) and software write-protection.
 715          */
 716         { "AT45DB011B",  0x1f2200, 512, 264, 9, SUP_POW2PS},
 717         { "at45db011d",  0x1f2200, 512, 256, 8, SUP_POW2PS | IS_POW2PS},
 718
 719         { "AT45DB021B",  0x1f2300, 1024, 264, 9, SUP_POW2PS},
 720         { "at45db021d",  0x1f2300, 1024, 256, 8, SUP_POW2PS | IS_POW2PS},
 721
 722         { "AT45DB041x",  0x1f2400, 2048, 264, 9, SUP_POW2PS},
 723         { "at45db041d",  0x1f2400, 2048, 256, 8, SUP_POW2PS | IS_POW2PS},
 724
 725         { "AT45DB081B",  0x1f2500, 4096, 264, 9, SUP_POW2PS},
 726         { "at45db081d",  0x1f2500, 4096, 256, 8, SUP_POW2PS | IS_POW2PS},
 727
 728         { "AT45DB161x",  0x1f2600, 4096, 528, 10, SUP_POW2PS},
 729         { "at45db161d",  0x1f2600, 4096, 512, 9, SUP_POW2PS | IS_POW2PS},
 730
 731         { "AT45DB321x",  0x1f2700, 8192, 528, 10, 0},           /* rev C */
 732
 733         { "AT45DB321x",  0x1f2701, 8192, 528, 10, SUP_POW2PS},
 734         { "at45db321d",  0x1f2701, 8192, 512, 9, SUP_POW2PS | IS_POW2PS},
 735
 736         { "AT45DB642x",  0x1f2800, 8192, 1056, 11, SUP_POW2PS},
 737         { "at45db642d",  0x1f2800, 8192, 1024, 10, SUP_POW2PS | IS_POW2PS},
 738 };
 739
 740 static struct flash_info *jedec_probe(struct spi_device *spi)
 741 {
 742         int                     tmp;
 743         uint8_t                 code = OP_READ_ID;
 744         uint8_t                 id[3];
 745         uint32_t                jedec;
 746         struct flash_info       *info;
 747         int status;
 748
 749         /* JEDEC also defines an optional "extended device information"
 750          * string for after vendor-specific data, after the three bytes
 751          * we use here.  Supporting some chips might require using it.
 752          *
 753          * If the vendor ID isn't Atmel's (0x1f), assume this call failed.
 754          * That's not an error; only rev C and newer chips handle it, and
 755          * only Atmel sells these chips.
 756          */
 757         tmp = spi_write_then_read(spi, &code, 1, id, 3);
 758         if (tmp < 0) {
 759                 pr_debug("%s: error %d reading JEDEC ID\n",
 760                         dev_name(&spi->dev), tmp);
 761                 return ERR_PTR(tmp);
 762         }
 763         if (id[0] != 0x1f)
 764                 return NULL;
 765
 766         jedec = id[0];
 767         jedec = jedec << 8;
 768         jedec |= id[1];
 769         jedec = jedec << 8;
 770         jedec |= id[2];
 771
 772         for (tmp = 0, info = dataflash_data;
 773                         tmp < ARRAY_SIZE(dataflash_data);
 774                         tmp++, info++) {
 775                 if (info->jedec_id == jedec) {
 776                         pr_debug("%s: OTP, sector protect%s\n",
 777                                 dev_name(&spi->dev),
 778                                 (info->flags & SUP_POW2PS)
 779                                         ? ", binary pagesize" : ""
 780                                 );
 781                         if (info->flags & SUP_POW2PS) {
 782                                 status = dataflash_status(spi);
 783                                 if (status < 0) {
 784                                         pr_debug("%s: status error %d\n",
 785                                                 dev_name(&spi->dev), status);
 786                                         return ERR_PTR(status);
 787                                 }
 788                                 if (status & 0x1) {
 789                                         if (info->flags & IS_POW2PS)
 790                                                 return info;
 791                                 } else {
 792                                         if (!(info->flags & IS_POW2PS))
 793                                                 return info;
 794                                 }
 795                         } else
 796                                 return info;
 797                 }
 798         }
 799
 800         /*
 801          * Treat other chips as errors ... we won't know the right page
 802          * size (it might be binary) even when we can tell which density
 803          * class is involved (legacy chip id scheme).
 804          */
 805         dev_warn(&spi->dev, "JEDEC id %06x not handled\n", jedec);
 806         return ERR_PTR(-ENODEV);
 807 }
 808
 809 /*
 810  * Detect and initialize DataFlash device, using JEDEC IDs on newer chips
 811  * or else the ID code embedded in the status bits:
 812  *
 813  *   Device      Density         ID code          #Pages PageSize  Offset
 814  *   AT45DB011B  1Mbit   (128K)  xx0011xx (0x0c)    512    264      9
 815  *   AT45DB021B  2Mbit   (256K)  xx0101xx (0x14)   1024    264      9
 816  *   AT45DB041B  4Mbit   (512K)  xx0111xx (0x1c)   2048    264      9
 817  *   AT45DB081B  8Mbit   (1M)    xx1001xx (0x24)   4096    264      9
 818  *   AT45DB0161B 16Mbit  (2M)    xx1011xx (0x2c)   4096    528     10
 819  *   AT45DB0321B 32Mbit  (4M)    xx1101xx (0x34)   8192    528     10
 820  *   AT45DB0642  64Mbit  (8M)    xx111xxx (0x3c)   8192   1056     11
 821  *   AT45DB1282  128Mbit (16M)   xx0100xx (0x10)  16384   1056     11
 822  */
 823 static int dataflash_probe(struct spi_device *spi)
 824 {
 825         int status;
 826         struct flash_info       *info;
 827
 828         /*
 829          * Try to detect dataflash by JEDEC ID.
 830          * If it succeeds we know we have either a C or D part.
 831          * D will support power of 2 pagesize option.
 832          * Both support the security register, though with different
 833          * write procedures.
 834          */
 835         info = jedec_probe(spi);
 836         if (IS_ERR(info))
 837                 return PTR_ERR(info);
 838         if (info != NULL)
 839                 return add_dataflash_otp(spi, info->name, info->nr_pages,
 840                                 info->pagesize, info->pageoffset,
 841                                 (info->flags & SUP_POW2PS) ? 'd' : 'c');
 842
 843         /*
 844          * Older chips support only legacy commands, identifing
 845          * capacity using bits in the status byte.
 846          */
 847         status = dataflash_status(spi);
 848         if (status <= 0 || status == 0xff) {
 849                 pr_debug("%s: status error %d\n",
 850                                 dev_name(&spi->dev), status);
 851                 if (status == 0 || status == 0xff)
 852                         status = -ENODEV;
 853                 return status;
 854         }
 855
 856         /* if there's a device there, assume it's dataflash.
 857          * board setup should have set spi->max_speed_max to
 858          * match f(car) for continuous reads, mode 0 or 3.
 859          */
 860         switch (status & 0x3c) {
 861         case 0x0c:      /* 0 0 1 1 x x */
 862                 status = add_dataflash(spi, "AT45DB011B", 512, 264, 9);
 863                 break;
 864         case 0x14:      /* 0 1 0 1 x x */
 865                 status = add_dataflash(spi, "AT45DB021B", 1024, 264, 9);
 866                 break;
 867         case 0x1c:      /* 0 1 1 1 x x */
 868                 status = add_dataflash(spi, "AT45DB041x", 2048, 264, 9);
 869                 break;
 870         case 0x24:      /* 1 0 0 1 x x */
 871                 status = add_dataflash(spi, "AT45DB081B", 4096, 264, 9);
 872                 break;
 873         case 0x2c:      /* 1 0 1 1 x x */
 874                 status = add_dataflash(spi, "AT45DB161x", 4096, 528, 10);
 875                 break;
 876         case 0x34:      /* 1 1 0 1 x x */
 877                 status = add_dataflash(spi, "AT45DB321x", 8192, 528, 10);
 878                 break;
 879         case 0x38:      /* 1 1 1 x x x */
 880         case 0x3c:
 881                 status = add_dataflash(spi, "AT45DB642x", 8192, 1056, 11);
 882                 break;
 883         /* obsolete AT45DB1282 not (yet?) supported */
 884         default:
 885                 dev_info(&spi->dev, "unsupported device (%x)\n",
 886                                 status & 0x3c);
 887                 status = -ENODEV;
 888         }
 889
 890         if (status < 0)
 891                 pr_debug("%s: add_dataflash --> %d\n", dev_name(&spi->dev),
 892                                 status);
 893
 894         return status;
 895 }
 896
 897 static int dataflash_remove(struct spi_device *spi)
 898 {
 899         struct dataflash        *flash = spi_get_drvdata(spi);
 900         int                     status;
 901
 902         pr_debug("%s: remove\n", dev_name(&spi->dev));
 903
 904         status = mtd_device_unregister(&flash->mtd);
 905         if (status == 0)
 906                 kfree(flash);
 907         return status;
 908 }
 909
 910 static struct spi_driver dataflash_driver = {
 911         .driver = {
 912                 .name           = "mtd_dataflash",
 913                 .of_match_table = of_match_ptr(dataflash_dt_ids),
 914         },
 915
 916         .probe          = dataflash_probe,
 917         .remove         = dataflash_remove,
 918
 919         /* FIXME:  investigate suspend and resume... */
 920 };
 921
 922 module_spi_driver(dataflash_driver);
 923
 924 MODULE_LICENSE("GPL");
 925 MODULE_AUTHOR("Andrew Victor, David Brownell");
 926 MODULE_DESCRIPTION("MTD DataFlash driver");
 927 MODULE_ALIAS("spi:mtd_dataflash");