nand_base.c 79.6 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);

L
Linus Torvalds 已提交
111 112 113
/**
 * nand_release_device - [GENERIC] release chip
 * @mtd:	MTD device structure
114 115
 *
 * Deselect, release chip lock and wake up anyone waiting on the device
L
Linus Torvalds 已提交
116
 */
117
static void nand_release_device(struct mtd_info *mtd)
L
Linus Torvalds 已提交
118
{
119
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
120 121

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

T
Thomas Gleixner 已提交
124
	/* Release the controller and the chip */
125 126 127 128 129
	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 已提交
130 131 132 133 134 135 136 137
}

/**
 * nand_read_byte - [DEFAULT] read one byte from the chip
 * @mtd:	MTD device structure
 *
 * Default read function for 8bit buswith
 */
138
static uint8_t nand_read_byte(struct mtd_info *mtd)
L
Linus Torvalds 已提交
139
{
140 141
	struct nand_chip *chip = mtd->priv;
	return readb(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
142 143 144 145 146 147
}

/**
 * nand_read_byte16 - [DEFAULT] read one byte endianess aware from the chip
 * @mtd:	MTD device structure
 *
148
 * Default read function for 16bit buswith with
L
Linus Torvalds 已提交
149 150
 * endianess conversion
 */
151
static uint8_t nand_read_byte16(struct mtd_info *mtd)
L
Linus Torvalds 已提交
152
{
153 154
	struct nand_chip *chip = mtd->priv;
	return (uint8_t) cpu_to_le16(readw(chip->IO_ADDR_R));
L
Linus Torvalds 已提交
155 156 157 158 159 160
}

/**
 * nand_read_word - [DEFAULT] read one word from the chip
 * @mtd:	MTD device structure
 *
161
 * Default read function for 16bit buswith without
L
Linus Torvalds 已提交
162 163 164 165
 * endianess conversion
 */
static u16 nand_read_word(struct mtd_info *mtd)
{
166 167
	struct nand_chip *chip = mtd->priv;
	return readw(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
168 169 170 171 172
}

/**
 * nand_select_chip - [DEFAULT] control CE line
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
173
 * @chipnr:	chipnumber to select, -1 for deselect
L
Linus Torvalds 已提交
174 175 176
 *
 * Default select function for 1 chip devices.
 */
177
static void nand_select_chip(struct mtd_info *mtd, int chipnr)
L
Linus Torvalds 已提交
178
{
179 180 181
	struct nand_chip *chip = mtd->priv;

	switch (chipnr) {
L
Linus Torvalds 已提交
182
	case -1:
183
		chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
L
Linus Torvalds 已提交
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
		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
 */
201
static void nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
202 203
{
	int i;
204
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
205

206
	for (i = 0; i < len; i++)
207
		writeb(buf[i], chip->IO_ADDR_W);
L
Linus Torvalds 已提交
208 209 210
}

/**
211
 * nand_read_buf - [DEFAULT] read chip data into buffer
L
Linus Torvalds 已提交
212 213 214 215 216 217
 * @mtd:	MTD device structure
 * @buf:	buffer to store date
 * @len:	number of bytes to read
 *
 * Default read function for 8bit buswith
 */
218
static void nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
L
Linus Torvalds 已提交
219 220
{
	int i;
221
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
222

223
	for (i = 0; i < len; i++)
224
		buf[i] = readb(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
225 226 227
}

/**
228
 * nand_verify_buf - [DEFAULT] Verify chip data against buffer
L
Linus Torvalds 已提交
229 230 231 232 233 234
 * @mtd:	MTD device structure
 * @buf:	buffer containing the data to compare
 * @len:	number of bytes to compare
 *
 * Default verify function for 8bit buswith
 */
235
static int nand_verify_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
236 237
{
	int i;
238
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
239

240
	for (i = 0; i < len; i++)
241
		if (buf[i] != readb(chip->IO_ADDR_R))
L
Linus Torvalds 已提交
242 243 244 245 246 247 248 249 250 251 252 253
			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
 */
254
static void nand_write_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
255 256
{
	int i;
257
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
258 259
	u16 *p = (u16 *) buf;
	len >>= 1;
260

261
	for (i = 0; i < len; i++)
262
		writew(p[i], chip->IO_ADDR_W);
263

L
Linus Torvalds 已提交
264 265 266
}

/**
267
 * nand_read_buf16 - [DEFAULT] read chip data into buffer
L
Linus Torvalds 已提交
268 269 270 271 272 273
 * @mtd:	MTD device structure
 * @buf:	buffer to store date
 * @len:	number of bytes to read
 *
 * Default read function for 16bit buswith
 */
274
static void nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len)
L
Linus Torvalds 已提交
275 276
{
	int i;
277
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
278 279 280
	u16 *p = (u16 *) buf;
	len >>= 1;

281
	for (i = 0; i < len; i++)
282
		p[i] = readw(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
283 284 285
}

/**
286
 * nand_verify_buf16 - [DEFAULT] Verify chip data against buffer
L
Linus Torvalds 已提交
287 288 289 290 291 292
 * @mtd:	MTD device structure
 * @buf:	buffer containing the data to compare
 * @len:	number of bytes to compare
 *
 * Default verify function for 16bit buswith
 */
293
static int nand_verify_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
294 295
{
	int i;
296
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
297 298 299
	u16 *p = (u16 *) buf;
	len >>= 1;

300
	for (i = 0; i < len; i++)
301
		if (p[i] != readw(chip->IO_ADDR_R))
L
Linus Torvalds 已提交
302 303 304 305 306 307 308 309 310 311 312
			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
 *
313
 * Check, if the block is bad.
L
Linus Torvalds 已提交
314 315 316 317
 */
static int nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
{
	int page, chipnr, res = 0;
318
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
319 320
	u16 bad;

321 322
	page = (int)(ofs >> chip->page_shift) & chip->pagemask;

L
Linus Torvalds 已提交
323
	if (getchip) {
324
		chipnr = (int)(ofs >> chip->chip_shift);
L
Linus Torvalds 已提交
325

326
		nand_get_device(chip, mtd, FL_READING);
L
Linus Torvalds 已提交
327 328

		/* Select the NAND device */
329
		chip->select_chip(mtd, chipnr);
330
	}
L
Linus Torvalds 已提交
331

332 333
	if (chip->options & NAND_BUSWIDTH_16) {
		chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos & 0xFE,
334
			      page);
335 336
		bad = cpu_to_le16(chip->read_word(mtd));
		if (chip->badblockpos & 0x1)
337
			bad >>= 8;
L
Linus Torvalds 已提交
338 339 340
		if ((bad & 0xFF) != 0xff)
			res = 1;
	} else {
341
		chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos, page);
342
		if (chip->read_byte(mtd) != 0xff)
L
Linus Torvalds 已提交
343 344
			res = 1;
	}
345

346
	if (getchip)
L
Linus Torvalds 已提交
347
		nand_release_device(mtd);
348

L
Linus Torvalds 已提交
349 350 351 352 353 354 355 356 357 358 359 360 361
	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)
{
362
	struct nand_chip *chip = mtd->priv;
363
	uint8_t buf[2] = { 0, 0 };
364
	int block, ret;
365

L
Linus Torvalds 已提交
366
	/* Get block number */
367
	block = (int)(ofs >> chip->bbt_erase_shift);
368 369
	if (chip->bbt)
		chip->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
L
Linus Torvalds 已提交
370 371

	/* Do we have a flash based bad block table ? */
372
	if (chip->options & NAND_USE_FLASH_BBT)
373 374 375 376 377
		ret = nand_update_bbt(mtd, ofs);
	else {
		/* We write two bytes, so we dont have to mess with 16 bit
		 * access
		 */
378
		nand_get_device(chip, mtd, FL_WRITING);
379
		ofs += mtd->oobsize;
380
		chip->ops.len = chip->ops.ooblen = 2;
381 382 383 384 385
		chip->ops.datbuf = NULL;
		chip->ops.oobbuf = buf;
		chip->ops.ooboffs = chip->badblockpos & ~0x01;

		ret = nand_do_write_oob(mtd, ofs, &chip->ops);
386
		nand_release_device(mtd);
387 388 389
	}
	if (!ret)
		mtd->ecc_stats.badblocks++;
390

391
	return ret;
L
Linus Torvalds 已提交
392 393
}

394
/**
L
Linus Torvalds 已提交
395 396
 * nand_check_wp - [GENERIC] check if the chip is write protected
 * @mtd:	MTD device structure
397
 * Check, if the device is write protected
L
Linus Torvalds 已提交
398
 *
399
 * The function expects, that the device is already selected
L
Linus Torvalds 已提交
400
 */
401
static int nand_check_wp(struct mtd_info *mtd)
L
Linus Torvalds 已提交
402
{
403
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
404
	/* Check the WP bit */
405 406
	chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
	return (chip->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
L
Linus Torvalds 已提交
407 408 409 410 411 412 413 414 415 416 417 418
}

/**
 * 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.
 */
419 420
static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip,
			       int allowbbt)
L
Linus Torvalds 已提交
421
{
422
	struct nand_chip *chip = mtd->priv;
423

424 425
	if (!chip->bbt)
		return chip->block_bad(mtd, ofs, getchip);
426

L
Linus Torvalds 已提交
427
	/* Return info from the table */
428
	return nand_isbad_bbt(mtd, ofs, allowbbt);
L
Linus Torvalds 已提交
429 430
}

431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
/**
 * 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);
	}
}

453
/*
454 455 456
 * Wait for the ready pin, after a command
 * The timeout is catched later.
 */
457
void nand_wait_ready(struct mtd_info *mtd)
458
{
459
	struct nand_chip *chip = mtd->priv;
460
	unsigned long timeo = jiffies + 2;
461

462 463 464 465
	/* 400ms timeout */
	if (in_interrupt() || oops_in_progress)
		return panic_nand_wait_ready(mtd, 400);

466
	led_trigger_event(nand_led_trigger, LED_FULL);
467 468
	/* wait until command is processed or timeout occures */
	do {
469
		if (chip->dev_ready(mtd))
470
			break;
I
Ingo Molnar 已提交
471
		touch_softlockup_watchdog();
472
	} while (time_before(jiffies, timeo));
473
	led_trigger_event(nand_led_trigger, LED_OFF);
474
}
475
EXPORT_SYMBOL_GPL(nand_wait_ready);
476

L
Linus Torvalds 已提交
477 478 479 480 481 482 483 484 485 486
/**
 * 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)
 */
487 488
static void nand_command(struct mtd_info *mtd, unsigned int command,
			 int column, int page_addr)
L
Linus Torvalds 已提交
489
{
490
	register struct nand_chip *chip = mtd->priv;
491
	int ctrl = NAND_CTRL_CLE | NAND_CTRL_CHANGE;
L
Linus Torvalds 已提交
492 493 494 495 496 497 498

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

J
Joern Engel 已提交
499
		if (column >= mtd->writesize) {
L
Linus Torvalds 已提交
500
			/* OOB area */
J
Joern Engel 已提交
501
			column -= mtd->writesize;
L
Linus Torvalds 已提交
502 503 504 505 506 507 508 509
			readcmd = NAND_CMD_READOOB;
		} else if (column < 256) {
			/* First 256 bytes --> READ0 */
			readcmd = NAND_CMD_READ0;
		} else {
			column -= 256;
			readcmd = NAND_CMD_READ1;
		}
510
		chip->cmd_ctrl(mtd, readcmd, ctrl);
511
		ctrl &= ~NAND_CTRL_CHANGE;
L
Linus Torvalds 已提交
512
	}
513
	chip->cmd_ctrl(mtd, command, ctrl);
L
Linus Torvalds 已提交
514

515 516 517 518 519 520 521
	/*
	 * Address cycle, when necessary
	 */
	ctrl = NAND_CTRL_ALE | NAND_CTRL_CHANGE;
	/* Serially input address */
	if (column != -1) {
		/* Adjust columns for 16 bit buswidth */
522
		if (chip->options & NAND_BUSWIDTH_16)
523
			column >>= 1;
524
		chip->cmd_ctrl(mtd, column, ctrl);
525 526 527
		ctrl &= ~NAND_CTRL_CHANGE;
	}
	if (page_addr != -1) {
528
		chip->cmd_ctrl(mtd, page_addr, ctrl);
529
		ctrl &= ~NAND_CTRL_CHANGE;
530
		chip->cmd_ctrl(mtd, page_addr >> 8, ctrl);
531
		/* One more address cycle for devices > 32MiB */
532 533
		if (chip->chipsize > (32 << 20))
			chip->cmd_ctrl(mtd, page_addr >> 16, ctrl);
L
Linus Torvalds 已提交
534
	}
535
	chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
536 537 538

	/*
	 * program and erase have their own busy handlers
L
Linus Torvalds 已提交
539
	 * status and sequential in needs no delay
540
	 */
L
Linus Torvalds 已提交
541
	switch (command) {
542

L
Linus Torvalds 已提交
543 544 545 546 547 548 549 550
	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:
551
		if (chip->dev_ready)
L
Linus Torvalds 已提交
552
			break;
553 554
		udelay(chip->chip_delay);
		chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
555
			       NAND_CTRL_CLE | NAND_CTRL_CHANGE);
556 557
		chip->cmd_ctrl(mtd,
			       NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
558
		while (!(chip->read_byte(mtd) & NAND_STATUS_READY)) ;
L
Linus Torvalds 已提交
559 560
		return;

561
		/* This applies to read commands */
L
Linus Torvalds 已提交
562
	default:
563
		/*
L
Linus Torvalds 已提交
564 565
		 * If we don't have access to the busy pin, we apply the given
		 * command delay
566
		 */
567 568
		if (!chip->dev_ready) {
			udelay(chip->chip_delay);
L
Linus Torvalds 已提交
569
			return;
570
		}
L
Linus Torvalds 已提交
571 572 573
	}
	/* Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine. */
574
	ndelay(100);
575 576

	nand_wait_ready(mtd);
L
Linus Torvalds 已提交
577 578 579 580 581 582 583 584 585
}

/**
 * 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
 *
586 587 588
 * 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 已提交
589
 */
590 591
static void nand_command_lp(struct mtd_info *mtd, unsigned int command,
			    int column, int page_addr)
L
Linus Torvalds 已提交
592
{
593
	register struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
594 595 596

	/* Emulate NAND_CMD_READOOB */
	if (command == NAND_CMD_READOOB) {
J
Joern Engel 已提交
597
		column += mtd->writesize;
L
Linus Torvalds 已提交
598 599
		command = NAND_CMD_READ0;
	}
600

601
	/* Command latch cycle */
602
	chip->cmd_ctrl(mtd, command & 0xff,
603
		       NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
L
Linus Torvalds 已提交
604 605

	if (column != -1 || page_addr != -1) {
606
		int ctrl = NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE;
L
Linus Torvalds 已提交
607 608 609 610

		/* Serially input address */
		if (column != -1) {
			/* Adjust columns for 16 bit buswidth */
611
			if (chip->options & NAND_BUSWIDTH_16)
L
Linus Torvalds 已提交
612
				column >>= 1;
613
			chip->cmd_ctrl(mtd, column, ctrl);
614
			ctrl &= ~NAND_CTRL_CHANGE;
615
			chip->cmd_ctrl(mtd, column >> 8, ctrl);
616
		}
L
Linus Torvalds 已提交
617
		if (page_addr != -1) {
618 619
			chip->cmd_ctrl(mtd, page_addr, ctrl);
			chip->cmd_ctrl(mtd, page_addr >> 8,
620
				       NAND_NCE | NAND_ALE);
L
Linus Torvalds 已提交
621
			/* One more address cycle for devices > 128MiB */
622 623
			if (chip->chipsize > (128 << 20))
				chip->cmd_ctrl(mtd, page_addr >> 16,
624
					       NAND_NCE | NAND_ALE);
L
Linus Torvalds 已提交
625 626
		}
	}
627
	chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
628 629 630

	/*
	 * program and erase have their own busy handlers
631 632
	 * status, sequential in, and deplete1 need no delay
	 */
L
Linus Torvalds 已提交
633
	switch (command) {
634

L
Linus Torvalds 已提交
635 636 637 638 639
	case NAND_CMD_CACHEDPROG:
	case NAND_CMD_PAGEPROG:
	case NAND_CMD_ERASE1:
	case NAND_CMD_ERASE2:
	case NAND_CMD_SEQIN:
640
	case NAND_CMD_RNDIN:
L
Linus Torvalds 已提交
641
	case NAND_CMD_STATUS:
642
	case NAND_CMD_DEPLETE1:
L
Linus Torvalds 已提交
643 644
		return;

645 646 647
		/*
		 * read error status commands require only a short delay
		 */
648 649 650 651 652
	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:
653
		udelay(chip->chip_delay);
654
		return;
L
Linus Torvalds 已提交
655 656

	case NAND_CMD_RESET:
657
		if (chip->dev_ready)
L
Linus Torvalds 已提交
658
			break;
659
		udelay(chip->chip_delay);
660 661 662 663
		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);
664
		while (!(chip->read_byte(mtd) & NAND_STATUS_READY)) ;
L
Linus Torvalds 已提交
665 666
		return;

667 668 669 670 671 672 673 674
	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 已提交
675
	case NAND_CMD_READ0:
676 677 678 679
		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);
680

681
		/* This applies to read commands */
L
Linus Torvalds 已提交
682
	default:
683
		/*
L
Linus Torvalds 已提交
684 685
		 * If we don't have access to the busy pin, we apply the given
		 * command delay
686
		 */
687 688
		if (!chip->dev_ready) {
			udelay(chip->chip_delay);
L
Linus Torvalds 已提交
689
			return;
690
		}
L
Linus Torvalds 已提交
691
	}
692

L
Linus Torvalds 已提交
693 694
	/* Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine. */
695
	ndelay(100);
696 697

	nand_wait_ready(mtd);
L
Linus Torvalds 已提交
698 699
}

700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
/**
 * 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 已提交
716 717
/**
 * nand_get_device - [GENERIC] Get chip for selected access
R
Randy Dunlap 已提交
718
 * @chip:	the nand chip descriptor
L
Linus Torvalds 已提交
719
 * @mtd:	MTD device structure
720
 * @new_state:	the state which is requested
L
Linus Torvalds 已提交
721 722 723
 *
 * Get the device and lock it for exclusive access
 */
724
static int
725
nand_get_device(struct nand_chip *chip, struct mtd_info *mtd, int new_state)
L
Linus Torvalds 已提交
726
{
727 728
	spinlock_t *lock = &chip->controller->lock;
	wait_queue_head_t *wq = &chip->controller->wq;
729 730
	DECLARE_WAITQUEUE(wait, current);
 retry:
731 732
	spin_lock(lock);

733
	/* Hardware controller shared among independent devices */
734 735
	if (!chip->controller->active)
		chip->controller->active = chip;
T
Thomas Gleixner 已提交
736

737 738
	if (chip->controller->active == chip && chip->state == FL_READY) {
		chip->state = new_state;
739
		spin_unlock(lock);
740 741 742 743
		return 0;
	}
	if (new_state == FL_PM_SUSPENDED) {
		spin_unlock(lock);
744
		return (chip->state == FL_PM_SUSPENDED) ? 0 : -EAGAIN;
745 746 747 748 749 750
	}
	set_current_state(TASK_UNINTERRUPTIBLE);
	add_wait_queue(wq, &wait);
	spin_unlock(lock);
	schedule();
	remove_wait_queue(wq, &wait);
L
Linus Torvalds 已提交
751 752 753
	goto retry;
}

754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
/**
 * 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 已提交
780 781 782
/**
 * nand_wait - [DEFAULT]  wait until the command is done
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
783
 * @chip:	NAND chip structure
L
Linus Torvalds 已提交
784 785
 *
 * Wait for command done. This applies to erase and program only
786
 * Erase can take up to 400ms and program up to 20ms according to
L
Linus Torvalds 已提交
787
 * general NAND and SmartMedia specs
R
Randy Dunlap 已提交
788
 */
789
static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
L
Linus Torvalds 已提交
790 791
{

792
	unsigned long timeo = jiffies;
793
	int status, state = chip->state;
794

L
Linus Torvalds 已提交
795
	if (state == FL_ERASING)
796
		timeo += (HZ * 400) / 1000;
L
Linus Torvalds 已提交
797
	else
798
		timeo += (HZ * 20) / 1000;
L
Linus Torvalds 已提交
799

800 801
	led_trigger_event(nand_led_trigger, LED_FULL);

L
Linus Torvalds 已提交
802 803
	/* Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine. */
804
	ndelay(100);
L
Linus Torvalds 已提交
805

806 807
	if ((state == FL_ERASING) && (chip->options & NAND_IS_AND))
		chip->cmdfunc(mtd, NAND_CMD_STATUS_MULTI, -1, -1);
808
	else
809
		chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
L
Linus Torvalds 已提交
810

811 812 813 814 815 816 817 818 819 820 821 822
	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 已提交
823 824
		}
	}
825 826
	led_trigger_event(nand_led_trigger, LED_OFF);

827
	status = (int)chip->read_byte(mtd);
L
Linus Torvalds 已提交
828 829 830
	return status;
}

831 832 833 834 835
/**
 * 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
836
 * @page:	page number to read
837 838
 *
 * Not for syndrome calculating ecc controllers, which use a special oob layout
839 840
 */
static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
841
			      uint8_t *buf, int page)
842 843 844 845 846 847
{
	chip->read_buf(mtd, buf, mtd->writesize);
	chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
	return 0;
}

848 849 850 851 852
/**
 * 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
853
 * @page:	page number to read
854 855 856 857
 *
 * 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,
858
			      uint8_t *buf, int page)
859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
{
	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 已提交
890
/**
891
 * nand_read_page_swecc - [REPLACABLE] software ecc based page read function
892 893 894
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
895
 * @page:	page number to read
896
 */
897
static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
898
				uint8_t *buf, int page)
L
Linus Torvalds 已提交
899
{
900 901 902 903
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
904 905
	uint8_t *ecc_calc = chip->buffers->ecccalc;
	uint8_t *ecc_code = chip->buffers->ecccode;
906
	uint32_t *eccpos = chip->ecc.layout->eccpos;
907

908
	chip->ecc.read_page_raw(mtd, chip, buf, page);
909 910 911 912 913

	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++)
914
		ecc_code[i] = chip->oob_poi[eccpos[i]];
915 916 917 918 919 920 921 922

	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]);
923
		if (stat < 0)
924 925 926 927 928
			mtd->ecc_stats.failed++;
		else
			mtd->ecc_stats.corrected += stat;
	}
	return 0;
929
}
L
Linus Torvalds 已提交
930

931 932 933 934
/**
 * nand_read_subpage - [REPLACABLE] software ecc based sub-page read function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
935 936 937
 * @data_offs:	offset of requested data within the page
 * @readlen:	data length
 * @bufpoi:	buffer to store read data
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
 */
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;
}

1012
/**
1013
 * nand_read_page_hwecc - [REPLACABLE] hardware ecc based page read function
1014 1015 1016
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
1017
 * @page:	page number to read
1018
 *
1019
 * Not for syndrome calculating ecc controllers which need a special oob layout
1020
 */
1021
static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
1022
				uint8_t *buf, int page)
L
Linus Torvalds 已提交
1023
{
1024 1025 1026 1027
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1028 1029
	uint8_t *ecc_calc = chip->buffers->ecccalc;
	uint8_t *ecc_code = chip->buffers->ecccode;
1030
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1031 1032 1033 1034 1035

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

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

1042 1043
	eccsteps = chip->ecc.steps;
	p = buf;
1044

1045 1046
	for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		int stat;
L
Linus Torvalds 已提交
1047

1048
		stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
1049
		if (stat < 0)
1050 1051 1052 1053 1054 1055
			mtd->ecc_stats.failed++;
		else
			mtd->ecc_stats.corrected += stat;
	}
	return 0;
}
L
Linus Torvalds 已提交
1056

1057 1058 1059 1060 1061
/**
 * 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
1062
 * @page:	page number to read
1063 1064 1065 1066 1067 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 1099 1100 1101 1102 1103 1104 1105
 *
 * 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;
}

1106
/**
1107
 * nand_read_page_syndrome - [REPLACABLE] hardware ecc syndrom based page read
1108 1109 1110
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
1111
 * @page:	page number to read
1112 1113
 *
 * The hw generator calculates the error syndrome automatically. Therefor
1114
 * we need a special oob layout and handling.
1115 1116
 */
static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1117
				   uint8_t *buf, int page)
1118 1119 1120 1121 1122
{
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1123
	uint8_t *oob = chip->oob_poi;
L
Linus Torvalds 已提交
1124

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

1128 1129
		chip->ecc.hwctl(mtd, NAND_ECC_READ);
		chip->read_buf(mtd, p, eccsize);
L
Linus Torvalds 已提交
1130

1131 1132 1133 1134
		if (chip->ecc.prepad) {
			chip->read_buf(mtd, oob, chip->ecc.prepad);
			oob += chip->ecc.prepad;
		}
L
Linus Torvalds 已提交
1135

1136 1137 1138
		chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
		chip->read_buf(mtd, oob, eccbytes);
		stat = chip->ecc.correct(mtd, p, oob, NULL);
1139

1140
		if (stat < 0)
1141
			mtd->ecc_stats.failed++;
1142
		else
1143
			mtd->ecc_stats.corrected += stat;
1144

1145
		oob += eccbytes;
L
Linus Torvalds 已提交
1146

1147 1148 1149
		if (chip->ecc.postpad) {
			chip->read_buf(mtd, oob, chip->ecc.postpad);
			oob += chip->ecc.postpad;
1150
		}
1151
	}
L
Linus Torvalds 已提交
1152

1153
	/* Calculate remaining oob bytes */
1154
	i = mtd->oobsize - (oob - chip->oob_poi);
1155 1156
	if (i)
		chip->read_buf(mtd, oob, i);
1157

1158 1159
	return 0;
}
L
Linus Torvalds 已提交
1160

1161
/**
1162 1163
 * nand_transfer_oob - [Internal] Transfer oob to client buffer
 * @chip:	nand chip structure
R
Randy Dunlap 已提交
1164
 * @oob:	oob destination address
1165
 * @ops:	oob ops structure
1166
 * @len:	size of oob to transfer
1167 1168
 */
static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
1169
				  struct mtd_oob_ops *ops, size_t len)
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179
{
	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;
1180 1181
		uint32_t boffs = 0, roffs = ops->ooboffs;
		size_t bytes = 0;
1182 1183

		for(; free->length && len; free++, len -= bytes) {
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
			/* 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);
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
			oob += bytes;
		}
		return oob;
	}
	default:
		BUG();
	}
	return NULL;
}

/**
 * nand_do_read_ops - [Internal] Read data with ECC
1211 1212 1213
 *
 * @mtd:	MTD device structure
 * @from:	offset to read from
R
Randy Dunlap 已提交
1214
 * @ops:	oob ops structure
1215 1216 1217
 *
 * Internal function. Called with chip held.
 */
1218 1219
static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
1220 1221 1222 1223 1224 1225 1226
{
	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;
1227
	uint32_t readlen = ops->len;
1228
	uint32_t oobreadlen = ops->ooblen;
1229
	uint8_t *bufpoi, *oob, *buf;
L
Linus Torvalds 已提交
1230

1231
	stats = mtd->ecc_stats;
L
Linus Torvalds 已提交
1232

1233 1234
	chipnr = (int)(from >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);
1235

1236 1237
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1238

1239
	col = (int)(from & (mtd->writesize - 1));
1240

1241 1242 1243
	buf = ops->datbuf;
	oob = ops->oobbuf;

1244 1245 1246
	while(1) {
		bytes = min(mtd->writesize - col, readlen);
		aligned = (bytes == mtd->writesize);
1247

1248
		/* Is the current page in the buffer ? */
1249
		if (realpage != chip->pagebuf || oob) {
1250
			bufpoi = aligned ? buf : chip->buffers->databuf;
1251

1252 1253 1254
			if (likely(sndcmd)) {
				chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
				sndcmd = 0;
L
Linus Torvalds 已提交
1255 1256
			}

1257
			/* Now read the page into the buffer */
1258
			if (unlikely(ops->mode == MTD_OOB_RAW))
1259 1260
				ret = chip->ecc.read_page_raw(mtd, chip,
							      bufpoi, page);
1261 1262
			else if (!aligned && NAND_SUBPAGE_READ(chip) && !oob)
				ret = chip->ecc.read_subpage(mtd, chip, col, bytes, bufpoi);
1263
			else
1264 1265
				ret = chip->ecc.read_page(mtd, chip, bufpoi,
							  page);
1266
			if (ret < 0)
L
Linus Torvalds 已提交
1267
				break;
1268 1269 1270

			/* Transfer not aligned data */
			if (!aligned) {
1271 1272
				if (!NAND_SUBPAGE_READ(chip) && !oob)
					chip->pagebuf = realpage;
1273
				memcpy(buf, chip->buffers->databuf + col, bytes);
1274 1275
			}

1276 1277 1278 1279
			buf += bytes;

			if (unlikely(oob)) {
				/* Raw mode does data:oob:data:oob */
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
				if (ops->mode != MTD_OOB_RAW) {
					int toread = min(oobreadlen,
						chip->ecc.layout->oobavail);
					if (toread) {
						oob = nand_transfer_oob(chip,
							oob, ops, toread);
						oobreadlen -= toread;
					}
				} else
					buf = nand_transfer_oob(chip,
						buf, ops, mtd->oobsize);
1291 1292
			}

1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
			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 已提交
1305
			}
1306
		} else {
1307
			memcpy(buf, chip->buffers->databuf + col, bytes);
1308 1309
			buf += bytes;
		}
L
Linus Torvalds 已提交
1310

1311
		readlen -= bytes;
1312

1313
		if (!readlen)
1314
			break;
L
Linus Torvalds 已提交
1315 1316 1317 1318 1319 1320

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

1321
		page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1322 1323 1324
		/* Check, if we cross a chip boundary */
		if (!page) {
			chipnr++;
1325 1326
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1327
		}
1328

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

1336
	ops->retlen = ops->len - (size_t) readlen;
1337 1338
	if (oob)
		ops->oobretlen = ops->ooblen - oobreadlen;
L
Linus Torvalds 已提交
1339

1340 1341 1342
	if (ret)
		return ret;

1343 1344 1345 1346
	if (mtd->ecc_stats.failed - stats.failed)
		return -EBADMSG;

	return  mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
}

/**
 * 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)
{
1362
	struct nand_chip *chip = mtd->priv;
1363 1364 1365 1366 1367 1368 1369 1370
	int ret;

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

1371
	nand_get_device(chip, mtd, FL_READING);
1372

1373 1374 1375 1376 1377
	chip->ops.len = len;
	chip->ops.datbuf = buf;
	chip->ops.oobbuf = NULL;

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

R
Richard Purdie 已提交
1379 1380
	*retlen = chip->ops.retlen;

1381 1382 1383
	nand_release_device(mtd);

	return ret;
L
Linus Torvalds 已提交
1384 1385
}

1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
/**
 * 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 已提交
1463
	return status & NAND_STATUS_FAIL ? -EIO : 0;
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
}

/**
 * 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
1490
		pos = eccsize;
1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524

	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 已提交
1525
/**
1526
 * nand_do_read_oob - [Intern] NAND read out-of-band
L
Linus Torvalds 已提交
1527 1528
 * @mtd:	MTD device structure
 * @from:	offset to read from
1529
 * @ops:	oob operations description structure
L
Linus Torvalds 已提交
1530 1531 1532
 *
 * NAND read out-of-band data from the spare area
 */
1533 1534
static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1535
{
1536
	int page, realpage, chipnr, sndcmd = 1;
1537
	struct nand_chip *chip = mtd->priv;
1538
	int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
1539 1540
	int readlen = ops->ooblen;
	int len;
1541
	uint8_t *buf = ops->oobbuf;
1542

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

1546
	if (ops->mode == MTD_OOB_AUTO)
1547
		len = chip->ecc.layout->oobavail;
1548 1549 1550 1551
	else
		len = mtd->oobsize;

	if (unlikely(ops->ooboffs >= len)) {
1552 1553
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to start read "
					"outside oob\n", __func__);
1554 1555 1556 1557 1558 1559 1560
		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)) {
1561 1562
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt read beyond end "
					"of device\n", __func__);
1563 1564
		return -EINVAL;
	}
1565

1566
	chipnr = (int)(from >> chip->chip_shift);
1567
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1568

1569 1570 1571
	/* Shift to get page */
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1572

1573
	while(1) {
1574
		sndcmd = chip->ecc.read_oob(mtd, chip, page, sndcmd);
1575 1576 1577

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

1579 1580 1581 1582 1583 1584
		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.
1585
			 */
1586 1587
			if (!chip->dev_ready)
				udelay(chip->chip_delay);
1588 1589
			else
				nand_wait_ready(mtd);
1590
		}
1591

1592
		readlen -= len;
S
Savin Zlobec 已提交
1593 1594 1595
		if (!readlen)
			break;

1596 1597 1598 1599 1600 1601 1602 1603 1604
		/* 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 已提交
1605
		}
1606 1607 1608 1609 1610 1611

		/* 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 已提交
1612 1613
	}

1614
	ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
1615 1616 1617 1618
	return 0;
}

/**
1619
 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
L
Linus Torvalds 已提交
1620 1621
 * @mtd:	MTD device structure
 * @from:	offset to read from
1622
 * @ops:	oob operation description structure
L
Linus Torvalds 已提交
1623
 *
1624
 * NAND read data and/or out-of-band data
L
Linus Torvalds 已提交
1625
 */
1626 1627
static int nand_read_oob(struct mtd_info *mtd, loff_t from,
			 struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1628
{
1629
	struct nand_chip *chip = mtd->priv;
1630 1631 1632
	int ret = -ENOTSUPP;

	ops->retlen = 0;
L
Linus Torvalds 已提交
1633 1634

	/* Do not allow reads past end of device */
1635
	if (ops->datbuf && (from + ops->len) > mtd->size) {
1636 1637
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt read "
				"beyond end of device\n", __func__);
L
Linus Torvalds 已提交
1638 1639 1640
		return -EINVAL;
	}

1641
	nand_get_device(chip, mtd, FL_READING);
L
Linus Torvalds 已提交
1642

1643 1644 1645 1646 1647
	switch(ops->mode) {
	case MTD_OOB_PLACE:
	case MTD_OOB_AUTO:
	case MTD_OOB_RAW:
		break;
L
Linus Torvalds 已提交
1648

1649 1650 1651
	default:
		goto out;
	}
L
Linus Torvalds 已提交
1652

1653 1654 1655 1656
	if (!ops->datbuf)
		ret = nand_do_read_oob(mtd, from, ops);
	else
		ret = nand_do_read_ops(mtd, from, ops);
1657

1658 1659 1660 1661
 out:
	nand_release_device(mtd);
	return ret;
}
1662

L
Linus Torvalds 已提交
1663

1664 1665 1666 1667 1668
/**
 * nand_write_page_raw - [Intern] raw page write function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
1669 1670
 *
 * Not for syndrome calculating ecc controllers, which use a special oob layout
1671 1672 1673 1674 1675 1676
 */
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 已提交
1677 1678
}

1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716
/**
 * 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);
}
1717
/**
1718
 * nand_write_page_swecc - [REPLACABLE] software ecc based page write function
1719 1720 1721
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
1722
 */
1723 1724
static void nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
				  const uint8_t *buf)
1725
{
1726 1727 1728
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
1729
	uint8_t *ecc_calc = chip->buffers->ecccalc;
1730
	const uint8_t *p = buf;
1731
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1732

1733 1734 1735
	/* Software ecc calculation */
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1736

1737 1738
	for (i = 0; i < chip->ecc.total; i++)
		chip->oob_poi[eccpos[i]] = ecc_calc[i];
1739

1740
	chip->ecc.write_page_raw(mtd, chip, buf);
1741
}
1742

1743
/**
1744
 * nand_write_page_hwecc - [REPLACABLE] hardware ecc based page write function
1745 1746 1747 1748 1749 1750 1751 1752 1753 1754
 * @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;
1755
	uint8_t *ecc_calc = chip->buffers->ecccalc;
1756
	const uint8_t *p = buf;
1757
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1758

1759 1760
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
1761
		chip->write_buf(mtd, p, eccsize);
1762
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1763 1764
	}

1765 1766 1767 1768
	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);
1769 1770
}

1771
/**
1772
 * nand_write_page_syndrome - [REPLACABLE] hardware ecc syndrom based page write
1773 1774 1775
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
L
Linus Torvalds 已提交
1776
 *
1777 1778 1779 1780 1781
 * 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 已提交
1782
{
1783 1784 1785 1786 1787
	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 已提交
1788

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

1791 1792
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
		chip->write_buf(mtd, p, eccsize);
1793

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

	/* Calculate remaining oob bytes */
1810
	i = mtd->oobsize - (oob - chip->oob_poi);
1811 1812 1813 1814 1815
	if (i)
		chip->write_buf(mtd, oob, i);
}

/**
1816
 * nand_write_page - [REPLACEABLE] write one page
1817 1818 1819 1820 1821
 * @mtd:	MTD device structure
 * @chip:	NAND chip descriptor
 * @buf:	the data to write
 * @page:	page number to write
 * @cached:	cached programming
1822
 * @raw:	use _raw version of write_page
1823 1824
 */
static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
1825
			   const uint8_t *buf, int page, int cached, int raw)
1826 1827 1828 1829 1830
{
	int status;

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

1831 1832 1833 1834
	if (unlikely(raw))
		chip->ecc.write_page_raw(mtd, chip, buf);
	else
		chip->ecc.write_page(mtd, chip, buf);
1835 1836 1837 1838 1839 1840 1841 1842 1843 1844

	/*
	 * 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);
1845
		status = chip->waitfunc(mtd, chip);
1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857
		/*
		 * 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);
1858
		status = chip->waitfunc(mtd, chip);
1859 1860 1861 1862 1863 1864 1865 1866 1867 1868
	}

#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 已提交
1869 1870
}

1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890
/**
 * nand_fill_oob - [Internal] Transfer client buffer to oob
 * @chip:	nand chip structure
 * @oob:	oob data buffer
 * @ops:	oob ops structure
 */
static uint8_t *nand_fill_oob(struct nand_chip *chip, uint8_t *oob,
				  struct mtd_oob_ops *ops)
{
	size_t len = ops->ooblen;

	switch(ops->mode) {

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

	case MTD_OOB_AUTO: {
		struct nand_oobfree *free = chip->ecc.layout->oobfree;
1891 1892
		uint32_t boffs = 0, woffs = ops->ooboffs;
		size_t bytes = 0;
1893 1894

		for(; free->length && len; free++, len -= bytes) {
1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908
			/* 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;
			}
1909
			memcpy(chip->oob_poi + boffs, oob, bytes);
1910 1911 1912 1913 1914 1915 1916 1917 1918 1919
			oob += bytes;
		}
		return oob;
	}
	default:
		BUG();
	}
	return NULL;
}

1920
#define NOTALIGNED(x)	(x & (chip->subpagesize - 1)) != 0
L
Linus Torvalds 已提交
1921 1922

/**
1923
 * nand_do_write_ops - [Internal] NAND write with ECC
L
Linus Torvalds 已提交
1924 1925
 * @mtd:	MTD device structure
 * @to:		offset to write to
1926
 * @ops:	oob operations description structure
L
Linus Torvalds 已提交
1927 1928 1929
 *
 * NAND write with ECC
 */
1930 1931
static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1932
{
1933
	int chipnr, realpage, page, blockmask, column;
1934
	struct nand_chip *chip = mtd->priv;
1935 1936 1937
	uint32_t writelen = ops->len;
	uint8_t *oob = ops->oobbuf;
	uint8_t *buf = ops->datbuf;
1938
	int ret, subpage;
L
Linus Torvalds 已提交
1939

1940
	ops->retlen = 0;
1941 1942
	if (!writelen)
		return 0;
L
Linus Torvalds 已提交
1943

1944
	/* reject writes, which are not page aligned */
1945
	if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
1946 1947
		printk(KERN_NOTICE "%s: Attempt to write not "
				"page aligned data\n", __func__);
L
Linus Torvalds 已提交
1948 1949 1950
		return -EINVAL;
	}

1951 1952 1953 1954 1955
	column = to & (mtd->writesize - 1);
	subpage = column || (writelen & (mtd->writesize - 1));

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

1957 1958 1959
	chipnr = (int)(to >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);

L
Linus Torvalds 已提交
1960 1961
	/* Check, if it is write protected */
	if (nand_check_wp(mtd))
1962
		return -EIO;
L
Linus Torvalds 已提交
1963

1964 1965 1966 1967 1968 1969
	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) &&
1970
	    (chip->pagebuf << chip->page_shift) < (to + ops->len))
1971
		chip->pagebuf = -1;
1972

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

1977
	while(1) {
1978
		int bytes = mtd->writesize;
1979
		int cached = writelen > bytes && page != blockmask;
1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990
		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 已提交
1991

1992 1993 1994
		if (unlikely(oob))
			oob = nand_fill_oob(chip, oob, ops);

1995
		ret = chip->write_page(mtd, chip, wbuf, page, cached,
1996
				       (ops->mode == MTD_OOB_RAW));
1997 1998 1999 2000 2001 2002 2003
		if (ret)
			break;

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

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

	ops->retlen = ops->len - writelen;
2018 2019
	if (unlikely(oob))
		ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
2020 2021 2022
	return ret;
}

2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
/**
 * 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;
}

2062
/**
2063
 * nand_write - [MTD Interface] NAND write with ECC
2064 2065 2066
 * @mtd:	MTD device structure
 * @to:		offset to write to
 * @len:	number of bytes to write
2067 2068
 * @retlen:	pointer to variable to store the number of written bytes
 * @buf:	the data to write
2069
 *
2070
 * NAND write with ECC
2071
 */
2072 2073
static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
			  size_t *retlen, const uint8_t *buf)
2074 2075 2076 2077
{
	struct nand_chip *chip = mtd->priv;
	int ret;

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

2084
	nand_get_device(chip, mtd, FL_WRITING);
2085

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

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

R
Richard Purdie 已提交
2092 2093
	*retlen = chip->ops.retlen;

2094
	nand_release_device(mtd);
2095 2096

	return ret;
2097
}
2098

L
Linus Torvalds 已提交
2099
/**
2100
 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
L
Linus Torvalds 已提交
2101 2102
 * @mtd:	MTD device structure
 * @to:		offset to write to
2103
 * @ops:	oob operation description structure
L
Linus Torvalds 已提交
2104 2105 2106
 *
 * NAND write out-of-band
 */
2107 2108
static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
2109
{
2110
	int chipnr, page, status, len;
2111
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2112

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

2116 2117 2118 2119 2120
	if (ops->mode == MTD_OOB_AUTO)
		len = chip->ecc.layout->oobavail;
	else
		len = mtd->oobsize;

L
Linus Torvalds 已提交
2121
	/* Do not allow write past end of page */
2122
	if ((ops->ooboffs + ops->ooblen) > len) {
2123 2124
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to write "
				"past end of page\n", __func__);
L
Linus Torvalds 已提交
2125 2126 2127
		return -EINVAL;
	}

2128
	if (unlikely(ops->ooboffs >= len)) {
2129 2130
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt to start "
				"write outside oob\n", __func__);
2131 2132 2133 2134 2135 2136 2137 2138
		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)) {
2139 2140
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt write beyond "
				"end of device\n", __func__);
2141 2142 2143
		return -EINVAL;
	}

2144
	chipnr = (int)(to >> chip->chip_shift);
2145
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2146

2147 2148 2149 2150 2151 2152 2153 2154 2155
	/* 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.
	 */
2156
	chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
L
Linus Torvalds 已提交
2157 2158 2159

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

L
Linus Torvalds 已提交
2162
	/* Invalidate the page cache, if we write to the cached page */
2163 2164
	if (page == chip->pagebuf)
		chip->pagebuf = -1;
L
Linus Torvalds 已提交
2165

2166 2167 2168 2169
	memset(chip->oob_poi, 0xff, mtd->oobsize);
	nand_fill_oob(chip, ops->oobbuf, ops);
	status = chip->ecc.write_oob(mtd, chip, page & chip->pagemask);
	memset(chip->oob_poi, 0xff, mtd->oobsize);
L
Linus Torvalds 已提交
2170

2171 2172
	if (status)
		return status;
L
Linus Torvalds 已提交
2173

2174
	ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
2175

2176
	return 0;
2177 2178 2179 2180 2181
}

/**
 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
2182
 * @to:		offset to write to
2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193
 * @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 */
2194
	if (ops->datbuf && (to + ops->len) > mtd->size) {
2195 2196
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Attempt write beyond "
				"end of device\n", __func__);
2197 2198 2199
		return -EINVAL;
	}

2200
	nand_get_device(chip, mtd, FL_WRITING);
2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216

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

2217
 out:
L
Linus Torvalds 已提交
2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228
	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
 */
2229
static void single_erase_cmd(struct mtd_info *mtd, int page)
L
Linus Torvalds 已提交
2230
{
2231
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2232
	/* Send commands to erase a block */
2233 2234
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
	chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
L
Linus Torvalds 已提交
2235 2236 2237 2238 2239 2240 2241 2242 2243 2244
}

/**
 * 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
 */
2245
static void multi_erase_cmd(struct mtd_info *mtd, int page)
L
Linus Torvalds 已提交
2246
{
2247
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2248
	/* Send commands to erase a block */
2249 2250 2251 2252 2253
	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 已提交
2254 2255 2256 2257 2258 2259 2260 2261 2262
}

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

2268
#define BBT_PAGE_MASK	0xffffff3f
L
Linus Torvalds 已提交
2269
/**
2270
 * nand_erase_nand - [Internal] erase block(s)
L
Linus Torvalds 已提交
2271 2272 2273 2274 2275 2276
 * @mtd:	MTD device structure
 * @instr:	erase instruction
 * @allowbbt:	allow erasing the bbt area
 *
 * Erase one ore more blocks
 */
2277 2278
int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
		    int allowbbt)
L
Linus Torvalds 已提交
2279
{
2280
	int page, status, pages_per_block, ret, chipnr;
2281
	struct nand_chip *chip = mtd->priv;
2282
	loff_t rewrite_bbt[NAND_MAX_CHIPS]={0};
2283
	unsigned int bbt_masked_page = 0xffffffff;
2284
	loff_t len;
L
Linus Torvalds 已提交
2285

2286 2287 2288
	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 已提交
2289 2290

	/* Start address must align on block boundary */
2291
	if (instr->addr & ((1 << chip->phys_erase_shift) - 1)) {
2292
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Unaligned address\n", __func__);
L
Linus Torvalds 已提交
2293 2294 2295 2296
		return -EINVAL;
	}

	/* Length must align on block boundary */
2297
	if (instr->len & ((1 << chip->phys_erase_shift) - 1)) {
2298 2299
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Length not block aligned\n",
					__func__);
L
Linus Torvalds 已提交
2300 2301 2302 2303 2304
		return -EINVAL;
	}

	/* Do not allow erase past end of device */
	if ((instr->len + instr->addr) > mtd->size) {
2305 2306
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Erase past end of device\n",
					__func__);
L
Linus Torvalds 已提交
2307 2308 2309
		return -EINVAL;
	}

2310
	instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN;
L
Linus Torvalds 已提交
2311 2312

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

	/* Shift to get first page */
2316 2317
	page = (int)(instr->addr >> chip->page_shift);
	chipnr = (int)(instr->addr >> chip->chip_shift);
L
Linus Torvalds 已提交
2318 2319

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

	/* Select the NAND device */
2323
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2324 2325 2326

	/* Check, if it is write protected */
	if (nand_check_wp(mtd)) {
2327 2328
		DEBUG(MTD_DEBUG_LEVEL0, "%s: Device is write protected!!!\n",
					__func__);
L
Linus Torvalds 已提交
2329 2330 2331 2332
		instr->state = MTD_ERASE_FAILED;
		goto erase_exit;
	}

2333 2334 2335 2336 2337 2338 2339 2340
	/*
	 * 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;
2341

L
Linus Torvalds 已提交
2342 2343 2344 2345 2346 2347
	/* Loop through the pages */
	len = instr->len;

	instr->state = MTD_ERASING;

	while (len) {
2348 2349 2350 2351 2352
		/*
		 * 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)) {
2353 2354
			printk(KERN_WARNING "%s: attempt to erase a bad block "
					"at page 0x%08x\n", __func__, page);
L
Linus Torvalds 已提交
2355 2356 2357
			instr->state = MTD_ERASE_FAILED;
			goto erase_exit;
		}
2358

2359 2360 2361 2362 2363 2364 2365
		/*
		 * 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 已提交
2366

2367
		chip->erase_cmd(mtd, page & chip->pagemask);
2368

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

2371 2372 2373 2374 2375 2376 2377
		/*
		 * 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);
2378

L
Linus Torvalds 已提交
2379
		/* See if block erase succeeded */
2380
		if (status & NAND_STATUS_FAIL) {
2381 2382
			DEBUG(MTD_DEBUG_LEVEL0, "%s: Failed erase, "
					"page 0x%08x\n", __func__, page);
L
Linus Torvalds 已提交
2383
			instr->state = MTD_ERASE_FAILED;
2384 2385
			instr->fail_addr =
				((loff_t)page << chip->page_shift);
L
Linus Torvalds 已提交
2386 2387
			goto erase_exit;
		}
2388

2389 2390 2391 2392 2393 2394
		/*
		 * 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)
2395 2396
			    rewrite_bbt[chipnr] =
					((loff_t)page << chip->page_shift);
2397

L
Linus Torvalds 已提交
2398
		/* Increment page address and decrement length */
2399
		len -= (1 << chip->phys_erase_shift);
L
Linus Torvalds 已提交
2400 2401 2402
		page += pages_per_block;

		/* Check, if we cross a chip boundary */
2403
		if (len && !(page & chip->pagemask)) {
L
Linus Torvalds 已提交
2404
			chipnr++;
2405 2406
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
2407

2408 2409 2410 2411 2412 2413 2414 2415
			/*
			 * 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 已提交
2416 2417 2418 2419
		}
	}
	instr->state = MTD_ERASE_DONE;

2420
 erase_exit:
L
Linus Torvalds 已提交
2421 2422 2423 2424 2425 2426

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

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

2427 2428 2429 2430
	/* Do call back function */
	if (!ret)
		mtd_erase_callback(instr);

2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441
	/*
	 * 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 */
2442 2443 2444
		DEBUG(MTD_DEBUG_LEVEL0, "%s: nand_update_bbt "
			"(%d:0x%0llx 0x%0x)\n", __func__, chipnr,
			rewrite_bbt[chipnr], chip->bbt_td->pages[chipnr]);
2445
		nand_update_bbt(mtd, rewrite_bbt[chipnr]);
2446 2447
	}

L
Linus Torvalds 已提交
2448 2449 2450 2451 2452 2453 2454 2455 2456 2457
	/* 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
 */
2458
static void nand_sync(struct mtd_info *mtd)
L
Linus Torvalds 已提交
2459
{
2460
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2461

2462
	DEBUG(MTD_DEBUG_LEVEL3, "%s: called\n", __func__);
L
Linus Torvalds 已提交
2463 2464

	/* Grab the lock and see if the device is available */
2465
	nand_get_device(chip, mtd, FL_SYNCING);
L
Linus Torvalds 已提交
2466
	/* Release it and go back */
2467
	nand_release_device(mtd);
L
Linus Torvalds 已提交
2468 2469 2470
}

/**
2471
 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
L
Linus Torvalds 已提交
2472
 * @mtd:	MTD device structure
R
Randy Dunlap 已提交
2473
 * @offs:	offset relative to mtd start
L
Linus Torvalds 已提交
2474
 */
2475
static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
L
Linus Torvalds 已提交
2476 2477
{
	/* Check for invalid offset */
2478
	if (offs > mtd->size)
L
Linus Torvalds 已提交
2479
		return -EINVAL;
2480

2481
	return nand_block_checkbad(mtd, offs, 1, 0);
L
Linus Torvalds 已提交
2482 2483 2484
}

/**
2485
 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
L
Linus Torvalds 已提交
2486 2487 2488
 * @mtd:	MTD device structure
 * @ofs:	offset relative to mtd start
 */
2489
static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
L
Linus Torvalds 已提交
2490
{
2491
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2492 2493
	int ret;

2494 2495
	if ((ret = nand_block_isbad(mtd, ofs))) {
		/* If it was bad already, return success and do nothing. */
L
Linus Torvalds 已提交
2496 2497
		if (ret > 0)
			return 0;
2498 2499
		return ret;
	}
L
Linus Torvalds 已提交
2500

2501
	return chip->block_markbad(mtd, ofs);
L
Linus Torvalds 已提交
2502 2503
}

2504 2505 2506 2507 2508 2509
/**
 * nand_suspend - [MTD Interface] Suspend the NAND flash
 * @mtd:	MTD device structure
 */
static int nand_suspend(struct mtd_info *mtd)
{
2510
	struct nand_chip *chip = mtd->priv;
2511

2512
	return nand_get_device(chip, mtd, FL_PM_SUSPENDED);
2513 2514 2515 2516 2517 2518 2519 2520
}

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

2523
	if (chip->state == FL_PM_SUSPENDED)
2524 2525
		nand_release_device(mtd);
	else
2526 2527
		printk(KERN_ERR "%s called for a chip which is not "
		       "in suspended state\n", __func__);
2528 2529
}

T
Thomas Gleixner 已提交
2530 2531 2532
/*
 * Set default functions
 */
2533
static void nand_set_defaults(struct nand_chip *chip, int busw)
T
Thomas Gleixner 已提交
2534
{
L
Linus Torvalds 已提交
2535
	/* check for proper chip_delay setup, set 20us if not */
2536 2537
	if (!chip->chip_delay)
		chip->chip_delay = 20;
L
Linus Torvalds 已提交
2538 2539

	/* check, if a user supplied command function given */
2540 2541
	if (chip->cmdfunc == NULL)
		chip->cmdfunc = nand_command;
L
Linus Torvalds 已提交
2542 2543

	/* check, if a user supplied wait function given */
2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564
	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;
2565 2566 2567 2568 2569 2570 2571

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

T
Thomas Gleixner 已提交
2572 2573 2574
}

/*
2575
 * Get the flash and manufacturer id and lookup if the type is supported
T
Thomas Gleixner 已提交
2576 2577
 */
static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
2578
						  struct nand_chip *chip,
T
Thomas Gleixner 已提交
2579 2580 2581 2582
						  int busw, int *maf_id)
{
	struct nand_flash_dev *type = NULL;
	int i, dev_id, maf_idx;
2583
	int tmp_id, tmp_manf;
L
Linus Torvalds 已提交
2584 2585

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

2588 2589 2590 2591 2592 2593
	/*
	 * 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 已提交
2594
	/* Send the command for reading device ID */
2595
	chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
L
Linus Torvalds 已提交
2596 2597

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

2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620
	/* Try again to make sure, as some systems the bus-hold or other
	 * interface concerns can cause random data which looks like a
	 * possibly credible NAND flash to appear. If the two results do
	 * not match, ignore the device completely.
	 */

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

	/* Read manufacturer and device IDs */

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

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

T
Thomas Gleixner 已提交
2621
	/* Lookup the flash id */
L
Linus Torvalds 已提交
2622
	for (i = 0; nand_flash_ids[i].name != NULL; i++) {
T
Thomas Gleixner 已提交
2623 2624 2625 2626 2627
		if (dev_id == nand_flash_ids[i].id) {
			type =  &nand_flash_ids[i];
			break;
		}
	}
2628

T
Thomas Gleixner 已提交
2629 2630 2631
	if (!type)
		return ERR_PTR(-ENODEV);

2632 2633 2634
	if (!mtd->name)
		mtd->name = type->name;

2635
	chip->chipsize = (uint64_t)type->chipsize << 20;
T
Thomas Gleixner 已提交
2636 2637

	/* Newer devices have all the information in additional id bytes */
2638
	if (!type->pagesize) {
T
Thomas Gleixner 已提交
2639
		int extid;
2640 2641
		/* The 3rd id byte holds MLC / multichip data */
		chip->cellinfo = chip->read_byte(mtd);
T
Thomas Gleixner 已提交
2642
		/* The 4th id byte is the important one */
2643
		extid = chip->read_byte(mtd);
T
Thomas Gleixner 已提交
2644
		/* Calc pagesize */
2645
		mtd->writesize = 1024 << (extid & 0x3);
T
Thomas Gleixner 已提交
2646 2647
		extid >>= 2;
		/* Calc oobsize */
2648
		mtd->oobsize = (8 << (extid & 0x01)) * (mtd->writesize >> 9);
T
Thomas Gleixner 已提交
2649 2650 2651 2652 2653 2654
		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;
2655

T
Thomas Gleixner 已提交
2656 2657
	} else {
		/*
2658
		 * Old devices have chip data hardcoded in the device id table
T
Thomas Gleixner 已提交
2659
		 */
2660 2661
		mtd->erasesize = type->erasesize;
		mtd->writesize = type->pagesize;
2662
		mtd->oobsize = mtd->writesize / 32;
2663
		busw = type->options & NAND_BUSWIDTH_16;
T
Thomas Gleixner 已提交
2664
	}
L
Linus Torvalds 已提交
2665

T
Thomas Gleixner 已提交
2666
	/* Try to identify manufacturer */
2667
	for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
T
Thomas Gleixner 已提交
2668 2669 2670
		if (nand_manuf_ids[maf_idx].id == *maf_id)
			break;
	}
2671

T
Thomas Gleixner 已提交
2672 2673
	/*
	 * Check, if buswidth is correct. Hardware drivers should set
2674
	 * chip correct !
T
Thomas Gleixner 已提交
2675
	 */
2676
	if (busw != (chip->options & NAND_BUSWIDTH_16)) {
T
Thomas Gleixner 已提交
2677 2678 2679 2680
		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",
2681
		       (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
T
Thomas Gleixner 已提交
2682 2683 2684
		       busw ? 16 : 8);
		return ERR_PTR(-EINVAL);
	}
2685

T
Thomas Gleixner 已提交
2686
	/* Calculate the address shift from the page size */
2687
	chip->page_shift = ffs(mtd->writesize) - 1;
T
Thomas Gleixner 已提交
2688
	/* Convert chipsize to number of pages per chip -1. */
2689
	chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
2690

2691
	chip->bbt_erase_shift = chip->phys_erase_shift =
T
Thomas Gleixner 已提交
2692
		ffs(mtd->erasesize) - 1;
2693 2694 2695 2696
	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 已提交
2697

T
Thomas Gleixner 已提交
2698
	/* Set the bad block position */
2699
	chip->badblockpos = mtd->writesize > 512 ?
T
Thomas Gleixner 已提交
2700
		NAND_LARGE_BADBLOCK_POS : NAND_SMALL_BADBLOCK_POS;
2701

T
Thomas Gleixner 已提交
2702
	/* Get chip options, preserve non chip based options */
2703
	chip->options &= ~NAND_CHIPOPTIONS_MSK;
2704
	chip->options |= type->options & NAND_CHIPOPTIONS_MSK;
T
Thomas Gleixner 已提交
2705 2706

	/*
2707
	 * Set chip as a default. Board drivers can override it, if necessary
T
Thomas Gleixner 已提交
2708
	 */
2709
	chip->options |= NAND_NO_AUTOINCR;
T
Thomas Gleixner 已提交
2710

2711
	/* Check if chip is a not a samsung device. Do not clear the
T
Thomas Gleixner 已提交
2712 2713
	 * options for chips which are not having an extended id.
	 */
2714
	if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
2715
		chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
T
Thomas Gleixner 已提交
2716 2717

	/* Check for AND chips with 4 page planes */
2718 2719
	if (chip->options & NAND_4PAGE_ARRAY)
		chip->erase_cmd = multi_erase_cmd;
T
Thomas Gleixner 已提交
2720
	else
2721
		chip->erase_cmd = single_erase_cmd;
T
Thomas Gleixner 已提交
2722 2723

	/* Do not replace user supplied command function ! */
2724 2725
	if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
		chip->cmdfunc = nand_command_lp;
T
Thomas Gleixner 已提交
2726 2727 2728 2729 2730 2731 2732 2733 2734

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

/**
2735 2736 2737
 * nand_scan_ident - [NAND Interface] Scan for the NAND device
 * @mtd:	     MTD device structure
 * @maxchips:	     Number of chips to scan for
T
Thomas Gleixner 已提交
2738
 *
2739 2740
 * 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 已提交
2741
 *
2742
 * The mtd->owner field must be set to the module of the caller.
T
Thomas Gleixner 已提交
2743
 */
2744
int nand_scan_ident(struct mtd_info *mtd, int maxchips)
T
Thomas Gleixner 已提交
2745 2746
{
	int i, busw, nand_maf_id;
2747
	struct nand_chip *chip = mtd->priv;
T
Thomas Gleixner 已提交
2748 2749 2750
	struct nand_flash_dev *type;

	/* Get buswidth to select the correct functions */
2751
	busw = chip->options & NAND_BUSWIDTH_16;
T
Thomas Gleixner 已提交
2752
	/* Set the default functions */
2753
	nand_set_defaults(chip, busw);
T
Thomas Gleixner 已提交
2754 2755

	/* Read the flash type */
2756
	type = nand_get_flash_type(mtd, chip, busw, &nand_maf_id);
T
Thomas Gleixner 已提交
2757 2758

	if (IS_ERR(type)) {
2759
		printk(KERN_WARNING "No NAND device found!!!\n");
2760
		chip->select_chip(mtd, -1);
T
Thomas Gleixner 已提交
2761
		return PTR_ERR(type);
L
Linus Torvalds 已提交
2762 2763
	}

T
Thomas Gleixner 已提交
2764
	/* Check for a chip array */
2765
	for (i = 1; i < maxchips; i++) {
2766
		chip->select_chip(mtd, i);
2767 2768
		/* See comment in nand_get_flash_type for reset */
		chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
L
Linus Torvalds 已提交
2769
		/* Send the command for reading device ID */
2770
		chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
L
Linus Torvalds 已提交
2771
		/* Read manufacturer and device IDs */
2772 2773
		if (nand_maf_id != chip->read_byte(mtd) ||
		    type->id != chip->read_byte(mtd))
L
Linus Torvalds 已提交
2774 2775 2776 2777
			break;
	}
	if (i > 1)
		printk(KERN_INFO "%d NAND chips detected\n", i);
2778

L
Linus Torvalds 已提交
2779
	/* Store the number of chips and calc total size for mtd */
2780 2781
	chip->numchips = i;
	mtd->size = i * chip->chipsize;
T
Thomas Gleixner 已提交
2782

2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799
	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;

2800 2801 2802 2803 2804
	if (!(chip->options & NAND_OWN_BUFFERS))
		chip->buffers = kmalloc(sizeof(*chip->buffers), GFP_KERNEL);
	if (!chip->buffers)
		return -ENOMEM;

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

T
Thomas Gleixner 已提交
2808 2809 2810
	/*
	 * If no default placement scheme is given, select an appropriate one
	 */
2811
	if (!chip->ecc.layout) {
2812
		switch (mtd->oobsize) {
L
Linus Torvalds 已提交
2813
		case 8:
2814
			chip->ecc.layout = &nand_oob_8;
L
Linus Torvalds 已提交
2815 2816
			break;
		case 16:
2817
			chip->ecc.layout = &nand_oob_16;
L
Linus Torvalds 已提交
2818 2819
			break;
		case 64:
2820
			chip->ecc.layout = &nand_oob_64;
L
Linus Torvalds 已提交
2821
			break;
2822 2823 2824
		case 128:
			chip->ecc.layout = &nand_oob_128;
			break;
L
Linus Torvalds 已提交
2825
		default:
T
Thomas Gleixner 已提交
2826 2827
			printk(KERN_WARNING "No oob scheme defined for "
			       "oobsize %d\n", mtd->oobsize);
L
Linus Torvalds 已提交
2828 2829 2830
			BUG();
		}
	}
2831

2832 2833 2834
	if (!chip->write_page)
		chip->write_page = nand_write_page;

2835
	/*
T
Thomas Gleixner 已提交
2836 2837
	 * check ECC mode, default to software if 3byte/512byte hardware ECC is
	 * selected and we have 256 byte pagesize fallback to software ECC
2838
	 */
2839

2840
	switch (chip->ecc.mode) {
2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851
	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 已提交
2852
	case NAND_ECC_HW:
2853 2854 2855
		/* Use standard hwecc read page function ? */
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_hwecc;
2856 2857
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_hwecc;
2858 2859 2860 2861
		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;
2862 2863 2864 2865
		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;
2866

T
Thomas Gleixner 已提交
2867
	case NAND_ECC_HW_SYNDROME:
2868 2869 2870
		if ((!chip->ecc.calculate || !chip->ecc.correct ||
		     !chip->ecc.hwctl) &&
		    (!chip->ecc.read_page ||
2871
		     chip->ecc.read_page == nand_read_page_hwecc ||
2872
		     !chip->ecc.write_page ||
2873
		     chip->ecc.write_page == nand_write_page_hwecc)) {
2874
			printk(KERN_WARNING "No ECC functions supplied; "
T
Thomas Gleixner 已提交
2875 2876 2877
			       "Hardware ECC not possible\n");
			BUG();
		}
2878
		/* Use standard syndrome read/write page function ? */
2879 2880
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_syndrome;
2881 2882
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_syndrome;
2883 2884 2885 2886
		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;
2887 2888 2889 2890
		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;
2891

2892
		if (mtd->writesize >= chip->ecc.size)
T
Thomas Gleixner 已提交
2893 2894 2895
			break;
		printk(KERN_WARNING "%d byte HW ECC not possible on "
		       "%d byte page size, fallback to SW ECC\n",
2896 2897
		       chip->ecc.size, mtd->writesize);
		chip->ecc.mode = NAND_ECC_SOFT;
2898

T
Thomas Gleixner 已提交
2899
	case NAND_ECC_SOFT:
2900 2901
		chip->ecc.calculate = nand_calculate_ecc;
		chip->ecc.correct = nand_correct_data;
2902
		chip->ecc.read_page = nand_read_page_swecc;
2903
		chip->ecc.read_subpage = nand_read_subpage;
2904
		chip->ecc.write_page = nand_write_page_swecc;
2905 2906
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
2907 2908
		chip->ecc.read_oob = nand_read_oob_std;
		chip->ecc.write_oob = nand_write_oob_std;
2909 2910
		if (!chip->ecc.size)
			chip->ecc.size = 256;
2911
		chip->ecc.bytes = 3;
L
Linus Torvalds 已提交
2912
		break;
2913 2914

	case NAND_ECC_NONE:
T
Thomas Gleixner 已提交
2915 2916
		printk(KERN_WARNING "NAND_ECC_NONE selected by board driver. "
		       "This is not recommended !!\n");
2917 2918
		chip->ecc.read_page = nand_read_page_raw;
		chip->ecc.write_page = nand_write_page_raw;
2919
		chip->ecc.read_oob = nand_read_oob_std;
2920 2921
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
2922
		chip->ecc.write_oob = nand_write_oob_std;
2923 2924
		chip->ecc.size = mtd->writesize;
		chip->ecc.bytes = 0;
L
Linus Torvalds 已提交
2925
		break;
2926

L
Linus Torvalds 已提交
2927
	default:
T
Thomas Gleixner 已提交
2928
		printk(KERN_WARNING "Invalid NAND_ECC_MODE %d\n",
2929
		       chip->ecc.mode);
2930
		BUG();
L
Linus Torvalds 已提交
2931
	}
2932

2933 2934 2935 2936 2937
	/*
	 * The number of bytes available for a client to place data into
	 * the out of band area
	 */
	chip->ecc.layout->oobavail = 0;
2938 2939
	for (i = 0; chip->ecc.layout->oobfree[i].length
			&& i < ARRAY_SIZE(chip->ecc.layout->oobfree); i++)
2940 2941
		chip->ecc.layout->oobavail +=
			chip->ecc.layout->oobfree[i].length;
V
Vitaly Wool 已提交
2942
	mtd->oobavail = chip->ecc.layout->oobavail;
2943

T
Thomas Gleixner 已提交
2944 2945 2946 2947
	/*
	 * Set the number of read / write steps for one page depending on ECC
	 * mode
	 */
2948 2949
	chip->ecc.steps = mtd->writesize / chip->ecc.size;
	if(chip->ecc.steps * chip->ecc.size != mtd->writesize) {
T
Thomas Gleixner 已提交
2950 2951
		printk(KERN_WARNING "Invalid ecc parameters\n");
		BUG();
L
Linus Torvalds 已提交
2952
	}
2953
	chip->ecc.total = chip->ecc.steps * chip->ecc.bytes;
2954

2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966
	/*
	 * 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:
2967
		case 16:
2968 2969 2970 2971 2972 2973
			mtd->subpage_sft = 2;
			break;
		}
	}
	chip->subpagesize = mtd->writesize >> mtd->subpage_sft;

2974
	/* Initialize state */
2975
	chip->state = FL_READY;
L
Linus Torvalds 已提交
2976 2977

	/* De-select the device */
2978
	chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
2979 2980

	/* Invalidate the pagebuffer reference */
2981
	chip->pagebuf = -1;
L
Linus Torvalds 已提交
2982 2983 2984

	/* Fill in remaining MTD driver data */
	mtd->type = MTD_NANDFLASH;
J
Joern Engel 已提交
2985
	mtd->flags = MTD_CAP_NANDFLASH;
L
Linus Torvalds 已提交
2986 2987 2988 2989 2990
	mtd->erase = nand_erase;
	mtd->point = NULL;
	mtd->unpoint = NULL;
	mtd->read = nand_read;
	mtd->write = nand_write;
2991
	mtd->panic_write = panic_nand_write;
L
Linus Torvalds 已提交
2992 2993 2994 2995 2996
	mtd->read_oob = nand_read_oob;
	mtd->write_oob = nand_write_oob;
	mtd->sync = nand_sync;
	mtd->lock = NULL;
	mtd->unlock = NULL;
2997 2998
	mtd->suspend = nand_suspend;
	mtd->resume = nand_resume;
L
Linus Torvalds 已提交
2999 3000 3001
	mtd->block_isbad = nand_block_isbad;
	mtd->block_markbad = nand_block_markbad;

3002 3003
	/* propagate ecc.layout to mtd_info */
	mtd->ecclayout = chip->ecc.layout;
L
Linus Torvalds 已提交
3004

3005
	/* Check, if we should skip the bad block table scan */
3006
	if (chip->options & NAND_SKIP_BBTSCAN)
3007
		return 0;
L
Linus Torvalds 已提交
3008 3009

	/* Build bad block table */
3010
	return chip->scan_bbt(mtd);
L
Linus Torvalds 已提交
3011 3012
}

3013
/* is_module_text_address() isn't exported, and it's mostly a pointless
3014 3015 3016 3017 3018 3019
   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() \
3020
	is_module_text_address((unsigned long)__builtin_return_address(0))
3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040
#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()) {
3041 3042
		printk(KERN_CRIT "%s called with NULL mtd->owner!\n",
				__func__);
3043 3044 3045 3046 3047 3048 3049 3050 3051
		BUG();
	}

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

L
Linus Torvalds 已提交
3052
/**
3053
 * nand_release - [NAND Interface] Free resources held by the NAND device
L
Linus Torvalds 已提交
3054 3055
 * @mtd:	MTD device structure
*/
3056
void nand_release(struct mtd_info *mtd)
L
Linus Torvalds 已提交
3057
{
3058
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
3059 3060 3061

#ifdef CONFIG_MTD_PARTITIONS
	/* Deregister partitions */
3062
	del_mtd_partitions(mtd);
L
Linus Torvalds 已提交
3063 3064
#endif
	/* Deregister the device */
3065
	del_mtd_device(mtd);
L
Linus Torvalds 已提交
3066

J
Jesper Juhl 已提交
3067
	/* Free bad block table memory */
3068
	kfree(chip->bbt);
3069 3070
	if (!(chip->options & NAND_OWN_BUFFERS))
		kfree(chip->buffers);
L
Linus Torvalds 已提交
3071 3072
}

3073
EXPORT_SYMBOL_GPL(nand_scan);
3074 3075
EXPORT_SYMBOL_GPL(nand_scan_ident);
EXPORT_SYMBOL_GPL(nand_scan_tail);
3076
EXPORT_SYMBOL_GPL(nand_release);
3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091

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

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