drivers/mtd/nand/nand_spl_simple.c

   1 /*
   2  * (C) Copyright 2006-2008
   3  * Stefan Roese, DENX Software Engineering, sr@denx.de.
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  */
   7
   8 #include <common.h>
   9 #include <nand.h>
  10 #include <asm/io.h>
  11 #include <linux/mtd/nand_ecc.h>
  12
  13 static int nand_ecc_pos[] = CONFIG_SYS_NAND_ECCPOS;
  14 static nand_info_t mtd;
  15 static struct nand_chip nand_chip;
  16
  17 #define ECCSTEPS        (CONFIG_SYS_NAND_PAGE_SIZE / \
  18                                         CONFIG_SYS_NAND_ECCSIZE)
  19 #define ECCTOTAL        (ECCSTEPS * CONFIG_SYS_NAND_ECCBYTES)
  20
  21
  22 #if (CONFIG_SYS_NAND_PAGE_SIZE <= 512)
  23 /*
  24  * NAND command for small page NAND devices (512)
  25  */
  26 static int nand_command(int block, int page, uint32_t offs,
  27         u8 cmd)
  28 {
  29         struct nand_chip *this = mtd.priv;
  30         int page_addr = page + block * CONFIG_SYS_NAND_PAGE_COUNT;
  31
  32         while (!this->dev_ready(&mtd))
  33                 ;
  34
  35         /* Begin command latch cycle */
  36         this->cmd_ctrl(&mtd, cmd, NAND_CTRL_CLE | NAND_CTRL_CHANGE);
  37         /* Set ALE and clear CLE to start address cycle */
  38         /* Column address */
  39         this->cmd_ctrl(&mtd, offs, NAND_CTRL_ALE | NAND_CTRL_CHANGE);
  40         this->cmd_ctrl(&mtd, page_addr & 0xff, NAND_CTRL_ALE); /* A[16:9] */
  41         this->cmd_ctrl(&mtd, (page_addr >> 8) & 0xff,
  42                        NAND_CTRL_ALE); /* A[24:17] */
  43 #ifdef CONFIG_SYS_NAND_4_ADDR_CYCLE
  44         /* One more address cycle for devices > 32MiB */
  45         this->cmd_ctrl(&mtd, (page_addr >> 16) & 0x0f,
  46                        NAND_CTRL_ALE); /* A[28:25] */
  47 #endif
  48         /* Latch in address */
  49         this->cmd_ctrl(&mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
  50
  51         /*
  52          * Wait a while for the data to be ready
  53          */
  54         while (!this->dev_ready(&mtd))
  55                 ;
  56
  57         return 0;
  58 }
  59 #else
  60 /*
  61  * NAND command for large page NAND devices (2k)
  62  */
  63 static int nand_command(int block, int page, uint32_t offs,
  64         u8 cmd)
  65 {
  66         struct nand_chip *this = mtd.priv;
  67         int page_addr = page + block * CONFIG_SYS_NAND_PAGE_COUNT;
  68         void (*hwctrl)(struct mtd_info *mtd, int cmd,
  69                         unsigned int ctrl) = this->cmd_ctrl;
  70
  71         while (!this->dev_ready(&mtd))
  72                 ;
  73
  74         /* Emulate NAND_CMD_READOOB */
  75         if (cmd == NAND_CMD_READOOB) {
  76                 offs += CONFIG_SYS_NAND_PAGE_SIZE;
  77                 cmd = NAND_CMD_READ0;
  78         }
  79
  80         /* Shift the offset from byte addressing to word addressing. */
  81         if (this->options & NAND_BUSWIDTH_16)
  82                 offs >>= 1;
  83
  84         /* Begin command latch cycle */
  85         hwctrl(&mtd, cmd, NAND_CTRL_CLE | NAND_CTRL_CHANGE);
  86         /* Set ALE and clear CLE to start address cycle */
  87         /* Column address */
  88         hwctrl(&mtd, offs & 0xff,
  89                        NAND_CTRL_ALE | NAND_CTRL_CHANGE); /* A[7:0] */
  90         hwctrl(&mtd, (offs >> 8) & 0xff, NAND_CTRL_ALE); /* A[11:9] */
  91         /* Row address */
  92         hwctrl(&mtd, (page_addr & 0xff), NAND_CTRL_ALE); /* A[19:12] */
  93         hwctrl(&mtd, ((page_addr >> 8) & 0xff),
  94                        NAND_CTRL_ALE); /* A[27:20] */
  95 #ifdef CONFIG_SYS_NAND_5_ADDR_CYCLE
  96         /* One more address cycle for devices > 128MiB */
  97         hwctrl(&mtd, (page_addr >> 16) & 0x0f,
  98                        NAND_CTRL_ALE); /* A[31:28] */
  99 #endif
 100         /* Latch in address */
 101         hwctrl(&mtd, NAND_CMD_READSTART,
 102                        NAND_CTRL_CLE | NAND_CTRL_CHANGE);
 103         hwctrl(&mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
 104
 105         /*
 106          * Wait a while for the data to be ready
 107          */
 108         while (!this->dev_ready(&mtd))
 109                 ;
 110
 111         return 0;
 112 }
 113 #endif
 114
 115 static int nand_is_bad_block(int block)
 116 {
 117         struct nand_chip *this = mtd.priv;
 118
 119         nand_command(block, 0, CONFIG_SYS_NAND_BAD_BLOCK_POS,
 120                 NAND_CMD_READOOB);
 121
 122         /*
 123          * Read one byte (or two if it's a 16 bit chip).
 124          */
 125         if (this->options & NAND_BUSWIDTH_16) {
 126                 if (readw(this->IO_ADDR_R) != 0xffff)
 127                         return 1;
 128         } else {
 129                 if (readb(this->IO_ADDR_R) != 0xff)
 130                         return 1;
 131         }
 132
 133         return 0;
 134 }
 135
 136 #if defined(CONFIG_SYS_NAND_HW_ECC_OOBFIRST)
 137 static int nand_read_page(int block, int page, uchar *dst)
 138 {
 139         struct nand_chip *this = mtd.priv;
 140         u_char ecc_calc[ECCTOTAL];
 141         u_char ecc_code[ECCTOTAL];
 142         u_char oob_data[CONFIG_SYS_NAND_OOBSIZE];
 143         int i;
 144         int eccsize = CONFIG_SYS_NAND_ECCSIZE;
 145         int eccbytes = CONFIG_SYS_NAND_ECCBYTES;
 146         int eccsteps = ECCSTEPS;
 147         uint8_t *p = dst;
 148
 149         nand_command(block, page, 0, NAND_CMD_READOOB);
 150         this->read_buf(&mtd, oob_data, CONFIG_SYS_NAND_OOBSIZE);
 151         nand_command(block, page, 0, NAND_CMD_READ0);
 152
 153         /* Pick the ECC bytes out of the oob data */
 154         for (i = 0; i < ECCTOTAL; i++)
 155                 ecc_code[i] = oob_data[nand_ecc_pos[i]];
 156
 157
 158         for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
 159                 this->ecc.hwctl(&mtd, NAND_ECC_READ);
 160                 this->read_buf(&mtd, p, eccsize);
 161                 this->ecc.calculate(&mtd, p, &ecc_calc[i]);
 162                 this->ecc.correct(&mtd, p, &ecc_code[i], &ecc_calc[i]);
 163         }
 164
 165         return 0;
 166 }
 167 #else
 168 static int nand_read_page(int block, int page, void *dst)
 169 {
 170         struct nand_chip *this = mtd.priv;
 171         u_char ecc_calc[ECCTOTAL];
 172         u_char ecc_code[ECCTOTAL];
 173         u_char oob_data[CONFIG_SYS_NAND_OOBSIZE];
 174         int i;
 175         int eccsize = CONFIG_SYS_NAND_ECCSIZE;
 176         int eccbytes = CONFIG_SYS_NAND_ECCBYTES;
 177         int eccsteps = ECCSTEPS;
 178         uint8_t *p = dst;
 179
 180         nand_command(block, page, 0, NAND_CMD_READ0);
 181
 182         for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
 183                 if (this->ecc.mode != NAND_ECC_SOFT)
 184                         this->ecc.hwctl(&mtd, NAND_ECC_READ);
 185                 this->read_buf(&mtd, p, eccsize);
 186                 this->ecc.calculate(&mtd, p, &ecc_calc[i]);
 187         }
 188         this->read_buf(&mtd, oob_data, CONFIG_SYS_NAND_OOBSIZE);
 189
 190         /* Pick the ECC bytes out of the oob data */
 191         for (i = 0; i < ECCTOTAL; i++)
 192                 ecc_code[i] = oob_data[nand_ecc_pos[i]];
 193
 194         eccsteps = ECCSTEPS;
 195         p = dst;
 196
 197         for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
 198                 /* No chance to do something with the possible error message
 199                  * from correct_data(). We just hope that all possible errors
 200                  * are corrected by this routine.
 201                  */
 202                 this->ecc.correct(&mtd, p, &ecc_code[i], &ecc_calc[i]);
 203         }
 204
 205         return 0;
 206 }
 207 #endif
 208
 209 int nand_spl_load_image(uint32_t offs, unsigned int size, void *dst)
 210 {
 211         unsigned int block, lastblock, bad = 0;
 212         unsigned int page;
 213         const int ppb = CONFIG_SYS_NAND_BLOCK_SIZE / CONFIG_SYS_NAND_PAGE_SIZE;
 214         int maxbad;
 215
 216 #ifdef CONFIG_SYS_NAND_MAXBAD
 217         maxbad = CONFIG_SYS_NAND_MAXBAD;
 218 #else
 219         maxbad = mtd.size;
 220 #endif
 221         /*
 222          * offs has to be aligned to a page address!
 223          */
 224         block = offs / CONFIG_SYS_NAND_BLOCK_SIZE;
 225         lastblock = (offs + size - 1) / CONFIG_SYS_NAND_BLOCK_SIZE;
 226         page = (offs % CONFIG_SYS_NAND_BLOCK_SIZE) / CONFIG_SYS_NAND_PAGE_SIZE;
 227
 228         while (block <= lastblock) {
 229                 if (!nand_is_bad_block(block)) {
 230                         /*
 231                          * Skip bad blocks
 232                          */
 233                         while (page < CONFIG_SYS_NAND_PAGE_COUNT) {
 234                                 if (nand_chip.ecc.read_page) {
 235                                         int ret;
 236
 237                                         ret = nand_chip.ecc.read_page(&mtd, &nand_chip,
 238                                                 dst, block * ppb + page);
 239                                         if (ret) {
 240                                                 if (page > 0)
 241                                                         dst -= (page - 1) * CONFIG_SYS_NAND_PAGE_SIZE;
 242                                                 bad++;
 243                                                 lastblock++;
 244                                                 break;
 245                                         }
 246                                 } else {
 247                                         nand_read_page(block, page, dst);
 248                                 }
 249                                 dst += CONFIG_SYS_NAND_PAGE_SIZE;
 250                                 page++;
 251                         }
 252
 253                         page = 0;
 254                 } else {
 255                         printf("Skipping bad block %d\n", block);
 256                         bad++;
 257                         lastblock++;
 258                 }
 259
 260                 if (maxbad > 0 && bad > maxbad) {
 261                         printf("Too many bad blocks encountered\n");
 262                         return -1;
 263                 }
 264
 265                 block++;
 266         }
 267
 268         return 0;
 269 }
 270
 271 /* nand_init() - initialize data to make nand usable by SPL */
 272 void nand_init(void)
 273 {
 274         static struct nand_buffers ecc_buf;
 275
 276         /*
 277          * Init board specific nand support
 278          */
 279         mtd.priv = &nand_chip;
 280         mtd.erasesize = CONFIG_SYS_NAND_BLOCK_SIZE;
 281         mtd.writesize = CONFIG_SYS_NAND_PAGE_SIZE;
 282         mtd.oobsize = CONFIG_SYS_NAND_OOBSIZE;
 283
 284         nand_chip.IO_ADDR_R = nand_chip.IO_ADDR_W =
 285                 (void  __iomem *)CONFIG_SYS_NAND_BASE;
 286         nand_chip.oob_poi = ecc_buf.databuf;
 287         nand_chip.buffers = &ecc_buf;
 288
 289         board_nand_init(&nand_chip);
 290
 291 #ifdef CONFIG_SPL_NAND_SOFTECC
 292         if (nand_chip.ecc.mode == NAND_ECC_SOFT) {
 293                 nand_chip.ecc.calculate = nand_calculate_ecc;
 294                 nand_chip.ecc.correct = nand_correct_data;
 295         }
 296 #endif
 297
 298         if (nand_chip.select_chip)
 299                 nand_chip.select_chip(&mtd, 0);
 300 }
 301
 302 /* Unselect after operation */
 303 void nand_deselect(void)
 304 {
 305         if (nand_chip.select_chip)
 306                 nand_chip.select_chip(&mtd, -1);
 307 }