drivers/mtd/nand/gpmi-nand/gpmi-nand.c

   1 /*
   2  * Freescale GPMI NAND Flash Driver
   3  *
   4  * Copyright (C) 2010-2011 Freescale Semiconductor, Inc.
   5  * Copyright (C) 2008 Embedded Alley Solutions, Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21 #include <linux/clk.h>
  22 #include <linux/slab.h>
  23 #include <linux/interrupt.h>
  24 #include <linux/module.h>
  25 #include <linux/mtd/gpmi-nand.h>
  26 #include <linux/mtd/partitions.h>
  27 #include <linux/of.h>
  28 #include <linux/of_device.h>
  29 #include "gpmi-nand.h"
  30
  31 /* add our owner bbt descriptor */
  32 static uint8_t scan_ff_pattern[] = { 0xff };
  33 static struct nand_bbt_descr gpmi_bbt_descr = {
  34         .options        = 0,
  35         .offs           = 0,
  36         .len            = 1,
  37         .pattern        = scan_ff_pattern
  38 };
  39
  40 /*  We will use all the (page + OOB). */
  41 static struct nand_ecclayout gpmi_hw_ecclayout = {
  42         .eccbytes = 0,
  43         .eccpos = { 0, },
  44         .oobfree = { {.offset = 0, .length = 0} }
  45 };
  46
  47 static irqreturn_t bch_irq(int irq, void *cookie)
  48 {
  49         struct gpmi_nand_data *this = cookie;
  50
  51         gpmi_clear_bch(this);
  52         complete(&this->bch_done);
  53         return IRQ_HANDLED;
  54 }
  55
  56 /*
  57  *  Calculate the ECC strength by hand:
  58  *      E : The ECC strength.
  59  *      G : the length of Galois Field.
  60  *      N : The chunk count of per page.
  61  *      O : the oobsize of the NAND chip.
  62  *      M : the metasize of per page.
  63  *
  64  *      The formula is :
  65  *              E * G * N
  66  *            ------------ <= (O - M)
  67  *                  8
  68  *
  69  *      So, we get E by:
  70  *                    (O - M) * 8
  71  *              E <= -------------
  72  *                       G * N
  73  */
  74 static inline int get_ecc_strength(struct gpmi_nand_data *this)
  75 {
  76         struct bch_geometry *geo = &this->bch_geometry;
  77         struct mtd_info *mtd = &this->mtd;
  78         int ecc_strength;
  79
  80         ecc_strength = ((mtd->oobsize - geo->metadata_size) * 8)
  81                         / (geo->gf_len * geo->ecc_chunk_count);
  82
  83         /* We need the minor even number. */
  84         return round_down(ecc_strength, 2);
  85 }
  86
  87 int common_nfc_set_geometry(struct gpmi_nand_data *this)
  88 {
  89         struct bch_geometry *geo = &this->bch_geometry;
  90         struct mtd_info *mtd = &this->mtd;
  91         unsigned int metadata_size;
  92         unsigned int status_size;
  93         unsigned int block_mark_bit_offset;
  94
  95         /*
  96          * The size of the metadata can be changed, though we set it to 10
  97          * bytes now. But it can't be too large, because we have to save
  98          * enough space for BCH.
  99          */
 100         geo->metadata_size = 10;
 101
 102         /* The default for the length of Galois Field. */
 103         geo->gf_len = 13;
 104
 105         /* The default for chunk size. There is no oobsize greater then 512. */
 106         geo->ecc_chunk_size = 512;
 107         while (geo->ecc_chunk_size < mtd->oobsize)
 108                 geo->ecc_chunk_size *= 2; /* keep C >= O */
 109
 110         geo->ecc_chunk_count = mtd->writesize / geo->ecc_chunk_size;
 111
 112         /* We use the same ECC strength for all chunks. */
 113         geo->ecc_strength = get_ecc_strength(this);
 114         if (!geo->ecc_strength) {
 115                 pr_err("We get a wrong ECC strength.\n");
 116                 return -EINVAL;
 117         }
 118
 119         geo->page_size = mtd->writesize + mtd->oobsize;
 120         geo->payload_size = mtd->writesize;
 121
 122         /*
 123          * The auxiliary buffer contains the metadata and the ECC status. The
 124          * metadata is padded to the nearest 32-bit boundary. The ECC status
 125          * contains one byte for every ECC chunk, and is also padded to the
 126          * nearest 32-bit boundary.
 127          */
 128         metadata_size = ALIGN(geo->metadata_size, 4);
 129         status_size   = ALIGN(geo->ecc_chunk_count, 4);
 130
 131         geo->auxiliary_size = metadata_size + status_size;
 132         geo->auxiliary_status_offset = metadata_size;
 133
 134         if (!this->swap_block_mark)
 135                 return 0;
 136
 137         /*
 138          * We need to compute the byte and bit offsets of
 139          * the physical block mark within the ECC-based view of the page.
 140          *
 141          * NAND chip with 2K page shows below:
 142          *                                             (Block Mark)
 143          *                                                   |      |
 144          *                                                   |  D   |
 145          *                                                   |<---->|
 146          *                                                   V      V
 147          *    +---+----------+-+----------+-+----------+-+----------+-+
 148          *    | M |   data   |E|   data   |E|   data   |E|   data   |E|
 149          *    +---+----------+-+----------+-+----------+-+----------+-+
 150          *
 151          * The position of block mark moves forward in the ECC-based view
 152          * of page, and the delta is:
 153          *
 154          *                   E * G * (N - 1)
 155          *             D = (---------------- + M)
 156          *                          8
 157          *
 158          * With the formula to compute the ECC strength, and the condition
 159          *       : C >= O         (C is the ecc chunk size)
 160          *
 161          * It's easy to deduce to the following result:
 162          *
 163          *         E * G       (O - M)      C - M         C - M
 164          *      ----------- <= ------- <=  --------  <  ---------
 165          *           8            N           N          (N - 1)
 166          *
 167          *  So, we get:
 168          *
 169          *                   E * G * (N - 1)
 170          *             D = (---------------- + M) < C
 171          *                          8
 172          *
 173          *  The above inequality means the position of block mark
 174          *  within the ECC-based view of the page is still in the data chunk,
 175          *  and it's NOT in the ECC bits of the chunk.
 176          *
 177          *  Use the following to compute the bit position of the
 178          *  physical block mark within the ECC-based view of the page:
 179          *          (page_size - D) * 8
 180          *
 181          *  --Huang Shijie
 182          */
 183         block_mark_bit_offset = mtd->writesize * 8 -
 184                 (geo->ecc_strength * geo->gf_len * (geo->ecc_chunk_count - 1)
 185                                 + geo->metadata_size * 8);
 186
 187         geo->block_mark_byte_offset = block_mark_bit_offset / 8;
 188         geo->block_mark_bit_offset  = block_mark_bit_offset % 8;
 189         return 0;
 190 }
 191
 192 struct dma_chan *get_dma_chan(struct gpmi_nand_data *this)
 193 {
 194         int chipnr = this->current_chip;
 195
 196         return this->dma_chans[chipnr];
 197 }
 198
 199 /* Can we use the upper's buffer directly for DMA? */
 200 void prepare_data_dma(struct gpmi_nand_data *this, enum dma_data_direction dr)
 201 {
 202         struct scatterlist *sgl = &this->data_sgl;
 203         int ret;
 204
 205         this->direct_dma_map_ok = true;
 206
 207         /* first try to map the upper buffer directly */
 208         sg_init_one(sgl, this->upper_buf, this->upper_len);
 209         ret = dma_map_sg(this->dev, sgl, 1, dr);
 210         if (ret == 0) {
 211                 /* We have to use our own DMA buffer. */
 212                 sg_init_one(sgl, this->data_buffer_dma, PAGE_SIZE);
 213
 214                 if (dr == DMA_TO_DEVICE)
 215                         memcpy(this->data_buffer_dma, this->upper_buf,
 216                                 this->upper_len);
 217
 218                 ret = dma_map_sg(this->dev, sgl, 1, dr);
 219                 if (ret == 0)
 220                         pr_err("map failed.\n");
 221
 222                 this->direct_dma_map_ok = false;
 223         }
 224 }
 225
 226 /* This will be called after the DMA operation is finished. */
 227 static void dma_irq_callback(void *param)
 228 {
 229         struct gpmi_nand_data *this = param;
 230         struct completion *dma_c = &this->dma_done;
 231
 232         complete(dma_c);
 233
 234         switch (this->dma_type) {
 235         case DMA_FOR_COMMAND:
 236                 dma_unmap_sg(this->dev, &this->cmd_sgl, 1, DMA_TO_DEVICE);
 237                 break;
 238
 239         case DMA_FOR_READ_DATA:
 240                 dma_unmap_sg(this->dev, &this->data_sgl, 1, DMA_FROM_DEVICE);
 241                 if (this->direct_dma_map_ok == false)
 242                         memcpy(this->upper_buf, this->data_buffer_dma,
 243                                 this->upper_len);
 244                 break;
 245
 246         case DMA_FOR_WRITE_DATA:
 247                 dma_unmap_sg(this->dev, &this->data_sgl, 1, DMA_TO_DEVICE);
 248                 break;
 249
 250         case DMA_FOR_READ_ECC_PAGE:
 251         case DMA_FOR_WRITE_ECC_PAGE:
 252                 /* We have to wait the BCH interrupt to finish. */
 253                 break;
 254
 255         default:
 256                 pr_err("in wrong DMA operation.\n");
 257         }
 258 }
 259
 260 int start_dma_without_bch_irq(struct gpmi_nand_data *this,
 261                                 struct dma_async_tx_descriptor *desc)
 262 {
 263         struct completion *dma_c = &this->dma_done;
 264         int err;
 265
 266         init_completion(dma_c);
 267
 268         desc->callback          = dma_irq_callback;
 269         desc->callback_param    = this;
 270         dmaengine_submit(desc);
 271         dma_async_issue_pending(get_dma_chan(this));
 272
 273         /* Wait for the interrupt from the DMA block. */
 274         err = wait_for_completion_timeout(dma_c, msecs_to_jiffies(1000));
 275         if (!err) {
 276                 pr_err("DMA timeout, last DMA :%d\n", this->last_dma_type);
 277                 gpmi_dump_info(this);
 278                 return -ETIMEDOUT;
 279         }
 280         return 0;
 281 }
 282
 283 /*
 284  * This function is used in BCH reading or BCH writing pages.
 285  * It will wait for the BCH interrupt as long as ONE second.
 286  * Actually, we must wait for two interrupts :
 287  *      [1] firstly the DMA interrupt and
 288  *      [2] secondly the BCH interrupt.
 289  */
 290 int start_dma_with_bch_irq(struct gpmi_nand_data *this,
 291                         struct dma_async_tx_descriptor *desc)
 292 {
 293         struct completion *bch_c = &this->bch_done;
 294         int err;
 295
 296         /* Prepare to receive an interrupt from the BCH block. */
 297         init_completion(bch_c);
 298
 299         /* start the DMA */
 300         start_dma_without_bch_irq(this, desc);
 301
 302         /* Wait for the interrupt from the BCH block. */
 303         err = wait_for_completion_timeout(bch_c, msecs_to_jiffies(1000));
 304         if (!err) {
 305                 pr_err("BCH timeout, last DMA :%d\n", this->last_dma_type);
 306                 gpmi_dump_info(this);
 307                 return -ETIMEDOUT;
 308         }
 309         return 0;
 310 }
 311
 312 static int __devinit
 313 acquire_register_block(struct gpmi_nand_data *this, const char *res_name)
 314 {
 315         struct platform_device *pdev = this->pdev;
 316         struct resources *res = &this->resources;
 317         struct resource *r;
 318         void *p;
 319
 320         r = platform_get_resource_byname(pdev, IORESOURCE_MEM, res_name);
 321         if (!r) {
 322                 pr_err("Can't get resource for %s\n", res_name);
 323                 return -ENXIO;
 324         }
 325
 326         p = ioremap(r->start, resource_size(r));
 327         if (!p) {
 328                 pr_err("Can't remap %s\n", res_name);
 329                 return -ENOMEM;
 330         }
 331
 332         if (!strcmp(res_name, GPMI_NAND_GPMI_REGS_ADDR_RES_NAME))
 333                 res->gpmi_regs = p;
 334         else if (!strcmp(res_name, GPMI_NAND_BCH_REGS_ADDR_RES_NAME))
 335                 res->bch_regs = p;
 336         else
 337                 pr_err("unknown resource name : %s\n", res_name);
 338
 339         return 0;
 340 }
 341
 342 static void release_register_block(struct gpmi_nand_data *this)
 343 {
 344         struct resources *res = &this->resources;
 345         if (res->gpmi_regs)
 346                 iounmap(res->gpmi_regs);
 347         if (res->bch_regs)
 348                 iounmap(res->bch_regs);
 349         res->gpmi_regs = NULL;
 350         res->bch_regs = NULL;
 351 }
 352
 353 static int __devinit
 354 acquire_bch_irq(struct gpmi_nand_data *this, irq_handler_t irq_h)
 355 {
 356         struct platform_device *pdev = this->pdev;
 357         struct resources *res = &this->resources;
 358         const char *res_name = GPMI_NAND_BCH_INTERRUPT_RES_NAME;
 359         struct resource *r;
 360         int err;
 361
 362         r = platform_get_resource_byname(pdev, IORESOURCE_IRQ, res_name);
 363         if (!r) {
 364                 pr_err("Can't get resource for %s\n", res_name);
 365                 return -ENXIO;
 366         }
 367
 368         err = request_irq(r->start, irq_h, 0, res_name, this);
 369         if (err) {
 370                 pr_err("Can't own %s\n", res_name);
 371                 return err;
 372         }
 373
 374         res->bch_low_interrupt = r->start;
 375         res->bch_high_interrupt = r->end;
 376         return 0;
 377 }
 378
 379 static void release_bch_irq(struct gpmi_nand_data *this)
 380 {
 381         struct resources *res = &this->resources;
 382         int i = res->bch_low_interrupt;
 383
 384         for (; i <= res->bch_high_interrupt; i++)
 385                 free_irq(i, this);
 386 }
 387
 388 static bool gpmi_dma_filter(struct dma_chan *chan, void *param)
 389 {
 390         struct gpmi_nand_data *this = param;
 391         int dma_channel = (int)this->private;
 392
 393         if (!mxs_dma_is_apbh(chan))
 394                 return false;
 395         /*
 396          * only catch the GPMI dma channels :
 397          *      for mx23 :      MX23_DMA_GPMI0 ~ MX23_DMA_GPMI3
 398          *              (These four channels share the same IRQ!)
 399          *
 400          *      for mx28 :      MX28_DMA_GPMI0 ~ MX28_DMA_GPMI7
 401          *              (These eight channels share the same IRQ!)
 402          */
 403         if (dma_channel == chan->chan_id) {
 404                 chan->private = &this->dma_data;
 405                 return true;
 406         }
 407         return false;
 408 }
 409
 410 static void release_dma_channels(struct gpmi_nand_data *this)
 411 {
 412         unsigned int i;
 413         for (i = 0; i < DMA_CHANS; i++)
 414                 if (this->dma_chans[i]) {
 415                         dma_release_channel(this->dma_chans[i]);
 416                         this->dma_chans[i] = NULL;
 417                 }
 418 }
 419
 420 static int __devinit acquire_dma_channels(struct gpmi_nand_data *this)
 421 {
 422         struct platform_device *pdev = this->pdev;
 423         struct resource *r_dma;
 424         struct device_node *dn;
 425         int dma_channel;
 426         unsigned int ret;
 427         struct dma_chan *dma_chan;
 428         dma_cap_mask_t mask;
 429
 430         /* dma channel, we only use the first one. */
 431         dn = pdev->dev.of_node;
 432         ret = of_property_read_u32(dn, "fsl,gpmi-dma-channel", &dma_channel);
 433         if (ret) {
 434                 pr_err("unable to get DMA channel from dt.\n");
 435                 goto acquire_err;
 436         }
 437         this->private = (void *)dma_channel;
 438
 439         /* gpmi dma interrupt */
 440         r_dma = platform_get_resource_byname(pdev, IORESOURCE_IRQ,
 441                                         GPMI_NAND_DMA_INTERRUPT_RES_NAME);
 442         if (!r_dma) {
 443                 pr_err("Can't get resource for DMA\n");
 444                 goto acquire_err;
 445         }
 446         this->dma_data.chan_irq = r_dma->start;
 447
 448         /* request dma channel */
 449         dma_cap_zero(mask);
 450         dma_cap_set(DMA_SLAVE, mask);
 451
 452         dma_chan = dma_request_channel(mask, gpmi_dma_filter, this);
 453         if (!dma_chan) {
 454                 pr_err("dma_request_channel failed.\n");
 455                 goto acquire_err;
 456         }
 457
 458         this->dma_chans[0] = dma_chan;
 459         return 0;
 460
 461 acquire_err:
 462         release_dma_channels(this);
 463         return -EINVAL;
 464 }
 465
 466 static int __devinit acquire_resources(struct gpmi_nand_data *this)
 467 {
 468         struct resources *res = &this->resources;
 469         int ret;
 470
 471         ret = acquire_register_block(this, GPMI_NAND_GPMI_REGS_ADDR_RES_NAME);
 472         if (ret)
 473                 goto exit_regs;
 474
 475         ret = acquire_register_block(this, GPMI_NAND_BCH_REGS_ADDR_RES_NAME);
 476         if (ret)
 477                 goto exit_regs;
 478
 479         ret = acquire_bch_irq(this, bch_irq);
 480         if (ret)
 481                 goto exit_regs;
 482
 483         ret = acquire_dma_channels(this);
 484         if (ret)
 485                 goto exit_dma_channels;
 486
 487         res->clock = clk_get(&this->pdev->dev, NULL);
 488         if (IS_ERR(res->clock)) {
 489                 pr_err("can not get the clock\n");
 490                 ret = -ENOENT;
 491                 goto exit_clock;
 492         }
 493         return 0;
 494
 495 exit_clock:
 496         release_dma_channels(this);
 497 exit_dma_channels:
 498         release_bch_irq(this);
 499 exit_regs:
 500         release_register_block(this);
 501         return ret;
 502 }
 503
 504 static void release_resources(struct gpmi_nand_data *this)
 505 {
 506         struct resources *r = &this->resources;
 507
 508         clk_put(r->clock);
 509         release_register_block(this);
 510         release_bch_irq(this);
 511         release_dma_channels(this);
 512 }
 513
 514 static int __devinit init_hardware(struct gpmi_nand_data *this)
 515 {
 516         int ret;
 517
 518         /*
 519          * This structure contains the "safe" GPMI timing that should succeed
 520          * with any NAND Flash device
 521          * (although, with less-than-optimal performance).
 522          */
 523         struct nand_timing  safe_timing = {
 524                 .data_setup_in_ns        = 80,
 525                 .data_hold_in_ns         = 60,
 526                 .address_setup_in_ns     = 25,
 527                 .gpmi_sample_delay_in_ns =  6,
 528                 .tREA_in_ns              = -1,
 529                 .tRLOH_in_ns             = -1,
 530                 .tRHOH_in_ns             = -1,
 531         };
 532
 533         /* Initialize the hardwares. */
 534         ret = gpmi_init(this);
 535         if (ret)
 536                 return ret;
 537
 538         this->timing = safe_timing;
 539         return 0;
 540 }
 541
 542 static int read_page_prepare(struct gpmi_nand_data *this,
 543                         void *destination, unsigned length,
 544                         void *alt_virt, dma_addr_t alt_phys, unsigned alt_size,
 545                         void **use_virt, dma_addr_t *use_phys)
 546 {
 547         struct device *dev = this->dev;
 548
 549         if (virt_addr_valid(destination)) {
 550                 dma_addr_t dest_phys;
 551
 552                 dest_phys = dma_map_single(dev, destination,
 553                                                 length, DMA_FROM_DEVICE);
 554                 if (dma_mapping_error(dev, dest_phys)) {
 555                         if (alt_size < length) {
 556                                 pr_err("Alternate buffer is too small\n");
 557                                 return -ENOMEM;
 558                         }
 559                         goto map_failed;
 560                 }
 561                 *use_virt = destination;
 562                 *use_phys = dest_phys;
 563                 this->direct_dma_map_ok = true;
 564                 return 0;
 565         }
 566
 567 map_failed:
 568         *use_virt = alt_virt;
 569         *use_phys = alt_phys;
 570         this->direct_dma_map_ok = false;
 571         return 0;
 572 }
 573
 574 static inline void read_page_end(struct gpmi_nand_data *this,
 575                         void *destination, unsigned length,
 576                         void *alt_virt, dma_addr_t alt_phys, unsigned alt_size,
 577                         void *used_virt, dma_addr_t used_phys)
 578 {
 579         if (this->direct_dma_map_ok)
 580                 dma_unmap_single(this->dev, used_phys, length, DMA_FROM_DEVICE);
 581 }
 582
 583 static inline void read_page_swap_end(struct gpmi_nand_data *this,
 584                         void *destination, unsigned length,
 585                         void *alt_virt, dma_addr_t alt_phys, unsigned alt_size,
 586                         void *used_virt, dma_addr_t used_phys)
 587 {
 588         if (!this->direct_dma_map_ok)
 589                 memcpy(destination, alt_virt, length);
 590 }
 591
 592 static int send_page_prepare(struct gpmi_nand_data *this,
 593                         const void *source, unsigned length,
 594                         void *alt_virt, dma_addr_t alt_phys, unsigned alt_size,
 595                         const void **use_virt, dma_addr_t *use_phys)
 596 {
 597         struct device *dev = this->dev;
 598
 599         if (virt_addr_valid(source)) {
 600                 dma_addr_t source_phys;
 601
 602                 source_phys = dma_map_single(dev, (void *)source, length,
 603                                                 DMA_TO_DEVICE);
 604                 if (dma_mapping_error(dev, source_phys)) {
 605                         if (alt_size < length) {
 606                                 pr_err("Alternate buffer is too small\n");
 607                                 return -ENOMEM;
 608                         }
 609                         goto map_failed;
 610                 }
 611                 *use_virt = source;
 612                 *use_phys = source_phys;
 613                 return 0;
 614         }
 615 map_failed:
 616         /*
 617          * Copy the content of the source buffer into the alternate
 618          * buffer and set up the return values accordingly.
 619          */
 620         memcpy(alt_virt, source, length);
 621
 622         *use_virt = alt_virt;
 623         *use_phys = alt_phys;
 624         return 0;
 625 }
 626
 627 static void send_page_end(struct gpmi_nand_data *this,
 628                         const void *source, unsigned length,
 629                         void *alt_virt, dma_addr_t alt_phys, unsigned alt_size,
 630                         const void *used_virt, dma_addr_t used_phys)
 631 {
 632         struct device *dev = this->dev;
 633         if (used_virt == source)
 634                 dma_unmap_single(dev, used_phys, length, DMA_TO_DEVICE);
 635 }
 636
 637 static void gpmi_free_dma_buffer(struct gpmi_nand_data *this)
 638 {
 639         struct device *dev = this->dev;
 640
 641         if (this->page_buffer_virt && virt_addr_valid(this->page_buffer_virt))
 642                 dma_free_coherent(dev, this->page_buffer_size,
 643                                         this->page_buffer_virt,
 644                                         this->page_buffer_phys);
 645         kfree(this->cmd_buffer);
 646         kfree(this->data_buffer_dma);
 647
 648         this->cmd_buffer        = NULL;
 649         this->data_buffer_dma   = NULL;
 650         this->page_buffer_virt  = NULL;
 651         this->page_buffer_size  =  0;
 652 }
 653
 654 /* Allocate the DMA buffers */
 655 static int gpmi_alloc_dma_buffer(struct gpmi_nand_data *this)
 656 {
 657         struct bch_geometry *geo = &this->bch_geometry;
 658         struct device *dev = this->dev;
 659
 660         /* [1] Allocate a command buffer. PAGE_SIZE is enough. */
 661         this->cmd_buffer = kzalloc(PAGE_SIZE, GFP_DMA);
 662         if (this->cmd_buffer == NULL)
 663                 goto error_alloc;
 664
 665         /* [2] Allocate a read/write data buffer. PAGE_SIZE is enough. */
 666         this->data_buffer_dma = kzalloc(PAGE_SIZE, GFP_DMA);
 667         if (this->data_buffer_dma == NULL)
 668                 goto error_alloc;
 669
 670         /*
 671          * [3] Allocate the page buffer.
 672          *
 673          * Both the payload buffer and the auxiliary buffer must appear on
 674          * 32-bit boundaries. We presume the size of the payload buffer is a
 675          * power of two and is much larger than four, which guarantees the
 676          * auxiliary buffer will appear on a 32-bit boundary.
 677          */
 678         this->page_buffer_size = geo->payload_size + geo->auxiliary_size;
 679         this->page_buffer_virt = dma_alloc_coherent(dev, this->page_buffer_size,
 680                                         &this->page_buffer_phys, GFP_DMA);
 681         if (!this->page_buffer_virt)
 682                 goto error_alloc;
 683
 684
 685         /* Slice up the page buffer. */
 686         this->payload_virt = this->page_buffer_virt;
 687         this->payload_phys = this->page_buffer_phys;
 688         this->auxiliary_virt = this->payload_virt + geo->payload_size;
 689         this->auxiliary_phys = this->payload_phys + geo->payload_size;
 690         return 0;
 691
 692 error_alloc:
 693         gpmi_free_dma_buffer(this);
 694         pr_err("allocate DMA buffer ret!!\n");
 695         return -ENOMEM;
 696 }
 697
 698 static void gpmi_cmd_ctrl(struct mtd_info *mtd, int data, unsigned int ctrl)
 699 {
 700         struct nand_chip *chip = mtd->priv;
 701         struct gpmi_nand_data *this = chip->priv;
 702         int ret;
 703
 704         /*
 705          * Every operation begins with a command byte and a series of zero or
 706          * more address bytes. These are distinguished by either the Address
 707          * Latch Enable (ALE) or Command Latch Enable (CLE) signals being
 708          * asserted. When MTD is ready to execute the command, it will deassert
 709          * both latch enables.
 710          *
 711          * Rather than run a separate DMA operation for every single byte, we
 712          * queue them up and run a single DMA operation for the entire series
 713          * of command and data bytes. NAND_CMD_NONE means the END of the queue.
 714          */
 715         if ((ctrl & (NAND_ALE | NAND_CLE))) {
 716                 if (data != NAND_CMD_NONE)
 717                         this->cmd_buffer[this->command_length++] = data;
 718                 return;
 719         }
 720
 721         if (!this->command_length)
 722                 return;
 723
 724         ret = gpmi_send_command(this);
 725         if (ret)
 726                 pr_err("Chip: %u, Error %d\n", this->current_chip, ret);
 727
 728         this->command_length = 0;
 729 }
 730
 731 static int gpmi_dev_ready(struct mtd_info *mtd)
 732 {
 733         struct nand_chip *chip = mtd->priv;
 734         struct gpmi_nand_data *this = chip->priv;
 735
 736         return gpmi_is_ready(this, this->current_chip);
 737 }
 738
 739 static void gpmi_select_chip(struct mtd_info *mtd, int chipnr)
 740 {
 741         struct nand_chip *chip = mtd->priv;
 742         struct gpmi_nand_data *this = chip->priv;
 743
 744         if ((this->current_chip < 0) && (chipnr >= 0))
 745                 gpmi_begin(this);
 746         else if ((this->current_chip >= 0) && (chipnr < 0))
 747                 gpmi_end(this);
 748
 749         this->current_chip = chipnr;
 750 }
 751
 752 static void gpmi_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
 753 {
 754         struct nand_chip *chip = mtd->priv;
 755         struct gpmi_nand_data *this = chip->priv;
 756
 757         pr_debug("len is %d\n", len);
 758         this->upper_buf = buf;
 759         this->upper_len = len;
 760
 761         gpmi_read_data(this);
 762 }
 763
 764 static void gpmi_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
 765 {
 766         struct nand_chip *chip = mtd->priv;
 767         struct gpmi_nand_data *this = chip->priv;
 768
 769         pr_debug("len is %d\n", len);
 770         this->upper_buf = (uint8_t *)buf;
 771         this->upper_len = len;
 772
 773         gpmi_send_data(this);
 774 }
 775
 776 static uint8_t gpmi_read_byte(struct mtd_info *mtd)
 777 {
 778         struct nand_chip *chip = mtd->priv;
 779         struct gpmi_nand_data *this = chip->priv;
 780         uint8_t *buf = this->data_buffer_dma;
 781
 782         gpmi_read_buf(mtd, buf, 1);
 783         return buf[0];
 784 }
 785
 786 /*
 787  * Handles block mark swapping.
 788  * It can be called in swapping the block mark, or swapping it back,
 789  * because the the operations are the same.
 790  */
 791 static void block_mark_swapping(struct gpmi_nand_data *this,
 792                                 void *payload, void *auxiliary)
 793 {
 794         struct bch_geometry *nfc_geo = &this->bch_geometry;
 795         unsigned char *p;
 796         unsigned char *a;
 797         unsigned int  bit;
 798         unsigned char mask;
 799         unsigned char from_data;
 800         unsigned char from_oob;
 801
 802         if (!this->swap_block_mark)
 803                 return;
 804
 805         /*
 806          * If control arrives here, we're swapping. Make some convenience
 807          * variables.
 808          */
 809         bit = nfc_geo->block_mark_bit_offset;
 810         p   = payload + nfc_geo->block_mark_byte_offset;
 811         a   = auxiliary;
 812
 813         /*
 814          * Get the byte from the data area that overlays the block mark. Since
 815          * the ECC engine applies its own view to the bits in the page, the
 816          * physical block mark won't (in general) appear on a byte boundary in
 817          * the data.
 818          */
 819         from_data = (p[0] >> bit) | (p[1] << (8 - bit));
 820
 821         /* Get the byte from the OOB. */
 822         from_oob = a[0];
 823
 824         /* Swap them. */
 825         a[0] = from_data;
 826
 827         mask = (0x1 << bit) - 1;
 828         p[0] = (p[0] & mask) | (from_oob << bit);
 829
 830         mask = ~0 << bit;
 831         p[1] = (p[1] & mask) | (from_oob >> (8 - bit));
 832 }
 833
 834 static int gpmi_ecc_read_page(struct mtd_info *mtd, struct nand_chip *chip,
 835                                 uint8_t *buf, int oob_required, int page)
 836 {
 837         struct gpmi_nand_data *this = chip->priv;
 838         struct bch_geometry *nfc_geo = &this->bch_geometry;
 839         void          *payload_virt;
 840         dma_addr_t    payload_phys;
 841         void          *auxiliary_virt;
 842         dma_addr_t    auxiliary_phys;
 843         unsigned int  i;
 844         unsigned char *status;
 845         unsigned int  failed;
 846         unsigned int  corrected;
 847         int           ret;
 848
 849         pr_debug("page number is : %d\n", page);
 850         ret = read_page_prepare(this, buf, mtd->writesize,
 851                                         this->payload_virt, this->payload_phys,
 852                                         nfc_geo->payload_size,
 853                                         &payload_virt, &payload_phys);
 854         if (ret) {
 855                 pr_err("Inadequate DMA buffer\n");
 856                 ret = -ENOMEM;
 857                 return ret;
 858         }
 859         auxiliary_virt = this->auxiliary_virt;
 860         auxiliary_phys = this->auxiliary_phys;
 861
 862         /* go! */
 863         ret = gpmi_read_page(this, payload_phys, auxiliary_phys);
 864         read_page_end(this, buf, mtd->writesize,
 865                         this->payload_virt, this->payload_phys,
 866                         nfc_geo->payload_size,
 867                         payload_virt, payload_phys);
 868         if (ret) {
 869                 pr_err("Error in ECC-based read: %d\n", ret);
 870                 goto exit_nfc;
 871         }
 872
 873         /* handle the block mark swapping */
 874         block_mark_swapping(this, payload_virt, auxiliary_virt);
 875
 876         /* Loop over status bytes, accumulating ECC status. */
 877         failed          = 0;
 878         corrected       = 0;
 879         status          = auxiliary_virt + nfc_geo->auxiliary_status_offset;
 880
 881         for (i = 0; i < nfc_geo->ecc_chunk_count; i++, status++) {
 882                 if ((*status == STATUS_GOOD) || (*status == STATUS_ERASED))
 883                         continue;
 884
 885                 if (*status == STATUS_UNCORRECTABLE) {
 886                         failed++;
 887                         continue;
 888                 }
 889                 corrected += *status;
 890         }
 891
 892         /*
 893          * Propagate ECC status to the owning MTD only when failed or
 894          * corrected times nearly reaches our ECC correction threshold.
 895          */
 896         if (failed || corrected >= (nfc_geo->ecc_strength - 1)) {
 897                 mtd->ecc_stats.failed    += failed;
 898                 mtd->ecc_stats.corrected += corrected;
 899         }
 900
 901         if (oob_required) {
 902                 /*
 903                  * It's time to deliver the OOB bytes. See gpmi_ecc_read_oob()
 904                  * for details about our policy for delivering the OOB.
 905                  *
 906                  * We fill the caller's buffer with set bits, and then copy the
 907                  * block mark to th caller's buffer. Note that, if block mark
 908                  * swapping was necessary, it has already been done, so we can
 909                  * rely on the first byte of the auxiliary buffer to contain
 910                  * the block mark.
 911                  */
 912                 memset(chip->oob_poi, ~0, mtd->oobsize);
 913                 chip->oob_poi[0] = ((uint8_t *) auxiliary_virt)[0];
 914
 915                 read_page_swap_end(this, buf, mtd->writesize,
 916                                 this->payload_virt, this->payload_phys,
 917                                 nfc_geo->payload_size,
 918                                 payload_virt, payload_phys);
 919         }
 920 exit_nfc:
 921         return ret;
 922 }
 923
 924 static void gpmi_ecc_write_page(struct mtd_info *mtd, struct nand_chip *chip,
 925                                 const uint8_t *buf, int oob_required)
 926 {
 927         struct gpmi_nand_data *this = chip->priv;
 928         struct bch_geometry *nfc_geo = &this->bch_geometry;
 929         const void *payload_virt;
 930         dma_addr_t payload_phys;
 931         const void *auxiliary_virt;
 932         dma_addr_t auxiliary_phys;
 933         int        ret;
 934
 935         pr_debug("ecc write page.\n");
 936         if (this->swap_block_mark) {
 937                 /*
 938                  * If control arrives here, we're doing block mark swapping.
 939                  * Since we can't modify the caller's buffers, we must copy them
 940                  * into our own.
 941                  */
 942                 memcpy(this->payload_virt, buf, mtd->writesize);
 943                 payload_virt = this->payload_virt;
 944                 payload_phys = this->payload_phys;
 945
 946                 memcpy(this->auxiliary_virt, chip->oob_poi,
 947                                 nfc_geo->auxiliary_size);
 948                 auxiliary_virt = this->auxiliary_virt;
 949                 auxiliary_phys = this->auxiliary_phys;
 950
 951                 /* Handle block mark swapping. */
 952                 block_mark_swapping(this,
 953                                 (void *) payload_virt, (void *) auxiliary_virt);
 954         } else {
 955                 /*
 956                  * If control arrives here, we're not doing block mark swapping,
 957                  * so we can to try and use the caller's buffers.
 958                  */
 959                 ret = send_page_prepare(this,
 960                                 buf, mtd->writesize,
 961                                 this->payload_virt, this->payload_phys,
 962                                 nfc_geo->payload_size,
 963                                 &payload_virt, &payload_phys);
 964                 if (ret) {
 965                         pr_err("Inadequate payload DMA buffer\n");
 966                         return;
 967                 }
 968
 969                 ret = send_page_prepare(this,
 970                                 chip->oob_poi, mtd->oobsize,
 971                                 this->auxiliary_virt, this->auxiliary_phys,
 972                                 nfc_geo->auxiliary_size,
 973                                 &auxiliary_virt, &auxiliary_phys);
 974                 if (ret) {
 975                         pr_err("Inadequate auxiliary DMA buffer\n");
 976                         goto exit_auxiliary;
 977                 }
 978         }
 979
 980         /* Ask the NFC. */
 981         ret = gpmi_send_page(this, payload_phys, auxiliary_phys);
 982         if (ret)
 983                 pr_err("Error in ECC-based write: %d\n", ret);
 984
 985         if (!this->swap_block_mark) {
 986                 send_page_end(this, chip->oob_poi, mtd->oobsize,
 987                                 this->auxiliary_virt, this->auxiliary_phys,
 988                                 nfc_geo->auxiliary_size,
 989                                 auxiliary_virt, auxiliary_phys);
 990 exit_auxiliary:
 991                 send_page_end(this, buf, mtd->writesize,
 992                                 this->payload_virt, this->payload_phys,
 993                                 nfc_geo->payload_size,
 994                                 payload_virt, payload_phys);
 995         }
 996 }
 997
 998 /*
 999  * There are several places in this driver where we have to handle the OOB and
1000  * block marks. This is the function where things are the most complicated, so
1001  * this is where we try to explain it all. All the other places refer back to
1002  * here.
1003  *
1004  * These are the rules, in order of decreasing importance:
1005  *
1006  * 1) Nothing the caller does can be allowed to imperil the block mark.
1007  *
1008  * 2) In read operations, the first byte of the OOB we return must reflect the
1009  *    true state of the block mark, no matter where that block mark appears in
1010  *    the physical page.
1011  *
1012  * 3) ECC-based read operations return an OOB full of set bits (since we never
1013  *    allow ECC-based writes to the OOB, it doesn't matter what ECC-based reads
1014  *    return).
1015  *
1016  * 4) "Raw" read operations return a direct view of the physical bytes in the
1017  *    page, using the conventional definition of which bytes are data and which
1018  *    are OOB. This gives the caller a way to see the actual, physical bytes
1019  *    in the page, without the distortions applied by our ECC engine.
1020  *
1021  *
1022  * What we do for this specific read operation depends on two questions:
1023  *
1024  * 1) Are we doing a "raw" read, or an ECC-based read?
1025  *
1026  * 2) Are we using block mark swapping or transcription?
1027  *
1028  * There are four cases, illustrated by the following Karnaugh map:
1029  *
1030  *                    |           Raw           |         ECC-based       |
1031  *       -------------+-------------------------+-------------------------+
1032  *                    | Read the conventional   |                         |
1033  *                    | OOB at the end of the   |                         |
1034  *       Swapping     | page and return it. It  |                         |
1035  *                    | contains exactly what   |                         |
1036  *                    | we want.                | Read the block mark and |
1037  *       -------------+-------------------------+ return it in a buffer   |
1038  *                    | Read the conventional   | full of set bits.       |
1039  *                    | OOB at the end of the   |                         |
1040  *                    | page and also the block |                         |
1041  *       Transcribing | mark in the metadata.   |                         |
1042  *                    | Copy the block mark     |                         |
1043  *                    | into the first byte of  |                         |
1044  *                    | the OOB.                |                         |
1045  *       -------------+-------------------------+-------------------------+
1046  *
1047  * Note that we break rule #4 in the Transcribing/Raw case because we're not
1048  * giving an accurate view of the actual, physical bytes in the page (we're
1049  * overwriting the block mark). That's OK because it's more important to follow
1050  * rule #2.
1051  *
1052  * It turns out that knowing whether we want an "ECC-based" or "raw" read is not
1053  * easy. When reading a page, for example, the NAND Flash MTD code calls our
1054  * ecc.read_page or ecc.read_page_raw function. Thus, the fact that MTD wants an
1055  * ECC-based or raw view of the page is implicit in which function it calls
1056  * (there is a similar pair of ECC-based/raw functions for writing).
1057  *
1058  * Since MTD assumes the OOB is not covered by ECC, there is no pair of
1059  * ECC-based/raw functions for reading or or writing the OOB. The fact that the
1060  * caller wants an ECC-based or raw view of the page is not propagated down to
1061  * this driver.
1062  */
1063 static int gpmi_ecc_read_oob(struct mtd_info *mtd, struct nand_chip *chip,
1064                                 int page)
1065 {
1066         struct gpmi_nand_data *this = chip->priv;
1067
1068         pr_debug("page number is %d\n", page);
1069         /* clear the OOB buffer */
1070         memset(chip->oob_poi, ~0, mtd->oobsize);
1071
1072         /* Read out the conventional OOB. */
1073         chip->cmdfunc(mtd, NAND_CMD_READ0, mtd->writesize, page);
1074         chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1075
1076         /*
1077          * Now, we want to make sure the block mark is correct. In the
1078          * Swapping/Raw case, we already have it. Otherwise, we need to
1079          * explicitly read it.
1080          */
1081         if (!this->swap_block_mark) {
1082                 /* Read the block mark into the first byte of the OOB buffer. */
1083                 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
1084                 chip->oob_poi[0] = chip->read_byte(mtd);
1085         }
1086
1087         return 0;
1088 }
1089
1090 static int
1091 gpmi_ecc_write_oob(struct mtd_info *mtd, struct nand_chip *chip, int page)
1092 {
1093         /*
1094          * The BCH will use all the (page + oob).
1095          * Our gpmi_hw_ecclayout can only prohibit the JFFS2 to write the oob.
1096          * But it can not stop some ioctls such MEMWRITEOOB which uses
1097          * MTD_OPS_PLACE_OOB. So We have to implement this function to prohibit
1098          * these ioctls too.
1099          */
1100         return -EPERM;
1101 }
1102
1103 static int gpmi_block_markbad(struct mtd_info *mtd, loff_t ofs)
1104 {
1105         struct nand_chip *chip = mtd->priv;
1106         struct gpmi_nand_data *this = chip->priv;
1107         int block, ret = 0;
1108         uint8_t *block_mark;
1109         int column, page, status, chipnr;
1110
1111         /* Get block number */
1112         block = (int)(ofs >> chip->bbt_erase_shift);
1113         if (chip->bbt)
1114                 chip->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
1115
1116         /* Do we have a flash based bad block table ? */
1117         if (chip->bbt_options & NAND_BBT_USE_FLASH)
1118                 ret = nand_update_bbt(mtd, ofs);
1119         else {
1120                 chipnr = (int)(ofs >> chip->chip_shift);
1121                 chip->select_chip(mtd, chipnr);
1122
1123                 column = this->swap_block_mark ? mtd->writesize : 0;
1124
1125                 /* Write the block mark. */
1126                 block_mark = this->data_buffer_dma;
1127                 block_mark[0] = 0; /* bad block marker */
1128
1129                 /* Shift to get page */
1130                 page = (int)(ofs >> chip->page_shift);
1131
1132                 chip->cmdfunc(mtd, NAND_CMD_SEQIN, column, page);
1133                 chip->write_buf(mtd, block_mark, 1);
1134                 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1135
1136                 status = chip->waitfunc(mtd, chip);
1137                 if (status & NAND_STATUS_FAIL)
1138                         ret = -EIO;
1139
1140                 chip->select_chip(mtd, -1);
1141         }
1142         if (!ret)
1143                 mtd->ecc_stats.badblocks++;
1144
1145         return ret;
1146 }
1147
1148 static int nand_boot_set_geometry(struct gpmi_nand_data *this)
1149 {
1150         struct boot_rom_geometry *geometry = &this->rom_geometry;
1151
1152         /*
1153          * Set the boot block stride size.
1154          *
1155          * In principle, we should be reading this from the OTP bits, since
1156          * that's where the ROM is going to get it. In fact, we don't have any
1157          * way to read the OTP bits, so we go with the default and hope for the
1158          * best.
1159          */
1160         geometry->stride_size_in_pages = 64;
1161
1162         /*
1163          * Set the search area stride exponent.
1164          *
1165          * In principle, we should be reading this from the OTP bits, since
1166          * that's where the ROM is going to get it. In fact, we don't have any
1167          * way to read the OTP bits, so we go with the default and hope for the
1168          * best.
1169          */
1170         geometry->search_area_stride_exponent = 2;
1171         return 0;
1172 }
1173
1174 static const char  *fingerprint = "STMP";
1175 static int mx23_check_transcription_stamp(struct gpmi_nand_data *this)
1176 {
1177         struct boot_rom_geometry *rom_geo = &this->rom_geometry;
1178         struct device *dev = this->dev;
1179         struct mtd_info *mtd = &this->mtd;
1180         struct nand_chip *chip = &this->nand;
1181         unsigned int search_area_size_in_strides;
1182         unsigned int stride;
1183         unsigned int page;
1184         loff_t byte;
1185         uint8_t *buffer = chip->buffers->databuf;
1186         int saved_chip_number;
1187         int found_an_ncb_fingerprint = false;
1188
1189         /* Compute the number of strides in a search area. */
1190         search_area_size_in_strides = 1 << rom_geo->search_area_stride_exponent;
1191
1192         saved_chip_number = this->current_chip;
1193         chip->select_chip(mtd, 0);
1194
1195         /*
1196          * Loop through the first search area, looking for the NCB fingerprint.
1197          */
1198         dev_dbg(dev, "Scanning for an NCB fingerprint...\n");
1199
1200         for (stride = 0; stride < search_area_size_in_strides; stride++) {
1201                 /* Compute the page and byte addresses. */
1202                 page = stride * rom_geo->stride_size_in_pages;
1203                 byte = page   * mtd->writesize;
1204
1205                 dev_dbg(dev, "Looking for a fingerprint in page 0x%x\n", page);
1206
1207                 /*
1208                  * Read the NCB fingerprint. The fingerprint is four bytes long
1209                  * and starts in the 12th byte of the page.
1210                  */
1211                 chip->cmdfunc(mtd, NAND_CMD_READ0, 12, page);
1212                 chip->read_buf(mtd, buffer, strlen(fingerprint));
1213
1214                 /* Look for the fingerprint. */
1215                 if (!memcmp(buffer, fingerprint, strlen(fingerprint))) {
1216                         found_an_ncb_fingerprint = true;
1217                         break;
1218                 }
1219
1220         }
1221
1222         chip->select_chip(mtd, saved_chip_number);
1223
1224         if (found_an_ncb_fingerprint)
1225                 dev_dbg(dev, "\tFound a fingerprint\n");
1226         else
1227                 dev_dbg(dev, "\tNo fingerprint found\n");
1228         return found_an_ncb_fingerprint;
1229 }
1230
1231 /* Writes a transcription stamp. */
1232 static int mx23_write_transcription_stamp(struct gpmi_nand_data *this)
1233 {
1234         struct device *dev = this->dev;
1235         struct boot_rom_geometry *rom_geo = &this->rom_geometry;
1236         struct mtd_info *mtd = &this->mtd;
1237         struct nand_chip *chip = &this->nand;
1238         unsigned int block_size_in_pages;
1239         unsigned int search_area_size_in_strides;
1240         unsigned int search_area_size_in_pages;
1241         unsigned int search_area_size_in_blocks;
1242         unsigned int block;
1243         unsigned int stride;
1244         unsigned int page;
1245         loff_t       byte;
1246         uint8_t      *buffer = chip->buffers->databuf;
1247         int saved_chip_number;
1248         int status;
1249
1250         /* Compute the search area geometry. */
1251         block_size_in_pages = mtd->erasesize / mtd->writesize;
1252         search_area_size_in_strides = 1 << rom_geo->search_area_stride_exponent;
1253         search_area_size_in_pages = search_area_size_in_strides *
1254                                         rom_geo->stride_size_in_pages;
1255         search_area_size_in_blocks =
1256                   (search_area_size_in_pages + (block_size_in_pages - 1)) /
1257                                     block_size_in_pages;
1258
1259         dev_dbg(dev, "Search Area Geometry :\n");
1260         dev_dbg(dev, "\tin Blocks : %u\n", search_area_size_in_blocks);
1261         dev_dbg(dev, "\tin Strides: %u\n", search_area_size_in_strides);
1262         dev_dbg(dev, "\tin Pages  : %u\n", search_area_size_in_pages);
1263
1264         /* Select chip 0. */
1265         saved_chip_number = this->current_chip;
1266         chip->select_chip(mtd, 0);
1267
1268         /* Loop over blocks in the first search area, erasing them. */
1269         dev_dbg(dev, "Erasing the search area...\n");
1270
1271         for (block = 0; block < search_area_size_in_blocks; block++) {
1272                 /* Compute the page address. */
1273                 page = block * block_size_in_pages;
1274
1275                 /* Erase this block. */
1276                 dev_dbg(dev, "\tErasing block 0x%x\n", block);
1277                 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
1278                 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
1279
1280                 /* Wait for the erase to finish. */
1281                 status = chip->waitfunc(mtd, chip);
1282                 if (status & NAND_STATUS_FAIL)
1283                         dev_err(dev, "[%s] Erase failed.\n", __func__);
1284         }
1285
1286         /* Write the NCB fingerprint into the page buffer. */
1287         memset(buffer, ~0, mtd->writesize);
1288         memset(chip->oob_poi, ~0, mtd->oobsize);
1289         memcpy(buffer + 12, fingerprint, strlen(fingerprint));
1290
1291         /* Loop through the first search area, writing NCB fingerprints. */
1292         dev_dbg(dev, "Writing NCB fingerprints...\n");
1293         for (stride = 0; stride < search_area_size_in_strides; stride++) {
1294                 /* Compute the page and byte addresses. */
1295                 page = stride * rom_geo->stride_size_in_pages;
1296                 byte = page   * mtd->writesize;
1297
1298                 /* Write the first page of the current stride. */
1299                 dev_dbg(dev, "Writing an NCB fingerprint in page 0x%x\n", page);
1300                 chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0x00, page);
1301                 chip->ecc.write_page_raw(mtd, chip, buffer, 0);
1302                 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1303
1304                 /* Wait for the write to finish. */
1305                 status = chip->waitfunc(mtd, chip);
1306                 if (status & NAND_STATUS_FAIL)
1307                         dev_err(dev, "[%s] Write failed.\n", __func__);
1308         }
1309
1310         /* Deselect chip 0. */
1311         chip->select_chip(mtd, saved_chip_number);
1312         return 0;
1313 }
1314
1315 static int mx23_boot_init(struct gpmi_nand_data  *this)
1316 {
1317         struct device *dev = this->dev;
1318         struct nand_chip *chip = &this->nand;
1319         struct mtd_info *mtd = &this->mtd;
1320         unsigned int block_count;
1321         unsigned int block;
1322         int     chipnr;
1323         int     page;
1324         loff_t  byte;
1325         uint8_t block_mark;
1326         int     ret = 0;
1327
1328         /*
1329          * If control arrives here, we can't use block mark swapping, which
1330          * means we're forced to use transcription. First, scan for the
1331          * transcription stamp. If we find it, then we don't have to do
1332          * anything -- the block marks are already transcribed.
1333          */
1334         if (mx23_check_transcription_stamp(this))
1335                 return 0;
1336
1337         /*
1338          * If control arrives here, we couldn't find a transcription stamp, so
1339          * so we presume the block marks are in the conventional location.
1340          */
1341         dev_dbg(dev, "Transcribing bad block marks...\n");
1342
1343         /* Compute the number of blocks in the entire medium. */
1344         block_count = chip->chipsize >> chip->phys_erase_shift;
1345
1346         /*
1347          * Loop over all the blocks in the medium, transcribing block marks as
1348          * we go.
1349          */
1350         for (block = 0; block < block_count; block++) {
1351                 /*
1352                  * Compute the chip, page and byte addresses for this block's
1353                  * conventional mark.
1354                  */
1355                 chipnr = block >> (chip->chip_shift - chip->phys_erase_shift);
1356                 page = block << (chip->phys_erase_shift - chip->page_shift);
1357                 byte = block <<  chip->phys_erase_shift;
1358
1359                 /* Send the command to read the conventional block mark. */
1360                 chip->select_chip(mtd, chipnr);
1361                 chip->cmdfunc(mtd, NAND_CMD_READ0, mtd->writesize, page);
1362                 block_mark = chip->read_byte(mtd);
1363                 chip->select_chip(mtd, -1);
1364
1365                 /*
1366                  * Check if the block is marked bad. If so, we need to mark it
1367                  * again, but this time the result will be a mark in the
1368                  * location where we transcribe block marks.
1369                  */
1370                 if (block_mark != 0xff) {
1371                         dev_dbg(dev, "Transcribing mark in block %u\n", block);
1372                         ret = chip->block_markbad(mtd, byte);
1373                         if (ret)
1374                                 dev_err(dev, "Failed to mark block bad with "
1375                                                         "ret %d\n", ret);
1376                 }
1377         }
1378
1379         /* Write the stamp that indicates we've transcribed the block marks. */
1380         mx23_write_transcription_stamp(this);
1381         return 0;
1382 }
1383
1384 static int nand_boot_init(struct gpmi_nand_data  *this)
1385 {
1386         nand_boot_set_geometry(this);
1387
1388         /* This is ROM arch-specific initilization before the BBT scanning. */
1389         if (GPMI_IS_MX23(this))
1390                 return mx23_boot_init(this);
1391         return 0;
1392 }
1393
1394 static int gpmi_set_geometry(struct gpmi_nand_data *this)
1395 {
1396         int ret;
1397
1398         /* Free the temporary DMA memory for reading ID. */
1399         gpmi_free_dma_buffer(this);
1400
1401         /* Set up the NFC geometry which is used by BCH. */
1402         ret = bch_set_geometry(this);
1403         if (ret) {
1404                 pr_err("set geometry ret : %d\n", ret);
1405                 return ret;
1406         }
1407
1408         /* Alloc the new DMA buffers according to the pagesize and oobsize */
1409         return gpmi_alloc_dma_buffer(this);
1410 }
1411
1412 static int gpmi_pre_bbt_scan(struct gpmi_nand_data  *this)
1413 {
1414         int ret;
1415
1416         /* Set up swap_block_mark, must be set before the gpmi_set_geometry() */
1417         if (GPMI_IS_MX23(this))
1418                 this->swap_block_mark = false;
1419         else
1420                 this->swap_block_mark = true;
1421
1422         /* Set up the medium geometry */
1423         ret = gpmi_set_geometry(this);
1424         if (ret)
1425                 return ret;
1426
1427         /* Adjust the ECC strength according to the chip. */
1428         this->nand.ecc.strength = this->bch_geometry.ecc_strength;
1429         this->mtd.ecc_strength = this->bch_geometry.ecc_strength;
1430
1431         /* NAND boot init, depends on the gpmi_set_geometry(). */
1432         return nand_boot_init(this);
1433 }
1434
1435 static int gpmi_scan_bbt(struct mtd_info *mtd)
1436 {
1437         struct nand_chip *chip = mtd->priv;
1438         struct gpmi_nand_data *this = chip->priv;
1439         int ret;
1440
1441         /* Prepare for the BBT scan. */
1442         ret = gpmi_pre_bbt_scan(this);
1443         if (ret)
1444                 return ret;
1445
1446         /* use the default BBT implementation */
1447         return nand_default_bbt(mtd);
1448 }
1449
1450 void gpmi_nfc_exit(struct gpmi_nand_data *this)
1451 {
1452         nand_release(&this->mtd);
1453         gpmi_free_dma_buffer(this);
1454 }
1455
1456 static int __devinit gpmi_nfc_init(struct gpmi_nand_data *this)
1457 {
1458         struct mtd_info  *mtd = &this->mtd;
1459         struct nand_chip *chip = &this->nand;
1460         struct mtd_part_parser_data ppdata = {};
1461         int ret;
1462
1463         /* init current chip */
1464         this->current_chip      = -1;
1465
1466         /* init the MTD data structures */
1467         mtd->priv               = chip;
1468         mtd->name               = "gpmi-nand";
1469         mtd->owner              = THIS_MODULE;
1470
1471         /* init the nand_chip{}, we don't support a 16-bit NAND Flash bus. */
1472         chip->priv              = this;
1473         chip->select_chip       = gpmi_select_chip;
1474         chip->cmd_ctrl          = gpmi_cmd_ctrl;
1475         chip->dev_ready         = gpmi_dev_ready;
1476         chip->read_byte         = gpmi_read_byte;
1477         chip->read_buf          = gpmi_read_buf;
1478         chip->write_buf         = gpmi_write_buf;
1479         chip->ecc.read_page     = gpmi_ecc_read_page;
1480         chip->ecc.write_page    = gpmi_ecc_write_page;
1481         chip->ecc.read_oob      = gpmi_ecc_read_oob;
1482         chip->ecc.write_oob     = gpmi_ecc_write_oob;
1483         chip->scan_bbt          = gpmi_scan_bbt;
1484         chip->badblock_pattern  = &gpmi_bbt_descr;
1485         chip->block_markbad     = gpmi_block_markbad;
1486         chip->options           |= NAND_NO_SUBPAGE_WRITE;
1487         chip->ecc.mode          = NAND_ECC_HW;
1488         chip->ecc.size          = 1;
1489         chip->ecc.strength      = 8;
1490         chip->ecc.layout        = &gpmi_hw_ecclayout;
1491
1492         /* Allocate a temporary DMA buffer for reading ID in the nand_scan() */
1493         this->bch_geometry.payload_size = 1024;
1494         this->bch_geometry.auxiliary_size = 128;
1495         ret = gpmi_alloc_dma_buffer(this);
1496         if (ret)
1497                 goto err_out;
1498
1499         ret = nand_scan(mtd, 1);
1500         if (ret) {
1501                 pr_err("Chip scan failed\n");
1502                 goto err_out;
1503         }
1504
1505         ppdata.of_node = this->pdev->dev.of_node;
1506         ret = mtd_device_parse_register(mtd, NULL, &ppdata, NULL, 0);
1507         if (ret)
1508                 goto err_out;
1509         return 0;
1510
1511 err_out:
1512         gpmi_nfc_exit(this);
1513         return ret;
1514 }
1515
1516 static const struct platform_device_id gpmi_ids[] = {
1517         { .name = "imx23-gpmi-nand", .driver_data = IS_MX23, },
1518         { .name = "imx28-gpmi-nand", .driver_data = IS_MX28, },
1519         { .name = "imx6q-gpmi-nand", .driver_data = IS_MX6Q, },
1520         {},
1521 };
1522
1523 static const struct of_device_id gpmi_nand_id_table[] = {
1524         {
1525                 .compatible = "fsl,imx23-gpmi-nand",
1526                 .data = (void *)&gpmi_ids[IS_MX23]
1527         }, {
1528                 .compatible = "fsl,imx28-gpmi-nand",
1529                 .data = (void *)&gpmi_ids[IS_MX28]
1530         }, {
1531                 .compatible = "fsl,imx6q-gpmi-nand",
1532                 .data = (void *)&gpmi_ids[IS_MX6Q]
1533         }, {}
1534 };
1535 MODULE_DEVICE_TABLE(of, gpmi_nand_id_table);
1536
1537 static int __devinit gpmi_nand_probe(struct platform_device *pdev)
1538 {
1539         struct gpmi_nand_data *this;
1540         const struct of_device_id *of_id;
1541         int ret;
1542
1543         of_id = of_match_device(gpmi_nand_id_table, &pdev->dev);
1544         if (of_id) {
1545                 pdev->id_entry = of_id->data;
1546         } else {
1547                 pr_err("Failed to find the right device id.\n");
1548                 return -ENOMEM;
1549         }
1550
1551         this = kzalloc(sizeof(*this), GFP_KERNEL);
1552         if (!this) {
1553                 pr_err("Failed to allocate per-device memory\n");
1554                 return -ENOMEM;
1555         }
1556
1557         platform_set_drvdata(pdev, this);
1558         this->pdev  = pdev;
1559         this->dev   = &pdev->dev;
1560
1561         ret = acquire_resources(this);
1562         if (ret)
1563                 goto exit_acquire_resources;
1564
1565         ret = init_hardware(this);
1566         if (ret)
1567                 goto exit_nfc_init;
1568
1569         ret = gpmi_nfc_init(this);
1570         if (ret)
1571                 goto exit_nfc_init;
1572
1573         return 0;
1574
1575 exit_nfc_init:
1576         release_resources(this);
1577 exit_acquire_resources:
1578         platform_set_drvdata(pdev, NULL);
1579         kfree(this);
1580         return ret;
1581 }
1582
1583 static int __exit gpmi_nand_remove(struct platform_device *pdev)
1584 {
1585         struct gpmi_nand_data *this = platform_get_drvdata(pdev);
1586
1587         gpmi_nfc_exit(this);
1588         release_resources(this);
1589         platform_set_drvdata(pdev, NULL);
1590         kfree(this);
1591         return 0;
1592 }
1593
1594 static struct platform_driver gpmi_nand_driver = {
1595         .driver = {
1596                 .name = "gpmi-nand",
1597                 .of_match_table = gpmi_nand_id_table,
1598         },
1599         .probe   = gpmi_nand_probe,
1600         .remove  = __exit_p(gpmi_nand_remove),
1601         .id_table = gpmi_ids,
1602 };
1603
1604 static int __init gpmi_nand_init(void)
1605 {
1606         int err;
1607
1608         err = platform_driver_register(&gpmi_nand_driver);
1609         if (err == 0)
1610                 printk(KERN_INFO "GPMI NAND driver registered. (IMX)\n");
1611         else
1612                 pr_err("i.MX GPMI NAND driver registration failed\n");
1613         return err;
1614 }
1615
1616 static void __exit gpmi_nand_exit(void)
1617 {
1618         platform_driver_unregister(&gpmi_nand_driver);
1619 }
1620
1621 module_init(gpmi_nand_init);
1622 module_exit(gpmi_nand_exit);
1623
1624 MODULE_AUTHOR("Freescale Semiconductor, Inc.");
1625 MODULE_DESCRIPTION("i.MX GPMI NAND Flash Controller Driver");
1626 MODULE_LICENSE("GPL");