drivers/mtd/nand/mxs_nand.c

   1 /*
   2  * Freescale i.MX28 NAND flash driver
   3  *
   4  * Copyright (C) 2011 Marek Vasut <marek.vasut@gmail.com>
   5  * on behalf of DENX Software Engineering GmbH
   6  *
   7  * Based on code from LTIB:
   8  * Freescale GPMI NFC NAND Flash Driver
   9  *
  10  * Copyright (C) 2010 Freescale Semiconductor, Inc.
  11  * Copyright (C) 2008 Embedded Alley Solutions, Inc.
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License along
  24  * with this program; if not, write to the Free Software Foundation, Inc.,
  25  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  26  */
  27
  28 #include <linux/mtd/mtd.h>
  29 #include <linux/mtd/nand.h>
  30 #include <linux/types.h>
  31 #include <common.h>
  32 #include <malloc.h>
  33 #include <asm/errno.h>
  34 #include <asm/io.h>
  35 #include <asm/arch/clock.h>
  36 #include <asm/arch/imx-regs.h>
  37 #include <asm/arch/sys_proto.h>
  38 #include <asm/arch/dma.h>
  39
  40 #define MXS_NAND_DMA_DESCRIPTOR_COUNT           4
  41
  42 #define MXS_NAND_CHUNK_DATA_CHUNK_SIZE          512
  43 #define MXS_NAND_METADATA_SIZE                  10
  44
  45 #define MXS_NAND_COMMAND_BUFFER_SIZE            32
  46
  47 #define MXS_NAND_BCH_TIMEOUT                    10000
  48
  49 struct mxs_nand_info {
  50         int             cur_chip;
  51
  52         uint32_t        cmd_queue_len;
  53
  54         uint8_t         *cmd_buf;
  55         uint8_t         *data_buf;
  56         uint8_t         *oob_buf;
  57
  58         uint8_t         marking_block_bad;
  59         uint8_t         raw_oob_mode;
  60
  61         /* Functions with altered behaviour */
  62         int             (*hooked_read_oob)(struct mtd_info *mtd,
  63                                 loff_t from, struct mtd_oob_ops *ops);
  64         int             (*hooked_write_oob)(struct mtd_info *mtd,
  65                                 loff_t to, struct mtd_oob_ops *ops);
  66         int             (*hooked_block_markbad)(struct mtd_info *mtd,
  67                                 loff_t ofs);
  68
  69         /* DMA descriptors */
  70         struct mxs_dma_desc     **desc;
  71         uint32_t                desc_index;
  72 };
  73
  74 struct nand_ecclayout fake_ecc_layout;
  75
  76 static struct mxs_dma_desc *mxs_nand_get_dma_desc(struct mxs_nand_info *info)
  77 {
  78         struct mxs_dma_desc *desc;
  79
  80         if (info->desc_index >= MXS_NAND_DMA_DESCRIPTOR_COUNT) {
  81                 printf("MXS NAND: Too many DMA descriptors requested\n");
  82                 return NULL;
  83         }
  84
  85         desc = info->desc[info->desc_index];
  86         info->desc_index++;
  87
  88         return desc;
  89 }
  90
  91 static void mxs_nand_return_dma_descs(struct mxs_nand_info *info)
  92 {
  93         int i;
  94         struct mxs_dma_desc *desc;
  95
  96         for (i = 0; i < info->desc_index; i++) {
  97                 desc = info->desc[i];
  98                 memset(desc, 0, sizeof(struct mxs_dma_desc));
  99                 desc->address = (dma_addr_t)desc;
 100         }
 101
 102         info->desc_index = 0;
 103 }
 104
 105 static uint32_t mxs_nand_ecc_chunk_cnt(uint32_t page_data_size)
 106 {
 107         return page_data_size / MXS_NAND_CHUNK_DATA_CHUNK_SIZE;
 108 }
 109
 110 static uint32_t mxs_nand_ecc_size_in_bits(uint32_t ecc_strength)
 111 {
 112         return ecc_strength * 13;
 113 }
 114
 115 static uint32_t mxs_nand_aux_status_offset(void)
 116 {
 117         return (MXS_NAND_METADATA_SIZE + 0x3) & ~0x3;
 118 }
 119
 120 static inline uint32_t mxs_nand_get_ecc_strength(uint32_t page_data_size,
 121                                                 uint32_t page_oob_size)
 122 {
 123         if (page_data_size == 2048)
 124                 return 8;
 125
 126         if (page_data_size == 4096) {
 127                 if (page_oob_size == 128)
 128                         return 8;
 129
 130                 if (page_oob_size == 218)
 131                         return 16;
 132         }
 133
 134         return 0;
 135 }
 136
 137 static inline uint32_t mxs_nand_get_mark_offset(uint32_t page_data_size,
 138                                                 uint32_t ecc_strength)
 139 {
 140         uint32_t chunk_data_size_in_bits;
 141         uint32_t chunk_ecc_size_in_bits;
 142         uint32_t chunk_total_size_in_bits;
 143         uint32_t block_mark_chunk_number;
 144         uint32_t block_mark_chunk_bit_offset;
 145         uint32_t block_mark_bit_offset;
 146
 147         chunk_data_size_in_bits = MXS_NAND_CHUNK_DATA_CHUNK_SIZE * 8;
 148         chunk_ecc_size_in_bits  = mxs_nand_ecc_size_in_bits(ecc_strength);
 149
 150         chunk_total_size_in_bits =
 151                         chunk_data_size_in_bits + chunk_ecc_size_in_bits;
 152
 153         /* Compute the bit offset of the block mark within the physical page. */
 154         block_mark_bit_offset = page_data_size * 8;
 155
 156         /* Subtract the metadata bits. */
 157         block_mark_bit_offset -= MXS_NAND_METADATA_SIZE * 8;
 158
 159         /*
 160          * Compute the chunk number (starting at zero) in which the block mark
 161          * appears.
 162          */
 163         block_mark_chunk_number =
 164                         block_mark_bit_offset / chunk_total_size_in_bits;
 165
 166         /*
 167          * Compute the bit offset of the block mark within its chunk, and
 168          * validate it.
 169          */
 170         block_mark_chunk_bit_offset = block_mark_bit_offset -
 171                         (block_mark_chunk_number * chunk_total_size_in_bits);
 172
 173         if (block_mark_chunk_bit_offset > chunk_data_size_in_bits)
 174                 return 1;
 175
 176         /*
 177          * Now that we know the chunk number in which the block mark appears,
 178          * we can subtract all the ECC bits that appear before it.
 179          */
 180         block_mark_bit_offset -=
 181                 block_mark_chunk_number * chunk_ecc_size_in_bits;
 182
 183         return block_mark_bit_offset;
 184 }
 185
 186 static uint32_t mxs_nand_mark_byte_offset(struct mtd_info *mtd)
 187 {
 188         uint32_t ecc_strength;
 189         ecc_strength = mxs_nand_get_ecc_strength(mtd->writesize, mtd->oobsize);
 190         return mxs_nand_get_mark_offset(mtd->writesize, ecc_strength) >> 3;
 191 }
 192
 193 static uint32_t mxs_nand_mark_bit_offset(struct mtd_info *mtd)
 194 {
 195         uint32_t ecc_strength;
 196         ecc_strength = mxs_nand_get_ecc_strength(mtd->writesize, mtd->oobsize);
 197         return mxs_nand_get_mark_offset(mtd->writesize, ecc_strength) & 0x7;
 198 }
 199
 200 /*
 201  * Wait for BCH complete IRQ and clear the IRQ
 202  */
 203 static int mxs_nand_wait_for_bch_complete(void)
 204 {
 205         struct mx28_bch_regs *bch_regs = (struct mx28_bch_regs *)MXS_BCH_BASE;
 206         int timeout = MXS_NAND_BCH_TIMEOUT;
 207         int ret;
 208
 209         ret = mx28_wait_mask_set(&bch_regs->hw_bch_ctrl_reg,
 210                 BCH_CTRL_COMPLETE_IRQ, timeout);
 211
 212         writel(BCH_CTRL_COMPLETE_IRQ, &bch_regs->hw_bch_ctrl_clr);
 213
 214         return ret;
 215 }
 216
 217 /*
 218  * This is the function that we install in the cmd_ctrl function pointer of the
 219  * owning struct nand_chip. The only functions in the reference implementation
 220  * that use these functions pointers are cmdfunc and select_chip.
 221  *
 222  * In this driver, we implement our own select_chip, so this function will only
 223  * be called by the reference implementation's cmdfunc. For this reason, we can
 224  * ignore the chip enable bit and concentrate only on sending bytes to the NAND
 225  * Flash.
 226  */
 227 static void mxs_nand_cmd_ctrl(struct mtd_info *mtd, int data, unsigned int ctrl)
 228 {
 229         struct nand_chip *nand = mtd->priv;
 230         struct mxs_nand_info *nand_info = nand->priv;
 231         struct mxs_dma_desc *d;
 232         uint32_t channel = MXS_DMA_CHANNEL_AHB_APBH_GPMI0 + nand_info->cur_chip;
 233         int ret;
 234
 235         /*
 236          * If this condition is true, something is _VERY_ wrong in MTD
 237          * subsystem!
 238          */
 239         if (nand_info->cmd_queue_len == MXS_NAND_COMMAND_BUFFER_SIZE) {
 240                 printf("MXS NAND: Command queue too long\n");
 241                 return;
 242         }
 243
 244         /*
 245          * Every operation begins with a command byte and a series of zero or
 246          * more address bytes. These are distinguished by either the Address
 247          * Latch Enable (ALE) or Command Latch Enable (CLE) signals being
 248          * asserted. When MTD is ready to execute the command, it will
 249          * deasert both latch enables.
 250          *
 251          * Rather than run a separate DMA operation for every single byte, we
 252          * queue them up and run a single DMA operation for the entire series
 253          * of command and data bytes.
 254          */
 255         if (ctrl & (NAND_ALE | NAND_CLE)) {
 256                 if (data != NAND_CMD_NONE)
 257                         nand_info->cmd_buf[nand_info->cmd_queue_len++] = data;
 258                 return;
 259         }
 260
 261         /*
 262          * If control arrives here, MTD has deasserted both the ALE and CLE,
 263          * which means it's ready to run an operation. Check if we have any
 264          * bytes to send.
 265          */
 266         if (nand_info->cmd_queue_len == 0)
 267                 return;
 268
 269         /* Compile the DMA descriptor -- a descriptor that sends command. */
 270         d = mxs_nand_get_dma_desc(nand_info);
 271         d->cmd.data =
 272                 MXS_DMA_DESC_COMMAND_DMA_READ | MXS_DMA_DESC_IRQ |
 273                 MXS_DMA_DESC_CHAIN | MXS_DMA_DESC_DEC_SEM |
 274                 MXS_DMA_DESC_WAIT4END | (3 << MXS_DMA_DESC_PIO_WORDS_OFFSET) |
 275                 (nand_info->cmd_queue_len << MXS_DMA_DESC_BYTES_OFFSET);
 276
 277         d->cmd.address = (dma_addr_t)nand_info->cmd_buf;
 278
 279         d->cmd.pio_words[0] =
 280                 GPMI_CTRL0_COMMAND_MODE_WRITE |
 281                 GPMI_CTRL0_WORD_LENGTH |
 282                 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
 283                 GPMI_CTRL0_ADDRESS_NAND_CLE |
 284                 GPMI_CTRL0_ADDRESS_INCREMENT |
 285                 nand_info->cmd_queue_len;
 286
 287         mxs_dma_desc_append(channel, d);
 288
 289         /* Execute the DMA chain. */
 290         ret = mxs_dma_go(channel);
 291         if (ret)
 292                 printf("MXS NAND: Error sending command\n");
 293
 294         mxs_nand_return_dma_descs(nand_info);
 295
 296         /* Reset the command queue. */
 297         nand_info->cmd_queue_len = 0;
 298 }
 299
 300 /*
 301  * Test if the NAND flash is ready.
 302  */
 303 static int mxs_nand_device_ready(struct mtd_info *mtd)
 304 {
 305         struct nand_chip *chip = mtd->priv;
 306         struct mxs_nand_info *nand_info = chip->priv;
 307         struct mx28_gpmi_regs *gpmi_regs =
 308                 (struct mx28_gpmi_regs *)MXS_GPMI_BASE;
 309         uint32_t tmp;
 310
 311         tmp = readl(&gpmi_regs->hw_gpmi_stat);
 312         tmp >>= (GPMI_STAT_READY_BUSY_OFFSET + nand_info->cur_chip);
 313
 314         return tmp & 1;
 315 }
 316
 317 /*
 318  * Select the NAND chip.
 319  */
 320 static void mxs_nand_select_chip(struct mtd_info *mtd, int chip)
 321 {
 322         struct nand_chip *nand = mtd->priv;
 323         struct mxs_nand_info *nand_info = nand->priv;
 324
 325         nand_info->cur_chip = chip;
 326 }
 327
 328 /*
 329  * Handle block mark swapping.
 330  *
 331  * Note that, when this function is called, it doesn't know whether it's
 332  * swapping the block mark, or swapping it *back* -- but it doesn't matter
 333  * because the the operation is the same.
 334  */
 335 static void mxs_nand_swap_block_mark(struct mtd_info *mtd,
 336                                         uint8_t *data_buf, uint8_t *oob_buf)
 337 {
 338         uint32_t bit_offset;
 339         uint32_t buf_offset;
 340
 341         uint32_t src;
 342         uint32_t dst;
 343
 344         bit_offset = mxs_nand_mark_bit_offset(mtd);
 345         buf_offset = mxs_nand_mark_byte_offset(mtd);
 346
 347         /*
 348          * Get the byte from the data area that overlays the block mark. Since
 349          * the ECC engine applies its own view to the bits in the page, the
 350          * physical block mark won't (in general) appear on a byte boundary in
 351          * the data.
 352          */
 353         src = data_buf[buf_offset] >> bit_offset;
 354         src |= data_buf[buf_offset + 1] << (8 - bit_offset);
 355
 356         dst = oob_buf[0];
 357
 358         oob_buf[0] = src;
 359
 360         data_buf[buf_offset] &= ~(0xff << bit_offset);
 361         data_buf[buf_offset + 1] &= 0xff << bit_offset;
 362
 363         data_buf[buf_offset] |= dst << bit_offset;
 364         data_buf[buf_offset + 1] |= dst >> (8 - bit_offset);
 365 }
 366
 367 /*
 368  * Read data from NAND.
 369  */
 370 static void mxs_nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int length)
 371 {
 372         struct nand_chip *nand = mtd->priv;
 373         struct mxs_nand_info *nand_info = nand->priv;
 374         struct mxs_dma_desc *d;
 375         uint32_t channel = MXS_DMA_CHANNEL_AHB_APBH_GPMI0 + nand_info->cur_chip;
 376         int ret;
 377
 378         if (length > NAND_MAX_PAGESIZE) {
 379                 printf("MXS NAND: DMA buffer too big\n");
 380                 return;
 381         }
 382
 383         if (!buf) {
 384                 printf("MXS NAND: DMA buffer is NULL\n");
 385                 return;
 386         }
 387
 388         /* Compile the DMA descriptor - a descriptor that reads data. */
 389         d = mxs_nand_get_dma_desc(nand_info);
 390         d->cmd.data =
 391                 MXS_DMA_DESC_COMMAND_DMA_WRITE | MXS_DMA_DESC_IRQ |
 392                 MXS_DMA_DESC_DEC_SEM | MXS_DMA_DESC_WAIT4END |
 393                 (1 << MXS_DMA_DESC_PIO_WORDS_OFFSET) |
 394                 (length << MXS_DMA_DESC_BYTES_OFFSET);
 395
 396         d->cmd.address = (dma_addr_t)nand_info->data_buf;
 397
 398         d->cmd.pio_words[0] =
 399                 GPMI_CTRL0_COMMAND_MODE_READ |
 400                 GPMI_CTRL0_WORD_LENGTH |
 401                 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
 402                 GPMI_CTRL0_ADDRESS_NAND_DATA |
 403                 length;
 404
 405         mxs_dma_desc_append(channel, d);
 406
 407         /*
 408          * A DMA descriptor that waits for the command to end and the chip to
 409          * become ready.
 410          *
 411          * I think we actually should *not* be waiting for the chip to become
 412          * ready because, after all, we don't care. I think the original code
 413          * did that and no one has re-thought it yet.
 414          */
 415         d = mxs_nand_get_dma_desc(nand_info);
 416         d->cmd.data =
 417                 MXS_DMA_DESC_COMMAND_NO_DMAXFER | MXS_DMA_DESC_IRQ |
 418                 MXS_DMA_DESC_NAND_WAIT_4_READY | MXS_DMA_DESC_DEC_SEM |
 419                 MXS_DMA_DESC_WAIT4END | (4 << MXS_DMA_DESC_PIO_WORDS_OFFSET);
 420
 421         d->cmd.address = 0;
 422
 423         d->cmd.pio_words[0] =
 424                 GPMI_CTRL0_COMMAND_MODE_WAIT_FOR_READY |
 425                 GPMI_CTRL0_WORD_LENGTH |
 426                 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
 427                 GPMI_CTRL0_ADDRESS_NAND_DATA;
 428
 429         mxs_dma_desc_append(channel, d);
 430
 431         /* Execute the DMA chain. */
 432         ret = mxs_dma_go(channel);
 433         if (ret) {
 434                 printf("MXS NAND: DMA read error\n");
 435                 goto rtn;
 436         }
 437
 438         memcpy(buf, nand_info->data_buf, length);
 439
 440 rtn:
 441         mxs_nand_return_dma_descs(nand_info);
 442 }
 443
 444 /*
 445  * Write data to NAND.
 446  */
 447 static void mxs_nand_write_buf(struct mtd_info *mtd, const uint8_t *buf,
 448                                 int length)
 449 {
 450         struct nand_chip *nand = mtd->priv;
 451         struct mxs_nand_info *nand_info = nand->priv;
 452         struct mxs_dma_desc *d;
 453         uint32_t channel = MXS_DMA_CHANNEL_AHB_APBH_GPMI0 + nand_info->cur_chip;
 454         int ret;
 455
 456         if (length > NAND_MAX_PAGESIZE) {
 457                 printf("MXS NAND: DMA buffer too big\n");
 458                 return;
 459         }
 460
 461         if (!buf) {
 462                 printf("MXS NAND: DMA buffer is NULL\n");
 463                 return;
 464         }
 465
 466         memcpy(nand_info->data_buf, buf, length);
 467
 468         /* Compile the DMA descriptor - a descriptor that writes data. */
 469         d = mxs_nand_get_dma_desc(nand_info);
 470         d->cmd.data =
 471                 MXS_DMA_DESC_COMMAND_DMA_READ | MXS_DMA_DESC_IRQ |
 472                 MXS_DMA_DESC_DEC_SEM | MXS_DMA_DESC_WAIT4END |
 473                 (4 << MXS_DMA_DESC_PIO_WORDS_OFFSET) |
 474                 (length << MXS_DMA_DESC_BYTES_OFFSET);
 475
 476         d->cmd.address = (dma_addr_t)nand_info->data_buf;
 477
 478         d->cmd.pio_words[0] =
 479                 GPMI_CTRL0_COMMAND_MODE_WRITE |
 480                 GPMI_CTRL0_WORD_LENGTH |
 481                 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
 482                 GPMI_CTRL0_ADDRESS_NAND_DATA |
 483                 length;
 484
 485         mxs_dma_desc_append(channel, d);
 486
 487         /* Execute the DMA chain. */
 488         ret = mxs_dma_go(channel);
 489         if (ret)
 490                 printf("MXS NAND: DMA write error\n");
 491
 492         mxs_nand_return_dma_descs(nand_info);
 493 }
 494
 495 /*
 496  * Read a single byte from NAND.
 497  */
 498 static uint8_t mxs_nand_read_byte(struct mtd_info *mtd)
 499 {
 500         uint8_t buf;
 501         mxs_nand_read_buf(mtd, &buf, 1);
 502         return buf;
 503 }
 504
 505 static void invalidate_buffers(struct mtd_info *mtd, struct mxs_nand_info *nand_info)
 506 {
 507         invalidate_dcache_range((unsigned long)nand_info->data_buf,
 508                                 (unsigned long)nand_info->data_buf +
 509                                 mtd->writesize);
 510         invalidate_dcache_range((unsigned long)nand_info->oob_buf,
 511                                 (unsigned long)nand_info->oob_buf +
 512                                 mtd->oobsize);
 513 }
 514
 515 static void flush_buffers(struct mtd_info *mtd, struct mxs_nand_info *nand_info)
 516 {
 517         flush_dcache_range((unsigned long)nand_info->data_buf,
 518                         (unsigned long)nand_info->data_buf +
 519                         mtd->writesize);
 520         flush_dcache_range((unsigned long)nand_info->oob_buf,
 521                         (unsigned long)nand_info->oob_buf +
 522                         mtd->oobsize);
 523 }
 524
 525 /*
 526  * Read a page from NAND.
 527  */
 528 static int mxs_nand_ecc_read_page(struct mtd_info *mtd, struct nand_chip *nand,
 529                                         uint8_t *buf, int page)
 530 {
 531         struct mxs_nand_info *nand_info = nand->priv;
 532         struct mxs_dma_desc *d;
 533         uint32_t channel = MXS_DMA_CHANNEL_AHB_APBH_GPMI0 + nand_info->cur_chip;
 534         uint32_t corrected = 0, failed = 0;
 535         uint8_t *status;
 536         int i, ret;
 537
 538         /* Compile the DMA descriptor - wait for ready. */
 539         d = mxs_nand_get_dma_desc(nand_info);
 540         d->cmd.data =
 541                 MXS_DMA_DESC_COMMAND_NO_DMAXFER | MXS_DMA_DESC_CHAIN |
 542                 MXS_DMA_DESC_NAND_WAIT_4_READY | MXS_DMA_DESC_WAIT4END |
 543                 (1 << MXS_DMA_DESC_PIO_WORDS_OFFSET);
 544
 545         d->cmd.address = 0;
 546
 547         d->cmd.pio_words[0] =
 548                 GPMI_CTRL0_COMMAND_MODE_WAIT_FOR_READY |
 549                 GPMI_CTRL0_WORD_LENGTH |
 550                 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
 551                 GPMI_CTRL0_ADDRESS_NAND_DATA;
 552
 553         mxs_dma_desc_append(channel, d);
 554
 555         /* Compile the DMA descriptor - enable the BCH block and read. */
 556         d = mxs_nand_get_dma_desc(nand_info);
 557         d->cmd.data =
 558                 MXS_DMA_DESC_COMMAND_NO_DMAXFER | MXS_DMA_DESC_CHAIN |
 559                 MXS_DMA_DESC_WAIT4END | (6 << MXS_DMA_DESC_PIO_WORDS_OFFSET);
 560
 561         d->cmd.address = 0;
 562
 563         d->cmd.pio_words[0] =
 564                 GPMI_CTRL0_COMMAND_MODE_READ |
 565                 GPMI_CTRL0_WORD_LENGTH |
 566                 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
 567                 GPMI_CTRL0_ADDRESS_NAND_DATA |
 568                 (mtd->writesize + mtd->oobsize);
 569         d->cmd.pio_words[1] = 0;
 570         d->cmd.pio_words[2] =
 571                 GPMI_ECCCTRL_ENABLE_ECC |
 572                 GPMI_ECCCTRL_ECC_CMD_DECODE |
 573                 GPMI_ECCCTRL_BUFFER_MASK_BCH_PAGE;
 574         d->cmd.pio_words[3] = mtd->writesize + mtd->oobsize;
 575         d->cmd.pio_words[4] = (dma_addr_t)nand_info->data_buf;
 576         d->cmd.pio_words[5] = (dma_addr_t)nand_info->oob_buf;
 577
 578         flush_buffers(mtd, nand_info);
 579
 580         mxs_dma_desc_append(channel, d);
 581
 582         /* Compile the DMA descriptor - disable the BCH block. */
 583         d = mxs_nand_get_dma_desc(nand_info);
 584         d->cmd.data =
 585                 MXS_DMA_DESC_COMMAND_NO_DMAXFER | MXS_DMA_DESC_CHAIN |
 586                 MXS_DMA_DESC_NAND_WAIT_4_READY | MXS_DMA_DESC_WAIT4END |
 587                 (3 << MXS_DMA_DESC_PIO_WORDS_OFFSET);
 588
 589         d->cmd.address = 0;
 590
 591         d->cmd.pio_words[0] =
 592                 GPMI_CTRL0_COMMAND_MODE_WAIT_FOR_READY |
 593                 GPMI_CTRL0_WORD_LENGTH |
 594                 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
 595                 GPMI_CTRL0_ADDRESS_NAND_DATA |
 596                 (mtd->writesize + mtd->oobsize);
 597         d->cmd.pio_words[1] = 0;
 598         d->cmd.pio_words[2] = 0;
 599
 600         mxs_dma_desc_append(channel, d);
 601
 602         /* Compile the DMA descriptor - deassert the NAND lock and interrupt. */
 603         d = mxs_nand_get_dma_desc(nand_info);
 604         d->cmd.data =
 605                 MXS_DMA_DESC_COMMAND_NO_DMAXFER | MXS_DMA_DESC_IRQ |
 606                 MXS_DMA_DESC_DEC_SEM;
 607
 608         d->cmd.address = 0;
 609
 610         mxs_dma_desc_append(channel, d);
 611
 612         /* Execute the DMA chain. */
 613         ret = mxs_dma_go(channel);
 614         if (ret) {
 615                 printf("MXS NAND: DMA read error\n");
 616                 goto rtn;
 617         }
 618
 619         ret = mxs_nand_wait_for_bch_complete();
 620         if (ret) {
 621                 printf("MXS NAND: BCH read timeout\n");
 622                 goto rtn;
 623         }
 624
 625         invalidate_buffers(mtd, nand_info);
 626
 627         /* Read DMA completed, now do the mark swapping. */
 628         mxs_nand_swap_block_mark(mtd, nand_info->data_buf, nand_info->oob_buf);
 629
 630         /* Loop over status bytes, accumulating ECC status. */
 631         status = nand_info->oob_buf + mxs_nand_aux_status_offset();
 632         for (i = 0; i < mxs_nand_ecc_chunk_cnt(mtd->writesize); i++) {
 633                 if (status[i] == 0x00)
 634                         continue;
 635
 636                 if (status[i] == 0xff)
 637                         continue;
 638
 639                 if (status[i] == 0xfe) {
 640                         failed++;
 641                         continue;
 642                 }
 643
 644                 corrected += status[i];
 645         }
 646
 647         /* Propagate ECC status to the owning MTD. */
 648         mtd->ecc_stats.failed += failed;
 649         mtd->ecc_stats.corrected += corrected;
 650
 651         /*
 652          * It's time to deliver the OOB bytes. See mxs_nand_ecc_read_oob() for
 653          * details about our policy for delivering the OOB.
 654          *
 655          * We fill the caller's buffer with set bits, and then copy the block
 656          * mark to the caller's buffer. Note that, if block mark swapping was
 657          * necessary, it has already been done, so we can rely on the first
 658          * byte of the auxiliary buffer to contain the block mark.
 659          */
 660         memset(nand->oob_poi, 0xff, mtd->oobsize);
 661
 662         nand->oob_poi[0] = nand_info->oob_buf[0];
 663
 664         memcpy(buf, nand_info->data_buf, mtd->writesize);
 665
 666 rtn:
 667         mxs_nand_return_dma_descs(nand_info);
 668
 669         return ret;
 670 }
 671
 672 /*
 673  * Write a page to NAND.
 674  */
 675 static void mxs_nand_ecc_write_page(struct mtd_info *mtd,
 676                                 struct nand_chip *nand, const uint8_t *buf)
 677 {
 678         struct mxs_nand_info *nand_info = nand->priv;
 679         struct mxs_dma_desc *d;
 680         uint32_t channel = MXS_DMA_CHANNEL_AHB_APBH_GPMI0 + nand_info->cur_chip;
 681         int ret;
 682
 683         memcpy(nand_info->data_buf, buf, mtd->writesize);
 684         memcpy(nand_info->oob_buf, nand->oob_poi, mtd->oobsize);
 685
 686         /* Handle block mark swapping. */
 687         mxs_nand_swap_block_mark(mtd, nand_info->data_buf, nand_info->oob_buf);
 688
 689         /* Compile the DMA descriptor - write data. */
 690         d = mxs_nand_get_dma_desc(nand_info);
 691         d->cmd.data =
 692                 MXS_DMA_DESC_COMMAND_NO_DMAXFER | MXS_DMA_DESC_IRQ |
 693                 MXS_DMA_DESC_DEC_SEM | MXS_DMA_DESC_WAIT4END |
 694                 (6 << MXS_DMA_DESC_PIO_WORDS_OFFSET);
 695
 696         d->cmd.address = 0;
 697
 698         d->cmd.pio_words[0] =
 699                 GPMI_CTRL0_COMMAND_MODE_WRITE |
 700                 GPMI_CTRL0_WORD_LENGTH |
 701                 (nand_info->cur_chip << GPMI_CTRL0_CS_OFFSET) |
 702                 GPMI_CTRL0_ADDRESS_NAND_DATA;
 703         d->cmd.pio_words[1] = 0;
 704         d->cmd.pio_words[2] =
 705                 GPMI_ECCCTRL_ENABLE_ECC |
 706                 GPMI_ECCCTRL_ECC_CMD_ENCODE |
 707                 GPMI_ECCCTRL_BUFFER_MASK_BCH_PAGE;
 708         d->cmd.pio_words[3] = mtd->writesize + mtd->oobsize;
 709         d->cmd.pio_words[4] = (dma_addr_t)nand_info->data_buf;
 710         d->cmd.pio_words[5] = (dma_addr_t)nand_info->oob_buf;
 711
 712         flush_buffers(mtd, nand_info);
 713
 714         mxs_dma_desc_append(channel, d);
 715
 716         /* Execute the DMA chain. */
 717         ret = mxs_dma_go(channel);
 718         if (ret) {
 719                 printf("MXS NAND: DMA write error\n");
 720                 goto rtn;
 721         }
 722
 723         ret = mxs_nand_wait_for_bch_complete();
 724         if (ret) {
 725                 printf("MXS NAND: BCH write timeout\n");
 726                 goto rtn;
 727         }
 728
 729 rtn:
 730         mxs_nand_return_dma_descs(nand_info);
 731 }
 732
 733 /*
 734  * Read OOB from NAND.
 735  *
 736  * This function is a veneer that replaces the function originally installed by
 737  * the NAND Flash MTD code.
 738  */
 739 static int mxs_nand_hook_read_oob(struct mtd_info *mtd, loff_t from,
 740                                         struct mtd_oob_ops *ops)
 741 {
 742         struct nand_chip *chip = mtd->priv;
 743         struct mxs_nand_info *nand_info = chip->priv;
 744         int ret;
 745
 746         if (ops->mode == MTD_OOB_RAW)
 747                 nand_info->raw_oob_mode = 1;
 748         else
 749                 nand_info->raw_oob_mode = 0;
 750
 751         ret = nand_info->hooked_read_oob(mtd, from, ops);
 752
 753         nand_info->raw_oob_mode = 0;
 754
 755         return ret;
 756 }
 757
 758 /*
 759  * Write OOB to NAND.
 760  *
 761  * This function is a veneer that replaces the function originally installed by
 762  * the NAND Flash MTD code.
 763  */
 764 static int mxs_nand_hook_write_oob(struct mtd_info *mtd, loff_t to,
 765                                         struct mtd_oob_ops *ops)
 766 {
 767         struct nand_chip *chip = mtd->priv;
 768         struct mxs_nand_info *nand_info = chip->priv;
 769         int ret;
 770
 771         if (ops->mode == MTD_OOB_RAW)
 772                 nand_info->raw_oob_mode = 1;
 773         else
 774                 nand_info->raw_oob_mode = 0;
 775
 776         ret = nand_info->hooked_write_oob(mtd, to, ops);
 777
 778         nand_info->raw_oob_mode = 0;
 779
 780         return ret;
 781 }
 782
 783 /*
 784  * Mark a block bad in NAND.
 785  *
 786  * This function is a veneer that replaces the function originally installed by
 787  * the NAND Flash MTD code.
 788  */
 789 static int mxs_nand_hook_block_markbad(struct mtd_info *mtd, loff_t ofs)
 790 {
 791         struct nand_chip *chip = mtd->priv;
 792         struct mxs_nand_info *nand_info = chip->priv;
 793         int ret;
 794
 795         nand_info->marking_block_bad = 1;
 796
 797         ret = nand_info->hooked_block_markbad(mtd, ofs);
 798
 799         nand_info->marking_block_bad = 0;
 800
 801         return ret;
 802 }
 803
 804 /*
 805  * There are several places in this driver where we have to handle the OOB and
 806  * block marks. This is the function where things are the most complicated, so
 807  * this is where we try to explain it all. All the other places refer back to
 808  * here.
 809  *
 810  * These are the rules, in order of decreasing importance:
 811  *
 812  * 1) Nothing the caller does can be allowed to imperil the block mark, so all
 813  *    write operations take measures to protect it.
 814  *
 815  * 2) In read operations, the first byte of the OOB we return must reflect the
 816  *    true state of the block mark, no matter where that block mark appears in
 817  *    the physical page.
 818  *
 819  * 3) ECC-based read operations return an OOB full of set bits (since we never
 820  *    allow ECC-based writes to the OOB, it doesn't matter what ECC-based reads
 821  *    return).
 822  *
 823  * 4) "Raw" read operations return a direct view of the physical bytes in the
 824  *    page, using the conventional definition of which bytes are data and which
 825  *    are OOB. This gives the caller a way to see the actual, physical bytes
 826  *    in the page, without the distortions applied by our ECC engine.
 827  *
 828  * What we do for this specific read operation depends on whether we're doing
 829  * "raw" read, or an ECC-based read.
 830  *
 831  * It turns out that knowing whether we want an "ECC-based" or "raw" read is not
 832  * easy. When reading a page, for example, the NAND Flash MTD code calls our
 833  * ecc.read_page or ecc.read_page_raw function. Thus, the fact that MTD wants an
 834  * ECC-based or raw view of the page is implicit in which function it calls
 835  * (there is a similar pair of ECC-based/raw functions for writing).
 836  *
 837  * Since MTD assumes the OOB is not covered by ECC, there is no pair of
 838  * ECC-based/raw functions for reading or or writing the OOB. The fact that the
 839  * caller wants an ECC-based or raw view of the page is not propagated down to
 840  * this driver.
 841  *
 842  * Since our OOB *is* covered by ECC, we need this information. So, we hook the
 843  * ecc.read_oob and ecc.write_oob function pointers in the owning
 844  * struct mtd_info with our own functions. These hook functions set the
 845  * raw_oob_mode field so that, when control finally arrives here, we'll know
 846  * what to do.
 847  */
 848 static int mxs_nand_ecc_read_oob(struct mtd_info *mtd, struct nand_chip *nand,
 849                                 int page, int cmd)
 850 {
 851         struct mxs_nand_info *nand_info = nand->priv;
 852
 853         /*
 854          * First, fill in the OOB buffer. If we're doing a raw read, we need to
 855          * get the bytes from the physical page. If we're not doing a raw read,
 856          * we need to fill the buffer with set bits.
 857          */
 858         if (nand_info->raw_oob_mode) {
 859                 /*
 860                  * If control arrives here, we're doing a "raw" read. Send the
 861                  * command to read the conventional OOB and read it.
 862                  */
 863                 nand->cmdfunc(mtd, NAND_CMD_READ0, mtd->writesize, page);
 864                 nand->read_buf(mtd, nand->oob_poi, mtd->oobsize);
 865         } else {
 866                 /*
 867                  * If control arrives here, we're not doing a "raw" read. Fill
 868                  * the OOB buffer with set bits and correct the block mark.
 869                  */
 870                 memset(nand->oob_poi, 0xff, mtd->oobsize);
 871
 872                 nand->cmdfunc(mtd, NAND_CMD_READ0, mtd->writesize, page);
 873                 mxs_nand_read_buf(mtd, nand->oob_poi, 1);
 874         }
 875
 876         return 0;
 877
 878 }
 879
 880 /*
 881  * Write OOB data to NAND.
 882  */
 883 static int mxs_nand_ecc_write_oob(struct mtd_info *mtd, struct nand_chip *nand,
 884                                         int page)
 885 {
 886         struct mxs_nand_info *nand_info = nand->priv;
 887         uint8_t block_mark = 0;
 888
 889         /*
 890          * There are fundamental incompatibilities between the i.MX GPMI NFC and
 891          * the NAND Flash MTD model that make it essentially impossible to write
 892          * the out-of-band bytes.
 893          *
 894          * We permit *ONE* exception. If the *intent* of writing the OOB is to
 895          * mark a block bad, we can do that.
 896          */
 897
 898         if (!nand_info->marking_block_bad) {
 899                 printf("NXS NAND: Writing OOB isn't supported\n");
 900                 return -EIO;
 901         }
 902
 903         /* Write the block mark. */
 904         nand->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize, page);
 905         nand->write_buf(mtd, &block_mark, 1);
 906         nand->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
 907
 908         /* Check if it worked. */
 909         if (nand->waitfunc(mtd, nand) & NAND_STATUS_FAIL)
 910                 return -EIO;
 911
 912         return 0;
 913 }
 914
 915 /*
 916  * Claims all blocks are good.
 917  *
 918  * In principle, this function is *only* called when the NAND Flash MTD system
 919  * isn't allowed to keep an in-memory bad block table, so it is forced to ask
 920  * the driver for bad block information.
 921  *
 922  * In fact, we permit the NAND Flash MTD system to have an in-memory BBT, so
 923  * this function is *only* called when we take it away.
 924  *
 925  * Thus, this function is only called when we want *all* blocks to look good,
 926  * so it *always* return success.
 927  */
 928 static int mxs_nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
 929 {
 930         return 0;
 931 }
 932
 933 /*
 934  * Nominally, the purpose of this function is to look for or create the bad
 935  * block table. In fact, since the we call this function at the very end of
 936  * the initialization process started by nand_scan(), and we don't have a
 937  * more formal mechanism, we "hook" this function to continue init process.
 938  *
 939  * At this point, the physical NAND Flash chips have been identified and
 940  * counted, so we know the physical geometry. This enables us to make some
 941  * important configuration decisions.
 942  *
 943  * The return value of this function propogates directly back to this driver's
 944  * call to nand_scan(). Anything other than zero will cause this driver to
 945  * tear everything down and declare failure.
 946  */
 947 static int mxs_nand_scan_bbt(struct mtd_info *mtd)
 948 {
 949         struct nand_chip *nand = mtd->priv;
 950         struct mxs_nand_info *nand_info = nand->priv;
 951         struct mx28_bch_regs *bch_regs = (struct mx28_bch_regs *)MXS_BCH_BASE;
 952         uint32_t tmp;
 953
 954         /* Configure BCH and set NFC geometry */
 955         if (readl(&bch_regs->hw_bch_ctrl_reg) &
 956                 (BCH_CTRL_SFTRST | BCH_CTRL_CLKGATE))
 957                 /* When booting from NAND the BCH engine will already
 958                  * be operational and obviously does not like being reset here.
 959                  * There will be occasional read errors upon boot when this
 960                  * reset is done.
 961                  */
 962                 mx28_reset_block(&bch_regs->hw_bch_ctrl_reg);
 963
 964         /* Configure layout 0 */
 965         tmp = (mxs_nand_ecc_chunk_cnt(mtd->writesize) - 1)
 966                 << BCH_FLASHLAYOUT0_NBLOCKS_OFFSET;
 967         tmp |= MXS_NAND_METADATA_SIZE << BCH_FLASHLAYOUT0_META_SIZE_OFFSET;
 968         tmp |= (mxs_nand_get_ecc_strength(mtd->writesize, mtd->oobsize) >> 1)
 969                 << BCH_FLASHLAYOUT0_ECC0_OFFSET;
 970         tmp |= MXS_NAND_CHUNK_DATA_CHUNK_SIZE;
 971         writel(tmp, &bch_regs->hw_bch_flash0layout0);
 972
 973         tmp = (mtd->writesize + mtd->oobsize)
 974                 << BCH_FLASHLAYOUT1_PAGE_SIZE_OFFSET;
 975         tmp |= (mxs_nand_get_ecc_strength(mtd->writesize, mtd->oobsize) >> 1)
 976                 << BCH_FLASHLAYOUT1_ECCN_OFFSET;
 977         tmp |= MXS_NAND_CHUNK_DATA_CHUNK_SIZE;
 978         writel(tmp, &bch_regs->hw_bch_flash0layout1);
 979
 980         /* Set *all* chip selects to use layout 0 */
 981         writel(0, &bch_regs->hw_bch_layoutselect);
 982
 983         /* Enable BCH complete interrupt */
 984         writel(BCH_CTRL_COMPLETE_IRQ_EN, &bch_regs->hw_bch_ctrl_set);
 985
 986         /* Hook some operations at the MTD level. */
 987         if (mtd->read_oob != mxs_nand_hook_read_oob) {
 988                 nand_info->hooked_read_oob = mtd->read_oob;
 989                 mtd->read_oob = mxs_nand_hook_read_oob;
 990         }
 991
 992         if (mtd->write_oob != mxs_nand_hook_write_oob) {
 993                 nand_info->hooked_write_oob = mtd->write_oob;
 994                 mtd->write_oob = mxs_nand_hook_write_oob;
 995         }
 996
 997         if (mtd->block_markbad != mxs_nand_hook_block_markbad) {
 998                 nand_info->hooked_block_markbad = mtd->block_markbad;
 999                 mtd->block_markbad = mxs_nand_hook_block_markbad;
1000         }
1001
1002         /* We use the reference implementation for bad block management. */
1003         return nand_default_bbt(mtd);
1004 }
1005
1006 /*
1007  * Allocate DMA buffers
1008  */
1009 int mxs_nand_alloc_buffers(struct mxs_nand_info *nand_info)
1010 {
1011         uint8_t *buf;
1012         const int size = NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE;
1013
1014         /* DMA buffers */
1015         buf = memalign(MXS_DMA_ALIGNMENT, size);
1016         if (!buf) {
1017                 printf("MXS NAND: Error allocating DMA buffers\n");
1018                 return -ENOMEM;
1019         }
1020
1021         memset(buf, 0, size);
1022
1023         nand_info->data_buf = buf;
1024         nand_info->oob_buf = buf + NAND_MAX_PAGESIZE;
1025
1026         /* Command buffers */
1027         nand_info->cmd_buf = memalign(MXS_DMA_ALIGNMENT,
1028                                 MXS_NAND_COMMAND_BUFFER_SIZE);
1029         if (!nand_info->cmd_buf) {
1030                 free(buf);
1031                 printf("MXS NAND: Error allocating command buffers\n");
1032                 return -ENOMEM;
1033         }
1034         memset(nand_info->cmd_buf, 0, MXS_NAND_COMMAND_BUFFER_SIZE);
1035         nand_info->cmd_queue_len = 0;
1036
1037         return 0;
1038 }
1039
1040 /*
1041  * Initializes the NFC hardware.
1042  */
1043 int mxs_nand_init(struct mxs_nand_info *info)
1044 {
1045         struct mx28_gpmi_regs *gpmi_regs =
1046                 (struct mx28_gpmi_regs *)MXS_GPMI_BASE;
1047         int i = 0;
1048
1049         info->desc = malloc(sizeof(struct mxs_dma_desc *) *
1050                                 MXS_NAND_DMA_DESCRIPTOR_COUNT);
1051         if (!info->desc)
1052                 goto err1;
1053
1054         /* Allocate the DMA descriptors. */
1055         for (i = 0; i < MXS_NAND_DMA_DESCRIPTOR_COUNT; i++) {
1056                 info->desc[i] = mxs_dma_desc_alloc();
1057                 if (!info->desc[i])
1058                         goto err2;
1059         }
1060
1061         /* Init the DMA controller. */
1062         mxs_dma_init();
1063
1064         /* Reset the GPMI block. */
1065         mx28_reset_block(&gpmi_regs->hw_gpmi_ctrl0_reg);
1066
1067         /*
1068          * Choose NAND mode, set IRQ polarity, disable write protection and
1069          * select BCH ECC.
1070          */
1071         clrsetbits_le32(&gpmi_regs->hw_gpmi_ctrl1,
1072                         GPMI_CTRL1_GPMI_MODE,
1073                         GPMI_CTRL1_ATA_IRQRDY_POLARITY | GPMI_CTRL1_DEV_RESET |
1074                         GPMI_CTRL1_BCH_MODE);
1075
1076         return 0;
1077
1078 err2:
1079         free(info->desc);
1080 err1:
1081         for (--i; i >= 0; i--)
1082                 mxs_dma_desc_free(info->desc[i]);
1083         printf("MXS NAND: Unable to allocate DMA descriptors\n");
1084         return -ENOMEM;
1085 }
1086
1087 /*!
1088  * This function is called during the driver binding process.
1089  *
1090  * @param   pdev  the device structure used to store device specific
1091  *                information that is used by the suspend, resume and
1092  *                remove functions
1093  *
1094  * @return  The function always returns 0.
1095  */
1096 int board_nand_init(struct nand_chip *nand)
1097 {
1098         struct mxs_nand_info *nand_info;
1099         int err;
1100
1101         nand_info = malloc(sizeof(struct mxs_nand_info));
1102         if (!nand_info) {
1103                 printf("MXS NAND: Failed to allocate private data\n");
1104                 return -ENOMEM;
1105         }
1106         memset(nand_info, 0, sizeof(struct mxs_nand_info));
1107
1108         err = mxs_nand_alloc_buffers(nand_info);
1109         if (err)
1110                 goto err1;
1111
1112         err = mxs_nand_init(nand_info);
1113         if (err)
1114                 goto err2;
1115
1116         memset(&fake_ecc_layout, 0, sizeof(fake_ecc_layout));
1117
1118         nand->priv = nand_info;
1119         nand->options |= NAND_NO_SUBPAGE_WRITE;
1120 #ifdef CONFIG_SYS_NAND_USE_FLASH_BBT
1121         nand->options |= NAND_USE_FLASH_BBT | NAND_USE_FLASH_BBT_NO_OOB;
1122 #endif
1123         nand->cmd_ctrl          = mxs_nand_cmd_ctrl;
1124
1125         nand->dev_ready         = mxs_nand_device_ready;
1126         nand->select_chip       = mxs_nand_select_chip;
1127         nand->block_bad         = mxs_nand_block_bad;
1128         nand->scan_bbt          = mxs_nand_scan_bbt;
1129
1130         nand->read_byte         = mxs_nand_read_byte;
1131
1132         nand->read_buf          = mxs_nand_read_buf;
1133         nand->write_buf         = mxs_nand_write_buf;
1134
1135         nand->ecc.read_page     = mxs_nand_ecc_read_page;
1136         nand->ecc.write_page    = mxs_nand_ecc_write_page;
1137         nand->ecc.read_oob      = mxs_nand_ecc_read_oob;
1138         nand->ecc.write_oob     = mxs_nand_ecc_write_oob;
1139
1140         nand->ecc.layout        = &fake_ecc_layout;
1141         nand->ecc.mode          = NAND_ECC_HW;
1142         nand->ecc.bytes         = 9;
1143         nand->ecc.size          = 512;
1144
1145         return 0;
1146
1147 err2:
1148         free(nand_info->data_buf);
1149         free(nand_info->cmd_buf);
1150 err1:
1151         free(nand_info);
1152         return err;
1153 }