cpu/arm926ejs/davinci/nand.c

   1 /*
   2  * NAND driver for TI DaVinci based boards.
   3  *
   4  * Copyright (C) 2007 Sergey Kubushyn <ksi@koi8.net>
   5  *
   6  * Based on Linux DaVinci NAND driver by TI. Original copyright follows:
   7  */
   8
   9 /*
  10  *
  11  * linux/drivers/mtd/nand/nand_davinci.c
  12  *
  13  * NAND Flash Driver
  14  *
  15  * Copyright (C) 2006 Texas Instruments.
  16  *
  17  * ----------------------------------------------------------------------------
  18  *
  19  * This program is free software; you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation; either version 2 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  *  You should have received a copy of the GNU General Public License
  30  *  along with this program; if not, write to the Free Software
  31  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  32  * ----------------------------------------------------------------------------
  33  *
  34  *  Overview:
  35  *   This is a device driver for the NAND flash device found on the
  36  *   DaVinci board which utilizes the Samsung k9k2g08 part.
  37  *
  38  Modifications:
  39  ver. 1.0: Feb 2005, Vinod/Sudhakar
  40  -
  41  *
  42  */
  43
  44 #include <common.h>
  45 #include <asm/io.h>
  46
  47 #ifdef CFG_USE_NAND
  48 #if !defined(CFG_NAND_LEGACY)
  49
  50 #include <nand.h>
  51 #include <asm/arch/nand_defs.h>
  52 #include <asm/arch/emif_defs.h>
  53
  54 extern struct nand_chip nand_dev_desc[CFG_MAX_NAND_DEVICE];
  55
  56 static void nand_davinci_hwcontrol(struct mtd_info *mtd, int cmd, unsigned int ctrl)
  57 {
  58         struct          nand_chip *this = mtd->priv;
  59         u_int32_t       IO_ADDR_W = (u_int32_t)this->IO_ADDR_W;
  60
  61         IO_ADDR_W &= ~(MASK_ALE|MASK_CLE);
  62
  63         if (ctrl & NAND_CTRL_CHANGE) {
  64                 if ( ctrl & NAND_CLE )
  65                         IO_ADDR_W |= MASK_CLE;
  66                 if ( ctrl & NAND_ALE )
  67                         IO_ADDR_W |= MASK_ALE;
  68                 this->IO_ADDR_W = (void __iomem *) IO_ADDR_W;
  69         }
  70
  71         if (cmd != NAND_CMD_NONE)
  72                 writeb(cmd, this->IO_ADDR_W);
  73 }
  74
  75 /* Set WP on deselect, write enable on select */
  76 static void nand_davinci_select_chip(struct mtd_info *mtd, int chip)
  77 {
  78 #define GPIO_SET_DATA01 0x01c67018
  79 #define GPIO_CLR_DATA01 0x01c6701c
  80 #define GPIO_NAND_WP    (1 << 4)
  81 #ifdef SONATA_BOARD_GPIOWP
  82         if (chip < 0) {
  83                 REG(GPIO_CLR_DATA01) |= GPIO_NAND_WP;
  84         } else {
  85                 REG(GPIO_SET_DATA01) |= GPIO_NAND_WP;
  86         }
  87 #endif
  88 }
  89
  90 #ifdef CFG_NAND_HW_ECC
  91 #ifdef CFG_NAND_LARGEPAGE
  92 static struct nand_ecclayout davinci_nand_ecclayout = {
  93         .useecc = MTD_NANDECC_AUTOPLACE,
  94         .eccbytes = 12,
  95         .eccpos = {8, 9, 10, 24, 25, 26, 40, 41, 42, 56, 57, 58},
  96         .oobfree = {
  97                 {.offset = 2, .length = 6},
  98                 {.offset = 12, .length = 12},
  99                 {.offset = 28, .length = 12},
 100                 {.offset = 44, .length = 12},
 101                 {.offset = 60, .length = 4}
 102         }
 103 };
 104 #elif defined(CFG_NAND_SMALLPAGE)
 105 static struct nand_ecclayout davinci_nand_ecclayout = {
 106         .useecc = MTD_NANDECC_AUTOPLACE,
 107         .eccbytes = 3,
 108         .eccpos = {0, 1, 2},
 109         .oobfree = {
 110                 {.offset = 6, .length = 2},
 111                 {.offset = 8, .length = 8}
 112         }
 113 };
 114 #else
 115 #error "Either CFG_NAND_LARGEPAGE or CFG_NAND_SMALLPAGE must be defined!"
 116 #endif
 117
 118 static void nand_davinci_enable_hwecc(struct mtd_info *mtd, int mode)
 119 {
 120         emifregs        emif_addr;
 121         int             dummy;
 122
 123         emif_addr = (emifregs)DAVINCI_ASYNC_EMIF_CNTRL_BASE;
 124
 125         dummy = emif_addr->NANDF1ECC;
 126         dummy = emif_addr->NANDF2ECC;
 127         dummy = emif_addr->NANDF3ECC;
 128         dummy = emif_addr->NANDF4ECC;
 129
 130         emif_addr->NANDFCR |= (1 << 8);
 131 }
 132
 133 static u_int32_t nand_davinci_readecc(struct mtd_info *mtd, u_int32_t region)
 134 {
 135         u_int32_t       ecc = 0;
 136         emifregs        emif_base_addr;
 137
 138         emif_base_addr = (emifregs)DAVINCI_ASYNC_EMIF_CNTRL_BASE;
 139
 140         if (region == 1)
 141                 ecc = emif_base_addr->NANDF1ECC;
 142         else if (region == 2)
 143                 ecc = emif_base_addr->NANDF2ECC;
 144         else if (region == 3)
 145                 ecc = emif_base_addr->NANDF3ECC;
 146         else if (region == 4)
 147                 ecc = emif_base_addr->NANDF4ECC;
 148
 149         return(ecc);
 150 }
 151
 152 static int nand_davinci_calculate_ecc(struct mtd_info *mtd, const u_char *dat, u_char *ecc_code)
 153 {
 154         u_int32_t               tmp;
 155         int                     region, n;
 156         struct nand_chip        *this = mtd->priv;
 157
 158         n = (this->ecc.size/512);
 159
 160         region = 1;
 161         while (n--) {
 162                 tmp = nand_davinci_readecc(mtd, region);
 163                 *ecc_code++ = tmp;
 164                 *ecc_code++ = tmp >> 16;
 165                 *ecc_code++ = ((tmp >> 8) & 0x0f) | ((tmp >> 20) & 0xf0);
 166                 region++;
 167         }
 168         return(0);
 169 }
 170
 171 static void nand_davinci_gen_true_ecc(u_int8_t *ecc_buf)
 172 {
 173         u_int32_t       tmp = ecc_buf[0] | (ecc_buf[1] << 16) | ((ecc_buf[2] & 0xf0) << 20) | ((ecc_buf[2] & 0x0f) << 8);
 174
 175         ecc_buf[0] = ~(P64o(tmp) | P64e(tmp) | P32o(tmp) | P32e(tmp) | P16o(tmp) | P16e(tmp) | P8o(tmp) | P8e(tmp));
 176         ecc_buf[1] = ~(P1024o(tmp) | P1024e(tmp) | P512o(tmp) | P512e(tmp) | P256o(tmp) | P256e(tmp) | P128o(tmp) | P128e(tmp));
 177         ecc_buf[2] = ~( P4o(tmp) | P4e(tmp) | P2o(tmp) | P2e(tmp) | P1o(tmp) | P1e(tmp) | P2048o(tmp) | P2048e(tmp));
 178 }
 179
 180 static int nand_davinci_compare_ecc(u_int8_t *ecc_nand, u_int8_t *ecc_calc, u_int8_t *page_data)
 181 {
 182         u_int32_t       i;
 183         u_int8_t        tmp0_bit[8], tmp1_bit[8], tmp2_bit[8];
 184         u_int8_t        comp0_bit[8], comp1_bit[8], comp2_bit[8];
 185         u_int8_t        ecc_bit[24];
 186         u_int8_t        ecc_sum = 0;
 187         u_int8_t        find_bit = 0;
 188         u_int32_t       find_byte = 0;
 189         int             is_ecc_ff;
 190
 191         is_ecc_ff = ((*ecc_nand == 0xff) && (*(ecc_nand + 1) == 0xff) && (*(ecc_nand + 2) == 0xff));
 192
 193         nand_davinci_gen_true_ecc(ecc_nand);
 194         nand_davinci_gen_true_ecc(ecc_calc);
 195
 196         for (i = 0; i <= 2; i++) {
 197                 *(ecc_nand + i) = ~(*(ecc_nand + i));
 198                 *(ecc_calc + i) = ~(*(ecc_calc + i));
 199         }
 200
 201         for (i = 0; i < 8; i++) {
 202                 tmp0_bit[i] = *ecc_nand % 2;
 203                 *ecc_nand = *ecc_nand / 2;
 204         }
 205
 206         for (i = 0; i < 8; i++) {
 207                 tmp1_bit[i] = *(ecc_nand + 1) % 2;
 208                 *(ecc_nand + 1) = *(ecc_nand + 1) / 2;
 209         }
 210
 211         for (i = 0; i < 8; i++) {
 212                 tmp2_bit[i] = *(ecc_nand + 2) % 2;
 213                 *(ecc_nand + 2) = *(ecc_nand + 2) / 2;
 214         }
 215
 216         for (i = 0; i < 8; i++) {
 217                 comp0_bit[i] = *ecc_calc % 2;
 218                 *ecc_calc = *ecc_calc / 2;
 219         }
 220
 221         for (i = 0; i < 8; i++) {
 222                 comp1_bit[i] = *(ecc_calc + 1) % 2;
 223                 *(ecc_calc + 1) = *(ecc_calc + 1) / 2;
 224         }
 225
 226         for (i = 0; i < 8; i++) {
 227                 comp2_bit[i] = *(ecc_calc + 2) % 2;
 228                 *(ecc_calc + 2) = *(ecc_calc + 2) / 2;
 229         }
 230
 231         for (i = 0; i< 6; i++)
 232                 ecc_bit[i] = tmp2_bit[i + 2] ^ comp2_bit[i + 2];
 233
 234         for (i = 0; i < 8; i++)
 235                 ecc_bit[i + 6] = tmp0_bit[i] ^ comp0_bit[i];
 236
 237         for (i = 0; i < 8; i++)
 238                 ecc_bit[i + 14] = tmp1_bit[i] ^ comp1_bit[i];
 239
 240         ecc_bit[22] = tmp2_bit[0] ^ comp2_bit[0];
 241         ecc_bit[23] = tmp2_bit[1] ^ comp2_bit[1];
 242
 243         for (i = 0; i < 24; i++)
 244                 ecc_sum += ecc_bit[i];
 245
 246         switch (ecc_sum) {
 247                 case 0:
 248                         /* Not reached because this function is not called if
 249                            ECC values are equal */
 250                         return 0;
 251                 case 1:
 252                         /* Uncorrectable error */
 253                         MTDDEBUG (MTD_DEBUG_LEVEL0,
 254                                   "ECC UNCORRECTED_ERROR 1\n");
 255                         return(-1);
 256                 case 12:
 257                         /* Correctable error */
 258                         find_byte = (ecc_bit[23] << 8) +
 259                                 (ecc_bit[21] << 7) +
 260                                 (ecc_bit[19] << 6) +
 261                                 (ecc_bit[17] << 5) +
 262                                 (ecc_bit[15] << 4) +
 263                                 (ecc_bit[13] << 3) +
 264                                 (ecc_bit[11] << 2) +
 265                                 (ecc_bit[9]  << 1) +
 266                                 ecc_bit[7];
 267
 268                         find_bit = (ecc_bit[5] << 2) + (ecc_bit[3] << 1) + ecc_bit[1];
 269
 270                         MTDDEBUG (MTD_DEBUG_LEVEL0, "Correcting single bit ECC "
 271                                   "error at offset: %d, bit: %d\n",
 272                                   find_byte, find_bit);
 273
 274                         page_data[find_byte] ^= (1 << find_bit);
 275
 276                         return(0);
 277                 default:
 278                         if (is_ecc_ff) {
 279                                 if (ecc_calc[0] == 0 && ecc_calc[1] == 0 && ecc_calc[2] == 0)
 280                                         return(0);
 281                         }
 282                         MTDDEBUG (MTD_DEBUG_LEVEL0,
 283                                   "UNCORRECTED_ERROR default\n");
 284                         return(-1);
 285         }
 286 }
 287
 288 static int nand_davinci_correct_data(struct mtd_info *mtd, u_char *dat, u_char *read_ecc, u_char *calc_ecc)
 289 {
 290         struct nand_chip        *this;
 291         int                     block_count = 0, i, rc;
 292
 293         this = mtd->priv;
 294         block_count = (this->ecc.size/512);
 295         for (i = 0; i < block_count; i++) {
 296                 if (memcmp(read_ecc, calc_ecc, 3) != 0) {
 297                         rc = nand_davinci_compare_ecc(read_ecc, calc_ecc, dat);
 298                         if (rc < 0) {
 299                                 return(rc);
 300                         }
 301                 }
 302                 read_ecc += 3;
 303                 calc_ecc += 3;
 304                 dat += 512;
 305         }
 306         return(0);
 307 }
 308 #endif
 309
 310 static int nand_davinci_dev_ready(struct mtd_info *mtd)
 311 {
 312         emifregs        emif_addr;
 313
 314         emif_addr = (emifregs)DAVINCI_ASYNC_EMIF_CNTRL_BASE;
 315
 316         return(emif_addr->NANDFSR & 0x1);
 317 }
 318
 319 static int nand_davinci_waitfunc(struct mtd_info *mtd, struct nand_chip *this)
 320 {
 321         while(!nand_davinci_dev_ready(mtd)) {;}
 322         *NAND_CE0CLE = NAND_STATUS;
 323         return(*NAND_CE0DATA);
 324 }
 325
 326 static void nand_flash_init(void)
 327 {
 328         u_int32_t       acfg1 = 0x3ffffffc;
 329         u_int32_t       acfg2 = 0x3ffffffc;
 330         u_int32_t       acfg3 = 0x3ffffffc;
 331         u_int32_t       acfg4 = 0x3ffffffc;
 332         emifregs        emif_regs;
 333
 334         /*------------------------------------------------------------------*
 335          *  NAND FLASH CHIP TIMEOUT @ 459 MHz                               *
 336          *                                                                  *
 337          *  AEMIF.CLK freq   = PLL1/6 = 459/6 = 76.5 MHz                    *
 338          *  AEMIF.CLK period = 1/76.5 MHz = 13.1 ns                         *
 339          *                                                                  *
 340          *------------------------------------------------------------------*/
 341          acfg1 = 0
 342                 | (0 << 31 )    /* selectStrobe */
 343                 | (0 << 30 )    /* extWait */
 344                 | (1 << 26 )    /* writeSetup   10 ns */
 345                 | (3 << 20 )    /* writeStrobe  40 ns */
 346                 | (1 << 17 )    /* writeHold    10 ns */
 347                 | (1 << 13 )    /* readSetup    10 ns */
 348                 | (5 << 7 )     /* readStrobe   60 ns */
 349                 | (1 << 4 )     /* readHold     10 ns */
 350                 | (3 << 2 )     /* turnAround   ?? ns */
 351                 | (0 << 0 )     /* asyncSize    8-bit bus */
 352                 ;
 353
 354         emif_regs = (emifregs)DAVINCI_ASYNC_EMIF_CNTRL_BASE;
 355
 356         emif_regs->AWCCR |= 0x10000000;
 357         emif_regs->AB1CR = acfg1;       /* 0x08244128 */;
 358         emif_regs->AB2CR = acfg2;
 359         emif_regs->AB3CR = acfg3;
 360         emif_regs->AB4CR = acfg4;
 361         emif_regs->NANDFCR = 0x00000101;
 362 }
 363
 364 int board_nand_init(struct nand_chip *nand)
 365 {
 366         nand->IO_ADDR_R   = (void  __iomem *)NAND_CE0DATA;
 367         nand->IO_ADDR_W   = (void  __iomem *)NAND_CE0DATA;
 368         nand->chip_delay  = 0;
 369         nand->select_chip = nand_davinci_select_chip;
 370 #ifdef CFG_NAND_USE_FLASH_BBT
 371         nand->options     = NAND_USE_FLASH_BBT;
 372 #endif
 373 #ifdef CFG_NAND_HW_ECC
 374 #ifdef CFG_NAND_LARGEPAGE
 375         nand->ecc.mode = NAND_ECC_HW;
 376         nand->ecc.size = 2048;
 377         nand->ecc.bytes = 12;
 378 #elif defined(CFG_NAND_SMALLPAGE)
 379         nand->ecc.mode = NAND_ECC_HW;
 380         nand->ecc.size = 512;
 381         nand->ecc.bytes = 3;
 382 #else
 383 #error "Either CFG_NAND_LARGEPAGE or CFG_NAND_SMALLPAGE must be defined!"
 384 #endif
 385         nand->ecc.layout  = &davinci_nand_ecclayout;
 386         nand->ecc.calculate = nand_davinci_calculate_ecc;
 387         nand->ecc.correct  = nand_davinci_correct_data;
 388         nand->ecc.hwctl  = nand_davinci_enable_hwecc;
 389 #else
 390         nand->ecc.mode = NAND_ECC_SOFT;
 391 #endif
 392
 393         /* Set address of hardware control function */
 394         nand->cmd_ctrl = nand_davinci_hwcontrol;
 395
 396         nand->dev_ready = nand_davinci_dev_ready;
 397         nand->waitfunc = nand_davinci_waitfunc;
 398
 399         nand_flash_init();
 400
 401         return(0);
 402 }
 403
 404 #else
 405 #error "U-Boot legacy NAND support not available for DaVinci chips"
 406 #endif
 407 #endif  /* CFG_USE_NAND */