xref: /OK3568_Linux_fs/kernel/drivers/ata/pata_rb532_cf.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  *  A low-level PATA driver to handle a Compact Flash connected on the
4*4882a593Smuzhiyun  *  Mikrotik's RouterBoard 532 board.
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  *  Copyright (C) 2007 Gabor Juhos <juhosg at openwrt.org>
7*4882a593Smuzhiyun  *  Copyright (C) 2008 Florian Fainelli <florian@openwrt.org>
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  *  This file was based on: drivers/ata/pata_ixp4xx_cf.c
10*4882a593Smuzhiyun  *	Copyright (C) 2006-07 Tower Technologies
11*4882a593Smuzhiyun  *	Author: Alessandro Zummo <a.zummo@towertech.it>
12*4882a593Smuzhiyun  *
13*4882a593Smuzhiyun  *  Also was based on the driver for Linux 2.4.xx published by Mikrotik for
14*4882a593Smuzhiyun  *  their RouterBoard 1xx and 5xx series devices. The original Mikrotik code
15*4882a593Smuzhiyun  *  seems not to have a license.
16*4882a593Smuzhiyun  */
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #include <linux/gfp.h>
19*4882a593Smuzhiyun #include <linux/kernel.h>
20*4882a593Smuzhiyun #include <linux/module.h>
21*4882a593Smuzhiyun #include <linux/platform_device.h>
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun #include <linux/io.h>
24*4882a593Smuzhiyun #include <linux/interrupt.h>
25*4882a593Smuzhiyun #include <linux/irq.h>
26*4882a593Smuzhiyun #include <linux/gpio/consumer.h>
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun #include <linux/libata.h>
29*4882a593Smuzhiyun #include <scsi/scsi_host.h>
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun #include <asm/mach-rc32434/rb.h>
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun #define DRV_NAME	"pata-rb532-cf"
34*4882a593Smuzhiyun #define DRV_VERSION	"0.1.0"
35*4882a593Smuzhiyun #define DRV_DESC	"PATA driver for RouterBOARD 532 Compact Flash"
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun #define RB500_CF_MAXPORTS	1
38*4882a593Smuzhiyun #define RB500_CF_IO_DELAY	400
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun #define RB500_CF_REG_BASE	0x0800
41*4882a593Smuzhiyun #define RB500_CF_REG_ERR	0x080D
42*4882a593Smuzhiyun #define RB500_CF_REG_CTRL	0x080E
43*4882a593Smuzhiyun /* 32bit buffered data register offset */
44*4882a593Smuzhiyun #define RB500_CF_REG_DBUF32	0x0C00
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun struct rb532_cf_info {
47*4882a593Smuzhiyun 	void __iomem	*iobase;
48*4882a593Smuzhiyun 	struct gpio_desc *gpio_line;
49*4882a593Smuzhiyun 	unsigned int	irq;
50*4882a593Smuzhiyun };
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun /* ------------------------------------------------------------------------ */
53*4882a593Smuzhiyun 
rb532_pata_irq_handler(int irq,void * dev_instance)54*4882a593Smuzhiyun static irqreturn_t rb532_pata_irq_handler(int irq, void *dev_instance)
55*4882a593Smuzhiyun {
56*4882a593Smuzhiyun 	struct ata_host *ah = dev_instance;
57*4882a593Smuzhiyun 	struct rb532_cf_info *info = ah->private_data;
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun 	if (gpiod_get_value(info->gpio_line)) {
60*4882a593Smuzhiyun 		irq_set_irq_type(info->irq, IRQ_TYPE_LEVEL_LOW);
61*4882a593Smuzhiyun 		ata_sff_interrupt(info->irq, dev_instance);
62*4882a593Smuzhiyun 	} else {
63*4882a593Smuzhiyun 		irq_set_irq_type(info->irq, IRQ_TYPE_LEVEL_HIGH);
64*4882a593Smuzhiyun 	}
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun 	return IRQ_HANDLED;
67*4882a593Smuzhiyun }
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun static struct ata_port_operations rb532_pata_port_ops = {
70*4882a593Smuzhiyun 	.inherits		= &ata_sff_port_ops,
71*4882a593Smuzhiyun 	.sff_data_xfer		= ata_sff_data_xfer32,
72*4882a593Smuzhiyun };
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun /* ------------------------------------------------------------------------ */
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun static struct scsi_host_template rb532_pata_sht = {
77*4882a593Smuzhiyun 	ATA_PIO_SHT(DRV_NAME),
78*4882a593Smuzhiyun };
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun /* ------------------------------------------------------------------------ */
81*4882a593Smuzhiyun 
rb532_pata_setup_ports(struct ata_host * ah)82*4882a593Smuzhiyun static void rb532_pata_setup_ports(struct ata_host *ah)
83*4882a593Smuzhiyun {
84*4882a593Smuzhiyun 	struct rb532_cf_info *info = ah->private_data;
85*4882a593Smuzhiyun 	struct ata_port *ap;
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun 	ap = ah->ports[0];
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun 	ap->ops		= &rb532_pata_port_ops;
90*4882a593Smuzhiyun 	ap->pio_mask	= ATA_PIO4;
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun 	ap->ioaddr.cmd_addr	= info->iobase + RB500_CF_REG_BASE;
93*4882a593Smuzhiyun 	ap->ioaddr.ctl_addr	= info->iobase + RB500_CF_REG_CTRL;
94*4882a593Smuzhiyun 	ap->ioaddr.altstatus_addr = info->iobase + RB500_CF_REG_CTRL;
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun 	ata_sff_std_ports(&ap->ioaddr);
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun 	ap->ioaddr.data_addr	= info->iobase + RB500_CF_REG_DBUF32;
99*4882a593Smuzhiyun 	ap->ioaddr.error_addr	= info->iobase + RB500_CF_REG_ERR;
100*4882a593Smuzhiyun }
101*4882a593Smuzhiyun 
rb532_pata_driver_probe(struct platform_device * pdev)102*4882a593Smuzhiyun static int rb532_pata_driver_probe(struct platform_device *pdev)
103*4882a593Smuzhiyun {
104*4882a593Smuzhiyun 	int irq;
105*4882a593Smuzhiyun 	struct gpio_desc *gpiod;
106*4882a593Smuzhiyun 	struct resource *res;
107*4882a593Smuzhiyun 	struct ata_host *ah;
108*4882a593Smuzhiyun 	struct rb532_cf_info *info;
109*4882a593Smuzhiyun 	int ret;
110*4882a593Smuzhiyun 
111*4882a593Smuzhiyun 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
112*4882a593Smuzhiyun 	if (!res) {
113*4882a593Smuzhiyun 		dev_err(&pdev->dev, "no IOMEM resource found\n");
114*4882a593Smuzhiyun 		return -EINVAL;
115*4882a593Smuzhiyun 	}
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun 	irq = platform_get_irq(pdev, 0);
118*4882a593Smuzhiyun 	if (irq < 0) {
119*4882a593Smuzhiyun 		dev_err(&pdev->dev, "no IRQ resource found\n");
120*4882a593Smuzhiyun 		return irq;
121*4882a593Smuzhiyun 	}
122*4882a593Smuzhiyun 	if (!irq)
123*4882a593Smuzhiyun 		return -EINVAL;
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun 	gpiod = devm_gpiod_get(&pdev->dev, NULL, GPIOD_IN);
126*4882a593Smuzhiyun 	if (IS_ERR(gpiod)) {
127*4882a593Smuzhiyun 		dev_err(&pdev->dev, "no GPIO found for irq%d\n", irq);
128*4882a593Smuzhiyun 		return PTR_ERR(gpiod);
129*4882a593Smuzhiyun 	}
130*4882a593Smuzhiyun 	gpiod_set_consumer_name(gpiod, DRV_NAME);
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun 	/* allocate host */
133*4882a593Smuzhiyun 	ah = ata_host_alloc(&pdev->dev, RB500_CF_MAXPORTS);
134*4882a593Smuzhiyun 	if (!ah)
135*4882a593Smuzhiyun 		return -ENOMEM;
136*4882a593Smuzhiyun 
137*4882a593Smuzhiyun 	info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
138*4882a593Smuzhiyun 	if (!info)
139*4882a593Smuzhiyun 		return -ENOMEM;
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun 	ah->private_data = info;
142*4882a593Smuzhiyun 	info->gpio_line = gpiod;
143*4882a593Smuzhiyun 	info->irq = irq;
144*4882a593Smuzhiyun 
145*4882a593Smuzhiyun 	info->iobase = devm_ioremap(&pdev->dev, res->start,
146*4882a593Smuzhiyun 				resource_size(res));
147*4882a593Smuzhiyun 	if (!info->iobase)
148*4882a593Smuzhiyun 		return -ENOMEM;
149*4882a593Smuzhiyun 
150*4882a593Smuzhiyun 	rb532_pata_setup_ports(ah);
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun 	ret = ata_host_activate(ah, irq, rb532_pata_irq_handler,
153*4882a593Smuzhiyun 				IRQF_TRIGGER_LOW, &rb532_pata_sht);
154*4882a593Smuzhiyun 	if (ret)
155*4882a593Smuzhiyun 		return ret;
156*4882a593Smuzhiyun 
157*4882a593Smuzhiyun 	return 0;
158*4882a593Smuzhiyun }
159*4882a593Smuzhiyun 
rb532_pata_driver_remove(struct platform_device * pdev)160*4882a593Smuzhiyun static int rb532_pata_driver_remove(struct platform_device *pdev)
161*4882a593Smuzhiyun {
162*4882a593Smuzhiyun 	struct ata_host *ah = platform_get_drvdata(pdev);
163*4882a593Smuzhiyun 
164*4882a593Smuzhiyun 	ata_host_detach(ah);
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun 	return 0;
167*4882a593Smuzhiyun }
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun static struct platform_driver rb532_pata_platform_driver = {
170*4882a593Smuzhiyun 	.probe		= rb532_pata_driver_probe,
171*4882a593Smuzhiyun 	.remove		= rb532_pata_driver_remove,
172*4882a593Smuzhiyun 	.driver	 = {
173*4882a593Smuzhiyun 		.name   = DRV_NAME,
174*4882a593Smuzhiyun 	},
175*4882a593Smuzhiyun };
176*4882a593Smuzhiyun 
177*4882a593Smuzhiyun #define DRV_INFO DRV_DESC " version " DRV_VERSION
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun module_platform_driver(rb532_pata_platform_driver);
180*4882a593Smuzhiyun 
181*4882a593Smuzhiyun MODULE_AUTHOR("Gabor Juhos <juhosg at openwrt.org>");
182*4882a593Smuzhiyun MODULE_AUTHOR("Florian Fainelli <florian@openwrt.org>");
183*4882a593Smuzhiyun MODULE_DESCRIPTION(DRV_DESC);
184*4882a593Smuzhiyun MODULE_VERSION(DRV_VERSION);
185*4882a593Smuzhiyun MODULE_LICENSE("GPL");
186*4882a593Smuzhiyun MODULE_ALIAS("platform:" DRV_NAME);
187