/* * Linux driver for Disk-On-Chip Millennium * (c) 1999 Machine Vision Holdings, Inc. * (c) 1999, 2000 David Woodhouse <dwmw2@infradead.org> * * $Id: doc2001.c,v 1.38 2002/12/10 15:05:42 gleixner Exp $ */#include <linux/kernel.h>#include <linux/module.h>#include <asm/errno.h>#include <asm/io.h>#include <asm/uaccess.h>#include <linux/miscdevice.h>#include <linux/pci.h>#include <linux/delay.h>#include <linux/slab.h>#include <linux/sched.h>#include <linux/init.h>#include <linux/types.h>#include <linux/mtd/mtd.h>#include <linux/mtd/nand.h>#include <linux/mtd/doc2000.h>/* #define ECC_DEBUG *//* I have no idea why some DoC chips can not use memcop_form|to_io(). * This may be due to the different revisions of the ASIC controller built-in or * simplily a QA/Bug issue. Who knows ?? If you have trouble, please uncomment * this:*/#undef USE_MEMCPYstatic int doc_read(struct mtd_info *mtd, loff_t from, size_t len,		    size_t *retlen, u_char *buf);static int doc_write(struct mtd_info *mtd, loff_t to, size_t len,		     size_t *retlen, const u_char *buf);static int doc_read_ecc(struct mtd_info *mtd, loff_t from, size_t len,			size_t *retlen, u_char *buf, u_char *eccbuf, int oobsel);static int doc_write_ecc(struct mtd_info *mtd, loff_t to, size_t len,			 size_t *retlen, const u_char *buf, u_char *eccbuf, int oobsel);static int doc_read_oob(struct mtd_info *mtd, loff_t ofs, size_t len,			size_t *retlen, u_char *buf);static int doc_write_oob(struct mtd_info *mtd, loff_t ofs, size_t len,			 size_t *retlen, const u_char *buf);static int doc_erase (struct mtd_info *mtd, struct erase_info *instr);static struct mtd_info *docmillist = NULL;/* Perform the required delay cycles by reading from the NOP register */static void DoC_Delay(unsigned long docptr, unsigned short cycles){	volatile char dummy;	int i;	for (i = 0; i < cycles; i++)		dummy = ReadDOC(docptr, NOP);}/* DOC_WaitReady: Wait for RDY line to be asserted by the flash chip */static int _DoC_WaitReady(unsigned long docptr){	unsigned short c = 0xffff;	DEBUG(MTD_DEBUG_LEVEL3,	      "_DoC_WaitReady called for out-of-line wait\n");	/* Out-of-line routine to wait for chip response */	while (!(ReadDOC(docptr, CDSNControl) & CDSN_CTRL_FR_B) && --c)		;	if (c == 0)		DEBUG(MTD_DEBUG_LEVEL2, "_DoC_WaitReady timed out.\n");	return (c == 0);}static inline int DoC_WaitReady(unsigned long docptr){	/* This is inline, to optimise the common case, where it's ready instantly */	int ret = 0;	/* 4 read form NOP register should be issued in prior to the read from CDSNControl	   see Software Requirement 11.4 item 2. */	DoC_Delay(docptr, 4);	if (!(ReadDOC(docptr, CDSNControl) & CDSN_CTRL_FR_B))		/* Call the out-of-line routine to wait */		ret = _DoC_WaitReady(docptr);	/* issue 2 read from NOP register after reading from CDSNControl register	   see Software Requirement 11.4 item 2. */	DoC_Delay(docptr, 2);	return ret;}/* DoC_Command: Send a flash command to the flash chip through the CDSN IO register   with the internal pipeline. Each of 4 delay cycles (read from the NOP register) is   required after writing to CDSN Control register, see Software Requirement 11.4 item 3. */static inline void DoC_Command(unsigned long docptr, unsigned char command,			       unsigned char xtraflags){	/* Assert the CLE (Command Latch Enable) line to the flash chip */	WriteDOC(xtraflags | CDSN_CTRL_CLE | CDSN_CTRL_CE, docptr, CDSNControl);	DoC_Delay(docptr, 4);	/* Send the command */	WriteDOC(command, docptr, Mil_CDSN_IO);	WriteDOC(0x00, docptr, WritePipeTerm);	/* Lower the CLE line */	WriteDOC(xtraflags | CDSN_CTRL_CE, docptr, CDSNControl);	DoC_Delay(docptr, 4);}/* DoC_Address: Set the current address for the flash chip through the CDSN IO register   with the internal pipeline. Each of 4 delay cycles (read from the NOP register) is   required after writing to CDSN Control register, see Software Requirement 11.4 item 3. */static inline void DoC_Address(unsigned long docptr, int numbytes, unsigned long ofs,			       unsigned char xtraflags1, unsigned char xtraflags2){	/* Assert the ALE (Address Latch Enable) line to the flash chip */	WriteDOC(xtraflags1 | CDSN_CTRL_ALE | CDSN_CTRL_CE, docptr, CDSNControl);	DoC_Delay(docptr, 4);	/* Send the address */	switch (numbytes)	    {	    case 1:		    /* Send single byte, bits 0-7. */		    WriteDOC(ofs & 0xff, docptr, Mil_CDSN_IO);		    WriteDOC(0x00, docptr, WritePipeTerm);		    break;	    case 2:		    /* Send bits 9-16 followed by 17-23 */		    WriteDOC((ofs >> 9)  & 0xff, docptr, Mil_CDSN_IO);		    WriteDOC((ofs >> 17) & 0xff, docptr, Mil_CDSN_IO);		    WriteDOC(0x00, docptr, WritePipeTerm);		break;	    case 3:		    /* Send 0-7, 9-16, then 17-23 */		    WriteDOC(ofs & 0xff, docptr, Mil_CDSN_IO);		    WriteDOC((ofs >> 9)  & 0xff, docptr, Mil_CDSN_IO);		    WriteDOC((ofs >> 17) & 0xff, docptr, Mil_CDSN_IO);		    WriteDOC(0x00, docptr, WritePipeTerm);		break;	    default:		return;	    }	/* Lower the ALE line */	WriteDOC(xtraflags1 | xtraflags2 | CDSN_CTRL_CE, docptr, CDSNControl);	DoC_Delay(docptr, 4);}/* DoC_SelectChip: Select a given flash chip within the current floor */static int DoC_SelectChip(unsigned long docptr, int chip){	/* Select the individual flash chip requested */	WriteDOC(chip, docptr, CDSNDeviceSelect);	DoC_Delay(docptr, 4);	/* Wait for it to be ready */	return DoC_WaitReady(docptr);}/* DoC_SelectFloor: Select a given floor (bank of flash chips) */static int DoC_SelectFloor(unsigned long docptr, int floor){	/* Select the floor (bank) of chips required */	WriteDOC(floor, docptr, FloorSelect);	/* Wait for the chip to be ready */	return DoC_WaitReady(docptr);}/* DoC_IdentChip: Identify a given NAND chip given {floor,chip} */static int DoC_IdentChip(struct DiskOnChip *doc, int floor, int chip){	int mfr, id, i, j;	volatile char dummy;	/* Page in the required floor/chip	   FIXME: is this supported by Millennium ?? */	DoC_SelectFloor(doc->virtadr, floor);	DoC_SelectChip(doc->virtadr, chip);	/* Reset the chip, see Software Requirement 11.4 item 1. */	DoC_Command(doc->virtadr, NAND_CMD_RESET, CDSN_CTRL_WP);	DoC_WaitReady(doc->virtadr);	/* Read the NAND chip ID: 1. Send ReadID command */ 	DoC_Command(doc->virtadr, NAND_CMD_READID, CDSN_CTRL_WP);	/* Read the NAND chip ID: 2. Send address byte zero */ 	DoC_Address(doc->virtadr, 1, 0x00, CDSN_CTRL_WP, 0x00);	/* Read the manufacturer and device id codes of the flash device through	   CDSN IO register see Software Requirement 11.4 item 5.*/	dummy = ReadDOC(doc->virtadr, ReadPipeInit);	DoC_Delay(doc->virtadr, 2);	mfr = ReadDOC(doc->virtadr, Mil_CDSN_IO);	DoC_Delay(doc->virtadr, 2);	id  = ReadDOC(doc->virtadr, Mil_CDSN_IO);	dummy = ReadDOC(doc->virtadr, LastDataRead);	/* No response - return failure */	if (mfr == 0xff || mfr == 0)		return 0;	/* FIXME: to deal with multi-flash on multi-Millennium case more carefully */	for (i = 0; nand_flash_ids[i].name != NULL; i++) {		if ( id == nand_flash_ids[i].id) {			/* Try to identify manufacturer */			for (j = 0; nand_manuf_ids[j].id != 0x0; j++) {				if (nand_manuf_ids[j].id == mfr)					break;			}				printk(KERN_INFO "Flash chip found: Manufacturer ID: %2.2X, "			       "Chip ID: %2.2X (%s:%s)\n",			       mfr, id, nand_manuf_ids[j].name, nand_flash_ids[i].name);			doc->mfr = mfr;			doc->id = id;			doc->chipshift = nand_flash_ids[i].chipshift;			break;		}	}	if (nand_flash_ids[i].name == NULL)		return 0;	else		return 1;}/* DoC_ScanChips: Find all NAND chips present in a DiskOnChip, and identify them */static void DoC_ScanChips(struct DiskOnChip *this){	int floor, chip;	int numchips[MAX_FLOORS_MIL];	int ret;	this->numchips = 0;	this->mfr = 0;	this->id = 0;	/* For each floor, find the number of valid chips it contains */	for (floor = 0,ret = 1; floor < MAX_FLOORS_MIL; floor++) {		numchips[floor] = 0;		for (chip = 0; chip < MAX_CHIPS_MIL && ret != 0; chip++) {			ret = DoC_IdentChip(this, floor, chip);			if (ret) {				numchips[floor]++;				this->numchips++;			}		}	}	/* If there are none at all that we recognise, bail */	if (!this->numchips) {		printk("No flash chips recognised.\n");		return;	}	/* Allocate an array to hold the information for each chip */	this->chips = kmalloc(sizeof(struct Nand) * this->numchips, GFP_KERNEL);	if (!this->chips){		printk("No memory for allocating chip info structures\n");		return;	}	/* Fill out the chip array with {floor, chipno} for each 	 * detected chip in the device. */	for (floor = 0, ret = 0; floor < MAX_FLOORS_MIL; floor++) {		for (chip = 0 ; chip < numchips[floor] ; chip++) {			this->chips[ret].floor = floor;			this->chips[ret].chip = chip;			this->chips[ret].curadr = 0;			this->chips[ret].curmode = 0x50;			ret++;		}	}	/* Calculate and print the total size of the device */	this->totlen = this->numchips * (1 << this->chipshift);	printk(KERN_INFO "%d flash chips found. Total DiskOnChip size: %ld MiB\n",	       this->numchips ,this->totlen >> 20);}static int DoCMil_is_alias(struct DiskOnChip *doc1, struct DiskOnChip *doc2){	int tmp1, tmp2, retval;	if (doc1->physadr == doc2->physadr)		return 1;	/* Use the alias resolution register which was set aside for this	 * purpose. If it's value is the same on both chips, they might	 * be the same chip, and we write to one and check for a change in	 * the other. It's unclear if this register is usuable in the	 * DoC 2000 (it's in the Millenium docs), but it seems to work. */	tmp1 = ReadDOC(doc1->virtadr, AliasResolution);	tmp2 = ReadDOC(doc2->virtadr, AliasResolution);	if (tmp1 != tmp2)		return 0;		WriteDOC((tmp1+1) % 0xff, doc1->virtadr, AliasResolution);	tmp2 = ReadDOC(doc2->virtadr, AliasResolution);	if (tmp2 == (tmp1+1) % 0xff)		retval = 1;	else		retval = 0;	/* Restore register contents.  May not be necessary, but do it just to	 * be safe. */	WriteDOC(tmp1, doc1->virtadr, AliasResolution);	return retval;}static const char im_name[] = "DoCMil_init";/* This routine is made available to other mtd code via * inter_module_register.  It must only be accessed through * inter_module_get which will bump the use count of this module.  The * addresses passed back in mtd are valid as long as the use count of * this module is non-zero, i.e. between inter_module_get and * inter_module_put.  Keith Owens <kaos@ocs.com.au> 29 Oct 2000. */static void DoCMil_init(struct mtd_info *mtd){	struct DiskOnChip *this = (struct DiskOnChip *)mtd->priv;	struct DiskOnChip *old = NULL;	/* We must avoid being called twice for the same device. */	if (docmillist)		old = (struct DiskOnChip *)docmillist->priv;	while (old) {		if (DoCMil_is_alias(this, old)) {			printk(KERN_NOTICE "Ignoring DiskOnChip Millennium at "			       "0x%lX - already configured\n", this->physadr);			iounmap((void *)this->virtadr);			kfree(mtd);			return;		}		if (old->nextdoc)			old = (struct DiskOnChip *)old->nextdoc->priv;		else			old = NULL;	}	mtd->name = "DiskOnChip Millennium";	printk(KERN_NOTICE "DiskOnChip Millennium found at address 0x%lX\n",	       this->physadr);	mtd->type = MTD_NANDFLASH;	mtd->flags = MTD_CAP_NANDFLASH;	mtd->size = 0;	/* FIXME: erase size is not always 8kB */	mtd->erasesize = 0x2000;	mtd->oobblock = 512;	mtd->oobsize = 16;	mtd->module = THIS_MODULE;	mtd->erase = doc_erase;	mtd->point = NULL;	mtd->unpoint = NULL;	mtd->read = doc_read;	mtd->write = doc_write;	mtd->read_ecc = doc_read_ecc;	mtd->write_ecc = doc_write_ecc;	mtd->read_oob = doc_read_oob;	mtd->write_oob = doc_write_oob;	mtd->sync = NULL;	this->totlen = 0;	this->numchips = 0;	this->curfloor = -1;	this->curchip = -1;	/* Ident all the chips present. */	DoC_ScanChips(this);	if (!this->totlen) {		kfree(mtd);		iounmap((void *)this->virtadr);	} else {		this->nextdoc = docmillist;		docmillist = mtd;		mtd->size  = this->totlen;		add_mtd_device(mtd);		return;	}}static int doc_read (struct mtd_info *mtd, loff_t from, size_t len,		     size_t *retlen, u_char *buf){	/* Just a special case of doc_read_ecc */	return doc_read_ecc(mtd, from, len, retlen, buf, NULL, 0);}static int doc_read_ecc (struct mtd_info *mtd, loff_t from, size_t len,			 size_t *retlen, u_char *buf, u_char *eccbuf, int oobsel){	int i, ret;	volatile char dummy;	unsigned char syndrome[6];	struct DiskOnChip *this = (struct DiskOnChip *)mtd->priv;	unsigned long docptr = this->virtadr;	struct Nand *mychip = &this->chips[from >> (this->chipshift)];	/* Don't allow read past end of device */	if (from >= this->totlen)		return -EINVAL;	/* Don't allow a single read to cross a 512-byte block boundary */	if (from + len > ((from | 0x1ff) + 1)) 		len = ((from | 0x1ff) + 1) - from;	/* Find the chip which is to be used and select it */	if (this->curfloor != mychip->floor) {		DoC_SelectFloor(docptr, mychip->floor);		DoC_SelectChip(docptr, mychip->chip);	} else if (this->curchip != mychip->chip) {		DoC_SelectChip(docptr, mychip->chip);	}	this->curfloor = mychip->floor;	this->curchip = mychip->chip;	/* issue the Read0 or Read1 command depend on which half of the page	   we are accessing. Polling the Flash Ready bit after issue 3 bytes	   address in Sequence Read Mode, see Software Requirement 11.4 item 1.*/	DoC_Command(docptr, (from >> 8) & 1, CDSN_CTRL_WP);	DoC_Address(docptr, 3, from, CDSN_CTRL_WP, 0x00);	DoC_WaitReady(docptr);