nand_base.c 86.0 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
	if (chip->options & NAND_BBT_SCANLASTPAGE)
351 352
		ofs += mtd->erasesize - mtd->writesize;

353 354
	page = (int)(ofs >> chip->page_shift) & chip->pagemask;

L
Linus Torvalds 已提交
355
	if (getchip) {
356
		chipnr = (int)(ofs >> chip->chip_shift);
L
Linus Torvalds 已提交
357

358
		nand_get_device(chip, mtd, FL_READING);
L
Linus Torvalds 已提交
359 360

		/* Select the NAND device */
361
		chip->select_chip(mtd, chipnr);
362
	}
L
Linus Torvalds 已提交
363

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

377 378 379 380 381
	if (likely(chip->badblockbits == 8))
		res = bad != 0xFF;
	else
		res = hweight8(bad) < chip->badblockbits;

382
	if (getchip)
L
Linus Torvalds 已提交
383
		nand_release_device(mtd);
384

L
Linus Torvalds 已提交
385 386 387 388 389 390 391 392 393 394 395 396 397
	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)
{
398
	struct nand_chip *chip = mtd->priv;
399
	uint8_t buf[2] = { 0, 0 };
400
	int block, ret;
401

402
	if (chip->options & NAND_BBT_SCANLASTPAGE)
403 404
		ofs += mtd->erasesize - mtd->writesize;

L
Linus Torvalds 已提交
405
	/* Get block number */
406
	block = (int)(ofs >> chip->bbt_erase_shift);
407 408
	if (chip->bbt)
		chip->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
L
Linus Torvalds 已提交
409 410

	/* Do we have a flash based bad block table ? */
411
	if (chip->options & NAND_USE_FLASH_BBT)
412 413 414 415 416
		ret = nand_update_bbt(mtd, ofs);
	else {
		/* We write two bytes, so we dont have to mess with 16 bit
		 * access
		 */
417
		nand_get_device(chip, mtd, FL_WRITING);
418
		ofs += mtd->oobsize;
419
		chip->ops.len = chip->ops.ooblen = 2;
420 421 422 423 424
		chip->ops.datbuf = NULL;
		chip->ops.oobbuf = buf;
		chip->ops.ooboffs = chip->badblockpos & ~0x01;

		ret = nand_do_write_oob(mtd, ofs, &chip->ops);
425
		nand_release_device(mtd);
426 427 428
	}
	if (!ret)
		mtd->ecc_stats.badblocks++;
429

430
	return ret;
L
Linus Torvalds 已提交
431 432
}

433
/**
L
Linus Torvalds 已提交
434 435
 * nand_check_wp - [GENERIC] check if the chip is write protected
 * @mtd:	MTD device structure
436
 * Check, if the device is write protected
L
Linus Torvalds 已提交
437
 *
438
 * The function expects, that the device is already selected
L
Linus Torvalds 已提交
439
 */
440
static int nand_check_wp(struct mtd_info *mtd)
L
Linus Torvalds 已提交
441
{
442
	struct nand_chip *chip = mtd->priv;
443 444 445 446 447

	/* broken xD cards report WP despite being writable */
	if (chip->options & NAND_BROKEN_XD)
		return 0;

L
Linus Torvalds 已提交
448
	/* Check the WP bit */
449 450
	chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
	return (chip->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
L
Linus Torvalds 已提交
451 452 453 454 455 456 457 458 459 460 461 462
}

/**
 * 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.
 */
463 464
static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip,
			       int allowbbt)
L
Linus Torvalds 已提交
465
{
466
	struct nand_chip *chip = mtd->priv;
467

468 469
	if (!chip->bbt)
		return chip->block_bad(mtd, ofs, getchip);
470

L
Linus Torvalds 已提交
471
	/* Return info from the table */
472
	return nand_isbad_bbt(mtd, ofs, allowbbt);
L
Linus Torvalds 已提交
473 474
}

475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
/**
 * 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);
	}
}

497
/*
498 499 500
 * Wait for the ready pin, after a command
 * The timeout is catched later.
 */
501
void nand_wait_ready(struct mtd_info *mtd)
502
{
503
	struct nand_chip *chip = mtd->priv;
504
	unsigned long timeo = jiffies + 2;
505

506 507 508 509
	/* 400ms timeout */
	if (in_interrupt() || oops_in_progress)
		return panic_nand_wait_ready(mtd, 400);

510
	led_trigger_event(nand_led_trigger, LED_FULL);
511 512
	/* wait until command is processed or timeout occures */
	do {
513
		if (chip->dev_ready(mtd))
514
			break;
I
Ingo Molnar 已提交
515
		touch_softlockup_watchdog();
516
	} while (time_before(jiffies, timeo));
517
	led_trigger_event(nand_led_trigger, LED_OFF);
518
}
519
EXPORT_SYMBOL_GPL(nand_wait_ready);
520

L
Linus Torvalds 已提交
521 522 523 524 525 526 527 528 529 530
/**
 * 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)
 */
531 532
static void nand_command(struct mtd_info *mtd, unsigned int command,
			 int column, int page_addr)
L
Linus Torvalds 已提交
533
{
534
	register struct nand_chip *chip = mtd->priv;
535
	int ctrl = NAND_CTRL_CLE | NAND_CTRL_CHANGE;
L
Linus Torvalds 已提交
536 537 538 539 540 541 542

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

J
Joern Engel 已提交
543
		if (column >= mtd->writesize) {
L
Linus Torvalds 已提交
544
			/* OOB area */
J
Joern Engel 已提交
545
			column -= mtd->writesize;
L
Linus Torvalds 已提交
546 547 548 549 550 551 552 553
			readcmd = NAND_CMD_READOOB;
		} else if (column < 256) {
			/* First 256 bytes --> READ0 */
			readcmd = NAND_CMD_READ0;
		} else {
			column -= 256;
			readcmd = NAND_CMD_READ1;
		}
554
		chip->cmd_ctrl(mtd, readcmd, ctrl);
555
		ctrl &= ~NAND_CTRL_CHANGE;
L
Linus Torvalds 已提交
556
	}
557
	chip->cmd_ctrl(mtd, command, ctrl);
L
Linus Torvalds 已提交
558

559 560 561 562 563 564 565
	/*
	 * Address cycle, when necessary
	 */
	ctrl = NAND_CTRL_ALE | NAND_CTRL_CHANGE;
	/* Serially input address */
	if (column != -1) {
		/* Adjust columns for 16 bit buswidth */
566
		if (chip->options & NAND_BUSWIDTH_16)
567
			column >>= 1;
568
		chip->cmd_ctrl(mtd, column, ctrl);
569 570 571
		ctrl &= ~NAND_CTRL_CHANGE;
	}
	if (page_addr != -1) {
572
		chip->cmd_ctrl(mtd, page_addr, ctrl);
573
		ctrl &= ~NAND_CTRL_CHANGE;
574
		chip->cmd_ctrl(mtd, page_addr >> 8, ctrl);
575
		/* One more address cycle for devices > 32MiB */
576 577
		if (chip->chipsize > (32 << 20))
			chip->cmd_ctrl(mtd, page_addr >> 16, ctrl);
L
Linus Torvalds 已提交
578
	}
579
	chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
580 581 582

	/*
	 * program and erase have their own busy handlers
L
Linus Torvalds 已提交
583
	 * status and sequential in needs no delay
584
	 */
L
Linus Torvalds 已提交
585
	switch (command) {
586

L
Linus Torvalds 已提交
587 588 589 590 591 592 593 594
	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:
595
		if (chip->dev_ready)
L
Linus Torvalds 已提交
596
			break;
597 598
		udelay(chip->chip_delay);
		chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
599
			       NAND_CTRL_CLE | NAND_CTRL_CHANGE);
600 601
		chip->cmd_ctrl(mtd,
			       NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
602
		while (!(chip->read_byte(mtd) & NAND_STATUS_READY)) ;
L
Linus Torvalds 已提交
603 604
		return;

605
		/* This applies to read commands */
L
Linus Torvalds 已提交
606
	default:
607
		/*
L
Linus Torvalds 已提交
608 609
		 * If we don't have access to the busy pin, we apply the given
		 * command delay
610
		 */
611 612
		if (!chip->dev_ready) {
			udelay(chip->chip_delay);
L
Linus Torvalds 已提交
613
			return;
614
		}
L
Linus Torvalds 已提交
615 616 617
	}
	/* Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine. */
618
	ndelay(100);
619 620

	nand_wait_ready(mtd);
L
Linus Torvalds 已提交
621 622 623 624 625 626 627 628 629
}

/**
 * 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
 *
630 631 632
 * 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 已提交
633
 */
634 635
static void nand_command_lp(struct mtd_info *mtd, unsigned int command,
			    int column, int page_addr)
L
Linus Torvalds 已提交
636
{
637
	register struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
638 639 640

	/* Emulate NAND_CMD_READOOB */
	if (command == NAND_CMD_READOOB) {
J
Joern Engel 已提交
641
		column += mtd->writesize;
L
Linus Torvalds 已提交
642 643
		command = NAND_CMD_READ0;
	}
644

645
	/* Command latch cycle */
646
	chip->cmd_ctrl(mtd, command & 0xff,
647
		       NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
L
Linus Torvalds 已提交
648 649

	if (column != -1 || page_addr != -1) {
650
		int ctrl = NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE;
L
Linus Torvalds 已提交
651 652 653 654

		/* Serially input address */
		if (column != -1) {
			/* Adjust columns for 16 bit buswidth */
655
			if (chip->options & NAND_BUSWIDTH_16)
L
Linus Torvalds 已提交
656
				column >>= 1;
657
			chip->cmd_ctrl(mtd, column, ctrl);
658
			ctrl &= ~NAND_CTRL_CHANGE;
659
			chip->cmd_ctrl(mtd, column >> 8, ctrl);
660
		}
L
Linus Torvalds 已提交
661
		if (page_addr != -1) {
662 663
			chip->cmd_ctrl(mtd, page_addr, ctrl);
			chip->cmd_ctrl(mtd, page_addr >> 8,
664
				       NAND_NCE | NAND_ALE);
L
Linus Torvalds 已提交
665
			/* One more address cycle for devices > 128MiB */
666 667
			if (chip->chipsize > (128 << 20))
				chip->cmd_ctrl(mtd, page_addr >> 16,
668
					       NAND_NCE | NAND_ALE);
L
Linus Torvalds 已提交
669 670
		}
	}
671
	chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
672 673 674

	/*
	 * program and erase have their own busy handlers
675 676
	 * status, sequential in, and deplete1 need no delay
	 */
L
Linus Torvalds 已提交
677
	switch (command) {
678

L
Linus Torvalds 已提交
679 680 681 682 683
	case NAND_CMD_CACHEDPROG:
	case NAND_CMD_PAGEPROG:
	case NAND_CMD_ERASE1:
	case NAND_CMD_ERASE2:
	case NAND_CMD_SEQIN:
684
	case NAND_CMD_RNDIN:
L
Linus Torvalds 已提交
685
	case NAND_CMD_STATUS:
686
	case NAND_CMD_DEPLETE1:
L
Linus Torvalds 已提交
687 688
		return;

689 690 691
		/*
		 * read error status commands require only a short delay
		 */
692 693 694 695 696
	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:
697
		udelay(chip->chip_delay);
698
		return;
L
Linus Torvalds 已提交
699 700

	case NAND_CMD_RESET:
701
		if (chip->dev_ready)
L
Linus Torvalds 已提交
702
			break;
703
		udelay(chip->chip_delay);
704 705 706 707
		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);
708
		while (!(chip->read_byte(mtd) & NAND_STATUS_READY)) ;
L
Linus Torvalds 已提交
709 710
		return;

711 712 713 714 715 716 717 718
	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 已提交
719
	case NAND_CMD_READ0:
720 721 722 723
		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);
724

725
		/* This applies to read commands */
L
Linus Torvalds 已提交
726
	default:
727
		/*
L
Linus Torvalds 已提交
728 729
		 * If we don't have access to the busy pin, we apply the given
		 * command delay
730
		 */
731 732
		if (!chip->dev_ready) {
			udelay(chip->chip_delay);
L
Linus Torvalds 已提交
733
			return;
734
		}
L
Linus Torvalds 已提交
735
	}
736

L
Linus Torvalds 已提交
737 738
	/* Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine. */
739
	ndelay(100);
740 741

	nand_wait_ready(mtd);
L
Linus Torvalds 已提交
742 743
}

744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
/**
 * 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 已提交
760 761
/**
 * nand_get_device - [GENERIC] Get chip for selected access
R
Randy Dunlap 已提交
762
 * @chip:	the nand chip descriptor
L
Linus Torvalds 已提交
763
 * @mtd:	MTD device structure
764
 * @new_state:	the state which is requested
L
Linus Torvalds 已提交
765 766 767
 *
 * Get the device and lock it for exclusive access
 */
768
static int
769
nand_get_device(struct nand_chip *chip, struct mtd_info *mtd, int new_state)
L
Linus Torvalds 已提交
770
{
771 772
	spinlock_t *lock = &chip->controller->lock;
	wait_queue_head_t *wq = &chip->controller->wq;
773 774
	DECLARE_WAITQUEUE(wait, current);
 retry:
775 776
	spin_lock(lock);

777
	/* Hardware controller shared among independent devices */
778 779
	if (!chip->controller->active)
		chip->controller->active = chip;
T
Thomas Gleixner 已提交
780

781 782
	if (chip->controller->active == chip && chip->state == FL_READY) {
		chip->state = new_state;
783
		spin_unlock(lock);
784 785 786
		return 0;
	}
	if (new_state == FL_PM_SUSPENDED) {
787 788 789 790 791
		if (chip->controller->active->state == FL_PM_SUSPENDED) {
			chip->state = FL_PM_SUSPENDED;
			spin_unlock(lock);
			return 0;
		}
792 793 794 795 796 797
	}
	set_current_state(TASK_UNINTERRUPTIBLE);
	add_wait_queue(wq, &wait);
	spin_unlock(lock);
	schedule();
	remove_wait_queue(wq, &wait);
L
Linus Torvalds 已提交
798 799 800
	goto retry;
}

801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
/**
 * 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 已提交
827 828 829
/**
 * nand_wait - [DEFAULT]  wait until the command is done
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
830
 * @chip:	NAND chip structure
L
Linus Torvalds 已提交
831 832
 *
 * Wait for command done. This applies to erase and program only
833
 * Erase can take up to 400ms and program up to 20ms according to
L
Linus Torvalds 已提交
834
 * general NAND and SmartMedia specs
R
Randy Dunlap 已提交
835
 */
836
static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
L
Linus Torvalds 已提交
837 838
{

839
	unsigned long timeo = jiffies;
840
	int status, state = chip->state;
841

L
Linus Torvalds 已提交
842
	if (state == FL_ERASING)
843
		timeo += (HZ * 400) / 1000;
L
Linus Torvalds 已提交
844
	else
845
		timeo += (HZ * 20) / 1000;
L
Linus Torvalds 已提交
846

847 848
	led_trigger_event(nand_led_trigger, LED_FULL);

L
Linus Torvalds 已提交
849 850
	/* Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine. */
851
	ndelay(100);
L
Linus Torvalds 已提交
852

853 854
	if ((state == FL_ERASING) && (chip->options & NAND_IS_AND))
		chip->cmdfunc(mtd, NAND_CMD_STATUS_MULTI, -1, -1);
855
	else
856
		chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
L
Linus Torvalds 已提交
857

858 859 860 861 862 863 864 865 866 867 868 869
	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 已提交
870 871
		}
	}
872 873
	led_trigger_event(nand_led_trigger, LED_OFF);

874
	status = (int)chip->read_byte(mtd);
L
Linus Torvalds 已提交
875 876 877
	return status;
}

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 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
/**
 * __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;
}

1040 1041 1042 1043 1044
/**
 * 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
1045
 * @page:	page number to read
1046 1047
 *
 * Not for syndrome calculating ecc controllers, which use a special oob layout
1048 1049
 */
static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1050
			      uint8_t *buf, int page)
1051 1052 1053 1054 1055 1056
{
	chip->read_buf(mtd, buf, mtd->writesize);
	chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
	return 0;
}

1057 1058 1059 1060 1061
/**
 * 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
1062
 * @page:	page number to read
1063 1064 1065 1066
 *
 * 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,
1067
			      uint8_t *buf, int page)
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
{
	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 已提交
1099
/**
1100
 * nand_read_page_swecc - [REPLACABLE] software ecc based page read function
1101 1102 1103
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
1104
 * @page:	page number to read
1105
 */
1106
static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
1107
				uint8_t *buf, int page)
L
Linus Torvalds 已提交
1108
{
1109 1110 1111 1112
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1113 1114
	uint8_t *ecc_calc = chip->buffers->ecccalc;
	uint8_t *ecc_code = chip->buffers->ecccode;
1115
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1116

1117
	chip->ecc.read_page_raw(mtd, chip, buf, page);
1118 1119 1120 1121 1122

	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++)
1123
		ecc_code[i] = chip->oob_poi[eccpos[i]];
1124 1125 1126 1127 1128 1129 1130 1131

	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]);
1132
		if (stat < 0)
1133 1134 1135 1136 1137
			mtd->ecc_stats.failed++;
		else
			mtd->ecc_stats.corrected += stat;
	}
	return 0;
1138
}
L
Linus Torvalds 已提交
1139

1140 1141 1142 1143
/**
 * nand_read_subpage - [REPLACABLE] software ecc based sub-page read function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
1144 1145 1146
 * @data_offs:	offset of requested data within the page
 * @readlen:	data length
 * @bufpoi:	buffer to store read data
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 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
 */
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;
}

1221
/**
1222
 * nand_read_page_hwecc - [REPLACABLE] hardware ecc based page read function
1223 1224 1225
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
1226
 * @page:	page number to read
1227
 *
1228
 * Not for syndrome calculating ecc controllers which need a special oob layout
1229
 */
1230
static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
1231
				uint8_t *buf, int page)
L
Linus Torvalds 已提交
1232
{
1233 1234 1235 1236
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1237 1238
	uint8_t *ecc_calc = chip->buffers->ecccalc;
	uint8_t *ecc_code = chip->buffers->ecccode;
1239
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1240 1241 1242 1243 1244

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

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

1251 1252
	eccsteps = chip->ecc.steps;
	p = buf;
1253

1254 1255
	for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		int stat;
L
Linus Torvalds 已提交
1256

1257
		stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
1258
		if (stat < 0)
1259 1260 1261 1262 1263 1264
			mtd->ecc_stats.failed++;
		else
			mtd->ecc_stats.corrected += stat;
	}
	return 0;
}
L
Linus Torvalds 已提交
1265

1266 1267 1268 1269 1270
/**
 * 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
1271
 * @page:	page number to read
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 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314
 *
 * 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;
}

1315
/**
1316
 * nand_read_page_syndrome - [REPLACABLE] hardware ecc syndrom based page read
1317 1318 1319
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
1320
 * @page:	page number to read
1321 1322
 *
 * The hw generator calculates the error syndrome automatically. Therefor
1323
 * we need a special oob layout and handling.
1324 1325
 */
static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1326
				   uint8_t *buf, int page)
1327 1328 1329 1330 1331
{
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1332
	uint8_t *oob = chip->oob_poi;
L
Linus Torvalds 已提交
1333

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

1337 1338
		chip->ecc.hwctl(mtd, NAND_ECC_READ);
		chip->read_buf(mtd, p, eccsize);
L
Linus Torvalds 已提交
1339

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

1345 1346 1347
		chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
		chip->read_buf(mtd, oob, eccbytes);
		stat = chip->ecc.correct(mtd, p, oob, NULL);
1348

1349
		if (stat < 0)
1350
			mtd->ecc_stats.failed++;
1351
		else
1352
			mtd->ecc_stats.corrected += stat;
1353

1354
		oob += eccbytes;
L
Linus Torvalds 已提交
1355

1356 1357 1358
		if (chip->ecc.postpad) {
			chip->read_buf(mtd, oob, chip->ecc.postpad);
			oob += chip->ecc.postpad;
1359
		}
1360
	}
L
Linus Torvalds 已提交
1361

1362
	/* Calculate remaining oob bytes */
1363
	i = mtd->oobsize - (oob - chip->oob_poi);
1364 1365
	if (i)
		chip->read_buf(mtd, oob, i);
1366

1367 1368
	return 0;
}
L
Linus Torvalds 已提交
1369

1370
/**
1371 1372
 * nand_transfer_oob - [Internal] Transfer oob to client buffer
 * @chip:	nand chip structure
R
Randy Dunlap 已提交
1373
 * @oob:	oob destination address
1374
 * @ops:	oob ops structure
1375
 * @len:	size of oob to transfer
1376 1377
 */
static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
1378
				  struct mtd_oob_ops *ops, size_t len)
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388
{
	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;
1389 1390
		uint32_t boffs = 0, roffs = ops->ooboffs;
		size_t bytes = 0;
1391 1392

		for(; free->length && len; free++, len -= bytes) {
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407
			/* 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);
1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419
			oob += bytes;
		}
		return oob;
	}
	default:
		BUG();
	}
	return NULL;
}

/**
 * nand_do_read_ops - [Internal] Read data with ECC
1420 1421 1422
 *
 * @mtd:	MTD device structure
 * @from:	offset to read from
R
Randy Dunlap 已提交
1423
 * @ops:	oob ops structure
1424 1425 1426
 *
 * Internal function. Called with chip held.
 */
1427 1428
static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
1429 1430 1431 1432 1433 1434 1435
{
	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;
1436
	uint32_t readlen = ops->len;
1437
	uint32_t oobreadlen = ops->ooblen;
1438 1439 1440
	uint32_t max_oobsize = ops->mode == MTD_OOB_AUTO ?
		mtd->oobavail : mtd->oobsize;

1441
	uint8_t *bufpoi, *oob, *buf;
L
Linus Torvalds 已提交
1442

1443
	stats = mtd->ecc_stats;
L
Linus Torvalds 已提交
1444

1445 1446
	chipnr = (int)(from >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);
1447

1448 1449
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1450

1451
	col = (int)(from & (mtd->writesize - 1));
1452

1453 1454 1455
	buf = ops->datbuf;
	oob = ops->oobbuf;

1456 1457 1458
	while(1) {
		bytes = min(mtd->writesize - col, readlen);
		aligned = (bytes == mtd->writesize);
1459

1460
		/* Is the current page in the buffer ? */
1461
		if (realpage != chip->pagebuf || oob) {
1462
			bufpoi = aligned ? buf : chip->buffers->databuf;
1463

1464 1465 1466
			if (likely(sndcmd)) {
				chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
				sndcmd = 0;
L
Linus Torvalds 已提交
1467 1468
			}

1469
			/* Now read the page into the buffer */
1470
			if (unlikely(ops->mode == MTD_OOB_RAW))
1471 1472
				ret = chip->ecc.read_page_raw(mtd, chip,
							      bufpoi, page);
1473 1474
			else if (!aligned && NAND_SUBPAGE_READ(chip) && !oob)
				ret = chip->ecc.read_subpage(mtd, chip, col, bytes, bufpoi);
1475
			else
1476 1477
				ret = chip->ecc.read_page(mtd, chip, bufpoi,
							  page);
1478
			if (ret < 0)
L
Linus Torvalds 已提交
1479
				break;
1480 1481 1482

			/* Transfer not aligned data */
			if (!aligned) {
1483 1484
				if (!NAND_SUBPAGE_READ(chip) && !oob)
					chip->pagebuf = realpage;
1485
				memcpy(buf, chip->buffers->databuf + col, bytes);
1486 1487
			}

1488 1489 1490
			buf += bytes;

			if (unlikely(oob)) {
1491

1492 1493 1494 1495 1496 1497 1498
				int toread = min(oobreadlen, max_oobsize);

				if (toread) {
					oob = nand_transfer_oob(chip,
						oob, ops, toread);
					oobreadlen -= toread;
				}
1499 1500
			}

1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
			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 已提交
1513
			}
1514
		} else {
1515
			memcpy(buf, chip->buffers->databuf + col, bytes);
1516 1517
			buf += bytes;
		}
L
Linus Torvalds 已提交
1518

1519
		readlen -= bytes;
1520

1521
		if (!readlen)
1522
			break;
L
Linus Torvalds 已提交
1523 1524 1525 1526 1527 1528

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

1529
		page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1530 1531 1532
		/* Check, if we cross a chip boundary */
		if (!page) {
			chipnr++;
1533 1534
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1535
		}
1536

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

1544
	ops->retlen = ops->len - (size_t) readlen;
1545 1546
	if (oob)
		ops->oobretlen = ops->ooblen - oobreadlen;
L
Linus Torvalds 已提交
1547

1548 1549 1550
	if (ret)
		return ret;

1551 1552 1553 1554
	if (mtd->ecc_stats.failed - stats.failed)
		return -EBADMSG;

	return  mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
}

/**
 * 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)
{
1570
	struct nand_chip *chip = mtd->priv;
1571 1572 1573 1574 1575 1576 1577 1578
	int ret;

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

1579
	nand_get_device(chip, mtd, FL_READING);
1580

1581 1582 1583 1584 1585
	chip->ops.len = len;
	chip->ops.datbuf = buf;
	chip->ops.oobbuf = NULL;

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

R
Richard Purdie 已提交
1587 1588
	*retlen = chip->ops.retlen;

1589 1590 1591
	nand_release_device(mtd);

	return ret;
L
Linus Torvalds 已提交
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 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670
/**
 * 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 已提交
1671
	return status & NAND_STATUS_FAIL ? -EIO : 0;
1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697
}

/**
 * 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
1698
		pos = eccsize;
1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732

	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 已提交
1733
/**
1734
 * nand_do_read_oob - [Intern] NAND read out-of-band
L
Linus Torvalds 已提交
1735 1736
 * @mtd:	MTD device structure
 * @from:	offset to read from
1737
 * @ops:	oob operations description structure
L
Linus Torvalds 已提交
1738 1739 1740
 *
 * NAND read out-of-band data from the spare area
 */
1741 1742
static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1743
{
1744
	int page, realpage, chipnr, sndcmd = 1;
1745
	struct nand_chip *chip = mtd->priv;
1746
	int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
1747 1748
	int readlen = ops->ooblen;
	int len;
1749
	uint8_t *buf = ops->oobbuf;
1750

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

1754
	if (ops->mode == MTD_OOB_AUTO)
1755
		len = chip->ecc.layout->oobavail;
1756 1757 1758 1759
	else
		len = mtd->oobsize;

	if (unlikely(ops->ooboffs >= len)) {
1760 1761
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to start read "
					"outside oob\n", __func__);
1762 1763 1764 1765 1766 1767 1768
		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)) {
1769 1770
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt read beyond end "
					"of device\n", __func__);
1771 1772
		return -EINVAL;
	}
1773

1774
	chipnr = (int)(from >> chip->chip_shift);
1775
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1776

1777 1778 1779
	/* Shift to get page */
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1780

1781
	while(1) {
1782
		sndcmd = chip->ecc.read_oob(mtd, chip, page, sndcmd);
1783 1784 1785

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

1787 1788 1789 1790 1791 1792
		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.
1793
			 */
1794 1795
			if (!chip->dev_ready)
				udelay(chip->chip_delay);
1796 1797
			else
				nand_wait_ready(mtd);
1798
		}
1799

1800
		readlen -= len;
S
Savin Zlobec 已提交
1801 1802 1803
		if (!readlen)
			break;

1804 1805 1806 1807 1808 1809 1810 1811 1812
		/* 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 已提交
1813
		}
1814 1815 1816 1817 1818 1819

		/* 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 已提交
1820 1821
	}

1822
	ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
1823 1824 1825 1826
	return 0;
}

/**
1827
 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
L
Linus Torvalds 已提交
1828 1829
 * @mtd:	MTD device structure
 * @from:	offset to read from
1830
 * @ops:	oob operation description structure
L
Linus Torvalds 已提交
1831
 *
1832
 * NAND read data and/or out-of-band data
L
Linus Torvalds 已提交
1833
 */
1834 1835
static int nand_read_oob(struct mtd_info *mtd, loff_t from,
			 struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1836
{
1837
	struct nand_chip *chip = mtd->priv;
1838 1839 1840
	int ret = -ENOTSUPP;

	ops->retlen = 0;
L
Linus Torvalds 已提交
1841 1842

	/* Do not allow reads past end of device */
1843
	if (ops->datbuf && (from + ops->len) > mtd->size) {
1844 1845
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt read "
				"beyond end of device\n", __func__);
L
Linus Torvalds 已提交
1846 1847 1848
		return -EINVAL;
	}

1849
	nand_get_device(chip, mtd, FL_READING);
L
Linus Torvalds 已提交
1850

1851 1852 1853 1854 1855
	switch(ops->mode) {
	case MTD_OOB_PLACE:
	case MTD_OOB_AUTO:
	case MTD_OOB_RAW:
		break;
L
Linus Torvalds 已提交
1856

1857 1858 1859
	default:
		goto out;
	}
L
Linus Torvalds 已提交
1860

1861 1862 1863 1864
	if (!ops->datbuf)
		ret = nand_do_read_oob(mtd, from, ops);
	else
		ret = nand_do_read_ops(mtd, from, ops);
1865

1866 1867 1868 1869
 out:
	nand_release_device(mtd);
	return ret;
}
1870

L
Linus Torvalds 已提交
1871

1872 1873 1874 1875 1876
/**
 * nand_write_page_raw - [Intern] raw page write function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
1877 1878
 *
 * Not for syndrome calculating ecc controllers, which use a special oob layout
1879 1880 1881 1882 1883 1884
 */
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 已提交
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 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924
/**
 * 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);
}
1925
/**
1926
 * nand_write_page_swecc - [REPLACABLE] software ecc based page write function
1927 1928 1929
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
1930
 */
1931 1932
static void nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
				  const uint8_t *buf)
1933
{
1934 1935 1936
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
1937
	uint8_t *ecc_calc = chip->buffers->ecccalc;
1938
	const uint8_t *p = buf;
1939
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1940

1941 1942 1943
	/* Software ecc calculation */
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1944

1945 1946
	for (i = 0; i < chip->ecc.total; i++)
		chip->oob_poi[eccpos[i]] = ecc_calc[i];
1947

1948
	chip->ecc.write_page_raw(mtd, chip, buf);
1949
}
1950

1951
/**
1952
 * nand_write_page_hwecc - [REPLACABLE] hardware ecc based page write function
1953 1954 1955 1956 1957 1958 1959 1960 1961 1962
 * @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;
1963
	uint8_t *ecc_calc = chip->buffers->ecccalc;
1964
	const uint8_t *p = buf;
1965
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1966

1967 1968
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
1969
		chip->write_buf(mtd, p, eccsize);
1970
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1971 1972
	}

1973 1974 1975 1976
	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);
1977 1978
}

1979
/**
1980
 * nand_write_page_syndrome - [REPLACABLE] hardware ecc syndrom based page write
1981 1982 1983
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
L
Linus Torvalds 已提交
1984
 *
1985 1986 1987 1988 1989
 * 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 已提交
1990
{
1991 1992 1993 1994 1995
	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 已提交
1996

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

1999 2000
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
		chip->write_buf(mtd, p, eccsize);
2001

2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013
		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 已提交
2014 2015
		}
	}
2016 2017

	/* Calculate remaining oob bytes */
2018
	i = mtd->oobsize - (oob - chip->oob_poi);
2019 2020 2021 2022 2023
	if (i)
		chip->write_buf(mtd, oob, i);
}

/**
2024
 * nand_write_page - [REPLACEABLE] write one page
2025 2026 2027 2028 2029
 * @mtd:	MTD device structure
 * @chip:	NAND chip descriptor
 * @buf:	the data to write
 * @page:	page number to write
 * @cached:	cached programming
2030
 * @raw:	use _raw version of write_page
2031 2032
 */
static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
2033
			   const uint8_t *buf, int page, int cached, int raw)
2034 2035 2036 2037 2038
{
	int status;

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

2039 2040 2041 2042
	if (unlikely(raw))
		chip->ecc.write_page_raw(mtd, chip, buf);
	else
		chip->ecc.write_page(mtd, chip, buf);
2043 2044 2045 2046 2047 2048 2049 2050 2051 2052

	/*
	 * 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);
2053
		status = chip->waitfunc(mtd, chip);
2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065
		/*
		 * 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);
2066
		status = chip->waitfunc(mtd, chip);
2067 2068 2069 2070 2071 2072 2073 2074 2075 2076
	}

#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 已提交
2077 2078
}

2079 2080 2081 2082 2083 2084
/**
 * nand_fill_oob - [Internal] Transfer client buffer to oob
 * @chip:	nand chip structure
 * @oob:	oob data buffer
 * @ops:	oob ops structure
 */
2085 2086
static uint8_t *nand_fill_oob(struct nand_chip *chip, uint8_t *oob, size_t len,
						struct mtd_oob_ops *ops)
2087 2088 2089 2090 2091 2092 2093 2094 2095 2096
{
	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;
2097 2098
		uint32_t boffs = 0, woffs = ops->ooboffs;
		size_t bytes = 0;
2099 2100

		for(; free->length && len; free++, len -= bytes) {
2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114
			/* 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;
			}
2115
			memcpy(chip->oob_poi + boffs, oob, bytes);
2116 2117 2118 2119 2120 2121 2122 2123 2124 2125
			oob += bytes;
		}
		return oob;
	}
	default:
		BUG();
	}
	return NULL;
}

2126
#define NOTALIGNED(x)	(x & (chip->subpagesize - 1)) != 0
L
Linus Torvalds 已提交
2127 2128

/**
2129
 * nand_do_write_ops - [Internal] NAND write with ECC
L
Linus Torvalds 已提交
2130 2131
 * @mtd:	MTD device structure
 * @to:		offset to write to
2132
 * @ops:	oob operations description structure
L
Linus Torvalds 已提交
2133 2134 2135
 *
 * NAND write with ECC
 */
2136 2137
static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
2138
{
2139
	int chipnr, realpage, page, blockmask, column;
2140
	struct nand_chip *chip = mtd->priv;
2141
	uint32_t writelen = ops->len;
2142 2143 2144 2145 2146

	uint32_t oobwritelen = ops->ooblen;
	uint32_t oobmaxlen = ops->mode == MTD_OOB_AUTO ?
				mtd->oobavail : mtd->oobsize;

2147 2148
	uint8_t *oob = ops->oobbuf;
	uint8_t *buf = ops->datbuf;
2149
	int ret, subpage;
L
Linus Torvalds 已提交
2150

2151
	ops->retlen = 0;
2152 2153
	if (!writelen)
		return 0;
L
Linus Torvalds 已提交
2154

2155
	/* reject writes, which are not page aligned */
2156
	if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
2157 2158
		printk(KERN_NOTICE "%s: Attempt to write not "
				"page aligned data\n", __func__);
L
Linus Torvalds 已提交
2159 2160 2161
		return -EINVAL;
	}

2162 2163 2164 2165 2166
	column = to & (mtd->writesize - 1);
	subpage = column || (writelen & (mtd->writesize - 1));

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

2168 2169 2170
	chipnr = (int)(to >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);

L
Linus Torvalds 已提交
2171 2172
	/* Check, if it is write protected */
	if (nand_check_wp(mtd))
2173
		return -EIO;
L
Linus Torvalds 已提交
2174

2175 2176 2177 2178 2179 2180
	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) &&
2181
	    (chip->pagebuf << chip->page_shift) < (to + ops->len))
2182
		chip->pagebuf = -1;
2183

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

2188 2189 2190 2191
	/* Don't allow multipage oob writes with offset */
	if (ops->ooboffs && (ops->ooboffs + ops->ooblen > oobmaxlen))
		return -EINVAL;

2192
	while(1) {
2193
		int bytes = mtd->writesize;
2194
		int cached = writelen > bytes && page != blockmask;
2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205
		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 已提交
2206

2207 2208 2209 2210 2211
		if (unlikely(oob)) {
			size_t len = min(oobwritelen, oobmaxlen);
			oob = nand_fill_oob(chip, oob, len, ops);
			oobwritelen -= len;
		}
2212

2213
		ret = chip->write_page(mtd, chip, wbuf, page, cached,
2214
				       (ops->mode == MTD_OOB_RAW));
2215 2216 2217 2218 2219 2220 2221
		if (ret)
			break;

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

2222
		column = 0;
2223 2224 2225 2226 2227 2228 2229 2230 2231
		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 已提交
2232 2233
		}
	}
2234 2235

	ops->retlen = ops->len - writelen;
2236 2237
	if (unlikely(oob))
		ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
2238 2239 2240
	return ret;
}

2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279
/**
 * 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;
}

2280
/**
2281
 * nand_write - [MTD Interface] NAND write with ECC
2282 2283 2284
 * @mtd:	MTD device structure
 * @to:		offset to write to
 * @len:	number of bytes to write
2285 2286
 * @retlen:	pointer to variable to store the number of written bytes
 * @buf:	the data to write
2287
 *
2288
 * NAND write with ECC
2289
 */
2290 2291
static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
			  size_t *retlen, const uint8_t *buf)
2292 2293 2294 2295
{
	struct nand_chip *chip = mtd->priv;
	int ret;

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

2302
	nand_get_device(chip, mtd, FL_WRITING);
2303

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

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

R
Richard Purdie 已提交
2310 2311
	*retlen = chip->ops.retlen;

2312
	nand_release_device(mtd);
2313 2314

	return ret;
2315
}
2316

L
Linus Torvalds 已提交
2317
/**
2318
 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
L
Linus Torvalds 已提交
2319 2320
 * @mtd:	MTD device structure
 * @to:		offset to write to
2321
 * @ops:	oob operation description structure
L
Linus Torvalds 已提交
2322 2323 2324
 *
 * NAND write out-of-band
 */
2325 2326
static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
2327
{
2328
	int chipnr, page, status, len;
2329
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2330

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

2334 2335 2336 2337 2338
	if (ops->mode == MTD_OOB_AUTO)
		len = chip->ecc.layout->oobavail;
	else
		len = mtd->oobsize;

L
Linus Torvalds 已提交
2339
	/* Do not allow write past end of page */
2340
	if ((ops->ooboffs + ops->ooblen) > len) {
2341 2342
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to write "
				"past end of page\n", __func__);
L
Linus Torvalds 已提交
2343 2344 2345
		return -EINVAL;
	}

2346
	if (unlikely(ops->ooboffs >= len)) {
2347 2348
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to start "
				"write outside oob\n", __func__);
2349 2350 2351 2352 2353 2354 2355 2356
		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)) {
2357 2358
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt write beyond "
				"end of device\n", __func__);
2359 2360 2361
		return -EINVAL;
	}

2362
	chipnr = (int)(to >> chip->chip_shift);
2363
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2364

2365 2366 2367 2368 2369 2370 2371 2372 2373
	/* 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.
	 */
2374
	chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
L
Linus Torvalds 已提交
2375 2376 2377

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

L
Linus Torvalds 已提交
2380
	/* Invalidate the page cache, if we write to the cached page */
2381 2382
	if (page == chip->pagebuf)
		chip->pagebuf = -1;
L
Linus Torvalds 已提交
2383

2384
	memset(chip->oob_poi, 0xff, mtd->oobsize);
2385
	nand_fill_oob(chip, ops->oobbuf, ops->ooblen, ops);
2386 2387
	status = chip->ecc.write_oob(mtd, chip, page & chip->pagemask);
	memset(chip->oob_poi, 0xff, mtd->oobsize);
L
Linus Torvalds 已提交
2388

2389 2390
	if (status)
		return status;
L
Linus Torvalds 已提交
2391

2392
	ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
2393

2394
	return 0;
2395 2396 2397 2398 2399
}

/**
 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
2400
 * @to:		offset to write to
2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411
 * @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 */
2412
	if (ops->datbuf && (to + ops->len) > mtd->size) {
2413 2414
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt write beyond "
				"end of device\n", __func__);
2415 2416 2417
		return -EINVAL;
	}

2418
	nand_get_device(chip, mtd, FL_WRITING);
2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434

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

2435
 out:
L
Linus Torvalds 已提交
2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446
	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
 */
2447
static void single_erase_cmd(struct mtd_info *mtd, int page)
L
Linus Torvalds 已提交
2448
{
2449
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2450
	/* Send commands to erase a block */
2451 2452
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
	chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
L
Linus Torvalds 已提交
2453 2454 2455 2456 2457 2458 2459 2460 2461 2462
}

/**
 * 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
 */
2463
static void multi_erase_cmd(struct mtd_info *mtd, int page)
L
Linus Torvalds 已提交
2464
{
2465
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2466
	/* Send commands to erase a block */
2467 2468 2469 2470 2471
	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 已提交
2472 2473 2474 2475 2476 2477 2478 2479 2480
}

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

2486
#define BBT_PAGE_MASK	0xffffff3f
L
Linus Torvalds 已提交
2487
/**
2488
 * nand_erase_nand - [Internal] erase block(s)
L
Linus Torvalds 已提交
2489 2490 2491 2492 2493 2494
 * @mtd:	MTD device structure
 * @instr:	erase instruction
 * @allowbbt:	allow erasing the bbt area
 *
 * Erase one ore more blocks
 */
2495 2496
int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
		    int allowbbt)
L
Linus Torvalds 已提交
2497
{
2498
	int page, status, pages_per_block, ret, chipnr;
2499
	struct nand_chip *chip = mtd->priv;
2500
	loff_t rewrite_bbt[NAND_MAX_CHIPS]={0};
2501
	unsigned int bbt_masked_page = 0xffffffff;
2502
	loff_t len;
L
Linus Torvalds 已提交
2503

2504 2505 2506
	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 已提交
2507

2508
	if (check_offs_len(mtd, instr->addr, instr->len))
L
Linus Torvalds 已提交
2509 2510
		return -EINVAL;

2511
	instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
L
Linus Torvalds 已提交
2512 2513

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

	/* Shift to get first page */
2517 2518
	page = (int)(instr->addr >> chip->page_shift);
	chipnr = (int)(instr->addr >> chip->chip_shift);
L
Linus Torvalds 已提交
2519 2520

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

	/* Select the NAND device */
2524
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2525 2526 2527

	/* Check, if it is write protected */
	if (nand_check_wp(mtd)) {
2528 2529
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Device is write protected!!!\n",
					__func__);
L
Linus Torvalds 已提交
2530 2531 2532 2533
		instr->state = MTD_ERASE_FAILED;
		goto erase_exit;
	}

2534 2535 2536 2537 2538 2539 2540 2541
	/*
	 * 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;
2542

L
Linus Torvalds 已提交
2543 2544 2545 2546 2547 2548
	/* Loop through the pages */
	len = instr->len;

	instr->state = MTD_ERASING;

	while (len) {
2549 2550 2551 2552 2553
		/*
		 * 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)) {
2554 2555
			printk(KERN_WARNING "%s: attempt to erase a bad block "
					"at page 0x%08x\n", __func__, page);
L
Linus Torvalds 已提交
2556 2557 2558
			instr->state = MTD_ERASE_FAILED;
			goto erase_exit;
		}
2559

2560 2561 2562 2563 2564 2565 2566
		/*
		 * 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 已提交
2567

2568
		chip->erase_cmd(mtd, page & chip->pagemask);
2569

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

2572 2573 2574 2575 2576 2577 2578
		/*
		 * 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);
2579

L
Linus Torvalds 已提交
2580
		/* See if block erase succeeded */
2581
		if (status & NAND_STATUS_FAIL) {
2582 2583
			DEBUG(MTD_DEBUG_LEVEL0, "%s: Failed erase, "
					"page 0x%08x\n", __func__, page);
L
Linus Torvalds 已提交
2584
			instr->state = MTD_ERASE_FAILED;
2585 2586
			instr->fail_addr =
				((loff_t)page << chip->page_shift);
L
Linus Torvalds 已提交
2587 2588
			goto erase_exit;
		}
2589

2590 2591 2592 2593 2594 2595
		/*
		 * 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)
2596 2597
			    rewrite_bbt[chipnr] =
					((loff_t)page << chip->page_shift);
2598

L
Linus Torvalds 已提交
2599
		/* Increment page address and decrement length */
2600
		len -= (1 << chip->phys_erase_shift);
L
Linus Torvalds 已提交
2601 2602 2603
		page += pages_per_block;

		/* Check, if we cross a chip boundary */
2604
		if (len && !(page & chip->pagemask)) {
L
Linus Torvalds 已提交
2605
			chipnr++;
2606 2607
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
2608

2609 2610 2611 2612 2613 2614 2615 2616
			/*
			 * 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 已提交
2617 2618 2619 2620
		}
	}
	instr->state = MTD_ERASE_DONE;

2621
 erase_exit:
L
Linus Torvalds 已提交
2622 2623 2624 2625 2626 2627

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

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

2628 2629 2630 2631
	/* Do call back function */
	if (!ret)
		mtd_erase_callback(instr);

2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642
	/*
	 * 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 */
2643 2644 2645
		DEBUG(MTD_DEBUG_LEVEL0, "%s: nand_update_bbt "
			"(%d:0x%0llx 0x%0x)\n", __func__, chipnr,
			rewrite_bbt[chipnr], chip->bbt_td->pages[chipnr]);
2646
		nand_update_bbt(mtd, rewrite_bbt[chipnr]);
2647 2648
	}

L
Linus Torvalds 已提交
2649 2650 2651 2652 2653 2654 2655 2656 2657 2658
	/* 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
 */
2659
static void nand_sync(struct mtd_info *mtd)
L
Linus Torvalds 已提交
2660
{
2661
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2662

2663
	DEBUG(MTD_DEBUG_LEVEL3, "%s: called\n", __func__);
L
Linus Torvalds 已提交
2664 2665

	/* Grab the lock and see if the device is available */
2666
	nand_get_device(chip, mtd, FL_SYNCING);
L
Linus Torvalds 已提交
2667
	/* Release it and go back */
2668
	nand_release_device(mtd);
L
Linus Torvalds 已提交
2669 2670 2671
}

/**
2672
 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
L
Linus Torvalds 已提交
2673
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
2674
 * @offs:	offset relative to mtd start
L
Linus Torvalds 已提交
2675
 */
2676
static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
L
Linus Torvalds 已提交
2677 2678
{
	/* Check for invalid offset */
2679
	if (offs > mtd->size)
L
Linus Torvalds 已提交
2680
		return -EINVAL;
2681

2682
	return nand_block_checkbad(mtd, offs, 1, 0);
L
Linus Torvalds 已提交
2683 2684 2685
}

/**
2686
 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
L
Linus Torvalds 已提交
2687 2688 2689
 * @mtd:	MTD device structure
 * @ofs:	offset relative to mtd start
 */
2690
static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
L
Linus Torvalds 已提交
2691
{
2692
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2693 2694
	int ret;

2695 2696
	if ((ret = nand_block_isbad(mtd, ofs))) {
		/* If it was bad already, return success and do nothing. */
L
Linus Torvalds 已提交
2697 2698
		if (ret > 0)
			return 0;
2699 2700
		return ret;
	}
L
Linus Torvalds 已提交
2701

2702
	return chip->block_markbad(mtd, ofs);
L
Linus Torvalds 已提交
2703 2704
}

2705 2706 2707 2708 2709 2710
/**
 * nand_suspend - [MTD Interface] Suspend the NAND flash
 * @mtd:	MTD device structure
 */
static int nand_suspend(struct mtd_info *mtd)
{
2711
	struct nand_chip *chip = mtd->priv;
2712

2713
	return nand_get_device(chip, mtd, FL_PM_SUSPENDED);
2714 2715 2716 2717 2718 2719 2720 2721
}

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

2724
	if (chip->state == FL_PM_SUSPENDED)
2725 2726
		nand_release_device(mtd);
	else
2727 2728
		printk(KERN_ERR "%s called for a chip which is not "
		       "in suspended state\n", __func__);
2729 2730
}

T
Thomas Gleixner 已提交
2731 2732 2733
/*
 * Set default functions
 */
2734
static void nand_set_defaults(struct nand_chip *chip, int busw)
T
Thomas Gleixner 已提交
2735
{
L
Linus Torvalds 已提交
2736
	/* check for proper chip_delay setup, set 20us if not */
2737 2738
	if (!chip->chip_delay)
		chip->chip_delay = 20;
L
Linus Torvalds 已提交
2739 2740

	/* check, if a user supplied command function given */
2741 2742
	if (chip->cmdfunc == NULL)
		chip->cmdfunc = nand_command;
L
Linus Torvalds 已提交
2743 2744

	/* check, if a user supplied wait function given */
2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765
	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;
2766 2767 2768 2769 2770 2771 2772

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

T
Thomas Gleixner 已提交
2773 2774 2775
}

/*
2776
 * Get the flash and manufacturer id and lookup if the type is supported
T
Thomas Gleixner 已提交
2777 2778
 */
static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
2779
						  struct nand_chip *chip,
2780 2781
						  int busw, int *maf_id,
						  struct nand_flash_dev *type)
T
Thomas Gleixner 已提交
2782
{
2783 2784
	int i, dev_id, maf_idx;
	u8 id_data[8];
L
Linus Torvalds 已提交
2785 2786

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

2789 2790 2791 2792 2793 2794
	/*
	 * 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 已提交
2795
	/* Send the command for reading device ID */
2796
	chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
L
Linus Torvalds 已提交
2797 2798

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

2802 2803 2804 2805 2806 2807 2808 2809
	/* 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);

2810
	/* Read entire ID string */
2811

2812 2813
	for (i = 0; i < 8; i++)
		id_data[i] = chip->read_byte(mtd);
2814

2815
	if (id_data[0] != *maf_id || id_data[1] != dev_id) {
2816 2817
		printk(KERN_INFO "%s: second ID read did not match "
		       "%02x,%02x against %02x,%02x\n", __func__,
2818
		       *maf_id, dev_id, id_data[0], id_data[1]);
2819 2820 2821
		return ERR_PTR(-ENODEV);
	}

T
Thomas Gleixner 已提交
2822
	if (!type)
2823 2824 2825 2826 2827 2828 2829
		type = nand_flash_ids;

	for (; type->name != NULL; type++)
		if (dev_id == type->id)
                        break;

	if (!type->name)
T
Thomas Gleixner 已提交
2830 2831
		return ERR_PTR(-ENODEV);

2832 2833 2834
	if (!mtd->name)
		mtd->name = type->name;

2835
	chip->chipsize = (uint64_t)type->chipsize << 20;
T
Thomas Gleixner 已提交
2836 2837

	/* Newer devices have all the information in additional id bytes */
2838
	if (!type->pagesize) {
T
Thomas Gleixner 已提交
2839
		int extid;
2840
		/* The 3rd id byte holds MLC / multichip data */
2841
		chip->cellinfo = id_data[2];
T
Thomas Gleixner 已提交
2842
		/* The 4th id byte is the important one */
2843
		extid = id_data[3];
2844

2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879
		/*
		 * Field definitions are in the following datasheets:
		 * Old style (4,5 byte ID): Samsung K9GAG08U0M (p.32)
		 * New style   (6 byte ID): Samsung K9GAG08U0D (p.40)
		 *
		 * Check for wraparound + Samsung ID + nonzero 6th byte
		 * to decide what to do.
		 */
		if (id_data[0] == id_data[6] && id_data[1] == id_data[7] &&
				id_data[0] == NAND_MFR_SAMSUNG &&
				id_data[5] != 0x00) {
			/* Calc pagesize */
			mtd->writesize = 2048 << (extid & 0x03);
			extid >>= 2;
			/* Calc oobsize */
			mtd->oobsize = (extid & 0x03) == 0x01 ? 128 : 218;
			extid >>= 2;
			/* Calc blocksize */
			mtd->erasesize = (128 * 1024) <<
				(((extid >> 1) & 0x04) | (extid & 0x03));
			busw = 0;
		} else {
			/* Calc pagesize */
			mtd->writesize = 1024 << (extid & 0x03);
			extid >>= 2;
			/* Calc oobsize */
			mtd->oobsize = (8 << (extid & 0x01)) *
				(mtd->writesize >> 9);
			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;
		}
T
Thomas Gleixner 已提交
2880 2881
	} else {
		/*
2882
		 * Old devices have chip data hardcoded in the device id table
T
Thomas Gleixner 已提交
2883
		 */
2884 2885
		mtd->erasesize = type->erasesize;
		mtd->writesize = type->pagesize;
2886
		mtd->oobsize = mtd->writesize / 32;
2887
		busw = type->options & NAND_BUSWIDTH_16;
T
Thomas Gleixner 已提交
2888
	}
L
Linus Torvalds 已提交
2889

T
Thomas Gleixner 已提交
2890
	/* Try to identify manufacturer */
2891
	for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
T
Thomas Gleixner 已提交
2892 2893 2894
		if (nand_manuf_ids[maf_idx].id == *maf_id)
			break;
	}
2895

T
Thomas Gleixner 已提交
2896 2897
	/*
	 * Check, if buswidth is correct. Hardware drivers should set
2898
	 * chip correct !
T
Thomas Gleixner 已提交
2899
	 */
2900
	if (busw != (chip->options & NAND_BUSWIDTH_16)) {
T
Thomas Gleixner 已提交
2901 2902 2903 2904
		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",
2905
		       (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
T
Thomas Gleixner 已提交
2906 2907 2908
		       busw ? 16 : 8);
		return ERR_PTR(-EINVAL);
	}
2909

T
Thomas Gleixner 已提交
2910
	/* Calculate the address shift from the page size */
2911
	chip->page_shift = ffs(mtd->writesize) - 1;
T
Thomas Gleixner 已提交
2912
	/* Convert chipsize to number of pages per chip -1. */
2913
	chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
2914

2915
	chip->bbt_erase_shift = chip->phys_erase_shift =
T
Thomas Gleixner 已提交
2916
		ffs(mtd->erasesize) - 1;
2917 2918 2919 2920
	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 已提交
2921

T
Thomas Gleixner 已提交
2922
	/* Set the bad block position */
2923 2924 2925 2926 2927 2928 2929 2930
	if (!(busw & NAND_BUSWIDTH_16) && (*maf_id == NAND_MFR_STMICRO ||
				(*maf_id == NAND_MFR_SAMSUNG &&
				 mtd->writesize == 512) ||
				*maf_id == NAND_MFR_AMD))
		chip->badblockpos = NAND_SMALL_BADBLOCK_POS;
	else
		chip->badblockpos = NAND_LARGE_BADBLOCK_POS;

2931

T
Thomas Gleixner 已提交
2932
	/* Get chip options, preserve non chip based options */
2933
	chip->options &= ~NAND_CHIPOPTIONS_MSK;
2934
	chip->options |= type->options & NAND_CHIPOPTIONS_MSK;
T
Thomas Gleixner 已提交
2935 2936

	/*
2937
	 * Set chip as a default. Board drivers can override it, if necessary
T
Thomas Gleixner 已提交
2938
	 */
2939
	chip->options |= NAND_NO_AUTOINCR;
T
Thomas Gleixner 已提交
2940

2941
	/* Check if chip is a not a samsung device. Do not clear the
T
Thomas Gleixner 已提交
2942 2943
	 * options for chips which are not having an extended id.
	 */
2944
	if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
2945
		chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
T
Thomas Gleixner 已提交
2946

2947 2948
	/*
	 * Bad block marker is stored in the last page of each block
2949 2950 2951 2952
	 * on Samsung and Hynix MLC devices; stored in first two pages
	 * of each block on Micron devices with 2KiB pages and on
	 * SLC Samsung, Hynix, and AMD/Spansion. All others scan only
	 * the first page.
2953 2954 2955 2956
	 */
	if ((chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
			(*maf_id == NAND_MFR_SAMSUNG ||
			 *maf_id == NAND_MFR_HYNIX))
2957
		chip->options |= NAND_BBT_SCANLASTPAGE;
2958 2959 2960 2961 2962 2963 2964 2965
	else if ((!(chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
				(*maf_id == NAND_MFR_SAMSUNG ||
				 *maf_id == NAND_MFR_HYNIX ||
				 *maf_id == NAND_MFR_AMD)) ||
			(mtd->writesize == 2048 &&
			 *maf_id == NAND_MFR_MICRON))
		chip->options |= NAND_BBT_SCAN2NDPAGE;

2966

T
Thomas Gleixner 已提交
2967
	/* Check for AND chips with 4 page planes */
2968 2969
	if (chip->options & NAND_4PAGE_ARRAY)
		chip->erase_cmd = multi_erase_cmd;
T
Thomas Gleixner 已提交
2970
	else
2971
		chip->erase_cmd = single_erase_cmd;
T
Thomas Gleixner 已提交
2972 2973

	/* Do not replace user supplied command function ! */
2974 2975
	if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
		chip->cmdfunc = nand_command_lp;
T
Thomas Gleixner 已提交
2976 2977 2978 2979 2980 2981 2982 2983 2984

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

/**
2985 2986 2987
 * nand_scan_ident - [NAND Interface] Scan for the NAND device
 * @mtd:	     MTD device structure
 * @maxchips:	     Number of chips to scan for
2988
 * @table:	     Alternative NAND ID table
T
Thomas Gleixner 已提交
2989
 *
2990 2991
 * 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 已提交
2992
 *
2993
 * The mtd->owner field must be set to the module of the caller.
T
Thomas Gleixner 已提交
2994
 */
2995 2996
int nand_scan_ident(struct mtd_info *mtd, int maxchips,
		    struct nand_flash_dev *table)
T
Thomas Gleixner 已提交
2997 2998
{
	int i, busw, nand_maf_id;
2999
	struct nand_chip *chip = mtd->priv;
T
Thomas Gleixner 已提交
3000 3001 3002
	struct nand_flash_dev *type;

	/* Get buswidth to select the correct functions */
3003
	busw = chip->options & NAND_BUSWIDTH_16;
T
Thomas Gleixner 已提交
3004
	/* Set the default functions */
3005
	nand_set_defaults(chip, busw);
T
Thomas Gleixner 已提交
3006 3007

	/* Read the flash type */
3008
	type = nand_get_flash_type(mtd, chip, busw, &nand_maf_id, table);
T
Thomas Gleixner 已提交
3009 3010

	if (IS_ERR(type)) {
3011 3012
		if (!(chip->options & NAND_SCAN_SILENT_NODEV))
			printk(KERN_WARNING "No NAND device found.\n");
3013
		chip->select_chip(mtd, -1);
T
Thomas Gleixner 已提交
3014
		return PTR_ERR(type);
L
Linus Torvalds 已提交
3015 3016
	}

T
Thomas Gleixner 已提交
3017
	/* Check for a chip array */
3018
	for (i = 1; i < maxchips; i++) {
3019
		chip->select_chip(mtd, i);
3020 3021
		/* See comment in nand_get_flash_type for reset */
		chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
L
Linus Torvalds 已提交
3022
		/* Send the command for reading device ID */
3023
		chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
L
Linus Torvalds 已提交
3024
		/* Read manufacturer and device IDs */
3025 3026
		if (nand_maf_id != chip->read_byte(mtd) ||
		    type->id != chip->read_byte(mtd))
L
Linus Torvalds 已提交
3027 3028 3029 3030
			break;
	}
	if (i > 1)
		printk(KERN_INFO "%d NAND chips detected\n", i);
3031

L
Linus Torvalds 已提交
3032
	/* Store the number of chips and calc total size for mtd */
3033 3034
	chip->numchips = i;
	mtd->size = i * chip->chipsize;
T
Thomas Gleixner 已提交
3035

3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052
	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;

3053 3054 3055 3056 3057
	if (!(chip->options & NAND_OWN_BUFFERS))
		chip->buffers = kmalloc(sizeof(*chip->buffers), GFP_KERNEL);
	if (!chip->buffers)
		return -ENOMEM;

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

T
Thomas Gleixner 已提交
3061 3062 3063
	/*
	 * If no default placement scheme is given, select an appropriate one
	 */
3064
	if (!chip->ecc.layout) {
3065
		switch (mtd->oobsize) {
L
Linus Torvalds 已提交
3066
		case 8:
3067
			chip->ecc.layout = &nand_oob_8;
L
Linus Torvalds 已提交
3068 3069
			break;
		case 16:
3070
			chip->ecc.layout = &nand_oob_16;
L
Linus Torvalds 已提交
3071 3072
			break;
		case 64:
3073
			chip->ecc.layout = &nand_oob_64;
L
Linus Torvalds 已提交
3074
			break;
3075 3076 3077
		case 128:
			chip->ecc.layout = &nand_oob_128;
			break;
L
Linus Torvalds 已提交
3078
		default:
T
Thomas Gleixner 已提交
3079 3080
			printk(KERN_WARNING "No oob scheme defined for "
			       "oobsize %d\n", mtd->oobsize);
L
Linus Torvalds 已提交
3081 3082 3083
			BUG();
		}
	}
3084

3085 3086 3087
	if (!chip->write_page)
		chip->write_page = nand_write_page;

3088
	/*
T
Thomas Gleixner 已提交
3089 3090
	 * check ECC mode, default to software if 3byte/512byte hardware ECC is
	 * selected and we have 256 byte pagesize fallback to software ECC
3091
	 */
3092

3093
	switch (chip->ecc.mode) {
3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104
	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 已提交
3105
	case NAND_ECC_HW:
3106 3107 3108
		/* Use standard hwecc read page function ? */
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_hwecc;
3109 3110
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_hwecc;
3111 3112 3113 3114
		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;
3115 3116 3117 3118
		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;
3119

T
Thomas Gleixner 已提交
3120
	case NAND_ECC_HW_SYNDROME:
3121 3122 3123
		if ((!chip->ecc.calculate || !chip->ecc.correct ||
		     !chip->ecc.hwctl) &&
		    (!chip->ecc.read_page ||
3124
		     chip->ecc.read_page == nand_read_page_hwecc ||
3125
		     !chip->ecc.write_page ||
3126
		     chip->ecc.write_page == nand_write_page_hwecc)) {
3127
			printk(KERN_WARNING "No ECC functions supplied; "
T
Thomas Gleixner 已提交
3128 3129 3130
			       "Hardware ECC not possible\n");
			BUG();
		}
3131
		/* Use standard syndrome read/write page function ? */
3132 3133
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_syndrome;
3134 3135
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_syndrome;
3136 3137 3138 3139
		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;
3140 3141 3142 3143
		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;
3144

3145
		if (mtd->writesize >= chip->ecc.size)
T
Thomas Gleixner 已提交
3146 3147 3148
			break;
		printk(KERN_WARNING "%d byte HW ECC not possible on "
		       "%d byte page size, fallback to SW ECC\n",
3149 3150
		       chip->ecc.size, mtd->writesize);
		chip->ecc.mode = NAND_ECC_SOFT;
3151

T
Thomas Gleixner 已提交
3152
	case NAND_ECC_SOFT:
3153 3154
		chip->ecc.calculate = nand_calculate_ecc;
		chip->ecc.correct = nand_correct_data;
3155
		chip->ecc.read_page = nand_read_page_swecc;
3156
		chip->ecc.read_subpage = nand_read_subpage;
3157
		chip->ecc.write_page = nand_write_page_swecc;
3158 3159
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
3160 3161
		chip->ecc.read_oob = nand_read_oob_std;
		chip->ecc.write_oob = nand_write_oob_std;
3162 3163
		if (!chip->ecc.size)
			chip->ecc.size = 256;
3164
		chip->ecc.bytes = 3;
L
Linus Torvalds 已提交
3165
		break;
3166 3167

	case NAND_ECC_NONE:
T
Thomas Gleixner 已提交
3168 3169
		printk(KERN_WARNING "NAND_ECC_NONE selected by board driver. "
		       "This is not recommended !!\n");
3170 3171
		chip->ecc.read_page = nand_read_page_raw;
		chip->ecc.write_page = nand_write_page_raw;
3172
		chip->ecc.read_oob = nand_read_oob_std;
3173 3174
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
3175
		chip->ecc.write_oob = nand_write_oob_std;
3176 3177
		chip->ecc.size = mtd->writesize;
		chip->ecc.bytes = 0;
L
Linus Torvalds 已提交
3178
		break;
3179

L
Linus Torvalds 已提交
3180
	default:
T
Thomas Gleixner 已提交
3181
		printk(KERN_WARNING "Invalid NAND_ECC_MODE %d\n",
3182
		       chip->ecc.mode);
3183
		BUG();
L
Linus Torvalds 已提交
3184
	}
3185

3186 3187 3188 3189 3190
	/*
	 * The number of bytes available for a client to place data into
	 * the out of band area
	 */
	chip->ecc.layout->oobavail = 0;
3191 3192
	for (i = 0; chip->ecc.layout->oobfree[i].length
			&& i < ARRAY_SIZE(chip->ecc.layout->oobfree); i++)
3193 3194
		chip->ecc.layout->oobavail +=
			chip->ecc.layout->oobfree[i].length;
V
Vitaly Wool 已提交
3195
	mtd->oobavail = chip->ecc.layout->oobavail;
3196

T
Thomas Gleixner 已提交
3197 3198 3199 3200
	/*
	 * Set the number of read / write steps for one page depending on ECC
	 * mode
	 */
3201 3202
	chip->ecc.steps = mtd->writesize / chip->ecc.size;
	if(chip->ecc.steps * chip->ecc.size != mtd->writesize) {
T
Thomas Gleixner 已提交
3203 3204
		printk(KERN_WARNING "Invalid ecc parameters\n");
		BUG();
L
Linus Torvalds 已提交
3205
	}
3206
	chip->ecc.total = chip->ecc.steps * chip->ecc.bytes;
3207

3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219
	/*
	 * 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:
3220
		case 16:
3221 3222 3223 3224 3225 3226
			mtd->subpage_sft = 2;
			break;
		}
	}
	chip->subpagesize = mtd->writesize >> mtd->subpage_sft;

3227
	/* Initialize state */
3228
	chip->state = FL_READY;
L
Linus Torvalds 已提交
3229 3230

	/* De-select the device */
3231
	chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
3232 3233

	/* Invalidate the pagebuffer reference */
3234
	chip->pagebuf = -1;
L
Linus Torvalds 已提交
3235 3236 3237

	/* Fill in remaining MTD driver data */
	mtd->type = MTD_NANDFLASH;
3238 3239
	mtd->flags = (chip->options & NAND_ROM) ? MTD_CAP_ROM :
						MTD_CAP_NANDFLASH;
L
Linus Torvalds 已提交
3240 3241 3242 3243 3244
	mtd->erase = nand_erase;
	mtd->point = NULL;
	mtd->unpoint = NULL;
	mtd->read = nand_read;
	mtd->write = nand_write;
3245
	mtd->panic_write = panic_nand_write;
L
Linus Torvalds 已提交
3246 3247 3248 3249 3250
	mtd->read_oob = nand_read_oob;
	mtd->write_oob = nand_write_oob;
	mtd->sync = nand_sync;
	mtd->lock = NULL;
	mtd->unlock = NULL;
3251 3252
	mtd->suspend = nand_suspend;
	mtd->resume = nand_resume;
L
Linus Torvalds 已提交
3253 3254 3255
	mtd->block_isbad = nand_block_isbad;
	mtd->block_markbad = nand_block_markbad;

3256 3257
	/* propagate ecc.layout to mtd_info */
	mtd->ecclayout = chip->ecc.layout;
L
Linus Torvalds 已提交
3258

3259
	/* Check, if we should skip the bad block table scan */
3260
	if (chip->options & NAND_SKIP_BBTSCAN)
3261
		return 0;
L
Linus Torvalds 已提交
3262 3263

	/* Build bad block table */
3264
	return chip->scan_bbt(mtd);
L
Linus Torvalds 已提交
3265 3266
}

3267
/* is_module_text_address() isn't exported, and it's mostly a pointless
3268 3269 3270 3271 3272 3273
   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() \
3274
	is_module_text_address((unsigned long)__builtin_return_address(0))
3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294
#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()) {
3295 3296
		printk(KERN_CRIT "%s called with NULL mtd->owner!\n",
				__func__);
3297 3298 3299
		BUG();
	}

3300
	ret = nand_scan_ident(mtd, maxchips, NULL);
3301 3302 3303 3304 3305
	if (!ret)
		ret = nand_scan_tail(mtd);
	return ret;
}

L
Linus Torvalds 已提交
3306
/**
3307
 * nand_release - [NAND Interface] Free resources held by the NAND device
L
Linus Torvalds 已提交
3308 3309
 * @mtd:	MTD device structure
*/
3310
void nand_release(struct mtd_info *mtd)
L
Linus Torvalds 已提交
3311
{
3312
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
3313 3314 3315

#ifdef CONFIG_MTD_PARTITIONS
	/* Deregister partitions */
3316
	del_mtd_partitions(mtd);
L
Linus Torvalds 已提交
3317 3318
#endif
	/* Deregister the device */
3319
	del_mtd_device(mtd);
L
Linus Torvalds 已提交
3320

J
Jesper Juhl 已提交
3321
	/* Free bad block table memory */
3322
	kfree(chip->bbt);
3323 3324
	if (!(chip->options & NAND_OWN_BUFFERS))
		kfree(chip->buffers);
L
Linus Torvalds 已提交
3325 3326
}

3327 3328
EXPORT_SYMBOL_GPL(nand_lock);
EXPORT_SYMBOL_GPL(nand_unlock);
3329
EXPORT_SYMBOL_GPL(nand_scan);
3330 3331
EXPORT_SYMBOL_GPL(nand_scan_ident);
EXPORT_SYMBOL_GPL(nand_scan_tail);
3332
EXPORT_SYMBOL_GPL(nand_release);
3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347

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

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