drivers/mtd/nand/nand_spl_simple.c

   1 /*
   2  * (C) Copyright 2006-2008
   3  * Stefan Roese, DENX Software Engineering, sr@denx.de.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of
   8  * the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  18  * MA 02111-1307 USA
  19  */
  20
  21 #include <common.h>
  22 #include <nand.h>
  23 #include <asm/io.h>
  24
  25 static int nand_ecc_pos[] = CONFIG_SYS_NAND_ECCPOS;
  26 static nand_info_t mtd;
  27 static struct nand_chip nand_chip;
  28
  29 #if (CONFIG_SYS_NAND_PAGE_SIZE <= 512)
  30 /*
  31  * NAND command for small page NAND devices (512)
  32  */
  33 static int nand_command(int block, int page, uint32_t offs,
  34         u8 cmd)
  35 {
  36         struct nand_chip *this = mtd.priv;
  37         int page_addr = page + block * CONFIG_SYS_NAND_PAGE_COUNT;
  38
  39         while (!this->dev_ready(&mtd))
  40                 ;
  41
  42         /* Begin command latch cycle */
  43         this->cmd_ctrl(&mtd, cmd, NAND_CTRL_CLE | NAND_CTRL_CHANGE);
  44         /* Set ALE and clear CLE to start address cycle */
  45         /* Column address */
  46         this->cmd_ctrl(&mtd, offs, NAND_CTRL_ALE | NAND_CTRL_CHANGE);
  47         this->cmd_ctrl(&mtd, page_addr & 0xff, NAND_CTRL_ALE); /* A[16:9] */
  48         this->cmd_ctrl(&mtd, (page_addr >> 8) & 0xff,
  49                        NAND_CTRL_ALE); /* A[24:17] */
  50 #ifdef CONFIG_SYS_NAND_4_ADDR_CYCLE
  51         /* One more address cycle for devices > 32MiB */
  52         this->cmd_ctrl(&mtd, (page_addr >> 16) & 0x0f,
  53                        NAND_CTRL_ALE); /* A[28:25] */
  54 #endif
  55         /* Latch in address */
  56         this->cmd_ctrl(&mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
  57
  58         /*
  59          * Wait a while for the data to be ready
  60          */
  61         while (!this->dev_ready(&mtd))
  62                 ;
  63
  64         return 0;
  65 }
  66 #else
  67 /*
  68  * NAND command for large page NAND devices (2k)
  69  */
  70 static int nand_command(int block, int page, uint32_t offs,
  71         u8 cmd)
  72 {
  73         struct nand_chip *this = mtd.priv;
  74         int page_addr = page + block * CONFIG_SYS_NAND_PAGE_COUNT;
  75         void (*hwctrl)(struct mtd_info *mtd, int cmd,
  76                         unsigned int ctrl) = this->cmd_ctrl;
  77
  78         while (!this->dev_ready(&mtd))
  79                 ;
  80
  81         /* Emulate NAND_CMD_READOOB */
  82         if (cmd == NAND_CMD_READOOB) {
  83                 offs += CONFIG_SYS_NAND_PAGE_SIZE;
  84                 cmd = NAND_CMD_READ0;
  85         }
  86
  87         /* Shift the offset from byte addressing to word addressing. */
  88         if (this->options & NAND_BUSWIDTH_16)
  89                 offs >>= 1;
  90
  91         /* Begin command latch cycle */
  92         hwctrl(&mtd, cmd, NAND_CTRL_CLE | NAND_CTRL_CHANGE);
  93         /* Set ALE and clear CLE to start address cycle */
  94         /* Column address */
  95         hwctrl(&mtd, offs & 0xff,
  96                        NAND_CTRL_ALE | NAND_CTRL_CHANGE); /* A[7:0] */
  97         hwctrl(&mtd, (offs >> 8) & 0xff, NAND_CTRL_ALE); /* A[11:9] */
  98         /* Row address */
  99         hwctrl(&mtd, (page_addr & 0xff), NAND_CTRL_ALE); /* A[19:12] */
 100         hwctrl(&mtd, ((page_addr >> 8) & 0xff),
 101                        NAND_CTRL_ALE); /* A[27:20] */
 102 #ifdef CONFIG_SYS_NAND_5_ADDR_CYCLE
 103         /* One more address cycle for devices > 128MiB */
 104         hwctrl(&mtd, (page_addr >> 16) & 0x0f,
 105                        NAND_CTRL_ALE); /* A[31:28] */
 106 #endif
 107         /* Latch in address */
 108         hwctrl(&mtd, NAND_CMD_READSTART,
 109                        NAND_CTRL_CLE | NAND_CTRL_CHANGE);
 110         hwctrl(&mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
 111
 112         /*
 113          * Wait a while for the data to be ready
 114          */
 115         while (!this->dev_ready(&mtd))
 116                 ;
 117
 118         return 0;
 119 }
 120 #endif
 121
 122 static int nand_is_bad_block(int block)
 123 {
 124         struct nand_chip *this = mtd.priv;
 125
 126         nand_command(block, 0, CONFIG_SYS_NAND_BAD_BLOCK_POS,
 127                 NAND_CMD_READOOB);
 128
 129         /*
 130          * Read one byte (or two if it's a 16 bit chip).
 131          */
 132         if (this->options & NAND_BUSWIDTH_16) {
 133                 if (readw(this->IO_ADDR_R) != 0xffff)
 134                         return 1;
 135         } else {
 136                 if (readb(this->IO_ADDR_R) != 0xff)
 137                         return 1;
 138         }
 139
 140         return 0;
 141 }
 142
 143 #if defined(CONFIG_SYS_NAND_HW_ECC_OOBFIRST)
 144 static int nand_read_page(int block, int page, uchar *dst)
 145 {
 146         struct nand_chip *this = mtd.priv;
 147         u_char *ecc_calc;
 148         u_char *ecc_code;
 149         u_char *oob_data;
 150         int i;
 151         int eccsize = CONFIG_SYS_NAND_ECCSIZE;
 152         int eccbytes = CONFIG_SYS_NAND_ECCBYTES;
 153         int eccsteps = CONFIG_SYS_NAND_ECCSTEPS;
 154         uint8_t *p = dst;
 155         int stat;
 156
 157         /*
 158          * No malloc available for now, just use some temporary locations
 159          * in SDRAM
 160          */
 161         ecc_calc = (u_char *)(CONFIG_SYS_SDRAM_BASE + 0x10000);
 162         ecc_code = ecc_calc + 0x100;
 163         oob_data = ecc_calc + 0x200;
 164
 165         nand_command(block, page, 0, NAND_CMD_READOOB);
 166         this->read_buf(&mtd, oob_data, CONFIG_SYS_NAND_OOBSIZE);
 167         nand_command(block, page, 0, NAND_CMD_READ0);
 168
 169         /* Pick the ECC bytes out of the oob data */
 170         for (i = 0; i < CONFIG_SYS_NAND_ECCTOTAL; i++)
 171                 ecc_code[i] = oob_data[nand_ecc_pos[i]];
 172
 173
 174         for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
 175                 this->ecc.hwctl(&mtd, NAND_ECC_READ);
 176                 this->read_buf(&mtd, p, eccsize);
 177                 this->ecc.calculate(&mtd, p, &ecc_calc[i]);
 178                 stat = this->ecc.correct(&mtd, p, &ecc_code[i], &ecc_calc[i]);
 179         }
 180
 181         return 0;
 182 }
 183 #else
 184 static int nand_read_page(int block, int page, void *dst)
 185 {
 186         struct nand_chip *this = mtd.priv;
 187         u_char *ecc_calc;
 188         u_char *ecc_code;
 189         u_char *oob_data;
 190         int i;
 191         int eccsize = CONFIG_SYS_NAND_ECCSIZE;
 192         int eccbytes = CONFIG_SYS_NAND_ECCBYTES;
 193         int eccsteps = CONFIG_SYS_NAND_ECCSTEPS;
 194         uint8_t *p = dst;
 195         int stat;
 196
 197         nand_command(block, page, 0, NAND_CMD_READ0);
 198
 199         /* No malloc available for now, just use some temporary locations
 200          * in SDRAM
 201          */
 202         ecc_calc = (u_char *)(CONFIG_SYS_SDRAM_BASE + 0x10000);
 203         ecc_code = ecc_calc + 0x100;
 204         oob_data = ecc_calc + 0x200;
 205
 206         for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
 207                 this->ecc.hwctl(&mtd, NAND_ECC_READ);
 208                 this->read_buf(&mtd, p, eccsize);
 209                 this->ecc.calculate(&mtd, p, &ecc_calc[i]);
 210         }
 211         this->read_buf(&mtd, oob_data, CONFIG_SYS_NAND_OOBSIZE);
 212
 213         /* Pick the ECC bytes out of the oob data */
 214         for (i = 0; i < CONFIG_SYS_NAND_ECCTOTAL; i++)
 215                 ecc_code[i] = oob_data[nand_ecc_pos[i]];
 216
 217         eccsteps = CONFIG_SYS_NAND_ECCSTEPS;
 218         p = dst;
 219
 220         for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
 221                 /* No chance to do something with the possible error message
 222                  * from correct_data(). We just hope that all possible errors
 223                  * are corrected by this routine.
 224                  */
 225                 stat = this->ecc.correct(&mtd, p, &ecc_code[i], &ecc_calc[i]);
 226         }
 227
 228         return 0;
 229 }
 230 #endif
 231
 232 int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst)
 233 {
 234         unsigned int block, lastblock;
 235         unsigned int page;
 236
 237         /*
 238          * offs has to be aligned to a page address!
 239          */
 240         block = offs / CONFIG_SYS_NAND_BLOCK_SIZE;
 241         lastblock = (offs + size - 1) / CONFIG_SYS_NAND_BLOCK_SIZE;
 242         page = (offs % CONFIG_SYS_NAND_BLOCK_SIZE) / CONFIG_SYS_NAND_PAGE_SIZE;
 243
 244         while (block <= lastblock) {
 245                 if (!nand_is_bad_block(block)) {
 246                         /*
 247                          * Skip bad blocks
 248                          */
 249                         while (page < CONFIG_SYS_NAND_PAGE_COUNT) {
 250                                 nand_read_page(block, page, dst);
 251                                 dst += CONFIG_SYS_NAND_PAGE_SIZE;
 252                                 page++;
 253                         }
 254
 255                         page = 0;
 256                 } else {
 257                         lastblock++;
 258                 }
 259
 260                 block++;
 261         }
 262
 263         return 0;
 264 }
 265
 266 /* nand_init() - initialize data to make nand usable by SPL */
 267 void nand_init(void)
 268 {
 269         /*
 270          * Init board specific nand support
 271          */
 272         mtd.priv = &nand_chip;
 273         nand_chip.IO_ADDR_R = nand_chip.IO_ADDR_W =
 274                 (void  __iomem *)CONFIG_SYS_NAND_BASE;
 275         board_nand_init(&nand_chip);
 276
 277         if (nand_chip.select_chip)
 278                 nand_chip.select_chip(&mtd, 0);
 279 }
 280
 281 /* Unselect after operation */
 282 void nand_deselect(void)
 283 {
 284         if (nand_chip.select_chip)
 285                 nand_chip.select_chip(&mtd, -1);
 286 }