nand_base.c 83.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
		if (chip->controller->active->state == FL_PM_SUSPENDED) {
			chip->state = FL_PM_SUSPENDED;
			spin_unlock(lock);
			return 0;
		}
777 778 779 780 781 782
	}
	set_current_state(TASK_UNINTERRUPTIBLE);
	add_wait_queue(wq, &wait);
	spin_unlock(lock);
	schedule();
	remove_wait_queue(wq, &wait);
L
Linus Torvalds 已提交
783 784 785
	goto retry;
}

786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811
/**
 * 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 已提交
812 813 814
/**
 * nand_wait - [DEFAULT]  wait until the command is done
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
815
 * @chip:	NAND chip structure
L
Linus Torvalds 已提交
816 817
 *
 * Wait for command done. This applies to erase and program only
818
 * Erase can take up to 400ms and program up to 20ms according to
L
Linus Torvalds 已提交
819
 * general NAND and SmartMedia specs
R
Randy Dunlap 已提交
820
 */
821
static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
L
Linus Torvalds 已提交
822 823
{

824
	unsigned long timeo = jiffies;
825
	int status, state = chip->state;
826

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

832 833
	led_trigger_event(nand_led_trigger, LED_FULL);

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

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

843 844 845 846 847 848 849 850 851 852 853 854
	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 已提交
855 856
		}
	}
857 858
	led_trigger_event(nand_led_trigger, LED_OFF);

859
	status = (int)chip->read_byte(mtd);
L
Linus Torvalds 已提交
860 861 862
	return status;
}

863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 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 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 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
/**
 * __nand_unlock - [REPLACABLE] unlocks specified locked blockes
 *
 * @param mtd - mtd info
 * @param ofs - offset to start unlock from
 * @param len - length to unlock
 * @invert -  when = 0, unlock the range of blocks within the lower and
 *                      upper boundary address
 *            whne = 1, unlock the range of blocks outside the boundaries
 *                      of the lower and upper boundary address
 *
 * @return - unlock status
 */
static int __nand_unlock(struct mtd_info *mtd, loff_t ofs,
					uint64_t len, int invert)
{
	int ret = 0;
	int status, page;
	struct nand_chip *chip = mtd->priv;

	/* Submit address of first page to unlock */
	page = ofs >> chip->page_shift;
	chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);

	/* Submit address of last page to unlock */
	page = (ofs + len) >> chip->page_shift;
	chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1,
				(page | invert) & chip->pagemask);

	/* Call wait ready function */
	status = chip->waitfunc(mtd, chip);
	udelay(1000);
	/* See if device thinks it succeeded */
	if (status & 0x01) {
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Error status = 0x%08x\n",
					__func__, status);
		ret = -EIO;
	}

	return ret;
}

/**
 * nand_unlock - [REPLACABLE] unlocks specified locked blockes
 *
 * @param mtd - mtd info
 * @param ofs - offset to start unlock from
 * @param len - length to unlock
 *
 * @return - unlock status
 */
int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
{
	int ret = 0;
	int chipnr;
	struct nand_chip *chip = mtd->priv;

	DEBUG(MTD_DEBUG_LEVEL3, "%s: start = 0x%012llx, len = %llu\n",
			__func__, (unsigned long long)ofs, len);

	if (check_offs_len(mtd, ofs, len))
		ret = -EINVAL;

	/* Align to last block address if size addresses end of the device */
	if (ofs + len == mtd->size)
		len -= mtd->erasesize;

	nand_get_device(chip, mtd, FL_UNLOCKING);

	/* Shift to get chip number */
	chipnr = ofs >> chip->chip_shift;

	chip->select_chip(mtd, chipnr);

	/* Check, if it is write protected */
	if (nand_check_wp(mtd)) {
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Device is write protected!!!\n",
					__func__);
		ret = -EIO;
		goto out;
	}

	ret = __nand_unlock(mtd, ofs, len, 0);

out:
	/* de-select the NAND device */
	chip->select_chip(mtd, -1);

	nand_release_device(mtd);

	return ret;
}

/**
 * nand_lock - [REPLACABLE] locks all blockes present in the device
 *
 * @param mtd - mtd info
 * @param ofs - offset to start unlock from
 * @param len - length to unlock
 *
 * @return - lock status
 *
 * This feature is not support in many NAND parts. 'Micron' NAND parts
 * do have this feature, but it allows only to lock all blocks not for
 * specified range for block.
 *
 * Implementing 'lock' feature by making use of 'unlock', for now.
 */
int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
{
	int ret = 0;
	int chipnr, status, page;
	struct nand_chip *chip = mtd->priv;

	DEBUG(MTD_DEBUG_LEVEL3, "%s: start = 0x%012llx, len = %llu\n",
			__func__, (unsigned long long)ofs, len);

	if (check_offs_len(mtd, ofs, len))
		ret = -EINVAL;

	nand_get_device(chip, mtd, FL_LOCKING);

	/* Shift to get chip number */
	chipnr = ofs >> chip->chip_shift;

	chip->select_chip(mtd, chipnr);

	/* Check, if it is write protected */
	if (nand_check_wp(mtd)) {
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Device is write protected!!!\n",
					__func__);
		status = MTD_ERASE_FAILED;
		ret = -EIO;
		goto out;
	}

	/* Submit address of first page to lock */
	page = ofs >> chip->page_shift;
	chip->cmdfunc(mtd, NAND_CMD_LOCK, -1, page & chip->pagemask);

	/* Call wait ready function */
	status = chip->waitfunc(mtd, chip);
	udelay(1000);
	/* See if device thinks it succeeded */
	if (status & 0x01) {
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Error status = 0x%08x\n",
					__func__, status);
		ret = -EIO;
		goto out;
	}

	ret = __nand_unlock(mtd, ofs, len, 0x1);

out:
	/* de-select the NAND device */
	chip->select_chip(mtd, -1);

	nand_release_device(mtd);

	return ret;
}

1025 1026 1027 1028 1029
/**
 * 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
1030
 * @page:	page number to read
1031 1032
 *
 * Not for syndrome calculating ecc controllers, which use a special oob layout
1033 1034
 */
static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1035
			      uint8_t *buf, int page)
1036 1037 1038 1039 1040 1041
{
	chip->read_buf(mtd, buf, mtd->writesize);
	chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
	return 0;
}

1042 1043 1044 1045 1046
/**
 * 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
1047
 * @page:	page number to read
1048 1049 1050 1051
 *
 * 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,
1052
			      uint8_t *buf, int page)
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
{
	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 已提交
1084
/**
1085
 * nand_read_page_swecc - [REPLACABLE] software ecc based page read function
1086 1087 1088
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
1089
 * @page:	page number to read
1090
 */
1091
static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
1092
				uint8_t *buf, int page)
L
Linus Torvalds 已提交
1093
{
1094 1095 1096 1097
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1098 1099
	uint8_t *ecc_calc = chip->buffers->ecccalc;
	uint8_t *ecc_code = chip->buffers->ecccode;
1100
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1101

1102
	chip->ecc.read_page_raw(mtd, chip, buf, page);
1103 1104 1105 1106 1107

	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++)
1108
		ecc_code[i] = chip->oob_poi[eccpos[i]];
1109 1110 1111 1112 1113 1114 1115 1116

	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]);
1117
		if (stat < 0)
1118 1119 1120 1121 1122
			mtd->ecc_stats.failed++;
		else
			mtd->ecc_stats.corrected += stat;
	}
	return 0;
1123
}
L
Linus Torvalds 已提交
1124

1125 1126 1127 1128
/**
 * nand_read_subpage - [REPLACABLE] software ecc based sub-page read function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
1129 1130 1131
 * @data_offs:	offset of requested data within the page
 * @readlen:	data length
 * @bufpoi:	buffer to store read data
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
 */
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;
}

1206
/**
1207
 * nand_read_page_hwecc - [REPLACABLE] hardware ecc based page read function
1208 1209 1210
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
1211
 * @page:	page number to read
1212
 *
1213
 * Not for syndrome calculating ecc controllers which need a special oob layout
1214
 */
1215
static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
1216
				uint8_t *buf, int page)
L
Linus Torvalds 已提交
1217
{
1218 1219 1220 1221
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1222 1223
	uint8_t *ecc_calc = chip->buffers->ecccalc;
	uint8_t *ecc_code = chip->buffers->ecccode;
1224
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1225 1226 1227 1228 1229

	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 已提交
1230
	}
1231
	chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
L
Linus Torvalds 已提交
1232

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

1236 1237
	eccsteps = chip->ecc.steps;
	p = buf;
1238

1239 1240
	for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		int stat;
L
Linus Torvalds 已提交
1241

1242
		stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
1243
		if (stat < 0)
1244 1245 1246 1247 1248 1249
			mtd->ecc_stats.failed++;
		else
			mtd->ecc_stats.corrected += stat;
	}
	return 0;
}
L
Linus Torvalds 已提交
1250

1251 1252 1253 1254 1255
/**
 * 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
1256
 * @page:	page number to read
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
 *
 * 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;
}

1300
/**
1301
 * nand_read_page_syndrome - [REPLACABLE] hardware ecc syndrom based page read
1302 1303 1304
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
1305
 * @page:	page number to read
1306 1307
 *
 * The hw generator calculates the error syndrome automatically. Therefor
1308
 * we need a special oob layout and handling.
1309 1310
 */
static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1311
				   uint8_t *buf, int page)
1312 1313 1314 1315 1316
{
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1317
	uint8_t *oob = chip->oob_poi;
L
Linus Torvalds 已提交
1318

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

1322 1323
		chip->ecc.hwctl(mtd, NAND_ECC_READ);
		chip->read_buf(mtd, p, eccsize);
L
Linus Torvalds 已提交
1324

1325 1326 1327 1328
		if (chip->ecc.prepad) {
			chip->read_buf(mtd, oob, chip->ecc.prepad);
			oob += chip->ecc.prepad;
		}
L
Linus Torvalds 已提交
1329

1330 1331 1332
		chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
		chip->read_buf(mtd, oob, eccbytes);
		stat = chip->ecc.correct(mtd, p, oob, NULL);
1333

1334
		if (stat < 0)
1335
			mtd->ecc_stats.failed++;
1336
		else
1337
			mtd->ecc_stats.corrected += stat;
1338

1339
		oob += eccbytes;
L
Linus Torvalds 已提交
1340

1341 1342 1343
		if (chip->ecc.postpad) {
			chip->read_buf(mtd, oob, chip->ecc.postpad);
			oob += chip->ecc.postpad;
1344
		}
1345
	}
L
Linus Torvalds 已提交
1346

1347
	/* Calculate remaining oob bytes */
1348
	i = mtd->oobsize - (oob - chip->oob_poi);
1349 1350
	if (i)
		chip->read_buf(mtd, oob, i);
1351

1352 1353
	return 0;
}
L
Linus Torvalds 已提交
1354

1355
/**
1356 1357
 * nand_transfer_oob - [Internal] Transfer oob to client buffer
 * @chip:	nand chip structure
R
Randy Dunlap 已提交
1358
 * @oob:	oob destination address
1359
 * @ops:	oob ops structure
1360
 * @len:	size of oob to transfer
1361 1362
 */
static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
1363
				  struct mtd_oob_ops *ops, size_t len)
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
{
	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;
1374 1375
		uint32_t boffs = 0, roffs = ops->ooboffs;
		size_t bytes = 0;
1376 1377

		for(; free->length && len; free++, len -= bytes) {
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392
			/* 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);
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404
			oob += bytes;
		}
		return oob;
	}
	default:
		BUG();
	}
	return NULL;
}

/**
 * nand_do_read_ops - [Internal] Read data with ECC
1405 1406 1407
 *
 * @mtd:	MTD device structure
 * @from:	offset to read from
R
Randy Dunlap 已提交
1408
 * @ops:	oob ops structure
1409 1410 1411
 *
 * Internal function. Called with chip held.
 */
1412 1413
static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
1414 1415 1416 1417 1418 1419 1420
{
	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;
1421
	uint32_t readlen = ops->len;
1422
	uint32_t oobreadlen = ops->ooblen;
1423 1424 1425
	uint32_t max_oobsize = ops->mode == MTD_OOB_AUTO ?
		mtd->oobavail : mtd->oobsize;

1426
	uint8_t *bufpoi, *oob, *buf;
L
Linus Torvalds 已提交
1427

1428
	stats = mtd->ecc_stats;
L
Linus Torvalds 已提交
1429

1430 1431
	chipnr = (int)(from >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);
1432

1433 1434
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1435

1436
	col = (int)(from & (mtd->writesize - 1));
1437

1438 1439 1440
	buf = ops->datbuf;
	oob = ops->oobbuf;

1441 1442 1443
	while(1) {
		bytes = min(mtd->writesize - col, readlen);
		aligned = (bytes == mtd->writesize);
1444

1445
		/* Is the current page in the buffer ? */
1446
		if (realpage != chip->pagebuf || oob) {
1447
			bufpoi = aligned ? buf : chip->buffers->databuf;
1448

1449 1450 1451
			if (likely(sndcmd)) {
				chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
				sndcmd = 0;
L
Linus Torvalds 已提交
1452 1453
			}

1454
			/* Now read the page into the buffer */
1455
			if (unlikely(ops->mode == MTD_OOB_RAW))
1456 1457
				ret = chip->ecc.read_page_raw(mtd, chip,
							      bufpoi, page);
1458 1459
			else if (!aligned && NAND_SUBPAGE_READ(chip) && !oob)
				ret = chip->ecc.read_subpage(mtd, chip, col, bytes, bufpoi);
1460
			else
1461 1462
				ret = chip->ecc.read_page(mtd, chip, bufpoi,
							  page);
1463
			if (ret < 0)
L
Linus Torvalds 已提交
1464
				break;
1465 1466 1467

			/* Transfer not aligned data */
			if (!aligned) {
1468 1469
				if (!NAND_SUBPAGE_READ(chip) && !oob)
					chip->pagebuf = realpage;
1470
				memcpy(buf, chip->buffers->databuf + col, bytes);
1471 1472
			}

1473 1474 1475
			buf += bytes;

			if (unlikely(oob)) {
1476

1477
				/* Raw mode does data:oob:data:oob */
1478 1479
				if (ops->mode != MTD_OOB_RAW) {
					int toread = min(oobreadlen,
1480
								max_oobsize);
1481 1482 1483 1484 1485 1486 1487 1488
					if (toread) {
						oob = nand_transfer_oob(chip,
							oob, ops, toread);
						oobreadlen -= toread;
					}
				} else
					buf = nand_transfer_oob(chip,
						buf, ops, mtd->oobsize);
1489 1490
			}

1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502
			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 已提交
1503
			}
1504
		} else {
1505
			memcpy(buf, chip->buffers->databuf + col, bytes);
1506 1507
			buf += bytes;
		}
L
Linus Torvalds 已提交
1508

1509
		readlen -= bytes;
1510

1511
		if (!readlen)
1512
			break;
L
Linus Torvalds 已提交
1513 1514 1515 1516 1517 1518

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

1519
		page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1520 1521 1522
		/* Check, if we cross a chip boundary */
		if (!page) {
			chipnr++;
1523 1524
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1525
		}
1526

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

1534
	ops->retlen = ops->len - (size_t) readlen;
1535 1536
	if (oob)
		ops->oobretlen = ops->ooblen - oobreadlen;
L
Linus Torvalds 已提交
1537

1538 1539 1540
	if (ret)
		return ret;

1541 1542 1543 1544
	if (mtd->ecc_stats.failed - stats.failed)
		return -EBADMSG;

	return  mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
}

/**
 * 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)
{
1560
	struct nand_chip *chip = mtd->priv;
1561 1562 1563 1564 1565 1566 1567 1568
	int ret;

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

1569
	nand_get_device(chip, mtd, FL_READING);
1570

1571 1572 1573 1574 1575
	chip->ops.len = len;
	chip->ops.datbuf = buf;
	chip->ops.oobbuf = NULL;

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

R
Richard Purdie 已提交
1577 1578
	*retlen = chip->ops.retlen;

1579 1580 1581
	nand_release_device(mtd);

	return ret;
L
Linus Torvalds 已提交
1582 1583
}

1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
/**
 * 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 已提交
1661
	return status & NAND_STATUS_FAIL ? -EIO : 0;
1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687
}

/**
 * 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
1688
		pos = eccsize;
1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722

	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 已提交
1723
/**
1724
 * nand_do_read_oob - [Intern] NAND read out-of-band
L
Linus Torvalds 已提交
1725 1726
 * @mtd:	MTD device structure
 * @from:	offset to read from
1727
 * @ops:	oob operations description structure
L
Linus Torvalds 已提交
1728 1729 1730
 *
 * NAND read out-of-band data from the spare area
 */
1731 1732
static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1733
{
1734
	int page, realpage, chipnr, sndcmd = 1;
1735
	struct nand_chip *chip = mtd->priv;
1736
	int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
1737 1738
	int readlen = ops->ooblen;
	int len;
1739
	uint8_t *buf = ops->oobbuf;
1740

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

1744
	if (ops->mode == MTD_OOB_AUTO)
1745
		len = chip->ecc.layout->oobavail;
1746 1747 1748 1749
	else
		len = mtd->oobsize;

	if (unlikely(ops->ooboffs >= len)) {
1750 1751
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to start read "
					"outside oob\n", __func__);
1752 1753 1754 1755 1756 1757 1758
		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)) {
1759 1760
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt read beyond end "
					"of device\n", __func__);
1761 1762
		return -EINVAL;
	}
1763

1764
	chipnr = (int)(from >> chip->chip_shift);
1765
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1766

1767 1768 1769
	/* Shift to get page */
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1770

1771
	while(1) {
1772
		sndcmd = chip->ecc.read_oob(mtd, chip, page, sndcmd);
1773 1774 1775

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

1777 1778 1779 1780 1781 1782
		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.
1783
			 */
1784 1785
			if (!chip->dev_ready)
				udelay(chip->chip_delay);
1786 1787
			else
				nand_wait_ready(mtd);
1788
		}
1789

1790
		readlen -= len;
S
Savin Zlobec 已提交
1791 1792 1793
		if (!readlen)
			break;

1794 1795 1796 1797 1798 1799 1800 1801 1802
		/* 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 已提交
1803
		}
1804 1805 1806 1807 1808 1809

		/* 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 已提交
1810 1811
	}

1812
	ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
1813 1814 1815 1816
	return 0;
}

/**
1817
 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
L
Linus Torvalds 已提交
1818 1819
 * @mtd:	MTD device structure
 * @from:	offset to read from
1820
 * @ops:	oob operation description structure
L
Linus Torvalds 已提交
1821
 *
1822
 * NAND read data and/or out-of-band data
L
Linus Torvalds 已提交
1823
 */
1824 1825
static int nand_read_oob(struct mtd_info *mtd, loff_t from,
			 struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1826
{
1827
	struct nand_chip *chip = mtd->priv;
1828 1829 1830
	int ret = -ENOTSUPP;

	ops->retlen = 0;
L
Linus Torvalds 已提交
1831 1832

	/* Do not allow reads past end of device */
1833
	if (ops->datbuf && (from + ops->len) > mtd->size) {
1834 1835
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt read "
				"beyond end of device\n", __func__);
L
Linus Torvalds 已提交
1836 1837 1838
		return -EINVAL;
	}

1839
	nand_get_device(chip, mtd, FL_READING);
L
Linus Torvalds 已提交
1840

1841 1842 1843 1844 1845
	switch(ops->mode) {
	case MTD_OOB_PLACE:
	case MTD_OOB_AUTO:
	case MTD_OOB_RAW:
		break;
L
Linus Torvalds 已提交
1846

1847 1848 1849
	default:
		goto out;
	}
L
Linus Torvalds 已提交
1850

1851 1852 1853 1854
	if (!ops->datbuf)
		ret = nand_do_read_oob(mtd, from, ops);
	else
		ret = nand_do_read_ops(mtd, from, ops);
1855

1856 1857 1858 1859
 out:
	nand_release_device(mtd);
	return ret;
}
1860

L
Linus Torvalds 已提交
1861

1862 1863 1864 1865 1866
/**
 * nand_write_page_raw - [Intern] raw page write function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
1867 1868
 *
 * Not for syndrome calculating ecc controllers, which use a special oob layout
1869 1870 1871 1872 1873 1874
 */
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 已提交
1875 1876
}

1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914
/**
 * 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);
}
1915
/**
1916
 * nand_write_page_swecc - [REPLACABLE] software ecc based page write function
1917 1918 1919
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
1920
 */
1921 1922
static void nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
				  const uint8_t *buf)
1923
{
1924 1925 1926
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
1927
	uint8_t *ecc_calc = chip->buffers->ecccalc;
1928
	const uint8_t *p = buf;
1929
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1930

1931 1932 1933
	/* Software ecc calculation */
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1934

1935 1936
	for (i = 0; i < chip->ecc.total; i++)
		chip->oob_poi[eccpos[i]] = ecc_calc[i];
1937

1938
	chip->ecc.write_page_raw(mtd, chip, buf);
1939
}
1940

1941
/**
1942
 * nand_write_page_hwecc - [REPLACABLE] hardware ecc based page write function
1943 1944 1945 1946 1947 1948 1949 1950 1951 1952
 * @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;
1953
	uint8_t *ecc_calc = chip->buffers->ecccalc;
1954
	const uint8_t *p = buf;
1955
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1956

1957 1958
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
1959
		chip->write_buf(mtd, p, eccsize);
1960
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1961 1962
	}

1963 1964 1965 1966
	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);
1967 1968
}

1969
/**
1970
 * nand_write_page_syndrome - [REPLACABLE] hardware ecc syndrom based page write
1971 1972 1973
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
L
Linus Torvalds 已提交
1974
 *
1975 1976 1977 1978 1979
 * 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 已提交
1980
{
1981 1982 1983 1984 1985
	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 已提交
1986

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

1989 1990
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
		chip->write_buf(mtd, p, eccsize);
1991

1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003
		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 已提交
2004 2005
		}
	}
2006 2007

	/* Calculate remaining oob bytes */
2008
	i = mtd->oobsize - (oob - chip->oob_poi);
2009 2010 2011 2012 2013
	if (i)
		chip->write_buf(mtd, oob, i);
}

/**
2014
 * nand_write_page - [REPLACEABLE] write one page
2015 2016 2017 2018 2019
 * @mtd:	MTD device structure
 * @chip:	NAND chip descriptor
 * @buf:	the data to write
 * @page:	page number to write
 * @cached:	cached programming
2020
 * @raw:	use _raw version of write_page
2021 2022
 */
static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
2023
			   const uint8_t *buf, int page, int cached, int raw)
2024 2025 2026 2027 2028
{
	int status;

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

2029 2030 2031 2032
	if (unlikely(raw))
		chip->ecc.write_page_raw(mtd, chip, buf);
	else
		chip->ecc.write_page(mtd, chip, buf);
2033 2034 2035 2036 2037 2038 2039 2040 2041 2042

	/*
	 * 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);
2043
		status = chip->waitfunc(mtd, chip);
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055
		/*
		 * 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);
2056
		status = chip->waitfunc(mtd, chip);
2057 2058 2059 2060 2061 2062 2063 2064 2065 2066
	}

#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 已提交
2067 2068
}

2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088
/**
 * 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;
2089 2090
		uint32_t boffs = 0, woffs = ops->ooboffs;
		size_t bytes = 0;
2091 2092

		for(; free->length && len; free++, len -= bytes) {
2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106
			/* 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;
			}
2107
			memcpy(chip->oob_poi + boffs, oob, bytes);
2108 2109 2110 2111 2112 2113 2114 2115 2116 2117
			oob += bytes;
		}
		return oob;
	}
	default:
		BUG();
	}
	return NULL;
}

2118
#define NOTALIGNED(x)	(x & (chip->subpagesize - 1)) != 0
L
Linus Torvalds 已提交
2119 2120

/**
2121
 * nand_do_write_ops - [Internal] NAND write with ECC
L
Linus Torvalds 已提交
2122 2123
 * @mtd:	MTD device structure
 * @to:		offset to write to
2124
 * @ops:	oob operations description structure
L
Linus Torvalds 已提交
2125 2126 2127
 *
 * NAND write with ECC
 */
2128 2129
static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
2130
{
2131
	int chipnr, realpage, page, blockmask, column;
2132
	struct nand_chip *chip = mtd->priv;
2133 2134 2135
	uint32_t writelen = ops->len;
	uint8_t *oob = ops->oobbuf;
	uint8_t *buf = ops->datbuf;
2136
	int ret, subpage;
L
Linus Torvalds 已提交
2137

2138
	ops->retlen = 0;
2139 2140
	if (!writelen)
		return 0;
L
Linus Torvalds 已提交
2141

2142
	/* reject writes, which are not page aligned */
2143
	if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
2144 2145
		printk(KERN_NOTICE "%s: Attempt to write not "
				"page aligned data\n", __func__);
L
Linus Torvalds 已提交
2146 2147 2148
		return -EINVAL;
	}

2149 2150 2151 2152 2153
	column = to & (mtd->writesize - 1);
	subpage = column || (writelen & (mtd->writesize - 1));

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

2155 2156 2157
	chipnr = (int)(to >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);

L
Linus Torvalds 已提交
2158 2159
	/* Check, if it is write protected */
	if (nand_check_wp(mtd))
2160
		return -EIO;
L
Linus Torvalds 已提交
2161

2162 2163 2164 2165 2166 2167
	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) &&
2168
	    (chip->pagebuf << chip->page_shift) < (to + ops->len))
2169
		chip->pagebuf = -1;
2170

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

2175
	while(1) {
2176
		int bytes = mtd->writesize;
2177
		int cached = writelen > bytes && page != blockmask;
2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188
		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 已提交
2189

2190 2191 2192
		if (unlikely(oob))
			oob = nand_fill_oob(chip, oob, ops);

2193
		ret = chip->write_page(mtd, chip, wbuf, page, cached,
2194
				       (ops->mode == MTD_OOB_RAW));
2195 2196 2197 2198 2199 2200 2201
		if (ret)
			break;

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

2202
		column = 0;
2203 2204 2205 2206 2207 2208 2209 2210 2211
		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 已提交
2212 2213
		}
	}
2214 2215

	ops->retlen = ops->len - writelen;
2216 2217
	if (unlikely(oob))
		ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
2218 2219 2220
	return ret;
}

2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259
/**
 * 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;
}

2260
/**
2261
 * nand_write - [MTD Interface] NAND write with ECC
2262 2263 2264
 * @mtd:	MTD device structure
 * @to:		offset to write to
 * @len:	number of bytes to write
2265 2266
 * @retlen:	pointer to variable to store the number of written bytes
 * @buf:	the data to write
2267
 *
2268
 * NAND write with ECC
2269
 */
2270 2271
static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
			  size_t *retlen, const uint8_t *buf)
2272 2273 2274 2275
{
	struct nand_chip *chip = mtd->priv;
	int ret;

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

2282
	nand_get_device(chip, mtd, FL_WRITING);
2283

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

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

R
Richard Purdie 已提交
2290 2291
	*retlen = chip->ops.retlen;

2292
	nand_release_device(mtd);
2293 2294

	return ret;
2295
}
2296

L
Linus Torvalds 已提交
2297
/**
2298
 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
L
Linus Torvalds 已提交
2299 2300
 * @mtd:	MTD device structure
 * @to:		offset to write to
2301
 * @ops:	oob operation description structure
L
Linus Torvalds 已提交
2302 2303 2304
 *
 * NAND write out-of-band
 */
2305 2306
static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
2307
{
2308
	int chipnr, page, status, len;
2309
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2310

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

2314 2315 2316 2317 2318
	if (ops->mode == MTD_OOB_AUTO)
		len = chip->ecc.layout->oobavail;
	else
		len = mtd->oobsize;

L
Linus Torvalds 已提交
2319
	/* Do not allow write past end of page */
2320
	if ((ops->ooboffs + ops->ooblen) > len) {
2321 2322
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to write "
				"past end of page\n", __func__);
L
Linus Torvalds 已提交
2323 2324 2325
		return -EINVAL;
	}

2326
	if (unlikely(ops->ooboffs >= len)) {
2327 2328
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to start "
				"write outside oob\n", __func__);
2329 2330 2331 2332 2333 2334 2335 2336
		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)) {
2337 2338
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt write beyond "
				"end of device\n", __func__);
2339 2340 2341
		return -EINVAL;
	}

2342
	chipnr = (int)(to >> chip->chip_shift);
2343
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2344

2345 2346 2347 2348 2349 2350 2351 2352 2353
	/* 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.
	 */
2354
	chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
L
Linus Torvalds 已提交
2355 2356 2357

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

L
Linus Torvalds 已提交
2360
	/* Invalidate the page cache, if we write to the cached page */
2361 2362
	if (page == chip->pagebuf)
		chip->pagebuf = -1;
L
Linus Torvalds 已提交
2363

2364 2365 2366 2367
	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 已提交
2368

2369 2370
	if (status)
		return status;
L
Linus Torvalds 已提交
2371

2372
	ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
2373

2374
	return 0;
2375 2376 2377 2378 2379
}

/**
 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
2380
 * @to:		offset to write to
2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391
 * @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 */
2392
	if (ops->datbuf && (to + ops->len) > mtd->size) {
2393 2394
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt write beyond "
				"end of device\n", __func__);
2395 2396 2397
		return -EINVAL;
	}

2398
	nand_get_device(chip, mtd, FL_WRITING);
2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414

	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);

2415
 out:
L
Linus Torvalds 已提交
2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426
	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
 */
2427
static void single_erase_cmd(struct mtd_info *mtd, int page)
L
Linus Torvalds 已提交
2428
{
2429
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2430
	/* Send commands to erase a block */
2431 2432
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
	chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
L
Linus Torvalds 已提交
2433 2434 2435 2436 2437 2438 2439 2440 2441 2442
}

/**
 * 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
 */
2443
static void multi_erase_cmd(struct mtd_info *mtd, int page)
L
Linus Torvalds 已提交
2444
{
2445
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2446
	/* Send commands to erase a block */
2447 2448 2449 2450 2451
	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 已提交
2452 2453 2454 2455 2456 2457 2458 2459 2460
}

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

2466
#define BBT_PAGE_MASK	0xffffff3f
L
Linus Torvalds 已提交
2467
/**
2468
 * nand_erase_nand - [Internal] erase block(s)
L
Linus Torvalds 已提交
2469 2470 2471 2472 2473 2474
 * @mtd:	MTD device structure
 * @instr:	erase instruction
 * @allowbbt:	allow erasing the bbt area
 *
 * Erase one ore more blocks
 */
2475 2476
int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
		    int allowbbt)
L
Linus Torvalds 已提交
2477
{
2478
	int page, status, pages_per_block, ret, chipnr;
2479
	struct nand_chip *chip = mtd->priv;
2480
	loff_t rewrite_bbt[NAND_MAX_CHIPS]={0};
2481
	unsigned int bbt_masked_page = 0xffffffff;
2482
	loff_t len;
L
Linus Torvalds 已提交
2483

2484 2485 2486
	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 已提交
2487

2488
	if (check_offs_len(mtd, instr->addr, instr->len))
L
Linus Torvalds 已提交
2489 2490
		return -EINVAL;

2491
	instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
L
Linus Torvalds 已提交
2492 2493

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

	/* Shift to get first page */
2497 2498
	page = (int)(instr->addr >> chip->page_shift);
	chipnr = (int)(instr->addr >> chip->chip_shift);
L
Linus Torvalds 已提交
2499 2500

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

	/* Select the NAND device */
2504
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2505 2506 2507

	/* Check, if it is write protected */
	if (nand_check_wp(mtd)) {
2508 2509
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Device is write protected!!!\n",
					__func__);
L
Linus Torvalds 已提交
2510 2511 2512 2513
		instr->state = MTD_ERASE_FAILED;
		goto erase_exit;
	}

2514 2515 2516 2517 2518 2519 2520 2521
	/*
	 * 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;
2522

L
Linus Torvalds 已提交
2523 2524 2525 2526 2527 2528
	/* Loop through the pages */
	len = instr->len;

	instr->state = MTD_ERASING;

	while (len) {
2529 2530 2531 2532 2533
		/*
		 * 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)) {
2534 2535
			printk(KERN_WARNING "%s: attempt to erase a bad block "
					"at page 0x%08x\n", __func__, page);
L
Linus Torvalds 已提交
2536 2537 2538
			instr->state = MTD_ERASE_FAILED;
			goto erase_exit;
		}
2539

2540 2541 2542 2543 2544 2545 2546
		/*
		 * 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 已提交
2547

2548
		chip->erase_cmd(mtd, page & chip->pagemask);
2549

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

2552 2553 2554 2555 2556 2557 2558
		/*
		 * 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);
2559

L
Linus Torvalds 已提交
2560
		/* See if block erase succeeded */
2561
		if (status & NAND_STATUS_FAIL) {
2562 2563
			DEBUG(MTD_DEBUG_LEVEL0, "%s: Failed erase, "
					"page 0x%08x\n", __func__, page);
L
Linus Torvalds 已提交
2564
			instr->state = MTD_ERASE_FAILED;
2565 2566
			instr->fail_addr =
				((loff_t)page << chip->page_shift);
L
Linus Torvalds 已提交
2567 2568
			goto erase_exit;
		}
2569

2570 2571 2572 2573 2574 2575
		/*
		 * 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)
2576 2577
			    rewrite_bbt[chipnr] =
					((loff_t)page << chip->page_shift);
2578

L
Linus Torvalds 已提交
2579
		/* Increment page address and decrement length */
2580
		len -= (1 << chip->phys_erase_shift);
L
Linus Torvalds 已提交
2581 2582 2583
		page += pages_per_block;

		/* Check, if we cross a chip boundary */
2584
		if (len && !(page & chip->pagemask)) {
L
Linus Torvalds 已提交
2585
			chipnr++;
2586 2587
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
2588

2589 2590 2591 2592 2593 2594 2595 2596
			/*
			 * 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 已提交
2597 2598 2599 2600
		}
	}
	instr->state = MTD_ERASE_DONE;

2601
 erase_exit:
L
Linus Torvalds 已提交
2602 2603 2604 2605 2606 2607

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

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

2608 2609 2610 2611
	/* Do call back function */
	if (!ret)
		mtd_erase_callback(instr);

2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622
	/*
	 * 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 */
2623 2624 2625
		DEBUG(MTD_DEBUG_LEVEL0, "%s: nand_update_bbt "
			"(%d:0x%0llx 0x%0x)\n", __func__, chipnr,
			rewrite_bbt[chipnr], chip->bbt_td->pages[chipnr]);
2626
		nand_update_bbt(mtd, rewrite_bbt[chipnr]);
2627 2628
	}

L
Linus Torvalds 已提交
2629 2630 2631 2632 2633 2634 2635 2636 2637 2638
	/* 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
 */
2639
static void nand_sync(struct mtd_info *mtd)
L
Linus Torvalds 已提交
2640
{
2641
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2642

2643
	DEBUG(MTD_DEBUG_LEVEL3, "%s: called\n", __func__);
L
Linus Torvalds 已提交
2644 2645

	/* Grab the lock and see if the device is available */
2646
	nand_get_device(chip, mtd, FL_SYNCING);
L
Linus Torvalds 已提交
2647
	/* Release it and go back */
2648
	nand_release_device(mtd);
L
Linus Torvalds 已提交
2649 2650 2651
}

/**
2652
 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
L
Linus Torvalds 已提交
2653
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
2654
 * @offs:	offset relative to mtd start
L
Linus Torvalds 已提交
2655
 */
2656
static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
L
Linus Torvalds 已提交
2657 2658
{
	/* Check for invalid offset */
2659
	if (offs > mtd->size)
L
Linus Torvalds 已提交
2660
		return -EINVAL;
2661

2662
	return nand_block_checkbad(mtd, offs, 1, 0);
L
Linus Torvalds 已提交
2663 2664 2665
}

/**
2666
 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
L
Linus Torvalds 已提交
2667 2668 2669
 * @mtd:	MTD device structure
 * @ofs:	offset relative to mtd start
 */
2670
static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
L
Linus Torvalds 已提交
2671
{
2672
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2673 2674
	int ret;

2675 2676
	if ((ret = nand_block_isbad(mtd, ofs))) {
		/* If it was bad already, return success and do nothing. */
L
Linus Torvalds 已提交
2677 2678
		if (ret > 0)
			return 0;
2679 2680
		return ret;
	}
L
Linus Torvalds 已提交
2681

2682
	return chip->block_markbad(mtd, ofs);
L
Linus Torvalds 已提交
2683 2684
}

2685 2686 2687 2688 2689 2690
/**
 * nand_suspend - [MTD Interface] Suspend the NAND flash
 * @mtd:	MTD device structure
 */
static int nand_suspend(struct mtd_info *mtd)
{
2691
	struct nand_chip *chip = mtd->priv;
2692

2693
	return nand_get_device(chip, mtd, FL_PM_SUSPENDED);
2694 2695 2696 2697 2698 2699 2700 2701
}

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

2704
	if (chip->state == FL_PM_SUSPENDED)
2705 2706
		nand_release_device(mtd);
	else
2707 2708
		printk(KERN_ERR "%s called for a chip which is not "
		       "in suspended state\n", __func__);
2709 2710
}

T
Thomas Gleixner 已提交
2711 2712 2713
/*
 * Set default functions
 */
2714
static void nand_set_defaults(struct nand_chip *chip, int busw)
T
Thomas Gleixner 已提交
2715
{
L
Linus Torvalds 已提交
2716
	/* check for proper chip_delay setup, set 20us if not */
2717 2718
	if (!chip->chip_delay)
		chip->chip_delay = 20;
L
Linus Torvalds 已提交
2719 2720

	/* check, if a user supplied command function given */
2721 2722
	if (chip->cmdfunc == NULL)
		chip->cmdfunc = nand_command;
L
Linus Torvalds 已提交
2723 2724

	/* check, if a user supplied wait function given */
2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745
	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;
2746 2747 2748 2749 2750 2751 2752

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

T
Thomas Gleixner 已提交
2753 2754 2755
}

/*
2756
 * Get the flash and manufacturer id and lookup if the type is supported
T
Thomas Gleixner 已提交
2757 2758
 */
static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
2759
						  struct nand_chip *chip,
T
Thomas Gleixner 已提交
2760 2761 2762 2763
						  int busw, int *maf_id)
{
	struct nand_flash_dev *type = NULL;
	int i, dev_id, maf_idx;
2764
	int tmp_id, tmp_manf;
L
Linus Torvalds 已提交
2765 2766

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

2769 2770 2771 2772 2773 2774
	/*
	 * 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 已提交
2775
	/* Send the command for reading device ID */
2776
	chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
L
Linus Torvalds 已提交
2777 2778

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

2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801
	/* 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 已提交
2802
	/* Lookup the flash id */
L
Linus Torvalds 已提交
2803
	for (i = 0; nand_flash_ids[i].name != NULL; i++) {
T
Thomas Gleixner 已提交
2804 2805 2806 2807 2808
		if (dev_id == nand_flash_ids[i].id) {
			type =  &nand_flash_ids[i];
			break;
		}
	}
2809

T
Thomas Gleixner 已提交
2810 2811 2812
	if (!type)
		return ERR_PTR(-ENODEV);

2813 2814 2815
	if (!mtd->name)
		mtd->name = type->name;

2816
	chip->chipsize = (uint64_t)type->chipsize << 20;
T
Thomas Gleixner 已提交
2817 2818

	/* Newer devices have all the information in additional id bytes */
2819
	if (!type->pagesize) {
T
Thomas Gleixner 已提交
2820
		int extid;
2821 2822
		/* The 3rd id byte holds MLC / multichip data */
		chip->cellinfo = chip->read_byte(mtd);
T
Thomas Gleixner 已提交
2823
		/* The 4th id byte is the important one */
2824
		extid = chip->read_byte(mtd);
T
Thomas Gleixner 已提交
2825
		/* Calc pagesize */
2826
		mtd->writesize = 1024 << (extid & 0x3);
T
Thomas Gleixner 已提交
2827 2828
		extid >>= 2;
		/* Calc oobsize */
2829
		mtd->oobsize = (8 << (extid & 0x01)) * (mtd->writesize >> 9);
T
Thomas Gleixner 已提交
2830 2831 2832 2833 2834 2835
		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;
2836

T
Thomas Gleixner 已提交
2837 2838
	} else {
		/*
2839
		 * Old devices have chip data hardcoded in the device id table
T
Thomas Gleixner 已提交
2840
		 */
2841 2842
		mtd->erasesize = type->erasesize;
		mtd->writesize = type->pagesize;
2843
		mtd->oobsize = mtd->writesize / 32;
2844
		busw = type->options & NAND_BUSWIDTH_16;
T
Thomas Gleixner 已提交
2845
	}
L
Linus Torvalds 已提交
2846

T
Thomas Gleixner 已提交
2847
	/* Try to identify manufacturer */
2848
	for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
T
Thomas Gleixner 已提交
2849 2850 2851
		if (nand_manuf_ids[maf_idx].id == *maf_id)
			break;
	}
2852

T
Thomas Gleixner 已提交
2853 2854
	/*
	 * Check, if buswidth is correct. Hardware drivers should set
2855
	 * chip correct !
T
Thomas Gleixner 已提交
2856
	 */
2857
	if (busw != (chip->options & NAND_BUSWIDTH_16)) {
T
Thomas Gleixner 已提交
2858 2859 2860 2861
		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",
2862
		       (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
T
Thomas Gleixner 已提交
2863 2864 2865
		       busw ? 16 : 8);
		return ERR_PTR(-EINVAL);
	}
2866

T
Thomas Gleixner 已提交
2867
	/* Calculate the address shift from the page size */
2868
	chip->page_shift = ffs(mtd->writesize) - 1;
T
Thomas Gleixner 已提交
2869
	/* Convert chipsize to number of pages per chip -1. */
2870
	chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
2871

2872
	chip->bbt_erase_shift = chip->phys_erase_shift =
T
Thomas Gleixner 已提交
2873
		ffs(mtd->erasesize) - 1;
2874 2875 2876 2877
	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 已提交
2878

T
Thomas Gleixner 已提交
2879
	/* Set the bad block position */
2880
	chip->badblockpos = mtd->writesize > 512 ?
T
Thomas Gleixner 已提交
2881
		NAND_LARGE_BADBLOCK_POS : NAND_SMALL_BADBLOCK_POS;
2882

T
Thomas Gleixner 已提交
2883
	/* Get chip options, preserve non chip based options */
2884
	chip->options &= ~NAND_CHIPOPTIONS_MSK;
2885
	chip->options |= type->options & NAND_CHIPOPTIONS_MSK;
T
Thomas Gleixner 已提交
2886 2887

	/*
2888
	 * Set chip as a default. Board drivers can override it, if necessary
T
Thomas Gleixner 已提交
2889
	 */
2890
	chip->options |= NAND_NO_AUTOINCR;
T
Thomas Gleixner 已提交
2891

2892
	/* Check if chip is a not a samsung device. Do not clear the
T
Thomas Gleixner 已提交
2893 2894
	 * options for chips which are not having an extended id.
	 */
2895
	if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
2896
		chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
T
Thomas Gleixner 已提交
2897 2898

	/* Check for AND chips with 4 page planes */
2899 2900
	if (chip->options & NAND_4PAGE_ARRAY)
		chip->erase_cmd = multi_erase_cmd;
T
Thomas Gleixner 已提交
2901
	else
2902
		chip->erase_cmd = single_erase_cmd;
T
Thomas Gleixner 已提交
2903 2904

	/* Do not replace user supplied command function ! */
2905 2906
	if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
		chip->cmdfunc = nand_command_lp;
T
Thomas Gleixner 已提交
2907 2908 2909 2910 2911 2912 2913 2914 2915

	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;
}

/**
2916 2917 2918
 * nand_scan_ident - [NAND Interface] Scan for the NAND device
 * @mtd:	     MTD device structure
 * @maxchips:	     Number of chips to scan for
T
Thomas Gleixner 已提交
2919
 *
2920 2921
 * 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 已提交
2922
 *
2923
 * The mtd->owner field must be set to the module of the caller.
T
Thomas Gleixner 已提交
2924
 */
2925
int nand_scan_ident(struct mtd_info *mtd, int maxchips)
T
Thomas Gleixner 已提交
2926 2927
{
	int i, busw, nand_maf_id;
2928
	struct nand_chip *chip = mtd->priv;
T
Thomas Gleixner 已提交
2929 2930 2931
	struct nand_flash_dev *type;

	/* Get buswidth to select the correct functions */
2932
	busw = chip->options & NAND_BUSWIDTH_16;
T
Thomas Gleixner 已提交
2933
	/* Set the default functions */
2934
	nand_set_defaults(chip, busw);
T
Thomas Gleixner 已提交
2935 2936

	/* Read the flash type */
2937
	type = nand_get_flash_type(mtd, chip, busw, &nand_maf_id);
T
Thomas Gleixner 已提交
2938 2939

	if (IS_ERR(type)) {
2940 2941
		if (!(chip->options & NAND_SCAN_SILENT_NODEV))
			printk(KERN_WARNING "No NAND device found.\n");
2942
		chip->select_chip(mtd, -1);
T
Thomas Gleixner 已提交
2943
		return PTR_ERR(type);
L
Linus Torvalds 已提交
2944 2945
	}

T
Thomas Gleixner 已提交
2946
	/* Check for a chip array */
2947
	for (i = 1; i < maxchips; i++) {
2948
		chip->select_chip(mtd, i);
2949 2950
		/* See comment in nand_get_flash_type for reset */
		chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
L
Linus Torvalds 已提交
2951
		/* Send the command for reading device ID */
2952
		chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
L
Linus Torvalds 已提交
2953
		/* Read manufacturer and device IDs */
2954 2955
		if (nand_maf_id != chip->read_byte(mtd) ||
		    type->id != chip->read_byte(mtd))
L
Linus Torvalds 已提交
2956 2957 2958 2959
			break;
	}
	if (i > 1)
		printk(KERN_INFO "%d NAND chips detected\n", i);
2960

L
Linus Torvalds 已提交
2961
	/* Store the number of chips and calc total size for mtd */
2962 2963
	chip->numchips = i;
	mtd->size = i * chip->chipsize;
T
Thomas Gleixner 已提交
2964

2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981
	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;

2982 2983 2984 2985 2986
	if (!(chip->options & NAND_OWN_BUFFERS))
		chip->buffers = kmalloc(sizeof(*chip->buffers), GFP_KERNEL);
	if (!chip->buffers)
		return -ENOMEM;

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

T
Thomas Gleixner 已提交
2990 2991 2992
	/*
	 * If no default placement scheme is given, select an appropriate one
	 */
2993
	if (!chip->ecc.layout) {
2994
		switch (mtd->oobsize) {
L
Linus Torvalds 已提交
2995
		case 8:
2996
			chip->ecc.layout = &nand_oob_8;
L
Linus Torvalds 已提交
2997 2998
			break;
		case 16:
2999
			chip->ecc.layout = &nand_oob_16;
L
Linus Torvalds 已提交
3000 3001
			break;
		case 64:
3002
			chip->ecc.layout = &nand_oob_64;
L
Linus Torvalds 已提交
3003
			break;
3004 3005 3006
		case 128:
			chip->ecc.layout = &nand_oob_128;
			break;
L
Linus Torvalds 已提交
3007
		default:
T
Thomas Gleixner 已提交
3008 3009
			printk(KERN_WARNING "No oob scheme defined for "
			       "oobsize %d\n", mtd->oobsize);
L
Linus Torvalds 已提交
3010 3011 3012
			BUG();
		}
	}
3013

3014 3015 3016
	if (!chip->write_page)
		chip->write_page = nand_write_page;

3017
	/*
T
Thomas Gleixner 已提交
3018 3019
	 * check ECC mode, default to software if 3byte/512byte hardware ECC is
	 * selected and we have 256 byte pagesize fallback to software ECC
3020
	 */
3021

3022
	switch (chip->ecc.mode) {
3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033
	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 已提交
3034
	case NAND_ECC_HW:
3035 3036 3037
		/* Use standard hwecc read page function ? */
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_hwecc;
3038 3039
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_hwecc;
3040 3041 3042 3043
		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;
3044 3045 3046 3047
		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;
3048

T
Thomas Gleixner 已提交
3049
	case NAND_ECC_HW_SYNDROME:
3050 3051 3052
		if ((!chip->ecc.calculate || !chip->ecc.correct ||
		     !chip->ecc.hwctl) &&
		    (!chip->ecc.read_page ||
3053
		     chip->ecc.read_page == nand_read_page_hwecc ||
3054
		     !chip->ecc.write_page ||
3055
		     chip->ecc.write_page == nand_write_page_hwecc)) {
3056
			printk(KERN_WARNING "No ECC functions supplied; "
T
Thomas Gleixner 已提交
3057 3058 3059
			       "Hardware ECC not possible\n");
			BUG();
		}
3060
		/* Use standard syndrome read/write page function ? */
3061 3062
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_syndrome;
3063 3064
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_syndrome;
3065 3066 3067 3068
		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;
3069 3070 3071 3072
		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;
3073

3074
		if (mtd->writesize >= chip->ecc.size)
T
Thomas Gleixner 已提交
3075 3076 3077
			break;
		printk(KERN_WARNING "%d byte HW ECC not possible on "
		       "%d byte page size, fallback to SW ECC\n",
3078 3079
		       chip->ecc.size, mtd->writesize);
		chip->ecc.mode = NAND_ECC_SOFT;
3080

T
Thomas Gleixner 已提交
3081
	case NAND_ECC_SOFT:
3082 3083
		chip->ecc.calculate = nand_calculate_ecc;
		chip->ecc.correct = nand_correct_data;
3084
		chip->ecc.read_page = nand_read_page_swecc;
3085
		chip->ecc.read_subpage = nand_read_subpage;
3086
		chip->ecc.write_page = nand_write_page_swecc;
3087 3088
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
3089 3090
		chip->ecc.read_oob = nand_read_oob_std;
		chip->ecc.write_oob = nand_write_oob_std;
3091 3092
		if (!chip->ecc.size)
			chip->ecc.size = 256;
3093
		chip->ecc.bytes = 3;
L
Linus Torvalds 已提交
3094
		break;
3095 3096

	case NAND_ECC_NONE:
T
Thomas Gleixner 已提交
3097 3098
		printk(KERN_WARNING "NAND_ECC_NONE selected by board driver. "
		       "This is not recommended !!\n");
3099 3100
		chip->ecc.read_page = nand_read_page_raw;
		chip->ecc.write_page = nand_write_page_raw;
3101
		chip->ecc.read_oob = nand_read_oob_std;
3102 3103
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
3104
		chip->ecc.write_oob = nand_write_oob_std;
3105 3106
		chip->ecc.size = mtd->writesize;
		chip->ecc.bytes = 0;
L
Linus Torvalds 已提交
3107
		break;
3108

L
Linus Torvalds 已提交
3109
	default:
T
Thomas Gleixner 已提交
3110
		printk(KERN_WARNING "Invalid NAND_ECC_MODE %d\n",
3111
		       chip->ecc.mode);
3112
		BUG();
L
Linus Torvalds 已提交
3113
	}
3114

3115 3116 3117 3118 3119
	/*
	 * The number of bytes available for a client to place data into
	 * the out of band area
	 */
	chip->ecc.layout->oobavail = 0;
3120 3121
	for (i = 0; chip->ecc.layout->oobfree[i].length
			&& i < ARRAY_SIZE(chip->ecc.layout->oobfree); i++)
3122 3123
		chip->ecc.layout->oobavail +=
			chip->ecc.layout->oobfree[i].length;
V
Vitaly Wool 已提交
3124
	mtd->oobavail = chip->ecc.layout->oobavail;
3125

T
Thomas Gleixner 已提交
3126 3127 3128 3129
	/*
	 * Set the number of read / write steps for one page depending on ECC
	 * mode
	 */
3130 3131
	chip->ecc.steps = mtd->writesize / chip->ecc.size;
	if(chip->ecc.steps * chip->ecc.size != mtd->writesize) {
T
Thomas Gleixner 已提交
3132 3133
		printk(KERN_WARNING "Invalid ecc parameters\n");
		BUG();
L
Linus Torvalds 已提交
3134
	}
3135
	chip->ecc.total = chip->ecc.steps * chip->ecc.bytes;
3136

3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148
	/*
	 * 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:
3149
		case 16:
3150 3151 3152 3153 3154 3155
			mtd->subpage_sft = 2;
			break;
		}
	}
	chip->subpagesize = mtd->writesize >> mtd->subpage_sft;

3156
	/* Initialize state */
3157
	chip->state = FL_READY;
L
Linus Torvalds 已提交
3158 3159

	/* De-select the device */
3160
	chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
3161 3162

	/* Invalidate the pagebuffer reference */
3163
	chip->pagebuf = -1;
L
Linus Torvalds 已提交
3164 3165 3166

	/* Fill in remaining MTD driver data */
	mtd->type = MTD_NANDFLASH;
J
Joern Engel 已提交
3167
	mtd->flags = MTD_CAP_NANDFLASH;
L
Linus Torvalds 已提交
3168 3169 3170 3171 3172
	mtd->erase = nand_erase;
	mtd->point = NULL;
	mtd->unpoint = NULL;
	mtd->read = nand_read;
	mtd->write = nand_write;
3173
	mtd->panic_write = panic_nand_write;
L
Linus Torvalds 已提交
3174 3175 3176 3177 3178
	mtd->read_oob = nand_read_oob;
	mtd->write_oob = nand_write_oob;
	mtd->sync = nand_sync;
	mtd->lock = NULL;
	mtd->unlock = NULL;
3179 3180
	mtd->suspend = nand_suspend;
	mtd->resume = nand_resume;
L
Linus Torvalds 已提交
3181 3182 3183
	mtd->block_isbad = nand_block_isbad;
	mtd->block_markbad = nand_block_markbad;

3184 3185
	/* propagate ecc.layout to mtd_info */
	mtd->ecclayout = chip->ecc.layout;
L
Linus Torvalds 已提交
3186

3187
	/* Check, if we should skip the bad block table scan */
3188
	if (chip->options & NAND_SKIP_BBTSCAN)
3189
		return 0;
L
Linus Torvalds 已提交
3190 3191

	/* Build bad block table */
3192
	return chip->scan_bbt(mtd);
L
Linus Torvalds 已提交
3193 3194
}

3195
/* is_module_text_address() isn't exported, and it's mostly a pointless
3196 3197 3198 3199 3200 3201
   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() \
3202
	is_module_text_address((unsigned long)__builtin_return_address(0))
3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222
#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()) {
3223 3224
		printk(KERN_CRIT "%s called with NULL mtd->owner!\n",
				__func__);
3225 3226 3227 3228 3229 3230 3231 3232 3233
		BUG();
	}

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

L
Linus Torvalds 已提交
3234
/**
3235
 * nand_release - [NAND Interface] Free resources held by the NAND device
L
Linus Torvalds 已提交
3236 3237
 * @mtd:	MTD device structure
*/
3238
void nand_release(struct mtd_info *mtd)
L
Linus Torvalds 已提交
3239
{
3240
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
3241 3242 3243

#ifdef CONFIG_MTD_PARTITIONS
	/* Deregister partitions */
3244
	del_mtd_partitions(mtd);
L
Linus Torvalds 已提交
3245 3246
#endif
	/* Deregister the device */
3247
	del_mtd_device(mtd);
L
Linus Torvalds 已提交
3248

J
Jesper Juhl 已提交
3249
	/* Free bad block table memory */
3250
	kfree(chip->bbt);
3251 3252
	if (!(chip->options & NAND_OWN_BUFFERS))
		kfree(chip->buffers);
L
Linus Torvalds 已提交
3253 3254
}

3255 3256
EXPORT_SYMBOL_GPL(nand_lock);
EXPORT_SYMBOL_GPL(nand_unlock);
3257
EXPORT_SYMBOL_GPL(nand_scan);
3258 3259
EXPORT_SYMBOL_GPL(nand_scan_ident);
EXPORT_SYMBOL_GPL(nand_scan_tail);
3260
EXPORT_SYMBOL_GPL(nand_release);
3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275

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);

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