[net-next-2.6.git] / drivers / mtd / nand / excite_nandflash.c

/*
*  Copyright (C) 2005 - 2007 by Basler Vision Technologies AG
*  Author: Thomas Koeller <thomas.koeller.qbaslerweb.com>
*  Original code by Thies Moeller <thies.moeller@baslerweb.com>
*
*  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-1307  USA
*/

#include <linux/module.h>
#include <linux/types.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/ioport.h>
#include <linux/platform_device.h>
#include <linux/delay.h>
#include <linux/err.h>

#include <linux/mtd/mtd.h>
#include <linux/mtd/nand.h>
#include <linux/mtd/nand_ecc.h>
#include <linux/mtd/partitions.h>

#include <asm/io.h>
#include <asm/rm9k-ocd.h>

#include <excite_nandflash.h>

#define EXCITE_NANDFLASH_VERSION "0.1"

/* I/O register offsets */
#define EXCITE_NANDFLASH_DATA_BYTE   0x00
#define EXCITE_NANDFLASH_STATUS_BYTE 0x0c
#define EXCITE_NANDFLASH_ADDR_BYTE   0x10
#define EXCITE_NANDFLASH_CMD_BYTE    0x14

/* prefix for debug output */
static const char module_id[] = "excite_nandflash";

/*
 * partition definition
 */
static const struct mtd_partition partition_info[] = {
	{
		.name = "eXcite RootFS",
		.offset = 0,
		.size = MTDPART_SIZ_FULL
	}
};

static inline const struct resource *
excite_nand_get_resource(struct platform_device *d, unsigned long flags,
			 const char *basename)
{
	char buf[80];

	if (snprintf(buf, sizeof buf, "%s_%u", basename, d->id) >= sizeof buf)
		return NULL;
	return platform_get_resource_byname(d, flags, buf);
}

static inline void __iomem *
excite_nand_map_regs(struct platform_device *d, const char *basename)
{
	void *result = NULL;
	const struct resource *const r =
	    excite_nand_get_resource(d, IORESOURCE_MEM, basename);

	if (r)
		result = ioremap_nocache(r->start, r->end + 1 - r->start);
	return result;
}

/* controller and mtd information */
struct excite_nand_drvdata {
	struct mtd_info board_mtd;
	struct nand_chip board_chip;
	void __iomem *regs;
	void __iomem *tgt;
};

/* Control function */
static void excite_nand_control(struct mtd_info *mtd, int cmd,
				       unsigned int ctrl)
{
	struct excite_nand_drvdata * const d =
	    container_of(mtd, struct excite_nand_drvdata, board_mtd);

	switch (ctrl) {
	case NAND_CTRL_CHANGE | NAND_CTRL_CLE:
		d->tgt = d->regs + EXCITE_NANDFLASH_CMD_BYTE;
		break;
	case NAND_CTRL_CHANGE | NAND_CTRL_ALE:
		d->tgt = d->regs + EXCITE_NANDFLASH_ADDR_BYTE;
		break;
	case NAND_CTRL_CHANGE | NAND_NCE:
		d->tgt = d->regs + EXCITE_NANDFLASH_DATA_BYTE;
		break;
	}

	if (cmd != NAND_CMD_NONE)
		__raw_writeb(cmd, d->tgt);
}

/* Return 0 if flash is busy, 1 if ready */
static int excite_nand_devready(struct mtd_info *mtd)
{
	struct excite_nand_drvdata * const drvdata =
	    container_of(mtd, struct excite_nand_drvdata, board_mtd);

	return __raw_readb(drvdata->regs + EXCITE_NANDFLASH_STATUS_BYTE);
}

/*
 * Called by device layer to remove the driver.
 * The binding to the mtd and all allocated
 * resources are released.
 */
static int __devexit excite_nand_remove(struct platform_device *dev)
{
	struct excite_nand_drvdata * const this = platform_get_drvdata(dev);

	platform_set_drvdata(dev, NULL);

	if (unlikely(!this)) {
		printk(KERN_ERR "%s: called %s without private data!!",
		       module_id, __func__);
		return -EINVAL;
	}

	/* first thing we need to do is release our mtd
	 * then go through freeing the resource used
	 */
	nand_release(&this->board_mtd);

	/* free the common resources */
	iounmap(this->regs);
	kfree(this);

	DEBUG(MTD_DEBUG_LEVEL1, "%s: removed\n", module_id);
	return 0;
}

/*
 * Called by device layer when it finds a device matching
 * one our driver can handle. This code checks to see if
 * it can allocate all necessary resources then calls the
 * nand layer to look for devices.
*/
static int __init excite_nand_probe(struct platform_device *pdev)
{
	struct excite_nand_drvdata *drvdata;	/* private driver data */
	struct nand_chip *board_chip;	/* private flash chip data */
	struct mtd_info *board_mtd;	/* mtd info for this board */
	int scan_res;

	drvdata = kzalloc(sizeof(*drvdata), GFP_KERNEL);
	if (unlikely(!drvdata)) {
		printk(KERN_ERR "%s: no memory for drvdata\n",
		       module_id);
		return -ENOMEM;
	}

	/* bind private data into driver */
	platform_set_drvdata(pdev, drvdata);

	/* allocate and map the resource */
	drvdata->regs =
		excite_nand_map_regs(pdev, EXCITE_NANDFLASH_RESOURCE_REGS);

	if (unlikely(!drvdata->regs)) {
		printk(KERN_ERR "%s: cannot reserve register region\n",
		       module_id);
		kfree(drvdata);
		return -ENXIO;
	}
	
	drvdata->tgt = drvdata->regs + EXCITE_NANDFLASH_DATA_BYTE;

	/* initialise our chip */
	board_chip = &drvdata->board_chip;
	board_chip->IO_ADDR_R = board_chip->IO_ADDR_W =
		drvdata->regs + EXCITE_NANDFLASH_DATA_BYTE;
	board_chip->cmd_ctrl = excite_nand_control;
	board_chip->dev_ready = excite_nand_devready;
	board_chip->chip_delay = 25;
	board_chip->ecc.mode = NAND_ECC_SOFT;

	/* link chip to mtd */
	board_mtd = &drvdata->board_mtd;
	board_mtd->priv = board_chip;

	DEBUG(MTD_DEBUG_LEVEL2, "%s: device scan\n", module_id);
	scan_res = nand_scan(&drvdata->board_mtd, 1);

	if (likely(!scan_res)) {
		DEBUG(MTD_DEBUG_LEVEL2, "%s: register partitions\n", module_id);
		add_mtd_partitions(&drvdata->board_mtd, partition_info,
				   ARRAY_SIZE(partition_info));
	} else {
		iounmap(drvdata->regs);
		kfree(drvdata);
		printk(KERN_ERR "%s: device scan failed\n", module_id);
		return -EIO;
	}
	return 0;
}

static struct platform_driver excite_nand_driver = {
	.driver = {
		.name = "excite_nand",
		.owner		= THIS_MODULE,
	},
	.probe = excite_nand_probe,
	.remove = __devexit_p(excite_nand_remove)
};

static int __init excite_nand_init(void)
{
	pr_info("Basler eXcite nand flash driver Version "
		EXCITE_NANDFLASH_VERSION "\n");
	return platform_driver_register(&excite_nand_driver);
}

static void __exit excite_nand_exit(void)
{
	platform_driver_unregister(&excite_nand_driver);
}

module_init(excite_nand_init);
module_exit(excite_nand_exit);

MODULE_AUTHOR("Thomas Koeller <thomas.koeller@baslerweb.com>");
MODULE_DESCRIPTION("Basler eXcite NAND-Flash driver");
MODULE_LICENSE("GPL");
MODULE_VERSION(EXCITE_NANDFLASH_VERSION)
Commit	Line	Data
67a9c7af TK	1	/*
	2	* Copyright (C) 2005 - 2007 by Basler Vision Technologies AG
	3	* Author: Thomas Koeller <thomas.koeller.qbaslerweb.com>
	4	* Original code by Thies Moeller <thies.moeller@baslerweb.com>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	19	*/
	20
	21	#include <linux/module.h>
	22	#include <linux/types.h>
	23	#include <linux/init.h>
	24	#include <linux/kernel.h>
	25	#include <linux/string.h>
	26	#include <linux/ioport.h>
	27	#include <linux/platform_device.h>
	28	#include <linux/delay.h>
	29	#include <linux/err.h>
67a9c7af TK	30
	31	#include <linux/mtd/mtd.h>
	32	#include <linux/mtd/nand.h>
	33	#include <linux/mtd/nand_ecc.h>
	34	#include <linux/mtd/partitions.h>
	35
	36	#include <asm/io.h>
	37	#include <asm/rm9k-ocd.h>
	38
	39	#include <excite_nandflash.h>
	40
	41	#define EXCITE_NANDFLASH_VERSION "0.1"
	42
	43	/* I/O register offsets */
	44	#define EXCITE_NANDFLASH_DATA_BYTE 0x00
	45	#define EXCITE_NANDFLASH_STATUS_BYTE 0x0c
	46	#define EXCITE_NANDFLASH_ADDR_BYTE 0x10
	47	#define EXCITE_NANDFLASH_CMD_BYTE 0x14
	48
	49	/* prefix for debug output */
	50	static const char module_id[] = "excite_nandflash";
	51
	52	/*
	53	* partition definition
	54	*/
	55	static const struct mtd_partition partition_info[] = {
	56	{
	57	.name = "eXcite RootFS",
	58	.offset = 0,
	59	.size = MTDPART_SIZ_FULL
	60	}
	61	};
	62
	63	static inline const struct resource *
	64	excite_nand_get_resource(struct platform_device *d, unsigned long flags,
	65	const char *basename)
	66	{
	67	char buf[80];
	68
	69	if (snprintf(buf, sizeof buf, "%s_%u", basename, d->id) >= sizeof buf)
	70	return NULL;
	71	return platform_get_resource_byname(d, flags, buf);
	72	}
	73
	74	static inline void __iomem *
	75	excite_nand_map_regs(struct platform_device d, const char basename)
	76	{
	77	void *result = NULL;
	78	const struct resource *const r =
	79	excite_nand_get_resource(d, IORESOURCE_MEM, basename);
	80
	81	if (r)
	82	result = ioremap_nocache(r->start, r->end + 1 - r->start);
	83	return result;
	84	}
	85
	86	/* controller and mtd information */
	87	struct excite_nand_drvdata {
	88	struct mtd_info board_mtd;
	89	struct nand_chip board_chip;
	90	void __iomem *regs;
	91	void __iomem *tgt;
	92	};
	93
94	/* Control function */
95	static void excite_nand_control(struct mtd_info *mtd, int cmd,
96	unsigned int ctrl)
97	{
98	struct excite_nand_drvdata * const d =
99	container_of(mtd, struct excite_nand_drvdata, board_mtd);
100
101	switch (ctrl) {
102	case NAND_CTRL_CHANGE \| NAND_CTRL_CLE:
103	d->tgt = d->regs + EXCITE_NANDFLASH_CMD_BYTE;
104	break;
105	case NAND_CTRL_CHANGE \| NAND_CTRL_ALE:
106	d->tgt = d->regs + EXCITE_NANDFLASH_ADDR_BYTE;
107	break;
108	case NAND_CTRL_CHANGE \| NAND_NCE:
109	d->tgt = d->regs + EXCITE_NANDFLASH_DATA_BYTE;
110	break;
111	}
112
113	if (cmd != NAND_CMD_NONE)
114	__raw_writeb(cmd, d->tgt);
115	}
116
117	/* Return 0 if flash is busy, 1 if ready */
118	static int excite_nand_devready(struct mtd_info *mtd)
119	{
120	struct excite_nand_drvdata * const drvdata =
121	container_of(mtd, struct excite_nand_drvdata, board_mtd);
122
123	return __raw_readb(drvdata->regs + EXCITE_NANDFLASH_STATUS_BYTE);
124	}
125
126	/*
127	* Called by device layer to remove the driver.
128	* The binding to the mtd and all allocated
129	* resources are released.
130	*/
8fead79c	131	static int __devexit excite_nand_remove(struct platform_device *dev)
67a9c7af	132	{
7a192ec3	133	struct excite_nand_drvdata * const this = platform_get_drvdata(dev);
67a9c7af	134
7a192ec3	135	platform_set_drvdata(dev, NULL);
67a9c7af TK	136
	137	if (unlikely(!this)) {
	138	printk(KERN_ERR "%s: called %s without private data!!",
	139	module_id, __func__);
	140	return -EINVAL;
	141	}
	142
	143	/* first thing we need to do is release our mtd
	144	* then go through freeing the resource used
	145	*/
	146	nand_release(&this->board_mtd);
	147
	148	/* free the common resources */
	149	iounmap(this->regs);
	150	kfree(this);
	151
	152	DEBUG(MTD_DEBUG_LEVEL1, "%s: removed\n", module_id);
	153	return 0;
	154	}
	155
	156	/*
	157	* Called by device layer when it finds a device matching
	158	* one our driver can handle. This code checks to see if
	159	* it can allocate all necessary resources then calls the
	160	* nand layer to look for devices.
	161	*/
7a192ec3	162	static int __init excite_nand_probe(struct platform_device *pdev)
67a9c7af	163	{
67a9c7af TK	164	struct excite_nand_drvdata drvdata; / private driver data */
	165	struct nand_chip board_chip; / private flash chip data */
	166	struct mtd_info board_mtd; / mtd info for this board */
	167	int scan_res;
	168
	169	drvdata = kzalloc(sizeof(*drvdata), GFP_KERNEL);
	170	if (unlikely(!drvdata)) {
	171	printk(KERN_ERR "%s: no memory for drvdata\n",
	172	module_id);
	173	return -ENOMEM;
	174	}
	175
	176	/* bind private data into driver */
7a192ec3	177	platform_set_drvdata(pdev, drvdata);
67a9c7af TK	178
	179	/* allocate and map the resource */
	180	drvdata->regs =
	181	excite_nand_map_regs(pdev, EXCITE_NANDFLASH_RESOURCE_REGS);
	182
	183	if (unlikely(!drvdata->regs)) {
	184	printk(KERN_ERR "%s: cannot reserve register region\n",
	185	module_id);
	186	kfree(drvdata);
	187	return -ENXIO;
	188	}
	189
	190	drvdata->tgt = drvdata->regs + EXCITE_NANDFLASH_DATA_BYTE;
	191
	192	/* initialise our chip */
	193	board_chip = &drvdata->board_chip;
	194	board_chip->IO_ADDR_R = board_chip->IO_ADDR_W =
	195	drvdata->regs + EXCITE_NANDFLASH_DATA_BYTE;
	196	board_chip->cmd_ctrl = excite_nand_control;
	197	board_chip->dev_ready = excite_nand_devready;
	198	board_chip->chip_delay = 25;
	199	board_chip->ecc.mode = NAND_ECC_SOFT;
	200
	201	/* link chip to mtd */
	202	board_mtd = &drvdata->board_mtd;
	203	board_mtd->priv = board_chip;
	204
	205	DEBUG(MTD_DEBUG_LEVEL2, "%s: device scan\n", module_id);
	206	scan_res = nand_scan(&drvdata->board_mtd, 1);
	207
	208	if (likely(!scan_res)) {
	209	DEBUG(MTD_DEBUG_LEVEL2, "%s: register partitions\n", module_id);
	210	add_mtd_partitions(&drvdata->board_mtd, partition_info,
ff0de61c	211	ARRAY_SIZE(partition_info));
67a9c7af TK	212	} else {
	213	iounmap(drvdata->regs);
	214	kfree(drvdata);
	215	printk(KERN_ERR "%s: device scan failed\n", module_id);
	216	return -EIO;
	217	}
	218	return 0;
	219	}
	220
7a192ec3 ML	221	static struct platform_driver excite_nand_driver = {
	222	.driver = {
	223	.name = "excite_nand",
	224	.owner = THIS_MODULE,
	225	},
67a9c7af	226	.probe = excite_nand_probe,
7a192ec3	227	.remove = __devexit_p(excite_nand_remove)
67a9c7af TK	228	};
	229
	230	static int __init excite_nand_init(void)
	231	{
	232	pr_info("Basler eXcite nand flash driver Version "
	233	EXCITE_NANDFLASH_VERSION "\n");
7a192ec3	234	return platform_driver_register(&excite_nand_driver);
67a9c7af TK	235	}
	236
	237	static void __exit excite_nand_exit(void)
	238	{
7a192ec3	239	platform_driver_unregister(&excite_nand_driver);
67a9c7af TK	240	}
	241
	242	module_init(excite_nand_init);
	243	module_exit(excite_nand_exit);
	244
	245	MODULE_AUTHOR("Thomas Koeller <thomas.koeller@baslerweb.com>");
	246	MODULE_DESCRIPTION("Basler eXcite NAND-Flash driver");
	247	MODULE_LICENSE("GPL");
	248	MODULE_VERSION(EXCITE_NANDFLASH_VERSION)