blob: 21cc5a39407d29f74ddb987f6d0373632fa6afba [file] [log] [blame]
Wolfgang Denk932394a2005-08-17 12:55:25 +02001/*
2 * drivers/mtd/nand.c
3 *
4 * Overview:
5 * This is the generic MTD driver for NAND flash devices. It should be
6 * capable of working with almost all NAND chips currently available.
7 * Basic support for AG-AND chips is provided.
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +02008 *
Wolfgang Denk932394a2005-08-17 12:55:25 +02009 * Additional technical information is available on
Scott Woodc45912d2008-10-24 16:20:43 -050010 * http://www.linux-mtd.infradead.org/doc/nand.html
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +020011 *
Wolfgang Denk932394a2005-08-17 12:55:25 +020012 * Copyright (C) 2000 Steven J. Hill (sjhill@realitydiluted.com)
William Juulcfa460a2007-10-31 13:53:06 +010013 * 2002-2006 Thomas Gleixner (tglx@linutronix.de)
Wolfgang Denk932394a2005-08-17 12:55:25 +020014 *
William Juulcfa460a2007-10-31 13:53:06 +010015 * Credits:
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +020016 * David Woodhouse for adding multichip support
17 *
Wolfgang Denk932394a2005-08-17 12:55:25 +020018 * Aleph One Ltd. and Toby Churchill Ltd. for supporting the
19 * rework for 2K page size chips
20 *
William Juulcfa460a2007-10-31 13:53:06 +010021 * TODO:
Wolfgang Denk932394a2005-08-17 12:55:25 +020022 * Enable cached programming for 2k page size chips
23 * Check, if mtd->ecctype should be set to MTD_ECC_HW
24 * if we have HW ecc support.
25 * The AG-AND chips have nice features for speed improvement,
26 * which are not supported yet. Read / program 4 pages in one go.
Scott Woodc45912d2008-10-24 16:20:43 -050027 * BBT table is not serialized, has to be fixed
Wolfgang Denk932394a2005-08-17 12:55:25 +020028 *
Wolfgang Denk932394a2005-08-17 12:55:25 +020029 * This program is free software; you can redistribute it and/or modify
30 * it under the terms of the GNU General Public License version 2 as
31 * published by the Free Software Foundation.
32 *
33 */
34
Wolfgang Denk932394a2005-08-17 12:55:25 +020035#include <common.h>
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +010036
William Juulcfa460a2007-10-31 13:53:06 +010037#define ENOTSUPP 524 /* Operation is not supported */
38
Wolfgang Denk932394a2005-08-17 12:55:25 +020039#include <malloc.h>
40#include <watchdog.h>
William Juulcfa460a2007-10-31 13:53:06 +010041#include <linux/err.h>
Wolfgang Denk932394a2005-08-17 12:55:25 +020042#include <linux/mtd/compat.h>
43#include <linux/mtd/mtd.h>
44#include <linux/mtd/nand.h>
45#include <linux/mtd/nand_ecc.h>
46
Stefan Roese10bb62d2009-04-24 15:58:33 +020047#ifdef CONFIG_MTD_PARTITIONS
48#include <linux/mtd/partitions.h>
49#endif
50
Wolfgang Denk932394a2005-08-17 12:55:25 +020051#include <asm/io.h>
52#include <asm/errno.h>
53
Peter Tyser8da60122009-02-04 13:47:22 -060054/*
55 * CONFIG_SYS_NAND_RESET_CNT is used as a timeout mechanism when resetting
56 * a flash. NAND flash is initialized prior to interrupts so standard timers
57 * can't be used. CONFIG_SYS_NAND_RESET_CNT should be set to a value
58 * which is greater than (max NAND reset time / NAND status read time).
59 * A conservative default of 200000 (500 us / 25 ns) is used as a default.
60 */
61#ifndef CONFIG_SYS_NAND_RESET_CNT
62#define CONFIG_SYS_NAND_RESET_CNT 200000
63#endif
64
Wolfgang Denk932394a2005-08-17 12:55:25 +020065/* Define default oob placement schemes for large and small page devices */
William Juulcfa460a2007-10-31 13:53:06 +010066static struct nand_ecclayout nand_oob_8 = {
Wolfgang Denk932394a2005-08-17 12:55:25 +020067 .eccbytes = 3,
68 .eccpos = {0, 1, 2},
William Juulcfa460a2007-10-31 13:53:06 +010069 .oobfree = {
70 {.offset = 3,
71 .length = 2},
72 {.offset = 6,
73 .length = 2}}
Wolfgang Denk932394a2005-08-17 12:55:25 +020074};
75
William Juulcfa460a2007-10-31 13:53:06 +010076static struct nand_ecclayout nand_oob_16 = {
Wolfgang Denk932394a2005-08-17 12:55:25 +020077 .eccbytes = 6,
78 .eccpos = {0, 1, 2, 3, 6, 7},
William Juulcfa460a2007-10-31 13:53:06 +010079 .oobfree = {
80 {.offset = 8,
81 . length = 8}}
Wolfgang Denk932394a2005-08-17 12:55:25 +020082};
83
William Juulcfa460a2007-10-31 13:53:06 +010084static struct nand_ecclayout nand_oob_64 = {
Wolfgang Denk932394a2005-08-17 12:55:25 +020085 .eccbytes = 24,
86 .eccpos = {
William Juulcfa460a2007-10-31 13:53:06 +010087 40, 41, 42, 43, 44, 45, 46, 47,
88 48, 49, 50, 51, 52, 53, 54, 55,
89 56, 57, 58, 59, 60, 61, 62, 63},
90 .oobfree = {
91 {.offset = 2,
92 .length = 38}}
Wolfgang Denk932394a2005-08-17 12:55:25 +020093};
94
William Juulcfa460a2007-10-31 13:53:06 +010095static struct nand_ecclayout nand_oob_128 = {
Sergei Poselenov248ae5c2008-06-06 15:42:43 +020096 .eccbytes = 48,
97 .eccpos = {
William Juulcfa460a2007-10-31 13:53:06 +010098 80, 81, 82, 83, 84, 85, 86, 87,
99 88, 89, 90, 91, 92, 93, 94, 95,
100 96, 97, 98, 99, 100, 101, 102, 103,
101 104, 105, 106, 107, 108, 109, 110, 111,
102 112, 113, 114, 115, 116, 117, 118, 119,
103 120, 121, 122, 123, 124, 125, 126, 127},
104 .oobfree = {
105 {.offset = 2,
106 .length = 78}}
Wolfgang Denk932394a2005-08-17 12:55:25 +0200107};
108
William Juulcfa460a2007-10-31 13:53:06 +0100109
110static int nand_get_device(struct nand_chip *chip, struct mtd_info *mtd,
111 int new_state);
112
113static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
114 struct mtd_oob_ops *ops);
115
116static int nand_wait(struct mtd_info *mtd, struct nand_chip *this);
Sergei Poselenov248ae5c2008-06-06 15:42:43 +0200117
Wolfgang Denk932394a2005-08-17 12:55:25 +0200118/**
119 * nand_release_device - [GENERIC] release chip
120 * @mtd: MTD device structure
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200121 *
122 * Deselect, release chip lock and wake up anyone waiting on the device
Wolfgang Denk932394a2005-08-17 12:55:25 +0200123 */
Wolfgang Denk8e9655f2005-11-02 14:29:12 +0100124static void nand_release_device (struct mtd_info *mtd)
125{
126 struct nand_chip *this = mtd->priv;
127 this->select_chip(mtd, -1); /* De-select the NAND device */
128}
Wolfgang Denk932394a2005-08-17 12:55:25 +0200129
130/**
131 * nand_read_byte - [DEFAULT] read one byte from the chip
132 * @mtd: MTD device structure
133 *
134 * Default read function for 8bit buswith
135 */
William Juulcfa460a2007-10-31 13:53:06 +0100136static uint8_t nand_read_byte(struct mtd_info *mtd)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200137{
William Juulcfa460a2007-10-31 13:53:06 +0100138 struct nand_chip *chip = mtd->priv;
139 return readb(chip->IO_ADDR_R);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200140}
141
142/**
143 * nand_read_byte16 - [DEFAULT] read one byte endianess aware from the chip
144 * @mtd: MTD device structure
145 *
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200146 * Default read function for 16bit buswith with
Wolfgang Denk932394a2005-08-17 12:55:25 +0200147 * endianess conversion
148 */
William Juulcfa460a2007-10-31 13:53:06 +0100149static uint8_t nand_read_byte16(struct mtd_info *mtd)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200150{
William Juulcfa460a2007-10-31 13:53:06 +0100151 struct nand_chip *chip = mtd->priv;
152 return (uint8_t) cpu_to_le16(readw(chip->IO_ADDR_R));
Wolfgang Denk932394a2005-08-17 12:55:25 +0200153}
154
155/**
156 * nand_read_word - [DEFAULT] read one word from the chip
157 * @mtd: MTD device structure
158 *
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200159 * Default read function for 16bit buswith without
Wolfgang Denk932394a2005-08-17 12:55:25 +0200160 * endianess conversion
161 */
162static u16 nand_read_word(struct mtd_info *mtd)
163{
William Juulcfa460a2007-10-31 13:53:06 +0100164 struct nand_chip *chip = mtd->priv;
165 return readw(chip->IO_ADDR_R);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200166}
167
168/**
169 * nand_select_chip - [DEFAULT] control CE line
170 * @mtd: MTD device structure
William Juulcfa460a2007-10-31 13:53:06 +0100171 * @chipnr: chipnumber to select, -1 for deselect
Wolfgang Denk932394a2005-08-17 12:55:25 +0200172 *
173 * Default select function for 1 chip devices.
174 */
William Juulcfa460a2007-10-31 13:53:06 +0100175static void nand_select_chip(struct mtd_info *mtd, int chipnr)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200176{
William Juulcfa460a2007-10-31 13:53:06 +0100177 struct nand_chip *chip = mtd->priv;
178
179 switch (chipnr) {
Wolfgang Denk932394a2005-08-17 12:55:25 +0200180 case -1:
William Juulcfa460a2007-10-31 13:53:06 +0100181 chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200182 break;
183 case 0:
Wolfgang Denk932394a2005-08-17 12:55:25 +0200184 break;
185
186 default:
187 BUG();
188 }
189}
190
191/**
192 * nand_write_buf - [DEFAULT] write buffer to chip
193 * @mtd: MTD device structure
194 * @buf: data buffer
195 * @len: number of bytes to write
196 *
197 * Default write function for 8bit buswith
198 */
William Juulcfa460a2007-10-31 13:53:06 +0100199static void nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200200{
201 int i;
William Juulcfa460a2007-10-31 13:53:06 +0100202 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200203
William Juulcfa460a2007-10-31 13:53:06 +0100204 for (i = 0; i < len; i++)
205 writeb(buf[i], chip->IO_ADDR_W);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200206}
207
208/**
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200209 * nand_read_buf - [DEFAULT] read chip data into buffer
Wolfgang Denk932394a2005-08-17 12:55:25 +0200210 * @mtd: MTD device structure
211 * @buf: buffer to store date
212 * @len: number of bytes to read
213 *
214 * Default read function for 8bit buswith
215 */
William Juulcfa460a2007-10-31 13:53:06 +0100216static void nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200217{
218 int i;
William Juulcfa460a2007-10-31 13:53:06 +0100219 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200220
William Juulcfa460a2007-10-31 13:53:06 +0100221 for (i = 0; i < len; i++)
222 buf[i] = readb(chip->IO_ADDR_R);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200223}
224
225/**
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200226 * nand_verify_buf - [DEFAULT] Verify chip data against buffer
Wolfgang Denk932394a2005-08-17 12:55:25 +0200227 * @mtd: MTD device structure
228 * @buf: buffer containing the data to compare
229 * @len: number of bytes to compare
230 *
231 * Default verify function for 8bit buswith
232 */
William Juulcfa460a2007-10-31 13:53:06 +0100233static int nand_verify_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200234{
235 int i;
William Juulcfa460a2007-10-31 13:53:06 +0100236 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200237
William Juulcfa460a2007-10-31 13:53:06 +0100238 for (i = 0; i < len; i++)
239 if (buf[i] != readb(chip->IO_ADDR_R))
Wolfgang Denk932394a2005-08-17 12:55:25 +0200240 return -EFAULT;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200241 return 0;
242}
243
244/**
245 * nand_write_buf16 - [DEFAULT] write buffer to chip
246 * @mtd: MTD device structure
247 * @buf: data buffer
248 * @len: number of bytes to write
249 *
250 * Default write function for 16bit buswith
251 */
William Juulcfa460a2007-10-31 13:53:06 +0100252static void nand_write_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200253{
254 int i;
William Juulcfa460a2007-10-31 13:53:06 +0100255 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200256 u16 *p = (u16 *) buf;
257 len >>= 1;
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200258
William Juulcfa460a2007-10-31 13:53:06 +0100259 for (i = 0; i < len; i++)
260 writew(p[i], chip->IO_ADDR_W);
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200261
Wolfgang Denk932394a2005-08-17 12:55:25 +0200262}
263
264/**
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200265 * nand_read_buf16 - [DEFAULT] read chip data into buffer
Wolfgang Denk932394a2005-08-17 12:55:25 +0200266 * @mtd: MTD device structure
267 * @buf: buffer to store date
268 * @len: number of bytes to read
269 *
270 * Default read function for 16bit buswith
271 */
William Juulcfa460a2007-10-31 13:53:06 +0100272static void nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200273{
274 int i;
William Juulcfa460a2007-10-31 13:53:06 +0100275 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200276 u16 *p = (u16 *) buf;
277 len >>= 1;
278
William Juulcfa460a2007-10-31 13:53:06 +0100279 for (i = 0; i < len; i++)
280 p[i] = readw(chip->IO_ADDR_R);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200281}
282
283/**
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200284 * nand_verify_buf16 - [DEFAULT] Verify chip data against buffer
Wolfgang Denk932394a2005-08-17 12:55:25 +0200285 * @mtd: MTD device structure
286 * @buf: buffer containing the data to compare
287 * @len: number of bytes to compare
288 *
289 * Default verify function for 16bit buswith
290 */
William Juulcfa460a2007-10-31 13:53:06 +0100291static int nand_verify_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200292{
293 int i;
William Juulcfa460a2007-10-31 13:53:06 +0100294 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200295 u16 *p = (u16 *) buf;
296 len >>= 1;
297
William Juulcfa460a2007-10-31 13:53:06 +0100298 for (i = 0; i < len; i++)
299 if (p[i] != readw(chip->IO_ADDR_R))
Wolfgang Denk932394a2005-08-17 12:55:25 +0200300 return -EFAULT;
301
302 return 0;
303}
304
305/**
306 * nand_block_bad - [DEFAULT] Read bad block marker from the chip
307 * @mtd: MTD device structure
308 * @ofs: offset from device start
309 * @getchip: 0, if the chip is already selected
310 *
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200311 * Check, if the block is bad.
Wolfgang Denk932394a2005-08-17 12:55:25 +0200312 */
313static int nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
314{
315 int page, chipnr, res = 0;
William Juulcfa460a2007-10-31 13:53:06 +0100316 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200317 u16 bad;
318
William Juulcfa460a2007-10-31 13:53:06 +0100319 page = (int)(ofs >> chip->page_shift) & chip->pagemask;
Thomas Knoblocha7988652007-05-05 07:04:42 +0200320
Wolfgang Denk932394a2005-08-17 12:55:25 +0200321 if (getchip) {
William Juulcfa460a2007-10-31 13:53:06 +0100322 chipnr = (int)(ofs >> chip->chip_shift);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200323
William Juulcfa460a2007-10-31 13:53:06 +0100324 nand_get_device(chip, mtd, FL_READING);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200325
326 /* Select the NAND device */
William Juulcfa460a2007-10-31 13:53:06 +0100327 chip->select_chip(mtd, chipnr);
Thomas Knoblocha7988652007-05-05 07:04:42 +0200328 }
Wolfgang Denk932394a2005-08-17 12:55:25 +0200329
William Juulcfa460a2007-10-31 13:53:06 +0100330 if (chip->options & NAND_BUSWIDTH_16) {
331 chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos & 0xFE,
332 page);
333 bad = cpu_to_le16(chip->read_word(mtd));
334 if (chip->badblockpos & 0x1)
335 bad >>= 8;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200336 if ((bad & 0xFF) != 0xff)
337 res = 1;
338 } else {
William Juulcfa460a2007-10-31 13:53:06 +0100339 chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos, page);
340 if (chip->read_byte(mtd) != 0xff)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200341 res = 1;
342 }
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200343
William Juulcfa460a2007-10-31 13:53:06 +0100344 if (getchip)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200345 nand_release_device(mtd);
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200346
Wolfgang Denk932394a2005-08-17 12:55:25 +0200347 return res;
348}
349
350/**
351 * nand_default_block_markbad - [DEFAULT] mark a block bad
352 * @mtd: MTD device structure
353 * @ofs: offset from device start
354 *
355 * This is the default implementation, which can be overridden by
356 * a hardware specific driver.
357*/
358static int nand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
359{
William Juulcfa460a2007-10-31 13:53:06 +0100360 struct nand_chip *chip = mtd->priv;
361 uint8_t buf[2] = { 0, 0 };
362 int block, ret;
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200363
Wolfgang Denk932394a2005-08-17 12:55:25 +0200364 /* Get block number */
William Juulcfa460a2007-10-31 13:53:06 +0100365 block = (int)(ofs >> chip->bbt_erase_shift);
366 if (chip->bbt)
367 chip->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200368
369 /* Do we have a flash based bad block table ? */
William Juulcfa460a2007-10-31 13:53:06 +0100370 if (chip->options & NAND_USE_FLASH_BBT)
371 ret = nand_update_bbt(mtd, ofs);
372 else {
373 /* We write two bytes, so we dont have to mess with 16 bit
374 * access
375 */
Scott Woodc45912d2008-10-24 16:20:43 -0500376 nand_get_device(chip, mtd, FL_WRITING);
William Juulcfa460a2007-10-31 13:53:06 +0100377 ofs += mtd->oobsize;
378 chip->ops.len = chip->ops.ooblen = 2;
379 chip->ops.datbuf = NULL;
380 chip->ops.oobbuf = buf;
381 chip->ops.ooboffs = chip->badblockpos & ~0x01;
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200382
William Juulcfa460a2007-10-31 13:53:06 +0100383 ret = nand_do_write_oob(mtd, ofs, &chip->ops);
Scott Woodc45912d2008-10-24 16:20:43 -0500384 nand_release_device(mtd);
William Juulcfa460a2007-10-31 13:53:06 +0100385 }
386 if (!ret)
387 mtd->ecc_stats.badblocks++;
Scott Woodc45912d2008-10-24 16:20:43 -0500388
William Juulcfa460a2007-10-31 13:53:06 +0100389 return ret;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200390}
391
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200392/**
Wolfgang Denk932394a2005-08-17 12:55:25 +0200393 * nand_check_wp - [GENERIC] check if the chip is write protected
394 * @mtd: MTD device structure
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200395 * Check, if the device is write protected
Wolfgang Denk932394a2005-08-17 12:55:25 +0200396 *
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200397 * The function expects, that the device is already selected
Wolfgang Denk932394a2005-08-17 12:55:25 +0200398 */
William Juulcfa460a2007-10-31 13:53:06 +0100399static int nand_check_wp(struct mtd_info *mtd)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200400{
William Juulcfa460a2007-10-31 13:53:06 +0100401 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200402 /* Check the WP bit */
William Juulcfa460a2007-10-31 13:53:06 +0100403 chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
404 return (chip->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200405}
Markus Klotzbücher43638c62006-03-06 15:04:25 +0100406
Wolfgang Denk932394a2005-08-17 12:55:25 +0200407/**
408 * nand_block_checkbad - [GENERIC] Check if a block is marked bad
409 * @mtd: MTD device structure
410 * @ofs: offset from device start
411 * @getchip: 0, if the chip is already selected
412 * @allowbbt: 1, if its allowed to access the bbt area
413 *
414 * Check, if the block is bad. Either by reading the bad block table or
415 * calling of the scan function.
416 */
William Juulcfa460a2007-10-31 13:53:06 +0100417static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip,
418 int allowbbt)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200419{
William Juulcfa460a2007-10-31 13:53:06 +0100420 struct nand_chip *chip = mtd->priv;
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200421
Ilya Yanok13f0fd92008-06-30 15:34:40 +0200422 if (!(chip->options & NAND_BBT_SCANNED)) {
Ilya Yanok13f0fd92008-06-30 15:34:40 +0200423 chip->options |= NAND_BBT_SCANNED;
Scott Woodff49ea82008-12-16 14:24:16 -0600424 chip->scan_bbt(mtd);
Ilya Yanok13f0fd92008-06-30 15:34:40 +0200425 }
426
William Juulcfa460a2007-10-31 13:53:06 +0100427 if (!chip->bbt)
428 return chip->block_bad(mtd, ofs, getchip);
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200429
Wolfgang Denk932394a2005-08-17 12:55:25 +0200430 /* Return info from the table */
William Juulcfa460a2007-10-31 13:53:06 +0100431 return nand_isbad_bbt(mtd, ofs, allowbbt);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200432}
433
William Juulcfa460a2007-10-31 13:53:06 +0100434/*
435 * Wait for the ready pin, after a command
436 * The timeout is catched later.
437 */
William Juulcfa460a2007-10-31 13:53:06 +0100438void nand_wait_ready(struct mtd_info *mtd)
439{
440 struct nand_chip *chip = mtd->priv;
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200441 u32 timeo = (CONFIG_SYS_HZ * 20) / 1000;
Stefan Roese12072262008-01-05 16:43:25 +0100442
443 reset_timer();
444
445 /* wait until command is processed or timeout occures */
446 while (get_timer(0) < timeo) {
447 if (chip->dev_ready)
448 if (chip->dev_ready(mtd))
449 break;
450 }
William Juulcfa460a2007-10-31 13:53:06 +0100451}
William Juulcfa460a2007-10-31 13:53:06 +0100452
Wolfgang Denk932394a2005-08-17 12:55:25 +0200453/**
454 * nand_command - [DEFAULT] Send command to NAND device
455 * @mtd: MTD device structure
456 * @command: the command to be sent
457 * @column: the column address for this command, -1 if none
458 * @page_addr: the page address for this command, -1 if none
459 *
460 * Send command to NAND device. This function is used for small page
461 * devices (256/512 Bytes per page)
462 */
William Juulcfa460a2007-10-31 13:53:06 +0100463static void nand_command(struct mtd_info *mtd, unsigned int command,
464 int column, int page_addr)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200465{
William Juulcfa460a2007-10-31 13:53:06 +0100466 register struct nand_chip *chip = mtd->priv;
467 int ctrl = NAND_CTRL_CLE | NAND_CTRL_CHANGE;
Peter Tyser8da60122009-02-04 13:47:22 -0600468 uint32_t rst_sts_cnt = CONFIG_SYS_NAND_RESET_CNT;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200469
Wolfgang Denk932394a2005-08-17 12:55:25 +0200470 /*
471 * Write out the command to the device.
472 */
473 if (command == NAND_CMD_SEQIN) {
474 int readcmd;
475
William Juulcfa460a2007-10-31 13:53:06 +0100476 if (column >= mtd->writesize) {
Wolfgang Denk932394a2005-08-17 12:55:25 +0200477 /* OOB area */
William Juulcfa460a2007-10-31 13:53:06 +0100478 column -= mtd->writesize;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200479 readcmd = NAND_CMD_READOOB;
480 } else if (column < 256) {
481 /* First 256 bytes --> READ0 */
482 readcmd = NAND_CMD_READ0;
483 } else {
484 column -= 256;
485 readcmd = NAND_CMD_READ1;
486 }
William Juulcfa460a2007-10-31 13:53:06 +0100487 chip->cmd_ctrl(mtd, readcmd, ctrl);
488 ctrl &= ~NAND_CTRL_CHANGE;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200489 }
William Juulcfa460a2007-10-31 13:53:06 +0100490 chip->cmd_ctrl(mtd, command, ctrl);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200491
William Juulcfa460a2007-10-31 13:53:06 +0100492 /*
493 * Address cycle, when necessary
494 */
495 ctrl = NAND_CTRL_ALE | NAND_CTRL_CHANGE;
496 /* Serially input address */
497 if (column != -1) {
498 /* Adjust columns for 16 bit buswidth */
499 if (chip->options & NAND_BUSWIDTH_16)
500 column >>= 1;
501 chip->cmd_ctrl(mtd, column, ctrl);
502 ctrl &= ~NAND_CTRL_CHANGE;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200503 }
William Juulcfa460a2007-10-31 13:53:06 +0100504 if (page_addr != -1) {
505 chip->cmd_ctrl(mtd, page_addr, ctrl);
506 ctrl &= ~NAND_CTRL_CHANGE;
507 chip->cmd_ctrl(mtd, page_addr >> 8, ctrl);
508 /* One more address cycle for devices > 32MiB */
509 if (chip->chipsize > (32 << 20))
510 chip->cmd_ctrl(mtd, page_addr >> 16, ctrl);
511 }
512 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200513
514 /*
515 * program and erase have their own busy handlers
Wolfgang Denk932394a2005-08-17 12:55:25 +0200516 * status and sequential in needs no delay
William Juulcfa460a2007-10-31 13:53:06 +0100517 */
Wolfgang Denk932394a2005-08-17 12:55:25 +0200518 switch (command) {
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200519
Wolfgang Denk932394a2005-08-17 12:55:25 +0200520 case NAND_CMD_PAGEPROG:
521 case NAND_CMD_ERASE1:
522 case NAND_CMD_ERASE2:
523 case NAND_CMD_SEQIN:
524 case NAND_CMD_STATUS:
525 return;
526
527 case NAND_CMD_RESET:
William Juulcfa460a2007-10-31 13:53:06 +0100528 if (chip->dev_ready)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200529 break;
William Juulcfa460a2007-10-31 13:53:06 +0100530 udelay(chip->chip_delay);
531 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
532 NAND_CTRL_CLE | NAND_CTRL_CHANGE);
533 chip->cmd_ctrl(mtd,
534 NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Peter Tyser8da60122009-02-04 13:47:22 -0600535 while (!(chip->read_byte(mtd) & NAND_STATUS_READY) &&
536 (rst_sts_cnt--));
Wolfgang Denk932394a2005-08-17 12:55:25 +0200537 return;
538
William Juulcfa460a2007-10-31 13:53:06 +0100539 /* This applies to read commands */
Wolfgang Denk932394a2005-08-17 12:55:25 +0200540 default:
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200541 /*
Wolfgang Denk932394a2005-08-17 12:55:25 +0200542 * If we don't have access to the busy pin, we apply the given
543 * command delay
William Juulcfa460a2007-10-31 13:53:06 +0100544 */
545 if (!chip->dev_ready) {
546 udelay(chip->chip_delay);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200547 return;
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200548 }
Wolfgang Denk932394a2005-08-17 12:55:25 +0200549 }
Wolfgang Denk932394a2005-08-17 12:55:25 +0200550 /* Apply this short delay always to ensure that we do wait tWB in
551 * any case on any machine. */
William Juulcfa460a2007-10-31 13:53:06 +0100552 ndelay(100);
553
554 nand_wait_ready(mtd);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200555}
556
557/**
558 * nand_command_lp - [DEFAULT] Send command to NAND large page device
559 * @mtd: MTD device structure
560 * @command: the command to be sent
561 * @column: the column address for this command, -1 if none
562 * @page_addr: the page address for this command, -1 if none
563 *
William Juulcfa460a2007-10-31 13:53:06 +0100564 * Send command to NAND device. This is the version for the new large page
565 * devices We dont have the separate regions as we have in the small page
566 * devices. We must emulate NAND_CMD_READOOB to keep the code compatible.
Wolfgang Denk932394a2005-08-17 12:55:25 +0200567 */
William Juulcfa460a2007-10-31 13:53:06 +0100568static void nand_command_lp(struct mtd_info *mtd, unsigned int command,
569 int column, int page_addr)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200570{
William Juulcfa460a2007-10-31 13:53:06 +0100571 register struct nand_chip *chip = mtd->priv;
Peter Tyser8da60122009-02-04 13:47:22 -0600572 uint32_t rst_sts_cnt = CONFIG_SYS_NAND_RESET_CNT;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200573
574 /* Emulate NAND_CMD_READOOB */
575 if (command == NAND_CMD_READOOB) {
William Juulcfa460a2007-10-31 13:53:06 +0100576 column += mtd->writesize;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200577 command = NAND_CMD_READ0;
578 }
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200579
William Juulcfa460a2007-10-31 13:53:06 +0100580 /* Command latch cycle */
581 chip->cmd_ctrl(mtd, command & 0xff,
582 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200583
584 if (column != -1 || page_addr != -1) {
William Juulcfa460a2007-10-31 13:53:06 +0100585 int ctrl = NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200586
587 /* Serially input address */
588 if (column != -1) {
589 /* Adjust columns for 16 bit buswidth */
William Juulcfa460a2007-10-31 13:53:06 +0100590 if (chip->options & NAND_BUSWIDTH_16)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200591 column >>= 1;
William Juulcfa460a2007-10-31 13:53:06 +0100592 chip->cmd_ctrl(mtd, column, ctrl);
593 ctrl &= ~NAND_CTRL_CHANGE;
594 chip->cmd_ctrl(mtd, column >> 8, ctrl);
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200595 }
Wolfgang Denk932394a2005-08-17 12:55:25 +0200596 if (page_addr != -1) {
William Juulcfa460a2007-10-31 13:53:06 +0100597 chip->cmd_ctrl(mtd, page_addr, ctrl);
598 chip->cmd_ctrl(mtd, page_addr >> 8,
599 NAND_NCE | NAND_ALE);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200600 /* One more address cycle for devices > 128MiB */
William Juulcfa460a2007-10-31 13:53:06 +0100601 if (chip->chipsize > (128 << 20))
602 chip->cmd_ctrl(mtd, page_addr >> 16,
603 NAND_NCE | NAND_ALE);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200604 }
Wolfgang Denk932394a2005-08-17 12:55:25 +0200605 }
William Juulcfa460a2007-10-31 13:53:06 +0100606 chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200607
608 /*
609 * program and erase have their own busy handlers
William Juulcfa460a2007-10-31 13:53:06 +0100610 * status, sequential in, and deplete1 need no delay
611 */
Wolfgang Denk932394a2005-08-17 12:55:25 +0200612 switch (command) {
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200613
Wolfgang Denk932394a2005-08-17 12:55:25 +0200614 case NAND_CMD_CACHEDPROG:
615 case NAND_CMD_PAGEPROG:
616 case NAND_CMD_ERASE1:
617 case NAND_CMD_ERASE2:
618 case NAND_CMD_SEQIN:
William Juulcfa460a2007-10-31 13:53:06 +0100619 case NAND_CMD_RNDIN:
Wolfgang Denk932394a2005-08-17 12:55:25 +0200620 case NAND_CMD_STATUS:
William Juulcfa460a2007-10-31 13:53:06 +0100621 case NAND_CMD_DEPLETE1:
Wolfgang Denk932394a2005-08-17 12:55:25 +0200622 return;
623
William Juulcfa460a2007-10-31 13:53:06 +0100624 /*
625 * read error status commands require only a short delay
626 */
627 case NAND_CMD_STATUS_ERROR:
628 case NAND_CMD_STATUS_ERROR0:
629 case NAND_CMD_STATUS_ERROR1:
630 case NAND_CMD_STATUS_ERROR2:
631 case NAND_CMD_STATUS_ERROR3:
632 udelay(chip->chip_delay);
633 return;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200634
635 case NAND_CMD_RESET:
William Juulcfa460a2007-10-31 13:53:06 +0100636 if (chip->dev_ready)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200637 break;
William Juulcfa460a2007-10-31 13:53:06 +0100638 udelay(chip->chip_delay);
639 chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
640 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
641 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
642 NAND_NCE | NAND_CTRL_CHANGE);
Peter Tyser8da60122009-02-04 13:47:22 -0600643 while (!(chip->read_byte(mtd) & NAND_STATUS_READY) &&
644 (rst_sts_cnt--));
William Juulcfa460a2007-10-31 13:53:06 +0100645 return;
646
647 case NAND_CMD_RNDOUT:
648 /* No ready / busy check necessary */
649 chip->cmd_ctrl(mtd, NAND_CMD_RNDOUTSTART,
650 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
651 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
652 NAND_NCE | NAND_CTRL_CHANGE);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200653 return;
654
655 case NAND_CMD_READ0:
William Juulcfa460a2007-10-31 13:53:06 +0100656 chip->cmd_ctrl(mtd, NAND_CMD_READSTART,
657 NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
658 chip->cmd_ctrl(mtd, NAND_CMD_NONE,
659 NAND_NCE | NAND_CTRL_CHANGE);
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200660
William Juulcfa460a2007-10-31 13:53:06 +0100661 /* This applies to read commands */
Wolfgang Denk932394a2005-08-17 12:55:25 +0200662 default:
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200663 /*
Wolfgang Denk932394a2005-08-17 12:55:25 +0200664 * If we don't have access to the busy pin, we apply the given
665 * command delay
William Juulcfa460a2007-10-31 13:53:06 +0100666 */
667 if (!chip->dev_ready) {
668 udelay(chip->chip_delay);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200669 return;
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200670 }
Wolfgang Denk932394a2005-08-17 12:55:25 +0200671 }
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200672
Wolfgang Denk932394a2005-08-17 12:55:25 +0200673 /* Apply this short delay always to ensure that we do wait tWB in
674 * any case on any machine. */
William Juulcfa460a2007-10-31 13:53:06 +0100675 ndelay(100);
676
677 nand_wait_ready(mtd);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200678}
679
680/**
681 * nand_get_device - [GENERIC] Get chip for selected access
William Juulcfa460a2007-10-31 13:53:06 +0100682 * @chip: the nand chip descriptor
Wolfgang Denk932394a2005-08-17 12:55:25 +0200683 * @mtd: MTD device structure
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200684 * @new_state: the state which is requested
Wolfgang Denk932394a2005-08-17 12:55:25 +0200685 *
686 * Get the device and lock it for exclusive access
687 */
William Juulcfa460a2007-10-31 13:53:06 +0100688static int nand_get_device (struct nand_chip *this, struct mtd_info *mtd, int new_state)
689{
Marcel Ziswilereafcabd2008-06-22 16:30:06 +0200690 this->state = new_state;
William Juulcfa460a2007-10-31 13:53:06 +0100691 return 0;
692}
Wolfgang Denk932394a2005-08-17 12:55:25 +0200693
694/**
695 * nand_wait - [DEFAULT] wait until the command is done
696 * @mtd: MTD device structure
William Juulcfa460a2007-10-31 13:53:06 +0100697 * @chip: NAND chip structure
Wolfgang Denk932394a2005-08-17 12:55:25 +0200698 *
699 * Wait for command done. This applies to erase and program only
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200700 * Erase can take up to 400ms and program up to 20ms according to
Wolfgang Denk932394a2005-08-17 12:55:25 +0200701 * general NAND and SmartMedia specs
William Juulcfa460a2007-10-31 13:53:06 +0100702 */
William Juulcfa460a2007-10-31 13:53:06 +0100703static int nand_wait(struct mtd_info *mtd, struct nand_chip *this)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200704{
Wolfgang Denk8e9655f2005-11-02 14:29:12 +0100705 unsigned long timeo;
William Juulcfa460a2007-10-31 13:53:06 +0100706 int state = this->state;
Wolfgang Denk8e9655f2005-11-02 14:29:12 +0100707
708 if (state == FL_ERASING)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200709 timeo = (CONFIG_SYS_HZ * 400) / 1000;
Wolfgang Denk8e9655f2005-11-02 14:29:12 +0100710 else
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200711 timeo = (CONFIG_SYS_HZ * 20) / 1000;
Wolfgang Denk8e9655f2005-11-02 14:29:12 +0100712
713 if ((state == FL_ERASING) && (this->options & NAND_IS_AND))
714 this->cmdfunc(mtd, NAND_CMD_STATUS_MULTI, -1, -1);
715 else
716 this->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
717
Bartlomiej Sieka038ccac2006-02-24 09:37:22 +0100718 reset_timer();
Wolfgang Denk8e9655f2005-11-02 14:29:12 +0100719
720 while (1) {
Bartlomiej Sieka038ccac2006-02-24 09:37:22 +0100721 if (get_timer(0) > timeo) {
722 printf("Timeout!");
Stefan Roese15784862006-11-27 17:22:19 +0100723 return 0x01;
724 }
Wolfgang Denk8e9655f2005-11-02 14:29:12 +0100725
726 if (this->dev_ready) {
727 if (this->dev_ready(mtd))
728 break;
729 } else {
730 if (this->read_byte(mtd) & NAND_STATUS_READY)
731 break;
732 }
733 }
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100734#ifdef PPCHAMELON_NAND_TIMER_HACK
Bartlomiej Sieka038ccac2006-02-24 09:37:22 +0100735 reset_timer();
736 while (get_timer(0) < 10);
Bartlomiej Siekaaddb2e12006-03-05 18:57:33 +0100737#endif /* PPCHAMELON_NAND_TIMER_HACK */
Bartlomiej Sieka038ccac2006-02-24 09:37:22 +0100738
Wolfgang Denk8e9655f2005-11-02 14:29:12 +0100739 return this->read_byte(mtd);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200740}
Wolfgang Denk932394a2005-08-17 12:55:25 +0200741
742/**
William Juulcfa460a2007-10-31 13:53:06 +0100743 * nand_read_page_raw - [Intern] read raw page data without ecc
744 * @mtd: mtd info structure
745 * @chip: nand chip info structure
746 * @buf: buffer to store read data
Sandeep Paulraje25ee032009-11-07 14:24:50 -0500747 * @page: page number to read
David Brownell7e866612009-11-07 16:27:01 -0500748 *
749 * Not for syndrome calculating ecc controllers, which use a special oob layout
Wolfgang Denk932394a2005-08-17 12:55:25 +0200750 */
William Juulcfa460a2007-10-31 13:53:06 +0100751static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
Sandeep Paulraja2c65b42009-08-10 13:27:46 -0400752 uint8_t *buf, int page)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200753{
William Juulcfa460a2007-10-31 13:53:06 +0100754 chip->read_buf(mtd, buf, mtd->writesize);
755 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
756 return 0;
757}
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200758
William Juulcfa460a2007-10-31 13:53:06 +0100759/**
David Brownell7e866612009-11-07 16:27:01 -0500760 * nand_read_page_raw_syndrome - [Intern] read raw page data without ecc
761 * @mtd: mtd info structure
762 * @chip: nand chip info structure
763 * @buf: buffer to store read data
764 * @page: page number to read
765 *
766 * We need a special oob layout and handling even when OOB isn't used.
767 */
768static int nand_read_page_raw_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
769 uint8_t *buf, int page)
770{
771 int eccsize = chip->ecc.size;
772 int eccbytes = chip->ecc.bytes;
773 uint8_t *oob = chip->oob_poi;
774 int steps, size;
775
776 for (steps = chip->ecc.steps; steps > 0; steps--) {
777 chip->read_buf(mtd, buf, eccsize);
778 buf += eccsize;
779
780 if (chip->ecc.prepad) {
781 chip->read_buf(mtd, oob, chip->ecc.prepad);
782 oob += chip->ecc.prepad;
783 }
784
785 chip->read_buf(mtd, oob, eccbytes);
786 oob += eccbytes;
787
788 if (chip->ecc.postpad) {
789 chip->read_buf(mtd, oob, chip->ecc.postpad);
790 oob += chip->ecc.postpad;
791 }
792 }
793
794 size = mtd->oobsize - (oob - chip->oob_poi);
795 if (size)
796 chip->read_buf(mtd, oob, size);
797
798 return 0;
799}
800
801/**
William Juulcfa460a2007-10-31 13:53:06 +0100802 * nand_read_page_swecc - [REPLACABLE] software ecc based page read function
803 * @mtd: mtd info structure
804 * @chip: nand chip info structure
805 * @buf: buffer to store read data
Sandeep Paulraje25ee032009-11-07 14:24:50 -0500806 * @page: page number to read
William Juulcfa460a2007-10-31 13:53:06 +0100807 */
808static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
Sandeep Paulraja2c65b42009-08-10 13:27:46 -0400809 uint8_t *buf, int page)
William Juulcfa460a2007-10-31 13:53:06 +0100810{
811 int i, eccsize = chip->ecc.size;
812 int eccbytes = chip->ecc.bytes;
813 int eccsteps = chip->ecc.steps;
814 uint8_t *p = buf;
815 uint8_t *ecc_calc = chip->buffers->ecccalc;
816 uint8_t *ecc_code = chip->buffers->ecccode;
817 uint32_t *eccpos = chip->ecc.layout->eccpos;
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200818
Sandeep Paulraja2c65b42009-08-10 13:27:46 -0400819 chip->ecc.read_page_raw(mtd, chip, buf, page);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200820
William Juulcfa460a2007-10-31 13:53:06 +0100821 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
822 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200823
William Juulcfa460a2007-10-31 13:53:06 +0100824 for (i = 0; i < chip->ecc.total; i++)
825 ecc_code[i] = chip->oob_poi[eccpos[i]];
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200826
William Juulcfa460a2007-10-31 13:53:06 +0100827 eccsteps = chip->ecc.steps;
828 p = buf;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200829
William Juulcfa460a2007-10-31 13:53:06 +0100830 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
831 int stat;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200832
William Juulcfa460a2007-10-31 13:53:06 +0100833 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
Scott Woodc45912d2008-10-24 16:20:43 -0500834 if (stat < 0)
835 mtd->ecc_stats.failed++;
836 else
837 mtd->ecc_stats.corrected += stat;
838 }
839 return 0;
840}
841
842/**
843 * nand_read_subpage - [REPLACABLE] software ecc based sub-page read function
844 * @mtd: mtd info structure
845 * @chip: nand chip info structure
Sandeep Paulraje25ee032009-11-07 14:24:50 -0500846 * @data_offs: offset of requested data within the page
847 * @readlen: data length
848 * @bufpoi: buffer to store read data
Scott Woodc45912d2008-10-24 16:20:43 -0500849 */
850static int nand_read_subpage(struct mtd_info *mtd, struct nand_chip *chip, uint32_t data_offs, uint32_t readlen, uint8_t *bufpoi)
851{
852 int start_step, end_step, num_steps;
853 uint32_t *eccpos = chip->ecc.layout->eccpos;
854 uint8_t *p;
855 int data_col_addr, i, gaps = 0;
856 int datafrag_len, eccfrag_len, aligned_len, aligned_pos;
857 int busw = (chip->options & NAND_BUSWIDTH_16) ? 2 : 1;
858
859 /* Column address wihin the page aligned to ECC size (256bytes). */
860 start_step = data_offs / chip->ecc.size;
861 end_step = (data_offs + readlen - 1) / chip->ecc.size;
862 num_steps = end_step - start_step + 1;
863
864 /* Data size aligned to ECC ecc.size*/
865 datafrag_len = num_steps * chip->ecc.size;
866 eccfrag_len = num_steps * chip->ecc.bytes;
867
868 data_col_addr = start_step * chip->ecc.size;
869 /* If we read not a page aligned data */
870 if (data_col_addr != 0)
871 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, data_col_addr, -1);
872
873 p = bufpoi + data_col_addr;
874 chip->read_buf(mtd, p, datafrag_len);
875
876 /* Calculate ECC */
877 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size)
878 chip->ecc.calculate(mtd, p, &chip->buffers->ecccalc[i]);
879
880 /* The performance is faster if to position offsets
881 according to ecc.pos. Let make sure here that
882 there are no gaps in ecc positions */
883 for (i = 0; i < eccfrag_len - 1; i++) {
884 if (eccpos[i + start_step * chip->ecc.bytes] + 1 !=
885 eccpos[i + start_step * chip->ecc.bytes + 1]) {
886 gaps = 1;
887 break;
888 }
889 }
890 if (gaps) {
891 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize, -1);
892 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
893 } else {
894 /* send the command to read the particular ecc bytes */
895 /* take care about buswidth alignment in read_buf */
896 aligned_pos = eccpos[start_step * chip->ecc.bytes] & ~(busw - 1);
897 aligned_len = eccfrag_len;
898 if (eccpos[start_step * chip->ecc.bytes] & (busw - 1))
899 aligned_len++;
900 if (eccpos[(start_step + num_steps) * chip->ecc.bytes] & (busw - 1))
901 aligned_len++;
902
903 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize + aligned_pos, -1);
904 chip->read_buf(mtd, &chip->oob_poi[aligned_pos], aligned_len);
905 }
906
907 for (i = 0; i < eccfrag_len; i++)
908 chip->buffers->ecccode[i] = chip->oob_poi[eccpos[i + start_step * chip->ecc.bytes]];
909
910 p = bufpoi + data_col_addr;
911 for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size) {
912 int stat;
913
914 stat = chip->ecc.correct(mtd, p, &chip->buffers->ecccode[i], &chip->buffers->ecccalc[i]);
Sandeep Paulraj6cd752f2009-11-16 13:32:01 -0500915 if (stat == -1)
William Juulcfa460a2007-10-31 13:53:06 +0100916 mtd->ecc_stats.failed++;
917 else
918 mtd->ecc_stats.corrected += stat;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200919 }
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +0200920 return 0;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200921}
922
Wolfgang Denk932394a2005-08-17 12:55:25 +0200923/**
William Juulcfa460a2007-10-31 13:53:06 +0100924 * nand_read_page_hwecc - [REPLACABLE] hardware ecc based page read function
925 * @mtd: mtd info structure
926 * @chip: nand chip info structure
927 * @buf: buffer to store read data
Sandeep Paulraje25ee032009-11-07 14:24:50 -0500928 * @page: page number to read
Wolfgang Denk932394a2005-08-17 12:55:25 +0200929 *
William Juulcfa460a2007-10-31 13:53:06 +0100930 * Not for syndrome calculating ecc controllers which need a special oob layout
Wolfgang Denk932394a2005-08-17 12:55:25 +0200931 */
William Juulcfa460a2007-10-31 13:53:06 +0100932static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
Sandeep Paulraja2c65b42009-08-10 13:27:46 -0400933 uint8_t *buf, int page)
Wolfgang Denk932394a2005-08-17 12:55:25 +0200934{
William Juulcfa460a2007-10-31 13:53:06 +0100935 int i, eccsize = chip->ecc.size;
936 int eccbytes = chip->ecc.bytes;
937 int eccsteps = chip->ecc.steps;
938 uint8_t *p = buf;
939 uint8_t *ecc_calc = chip->buffers->ecccalc;
940 uint8_t *ecc_code = chip->buffers->ecccode;
941 uint32_t *eccpos = chip->ecc.layout->eccpos;
Wolfgang Denk932394a2005-08-17 12:55:25 +0200942
William Juulcfa460a2007-10-31 13:53:06 +0100943 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
944 chip->ecc.hwctl(mtd, NAND_ECC_READ);
945 chip->read_buf(mtd, p, eccsize);
946 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
947 }
948 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
Wolfgang Denk932394a2005-08-17 12:55:25 +0200949
William Juulcfa460a2007-10-31 13:53:06 +0100950 for (i = 0; i < chip->ecc.total; i++)
951 ecc_code[i] = chip->oob_poi[eccpos[i]];
Wolfgang Denk932394a2005-08-17 12:55:25 +0200952
William Juulcfa460a2007-10-31 13:53:06 +0100953 eccsteps = chip->ecc.steps;
954 p = buf;
955
956 for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
957 int stat;
958
959 stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
Sandeep Paulraj18b5a4b2009-11-07 14:25:03 -0500960 if (stat < 0)
William Juulcfa460a2007-10-31 13:53:06 +0100961 mtd->ecc_stats.failed++;
962 else
963 mtd->ecc_stats.corrected += stat;
964 }
965 return 0;
966}
967
968/**
Sandeep Paulrajf83b7f92009-08-10 13:27:56 -0400969 * nand_read_page_hwecc_oob_first - [REPLACABLE] hw ecc, read oob first
970 * @mtd: mtd info structure
971 * @chip: nand chip info structure
972 * @buf: buffer to store read data
Sandeep Paulraje25ee032009-11-07 14:24:50 -0500973 * @page: page number to read
Sandeep Paulrajf83b7f92009-08-10 13:27:56 -0400974 *
975 * Hardware ECC for large page chips, require OOB to be read first.
976 * For this ECC mode, the write_page method is re-used from ECC_HW.
977 * These methods read/write ECC from the OOB area, unlike the
978 * ECC_HW_SYNDROME support with multiple ECC steps, follows the
979 * "infix ECC" scheme and reads/writes ECC from the data area, by
980 * overwriting the NAND manufacturer bad block markings.
981 */
982static int nand_read_page_hwecc_oob_first(struct mtd_info *mtd,
983 struct nand_chip *chip, uint8_t *buf, int page)
984{
985 int i, eccsize = chip->ecc.size;
986 int eccbytes = chip->ecc.bytes;
987 int eccsteps = chip->ecc.steps;
988 uint8_t *p = buf;
989 uint8_t *ecc_code = chip->buffers->ecccode;
990 uint32_t *eccpos = chip->ecc.layout->eccpos;
991 uint8_t *ecc_calc = chip->buffers->ecccalc;
992
993 /* Read the OOB area first */
994 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
995 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
996 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
997
998 for (i = 0; i < chip->ecc.total; i++)
999 ecc_code[i] = chip->oob_poi[eccpos[i]];
1000
1001 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1002 int stat;
1003
1004 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1005 chip->read_buf(mtd, p, eccsize);
1006 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1007
1008 stat = chip->ecc.correct(mtd, p, &ecc_code[i], NULL);
1009 if (stat < 0)
1010 mtd->ecc_stats.failed++;
1011 else
1012 mtd->ecc_stats.corrected += stat;
1013 }
1014 return 0;
1015}
1016
1017/**
William Juulcfa460a2007-10-31 13:53:06 +01001018 * nand_read_page_syndrome - [REPLACABLE] hardware ecc syndrom based page read
1019 * @mtd: mtd info structure
1020 * @chip: nand chip info structure
1021 * @buf: buffer to store read data
Sandeep Paulraje25ee032009-11-07 14:24:50 -05001022 * @page: page number to read
William Juulcfa460a2007-10-31 13:53:06 +01001023 *
1024 * The hw generator calculates the error syndrome automatically. Therefor
1025 * we need a special oob layout and handling.
1026 */
1027static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
Sandeep Paulraja2c65b42009-08-10 13:27:46 -04001028 uint8_t *buf, int page)
William Juulcfa460a2007-10-31 13:53:06 +01001029{
1030 int i, eccsize = chip->ecc.size;
1031 int eccbytes = chip->ecc.bytes;
1032 int eccsteps = chip->ecc.steps;
1033 uint8_t *p = buf;
1034 uint8_t *oob = chip->oob_poi;
1035
1036 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1037 int stat;
1038
1039 chip->ecc.hwctl(mtd, NAND_ECC_READ);
1040 chip->read_buf(mtd, p, eccsize);
1041
1042 if (chip->ecc.prepad) {
1043 chip->read_buf(mtd, oob, chip->ecc.prepad);
1044 oob += chip->ecc.prepad;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001045 }
1046
William Juulcfa460a2007-10-31 13:53:06 +01001047 chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
1048 chip->read_buf(mtd, oob, eccbytes);
1049 stat = chip->ecc.correct(mtd, p, oob, NULL);
1050
Scott Woodc45912d2008-10-24 16:20:43 -05001051 if (stat < 0)
William Juulcfa460a2007-10-31 13:53:06 +01001052 mtd->ecc_stats.failed++;
1053 else
1054 mtd->ecc_stats.corrected += stat;
1055
1056 oob += eccbytes;
1057
1058 if (chip->ecc.postpad) {
1059 chip->read_buf(mtd, oob, chip->ecc.postpad);
1060 oob += chip->ecc.postpad;
1061 }
1062 }
1063
1064 /* Calculate remaining oob bytes */
1065 i = mtd->oobsize - (oob - chip->oob_poi);
1066 if (i)
1067 chip->read_buf(mtd, oob, i);
1068
1069 return 0;
1070}
1071
1072/**
1073 * nand_transfer_oob - [Internal] Transfer oob to client buffer
1074 * @chip: nand chip structure
1075 * @oob: oob destination address
1076 * @ops: oob ops structure
1077 * @len: size of oob to transfer
1078 */
1079static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
1080 struct mtd_oob_ops *ops, size_t len)
1081{
1082 switch(ops->mode) {
1083
1084 case MTD_OOB_PLACE:
1085 case MTD_OOB_RAW:
1086 memcpy(oob, chip->oob_poi + ops->ooboffs, len);
1087 return oob + len;
1088
1089 case MTD_OOB_AUTO: {
1090 struct nand_oobfree *free = chip->ecc.layout->oobfree;
1091 uint32_t boffs = 0, roffs = ops->ooboffs;
1092 size_t bytes = 0;
1093
1094 for(; free->length && len; free++, len -= bytes) {
1095 /* Read request not from offset 0 ? */
1096 if (unlikely(roffs)) {
1097 if (roffs >= free->length) {
1098 roffs -= free->length;
1099 continue;
1100 }
1101 boffs = free->offset + roffs;
1102 bytes = min_t(size_t, len,
1103 (free->length - roffs));
1104 roffs = 0;
1105 } else {
1106 bytes = min_t(size_t, len, free->length);
1107 boffs = free->offset;
1108 }
1109 memcpy(oob, chip->oob_poi + boffs, bytes);
1110 oob += bytes;
1111 }
1112 return oob;
1113 }
1114 default:
1115 BUG();
1116 }
1117 return NULL;
1118}
1119
1120/**
1121 * nand_do_read_ops - [Internal] Read data with ECC
1122 *
1123 * @mtd: MTD device structure
1124 * @from: offset to read from
1125 * @ops: oob ops structure
1126 *
1127 * Internal function. Called with chip held.
1128 */
1129static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
1130 struct mtd_oob_ops *ops)
1131{
1132 int chipnr, page, realpage, col, bytes, aligned;
1133 struct nand_chip *chip = mtd->priv;
1134 struct mtd_ecc_stats stats;
1135 int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
1136 int sndcmd = 1;
1137 int ret = 0;
1138 uint32_t readlen = ops->len;
1139 uint32_t oobreadlen = ops->ooblen;
1140 uint8_t *bufpoi, *oob, *buf;
1141
1142 stats = mtd->ecc_stats;
1143
1144 chipnr = (int)(from >> chip->chip_shift);
1145 chip->select_chip(mtd, chipnr);
1146
1147 realpage = (int)(from >> chip->page_shift);
1148 page = realpage & chip->pagemask;
1149
1150 col = (int)(from & (mtd->writesize - 1));
1151
1152 buf = ops->datbuf;
1153 oob = ops->oobbuf;
1154
1155 while(1) {
1156 bytes = min(mtd->writesize - col, readlen);
1157 aligned = (bytes == mtd->writesize);
1158
1159 /* Is the current page in the buffer ? */
1160 if (realpage != chip->pagebuf || oob) {
1161 bufpoi = aligned ? buf : chip->buffers->databuf;
1162
1163 if (likely(sndcmd)) {
1164 chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
1165 sndcmd = 0;
1166 }
1167
1168 /* Now read the page into the buffer */
1169 if (unlikely(ops->mode == MTD_OOB_RAW))
Sandeep Paulraja2c65b42009-08-10 13:27:46 -04001170 ret = chip->ecc.read_page_raw(mtd, chip,
1171 bufpoi, page);
Scott Woodc45912d2008-10-24 16:20:43 -05001172 else if (!aligned && NAND_SUBPAGE_READ(chip) && !oob)
1173 ret = chip->ecc.read_subpage(mtd, chip, col, bytes, bufpoi);
William Juulcfa460a2007-10-31 13:53:06 +01001174 else
Sandeep Paulraja2c65b42009-08-10 13:27:46 -04001175 ret = chip->ecc.read_page(mtd, chip, bufpoi,
1176 page);
William Juulcfa460a2007-10-31 13:53:06 +01001177 if (ret < 0)
1178 break;
1179
1180 /* Transfer not aligned data */
1181 if (!aligned) {
Scott Woodc45912d2008-10-24 16:20:43 -05001182 if (!NAND_SUBPAGE_READ(chip) && !oob)
1183 chip->pagebuf = realpage;
William Juulcfa460a2007-10-31 13:53:06 +01001184 memcpy(buf, chip->buffers->databuf + col, bytes);
1185 }
1186
1187 buf += bytes;
1188
1189 if (unlikely(oob)) {
1190 /* Raw mode does data:oob:data:oob */
1191 if (ops->mode != MTD_OOB_RAW) {
1192 int toread = min(oobreadlen,
1193 chip->ecc.layout->oobavail);
1194 if (toread) {
1195 oob = nand_transfer_oob(chip,
1196 oob, ops, toread);
1197 oobreadlen -= toread;
1198 }
1199 } else
1200 buf = nand_transfer_oob(chip,
1201 buf, ops, mtd->oobsize);
1202 }
1203
1204 if (!(chip->options & NAND_NO_READRDY)) {
1205 /*
1206 * Apply delay or wait for ready/busy pin. Do
1207 * this before the AUTOINCR check, so no
1208 * problems arise if a chip which does auto
1209 * increment is marked as NOAUTOINCR by the
1210 * board driver.
1211 */
1212 if (!chip->dev_ready)
1213 udelay(chip->chip_delay);
1214 else
1215 nand_wait_ready(mtd);
Wolfgang Denk932394a2005-08-17 12:55:25 +02001216 }
1217 } else {
William Juulcfa460a2007-10-31 13:53:06 +01001218 memcpy(buf, chip->buffers->databuf + col, bytes);
1219 buf += bytes;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001220 }
1221
William Juulcfa460a2007-10-31 13:53:06 +01001222 readlen -= bytes;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001223
William Juulcfa460a2007-10-31 13:53:06 +01001224 if (!readlen)
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +02001225 break;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001226
1227 /* For subsequent reads align to page boundary. */
1228 col = 0;
1229 /* Increment page address */
1230 realpage++;
1231
William Juulcfa460a2007-10-31 13:53:06 +01001232 page = realpage & chip->pagemask;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001233 /* Check, if we cross a chip boundary */
1234 if (!page) {
1235 chipnr++;
William Juulcfa460a2007-10-31 13:53:06 +01001236 chip->select_chip(mtd, -1);
1237 chip->select_chip(mtd, chipnr);
Wolfgang Denk932394a2005-08-17 12:55:25 +02001238 }
William Juulcfa460a2007-10-31 13:53:06 +01001239
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +02001240 /* Check, if the chip supports auto page increment
1241 * or if we have hit a block boundary.
William Juulcfa460a2007-10-31 13:53:06 +01001242 */
1243 if (!NAND_CANAUTOINCR(chip) || !(page & blkcheck))
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +02001244 sndcmd = 1;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001245 }
1246
William Juulcfa460a2007-10-31 13:53:06 +01001247 ops->retlen = ops->len - (size_t) readlen;
1248 if (oob)
1249 ops->oobretlen = ops->ooblen - oobreadlen;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001250
William Juulcfa460a2007-10-31 13:53:06 +01001251 if (ret)
1252 return ret;
1253
1254 if (mtd->ecc_stats.failed - stats.failed)
1255 return -EBADMSG;
1256
1257 return mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001258}
1259
1260/**
William Juulcfa460a2007-10-31 13:53:06 +01001261 * nand_read - [MTD Interface] MTD compability function for nand_do_read_ecc
Wolfgang Denk932394a2005-08-17 12:55:25 +02001262 * @mtd: MTD device structure
1263 * @from: offset to read from
1264 * @len: number of bytes to read
1265 * @retlen: pointer to variable to store the number of read bytes
1266 * @buf: the databuffer to put data
1267 *
William Juulcfa460a2007-10-31 13:53:06 +01001268 * Get hold of the chip and call nand_do_read
Wolfgang Denk932394a2005-08-17 12:55:25 +02001269 */
William Juulcfa460a2007-10-31 13:53:06 +01001270static int nand_read(struct mtd_info *mtd, loff_t from, size_t len,
1271 size_t *retlen, uint8_t *buf)
Wolfgang Denk932394a2005-08-17 12:55:25 +02001272{
William Juulcfa460a2007-10-31 13:53:06 +01001273 struct nand_chip *chip = mtd->priv;
1274 int ret;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001275
1276 /* Do not allow reads past end of device */
William Juulcfa460a2007-10-31 13:53:06 +01001277 if ((from + len) > mtd->size)
Wolfgang Denk932394a2005-08-17 12:55:25 +02001278 return -EINVAL;
William Juulcfa460a2007-10-31 13:53:06 +01001279 if (!len)
1280 return 0;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001281
William Juulcfa460a2007-10-31 13:53:06 +01001282 nand_get_device(chip, mtd, FL_READING);
Wolfgang Denk932394a2005-08-17 12:55:25 +02001283
William Juulcfa460a2007-10-31 13:53:06 +01001284 chip->ops.len = len;
1285 chip->ops.datbuf = buf;
1286 chip->ops.oobbuf = NULL;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001287
William Juulcfa460a2007-10-31 13:53:06 +01001288 ret = nand_do_read_ops(mtd, from, &chip->ops);
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +02001289
William Juulcfa460a2007-10-31 13:53:06 +01001290 *retlen = chip->ops.retlen;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001291
Wolfgang Denk932394a2005-08-17 12:55:25 +02001292 nand_release_device(mtd);
1293
1294 return ret;
1295}
1296
William Juulcfa460a2007-10-31 13:53:06 +01001297/**
1298 * nand_read_oob_std - [REPLACABLE] the most common OOB data read function
1299 * @mtd: mtd info structure
1300 * @chip: nand chip info structure
1301 * @page: page number to read
1302 * @sndcmd: flag whether to issue read command or not
1303 */
1304static int nand_read_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1305 int page, int sndcmd)
1306{
1307 if (sndcmd) {
1308 chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1309 sndcmd = 0;
1310 }
1311 chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1312 return sndcmd;
1313}
Wolfgang Denk932394a2005-08-17 12:55:25 +02001314
1315/**
William Juulcfa460a2007-10-31 13:53:06 +01001316 * nand_read_oob_syndrome - [REPLACABLE] OOB data read function for HW ECC
1317 * with syndromes
1318 * @mtd: mtd info structure
1319 * @chip: nand chip info structure
1320 * @page: page number to read
1321 * @sndcmd: flag whether to issue read command or not
1322 */
1323static int nand_read_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1324 int page, int sndcmd)
1325{
1326 uint8_t *buf = chip->oob_poi;
1327 int length = mtd->oobsize;
1328 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1329 int eccsize = chip->ecc.size;
1330 uint8_t *bufpoi = buf;
1331 int i, toread, sndrnd = 0, pos;
1332
1333 chip->cmdfunc(mtd, NAND_CMD_READ0, chip->ecc.size, page);
1334 for (i = 0; i < chip->ecc.steps; i++) {
1335 if (sndrnd) {
1336 pos = eccsize + i * (eccsize + chunk);
1337 if (mtd->writesize > 512)
1338 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, pos, -1);
1339 else
1340 chip->cmdfunc(mtd, NAND_CMD_READ0, pos, page);
1341 } else
1342 sndrnd = 1;
1343 toread = min_t(int, length, chunk);
1344 chip->read_buf(mtd, bufpoi, toread);
1345 bufpoi += toread;
1346 length -= toread;
1347 }
1348 if (length > 0)
1349 chip->read_buf(mtd, bufpoi, length);
1350
1351 return 1;
1352}
1353
1354/**
1355 * nand_write_oob_std - [REPLACABLE] the most common OOB data write function
1356 * @mtd: mtd info structure
1357 * @chip: nand chip info structure
1358 * @page: page number to write
1359 */
1360static int nand_write_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1361 int page)
1362{
1363 int status = 0;
1364 const uint8_t *buf = chip->oob_poi;
1365 int length = mtd->oobsize;
1366
1367 chip->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize, page);
1368 chip->write_buf(mtd, buf, length);
1369 /* Send command to program the OOB data */
1370 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1371
1372 status = chip->waitfunc(mtd, chip);
1373
1374 return status & NAND_STATUS_FAIL ? -EIO : 0;
1375}
1376
1377/**
1378 * nand_write_oob_syndrome - [REPLACABLE] OOB data write function for HW ECC
1379 * with syndrome - only for large page flash !
1380 * @mtd: mtd info structure
1381 * @chip: nand chip info structure
1382 * @page: page number to write
1383 */
1384static int nand_write_oob_syndrome(struct mtd_info *mtd,
1385 struct nand_chip *chip, int page)
1386{
1387 int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
1388 int eccsize = chip->ecc.size, length = mtd->oobsize;
1389 int i, len, pos, status = 0, sndcmd = 0, steps = chip->ecc.steps;
1390 const uint8_t *bufpoi = chip->oob_poi;
1391
1392 /*
1393 * data-ecc-data-ecc ... ecc-oob
1394 * or
1395 * data-pad-ecc-pad-data-pad .... ecc-pad-oob
1396 */
1397 if (!chip->ecc.prepad && !chip->ecc.postpad) {
1398 pos = steps * (eccsize + chunk);
1399 steps = 0;
1400 } else
1401 pos = eccsize;
1402
1403 chip->cmdfunc(mtd, NAND_CMD_SEQIN, pos, page);
1404 for (i = 0; i < steps; i++) {
1405 if (sndcmd) {
1406 if (mtd->writesize <= 512) {
1407 uint32_t fill = 0xFFFFFFFF;
1408
1409 len = eccsize;
1410 while (len > 0) {
1411 int num = min_t(int, len, 4);
1412 chip->write_buf(mtd, (uint8_t *)&fill,
1413 num);
1414 len -= num;
1415 }
1416 } else {
1417 pos = eccsize + i * (eccsize + chunk);
1418 chip->cmdfunc(mtd, NAND_CMD_RNDIN, pos, -1);
1419 }
1420 } else
1421 sndcmd = 1;
1422 len = min_t(int, length, chunk);
1423 chip->write_buf(mtd, bufpoi, len);
1424 bufpoi += len;
1425 length -= len;
1426 }
1427 if (length > 0)
1428 chip->write_buf(mtd, bufpoi, length);
1429
1430 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1431 status = chip->waitfunc(mtd, chip);
1432
1433 return status & NAND_STATUS_FAIL ? -EIO : 0;
1434}
1435
1436/**
1437 * nand_do_read_oob - [Intern] NAND read out-of-band
1438 * @mtd: MTD device structure
1439 * @from: offset to read from
1440 * @ops: oob operations description structure
1441 *
1442 * NAND read out-of-band data from the spare area
1443 */
1444static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
1445 struct mtd_oob_ops *ops)
1446{
1447 int page, realpage, chipnr, sndcmd = 1;
1448 struct nand_chip *chip = mtd->priv;
1449 int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
1450 int readlen = ops->ooblen;
1451 int len;
1452 uint8_t *buf = ops->oobbuf;
1453
1454 MTDDEBUG (MTD_DEBUG_LEVEL3, "nand_read_oob: from = 0x%08Lx, len = %i\n",
1455 (unsigned long long)from, readlen);
1456
1457 if (ops->mode == MTD_OOB_AUTO)
1458 len = chip->ecc.layout->oobavail;
1459 else
1460 len = mtd->oobsize;
1461
1462 if (unlikely(ops->ooboffs >= len)) {
1463 MTDDEBUG (MTD_DEBUG_LEVEL0, "nand_read_oob: "
1464 "Attempt to start read outside oob\n");
1465 return -EINVAL;
1466 }
1467
1468 /* Do not allow reads past end of device */
1469 if (unlikely(from >= mtd->size ||
1470 ops->ooboffs + readlen > ((mtd->size >> chip->page_shift) -
1471 (from >> chip->page_shift)) * len)) {
1472 MTDDEBUG (MTD_DEBUG_LEVEL0, "nand_read_oob: "
1473 "Attempt read beyond end of device\n");
1474 return -EINVAL;
1475 }
1476
1477 chipnr = (int)(from >> chip->chip_shift);
1478 chip->select_chip(mtd, chipnr);
1479
1480 /* Shift to get page */
1481 realpage = (int)(from >> chip->page_shift);
1482 page = realpage & chip->pagemask;
1483
1484 while(1) {
1485 sndcmd = chip->ecc.read_oob(mtd, chip, page, sndcmd);
1486
1487 len = min(len, readlen);
1488 buf = nand_transfer_oob(chip, buf, ops, len);
1489
1490 if (!(chip->options & NAND_NO_READRDY)) {
1491 /*
1492 * Apply delay or wait for ready/busy pin. Do this
1493 * before the AUTOINCR check, so no problems arise if a
1494 * chip which does auto increment is marked as
1495 * NOAUTOINCR by the board driver.
1496 */
1497 if (!chip->dev_ready)
1498 udelay(chip->chip_delay);
1499 else
1500 nand_wait_ready(mtd);
1501 }
1502
1503 readlen -= len;
1504 if (!readlen)
1505 break;
1506
1507 /* Increment page address */
1508 realpage++;
1509
1510 page = realpage & chip->pagemask;
1511 /* Check, if we cross a chip boundary */
1512 if (!page) {
1513 chipnr++;
1514 chip->select_chip(mtd, -1);
1515 chip->select_chip(mtd, chipnr);
1516 }
1517
1518 /* Check, if the chip supports auto page increment
1519 * or if we have hit a block boundary.
1520 */
1521 if (!NAND_CANAUTOINCR(chip) || !(page & blkcheck))
1522 sndcmd = 1;
1523 }
1524
1525 ops->oobretlen = ops->ooblen;
1526 return 0;
1527}
1528
1529/**
1530 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
1531 * @mtd: MTD device structure
1532 * @from: offset to read from
1533 * @ops: oob operation description structure
1534 *
1535 * NAND read data and/or out-of-band data
1536 */
1537static int nand_read_oob(struct mtd_info *mtd, loff_t from,
1538 struct mtd_oob_ops *ops)
1539{
1540 struct nand_chip *chip = mtd->priv;
1541 int ret = -ENOTSUPP;
1542
1543 ops->retlen = 0;
1544
1545 /* Do not allow reads past end of device */
1546 if (ops->datbuf && (from + ops->len) > mtd->size) {
1547 MTDDEBUG (MTD_DEBUG_LEVEL0, "nand_read_oob: "
1548 "Attempt read beyond end of device\n");
1549 return -EINVAL;
1550 }
1551
1552 nand_get_device(chip, mtd, FL_READING);
1553
1554 switch(ops->mode) {
1555 case MTD_OOB_PLACE:
1556 case MTD_OOB_AUTO:
1557 case MTD_OOB_RAW:
1558 break;
1559
1560 default:
1561 goto out;
1562 }
1563
1564 if (!ops->datbuf)
1565 ret = nand_do_read_oob(mtd, from, ops);
1566 else
1567 ret = nand_do_read_ops(mtd, from, ops);
1568
1569 out:
1570 nand_release_device(mtd);
1571 return ret;
1572}
1573
1574
1575/**
1576 * nand_write_page_raw - [Intern] raw page write function
1577 * @mtd: mtd info structure
1578 * @chip: nand chip info structure
1579 * @buf: data buffer
David Brownell7e866612009-11-07 16:27:01 -05001580 *
1581 * Not for syndrome calculating ecc controllers, which use a special oob layout
William Juulcfa460a2007-10-31 13:53:06 +01001582 */
1583static void nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1584 const uint8_t *buf)
1585{
1586 chip->write_buf(mtd, buf, mtd->writesize);
1587 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
1588}
1589
1590/**
David Brownell7e866612009-11-07 16:27:01 -05001591 * nand_write_page_raw_syndrome - [Intern] raw page write function
1592 * @mtd: mtd info structure
1593 * @chip: nand chip info structure
1594 * @buf: data buffer
1595 *
1596 * We need a special oob layout and handling even when ECC isn't checked.
1597 */
1598static void nand_write_page_raw_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1599 const uint8_t *buf)
1600{
1601 int eccsize = chip->ecc.size;
1602 int eccbytes = chip->ecc.bytes;
1603 uint8_t *oob = chip->oob_poi;
1604 int steps, size;
1605
1606 for (steps = chip->ecc.steps; steps > 0; steps--) {
1607 chip->write_buf(mtd, buf, eccsize);
1608 buf += eccsize;
1609
1610 if (chip->ecc.prepad) {
1611 chip->write_buf(mtd, oob, chip->ecc.prepad);
1612 oob += chip->ecc.prepad;
1613 }
1614
1615 chip->read_buf(mtd, oob, eccbytes);
1616 oob += eccbytes;
1617
1618 if (chip->ecc.postpad) {
1619 chip->write_buf(mtd, oob, chip->ecc.postpad);
1620 oob += chip->ecc.postpad;
1621 }
1622 }
1623
1624 size = mtd->oobsize - (oob - chip->oob_poi);
1625 if (size)
1626 chip->write_buf(mtd, oob, size);
1627}
1628/**
William Juulcfa460a2007-10-31 13:53:06 +01001629 * nand_write_page_swecc - [REPLACABLE] software ecc based page write function
1630 * @mtd: mtd info structure
1631 * @chip: nand chip info structure
1632 * @buf: data buffer
1633 */
1634static void nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
1635 const uint8_t *buf)
1636{
1637 int i, eccsize = chip->ecc.size;
1638 int eccbytes = chip->ecc.bytes;
1639 int eccsteps = chip->ecc.steps;
1640 uint8_t *ecc_calc = chip->buffers->ecccalc;
1641 const uint8_t *p = buf;
1642 uint32_t *eccpos = chip->ecc.layout->eccpos;
1643
1644 /* Software ecc calculation */
1645 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
1646 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1647
1648 for (i = 0; i < chip->ecc.total; i++)
1649 chip->oob_poi[eccpos[i]] = ecc_calc[i];
1650
1651 chip->ecc.write_page_raw(mtd, chip, buf);
1652}
1653
1654/**
1655 * nand_write_page_hwecc - [REPLACABLE] hardware ecc based page write function
1656 * @mtd: mtd info structure
1657 * @chip: nand chip info structure
1658 * @buf: data buffer
1659 */
1660static void nand_write_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
1661 const uint8_t *buf)
1662{
1663 int i, eccsize = chip->ecc.size;
1664 int eccbytes = chip->ecc.bytes;
1665 int eccsteps = chip->ecc.steps;
1666 uint8_t *ecc_calc = chip->buffers->ecccalc;
1667 const uint8_t *p = buf;
1668 uint32_t *eccpos = chip->ecc.layout->eccpos;
1669
1670 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1671 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
1672 chip->write_buf(mtd, p, eccsize);
1673 chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1674 }
1675
1676 for (i = 0; i < chip->ecc.total; i++)
1677 chip->oob_poi[eccpos[i]] = ecc_calc[i];
1678
1679 chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
1680}
1681
1682/**
1683 * nand_write_page_syndrome - [REPLACABLE] hardware ecc syndrom based page write
1684 * @mtd: mtd info structure
1685 * @chip: nand chip info structure
1686 * @buf: data buffer
1687 *
1688 * The hw generator calculates the error syndrome automatically. Therefor
1689 * we need a special oob layout and handling.
1690 */
1691static void nand_write_page_syndrome(struct mtd_info *mtd,
1692 struct nand_chip *chip, const uint8_t *buf)
1693{
1694 int i, eccsize = chip->ecc.size;
1695 int eccbytes = chip->ecc.bytes;
1696 int eccsteps = chip->ecc.steps;
1697 const uint8_t *p = buf;
1698 uint8_t *oob = chip->oob_poi;
1699
1700 for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
1701
1702 chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
1703 chip->write_buf(mtd, p, eccsize);
1704
1705 if (chip->ecc.prepad) {
1706 chip->write_buf(mtd, oob, chip->ecc.prepad);
1707 oob += chip->ecc.prepad;
1708 }
1709
1710 chip->ecc.calculate(mtd, p, oob);
1711 chip->write_buf(mtd, oob, eccbytes);
1712 oob += eccbytes;
1713
1714 if (chip->ecc.postpad) {
1715 chip->write_buf(mtd, oob, chip->ecc.postpad);
1716 oob += chip->ecc.postpad;
1717 }
1718 }
1719
1720 /* Calculate remaining oob bytes */
1721 i = mtd->oobsize - (oob - chip->oob_poi);
1722 if (i)
1723 chip->write_buf(mtd, oob, i);
1724}
1725
1726/**
1727 * nand_write_page - [REPLACEABLE] write one page
1728 * @mtd: MTD device structure
1729 * @chip: NAND chip descriptor
1730 * @buf: the data to write
1731 * @page: page number to write
1732 * @cached: cached programming
1733 * @raw: use _raw version of write_page
1734 */
1735static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
1736 const uint8_t *buf, int page, int cached, int raw)
1737{
1738 int status;
1739
1740 chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0x00, page);
1741
1742 if (unlikely(raw))
1743 chip->ecc.write_page_raw(mtd, chip, buf);
1744 else
1745 chip->ecc.write_page(mtd, chip, buf);
1746
1747 /*
1748 * Cached progamming disabled for now, Not sure if its worth the
1749 * trouble. The speed gain is not very impressive. (2.3->2.6Mib/s)
1750 */
1751 cached = 0;
1752
1753 if (!cached || !(chip->options & NAND_CACHEPRG)) {
1754
1755 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1756 status = chip->waitfunc(mtd, chip);
1757 /*
1758 * See if operation failed and additional status checks are
1759 * available
1760 */
1761 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
1762 status = chip->errstat(mtd, chip, FL_WRITING, status,
1763 page);
1764
1765 if (status & NAND_STATUS_FAIL)
1766 return -EIO;
1767 } else {
1768 chip->cmdfunc(mtd, NAND_CMD_CACHEDPROG, -1, -1);
1769 status = chip->waitfunc(mtd, chip);
1770 }
1771
1772#ifdef CONFIG_MTD_NAND_VERIFY_WRITE
1773 /* Send command to read back the data */
1774 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
1775
1776 if (chip->verify_buf(mtd, buf, mtd->writesize))
1777 return -EIO;
1778#endif
1779 return 0;
1780}
1781
1782/**
1783 * nand_fill_oob - [Internal] Transfer client buffer to oob
1784 * @chip: nand chip structure
1785 * @oob: oob data buffer
1786 * @ops: oob ops structure
1787 */
1788static uint8_t *nand_fill_oob(struct nand_chip *chip, uint8_t *oob,
1789 struct mtd_oob_ops *ops)
1790{
1791 size_t len = ops->ooblen;
1792
1793 switch(ops->mode) {
1794
1795 case MTD_OOB_PLACE:
1796 case MTD_OOB_RAW:
1797 memcpy(chip->oob_poi + ops->ooboffs, oob, len);
1798 return oob + len;
1799
1800 case MTD_OOB_AUTO: {
1801 struct nand_oobfree *free = chip->ecc.layout->oobfree;
1802 uint32_t boffs = 0, woffs = ops->ooboffs;
1803 size_t bytes = 0;
1804
1805 for(; free->length && len; free++, len -= bytes) {
1806 /* Write request not from offset 0 ? */
1807 if (unlikely(woffs)) {
1808 if (woffs >= free->length) {
1809 woffs -= free->length;
1810 continue;
1811 }
1812 boffs = free->offset + woffs;
1813 bytes = min_t(size_t, len,
1814 (free->length - woffs));
1815 woffs = 0;
1816 } else {
1817 bytes = min_t(size_t, len, free->length);
1818 boffs = free->offset;
1819 }
1820 memcpy(chip->oob_poi + boffs, oob, bytes);
1821 oob += bytes;
1822 }
1823 return oob;
1824 }
1825 default:
1826 BUG();
1827 }
1828 return NULL;
1829}
1830
1831#define NOTALIGNED(x) (x & (chip->subpagesize - 1)) != 0
1832
1833/**
1834 * nand_do_write_ops - [Internal] NAND write with ECC
1835 * @mtd: MTD device structure
1836 * @to: offset to write to
1837 * @ops: oob operations description structure
1838 *
1839 * NAND write with ECC
1840 */
1841static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
1842 struct mtd_oob_ops *ops)
1843{
1844 int chipnr, realpage, page, blockmask, column;
1845 struct nand_chip *chip = mtd->priv;
1846 uint32_t writelen = ops->len;
1847 uint8_t *oob = ops->oobbuf;
1848 uint8_t *buf = ops->datbuf;
1849 int ret, subpage;
1850
1851 ops->retlen = 0;
1852 if (!writelen)
1853 return 0;
1854
William Juulcfa460a2007-10-31 13:53:06 +01001855 column = to & (mtd->writesize - 1);
1856 subpage = column || (writelen & (mtd->writesize - 1));
1857
1858 if (subpage && oob)
1859 return -EINVAL;
1860
1861 chipnr = (int)(to >> chip->chip_shift);
1862 chip->select_chip(mtd, chipnr);
1863
1864 /* Check, if it is write protected */
1865 if (nand_check_wp(mtd)) {
1866 printk (KERN_NOTICE "nand_do_write_ops: Device is write protected\n");
1867 return -EIO;
1868 }
1869
1870 realpage = (int)(to >> chip->page_shift);
1871 page = realpage & chip->pagemask;
1872 blockmask = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
1873
1874 /* Invalidate the page cache, when we write to the cached page */
1875 if (to <= (chip->pagebuf << chip->page_shift) &&
1876 (chip->pagebuf << chip->page_shift) < (to + ops->len))
1877 chip->pagebuf = -1;
1878
1879 /* If we're not given explicit OOB data, let it be 0xFF */
1880 if (likely(!oob))
1881 memset(chip->oob_poi, 0xff, mtd->oobsize);
1882
1883 while(1) {
1884 int bytes = mtd->writesize;
1885 int cached = writelen > bytes && page != blockmask;
1886 uint8_t *wbuf = buf;
1887
1888 /* Partial page write ? */
1889 if (unlikely(column || writelen < (mtd->writesize - 1))) {
1890 cached = 0;
1891 bytes = min_t(int, bytes - column, (int) writelen);
1892 chip->pagebuf = -1;
1893 memset(chip->buffers->databuf, 0xff, mtd->writesize);
1894 memcpy(&chip->buffers->databuf[column], buf, bytes);
1895 wbuf = chip->buffers->databuf;
1896 }
1897
1898 if (unlikely(oob))
1899 oob = nand_fill_oob(chip, oob, ops);
1900
1901 ret = chip->write_page(mtd, chip, wbuf, page, cached,
1902 (ops->mode == MTD_OOB_RAW));
1903 if (ret)
1904 break;
1905
1906 writelen -= bytes;
1907 if (!writelen)
1908 break;
1909
1910 column = 0;
1911 buf += bytes;
1912 realpage++;
1913
1914 page = realpage & chip->pagemask;
1915 /* Check, if we cross a chip boundary */
1916 if (!page) {
1917 chipnr++;
1918 chip->select_chip(mtd, -1);
1919 chip->select_chip(mtd, chipnr);
1920 }
1921 }
1922
1923 ops->retlen = ops->len - writelen;
1924 if (unlikely(oob))
1925 ops->oobretlen = ops->ooblen;
1926 return ret;
1927}
1928
1929/**
1930 * nand_write - [MTD Interface] NAND write with ECC
Wolfgang Denk932394a2005-08-17 12:55:25 +02001931 * @mtd: MTD device structure
1932 * @to: offset to write to
1933 * @len: number of bytes to write
1934 * @retlen: pointer to variable to store the number of written bytes
1935 * @buf: the data to write
1936 *
William Juulcfa460a2007-10-31 13:53:06 +01001937 * NAND write with ECC
1938 */
1939static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
1940 size_t *retlen, const uint8_t *buf)
1941{
1942 struct nand_chip *chip = mtd->priv;
1943 int ret;
1944
1945 /* Do not allow reads past end of device */
1946 if ((to + len) > mtd->size)
1947 return -EINVAL;
1948 if (!len)
1949 return 0;
1950
1951 nand_get_device(chip, mtd, FL_WRITING);
1952
1953 chip->ops.len = len;
1954 chip->ops.datbuf = (uint8_t *)buf;
1955 chip->ops.oobbuf = NULL;
1956
1957 ret = nand_do_write_ops(mtd, to, &chip->ops);
1958
1959 *retlen = chip->ops.retlen;
1960
1961 nand_release_device(mtd);
1962
1963 return ret;
1964}
1965
1966/**
1967 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
1968 * @mtd: MTD device structure
1969 * @to: offset to write to
1970 * @ops: oob operation description structure
1971 *
Wolfgang Denk932394a2005-08-17 12:55:25 +02001972 * NAND write out-of-band
1973 */
William Juulcfa460a2007-10-31 13:53:06 +01001974static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
1975 struct mtd_oob_ops *ops)
Wolfgang Denk932394a2005-08-17 12:55:25 +02001976{
William Juulcfa460a2007-10-31 13:53:06 +01001977 int chipnr, page, status, len;
1978 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001979
Scott Wood3167c532008-06-20 12:38:57 -05001980 MTDDEBUG (MTD_DEBUG_LEVEL3, "nand_write_oob: to = 0x%08x, len = %i\n",
William Juulcfa460a2007-10-31 13:53:06 +01001981 (unsigned int)to, (int)ops->ooblen);
Wolfgang Denk932394a2005-08-17 12:55:25 +02001982
William Juulcfa460a2007-10-31 13:53:06 +01001983 if (ops->mode == MTD_OOB_AUTO)
1984 len = chip->ecc.layout->oobavail;
1985 else
1986 len = mtd->oobsize;
Wolfgang Denk932394a2005-08-17 12:55:25 +02001987
1988 /* Do not allow write past end of page */
William Juulcfa460a2007-10-31 13:53:06 +01001989 if ((ops->ooboffs + ops->ooblen) > len) {
Scott Wood3167c532008-06-20 12:38:57 -05001990 MTDDEBUG (MTD_DEBUG_LEVEL0, "nand_write_oob: "
1991 "Attempt to write past end of page\n");
Wolfgang Denk932394a2005-08-17 12:55:25 +02001992 return -EINVAL;
1993 }
1994
William Juulcfa460a2007-10-31 13:53:06 +01001995 if (unlikely(ops->ooboffs >= len)) {
1996 MTDDEBUG (MTD_DEBUG_LEVEL0, "nand_read_oob: "
1997 "Attempt to start write outside oob\n");
Wolfgang Denk932394a2005-08-17 12:55:25 +02001998 return -EINVAL;
1999 }
2000
William Juulcfa460a2007-10-31 13:53:06 +01002001 /* Do not allow reads past end of device */
2002 if (unlikely(to >= mtd->size ||
2003 ops->ooboffs + ops->ooblen >
2004 ((mtd->size >> chip->page_shift) -
2005 (to >> chip->page_shift)) * len)) {
2006 MTDDEBUG (MTD_DEBUG_LEVEL0, "nand_read_oob: "
2007 "Attempt write beyond end of device\n");
Wolfgang Denk932394a2005-08-17 12:55:25 +02002008 return -EINVAL;
2009 }
2010
William Juulcfa460a2007-10-31 13:53:06 +01002011 chipnr = (int)(to >> chip->chip_shift);
2012 chip->select_chip(mtd, chipnr);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002013
William Juulcfa460a2007-10-31 13:53:06 +01002014 /* Shift to get page */
2015 page = (int)(to >> chip->page_shift);
2016
2017 /*
2018 * Reset the chip. Some chips (like the Toshiba TC5832DC found in one
2019 * of my DiskOnChip 2000 test units) will clear the whole data page too
2020 * if we don't do this. I have no clue why, but I seem to have 'fixed'
2021 * it in the doc2000 driver in August 1999. dwmw2.
2022 */
2023 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002024
2025 /* Check, if it is write protected */
2026 if (nand_check_wp(mtd))
William Juulcfa460a2007-10-31 13:53:06 +01002027 return -EROFS;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002028
Wolfgang Denk932394a2005-08-17 12:55:25 +02002029 /* Invalidate the page cache, if we write to the cached page */
William Juulcfa460a2007-10-31 13:53:06 +01002030 if (page == chip->pagebuf)
2031 chip->pagebuf = -1;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002032
William Juulcfa460a2007-10-31 13:53:06 +01002033 memset(chip->oob_poi, 0xff, mtd->oobsize);
2034 nand_fill_oob(chip, ops->oobbuf, ops);
2035 status = chip->ecc.write_oob(mtd, chip, page & chip->pagemask);
2036 memset(chip->oob_poi, 0xff, mtd->oobsize);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002037
William Juulcfa460a2007-10-31 13:53:06 +01002038 if (status)
2039 return status;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002040
William Juulcfa460a2007-10-31 13:53:06 +01002041 ops->oobretlen = ops->ooblen;
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +02002042
William Juulcfa460a2007-10-31 13:53:06 +01002043 return 0;
2044}
Wolfgang Denk932394a2005-08-17 12:55:25 +02002045
William Juulcfa460a2007-10-31 13:53:06 +01002046/**
2047 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
2048 * @mtd: MTD device structure
2049 * @to: offset to write to
2050 * @ops: oob operation description structure
2051 */
2052static int nand_write_oob(struct mtd_info *mtd, loff_t to,
2053 struct mtd_oob_ops *ops)
2054{
2055 struct nand_chip *chip = mtd->priv;
2056 int ret = -ENOTSUPP;
2057
2058 ops->retlen = 0;
2059
2060 /* Do not allow writes past end of device */
2061 if (ops->datbuf && (to + ops->len) > mtd->size) {
2062 MTDDEBUG (MTD_DEBUG_LEVEL0, "nand_read_oob: "
2063 "Attempt read beyond end of device\n");
2064 return -EINVAL;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002065 }
Wolfgang Denk932394a2005-08-17 12:55:25 +02002066
William Juulcfa460a2007-10-31 13:53:06 +01002067 nand_get_device(chip, mtd, FL_WRITING);
2068
2069 switch(ops->mode) {
2070 case MTD_OOB_PLACE:
2071 case MTD_OOB_AUTO:
2072 case MTD_OOB_RAW:
2073 break;
2074
2075 default:
2076 goto out;
2077 }
2078
2079 if (!ops->datbuf)
2080 ret = nand_do_write_oob(mtd, to, ops);
2081 else
2082 ret = nand_do_write_ops(mtd, to, ops);
2083
2084 out:
2085 nand_release_device(mtd);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002086 return ret;
2087}
Wolfgang Denk932394a2005-08-17 12:55:25 +02002088
2089/**
2090 * single_erease_cmd - [GENERIC] NAND standard block erase command function
2091 * @mtd: MTD device structure
2092 * @page: the page address of the block which will be erased
2093 *
2094 * Standard erase command for NAND chips
2095 */
William Juulcfa460a2007-10-31 13:53:06 +01002096static void single_erase_cmd(struct mtd_info *mtd, int page)
Wolfgang Denk932394a2005-08-17 12:55:25 +02002097{
William Juulcfa460a2007-10-31 13:53:06 +01002098 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002099 /* Send commands to erase a block */
William Juulcfa460a2007-10-31 13:53:06 +01002100 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2101 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002102}
2103
2104/**
2105 * multi_erease_cmd - [GENERIC] AND specific block erase command function
2106 * @mtd: MTD device structure
2107 * @page: the page address of the block which will be erased
2108 *
2109 * AND multi block erase command function
2110 * Erase 4 consecutive blocks
2111 */
William Juulcfa460a2007-10-31 13:53:06 +01002112static void multi_erase_cmd(struct mtd_info *mtd, int page)
Wolfgang Denk932394a2005-08-17 12:55:25 +02002113{
William Juulcfa460a2007-10-31 13:53:06 +01002114 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002115 /* Send commands to erase a block */
William Juulcfa460a2007-10-31 13:53:06 +01002116 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2117 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2118 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
2119 chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
2120 chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002121}
2122
2123/**
2124 * nand_erase - [MTD Interface] erase block(s)
2125 * @mtd: MTD device structure
2126 * @instr: erase instruction
2127 *
2128 * Erase one ore more blocks
2129 */
William Juulcfa460a2007-10-31 13:53:06 +01002130static int nand_erase(struct mtd_info *mtd, struct erase_info *instr)
Wolfgang Denk932394a2005-08-17 12:55:25 +02002131{
William Juulcfa460a2007-10-31 13:53:06 +01002132 return nand_erase_nand(mtd, instr, 0);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002133}
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +02002134
William Juulcfa460a2007-10-31 13:53:06 +01002135#define BBT_PAGE_MASK 0xffffff3f
Wolfgang Denk932394a2005-08-17 12:55:25 +02002136/**
William Juulcfa460a2007-10-31 13:53:06 +01002137 * nand_erase_nand - [Internal] erase block(s)
Wolfgang Denk932394a2005-08-17 12:55:25 +02002138 * @mtd: MTD device structure
2139 * @instr: erase instruction
2140 * @allowbbt: allow erasing the bbt area
2141 *
2142 * Erase one ore more blocks
2143 */
William Juulcfa460a2007-10-31 13:53:06 +01002144int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
2145 int allowbbt)
Wolfgang Denk932394a2005-08-17 12:55:25 +02002146{
Sandeep Paulrajaaa8eec2009-10-30 13:51:23 -04002147 int page, status, pages_per_block, ret, chipnr;
William Juulcfa460a2007-10-31 13:53:06 +01002148 struct nand_chip *chip = mtd->priv;
Sandeep Paulrajaaa8eec2009-10-30 13:51:23 -04002149 loff_t rewrite_bbt[CONFIG_SYS_NAND_MAX_CHIPS] = {0};
William Juulcfa460a2007-10-31 13:53:06 +01002150 unsigned int bbt_masked_page = 0xffffffff;
Sandeep Paulrajaaa8eec2009-10-30 13:51:23 -04002151 loff_t len;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002152
Sandeep Paulrajaaa8eec2009-10-30 13:51:23 -04002153 MTDDEBUG(MTD_DEBUG_LEVEL3, "nand_erase: start = 0x%012llx, "
2154 "len = %llu\n", (unsigned long long) instr->addr,
2155 (unsigned long long) instr->len);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002156
2157 /* Start address must align on block boundary */
William Juulcfa460a2007-10-31 13:53:06 +01002158 if (instr->addr & ((1 << chip->phys_erase_shift) - 1)) {
Scott Wood3167c532008-06-20 12:38:57 -05002159 MTDDEBUG (MTD_DEBUG_LEVEL0, "nand_erase: Unaligned address\n");
Wolfgang Denk932394a2005-08-17 12:55:25 +02002160 return -EINVAL;
2161 }
2162
2163 /* Length must align on block boundary */
William Juulcfa460a2007-10-31 13:53:06 +01002164 if (instr->len & ((1 << chip->phys_erase_shift) - 1)) {
Scott Wood3167c532008-06-20 12:38:57 -05002165 MTDDEBUG (MTD_DEBUG_LEVEL0,
2166 "nand_erase: Length not block aligned\n");
Wolfgang Denk932394a2005-08-17 12:55:25 +02002167 return -EINVAL;
2168 }
2169
2170 /* Do not allow erase past end of device */
2171 if ((instr->len + instr->addr) > mtd->size) {
Scott Wood3167c532008-06-20 12:38:57 -05002172 MTDDEBUG (MTD_DEBUG_LEVEL0,
2173 "nand_erase: Erase past end of device\n");
Wolfgang Denk932394a2005-08-17 12:55:25 +02002174 return -EINVAL;
2175 }
2176
2177 instr->fail_addr = 0xffffffff;
2178
2179 /* Grab the lock and see if the device is available */
William Juulcfa460a2007-10-31 13:53:06 +01002180 nand_get_device(chip, mtd, FL_ERASING);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002181
2182 /* Shift to get first page */
William Juulcfa460a2007-10-31 13:53:06 +01002183 page = (int)(instr->addr >> chip->page_shift);
2184 chipnr = (int)(instr->addr >> chip->chip_shift);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002185
2186 /* Calculate pages in each block */
William Juulcfa460a2007-10-31 13:53:06 +01002187 pages_per_block = 1 << (chip->phys_erase_shift - chip->page_shift);
William Juul4cbb6512007-11-08 10:39:53 +01002188
Wolfgang Denk932394a2005-08-17 12:55:25 +02002189 /* Select the NAND device */
William Juulcfa460a2007-10-31 13:53:06 +01002190 chip->select_chip(mtd, chipnr);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002191
Wolfgang Denk932394a2005-08-17 12:55:25 +02002192 /* Check, if it is write protected */
2193 if (nand_check_wp(mtd)) {
Scott Wood3167c532008-06-20 12:38:57 -05002194 MTDDEBUG (MTD_DEBUG_LEVEL0,
2195 "nand_erase: Device is write protected!!!\n");
Wolfgang Denk932394a2005-08-17 12:55:25 +02002196 instr->state = MTD_ERASE_FAILED;
2197 goto erase_exit;
2198 }
2199
William Juulcfa460a2007-10-31 13:53:06 +01002200 /*
2201 * If BBT requires refresh, set the BBT page mask to see if the BBT
2202 * should be rewritten. Otherwise the mask is set to 0xffffffff which
2203 * can not be matched. This is also done when the bbt is actually
2204 * erased to avoid recusrsive updates
2205 */
2206 if (chip->options & BBT_AUTO_REFRESH && !allowbbt)
2207 bbt_masked_page = chip->bbt_td->pages[chipnr] & BBT_PAGE_MASK;
2208
Wolfgang Denk932394a2005-08-17 12:55:25 +02002209 /* Loop through the pages */
2210 len = instr->len;
2211
2212 instr->state = MTD_ERASING;
2213
2214 while (len) {
William Juulcfa460a2007-10-31 13:53:06 +01002215 /*
2216 * heck if we have a bad block, we do not erase bad blocks !
2217 */
2218 if (nand_block_checkbad(mtd, ((loff_t) page) <<
2219 chip->page_shift, 0, allowbbt)) {
2220 printk(KERN_WARNING "nand_erase: attempt to erase a "
2221 "bad block at page 0x%08x\n", page);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002222 instr->state = MTD_ERASE_FAILED;
2223 goto erase_exit;
2224 }
Wolfgang Denk932394a2005-08-17 12:55:25 +02002225
William Juulcfa460a2007-10-31 13:53:06 +01002226 /*
2227 * Invalidate the page cache, if we erase the block which
2228 * contains the current cached page
2229 */
2230 if (page <= chip->pagebuf && chip->pagebuf <
2231 (page + pages_per_block))
2232 chip->pagebuf = -1;
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +02002233
William Juulcfa460a2007-10-31 13:53:06 +01002234 chip->erase_cmd(mtd, page & chip->pagemask);
2235
2236 status = chip->waitfunc(mtd, chip);
2237
2238 /*
2239 * See if operation failed and additional status checks are
2240 * available
2241 */
2242 if ((status & NAND_STATUS_FAIL) && (chip->errstat))
2243 status = chip->errstat(mtd, chip, FL_ERASING,
2244 status, page);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002245
2246 /* See if block erase succeeded */
William Juulcfa460a2007-10-31 13:53:06 +01002247 if (status & NAND_STATUS_FAIL) {
Scott Wood3167c532008-06-20 12:38:57 -05002248 MTDDEBUG (MTD_DEBUG_LEVEL0, "nand_erase: "
2249 "Failed erase, page 0x%08x\n", page);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002250 instr->state = MTD_ERASE_FAILED;
Sandeep Paulrajaaa8eec2009-10-30 13:51:23 -04002251 instr->fail_addr = ((loff_t)page << chip->page_shift);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002252 goto erase_exit;
2253 }
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +02002254
William Juulcfa460a2007-10-31 13:53:06 +01002255 /*
2256 * If BBT requires refresh, set the BBT rewrite flag to the
2257 * page being erased
2258 */
2259 if (bbt_masked_page != 0xffffffff &&
2260 (page & BBT_PAGE_MASK) == bbt_masked_page)
Sandeep Paulrajaaa8eec2009-10-30 13:51:23 -04002261 rewrite_bbt[chipnr] =
2262 ((loff_t)page << chip->page_shift);
William Juulcfa460a2007-10-31 13:53:06 +01002263
Wolfgang Denk932394a2005-08-17 12:55:25 +02002264 /* Increment page address and decrement length */
William Juulcfa460a2007-10-31 13:53:06 +01002265 len -= (1 << chip->phys_erase_shift);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002266 page += pages_per_block;
2267
2268 /* Check, if we cross a chip boundary */
William Juulcfa460a2007-10-31 13:53:06 +01002269 if (len && !(page & chip->pagemask)) {
Wolfgang Denk932394a2005-08-17 12:55:25 +02002270 chipnr++;
William Juulcfa460a2007-10-31 13:53:06 +01002271 chip->select_chip(mtd, -1);
2272 chip->select_chip(mtd, chipnr);
2273
2274 /*
2275 * If BBT requires refresh and BBT-PERCHIP, set the BBT
2276 * page mask to see if this BBT should be rewritten
2277 */
2278 if (bbt_masked_page != 0xffffffff &&
2279 (chip->bbt_td->options & NAND_BBT_PERCHIP))
2280 bbt_masked_page = chip->bbt_td->pages[chipnr] &
2281 BBT_PAGE_MASK;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002282 }
2283 }
2284 instr->state = MTD_ERASE_DONE;
2285
William Juulcfa460a2007-10-31 13:53:06 +01002286 erase_exit:
Wolfgang Denk932394a2005-08-17 12:55:25 +02002287
2288 ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002289
2290 /* Deselect and wake up anyone waiting on the device */
2291 nand_release_device(mtd);
2292
Scott Woodc45912d2008-10-24 16:20:43 -05002293 /* Do call back function */
2294 if (!ret)
2295 mtd_erase_callback(instr);
2296
William Juulcfa460a2007-10-31 13:53:06 +01002297 /*
2298 * If BBT requires refresh and erase was successful, rewrite any
2299 * selected bad block tables
2300 */
2301 if (bbt_masked_page == 0xffffffff || ret)
2302 return ret;
2303
2304 for (chipnr = 0; chipnr < chip->numchips; chipnr++) {
2305 if (!rewrite_bbt[chipnr])
2306 continue;
2307 /* update the BBT for chip */
2308 MTDDEBUG (MTD_DEBUG_LEVEL0, "nand_erase_nand: nand_update_bbt "
Sandeep Paulrajaaa8eec2009-10-30 13:51:23 -04002309 "(%d:0x%0llx 0x%0x)\n", chipnr, rewrite_bbt[chipnr],
2310 chip->bbt_td->pages[chipnr]);
William Juulcfa460a2007-10-31 13:53:06 +01002311 nand_update_bbt(mtd, rewrite_bbt[chipnr]);
2312 }
2313
Wolfgang Denk932394a2005-08-17 12:55:25 +02002314 /* Return more or less happy */
2315 return ret;
2316}
2317
2318/**
2319 * nand_sync - [MTD Interface] sync
2320 * @mtd: MTD device structure
2321 *
2322 * Sync is actually a wait for chip ready function
2323 */
William Juulcfa460a2007-10-31 13:53:06 +01002324static void nand_sync(struct mtd_info *mtd)
Wolfgang Denk932394a2005-08-17 12:55:25 +02002325{
William Juulcfa460a2007-10-31 13:53:06 +01002326 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002327
Scott Wood3167c532008-06-20 12:38:57 -05002328 MTDDEBUG (MTD_DEBUG_LEVEL3, "nand_sync: called\n");
Wolfgang Denk932394a2005-08-17 12:55:25 +02002329
2330 /* Grab the lock and see if the device is available */
William Juulcfa460a2007-10-31 13:53:06 +01002331 nand_get_device(chip, mtd, FL_SYNCING);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002332 /* Release it and go back */
William Juulcfa460a2007-10-31 13:53:06 +01002333 nand_release_device(mtd);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002334}
2335
Wolfgang Denk932394a2005-08-17 12:55:25 +02002336/**
William Juulcfa460a2007-10-31 13:53:06 +01002337 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
Wolfgang Denk932394a2005-08-17 12:55:25 +02002338 * @mtd: MTD device structure
William Juulcfa460a2007-10-31 13:53:06 +01002339 * @offs: offset relative to mtd start
Wolfgang Denk932394a2005-08-17 12:55:25 +02002340 */
William Juulcfa460a2007-10-31 13:53:06 +01002341static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
Wolfgang Denk932394a2005-08-17 12:55:25 +02002342{
2343 /* Check for invalid offset */
William Juulcfa460a2007-10-31 13:53:06 +01002344 if (offs > mtd->size)
Wolfgang Denk932394a2005-08-17 12:55:25 +02002345 return -EINVAL;
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +02002346
William Juulcfa460a2007-10-31 13:53:06 +01002347 return nand_block_checkbad(mtd, offs, 1, 0);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002348}
2349
2350/**
William Juulcfa460a2007-10-31 13:53:06 +01002351 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
Wolfgang Denk932394a2005-08-17 12:55:25 +02002352 * @mtd: MTD device structure
2353 * @ofs: offset relative to mtd start
2354 */
William Juulcfa460a2007-10-31 13:53:06 +01002355static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
Wolfgang Denk932394a2005-08-17 12:55:25 +02002356{
William Juulcfa460a2007-10-31 13:53:06 +01002357 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002358 int ret;
2359
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +02002360 if ((ret = nand_block_isbad(mtd, ofs))) {
2361 /* If it was bad already, return success and do nothing. */
Wolfgang Denk932394a2005-08-17 12:55:25 +02002362 if (ret > 0)
2363 return 0;
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +02002364 return ret;
2365 }
Wolfgang Denk932394a2005-08-17 12:55:25 +02002366
William Juulcfa460a2007-10-31 13:53:06 +01002367 return chip->block_markbad(mtd, ofs);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002368}
2369
William Juulcfa460a2007-10-31 13:53:06 +01002370/*
2371 * Set default functions
2372 */
2373static void nand_set_defaults(struct nand_chip *chip, int busw)
2374{
2375 /* check for proper chip_delay setup, set 20us if not */
2376 if (!chip->chip_delay)
2377 chip->chip_delay = 20;
2378
2379 /* check, if a user supplied command function given */
2380 if (chip->cmdfunc == NULL)
2381 chip->cmdfunc = nand_command;
2382
2383 /* check, if a user supplied wait function given */
2384 if (chip->waitfunc == NULL)
2385 chip->waitfunc = nand_wait;
2386
2387 if (!chip->select_chip)
2388 chip->select_chip = nand_select_chip;
2389 if (!chip->read_byte)
2390 chip->read_byte = busw ? nand_read_byte16 : nand_read_byte;
2391 if (!chip->read_word)
2392 chip->read_word = nand_read_word;
2393 if (!chip->block_bad)
2394 chip->block_bad = nand_block_bad;
2395 if (!chip->block_markbad)
2396 chip->block_markbad = nand_default_block_markbad;
2397 if (!chip->write_buf)
2398 chip->write_buf = busw ? nand_write_buf16 : nand_write_buf;
2399 if (!chip->read_buf)
2400 chip->read_buf = busw ? nand_read_buf16 : nand_read_buf;
2401 if (!chip->verify_buf)
2402 chip->verify_buf = busw ? nand_verify_buf16 : nand_verify_buf;
2403 if (!chip->scan_bbt)
2404 chip->scan_bbt = nand_default_bbt;
Scott Wood5b8e6bb2010-08-25 17:42:49 -05002405 if (!chip->controller)
William Juulcfa460a2007-10-31 13:53:06 +01002406 chip->controller = &chip->hwcontrol;
William Juulcfa460a2007-10-31 13:53:06 +01002407}
2408
2409/*
2410 * Get the flash and manufacturer id and lookup if the type is supported
2411 */
2412static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
2413 struct nand_chip *chip,
2414 int busw, int *maf_id)
2415{
2416 struct nand_flash_dev *type = NULL;
2417 int i, dev_id, maf_idx;
Scott Woodc45912d2008-10-24 16:20:43 -05002418 int tmp_id, tmp_manf;
William Juulcfa460a2007-10-31 13:53:06 +01002419
2420 /* Select the device */
2421 chip->select_chip(mtd, 0);
2422
Karl Beldan33efde52008-09-15 16:08:03 +02002423 /*
2424 * Reset the chip, required by some chips (e.g. Micron MT29FxGxxxxx)
2425 * after power-up
2426 */
2427 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
2428
William Juulcfa460a2007-10-31 13:53:06 +01002429 /* Send the command for reading device ID */
2430 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
2431
2432 /* Read manufacturer and device IDs */
2433 *maf_id = chip->read_byte(mtd);
2434 dev_id = chip->read_byte(mtd);
2435
Scott Woodc45912d2008-10-24 16:20:43 -05002436 /* Try again to make sure, as some systems the bus-hold or other
2437 * interface concerns can cause random data which looks like a
2438 * possibly credible NAND flash to appear. If the two results do
2439 * not match, ignore the device completely.
2440 */
2441
2442 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
2443
2444 /* Read manufacturer and device IDs */
2445
2446 tmp_manf = chip->read_byte(mtd);
2447 tmp_id = chip->read_byte(mtd);
2448
2449 if (tmp_manf != *maf_id || tmp_id != dev_id) {
2450 printk(KERN_INFO "%s: second ID read did not match "
2451 "%02x,%02x against %02x,%02x\n", __func__,
2452 *maf_id, dev_id, tmp_manf, tmp_id);
2453 return ERR_PTR(-ENODEV);
2454 }
2455
William Juulcfa460a2007-10-31 13:53:06 +01002456 /* Lookup the flash id */
2457 for (i = 0; nand_flash_ids[i].name != NULL; i++) {
2458 if (dev_id == nand_flash_ids[i].id) {
2459 type = &nand_flash_ids[i];
2460 break;
2461 }
2462 }
2463
Florian Fainelli3e9b3492010-06-12 20:59:25 +02002464 if (!type) {
Steve Sakoman4c468392010-08-19 20:14:01 -07002465 /* supress warning if there is no nand */
2466 if (*maf_id != 0x00 && *maf_id != 0xff &&
2467 dev_id != 0x00 && dev_id != 0xff)
2468 printk(KERN_INFO "%s: unknown NAND device: "
2469 "Manufacturer ID: 0x%02x, Chip ID: 0x%02x\n",
2470 __func__, *maf_id, dev_id);
William Juulcfa460a2007-10-31 13:53:06 +01002471 return ERR_PTR(-ENODEV);
Florian Fainelli3e9b3492010-06-12 20:59:25 +02002472 }
William Juulcfa460a2007-10-31 13:53:06 +01002473
2474 if (!mtd->name)
2475 mtd->name = type->name;
2476
Sandeep Paulrajaaa8eec2009-10-30 13:51:23 -04002477 chip->chipsize = (uint64_t)type->chipsize << 20;
William Juulcfa460a2007-10-31 13:53:06 +01002478
2479 /* Newer devices have all the information in additional id bytes */
2480 if (!type->pagesize) {
2481 int extid;
2482 /* The 3rd id byte holds MLC / multichip data */
2483 chip->cellinfo = chip->read_byte(mtd);
2484 /* The 4th id byte is the important one */
2485 extid = chip->read_byte(mtd);
2486 /* Calc pagesize */
2487 mtd->writesize = 1024 << (extid & 0x3);
2488 extid >>= 2;
2489 /* Calc oobsize */
2490 mtd->oobsize = (8 << (extid & 0x01)) * (mtd->writesize >> 9);
2491 extid >>= 2;
2492 /* Calc blocksize. Blocksize is multiples of 64KiB */
2493 mtd->erasesize = (64 * 1024) << (extid & 0x03);
2494 extid >>= 2;
2495 /* Get buswidth information */
2496 busw = (extid & 0x01) ? NAND_BUSWIDTH_16 : 0;
2497
2498 } else {
2499 /*
2500 * Old devices have chip data hardcoded in the device id table
2501 */
2502 mtd->erasesize = type->erasesize;
2503 mtd->writesize = type->pagesize;
2504 mtd->oobsize = mtd->writesize / 32;
2505 busw = type->options & NAND_BUSWIDTH_16;
2506 }
2507
2508 /* Try to identify manufacturer */
2509 for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
2510 if (nand_manuf_ids[maf_idx].id == *maf_id)
2511 break;
2512 }
2513
2514 /*
2515 * Check, if buswidth is correct. Hardware drivers should set
2516 * chip correct !
2517 */
2518 if (busw != (chip->options & NAND_BUSWIDTH_16)) {
2519 printk(KERN_INFO "NAND device: Manufacturer ID:"
2520 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id,
2521 dev_id, nand_manuf_ids[maf_idx].name, mtd->name);
2522 printk(KERN_WARNING "NAND bus width %d instead %d bit\n",
2523 (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
2524 busw ? 16 : 8);
2525 return ERR_PTR(-EINVAL);
2526 }
2527
2528 /* Calculate the address shift from the page size */
2529 chip->page_shift = ffs(mtd->writesize) - 1;
2530 /* Convert chipsize to number of pages per chip -1. */
2531 chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
2532
2533 chip->bbt_erase_shift = chip->phys_erase_shift =
2534 ffs(mtd->erasesize) - 1;
Sandeep Paulrajaaa8eec2009-10-30 13:51:23 -04002535 if (chip->chipsize & 0xffffffff)
Sandeep Paulraj4f41e7e2009-11-07 14:24:06 -05002536 chip->chip_shift = ffs((unsigned)chip->chipsize) - 1;
Sandeep Paulrajaaa8eec2009-10-30 13:51:23 -04002537 else
2538 chip->chip_shift = ffs((unsigned)(chip->chipsize >> 32)) + 31;
William Juulcfa460a2007-10-31 13:53:06 +01002539
2540 /* Set the bad block position */
2541 chip->badblockpos = mtd->writesize > 512 ?
2542 NAND_LARGE_BADBLOCK_POS : NAND_SMALL_BADBLOCK_POS;
2543
2544 /* Get chip options, preserve non chip based options */
2545 chip->options &= ~NAND_CHIPOPTIONS_MSK;
2546 chip->options |= type->options & NAND_CHIPOPTIONS_MSK;
2547
2548 /*
2549 * Set chip as a default. Board drivers can override it, if necessary
2550 */
2551 chip->options |= NAND_NO_AUTOINCR;
2552
2553 /* Check if chip is a not a samsung device. Do not clear the
2554 * options for chips which are not having an extended id.
2555 */
2556 if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
2557 chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
2558
2559 /* Check for AND chips with 4 page planes */
2560 if (chip->options & NAND_4PAGE_ARRAY)
2561 chip->erase_cmd = multi_erase_cmd;
2562 else
2563 chip->erase_cmd = single_erase_cmd;
2564
2565 /* Do not replace user supplied command function ! */
2566 if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
2567 chip->cmdfunc = nand_command_lp;
2568
Stefan Roesee52b34d2008-01-10 18:47:33 +01002569 MTDDEBUG (MTD_DEBUG_LEVEL0, "NAND device: Manufacturer ID:"
2570 " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id, dev_id,
2571 nand_manuf_ids[maf_idx].name, type->name);
William Juulcfa460a2007-10-31 13:53:06 +01002572
2573 return type;
2574}
2575
2576/**
2577 * nand_scan_ident - [NAND Interface] Scan for the NAND device
2578 * @mtd: MTD device structure
2579 * @maxchips: Number of chips to scan for
2580 *
2581 * This is the first phase of the normal nand_scan() function. It
2582 * reads the flash ID and sets up MTD fields accordingly.
2583 *
2584 * The mtd->owner field must be set to the module of the caller.
2585 */
2586int nand_scan_ident(struct mtd_info *mtd, int maxchips)
2587{
2588 int i, busw, nand_maf_id;
2589 struct nand_chip *chip = mtd->priv;
2590 struct nand_flash_dev *type;
2591
2592 /* Get buswidth to select the correct functions */
2593 busw = chip->options & NAND_BUSWIDTH_16;
2594 /* Set the default functions */
2595 nand_set_defaults(chip, busw);
2596
2597 /* Read the flash type */
2598 type = nand_get_flash_type(mtd, chip, busw, &nand_maf_id);
2599
2600 if (IS_ERR(type)) {
Peter Tyser10dc6a92009-02-04 13:39:40 -06002601#ifndef CONFIG_SYS_NAND_QUIET_TEST
William Juulcfa460a2007-10-31 13:53:06 +01002602 printk(KERN_WARNING "No NAND device found!!!\n");
Peter Tyser10dc6a92009-02-04 13:39:40 -06002603#endif
William Juulcfa460a2007-10-31 13:53:06 +01002604 chip->select_chip(mtd, -1);
2605 return PTR_ERR(type);
2606 }
2607
2608 /* Check for a chip array */
2609 for (i = 1; i < maxchips; i++) {
2610 chip->select_chip(mtd, i);
Karl Beldan33efde52008-09-15 16:08:03 +02002611 /* See comment in nand_get_flash_type for reset */
2612 chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
William Juulcfa460a2007-10-31 13:53:06 +01002613 /* Send the command for reading device ID */
2614 chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
2615 /* Read manufacturer and device IDs */
2616 if (nand_maf_id != chip->read_byte(mtd) ||
2617 type->id != chip->read_byte(mtd))
2618 break;
2619 }
Wolfgang Grandegger672ed2a2009-02-11 18:38:20 +01002620#ifdef DEBUG
William Juulcfa460a2007-10-31 13:53:06 +01002621 if (i > 1)
2622 printk(KERN_INFO "%d NAND chips detected\n", i);
Wolfgang Grandegger672ed2a2009-02-11 18:38:20 +01002623#endif
William Juulcfa460a2007-10-31 13:53:06 +01002624
2625 /* Store the number of chips and calc total size for mtd */
2626 chip->numchips = i;
2627 mtd->size = i * chip->chipsize;
2628
2629 return 0;
2630}
2631
2632
2633/**
2634 * nand_scan_tail - [NAND Interface] Scan for the NAND device
2635 * @mtd: MTD device structure
William Juulcfa460a2007-10-31 13:53:06 +01002636 *
2637 * This is the second phase of the normal nand_scan() function. It
2638 * fills out all the uninitialized function pointers with the defaults
2639 * and scans for a bad block table if appropriate.
2640 */
2641int nand_scan_tail(struct mtd_info *mtd)
2642{
2643 int i;
2644 struct nand_chip *chip = mtd->priv;
2645
2646 if (!(chip->options & NAND_OWN_BUFFERS))
2647 chip->buffers = kmalloc(sizeof(*chip->buffers), GFP_KERNEL);
2648 if (!chip->buffers)
2649 return -ENOMEM;
2650
2651 /* Set the internal oob buffer location, just after the page data */
2652 chip->oob_poi = chip->buffers->databuf + mtd->writesize;
2653
2654 /*
2655 * If no default placement scheme is given, select an appropriate one
2656 */
2657 if (!chip->ecc.layout) {
2658 switch (mtd->oobsize) {
2659 case 8:
2660 chip->ecc.layout = &nand_oob_8;
2661 break;
2662 case 16:
2663 chip->ecc.layout = &nand_oob_16;
2664 break;
2665 case 64:
2666 chip->ecc.layout = &nand_oob_64;
2667 break;
2668 case 128:
2669 chip->ecc.layout = &nand_oob_128;
2670 break;
2671 default:
2672 printk(KERN_WARNING "No oob scheme defined for "
2673 "oobsize %d\n", mtd->oobsize);
William Juulcfa460a2007-10-31 13:53:06 +01002674 }
2675 }
2676
2677 if (!chip->write_page)
2678 chip->write_page = nand_write_page;
2679
2680 /*
2681 * check ECC mode, default to software if 3byte/512byte hardware ECC is
2682 * selected and we have 256 byte pagesize fallback to software ECC
2683 */
William Juulcfa460a2007-10-31 13:53:06 +01002684
2685 switch (chip->ecc.mode) {
Sandeep Paulrajf83b7f92009-08-10 13:27:56 -04002686 case NAND_ECC_HW_OOB_FIRST:
2687 /* Similar to NAND_ECC_HW, but a separate read_page handle */
2688 if (!chip->ecc.calculate || !chip->ecc.correct ||
2689 !chip->ecc.hwctl) {
2690 printk(KERN_WARNING "No ECC functions supplied, "
2691 "Hardware ECC not possible\n");
2692 BUG();
2693 }
2694 if (!chip->ecc.read_page)
2695 chip->ecc.read_page = nand_read_page_hwecc_oob_first;
2696
William Juulcfa460a2007-10-31 13:53:06 +01002697 case NAND_ECC_HW:
2698 /* Use standard hwecc read page function ? */
2699 if (!chip->ecc.read_page)
2700 chip->ecc.read_page = nand_read_page_hwecc;
2701 if (!chip->ecc.write_page)
2702 chip->ecc.write_page = nand_write_page_hwecc;
David Brownell7e866612009-11-07 16:27:01 -05002703 if (!chip->ecc.read_page_raw)
2704 chip->ecc.read_page_raw = nand_read_page_raw;
2705 if (!chip->ecc.write_page_raw)
2706 chip->ecc.write_page_raw = nand_write_page_raw;
William Juulcfa460a2007-10-31 13:53:06 +01002707 if (!chip->ecc.read_oob)
2708 chip->ecc.read_oob = nand_read_oob_std;
2709 if (!chip->ecc.write_oob)
2710 chip->ecc.write_oob = nand_write_oob_std;
2711
2712 case NAND_ECC_HW_SYNDROME:
Scott Wood41ef8c72008-03-18 15:29:14 -05002713 if ((!chip->ecc.calculate || !chip->ecc.correct ||
2714 !chip->ecc.hwctl) &&
2715 (!chip->ecc.read_page ||
2716 chip->ecc.read_page == nand_read_page_hwecc ||
2717 !chip->ecc.write_page ||
2718 chip->ecc.write_page == nand_write_page_hwecc)) {
William Juulcfa460a2007-10-31 13:53:06 +01002719 printk(KERN_WARNING "No ECC functions supplied, "
2720 "Hardware ECC not possible\n");
2721 BUG();
2722 }
2723 /* Use standard syndrome read/write page function ? */
2724 if (!chip->ecc.read_page)
2725 chip->ecc.read_page = nand_read_page_syndrome;
2726 if (!chip->ecc.write_page)
2727 chip->ecc.write_page = nand_write_page_syndrome;
David Brownell7e866612009-11-07 16:27:01 -05002728 if (!chip->ecc.read_page_raw)
2729 chip->ecc.read_page_raw = nand_read_page_raw_syndrome;
2730 if (!chip->ecc.write_page_raw)
2731 chip->ecc.write_page_raw = nand_write_page_raw_syndrome;
William Juulcfa460a2007-10-31 13:53:06 +01002732 if (!chip->ecc.read_oob)
2733 chip->ecc.read_oob = nand_read_oob_syndrome;
2734 if (!chip->ecc.write_oob)
2735 chip->ecc.write_oob = nand_write_oob_syndrome;
2736
2737 if (mtd->writesize >= chip->ecc.size)
2738 break;
2739 printk(KERN_WARNING "%d byte HW ECC not possible on "
2740 "%d byte page size, fallback to SW ECC\n",
2741 chip->ecc.size, mtd->writesize);
2742 chip->ecc.mode = NAND_ECC_SOFT;
2743
2744 case NAND_ECC_SOFT:
2745 chip->ecc.calculate = nand_calculate_ecc;
2746 chip->ecc.correct = nand_correct_data;
2747 chip->ecc.read_page = nand_read_page_swecc;
Scott Woodc45912d2008-10-24 16:20:43 -05002748 chip->ecc.read_subpage = nand_read_subpage;
William Juulcfa460a2007-10-31 13:53:06 +01002749 chip->ecc.write_page = nand_write_page_swecc;
David Brownell7e866612009-11-07 16:27:01 -05002750 chip->ecc.read_page_raw = nand_read_page_raw;
2751 chip->ecc.write_page_raw = nand_write_page_raw;
William Juulcfa460a2007-10-31 13:53:06 +01002752 chip->ecc.read_oob = nand_read_oob_std;
2753 chip->ecc.write_oob = nand_write_oob_std;
2754 chip->ecc.size = 256;
2755 chip->ecc.bytes = 3;
2756 break;
2757
2758 case NAND_ECC_NONE:
2759 printk(KERN_WARNING "NAND_ECC_NONE selected by board driver. "
2760 "This is not recommended !!\n");
2761 chip->ecc.read_page = nand_read_page_raw;
2762 chip->ecc.write_page = nand_write_page_raw;
2763 chip->ecc.read_oob = nand_read_oob_std;
David Brownell7e866612009-11-07 16:27:01 -05002764 chip->ecc.read_page_raw = nand_read_page_raw;
2765 chip->ecc.write_page_raw = nand_write_page_raw;
William Juulcfa460a2007-10-31 13:53:06 +01002766 chip->ecc.write_oob = nand_write_oob_std;
2767 chip->ecc.size = mtd->writesize;
2768 chip->ecc.bytes = 0;
2769 break;
2770
2771 default:
2772 printk(KERN_WARNING "Invalid NAND_ECC_MODE %d\n",
2773 chip->ecc.mode);
2774 BUG();
2775 }
2776
2777 /*
2778 * The number of bytes available for a client to place data into
2779 * the out of band area
2780 */
2781 chip->ecc.layout->oobavail = 0;
Sandeep Paulraj5df3c2b2009-11-07 14:25:18 -05002782 for (i = 0; chip->ecc.layout->oobfree[i].length
2783 && i < ARRAY_SIZE(chip->ecc.layout->oobfree); i++)
William Juulcfa460a2007-10-31 13:53:06 +01002784 chip->ecc.layout->oobavail +=
2785 chip->ecc.layout->oobfree[i].length;
2786 mtd->oobavail = chip->ecc.layout->oobavail;
2787
2788 /*
2789 * Set the number of read / write steps for one page depending on ECC
2790 * mode
2791 */
2792 chip->ecc.steps = mtd->writesize / chip->ecc.size;
2793 if(chip->ecc.steps * chip->ecc.size != mtd->writesize) {
2794 printk(KERN_WARNING "Invalid ecc parameters\n");
2795 BUG();
2796 }
2797 chip->ecc.total = chip->ecc.steps * chip->ecc.bytes;
2798
2799 /*
2800 * Allow subpage writes up to ecc.steps. Not possible for MLC
2801 * FLASH.
2802 */
2803 if (!(chip->options & NAND_NO_SUBPAGE_WRITE) &&
2804 !(chip->cellinfo & NAND_CI_CELLTYPE_MSK)) {
2805 switch(chip->ecc.steps) {
2806 case 2:
2807 mtd->subpage_sft = 1;
2808 break;
2809 case 4:
2810 case 8:
Sandeep Paulrajaad4a282009-11-07 14:24:34 -05002811 case 16:
William Juulcfa460a2007-10-31 13:53:06 +01002812 mtd->subpage_sft = 2;
2813 break;
2814 }
2815 }
2816 chip->subpagesize = mtd->writesize >> mtd->subpage_sft;
2817
2818 /* Initialize state */
2819 chip->state = FL_READY;
2820
2821 /* De-select the device */
2822 chip->select_chip(mtd, -1);
2823
2824 /* Invalidate the pagebuffer reference */
2825 chip->pagebuf = -1;
2826
2827 /* Fill in remaining MTD driver data */
2828 mtd->type = MTD_NANDFLASH;
2829 mtd->flags = MTD_CAP_NANDFLASH;
2830 mtd->erase = nand_erase;
2831 mtd->point = NULL;
2832 mtd->unpoint = NULL;
2833 mtd->read = nand_read;
2834 mtd->write = nand_write;
2835 mtd->read_oob = nand_read_oob;
2836 mtd->write_oob = nand_write_oob;
2837 mtd->sync = nand_sync;
2838 mtd->lock = NULL;
2839 mtd->unlock = NULL;
William Juulcfa460a2007-10-31 13:53:06 +01002840 mtd->block_isbad = nand_block_isbad;
2841 mtd->block_markbad = nand_block_markbad;
2842
2843 /* propagate ecc.layout to mtd_info */
2844 mtd->ecclayout = chip->ecc.layout;
2845
2846 /* Check, if we should skip the bad block table scan */
2847 if (chip->options & NAND_SKIP_BBTSCAN)
Ilya Yanok13f0fd92008-06-30 15:34:40 +02002848 chip->options |= NAND_BBT_SCANNED;
William Juulcfa460a2007-10-31 13:53:06 +01002849
Ilya Yanok13f0fd92008-06-30 15:34:40 +02002850 return 0;
William Juulcfa460a2007-10-31 13:53:06 +01002851}
2852
William Juulcfa460a2007-10-31 13:53:06 +01002853/**
Wolfgang Denk932394a2005-08-17 12:55:25 +02002854 * nand_scan - [NAND Interface] Scan for the NAND device
2855 * @mtd: MTD device structure
2856 * @maxchips: Number of chips to scan for
2857 *
William Juulcfa460a2007-10-31 13:53:06 +01002858 * This fills out all the uninitialized function pointers
Wolfgang Denk932394a2005-08-17 12:55:25 +02002859 * with the defaults.
2860 * The flash ID is read and the mtd/chip structures are
William Juulcfa460a2007-10-31 13:53:06 +01002861 * filled with the appropriate values.
2862 * The mtd->owner field must be set to the module of the caller
Wolfgang Denk932394a2005-08-17 12:55:25 +02002863 *
2864 */
William Juulcfa460a2007-10-31 13:53:06 +01002865int nand_scan(struct mtd_info *mtd, int maxchips)
Wolfgang Denk932394a2005-08-17 12:55:25 +02002866{
William Juulcfa460a2007-10-31 13:53:06 +01002867 int ret;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002868
William Juulcfa460a2007-10-31 13:53:06 +01002869 ret = nand_scan_ident(mtd, maxchips);
2870 if (!ret)
2871 ret = nand_scan_tail(mtd);
2872 return ret;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002873}
2874
2875/**
Wolfgang Denkac7eb8a2005-09-14 23:53:32 +02002876 * nand_release - [NAND Interface] Free resources held by the NAND device
Wolfgang Denk932394a2005-08-17 12:55:25 +02002877 * @mtd: MTD device structure
William Juulcfa460a2007-10-31 13:53:06 +01002878*/
2879void nand_release(struct mtd_info *mtd)
Wolfgang Denk932394a2005-08-17 12:55:25 +02002880{
William Juulcfa460a2007-10-31 13:53:06 +01002881 struct nand_chip *chip = mtd->priv;
Wolfgang Denk932394a2005-08-17 12:55:25 +02002882
2883#ifdef CONFIG_MTD_PARTITIONS
2884 /* Deregister partitions */
William Juulcfa460a2007-10-31 13:53:06 +01002885 del_mtd_partitions(mtd);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002886#endif
William Juulcfa460a2007-10-31 13:53:06 +01002887
2888 /* Free bad block table memory */
2889 kfree(chip->bbt);
2890 if (!(chip->options & NAND_OWN_BUFFERS))
2891 kfree(chip->buffers);
Wolfgang Denk932394a2005-08-17 12:55:25 +02002892}