nand_base.c 98.1 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6
/*
 *  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.
7
 *
L
Linus Torvalds 已提交
8
 *	Additional technical information is available on
9
 *	http://www.linux-mtd.infradead.org/doc/nand.html
10
 *
L
Linus Torvalds 已提交
11
 *  Copyright (C) 2000 Steven J. Hill (sjhill@realitydiluted.com)
12
 *		  2002-2006 Thomas Gleixner (tglx@linutronix.de)
L
Linus Torvalds 已提交
13
 *
14
 *  Credits:
15 16
 *	David Woodhouse for adding multichip support
 *
L
Linus Torvalds 已提交
17 18 19
 *	Aleph One Ltd. and Toby Churchill Ltd. for supporting the
 *	rework for 2K page size chips
 *
20
 *  TODO:
L
Linus Torvalds 已提交
21 22
 *	Enable cached programming for 2k page size chips
 *	Check, if mtd->ecctype should be set to MTD_ECC_HW
23
 *	if we have HW ECC support.
24
 *	BBT table is not serialized, has to be fixed
L
Linus Torvalds 已提交
25 26 27 28 29 30 31
 *
 * 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.
 *
 */

32
#include <linux/module.h>
L
Linus Torvalds 已提交
33 34
#include <linux/delay.h>
#include <linux/errno.h>
T
Thomas Gleixner 已提交
35
#include <linux/err.h>
L
Linus Torvalds 已提交
36 37 38 39 40 41
#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>
42
#include <linux/mtd/nand_bch.h>
L
Linus Torvalds 已提交
43 44
#include <linux/interrupt.h>
#include <linux/bitops.h>
45
#include <linux/leds.h>
46
#include <linux/io.h>
L
Linus Torvalds 已提交
47 48 49
#include <linux/mtd/partitions.h>

/* Define default oob placement schemes for large and small page devices */
50
static struct nand_ecclayout nand_oob_8 = {
L
Linus Torvalds 已提交
51 52
	.eccbytes = 3,
	.eccpos = {0, 1, 2},
53 54 55 56
	.oobfree = {
		{.offset = 3,
		 .length = 2},
		{.offset = 6,
57
		 .length = 2} }
L
Linus Torvalds 已提交
58 59
};

60
static struct nand_ecclayout nand_oob_16 = {
L
Linus Torvalds 已提交
61 62
	.eccbytes = 6,
	.eccpos = {0, 1, 2, 3, 6, 7},
63 64
	.oobfree = {
		{.offset = 8,
65
		 . length = 8} }
L
Linus Torvalds 已提交
66 67
};

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

79 80 81 82 83 84 85 86 87 88 89
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,
90
		 .length = 78} }
91 92
};

93
static int nand_get_device(struct mtd_info *mtd, int new_state);
L
Linus Torvalds 已提交
94

95 96 97
static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops);

T
Thomas Gleixner 已提交
98
/*
J
Joe Perches 已提交
99
 * For devices which display every fart in the system on a separate LED. Is
T
Thomas Gleixner 已提交
100 101 102 103
 * compiled away when LED support is disabled.
 */
DEFINE_LED_TRIGGER(nand_led_trigger);

104 105 106 107 108 109 110 111
static int check_offs_len(struct mtd_info *mtd,
					loff_t ofs, uint64_t len)
{
	struct nand_chip *chip = mtd->priv;
	int ret = 0;

	/* Start address must align on block boundary */
	if (ofs & ((1 << chip->phys_erase_shift) - 1)) {
112
		pr_debug("%s: unaligned address\n", __func__);
113 114 115 116 117
		ret = -EINVAL;
	}

	/* Length must align on block boundary */
	if (len & ((1 << chip->phys_erase_shift) - 1)) {
118
		pr_debug("%s: length not block aligned\n", __func__);
119 120 121 122 123 124
		ret = -EINVAL;
	}

	return ret;
}

L
Linus Torvalds 已提交
125 126
/**
 * nand_release_device - [GENERIC] release chip
127
 * @mtd: MTD device structure
128
 *
129
 * Release chip lock and wake up anyone waiting on the device.
L
Linus Torvalds 已提交
130
 */
131
static void nand_release_device(struct mtd_info *mtd)
L
Linus Torvalds 已提交
132
{
133
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
134

T
Thomas Gleixner 已提交
135
	/* Release the controller and the chip */
136 137 138 139 140
	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 已提交
141 142 143 144
}

/**
 * nand_read_byte - [DEFAULT] read one byte from the chip
145
 * @mtd: MTD device structure
L
Linus Torvalds 已提交
146
 *
147
 * Default read function for 8bit buswidth
L
Linus Torvalds 已提交
148
 */
149
static uint8_t nand_read_byte(struct mtd_info *mtd)
L
Linus Torvalds 已提交
150
{
151 152
	struct nand_chip *chip = mtd->priv;
	return readb(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
153 154 155
}

/**
M
Masanari Iida 已提交
156
 * nand_read_byte16 - [DEFAULT] read one byte endianness aware from the chip
157
 * nand_read_byte16 - [DEFAULT] read one byte endianness aware from the chip
158
 * @mtd: MTD device structure
L
Linus Torvalds 已提交
159
 *
160 161
 * Default read function for 16bit buswidth with endianness conversion.
 *
L
Linus Torvalds 已提交
162
 */
163
static uint8_t nand_read_byte16(struct mtd_info *mtd)
L
Linus Torvalds 已提交
164
{
165 166
	struct nand_chip *chip = mtd->priv;
	return (uint8_t) cpu_to_le16(readw(chip->IO_ADDR_R));
L
Linus Torvalds 已提交
167 168 169 170
}

/**
 * nand_read_word - [DEFAULT] read one word from the chip
171
 * @mtd: MTD device structure
L
Linus Torvalds 已提交
172
 *
173
 * Default read function for 16bit buswidth without endianness conversion.
L
Linus Torvalds 已提交
174 175 176
 */
static u16 nand_read_word(struct mtd_info *mtd)
{
177 178
	struct nand_chip *chip = mtd->priv;
	return readw(chip->IO_ADDR_R);
L
Linus Torvalds 已提交
179 180 181 182
}

/**
 * nand_select_chip - [DEFAULT] control CE line
183 184
 * @mtd: MTD device structure
 * @chipnr: chipnumber to select, -1 for deselect
L
Linus Torvalds 已提交
185 186 187
 *
 * Default select function for 1 chip devices.
 */
188
static void nand_select_chip(struct mtd_info *mtd, int chipnr)
L
Linus Torvalds 已提交
189
{
190 191 192
	struct nand_chip *chip = mtd->priv;

	switch (chipnr) {
L
Linus Torvalds 已提交
193
	case -1:
194
		chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE);
L
Linus Torvalds 已提交
195 196 197 198 199 200 201 202 203 204 205
		break;
	case 0:
		break;

	default:
		BUG();
	}
}

/**
 * nand_write_buf - [DEFAULT] write buffer to chip
206 207 208
 * @mtd: MTD device structure
 * @buf: data buffer
 * @len: number of bytes to write
L
Linus Torvalds 已提交
209
 *
210
 * Default write function for 8bit buswidth.
L
Linus Torvalds 已提交
211
 */
212
static void nand_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
213
{
214
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
215

216
	iowrite8_rep(chip->IO_ADDR_W, buf, len);
L
Linus Torvalds 已提交
217 218 219
}

/**
220
 * nand_read_buf - [DEFAULT] read chip data into buffer
221 222 223
 * @mtd: MTD device structure
 * @buf: buffer to store date
 * @len: number of bytes to read
L
Linus Torvalds 已提交
224
 *
225
 * Default read function for 8bit buswidth.
L
Linus Torvalds 已提交
226
 */
227
static void nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
L
Linus Torvalds 已提交
228
{
229
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
230

231
	ioread8_rep(chip->IO_ADDR_R, buf, len);
L
Linus Torvalds 已提交
232 233 234 235
}

/**
 * nand_write_buf16 - [DEFAULT] write buffer to chip
236 237 238
 * @mtd: MTD device structure
 * @buf: data buffer
 * @len: number of bytes to write
L
Linus Torvalds 已提交
239
 *
240
 * Default write function for 16bit buswidth.
L
Linus Torvalds 已提交
241
 */
242
static void nand_write_buf16(struct mtd_info *mtd, const uint8_t *buf, int len)
L
Linus Torvalds 已提交
243
{
244
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
245
	u16 *p = (u16 *) buf;
246

247
	iowrite16_rep(chip->IO_ADDR_W, p, len >> 1);
L
Linus Torvalds 已提交
248 249 250
}

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

263
	ioread16_rep(chip->IO_ADDR_R, p, len >> 1);
L
Linus Torvalds 已提交
264 265 266 267
}

/**
 * nand_block_bad - [DEFAULT] Read bad block marker from the chip
268 269 270
 * @mtd: MTD device structure
 * @ofs: offset from device start
 * @getchip: 0, if the chip is already selected
L
Linus Torvalds 已提交
271
 *
272
 * Check, if the block is bad.
L
Linus Torvalds 已提交
273 274 275
 */
static int nand_block_bad(struct mtd_info *mtd, loff_t ofs, int getchip)
{
276
	int page, chipnr, res = 0, i = 0;
277
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
278 279
	u16 bad;

280
	if (chip->bbt_options & NAND_BBT_SCANLASTPAGE)
281 282
		ofs += mtd->erasesize - mtd->writesize;

283 284
	page = (int)(ofs >> chip->page_shift) & chip->pagemask;

L
Linus Torvalds 已提交
285
	if (getchip) {
286
		chipnr = (int)(ofs >> chip->chip_shift);
L
Linus Torvalds 已提交
287

288
		nand_get_device(mtd, FL_READING);
L
Linus Torvalds 已提交
289 290

		/* Select the NAND device */
291
		chip->select_chip(mtd, chipnr);
292
	}
L
Linus Torvalds 已提交
293

294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
	do {
		if (chip->options & NAND_BUSWIDTH_16) {
			chip->cmdfunc(mtd, NAND_CMD_READOOB,
					chip->badblockpos & 0xFE, page);
			bad = cpu_to_le16(chip->read_word(mtd));
			if (chip->badblockpos & 0x1)
				bad >>= 8;
			else
				bad &= 0xFF;
		} else {
			chip->cmdfunc(mtd, NAND_CMD_READOOB, chip->badblockpos,
					page);
			bad = chip->read_byte(mtd);
		}

		if (likely(chip->badblockbits == 8))
			res = bad != 0xFF;
311
		else
312 313 314 315 316
			res = hweight8(bad) < chip->badblockbits;
		ofs += mtd->writesize;
		page = (int)(ofs >> chip->page_shift) & chip->pagemask;
		i++;
	} while (!res && i < 2 && (chip->bbt_options & NAND_BBT_SCAN2NDPAGE));
317

318 319
	if (getchip) {
		chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
320
		nand_release_device(mtd);
321
	}
322

L
Linus Torvalds 已提交
323 324 325 326 327
	return res;
}

/**
 * nand_default_block_markbad - [DEFAULT] mark a block bad
328 329
 * @mtd: MTD device structure
 * @ofs: offset from device start
L
Linus Torvalds 已提交
330
 *
331
 * This is the default implementation, which can be overridden by a hardware
332 333 334 335 336 337 338 339
 * specific driver. We try operations in the following order, according to our
 * bbt_options (NAND_BBT_NO_OOB_BBM and NAND_BBT_USE_FLASH):
 *  (1) erase the affected block, to allow OOB marker to be written cleanly
 *  (2) update in-memory BBT
 *  (3) write bad block marker to OOB area of affected block
 *  (4) update flash-based BBT
 * Note that we retain the first error encountered in (3) or (4), finish the
 * procedures, and dump the error in the end.
L
Linus Torvalds 已提交
340 341 342
*/
static int nand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
{
343
	struct nand_chip *chip = mtd->priv;
344
	uint8_t buf[2] = { 0, 0 };
345 346
	int block, res, ret = 0, i = 0;
	int write_oob = !(chip->bbt_options & NAND_BBT_NO_OOB_BBM);
347

348
	if (write_oob) {
349 350 351 352 353 354 355 356 357 358
		struct erase_info einfo;

		/* Attempt erase before marking OOB */
		memset(&einfo, 0, sizeof(einfo));
		einfo.mtd = mtd;
		einfo.addr = ofs;
		einfo.len = 1 << chip->phys_erase_shift;
		nand_erase_nand(mtd, &einfo, 0);
	}

L
Linus Torvalds 已提交
359
	/* Get block number */
360
	block = (int)(ofs >> chip->bbt_erase_shift);
361
	/* Mark block bad in memory-based BBT */
362 363
	if (chip->bbt)
		chip->bbt[block >> 2] |= 0x01 << ((block & 0x03) << 1);
L
Linus Torvalds 已提交
364

365 366
	/* Write bad block marker to OOB */
	if (write_oob) {
367
		struct mtd_oob_ops ops;
368
		loff_t wr_ofs = ofs;
369

370
		nand_get_device(mtd, FL_WRITING);
371

372 373
		ops.datbuf = NULL;
		ops.oobbuf = buf;
374 375 376 377 378 379 380
		ops.ooboffs = chip->badblockpos;
		if (chip->options & NAND_BUSWIDTH_16) {
			ops.ooboffs &= ~0x01;
			ops.len = ops.ooblen = 2;
		} else {
			ops.len = ops.ooblen = 1;
		}
B
Brian Norris 已提交
381
		ops.mode = MTD_OPS_PLACE_OOB;
382

383
		/* Write to first/last page(s) if necessary */
384 385
		if (chip->bbt_options & NAND_BBT_SCANLASTPAGE)
			wr_ofs += mtd->erasesize - mtd->writesize;
386
		do {
387 388 389
			res = nand_do_write_oob(mtd, wr_ofs, &ops);
			if (!ret)
				ret = res;
390 391

			i++;
392
			wr_ofs += mtd->writesize;
393
		} while ((chip->bbt_options & NAND_BBT_SCAN2NDPAGE) && i < 2);
394

395
		nand_release_device(mtd);
396
	}
397 398 399 400 401 402 403 404

	/* Update flash-based bad block table */
	if (chip->bbt_options & NAND_BBT_USE_FLASH) {
		res = nand_update_bbt(mtd, ofs);
		if (!ret)
			ret = res;
	}

405 406
	if (!ret)
		mtd->ecc_stats.badblocks++;
407

408
	return ret;
L
Linus Torvalds 已提交
409 410
}

411
/**
L
Linus Torvalds 已提交
412
 * nand_check_wp - [GENERIC] check if the chip is write protected
413
 * @mtd: MTD device structure
L
Linus Torvalds 已提交
414
 *
415 416
 * Check, if the device is write protected. The function expects, that the
 * device is already selected.
L
Linus Torvalds 已提交
417
 */
418
static int nand_check_wp(struct mtd_info *mtd)
L
Linus Torvalds 已提交
419
{
420
	struct nand_chip *chip = mtd->priv;
421

422
	/* Broken xD cards report WP despite being writable */
423 424 425
	if (chip->options & NAND_BROKEN_XD)
		return 0;

L
Linus Torvalds 已提交
426
	/* Check the WP bit */
427 428
	chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
	return (chip->read_byte(mtd) & NAND_STATUS_WP) ? 0 : 1;
L
Linus Torvalds 已提交
429 430 431 432
}

/**
 * nand_block_checkbad - [GENERIC] Check if a block is marked bad
433 434 435 436
 * @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
L
Linus Torvalds 已提交
437 438 439 440
 *
 * Check, if the block is bad. Either by reading the bad block table or
 * calling of the scan function.
 */
441 442
static int nand_block_checkbad(struct mtd_info *mtd, loff_t ofs, int getchip,
			       int allowbbt)
L
Linus Torvalds 已提交
443
{
444
	struct nand_chip *chip = mtd->priv;
445

446 447
	if (!chip->bbt)
		return chip->block_bad(mtd, ofs, getchip);
448

L
Linus Torvalds 已提交
449
	/* Return info from the table */
450
	return nand_isbad_bbt(mtd, ofs, allowbbt);
L
Linus Torvalds 已提交
451 452
}

453 454
/**
 * panic_nand_wait_ready - [GENERIC] Wait for the ready pin after commands.
455 456
 * @mtd: MTD device structure
 * @timeo: Timeout
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
 *
 * 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);
	}
}

475
/* Wait for the ready pin, after a command. The timeout is caught later. */
476
void nand_wait_ready(struct mtd_info *mtd)
477
{
478
	struct nand_chip *chip = mtd->priv;
479
	unsigned long timeo = jiffies + msecs_to_jiffies(20);
480

481 482 483 484
	/* 400ms timeout */
	if (in_interrupt() || oops_in_progress)
		return panic_nand_wait_ready(mtd, 400);

485
	led_trigger_event(nand_led_trigger, LED_FULL);
486
	/* Wait until command is processed or timeout occurs */
487
	do {
488
		if (chip->dev_ready(mtd))
489
			break;
I
Ingo Molnar 已提交
490
		touch_softlockup_watchdog();
491
	} while (time_before(jiffies, timeo));
492
	led_trigger_event(nand_led_trigger, LED_OFF);
493
}
494
EXPORT_SYMBOL_GPL(nand_wait_ready);
495

L
Linus Torvalds 已提交
496 497
/**
 * nand_command - [DEFAULT] Send command to NAND device
498 499 500 501
 * @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
L
Linus Torvalds 已提交
502
 *
503
 * Send command to NAND device. This function is used for small page devices
504
 * (512 Bytes per page).
L
Linus Torvalds 已提交
505
 */
506 507
static void nand_command(struct mtd_info *mtd, unsigned int command,
			 int column, int page_addr)
L
Linus Torvalds 已提交
508
{
509
	register struct nand_chip *chip = mtd->priv;
510
	int ctrl = NAND_CTRL_CLE | NAND_CTRL_CHANGE;
L
Linus Torvalds 已提交
511

512
	/* Write out the command to the device */
L
Linus Torvalds 已提交
513 514 515
	if (command == NAND_CMD_SEQIN) {
		int readcmd;

J
Joern Engel 已提交
516
		if (column >= mtd->writesize) {
L
Linus Torvalds 已提交
517
			/* OOB area */
J
Joern Engel 已提交
518
			column -= mtd->writesize;
L
Linus Torvalds 已提交
519 520 521 522 523 524 525 526
			readcmd = NAND_CMD_READOOB;
		} else if (column < 256) {
			/* First 256 bytes --> READ0 */
			readcmd = NAND_CMD_READ0;
		} else {
			column -= 256;
			readcmd = NAND_CMD_READ1;
		}
527
		chip->cmd_ctrl(mtd, readcmd, ctrl);
528
		ctrl &= ~NAND_CTRL_CHANGE;
L
Linus Torvalds 已提交
529
	}
530
	chip->cmd_ctrl(mtd, command, ctrl);
L
Linus Torvalds 已提交
531

532
	/* Address cycle, when necessary */
533 534 535 536
	ctrl = NAND_CTRL_ALE | NAND_CTRL_CHANGE;
	/* Serially input address */
	if (column != -1) {
		/* Adjust columns for 16 bit buswidth */
537
		if (chip->options & NAND_BUSWIDTH_16)
538
			column >>= 1;
539
		chip->cmd_ctrl(mtd, column, ctrl);
540 541 542
		ctrl &= ~NAND_CTRL_CHANGE;
	}
	if (page_addr != -1) {
543
		chip->cmd_ctrl(mtd, page_addr, ctrl);
544
		ctrl &= ~NAND_CTRL_CHANGE;
545
		chip->cmd_ctrl(mtd, page_addr >> 8, ctrl);
546
		/* One more address cycle for devices > 32MiB */
547 548
		if (chip->chipsize > (32 << 20))
			chip->cmd_ctrl(mtd, page_addr >> 16, ctrl);
L
Linus Torvalds 已提交
549
	}
550
	chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
551 552

	/*
553 554
	 * Program and erase have their own busy handlers status and sequential
	 * in needs no delay
555
	 */
L
Linus Torvalds 已提交
556
	switch (command) {
557

L
Linus Torvalds 已提交
558 559 560 561 562 563 564 565
	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:
566
		if (chip->dev_ready)
L
Linus Torvalds 已提交
567
			break;
568 569
		udelay(chip->chip_delay);
		chip->cmd_ctrl(mtd, NAND_CMD_STATUS,
570
			       NAND_CTRL_CLE | NAND_CTRL_CHANGE);
571 572
		chip->cmd_ctrl(mtd,
			       NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
573 574
		while (!(chip->read_byte(mtd) & NAND_STATUS_READY))
				;
L
Linus Torvalds 已提交
575 576
		return;

577
		/* This applies to read commands */
L
Linus Torvalds 已提交
578
	default:
579
		/*
L
Linus Torvalds 已提交
580 581
		 * If we don't have access to the busy pin, we apply the given
		 * command delay
582
		 */
583 584
		if (!chip->dev_ready) {
			udelay(chip->chip_delay);
L
Linus Torvalds 已提交
585
			return;
586
		}
L
Linus Torvalds 已提交
587
	}
588 589 590 591
	/*
	 * Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine.
	 */
592
	ndelay(100);
593 594

	nand_wait_ready(mtd);
L
Linus Torvalds 已提交
595 596 597 598
}

/**
 * nand_command_lp - [DEFAULT] Send command to NAND large page device
599 600 601 602
 * @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
L
Linus Torvalds 已提交
603
 *
604
 * Send command to NAND device. This is the version for the new large page
605 606
 * devices. We don't 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 已提交
607
 */
608 609
static void nand_command_lp(struct mtd_info *mtd, unsigned int command,
			    int column, int page_addr)
L
Linus Torvalds 已提交
610
{
611
	register struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
612 613 614

	/* Emulate NAND_CMD_READOOB */
	if (command == NAND_CMD_READOOB) {
J
Joern Engel 已提交
615
		column += mtd->writesize;
L
Linus Torvalds 已提交
616 617
		command = NAND_CMD_READ0;
	}
618

619
	/* Command latch cycle */
620
	chip->cmd_ctrl(mtd, command, NAND_NCE | NAND_CLE | NAND_CTRL_CHANGE);
L
Linus Torvalds 已提交
621 622

	if (column != -1 || page_addr != -1) {
623
		int ctrl = NAND_CTRL_CHANGE | NAND_NCE | NAND_ALE;
L
Linus Torvalds 已提交
624 625 626 627

		/* Serially input address */
		if (column != -1) {
			/* Adjust columns for 16 bit buswidth */
628
			if (chip->options & NAND_BUSWIDTH_16)
L
Linus Torvalds 已提交
629
				column >>= 1;
630
			chip->cmd_ctrl(mtd, column, ctrl);
631
			ctrl &= ~NAND_CTRL_CHANGE;
632
			chip->cmd_ctrl(mtd, column >> 8, ctrl);
633
		}
L
Linus Torvalds 已提交
634
		if (page_addr != -1) {
635 636
			chip->cmd_ctrl(mtd, page_addr, ctrl);
			chip->cmd_ctrl(mtd, page_addr >> 8,
637
				       NAND_NCE | NAND_ALE);
L
Linus Torvalds 已提交
638
			/* One more address cycle for devices > 128MiB */
639 640
			if (chip->chipsize > (128 << 20))
				chip->cmd_ctrl(mtd, page_addr >> 16,
641
					       NAND_NCE | NAND_ALE);
L
Linus Torvalds 已提交
642 643
		}
	}
644
	chip->cmd_ctrl(mtd, NAND_CMD_NONE, NAND_NCE | NAND_CTRL_CHANGE);
645 646

	/*
647 648
	 * Program and erase have their own busy handlers status, sequential
	 * in, and deplete1 need no delay.
649
	 */
L
Linus Torvalds 已提交
650
	switch (command) {
651

L
Linus Torvalds 已提交
652 653 654 655 656
	case NAND_CMD_CACHEDPROG:
	case NAND_CMD_PAGEPROG:
	case NAND_CMD_ERASE1:
	case NAND_CMD_ERASE2:
	case NAND_CMD_SEQIN:
657
	case NAND_CMD_RNDIN:
L
Linus Torvalds 已提交
658
	case NAND_CMD_STATUS:
659
		return;
L
Linus Torvalds 已提交
660 661

	case NAND_CMD_RESET:
662
		if (chip->dev_ready)
L
Linus Torvalds 已提交
663
			break;
664
		udelay(chip->chip_delay);
665 666 667 668
		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);
669 670
		while (!(chip->read_byte(mtd) & NAND_STATUS_READY))
				;
L
Linus Torvalds 已提交
671 672
		return;

673 674 675 676 677 678 679 680
	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 已提交
681
	case NAND_CMD_READ0:
682 683 684 685
		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);
686

687
		/* This applies to read commands */
L
Linus Torvalds 已提交
688
	default:
689
		/*
L
Linus Torvalds 已提交
690
		 * If we don't have access to the busy pin, we apply the given
691
		 * command delay.
692
		 */
693 694
		if (!chip->dev_ready) {
			udelay(chip->chip_delay);
L
Linus Torvalds 已提交
695
			return;
696
		}
L
Linus Torvalds 已提交
697
	}
698

699 700 701 702
	/*
	 * Apply this short delay always to ensure that we do wait tWB in
	 * any case on any machine.
	 */
703
	ndelay(100);
704 705

	nand_wait_ready(mtd);
L
Linus Torvalds 已提交
706 707
}

708 709
/**
 * panic_nand_get_device - [GENERIC] Get chip for selected access
710 711 712
 * @chip: the nand chip descriptor
 * @mtd: MTD device structure
 * @new_state: the state which is requested
713 714 715 716 717 718
 *
 * 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)
{
719
	/* Hardware controller shared among independent devices */
720 721 722 723
	chip->controller->active = chip;
	chip->state = new_state;
}

L
Linus Torvalds 已提交
724 725
/**
 * nand_get_device - [GENERIC] Get chip for selected access
726 727
 * @mtd: MTD device structure
 * @new_state: the state which is requested
L
Linus Torvalds 已提交
728 729 730
 *
 * Get the device and lock it for exclusive access
 */
731
static int
732
nand_get_device(struct mtd_info *mtd, int new_state)
L
Linus Torvalds 已提交
733
{
734
	struct nand_chip *chip = mtd->priv;
735 736
	spinlock_t *lock = &chip->controller->lock;
	wait_queue_head_t *wq = &chip->controller->wq;
737
	DECLARE_WAITQUEUE(wait, current);
738
retry:
739 740
	spin_lock(lock);

741
	/* Hardware controller shared among independent devices */
742 743
	if (!chip->controller->active)
		chip->controller->active = chip;
T
Thomas Gleixner 已提交
744

745 746
	if (chip->controller->active == chip && chip->state == FL_READY) {
		chip->state = new_state;
747
		spin_unlock(lock);
748 749 750
		return 0;
	}
	if (new_state == FL_PM_SUSPENDED) {
751 752 753 754 755
		if (chip->controller->active->state == FL_PM_SUSPENDED) {
			chip->state = FL_PM_SUSPENDED;
			spin_unlock(lock);
			return 0;
		}
756 757 758 759 760 761
	}
	set_current_state(TASK_UNINTERRUPTIBLE);
	add_wait_queue(wq, &wait);
	spin_unlock(lock);
	schedule();
	remove_wait_queue(wq, &wait);
L
Linus Torvalds 已提交
762 763 764
	goto retry;
}

765
/**
766 767 768 769
 * panic_nand_wait - [GENERIC] wait until the command is done
 * @mtd: MTD device structure
 * @chip: NAND chip structure
 * @timeo: timeout
770 771 772
 *
 * 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
773
 * an oops through mtdoops.
774 775 776 777 778 779 780 781 782 783 784 785 786 787
 */
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);
788
	}
789 790
}

L
Linus Torvalds 已提交
791
/**
792 793 794
 * nand_wait - [DEFAULT] wait until the command is done
 * @mtd: MTD device structure
 * @chip: NAND chip structure
L
Linus Torvalds 已提交
795
 *
796 797 798
 * Wait for command done. This applies to erase and program only. Erase can
 * take up to 400ms and program up to 20ms according to general NAND and
 * SmartMedia specs.
R
Randy Dunlap 已提交
799
 */
800
static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
L
Linus Torvalds 已提交
801 802
{

803
	int status, state = chip->state;
804
	unsigned long timeo = (state == FL_ERASING ? 400 : 20);
L
Linus Torvalds 已提交
805

806 807
	led_trigger_event(nand_led_trigger, LED_FULL);

808 809 810 811
	/*
	 * Apply this short delay always to ensure that we do wait tWB in any
	 * case on any machine.
	 */
812
	ndelay(100);
L
Linus Torvalds 已提交
813

814
	chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
L
Linus Torvalds 已提交
815

816 817 818
	if (in_interrupt() || oops_in_progress)
		panic_nand_wait(mtd, chip, timeo);
	else {
819
		timeo = jiffies + msecs_to_jiffies(timeo);
820 821 822 823 824 825 826 827 828
		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 已提交
829 830
		}
	}
831 832
	led_trigger_event(nand_led_trigger, LED_OFF);

833
	status = (int)chip->read_byte(mtd);
834 835
	/* This can happen if in case of timeout or buggy dev_ready */
	WARN_ON(!(status & NAND_STATUS_READY));
L
Linus Torvalds 已提交
836 837 838
	return status;
}

839
/**
840 841 842 843
 * __nand_unlock - [REPLACEABLE] unlocks specified locked blocks
 * @mtd: mtd info
 * @ofs: offset to start unlock from
 * @len: length to unlock
844 845 846 847
 * @invert: when = 0, unlock the range of blocks within the lower and
 *                    upper boundary address
 *          when = 1, unlock the range of blocks outside the boundaries
 *                    of the lower and upper boundary address
848
 *
849
 * Returs unlock status.
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
 */
static int __nand_unlock(struct mtd_info *mtd, loff_t ofs,
					uint64_t len, int invert)
{
	int ret = 0;
	int status, page;
	struct nand_chip *chip = mtd->priv;

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

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

	/* Call wait ready function */
	status = chip->waitfunc(mtd, chip);
	/* See if device thinks it succeeded */
870
	if (status & NAND_STATUS_FAIL) {
871
		pr_debug("%s: error status = 0x%08x\n",
872 873 874 875 876 877 878 879
					__func__, status);
		ret = -EIO;
	}

	return ret;
}

/**
880 881 882 883
 * nand_unlock - [REPLACEABLE] unlocks specified locked blocks
 * @mtd: mtd info
 * @ofs: offset to start unlock from
 * @len: length to unlock
884
 *
885
 * Returns unlock status.
886 887 888 889 890 891 892
 */
int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
{
	int ret = 0;
	int chipnr;
	struct nand_chip *chip = mtd->priv;

893
	pr_debug("%s: start = 0x%012llx, len = %llu\n",
894 895 896 897 898 899 900 901 902
			__func__, (unsigned long long)ofs, len);

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

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

903
	nand_get_device(mtd, FL_UNLOCKING);
904 905 906 907 908 909 910 911

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

	chip->select_chip(mtd, chipnr);

	/* Check, if it is write protected */
	if (nand_check_wp(mtd)) {
912
		pr_debug("%s: device is write protected!\n",
913 914 915 916 917 918 919 920
					__func__);
		ret = -EIO;
		goto out;
	}

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

out:
921
	chip->select_chip(mtd, -1);
922 923 924 925
	nand_release_device(mtd);

	return ret;
}
926
EXPORT_SYMBOL(nand_unlock);
927 928

/**
929 930 931 932
 * nand_lock - [REPLACEABLE] locks all blocks present in the device
 * @mtd: mtd info
 * @ofs: offset to start unlock from
 * @len: length to unlock
933
 *
934 935 936 937
 * This feature is not supported in many NAND parts. 'Micron' NAND parts do
 * have this feature, but it allows only to lock all blocks, not for specified
 * range for block. Implementing 'lock' feature by making use of 'unlock', for
 * now.
938
 *
939
 * Returns lock status.
940 941 942 943 944 945 946
 */
int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
{
	int ret = 0;
	int chipnr, status, page;
	struct nand_chip *chip = mtd->priv;

947
	pr_debug("%s: start = 0x%012llx, len = %llu\n",
948 949 950 951 952
			__func__, (unsigned long long)ofs, len);

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

953
	nand_get_device(mtd, FL_LOCKING);
954 955 956 957 958 959 960 961

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

	chip->select_chip(mtd, chipnr);

	/* Check, if it is write protected */
	if (nand_check_wp(mtd)) {
962
		pr_debug("%s: device is write protected!\n",
963 964 965 966 967 968 969 970 971 972 973 974 975
					__func__);
		status = MTD_ERASE_FAILED;
		ret = -EIO;
		goto out;
	}

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

	/* Call wait ready function */
	status = chip->waitfunc(mtd, chip);
	/* See if device thinks it succeeded */
976
	if (status & NAND_STATUS_FAIL) {
977
		pr_debug("%s: error status = 0x%08x\n",
978 979 980 981 982 983 984 985
					__func__, status);
		ret = -EIO;
		goto out;
	}

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

out:
986
	chip->select_chip(mtd, -1);
987 988 989 990
	nand_release_device(mtd);

	return ret;
}
991
EXPORT_SYMBOL(nand_lock);
992

993
/**
994
 * nand_read_page_raw - [INTERN] read raw page data without ecc
995 996 997
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: buffer to store read data
998
 * @oob_required: caller requires OOB data read to chip->oob_poi
999
 * @page: page number to read
1000
 *
1001
 * Not for syndrome calculating ECC controllers, which use a special oob layout.
1002 1003
 */
static int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1004
			      uint8_t *buf, int oob_required, int page)
1005 1006
{
	chip->read_buf(mtd, buf, mtd->writesize);
1007 1008
	if (oob_required)
		chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1009 1010 1011
	return 0;
}

1012
/**
1013
 * nand_read_page_raw_syndrome - [INTERN] read raw page data without ecc
1014 1015 1016
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: buffer to store read data
1017
 * @oob_required: caller requires OOB data read to chip->oob_poi
1018
 * @page: page number to read
1019 1020 1021
 *
 * We need a special oob layout and handling even when OOB isn't used.
 */
1022
static int nand_read_page_raw_syndrome(struct mtd_info *mtd,
1023 1024
				       struct nand_chip *chip, uint8_t *buf,
				       int oob_required, int page)
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
{
	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 已提交
1056
/**
1057
 * nand_read_page_swecc - [REPLACEABLE] software ECC based page read function
1058 1059 1060
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: buffer to store read data
1061
 * @oob_required: caller requires OOB data read to chip->oob_poi
1062
 * @page: page number to read
1063
 */
1064
static int nand_read_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
1065
				uint8_t *buf, int oob_required, int page)
L
Linus Torvalds 已提交
1066
{
1067 1068 1069 1070
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1071 1072
	uint8_t *ecc_calc = chip->buffers->ecccalc;
	uint8_t *ecc_code = chip->buffers->ecccode;
1073
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1074
	unsigned int max_bitflips = 0;
1075

1076
	chip->ecc.read_page_raw(mtd, chip, buf, 1, page);
1077 1078 1079 1080 1081

	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++)
1082
		ecc_code[i] = chip->oob_poi[eccpos[i]];
1083 1084 1085 1086 1087 1088 1089 1090

	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]);
1091
		if (stat < 0) {
1092
			mtd->ecc_stats.failed++;
1093
		} else {
1094
			mtd->ecc_stats.corrected += stat;
1095 1096
			max_bitflips = max_t(unsigned int, max_bitflips, stat);
		}
1097
	}
1098
	return max_bitflips;
1099
}
L
Linus Torvalds 已提交
1100

1101
/**
1102
 * nand_read_subpage - [REPLACEABLE] ECC based sub-page read function
1103 1104 1105 1106 1107
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @data_offs: offset of requested data within the page
 * @readlen: data length
 * @bufpoi: buffer to store read data
1108
 */
1109 1110
static int nand_read_subpage(struct mtd_info *mtd, struct nand_chip *chip,
			uint32_t data_offs, uint32_t readlen, uint8_t *bufpoi)
1111 1112 1113 1114 1115 1116 1117
{
	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;
1118
	int index = 0;
1119
	unsigned int max_bitflips = 0;
1120

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

1126
	/* Data size aligned to ECC ecc.size */
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
	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);

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

1142 1143
	/*
	 * The performance is faster if we position offsets according to
1144
	 * ecc.pos. Let's make sure that there are no gaps in ECC positions.
1145
	 */
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
	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 {
1157
		/*
1158
		 * Send the command to read the particular ECC bytes take care
1159 1160
		 * about buswidth alignment in read_buf.
		 */
1161 1162 1163
		index = start_step * chip->ecc.bytes;

		aligned_pos = eccpos[index] & ~(busw - 1);
1164
		aligned_len = eccfrag_len;
1165
		if (eccpos[index] & (busw - 1))
1166
			aligned_len++;
1167
		if (eccpos[index + (num_steps * chip->ecc.bytes)] & (busw - 1))
1168 1169
			aligned_len++;

1170 1171
		chip->cmdfunc(mtd, NAND_CMD_RNDOUT,
					mtd->writesize + aligned_pos, -1);
1172 1173 1174 1175
		chip->read_buf(mtd, &chip->oob_poi[aligned_pos], aligned_len);
	}

	for (i = 0; i < eccfrag_len; i++)
1176
		chip->buffers->ecccode[i] = chip->oob_poi[eccpos[i + index]];
1177 1178 1179 1180 1181

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

1182 1183
		stat = chip->ecc.correct(mtd, p,
			&chip->buffers->ecccode[i], &chip->buffers->ecccalc[i]);
1184
		if (stat < 0) {
1185
			mtd->ecc_stats.failed++;
1186
		} else {
1187
			mtd->ecc_stats.corrected += stat;
1188 1189
			max_bitflips = max_t(unsigned int, max_bitflips, stat);
		}
1190
	}
1191
	return max_bitflips;
1192 1193
}

1194
/**
1195
 * nand_read_page_hwecc - [REPLACEABLE] hardware ECC based page read function
1196 1197 1198
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: buffer to store read data
1199
 * @oob_required: caller requires OOB data read to chip->oob_poi
1200
 * @page: page number to read
1201
 *
1202
 * Not for syndrome calculating ECC controllers which need a special oob layout.
1203
 */
1204
static int nand_read_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
1205
				uint8_t *buf, int oob_required, int page)
L
Linus Torvalds 已提交
1206
{
1207 1208 1209 1210
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
	uint8_t *p = buf;
1211 1212
	uint8_t *ecc_calc = chip->buffers->ecccalc;
	uint8_t *ecc_code = chip->buffers->ecccode;
1213
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1214
	unsigned int max_bitflips = 0;
1215 1216 1217 1218 1219

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

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

1226 1227
	eccsteps = chip->ecc.steps;
	p = buf;
1228

1229 1230
	for (i = 0 ; eccsteps; eccsteps--, i += eccbytes, p += eccsize) {
		int stat;
L
Linus Torvalds 已提交
1231

1232
		stat = chip->ecc.correct(mtd, p, &ecc_code[i], &ecc_calc[i]);
1233
		if (stat < 0) {
1234
			mtd->ecc_stats.failed++;
1235
		} else {
1236
			mtd->ecc_stats.corrected += stat;
1237 1238
			max_bitflips = max_t(unsigned int, max_bitflips, stat);
		}
1239
	}
1240
	return max_bitflips;
1241
}
L
Linus Torvalds 已提交
1242

1243
/**
1244
 * nand_read_page_hwecc_oob_first - [REPLACEABLE] hw ecc, read oob first
1245 1246 1247
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: buffer to store read data
1248
 * @oob_required: caller requires OOB data read to chip->oob_poi
1249
 * @page: page number to read
1250
 *
1251 1252 1253 1254 1255
 * 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.
1256 1257
 */
static int nand_read_page_hwecc_oob_first(struct mtd_info *mtd,
1258
	struct nand_chip *chip, uint8_t *buf, int oob_required, int page)
1259 1260 1261 1262 1263 1264 1265 1266
{
	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;
1267
	unsigned int max_bitflips = 0;
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284

	/* 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);
1285
		if (stat < 0) {
1286
			mtd->ecc_stats.failed++;
1287
		} else {
1288
			mtd->ecc_stats.corrected += stat;
1289 1290
			max_bitflips = max_t(unsigned int, max_bitflips, stat);
		}
1291
	}
1292
	return max_bitflips;
1293 1294
}

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

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

1319 1320
		chip->ecc.hwctl(mtd, NAND_ECC_READ);
		chip->read_buf(mtd, p, eccsize);
L
Linus Torvalds 已提交
1321

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

1327 1328 1329
		chip->ecc.hwctl(mtd, NAND_ECC_READSYN);
		chip->read_buf(mtd, oob, eccbytes);
		stat = chip->ecc.correct(mtd, p, oob, NULL);
1330

1331
		if (stat < 0) {
1332
			mtd->ecc_stats.failed++;
1333
		} else {
1334
			mtd->ecc_stats.corrected += stat;
1335 1336
			max_bitflips = max_t(unsigned int, max_bitflips, stat);
		}
1337

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

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

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

1351
	return max_bitflips;
1352
}
L
Linus Torvalds 已提交
1353

1354
/**
1355
 * nand_transfer_oob - [INTERN] Transfer oob to client buffer
1356 1357 1358 1359
 * @chip: nand chip structure
 * @oob: oob destination address
 * @ops: oob ops structure
 * @len: size of oob to transfer
1360 1361
 */
static uint8_t *nand_transfer_oob(struct nand_chip *chip, uint8_t *oob,
1362
				  struct mtd_oob_ops *ops, size_t len)
1363
{
1364
	switch (ops->mode) {
1365

1366 1367
	case MTD_OPS_PLACE_OOB:
	case MTD_OPS_RAW:
1368 1369 1370
		memcpy(oob, chip->oob_poi + ops->ooboffs, len);
		return oob + len;

1371
	case MTD_OPS_AUTO_OOB: {
1372
		struct nand_oobfree *free = chip->ecc.layout->oobfree;
1373 1374
		uint32_t boffs = 0, roffs = ops->ooboffs;
		size_t bytes = 0;
1375

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

/**
1403
 * nand_do_read_ops - [INTERN] Read data with ECC
1404 1405 1406
 * @mtd: MTD device structure
 * @from: offset to read from
 * @ops: oob ops structure
1407 1408 1409
 *
 * Internal function. Called with chip held.
 */
1410 1411
static int nand_do_read_ops(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
1412
{
1413
	int chipnr, page, realpage, col, bytes, aligned, oob_required;
1414 1415 1416
	struct nand_chip *chip = mtd->priv;
	struct mtd_ecc_stats stats;
	int ret = 0;
1417
	uint32_t readlen = ops->len;
1418
	uint32_t oobreadlen = ops->ooblen;
1419
	uint32_t max_oobsize = ops->mode == MTD_OPS_AUTO_OOB ?
1420 1421
		mtd->oobavail : mtd->oobsize;

1422
	uint8_t *bufpoi, *oob, *buf;
1423
	unsigned int max_bitflips = 0;
L
Linus Torvalds 已提交
1424

1425
	stats = mtd->ecc_stats;
L
Linus Torvalds 已提交
1426

1427 1428
	chipnr = (int)(from >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);
1429

1430 1431
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1432

1433
	col = (int)(from & (mtd->writesize - 1));
1434

1435 1436
	buf = ops->datbuf;
	oob = ops->oobbuf;
1437
	oob_required = oob ? 1 : 0;
1438

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

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

1447
			chip->cmdfunc(mtd, NAND_CMD_READ0, 0x00, page);
L
Linus Torvalds 已提交
1448

1449 1450 1451 1452
			/*
			 * Now read the page into the buffer.  Absent an error,
			 * the read methods return max bitflips per ecc step.
			 */
1453
			if (unlikely(ops->mode == MTD_OPS_RAW))
1454
				ret = chip->ecc.read_page_raw(mtd, chip, bufpoi,
1455 1456
							      oob_required,
							      page);
1457 1458
			else if (!aligned && NAND_HAS_SUBPAGE_READ(chip) &&
				 !oob)
1459 1460
				ret = chip->ecc.read_subpage(mtd, chip,
							col, bytes, bufpoi);
1461
			else
1462
				ret = chip->ecc.read_page(mtd, chip, bufpoi,
1463
							  oob_required, page);
1464 1465 1466 1467
			if (ret < 0) {
				if (!aligned)
					/* Invalidate page cache */
					chip->pagebuf = -1;
L
Linus Torvalds 已提交
1468
				break;
1469
			}
1470

1471 1472
			max_bitflips = max_t(unsigned int, max_bitflips, ret);

1473 1474
			/* Transfer not aligned data */
			if (!aligned) {
1475
				if (!NAND_HAS_SUBPAGE_READ(chip) && !oob &&
1476
				    !(mtd->ecc_stats.failed - stats.failed) &&
1477
				    (ops->mode != MTD_OPS_RAW)) {
1478
					chip->pagebuf = realpage;
1479 1480
					chip->pagebuf_bitflips = ret;
				} else {
1481 1482
					/* Invalidate page cache */
					chip->pagebuf = -1;
1483
				}
1484
				memcpy(buf, chip->buffers->databuf + col, bytes);
1485 1486
			}

1487 1488 1489
			buf += bytes;

			if (unlikely(oob)) {
1490 1491 1492 1493 1494 1495 1496
				int toread = min(oobreadlen, max_oobsize);

				if (toread) {
					oob = nand_transfer_oob(chip,
						oob, ops, toread);
					oobreadlen -= toread;
				}
1497
			}
1498 1499 1500 1501 1502 1503 1504 1505

			if (chip->options & NAND_NEED_READRDY) {
				/* Apply delay or wait for ready/busy pin */
				if (!chip->dev_ready)
					udelay(chip->chip_delay);
				else
					nand_wait_ready(mtd);
			}
1506
		} else {
1507
			memcpy(buf, chip->buffers->databuf + col, bytes);
1508
			buf += bytes;
1509 1510
			max_bitflips = max_t(unsigned int, max_bitflips,
					     chip->pagebuf_bitflips);
1511
		}
L
Linus Torvalds 已提交
1512

1513
		readlen -= bytes;
1514

1515
		if (!readlen)
1516
			break;
L
Linus Torvalds 已提交
1517

1518
		/* For subsequent reads align to page boundary */
L
Linus Torvalds 已提交
1519 1520 1521 1522
		col = 0;
		/* Increment page address */
		realpage++;

1523
		page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1524 1525 1526
		/* Check, if we cross a chip boundary */
		if (!page) {
			chipnr++;
1527 1528
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1529 1530
		}
	}
1531
	chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
1532

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

1537
	if (ret < 0)
1538 1539
		return ret;

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

1543
	return max_bitflips;
1544 1545 1546
}

/**
L
Lucas De Marchi 已提交
1547
 * nand_read - [MTD Interface] MTD compatibility function for nand_do_read_ecc
1548 1549 1550 1551 1552
 * @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
1553
 *
1554
 * Get hold of the chip and call nand_do_read.
1555 1556 1557 1558
 */
static int nand_read(struct mtd_info *mtd, loff_t from, size_t len,
		     size_t *retlen, uint8_t *buf)
{
1559
	struct mtd_oob_ops ops;
1560 1561
	int ret;

1562
	nand_get_device(mtd, FL_READING);
1563 1564 1565
	ops.len = len;
	ops.datbuf = buf;
	ops.oobbuf = NULL;
1566
	ops.mode = MTD_OPS_PLACE_OOB;
1567 1568
	ret = nand_do_read_ops(mtd, from, &ops);
	*retlen = ops.retlen;
1569 1570
	nand_release_device(mtd);
	return ret;
L
Linus Torvalds 已提交
1571 1572
}

1573
/**
1574
 * nand_read_oob_std - [REPLACEABLE] the most common OOB data read function
1575 1576 1577
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @page: page number to read
1578 1579
 */
static int nand_read_oob_std(struct mtd_info *mtd, struct nand_chip *chip,
1580
			     int page)
1581
{
1582
	chip->cmdfunc(mtd, NAND_CMD_READOOB, 0, page);
1583
	chip->read_buf(mtd, chip->oob_poi, mtd->oobsize);
1584
	return 0;
1585 1586 1587
}

/**
1588
 * nand_read_oob_syndrome - [REPLACEABLE] OOB data read function for HW ECC
1589
 *			    with syndromes
1590 1591 1592
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @page: page number to read
1593 1594
 */
static int nand_read_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1595
				  int page)
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621
{
	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);

1622
	return 0;
1623 1624 1625
}

/**
1626
 * nand_write_oob_std - [REPLACEABLE] the most common OOB data write function
1627 1628 1629
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @page: page number to write
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644
 */
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 已提交
1645
	return status & NAND_STATUS_FAIL ? -EIO : 0;
1646 1647 1648
}

/**
1649
 * nand_write_oob_syndrome - [REPLACEABLE] OOB data write function for HW ECC
1650 1651 1652 1653
 *			     with syndrome - only for large page flash
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @page: page number to write
1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
 */
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
1672
		pos = eccsize;
1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706

	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 已提交
1707
/**
1708
 * nand_do_read_oob - [INTERN] NAND read out-of-band
1709 1710 1711
 * @mtd: MTD device structure
 * @from: offset to read from
 * @ops: oob operations description structure
L
Linus Torvalds 已提交
1712
 *
1713
 * NAND read out-of-band data from the spare area.
L
Linus Torvalds 已提交
1714
 */
1715 1716
static int nand_do_read_oob(struct mtd_info *mtd, loff_t from,
			    struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1717
{
1718
	int page, realpage, chipnr;
1719
	struct nand_chip *chip = mtd->priv;
1720
	struct mtd_ecc_stats stats;
1721 1722
	int readlen = ops->ooblen;
	int len;
1723
	uint8_t *buf = ops->oobbuf;
1724
	int ret = 0;
1725

1726
	pr_debug("%s: from = 0x%08Lx, len = %i\n",
1727
			__func__, (unsigned long long)from, readlen);
L
Linus Torvalds 已提交
1728

1729 1730
	stats = mtd->ecc_stats;

1731
	if (ops->mode == MTD_OPS_AUTO_OOB)
1732
		len = chip->ecc.layout->oobavail;
1733 1734 1735 1736
	else
		len = mtd->oobsize;

	if (unlikely(ops->ooboffs >= len)) {
1737 1738
		pr_debug("%s: attempt to start read outside oob\n",
				__func__);
1739 1740 1741 1742 1743 1744 1745
		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)) {
1746 1747
		pr_debug("%s: attempt to read beyond end of device\n",
				__func__);
1748 1749
		return -EINVAL;
	}
1750

1751
	chipnr = (int)(from >> chip->chip_shift);
1752
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
1753

1754 1755 1756
	/* Shift to get page */
	realpage = (int)(from >> chip->page_shift);
	page = realpage & chip->pagemask;
L
Linus Torvalds 已提交
1757

1758
	while (1) {
1759
		if (ops->mode == MTD_OPS_RAW)
1760
			ret = chip->ecc.read_oob_raw(mtd, chip, page);
1761
		else
1762 1763 1764 1765
			ret = chip->ecc.read_oob(mtd, chip, page);

		if (ret < 0)
			break;
1766 1767 1768

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

1770 1771 1772 1773 1774 1775 1776 1777
		if (chip->options & NAND_NEED_READRDY) {
			/* Apply delay or wait for ready/busy pin */
			if (!chip->dev_ready)
				udelay(chip->chip_delay);
			else
				nand_wait_ready(mtd);
		}

1778
		readlen -= len;
S
Savin Zlobec 已提交
1779 1780 1781
		if (!readlen)
			break;

1782 1783 1784 1785 1786 1787 1788 1789 1790
		/* 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 已提交
1791 1792
		}
	}
1793
	chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
1794

1795 1796 1797 1798
	ops->oobretlen = ops->ooblen - readlen;

	if (ret < 0)
		return ret;
1799 1800 1801 1802 1803

	if (mtd->ecc_stats.failed - stats.failed)
		return -EBADMSG;

	return  mtd->ecc_stats.corrected - stats.corrected ? -EUCLEAN : 0;
L
Linus Torvalds 已提交
1804 1805 1806
}

/**
1807
 * nand_read_oob - [MTD Interface] NAND read data and/or out-of-band
1808 1809 1810
 * @mtd: MTD device structure
 * @from: offset to read from
 * @ops: oob operation description structure
L
Linus Torvalds 已提交
1811
 *
1812
 * NAND read data and/or out-of-band data.
L
Linus Torvalds 已提交
1813
 */
1814 1815
static int nand_read_oob(struct mtd_info *mtd, loff_t from,
			 struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
1816
{
1817 1818 1819
	int ret = -ENOTSUPP;

	ops->retlen = 0;
L
Linus Torvalds 已提交
1820 1821

	/* Do not allow reads past end of device */
1822
	if (ops->datbuf && (from + ops->len) > mtd->size) {
1823 1824
		pr_debug("%s: attempt to read beyond end of device\n",
				__func__);
L
Linus Torvalds 已提交
1825 1826 1827
		return -EINVAL;
	}

1828
	nand_get_device(mtd, FL_READING);
L
Linus Torvalds 已提交
1829

1830
	switch (ops->mode) {
1831 1832 1833
	case MTD_OPS_PLACE_OOB:
	case MTD_OPS_AUTO_OOB:
	case MTD_OPS_RAW:
1834
		break;
L
Linus Torvalds 已提交
1835

1836 1837 1838
	default:
		goto out;
	}
L
Linus Torvalds 已提交
1839

1840 1841 1842 1843
	if (!ops->datbuf)
		ret = nand_do_read_oob(mtd, from, ops);
	else
		ret = nand_do_read_ops(mtd, from, ops);
1844

1845
out:
1846 1847 1848
	nand_release_device(mtd);
	return ret;
}
1849

L
Linus Torvalds 已提交
1850

1851
/**
1852
 * nand_write_page_raw - [INTERN] raw page write function
1853 1854 1855
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: data buffer
1856
 * @oob_required: must write chip->oob_poi to OOB
1857
 *
1858
 * Not for syndrome calculating ECC controllers, which use a special oob layout.
1859
 */
1860
static int nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1861
				const uint8_t *buf, int oob_required)
1862 1863
{
	chip->write_buf(mtd, buf, mtd->writesize);
1864 1865
	if (oob_required)
		chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);
1866 1867

	return 0;
L
Linus Torvalds 已提交
1868 1869
}

1870
/**
1871
 * nand_write_page_raw_syndrome - [INTERN] raw page write function
1872 1873 1874
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: data buffer
1875
 * @oob_required: must write chip->oob_poi to OOB
1876 1877 1878
 *
 * We need a special oob layout and handling even when ECC isn't checked.
 */
1879
static int nand_write_page_raw_syndrome(struct mtd_info *mtd,
1880
					struct nand_chip *chip,
1881
					const uint8_t *buf, int oob_required)
1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908
{
	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);
1909 1910

	return 0;
1911
}
1912
/**
1913
 * nand_write_page_swecc - [REPLACEABLE] software ECC based page write function
1914 1915 1916
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: data buffer
1917
 * @oob_required: must write chip->oob_poi to OOB
1918
 */
1919
static int nand_write_page_swecc(struct mtd_info *mtd, struct nand_chip *chip,
1920
				  const uint8_t *buf, int oob_required)
1921
{
1922 1923 1924
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
1925
	uint8_t *ecc_calc = chip->buffers->ecccalc;
1926
	const uint8_t *p = buf;
1927
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1928

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

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

1936
	return chip->ecc.write_page_raw(mtd, chip, buf, 1);
1937
}
1938

1939
/**
1940
 * nand_write_page_hwecc - [REPLACEABLE] hardware ECC based page write function
1941 1942 1943
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: data buffer
1944
 * @oob_required: must write chip->oob_poi to OOB
1945
 */
1946
static int nand_write_page_hwecc(struct mtd_info *mtd, struct nand_chip *chip,
1947
				  const uint8_t *buf, int oob_required)
1948 1949 1950 1951
{
	int i, eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	int eccsteps = chip->ecc.steps;
1952
	uint8_t *ecc_calc = chip->buffers->ecccalc;
1953
	const uint8_t *p = buf;
1954
	uint32_t *eccpos = chip->ecc.layout->eccpos;
1955

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

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

	return 0;
1968 1969
}

1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030

/**
 * nand_write_subpage_hwecc - [REPLACABLE] hardware ECC based subpage write
 * @mtd:	mtd info structure
 * @chip:	nand chip info structure
 * @column:	column address of subpage within the page
 * @data_len:	data length
 * @oob_required: must write chip->oob_poi to OOB
 */
static int nand_write_subpage_hwecc(struct mtd_info *mtd,
				struct nand_chip *chip, uint32_t offset,
				uint32_t data_len, const uint8_t *data_buf,
				int oob_required)
{
	uint8_t *oob_buf  = chip->oob_poi;
	uint8_t *ecc_calc = chip->buffers->ecccalc;
	int ecc_size      = chip->ecc.size;
	int ecc_bytes     = chip->ecc.bytes;
	int ecc_steps     = chip->ecc.steps;
	uint32_t *eccpos  = chip->ecc.layout->eccpos;
	uint32_t start_step = offset / ecc_size;
	uint32_t end_step   = (offset + data_len - 1) / ecc_size;
	int oob_bytes       = mtd->oobsize / ecc_steps;
	int step, i;

	for (step = 0; step < ecc_steps; step++) {
		/* configure controller for WRITE access */
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);

		/* write data (untouched subpages already masked by 0xFF) */
		chip->write_buf(mtd, data_buf, ecc_size);

		/* mask ECC of un-touched subpages by padding 0xFF */
		if ((step < start_step) || (step > end_step))
			memset(ecc_calc, 0xff, ecc_bytes);
		else
			chip->ecc.calculate(mtd, data_buf, ecc_calc);

		/* mask OOB of un-touched subpages by padding 0xFF */
		/* if oob_required, preserve OOB metadata of written subpage */
		if (!oob_required || (step < start_step) || (step > end_step))
			memset(oob_buf, 0xff, oob_bytes);

		data_buf += ecc_size;
		ecc_calc += ecc_bytes;
		oob_buf  += oob_bytes;
	}

	/* copy calculated ECC for whole page to chip->buffer->oob */
	/* this include masked-value(0xFF) for unwritten subpages */
	ecc_calc = chip->buffers->ecccalc;
	for (i = 0; i < chip->ecc.total; i++)
		chip->oob_poi[eccpos[i]] = ecc_calc[i];

	/* write OOB buffer to NAND device */
	chip->write_buf(mtd, chip->oob_poi, mtd->oobsize);

	return 0;
}


2031
/**
2032
 * nand_write_page_syndrome - [REPLACEABLE] hardware ECC syndrome based page write
2033 2034 2035
 * @mtd: mtd info structure
 * @chip: nand chip info structure
 * @buf: data buffer
2036
 * @oob_required: must write chip->oob_poi to OOB
L
Linus Torvalds 已提交
2037
 *
2038 2039
 * The hw generator calculates the error syndrome automatically. Therefore we
 * need a special oob layout and handling.
2040
 */
2041
static int nand_write_page_syndrome(struct mtd_info *mtd,
2042 2043
				    struct nand_chip *chip,
				    const uint8_t *buf, int oob_required)
L
Linus Torvalds 已提交
2044
{
2045 2046 2047 2048 2049
	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 已提交
2050

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

2053 2054
		chip->ecc.hwctl(mtd, NAND_ECC_WRITE);
		chip->write_buf(mtd, p, eccsize);
2055

2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067
		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 已提交
2068 2069
		}
	}
2070 2071

	/* Calculate remaining oob bytes */
2072
	i = mtd->oobsize - (oob - chip->oob_poi);
2073 2074
	if (i)
		chip->write_buf(mtd, oob, i);
2075 2076

	return 0;
2077 2078 2079
}

/**
2080
 * nand_write_page - [REPLACEABLE] write one page
2081 2082
 * @mtd: MTD device structure
 * @chip: NAND chip descriptor
2083 2084
 * @offset: address offset within the page
 * @data_len: length of actual data to be written
2085
 * @buf: the data to write
2086
 * @oob_required: must write chip->oob_poi to OOB
2087 2088 2089
 * @page: page number to write
 * @cached: cached programming
 * @raw: use _raw version of write_page
2090 2091
 */
static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
2092 2093
		uint32_t offset, int data_len, const uint8_t *buf,
		int oob_required, int page, int cached, int raw)
2094
{
2095 2096 2097 2098 2099 2100 2101
	int status, subpage;

	if (!(chip->options & NAND_NO_SUBPAGE_WRITE) &&
		chip->ecc.write_subpage)
		subpage = offset || (data_len < mtd->writesize);
	else
		subpage = 0;
2102 2103 2104

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

2105
	if (unlikely(raw))
2106 2107 2108 2109 2110
		status = chip->ecc.write_page_raw(mtd, chip, buf,
							oob_required);
	else if (subpage)
		status = chip->ecc.write_subpage(mtd, chip, offset, data_len,
							 buf, oob_required);
2111
	else
2112 2113 2114 2115
		status = chip->ecc.write_page(mtd, chip, buf, oob_required);

	if (status < 0)
		return status;
2116 2117

	/*
2118
	 * Cached progamming disabled for now. Not sure if it's worth the
2119
	 * trouble. The speed gain is not very impressive. (2.3->2.6Mib/s).
2120 2121 2122
	 */
	cached = 0;

2123
	if (!cached || !NAND_HAS_CACHEPROG(chip)) {
2124 2125

		chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
2126
		status = chip->waitfunc(mtd, chip);
2127 2128
		/*
		 * See if operation failed and additional status checks are
2129
		 * available.
2130 2131 2132 2133 2134 2135 2136 2137 2138
		 */
		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);
2139
		status = chip->waitfunc(mtd, chip);
2140 2141 2142
	}

	return 0;
L
Linus Torvalds 已提交
2143 2144
}

2145
/**
2146
 * nand_fill_oob - [INTERN] Transfer client buffer to oob
2147
 * @mtd: MTD device structure
2148 2149 2150
 * @oob: oob data buffer
 * @len: oob data write length
 * @ops: oob ops structure
2151
 */
2152 2153
static uint8_t *nand_fill_oob(struct mtd_info *mtd, uint8_t *oob, size_t len,
			      struct mtd_oob_ops *ops)
2154
{
2155 2156 2157 2158 2159 2160 2161 2162
	struct nand_chip *chip = mtd->priv;

	/*
	 * Initialise to all 0xFF, to avoid the possibility of left over OOB
	 * data from a previous OOB read.
	 */
	memset(chip->oob_poi, 0xff, mtd->oobsize);

2163
	switch (ops->mode) {
2164

2165 2166
	case MTD_OPS_PLACE_OOB:
	case MTD_OPS_RAW:
2167 2168 2169
		memcpy(chip->oob_poi + ops->ooboffs, oob, len);
		return oob + len;

2170
	case MTD_OPS_AUTO_OOB: {
2171
		struct nand_oobfree *free = chip->ecc.layout->oobfree;
2172 2173
		uint32_t boffs = 0, woffs = ops->ooboffs;
		size_t bytes = 0;
2174

2175
		for (; free->length && len; free++, len -= bytes) {
2176
			/* Write request not from offset 0? */
2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189
			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;
			}
2190
			memcpy(chip->oob_poi + boffs, oob, bytes);
2191 2192 2193 2194 2195 2196 2197 2198 2199 2200
			oob += bytes;
		}
		return oob;
	}
	default:
		BUG();
	}
	return NULL;
}

2201
#define NOTALIGNED(x)	((x & (chip->subpagesize - 1)) != 0)
L
Linus Torvalds 已提交
2202 2203

/**
2204
 * nand_do_write_ops - [INTERN] NAND write with ECC
2205 2206 2207
 * @mtd: MTD device structure
 * @to: offset to write to
 * @ops: oob operations description structure
L
Linus Torvalds 已提交
2208
 *
2209
 * NAND write with ECC.
L
Linus Torvalds 已提交
2210
 */
2211 2212
static int nand_do_write_ops(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
2213
{
2214
	int chipnr, realpage, page, blockmask, column;
2215
	struct nand_chip *chip = mtd->priv;
2216
	uint32_t writelen = ops->len;
2217 2218

	uint32_t oobwritelen = ops->ooblen;
2219
	uint32_t oobmaxlen = ops->mode == MTD_OPS_AUTO_OOB ?
2220 2221
				mtd->oobavail : mtd->oobsize;

2222 2223
	uint8_t *oob = ops->oobbuf;
	uint8_t *buf = ops->datbuf;
2224
	int ret;
2225
	int oob_required = oob ? 1 : 0;
L
Linus Torvalds 已提交
2226

2227
	ops->retlen = 0;
2228 2229
	if (!writelen)
		return 0;
L
Linus Torvalds 已提交
2230

2231
	/* Reject writes, which are not page aligned */
2232
	if (NOTALIGNED(to) || NOTALIGNED(ops->len)) {
2233 2234
		pr_notice("%s: attempt to write non page aligned data\n",
			   __func__);
L
Linus Torvalds 已提交
2235 2236 2237
		return -EINVAL;
	}

2238
	column = to & (mtd->writesize - 1);
L
Linus Torvalds 已提交
2239

2240 2241 2242
	chipnr = (int)(to >> chip->chip_shift);
	chip->select_chip(mtd, chipnr);

L
Linus Torvalds 已提交
2243
	/* Check, if it is write protected */
2244 2245 2246 2247
	if (nand_check_wp(mtd)) {
		ret = -EIO;
		goto err_out;
	}
L
Linus Torvalds 已提交
2248

2249 2250 2251 2252 2253 2254
	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) &&
2255
	    (chip->pagebuf << chip->page_shift) < (to + ops->len))
2256
		chip->pagebuf = -1;
2257

2258
	/* Don't allow multipage oob writes with offset */
2259 2260 2261 2262
	if (oob && ops->ooboffs && (ops->ooboffs + ops->ooblen > oobmaxlen)) {
		ret = -EINVAL;
		goto err_out;
	}
2263

2264
	while (1) {
2265
		int bytes = mtd->writesize;
2266
		int cached = writelen > bytes && page != blockmask;
2267 2268
		uint8_t *wbuf = buf;

2269
		/* Partial page write? */
2270 2271 2272 2273 2274 2275 2276 2277
		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 已提交
2278

2279 2280
		if (unlikely(oob)) {
			size_t len = min(oobwritelen, oobmaxlen);
2281
			oob = nand_fill_oob(mtd, oob, len, ops);
2282
			oobwritelen -= len;
2283 2284 2285
		} else {
			/* We still need to erase leftover OOB data */
			memset(chip->oob_poi, 0xff, mtd->oobsize);
2286
		}
2287 2288 2289
		ret = chip->write_page(mtd, chip, column, bytes, wbuf,
					oob_required, page, cached,
					(ops->mode == MTD_OPS_RAW));
2290 2291 2292 2293 2294 2295 2296
		if (ret)
			break;

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

2297
		column = 0;
2298 2299 2300 2301 2302 2303 2304 2305 2306
		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 已提交
2307 2308
		}
	}
2309 2310

	ops->retlen = ops->len - writelen;
2311 2312
	if (unlikely(oob))
		ops->oobretlen = ops->ooblen;
2313 2314 2315

err_out:
	chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
2316 2317 2318
	return ret;
}

2319 2320
/**
 * panic_nand_write - [MTD Interface] NAND write with ECC
2321 2322 2323 2324 2325
 * @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
2326 2327 2328 2329 2330 2331 2332 2333
 *
 * 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;
2334
	struct mtd_oob_ops ops;
2335 2336
	int ret;

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

2340
	/* Grab the device */
2341 2342
	panic_nand_get_device(chip, mtd, FL_WRITING);

2343 2344 2345
	ops.len = len;
	ops.datbuf = (uint8_t *)buf;
	ops.oobbuf = NULL;
2346
	ops.mode = MTD_OPS_PLACE_OOB;
2347

2348
	ret = nand_do_write_ops(mtd, to, &ops);
2349

2350
	*retlen = ops.retlen;
2351 2352 2353
	return ret;
}

2354
/**
2355
 * nand_write - [MTD Interface] NAND write with ECC
2356 2357 2358 2359 2360
 * @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
2361
 *
2362
 * NAND write with ECC.
2363
 */
2364 2365
static int nand_write(struct mtd_info *mtd, loff_t to, size_t len,
			  size_t *retlen, const uint8_t *buf)
2366
{
2367
	struct mtd_oob_ops ops;
2368 2369
	int ret;

2370
	nand_get_device(mtd, FL_WRITING);
2371 2372 2373
	ops.len = len;
	ops.datbuf = (uint8_t *)buf;
	ops.oobbuf = NULL;
2374
	ops.mode = MTD_OPS_PLACE_OOB;
2375 2376
	ret = nand_do_write_ops(mtd, to, &ops);
	*retlen = ops.retlen;
2377
	nand_release_device(mtd);
2378
	return ret;
2379
}
2380

L
Linus Torvalds 已提交
2381
/**
2382
 * nand_do_write_oob - [MTD Interface] NAND write out-of-band
2383 2384 2385
 * @mtd: MTD device structure
 * @to: offset to write to
 * @ops: oob operation description structure
L
Linus Torvalds 已提交
2386
 *
2387
 * NAND write out-of-band.
L
Linus Torvalds 已提交
2388
 */
2389 2390
static int nand_do_write_oob(struct mtd_info *mtd, loff_t to,
			     struct mtd_oob_ops *ops)
L
Linus Torvalds 已提交
2391
{
2392
	int chipnr, page, status, len;
2393
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2394

2395
	pr_debug("%s: to = 0x%08x, len = %i\n",
2396
			 __func__, (unsigned int)to, (int)ops->ooblen);
L
Linus Torvalds 已提交
2397

2398
	if (ops->mode == MTD_OPS_AUTO_OOB)
2399 2400 2401 2402
		len = chip->ecc.layout->oobavail;
	else
		len = mtd->oobsize;

L
Linus Torvalds 已提交
2403
	/* Do not allow write past end of page */
2404
	if ((ops->ooboffs + ops->ooblen) > len) {
2405 2406
		pr_debug("%s: attempt to write past end of page\n",
				__func__);
L
Linus Torvalds 已提交
2407 2408 2409
		return -EINVAL;
	}

2410
	if (unlikely(ops->ooboffs >= len)) {
2411 2412
		pr_debug("%s: attempt to start write outside oob\n",
				__func__);
2413 2414 2415
		return -EINVAL;
	}

2416
	/* Do not allow write past end of device */
2417 2418 2419 2420
	if (unlikely(to >= mtd->size ||
		     ops->ooboffs + ops->ooblen >
			((mtd->size >> chip->page_shift) -
			 (to >> chip->page_shift)) * len)) {
2421 2422
		pr_debug("%s: attempt to write beyond end of device\n",
				__func__);
2423 2424 2425
		return -EINVAL;
	}

2426
	chipnr = (int)(to >> chip->chip_shift);
2427
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2428

2429 2430 2431 2432 2433 2434 2435 2436 2437
	/* 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.
	 */
2438
	chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
L
Linus Torvalds 已提交
2439 2440

	/* Check, if it is write protected */
2441 2442
	if (nand_check_wp(mtd)) {
		chip->select_chip(mtd, -1);
2443
		return -EROFS;
2444
	}
2445

L
Linus Torvalds 已提交
2446
	/* Invalidate the page cache, if we write to the cached page */
2447 2448
	if (page == chip->pagebuf)
		chip->pagebuf = -1;
L
Linus Torvalds 已提交
2449

2450
	nand_fill_oob(mtd, ops->oobbuf, ops->ooblen, ops);
2451

2452
	if (ops->mode == MTD_OPS_RAW)
2453 2454 2455
		status = chip->ecc.write_oob_raw(mtd, chip, page & chip->pagemask);
	else
		status = chip->ecc.write_oob(mtd, chip, page & chip->pagemask);
L
Linus Torvalds 已提交
2456

2457 2458
	chip->select_chip(mtd, -1);

2459 2460
	if (status)
		return status;
L
Linus Torvalds 已提交
2461

2462
	ops->oobretlen = ops->ooblen;
L
Linus Torvalds 已提交
2463

2464
	return 0;
2465 2466 2467 2468
}

/**
 * nand_write_oob - [MTD Interface] NAND write data and/or out-of-band
2469 2470 2471
 * @mtd: MTD device structure
 * @to: offset to write to
 * @ops: oob operation description structure
2472 2473 2474 2475 2476 2477 2478 2479 2480
 */
static int nand_write_oob(struct mtd_info *mtd, loff_t to,
			  struct mtd_oob_ops *ops)
{
	int ret = -ENOTSUPP;

	ops->retlen = 0;

	/* Do not allow writes past end of device */
2481
	if (ops->datbuf && (to + ops->len) > mtd->size) {
2482 2483
		pr_debug("%s: attempt to write beyond end of device\n",
				__func__);
2484 2485 2486
		return -EINVAL;
	}

2487
	nand_get_device(mtd, FL_WRITING);
2488

2489
	switch (ops->mode) {
2490 2491 2492
	case MTD_OPS_PLACE_OOB:
	case MTD_OPS_AUTO_OOB:
	case MTD_OPS_RAW:
2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503
		break;

	default:
		goto out;
	}

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

2504
out:
L
Linus Torvalds 已提交
2505 2506 2507 2508 2509
	nand_release_device(mtd);
	return ret;
}

/**
2510
 * single_erase_cmd - [GENERIC] NAND standard block erase command function
2511 2512
 * @mtd: MTD device structure
 * @page: the page address of the block which will be erased
L
Linus Torvalds 已提交
2513
 *
2514
 * Standard erase command for NAND chips.
L
Linus Torvalds 已提交
2515
 */
2516
static void single_erase_cmd(struct mtd_info *mtd, int page)
L
Linus Torvalds 已提交
2517
{
2518
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
2519
	/* Send commands to erase a block */
2520 2521
	chip->cmdfunc(mtd, NAND_CMD_ERASE1, -1, page);
	chip->cmdfunc(mtd, NAND_CMD_ERASE2, -1, -1);
L
Linus Torvalds 已提交
2522 2523 2524 2525
}

/**
 * nand_erase - [MTD Interface] erase block(s)
2526 2527
 * @mtd: MTD device structure
 * @instr: erase instruction
L
Linus Torvalds 已提交
2528
 *
2529
 * Erase one ore more blocks.
L
Linus Torvalds 已提交
2530
 */
2531
static int nand_erase(struct mtd_info *mtd, struct erase_info *instr)
L
Linus Torvalds 已提交
2532
{
2533
	return nand_erase_nand(mtd, instr, 0);
L
Linus Torvalds 已提交
2534
}
2535

L
Linus Torvalds 已提交
2536
/**
2537
 * nand_erase_nand - [INTERN] erase block(s)
2538 2539 2540
 * @mtd: MTD device structure
 * @instr: erase instruction
 * @allowbbt: allow erasing the bbt area
L
Linus Torvalds 已提交
2541
 *
2542
 * Erase one ore more blocks.
L
Linus Torvalds 已提交
2543
 */
2544 2545
int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
		    int allowbbt)
L
Linus Torvalds 已提交
2546
{
2547
	int page, status, pages_per_block, ret, chipnr;
2548
	struct nand_chip *chip = mtd->priv;
2549
	loff_t len;
L
Linus Torvalds 已提交
2550

2551 2552 2553
	pr_debug("%s: start = 0x%012llx, len = %llu\n",
			__func__, (unsigned long long)instr->addr,
			(unsigned long long)instr->len);
L
Linus Torvalds 已提交
2554

2555
	if (check_offs_len(mtd, instr->addr, instr->len))
L
Linus Torvalds 已提交
2556 2557 2558
		return -EINVAL;

	/* Grab the lock and see if the device is available */
2559
	nand_get_device(mtd, FL_ERASING);
L
Linus Torvalds 已提交
2560 2561

	/* Shift to get first page */
2562 2563
	page = (int)(instr->addr >> chip->page_shift);
	chipnr = (int)(instr->addr >> chip->chip_shift);
L
Linus Torvalds 已提交
2564 2565

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

	/* Select the NAND device */
2569
	chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2570 2571 2572

	/* Check, if it is write protected */
	if (nand_check_wp(mtd)) {
2573 2574
		pr_debug("%s: device is write protected!\n",
				__func__);
L
Linus Torvalds 已提交
2575 2576 2577 2578 2579 2580 2581 2582 2583 2584
		instr->state = MTD_ERASE_FAILED;
		goto erase_exit;
	}

	/* Loop through the pages */
	len = instr->len;

	instr->state = MTD_ERASING;

	while (len) {
W
Wolfram Sang 已提交
2585
		/* Check if we have a bad block, we do not erase bad blocks! */
2586 2587
		if (nand_block_checkbad(mtd, ((loff_t) page) <<
					chip->page_shift, 0, allowbbt)) {
2588 2589
			pr_warn("%s: attempt to erase a bad block at page 0x%08x\n",
				    __func__, page);
L
Linus Torvalds 已提交
2590 2591 2592
			instr->state = MTD_ERASE_FAILED;
			goto erase_exit;
		}
2593

2594 2595
		/*
		 * Invalidate the page cache, if we erase the block which
2596
		 * contains the current cached page.
2597 2598 2599 2600
		 */
		if (page <= chip->pagebuf && chip->pagebuf <
		    (page + pages_per_block))
			chip->pagebuf = -1;
L
Linus Torvalds 已提交
2601

2602
		chip->erase_cmd(mtd, page & chip->pagemask);
2603

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

2606 2607 2608 2609 2610 2611 2612
		/*
		 * 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);
2613

L
Linus Torvalds 已提交
2614
		/* See if block erase succeeded */
2615
		if (status & NAND_STATUS_FAIL) {
2616 2617
			pr_debug("%s: failed erase, page 0x%08x\n",
					__func__, page);
L
Linus Torvalds 已提交
2618
			instr->state = MTD_ERASE_FAILED;
2619 2620
			instr->fail_addr =
				((loff_t)page << chip->page_shift);
L
Linus Torvalds 已提交
2621 2622
			goto erase_exit;
		}
2623

L
Linus Torvalds 已提交
2624
		/* Increment page address and decrement length */
2625
		len -= (1 << chip->phys_erase_shift);
L
Linus Torvalds 已提交
2626 2627 2628
		page += pages_per_block;

		/* Check, if we cross a chip boundary */
2629
		if (len && !(page & chip->pagemask)) {
L
Linus Torvalds 已提交
2630
			chipnr++;
2631 2632
			chip->select_chip(mtd, -1);
			chip->select_chip(mtd, chipnr);
L
Linus Torvalds 已提交
2633 2634 2635 2636
		}
	}
	instr->state = MTD_ERASE_DONE;

2637
erase_exit:
L
Linus Torvalds 已提交
2638 2639 2640 2641

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

	/* Deselect and wake up anyone waiting on the device */
2642
	chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
2643 2644
	nand_release_device(mtd);

2645 2646 2647 2648
	/* Do call back function */
	if (!ret)
		mtd_erase_callback(instr);

L
Linus Torvalds 已提交
2649 2650 2651 2652 2653 2654
	/* Return more or less happy */
	return ret;
}

/**
 * nand_sync - [MTD Interface] sync
2655
 * @mtd: MTD device structure
L
Linus Torvalds 已提交
2656
 *
2657
 * Sync is actually a wait for chip ready function.
L
Linus Torvalds 已提交
2658
 */
2659
static void nand_sync(struct mtd_info *mtd)
L
Linus Torvalds 已提交
2660
{
2661
	pr_debug("%s: called\n", __func__);
L
Linus Torvalds 已提交
2662 2663

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

/**
2670
 * nand_block_isbad - [MTD Interface] Check if block at offset is bad
2671 2672
 * @mtd: MTD device structure
 * @offs: offset relative to mtd start
L
Linus Torvalds 已提交
2673
 */
2674
static int nand_block_isbad(struct mtd_info *mtd, loff_t offs)
L
Linus Torvalds 已提交
2675
{
2676
	return nand_block_checkbad(mtd, offs, 1, 0);
L
Linus Torvalds 已提交
2677 2678 2679
}

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

2689 2690
	ret = nand_block_isbad(mtd, ofs);
	if (ret) {
2691
		/* If it was bad already, return success and do nothing */
L
Linus Torvalds 已提交
2692 2693
		if (ret > 0)
			return 0;
2694 2695
		return ret;
	}
L
Linus Torvalds 已提交
2696

2697
	return chip->block_markbad(mtd, ofs);
L
Linus Torvalds 已提交
2698 2699
}

2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711
/**
 * nand_onfi_set_features- [REPLACEABLE] set features for ONFI nand
 * @mtd: MTD device structure
 * @chip: nand chip info structure
 * @addr: feature address.
 * @subfeature_param: the subfeature parameters, a four bytes array.
 */
static int nand_onfi_set_features(struct mtd_info *mtd, struct nand_chip *chip,
			int addr, uint8_t *subfeature_param)
{
	int status;

2712 2713 2714
	if (!chip->onfi_version ||
	    !(le16_to_cpu(chip->onfi_params.opt_cmd)
	      & ONFI_OPT_CMD_SET_GET_FEATURES))
2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734
		return -EINVAL;

	chip->cmdfunc(mtd, NAND_CMD_SET_FEATURES, addr, -1);
	chip->write_buf(mtd, subfeature_param, ONFI_SUBFEATURE_PARAM_LEN);
	status = chip->waitfunc(mtd, chip);
	if (status & NAND_STATUS_FAIL)
		return -EIO;
	return 0;
}

/**
 * nand_onfi_get_features- [REPLACEABLE] get features for ONFI nand
 * @mtd: MTD device structure
 * @chip: nand chip info structure
 * @addr: feature address.
 * @subfeature_param: the subfeature parameters, a four bytes array.
 */
static int nand_onfi_get_features(struct mtd_info *mtd, struct nand_chip *chip,
			int addr, uint8_t *subfeature_param)
{
2735 2736 2737
	if (!chip->onfi_version ||
	    !(le16_to_cpu(chip->onfi_params.opt_cmd)
	      & ONFI_OPT_CMD_SET_GET_FEATURES))
2738 2739 2740 2741 2742 2743 2744 2745 2746 2747
		return -EINVAL;

	/* clear the sub feature parameters */
	memset(subfeature_param, 0, ONFI_SUBFEATURE_PARAM_LEN);

	chip->cmdfunc(mtd, NAND_CMD_GET_FEATURES, addr, -1);
	chip->read_buf(mtd, subfeature_param, ONFI_SUBFEATURE_PARAM_LEN);
	return 0;
}

2748 2749
/**
 * nand_suspend - [MTD Interface] Suspend the NAND flash
2750
 * @mtd: MTD device structure
2751 2752 2753
 */
static int nand_suspend(struct mtd_info *mtd)
{
2754
	return nand_get_device(mtd, FL_PM_SUSPENDED);
2755 2756 2757 2758
}

/**
 * nand_resume - [MTD Interface] Resume the NAND flash
2759
 * @mtd: MTD device structure
2760 2761 2762
 */
static void nand_resume(struct mtd_info *mtd)
{
2763
	struct nand_chip *chip = mtd->priv;
2764

2765
	if (chip->state == FL_PM_SUSPENDED)
2766 2767
		nand_release_device(mtd);
	else
2768 2769
		pr_err("%s called for a chip which is not in suspended state\n",
			__func__);
2770 2771
}

2772
/* Set default functions */
2773
static void nand_set_defaults(struct nand_chip *chip, int busw)
T
Thomas Gleixner 已提交
2774
{
L
Linus Torvalds 已提交
2775
	/* check for proper chip_delay setup, set 20us if not */
2776 2777
	if (!chip->chip_delay)
		chip->chip_delay = 20;
L
Linus Torvalds 已提交
2778 2779

	/* check, if a user supplied command function given */
2780 2781
	if (chip->cmdfunc == NULL)
		chip->cmdfunc = nand_command;
L
Linus Torvalds 已提交
2782 2783

	/* check, if a user supplied wait function given */
2784 2785 2786 2787 2788
	if (chip->waitfunc == NULL)
		chip->waitfunc = nand_wait;

	if (!chip->select_chip)
		chip->select_chip = nand_select_chip;
2789 2790 2791

	/* If called twice, pointers that depend on busw may need to be reset */
	if (!chip->read_byte || chip->read_byte == nand_read_byte)
2792 2793 2794 2795 2796 2797 2798
		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;
2799
	if (!chip->write_buf || chip->write_buf == nand_write_buf)
2800
		chip->write_buf = busw ? nand_write_buf16 : nand_write_buf;
2801
	if (!chip->read_buf || chip->read_buf == nand_read_buf)
2802 2803 2804
		chip->read_buf = busw ? nand_read_buf16 : nand_read_buf;
	if (!chip->scan_bbt)
		chip->scan_bbt = nand_default_bbt;
2805 2806 2807 2808 2809 2810 2811

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

T
Thomas Gleixner 已提交
2812 2813
}

2814
/* Sanitize ONFI strings so we can safely print them */
2815 2816 2817 2818
static void sanitize_string(uint8_t *s, size_t len)
{
	ssize_t i;

2819
	/* Null terminate */
2820 2821
	s[len - 1] = 0;

2822
	/* Remove non printable chars */
2823 2824 2825 2826 2827
	for (i = 0; i < len - 1; i++) {
		if (s[i] < ' ' || s[i] > 127)
			s[i] = '?';
	}

2828
	/* Remove trailing spaces */
2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843
	strim(s);
}

static u16 onfi_crc16(u16 crc, u8 const *p, size_t len)
{
	int i;
	while (len--) {
		crc ^= *p++ << 8;
		for (i = 0; i < 8; i++)
			crc = (crc << 1) ^ ((crc & 0x8000) ? 0x8005 : 0);
	}

	return crc;
}

2844
/*
2845
 * Check if the NAND chip is ONFI compliant, returns 1 if it is, 0 otherwise.
2846 2847
 */
static int nand_flash_detect_onfi(struct mtd_info *mtd, struct nand_chip *chip,
2848
					int *busw)
2849 2850 2851 2852 2853
{
	struct nand_onfi_params *p = &chip->onfi_params;
	int i;
	int val;

2854 2855 2856 2857 2858
	/* ONFI need to be probed in 8 bits mode, and 16 bits should be selected with NAND_BUSWIDTH_AUTO */
	if (chip->options & NAND_BUSWIDTH_16) {
		pr_err("Trying ONFI probe in 16 bits mode, aborting !\n");
		return 0;
	}
2859
	/* Try ONFI for unknown chip or LP */
2860 2861 2862 2863 2864 2865 2866 2867 2868 2869
	chip->cmdfunc(mtd, NAND_CMD_READID, 0x20, -1);
	if (chip->read_byte(mtd) != 'O' || chip->read_byte(mtd) != 'N' ||
		chip->read_byte(mtd) != 'F' || chip->read_byte(mtd) != 'I')
		return 0;

	chip->cmdfunc(mtd, NAND_CMD_PARAM, 0, -1);
	for (i = 0; i < 3; i++) {
		chip->read_buf(mtd, (uint8_t *)p, sizeof(*p));
		if (onfi_crc16(ONFI_CRC_BASE, (uint8_t *)p, 254) ==
				le16_to_cpu(p->crc)) {
2870
			pr_info("ONFI param page %d valid\n", i);
2871 2872 2873 2874 2875 2876 2877
			break;
		}
	}

	if (i == 3)
		return 0;

2878
	/* Check version */
2879
	val = le16_to_cpu(p->revision);
2880 2881 2882
	if (val & (1 << 5))
		chip->onfi_version = 23;
	else if (val & (1 << 4))
2883 2884 2885 2886 2887
		chip->onfi_version = 22;
	else if (val & (1 << 3))
		chip->onfi_version = 21;
	else if (val & (1 << 2))
		chip->onfi_version = 20;
2888
	else if (val & (1 << 1))
2889
		chip->onfi_version = 10;
2890 2891

	if (!chip->onfi_version) {
2892
		pr_info("%s: unsupported ONFI version: %d\n", __func__, val);
2893 2894
		return 0;
	}
2895 2896 2897 2898 2899 2900 2901 2902

	sanitize_string(p->manufacturer, sizeof(p->manufacturer));
	sanitize_string(p->model, sizeof(p->model));
	if (!mtd->name)
		mtd->name = p->model;
	mtd->writesize = le32_to_cpu(p->byte_per_page);
	mtd->erasesize = le32_to_cpu(p->pages_per_block) * mtd->writesize;
	mtd->oobsize = le16_to_cpu(p->spare_bytes_per_page);
2903 2904
	chip->chipsize = le32_to_cpu(p->blocks_per_lun);
	chip->chipsize *= (uint64_t)mtd->erasesize * p->lun_count;
2905
	*busw = 0;
2906
	if (le16_to_cpu(p->features) & 1)
2907
		*busw = NAND_BUSWIDTH_16;
2908

2909
	pr_info("ONFI flash detected\n");
2910 2911 2912
	return 1;
}

2913 2914 2915 2916 2917 2918 2919 2920
/*
 * nand_id_has_period - Check if an ID string has a given wraparound period
 * @id_data: the ID string
 * @arrlen: the length of the @id_data array
 * @period: the period of repitition
 *
 * Check if an ID string is repeated within a given sequence of bytes at
 * specific repetition interval period (e.g., {0x20,0x01,0x7F,0x20} has a
2921
 * period of 3). This is a helper function for nand_id_len(). Returns non-zero
2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971
 * if the repetition has a period of @period; otherwise, returns zero.
 */
static int nand_id_has_period(u8 *id_data, int arrlen, int period)
{
	int i, j;
	for (i = 0; i < period; i++)
		for (j = i + period; j < arrlen; j += period)
			if (id_data[i] != id_data[j])
				return 0;
	return 1;
}

/*
 * nand_id_len - Get the length of an ID string returned by CMD_READID
 * @id_data: the ID string
 * @arrlen: the length of the @id_data array

 * Returns the length of the ID string, according to known wraparound/trailing
 * zero patterns. If no pattern exists, returns the length of the array.
 */
static int nand_id_len(u8 *id_data, int arrlen)
{
	int last_nonzero, period;

	/* Find last non-zero byte */
	for (last_nonzero = arrlen - 1; last_nonzero >= 0; last_nonzero--)
		if (id_data[last_nonzero])
			break;

	/* All zeros */
	if (last_nonzero < 0)
		return 0;

	/* Calculate wraparound period */
	for (period = 1; period < arrlen; period++)
		if (nand_id_has_period(id_data, arrlen, period))
			break;

	/* There's a repeated pattern */
	if (period < arrlen)
		return period;

	/* There are trailing zeros */
	if (last_nonzero < arrlen - 1)
		return last_nonzero + 1;

	/* No pattern detected */
	return arrlen;
}

2972 2973 2974 2975 2976 2977 2978 2979
/*
 * Many new NAND share similar device ID codes, which represent the size of the
 * chip. The rest of the parameters must be decoded according to generic or
 * manufacturer-specific "extended ID" decoding patterns.
 */
static void nand_decode_ext_id(struct mtd_info *mtd, struct nand_chip *chip,
				u8 id_data[8], int *busw)
{
2980
	int extid, id_len;
2981 2982 2983 2984 2985
	/* The 3rd id byte holds MLC / multichip data */
	chip->cellinfo = id_data[2];
	/* The 4th id byte is the important one */
	extid = id_data[3];

2986 2987
	id_len = nand_id_len(id_data, 8);

2988 2989 2990
	/*
	 * Field definitions are in the following datasheets:
	 * Old style (4,5 byte ID): Samsung K9GAG08U0M (p.32)
2991
	 * New Samsung (6 byte ID): Samsung K9GAG08U0F (p.44)
2992
	 * Hynix MLC   (6 byte ID): Hynix H27UBG8T2B (p.22)
2993
	 *
2994 2995
	 * Check for ID length, non-zero 6th byte, cell type, and Hynix/Samsung
	 * ID to decide what to do.
2996
	 */
2997
	if (id_len == 6 && id_data[0] == NAND_MFR_SAMSUNG &&
2998
			(chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
2999
			id_data[5] != 0x00) {
3000 3001 3002 3003
		/* Calc pagesize */
		mtd->writesize = 2048 << (extid & 0x03);
		extid >>= 2;
		/* Calc oobsize */
3004
		switch (((extid >> 2) & 0x04) | (extid & 0x03)) {
3005 3006 3007 3008 3009 3010 3011 3012 3013
		case 1:
			mtd->oobsize = 128;
			break;
		case 2:
			mtd->oobsize = 218;
			break;
		case 3:
			mtd->oobsize = 400;
			break;
3014
		case 4:
3015 3016
			mtd->oobsize = 436;
			break;
3017 3018 3019 3020 3021 3022 3023
		case 5:
			mtd->oobsize = 512;
			break;
		case 6:
		default: /* Other cases are "reserved" (unknown) */
			mtd->oobsize = 640;
			break;
3024 3025 3026 3027 3028 3029
		}
		extid >>= 2;
		/* Calc blocksize */
		mtd->erasesize = (128 * 1024) <<
			(((extid >> 1) & 0x04) | (extid & 0x03));
		*busw = 0;
3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070
	} else if (id_len == 6 && id_data[0] == NAND_MFR_HYNIX &&
			(chip->cellinfo & NAND_CI_CELLTYPE_MSK)) {
		unsigned int tmp;

		/* Calc pagesize */
		mtd->writesize = 2048 << (extid & 0x03);
		extid >>= 2;
		/* Calc oobsize */
		switch (((extid >> 2) & 0x04) | (extid & 0x03)) {
		case 0:
			mtd->oobsize = 128;
			break;
		case 1:
			mtd->oobsize = 224;
			break;
		case 2:
			mtd->oobsize = 448;
			break;
		case 3:
			mtd->oobsize = 64;
			break;
		case 4:
			mtd->oobsize = 32;
			break;
		case 5:
			mtd->oobsize = 16;
			break;
		default:
			mtd->oobsize = 640;
			break;
		}
		extid >>= 2;
		/* Calc blocksize */
		tmp = ((extid >> 1) & 0x04) | (extid & 0x03);
		if (tmp < 0x03)
			mtd->erasesize = (128 * 1024) << tmp;
		else if (tmp == 0x03)
			mtd->erasesize = 768 * 1024;
		else
			mtd->erasesize = (64 * 1024) << tmp;
		*busw = 0;
3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086
	} else {
		/* Calc pagesize */
		mtd->writesize = 1024 << (extid & 0x03);
		extid >>= 2;
		/* Calc oobsize */
		mtd->oobsize = (8 << (extid & 0x01)) *
			(mtd->writesize >> 9);
		extid >>= 2;
		/* Calc blocksize. Blocksize is multiples of 64KiB */
		mtd->erasesize = (64 * 1024) << (extid & 0x03);
		extid >>= 2;
		/* Get buswidth information */
		*busw = (extid & 0x01) ? NAND_BUSWIDTH_16 : 0;
	}
}

3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116
/*
 * Old devices have chip data hardcoded in the device ID table. nand_decode_id
 * decodes a matching ID table entry and assigns the MTD size parameters for
 * the chip.
 */
static void nand_decode_id(struct mtd_info *mtd, struct nand_chip *chip,
				struct nand_flash_dev *type, u8 id_data[8],
				int *busw)
{
	int maf_id = id_data[0];

	mtd->erasesize = type->erasesize;
	mtd->writesize = type->pagesize;
	mtd->oobsize = mtd->writesize / 32;
	*busw = type->options & NAND_BUSWIDTH_16;

	/*
	 * Check for Spansion/AMD ID + repeating 5th, 6th byte since
	 * some Spansion chips have erasesize that conflicts with size
	 * listed in nand_ids table.
	 * Data sheet (5 byte ID): Spansion S30ML-P ORNAND (p.39)
	 */
	if (maf_id == NAND_MFR_AMD && id_data[4] != 0x00 && id_data[5] == 0x00
			&& id_data[6] == 0x00 && id_data[7] == 0x00
			&& mtd->writesize == 512) {
		mtd->erasesize = 128 * 1024;
		mtd->erasesize <<= ((id_data[3] & 0x03) << 1);
	}
}

3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153
/*
 * Set the bad block marker/indicator (BBM/BBI) patterns according to some
 * heuristic patterns using various detected parameters (e.g., manufacturer,
 * page size, cell-type information).
 */
static void nand_decode_bbm_options(struct mtd_info *mtd,
				    struct nand_chip *chip, u8 id_data[8])
{
	int maf_id = id_data[0];

	/* Set the bad block position */
	if (mtd->writesize > 512 || (chip->options & NAND_BUSWIDTH_16))
		chip->badblockpos = NAND_LARGE_BADBLOCK_POS;
	else
		chip->badblockpos = NAND_SMALL_BADBLOCK_POS;

	/*
	 * Bad block marker is stored in the last page of each block on Samsung
	 * and Hynix MLC devices; stored in first two pages of each block on
	 * Micron devices with 2KiB pages and on SLC Samsung, Hynix, Toshiba,
	 * AMD/Spansion, and Macronix.  All others scan only the first page.
	 */
	if ((chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
			(maf_id == NAND_MFR_SAMSUNG ||
			 maf_id == NAND_MFR_HYNIX))
		chip->bbt_options |= NAND_BBT_SCANLASTPAGE;
	else if ((!(chip->cellinfo & NAND_CI_CELLTYPE_MSK) &&
				(maf_id == NAND_MFR_SAMSUNG ||
				 maf_id == NAND_MFR_HYNIX ||
				 maf_id == NAND_MFR_TOSHIBA ||
				 maf_id == NAND_MFR_AMD ||
				 maf_id == NAND_MFR_MACRONIX)) ||
			(mtd->writesize == 2048 &&
			 maf_id == NAND_MFR_MICRON))
		chip->bbt_options |= NAND_BBT_SCAN2NDPAGE;
}

3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177
static inline bool is_full_id_nand(struct nand_flash_dev *type)
{
	return type->id_len;
}

static bool find_full_id_nand(struct mtd_info *mtd, struct nand_chip *chip,
		   struct nand_flash_dev *type, u8 *id_data, int *busw)
{
	if (!strncmp(type->id, id_data, type->id_len)) {
		mtd->writesize = type->pagesize;
		mtd->erasesize = type->erasesize;
		mtd->oobsize = type->oobsize;

		chip->cellinfo = id_data[2];
		chip->chipsize = (uint64_t)type->chipsize << 20;
		chip->options |= type->options;

		*busw = type->options & NAND_BUSWIDTH_16;

		return true;
	}
	return false;
}

T
Thomas Gleixner 已提交
3178
/*
3179
 * Get the flash and manufacturer id and lookup if the type is supported.
T
Thomas Gleixner 已提交
3180 3181
 */
static struct nand_flash_dev *nand_get_flash_type(struct mtd_info *mtd,
3182
						  struct nand_chip *chip,
3183 3184
						  int busw,
						  int *maf_id, int *dev_id,
3185
						  struct nand_flash_dev *type)
T
Thomas Gleixner 已提交
3186
{
3187
	int i, maf_idx;
3188
	u8 id_data[8];
L
Linus Torvalds 已提交
3189 3190

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

3193 3194
	/*
	 * Reset the chip, required by some chips (e.g. Micron MT29FxGxxxxx)
3195
	 * after power-up.
3196 3197 3198
	 */
	chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);

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

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

3206 3207
	/*
	 * Try again to make sure, as some systems the bus-hold or other
3208 3209 3210 3211 3212 3213 3214
	 * 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);

3215 3216
	/* Read entire ID string */
	for (i = 0; i < 8; i++)
3217
		id_data[i] = chip->read_byte(mtd);
3218

3219
	if (id_data[0] != *maf_id || id_data[1] != *dev_id) {
3220
		pr_info("%s: second ID read did not match "
3221 3222
			"%02x,%02x against %02x,%02x\n", __func__,
			*maf_id, *dev_id, id_data[0], id_data[1]);
3223 3224 3225
		return ERR_PTR(-ENODEV);
	}

T
Thomas Gleixner 已提交
3226
	if (!type)
3227 3228
		type = nand_flash_ids;

3229 3230 3231 3232 3233 3234 3235 3236
	for (; type->name != NULL; type++) {
		if (is_full_id_nand(type)) {
			if (find_full_id_nand(mtd, chip, type, id_data, &busw))
				goto ident_done;
		} else if (*dev_id == type->dev_id) {
				break;
		}
	}
3237

3238 3239
	chip->onfi_version = 0;
	if (!type->name || !type->pagesize) {
3240
		/* Check is chip is ONFI compliant */
3241
		if (nand_flash_detect_onfi(mtd, chip, &busw))
3242
			goto ident_done;
3243 3244
	}

3245
	if (!type->name)
T
Thomas Gleixner 已提交
3246 3247
		return ERR_PTR(-ENODEV);

3248 3249 3250
	if (!mtd->name)
		mtd->name = type->name;

3251
	chip->chipsize = (uint64_t)type->chipsize << 20;
T
Thomas Gleixner 已提交
3252

3253
	if (!type->pagesize && chip->init_size) {
3254
		/* Set the pagesize, oobsize, erasesize by the driver */
3255 3256
		busw = chip->init_size(mtd, chip, id_data);
	} else if (!type->pagesize) {
3257 3258
		/* Decode parameters from extended ID */
		nand_decode_ext_id(mtd, chip, id_data, &busw);
T
Thomas Gleixner 已提交
3259
	} else {
3260
		nand_decode_id(mtd, chip, type, id_data, &busw);
T
Thomas Gleixner 已提交
3261
	}
3262 3263
	/* Get chip options */
	chip->options |= type->options;
3264

3265 3266 3267
	/*
	 * Check if chip is not a Samsung device. Do not clear the
	 * options for chips which do not have an extended id.
3268 3269 3270 3271 3272
	 */
	if (*maf_id != NAND_MFR_SAMSUNG && !type->pagesize)
		chip->options &= ~NAND_SAMSUNG_LP_OPTIONS;
ident_done:

T
Thomas Gleixner 已提交
3273
	/* Try to identify manufacturer */
3274
	for (maf_idx = 0; nand_manuf_ids[maf_idx].id != 0x0; maf_idx++) {
T
Thomas Gleixner 已提交
3275 3276 3277
		if (nand_manuf_ids[maf_idx].id == *maf_id)
			break;
	}
3278

3279 3280 3281 3282 3283 3284 3285 3286 3287
	if (chip->options & NAND_BUSWIDTH_AUTO) {
		WARN_ON(chip->options & NAND_BUSWIDTH_16);
		chip->options |= busw;
		nand_set_defaults(chip, busw);
	} else if (busw != (chip->options & NAND_BUSWIDTH_16)) {
		/*
		 * Check, if buswidth is correct. Hardware drivers should set
		 * chip correct!
		 */
3288
		pr_info("NAND device: Manufacturer ID:"
3289 3290
			" 0x%02x, Chip ID: 0x%02x (%s %s)\n", *maf_id,
			*dev_id, nand_manuf_ids[maf_idx].name, mtd->name);
3291
		pr_warn("NAND bus width %d instead %d bit\n",
3292 3293
			   (chip->options & NAND_BUSWIDTH_16) ? 16 : 8,
			   busw ? 16 : 8);
T
Thomas Gleixner 已提交
3294 3295
		return ERR_PTR(-EINVAL);
	}
3296

3297 3298
	nand_decode_bbm_options(mtd, chip, id_data);

T
Thomas Gleixner 已提交
3299
	/* Calculate the address shift from the page size */
3300
	chip->page_shift = ffs(mtd->writesize) - 1;
3301
	/* Convert chipsize to number of pages per chip -1 */
3302
	chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
3303

3304
	chip->bbt_erase_shift = chip->phys_erase_shift =
T
Thomas Gleixner 已提交
3305
		ffs(mtd->erasesize) - 1;
3306 3307
	if (chip->chipsize & 0xffffffff)
		chip->chip_shift = ffs((unsigned)chip->chipsize) - 1;
3308 3309 3310 3311
	else {
		chip->chip_shift = ffs((unsigned)(chip->chipsize >> 32));
		chip->chip_shift += 32 - 1;
	}
L
Linus Torvalds 已提交
3312

A
Artem Bityutskiy 已提交
3313
	chip->badblockbits = 8;
3314
	chip->erase_cmd = single_erase_cmd;
T
Thomas Gleixner 已提交
3315

3316
	/* Do not replace user supplied command function! */
3317 3318
	if (mtd->writesize > 512 && chip->cmdfunc == nand_command)
		chip->cmdfunc = nand_command_lp;
T
Thomas Gleixner 已提交
3319

3320
	pr_info("NAND device: Manufacturer ID: 0x%02x, Chip ID: 0x%02x (%s %s),"
3321
		" %dMiB, page size: %d, OOB size: %d\n",
3322 3323
		*maf_id, *dev_id, nand_manuf_ids[maf_idx].name,
		chip->onfi_version ? chip->onfi_params.model : type->name,
3324
		(int)(chip->chipsize >> 20), mtd->writesize, mtd->oobsize);
T
Thomas Gleixner 已提交
3325 3326 3327 3328 3329

	return type;
}

/**
3330
 * nand_scan_ident - [NAND Interface] Scan for the NAND device
3331 3332 3333
 * @mtd: MTD device structure
 * @maxchips: number of chips to scan for
 * @table: alternative NAND ID table
T
Thomas Gleixner 已提交
3334
 *
3335 3336
 * 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 已提交
3337
 *
3338
 * The mtd->owner field must be set to the module of the caller.
T
Thomas Gleixner 已提交
3339
 */
3340 3341
int nand_scan_ident(struct mtd_info *mtd, int maxchips,
		    struct nand_flash_dev *table)
T
Thomas Gleixner 已提交
3342
{
3343
	int i, busw, nand_maf_id, nand_dev_id;
3344
	struct nand_chip *chip = mtd->priv;
T
Thomas Gleixner 已提交
3345 3346 3347
	struct nand_flash_dev *type;

	/* Get buswidth to select the correct functions */
3348
	busw = chip->options & NAND_BUSWIDTH_16;
T
Thomas Gleixner 已提交
3349
	/* Set the default functions */
3350
	nand_set_defaults(chip, busw);
T
Thomas Gleixner 已提交
3351 3352

	/* Read the flash type */
3353 3354
	type = nand_get_flash_type(mtd, chip, busw,
				&nand_maf_id, &nand_dev_id, table);
T
Thomas Gleixner 已提交
3355 3356

	if (IS_ERR(type)) {
3357
		if (!(chip->options & NAND_SCAN_SILENT_NODEV))
3358
			pr_warn("No NAND device found\n");
3359
		chip->select_chip(mtd, -1);
T
Thomas Gleixner 已提交
3360
		return PTR_ERR(type);
L
Linus Torvalds 已提交
3361 3362
	}

3363 3364
	chip->select_chip(mtd, -1);

T
Thomas Gleixner 已提交
3365
	/* Check for a chip array */
3366
	for (i = 1; i < maxchips; i++) {
3367
		chip->select_chip(mtd, i);
3368 3369
		/* See comment in nand_get_flash_type for reset */
		chip->cmdfunc(mtd, NAND_CMD_RESET, -1, -1);
L
Linus Torvalds 已提交
3370
		/* Send the command for reading device ID */
3371
		chip->cmdfunc(mtd, NAND_CMD_READID, 0x00, -1);
L
Linus Torvalds 已提交
3372
		/* Read manufacturer and device IDs */
3373
		if (nand_maf_id != chip->read_byte(mtd) ||
3374 3375
		    nand_dev_id != chip->read_byte(mtd)) {
			chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
3376
			break;
3377 3378
		}
		chip->select_chip(mtd, -1);
L
Linus Torvalds 已提交
3379 3380
	}
	if (i > 1)
3381
		pr_info("%d NAND chips detected\n", i);
3382

L
Linus Torvalds 已提交
3383
	/* Store the number of chips and calc total size for mtd */
3384 3385
	chip->numchips = i;
	mtd->size = i * chip->chipsize;
T
Thomas Gleixner 已提交
3386

3387 3388
	return 0;
}
3389
EXPORT_SYMBOL(nand_scan_ident);
3390 3391 3392 3393


/**
 * nand_scan_tail - [NAND Interface] Scan for the NAND device
3394
 * @mtd: MTD device structure
3395
 *
3396 3397 3398
 * 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.
3399 3400 3401 3402 3403 3404
 */
int nand_scan_tail(struct mtd_info *mtd)
{
	int i;
	struct nand_chip *chip = mtd->priv;

3405 3406 3407 3408
	/* New bad blocks should be marked in OOB, flash-based BBT, or both */
	BUG_ON((chip->bbt_options & NAND_BBT_NO_OOB_BBM) &&
			!(chip->bbt_options & NAND_BBT_USE_FLASH));

3409 3410 3411 3412 3413
	if (!(chip->options & NAND_OWN_BUFFERS))
		chip->buffers = kmalloc(sizeof(*chip->buffers), GFP_KERNEL);
	if (!chip->buffers)
		return -ENOMEM;

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

T
Thomas Gleixner 已提交
3417
	/*
3418
	 * If no default placement scheme is given, select an appropriate one.
T
Thomas Gleixner 已提交
3419
	 */
3420
	if (!chip->ecc.layout && (chip->ecc.mode != NAND_ECC_SOFT_BCH)) {
3421
		switch (mtd->oobsize) {
L
Linus Torvalds 已提交
3422
		case 8:
3423
			chip->ecc.layout = &nand_oob_8;
L
Linus Torvalds 已提交
3424 3425
			break;
		case 16:
3426
			chip->ecc.layout = &nand_oob_16;
L
Linus Torvalds 已提交
3427 3428
			break;
		case 64:
3429
			chip->ecc.layout = &nand_oob_64;
L
Linus Torvalds 已提交
3430
			break;
3431 3432 3433
		case 128:
			chip->ecc.layout = &nand_oob_128;
			break;
L
Linus Torvalds 已提交
3434
		default:
3435 3436
			pr_warn("No oob scheme defined for oobsize %d\n",
				   mtd->oobsize);
L
Linus Torvalds 已提交
3437 3438 3439
			BUG();
		}
	}
3440

3441 3442 3443
	if (!chip->write_page)
		chip->write_page = nand_write_page;

3444 3445 3446 3447 3448 3449
	/* set for ONFI nand */
	if (!chip->onfi_set_features)
		chip->onfi_set_features = nand_onfi_set_features;
	if (!chip->onfi_get_features)
		chip->onfi_get_features = nand_onfi_get_features;

3450
	/*
3451
	 * Check ECC mode, default to software if 3byte/512byte hardware ECC is
T
Thomas Gleixner 已提交
3452
	 * selected and we have 256 byte pagesize fallback to software ECC
3453
	 */
3454

3455
	switch (chip->ecc.mode) {
3456 3457 3458 3459
	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) {
3460
			pr_warn("No ECC functions supplied; "
3461
				   "hardware ECC not possible\n");
3462 3463 3464 3465 3466
			BUG();
		}
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_hwecc_oob_first;

T
Thomas Gleixner 已提交
3467
	case NAND_ECC_HW:
3468
		/* Use standard hwecc read page function? */
3469 3470
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_hwecc;
3471 3472
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_hwecc;
3473 3474 3475 3476
		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;
3477 3478 3479 3480
		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;
3481 3482 3483 3484
		if (!chip->ecc.read_subpage)
			chip->ecc.read_subpage = nand_read_subpage;
		if (!chip->ecc.write_subpage)
			chip->ecc.write_subpage = nand_write_subpage_hwecc;
3485

T
Thomas Gleixner 已提交
3486
	case NAND_ECC_HW_SYNDROME:
3487 3488 3489
		if ((!chip->ecc.calculate || !chip->ecc.correct ||
		     !chip->ecc.hwctl) &&
		    (!chip->ecc.read_page ||
3490
		     chip->ecc.read_page == nand_read_page_hwecc ||
3491
		     !chip->ecc.write_page ||
3492
		     chip->ecc.write_page == nand_write_page_hwecc)) {
3493
			pr_warn("No ECC functions supplied; "
3494
				   "hardware ECC not possible\n");
T
Thomas Gleixner 已提交
3495 3496
			BUG();
		}
3497
		/* Use standard syndrome read/write page function? */
3498 3499
		if (!chip->ecc.read_page)
			chip->ecc.read_page = nand_read_page_syndrome;
3500 3501
		if (!chip->ecc.write_page)
			chip->ecc.write_page = nand_write_page_syndrome;
3502 3503 3504 3505
		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;
3506 3507 3508 3509
		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;
3510

3511 3512 3513 3514 3515
		if (mtd->writesize >= chip->ecc.size) {
			if (!chip->ecc.strength) {
				pr_warn("Driver must set ecc.strength when using hardware ECC\n");
				BUG();
			}
T
Thomas Gleixner 已提交
3516
			break;
3517
		}
3518
		pr_warn("%d byte HW ECC not possible on "
3519 3520
			   "%d byte page size, fallback to SW ECC\n",
			   chip->ecc.size, mtd->writesize);
3521
		chip->ecc.mode = NAND_ECC_SOFT;
3522

T
Thomas Gleixner 已提交
3523
	case NAND_ECC_SOFT:
3524 3525
		chip->ecc.calculate = nand_calculate_ecc;
		chip->ecc.correct = nand_correct_data;
3526
		chip->ecc.read_page = nand_read_page_swecc;
3527
		chip->ecc.read_subpage = nand_read_subpage;
3528
		chip->ecc.write_page = nand_write_page_swecc;
3529 3530
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
3531 3532
		chip->ecc.read_oob = nand_read_oob_std;
		chip->ecc.write_oob = nand_write_oob_std;
3533 3534
		if (!chip->ecc.size)
			chip->ecc.size = 256;
3535
		chip->ecc.bytes = 3;
M
Mike Dunn 已提交
3536
		chip->ecc.strength = 1;
L
Linus Torvalds 已提交
3537
		break;
3538

3539 3540
	case NAND_ECC_SOFT_BCH:
		if (!mtd_nand_has_bch()) {
3541
			pr_warn("CONFIG_MTD_ECC_BCH not enabled\n");
3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555
			BUG();
		}
		chip->ecc.calculate = nand_bch_calculate_ecc;
		chip->ecc.correct = nand_bch_correct_data;
		chip->ecc.read_page = nand_read_page_swecc;
		chip->ecc.read_subpage = nand_read_subpage;
		chip->ecc.write_page = nand_write_page_swecc;
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
		chip->ecc.read_oob = nand_read_oob_std;
		chip->ecc.write_oob = nand_write_oob_std;
		/*
		 * Board driver should supply ecc.size and ecc.bytes values to
		 * select how many bits are correctable; see nand_bch_init()
3556 3557
		 * for details. Otherwise, default to 4 bits for large page
		 * devices.
3558 3559 3560 3561 3562 3563 3564 3565 3566 3567
		 */
		if (!chip->ecc.size && (mtd->oobsize >= 64)) {
			chip->ecc.size = 512;
			chip->ecc.bytes = 7;
		}
		chip->ecc.priv = nand_bch_init(mtd,
					       chip->ecc.size,
					       chip->ecc.bytes,
					       &chip->ecc.layout);
		if (!chip->ecc.priv) {
3568
			pr_warn("BCH ECC initialization failed!\n");
3569 3570
			BUG();
		}
M
Mike Dunn 已提交
3571
		chip->ecc.strength =
3572
			chip->ecc.bytes * 8 / fls(8 * chip->ecc.size);
3573 3574
		break;

3575
	case NAND_ECC_NONE:
3576
		pr_warn("NAND_ECC_NONE selected by board driver. "
3577
			   "This is not recommended!\n");
3578 3579
		chip->ecc.read_page = nand_read_page_raw;
		chip->ecc.write_page = nand_write_page_raw;
3580
		chip->ecc.read_oob = nand_read_oob_std;
3581 3582
		chip->ecc.read_page_raw = nand_read_page_raw;
		chip->ecc.write_page_raw = nand_write_page_raw;
3583
		chip->ecc.write_oob = nand_write_oob_std;
3584 3585
		chip->ecc.size = mtd->writesize;
		chip->ecc.bytes = 0;
M
Mike Dunn 已提交
3586
		chip->ecc.strength = 0;
L
Linus Torvalds 已提交
3587
		break;
3588

L
Linus Torvalds 已提交
3589
	default:
3590
		pr_warn("Invalid NAND_ECC_MODE %d\n", chip->ecc.mode);
3591
		BUG();
L
Linus Torvalds 已提交
3592
	}
3593

3594
	/* For many systems, the standard OOB write also works for raw */
3595 3596
	if (!chip->ecc.read_oob_raw)
		chip->ecc.read_oob_raw = chip->ecc.read_oob;
3597 3598 3599
	if (!chip->ecc.write_oob_raw)
		chip->ecc.write_oob_raw = chip->ecc.write_oob;

3600 3601
	/*
	 * The number of bytes available for a client to place data into
3602
	 * the out of band area.
3603 3604
	 */
	chip->ecc.layout->oobavail = 0;
3605 3606
	for (i = 0; chip->ecc.layout->oobfree[i].length
			&& i < ARRAY_SIZE(chip->ecc.layout->oobfree); i++)
3607 3608
		chip->ecc.layout->oobavail +=
			chip->ecc.layout->oobfree[i].length;
V
Vitaly Wool 已提交
3609
	mtd->oobavail = chip->ecc.layout->oobavail;
3610

T
Thomas Gleixner 已提交
3611 3612
	/*
	 * Set the number of read / write steps for one page depending on ECC
3613
	 * mode.
T
Thomas Gleixner 已提交
3614
	 */
3615
	chip->ecc.steps = mtd->writesize / chip->ecc.size;
3616
	if (chip->ecc.steps * chip->ecc.size != mtd->writesize) {
3617
		pr_warn("Invalid ECC parameters\n");
T
Thomas Gleixner 已提交
3618
		BUG();
L
Linus Torvalds 已提交
3619
	}
3620
	chip->ecc.total = chip->ecc.steps * chip->ecc.bytes;
3621

3622
	/* Allow subpage writes up to ecc.steps. Not possible for MLC flash */
3623 3624
	if (!(chip->options & NAND_NO_SUBPAGE_WRITE) &&
	    !(chip->cellinfo & NAND_CI_CELLTYPE_MSK)) {
3625
		switch (chip->ecc.steps) {
3626 3627 3628 3629 3630
		case 2:
			mtd->subpage_sft = 1;
			break;
		case 4:
		case 8:
3631
		case 16:
3632 3633 3634 3635 3636 3637
			mtd->subpage_sft = 2;
			break;
		}
	}
	chip->subpagesize = mtd->writesize >> mtd->subpage_sft;

3638
	/* Initialize state */
3639
	chip->state = FL_READY;
L
Linus Torvalds 已提交
3640 3641

	/* Invalidate the pagebuffer reference */
3642
	chip->pagebuf = -1;
L
Linus Torvalds 已提交
3643

3644 3645 3646 3647
	/* Large page NAND with SOFT_ECC should support subpage reads */
	if ((chip->ecc.mode == NAND_ECC_SOFT) && (chip->page_shift > 9))
		chip->options |= NAND_SUBPAGE_READ;

L
Linus Torvalds 已提交
3648 3649
	/* Fill in remaining MTD driver data */
	mtd->type = MTD_NANDFLASH;
3650 3651
	mtd->flags = (chip->options & NAND_ROM) ? MTD_CAP_ROM :
						MTD_CAP_NANDFLASH;
3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666
	mtd->_erase = nand_erase;
	mtd->_point = NULL;
	mtd->_unpoint = NULL;
	mtd->_read = nand_read;
	mtd->_write = nand_write;
	mtd->_panic_write = panic_nand_write;
	mtd->_read_oob = nand_read_oob;
	mtd->_write_oob = nand_write_oob;
	mtd->_sync = nand_sync;
	mtd->_lock = NULL;
	mtd->_unlock = NULL;
	mtd->_suspend = nand_suspend;
	mtd->_resume = nand_resume;
	mtd->_block_isbad = nand_block_isbad;
	mtd->_block_markbad = nand_block_markbad;
3667
	mtd->writebufsize = mtd->writesize;
L
Linus Torvalds 已提交
3668

M
Mike Dunn 已提交
3669
	/* propagate ecc info to mtd_info */
3670
	mtd->ecclayout = chip->ecc.layout;
3671
	mtd->ecc_strength = chip->ecc.strength;
3672 3673 3674 3675 3676 3677 3678
	/*
	 * Initialize bitflip_threshold to its default prior scan_bbt() call.
	 * scan_bbt() might invoke mtd_read(), thus bitflip_threshold must be
	 * properly set.
	 */
	if (!mtd->bitflip_threshold)
		mtd->bitflip_threshold = mtd->ecc_strength;
L
Linus Torvalds 已提交
3679

3680
	/* Check, if we should skip the bad block table scan */
3681
	if (chip->options & NAND_SKIP_BBTSCAN)
3682
		return 0;
L
Linus Torvalds 已提交
3683 3684

	/* Build bad block table */
3685
	return chip->scan_bbt(mtd);
L
Linus Torvalds 已提交
3686
}
3687
EXPORT_SYMBOL(nand_scan_tail);
L
Linus Torvalds 已提交
3688

3689 3690
/*
 * is_module_text_address() isn't exported, and it's mostly a pointless
3691
 * test if this is a module _anyway_ -- they'd have to try _really_ hard
3692 3693
 * to call us from in-kernel code if the core NAND support is modular.
 */
3694 3695 3696 3697
#ifdef MODULE
#define caller_is_module() (1)
#else
#define caller_is_module() \
3698
	is_module_text_address((unsigned long)__builtin_return_address(0))
3699 3700 3701 3702
#endif

/**
 * nand_scan - [NAND Interface] Scan for the NAND device
3703 3704
 * @mtd: MTD device structure
 * @maxchips: number of chips to scan for
3705
 *
3706 3707 3708 3709
 * 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.
3710 3711 3712 3713 3714 3715 3716
 */
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()) {
3717
		pr_crit("%s called with NULL mtd->owner!\n", __func__);
3718 3719 3720
		BUG();
	}

3721
	ret = nand_scan_ident(mtd, maxchips, NULL);
3722 3723 3724 3725
	if (!ret)
		ret = nand_scan_tail(mtd);
	return ret;
}
3726
EXPORT_SYMBOL(nand_scan);
3727

L
Linus Torvalds 已提交
3728
/**
3729
 * nand_release - [NAND Interface] Free resources held by the NAND device
3730 3731
 * @mtd: MTD device structure
 */
3732
void nand_release(struct mtd_info *mtd)
L
Linus Torvalds 已提交
3733
{
3734
	struct nand_chip *chip = mtd->priv;
L
Linus Torvalds 已提交
3735

3736 3737 3738
	if (chip->ecc.mode == NAND_ECC_SOFT_BCH)
		nand_bch_free((struct nand_bch_control *)chip->ecc.priv);

3739
	mtd_device_unregister(mtd);
L
Linus Torvalds 已提交
3740

J
Jesper Juhl 已提交
3741
	/* Free bad block table memory */
3742
	kfree(chip->bbt);
3743 3744
	if (!(chip->options & NAND_OWN_BUFFERS))
		kfree(chip->buffers);
3745 3746 3747 3748 3749

	/* Free bad block descriptor memory */
	if (chip->badblock_pattern && chip->badblock_pattern->options
			& NAND_BBT_DYNAMICSTRUCT)
		kfree(chip->badblock_pattern);
L
Linus Torvalds 已提交
3750
}
3751
EXPORT_SYMBOL_GPL(nand_release);
3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766

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

3767
MODULE_LICENSE("GPL");
3768 3769
MODULE_AUTHOR("Steven J. Hill <sjhill@realitydiluted.com>");
MODULE_AUTHOR("Thomas Gleixner <tglx@linutronix.de>");
3770
MODULE_DESCRIPTION("Generic NAND flash driver code");