xref: /openbmc/linux/drivers/ata/pata_platform.c (revision 9ac8d3fb)
1 /*
2  * Generic platform device PATA driver
3  *
4  * Copyright (C) 2006 - 2007  Paul Mundt
5  *
6  * Based on pata_pcmcia:
7  *
8  *   Copyright 2005-2006 Red Hat Inc, all rights reserved.
9  *
10  * This file is subject to the terms and conditions of the GNU General Public
11  * License.  See the file "COPYING" in the main directory of this archive
12  * for more details.
13  */
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/blkdev.h>
18 #include <scsi/scsi_host.h>
19 #include <linux/ata.h>
20 #include <linux/libata.h>
21 #include <linux/platform_device.h>
22 #include <linux/ata_platform.h>
23 
24 #define DRV_NAME "pata_platform"
25 #define DRV_VERSION "1.2"
26 
27 static int pio_mask = 1;
28 
29 /*
30  * Provide our own set_mode() as we don't want to change anything that has
31  * already been configured..
32  */
33 static int pata_platform_set_mode(struct ata_link *link, struct ata_device **unused)
34 {
35 	struct ata_device *dev;
36 
37 	ata_link_for_each_dev(dev, link) {
38 		if (ata_dev_enabled(dev)) {
39 			/* We don't really care */
40 			dev->pio_mode = dev->xfer_mode = XFER_PIO_0;
41 			dev->xfer_shift = ATA_SHIFT_PIO;
42 			dev->flags |= ATA_DFLAG_PIO;
43 			ata_dev_printk(dev, KERN_INFO, "configured for PIO\n");
44 		}
45 	}
46 	return 0;
47 }
48 
49 static struct scsi_host_template pata_platform_sht = {
50 	ATA_PIO_SHT(DRV_NAME),
51 };
52 
53 static struct ata_port_operations pata_platform_port_ops = {
54 	.inherits		= &ata_sff_port_ops,
55 	.sff_data_xfer		= ata_sff_data_xfer_noirq,
56 	.cable_detect		= ata_cable_unknown,
57 	.set_mode		= pata_platform_set_mode,
58 	.port_start		= ATA_OP_NULL,
59 };
60 
61 static void pata_platform_setup_port(struct ata_ioports *ioaddr,
62 				     unsigned int shift)
63 {
64 	/* Fixup the port shift for platforms that need it */
65 	ioaddr->data_addr	= ioaddr->cmd_addr + (ATA_REG_DATA    << shift);
66 	ioaddr->error_addr	= ioaddr->cmd_addr + (ATA_REG_ERR     << shift);
67 	ioaddr->feature_addr	= ioaddr->cmd_addr + (ATA_REG_FEATURE << shift);
68 	ioaddr->nsect_addr	= ioaddr->cmd_addr + (ATA_REG_NSECT   << shift);
69 	ioaddr->lbal_addr	= ioaddr->cmd_addr + (ATA_REG_LBAL    << shift);
70 	ioaddr->lbam_addr	= ioaddr->cmd_addr + (ATA_REG_LBAM    << shift);
71 	ioaddr->lbah_addr	= ioaddr->cmd_addr + (ATA_REG_LBAH    << shift);
72 	ioaddr->device_addr	= ioaddr->cmd_addr + (ATA_REG_DEVICE  << shift);
73 	ioaddr->status_addr	= ioaddr->cmd_addr + (ATA_REG_STATUS  << shift);
74 	ioaddr->command_addr	= ioaddr->cmd_addr + (ATA_REG_CMD     << shift);
75 }
76 
77 /**
78  *	__pata_platform_probe		-	attach a platform interface
79  *	@dev: device
80  *	@io_res: Resource representing I/O base
81  *	@ctl_res: Resource representing CTL base
82  *	@irq_res: Resource representing IRQ and its flags
83  *	@ioport_shift: I/O port shift
84  *	@__pio_mask: PIO mask
85  *
86  *	Register a platform bus IDE interface. Such interfaces are PIO and we
87  *	assume do not support IRQ sharing.
88  *
89  *	Platform devices are expected to contain at least 2 resources per port:
90  *
91  *		- I/O Base (IORESOURCE_IO or IORESOURCE_MEM)
92  *		- CTL Base (IORESOURCE_IO or IORESOURCE_MEM)
93  *
94  *	and optionally:
95  *
96  *		- IRQ	   (IORESOURCE_IRQ)
97  *
98  *	If the base resources are both mem types, the ioremap() is handled
99  *	here. For IORESOURCE_IO, it's assumed that there's no remapping
100  *	necessary.
101  *
102  *	If no IRQ resource is present, PIO polling mode is used instead.
103  */
104 int __devinit __pata_platform_probe(struct device *dev,
105 				    struct resource *io_res,
106 				    struct resource *ctl_res,
107 				    struct resource *irq_res,
108 				    unsigned int ioport_shift,
109 				    int __pio_mask)
110 {
111 	struct ata_host *host;
112 	struct ata_port *ap;
113 	unsigned int mmio;
114 	int irq = 0;
115 	int irq_flags = 0;
116 
117 	/*
118 	 * Check for MMIO
119 	 */
120 	mmio = (( io_res->flags == IORESOURCE_MEM) &&
121 		(ctl_res->flags == IORESOURCE_MEM));
122 
123 	/*
124 	 * And the IRQ
125 	 */
126 	if (irq_res && irq_res->start > 0) {
127 		irq = irq_res->start;
128 		irq_flags = irq_res->flags;
129 	}
130 
131 	/*
132 	 * Now that that's out of the way, wire up the port..
133 	 */
134 	host = ata_host_alloc(dev, 1);
135 	if (!host)
136 		return -ENOMEM;
137 	ap = host->ports[0];
138 
139 	ap->ops = &pata_platform_port_ops;
140 	ap->pio_mask = __pio_mask;
141 	ap->flags |= ATA_FLAG_SLAVE_POSS;
142 
143 	/*
144 	 * Use polling mode if there's no IRQ
145 	 */
146 	if (!irq) {
147 		ap->flags |= ATA_FLAG_PIO_POLLING;
148 		ata_port_desc(ap, "no IRQ, using PIO polling");
149 	}
150 
151 	/*
152 	 * Handle the MMIO case
153 	 */
154 	if (mmio) {
155 		ap->ioaddr.cmd_addr = devm_ioremap(dev, io_res->start,
156 				io_res->end - io_res->start + 1);
157 		ap->ioaddr.ctl_addr = devm_ioremap(dev, ctl_res->start,
158 				ctl_res->end - ctl_res->start + 1);
159 	} else {
160 		ap->ioaddr.cmd_addr = devm_ioport_map(dev, io_res->start,
161 				io_res->end - io_res->start + 1);
162 		ap->ioaddr.ctl_addr = devm_ioport_map(dev, ctl_res->start,
163 				ctl_res->end - ctl_res->start + 1);
164 	}
165 	if (!ap->ioaddr.cmd_addr || !ap->ioaddr.ctl_addr) {
166 		dev_err(dev, "failed to map IO/CTL base\n");
167 		return -ENOMEM;
168 	}
169 
170 	ap->ioaddr.altstatus_addr = ap->ioaddr.ctl_addr;
171 
172 	pata_platform_setup_port(&ap->ioaddr, ioport_shift);
173 
174 	ata_port_desc(ap, "%s cmd 0x%llx ctl 0x%llx", mmio ? "mmio" : "ioport",
175 		      (unsigned long long)io_res->start,
176 		      (unsigned long long)ctl_res->start);
177 
178 	/* activate */
179 	return ata_host_activate(host, irq, irq ? ata_sff_interrupt : NULL,
180 				 irq_flags, &pata_platform_sht);
181 }
182 EXPORT_SYMBOL_GPL(__pata_platform_probe);
183 
184 /**
185  *	__pata_platform_remove		-	unplug a platform interface
186  *	@dev: device
187  *
188  *	A platform bus ATA device has been unplugged. Perform the needed
189  *	cleanup. Also called on module unload for any active devices.
190  */
191 int __devexit __pata_platform_remove(struct device *dev)
192 {
193 	struct ata_host *host = dev_get_drvdata(dev);
194 
195 	ata_host_detach(host);
196 
197 	return 0;
198 }
199 EXPORT_SYMBOL_GPL(__pata_platform_remove);
200 
201 static int __devinit pata_platform_probe(struct platform_device *pdev)
202 {
203 	struct resource *io_res;
204 	struct resource *ctl_res;
205 	struct resource *irq_res;
206 	struct pata_platform_info *pp_info = pdev->dev.platform_data;
207 
208 	/*
209 	 * Simple resource validation ..
210 	 */
211 	if ((pdev->num_resources != 3) && (pdev->num_resources != 2)) {
212 		dev_err(&pdev->dev, "invalid number of resources\n");
213 		return -EINVAL;
214 	}
215 
216 	/*
217 	 * Get the I/O base first
218 	 */
219 	io_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
220 	if (io_res == NULL) {
221 		io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
222 		if (unlikely(io_res == NULL))
223 			return -EINVAL;
224 	}
225 
226 	/*
227 	 * Then the CTL base
228 	 */
229 	ctl_res = platform_get_resource(pdev, IORESOURCE_IO, 1);
230 	if (ctl_res == NULL) {
231 		ctl_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
232 		if (unlikely(ctl_res == NULL))
233 			return -EINVAL;
234 	}
235 
236 	/*
237 	 * And the IRQ
238 	 */
239 	irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
240 	if (irq_res)
241 		irq_res->flags = pp_info ? pp_info->irq_flags : 0;
242 
243 	return __pata_platform_probe(&pdev->dev, io_res, ctl_res, irq_res,
244 				     pp_info ? pp_info->ioport_shift : 0,
245 				     pio_mask);
246 }
247 
248 static int __devexit pata_platform_remove(struct platform_device *pdev)
249 {
250 	return __pata_platform_remove(&pdev->dev);
251 }
252 
253 static struct platform_driver pata_platform_driver = {
254 	.probe		= pata_platform_probe,
255 	.remove		= __devexit_p(pata_platform_remove),
256 	.driver = {
257 		.name		= DRV_NAME,
258 		.owner		= THIS_MODULE,
259 	},
260 };
261 
262 static int __init pata_platform_init(void)
263 {
264 	return platform_driver_register(&pata_platform_driver);
265 }
266 
267 static void __exit pata_platform_exit(void)
268 {
269 	platform_driver_unregister(&pata_platform_driver);
270 }
271 module_init(pata_platform_init);
272 module_exit(pata_platform_exit);
273 
274 module_param(pio_mask, int, 0);
275 
276 MODULE_AUTHOR("Paul Mundt");
277 MODULE_DESCRIPTION("low-level driver for platform device ATA");
278 MODULE_LICENSE("GPL");
279 MODULE_VERSION(DRV_VERSION);
280 MODULE_ALIAS("platform:" DRV_NAME);
281