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