nand_base.c 60.5 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 10
 *	Additional technical information is available on
 *	http://www.linux-mtd.infradead.org/tech/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 27 28 29 30 31 32 33
 *	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.
 *
 * 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.
 *
 */

34
#include <linux/module.h>
L
Linus Torvalds 已提交
35 36
#include <linux/delay.h>
#include <linux/errno.h>
T
Thomas Gleixner 已提交
37
#include <linux/err.h>
L
Linus Torvalds 已提交
38 39 40 41 42 43 44 45 46
#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>
47
#include <linux/leds.h>
L
Linus Torvalds 已提交
48 49 50 51 52 53 54
#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 */
55
static struct nand_ecclayout nand_oob_8 = {
L
Linus Torvalds 已提交
56 57
	.eccbytes = 3,
	.eccpos = {0, 1, 2},
58 59 60 61 62
	.oobfree = {
		{.offset = 3,
		 .length = 2},
		{.offset = 6,
		 .length = 2}}
L
Linus Torvalds 已提交
63 64
};

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

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

84
static int nand_get_device(struct nand_chip *chip, struct mtd_info *mtd,
85
			   int new_state);
L
Linus Torvalds 已提交
86

87 88 89
static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops);

T
Thomas Gleixner 已提交
90 91 92 93 94 95
/*
 * For devices which display every fart in the system on a seperate LED. Is
 * compiled away when LED support is disabled.
 */
DEFINE_LED_TRIGGER(nand_led_trigger);

L
Linus Torvalds 已提交
96 97 98
/**
 * nand_release_device - [GENERIC] release chip
 * @mtd:	MTD device structure
99 100
 *
 * Deselect, release chip lock and wake up anyone waiting on the device
L
Linus Torvalds 已提交
101
 */
102
static void nand_release_device(struct mtd_info *mtd)
L
Linus Torvalds 已提交
103
{
104
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
105 106

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

T
Thomas Gleixner 已提交
109
	/* Release the controller and the chip */
110 111 112 113 114
	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 已提交
115 116 117 118 119 120 121 122
}

/**
 * nand_read_byte - [DEFAULT] read one byte from the chip
 * @mtd:	MTD device structure
 *
 * Default read function for 8bit buswith
 */
123
static uint8_t nand_read_byte(struct mtd_info *mtd)
L
Linus Torvalds 已提交
124
{
125 126
	struct nand_chip *chip = mtd->priv;
	return readb(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
127 128 129 130 131 132
}

/**
 * nand_read_byte16 - [DEFAULT] read one byte endianess aware from the chip
 * @mtd:	MTD device structure
 *
133
 * Default read function for 16bit buswith with
L
Linus Torvalds 已提交
134 135
 * endianess conversion
 */
136
static uint8_t nand_read_byte16(struct mtd_info *mtd)
L
Linus Torvalds 已提交
137
{
138 139
	struct nand_chip *chip = mtd->priv;
	return (uint8_t) cpu_to_le16(readw(chip->IO_ADDR_R));
L
Linus Torvalds 已提交
140 141 142 143 144 145
}

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

/**
 * nand_select_chip - [DEFAULT] control CE line
 * @mtd:	MTD device structure
 * @chip:	chipnumber to select, -1 for deselect
 *
 * Default select function for 1 chip devices.
 */
162
static void nand_select_chip(struct mtd_info *mtd, int chipnr)
L
Linus Torvalds 已提交
163
{
164 165 166
	struct nand_chip *chip = mtd->priv;

	switch (chipnr) {
L
Linus Torvalds 已提交
167
	case -1:
168
		chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
L
Linus Torvalds 已提交
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
		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
 */
186
static void nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
187 188
{
	int i;
189
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
190

191
	for (i = 0; i < len; i++)
192
		writeb(buf[i], chip->IO_ADDR_W);
L
Linus Torvalds 已提交
193 194 195
}

/**
196
 * nand_read_buf - [DEFAULT] read chip data into buffer
L
Linus Torvalds 已提交
197 198 199 200 201 202
 * @mtd:	MTD device structure
 * @buf:	buffer to store date
 * @len:	number of bytes to read
 *
 * Default read function for 8bit buswith
 */
203
static void nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
L
Linus Torvalds 已提交
204 205
{
	int i;
206
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
207

208
	for (i = 0; i < len; i++)
209
		buf[i] = readb(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
210 211 212
}

/**
213
 * nand_verify_buf - [DEFAULT] Verify chip data against buffer
L
Linus Torvalds 已提交
214 215 216 217 218 219
 * @mtd:	MTD device structure
 * @buf:	buffer containing the data to compare
 * @len:	number of bytes to compare
 *
 * Default verify function for 8bit buswith
 */
220
static int nand_verify_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
221 222
{
	int i;
223
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
224

225
	for (i = 0; i < len; i++)
226
		if (buf[i] != readb(chip->IO_ADDR_R))
L
Linus Torvalds 已提交
227 228 229 230 231 232 233 234 235 236 237 238
			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
 */
239
static void nand_write_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
240 241
{
	int i;
242
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
243 244
	u16 *p = (u16 *) buf;
	len >>= 1;
245

246
	for (i = 0; i < len; i++)
247
		writew(p[i], chip->IO_ADDR_W);
248

L
Linus Torvalds 已提交
249 250 251
}

/**
252
 * nand_read_buf16 - [DEFAULT] read chip data into buffer
L
Linus Torvalds 已提交
253 254 255 256 257 258
 * @mtd:	MTD device structure
 * @buf:	buffer to store date
 * @len:	number of bytes to read
 *
 * Default read function for 16bit buswith
 */
259
static void nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len)
L
Linus Torvalds 已提交
260 261
{
	int i;
262
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
263 264 265
	u16 *p = (u16 *) buf;
	len >>= 1;

266
	for (i = 0; i < len; i++)
267
		p[i] = readw(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
268 269 270
}

/**
271
 * nand_verify_buf16 - [DEFAULT] Verify chip data against buffer
L
Linus Torvalds 已提交
272 273 274 275 276 277
 * @mtd:	MTD device structure
 * @buf:	buffer containing the data to compare
 * @len:	number of bytes to compare
 *
 * Default verify function for 16bit buswith
 */
278
static int nand_verify_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
279 280
{
	int i;
281
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
282 283 284
	u16 *p = (u16 *) buf;
	len >>= 1;

285
	for (i = 0; i < len; i++)
286
		if (p[i] != readw(chip->IO_ADDR_R))
L
Linus Torvalds 已提交
287 288 289 290 291 292 293 294 295 296 297
			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
 *
298
 * Check, if the block is bad.
L
Linus Torvalds 已提交
299 300 301 302
 */
static int nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
{
	int page, chipnr, res = 0;
303
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
304 305 306
	u16 bad;

	if (getchip) {
307 308
		page = (int)(ofs >> chip->page_shift);
		chipnr = (int)(ofs >> chip->chip_shift);
L
Linus Torvalds 已提交
309

310
		nand_get_device(chip, mtd, FL_READING);
L
Linus Torvalds 已提交
311 312

		/* Select the NAND device */
313
		chip->select_chip(mtd, chipnr);
314
	} else
315
		page = (int)ofs;
L
Linus Torvalds 已提交
316

317 318 319 320 321
	if (chip->options & NAND_BUSWIDTH_16) {
		chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos & 0xFE,
			      page & chip->pagemask);
		bad = cpu_to_le16(chip->read_word(mtd));
		if (chip->badblockpos & 0x1)
322
			bad >>= 8;
L
Linus Torvalds 已提交
323 324 325
		if ((bad & 0xFF) != 0xff)
			res = 1;
	} else {
326 327 328
		chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos,
			      page & chip->pagemask);
		if (chip->read_byte(mtd) != 0xff)
L
Linus Torvalds 已提交
329 330
			res = 1;
	}
331

332
	if (getchip)
L
Linus Torvalds 已提交
333
		nand_release_device(mtd);
334

L
Linus Torvalds 已提交
335 336 337 338 339 340 341 342 343 344 345 346 347
	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)
{
348
	struct nand_chip *chip = mtd->priv;
349
	uint8_t buf[2] = { 0, 0 };
350
	int block, ret;
351

L
Linus Torvalds 已提交
352
	/* Get block number */
353 354 355
	block = ((int)ofs) >> chip->bbt_erase_shift;
	if (chip->bbt)
		chip->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
L
Linus Torvalds 已提交
356 357

	/* Do we have a flash based bad block table ? */
358
	if (chip->options & NAND_USE_FLASH_BBT)
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
		ret = nand_update_bbt(mtd, ofs);
	else {
		/* We write two bytes, so we dont have to mess with 16 bit
		 * access
		 */
		ofs += mtd->oobsize;
		chip->ops.len = 2;
		chip->ops.datbuf = NULL;
		chip->ops.oobbuf = buf;
		chip->ops.ooboffs = chip->badblockpos & ~0x01;

		ret = nand_do_write_oob(mtd, ofs, &chip->ops);
	}
	if (!ret)
		mtd->ecc_stats.badblocks++;
	return ret;
L
Linus Torvalds 已提交
375 376
}

377
/**
L
Linus Torvalds 已提交
378 379
 * nand_check_wp - [GENERIC] check if the chip is write protected
 * @mtd:	MTD device structure
380
 * Check, if the device is write protected
L
Linus Torvalds 已提交
381
 *
382
 * The function expects, that the device is already selected
L
Linus Torvalds 已提交
383
 */
384
static int nand_check_wp(struct mtd_info *mtd)
L
Linus Torvalds 已提交
385
{
386
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
387
	/* Check the WP bit */
388 389
	chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
	return (chip->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
L
Linus Torvalds 已提交
390 391 392 393 394 395 396 397 398 399 400 401
}

/**
 * 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.
 */
402 403
static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip,
			       int allowbbt)
L
Linus Torvalds 已提交
404
{
405
	struct nand_chip *chip = mtd->priv;
406

407 408
	if (!chip->bbt)
		return chip->block_bad(mtd, ofs, getchip);
409

L
Linus Torvalds 已提交
410
	/* Return info from the table */
411
	return nand_isbad_bbt(mtd, ofs, allowbbt);
L
Linus Torvalds 已提交
412 413
}

414
/*
415 416 417 418 419
 * Wait for the ready pin, after a command
 * The timeout is catched later.
 */
static void nand_wait_ready(struct mtd_info *mtd)
{
420
	struct nand_chip *chip = mtd->priv;
421
	unsigned long timeo = jiffies + 2;
422

423
	led_trigger_event(nand_led_trigger, LED_FULL);
424 425
	/* wait until command is processed or timeout occures */
	do {
426
		if (chip->dev_ready(mtd))
427
			break;
I
Ingo Molnar 已提交
428
		touch_softlockup_watchdog();
429
	} while (time_before(jiffies, timeo));
430
	led_trigger_event(nand_led_trigger, LED_OFF);
431 432
}

L
Linus Torvalds 已提交
433 434 435 436 437 438 439 440 441 442
/**
 * 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)
 */
443 444
static void nand_command(struct mtd_info *mtd, unsigned int command,
			 int column, int page_addr)
L
Linus Torvalds 已提交
445
{
446
	register struct nand_chip *chip = mtd->priv;
447
	int ctrl = NAND_CTRL_CLE | NAND_CTRL_CHANGE;
L
Linus Torvalds 已提交
448 449 450 451 452 453 454

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

J
Joern Engel 已提交
455
		if (column >= mtd->writesize) {
L
Linus Torvalds 已提交
456
			/* OOB area */
J
Joern Engel 已提交
457
			column -= mtd->writesize;
L
Linus Torvalds 已提交
458 459 460 461 462 463 464 465
			readcmd = NAND_CMD_READOOB;
		} else if (column < 256) {
			/* First 256 bytes --> READ0 */
			readcmd = NAND_CMD_READ0;
		} else {
			column -= 256;
			readcmd = NAND_CMD_READ1;
		}
466
		chip->cmd_ctrl(mtd, readcmd, ctrl);
467
		ctrl &= ~NAND_CTRL_CHANGE;
L
Linus Torvalds 已提交
468
	}
469
	chip->cmd_ctrl(mtd, command, ctrl);
L
Linus Torvalds 已提交
470

471 472 473 474 475 476 477
	/*
	 * Address cycle, when necessary
	 */
	ctrl = NAND_CTRL_ALE | NAND_CTRL_CHANGE;
	/* Serially input address */
	if (column != -1) {
		/* Adjust columns for 16 bit buswidth */
478
		if (chip->options & NAND_BUSWIDTH_16)
479
			column >>= 1;
480
		chip->cmd_ctrl(mtd, column, ctrl);
481 482 483
		ctrl &= ~NAND_CTRL_CHANGE;
	}
	if (page_addr != -1) {
484
		chip->cmd_ctrl(mtd, page_addr, ctrl);
485
		ctrl &= ~NAND_CTRL_CHANGE;
486
		chip->cmd_ctrl(mtd, page_addr >> 8, ctrl);
487
		/* One more address cycle for devices > 32MiB */
488 489
		if (chip->chipsize > (32 << 20))
			chip->cmd_ctrl(mtd, page_addr >> 16, ctrl);
L
Linus Torvalds 已提交
490
	}
491
	chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
492 493 494

	/*
	 * program and erase have their own busy handlers
L
Linus Torvalds 已提交
495
	 * status and sequential in needs no delay
496
	 */
L
Linus Torvalds 已提交
497
	switch (command) {
498

L
Linus Torvalds 已提交
499 500 501 502 503
	case NAND_CMD_PAGEPROG:
	case NAND_CMD_ERASE1:
	case NAND_CMD_ERASE2:
	case NAND_CMD_SEQIN:
	case NAND_CMD_STATUS:
504
		chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE);
L
Linus Torvalds 已提交
505 506 507
		return;

	case NAND_CMD_RESET:
508
		if (chip->dev_ready)
L
Linus Torvalds 已提交
509
			break;
510 511
		udelay(chip->chip_delay);
		chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
512
			       NAND_CTRL_CLE | NAND_CTRL_CHANGE);
513 514
		chip->cmd_ctrl(mtd,
			       NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
515
		while (!(chip->read_byte(mtd) & NAND_STATUS_READY)) ;
L
Linus Torvalds 已提交
516 517
		return;

518
		/* This applies to read commands */
L
Linus Torvalds 已提交
519
	default:
520
		/*
L
Linus Torvalds 已提交
521 522
		 * If we don't have access to the busy pin, we apply the given
		 * command delay
523
		 */
524 525
		if (!chip->dev_ready) {
			udelay(chip->chip_delay);
L
Linus Torvalds 已提交
526
			return;
527
		}
L
Linus Torvalds 已提交
528 529 530
	}
	/* Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine. */
531
	ndelay(100);
532 533

	nand_wait_ready(mtd);
L
Linus Torvalds 已提交
534 535 536 537 538 539 540 541 542
}

/**
 * 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
 *
543 544 545
 * 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 已提交
546 547
 *
 */
548 549
static void nand_command_lp(struct mtd_info *mtd, unsigned int command,
			    int column, int page_addr)
L
Linus Torvalds 已提交
550
{
551
	register struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
552 553 554

	/* Emulate NAND_CMD_READOOB */
	if (command == NAND_CMD_READOOB) {
J
Joern Engel 已提交
555
		column += mtd->writesize;
L
Linus Torvalds 已提交
556 557
		command = NAND_CMD_READ0;
	}
558

559
	/* Command latch cycle */
560
	chip->cmd_ctrl(mtd, command & 0xff,
561
		       NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
L
Linus Torvalds 已提交
562 563

	if (column != -1 || page_addr != -1) {
564
		int ctrl = NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE;
L
Linus Torvalds 已提交
565 566 567 568

		/* Serially input address */
		if (column != -1) {
			/* Adjust columns for 16 bit buswidth */
569
			if (chip->options & NAND_BUSWIDTH_16)
L
Linus Torvalds 已提交
570
				column >>= 1;
571
			chip->cmd_ctrl(mtd, column, ctrl);
572
			ctrl &= ~NAND_CTRL_CHANGE;
573
			chip->cmd_ctrl(mtd, column >> 8, ctrl);
574
		}
L
Linus Torvalds 已提交
575
		if (page_addr != -1) {
576 577
			chip->cmd_ctrl(mtd, page_addr, ctrl);
			chip->cmd_ctrl(mtd, page_addr >> 8,
578
				       NAND_NCE | NAND_ALE);
L
Linus Torvalds 已提交
579
			/* One more address cycle for devices > 128MiB */
580 581
			if (chip->chipsize > (128 << 20))
				chip->cmd_ctrl(mtd, page_addr >> 16,
582
					       NAND_NCE | NAND_ALE);
L
Linus Torvalds 已提交
583 584
		}
	}
585
	chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
586 587 588

	/*
	 * program and erase have their own busy handlers
589 590
	 * status, sequential in, and deplete1 need no delay
	 */
L
Linus Torvalds 已提交
591
	switch (command) {
592

L
Linus Torvalds 已提交
593 594 595 596 597 598
	case NAND_CMD_CACHEDPROG:
	case NAND_CMD_PAGEPROG:
	case NAND_CMD_ERASE1:
	case NAND_CMD_ERASE2:
	case NAND_CMD_SEQIN:
	case NAND_CMD_STATUS:
599
	case NAND_CMD_DEPLETE1:
L
Linus Torvalds 已提交
600 601
		return;

602 603 604
		/*
		 * read error status commands require only a short delay
		 */
605 606 607 608 609
	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:
610
		udelay(chip->chip_delay);
611
		return;
L
Linus Torvalds 已提交
612 613

	case NAND_CMD_RESET:
614
		if (chip->dev_ready)
L
Linus Torvalds 已提交
615
			break;
616
		udelay(chip->chip_delay);
617 618 619 620
		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);
621
		while (!(chip->read_byte(mtd) & NAND_STATUS_READY)) ;
L
Linus Torvalds 已提交
622 623 624
		return;

	case NAND_CMD_READ0:
625 626 627 628
		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);
629

630
		/* This applies to read commands */
L
Linus Torvalds 已提交
631
	default:
632
		/*
L
Linus Torvalds 已提交
633 634
		 * If we don't have access to the busy pin, we apply the given
		 * command delay
635
		 */
636 637
		if (!chip->dev_ready) {
			udelay(chip->chip_delay);
L
Linus Torvalds 已提交
638
			return;
639
		}
L
Linus Torvalds 已提交
640
	}
641

L
Linus Torvalds 已提交
642 643
	/* Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine. */
644
	ndelay(100);
645 646

	nand_wait_ready(mtd);
L
Linus Torvalds 已提交
647 648 649 650 651 652
}

/**
 * nand_get_device - [GENERIC] Get chip for selected access
 * @this:	the nand chip descriptor
 * @mtd:	MTD device structure
653
 * @new_state:	the state which is requested
L
Linus Torvalds 已提交
654 655 656
 *
 * Get the device and lock it for exclusive access
 */
657
static int
658
nand_get_device(struct nand_chip *chip, struct mtd_info *mtd, int new_state)
L
Linus Torvalds 已提交
659
{
660 661
	spinlock_t *lock = &chip->controller->lock;
	wait_queue_head_t *wq = &chip->controller->wq;
662 663
	DECLARE_WAITQUEUE(wait, current);
 retry:
664 665
	spin_lock(lock);

L
Linus Torvalds 已提交
666
	/* Hardware controller shared among independend devices */
T
Thomas Gleixner 已提交
667
	/* Hardware controller shared among independend devices */
668 669
	if (!chip->controller->active)
		chip->controller->active = chip;
T
Thomas Gleixner 已提交
670

671 672
	if (chip->controller->active == chip && chip->state == FL_READY) {
		chip->state = new_state;
673
		spin_unlock(lock);
674 675 676 677
		return 0;
	}
	if (new_state == FL_PM_SUSPENDED) {
		spin_unlock(lock);
678
		return (chip->state == FL_PM_SUSPENDED) ? 0 : -EAGAIN;
679 680 681 682 683 684
	}
	set_current_state(TASK_UNINTERRUPTIBLE);
	add_wait_queue(wq, &wait);
	spin_unlock(lock);
	schedule();
	remove_wait_queue(wq, &wait);
L
Linus Torvalds 已提交
685 686 687 688 689 690 691 692 693 694
	goto retry;
}

/**
 * nand_wait - [DEFAULT]  wait until the command is done
 * @mtd:	MTD device structure
 * @this:	NAND chip structure
 * @state:	state to select the max. timeout value
 *
 * Wait for command done. This applies to erase and program only
695
 * Erase can take up to 400ms and program up to 20ms according to
L
Linus Torvalds 已提交
696 697 698
 * general NAND and SmartMedia specs
 *
*/
699
static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip, int state)
L
Linus Torvalds 已提交
700 701
{

702 703
	unsigned long timeo = jiffies;
	int status;
704

L
Linus Torvalds 已提交
705
	if (state == FL_ERASING)
706
		timeo += (HZ * 400) / 1000;
L
Linus Torvalds 已提交
707
	else
708
		timeo += (HZ * 20) / 1000;
L
Linus Torvalds 已提交
709

710 711
	led_trigger_event(nand_led_trigger, LED_FULL);

L
Linus Torvalds 已提交
712 713
	/* Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine. */
714
	ndelay(100);
L
Linus Torvalds 已提交
715

716 717
	if ((state == FL_ERASING) && (chip->options & NAND_IS_AND))
		chip->cmdfunc(mtd, NAND_CMD_STATUS_MULTI, -1, -1);
718
	else
719
		chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
L
Linus Torvalds 已提交
720

721
	while (time_before(jiffies, timeo)) {
L
Linus Torvalds 已提交
722
		/* Check, if we were interrupted */
723
		if (chip->state != state)
L
Linus Torvalds 已提交
724 725
			return 0;

726 727
		if (chip->dev_ready) {
			if (chip->dev_ready(mtd))
728
				break;
L
Linus Torvalds 已提交
729
		} else {
730
			if (chip->read_byte(mtd) & NAND_STATUS_READY)
L
Linus Torvalds 已提交
731 732
				break;
		}
733
		cond_resched();
L
Linus Torvalds 已提交
734
	}
735 736
	led_trigger_event(nand_led_trigger, LED_OFF);

737
	status = (int)chip->read_byte(mtd);
L
Linus Torvalds 已提交
738 739 740
	return status;
}

741 742 743 744 745 746 747 748 749 750 751 752 753 754
/**
 * 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
 */
static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
			      uint8_t *buf)
{
	chip->read_buf(mtd, buf, mtd->writesize);
	chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
	return 0;
}

L
Linus Torvalds 已提交
755
/**
756 757 758 759
 * nand_read_page_swecc - {REPLACABLE] software ecc based page read function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
760
 */
761 762
static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
				uint8_t *buf)
L
Linus Torvalds 已提交
763
{
764 765 766 767
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
768 769
	uint8_t *ecc_calc = chip->buffers.ecccalc;
	uint8_t *ecc_code = chip->buffers.ecccode;
770
	int *eccpos = chip->ecc.layout->eccpos;
771

772
	nand_read_page_raw(mtd, chip, buf);
773 774 775 776 777

	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++)
778
		ecc_code[i] = chip->oob_poi[eccpos[i]];
779 780 781 782 783 784 785 786 787 788 789 790 791 792

	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]);
		if (stat == -1)
			mtd->ecc_stats.failed++;
		else
			mtd->ecc_stats.corrected += stat;
	}
	return 0;
793
}
L
Linus Torvalds 已提交
794

795
/**
796 797 798 799
 * nand_read_page_hwecc - {REPLACABLE] hardware ecc based page read function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
800
 *
801
 * Not for syndrome calculating ecc controllers which need a special oob layout
802
 */
803 804
static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
				uint8_t *buf)
L
Linus Torvalds 已提交
805
{
806 807 808 809
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
810 811
	uint8_t *ecc_calc = chip->buffers.ecccalc;
	uint8_t *ecc_code = chip->buffers.ecccode;
812
	int *eccpos = chip->ecc.layout->eccpos;
813 814 815 816 817

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

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

824 825
	eccsteps = chip->ecc.steps;
	p = buf;
826

827 828
	for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		int stat;
L
Linus Torvalds 已提交
829

830 831 832 833 834 835 836 837
		stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
		if (stat == -1)
			mtd->ecc_stats.failed++;
		else
			mtd->ecc_stats.corrected += stat;
	}
	return 0;
}
L
Linus Torvalds 已提交
838

839 840 841 842 843 844 845
/**
 * nand_read_page_syndrome - {REPLACABLE] hardware ecc syndrom based page read
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	buffer to store read data
 *
 * The hw generator calculates the error syndrome automatically. Therefor
846
 * we need a special oob layout and handling.
847 848 849 850 851 852 853 854
 */
static int nand_read_page_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
				   uint8_t *buf)
{
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
855
	uint8_t *oob = chip->oob_poi;
L
Linus Torvalds 已提交
856

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

860 861
		chip->ecc.hwctl(mtd, NAND_ECC_READ);
		chip->read_buf(mtd, p, eccsize);
L
Linus Torvalds 已提交
862

863 864 865 866
		if (chip->ecc.prepad) {
			chip->read_buf(mtd, oob, chip->ecc.prepad);
			oob += chip->ecc.prepad;
		}
L
Linus Torvalds 已提交
867

868 869 870
		chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
		chip->read_buf(mtd, oob, eccbytes);
		stat = chip->ecc.correct(mtd, p, oob, NULL);
871

872 873
		if (stat == -1)
			mtd->ecc_stats.failed++;
874
		else
875
			mtd->ecc_stats.corrected += stat;
876

877
		oob += eccbytes;
L
Linus Torvalds 已提交
878

879 880 881
		if (chip->ecc.postpad) {
			chip->read_buf(mtd, oob, chip->ecc.postpad);
			oob += chip->ecc.postpad;
882
		}
883
	}
L
Linus Torvalds 已提交
884

885
	/* Calculate remaining oob bytes */
886
	i = oob - chip->oob_poi;
887 888
	if (i)
		chip->read_buf(mtd, oob, i);
889

890 891
	return 0;
}
L
Linus Torvalds 已提交
892

893
/**
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
 * nand_transfer_oob - [Internal] Transfer oob to client buffer
 * @chip:	nand chip structure
 * @ops:	oob ops structure
 */
static uint8_t *nand_transfer_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(oob, chip->oob_poi + ops->ooboffs, len);
		return oob + len;

	case MTD_OOB_AUTO: {
		struct nand_oobfree *free = chip->ecc.layout->oobfree;
		size_t bytes;

		for(; free->length && len; free++, len -= bytes) {
			bytes = min(len, free->length);

			memcpy(oob, chip->oob_poi + free->offset, bytes);
			oob += bytes;
		}
		return oob;
	}
	default:
		BUG();
	}
	return NULL;
}

/**
 * nand_do_read_ops - [Internal] Read data with ECC
930 931 932 933 934 935
 *
 * @mtd:	MTD device structure
 * @from:	offset to read from
 *
 * Internal function. Called with chip held.
 */
936 937
static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
938 939 940 941 942 943 944
{
	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;
945 946
	uint32_t readlen = ops->len;
	uint8_t *bufpoi, *oob, *buf;
L
Linus Torvalds 已提交
947

948
	stats = mtd->ecc_stats;
L
Linus Torvalds 已提交
949

950 951
	chipnr = (int)(from >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);
952

953 954
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
955

956
	col = (int)(from & (mtd->writesize - 1));
957
	chip->oob_poi = chip->buffers.oobrbuf;
958

959 960 961
	buf = ops->datbuf;
	oob = ops->oobbuf;

962 963 964
	while(1) {
		bytes = min(mtd->writesize - col, readlen);
		aligned = (bytes == mtd->writesize);
965

966
		/* Is the current page in the buffer ? */
967
		if (realpage != chip->pagebuf || oob) {
968
			bufpoi = aligned ? buf : chip->buffers.databuf;
969

970 971 972
			if (likely(sndcmd)) {
				chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
				sndcmd = 0;
L
Linus Torvalds 已提交
973 974
			}

975 976 977
			/* Now read the page into the buffer */
			ret = chip->ecc.read_page(mtd, chip, bufpoi);
			if (ret < 0)
L
Linus Torvalds 已提交
978
				break;
979 980 981 982

			/* Transfer not aligned data */
			if (!aligned) {
				chip->pagebuf = realpage;
983
				memcpy(buf, chip->buffers.databuf + col, bytes);
984 985
			}

986 987 988 989 990 991 992 993 994 995
			buf += bytes;

			if (unlikely(oob)) {
				/* Raw mode does data:oob:data:oob */
				if (ops->mode != MTD_OOB_RAW)
					oob = nand_transfer_oob(chip, oob, ops);
				else
					buf = nand_transfer_oob(chip, buf, ops);
			}

996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
			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 已提交
1008
			}
1009
		} else {
1010
			memcpy(buf, chip->buffers.databuf + col, bytes);
1011 1012
			buf += bytes;
		}
L
Linus Torvalds 已提交
1013

1014
		readlen -= bytes;
1015

1016
		if (!readlen)
1017
			break;
L
Linus Torvalds 已提交
1018 1019 1020 1021 1022 1023

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

1024
		page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1025 1026 1027
		/* Check, if we cross a chip boundary */
		if (!page) {
			chipnr++;
1028 1029
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1030
		}
1031

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

1039
	ops->retlen = ops->len - (size_t) readlen;
L
Linus Torvalds 已提交
1040

1041 1042 1043
	if (ret)
		return ret;

1044 1045 1046 1047
	if (mtd->ecc_stats.failed - stats.failed)
		return -EBADMSG;

	return  mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
}

/**
 * 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)
{
1063
	struct nand_chip *chip = mtd->priv;
1064 1065 1066 1067 1068 1069 1070 1071
	int ret;

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

1072
	nand_get_device(chip, mtd, FL_READING);
1073

1074 1075 1076 1077 1078
	chip->ops.len = len;
	chip->ops.datbuf = buf;
	chip->ops.oobbuf = NULL;

	ret = nand_do_read_ops(mtd, from, &chip->ops);
1079 1080 1081

	nand_release_device(mtd);

1082
	*retlen = chip->ops.retlen;
1083
	return ret;
L
Linus Torvalds 已提交
1084 1085 1086
}

/**
1087
 * nand_do_read_oob - [Intern] NAND read out-of-band
L
Linus Torvalds 已提交
1088 1089
 * @mtd:	MTD device structure
 * @from:	offset to read from
1090
 * @ops:	oob operations description structure
L
Linus Torvalds 已提交
1091 1092 1093
 *
 * NAND read out-of-band data from the spare area
 */
1094 1095
static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1096
{
1097
	int col, page, realpage, chipnr, sndcmd = 1;
1098
	struct nand_chip *chip = mtd->priv;
1099
	int blkcheck = (1 << (chip->phys_erase_shift - chip->page_shift)) - 1;
1100 1101
	int direct, bytes, readlen = ops->len;
	uint8_t *bufpoi, *buf = ops->oobbuf;
1102

1103 1104
	DEBUG(MTD_DEBUG_LEVEL3, "nand_read_oob: from = 0x%08x, len = %i\n",
	      (unsigned int)from, (int)len);
L
Linus Torvalds 已提交
1105

1106
	chipnr = (int)(from >> chip->chip_shift);
1107
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1108

1109 1110 1111
	/* Shift to get page */
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1112

1113 1114 1115 1116 1117 1118 1119
	if (ops->mode != MTD_OOB_AUTO) {
		col = ops->ooboffs;
		direct = 1;
	} else {
		col = 0;
		direct = 0;
	}
1120 1121

	while(1) {
1122 1123
		bytes = direct ? ops->ooblen : mtd->oobsize;
		bufpoi = direct ? buf : chip->buffers.oobrbuf;
1124 1125 1126 1127 1128 1129

		if (likely(sndcmd)) {
			chip->cmdfunc(mtd, NAND_CMD_READOOB, col, page);
			sndcmd = 0;
		}

1130
		chip->read_buf(mtd, bufpoi, bytes);
1131

1132 1133 1134 1135 1136 1137
		if (unlikely(!direct))
			buf = nand_transfer_oob(chip, buf, ops);
		else
			buf += ops->ooblen;

		readlen -= ops->ooblen;
1138 1139 1140 1141 1142 1143 1144 1145 1146
		if (!readlen)
			break;

		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.
1147
			 */
1148 1149
			if (!chip->dev_ready)
				udelay(chip->chip_delay);
1150 1151
			else
				nand_wait_ready(mtd);
1152
		}
1153

1154 1155 1156 1157 1158 1159 1160 1161 1162
		/* 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 已提交
1163
		}
1164 1165 1166 1167 1168 1169

		/* 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 已提交
1170 1171
	}

1172
	ops->retlen = ops->len;
L
Linus Torvalds 已提交
1173 1174 1175 1176
	return 0;
}

/**
1177
 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
L
Linus Torvalds 已提交
1178 1179
 * @mtd:	MTD device structure
 * @from:	offset to read from
1180
 * @ops:	oob operation description structure
L
Linus Torvalds 已提交
1181
 *
1182
 * NAND read data and/or out-of-band data
L
Linus Torvalds 已提交
1183
 */
1184 1185
static int nand_read_oob(struct mtd_info *mtd, loff_t from,
			 struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1186
{
1187 1188
	int (*read_page)(struct mtd_info *mtd, struct nand_chip *chip,
			 uint8_t *buf) = NULL;
1189
	struct nand_chip *chip = mtd->priv;
1190 1191 1192
	int ret = -ENOTSUPP;

	ops->retlen = 0;
L
Linus Torvalds 已提交
1193 1194

	/* Do not allow reads past end of device */
1195 1196
	if ((from + ops->len) > mtd->size) {
		DEBUG(MTD_DEBUG_LEVEL0, "nand_read_oob: "
1197
		      "Attempt read beyond end of device\n");
L
Linus Torvalds 已提交
1198 1199 1200
		return -EINVAL;
	}

1201
	nand_get_device(chip, mtd, FL_READING);
L
Linus Torvalds 已提交
1202

1203 1204 1205 1206
	switch(ops->mode) {
	case MTD_OOB_PLACE:
	case MTD_OOB_AUTO:
		break;
1207

1208 1209 1210 1211 1212
	case MTD_OOB_RAW:
		/* Replace the read_page algorithm temporary */
		read_page = chip->ecc.read_page;
		chip->ecc.read_page = nand_read_page_raw;
		break;
L
Linus Torvalds 已提交
1213

1214 1215 1216
	default:
		goto out;
	}
L
Linus Torvalds 已提交
1217

1218 1219 1220 1221
	if (!ops->datbuf)
		ret = nand_do_read_oob(mtd, from, ops);
	else
		ret = nand_do_read_ops(mtd, from, ops);
1222

1223 1224 1225 1226 1227 1228
	if (unlikely(ops->mode == MTD_OOB_RAW))
		chip->ecc.read_page = read_page;
 out:
	nand_release_device(mtd);
	return ret;
}
1229

L
Linus Torvalds 已提交
1230

1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
/**
 * nand_write_page_raw - [Intern] raw page write function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
 */
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 已提交
1242 1243
}

1244
/**
1245 1246 1247 1248
 * nand_write_page_swecc - {REPLACABLE] software ecc based page write function
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
1249
 */
1250 1251
static void nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
				  const uint8_t *buf)
1252
{
1253 1254 1255 1256 1257
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *ecc_calc = chip->buffers.ecccalc;
	const uint8_t *p = buf;
1258
	int *eccpos = chip->ecc.layout->eccpos;
1259

1260 1261 1262
	/* Software ecc calculation */
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize)
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1263

1264 1265
	for (i = 0; i < chip->ecc.total; i++)
		chip->oob_poi[eccpos[i]] = ecc_calc[i];
1266

1267
	nand_write_page_raw(mtd, chip, buf);
1268
}
1269

1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
/**
 * nand_write_page_hwecc - {REPLACABLE] hardware ecc based page write function
 * @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;
	uint8_t *ecc_calc = chip->buffers.ecccalc;
	const uint8_t *p = buf;
1284
	int *eccpos = chip->ecc.layout->eccpos;
1285

1286 1287
	for (i = 0; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
1288
		chip->write_buf(mtd, p, eccsize);
1289
		chip->ecc.calculate(mtd, p, &ecc_calc[i]);
1290 1291
	}

1292 1293 1294 1295
	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);
1296 1297
}

1298
/**
1299 1300 1301 1302
 * nand_write_page_syndrome - {REPLACABLE] hardware ecc syndrom based page write
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @buf:	data buffer
L
Linus Torvalds 已提交
1303
 *
1304 1305 1306 1307 1308
 * 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 已提交
1309
{
1310 1311 1312 1313 1314
	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 已提交
1315

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

1318 1319
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
		chip->write_buf(mtd, p, eccsize);
1320

1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
		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 已提交
1333 1334
		}
	}
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391

	/* Calculate remaining oob bytes */
	i = oob - chip->oob_poi;
	if (i)
		chip->write_buf(mtd, oob, i);
}

/**
 * nand_write_page - [INTERNAL] write one page
 * @mtd:	MTD device structure
 * @chip:	NAND chip descriptor
 * @buf:	the data to write
 * @page:	page number to write
 * @cached:	cached programming
 */
static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
			   const uint8_t *buf, int page, int cached)
{
	int status;

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

	chip->ecc.write_page(mtd, chip, buf);

	/*
	 * 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);
		status = chip->waitfunc(mtd, chip, FL_WRITING);
		/*
		 * 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);
		status = chip->waitfunc(mtd, chip, FL_WRITING);
	}

#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 已提交
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
/**
 * 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;
		size_t bytes;

		for(; free->length && len; free++, len -= bytes) {
			bytes = min(len, free->length);
			memcpy(chip->oob_poi + free->offset, oob, bytes);
			oob += bytes;
		}
		return oob;
	}
	default:
		BUG();
	}
	return NULL;
}

J
Joern Engel 已提交
1429
#define NOTALIGNED(x) (x & (mtd->writesize-1)) != 0
L
Linus Torvalds 已提交
1430 1431

/**
1432
 * nand_do_write_ops - [Internal] NAND write with ECC
L
Linus Torvalds 已提交
1433 1434
 * @mtd:	MTD device structure
 * @to:		offset to write to
1435
 * @ops:	oob operations description structure
L
Linus Torvalds 已提交
1436 1437 1438
 *
 * NAND write with ECC
 */
1439 1440
static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1441
{
1442
	int chipnr, realpage, page, blockmask;
1443
	struct nand_chip *chip = mtd->priv;
1444 1445 1446
	uint32_t writelen = ops->len;
	uint8_t *oob = ops->oobbuf;
	uint8_t *buf = ops->datbuf;
1447
	int bytes = mtd->writesize;
1448
	int ret;
L
Linus Torvalds 已提交
1449

1450
	ops->retlen = 0;
L
Linus Torvalds 已提交
1451

1452
	/* reject writes, which are not page aligned */
1453
	if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
1454 1455
		printk(KERN_NOTICE "nand_write: "
		       "Attempt to write not page aligned data\n");
L
Linus Torvalds 已提交
1456 1457 1458
		return -EINVAL;
	}

1459
	if (!writelen)
1460
		return 0;
L
Linus Torvalds 已提交
1461 1462 1463

	/* Check, if it is write protected */
	if (nand_check_wp(mtd))
1464
		return -EIO;
L
Linus Torvalds 已提交
1465

1466 1467
	chipnr = (int)(to >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1468

1469 1470 1471 1472 1473 1474
	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) &&
1475
	    (chip->pagebuf << chip->page_shift) < (to + ops->len))
1476
		chip->pagebuf = -1;
1477

1478
	chip->oob_poi = chip->buffers.oobwbuf;
1479

1480 1481
	while(1) {
		int cached = writelen > bytes && page != blockmask;
L
Linus Torvalds 已提交
1482

1483 1484 1485
		if (unlikely(oob))
			oob = nand_fill_oob(chip, oob, ops);

1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502
		ret = nand_write_page(mtd, chip, buf, page, cached);
		if (ret)
			break;

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

		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 已提交
1503 1504
		}
	}
1505 1506 1507 1508 1509

	if (unlikely(oob))
		memset(chip->oob_poi, 0xff, mtd->oobsize);

	ops->retlen = ops->len - writelen;
L
Linus Torvalds 已提交
1510 1511 1512
	return ret;
}

1513
/**
1514
 * nand_write - [MTD Interface] NAND write with ECC
1515 1516 1517
 * @mtd:	MTD device structure
 * @to:		offset to write to
 * @len:	number of bytes to write
1518 1519
 * @retlen:	pointer to variable to store the number of written bytes
 * @buf:	the data to write
1520
 *
1521
 * NAND write with ECC
1522
 */
1523 1524
static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
			  size_t *retlen, const uint8_t *buf)
1525 1526 1527 1528
{
	struct nand_chip *chip = mtd->priv;
	int ret;

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

1535
	nand_get_device(chip, mtd, FL_READING);
1536

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

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

	nand_release_device(mtd);
1544 1545 1546

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

L
Linus Torvalds 已提交
1549
/**
1550
 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
L
Linus Torvalds 已提交
1551 1552
 * @mtd:	MTD device structure
 * @to:		offset to write to
1553
 * @ops:	oob operation description structure
L
Linus Torvalds 已提交
1554 1555 1556
 *
 * NAND write out-of-band
 */
1557 1558
static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1559
{
1560
	int chipnr, page, status;
1561
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
1562

1563
	DEBUG(MTD_DEBUG_LEVEL3, "nand_write_oob: to = 0x%08x, len = %i\n",
1564
	      (unsigned int)to, (int)ops->len);
L
Linus Torvalds 已提交
1565 1566

	/* Do not allow write past end of page */
1567
	if ((ops->ooboffs + ops->len) > mtd->oobsize) {
1568 1569
		DEBUG(MTD_DEBUG_LEVEL0, "nand_write_oob: "
		      "Attempt to write past end of page\n");
L
Linus Torvalds 已提交
1570 1571 1572
		return -EINVAL;
	}

1573
	chipnr = (int)(to >> chip->chip_shift);
1574
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1575

1576 1577 1578 1579 1580 1581 1582 1583 1584
	/* 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.
	 */
1585
	chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
L
Linus Torvalds 已提交
1586 1587 1588

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

L
Linus Torvalds 已提交
1591
	/* Invalidate the page cache, if we write to the cached page */
1592 1593
	if (page == chip->pagebuf)
		chip->pagebuf = -1;
L
Linus Torvalds 已提交
1594

1595 1596 1597 1598
	if (ops->mode == MTD_OOB_AUTO || NAND_MUST_PAD(chip)) {
		chip->oob_poi = chip->buffers.oobwbuf;
		memset(chip->oob_poi, 0xff, mtd->oobsize);
		nand_fill_oob(chip, ops->oobbuf, ops);
1599 1600
		chip->cmdfunc(mtd, NAND_CMD_SEQIN, mtd->writesize,
			      page & chip->pagemask);
1601 1602
		chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
		memset(chip->oob_poi, 0xff, mtd->oobsize);
L
Linus Torvalds 已提交
1603
	} else {
1604 1605
		chip->cmdfunc(mtd, NAND_CMD_SEQIN,
			      mtd->writesize + ops->ooboffs,
1606
			      page & chip->pagemask);
1607
		chip->write_buf(mtd, ops->oobbuf, ops->len);
L
Linus Torvalds 已提交
1608
	}
1609

L
Linus Torvalds 已提交
1610
	/* Send command to program the OOB data */
1611
	chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
L
Linus Torvalds 已提交
1612

1613
	status = chip->waitfunc(mtd, chip, FL_WRITING);
L
Linus Torvalds 已提交
1614 1615

	/* See if device thinks it succeeded */
1616
	if (status & NAND_STATUS_FAIL) {
1617 1618
		DEBUG(MTD_DEBUG_LEVEL0, "nand_write_oob: "
		      "Failed write, page 0x%08x\n", page);
1619
		return -EIO;
L
Linus Torvalds 已提交
1620
	}
1621
	ops->retlen = ops->len;
L
Linus Torvalds 已提交
1622 1623

#ifdef CONFIG_MTD_NAND_VERIFY_WRITE
1624 1625 1626 1627
	if (ops->mode != MTD_OOB_AUTO) {
		/* Send command to read back the data */
		chip->cmdfunc(mtd, NAND_CMD_READOOB, ops->ooboffs,
			      page & chip->pagemask);
L
Linus Torvalds 已提交
1628

1629 1630 1631 1632 1633
		if (chip->verify_buf(mtd, ops->oobbuf, ops->len)) {
			DEBUG(MTD_DEBUG_LEVEL0, "nand_write_oob: "
			      "Failed write verify, page 0x%08x\n", page);
			return -EIO;
		}
L
Linus Torvalds 已提交
1634 1635
	}
#endif
1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685
		return 0;
}

/**
 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
 * @mtd:	MTD device structure
 * @from:	offset to read from
 * @ops:	oob operation description structure
 */
static int nand_write_oob(struct mtd_info *mtd, loff_t to,
			  struct mtd_oob_ops *ops)
{
	void (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
			  const uint8_t *buf) = NULL;
	struct nand_chip *chip = mtd->priv;
	int ret = -ENOTSUPP;

	ops->retlen = 0;

	/* Do not allow writes past end of device */
	if ((to + ops->len) > mtd->size) {
		DEBUG(MTD_DEBUG_LEVEL0, "nand_read_oob: "
		      "Attempt read beyond end of device\n");
		return -EINVAL;
	}

	nand_get_device(chip, mtd, FL_READING);

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

	case MTD_OOB_RAW:
		/* Replace the write_page algorithm temporary */
		write_page = chip->ecc.write_page;
		chip->ecc.write_page = nand_write_page_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);

	if (unlikely(ops->mode == MTD_OOB_RAW))
		chip->ecc.write_page = write_page;
1686
 out:
L
Linus Torvalds 已提交
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697
	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
 */
1698
static void single_erase_cmd(struct mtd_info *mtd, int page)
L
Linus Torvalds 已提交
1699
{
1700
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
1701
	/* Send commands to erase a block */
1702 1703
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
	chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
L
Linus Torvalds 已提交
1704 1705 1706 1707 1708 1709 1710 1711 1712 1713
}

/**
 * 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
 */
1714
static void multi_erase_cmd(struct mtd_info *mtd, int page)
L
Linus Torvalds 已提交
1715
{
1716
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
1717
	/* Send commands to erase a block */
1718 1719 1720 1721 1722
	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 已提交
1723 1724 1725 1726 1727 1728 1729 1730 1731
}

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

1737
#define BBT_PAGE_MASK	0xffffff3f
L
Linus Torvalds 已提交
1738
/**
1739
 * nand_erase_nand - [Internal] erase block(s)
L
Linus Torvalds 已提交
1740 1741 1742 1743 1744 1745
 * @mtd:	MTD device structure
 * @instr:	erase instruction
 * @allowbbt:	allow erasing the bbt area
 *
 * Erase one ore more blocks
 */
1746 1747
int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
		    int allowbbt)
L
Linus Torvalds 已提交
1748 1749
{
	int page, len, status, pages_per_block, ret, chipnr;
1750 1751 1752
	struct nand_chip *chip = mtd->priv;
	int rewrite_bbt[NAND_MAX_CHIPS]={0};
	unsigned int bbt_masked_page = 0xffffffff;
L
Linus Torvalds 已提交
1753

1754 1755
	DEBUG(MTD_DEBUG_LEVEL3, "nand_erase: start = 0x%08x, len = %i\n",
	      (unsigned int)instr->addr, (unsigned int)instr->len);
L
Linus Torvalds 已提交
1756 1757

	/* Start address must align on block boundary */
1758
	if (instr->addr & ((1 << chip->phys_erase_shift) - 1)) {
1759
		DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: Unaligned address\n");
L
Linus Torvalds 已提交
1760 1761 1762 1763
		return -EINVAL;
	}

	/* Length must align on block boundary */
1764 1765 1766
	if (instr->len & ((1 << chip->phys_erase_shift) - 1)) {
		DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: "
		      "Length not block aligned\n");
L
Linus Torvalds 已提交
1767 1768 1769 1770 1771
		return -EINVAL;
	}

	/* Do not allow erase past end of device */
	if ((instr->len + instr->addr) > mtd->size) {
1772 1773
		DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: "
		      "Erase past end of device\n");
L
Linus Torvalds 已提交
1774 1775 1776 1777 1778 1779
		return -EINVAL;
	}

	instr->fail_addr = 0xffffffff;

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

	/* Shift to get first page */
1783 1784
	page = (int)(instr->addr >> chip->page_shift);
	chipnr = (int)(instr->addr >> chip->chip_shift);
L
Linus Torvalds 已提交
1785 1786

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

	/* Select the NAND device */
1790
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1791 1792 1793

	/* Check, if it is write protected */
	if (nand_check_wp(mtd)) {
1794 1795
		DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: "
		      "Device is write protected!!!\n");
L
Linus Torvalds 已提交
1796 1797 1798 1799
		instr->state = MTD_ERASE_FAILED;
		goto erase_exit;
	}

1800 1801 1802 1803 1804 1805 1806 1807
	/*
	 * 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;
1808

L
Linus Torvalds 已提交
1809 1810 1811 1812 1813 1814
	/* Loop through the pages */
	len = instr->len;

	instr->state = MTD_ERASING;

	while (len) {
1815 1816 1817 1818 1819 1820 1821
		/*
		 * 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)) {
			printk(KERN_WARNING "nand_erase: attempt to erase a "
			       "bad block at page 0x%08x\n", page);
L
Linus Torvalds 已提交
1822 1823 1824
			instr->state = MTD_ERASE_FAILED;
			goto erase_exit;
		}
1825

1826 1827 1828 1829 1830 1831 1832
		/*
		 * 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 已提交
1833

1834
		chip->erase_cmd(mtd, page & chip->pagemask);
1835

1836
		status = chip->waitfunc(mtd, chip, FL_ERASING);
L
Linus Torvalds 已提交
1837

1838 1839 1840 1841 1842 1843 1844
		/*
		 * 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);
1845

L
Linus Torvalds 已提交
1846
		/* See if block erase succeeded */
1847
		if (status & NAND_STATUS_FAIL) {
1848 1849
			DEBUG(MTD_DEBUG_LEVEL0, "nand_erase: "
			      "Failed erase, page 0x%08x\n", page);
L
Linus Torvalds 已提交
1850
			instr->state = MTD_ERASE_FAILED;
1851
			instr->fail_addr = (page << chip->page_shift);
L
Linus Torvalds 已提交
1852 1853
			goto erase_exit;
		}
1854

1855 1856 1857 1858 1859 1860 1861
		/*
		 * 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)
			    rewrite_bbt[chipnr] = (page << chip->page_shift);
1862

L
Linus Torvalds 已提交
1863
		/* Increment page address and decrement length */
1864
		len -= (1 << chip->phys_erase_shift);
L
Linus Torvalds 已提交
1865 1866 1867
		page += pages_per_block;

		/* Check, if we cross a chip boundary */
1868
		if (len && !(page & chip->pagemask)) {
L
Linus Torvalds 已提交
1869
			chipnr++;
1870 1871
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
1872

1873 1874 1875 1876 1877 1878 1879 1880
			/*
			 * 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 已提交
1881 1882 1883 1884
		}
	}
	instr->state = MTD_ERASE_DONE;

1885
 erase_exit:
L
Linus Torvalds 已提交
1886 1887 1888 1889 1890 1891 1892 1893 1894

	ret = instr->state == MTD_ERASE_DONE ? 0 : -EIO;
	/* Do call back function */
	if (!ret)
		mtd_erase_callback(instr);

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

1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909
	/*
	 * 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 */
		DEBUG(MTD_DEBUG_LEVEL0, "nand_erase_nand: nand_update_bbt "
		      "(%d:0x%0x 0x%0x)\n", chipnr, rewrite_bbt[chipnr],
		      chip->bbt_td->pages[chipnr]);
		nand_update_bbt(mtd, rewrite_bbt[chipnr]);
1910 1911
	}

L
Linus Torvalds 已提交
1912 1913 1914 1915 1916 1917 1918 1919 1920 1921
	/* 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
 */
1922
static void nand_sync(struct mtd_info *mtd)
L
Linus Torvalds 已提交
1923
{
1924
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
1925

1926
	DEBUG(MTD_DEBUG_LEVEL3, "nand_sync: called\n");
L
Linus Torvalds 已提交
1927 1928

	/* Grab the lock and see if the device is available */
1929
	nand_get_device(chip, mtd, FL_SYNCING);
L
Linus Torvalds 已提交
1930
	/* Release it and go back */
1931
	nand_release_device(mtd);
L
Linus Torvalds 已提交
1932 1933 1934
}

/**
1935
 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
L
Linus Torvalds 已提交
1936 1937 1938
 * @mtd:	MTD device structure
 * @ofs:	offset relative to mtd start
 */
1939
static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
L
Linus Torvalds 已提交
1940 1941
{
	/* Check for invalid offset */
1942
	if (offs > mtd->size)
L
Linus Torvalds 已提交
1943
		return -EINVAL;
1944

1945
	return nand_block_checkbad(mtd, offs, 1, 0);
L
Linus Torvalds 已提交
1946 1947 1948
}

/**
1949
 * nand_block_markbad - [MTD Interface] Mark block at the given offset as bad
L
Linus Torvalds 已提交
1950 1951 1952
 * @mtd:	MTD device structure
 * @ofs:	offset relative to mtd start
 */
1953
static int nand_block_markbad(struct mtd_info *mtd, loff_t ofs)
L
Linus Torvalds 已提交
1954
{
1955
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
1956 1957
	int ret;

1958 1959
	if ((ret = nand_block_isbad(mtd, ofs))) {
		/* If it was bad already, return success and do nothing. */
L
Linus Torvalds 已提交
1960 1961
		if (ret > 0)
			return 0;
1962 1963
		return ret;
	}
L
Linus Torvalds 已提交
1964

1965
	return chip->block_markbad(mtd, ofs);
L
Linus Torvalds 已提交
1966 1967
}

1968 1969 1970 1971 1972 1973
/**
 * nand_suspend - [MTD Interface] Suspend the NAND flash
 * @mtd:	MTD device structure
 */
static int nand_suspend(struct mtd_info *mtd)
{
1974
	struct nand_chip *chip = mtd->priv;
1975

1976
	return nand_get_device(chip, mtd, FL_PM_SUSPENDED);
1977 1978 1979 1980 1981 1982 1983 1984
}

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

1987
	if (chip->state == FL_PM_SUSPENDED)
1988 1989
		nand_release_device(mtd);
	else
1990 1991
		printk(KERN_ERR "nand_resume() called for a chip which is not "
		       "in suspended state\n");
1992 1993
}

T
Thomas Gleixner 已提交
1994 1995 1996
/*
 * Set default functions
 */
1997
static void nand_set_defaults(struct nand_chip *chip, int busw)
T
Thomas Gleixner 已提交
1998
{
L
Linus Torvalds 已提交
1999
	/* check for proper chip_delay setup, set 20us if not */
2000 2001
	if (!chip->chip_delay)
		chip->chip_delay = 20;
L
Linus Torvalds 已提交
2002 2003

	/* check, if a user supplied command function given */
2004 2005
	if (chip->cmdfunc == NULL)
		chip->cmdfunc = nand_command;
L
Linus Torvalds 已提交
2006 2007

	/* check, if a user supplied wait function given */
2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028
	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;
2029 2030 2031 2032 2033 2034 2035

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

T
Thomas Gleixner 已提交
2036 2037 2038
}

/*
2039
 * Get the flash and manufacturer id and lookup if the type is supported
T
Thomas Gleixner 已提交
2040 2041
 */
static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
2042
						  struct nand_chip *chip,
T
Thomas Gleixner 已提交
2043 2044 2045 2046
						  int busw, int *maf_id)
{
	struct nand_flash_dev *type = NULL;
	int i, dev_id, maf_idx;
L
Linus Torvalds 已提交
2047 2048

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

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

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

T
Thomas Gleixner 已提交
2058
	/* Lookup the flash id */
L
Linus Torvalds 已提交
2059
	for (i = 0; nand_flash_ids[i].name != NULL; i++) {
T
Thomas Gleixner 已提交
2060 2061 2062 2063 2064
		if (dev_id == nand_flash_ids[i].id) {
			type =  &nand_flash_ids[i];
			break;
		}
	}
2065

T
Thomas Gleixner 已提交
2066 2067 2068
	if (!type)
		return ERR_PTR(-ENODEV);

2069 2070 2071 2072
	if (!mtd->name)
		mtd->name = type->name;

	chip->chipsize = type->chipsize << 20;
T
Thomas Gleixner 已提交
2073 2074

	/* Newer devices have all the information in additional id bytes */
2075
	if (!type->pagesize) {
T
Thomas Gleixner 已提交
2076 2077
		int extid;
		/* The 3rd id byte contains non relevant data ATM */
2078
		extid = chip->read_byte(mtd);
T
Thomas Gleixner 已提交
2079
		/* The 4th id byte is the important one */
2080
		extid = chip->read_byte(mtd);
T
Thomas Gleixner 已提交
2081
		/* Calc pagesize */
2082
		mtd->writesize = 1024 << (extid & 0x3);
T
Thomas Gleixner 已提交
2083 2084
		extid >>= 2;
		/* Calc oobsize */
2085
		mtd->oobsize = (8 << (extid & 0x01)) * (mtd->writesize >> 9);
T
Thomas Gleixner 已提交
2086 2087 2088 2089 2090 2091
		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;
2092

T
Thomas Gleixner 已提交
2093 2094
	} else {
		/*
2095
		 * Old devices have chip data hardcoded in the device id table
T
Thomas Gleixner 已提交
2096
		 */
2097 2098
		mtd->erasesize = type->erasesize;
		mtd->writesize = type->pagesize;
2099
		mtd->oobsize = mtd->writesize / 32;
2100
		busw = type->options & NAND_BUSWIDTH_16;
T
Thomas Gleixner 已提交
2101
	}
L
Linus Torvalds 已提交
2102

T
Thomas Gleixner 已提交
2103 2104 2105 2106 2107
	/* Try to identify manufacturer */
	for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_id++) {
		if (nand_manuf_ids[maf_idx].id == *maf_id)
			break;
	}
2108

T
Thomas Gleixner 已提交
2109 2110
	/*
	 * Check, if buswidth is correct. Hardware drivers should set
2111
	 * chip correct !
T
Thomas Gleixner 已提交
2112
	 */
2113
	if (busw != (chip->options & NAND_BUSWIDTH_16)) {
T
Thomas Gleixner 已提交
2114 2115 2116 2117
		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",
2118
		       (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
T
Thomas Gleixner 已提交
2119 2120 2121
		       busw ? 16 : 8);
		return ERR_PTR(-EINVAL);
	}
2122

T
Thomas Gleixner 已提交
2123
	/* Calculate the address shift from the page size */
2124
	chip->page_shift = ffs(mtd->writesize) - 1;
T
Thomas Gleixner 已提交
2125
	/* Convert chipsize to number of pages per chip -1. */
2126
	chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
2127

2128
	chip->bbt_erase_shift = chip->phys_erase_shift =
T
Thomas Gleixner 已提交
2129
		ffs(mtd->erasesize) - 1;
2130
	chip->chip_shift = ffs(chip->chipsize) - 1;
L
Linus Torvalds 已提交
2131

T
Thomas Gleixner 已提交
2132
	/* Set the bad block position */
2133
	chip->badblockpos = mtd->writesize > 512 ?
T
Thomas Gleixner 已提交
2134
		NAND_LARGE_BADBLOCK_POS : NAND_SMALL_BADBLOCK_POS;
2135

T
Thomas Gleixner 已提交
2136
	/* Get chip options, preserve non chip based options */
2137
	chip->options &= ~NAND_CHIPOPTIONS_MSK;
2138
	chip->options |= type->options & NAND_CHIPOPTIONS_MSK;
T
Thomas Gleixner 已提交
2139 2140

	/*
2141
	 * Set chip as a default. Board drivers can override it, if necessary
T
Thomas Gleixner 已提交
2142
	 */
2143
	chip->options |= NAND_NO_AUTOINCR;
T
Thomas Gleixner 已提交
2144

2145
	/* Check if chip is a not a samsung device. Do not clear the
T
Thomas Gleixner 已提交
2146 2147
	 * options for chips which are not having an extended id.
	 */
2148
	if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
2149
		chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
T
Thomas Gleixner 已提交
2150 2151

	/* Check for AND chips with 4 page planes */
2152 2153
	if (chip->options & NAND_4PAGE_ARRAY)
		chip->erase_cmd = multi_erase_cmd;
T
Thomas Gleixner 已提交
2154
	else
2155
		chip->erase_cmd = single_erase_cmd;
T
Thomas Gleixner 已提交
2156 2157

	/* Do not replace user supplied command function ! */
2158 2159
	if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
		chip->cmdfunc = nand_command_lp;
T
Thomas Gleixner 已提交
2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185

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

/* module_text_address() isn't exported, and it's mostly a pointless
   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() \
	module_text_address((unsigned long)__builtin_return_address(0))
#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
2186
 * filled with the appropriate values.
T
Thomas Gleixner 已提交
2187 2188 2189 2190 2191 2192
 * The mtd->owner field must be set to the module of the caller
 *
 */
int nand_scan(struct mtd_info *mtd, int maxchips)
{
	int i, busw, nand_maf_id;
2193
	struct nand_chip *chip = mtd->priv;
T
Thomas Gleixner 已提交
2194 2195 2196 2197 2198 2199
	struct nand_flash_dev *type;

	/* Many callers got this wrong, so check for it for a while... */
	if (!mtd->owner && caller_is_module()) {
		printk(KERN_CRIT "nand_scan() called with NULL mtd->owner!\n");
		BUG();
L
Linus Torvalds 已提交
2200 2201
	}

T
Thomas Gleixner 已提交
2202
	/* Get buswidth to select the correct functions */
2203
	busw = chip->options & NAND_BUSWIDTH_16;
T
Thomas Gleixner 已提交
2204
	/* Set the default functions */
2205
	nand_set_defaults(chip, busw);
T
Thomas Gleixner 已提交
2206 2207

	/* Read the flash type */
2208
	type = nand_get_flash_type(mtd, chip, busw, &nand_maf_id);
T
Thomas Gleixner 已提交
2209 2210

	if (IS_ERR(type)) {
2211
		printk(KERN_WARNING "No NAND device found!!!\n");
2212
		chip->select_chip(mtd, -1);
T
Thomas Gleixner 已提交
2213
		return PTR_ERR(type);
L
Linus Torvalds 已提交
2214 2215
	}

T
Thomas Gleixner 已提交
2216
	/* Check for a chip array */
2217
	for (i = 1; i < maxchips; i++) {
2218
		chip->select_chip(mtd, i);
L
Linus Torvalds 已提交
2219
		/* Send the command for reading device ID */
2220
		chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
L
Linus Torvalds 已提交
2221
		/* Read manufacturer and device IDs */
2222 2223
		if (nand_maf_id != chip->read_byte(mtd) ||
		    type->id != chip->read_byte(mtd))
L
Linus Torvalds 已提交
2224 2225 2226 2227
			break;
	}
	if (i > 1)
		printk(KERN_INFO "%d NAND chips detected\n", i);
2228

L
Linus Torvalds 已提交
2229
	/* Store the number of chips and calc total size for mtd */
2230 2231
	chip->numchips = i;
	mtd->size = i * chip->chipsize;
T
Thomas Gleixner 已提交
2232

2233 2234
	/* Preset the internal oob write buffer */
	memset(chip->buffers.oobwbuf, 0xff, mtd->oobsize);
L
Linus Torvalds 已提交
2235

T
Thomas Gleixner 已提交
2236 2237 2238
	/*
	 * If no default placement scheme is given, select an appropriate one
	 */
2239
	if (!chip->ecc.layout) {
2240
		switch (mtd->oobsize) {
L
Linus Torvalds 已提交
2241
		case 8:
2242
			chip->ecc.layout = &nand_oob_8;
L
Linus Torvalds 已提交
2243 2244
			break;
		case 16:
2245
			chip->ecc.layout = &nand_oob_16;
L
Linus Torvalds 已提交
2246 2247
			break;
		case 64:
2248
			chip->ecc.layout = &nand_oob_64;
L
Linus Torvalds 已提交
2249 2250
			break;
		default:
T
Thomas Gleixner 已提交
2251 2252
			printk(KERN_WARNING "No oob scheme defined for "
			       "oobsize %d\n", mtd->oobsize);
L
Linus Torvalds 已提交
2253 2254 2255
			BUG();
		}
	}
2256 2257

	/*
T
Thomas Gleixner 已提交
2258 2259
	 * check ECC mode, default to software if 3byte/512byte hardware ECC is
	 * selected and we have 256 byte pagesize fallback to software ECC
2260
	 */
2261
	switch (chip->ecc.mode) {
T
Thomas Gleixner 已提交
2262
	case NAND_ECC_HW:
2263 2264 2265
		/* Use standard hwecc read page function ? */
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_hwecc;
2266 2267
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_hwecc;
2268

T
Thomas Gleixner 已提交
2269
	case NAND_ECC_HW_SYNDROME:
2270 2271
		if (!chip->ecc.calculate || !chip->ecc.correct ||
		    !chip->ecc.hwctl) {
T
Thomas Gleixner 已提交
2272 2273 2274 2275
			printk(KERN_WARNING "No ECC functions supplied, "
			       "Hardware ECC not possible\n");
			BUG();
		}
2276
		/* Use standard syndrome read/write page function ? */
2277 2278
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_syndrome;
2279 2280
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_syndrome;
2281

2282
		if (mtd->writesize >= chip->ecc.size)
T
Thomas Gleixner 已提交
2283 2284 2285
			break;
		printk(KERN_WARNING "%d byte HW ECC not possible on "
		       "%d byte page size, fallback to SW ECC\n",
2286 2287
		       chip->ecc.size, mtd->writesize);
		chip->ecc.mode = NAND_ECC_SOFT;
2288

T
Thomas Gleixner 已提交
2289
	case NAND_ECC_SOFT:
2290 2291
		chip->ecc.calculate = nand_calculate_ecc;
		chip->ecc.correct = nand_correct_data;
2292
		chip->ecc.read_page = nand_read_page_swecc;
2293
		chip->ecc.write_page = nand_write_page_swecc;
2294 2295
		chip->ecc.size = 256;
		chip->ecc.bytes = 3;
L
Linus Torvalds 已提交
2296
		break;
2297 2298

	case NAND_ECC_NONE:
T
Thomas Gleixner 已提交
2299 2300
		printk(KERN_WARNING "NAND_ECC_NONE selected by board driver. "
		       "This is not recommended !!\n");
2301 2302
		chip->ecc.read_page = nand_read_page_raw;
		chip->ecc.write_page = nand_write_page_raw;
2303 2304
		chip->ecc.size = mtd->writesize;
		chip->ecc.bytes = 0;
L
Linus Torvalds 已提交
2305 2306
		break;
	default:
T
Thomas Gleixner 已提交
2307
		printk(KERN_WARNING "Invalid NAND_ECC_MODE %d\n",
2308
		       chip->ecc.mode);
2309
		BUG();
L
Linus Torvalds 已提交
2310
	}
2311

2312 2313 2314 2315 2316 2317 2318 2319 2320
	/*
	 * The number of bytes available for a client to place data into
	 * the out of band area
	 */
	chip->ecc.layout->oobavail = 0;
	for (i = 0; chip->ecc.layout->oobfree[i].length; i++)
		chip->ecc.layout->oobavail +=
			chip->ecc.layout->oobfree[i].length;

T
Thomas Gleixner 已提交
2321 2322 2323 2324
	/*
	 * Set the number of read / write steps for one page depending on ECC
	 * mode
	 */
2325 2326
	chip->ecc.steps = mtd->writesize / chip->ecc.size;
	if(chip->ecc.steps * chip->ecc.size != mtd->writesize) {
T
Thomas Gleixner 已提交
2327 2328
		printk(KERN_WARNING "Invalid ecc parameters\n");
		BUG();
L
Linus Torvalds 已提交
2329
	}
2330
	chip->ecc.total = chip->ecc.steps * chip->ecc.bytes;
2331

2332
	/* Initialize state */
2333
	chip->state = FL_READY;
L
Linus Torvalds 已提交
2334 2335

	/* De-select the device */
2336
	chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
2337 2338

	/* Invalidate the pagebuffer reference */
2339
	chip->pagebuf = -1;
L
Linus Torvalds 已提交
2340 2341 2342

	/* Fill in remaining MTD driver data */
	mtd->type = MTD_NANDFLASH;
J
Joern Engel 已提交
2343
	mtd->flags = MTD_CAP_NANDFLASH;
L
Linus Torvalds 已提交
2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354
	mtd->ecctype = MTD_ECC_SW;
	mtd->erase = nand_erase;
	mtd->point = NULL;
	mtd->unpoint = NULL;
	mtd->read = nand_read;
	mtd->write = nand_write;
	mtd->read_oob = nand_read_oob;
	mtd->write_oob = nand_write_oob;
	mtd->sync = nand_sync;
	mtd->lock = NULL;
	mtd->unlock = NULL;
2355 2356
	mtd->suspend = nand_suspend;
	mtd->resume = nand_resume;
L
Linus Torvalds 已提交
2357 2358 2359
	mtd->block_isbad = nand_block_isbad;
	mtd->block_markbad = nand_block_markbad;

2360 2361
	/* propagate ecc.layout to mtd_info */
	mtd->ecclayout = chip->ecc.layout;
L
Linus Torvalds 已提交
2362

2363
	/* Check, if we should skip the bad block table scan */
2364
	if (chip->options & NAND_SKIP_BBTSCAN)
2365
		return 0;
L
Linus Torvalds 已提交
2366 2367

	/* Build bad block table */
2368
	return chip->scan_bbt(mtd);
L
Linus Torvalds 已提交
2369 2370 2371
}

/**
2372
 * nand_release - [NAND Interface] Free resources held by the NAND device
L
Linus Torvalds 已提交
2373 2374
 * @mtd:	MTD device structure
*/
2375
void nand_release(struct mtd_info *mtd)
L
Linus Torvalds 已提交
2376
{
2377
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2378 2379 2380

#ifdef CONFIG_MTD_PARTITIONS
	/* Deregister partitions */
2381
	del_mtd_partitions(mtd);
L
Linus Torvalds 已提交
2382 2383
#endif
	/* Deregister the device */
2384
	del_mtd_device(mtd);
L
Linus Torvalds 已提交
2385

J
Jesper Juhl 已提交
2386
	/* Free bad block table memory */
2387
	kfree(chip->bbt);
L
Linus Torvalds 已提交
2388 2389
}

2390 2391
EXPORT_SYMBOL_GPL(nand_scan);
EXPORT_SYMBOL_GPL(nand_release);
2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406

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

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