[PATCH] NAND I/O instruction support

[PATCH] NAND I/O instruction support

[William J Beksi]

[-- Attachment #1: Type: text/plain, Size: 332 bytes --]

This patch is to implement reading and writing nand flash by I/O 
instructions. I have only been able to test on the x86 architecture.

Questions, comments, criticisms are welcome.

-- 
William J Beksi                          <wjbeksi@users.sourceforge.net>
GPG Key Fingerprint = ED4B 32C3 69E6 C2B7 705C  263F CB2F 3253 E7E1 DB3B

[-- Attachment #2: nand_io_instr.patch --]
[-- Type: text/x-patch, Size: 3730 bytes --]

Index: drivers/mtd/nand/Kconfig
===================================================================
RCS file: /home/cvs/mtd/drivers/mtd/nand/Kconfig,v
retrieving revision 1.26
diff -u -r1.26 Kconfig
--- drivers/mtd/nand/Kconfig	5 Jan 2005 12:42:24 -0000	1.26
+++ drivers/mtd/nand/Kconfig	31 Mar 2005 13:17:18 -0000
@@ -203,5 +203,20 @@
 	help
 	  The simulator may simulate verious NAND flash chips for the
 	  MTD nand layer.
+
+config MTD_NAND_USE_IO_INSTR
+       bool "Support for NAND Flash through the I/0 ports"
+       depends on MTD_NAND && MTD_PARTITIONS
+       help
+         Enables the driver for accessing NAND Flash through the I/O
+         ports. This can allow NAND Flash to be accessed from the IDE interface 
+         of a PC. If you say Y, you will be asked to select your architecture 
+         below. 
+
+config MTD_NAND_X86_IO_INSTR
+	bool "Support for x86 architecture I/O instructions"
+	depends on MTD_NAND_USE_IO_INSTR
+        help
+         Port numbers are of type unsigned int.
  
 endmenu
Index: drivers/mtd/nand/nand_base.c
===================================================================
RCS file: /home/cvs/mtd/drivers/mtd/nand/nand_base.c,v
retrieving revision 1.137
diff -u -r1.137 nand_base.c
--- drivers/mtd/nand/nand_base.c	24 Mar 2005 14:33:22 -0000	1.137
+++ drivers/mtd/nand/nand_base.c	31 Mar 2005 13:17:26 -0000
@@ -84,6 +84,16 @@
 #include <linux/mtd/partitions.h>
 #endif
 
+#ifdef CONFIG_MTD_NAND_USE_IO_INSTR
+static int nand_use_io_instr = 1;
+#else
+static int nand_use_io_instr = 0;
+#endif
+
+#ifdef CONFIG_MTD_NAND_X86_IO_INSTR
+static int nand_x86_io_instr = 1;
+#endif
+
 /* Define default oob placement schemes for large and small page devices */
 static struct nand_oobinfo nand_oob_8 = {
 	.useecc = MTD_NANDECC_AUTOPLACE,
@@ -189,7 +199,14 @@
 static u_char nand_read_byte(struct mtd_info *mtd)
 {
 	struct nand_chip *this = mtd->priv;
-	return readb(this->IO_ADDR_R);
+
+	switch(nand_use_io_instr) {
+		case 0:
+			return readb(this->IO_ADDR_R);
+		case 1:
+			if (nand_x86_io_instr)
+				return inb((unsigned int) this->IO_ADDR_R);
+	}
 }
 
 /**
@@ -202,7 +219,16 @@
 static void nand_write_byte(struct mtd_info *mtd, u_char byte)
 {
 	struct nand_chip *this = mtd->priv;
-	writeb(byte, this->IO_ADDR_W);
+
+	switch(nand_use_io_instr) {
+		case 0:
+			writeb(byte, this->IO_ADDR_W);
+			break;
+		case 1:
+			if (nand_x86_io_instr)
+				outb(byte, (unsigned int) this->IO_ADDR_W);
+			break;
+	}
 }
 
 /**
@@ -295,8 +321,17 @@
 	int i;
 	struct nand_chip *this = mtd->priv;
 
-	for (i=0; i<len; i++)
-		writeb(buf[i], this->IO_ADDR_W);
+	switch(nand_use_io_instr) {
+		case 0:
+			for (i=0; i<len; i++)
+				writeb(buf[i], this->IO_ADDR_W);
+			break;
+		case 1:
+			for (i=0; i<len; i++)
+				if (nand_x86_io_instr)
+					outb(buf[i], (unsigned int) this->IO_ADDR_W);
+			break;
+	}
 }
 
 /**
@@ -312,8 +347,17 @@
 	int i;
 	struct nand_chip *this = mtd->priv;
 
-	for (i=0; i<len; i++)
-		buf[i] = readb(this->IO_ADDR_R);
+	switch(nand_use_io_instr) {
+		case 0:
+			for (i=0; i<len; i++)
+				buf[i] = readb(this->IO_ADDR_R);
+			break;
+		case 1:
+			for (i=0; i<len; i++)
+				if (nand_x86_io_instr)
+					buf[i] = inb((unsigned int) this->IO_ADDR_R);
+			break;
+	}
 }
 
 /**
@@ -329,10 +373,19 @@
 	int i;
 	struct nand_chip *this = mtd->priv;
 
-	for (i=0; i<len; i++)
-		if (buf[i] != readb(this->IO_ADDR_R))
-			return -EFAULT;
-
+	switch(nand_use_io_instr) {
+		case 0:
+			for (i=0; i<len; i++)
+				if (buf[i] != readb(this->IO_ADDR_R))
+					return -EFAULT;
+			break;
+		case 1:
+			for (i=0; i<len; i++)
+				if (nand_x86_io_instr) 
+					if (buf[i] != inb((unsigned int) this->IO_ADDR_R))
+						return -EFAULT;
+			break;
+	}
 	return 0;
 }
 

Re: [PATCH] NAND I/O instruction support

[Artem B. Bityuckiy]

William J Beksi wrote:
> This patch is to implement reading and writing nand flash by I/O 
> instructions. I have only been able to test on the x86 architecture.
> 
> Questions, comments, criticisms are welcome.
Why didn't you use request_region()/release_region() to allocate IO ports?

I wonder, for what do you need this? Shouldn't you redefine 
nand_read_byte() and the like *in your driver* instead.

-- 
Best Regards,
Artem B. Bityuckiy,
St.-Petersburg, Russia.

Re: [PATCH] NAND I/O instruction support

[William J Beksi]

[-- Attachment #1: Type: text/plain, Size: 936 bytes --]

Hi Artem,

Artem B. Bityuckiy wrote:
> 
> 
> William J Beksi wrote:
> 
>> This patch is to implement reading and writing nand flash by I/O 
>> instructions. I have only been able to test on the x86 architecture.
>>
>> Questions, comments, criticisms are welcome.
> 
> Why didn't you use request_region()/release_region() to allocate IO ports?
> 
> I wonder, for what do you need this? 
Because I want to use the *same* I/O port range as that used by the IDE 
interface on a PC. I think a look at my driver below will make things 
clearer ;)

> Shouldn't you redefine nand_read_byte() and the like *in your driver* instead.
Sure, it can be done like that. I am just not sure if this feature would 
be useful to other driver writers in the future, that is why I tried to 
make it as general as possible.

Thomas, should read/write using inb/outb be in my driver, or should this 
be in nand_base.c?

Thanks for your comments.
--
William



[-- Attachment #2: ide.c --]
[-- Type: text/x-csrc, Size: 3946 bytes --]

/* drivers/mtd/nand/ide.c
 *
 * Copyright (C) 2004  William J Beksi <wjbeksi@users.sourceforge.net> 
 *
 * Overview:
 *  This device driver allows a NAND flash device to be accessed from
 *  an IDE interface.  
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or 
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
 */

#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/mtd/mtd.h>
#include <linux/mtd/nand.h>
#include <linux/mtd/partitions.h>
#include <linux/delay.h>
#include <asm/io.h>

/*
 * Values specific to the IDE
 */
#define IDE_IO_BASE_1 0x1F0		/* IDE1 NAND flash I/O base address */
#define IDE_IO_BASE_2 0x170		/* IDE2 NAND flash I/O base address */

#define IDE_IO_BASE IDE_IO_BASE_1

/*
 * IDE MTD structure
 */
static struct mtd_info *ide_mtd = NULL;

/*
 * Define partitions for flash device
 */
const static struct mtd_partition partition_info[] = {
	{ 
		.name   = "IDE flash partition 1", 
		.offset = 0,  
		.size   = 4*1024*1024 
	},
	{
		.name   = "IDE flash partition 2",
		.offset = 4*1024*1024,
		.size   = 4*1024*1024
	}
};
#define NUM_PARTITIONS  2 

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

	switch (cmd) {
		case NAND_CTL_SETCLE: this->IO_ADDR_W = (unsigned char *) IDE_IO_BASE+1; break;
		case NAND_CTL_CLRCLE: this->IO_ADDR_W = (unsigned char *) IDE_IO_BASE;   break;
		case NAND_CTL_SETALE: this->IO_ADDR_W = (unsigned char *) IDE_IO_BASE+2; break;	
		case NAND_CTL_CLRALE: this->IO_ADDR_W = (unsigned char *) IDE_IO_BASE;   break;
	}
}

/*
 * Main initialization routine
 */
int __init ide_init(void)
{
	struct nand_chip *this;
	int err = 0;

	/* Allocate memory for MTD device structure and private data */
	ide_mtd = kmalloc(sizeof(struct mtd_info) + sizeof(struct nand_chip), GFP_KERNEL);
	if (!ide_mtd) {
		printk("Unable to allocate IDE NAND MTD structure\n");
		err = -ENOMEM; 
		goto out;
	}

	/* Initialize structures */
	memset((char *) ide_mtd, 0, sizeof(struct mtd_info) + sizeof(struct nand_chip));

	/* Get pointer to private data */
	this = (struct nand_chip *) (&ide_mtd[1]);
	/* Link the private data with the MTD structure */
	ide_mtd->priv = this;

	/* Set address of NAND IO lines */
	this->IO_ADDR_R  = (void __iomem *) IDE_IO_BASE;
	this->IO_ADDR_W  = (void __iomem *) IDE_IO_BASE;
	/* Reference hardware control function */
	this->hwcontrol = ide_hwcontrol;
	/* Set command delay time */
	this->chip_delay = 20;
	/* Assign the device ready function */
	this->dev_ready = NULL;
	/* Set the ECC generator mode */
	this->eccmode = NAND_ECC_SOFT;

	/* Scan to find existance of the device */
	if (nand_scan(ide_mtd, 1)) {
		err = -ENXIO;
		goto out_mtd;
	}

	/* Register the partitions */
	add_mtd_partitions(ide_mtd, partition_info, NUM_PARTITIONS);
	goto out;

out_mtd:
	kfree(ide_mtd);
out:
	return err;
}
module_init(ide_init);

/*
 * Clean up routine
 */
#ifdef MODULE
static void __exit ide_cleanup (void)
{
	/* Release resources, unregister the device */
	nand_release(ide_mtd);	

	/* Free the MTD device structure */
	kfree(ide_mtd);
}
module_exit(ide_cleanup);
#endif

MODULE_LICENSE("GPL");
MODULE_AUTHOR("William J Beksi <wjbeksi@users.sourceforge.net>");
MODULE_DESCRIPTION("Glue layer for NAND flash through an IDE interface");

Re: [PATCH] NAND I/O instruction support

[Artem B. Bityuckiy]

On Wed, 2005-04-06 at 10:39 +0800, William J Beksi wrote:
> Because I want to use the *same* I/O port range as that used by the IDE 
> interface on a PC. I think a look at my driver below will make things 
> clearer ;)
Then this is rather hack then a standard thing. Hacks should stay in
drivers IMO.

-- 
Best Regards,
Artem B. Bityuckiy,
St.-Petersburg, Russia.