[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_to_nand(mtd);

	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_to_nand(mtd);

	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_to_nand(mtd);

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

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_to_nand(mtd);
	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 */
	this = kzalloc(sizeof(struct nand_chip), GFP_KERNEL);
	if (!this) {
		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;
	}

	cmx270_nand_mtd = nand_to_mtd(this);

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

	/* 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;
	this->ecc.algo = NAND_ECC_HAMMING;

	/* read/write functions */
	this->read_byte = cmx270_read_byte;
	this->read_buf = cmx270_read_buf;
	this->write_buf = cmx270_write_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, NULL,
					partition_info, NUM_PARTITIONS);
	if (ret)
		goto err_scan;

	/* Return happy */
	return 0;

err_scan:
	iounmap(cmx270_nand_io);
err_ioremap:
	kfree(this);
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);

	kfree(mtd_to_nand(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)
54d33c4c MR	55	{
4bd4ebcc	56	struct nand_chip *this = mtd_to_nand(mtd);
54d33c4c MR	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;
4bd4ebcc	64	struct nand_chip *this = mtd_to_nand(mtd);
54d33c4c MR	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;
4bd4ebcc	73	struct nand_chip *this = mtd_to_nand(mtd);
54d33c4c MR	74
	75	for (i=0; i<len; i++)
	76	*buf++ = readl(this->IO_ADDR_R) >> 16;
	77	}
	78
54d33c4c MR	79	static inline void nand_cs_on(void)
54d33c4c MR	80	{
70eb33d6	81	gpio_set_value(GPIO_NAND_CS, 0);
54d33c4c MR	82	}
	83
	84	static void nand_cs_off(void)
	85	{
70eb33d6	86	dsb();
54d33c4c	87
70eb33d6	88	gpio_set_value(GPIO_NAND_CS, 1);
54d33c4c MR	89	}
	90
	91	/*
	92	* hardware specific access to control-lines
	93	*/
	94	static void cmx270_hwcontrol(struct mtd_info *mtd, int dat,
	95	unsigned int ctrl)
	96	{
4bd4ebcc	97	struct nand_chip *this = mtd_to_nand(mtd);
54d33c4c MR	98	unsigned int nandaddr = (unsigned int)this->IO_ADDR_W;
54d33c4c MR	99
70eb33d6	100	dsb();
54d33c4c MR	101
	102	if (ctrl & NAND_CTRL_CHANGE) {
	103	if ( ctrl & NAND_ALE )
	104	nandaddr \|= (1 << 3);
	105	else
	106	nandaddr &= ~(1 << 3);
	107	if ( ctrl & NAND_CLE )
	108	nandaddr \|= (1 << 2);
	109	else
	110	nandaddr &= ~(1 << 2);
	111	if ( ctrl & NAND_NCE )
	112	nand_cs_on();
	113	else
	114	nand_cs_off();
	115	}
	116
70eb33d6	117	dsb();
54d33c4c MR	118	this->IO_ADDR_W = (void __iomem*)nandaddr;
	119	if (dat != NAND_CMD_NONE)
	120	writel((dat << 16), this->IO_ADDR_W);
	121
70eb33d6	122	dsb();
54d33c4c MR	123	}
	124
	125	/*
	126	* read device ready pin
	127	*/
	128	static int cmx270_device_ready(struct mtd_info *mtd)
	129	{
70eb33d6	130	dsb();
54d33c4c	131
70eb33d6	132	return (gpio_get_value(GPIO_NAND_RB));
54d33c4c MR	133	}
	134
	135	/*
	136	* Main initialization routine
	137	*/
627df23c	138	static int __init cmx270_init(void)
54d33c4c MR	139	{
54d33c4c MR	140	struct nand_chip *this;
54d33c4c MR	141	int ret;
54d33c4c MR	142
a7f3f030	143	if (!(machine_is_armcore() && cpu_is_pxa27x()))
70eb33d6 MR	144	return -ENODEV;
	145
	146	ret = gpio_request(GPIO_NAND_CS, "NAND CS");
	147	if (ret) {
	148	pr_warning("CM-X270: failed to request NAND CS gpio\n");
	149	return ret;
	150	}
	151
	152	gpio_direction_output(GPIO_NAND_CS, 1);
	153
	154	ret = gpio_request(GPIO_NAND_RB, "NAND R/B");
	155	if (ret) {
	156	pr_warning("CM-X270: failed to request NAND R/B gpio\n");
	157	goto err_gpio_request;
	158	}
	159
	160	gpio_direction_input(GPIO_NAND_RB);
	161
54d33c4c	162	/* Allocate memory for MTD device structure and private data */
2afd14f9 BB	163	this = kzalloc(sizeof(struct nand_chip), GFP_KERNEL);
2afd14f9 BB	164	if (!this) {
70eb33d6 MR	165	ret = -ENOMEM;
70eb33d6 MR	166	goto err_kzalloc;
54d33c4c MR	167	}
	168
	169	cmx270_nand_io = ioremap(PXA_CS1_PHYS, 12);
	170	if (!cmx270_nand_io) {
70eb33d6	171	pr_debug("Unable to ioremap NAND device\n");
54d33c4c	172	ret = -EINVAL;
70eb33d6	173	goto err_ioremap;
54d33c4c MR	174	}
54d33c4c MR	175
2afd14f9	176	cmx270_nand_mtd = nand_to_mtd(this);
54d33c4c MR	177
	178	/* Link the private data with the MTD structure */
	179	cmx270_nand_mtd->owner = THIS_MODULE;
54d33c4c MR	180
	181	/* insert callbacks */
	182	this->IO_ADDR_R = cmx270_nand_io;
	183	this->IO_ADDR_W = cmx270_nand_io;
	184	this->cmd_ctrl = cmx270_hwcontrol;
	185	this->dev_ready = cmx270_device_ready;
	186
	187	/* 15 us command delay time */
	188	this->chip_delay = 20;
	189	this->ecc.mode = NAND_ECC_SOFT;
d9944e1f	190	this->ecc.algo = NAND_ECC_HAMMING;
54d33c4c MR	191
	192	/* read/write functions */
	193	this->read_byte = cmx270_read_byte;
	194	this->read_buf = cmx270_read_buf;
	195	this->write_buf = cmx270_write_buf;
54d33c4c MR	196
	197	/* Scan to find existence of the device */
	198	if (nand_scan (cmx270_nand_mtd, 1)) {
70eb33d6	199	pr_notice("No NAND device\n");
54d33c4c	200	ret = -ENXIO;
70eb33d6	201	goto err_scan;
54d33c4c MR	202	}
54d33c4c MR	203
54d33c4c	204	/* Register the partitions */
42d7fbe2	205	ret = mtd_device_parse_register(cmx270_nand_mtd, NULL, NULL,
0b118f06	206	partition_info, NUM_PARTITIONS);
54d33c4c	207	if (ret)
70eb33d6	208	goto err_scan;
54d33c4c MR	209
	210	/* Return happy */
	211	return 0;
	212
70eb33d6	213	err_scan:
54d33c4c	214	iounmap(cmx270_nand_io);
70eb33d6	215	err_ioremap:
2afd14f9	216	kfree(this);
70eb33d6 MR	217	err_kzalloc:
	218	gpio_free(GPIO_NAND_RB);
	219	err_gpio_request:
	220	gpio_free(GPIO_NAND_CS);
54d33c4c MR	221
	222	return ret;
	223
	224	}
	225	module_init(cmx270_init);
	226
	227	/*
	228	* Clean up routine
	229	*/
627df23c	230	static void __exit cmx270_cleanup(void)
54d33c4c MR	231	{
	232	/* Release resources, unregister device */
	233	nand_release(cmx270_nand_mtd);
	234
70eb33d6 MR	235	gpio_free(GPIO_NAND_RB);
	236	gpio_free(GPIO_NAND_CS);
	237
54d33c4c MR	238	iounmap(cmx270_nand_io);
54d33c4c MR	239
2afd14f9	240	kfree(mtd_to_nand(cmx270_nand_mtd));
54d33c4c MR	241	}
	242	module_exit(cmx270_cleanup);
	243
	244	MODULE_LICENSE("GPL");
	245	MODULE_AUTHOR("Mike Rapoport <mike@compulab.co.il>");
	246	MODULE_DESCRIPTION("NAND flash driver for Compulab CM-X270 Module");