nand_base.c 79.9 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7
/*
 *  drivers/mtd/nand.c
 *
 *  Overview:
 *   This is the generic MTD driver for NAND flash devices. It should be
 *   capable of working with almost all NAND chips currently available.
 *   Basic support for AG-AND chips is provided.
8
 *
L
Linus Torvalds 已提交
9
 *	Additional technical information is available on
10
 *	http://www.linux-mtd.infradead.org/doc/nand.html
11
 *
L
Linus Torvalds 已提交
12
 *  Copyright (C) 2000 Steven J. Hill (sjhill@realitydiluted.com)
13
 *		  2002-2006 Thomas Gleixner (tglx@linutronix.de)
L
Linus Torvalds 已提交
14
 *
15
 *  Credits:
16 17
 *	David Woodhouse for adding multichip support
 *
L
Linus Torvalds 已提交
18 19 20
 *	Aleph One Ltd. and Toby Churchill Ltd. for supporting the
 *	rework for 2K page size chips
 *
21
 *  TODO:
L
Linus Torvalds 已提交
22 23 24 25 26
 *	Enable cached programming for 2k page size chips
 *	Check, if mtd->ecctype should be set to MTD_ECC_HW
 *	if we have HW ecc support.
 *	The AG-AND chips have nice features for speed improvement,
 *	which are not supported yet. Read / program 4 pages in one go.
27
 *	BBT table is not serialized, has to be fixed
L
Linus Torvalds 已提交
28 29 30 31 32 33 34
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 */

35
#include <linux/module.h>
L
Linus Torvalds 已提交
36 37
#include <linux/delay.h>
#include <linux/errno.h>
T
Thomas Gleixner 已提交
38
#include <linux/err.h>
L
Linus Torvalds 已提交
39 40 41 42 43 44 45 46 47
#include <linux/sched.h>
#include <linux/slab.h>
#include <linux/types.h>
#include <linux/mtd/mtd.h>
#include <linux/mtd/nand.h>
#include <linux/mtd/nand_ecc.h>
#include <linux/mtd/compatmac.h>
#include <linux/interrupt.h>
#include <linux/bitops.h>
48
#include <linux/leds.h>
L
Linus Torvalds 已提交
49 50 51 52 53 54 55
#include <asm/io.h>

#ifdef CONFIG_MTD_PARTITIONS
#include <linux/mtd/partitions.h>
#endif

/* Define default oob placement schemes for large and small page devices */
56
static struct nand_ecclayout nand_oob_8 = {
L
Linus Torvalds 已提交
57 58
	.eccbytes = 3,
	.eccpos = {0, 1, 2},
59 60 61 62 63
	.oobfree = {
		{.offset = 3,
		 .length = 2},
		{.offset = 6,
		 .length = 2}}
L
Linus Torvalds 已提交
64 65
};

66
static struct nand_ecclayout nand_oob_16 = {
L
Linus Torvalds 已提交
67 68
	.eccbytes = 6,
	.eccpos = {0, 1, 2, 3, 6, 7},
69 70 71
	.oobfree = {
		{.offset = 8,
		 . length = 8}}
L
Linus Torvalds 已提交
72 73
};

74
static struct nand_ecclayout nand_oob_64 = {
L
Linus Torvalds 已提交
75 76
	.eccbytes = 24,
	.eccpos = {
77 78 79
		   40, 41, 42, 43, 44, 45, 46, 47,
		   48, 49, 50, 51, 52, 53, 54, 55,
		   56, 57, 58, 59, 60, 61, 62, 63},
80 81 82
	.oobfree = {
		{.offset = 2,
		 .length = 38}}
L
Linus Torvalds 已提交
83 84
};

85 86 87 88 89 90 91 92 93 94 95 96 97 98
static struct nand_ecclayout nand_oob_128 = {
	.eccbytes = 48,
	.eccpos = {
		   80, 81, 82, 83, 84, 85, 86, 87,
		   88, 89, 90, 91, 92, 93, 94, 95,
		   96, 97, 98, 99, 100, 101, 102, 103,
		   104, 105, 106, 107, 108, 109, 110, 111,
		   112, 113, 114, 115, 116, 117, 118, 119,
		   120, 121, 122, 123, 124, 125, 126, 127},
	.oobfree = {
		{.offset = 2,
		 .length = 78}}
};

99
static int nand_get_device(struct nand_chip *chip, struct mtd_info *mtd,
100
			   int new_state);
L
Linus Torvalds 已提交
101

102 103 104
static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops);

T
Thomas Gleixner 已提交
105
/*
J
Joe Perches 已提交
106
 * For devices which display every fart in the system on a separate LED. Is
T
Thomas Gleixner 已提交
107 108 109 110
 * compiled away when LED support is disabled.
 */
DEFINE_LED_TRIGGER(nand_led_trigger);

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
static int check_offs_len(struct mtd_info *mtd,
					loff_t ofs, uint64_t len)
{
	struct nand_chip *chip = mtd->priv;
	int ret = 0;

	/* Start address must align on block boundary */
	if (ofs & ((1 << chip->phys_erase_shift) - 1)) {
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Unaligned address\n", __func__);
		ret = -EINVAL;
	}

	/* Length must align on block boundary */
	if (len & ((1 << chip->phys_erase_shift) - 1)) {
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Length not block aligned\n",
					__func__);
		ret = -EINVAL;
	}

	/* Do not allow past end of device */
	if (ofs + len > mtd->size) {
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Past end of device\n",
					__func__);
		ret = -EINVAL;
	}

	return ret;
}

L
Linus Torvalds 已提交
140 141 142
/**
 * nand_release_device - [GENERIC] release chip
 * @mtd:	MTD device structure
143 144
 *
 * Deselect, release chip lock and wake up anyone waiting on the device
L
Linus Torvalds 已提交
145
 */
146
static void nand_release_device(struct mtd_info *mtd)
L
Linus Torvalds 已提交
147
{
148
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
149 150

	/* De-select the NAND device */
151
	chip->select_chip(mtd, -1);
152

T
Thomas Gleixner 已提交
153
	/* Release the controller and the chip */
154 155 156 157 158
	spin_lock(&chip->controller->lock);
	chip->controller->active = NULL;
	chip->state = FL_READY;
	wake_up(&chip->controller->wq);
	spin_unlock(&chip->controller->lock);
L
Linus Torvalds 已提交
159 160 161 162 163 164 165 166
}

/**
 * nand_read_byte - [DEFAULT] read one byte from the chip
 * @mtd:	MTD device structure
 *
 * Default read function for 8bit buswith
 */
167
static uint8_t nand_read_byte(struct mtd_info *mtd)
L
Linus Torvalds 已提交
168
{
169 170
	struct nand_chip *chip = mtd->priv;
	return readb(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
171 172 173 174 175 176
}

/**
 * nand_read_byte16 - [DEFAULT] read one byte endianess aware from the chip
 * @mtd:	MTD device structure
 *
177
 * Default read function for 16bit buswith with
L
Linus Torvalds 已提交
178 179
 * endianess conversion
 */
180
static uint8_t nand_read_byte16(struct mtd_info *mtd)
L
Linus Torvalds 已提交
181
{
182 183
	struct nand_chip *chip = mtd->priv;
	return (uint8_t) cpu_to_le16(readw(chip->IO_ADDR_R));
L
Linus Torvalds 已提交
184 185 186 187 188 189
}

/**
 * nand_read_word - [DEFAULT] read one word from the chip
 * @mtd:	MTD device structure
 *
190
 * Default read function for 16bit buswith without
L
Linus Torvalds 已提交
191 192 193 194
 * endianess conversion
 */
static u16 nand_read_word(struct mtd_info *mtd)
{
195 196
	struct nand_chip *chip = mtd->priv;
	return readw(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
197 198 199 200 201
}

/**
 * nand_select_chip - [DEFAULT] control CE line
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
202
 * @chipnr:	chipnumber to select, -1 for deselect
L
Linus Torvalds 已提交
203 204 205
 *
 * Default select function for 1 chip devices.
 */
206
static void nand_select_chip(struct mtd_info *mtd, int chipnr)
L
Linus Torvalds 已提交
207
{
208 209 210
	struct nand_chip *chip = mtd->priv;

	switch (chipnr) {
L
Linus Torvalds 已提交
211
	case -1:
212
		chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
L
Linus Torvalds 已提交
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
		break;
	case 0:
		break;

	default:
		BUG();
	}
}

/**
 * nand_write_buf - [DEFAULT] write buffer to chip
 * @mtd:	MTD device structure
 * @buf:	data buffer
 * @len:	number of bytes to write
 *
 * Default write function for 8bit buswith
 */
230
static void nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
231 232
{
	int i;
233
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
234

235
	for (i = 0; i < len; i++)
236
		writeb(buf[i], chip->IO_ADDR_W);
L
Linus Torvalds 已提交
237 238 239
}

/**
240
 * nand_read_buf - [DEFAULT] read chip data into buffer
L
Linus Torvalds 已提交
241 242 243 244 245 246
 * @mtd:	MTD device structure
 * @buf:	buffer to store date
 * @len:	number of bytes to read
 *
 * Default read function for 8bit buswith
 */
247
static void nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
L
Linus Torvalds 已提交
248 249
{
	int i;
250
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
251

252
	for (i = 0; i < len; i++)
253
		buf[i] = readb(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
254 255 256
}

/**
257
 * nand_verify_buf - [DEFAULT] Verify chip data against buffer
L
Linus Torvalds 已提交
258 259 260 261 262 263
 * @mtd:	MTD device structure
 * @buf:	buffer containing the data to compare
 * @len:	number of bytes to compare
 *
 * Default verify function for 8bit buswith
 */
264
static int nand_verify_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
265 266
{
	int i;
267
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
268

269
	for (i = 0; i < len; i++)
270
		if (buf[i] != readb(chip->IO_ADDR_R))
L
Linus Torvalds 已提交
271 272 273 274 275 276 277 278 279 280 281 282
			return -EFAULT;
	return 0;
}

/**
 * nand_write_buf16 - [DEFAULT] write buffer to chip
 * @mtd:	MTD device structure
 * @buf:	data buffer
 * @len:	number of bytes to write
 *
 * Default write function for 16bit buswith
 */
283
static void nand_write_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
284 285
{
	int i;
286
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
287 288
	u16 *p = (u16 *) buf;
	len >>= 1;
289

290
	for (i = 0; i < len; i++)
291
		writew(p[i], chip->IO_ADDR_W);
292

L
Linus Torvalds 已提交
293 294 295
}

/**
296
 * nand_read_buf16 - [DEFAULT] read chip data into buffer
L
Linus Torvalds 已提交
297 298 299 300 301 302
 * @mtd:	MTD device structure
 * @buf:	buffer to store date
 * @len:	number of bytes to read
 *
 * Default read function for 16bit buswith
 */
303
static void nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len)
L
Linus Torvalds 已提交
304 305
{
	int i;
306
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
307 308 309
	u16 *p = (u16 *) buf;
	len >>= 1;

310
	for (i = 0; i < len; i++)
311
		p[i] = readw(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
312 313 314
}

/**
315
 * nand_verify_buf16 - [DEFAULT] Verify chip data against buffer
L
Linus Torvalds 已提交
316 317 318 319 320 321
 * @mtd:	MTD device structure
 * @buf:	buffer containing the data to compare
 * @len:	number of bytes to compare
 *
 * Default verify function for 16bit buswith
 */
322
static int nand_verify_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
323 324
{
	int i;
325
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
326 327 328
	u16 *p = (u16 *) buf;
	len >>= 1;

329
	for (i = 0; i < len; i++)
330
		if (p[i] != readw(chip->IO_ADDR_R))
L
Linus Torvalds 已提交
331 332 333 334 335 336 337 338 339 340 341
			return -EFAULT;

	return 0;
}

/**
 * nand_block_bad - [DEFAULT] Read bad block marker from the chip
 * @mtd:	MTD device structure
 * @ofs:	offset from device start
 * @getchip:	0, if the chip is already selected
 *
342
 * Check, if the block is bad.
L
Linus Torvalds 已提交
343 344 345 346
 */
static int nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
{
	int page, chipnr, res = 0;
347
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
348 349
	u16 bad;

350 351
	page = (int)(ofs >> chip->page_shift) & chip->pagemask;

L
Linus Torvalds 已提交
352
	if (getchip) {
353
		chipnr = (int)(ofs >> chip->chip_shift);
L
Linus Torvalds 已提交
354

355
		nand_get_device(chip, mtd, FL_READING);
L
Linus Torvalds 已提交
356 357

		/* Select the NAND device */
358
		chip->select_chip(mtd, chipnr);
359
	}
L
Linus Torvalds 已提交
360

361 362
	if (chip->options & NAND_BUSWIDTH_16) {
		chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos & 0xFE,
363
			      page);
364 365
		bad = cpu_to_le16(chip->read_word(mtd));
		if (chip->badblockpos & 0x1)
366
			bad >>= 8;
L
Linus Torvalds 已提交
367 368 369
		if ((bad & 0xFF) != 0xff)
			res = 1;
	} else {
370
		chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos, page);
371
		if (chip->read_byte(mtd) != 0xff)
L
Linus Torvalds 已提交
372 373
			res = 1;
	}
374

375
	if (getchip)
L
Linus Torvalds 已提交
376
		nand_release_device(mtd);
377

L
Linus Torvalds 已提交
378 379 380 381 382 383 384 385 386 387 388 389 390
	return res;
}

/**
 * nand_default_block_markbad - [DEFAULT] mark a block bad
 * @mtd:	MTD device structure
 * @ofs:	offset from device start
 *
 * This is the default implementation, which can be overridden by
 * a hardware specific driver.
*/
static int nand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
{
391
	struct nand_chip *chip = mtd->priv;
392
	uint8_t buf[2] = { 0, 0 };
393
	int block, ret;
394

L
Linus Torvalds 已提交
395
	/* Get block number */
396
	block = (int)(ofs >> chip->bbt_erase_shift);
397 398
	if (chip->bbt)
		chip->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
L
Linus Torvalds 已提交
399 400

	/* Do we have a flash based bad block table ? */
401
	if (chip->options & NAND_USE_FLASH_BBT)
402 403 404 405 406
		ret = nand_update_bbt(mtd, ofs);
	else {
		/* We write two bytes, so we dont have to mess with 16 bit
		 * access
		 */
407
		nand_get_device(chip, mtd, FL_WRITING);
408
		ofs += mtd->oobsize;
409
		chip->ops.len = chip->ops.ooblen = 2;
410 411 412 413 414
		chip->ops.datbuf = NULL;
		chip->ops.oobbuf = buf;
		chip->ops.ooboffs = chip->badblockpos & ~0x01;

		ret = nand_do_write_oob(mtd, ofs, &chip->ops);
415
		nand_release_device(mtd);
416 417 418
	}
	if (!ret)
		mtd->ecc_stats.badblocks++;
419

420
	return ret;
L
Linus Torvalds 已提交
421 422
}

423
/**
L
Linus Torvalds 已提交
424 425
 * nand_check_wp - [GENERIC] check if the chip is write protected
 * @mtd:	MTD device structure
426
 * Check, if the device is write protected
L
Linus Torvalds 已提交
427
 *
428
 * The function expects, that the device is already selected
L
Linus Torvalds 已提交
429
 */
430
static int nand_check_wp(struct mtd_info *mtd)
L
Linus Torvalds 已提交
431
{
432
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
433
	/* Check the WP bit */
434 435
	chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
	return (chip->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
L
Linus Torvalds 已提交
436 437 438 439 440 441 442 443 444 445 446 447
}

/**
 * nand_block_checkbad - [GENERIC] Check if a block is marked bad
 * @mtd:	MTD device structure
 * @ofs:	offset from device start
 * @getchip:	0, if the chip is already selected
 * @allowbbt:	1, if its allowed to access the bbt area
 *
 * Check, if the block is bad. Either by reading the bad block table or
 * calling of the scan function.
 */
448 449
static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip,
			       int allowbbt)
L
Linus Torvalds 已提交
450
{
451
	struct nand_chip *chip = mtd->priv;
452

453 454
	if (!chip->bbt)
		return chip->block_bad(mtd, ofs, getchip);
455

L
Linus Torvalds 已提交
456
	/* Return info from the table */
457
	return nand_isbad_bbt(mtd, ofs, allowbbt);
L
Linus Torvalds 已提交
458 459
}

460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
/**
 * panic_nand_wait_ready - [GENERIC] Wait for the ready pin after commands.
 * @mtd:	MTD device structure
 * @timeo:	Timeout
 *
 * Helper function for nand_wait_ready used when needing to wait in interrupt
 * context.
 */
static void panic_nand_wait_ready(struct mtd_info *mtd, unsigned long timeo)
{
	struct nand_chip *chip = mtd->priv;
	int i;

	/* Wait for the device to get ready */
	for (i = 0; i < timeo; i++) {
		if (chip->dev_ready(mtd))
			break;
		touch_softlockup_watchdog();
		mdelay(1);
	}
}

482
/*
483 484 485
 * Wait for the ready pin, after a command
 * The timeout is catched later.
 */
486
void nand_wait_ready(struct mtd_info *mtd)
487
{
488
	struct nand_chip *chip = mtd->priv;
489
	unsigned long timeo = jiffies + 2;
490

491 492 493 494
	/* 400ms timeout */
	if (in_interrupt() || oops_in_progress)
		return panic_nand_wait_ready(mtd, 400);

495
	led_trigger_event(nand_led_trigger, LED_FULL);
496 497
	/* wait until command is processed or timeout occures */
	do {
498
		if (chip->dev_ready(mtd))
499
			break;
I
Ingo Molnar 已提交
500
		touch_softlockup_watchdog();
501
	} while (time_before(jiffies, timeo));
502
	led_trigger_event(nand_led_trigger, LED_OFF);
503
}
504
EXPORT_SYMBOL_GPL(nand_wait_ready);
505

L
Linus Torvalds 已提交
506 507 508 509 510 511 512 513 514 515
/**
 * nand_command - [DEFAULT] Send command to NAND device
 * @mtd:	MTD device structure
 * @command:	the command to be sent
 * @column:	the column address for this command, -1 if none
 * @page_addr:	the page address for this command, -1 if none
 *
 * Send command to NAND device. This function is used for small page
 * devices (256/512 Bytes per page)
 */
516 517
static void nand_command(struct mtd_info *mtd, unsigned int command,
			 int column, int page_addr)
L
Linus Torvalds 已提交
518
{
519
	register struct nand_chip *chip = mtd->priv;
520
	int ctrl = NAND_CTRL_CLE | NAND_CTRL_CHANGE;
L
Linus Torvalds 已提交
521 522 523 524 525 526 527

	/*
	 * Write out the command to the device.
	 */
	if (command == NAND_CMD_SEQIN) {
		int readcmd;

J
Joern Engel 已提交
528
		if (column >= mtd->writesize) {
L
Linus Torvalds 已提交
529
			/* OOB area */
J
Joern Engel 已提交
530
			column -= mtd->writesize;
L
Linus Torvalds 已提交
531 532 533 534 535 536 537 538
			readcmd = NAND_CMD_READOOB;
		} else if (column < 256) {
			/* First 256 bytes --> READ0 */
			readcmd = NAND_CMD_READ0;
		} else {
			column -= 256;
			readcmd = NAND_CMD_READ1;
		}
539
		chip->cmd_ctrl(mtd, readcmd, ctrl);
540
		ctrl &= ~NAND_CTRL_CHANGE;
L
Linus Torvalds 已提交
541
	}
542
	chip->cmd_ctrl(mtd, command, ctrl);
L
Linus Torvalds 已提交
543

544 545 546 547 548 549 550
	/*
	 * Address cycle, when necessary
	 */
	ctrl = NAND_CTRL_ALE | NAND_CTRL_CHANGE;
	/* Serially input address */
	if (column != -1) {
		/* Adjust columns for 16 bit buswidth */
551
		if (chip->options & NAND_BUSWIDTH_16)
552
			column >>= 1;
553
		chip->cmd_ctrl(mtd, column, ctrl);
554 555 556
		ctrl &= ~NAND_CTRL_CHANGE;
	}
	if (page_addr != -1) {
557
		chip->cmd_ctrl(mtd, page_addr, ctrl);
558
		ctrl &= ~NAND_CTRL_CHANGE;
559
		chip->cmd_ctrl(mtd, page_addr >> 8, ctrl);
560
		/* One more address cycle for devices > 32MiB */
561 562
		if (chip->chipsize > (32 << 20))
			chip->cmd_ctrl(mtd, page_addr >> 16, ctrl);
L
Linus Torvalds 已提交
563
	}
564
	chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
565 566 567

	/*
	 * program and erase have their own busy handlers
L
Linus Torvalds 已提交
568
	 * status and sequential in needs no delay
569
	 */
L
Linus Torvalds 已提交
570
	switch (command) {
571

L
Linus Torvalds 已提交
572 573 574 575 576 577 578 579
	case NAND_CMD_PAGEPROG:
	case NAND_CMD_ERASE1:
	case NAND_CMD_ERASE2:
	case NAND_CMD_SEQIN:
	case NAND_CMD_STATUS:
		return;

	case NAND_CMD_RESET:
580
		if (chip->dev_ready)
L
Linus Torvalds 已提交
581
			break;
582 583
		udelay(chip->chip_delay);
		chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
584
			       NAND_CTRL_CLE | NAND_CTRL_CHANGE);
585 586
		chip->cmd_ctrl(mtd,
			       NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
587
		while (!(chip->read_byte(mtd) & NAND_STATUS_READY)) ;
L
Linus Torvalds 已提交
588 589
		return;

590
		/* This applies to read commands */
L
Linus Torvalds 已提交
591
	default:
592
		/*
L
Linus Torvalds 已提交
593 594
		 * If we don't have access to the busy pin, we apply the given
		 * command delay
595
		 */
596 597
		if (!chip->dev_ready) {
			udelay(chip->chip_delay);
L
Linus Torvalds 已提交
598
			return;
599
		}
L
Linus Torvalds 已提交
600 601 602
	}
	/* Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine. */
603
	ndelay(100);
604 605

	nand_wait_ready(mtd);
L
Linus Torvalds 已提交
606 607 608 609 610 611 612 613 614
}

/**
 * nand_command_lp - [DEFAULT] Send command to NAND large page device
 * @mtd:	MTD device structure
 * @command:	the command to be sent
 * @column:	the column address for this command, -1 if none
 * @page_addr:	the page address for this command, -1 if none
 *
615 616 617
 * Send command to NAND device. This is the version for the new large page
 * devices We dont have the separate regions as we have in the small page
 * devices.  We must emulate NAND_CMD_READOOB to keep the code compatible.
L
Linus Torvalds 已提交
618
 */
619 620
static void nand_command_lp(struct mtd_info *mtd, unsigned int command,
			    int column, int page_addr)
L
Linus Torvalds 已提交
621
{
622
	register struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
623 624 625

	/* Emulate NAND_CMD_READOOB */
	if (command == NAND_CMD_READOOB) {
J
Joern Engel 已提交
626
		column += mtd->writesize;
L
Linus Torvalds 已提交
627 628
		command = NAND_CMD_READ0;
	}
629

630
	/* Command latch cycle */
631
	chip->cmd_ctrl(mtd, command & 0xff,
632
		       NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
L
Linus Torvalds 已提交
633 634

	if (column != -1 || page_addr != -1) {
635
		int ctrl = NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE;
L
Linus Torvalds 已提交
636 637 638 639

		/* Serially input address */
		if (column != -1) {
			/* Adjust columns for 16 bit buswidth */
640
			if (chip->options & NAND_BUSWIDTH_16)
L
Linus Torvalds 已提交
641
				column >>= 1;
642
			chip->cmd_ctrl(mtd, column, ctrl);
643
			ctrl &= ~NAND_CTRL_CHANGE;
644
			chip->cmd_ctrl(mtd, column >> 8, ctrl);
645
		}
L
Linus Torvalds 已提交
646
		if (page_addr != -1) {
647 648
			chip->cmd_ctrl(mtd, page_addr, ctrl);
			chip->cmd_ctrl(mtd, page_addr >> 8,
649
				       NAND_NCE | NAND_ALE);
L
Linus Torvalds 已提交
650
			/* One more address cycle for devices > 128MiB */
651 652
			if (chip->chipsize > (128 << 20))
				chip->cmd_ctrl(mtd, page_addr >> 16,
653
					       NAND_NCE | NAND_ALE);
L
Linus Torvalds 已提交
654 655
		}
	}
656
	chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
657 658 659

	/*
	 * program and erase have their own busy handlers
660 661
	 * status, sequential in, and deplete1 need no delay
	 */
L
Linus Torvalds 已提交
662
	switch (command) {
663

L
Linus Torvalds 已提交
664 665 666 667 668
	case NAND_CMD_CACHEDPROG:
	case NAND_CMD_PAGEPROG:
	case NAND_CMD_ERASE1:
	case NAND_CMD_ERASE2:
	case NAND_CMD_SEQIN:
669
	case NAND_CMD_RNDIN:
L
Linus Torvalds 已提交
670
	case NAND_CMD_STATUS:
671
	case NAND_CMD_DEPLETE1:
L
Linus Torvalds 已提交
672 673
		return;

674 675 676
		/*
		 * read error status commands require only a short delay
		 */
677 678 679 680 681
	case NAND_CMD_STATUS_ERROR:
	case NAND_CMD_STATUS_ERROR0:
	case NAND_CMD_STATUS_ERROR1:
	case NAND_CMD_STATUS_ERROR2:
	case NAND_CMD_STATUS_ERROR3:
682
		udelay(chip->chip_delay);
683
		return;
L
Linus Torvalds 已提交
684 685

	case NAND_CMD_RESET:
686
		if (chip->dev_ready)
L
Linus Torvalds 已提交
687
			break;
688
		udelay(chip->chip_delay);
689 690 691 692
		chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
			       NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
		chip->cmd_ctrl(mtd, NAND_CMD_NONE,
			       NAND_NCE | NAND_CTRL_CHANGE);
693
		while (!(chip->read_byte(mtd) & NAND_STATUS_READY)) ;
L
Linus Torvalds 已提交
694 695
		return;

696 697 698 699 700 701 702 703
	case NAND_CMD_RNDOUT:
		/* No ready / busy check necessary */
		chip->cmd_ctrl(mtd, NAND_CMD_RNDOUTSTART,
			       NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
		chip->cmd_ctrl(mtd, NAND_CMD_NONE,
			       NAND_NCE | NAND_CTRL_CHANGE);
		return;

L
Linus Torvalds 已提交
704
	case NAND_CMD_READ0:
705 706 707 708
		chip->cmd_ctrl(mtd, NAND_CMD_READSTART,
			       NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
		chip->cmd_ctrl(mtd, NAND_CMD_NONE,
			       NAND_NCE | NAND_CTRL_CHANGE);
709

710
		/* This applies to read commands */
L
Linus Torvalds 已提交
711
	default:
712
		/*
L
Linus Torvalds 已提交
713 714
		 * If we don't have access to the busy pin, we apply the given
		 * command delay
715
		 */
716 717
		if (!chip->dev_ready) {
			udelay(chip->chip_delay);
L
Linus Torvalds 已提交
718
			return;
719
		}
L
Linus Torvalds 已提交
720
	}
721

L
Linus Torvalds 已提交
722 723
	/* Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine. */
724
	ndelay(100);
725 726

	nand_wait_ready(mtd);
L
Linus Torvalds 已提交
727 728
}

729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
/**
 * panic_nand_get_device - [GENERIC] Get chip for selected access
 * @chip:	the nand chip descriptor
 * @mtd:	MTD device structure
 * @new_state:	the state which is requested
 *
 * Used when in panic, no locks are taken.
 */
static void panic_nand_get_device(struct nand_chip *chip,
		      struct mtd_info *mtd, int new_state)
{
	/* Hardware controller shared among independend devices */
	chip->controller->active = chip;
	chip->state = new_state;
}

L
Linus Torvalds 已提交
745 746
/**
 * nand_get_device - [GENERIC] Get chip for selected access
R
Randy Dunlap 已提交
747
 * @chip:	the nand chip descriptor
L
Linus Torvalds 已提交
748
 * @mtd:	MTD device structure
749
 * @new_state:	the state which is requested
L
Linus Torvalds 已提交
750 751 752
 *
 * Get the device and lock it for exclusive access
 */
753
static int
754
nand_get_device(struct nand_chip *chip, struct mtd_info *mtd, int new_state)
L
Linus Torvalds 已提交
755
{
756 757
	spinlock_t *lock = &chip->controller->lock;
	wait_queue_head_t *wq = &chip->controller->wq;
758 759
	DECLARE_WAITQUEUE(wait, current);
 retry:
760 761
	spin_lock(lock);

762
	/* Hardware controller shared among independent devices */
763 764
	if (!chip->controller->active)
		chip->controller->active = chip;
T
Thomas Gleixner 已提交
765

766 767
	if (chip->controller->active == chip && chip->state == FL_READY) {
		chip->state = new_state;
768
		spin_unlock(lock);
769 770 771
		return 0;
	}
	if (new_state == FL_PM_SUSPENDED) {
772 773 774 775 776 777 778 779
		if (chip->controller->active->state == FL_PM_SUSPENDED) {
			chip->state = FL_PM_SUSPENDED;
			spin_unlock(lock);
			return 0;
		} else {
			spin_unlock(lock);
			return -EAGAIN;
		}
780 781 782 783 784 785
	}
	set_current_state(TASK_UNINTERRUPTIBLE);
	add_wait_queue(wq, &wait);
	spin_unlock(lock);
	schedule();
	remove_wait_queue(wq, &wait);
L
Linus Torvalds 已提交
786 787 788
	goto retry;
}

789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
/**
 * panic_nand_wait - [GENERIC]  wait until the command is done
 * @mtd:	MTD device structure
 * @chip:	NAND chip structure
 * @timeo:	Timeout
 *
 * Wait for command done. This is a helper function for nand_wait used when
 * we are in interrupt context. May happen when in panic and trying to write
 * an oops trough mtdoops.
 */
static void panic_nand_wait(struct mtd_info *mtd, struct nand_chip *chip,
			    unsigned long timeo)
{
	int i;
	for (i = 0; i < timeo; i++) {
		if (chip->dev_ready) {
			if (chip->dev_ready(mtd))
				break;
		} else {
			if (chip->read_byte(mtd) & NAND_STATUS_READY)
				break;
		}
		mdelay(1);
        }
}

L
Linus Torvalds 已提交
815 816 817
/**
 * nand_wait - [DEFAULT]  wait until the command is done
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
818
 * @chip:	NAND chip structure
L
Linus Torvalds 已提交
819 820
 *
 * Wait for command done. This applies to erase and program only
821
 * Erase can take up to 400ms and program up to 20ms according to
L
Linus Torvalds 已提交
822
 * general NAND and SmartMedia specs
R
Randy Dunlap 已提交
823
 */
824
static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
L
Linus Torvalds 已提交
825 826
{

827
	unsigned long timeo = jiffies;
828
	int status, state = chip->state;
829

L
Linus Torvalds 已提交
830
	if (state == FL_ERASING)
831
		timeo += (HZ * 400) / 1000;
L
Linus Torvalds 已提交
832
	else
833
		timeo += (HZ * 20) / 1000;
L
Linus Torvalds 已提交
834

835 836
	led_trigger_event(nand_led_trigger, LED_FULL);

L
Linus Torvalds 已提交
837 838
	/* Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine. */
839
	ndelay(100);
L
Linus Torvalds 已提交
840

841 842
	if ((state == FL_ERASING) && (chip->options & NAND_IS_AND))
		chip->cmdfunc(mtd, NAND_CMD_STATUS_MULTI, -1, -1);
843
	else
844
		chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
L
Linus Torvalds 已提交
845

846 847 848 849 850 851 852 853 854 855 856 857
	if (in_interrupt() || oops_in_progress)
		panic_nand_wait(mtd, chip, timeo);
	else {
		while (time_before(jiffies, timeo)) {
			if (chip->dev_ready) {
				if (chip->dev_ready(mtd))
					break;
			} else {
				if (chip->read_byte(mtd) & NAND_STATUS_READY)
					break;
			}
			cond_resched();
L
Linus Torvalds 已提交
858 859
		}
	}
860 861
	led_trigger_event(nand_led_trigger, LED_OFF);

862
	status = (int)chip->read_byte(mtd);
L
Linus Torvalds 已提交
863 864 865
	return status;
}

866 867 868 869 870
/**
 * nand_read_page_raw - [Intern] read raw page data without ecc
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
871
 * @page:	page number to read
872 873
 *
 * Not for syndrome calculating ecc controllers, which use a special oob layout
874 875
 */
static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
876
			      uint8_t *buf, int page)
877 878 879 880 881 882
{
	chip->read_buf(mtd, buf, mtd->writesize);
	chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
	return 0;
}

883 884 885 886 887
/**
 * nand_read_page_raw_syndrome - [Intern] read raw page data without ecc
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
888
 * @page:	page number to read
889 890 891 892
 *
 * We need a special oob layout and handling even when OOB isn't used.
 */
static int nand_read_page_raw_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
893
			      uint8_t *buf, int page)
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
{
	int eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	uint8_t *oob = chip->oob_poi;
	int steps, size;

	for (steps = chip->ecc.steps; steps > 0; steps--) {
		chip->read_buf(mtd, buf, eccsize);
		buf += eccsize;

		if (chip->ecc.prepad) {
			chip->read_buf(mtd, oob, chip->ecc.prepad);
			oob += chip->ecc.prepad;
		}

		chip->read_buf(mtd, oob, eccbytes);
		oob += eccbytes;

		if (chip->ecc.postpad) {
			chip->read_buf(mtd, oob, chip->ecc.postpad);
			oob += chip->ecc.postpad;
		}
	}

	size = mtd->oobsize - (oob - chip->oob_poi);
	if (size)
		chip->read_buf(mtd, oob, size);

	return 0;
}

L
Linus Torvalds 已提交
925
/**
926
 * nand_read_page_swecc - [REPLACABLE] software ecc based page read function
927 928 929
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
930
 * @page:	page number to read
931
 */
932
static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
933
				uint8_t *buf, int page)
L
Linus Torvalds 已提交
934
{
935 936 937 938
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
939 940
	uint8_t *ecc_calc = chip->buffers->ecccalc;
	uint8_t *ecc_code = chip->buffers->ecccode;
941
	uint32_t *eccpos = chip->ecc.layout->eccpos;
942

943
	chip->ecc.read_page_raw(mtd, chip, buf, page);
944 945 946 947 948

	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);

	for (i = 0; i < chip->ecc.total; i++)
949
		ecc_code[i] = chip->oob_poi[eccpos[i]];
950 951 952 953 954 955 956 957

	eccsteps = chip->ecc.steps;
	p = buf;

	for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		int stat;

		stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
958
		if (stat < 0)
959 960 961 962 963
			mtd->ecc_stats.failed++;
		else
			mtd->ecc_stats.corrected += stat;
	}
	return 0;
964
}
L
Linus Torvalds 已提交
965

966 967 968 969
/**
 * nand_read_subpage - [REPLACABLE] software ecc based sub-page read function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
970 971 972
 * @data_offs:	offset of requested data within the page
 * @readlen:	data length
 * @bufpoi:	buffer to store read data
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
 */
static int nand_read_subpage(struct mtd_info *mtd, struct nand_chip *chip, uint32_t data_offs, uint32_t readlen, uint8_t *bufpoi)
{
	int start_step, end_step, num_steps;
	uint32_t *eccpos = chip->ecc.layout->eccpos;
	uint8_t *p;
	int data_col_addr, i, gaps = 0;
	int datafrag_len, eccfrag_len, aligned_len, aligned_pos;
	int busw = (chip->options & NAND_BUSWIDTH_16) ? 2 : 1;

	/* Column address wihin the page aligned to ECC size (256bytes). */
	start_step = data_offs / chip->ecc.size;
	end_step = (data_offs + readlen - 1) / chip->ecc.size;
	num_steps = end_step - start_step + 1;

	/* Data size aligned to ECC ecc.size*/
	datafrag_len = num_steps * chip->ecc.size;
	eccfrag_len = num_steps * chip->ecc.bytes;

	data_col_addr = start_step * chip->ecc.size;
	/* If we read not a page aligned data */
	if (data_col_addr != 0)
		chip->cmdfunc(mtd, NAND_CMD_RNDOUT, data_col_addr, -1);

	p = bufpoi + data_col_addr;
	chip->read_buf(mtd, p, datafrag_len);

	/* Calculate  ECC */
	for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size)
		chip->ecc.calculate(mtd, p, &chip->buffers->ecccalc[i]);

	/* The performance is faster if to position offsets
	   according to ecc.pos. Let make sure here that
	   there are no gaps in ecc positions */
	for (i = 0; i < eccfrag_len - 1; i++) {
		if (eccpos[i + start_step * chip->ecc.bytes] + 1 !=
			eccpos[i + start_step * chip->ecc.bytes + 1]) {
			gaps = 1;
			break;
		}
	}
	if (gaps) {
		chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize, -1);
		chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
	} else {
		/* send the command to read the particular ecc bytes */
		/* take care about buswidth alignment in read_buf */
		aligned_pos = eccpos[start_step * chip->ecc.bytes] & ~(busw - 1);
		aligned_len = eccfrag_len;
		if (eccpos[start_step * chip->ecc.bytes] & (busw - 1))
			aligned_len++;
		if (eccpos[(start_step + num_steps) * chip->ecc.bytes] & (busw - 1))
			aligned_len++;

		chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize + aligned_pos, -1);
		chip->read_buf(mtd, &chip->oob_poi[aligned_pos], aligned_len);
	}

	for (i = 0; i < eccfrag_len; i++)
		chip->buffers->ecccode[i] = chip->oob_poi[eccpos[i + start_step * chip->ecc.bytes]];

	p = bufpoi + data_col_addr;
	for (i = 0; i < eccfrag_len ; i += chip->ecc.bytes, p += chip->ecc.size) {
		int stat;

		stat = chip->ecc.correct(mtd, p, &chip->buffers->ecccode[i], &chip->buffers->ecccalc[i]);
		if (stat == -1)
			mtd->ecc_stats.failed++;
		else
			mtd->ecc_stats.corrected += stat;
	}
	return 0;
}

1047
/**
1048
 * nand_read_page_hwecc - [REPLACABLE] hardware ecc based page read function
1049 1050 1051
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
1052
 * @page:	page number to read
1053
 *
1054
 * Not for syndrome calculating ecc controllers which need a special oob layout
1055
 */
1056
static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
1057
				uint8_t *buf, int page)
L
Linus Torvalds 已提交
1058
{
1059 1060 1061 1062
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1063 1064
	uint8_t *ecc_calc = chip->buffers->ecccalc;
	uint8_t *ecc_code = chip->buffers->ecccode;
1065
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1066 1067 1068 1069 1070

	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		chip->ecc.hwctl(mtd, NAND_ECC_READ);
		chip->read_buf(mtd, p, eccsize);
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
L
Linus Torvalds 已提交
1071
	}
1072
	chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
L
Linus Torvalds 已提交
1073

1074
	for (i = 0; i < chip->ecc.total; i++)
1075
		ecc_code[i] = chip->oob_poi[eccpos[i]];
L
Linus Torvalds 已提交
1076

1077 1078
	eccsteps = chip->ecc.steps;
	p = buf;
1079

1080 1081
	for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		int stat;
L
Linus Torvalds 已提交
1082

1083
		stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
1084
		if (stat < 0)
1085 1086 1087 1088 1089 1090
			mtd->ecc_stats.failed++;
		else
			mtd->ecc_stats.corrected += stat;
	}
	return 0;
}
L
Linus Torvalds 已提交
1091

1092 1093 1094 1095 1096
/**
 * nand_read_page_hwecc_oob_first - [REPLACABLE] hw ecc, read oob first
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
1097
 * @page:	page number to read
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
 *
 * Hardware ECC for large page chips, require OOB to be read first.
 * For this ECC mode, the write_page method is re-used from ECC_HW.
 * These methods read/write ECC from the OOB area, unlike the
 * ECC_HW_SYNDROME support with multiple ECC steps, follows the
 * "infix ECC" scheme and reads/writes ECC from the data area, by
 * overwriting the NAND manufacturer bad block markings.
 */
static int nand_read_page_hwecc_oob_first(struct mtd_info *mtd,
	struct nand_chip *chip, uint8_t *buf, int page)
{
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
	uint8_t *ecc_code = chip->buffers->ecccode;
	uint32_t *eccpos = chip->ecc.layout->eccpos;
	uint8_t *ecc_calc = chip->buffers->ecccalc;

	/* Read the OOB area first */
	chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
	chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
	chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);

	for (i = 0; i < chip->ecc.total; i++)
		ecc_code[i] = chip->oob_poi[eccpos[i]];

	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		int stat;

		chip->ecc.hwctl(mtd, NAND_ECC_READ);
		chip->read_buf(mtd, p, eccsize);
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);

		stat = chip->ecc.correct(mtd, p, &ecc_code[i], NULL);
		if (stat < 0)
			mtd->ecc_stats.failed++;
		else
			mtd->ecc_stats.corrected += stat;
	}
	return 0;
}

1141
/**
1142
 * nand_read_page_syndrome - [REPLACABLE] hardware ecc syndrom based page read
1143 1144 1145
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
1146
 * @page:	page number to read
1147 1148
 *
 * The hw generator calculates the error syndrome automatically. Therefor
1149
 * we need a special oob layout and handling.
1150 1151
 */
static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1152
				   uint8_t *buf, int page)
1153 1154 1155 1156 1157
{
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1158
	uint8_t *oob = chip->oob_poi;
L
Linus Torvalds 已提交
1159

1160 1161
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		int stat;
1162

1163 1164
		chip->ecc.hwctl(mtd, NAND_ECC_READ);
		chip->read_buf(mtd, p, eccsize);
L
Linus Torvalds 已提交
1165

1166 1167 1168 1169
		if (chip->ecc.prepad) {
			chip->read_buf(mtd, oob, chip->ecc.prepad);
			oob += chip->ecc.prepad;
		}
L
Linus Torvalds 已提交
1170

1171 1172 1173
		chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
		chip->read_buf(mtd, oob, eccbytes);
		stat = chip->ecc.correct(mtd, p, oob, NULL);
1174

1175
		if (stat < 0)
1176
			mtd->ecc_stats.failed++;
1177
		else
1178
			mtd->ecc_stats.corrected += stat;
1179

1180
		oob += eccbytes;
L
Linus Torvalds 已提交
1181

1182 1183 1184
		if (chip->ecc.postpad) {
			chip->read_buf(mtd, oob, chip->ecc.postpad);
			oob += chip->ecc.postpad;
1185
		}
1186
	}
L
Linus Torvalds 已提交
1187

1188
	/* Calculate remaining oob bytes */
1189
	i = mtd->oobsize - (oob - chip->oob_poi);
1190 1191
	if (i)
		chip->read_buf(mtd, oob, i);
1192

1193 1194
	return 0;
}
L
Linus Torvalds 已提交
1195

1196
/**
1197 1198
 * nand_transfer_oob - [Internal] Transfer oob to client buffer
 * @chip:	nand chip structure
R
Randy Dunlap 已提交
1199
 * @oob:	oob destination address
1200
 * @ops:	oob ops structure
1201
 * @len:	size of oob to transfer
1202 1203
 */
static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
1204
				  struct mtd_oob_ops *ops, size_t len)
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
{
	switch(ops->mode) {

	case MTD_OOB_PLACE:
	case MTD_OOB_RAW:
		memcpy(oob, chip->oob_poi + ops->ooboffs, len);
		return oob + len;

	case MTD_OOB_AUTO: {
		struct nand_oobfree *free = chip->ecc.layout->oobfree;
1215 1216
		uint32_t boffs = 0, roffs = ops->ooboffs;
		size_t bytes = 0;
1217 1218

		for(; free->length && len; free++, len -= bytes) {
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
			/* Read request not from offset 0 ? */
			if (unlikely(roffs)) {
				if (roffs >= free->length) {
					roffs -= free->length;
					continue;
				}
				boffs = free->offset + roffs;
				bytes = min_t(size_t, len,
					      (free->length - roffs));
				roffs = 0;
			} else {
				bytes = min_t(size_t, len, free->length);
				boffs = free->offset;
			}
			memcpy(oob, chip->oob_poi + boffs, bytes);
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
			oob += bytes;
		}
		return oob;
	}
	default:
		BUG();
	}
	return NULL;
}

/**
 * nand_do_read_ops - [Internal] Read data with ECC
1246 1247 1248
 *
 * @mtd:	MTD device structure
 * @from:	offset to read from
R
Randy Dunlap 已提交
1249
 * @ops:	oob ops structure
1250 1251 1252
 *
 * Internal function. Called with chip held.
 */
1253 1254
static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
1255 1256 1257 1258 1259 1260 1261
{
	int chipnr, page, realpage, col, bytes, aligned;
	struct nand_chip *chip = mtd->priv;
	struct mtd_ecc_stats stats;
	int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
	int sndcmd = 1;
	int ret = 0;
1262
	uint32_t readlen = ops->len;
1263
	uint32_t oobreadlen = ops->ooblen;
1264
	uint8_t *bufpoi, *oob, *buf;
L
Linus Torvalds 已提交
1265

1266
	stats = mtd->ecc_stats;
L
Linus Torvalds 已提交
1267

1268 1269
	chipnr = (int)(from >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);
1270

1271 1272
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1273

1274
	col = (int)(from & (mtd->writesize - 1));
1275

1276 1277 1278
	buf = ops->datbuf;
	oob = ops->oobbuf;

1279 1280 1281
	while(1) {
		bytes = min(mtd->writesize - col, readlen);
		aligned = (bytes == mtd->writesize);
1282

1283
		/* Is the current page in the buffer ? */
1284
		if (realpage != chip->pagebuf || oob) {
1285
			bufpoi = aligned ? buf : chip->buffers->databuf;
1286

1287 1288 1289
			if (likely(sndcmd)) {
				chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
				sndcmd = 0;
L
Linus Torvalds 已提交
1290 1291
			}

1292
			/* Now read the page into the buffer */
1293
			if (unlikely(ops->mode == MTD_OOB_RAW))
1294 1295
				ret = chip->ecc.read_page_raw(mtd, chip,
							      bufpoi, page);
1296 1297
			else if (!aligned && NAND_SUBPAGE_READ(chip) && !oob)
				ret = chip->ecc.read_subpage(mtd, chip, col, bytes, bufpoi);
1298
			else
1299 1300
				ret = chip->ecc.read_page(mtd, chip, bufpoi,
							  page);
1301
			if (ret < 0)
L
Linus Torvalds 已提交
1302
				break;
1303 1304 1305

			/* Transfer not aligned data */
			if (!aligned) {
1306 1307
				if (!NAND_SUBPAGE_READ(chip) && !oob)
					chip->pagebuf = realpage;
1308
				memcpy(buf, chip->buffers->databuf + col, bytes);
1309 1310
			}

1311 1312 1313 1314
			buf += bytes;

			if (unlikely(oob)) {
				/* Raw mode does data:oob:data:oob */
1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
				if (ops->mode != MTD_OOB_RAW) {
					int toread = min(oobreadlen,
						chip->ecc.layout->oobavail);
					if (toread) {
						oob = nand_transfer_oob(chip,
							oob, ops, toread);
						oobreadlen -= toread;
					}
				} else
					buf = nand_transfer_oob(chip,
						buf, ops, mtd->oobsize);
1326 1327
			}

1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339
			if (!(chip->options & NAND_NO_READRDY)) {
				/*
				 * Apply delay or wait for ready/busy pin. Do
				 * this before the AUTOINCR check, so no
				 * problems arise if a chip which does auto
				 * increment is marked as NOAUTOINCR by the
				 * board driver.
				 */
				if (!chip->dev_ready)
					udelay(chip->chip_delay);
				else
					nand_wait_ready(mtd);
L
Linus Torvalds 已提交
1340
			}
1341
		} else {
1342
			memcpy(buf, chip->buffers->databuf + col, bytes);
1343 1344
			buf += bytes;
		}
L
Linus Torvalds 已提交
1345

1346
		readlen -= bytes;
1347

1348
		if (!readlen)
1349
			break;
L
Linus Torvalds 已提交
1350 1351 1352 1353 1354 1355

		/* For subsequent reads align to page boundary. */
		col = 0;
		/* Increment page address */
		realpage++;

1356
		page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1357 1358 1359
		/* Check, if we cross a chip boundary */
		if (!page) {
			chipnr++;
1360 1361
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1362
		}
1363

1364 1365
		/* Check, if the chip supports auto page increment
		 * or if we have hit a block boundary.
1366
		 */
1367
		if (!NAND_CANAUTOINCR(chip) || !(page & blkcheck))
1368
			sndcmd = 1;
L
Linus Torvalds 已提交
1369 1370
	}

1371
	ops->retlen = ops->len - (size_t) readlen;
1372 1373
	if (oob)
		ops->oobretlen = ops->ooblen - oobreadlen;
L
Linus Torvalds 已提交
1374

1375 1376 1377
	if (ret)
		return ret;

1378 1379 1380 1381
	if (mtd->ecc_stats.failed - stats.failed)
		return -EBADMSG;

	return  mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
}

/**
 * nand_read - [MTD Interface] MTD compability function for nand_do_read_ecc
 * @mtd:	MTD device structure
 * @from:	offset to read from
 * @len:	number of bytes to read
 * @retlen:	pointer to variable to store the number of read bytes
 * @buf:	the databuffer to put data
 *
 * Get hold of the chip and call nand_do_read
 */
static int nand_read(struct mtd_info *mtd, loff_t from, size_t len,
		     size_t *retlen, uint8_t *buf)
{
1397
	struct nand_chip *chip = mtd->priv;
1398 1399 1400 1401 1402 1403 1404 1405
	int ret;

	/* Do not allow reads past end of device */
	if ((from + len) > mtd->size)
		return -EINVAL;
	if (!len)
		return 0;

1406
	nand_get_device(chip, mtd, FL_READING);
1407

1408 1409 1410 1411 1412
	chip->ops.len = len;
	chip->ops.datbuf = buf;
	chip->ops.oobbuf = NULL;

	ret = nand_do_read_ops(mtd, from, &chip->ops);
1413

R
Richard Purdie 已提交
1414 1415
	*retlen = chip->ops.retlen;

1416 1417 1418
	nand_release_device(mtd);

	return ret;
L
Linus Torvalds 已提交
1419 1420
}

1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
/**
 * nand_read_oob_std - [REPLACABLE] the most common OOB data read function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @page:	page number to read
 * @sndcmd:	flag whether to issue read command or not
 */
static int nand_read_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
			     int page, int sndcmd)
{
	if (sndcmd) {
		chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
		sndcmd = 0;
	}
	chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
	return sndcmd;
}

/**
 * nand_read_oob_syndrome - [REPLACABLE] OOB data read function for HW ECC
 *			    with syndromes
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @page:	page number to read
 * @sndcmd:	flag whether to issue read command or not
 */
static int nand_read_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
				  int page, int sndcmd)
{
	uint8_t *buf = chip->oob_poi;
	int length = mtd->oobsize;
	int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
	int eccsize = chip->ecc.size;
	uint8_t *bufpoi = buf;
	int i, toread, sndrnd = 0, pos;

	chip->cmdfunc(mtd, NAND_CMD_READ0, chip->ecc.size, page);
	for (i = 0; i < chip->ecc.steps; i++) {
		if (sndrnd) {
			pos = eccsize + i * (eccsize + chunk);
			if (mtd->writesize > 512)
				chip->cmdfunc(mtd, NAND_CMD_RNDOUT, pos, -1);
			else
				chip->cmdfunc(mtd, NAND_CMD_READ0, pos, page);
		} else
			sndrnd = 1;
		toread = min_t(int, length, chunk);
		chip->read_buf(mtd, bufpoi, toread);
		bufpoi += toread;
		length -= toread;
	}
	if (length > 0)
		chip->read_buf(mtd, bufpoi, length);

	return 1;
}

/**
 * nand_write_oob_std - [REPLACABLE] the most common OOB data write function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @page:	page number to write
 */
static int nand_write_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
			      int page)
{
	int status = 0;
	const uint8_t *buf = chip->oob_poi;
	int length = mtd->oobsize;

	chip->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize, page);
	chip->write_buf(mtd, buf, length);
	/* Send command to program the OOB data */
	chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);

	status = chip->waitfunc(mtd, chip);

S
Savin Zlobec 已提交
1498
	return status & NAND_STATUS_FAIL ? -EIO : 0;
1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524
}

/**
 * nand_write_oob_syndrome - [REPLACABLE] OOB data write function for HW ECC
 *			     with syndrome - only for large page flash !
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @page:	page number to write
 */
static int nand_write_oob_syndrome(struct mtd_info *mtd,
				   struct nand_chip *chip, int page)
{
	int chunk = chip->ecc.bytes + chip->ecc.prepad + chip->ecc.postpad;
	int eccsize = chip->ecc.size, length = mtd->oobsize;
	int i, len, pos, status = 0, sndcmd = 0, steps = chip->ecc.steps;
	const uint8_t *bufpoi = chip->oob_poi;

	/*
	 * data-ecc-data-ecc ... ecc-oob
	 * or
	 * data-pad-ecc-pad-data-pad .... ecc-pad-oob
	 */
	if (!chip->ecc.prepad && !chip->ecc.postpad) {
		pos = steps * (eccsize + chunk);
		steps = 0;
	} else
1525
		pos = eccsize;
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559

	chip->cmdfunc(mtd, NAND_CMD_SEQIN, pos, page);
	for (i = 0; i < steps; i++) {
		if (sndcmd) {
			if (mtd->writesize <= 512) {
				uint32_t fill = 0xFFFFFFFF;

				len = eccsize;
				while (len > 0) {
					int num = min_t(int, len, 4);
					chip->write_buf(mtd, (uint8_t *)&fill,
							num);
					len -= num;
				}
			} else {
				pos = eccsize + i * (eccsize + chunk);
				chip->cmdfunc(mtd, NAND_CMD_RNDIN, pos, -1);
			}
		} else
			sndcmd = 1;
		len = min_t(int, length, chunk);
		chip->write_buf(mtd, bufpoi, len);
		bufpoi += len;
		length -= len;
	}
	if (length > 0)
		chip->write_buf(mtd, bufpoi, length);

	chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
	status = chip->waitfunc(mtd, chip);

	return status & NAND_STATUS_FAIL ? -EIO : 0;
}

L
Linus Torvalds 已提交
1560
/**
1561
 * nand_do_read_oob - [Intern] NAND read out-of-band
L
Linus Torvalds 已提交
1562 1563
 * @mtd:	MTD device structure
 * @from:	offset to read from
1564
 * @ops:	oob operations description structure
L
Linus Torvalds 已提交
1565 1566 1567
 *
 * NAND read out-of-band data from the spare area
 */
1568 1569
static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1570
{
1571
	int page, realpage, chipnr, sndcmd = 1;
1572
	struct nand_chip *chip = mtd->priv;
1573
	int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
1574 1575
	int readlen = ops->ooblen;
	int len;
1576
	uint8_t *buf = ops->oobbuf;
1577

1578 1579
	DEBUG(MTD_DEBUG_LEVEL3, "%s: from = 0x%08Lx, len = %i\n",
			__func__, (unsigned long long)from, readlen);
L
Linus Torvalds 已提交
1580

1581
	if (ops->mode == MTD_OOB_AUTO)
1582
		len = chip->ecc.layout->oobavail;
1583 1584 1585 1586
	else
		len = mtd->oobsize;

	if (unlikely(ops->ooboffs >= len)) {
1587 1588
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to start read "
					"outside oob\n", __func__);
1589 1590 1591 1592 1593 1594 1595
		return -EINVAL;
	}

	/* Do not allow reads past end of device */
	if (unlikely(from >= mtd->size ||
		     ops->ooboffs + readlen > ((mtd->size >> chip->page_shift) -
					(from >> chip->page_shift)) * len)) {
1596 1597
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt read beyond end "
					"of device\n", __func__);
1598 1599
		return -EINVAL;
	}
1600

1601
	chipnr = (int)(from >> chip->chip_shift);
1602
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1603

1604 1605 1606
	/* Shift to get page */
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1607

1608
	while(1) {
1609
		sndcmd = chip->ecc.read_oob(mtd, chip, page, sndcmd);
1610 1611 1612

		len = min(len, readlen);
		buf = nand_transfer_oob(chip, buf, ops, len);
1613

1614 1615 1616 1617 1618 1619
		if (!(chip->options & NAND_NO_READRDY)) {
			/*
			 * Apply delay or wait for ready/busy pin. Do this
			 * before the AUTOINCR check, so no problems arise if a
			 * chip which does auto increment is marked as
			 * NOAUTOINCR by the board driver.
1620
			 */
1621 1622
			if (!chip->dev_ready)
				udelay(chip->chip_delay);
1623 1624
			else
				nand_wait_ready(mtd);
1625
		}
1626

1627
		readlen -= len;
S
Savin Zlobec 已提交
1628 1629 1630
		if (!readlen)
			break;

1631 1632 1633 1634 1635 1636 1637 1638 1639
		/* Increment page address */
		realpage++;

		page = realpage & chip->pagemask;
		/* Check, if we cross a chip boundary */
		if (!page) {
			chipnr++;
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1640
		}
1641 1642 1643 1644 1645 1646

		/* Check, if the chip supports auto page increment
		 * or if we have hit a block boundary.
		 */
		if (!NAND_CANAUTOINCR(chip) || !(page & blkcheck))
			sndcmd = 1;
L
Linus Torvalds 已提交
1647 1648
	}

1649
	ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
1650 1651 1652 1653
	return 0;
}

/**
1654
 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
L
Linus Torvalds 已提交
1655 1656
 * @mtd:	MTD device structure
 * @from:	offset to read from
1657
 * @ops:	oob operation description structure
L
Linus Torvalds 已提交
1658
 *
1659
 * NAND read data and/or out-of-band data
L
Linus Torvalds 已提交
1660
 */
1661 1662
static int nand_read_oob(struct mtd_info *mtd, loff_t from,
			 struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1663
{
1664
	struct nand_chip *chip = mtd->priv;
1665 1666 1667
	int ret = -ENOTSUPP;

	ops->retlen = 0;
L
Linus Torvalds 已提交
1668 1669

	/* Do not allow reads past end of device */
1670
	if (ops->datbuf && (from + ops->len) > mtd->size) {
1671 1672
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt read "
				"beyond end of device\n", __func__);
L
Linus Torvalds 已提交
1673 1674 1675
		return -EINVAL;
	}

1676
	nand_get_device(chip, mtd, FL_READING);
L
Linus Torvalds 已提交
1677

1678 1679 1680 1681 1682
	switch(ops->mode) {
	case MTD_OOB_PLACE:
	case MTD_OOB_AUTO:
	case MTD_OOB_RAW:
		break;
L
Linus Torvalds 已提交
1683

1684 1685 1686
	default:
		goto out;
	}
L
Linus Torvalds 已提交
1687

1688 1689 1690 1691
	if (!ops->datbuf)
		ret = nand_do_read_oob(mtd, from, ops);
	else
		ret = nand_do_read_ops(mtd, from, ops);
1692

1693 1694 1695 1696
 out:
	nand_release_device(mtd);
	return ret;
}
1697

L
Linus Torvalds 已提交
1698

1699 1700 1701 1702 1703
/**
 * nand_write_page_raw - [Intern] raw page write function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
1704 1705
 *
 * Not for syndrome calculating ecc controllers, which use a special oob layout
1706 1707 1708 1709 1710 1711
 */
static void nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
				const uint8_t *buf)
{
	chip->write_buf(mtd, buf, mtd->writesize);
	chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
L
Linus Torvalds 已提交
1712 1713
}

1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751
/**
 * nand_write_page_raw_syndrome - [Intern] raw page write function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
 *
 * We need a special oob layout and handling even when ECC isn't checked.
 */
static void nand_write_page_raw_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
				const uint8_t *buf)
{
	int eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	uint8_t *oob = chip->oob_poi;
	int steps, size;

	for (steps = chip->ecc.steps; steps > 0; steps--) {
		chip->write_buf(mtd, buf, eccsize);
		buf += eccsize;

		if (chip->ecc.prepad) {
			chip->write_buf(mtd, oob, chip->ecc.prepad);
			oob += chip->ecc.prepad;
		}

		chip->read_buf(mtd, oob, eccbytes);
		oob += eccbytes;

		if (chip->ecc.postpad) {
			chip->write_buf(mtd, oob, chip->ecc.postpad);
			oob += chip->ecc.postpad;
		}
	}

	size = mtd->oobsize - (oob - chip->oob_poi);
	if (size)
		chip->write_buf(mtd, oob, size);
}
1752
/**
1753
 * nand_write_page_swecc - [REPLACABLE] software ecc based page write function
1754 1755 1756
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
1757
 */
1758 1759
static void nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
				  const uint8_t *buf)
1760
{
1761 1762 1763
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
1764
	uint8_t *ecc_calc = chip->buffers->ecccalc;
1765
	const uint8_t *p = buf;
1766
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1767

1768 1769 1770
	/* Software ecc calculation */
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1771

1772 1773
	for (i = 0; i < chip->ecc.total; i++)
		chip->oob_poi[eccpos[i]] = ecc_calc[i];
1774

1775
	chip->ecc.write_page_raw(mtd, chip, buf);
1776
}
1777

1778
/**
1779
 * nand_write_page_hwecc - [REPLACABLE] hardware ecc based page write function
1780 1781 1782 1783 1784 1785 1786 1787 1788 1789
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
 */
static void nand_write_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
				  const uint8_t *buf)
{
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
1790
	uint8_t *ecc_calc = chip->buffers->ecccalc;
1791
	const uint8_t *p = buf;
1792
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1793

1794 1795
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
1796
		chip->write_buf(mtd, p, eccsize);
1797
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1798 1799
	}

1800 1801 1802 1803
	for (i = 0; i < chip->ecc.total; i++)
		chip->oob_poi[eccpos[i]] = ecc_calc[i];

	chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
1804 1805
}

1806
/**
1807
 * nand_write_page_syndrome - [REPLACABLE] hardware ecc syndrom based page write
1808 1809 1810
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
L
Linus Torvalds 已提交
1811
 *
1812 1813 1814 1815 1816
 * The hw generator calculates the error syndrome automatically. Therefor
 * we need a special oob layout and handling.
 */
static void nand_write_page_syndrome(struct mtd_info *mtd,
				    struct nand_chip *chip, const uint8_t *buf)
L
Linus Torvalds 已提交
1817
{
1818 1819 1820 1821 1822
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	const uint8_t *p = buf;
	uint8_t *oob = chip->oob_poi;
L
Linus Torvalds 已提交
1823

1824
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
L
Linus Torvalds 已提交
1825

1826 1827
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
		chip->write_buf(mtd, p, eccsize);
1828

1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840
		if (chip->ecc.prepad) {
			chip->write_buf(mtd, oob, chip->ecc.prepad);
			oob += chip->ecc.prepad;
		}

		chip->ecc.calculate(mtd, p, oob);
		chip->write_buf(mtd, oob, eccbytes);
		oob += eccbytes;

		if (chip->ecc.postpad) {
			chip->write_buf(mtd, oob, chip->ecc.postpad);
			oob += chip->ecc.postpad;
L
Linus Torvalds 已提交
1841 1842
		}
	}
1843 1844

	/* Calculate remaining oob bytes */
1845
	i = mtd->oobsize - (oob - chip->oob_poi);
1846 1847 1848 1849 1850
	if (i)
		chip->write_buf(mtd, oob, i);
}

/**
1851
 * nand_write_page - [REPLACEABLE] write one page
1852 1853 1854 1855 1856
 * @mtd:	MTD device structure
 * @chip:	NAND chip descriptor
 * @buf:	the data to write
 * @page:	page number to write
 * @cached:	cached programming
1857
 * @raw:	use _raw version of write_page
1858 1859
 */
static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
1860
			   const uint8_t *buf, int page, int cached, int raw)
1861 1862 1863 1864 1865
{
	int status;

	chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0x00, page);

1866 1867 1868 1869
	if (unlikely(raw))
		chip->ecc.write_page_raw(mtd, chip, buf);
	else
		chip->ecc.write_page(mtd, chip, buf);
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879

	/*
	 * Cached progamming disabled for now, Not sure if its worth the
	 * trouble. The speed gain is not very impressive. (2.3->2.6Mib/s)
	 */
	cached = 0;

	if (!cached || !(chip->options & NAND_CACHEPRG)) {

		chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
1880
		status = chip->waitfunc(mtd, chip);
1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892
		/*
		 * See if operation failed and additional status checks are
		 * available
		 */
		if ((status & NAND_STATUS_FAIL) && (chip->errstat))
			status = chip->errstat(mtd, chip, FL_WRITING, status,
					       page);

		if (status & NAND_STATUS_FAIL)
			return -EIO;
	} else {
		chip->cmdfunc(mtd, NAND_CMD_CACHEDPROG, -1, -1);
1893
		status = chip->waitfunc(mtd, chip);
1894 1895 1896 1897 1898 1899 1900 1901 1902 1903
	}

#ifdef CONFIG_MTD_NAND_VERIFY_WRITE
	/* Send command to read back the data */
	chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);

	if (chip->verify_buf(mtd, buf, mtd->writesize))
		return -EIO;
#endif
	return 0;
L
Linus Torvalds 已提交
1904 1905
}

1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925
/**
 * nand_fill_oob - [Internal] Transfer client buffer to oob
 * @chip:	nand chip structure
 * @oob:	oob data buffer
 * @ops:	oob ops structure
 */
static uint8_t *nand_fill_oob(struct nand_chip *chip, uint8_t *oob,
				  struct mtd_oob_ops *ops)
{
	size_t len = ops->ooblen;

	switch(ops->mode) {

	case MTD_OOB_PLACE:
	case MTD_OOB_RAW:
		memcpy(chip->oob_poi + ops->ooboffs, oob, len);
		return oob + len;

	case MTD_OOB_AUTO: {
		struct nand_oobfree *free = chip->ecc.layout->oobfree;
1926 1927
		uint32_t boffs = 0, woffs = ops->ooboffs;
		size_t bytes = 0;
1928 1929

		for(; free->length && len; free++, len -= bytes) {
1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943
			/* Write request not from offset 0 ? */
			if (unlikely(woffs)) {
				if (woffs >= free->length) {
					woffs -= free->length;
					continue;
				}
				boffs = free->offset + woffs;
				bytes = min_t(size_t, len,
					      (free->length - woffs));
				woffs = 0;
			} else {
				bytes = min_t(size_t, len, free->length);
				boffs = free->offset;
			}
1944
			memcpy(chip->oob_poi + boffs, oob, bytes);
1945 1946 1947 1948 1949 1950 1951 1952 1953 1954
			oob += bytes;
		}
		return oob;
	}
	default:
		BUG();
	}
	return NULL;
}

1955
#define NOTALIGNED(x)	(x & (chip->subpagesize - 1)) != 0
L
Linus Torvalds 已提交
1956 1957

/**
1958
 * nand_do_write_ops - [Internal] NAND write with ECC
L
Linus Torvalds 已提交
1959 1960
 * @mtd:	MTD device structure
 * @to:		offset to write to
1961
 * @ops:	oob operations description structure
L
Linus Torvalds 已提交
1962 1963 1964
 *
 * NAND write with ECC
 */
1965 1966
static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1967
{
1968
	int chipnr, realpage, page, blockmask, column;
1969
	struct nand_chip *chip = mtd->priv;
1970 1971 1972
	uint32_t writelen = ops->len;
	uint8_t *oob = ops->oobbuf;
	uint8_t *buf = ops->datbuf;
1973
	int ret, subpage;
L
Linus Torvalds 已提交
1974

1975
	ops->retlen = 0;
1976 1977
	if (!writelen)
		return 0;
L
Linus Torvalds 已提交
1978

1979
	/* reject writes, which are not page aligned */
1980
	if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
1981 1982
		printk(KERN_NOTICE "%s: Attempt to write not "
				"page aligned data\n", __func__);
L
Linus Torvalds 已提交
1983 1984 1985
		return -EINVAL;
	}

1986 1987 1988 1989 1990
	column = to & (mtd->writesize - 1);
	subpage = column || (writelen & (mtd->writesize - 1));

	if (subpage && oob)
		return -EINVAL;
L
Linus Torvalds 已提交
1991

1992 1993 1994
	chipnr = (int)(to >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);

L
Linus Torvalds 已提交
1995 1996
	/* Check, if it is write protected */
	if (nand_check_wp(mtd))
1997
		return -EIO;
L
Linus Torvalds 已提交
1998

1999 2000 2001 2002 2003 2004
	realpage = (int)(to >> chip->page_shift);
	page = realpage & chip->pagemask;
	blockmask = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;

	/* Invalidate the page cache, when we write to the cached page */
	if (to <= (chip->pagebuf << chip->page_shift) &&
2005
	    (chip->pagebuf << chip->page_shift) < (to + ops->len))
2006
		chip->pagebuf = -1;
2007

2008 2009 2010
	/* If we're not given explicit OOB data, let it be 0xFF */
	if (likely(!oob))
		memset(chip->oob_poi, 0xff, mtd->oobsize);
2011

2012
	while(1) {
2013
		int bytes = mtd->writesize;
2014
		int cached = writelen > bytes && page != blockmask;
2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025
		uint8_t *wbuf = buf;

		/* Partial page write ? */
		if (unlikely(column || writelen < (mtd->writesize - 1))) {
			cached = 0;
			bytes = min_t(int, bytes - column, (int) writelen);
			chip->pagebuf = -1;
			memset(chip->buffers->databuf, 0xff, mtd->writesize);
			memcpy(&chip->buffers->databuf[column], buf, bytes);
			wbuf = chip->buffers->databuf;
		}
L
Linus Torvalds 已提交
2026

2027 2028 2029
		if (unlikely(oob))
			oob = nand_fill_oob(chip, oob, ops);

2030
		ret = chip->write_page(mtd, chip, wbuf, page, cached,
2031
				       (ops->mode == MTD_OOB_RAW));
2032 2033 2034 2035 2036 2037 2038
		if (ret)
			break;

		writelen -= bytes;
		if (!writelen)
			break;

2039
		column = 0;
2040 2041 2042 2043 2044 2045 2046 2047 2048
		buf += bytes;
		realpage++;

		page = realpage & chip->pagemask;
		/* Check, if we cross a chip boundary */
		if (!page) {
			chipnr++;
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2049 2050
		}
	}
2051 2052

	ops->retlen = ops->len - writelen;
2053 2054
	if (unlikely(oob))
		ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
2055 2056 2057
	return ret;
}

2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096
/**
 * panic_nand_write - [MTD Interface] NAND write with ECC
 * @mtd:	MTD device structure
 * @to:		offset to write to
 * @len:	number of bytes to write
 * @retlen:	pointer to variable to store the number of written bytes
 * @buf:	the data to write
 *
 * NAND write with ECC. Used when performing writes in interrupt context, this
 * may for example be called by mtdoops when writing an oops while in panic.
 */
static int panic_nand_write(struct mtd_info *mtd, loff_t to, size_t len,
			    size_t *retlen, const uint8_t *buf)
{
	struct nand_chip *chip = mtd->priv;
	int ret;

	/* Do not allow reads past end of device */
	if ((to + len) > mtd->size)
		return -EINVAL;
	if (!len)
		return 0;

	/* Wait for the device to get ready.  */
	panic_nand_wait(mtd, chip, 400);

	/* Grab the device.  */
	panic_nand_get_device(chip, mtd, FL_WRITING);

	chip->ops.len = len;
	chip->ops.datbuf = (uint8_t *)buf;
	chip->ops.oobbuf = NULL;

	ret = nand_do_write_ops(mtd, to, &chip->ops);

	*retlen = chip->ops.retlen;
	return ret;
}

2097
/**
2098
 * nand_write - [MTD Interface] NAND write with ECC
2099 2100 2101
 * @mtd:	MTD device structure
 * @to:		offset to write to
 * @len:	number of bytes to write
2102 2103
 * @retlen:	pointer to variable to store the number of written bytes
 * @buf:	the data to write
2104
 *
2105
 * NAND write with ECC
2106
 */
2107 2108
static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
			  size_t *retlen, const uint8_t *buf)
2109 2110 2111 2112
{
	struct nand_chip *chip = mtd->priv;
	int ret;

2113 2114
	/* Do not allow reads past end of device */
	if ((to + len) > mtd->size)
2115
		return -EINVAL;
2116 2117
	if (!len)
		return 0;
2118

2119
	nand_get_device(chip, mtd, FL_WRITING);
2120

2121 2122 2123
	chip->ops.len = len;
	chip->ops.datbuf = (uint8_t *)buf;
	chip->ops.oobbuf = NULL;
2124

2125
	ret = nand_do_write_ops(mtd, to, &chip->ops);
2126

R
Richard Purdie 已提交
2127 2128
	*retlen = chip->ops.retlen;

2129
	nand_release_device(mtd);
2130 2131

	return ret;
2132
}
2133

L
Linus Torvalds 已提交
2134
/**
2135
 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
L
Linus Torvalds 已提交
2136 2137
 * @mtd:	MTD device structure
 * @to:		offset to write to
2138
 * @ops:	oob operation description structure
L
Linus Torvalds 已提交
2139 2140 2141
 *
 * NAND write out-of-band
 */
2142 2143
static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
2144
{
2145
	int chipnr, page, status, len;
2146
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2147

2148 2149
	DEBUG(MTD_DEBUG_LEVEL3, "%s: to = 0x%08x, len = %i\n",
			 __func__, (unsigned int)to, (int)ops->ooblen);
L
Linus Torvalds 已提交
2150

2151 2152 2153 2154 2155
	if (ops->mode == MTD_OOB_AUTO)
		len = chip->ecc.layout->oobavail;
	else
		len = mtd->oobsize;

L
Linus Torvalds 已提交
2156
	/* Do not allow write past end of page */
2157
	if ((ops->ooboffs + ops->ooblen) > len) {
2158 2159
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to write "
				"past end of page\n", __func__);
L
Linus Torvalds 已提交
2160 2161 2162
		return -EINVAL;
	}

2163
	if (unlikely(ops->ooboffs >= len)) {
2164 2165
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to start "
				"write outside oob\n", __func__);
2166 2167 2168 2169 2170 2171 2172 2173
		return -EINVAL;
	}

	/* Do not allow reads past end of device */
	if (unlikely(to >= mtd->size ||
		     ops->ooboffs + ops->ooblen >
			((mtd->size >> chip->page_shift) -
			 (to >> chip->page_shift)) * len)) {
2174 2175
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt write beyond "
				"end of device\n", __func__);
2176 2177 2178
		return -EINVAL;
	}

2179
	chipnr = (int)(to >> chip->chip_shift);
2180
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2181

2182 2183 2184 2185 2186 2187 2188 2189 2190
	/* Shift to get page */
	page = (int)(to >> chip->page_shift);

	/*
	 * Reset the chip. Some chips (like the Toshiba TC5832DC found in one
	 * of my DiskOnChip 2000 test units) will clear the whole data page too
	 * if we don't do this. I have no clue why, but I seem to have 'fixed'
	 * it in the doc2000 driver in August 1999.  dwmw2.
	 */
2191
	chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
L
Linus Torvalds 已提交
2192 2193 2194

	/* Check, if it is write protected */
	if (nand_check_wp(mtd))
2195
		return -EROFS;
2196

L
Linus Torvalds 已提交
2197
	/* Invalidate the page cache, if we write to the cached page */
2198 2199
	if (page == chip->pagebuf)
		chip->pagebuf = -1;
L
Linus Torvalds 已提交
2200

2201 2202 2203 2204
	memset(chip->oob_poi, 0xff, mtd->oobsize);
	nand_fill_oob(chip, ops->oobbuf, ops);
	status = chip->ecc.write_oob(mtd, chip, page & chip->pagemask);
	memset(chip->oob_poi, 0xff, mtd->oobsize);
L
Linus Torvalds 已提交
2205

2206 2207
	if (status)
		return status;
L
Linus Torvalds 已提交
2208

2209
	ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
2210

2211
	return 0;
2212 2213 2214 2215 2216
}

/**
 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
2217
 * @to:		offset to write to
2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228
 * @ops:	oob operation description structure
 */
static int nand_write_oob(struct mtd_info *mtd, loff_t to,
			  struct mtd_oob_ops *ops)
{
	struct nand_chip *chip = mtd->priv;
	int ret = -ENOTSUPP;

	ops->retlen = 0;

	/* Do not allow writes past end of device */
2229
	if (ops->datbuf && (to + ops->len) > mtd->size) {
2230 2231
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt write beyond "
				"end of device\n", __func__);
2232 2233 2234
		return -EINVAL;
	}

2235
	nand_get_device(chip, mtd, FL_WRITING);
2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251

	switch(ops->mode) {
	case MTD_OOB_PLACE:
	case MTD_OOB_AUTO:
	case MTD_OOB_RAW:
		break;

	default:
		goto out;
	}

	if (!ops->datbuf)
		ret = nand_do_write_oob(mtd, to, ops);
	else
		ret = nand_do_write_ops(mtd, to, ops);

2252
 out:
L
Linus Torvalds 已提交
2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263
	nand_release_device(mtd);
	return ret;
}

/**
 * single_erease_cmd - [GENERIC] NAND standard block erase command function
 * @mtd:	MTD device structure
 * @page:	the page address of the block which will be erased
 *
 * Standard erase command for NAND chips
 */
2264
static void single_erase_cmd(struct mtd_info *mtd, int page)
L
Linus Torvalds 已提交
2265
{
2266
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2267
	/* Send commands to erase a block */
2268 2269
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
	chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
L
Linus Torvalds 已提交
2270 2271 2272 2273 2274 2275 2276 2277 2278 2279
}

/**
 * multi_erease_cmd - [GENERIC] AND specific block erase command function
 * @mtd:	MTD device structure
 * @page:	the page address of the block which will be erased
 *
 * AND multi block erase command function
 * Erase 4 consecutive blocks
 */
2280
static void multi_erase_cmd(struct mtd_info *mtd, int page)
L
Linus Torvalds 已提交
2281
{
2282
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2283
	/* Send commands to erase a block */
2284 2285 2286 2287 2288
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page++);
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
	chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
L
Linus Torvalds 已提交
2289 2290 2291 2292 2293 2294 2295 2296 2297
}

/**
 * nand_erase - [MTD Interface] erase block(s)
 * @mtd:	MTD device structure
 * @instr:	erase instruction
 *
 * Erase one ore more blocks
 */
2298
static int nand_erase(struct mtd_info *mtd, struct erase_info *instr)
L
Linus Torvalds 已提交
2299
{
2300
	return nand_erase_nand(mtd, instr, 0);
L
Linus Torvalds 已提交
2301
}
2302

2303
#define BBT_PAGE_MASK	0xffffff3f
L
Linus Torvalds 已提交
2304
/**
2305
 * nand_erase_nand - [Internal] erase block(s)
L
Linus Torvalds 已提交
2306 2307 2308 2309 2310 2311
 * @mtd:	MTD device structure
 * @instr:	erase instruction
 * @allowbbt:	allow erasing the bbt area
 *
 * Erase one ore more blocks
 */
2312 2313
int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
		    int allowbbt)
L
Linus Torvalds 已提交
2314
{
2315
	int page, status, pages_per_block, ret, chipnr;
2316
	struct nand_chip *chip = mtd->priv;
2317
	loff_t rewrite_bbt[NAND_MAX_CHIPS]={0};
2318
	unsigned int bbt_masked_page = 0xffffffff;
2319
	loff_t len;
L
Linus Torvalds 已提交
2320

2321 2322 2323
	DEBUG(MTD_DEBUG_LEVEL3, "%s: start = 0x%012llx, len = %llu\n",
				__func__, (unsigned long long)instr->addr,
				(unsigned long long)instr->len);
L
Linus Torvalds 已提交
2324

2325
	if (check_offs_len(mtd, instr->addr, instr->len))
L
Linus Torvalds 已提交
2326 2327
		return -EINVAL;

2328
	instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
L
Linus Torvalds 已提交
2329 2330

	/* Grab the lock and see if the device is available */
2331
	nand_get_device(chip, mtd, FL_ERASING);
L
Linus Torvalds 已提交
2332 2333

	/* Shift to get first page */
2334 2335
	page = (int)(instr->addr >> chip->page_shift);
	chipnr = (int)(instr->addr >> chip->chip_shift);
L
Linus Torvalds 已提交
2336 2337

	/* Calculate pages in each block */
2338
	pages_per_block = 1 << (chip->phys_erase_shift - chip->page_shift);
L
Linus Torvalds 已提交
2339 2340

	/* Select the NAND device */
2341
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2342 2343 2344

	/* Check, if it is write protected */
	if (nand_check_wp(mtd)) {
2345 2346
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Device is write protected!!!\n",
					__func__);
L
Linus Torvalds 已提交
2347 2348 2349 2350
		instr->state = MTD_ERASE_FAILED;
		goto erase_exit;
	}

2351 2352 2353 2354 2355 2356 2357 2358
	/*
	 * If BBT requires refresh, set the BBT page mask to see if the BBT
	 * should be rewritten. Otherwise the mask is set to 0xffffffff which
	 * can not be matched. This is also done when the bbt is actually
	 * erased to avoid recusrsive updates
	 */
	if (chip->options & BBT_AUTO_REFRESH && !allowbbt)
		bbt_masked_page = chip->bbt_td->pages[chipnr] & BBT_PAGE_MASK;
2359

L
Linus Torvalds 已提交
2360 2361 2362 2363 2364 2365
	/* Loop through the pages */
	len = instr->len;

	instr->state = MTD_ERASING;

	while (len) {
2366 2367 2368 2369 2370
		/*
		 * heck if we have a bad block, we do not erase bad blocks !
		 */
		if (nand_block_checkbad(mtd, ((loff_t) page) <<
					chip->page_shift, 0, allowbbt)) {
2371 2372
			printk(KERN_WARNING "%s: attempt to erase a bad block "
					"at page 0x%08x\n", __func__, page);
L
Linus Torvalds 已提交
2373 2374 2375
			instr->state = MTD_ERASE_FAILED;
			goto erase_exit;
		}
2376

2377 2378 2379 2380 2381 2382 2383
		/*
		 * Invalidate the page cache, if we erase the block which
		 * contains the current cached page
		 */
		if (page <= chip->pagebuf && chip->pagebuf <
		    (page + pages_per_block))
			chip->pagebuf = -1;
L
Linus Torvalds 已提交
2384

2385
		chip->erase_cmd(mtd, page & chip->pagemask);
2386

2387
		status = chip->waitfunc(mtd, chip);
L
Linus Torvalds 已提交
2388

2389 2390 2391 2392 2393 2394 2395
		/*
		 * See if operation failed and additional status checks are
		 * available
		 */
		if ((status & NAND_STATUS_FAIL) && (chip->errstat))
			status = chip->errstat(mtd, chip, FL_ERASING,
					       status, page);
2396

L
Linus Torvalds 已提交
2397
		/* See if block erase succeeded */
2398
		if (status & NAND_STATUS_FAIL) {
2399 2400
			DEBUG(MTD_DEBUG_LEVEL0, "%s: Failed erase, "
					"page 0x%08x\n", __func__, page);
L
Linus Torvalds 已提交
2401
			instr->state = MTD_ERASE_FAILED;
2402 2403
			instr->fail_addr =
				((loff_t)page << chip->page_shift);
L
Linus Torvalds 已提交
2404 2405
			goto erase_exit;
		}
2406

2407 2408 2409 2410 2411 2412
		/*
		 * If BBT requires refresh, set the BBT rewrite flag to the
		 * page being erased
		 */
		if (bbt_masked_page != 0xffffffff &&
		    (page & BBT_PAGE_MASK) == bbt_masked_page)
2413 2414
			    rewrite_bbt[chipnr] =
					((loff_t)page << chip->page_shift);
2415

L
Linus Torvalds 已提交
2416
		/* Increment page address and decrement length */
2417
		len -= (1 << chip->phys_erase_shift);
L
Linus Torvalds 已提交
2418 2419 2420
		page += pages_per_block;

		/* Check, if we cross a chip boundary */
2421
		if (len && !(page & chip->pagemask)) {
L
Linus Torvalds 已提交
2422
			chipnr++;
2423 2424
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
2425

2426 2427 2428 2429 2430 2431 2432 2433
			/*
			 * If BBT requires refresh and BBT-PERCHIP, set the BBT
			 * page mask to see if this BBT should be rewritten
			 */
			if (bbt_masked_page != 0xffffffff &&
			    (chip->bbt_td->options & NAND_BBT_PERCHIP))
				bbt_masked_page = chip->bbt_td->pages[chipnr] &
					BBT_PAGE_MASK;
L
Linus Torvalds 已提交
2434 2435 2436 2437
		}
	}
	instr->state = MTD_ERASE_DONE;

2438
 erase_exit:
L
Linus Torvalds 已提交
2439 2440 2441 2442 2443 2444

	ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;

	/* Deselect and wake up anyone waiting on the device */
	nand_release_device(mtd);

2445 2446 2447 2448
	/* Do call back function */
	if (!ret)
		mtd_erase_callback(instr);

2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459
	/*
	 * If BBT requires refresh and erase was successful, rewrite any
	 * selected bad block tables
	 */
	if (bbt_masked_page == 0xffffffff || ret)
		return ret;

	for (chipnr = 0; chipnr < chip->numchips; chipnr++) {
		if (!rewrite_bbt[chipnr])
			continue;
		/* update the BBT for chip */
2460 2461 2462
		DEBUG(MTD_DEBUG_LEVEL0, "%s: nand_update_bbt "
			"(%d:0x%0llx 0x%0x)\n", __func__, chipnr,
			rewrite_bbt[chipnr], chip->bbt_td->pages[chipnr]);
2463
		nand_update_bbt(mtd, rewrite_bbt[chipnr]);
2464 2465
	}

L
Linus Torvalds 已提交
2466 2467 2468 2469 2470 2471 2472 2473 2474 2475
	/* Return more or less happy */
	return ret;
}

/**
 * nand_sync - [MTD Interface] sync
 * @mtd:	MTD device structure
 *
 * Sync is actually a wait for chip ready function
 */
2476
static void nand_sync(struct mtd_info *mtd)
L
Linus Torvalds 已提交
2477
{
2478
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2479

2480
	DEBUG(MTD_DEBUG_LEVEL3, "%s: called\n", __func__);
L
Linus Torvalds 已提交
2481 2482

	/* Grab the lock and see if the device is available */
2483
	nand_get_device(chip, mtd, FL_SYNCING);
L
Linus Torvalds 已提交
2484
	/* Release it and go back */
2485
	nand_release_device(mtd);
L
Linus Torvalds 已提交
2486 2487 2488
}

/**
2489
 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
L
Linus Torvalds 已提交
2490
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
2491
 * @offs:	offset relative to mtd start
L
Linus Torvalds 已提交
2492
 */
2493
static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
L
Linus Torvalds 已提交
2494 2495
{
	/* Check for invalid offset */
2496
	if (offs > mtd->size)
L
Linus Torvalds 已提交
2497
		return -EINVAL;
2498

2499
	return nand_block_checkbad(mtd, offs, 1, 0);
L
Linus Torvalds 已提交
2500 2501 2502
}

/**
2503
 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
L
Linus Torvalds 已提交
2504 2505 2506
 * @mtd:	MTD device structure
 * @ofs:	offset relative to mtd start
 */
2507
static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
L
Linus Torvalds 已提交
2508
{
2509
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2510 2511
	int ret;

2512 2513
	if ((ret = nand_block_isbad(mtd, ofs))) {
		/* If it was bad already, return success and do nothing. */
L
Linus Torvalds 已提交
2514 2515
		if (ret > 0)
			return 0;
2516 2517
		return ret;
	}
L
Linus Torvalds 已提交
2518

2519
	return chip->block_markbad(mtd, ofs);
L
Linus Torvalds 已提交
2520 2521
}

2522 2523 2524 2525 2526 2527
/**
 * nand_suspend - [MTD Interface] Suspend the NAND flash
 * @mtd:	MTD device structure
 */
static int nand_suspend(struct mtd_info *mtd)
{
2528
	struct nand_chip *chip = mtd->priv;
2529

2530
	return nand_get_device(chip, mtd, FL_PM_SUSPENDED);
2531 2532 2533 2534 2535 2536 2537 2538
}

/**
 * nand_resume - [MTD Interface] Resume the NAND flash
 * @mtd:	MTD device structure
 */
static void nand_resume(struct mtd_info *mtd)
{
2539
	struct nand_chip *chip = mtd->priv;
2540

2541
	if (chip->state == FL_PM_SUSPENDED)
2542 2543
		nand_release_device(mtd);
	else
2544 2545
		printk(KERN_ERR "%s called for a chip which is not "
		       "in suspended state\n", __func__);
2546 2547
}

T
Thomas Gleixner 已提交
2548 2549 2550
/*
 * Set default functions
 */
2551
static void nand_set_defaults(struct nand_chip *chip, int busw)
T
Thomas Gleixner 已提交
2552
{
L
Linus Torvalds 已提交
2553
	/* check for proper chip_delay setup, set 20us if not */
2554 2555
	if (!chip->chip_delay)
		chip->chip_delay = 20;
L
Linus Torvalds 已提交
2556 2557

	/* check, if a user supplied command function given */
2558 2559
	if (chip->cmdfunc == NULL)
		chip->cmdfunc = nand_command;
L
Linus Torvalds 已提交
2560 2561

	/* check, if a user supplied wait function given */
2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582
	if (chip->waitfunc == NULL)
		chip->waitfunc = nand_wait;

	if (!chip->select_chip)
		chip->select_chip = nand_select_chip;
	if (!chip->read_byte)
		chip->read_byte = busw ? nand_read_byte16 : nand_read_byte;
	if (!chip->read_word)
		chip->read_word = nand_read_word;
	if (!chip->block_bad)
		chip->block_bad = nand_block_bad;
	if (!chip->block_markbad)
		chip->block_markbad = nand_default_block_markbad;
	if (!chip->write_buf)
		chip->write_buf = busw ? nand_write_buf16 : nand_write_buf;
	if (!chip->read_buf)
		chip->read_buf = busw ? nand_read_buf16 : nand_read_buf;
	if (!chip->verify_buf)
		chip->verify_buf = busw ? nand_verify_buf16 : nand_verify_buf;
	if (!chip->scan_bbt)
		chip->scan_bbt = nand_default_bbt;
2583 2584 2585 2586 2587 2588 2589

	if (!chip->controller) {
		chip->controller = &chip->hwcontrol;
		spin_lock_init(&chip->controller->lock);
		init_waitqueue_head(&chip->controller->wq);
	}

T
Thomas Gleixner 已提交
2590 2591 2592
}

/*
2593
 * Get the flash and manufacturer id and lookup if the type is supported
T
Thomas Gleixner 已提交
2594 2595
 */
static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
2596
						  struct nand_chip *chip,
T
Thomas Gleixner 已提交
2597 2598 2599 2600
						  int busw, int *maf_id)
{
	struct nand_flash_dev *type = NULL;
	int i, dev_id, maf_idx;
2601
	int tmp_id, tmp_manf;
L
Linus Torvalds 已提交
2602 2603

	/* Select the device */
2604
	chip->select_chip(mtd, 0);
L
Linus Torvalds 已提交
2605

2606 2607 2608 2609 2610 2611
	/*
	 * Reset the chip, required by some chips (e.g. Micron MT29FxGxxxxx)
	 * after power-up
	 */
	chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);

L
Linus Torvalds 已提交
2612
	/* Send the command for reading device ID */
2613
	chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
L
Linus Torvalds 已提交
2614 2615

	/* Read manufacturer and device IDs */
2616 2617
	*maf_id = chip->read_byte(mtd);
	dev_id = chip->read_byte(mtd);
L
Linus Torvalds 已提交
2618

2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638
	/* Try again to make sure, as some systems the bus-hold or other
	 * interface concerns can cause random data which looks like a
	 * possibly credible NAND flash to appear. If the two results do
	 * not match, ignore the device completely.
	 */

	chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);

	/* Read manufacturer and device IDs */

	tmp_manf = chip->read_byte(mtd);
	tmp_id = chip->read_byte(mtd);

	if (tmp_manf != *maf_id || tmp_id != dev_id) {
		printk(KERN_INFO "%s: second ID read did not match "
		       "%02x,%02x against %02x,%02x\n", __func__,
		       *maf_id, dev_id, tmp_manf, tmp_id);
		return ERR_PTR(-ENODEV);
	}

T
Thomas Gleixner 已提交
2639
	/* Lookup the flash id */
L
Linus Torvalds 已提交
2640
	for (i = 0; nand_flash_ids[i].name != NULL; i++) {
T
Thomas Gleixner 已提交
2641 2642 2643 2644 2645
		if (dev_id == nand_flash_ids[i].id) {
			type =  &nand_flash_ids[i];
			break;
		}
	}
2646

T
Thomas Gleixner 已提交
2647 2648 2649
	if (!type)
		return ERR_PTR(-ENODEV);

2650 2651 2652
	if (!mtd->name)
		mtd->name = type->name;

2653
	chip->chipsize = (uint64_t)type->chipsize << 20;
T
Thomas Gleixner 已提交
2654 2655

	/* Newer devices have all the information in additional id bytes */
2656
	if (!type->pagesize) {
T
Thomas Gleixner 已提交
2657
		int extid;
2658 2659
		/* The 3rd id byte holds MLC / multichip data */
		chip->cellinfo = chip->read_byte(mtd);
T
Thomas Gleixner 已提交
2660
		/* The 4th id byte is the important one */
2661
		extid = chip->read_byte(mtd);
T
Thomas Gleixner 已提交
2662
		/* Calc pagesize */
2663
		mtd->writesize = 1024 << (extid & 0x3);
T
Thomas Gleixner 已提交
2664 2665
		extid >>= 2;
		/* Calc oobsize */
2666
		mtd->oobsize = (8 << (extid & 0x01)) * (mtd->writesize >> 9);
T
Thomas Gleixner 已提交
2667 2668 2669 2670 2671 2672
		extid >>= 2;
		/* Calc blocksize. Blocksize is multiples of 64KiB */
		mtd->erasesize = (64 * 1024) << (extid & 0x03);
		extid >>= 2;
		/* Get buswidth information */
		busw = (extid & 0x01) ? NAND_BUSWIDTH_16 : 0;
2673

T
Thomas Gleixner 已提交
2674 2675
	} else {
		/*
2676
		 * Old devices have chip data hardcoded in the device id table
T
Thomas Gleixner 已提交
2677
		 */
2678 2679
		mtd->erasesize = type->erasesize;
		mtd->writesize = type->pagesize;
2680
		mtd->oobsize = mtd->writesize / 32;
2681
		busw = type->options & NAND_BUSWIDTH_16;
T
Thomas Gleixner 已提交
2682
	}
L
Linus Torvalds 已提交
2683

T
Thomas Gleixner 已提交
2684
	/* Try to identify manufacturer */
2685
	for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
T
Thomas Gleixner 已提交
2686 2687 2688
		if (nand_manuf_ids[maf_idx].id == *maf_id)
			break;
	}
2689

T
Thomas Gleixner 已提交
2690 2691
	/*
	 * Check, if buswidth is correct. Hardware drivers should set
2692
	 * chip correct !
T
Thomas Gleixner 已提交
2693
	 */
2694
	if (busw != (chip->options & NAND_BUSWIDTH_16)) {
T
Thomas Gleixner 已提交
2695 2696 2697 2698
		printk(KERN_INFO "NAND device: Manufacturer ID:"
		       " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id,
		       dev_id, nand_manuf_ids[maf_idx].name, mtd->name);
		printk(KERN_WARNING "NAND bus width %d instead %d bit\n",
2699
		       (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
T
Thomas Gleixner 已提交
2700 2701 2702
		       busw ? 16 : 8);
		return ERR_PTR(-EINVAL);
	}
2703

T
Thomas Gleixner 已提交
2704
	/* Calculate the address shift from the page size */
2705
	chip->page_shift = ffs(mtd->writesize) - 1;
T
Thomas Gleixner 已提交
2706
	/* Convert chipsize to number of pages per chip -1. */
2707
	chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
2708

2709
	chip->bbt_erase_shift = chip->phys_erase_shift =
T
Thomas Gleixner 已提交
2710
		ffs(mtd->erasesize) - 1;
2711 2712 2713 2714
	if (chip->chipsize & 0xffffffff)
		chip->chip_shift = ffs((unsigned)chip->chipsize) - 1;
	else
		chip->chip_shift = ffs((unsigned)(chip->chipsize >> 32)) + 32 - 1;
L
Linus Torvalds 已提交
2715

T
Thomas Gleixner 已提交
2716
	/* Set the bad block position */
2717
	chip->badblockpos = mtd->writesize > 512 ?
T
Thomas Gleixner 已提交
2718
		NAND_LARGE_BADBLOCK_POS : NAND_SMALL_BADBLOCK_POS;
2719

T
Thomas Gleixner 已提交
2720
	/* Get chip options, preserve non chip based options */
2721
	chip->options &= ~NAND_CHIPOPTIONS_MSK;
2722
	chip->options |= type->options & NAND_CHIPOPTIONS_MSK;
T
Thomas Gleixner 已提交
2723 2724

	/*
2725
	 * Set chip as a default. Board drivers can override it, if necessary
T
Thomas Gleixner 已提交
2726
	 */
2727
	chip->options |= NAND_NO_AUTOINCR;
T
Thomas Gleixner 已提交
2728

2729
	/* Check if chip is a not a samsung device. Do not clear the
T
Thomas Gleixner 已提交
2730 2731
	 * options for chips which are not having an extended id.
	 */
2732
	if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
2733
		chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
T
Thomas Gleixner 已提交
2734 2735

	/* Check for AND chips with 4 page planes */
2736 2737
	if (chip->options & NAND_4PAGE_ARRAY)
		chip->erase_cmd = multi_erase_cmd;
T
Thomas Gleixner 已提交
2738
	else
2739
		chip->erase_cmd = single_erase_cmd;
T
Thomas Gleixner 已提交
2740 2741

	/* Do not replace user supplied command function ! */
2742 2743
	if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
		chip->cmdfunc = nand_command_lp;
T
Thomas Gleixner 已提交
2744 2745 2746 2747 2748 2749 2750 2751 2752

	printk(KERN_INFO "NAND device: Manufacturer ID:"
	       " 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id, dev_id,
	       nand_manuf_ids[maf_idx].name, type->name);

	return type;
}

/**
2753 2754 2755
 * nand_scan_ident - [NAND Interface] Scan for the NAND device
 * @mtd:	     MTD device structure
 * @maxchips:	     Number of chips to scan for
T
Thomas Gleixner 已提交
2756
 *
2757 2758
 * This is the first phase of the normal nand_scan() function. It
 * reads the flash ID and sets up MTD fields accordingly.
T
Thomas Gleixner 已提交
2759
 *
2760
 * The mtd->owner field must be set to the module of the caller.
T
Thomas Gleixner 已提交
2761
 */
2762
int nand_scan_ident(struct mtd_info *mtd, int maxchips)
T
Thomas Gleixner 已提交
2763 2764
{
	int i, busw, nand_maf_id;
2765
	struct nand_chip *chip = mtd->priv;
T
Thomas Gleixner 已提交
2766 2767 2768
	struct nand_flash_dev *type;

	/* Get buswidth to select the correct functions */
2769
	busw = chip->options & NAND_BUSWIDTH_16;
T
Thomas Gleixner 已提交
2770
	/* Set the default functions */
2771
	nand_set_defaults(chip, busw);
T
Thomas Gleixner 已提交
2772 2773

	/* Read the flash type */
2774
	type = nand_get_flash_type(mtd, chip, busw, &nand_maf_id);
T
Thomas Gleixner 已提交
2775 2776

	if (IS_ERR(type)) {
2777 2778
		if (!(chip->options & NAND_SCAN_SILENT_NODEV))
			printk(KERN_WARNING "No NAND device found.\n");
2779
		chip->select_chip(mtd, -1);
T
Thomas Gleixner 已提交
2780
		return PTR_ERR(type);
L
Linus Torvalds 已提交
2781 2782
	}

T
Thomas Gleixner 已提交
2783
	/* Check for a chip array */
2784
	for (i = 1; i < maxchips; i++) {
2785
		chip->select_chip(mtd, i);
2786 2787
		/* See comment in nand_get_flash_type for reset */
		chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
L
Linus Torvalds 已提交
2788
		/* Send the command for reading device ID */
2789
		chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
L
Linus Torvalds 已提交
2790
		/* Read manufacturer and device IDs */
2791 2792
		if (nand_maf_id != chip->read_byte(mtd) ||
		    type->id != chip->read_byte(mtd))
L
Linus Torvalds 已提交
2793 2794 2795 2796
			break;
	}
	if (i > 1)
		printk(KERN_INFO "%d NAND chips detected\n", i);
2797

L
Linus Torvalds 已提交
2798
	/* Store the number of chips and calc total size for mtd */
2799 2800
	chip->numchips = i;
	mtd->size = i * chip->chipsize;
T
Thomas Gleixner 已提交
2801

2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818
	return 0;
}


/**
 * nand_scan_tail - [NAND Interface] Scan for the NAND device
 * @mtd:	    MTD device structure
 *
 * This is the second phase of the normal nand_scan() function. It
 * fills out all the uninitialized function pointers with the defaults
 * and scans for a bad block table if appropriate.
 */
int nand_scan_tail(struct mtd_info *mtd)
{
	int i;
	struct nand_chip *chip = mtd->priv;

2819 2820 2821 2822 2823
	if (!(chip->options & NAND_OWN_BUFFERS))
		chip->buffers = kmalloc(sizeof(*chip->buffers), GFP_KERNEL);
	if (!chip->buffers)
		return -ENOMEM;

2824
	/* Set the internal oob buffer location, just after the page data */
2825
	chip->oob_poi = chip->buffers->databuf + mtd->writesize;
L
Linus Torvalds 已提交
2826

T
Thomas Gleixner 已提交
2827 2828 2829
	/*
	 * If no default placement scheme is given, select an appropriate one
	 */
2830
	if (!chip->ecc.layout) {
2831
		switch (mtd->oobsize) {
L
Linus Torvalds 已提交
2832
		case 8:
2833
			chip->ecc.layout = &nand_oob_8;
L
Linus Torvalds 已提交
2834 2835
			break;
		case 16:
2836
			chip->ecc.layout = &nand_oob_16;
L
Linus Torvalds 已提交
2837 2838
			break;
		case 64:
2839
			chip->ecc.layout = &nand_oob_64;
L
Linus Torvalds 已提交
2840
			break;
2841 2842 2843
		case 128:
			chip->ecc.layout = &nand_oob_128;
			break;
L
Linus Torvalds 已提交
2844
		default:
T
Thomas Gleixner 已提交
2845 2846
			printk(KERN_WARNING "No oob scheme defined for "
			       "oobsize %d\n", mtd->oobsize);
L
Linus Torvalds 已提交
2847 2848 2849
			BUG();
		}
	}
2850

2851 2852 2853
	if (!chip->write_page)
		chip->write_page = nand_write_page;

2854
	/*
T
Thomas Gleixner 已提交
2855 2856
	 * check ECC mode, default to software if 3byte/512byte hardware ECC is
	 * selected and we have 256 byte pagesize fallback to software ECC
2857
	 */
2858

2859
	switch (chip->ecc.mode) {
2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870
	case NAND_ECC_HW_OOB_FIRST:
		/* Similar to NAND_ECC_HW, but a separate read_page handle */
		if (!chip->ecc.calculate || !chip->ecc.correct ||
		     !chip->ecc.hwctl) {
			printk(KERN_WARNING "No ECC functions supplied; "
			       "Hardware ECC not possible\n");
			BUG();
		}
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_hwecc_oob_first;

T
Thomas Gleixner 已提交
2871
	case NAND_ECC_HW:
2872 2873 2874
		/* Use standard hwecc read page function ? */
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_hwecc;
2875 2876
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_hwecc;
2877 2878 2879 2880
		if (!chip->ecc.read_page_raw)
			chip->ecc.read_page_raw = nand_read_page_raw;
		if (!chip->ecc.write_page_raw)
			chip->ecc.write_page_raw = nand_write_page_raw;
2881 2882 2883 2884
		if (!chip->ecc.read_oob)
			chip->ecc.read_oob = nand_read_oob_std;
		if (!chip->ecc.write_oob)
			chip->ecc.write_oob = nand_write_oob_std;
2885

T
Thomas Gleixner 已提交
2886
	case NAND_ECC_HW_SYNDROME:
2887 2888 2889
		if ((!chip->ecc.calculate || !chip->ecc.correct ||
		     !chip->ecc.hwctl) &&
		    (!chip->ecc.read_page ||
2890
		     chip->ecc.read_page == nand_read_page_hwecc ||
2891
		     !chip->ecc.write_page ||
2892
		     chip->ecc.write_page == nand_write_page_hwecc)) {
2893
			printk(KERN_WARNING "No ECC functions supplied; "
T
Thomas Gleixner 已提交
2894 2895 2896
			       "Hardware ECC not possible\n");
			BUG();
		}
2897
		/* Use standard syndrome read/write page function ? */
2898 2899
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_syndrome;
2900 2901
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_syndrome;
2902 2903 2904 2905
		if (!chip->ecc.read_page_raw)
			chip->ecc.read_page_raw = nand_read_page_raw_syndrome;
		if (!chip->ecc.write_page_raw)
			chip->ecc.write_page_raw = nand_write_page_raw_syndrome;
2906 2907 2908 2909
		if (!chip->ecc.read_oob)
			chip->ecc.read_oob = nand_read_oob_syndrome;
		if (!chip->ecc.write_oob)
			chip->ecc.write_oob = nand_write_oob_syndrome;
2910

2911
		if (mtd->writesize >= chip->ecc.size)
T
Thomas Gleixner 已提交
2912 2913 2914
			break;
		printk(KERN_WARNING "%d byte HW ECC not possible on "
		       "%d byte page size, fallback to SW ECC\n",
2915 2916
		       chip->ecc.size, mtd->writesize);
		chip->ecc.mode = NAND_ECC_SOFT;
2917

T
Thomas Gleixner 已提交
2918
	case NAND_ECC_SOFT:
2919 2920
		chip->ecc.calculate = nand_calculate_ecc;
		chip->ecc.correct = nand_correct_data;
2921
		chip->ecc.read_page = nand_read_page_swecc;
2922
		chip->ecc.read_subpage = nand_read_subpage;
2923
		chip->ecc.write_page = nand_write_page_swecc;
2924 2925
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
2926 2927
		chip->ecc.read_oob = nand_read_oob_std;
		chip->ecc.write_oob = nand_write_oob_std;
2928 2929
		if (!chip->ecc.size)
			chip->ecc.size = 256;
2930
		chip->ecc.bytes = 3;
L
Linus Torvalds 已提交
2931
		break;
2932 2933

	case NAND_ECC_NONE:
T
Thomas Gleixner 已提交
2934 2935
		printk(KERN_WARNING "NAND_ECC_NONE selected by board driver. "
		       "This is not recommended !!\n");
2936 2937
		chip->ecc.read_page = nand_read_page_raw;
		chip->ecc.write_page = nand_write_page_raw;
2938
		chip->ecc.read_oob = nand_read_oob_std;
2939 2940
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
2941
		chip->ecc.write_oob = nand_write_oob_std;
2942 2943
		chip->ecc.size = mtd->writesize;
		chip->ecc.bytes = 0;
L
Linus Torvalds 已提交
2944
		break;
2945

L
Linus Torvalds 已提交
2946
	default:
T
Thomas Gleixner 已提交
2947
		printk(KERN_WARNING "Invalid NAND_ECC_MODE %d\n",
2948
		       chip->ecc.mode);
2949
		BUG();
L
Linus Torvalds 已提交
2950
	}
2951

2952 2953 2954 2955 2956
	/*
	 * The number of bytes available for a client to place data into
	 * the out of band area
	 */
	chip->ecc.layout->oobavail = 0;
2957 2958
	for (i = 0; chip->ecc.layout->oobfree[i].length
			&& i < ARRAY_SIZE(chip->ecc.layout->oobfree); i++)
2959 2960
		chip->ecc.layout->oobavail +=
			chip->ecc.layout->oobfree[i].length;
V
Vitaly Wool 已提交
2961
	mtd->oobavail = chip->ecc.layout->oobavail;
2962

T
Thomas Gleixner 已提交
2963 2964 2965 2966
	/*
	 * Set the number of read / write steps for one page depending on ECC
	 * mode
	 */
2967 2968
	chip->ecc.steps = mtd->writesize / chip->ecc.size;
	if(chip->ecc.steps * chip->ecc.size != mtd->writesize) {
T
Thomas Gleixner 已提交
2969 2970
		printk(KERN_WARNING "Invalid ecc parameters\n");
		BUG();
L
Linus Torvalds 已提交
2971
	}
2972
	chip->ecc.total = chip->ecc.steps * chip->ecc.bytes;
2973

2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985
	/*
	 * Allow subpage writes up to ecc.steps. Not possible for MLC
	 * FLASH.
	 */
	if (!(chip->options & NAND_NO_SUBPAGE_WRITE) &&
	    !(chip->cellinfo & NAND_CI_CELLTYPE_MSK)) {
		switch(chip->ecc.steps) {
		case 2:
			mtd->subpage_sft = 1;
			break;
		case 4:
		case 8:
2986
		case 16:
2987 2988 2989 2990 2991 2992
			mtd->subpage_sft = 2;
			break;
		}
	}
	chip->subpagesize = mtd->writesize >> mtd->subpage_sft;

2993
	/* Initialize state */
2994
	chip->state = FL_READY;
L
Linus Torvalds 已提交
2995 2996

	/* De-select the device */
2997
	chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
2998 2999

	/* Invalidate the pagebuffer reference */
3000
	chip->pagebuf = -1;
L
Linus Torvalds 已提交
3001 3002 3003

	/* Fill in remaining MTD driver data */
	mtd->type = MTD_NANDFLASH;
J
Joern Engel 已提交
3004
	mtd->flags = MTD_CAP_NANDFLASH;
L
Linus Torvalds 已提交
3005 3006 3007 3008 3009
	mtd->erase = nand_erase;
	mtd->point = NULL;
	mtd->unpoint = NULL;
	mtd->read = nand_read;
	mtd->write = nand_write;
3010
	mtd->panic_write = panic_nand_write;
L
Linus Torvalds 已提交
3011 3012 3013 3014 3015
	mtd->read_oob = nand_read_oob;
	mtd->write_oob = nand_write_oob;
	mtd->sync = nand_sync;
	mtd->lock = NULL;
	mtd->unlock = NULL;
3016 3017
	mtd->suspend = nand_suspend;
	mtd->resume = nand_resume;
L
Linus Torvalds 已提交
3018 3019 3020
	mtd->block_isbad = nand_block_isbad;
	mtd->block_markbad = nand_block_markbad;

3021 3022
	/* propagate ecc.layout to mtd_info */
	mtd->ecclayout = chip->ecc.layout;
L
Linus Torvalds 已提交
3023

3024
	/* Check, if we should skip the bad block table scan */
3025
	if (chip->options & NAND_SKIP_BBTSCAN)
3026
		return 0;
L
Linus Torvalds 已提交
3027 3028

	/* Build bad block table */
3029
	return chip->scan_bbt(mtd);
L
Linus Torvalds 已提交
3030 3031
}

3032
/* is_module_text_address() isn't exported, and it's mostly a pointless
3033 3034 3035 3036 3037 3038
   test if this is a module _anyway_ -- they'd have to try _really_ hard
   to call us from in-kernel code if the core NAND support is modular. */
#ifdef MODULE
#define caller_is_module() (1)
#else
#define caller_is_module() \
3039
	is_module_text_address((unsigned long)__builtin_return_address(0))
3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059
#endif

/**
 * nand_scan - [NAND Interface] Scan for the NAND device
 * @mtd:	MTD device structure
 * @maxchips:	Number of chips to scan for
 *
 * This fills out all the uninitialized function pointers
 * with the defaults.
 * The flash ID is read and the mtd/chip structures are
 * filled with the appropriate values.
 * The mtd->owner field must be set to the module of the caller
 *
 */
int nand_scan(struct mtd_info *mtd, int maxchips)
{
	int ret;

	/* Many callers got this wrong, so check for it for a while... */
	if (!mtd->owner && caller_is_module()) {
3060 3061
		printk(KERN_CRIT "%s called with NULL mtd->owner!\n",
				__func__);
3062 3063 3064 3065 3066 3067 3068 3069 3070
		BUG();
	}

	ret = nand_scan_ident(mtd, maxchips);
	if (!ret)
		ret = nand_scan_tail(mtd);
	return ret;
}

L
Linus Torvalds 已提交
3071
/**
3072
 * nand_release - [NAND Interface] Free resources held by the NAND device
L
Linus Torvalds 已提交
3073 3074
 * @mtd:	MTD device structure
*/
3075
void nand_release(struct mtd_info *mtd)
L
Linus Torvalds 已提交
3076
{
3077
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
3078 3079 3080

#ifdef CONFIG_MTD_PARTITIONS
	/* Deregister partitions */
3081
	del_mtd_partitions(mtd);
L
Linus Torvalds 已提交
3082 3083
#endif
	/* Deregister the device */
3084
	del_mtd_device(mtd);
L
Linus Torvalds 已提交
3085

J
Jesper Juhl 已提交
3086
	/* Free bad block table memory */
3087
	kfree(chip->bbt);
3088 3089
	if (!(chip->options & NAND_OWN_BUFFERS))
		kfree(chip->buffers);
L
Linus Torvalds 已提交
3090 3091
}

3092
EXPORT_SYMBOL_GPL(nand_scan);
3093 3094
EXPORT_SYMBOL_GPL(nand_scan_ident);
EXPORT_SYMBOL_GPL(nand_scan_tail);
3095
EXPORT_SYMBOL_GPL(nand_release);
3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110

static int __init nand_base_init(void)
{
	led_trigger_register_simple("nand-disk", &nand_led_trigger);
	return 0;
}

static void __exit nand_base_exit(void)
{
	led_trigger_unregister_simple(nand_led_trigger);
}

module_init(nand_base_init);
module_exit(nand_base_exit);

3111 3112 3113
MODULE_LICENSE("GPL");
MODULE_AUTHOR("Steven J. Hill <sjhill@realitydiluted.com>, Thomas Gleixner <tglx@linutronix.de>");
MODULE_DESCRIPTION("Generic NAND flash driver code");