atmel_nand.c 20.6 KB
Newer Older
A
Andrew Victor 已提交
1 2 3 4 5 6 7 8 9
/*
 *  Copyright (C) 2003 Rick Bronson
 *
 *  Derived from drivers/mtd/nand/autcpu12.c
 *	 Copyright (c) 2001 Thomas Gleixner (gleixner@autronix.de)
 *
 *  Derived from drivers/mtd/spia.c
 *	 Copyright (C) 2000 Steven J. Hill (sjhill@cotw.com)
 *
10 11 12 13 14 15 16 17 18
 *
 *  Add Hardware ECC support for AT91SAM9260 / AT91SAM9263
 *     Richard Genoud (richard.genoud@gmail.com), Adeneo Copyright (C) 2007
 *
 *     Derived from Das U-Boot source code
 *     		(u-boot-1.1.5/board/atmel/at91sam9263ek/nand.c)
 *     (C) Copyright 2006 ATMEL Rousset, Lacressonniere Nicolas
 *
 *
A
Andrew Victor 已提交
19 20 21 22 23 24
 * 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.
 *
 */

25
#include <linux/dma-mapping.h>
A
Andrew Victor 已提交
26 27
#include <linux/slab.h>
#include <linux/module.h>
28
#include <linux/moduleparam.h>
A
Andrew Victor 已提交
29
#include <linux/platform_device.h>
30 31 32 33
#include <linux/of.h>
#include <linux/of_device.h>
#include <linux/of_gpio.h>
#include <linux/of_mtd.h>
A
Andrew Victor 已提交
34 35 36 37
#include <linux/mtd/mtd.h>
#include <linux/mtd/nand.h>
#include <linux/mtd/partitions.h>

38
#include <linux/dmaengine.h>
39 40
#include <linux/gpio.h>
#include <linux/io.h>
41
#include <linux/platform_data/atmel.h>
A
Andrew Victor 已提交
42

43
#include <mach/cpu.h>
A
Andrew Victor 已提交
44

45 46 47
static int use_dma = 1;
module_param(use_dma, int, 0);

48 49 50
static int on_flash_bbt = 0;
module_param(on_flash_bbt, int, 0);

51 52
/* Register access macros */
#define ecc_readl(add, reg)				\
53
	__raw_readl(add + ATMEL_ECC_##reg)
54
#define ecc_writel(add, reg, value)			\
55
	__raw_writel((value), add + ATMEL_ECC_##reg)
56

57
#include "atmel_nand_ecc.h"	/* Hardware ECC registers */
58 59 60 61 62 63

/* oob layout for large page size
 * bad block info is on bytes 0 and 1
 * the bytes have to be consecutives to avoid
 * several NAND_CMD_RNDOUT during read
 */
64
static struct nand_ecclayout atmel_oobinfo_large = {
65 66 67 68 69 70 71 72 73 74 75 76
	.eccbytes = 4,
	.eccpos = {60, 61, 62, 63},
	.oobfree = {
		{2, 58}
	},
};

/* oob layout for small page size
 * bad block info is on bytes 4 and 5
 * the bytes have to be consecutives to avoid
 * several NAND_CMD_RNDOUT during read
 */
77
static struct nand_ecclayout atmel_oobinfo_small = {
78 79 80 81 82 83 84
	.eccbytes = 4,
	.eccpos = {0, 1, 2, 3},
	.oobfree = {
		{6, 10}
	},
};

85
struct atmel_nand_host {
A
Andrew Victor 已提交
86 87 88
	struct nand_chip	nand_chip;
	struct mtd_info		mtd;
	void __iomem		*io_base;
89
	dma_addr_t		io_phys;
90
	struct atmel_nand_data	board;
91 92
	struct device		*dev;
	void __iomem		*ecc;
93 94 95

	struct completion	comp;
	struct dma_chan		*dma_chan;
96 97 98 99 100

	bool			has_pmecc;
	u8			pmecc_corr_cap;
	u16			pmecc_sector_size;
	u32			pmecc_lookup_table_offset;
A
Andrew Victor 已提交
101 102
};

103 104 105 106 107
static int cpu_has_dma(void)
{
	return cpu_is_at91sam9rl() || cpu_is_at91sam9g45();
}

108 109 110
/*
 * Enable NAND.
 */
111
static void atmel_nand_enable(struct atmel_nand_host *host)
112
{
113 114
	if (gpio_is_valid(host->board.enable_pin))
		gpio_set_value(host->board.enable_pin, 0);
115 116 117 118 119
}

/*
 * Disable NAND.
 */
120
static void atmel_nand_disable(struct atmel_nand_host *host)
121
{
122 123
	if (gpio_is_valid(host->board.enable_pin))
		gpio_set_value(host->board.enable_pin, 1);
124 125
}

A
Andrew Victor 已提交
126 127 128
/*
 * Hardware specific access to control-lines
 */
129
static void atmel_nand_cmd_ctrl(struct mtd_info *mtd, int cmd, unsigned int ctrl)
A
Andrew Victor 已提交
130 131
{
	struct nand_chip *nand_chip = mtd->priv;
132
	struct atmel_nand_host *host = nand_chip->priv;
A
Andrew Victor 已提交
133

134
	if (ctrl & NAND_CTRL_CHANGE) {
135
		if (ctrl & NAND_NCE)
136
			atmel_nand_enable(host);
137
		else
138
			atmel_nand_disable(host);
139
	}
A
Andrew Victor 已提交
140 141 142 143
	if (cmd == NAND_CMD_NONE)
		return;

	if (ctrl & NAND_CLE)
144
		writeb(cmd, host->io_base + (1 << host->board.cle));
A
Andrew Victor 已提交
145
	else
146
		writeb(cmd, host->io_base + (1 << host->board.ale));
A
Andrew Victor 已提交
147 148 149 150 151
}

/*
 * Read the Device Ready pin.
 */
152
static int atmel_nand_device_ready(struct mtd_info *mtd)
A
Andrew Victor 已提交
153 154
{
	struct nand_chip *nand_chip = mtd->priv;
155
	struct atmel_nand_host *host = nand_chip->priv;
A
Andrew Victor 已提交
156

157 158
	return gpio_get_value(host->board.rdy_pin) ^
                !!host->board.rdy_pin_active_low;
A
Andrew Victor 已提交
159 160
}

161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
/*
 * Minimal-overhead PIO for data access.
 */
static void atmel_read_buf8(struct mtd_info *mtd, u8 *buf, int len)
{
	struct nand_chip	*nand_chip = mtd->priv;

	__raw_readsb(nand_chip->IO_ADDR_R, buf, len);
}

static void atmel_read_buf16(struct mtd_info *mtd, u8 *buf, int len)
{
	struct nand_chip	*nand_chip = mtd->priv;

	__raw_readsw(nand_chip->IO_ADDR_R, buf, len / 2);
}

static void atmel_write_buf8(struct mtd_info *mtd, const u8 *buf, int len)
{
	struct nand_chip	*nand_chip = mtd->priv;

	__raw_writesb(nand_chip->IO_ADDR_W, buf, len);
}

static void atmel_write_buf16(struct mtd_info *mtd, const u8 *buf, int len)
{
	struct nand_chip	*nand_chip = mtd->priv;

	__raw_writesw(nand_chip->IO_ADDR_W, buf, len / 2);
}

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
static void dma_complete_func(void *completion)
{
	complete(completion);
}

static int atmel_nand_dma_op(struct mtd_info *mtd, void *buf, int len,
			       int is_read)
{
	struct dma_device *dma_dev;
	enum dma_ctrl_flags flags;
	dma_addr_t dma_src_addr, dma_dst_addr, phys_addr;
	struct dma_async_tx_descriptor *tx = NULL;
	dma_cookie_t cookie;
	struct nand_chip *chip = mtd->priv;
	struct atmel_nand_host *host = chip->priv;
	void *p = buf;
	int err = -EIO;
	enum dma_data_direction dir = is_read ? DMA_FROM_DEVICE : DMA_TO_DEVICE;

211 212
	if (buf >= high_memory)
		goto err_buf;
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265

	dma_dev = host->dma_chan->device;

	flags = DMA_CTRL_ACK | DMA_PREP_INTERRUPT | DMA_COMPL_SKIP_SRC_UNMAP |
		DMA_COMPL_SKIP_DEST_UNMAP;

	phys_addr = dma_map_single(dma_dev->dev, p, len, dir);
	if (dma_mapping_error(dma_dev->dev, phys_addr)) {
		dev_err(host->dev, "Failed to dma_map_single\n");
		goto err_buf;
	}

	if (is_read) {
		dma_src_addr = host->io_phys;
		dma_dst_addr = phys_addr;
	} else {
		dma_src_addr = phys_addr;
		dma_dst_addr = host->io_phys;
	}

	tx = dma_dev->device_prep_dma_memcpy(host->dma_chan, dma_dst_addr,
					     dma_src_addr, len, flags);
	if (!tx) {
		dev_err(host->dev, "Failed to prepare DMA memcpy\n");
		goto err_dma;
	}

	init_completion(&host->comp);
	tx->callback = dma_complete_func;
	tx->callback_param = &host->comp;

	cookie = tx->tx_submit(tx);
	if (dma_submit_error(cookie)) {
		dev_err(host->dev, "Failed to do DMA tx_submit\n");
		goto err_dma;
	}

	dma_async_issue_pending(host->dma_chan);
	wait_for_completion(&host->comp);

	err = 0;

err_dma:
	dma_unmap_single(dma_dev->dev, phys_addr, len, dir);
err_buf:
	if (err != 0)
		dev_warn(host->dev, "Fall back to CPU I/O\n");
	return err;
}

static void atmel_read_buf(struct mtd_info *mtd, u8 *buf, int len)
{
	struct nand_chip *chip = mtd->priv;
266
	struct atmel_nand_host *host = chip->priv;
267

268 269
	if (use_dma && len > mtd->oobsize)
		/* only use DMA for bigger than oob size: better performances */
270 271 272
		if (atmel_nand_dma_op(mtd, buf, len, 1) == 0)
			return;

273
	if (host->board.bus_width_16)
274 275 276
		atmel_read_buf16(mtd, buf, len);
	else
		atmel_read_buf8(mtd, buf, len);
277 278 279 280 281
}

static void atmel_write_buf(struct mtd_info *mtd, const u8 *buf, int len)
{
	struct nand_chip *chip = mtd->priv;
282
	struct atmel_nand_host *host = chip->priv;
283

284 285
	if (use_dma && len > mtd->oobsize)
		/* only use DMA for bigger than oob size: better performances */
286 287 288
		if (atmel_nand_dma_op(mtd, (void *)buf, len, 0) == 0)
			return;

289
	if (host->board.bus_width_16)
290 291 292
		atmel_write_buf16(mtd, buf, len);
	else
		atmel_write_buf8(mtd, buf, len);
293 294
}

295 296 297 298 299 300 301 302 303
/*
 * Calculate HW ECC
 *
 * function called after a write
 *
 * mtd:        MTD block structure
 * dat:        raw data (unused)
 * ecc_code:   buffer for ECC
 */
304
static int atmel_nand_calculate(struct mtd_info *mtd,
305 306 307
		const u_char *dat, unsigned char *ecc_code)
{
	struct nand_chip *nand_chip = mtd->priv;
308
	struct atmel_nand_host *host = nand_chip->priv;
309 310 311
	unsigned int ecc_value;

	/* get the first 2 ECC bytes */
312
	ecc_value = ecc_readl(host->ecc, PR);
313

314 315
	ecc_code[0] = ecc_value & 0xFF;
	ecc_code[1] = (ecc_value >> 8) & 0xFF;
316 317

	/* get the last 2 ECC bytes */
318
	ecc_value = ecc_readl(host->ecc, NPR) & ATMEL_ECC_NPARITY;
319

320 321
	ecc_code[2] = ecc_value & 0xFF;
	ecc_code[3] = (ecc_value >> 8) & 0xFF;
322 323 324 325 326 327 328 329 330 331

	return 0;
}

/*
 * HW ECC read page function
 *
 * mtd:        mtd info structure
 * chip:       nand chip info structure
 * buf:        buffer to store read data
332
 * oob_required:    caller expects OOB data read to chip->oob_poi
333
 */
334 335
static int atmel_nand_read_page(struct mtd_info *mtd, struct nand_chip *chip,
				uint8_t *buf, int oob_required, int page)
336 337 338 339 340 341 342 343
{
	int eccsize = chip->ecc.size;
	int eccbytes = chip->ecc.bytes;
	uint32_t *eccpos = chip->ecc.layout->eccpos;
	uint8_t *p = buf;
	uint8_t *oob = chip->oob_poi;
	uint8_t *ecc_pos;
	int stat;
344
	unsigned int max_bitflips = 0;
345

346 347 348 349 350 351 352 353 354 355 356 357 358
	/*
	 * Errata: ALE is incorrectly wired up to the ECC controller
	 * on the AP7000, so it will include the address cycles in the
	 * ECC calculation.
	 *
	 * Workaround: Reset the parity registers before reading the
	 * actual data.
	 */
	if (cpu_is_at32ap7000()) {
		struct atmel_nand_host *host = chip->priv;
		ecc_writel(host->ecc, CR, ATMEL_ECC_RST);
	}

359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
	/* read the page */
	chip->read_buf(mtd, p, eccsize);

	/* move to ECC position if needed */
	if (eccpos[0] != 0) {
		/* This only works on large pages
		 * because the ECC controller waits for
		 * NAND_CMD_RNDOUTSTART after the
		 * NAND_CMD_RNDOUT.
		 * anyway, for small pages, the eccpos[0] == 0
		 */
		chip->cmdfunc(mtd, NAND_CMD_RNDOUT,
				mtd->writesize + eccpos[0], -1);
	}

	/* the ECC controller needs to read the ECC just after the data */
	ecc_pos = oob + eccpos[0];
	chip->read_buf(mtd, ecc_pos, eccbytes);

	/* check if there's an error */
	stat = chip->ecc.correct(mtd, p, oob, NULL);

381
	if (stat < 0) {
382
		mtd->ecc_stats.failed++;
383
	} else {
384
		mtd->ecc_stats.corrected += stat;
385 386
		max_bitflips = max_t(unsigned int, max_bitflips, stat);
	}
387 388 389 390 391 392 393

	/* get back to oob start (end of page) */
	chip->cmdfunc(mtd, NAND_CMD_RNDOUT, mtd->writesize, -1);

	/* read the oob */
	chip->read_buf(mtd, oob, mtd->oobsize);

394
	return max_bitflips;
395 396 397 398 399 400 401 402 403 404 405 406 407 408
}

/*
 * HW ECC Correction
 *
 * function called after a read
 *
 * mtd:        MTD block structure
 * dat:        raw data read from the chip
 * read_ecc:   ECC from the chip (unused)
 * isnull:     unused
 *
 * Detect and correct a 1 bit error for a page
 */
409
static int atmel_nand_correct(struct mtd_info *mtd, u_char *dat,
410 411 412
		u_char *read_ecc, u_char *isnull)
{
	struct nand_chip *nand_chip = mtd->priv;
413
	struct atmel_nand_host *host = nand_chip->priv;
414 415 416 417 418 419 420
	unsigned int ecc_status;
	unsigned int ecc_word, ecc_bit;

	/* get the status from the Status Register */
	ecc_status = ecc_readl(host->ecc, SR);

	/* if there's no error */
421
	if (likely(!(ecc_status & ATMEL_ECC_RECERR)))
422 423 424
		return 0;

	/* get error bit offset (4 bits) */
425
	ecc_bit = ecc_readl(host->ecc, PR) & ATMEL_ECC_BITADDR;
426
	/* get word address (12 bits) */
427
	ecc_word = ecc_readl(host->ecc, PR) & ATMEL_ECC_WORDADDR;
428 429 430
	ecc_word >>= 4;

	/* if there are multiple errors */
431
	if (ecc_status & ATMEL_ECC_MULERR) {
432 433
		/* check if it is a freshly erased block
		 * (filled with 0xff) */
434 435
		if ((ecc_bit == ATMEL_ECC_BITADDR)
				&& (ecc_word == (ATMEL_ECC_WORDADDR >> 4))) {
436 437 438 439 440 441
			/* the block has just been erased, return OK */
			return 0;
		}
		/* it doesn't seems to be a freshly
		 * erased block.
		 * We can't correct so many errors */
442
		dev_dbg(host->dev, "atmel_nand : multiple errors detected."
443 444 445 446 447
				" Unable to correct.\n");
		return -EIO;
	}

	/* if there's a single bit error : we can correct it */
448
	if (ecc_status & ATMEL_ECC_ECCERR) {
449 450 451
		/* there's nothing much to do here.
		 * the bit error is on the ECC itself.
		 */
452
		dev_dbg(host->dev, "atmel_nand : one bit error on ECC code."
453 454 455 456
				" Nothing to correct\n");
		return 0;
	}

457
	dev_dbg(host->dev, "atmel_nand : one bit error on data."
458 459 460 461 462 463 464 465 466 467 468
			" (word offset in the page :"
			" 0x%x bit offset : 0x%x)\n",
			ecc_word, ecc_bit);
	/* correct the error */
	if (nand_chip->options & NAND_BUSWIDTH_16) {
		/* 16 bits words */
		((unsigned short *) dat)[ecc_word] ^= (1 << ecc_bit);
	} else {
		/* 8 bits words */
		dat[ecc_word] ^= (1 << ecc_bit);
	}
469
	dev_dbg(host->dev, "atmel_nand : error corrected\n");
470 471 472 473
	return 1;
}

/*
474
 * Enable HW ECC : unused on most chips
475
 */
476 477 478 479 480 481 482 483
static void atmel_nand_hwctl(struct mtd_info *mtd, int mode)
{
	if (cpu_is_at32ap7000()) {
		struct nand_chip *nand_chip = mtd->priv;
		struct atmel_nand_host *host = nand_chip->priv;
		ecc_writel(host->ecc, CR, ATMEL_ECC_RST);
	}
}
484

485 486 487 488
#if defined(CONFIG_OF)
static int __devinit atmel_of_init_port(struct atmel_nand_host *host,
					 struct device_node *np)
{
489 490
	u32 val, table_offset;
	u32 offset[2];
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
	int ecc_mode;
	struct atmel_nand_data *board = &host->board;
	enum of_gpio_flags flags;

	if (of_property_read_u32(np, "atmel,nand-addr-offset", &val) == 0) {
		if (val >= 32) {
			dev_err(host->dev, "invalid addr-offset %u\n", val);
			return -EINVAL;
		}
		board->ale = val;
	}

	if (of_property_read_u32(np, "atmel,nand-cmd-offset", &val) == 0) {
		if (val >= 32) {
			dev_err(host->dev, "invalid cmd-offset %u\n", val);
			return -EINVAL;
		}
		board->cle = val;
	}

	ecc_mode = of_get_nand_ecc_mode(np);

	board->ecc_mode = ecc_mode < 0 ? NAND_ECC_SOFT : ecc_mode;

	board->on_flash_bbt = of_get_nand_on_flash_bbt(np);

	if (of_get_nand_bus_width(np) == 16)
		board->bus_width_16 = 1;

	board->rdy_pin = of_get_gpio_flags(np, 0, &flags);
	board->rdy_pin_active_low = (flags == OF_GPIO_ACTIVE_LOW);

	board->enable_pin = of_get_gpio(np, 1);
	board->det_pin = of_get_gpio(np, 2);

526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
	host->has_pmecc = of_property_read_bool(np, "atmel,has-pmecc");

	if (!(board->ecc_mode == NAND_ECC_HW) || !host->has_pmecc)
		return 0;	/* Not using PMECC */

	/* use PMECC, get correction capability, sector size and lookup
	 * table offset.
	 */
	if (of_property_read_u32(np, "atmel,pmecc-cap", &val) != 0) {
		dev_err(host->dev, "Cannot decide PMECC Capability\n");
		return -EINVAL;
	} else if ((val != 2) && (val != 4) && (val != 8) && (val != 12) &&
	    (val != 24)) {
		dev_err(host->dev,
			"Unsupported PMECC correction capability: %d; should be 2, 4, 8, 12 or 24\n",
			val);
		return -EINVAL;
	}
	host->pmecc_corr_cap = (u8)val;

	if (of_property_read_u32(np, "atmel,pmecc-sector-size", &val) != 0) {
		dev_err(host->dev, "Cannot decide PMECC Sector Size\n");
		return -EINVAL;
	} else if ((val != 512) && (val != 1024)) {
		dev_err(host->dev,
			"Unsupported PMECC sector size: %d; should be 512 or 1024 bytes\n",
			val);
		return -EINVAL;
	}
	host->pmecc_sector_size = (u16)val;

	if (of_property_read_u32_array(np, "atmel,pmecc-lookup-table-offset",
			offset, 2) != 0) {
		dev_err(host->dev, "Cannot get PMECC lookup table offset\n");
		return -EINVAL;
	}
	table_offset = host->pmecc_sector_size == 512 ? offset[0] : offset[1];

	if (!table_offset) {
		dev_err(host->dev, "Invalid PMECC lookup table offset\n");
		return -EINVAL;
	}
	host->pmecc_lookup_table_offset = table_offset;

570 571 572 573 574 575 576 577 578 579
	return 0;
}
#else
static int __devinit atmel_of_init_port(struct atmel_nand_host *host,
					 struct device_node *np)
{
	return -EINVAL;
}
#endif

580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
static int __init atmel_hw_nand_init_params(struct platform_device *pdev,
					 struct atmel_nand_host *host)
{
	struct mtd_info *mtd = &host->mtd;
	struct nand_chip *nand_chip = &host->nand_chip;
	struct resource		*regs;

	regs = platform_get_resource(pdev, IORESOURCE_MEM, 1);
	if (!regs) {
		dev_err(host->dev,
			"Can't get I/O resource regs, use software ECC\n");
		nand_chip->ecc.mode = NAND_ECC_SOFT;
		return 0;
	}

	host->ecc = ioremap(regs->start, resource_size(regs));
	if (host->ecc == NULL) {
		dev_err(host->dev, "ioremap failed\n");
		return -EIO;
	}

	/* ECC is calculated for the whole page (1 step) */
	nand_chip->ecc.size = mtd->writesize;

	/* set ECC page size and oob layout */
	switch (mtd->writesize) {
	case 512:
		nand_chip->ecc.layout = &atmel_oobinfo_small;
		ecc_writel(host->ecc, MR, ATMEL_ECC_PAGESIZE_528);
		break;
	case 1024:
		nand_chip->ecc.layout = &atmel_oobinfo_large;
		ecc_writel(host->ecc, MR, ATMEL_ECC_PAGESIZE_1056);
		break;
	case 2048:
		nand_chip->ecc.layout = &atmel_oobinfo_large;
		ecc_writel(host->ecc, MR, ATMEL_ECC_PAGESIZE_2112);
		break;
	case 4096:
		nand_chip->ecc.layout = &atmel_oobinfo_large;
		ecc_writel(host->ecc, MR, ATMEL_ECC_PAGESIZE_4224);
		break;
	default:
		/* page size not handled by HW ECC */
		/* switching back to soft ECC */
		nand_chip->ecc.mode = NAND_ECC_SOFT;
		return 0;
	}

	/* set up for HW ECC */
	nand_chip->ecc.calculate = atmel_nand_calculate;
	nand_chip->ecc.correct = atmel_nand_correct;
	nand_chip->ecc.hwctl = atmel_nand_hwctl;
	nand_chip->ecc.read_page = atmel_nand_read_page;
	nand_chip->ecc.bytes = 4;
	nand_chip->ecc.strength = 1;

	return 0;
}

A
Andrew Victor 已提交
640 641 642
/*
 * Probe for the NAND device.
 */
643
static int __init atmel_nand_probe(struct platform_device *pdev)
A
Andrew Victor 已提交
644
{
645
	struct atmel_nand_host *host;
A
Andrew Victor 已提交
646 647
	struct mtd_info *mtd;
	struct nand_chip *nand_chip;
648
	struct resource *mem;
649
	struct mtd_part_parser_data ppdata = {};
A
Andrew Victor 已提交
650 651
	int res;

652 653 654 655 656 657
	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!mem) {
		printk(KERN_ERR "atmel_nand: can't get I/O resource mem\n");
		return -ENXIO;
	}

A
Andrew Victor 已提交
658
	/* Allocate memory for the device structure (and zero it) */
659
	host = kzalloc(sizeof(struct atmel_nand_host), GFP_KERNEL);
A
Andrew Victor 已提交
660
	if (!host) {
661
		printk(KERN_ERR "atmel_nand: failed to allocate device structure.\n");
A
Andrew Victor 已提交
662 663 664
		return -ENOMEM;
	}

665 666
	host->io_phys = (dma_addr_t)mem->start;

667
	host->io_base = ioremap(mem->start, resource_size(mem));
A
Andrew Victor 已提交
668
	if (host->io_base == NULL) {
669
		printk(KERN_ERR "atmel_nand: ioremap failed\n");
670 671
		res = -EIO;
		goto err_nand_ioremap;
A
Andrew Victor 已提交
672 673 674 675
	}

	mtd = &host->mtd;
	nand_chip = &host->nand_chip;
676
	host->dev = &pdev->dev;
677 678 679 680 681 682 683 684
	if (pdev->dev.of_node) {
		res = atmel_of_init_port(host, pdev->dev.of_node);
		if (res)
			goto err_nand_ioremap;
	} else {
		memcpy(&host->board, pdev->dev.platform_data,
		       sizeof(struct atmel_nand_data));
	}
A
Andrew Victor 已提交
685 686 687 688 689 690 691 692

	nand_chip->priv = host;		/* link the private data structures */
	mtd->priv = nand_chip;
	mtd->owner = THIS_MODULE;

	/* Set address of NAND IO lines */
	nand_chip->IO_ADDR_R = host->io_base;
	nand_chip->IO_ADDR_W = host->io_base;
693
	nand_chip->cmd_ctrl = atmel_nand_cmd_ctrl;
I
Ivan Kuten 已提交
694

695
	if (gpio_is_valid(host->board.rdy_pin))
696
		nand_chip->dev_ready = atmel_nand_device_ready;
I
Ivan Kuten 已提交
697

698
	nand_chip->ecc.mode = host->board.ecc_mode;
A
Andrew Victor 已提交
699 700
	nand_chip->chip_delay = 20;		/* 20us command delay time */

701
	if (host->board.bus_width_16)	/* 16-bit bus width */
702
		nand_chip->options |= NAND_BUSWIDTH_16;
703 704 705

	nand_chip->read_buf = atmel_read_buf;
	nand_chip->write_buf = atmel_write_buf;
706

A
Andrew Victor 已提交
707
	platform_set_drvdata(pdev, host);
708
	atmel_nand_enable(host);
A
Andrew Victor 已提交
709

710 711
	if (gpio_is_valid(host->board.det_pin)) {
		if (gpio_get_value(host->board.det_pin)) {
712
			printk(KERN_INFO "No SmartMedia card inserted.\n");
R
Roel Kluin 已提交
713
			res = -ENXIO;
714
			goto err_no_card;
A
Andrew Victor 已提交
715 716 717
		}
	}

718
	if (host->board.on_flash_bbt || on_flash_bbt) {
719
		printk(KERN_INFO "atmel_nand: Use On Flash BBT\n");
720
		nand_chip->bbt_options |= NAND_BBT_USE_FLASH;
721 722
	}

723 724 725 726
	if (!cpu_has_dma())
		use_dma = 0;

	if (use_dma) {
727 728 729 730
		dma_cap_mask_t mask;

		dma_cap_zero(mask);
		dma_cap_set(DMA_MEMCPY, mask);
731
		host->dma_chan = dma_request_channel(mask, NULL, NULL);
732 733 734 735 736 737
		if (!host->dma_chan) {
			dev_err(host->dev, "Failed to request DMA channel\n");
			use_dma = 0;
		}
	}
	if (use_dma)
738 739
		dev_info(host->dev, "Using %s for DMA transfers.\n",
					dma_chan_name(host->dma_chan));
740 741 742
	else
		dev_info(host->dev, "No DMA support for NAND access.\n");

743
	/* first scan to find the device and get the page size */
744
	if (nand_scan_ident(mtd, 1, NULL)) {
745
		res = -ENXIO;
746
		goto err_scan_ident;
747 748
	}

749
	if (nand_chip->ecc.mode == NAND_ECC_HW) {
750 751 752
		res = atmel_hw_nand_init_params(pdev, host);
		if (res != 0)
			goto err_hw_ecc;
753 754 755 756
	}

	/* second phase scan */
	if (nand_scan_tail(mtd)) {
A
Andrew Victor 已提交
757
		res = -ENXIO;
758
		goto err_scan_tail;
A
Andrew Victor 已提交
759 760
	}

761
	mtd->name = "atmel_nand";
762 763 764
	ppdata.of_node = pdev->dev.of_node;
	res = mtd_device_parse_register(mtd, NULL, &ppdata,
			host->board.parts, host->board.num_parts);
A
Andrew Victor 已提交
765 766 767
	if (!res)
		return res;

768
err_scan_tail:
769 770 771
	if (host->ecc)
		iounmap(host->ecc);
err_hw_ecc:
772 773
err_scan_ident:
err_no_card:
774
	atmel_nand_disable(host);
A
Andrew Victor 已提交
775
	platform_set_drvdata(pdev, NULL);
776 777
	if (host->dma_chan)
		dma_release_channel(host->dma_chan);
A
Andrew Victor 已提交
778
	iounmap(host->io_base);
779
err_nand_ioremap:
A
Andrew Victor 已提交
780 781 782 783 784 785 786
	kfree(host);
	return res;
}

/*
 * Remove a NAND device.
 */
787
static int __exit atmel_nand_remove(struct platform_device *pdev)
A
Andrew Victor 已提交
788
{
789
	struct atmel_nand_host *host = platform_get_drvdata(pdev);
A
Andrew Victor 已提交
790 791 792 793
	struct mtd_info *mtd = &host->mtd;

	nand_release(mtd);

794
	atmel_nand_disable(host);
A
Andrew Victor 已提交
795

796 797
	if (host->ecc)
		iounmap(host->ecc);
798 799 800 801

	if (host->dma_chan)
		dma_release_channel(host->dma_chan);

A
Andrew Victor 已提交
802 803 804 805 806 807
	iounmap(host->io_base);
	kfree(host);

	return 0;
}

808 809 810 811 812 813 814 815 816
#if defined(CONFIG_OF)
static const struct of_device_id atmel_nand_dt_ids[] = {
	{ .compatible = "atmel,at91rm9200-nand" },
	{ /* sentinel */ }
};

MODULE_DEVICE_TABLE(of, atmel_nand_dt_ids);
#endif

817
static struct platform_driver atmel_nand_driver = {
818
	.remove		= __exit_p(atmel_nand_remove),
A
Andrew Victor 已提交
819
	.driver		= {
820
		.name	= "atmel_nand",
A
Andrew Victor 已提交
821
		.owner	= THIS_MODULE,
822
		.of_match_table	= of_match_ptr(atmel_nand_dt_ids),
A
Andrew Victor 已提交
823 824 825
	},
};

826
static int __init atmel_nand_init(void)
A
Andrew Victor 已提交
827
{
828
	return platform_driver_probe(&atmel_nand_driver, atmel_nand_probe);
A
Andrew Victor 已提交
829 830 831
}


832
static void __exit atmel_nand_exit(void)
A
Andrew Victor 已提交
833
{
834
	platform_driver_unregister(&atmel_nand_driver);
A
Andrew Victor 已提交
835 836 837
}


838 839
module_init(atmel_nand_init);
module_exit(atmel_nand_exit);
A
Andrew Victor 已提交
840 841 842

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Rick Bronson");
843
MODULE_DESCRIPTION("NAND/SmartMedia driver for AT91 / AVR32");
844
MODULE_ALIAS("platform:atmel_nand");