au1550nd.c 14.4 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 *  drivers/mtd/nand/au1550nd.c
 *
 *  Copyright (C) 2004 Embedded Edge, LLC
 *
 * 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.
 *
 */

#include <linux/slab.h>
#include <linux/init.h>
#include <linux/module.h>
15
#include <linux/interrupt.h>
L
Linus Torvalds 已提交
16 17 18 19 20
#include <linux/mtd/mtd.h>
#include <linux/mtd/nand.h>
#include <linux/mtd/partitions.h>
#include <asm/io.h>

21
#include <asm/mach-au1x00/au1xxx.h>
22
#include <asm/mach-db1x00/bcsr.h>
L
Linus Torvalds 已提交
23 24 25 26 27 28

/*
 * MTD structure for NAND controller
 */
static struct mtd_info *au1550_mtd = NULL;
static void __iomem *p_nand;
29
static int nand_width = 1;	/* default x8 */
30
static void (*au1550_write_byte)(struct mtd_info *, u_char);
L
Linus Torvalds 已提交
31 32 33 34

/*
 * Define partitions for flash device
 */
35
static const struct mtd_partition partition_info[] = {
36
	{
37 38 39
	 .name = "NAND FS 0",
	 .offset = 0,
	 .size = 8 * 1024 * 1024},
40
	{
41 42 43
	 .name = "NAND FS 1",
	 .offset = MTDPART_OFS_APPEND,
	 .size = MTDPART_SIZ_FULL}
L
Linus Torvalds 已提交
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
};

/**
 * au_read_byte -  read one byte from the chip
 * @mtd:	MTD device structure
 *
 *  read function for 8bit buswith
 */
static u_char au_read_byte(struct mtd_info *mtd)
{
	struct nand_chip *this = mtd->priv;
	u_char ret = readb(this->IO_ADDR_R);
	au_sync();
	return ret;
}

/**
 * au_write_byte -  write one byte to the chip
 * @mtd:	MTD device structure
 * @byte:	pointer to data byte to write
 *
 *  write function for 8it buswith
 */
static void au_write_byte(struct mtd_info *mtd, u_char byte)
{
	struct nand_chip *this = mtd->priv;
	writeb(byte, this->IO_ADDR_W);
	au_sync();
}

/**
 * au_read_byte16 -  read one byte endianess aware from the chip
 * @mtd:	MTD device structure
 *
78
 *  read function for 16bit buswith with
L
Linus Torvalds 已提交
79 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
 * endianess conversion
 */
static u_char au_read_byte16(struct mtd_info *mtd)
{
	struct nand_chip *this = mtd->priv;
	u_char ret = (u_char) cpu_to_le16(readw(this->IO_ADDR_R));
	au_sync();
	return ret;
}

/**
 * au_write_byte16 -  write one byte endianess aware to the chip
 * @mtd:	MTD device structure
 * @byte:	pointer to data byte to write
 *
 *  write function for 16bit buswith with
 * endianess conversion
 */
static void au_write_byte16(struct mtd_info *mtd, u_char byte)
{
	struct nand_chip *this = mtd->priv;
	writew(le16_to_cpu((u16) byte), this->IO_ADDR_W);
	au_sync();
}

/**
 * au_read_word -  read one word from the chip
 * @mtd:	MTD device structure
 *
108
 *  read function for 16bit buswith without
L
Linus Torvalds 已提交
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
 * endianess conversion
 */
static u16 au_read_word(struct mtd_info *mtd)
{
	struct nand_chip *this = mtd->priv;
	u16 ret = readw(this->IO_ADDR_R);
	au_sync();
	return ret;
}

/**
 * au_write_buf -  write buffer to chip
 * @mtd:	MTD device structure
 * @buf:	data buffer
 * @len:	number of bytes to write
 *
 *  write function for 8bit buswith
 */
static void au_write_buf(struct mtd_info *mtd, const u_char *buf, int len)
{
	int i;
	struct nand_chip *this = mtd->priv;

132
	for (i = 0; i < len; i++) {
L
Linus Torvalds 已提交
133 134 135 136 137 138
		writeb(buf[i], this->IO_ADDR_W);
		au_sync();
	}
}

/**
139
 * au_read_buf -  read chip data into buffer
L
Linus Torvalds 已提交
140 141 142 143 144 145 146 147 148 149 150
 * @mtd:	MTD device structure
 * @buf:	buffer to store date
 * @len:	number of bytes to read
 *
 *  read function for 8bit buswith
 */
static void au_read_buf(struct mtd_info *mtd, u_char *buf, int len)
{
	int i;
	struct nand_chip *this = mtd->priv;

151
	for (i = 0; i < len; i++) {
L
Linus Torvalds 已提交
152
		buf[i] = readb(this->IO_ADDR_R);
153
		au_sync();
L
Linus Torvalds 已提交
154 155 156 157
	}
}

/**
158
 * au_verify_buf -  Verify chip data against buffer
L
Linus Torvalds 已提交
159 160 161 162 163 164 165 166 167 168 169
 * @mtd:	MTD device structure
 * @buf:	buffer containing the data to compare
 * @len:	number of bytes to compare
 *
 *  verify function for 8bit buswith
 */
static int au_verify_buf(struct mtd_info *mtd, const u_char *buf, int len)
{
	int i;
	struct nand_chip *this = mtd->priv;

170
	for (i = 0; i < len; i++) {
L
Linus Torvalds 已提交
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
		if (buf[i] != readb(this->IO_ADDR_R))
			return -EFAULT;
		au_sync();
	}

	return 0;
}

/**
 * au_write_buf16 -  write buffer to chip
 * @mtd:	MTD device structure
 * @buf:	data buffer
 * @len:	number of bytes to write
 *
 *  write function for 16bit buswith
 */
static void au_write_buf16(struct mtd_info *mtd, const u_char *buf, int len)
{
	int i;
	struct nand_chip *this = mtd->priv;
	u16 *p = (u16 *) buf;
	len >>= 1;
193

194
	for (i = 0; i < len; i++) {
L
Linus Torvalds 已提交
195 196 197
		writew(p[i], this->IO_ADDR_W);
		au_sync();
	}
198

L
Linus Torvalds 已提交
199 200 201
}

/**
202
 * au_read_buf16 -  read chip data into buffer
L
Linus Torvalds 已提交
203 204 205 206 207 208 209 210 211 212 213 214 215
 * @mtd:	MTD device structure
 * @buf:	buffer to store date
 * @len:	number of bytes to read
 *
 *  read function for 16bit buswith
 */
static void au_read_buf16(struct mtd_info *mtd, u_char *buf, int len)
{
	int i;
	struct nand_chip *this = mtd->priv;
	u16 *p = (u16 *) buf;
	len >>= 1;

216
	for (i = 0; i < len; i++) {
L
Linus Torvalds 已提交
217 218 219 220 221 222
		p[i] = readw(this->IO_ADDR_R);
		au_sync();
	}
}

/**
223
 * au_verify_buf16 -  Verify chip data against buffer
L
Linus Torvalds 已提交
224 225 226 227 228 229 230 231 232 233 234 235 236
 * @mtd:	MTD device structure
 * @buf:	buffer containing the data to compare
 * @len:	number of bytes to compare
 *
 *  verify function for 16bit buswith
 */
static int au_verify_buf16(struct mtd_info *mtd, const u_char *buf, int len)
{
	int i;
	struct nand_chip *this = mtd->priv;
	u16 *p = (u16 *) buf;
	len >>= 1;

237
	for (i = 0; i < len; i++) {
L
Linus Torvalds 已提交
238 239 240 241 242 243 244
		if (p[i] != readw(this->IO_ADDR_R))
			return -EFAULT;
		au_sync();
	}
	return 0;
}

245 246 247 248 249 250 251 252 253 254 255 256
/* Select the chip by setting nCE to low */
#define NAND_CTL_SETNCE		1
/* Deselect the chip by setting nCE to high */
#define NAND_CTL_CLRNCE		2
/* Select the command latch by setting CLE to high */
#define NAND_CTL_SETCLE		3
/* Deselect the command latch by setting CLE to low */
#define NAND_CTL_CLRCLE		4
/* Select the address latch by setting ALE to high */
#define NAND_CTL_SETALE		5
/* Deselect the address latch by setting ALE to low */
#define NAND_CTL_CLRALE		6
L
Linus Torvalds 已提交
257 258 259 260 261

static void au1550_hwcontrol(struct mtd_info *mtd, int cmd)
{
	register struct nand_chip *this = mtd->priv;

262 263 264 265 266 267 268 269 270
	switch (cmd) {

	case NAND_CTL_SETCLE:
		this->IO_ADDR_W = p_nand + MEM_STNAND_CMD;
		break;

	case NAND_CTL_CLRCLE:
		this->IO_ADDR_W = p_nand + MEM_STNAND_DATA;
		break;
L
Linus Torvalds 已提交
271

272 273 274
	case NAND_CTL_SETALE:
		this->IO_ADDR_W = p_nand + MEM_STNAND_ADDR;
		break;
L
Linus Torvalds 已提交
275

276 277
	case NAND_CTL_CLRALE:
		this->IO_ADDR_W = p_nand + MEM_STNAND_DATA;
278
		/* FIXME: Nobody knows why this is necessary,
L
Linus Torvalds 已提交
279
		 * but it works only that way */
280
		udelay(1);
L
Linus Torvalds 已提交
281 282
		break;

283
	case NAND_CTL_SETNCE:
L
Linus Torvalds 已提交
284
		/* assert (force assert) chip enable */
285
		au_writel((1 << (4 + NAND_CS)), MEM_STNDCTL);
L
Linus Torvalds 已提交
286 287
		break;

288
	case NAND_CTL_CLRNCE:
289 290
		/* deassert chip enable */
		au_writel(0, MEM_STNDCTL);
L
Linus Torvalds 已提交
291 292 293 294
		break;
	}

	this->IO_ADDR_R = this->IO_ADDR_W;
295

L
Linus Torvalds 已提交
296 297 298 299 300 301 302 303 304 305 306
	/* Drain the writebuffer */
	au_sync();
}

int au1550_device_ready(struct mtd_info *mtd)
{
	int ret = (au_readl(MEM_STSTAT) & 0x1) ? 1 : 0;
	au_sync();
	return ret;
}

307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
/**
 * au1550_select_chip - control -CE line
 *	Forbid driving -CE manually permitting the NAND controller to do this.
 *	Keeping -CE asserted during the whole sector reads interferes with the
 *	NOR flash and PCMCIA drivers as it causes contention on the static bus.
 *	We only have to hold -CE low for the NAND read commands since the flash
 *	chip needs it to be asserted during chip not ready time but the NAND
 *	controller keeps it released.
 *
 * @mtd:	MTD device structure
 * @chip:	chipnumber to select, -1 for deselect
 */
static void au1550_select_chip(struct mtd_info *mtd, int chip)
{
}

/**
 * au1550_command - Send command to NAND device
 * @mtd:	MTD device structure
 * @command:	the command to be sent
 * @column:	the column address for this command, -1 if none
 * @page_addr:	the page address for this command, -1 if none
 */
static void au1550_command(struct mtd_info *mtd, unsigned command, int column, int page_addr)
{
	register struct nand_chip *this = mtd->priv;
	int ce_override = 0, i;
	ulong flags;

	/* Begin command latch cycle */
337
	au1550_hwcontrol(mtd, NAND_CTL_SETCLE);
338 339 340 341 342 343
	/*
	 * Write out the command to the device.
	 */
	if (command == NAND_CMD_SEQIN) {
		int readcmd;

J
Joern Engel 已提交
344
		if (column >= mtd->writesize) {
345
			/* OOB area */
J
Joern Engel 已提交
346
			column -= mtd->writesize;
347 348 349 350 351 352 353 354
			readcmd = NAND_CMD_READOOB;
		} else if (column < 256) {
			/* First 256 bytes --> READ0 */
			readcmd = NAND_CMD_READ0;
		} else {
			column -= 256;
			readcmd = NAND_CMD_READ1;
		}
355
		au1550_write_byte(mtd, readcmd);
356
	}
357
	au1550_write_byte(mtd, command);
358 359

	/* Set ALE and clear CLE to start address cycle */
360
	au1550_hwcontrol(mtd, NAND_CTL_CLRCLE);
361 362

	if (column != -1 || page_addr != -1) {
363
		au1550_hwcontrol(mtd, NAND_CTL_SETALE);
364 365 366 367 368 369

		/* Serially input address */
		if (column != -1) {
			/* Adjust columns for 16 bit buswidth */
			if (this->options & NAND_BUSWIDTH_16)
				column >>= 1;
370
			au1550_write_byte(mtd, column);
371 372
		}
		if (page_addr != -1) {
373
			au1550_write_byte(mtd, (u8)(page_addr & 0xff));
374 375 376 377 378 379 380 381 382 383 384 385 386 387

			if (command == NAND_CMD_READ0 ||
			    command == NAND_CMD_READ1 ||
			    command == NAND_CMD_READOOB) {
				/*
				 * NAND controller will release -CE after
				 * the last address byte is written, so we'll
				 * have to forcibly assert it. No interrupts
				 * are allowed while we do this as we don't
				 * want the NOR flash or PCMCIA drivers to
				 * steal our precious bytes of data...
				 */
				ce_override = 1;
				local_irq_save(flags);
388
				au1550_hwcontrol(mtd, NAND_CTL_SETNCE);
389 390
			}

391
			au1550_write_byte(mtd, (u8)(page_addr >> 8));
392 393 394

			/* One more address cycle for devices > 32MiB */
			if (this->chipsize > (32 << 20))
395
				au1550_write_byte(mtd, (u8)((page_addr >> 16) & 0x0f));
396 397
		}
		/* Latch in address */
398
		au1550_hwcontrol(mtd, NAND_CTL_CLRALE);
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
	}

	/*
	 * Program and erase have their own busy handlers.
	 * Status and sequential in need no delay.
	 */
	switch (command) {

	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:
		break;

	case NAND_CMD_READ0:
	case NAND_CMD_READ1:
	case NAND_CMD_READOOB:
		/* Check if we're really driving -CE low (just in case) */
		if (unlikely(!ce_override))
			break;

		/* Apply a short delay always to ensure that we do wait tWB. */
		ndelay(100);
		/* Wait for a chip to become ready... */
		for (i = this->chip_delay; !this->dev_ready(mtd) && i > 0; --i)
			udelay(1);

		/* Release -CE and re-enable interrupts. */
431
		au1550_hwcontrol(mtd, NAND_CTL_CLRNCE);
432 433 434 435 436 437 438 439 440 441
		local_irq_restore(flags);
		return;
	}
	/* Apply this short delay always to ensure that we do wait tWB. */
	ndelay(100);

	while(!this->dev_ready(mtd));
}


L
Linus Torvalds 已提交
442 443 444
/*
 * Main initialization routine
 */
445
static int __init au1xxx_nand_init(void)
L
Linus Torvalds 已提交
446 447
{
	struct nand_chip *this;
448
	u16 boot_swapboot = 0;	/* default value */
L
Linus Torvalds 已提交
449
	int retval;
450 451
	u32 mem_staddr;
	u32 nand_phys;
L
Linus Torvalds 已提交
452 453

	/* Allocate memory for MTD device structure and private data */
H
H Hartley Sweeten 已提交
454
	au1550_mtd = kzalloc(sizeof(struct mtd_info) + sizeof(struct nand_chip), GFP_KERNEL);
L
Linus Torvalds 已提交
455
	if (!au1550_mtd) {
456
		printk("Unable to allocate NAND MTD dev structure.\n");
L
Linus Torvalds 已提交
457 458 459 460
		return -ENOMEM;
	}

	/* Get pointer to private data */
461
	this = (struct nand_chip *)(&au1550_mtd[1]);
L
Linus Torvalds 已提交
462 463 464

	/* Link the private data with the MTD structure */
	au1550_mtd->priv = this;
465
	au1550_mtd->owner = THIS_MODULE;
L
Linus Torvalds 已提交
466

467

468 469
	/* MEM_STNDCTL: disable ints, disable nand boot */
	au_writel(0, MEM_STNDCTL);
L
Linus Torvalds 已提交
470 471 472

#ifdef CONFIG_MIPS_PB1550
	/* set gpio206 high */
473
	au_writel(au_readl(GPIO2_DIR) & ~(1 << 6), GPIO2_DIR);
L
Linus Torvalds 已提交
474

475 476
	boot_swapboot = (au_readl(MEM_STSTAT) & (0x7 << 1)) | ((bcsr_read(BCSR_STATUS) >> 6) & 0x1);

L
Linus Torvalds 已提交
477
	switch (boot_swapboot) {
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
	case 0:
	case 2:
	case 8:
	case 0xC:
	case 0xD:
		/* x16 NAND Flash */
		nand_width = 0;
		break;
	case 1:
	case 9:
	case 3:
	case 0xE:
	case 0xF:
		/* x8 NAND Flash */
		nand_width = 1;
		break;
	default:
		printk("Pb1550 NAND: bad boot:swap\n");
		retval = -EINVAL;
		goto outmem;
L
Linus Torvalds 已提交
498 499 500
	}
#endif

501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
	/* Configure chip-select; normally done by boot code, e.g. YAMON */
#ifdef NAND_STCFG
	if (NAND_CS == 0) {
		au_writel(NAND_STCFG,  MEM_STCFG0);
		au_writel(NAND_STTIME, MEM_STTIME0);
		au_writel(NAND_STADDR, MEM_STADDR0);
	}
	if (NAND_CS == 1) {
		au_writel(NAND_STCFG,  MEM_STCFG1);
		au_writel(NAND_STTIME, MEM_STTIME1);
		au_writel(NAND_STADDR, MEM_STADDR1);
	}
	if (NAND_CS == 2) {
		au_writel(NAND_STCFG,  MEM_STCFG2);
		au_writel(NAND_STTIME, MEM_STTIME2);
		au_writel(NAND_STADDR, MEM_STADDR2);
	}
	if (NAND_CS == 3) {
		au_writel(NAND_STCFG,  MEM_STCFG3);
		au_writel(NAND_STTIME, MEM_STTIME3);
		au_writel(NAND_STADDR, MEM_STADDR3);
	}
#endif
524

525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
	/* Locate NAND chip-select in order to determine NAND phys address */
	mem_staddr = 0x00000000;
	if (((au_readl(MEM_STCFG0) & 0x7) == 0x5) && (NAND_CS == 0))
		mem_staddr = au_readl(MEM_STADDR0);
	else if (((au_readl(MEM_STCFG1) & 0x7) == 0x5) && (NAND_CS == 1))
		mem_staddr = au_readl(MEM_STADDR1);
	else if (((au_readl(MEM_STCFG2) & 0x7) == 0x5) && (NAND_CS == 2))
		mem_staddr = au_readl(MEM_STADDR2);
	else if (((au_readl(MEM_STCFG3) & 0x7) == 0x5) && (NAND_CS == 3))
		mem_staddr = au_readl(MEM_STADDR3);

	if (mem_staddr == 0x00000000) {
		printk("Au1xxx NAND: ERROR WITH NAND CHIP-SELECT\n");
		kfree(au1550_mtd);
		return 1;
	}
	nand_phys = (mem_staddr << 4) & 0xFFFC0000;
L
Linus Torvalds 已提交
542

543
	p_nand = ioremap(nand_phys, 0x1000);
544 545 546

	/* make controller and MTD agree */
	if (NAND_CS == 0)
547
		nand_width = au_readl(MEM_STCFG0) & (1 << 22);
548
	if (NAND_CS == 1)
549
		nand_width = au_readl(MEM_STCFG1) & (1 << 22);
550
	if (NAND_CS == 2)
551
		nand_width = au_readl(MEM_STCFG2) & (1 << 22);
552
	if (NAND_CS == 3)
553
		nand_width = au_readl(MEM_STCFG3) & (1 << 22);
L
Linus Torvalds 已提交
554 555 556

	/* Set address of hardware control function */
	this->dev_ready = au1550_device_ready;
557 558 559
	this->select_chip = au1550_select_chip;
	this->cmdfunc = au1550_command;

L
Linus Torvalds 已提交
560
	/* 30 us command delay time */
561
	this->chip_delay = 30;
T
Thomas Gleixner 已提交
562
	this->ecc.mode = NAND_ECC_SOFT;
L
Linus Torvalds 已提交
563 564 565 566 567 568 569

	this->options = NAND_NO_AUTOINCR;

	if (!nand_width)
		this->options |= NAND_BUSWIDTH_16;

	this->read_byte = (!nand_width) ? au_read_byte16 : au_read_byte;
570
	au1550_write_byte = (!nand_width) ? au_write_byte16 : au_write_byte;
L
Linus Torvalds 已提交
571 572 573 574 575 576
	this->read_word = au_read_word;
	this->write_buf = (!nand_width) ? au_write_buf16 : au_write_buf;
	this->read_buf = (!nand_width) ? au_read_buf16 : au_read_buf;
	this->verify_buf = (!nand_width) ? au_verify_buf16 : au_verify_buf;

	/* Scan to find existence of the device */
577
	if (nand_scan(au1550_mtd, 1)) {
L
Linus Torvalds 已提交
578 579 580 581 582
		retval = -ENXIO;
		goto outio;
	}

	/* Register the partitions */
583
	add_mtd_partitions(au1550_mtd, partition_info, ARRAY_SIZE(partition_info));
L
Linus Torvalds 已提交
584 585 586 587

	return 0;

 outio:
588
	iounmap(p_nand);
589

L
Linus Torvalds 已提交
590
 outmem:
591
	kfree(au1550_mtd);
L
Linus Torvalds 已提交
592 593 594
	return retval;
}

595
module_init(au1xxx_nand_init);
L
Linus Torvalds 已提交
596 597 598 599

/*
 * Clean up routine
 */
600
static void __exit au1550_cleanup(void)
L
Linus Torvalds 已提交
601 602
{
	/* Release resources, unregister device */
603
	nand_release(au1550_mtd);
L
Linus Torvalds 已提交
604 605

	/* Free the MTD device structure */
606
	kfree(au1550_mtd);
L
Linus Torvalds 已提交
607 608

	/* Unmap */
609
	iounmap(p_nand);
L
Linus Torvalds 已提交
610
}
611

L
Linus Torvalds 已提交
612 613 614 615 616
module_exit(au1550_cleanup);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Embedded Edge, LLC");
MODULE_DESCRIPTION("Board-specific glue layer for NAND flash on Pb1550 board");