[deliverable/linux.git] / drivers / mtd / nand / cmx270_nand.c

/*
 *  linux/drivers/mtd/nand/cmx270-nand.c
 *
 *  Copyright (C) 2006 Compulab, Ltd.
 *  Mike Rapoport <mike@compulab.co.il>
 *
 *  Derived from drivers/mtd/nand/h1910.c
 *       Copyright (C) 2002 Marius Gröger (mag@sysgo.de)
 *       Copyright (c) 2001 Thomas Gleixner (gleixner@autronix.de)
 *
 *
 * 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.
 *
 *  Overview:
 *   This is a device driver for the NAND flash device found on the
 *   CM-X270 board.
 */

#include <linux/mtd/nand.h>
#include <linux/mtd/partitions.h>
#include <linux/slab.h>
#include <linux/gpio.h>
#include <linux/module.h>

#include <asm/io.h>
#include <asm/irq.h>
#include <asm/mach-types.h>

#include <mach/pxa2xx-regs.h>

#define GPIO_NAND_CS	(11)
#define GPIO_NAND_RB	(89)

/* MTD structure for CM-X270 board */
static struct mtd_info *cmx270_nand_mtd;

/* remaped IO address of the device */
static void __iomem *cmx270_nand_io;

/*
 * Define static partitions for flash device
 */
static struct mtd_partition partition_info[] = {
	[0] = {
		.name	= "cmx270-0",
		.offset	= 0,
		.size	= MTDPART_SIZ_FULL
	}
};
#define NUM_PARTITIONS (ARRAY_SIZE(partition_info))

static u_char cmx270_read_byte(struct mtd_info *mtd)
{
	struct nand_chip *this = mtd->priv;

	return (readl(this->IO_ADDR_R) >> 16);
}

static void cmx270_write_buf(struct mtd_info *mtd, const u_char *buf, int len)
{
	int i;
	struct nand_chip *this = mtd->priv;

	for (i=0; i<len; i++)
		writel((*buf++ << 16), this->IO_ADDR_W);
}

static void cmx270_read_buf(struct mtd_info *mtd, u_char *buf, int len)
{
	int i;
	struct nand_chip *this = mtd->priv;

	for (i=0; i<len; i++)
		*buf++ = readl(this->IO_ADDR_R) >> 16;
}

static int cmx270_verify_buf(struct mtd_info *mtd, const u_char *buf, int len)
{
	int i;
	struct nand_chip *this = mtd->priv;

	for (i=0; i<len; i++)
		if (buf[i] != (u_char)(readl(this->IO_ADDR_R) >> 16))
			return -EFAULT;

	return 0;
}

static inline void nand_cs_on(void)
{
	gpio_set_value(GPIO_NAND_CS, 0);
}

static void nand_cs_off(void)
{
	dsb();

	gpio_set_value(GPIO_NAND_CS, 1);
}

/*
 *	hardware specific access to control-lines
 */
static void cmx270_hwcontrol(struct mtd_info *mtd, int dat,
			     unsigned int ctrl)
{
	struct nand_chip* this = mtd->priv;
	unsigned int nandaddr = (unsigned int)this->IO_ADDR_W;

	dsb();

	if (ctrl & NAND_CTRL_CHANGE) {
		if ( ctrl & NAND_ALE )
			nandaddr |=  (1 << 3);
		else
			nandaddr &= ~(1 << 3);
		if ( ctrl & NAND_CLE )
			nandaddr |=  (1 << 2);
		else
			nandaddr &= ~(1 << 2);
		if ( ctrl & NAND_NCE )
			nand_cs_on();
		else
			nand_cs_off();
	}

	dsb();
	this->IO_ADDR_W = (void __iomem*)nandaddr;
	if (dat != NAND_CMD_NONE)
		writel((dat << 16), this->IO_ADDR_W);

	dsb();
}

/*
 *	read device ready pin
 */
static int cmx270_device_ready(struct mtd_info *mtd)
{
	dsb();

	return (gpio_get_value(GPIO_NAND_RB));
}

/*
 * Main initialization routine
 */
static int __init cmx270_init(void)
{
	struct nand_chip *this;
	int ret;

	if (!(machine_is_armcore() && cpu_is_pxa27x()))
		return -ENODEV;

	ret = gpio_request(GPIO_NAND_CS, "NAND CS");
	if (ret) {
		pr_warning("CM-X270: failed to request NAND CS gpio\n");
		return ret;
	}

	gpio_direction_output(GPIO_NAND_CS, 1);

	ret = gpio_request(GPIO_NAND_RB, "NAND R/B");
	if (ret) {
		pr_warning("CM-X270: failed to request NAND R/B gpio\n");
		goto err_gpio_request;
	}

	gpio_direction_input(GPIO_NAND_RB);

	/* Allocate memory for MTD device structure and private data */
	cmx270_nand_mtd = kzalloc(sizeof(struct mtd_info) +
				  sizeof(struct nand_chip),
				  GFP_KERNEL);
	if (!cmx270_nand_mtd) {
		pr_debug("Unable to allocate CM-X270 NAND MTD device structure.\n");
		ret = -ENOMEM;
		goto err_kzalloc;
	}

	cmx270_nand_io = ioremap(PXA_CS1_PHYS, 12);
	if (!cmx270_nand_io) {
		pr_debug("Unable to ioremap NAND device\n");
		ret = -EINVAL;
		goto err_ioremap;
	}

	/* Get pointer to private data */
	this = (struct nand_chip *)(&cmx270_nand_mtd[1]);

	/* Link the private data with the MTD structure */
	cmx270_nand_mtd->owner = THIS_MODULE;
	cmx270_nand_mtd->priv = this;

	/* insert callbacks */
	this->IO_ADDR_R = cmx270_nand_io;
	this->IO_ADDR_W = cmx270_nand_io;
	this->cmd_ctrl = cmx270_hwcontrol;
	this->dev_ready = cmx270_device_ready;

	/* 15 us command delay time */
	this->chip_delay = 20;
	this->ecc.mode = NAND_ECC_SOFT;

	/* read/write functions */
	this->read_byte = cmx270_read_byte;
	this->read_buf = cmx270_read_buf;
	this->write_buf = cmx270_write_buf;
	this->verify_buf = cmx270_verify_buf;

	/* Scan to find existence of the device */
	if (nand_scan (cmx270_nand_mtd, 1)) {
		pr_notice("No NAND device\n");
		ret = -ENXIO;
		goto err_scan;
	}

	/* Register the partitions */
	ret = mtd_device_parse_register(cmx270_nand_mtd, NULL, 0,
					partition_info, NUM_PARTITIONS);
	if (ret)
		goto err_scan;

	/* Return happy */
	return 0;

err_scan:
	iounmap(cmx270_nand_io);
err_ioremap:
	kfree(cmx270_nand_mtd);
err_kzalloc:
	gpio_free(GPIO_NAND_RB);
err_gpio_request:
	gpio_free(GPIO_NAND_CS);

	return ret;

}
module_init(cmx270_init);

/*
 * Clean up routine
 */
static void __exit cmx270_cleanup(void)
{
	/* Release resources, unregister device */
	nand_release(cmx270_nand_mtd);

	gpio_free(GPIO_NAND_RB);
	gpio_free(GPIO_NAND_CS);

	iounmap(cmx270_nand_io);

	/* Free the MTD device structure */
	kfree (cmx270_nand_mtd);
}
module_exit(cmx270_cleanup);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Mike Rapoport <mike@compulab.co.il>");
MODULE_DESCRIPTION("NAND flash driver for Compulab CM-X270 Module");
Commit	Line	Data
54d33c4c MR	1	/*
	2	* linux/drivers/mtd/nand/cmx270-nand.c
	3	*
	4	* Copyright (C) 2006 Compulab, Ltd.
	5	* Mike Rapoport <mike@compulab.co.il>
	6	*
	7	* Derived from drivers/mtd/nand/h1910.c
	8	* Copyright (C) 2002 Marius Gröger (mag@sysgo.de)
	9	* Copyright (c) 2001 Thomas Gleixner (gleixner@autronix.de)
	10	*
	11	*
	12	* This program is free software; you can redistribute it and/or modify
	13	* it under the terms of the GNU General Public License version 2 as
	14	* published by the Free Software Foundation.
	15	*
	16	* Overview:
	17	* This is a device driver for the NAND flash device found on the
	18	* CM-X270 board.
	19	*/
	20
	21	#include <linux/mtd/nand.h>
	22	#include <linux/mtd/partitions.h>
5a0e3ad6	23	#include <linux/slab.h>
70eb33d6	24	#include <linux/gpio.h>
a0e5cc58	25	#include <linux/module.h>
54d33c4c MR	26
	27	#include <asm/io.h>
	28	#include <asm/irq.h>
70eb33d6	29	#include <asm/mach-types.h>
54d33c4c	30
b74d1969	31	#include <mach/pxa2xx-regs.h>
54d33c4c MR	32
	33	#define GPIO_NAND_CS (11)
	34	#define GPIO_NAND_RB (89)
	35
54d33c4c MR	36	/* MTD structure for CM-X270 board */
	37	static struct mtd_info *cmx270_nand_mtd;
	38
	39	/* remaped IO address of the device */
	40	static void __iomem *cmx270_nand_io;
	41
	42	/*
	43	* Define static partitions for flash device
	44	*/
	45	static struct mtd_partition partition_info[] = {
	46	[0] = {
	47	.name = "cmx270-0",
	48	.offset = 0,
	49	.size = MTDPART_SIZ_FULL
	50	}
	51	};
	52	#define NUM_PARTITIONS (ARRAY_SIZE(partition_info))
	53
54d33c4c MR	54	static u_char cmx270_read_byte(struct mtd_info *mtd)
	55	{
	56	struct nand_chip *this = mtd->priv;
	57
	58	return (readl(this->IO_ADDR_R) >> 16);
	59	}
	60
	61	static void cmx270_write_buf(struct mtd_info mtd, const u_char buf, int len)
	62	{
	63	int i;
	64	struct nand_chip *this = mtd->priv;
	65
	66	for (i=0; i<len; i++)
	67	writel((*buf++ << 16), this->IO_ADDR_W);
	68	}
	69
	70	static void cmx270_read_buf(struct mtd_info mtd, u_char buf, int len)
	71	{
	72	int i;
	73	struct nand_chip *this = mtd->priv;
	74
	75	for (i=0; i<len; i++)
	76	*buf++ = readl(this->IO_ADDR_R) >> 16;
	77	}
	78
	79	static int cmx270_verify_buf(struct mtd_info mtd, const u_char buf, int len)
	80	{
	81	int i;
	82	struct nand_chip *this = mtd->priv;
	83
	84	for (i=0; i<len; i++)
	85	if (buf[i] != (u_char)(readl(this->IO_ADDR_R) >> 16))
	86	return -EFAULT;
	87
	88	return 0;
	89	}
	90
	91	static inline void nand_cs_on(void)
	92	{
70eb33d6	93	gpio_set_value(GPIO_NAND_CS, 0);
54d33c4c MR	94	}
	95
	96	static void nand_cs_off(void)
	97	{
70eb33d6	98	dsb();
54d33c4c	99
70eb33d6	100	gpio_set_value(GPIO_NAND_CS, 1);
54d33c4c MR	101	}
	102
	103	/*
	104	* hardware specific access to control-lines
	105	*/
	106	static void cmx270_hwcontrol(struct mtd_info *mtd, int dat,
	107	unsigned int ctrl)
	108	{
	109	struct nand_chip* this = mtd->priv;
	110	unsigned int nandaddr = (unsigned int)this->IO_ADDR_W;
	111
70eb33d6	112	dsb();
54d33c4c MR	113
	114	if (ctrl & NAND_CTRL_CHANGE) {
	115	if ( ctrl & NAND_ALE )
	116	nandaddr \|= (1 << 3);
	117	else
	118	nandaddr &= ~(1 << 3);
	119	if ( ctrl & NAND_CLE )
	120	nandaddr \|= (1 << 2);
	121	else
	122	nandaddr &= ~(1 << 2);
	123	if ( ctrl & NAND_NCE )
	124	nand_cs_on();
	125	else
	126	nand_cs_off();
	127	}
	128
70eb33d6	129	dsb();
54d33c4c MR	130	this->IO_ADDR_W = (void __iomem*)nandaddr;
	131	if (dat != NAND_CMD_NONE)
	132	writel((dat << 16), this->IO_ADDR_W);
	133
70eb33d6	134	dsb();
54d33c4c MR	135	}
	136
	137	/*
	138	* read device ready pin
	139	*/
	140	static int cmx270_device_ready(struct mtd_info *mtd)
	141	{
70eb33d6	142	dsb();
54d33c4c	143
70eb33d6	144	return (gpio_get_value(GPIO_NAND_RB));
54d33c4c MR	145	}
	146
	147	/*
	148	* Main initialization routine
	149	*/
627df23c	150	static int __init cmx270_init(void)
54d33c4c MR	151	{
54d33c4c MR	152	struct nand_chip *this;
54d33c4c MR	153	int ret;
54d33c4c MR	154
a7f3f030	155	if (!(machine_is_armcore() && cpu_is_pxa27x()))
70eb33d6 MR	156	return -ENODEV;
	157
	158	ret = gpio_request(GPIO_NAND_CS, "NAND CS");
	159	if (ret) {
	160	pr_warning("CM-X270: failed to request NAND CS gpio\n");
	161	return ret;
	162	}
	163
	164	gpio_direction_output(GPIO_NAND_CS, 1);
	165
	166	ret = gpio_request(GPIO_NAND_RB, "NAND R/B");
	167	if (ret) {
	168	pr_warning("CM-X270: failed to request NAND R/B gpio\n");
	169	goto err_gpio_request;
	170	}
	171
	172	gpio_direction_input(GPIO_NAND_RB);
	173
54d33c4c MR	174	/* Allocate memory for MTD device structure and private data */
	175	cmx270_nand_mtd = kzalloc(sizeof(struct mtd_info) +
	176	sizeof(struct nand_chip),
	177	GFP_KERNEL);
	178	if (!cmx270_nand_mtd) {
70eb33d6 MR	179	pr_debug("Unable to allocate CM-X270 NAND MTD device structure.\n");
	180	ret = -ENOMEM;
	181	goto err_kzalloc;
54d33c4c MR	182	}
	183
	184	cmx270_nand_io = ioremap(PXA_CS1_PHYS, 12);
	185	if (!cmx270_nand_io) {
70eb33d6	186	pr_debug("Unable to ioremap NAND device\n");
54d33c4c	187	ret = -EINVAL;
70eb33d6	188	goto err_ioremap;
54d33c4c MR	189	}
	190
	191	/* Get pointer to private data */
	192	this = (struct nand_chip *)(&cmx270_nand_mtd[1]);
	193
	194	/* Link the private data with the MTD structure */
	195	cmx270_nand_mtd->owner = THIS_MODULE;
	196	cmx270_nand_mtd->priv = this;
	197
	198	/* insert callbacks */
	199	this->IO_ADDR_R = cmx270_nand_io;
	200	this->IO_ADDR_W = cmx270_nand_io;
	201	this->cmd_ctrl = cmx270_hwcontrol;
	202	this->dev_ready = cmx270_device_ready;
	203
	204	/* 15 us command delay time */
	205	this->chip_delay = 20;
	206	this->ecc.mode = NAND_ECC_SOFT;
	207
	208	/* read/write functions */
	209	this->read_byte = cmx270_read_byte;
	210	this->read_buf = cmx270_read_buf;
	211	this->write_buf = cmx270_write_buf;
	212	this->verify_buf = cmx270_verify_buf;
	213
	214	/* Scan to find existence of the device */
	215	if (nand_scan (cmx270_nand_mtd, 1)) {
70eb33d6	216	pr_notice("No NAND device\n");
54d33c4c	217	ret = -ENXIO;
70eb33d6	218	goto err_scan;
54d33c4c MR	219	}
54d33c4c MR	220
54d33c4c	221	/* Register the partitions */
0b118f06 DES	222	ret = mtd_device_parse_register(cmx270_nand_mtd, NULL, 0,
0b118f06 DES	223	partition_info, NUM_PARTITIONS);
54d33c4c	224	if (ret)
70eb33d6	225	goto err_scan;
54d33c4c MR	226
	227	/* Return happy */
	228	return 0;
	229
70eb33d6	230	err_scan:
54d33c4c	231	iounmap(cmx270_nand_io);
70eb33d6	232	err_ioremap:
54d33c4c	233	kfree(cmx270_nand_mtd);
70eb33d6 MR	234	err_kzalloc:
	235	gpio_free(GPIO_NAND_RB);
	236	err_gpio_request:
	237	gpio_free(GPIO_NAND_CS);
54d33c4c MR	238
	239	return ret;
	240
	241	}
	242	module_init(cmx270_init);
	243
	244	/*
	245	* Clean up routine
	246	*/
627df23c	247	static void __exit cmx270_cleanup(void)
54d33c4c MR	248	{
	249	/* Release resources, unregister device */
	250	nand_release(cmx270_nand_mtd);
	251
70eb33d6 MR	252	gpio_free(GPIO_NAND_RB);
	253	gpio_free(GPIO_NAND_CS);
	254
54d33c4c MR	255	iounmap(cmx270_nand_io);
	256
	257	/* Free the MTD device structure */
	258	kfree (cmx270_nand_mtd);
	259	}
	260	module_exit(cmx270_cleanup);
	261
	262	MODULE_LICENSE("GPL");
	263	MODULE_AUTHOR("Mike Rapoport <mike@compulab.co.il>");
	264	MODULE_DESCRIPTION("NAND flash driver for Compulab CM-X270 Module");