[deliverable/linux.git] / drivers / ata / pata_rb532_cf.c

/*
 *  A low-level PATA driver to handle a Compact Flash connected on the
 *  Mikrotik's RouterBoard 532 board.
 *
 *  Copyright (C) 2007 Gabor Juhos <juhosg at openwrt.org>
 *  Copyright (C) 2008 Florian Fainelli <florian@openwrt.org>
 *
 *  This file was based on: drivers/ata/pata_ixp4xx_cf.c
 *	Copyright (C) 2006-07 Tower Technologies
 *	Author: Alessandro Zummo <a.zummo@towertech.it>
 *
 *  Also was based on the driver for Linux 2.4.xx published by Mikrotik for
 *  their RouterBoard 1xx and 5xx series devices. The original Mikrotik code
 *  seems not to have a license.
 *
 *  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.
 *
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/platform_device.h>

#include <linux/io.h>
#include <linux/interrupt.h>
#include <linux/irq.h>

#include <linux/libata.h>
#include <scsi/scsi_host.h>

#include <asm/gpio.h>

#define DRV_NAME	"pata-rb532-cf"
#define DRV_VERSION	"0.1.0"
#define DRV_DESC	"PATA driver for RouterBOARD 532 Compact Flash"

#define RB500_CF_MAXPORTS	1
#define RB500_CF_IO_DELAY	400

#define RB500_CF_REG_BASE	0x0800
#define RB500_CF_REG_ERR	0x080D
#define RB500_CF_REG_CTRL	0x080E
/* 32bit buffered data register offset */
#define RB500_CF_REG_DBUF32	0x0C00

struct rb532_cf_info {
	void __iomem	*iobase;
	unsigned int	gpio_line;
	int		frozen;
	unsigned int	irq;
};

/* ------------------------------------------------------------------------ */

static inline void rb532_pata_finish_io(struct ata_port *ap)
{
	struct ata_host *ah = ap->host;
	struct rb532_cf_info *info = ah->private_data;

	/* FIXME: Keep previous delay. If this is merely a fence then
	   ata_sff_sync might be sufficient. */
	ata_sff_dma_pause(ap);
	ndelay(RB500_CF_IO_DELAY);
}

static void rb532_pata_exec_command(struct ata_port *ap,
				const struct ata_taskfile *tf)
{
	writeb(tf->command, ap->ioaddr.command_addr);
	rb532_pata_finish_io(ap);
}

static unsigned int rb532_pata_data_xfer(struct ata_device *adev, unsigned char *buf,
				unsigned int buflen, int write_data)
{
	struct ata_port *ap = adev->link->ap;
	void __iomem *ioaddr = ap->ioaddr.data_addr;
	int retlen = buflen;

	if (write_data) {
		for (; buflen > 0; buflen--, buf++)
			writeb(*buf, ioaddr);
	} else {
		for (; buflen > 0; buflen--, buf++)
			*buf = readb(ioaddr);
	}

	rb532_pata_finish_io(adev->link->ap);
	return retlen;
}

static void rb532_pata_freeze(struct ata_port *ap)
{
	struct rb532_cf_info *info = ap->host->private_data;

	info->frozen = 1;
}

static void rb532_pata_thaw(struct ata_port *ap)
{
	struct rb532_cf_info *info = ap->host->private_data;

	info->frozen = 0;
}

static irqreturn_t rb532_pata_irq_handler(int irq, void *dev_instance)
{
	struct ata_host *ah = dev_instance;
	struct rb532_cf_info *info = ah->private_data;

	if (gpio_get_value(info->gpio_line)) {
		set_irq_type(info->irq, IRQ_TYPE_LEVEL_LOW);
		if (!info->frozen)
			ata_sff_interrupt(info->irq, dev_instance);
	} else {
		set_irq_type(info->irq, IRQ_TYPE_LEVEL_HIGH);
	}

	return IRQ_HANDLED;
}

static struct ata_port_operations rb532_pata_port_ops = {
	.inherits		= &ata_sff_port_ops,
	.sff_exec_command	= rb532_pata_exec_command,
	.sff_data_xfer		= rb532_pata_data_xfer,
	.freeze			= rb532_pata_freeze,
	.thaw			= rb532_pata_thaw,
};

/* ------------------------------------------------------------------------ */

static struct scsi_host_template rb532_pata_sht = {
	ATA_PIO_SHT(DRV_NAME),
};

/* ------------------------------------------------------------------------ */

static void rb532_pata_setup_ports(struct ata_host *ah)
{
	struct rb532_cf_info *info = ah->private_data;
	struct ata_port *ap;

	ap = ah->ports[0];

	ap->ops		= &rb532_pata_port_ops;
	ap->pio_mask	= 0x1f; /* PIO4 */
	ap->flags	= ATA_FLAG_NO_LEGACY | ATA_FLAG_MMIO;

	ap->ioaddr.cmd_addr	= info->iobase + RB500_CF_REG_BASE;
	ap->ioaddr.ctl_addr	= info->iobase + RB500_CF_REG_CTRL;
	ap->ioaddr.altstatus_addr = info->iobase + RB500_CF_REG_CTRL;

	ata_sff_std_ports(&ap->ioaddr);

	ap->ioaddr.data_addr	= info->iobase + RB500_CF_REG_DBUF32;
	ap->ioaddr.error_addr	= info->iobase + RB500_CF_REG_ERR;
}

static __devinit int rb532_pata_driver_probe(struct platform_device *pdev)
{
	unsigned int irq;
	int gpio;
	struct resource *res;
	struct ata_host *ah;
	struct rb532_cf_info *info;
	int ret;

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!res) {
		dev_err(&pdev->dev, "no IOMEM resource found\n");
		return -EINVAL;
	}

	irq = platform_get_irq(pdev, 0);
	if (irq <= 0) {
		dev_err(&pdev->dev, "no IRQ resource found\n");
		return -ENOENT;
	}

	gpio = irq_to_gpio(irq);
	if (gpio < 0) {
		dev_err(&pdev->dev, "no GPIO found for irq%d\n", irq);
		return -ENOENT;
	}

	ret = gpio_request(gpio, DRV_NAME);
	if (ret) {
		dev_err(&pdev->dev, "GPIO request failed\n");
		return ret;
	}

	/* allocate host */
	ah = ata_host_alloc(&pdev->dev, RB500_CF_MAXPORTS);
	if (!ah)
		return -ENOMEM;

	platform_set_drvdata(pdev, ah);

	info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
	if (!info)
		return -ENOMEM;

	ah->private_data = info;
	info->gpio_line = gpio;
	info->irq = irq;

	info->iobase = devm_ioremap_nocache(&pdev->dev, res->start,
				res->end - res->start + 1);
	if (!info->iobase)
		return -ENOMEM;

	ret = gpio_direction_input(gpio);
	if (ret) {
		dev_err(&pdev->dev, "unable to set GPIO direction, err=%d\n",
				ret);
		goto err_free_gpio;
	}

	rb532_pata_setup_ports(ah);

	ret = ata_host_activate(ah, irq, rb532_pata_irq_handler,
				IRQF_TRIGGER_LOW, &rb532_pata_sht);
	if (ret)
		goto err_free_gpio;

	return 0;

err_free_gpio:
	gpio_free(gpio);

	return ret;
}

static __devexit int rb532_pata_driver_remove(struct platform_device *pdev)
{
	struct ata_host *ah = platform_get_drvdata(pdev);
	struct rb532_cf_info *info = ah->private_data;

	ata_host_detach(ah);
	gpio_free(info->gpio_line);

	return 0;
}

/* work with hotplug and coldplug */
MODULE_ALIAS("platform:" DRV_NAME);

static struct platform_driver rb532_pata_platform_driver = {
	.probe		= rb532_pata_driver_probe,
	.remove		= __devexit_p(rb532_pata_driver_remove),
	.driver	 = {
		.name   = DRV_NAME,
		.owner  = THIS_MODULE,
	},
};

/* ------------------------------------------------------------------------ */

#define DRV_INFO DRV_DESC " version " DRV_VERSION

static int __init rb532_pata_module_init(void)
{
	printk(KERN_INFO DRV_INFO "\n");

	return platform_driver_register(&rb532_pata_platform_driver);
}

static void __exit rb532_pata_module_exit(void)
{
	platform_driver_unregister(&rb532_pata_platform_driver);
}

MODULE_AUTHOR("Gabor Juhos <juhosg at openwrt.org>");
MODULE_AUTHOR("Florian Fainelli <florian@openwrt.org>");
MODULE_DESCRIPTION(DRV_DESC);
MODULE_VERSION(DRV_VERSION);
MODULE_LICENSE("GPL");

module_init(rb532_pata_module_init);
module_exit(rb532_pata_module_exit);
Commit	Line	Data
3db691da FF	1	/*
	2	* A low-level PATA driver to handle a Compact Flash connected on the
	3	* Mikrotik's RouterBoard 532 board.
	4	*
	5	* Copyright (C) 2007 Gabor Juhos <juhosg at openwrt.org>
	6	* Copyright (C) 2008 Florian Fainelli <florian@openwrt.org>
	7	*
	8	* This file was based on: drivers/ata/pata_ixp4xx_cf.c
	9	* Copyright (C) 2006-07 Tower Technologies
	10	* Author: Alessandro Zummo <a.zummo@towertech.it>
	11	*
	12	* Also was based on the driver for Linux 2.4.xx published by Mikrotik for
	13	* their RouterBoard 1xx and 5xx series devices. The original Mikrotik code
	14	* seems not to have a license.
	15	*
	16	* This program is free software; you can redistribute it and/or modify
	17	* it under the terms of the GNU General Public License version 2 as
	18	* published by the Free Software Foundation.
	19	*
	20	*/
	21
	22	#include <linux/kernel.h>
	23	#include <linux/module.h>
	24	#include <linux/platform_device.h>
	25
	26	#include <linux/io.h>
	27	#include <linux/interrupt.h>
	28	#include <linux/irq.h>
	29
	30	#include <linux/libata.h>
	31	#include <scsi/scsi_host.h>
	32
	33	#include <asm/gpio.h>
	34
3dd654bf	35	#define DRV_NAME "pata-rb532-cf"
3db691da FF	36	#define DRV_VERSION "0.1.0"
	37	#define DRV_DESC "PATA driver for RouterBOARD 532 Compact Flash"
	38
	39	#define RB500_CF_MAXPORTS 1
	40	#define RB500_CF_IO_DELAY 400
	41
9f14786e PS	42	#define RB500_CF_REG_BASE 0x0800
9f14786e PS	43	#define RB500_CF_REG_ERR 0x080D
3db691da	44	#define RB500_CF_REG_CTRL 0x080E
9f14786e PS	45	/* 32bit buffered data register offset */
9f14786e PS	46	#define RB500_CF_REG_DBUF32 0x0C00
3db691da	47
3dd654bf	48	struct rb532_cf_info {
3db691da FF	49	void __iomem *iobase;
	50	unsigned int gpio_line;
	51	int frozen;
	52	unsigned int irq;
	53	};
	54
	55	/* ------------------------------------------------------------------------ */
	56
3dd654bf	57	static inline void rb532_pata_finish_io(struct ata_port *ap)
3db691da FF	58	{
3db691da FF	59	struct ata_host *ah = ap->host;
3dd654bf	60	struct rb532_cf_info *info = ah->private_data;
3db691da	61
a57c1bad AC	62	/* FIXME: Keep previous delay. If this is merely a fence then
	63	ata_sff_sync might be sufficient. */
	64	ata_sff_dma_pause(ap);
3db691da	65	ndelay(RB500_CF_IO_DELAY);
3db691da FF	66	}
3db691da FF	67
3dd654bf	68	static void rb532_pata_exec_command(struct ata_port *ap,
3db691da FF	69	const struct ata_taskfile *tf)
	70	{
	71	writeb(tf->command, ap->ioaddr.command_addr);
3dd654bf	72	rb532_pata_finish_io(ap);
3db691da FF	73	}
3db691da FF	74
03f60840	75	static unsigned int rb532_pata_data_xfer(struct ata_device adev, unsigned char buf,
3db691da FF	76	unsigned int buflen, int write_data)
	77	{
	78	struct ata_port *ap = adev->link->ap;
	79	void __iomem *ioaddr = ap->ioaddr.data_addr;
03f60840	80	int retlen = buflen;
3db691da FF	81
	82	if (write_data) {
	83	for (; buflen > 0; buflen--, buf++)
	84	writeb(*buf, ioaddr);
	85	} else {
	86	for (; buflen > 0; buflen--, buf++)
	87	*buf = readb(ioaddr);
	88	}
	89
3dd654bf	90	rb532_pata_finish_io(adev->link->ap);
03f60840	91	return retlen;
3db691da FF	92	}
3db691da FF	93
3dd654bf	94	static void rb532_pata_freeze(struct ata_port *ap)
3db691da	95	{
3dd654bf	96	struct rb532_cf_info *info = ap->host->private_data;
3db691da FF	97
	98	info->frozen = 1;
	99	}
	100
3dd654bf	101	static void rb532_pata_thaw(struct ata_port *ap)
3db691da	102	{
3dd654bf	103	struct rb532_cf_info *info = ap->host->private_data;
3db691da FF	104
	105	info->frozen = 0;
	106	}
	107
3dd654bf	108	static irqreturn_t rb532_pata_irq_handler(int irq, void *dev_instance)
3db691da FF	109	{
3db691da FF	110	struct ata_host *ah = dev_instance;
3dd654bf	111	struct rb532_cf_info *info = ah->private_data;
3db691da FF	112
	113	if (gpio_get_value(info->gpio_line)) {
	114	set_irq_type(info->irq, IRQ_TYPE_LEVEL_LOW);
	115	if (!info->frozen)
9363c382	116	ata_sff_interrupt(info->irq, dev_instance);
3db691da FF	117	} else {
	118	set_irq_type(info->irq, IRQ_TYPE_LEVEL_HIGH);
	119	}
	120
	121	return IRQ_HANDLED;
	122	}
	123
3dd654bf	124	static struct ata_port_operations rb532_pata_port_ops = {
029cfd6b	125	.inherits = &ata_sff_port_ops,
3dd654bf RB	126	.sff_exec_command = rb532_pata_exec_command,
	127	.sff_data_xfer = rb532_pata_data_xfer,
	128	.freeze = rb532_pata_freeze,
	129	.thaw = rb532_pata_thaw,
3db691da FF	130	};
	131
	132	/* ------------------------------------------------------------------------ */
	133
3dd654bf	134	static struct scsi_host_template rb532_pata_sht = {
68d1d07b	135	ATA_PIO_SHT(DRV_NAME),
3db691da FF	136	};
	137
	138	/* ------------------------------------------------------------------------ */
	139
3dd654bf	140	static void rb532_pata_setup_ports(struct ata_host *ah)
3db691da	141	{
3dd654bf	142	struct rb532_cf_info *info = ah->private_data;
3db691da FF	143	struct ata_port *ap;
	144
	145	ap = ah->ports[0];
	146
3dd654bf	147	ap->ops = &rb532_pata_port_ops;
3db691da FF	148	ap->pio_mask = 0x1f; /* PIO4 */
	149	ap->flags = ATA_FLAG_NO_LEGACY \| ATA_FLAG_MMIO;
	150
9f14786e	151	ap->ioaddr.cmd_addr = info->iobase + RB500_CF_REG_BASE;
3db691da FF	152	ap->ioaddr.ctl_addr = info->iobase + RB500_CF_REG_CTRL;
	153	ap->ioaddr.altstatus_addr = info->iobase + RB500_CF_REG_CTRL;
	154
9363c382	155	ata_sff_std_ports(&ap->ioaddr);
3db691da	156
9f14786e PS	157	ap->ioaddr.data_addr = info->iobase + RB500_CF_REG_DBUF32;
9f14786e PS	158	ap->ioaddr.error_addr = info->iobase + RB500_CF_REG_ERR;
3db691da FF	159	}
3db691da FF	160
3dd654bf	161	static __devinit int rb532_pata_driver_probe(struct platform_device *pdev)
3db691da FF	162	{
	163	unsigned int irq;
	164	int gpio;
	165	struct resource *res;
	166	struct ata_host *ah;
3dd654bf	167	struct rb532_cf_info *info;
3db691da FF	168	int ret;
	169
	170	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	171	if (!res) {
	172	dev_err(&pdev->dev, "no IOMEM resource found\n");
	173	return -EINVAL;
	174	}
	175
	176	irq = platform_get_irq(pdev, 0);
	177	if (irq <= 0) {
	178	dev_err(&pdev->dev, "no IRQ resource found\n");
	179	return -ENOENT;
	180	}
	181
	182	gpio = irq_to_gpio(irq);
	183	if (gpio < 0) {
	184	dev_err(&pdev->dev, "no GPIO found for irq%d\n", irq);
	185	return -ENOENT;
	186	}
	187
	188	ret = gpio_request(gpio, DRV_NAME);
	189	if (ret) {
	190	dev_err(&pdev->dev, "GPIO request failed\n");
	191	return ret;
	192	}
	193
	194	/* allocate host */
	195	ah = ata_host_alloc(&pdev->dev, RB500_CF_MAXPORTS);
	196	if (!ah)
	197	return -ENOMEM;
	198
	199	platform_set_drvdata(pdev, ah);
	200
	201	info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
	202	if (!info)
	203	return -ENOMEM;
	204
	205	ah->private_data = info;
	206	info->gpio_line = gpio;
	207	info->irq = irq;
	208
	209	info->iobase = devm_ioremap_nocache(&pdev->dev, res->start,
	210	res->end - res->start + 1);
	211	if (!info->iobase)
	212	return -ENOMEM;
	213
	214	ret = gpio_direction_input(gpio);
	215	if (ret) {
	216	dev_err(&pdev->dev, "unable to set GPIO direction, err=%d\n",
	217	ret);
	218	goto err_free_gpio;
	219	}
	220
3dd654bf	221	rb532_pata_setup_ports(ah);
3db691da	222
3dd654bf RB	223	ret = ata_host_activate(ah, irq, rb532_pata_irq_handler,
3dd654bf RB	224	IRQF_TRIGGER_LOW, &rb532_pata_sht);
3db691da FF	225	if (ret)
	226	goto err_free_gpio;
	227
	228	return 0;
	229
	230	err_free_gpio:
	231	gpio_free(gpio);
	232
	233	return ret;
	234	}
	235
3dd654bf	236	static __devexit int rb532_pata_driver_remove(struct platform_device *pdev)
3db691da FF	237	{
3db691da FF	238	struct ata_host *ah = platform_get_drvdata(pdev);
3dd654bf	239	struct rb532_cf_info *info = ah->private_data;
3db691da FF	240
	241	ata_host_detach(ah);
	242	gpio_free(info->gpio_line);
	243
	244	return 0;
	245	}
	246
458622fc KS	247	/* work with hotplug and coldplug */
	248	MODULE_ALIAS("platform:" DRV_NAME);
	249
3dd654bf RB	250	static struct platform_driver rb532_pata_platform_driver = {
	251	.probe = rb532_pata_driver_probe,
	252	.remove = __devexit_p(rb532_pata_driver_remove),
3db691da FF	253	.driver = {
	254	.name = DRV_NAME,
	255	.owner = THIS_MODULE,
	256	},
	257	};
	258
	259	/* ------------------------------------------------------------------------ */
	260
	261	#define DRV_INFO DRV_DESC " version " DRV_VERSION
	262
3dd654bf	263	static int __init rb532_pata_module_init(void)
3db691da FF	264	{
	265	printk(KERN_INFO DRV_INFO "\n");
	266
3dd654bf	267	return platform_driver_register(&rb532_pata_platform_driver);
3db691da FF	268	}
3db691da FF	269
3dd654bf	270	static void __exit rb532_pata_module_exit(void)
3db691da	271	{
3dd654bf	272	platform_driver_unregister(&rb532_pata_platform_driver);
3db691da FF	273	}
	274
	275	MODULE_AUTHOR("Gabor Juhos <juhosg at openwrt.org>");
	276	MODULE_AUTHOR("Florian Fainelli <florian@openwrt.org>");
	277	MODULE_DESCRIPTION(DRV_DESC);
	278	MODULE_VERSION(DRV_VERSION);
	279	MODULE_LICENSE("GPL");
	280
3dd654bf RB	281	module_init(rb532_pata_module_init);
3dd654bf RB	282	module_exit(rb532_pata_module_exit);