libata: normalize port_info, port_operations and sht tables
[safe/jmp/linux-2.6] / 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 <alan@redhat.com>, 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         .module                 = THIS_MODULE,
51         .name                   = DRV_NAME,
52         .ioctl                  = ata_scsi_ioctl,
53         .queuecommand           = ata_scsi_queuecmd,
54         .can_queue              = ATA_DEF_QUEUE,
55         .this_id                = ATA_SHT_THIS_ID,
56         .sg_tablesize           = LIBATA_MAX_PRD,
57         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
58         .emulated               = ATA_SHT_EMULATED,
59         .use_clustering         = ATA_SHT_USE_CLUSTERING,
60         .proc_name              = DRV_NAME,
61         .dma_boundary           = ATA_DMA_BOUNDARY,
62         .slave_configure        = ata_scsi_slave_config,
63         .slave_destroy          = ata_scsi_slave_destroy,
64         .bios_param             = ata_std_bios_param,
65 };
66
67 static struct ata_port_operations pata_platform_port_ops = {
68         .set_mode               = pata_platform_set_mode,
69
70         .tf_load                = ata_tf_load,
71         .tf_read                = ata_tf_read,
72         .check_status           = ata_check_status,
73         .exec_command           = ata_exec_command,
74         .dev_select             = ata_std_dev_select,
75
76         .freeze                 = ata_bmdma_freeze,
77         .thaw                   = ata_bmdma_thaw,
78         .error_handler          = ata_bmdma_error_handler,
79         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
80         .cable_detect           = ata_cable_unknown,
81
82         .qc_prep                = ata_qc_prep,
83         .qc_issue               = ata_qc_issue_prot,
84
85         .data_xfer              = ata_data_xfer_noirq,
86
87         .irq_clear              = ata_noop_irq_clear,
88         .irq_on                 = ata_irq_on,
89 };
90
91 static void pata_platform_setup_port(struct ata_ioports *ioaddr,
92                                      unsigned int shift)
93 {
94         /* Fixup the port shift for platforms that need it */
95         ioaddr->data_addr       = ioaddr->cmd_addr + (ATA_REG_DATA    << shift);
96         ioaddr->error_addr      = ioaddr->cmd_addr + (ATA_REG_ERR     << shift);
97         ioaddr->feature_addr    = ioaddr->cmd_addr + (ATA_REG_FEATURE << shift);
98         ioaddr->nsect_addr      = ioaddr->cmd_addr + (ATA_REG_NSECT   << shift);
99         ioaddr->lbal_addr       = ioaddr->cmd_addr + (ATA_REG_LBAL    << shift);
100         ioaddr->lbam_addr       = ioaddr->cmd_addr + (ATA_REG_LBAM    << shift);
101         ioaddr->lbah_addr       = ioaddr->cmd_addr + (ATA_REG_LBAH    << shift);
102         ioaddr->device_addr     = ioaddr->cmd_addr + (ATA_REG_DEVICE  << shift);
103         ioaddr->status_addr     = ioaddr->cmd_addr + (ATA_REG_STATUS  << shift);
104         ioaddr->command_addr    = ioaddr->cmd_addr + (ATA_REG_CMD     << shift);
105 }
106
107 /**
108  *      __pata_platform_probe           -       attach a platform interface
109  *      @dev: device
110  *      @io_res: Resource representing I/O base
111  *      @ctl_res: Resource representing CTL base
112  *      @irq_res: Resource representing IRQ and its flags
113  *      @ioport_shift: I/O port shift
114  *      @__pio_mask: PIO mask
115  *
116  *      Register a platform bus IDE interface. Such interfaces are PIO and we
117  *      assume do not support IRQ sharing.
118  *
119  *      Platform devices are expected to contain at least 2 resources per port:
120  *
121  *              - I/O Base (IORESOURCE_IO or IORESOURCE_MEM)
122  *              - CTL Base (IORESOURCE_IO or IORESOURCE_MEM)
123  *
124  *      and optionally:
125  *
126  *              - IRQ      (IORESOURCE_IRQ)
127  *
128  *      If the base resources are both mem types, the ioremap() is handled
129  *      here. For IORESOURCE_IO, it's assumed that there's no remapping
130  *      necessary.
131  *
132  *      If no IRQ resource is present, PIO polling mode is used instead.
133  */
134 int __devinit __pata_platform_probe(struct device *dev,
135                                     struct resource *io_res,
136                                     struct resource *ctl_res,
137                                     struct resource *irq_res,
138                                     unsigned int ioport_shift,
139                                     int __pio_mask)
140 {
141         struct ata_host *host;
142         struct ata_port *ap;
143         unsigned int mmio;
144         int irq = 0;
145         int irq_flags = 0;
146
147         /*
148          * Check for MMIO
149          */
150         mmio = (( io_res->flags == IORESOURCE_MEM) &&
151                 (ctl_res->flags == IORESOURCE_MEM));
152
153         /*
154          * And the IRQ
155          */
156         if (irq_res && irq_res->start > 0) {
157                 irq = irq_res->start;
158                 irq_flags = irq_res->flags;
159         }
160
161         /*
162          * Now that that's out of the way, wire up the port..
163          */
164         host = ata_host_alloc(dev, 1);
165         if (!host)
166                 return -ENOMEM;
167         ap = host->ports[0];
168
169         ap->ops = &pata_platform_port_ops;
170         ap->pio_mask = __pio_mask;
171         ap->flags |= ATA_FLAG_SLAVE_POSS;
172
173         /*
174          * Use polling mode if there's no IRQ
175          */
176         if (!irq) {
177                 ap->flags |= ATA_FLAG_PIO_POLLING;
178                 ata_port_desc(ap, "no IRQ, using PIO polling");
179         }
180
181         /*
182          * Handle the MMIO case
183          */
184         if (mmio) {
185                 ap->ioaddr.cmd_addr = devm_ioremap(dev, io_res->start,
186                                 io_res->end - io_res->start + 1);
187                 ap->ioaddr.ctl_addr = devm_ioremap(dev, ctl_res->start,
188                                 ctl_res->end - ctl_res->start + 1);
189         } else {
190                 ap->ioaddr.cmd_addr = devm_ioport_map(dev, io_res->start,
191                                 io_res->end - io_res->start + 1);
192                 ap->ioaddr.ctl_addr = devm_ioport_map(dev, ctl_res->start,
193                                 ctl_res->end - ctl_res->start + 1);
194         }
195         if (!ap->ioaddr.cmd_addr || !ap->ioaddr.ctl_addr) {
196                 dev_err(dev, "failed to map IO/CTL base\n");
197                 return -ENOMEM;
198         }
199
200         ap->ioaddr.altstatus_addr = ap->ioaddr.ctl_addr;
201
202         pata_platform_setup_port(&ap->ioaddr, ioport_shift);
203
204         ata_port_desc(ap, "%s cmd 0x%llx ctl 0x%llx", mmio ? "mmio" : "ioport",
205                       (unsigned long long)io_res->start,
206                       (unsigned long long)ctl_res->start);
207
208         /* activate */
209         return ata_host_activate(host, irq, irq ? ata_interrupt : NULL,
210                                  irq_flags, &pata_platform_sht);
211 }
212 EXPORT_SYMBOL_GPL(__pata_platform_probe);
213
214 /**
215  *      __pata_platform_remove          -       unplug a platform interface
216  *      @dev: device
217  *
218  *      A platform bus ATA device has been unplugged. Perform the needed
219  *      cleanup. Also called on module unload for any active devices.
220  */
221 int __devexit __pata_platform_remove(struct device *dev)
222 {
223         struct ata_host *host = dev_get_drvdata(dev);
224
225         ata_host_detach(host);
226
227         return 0;
228 }
229 EXPORT_SYMBOL_GPL(__pata_platform_remove);
230
231 static int __devinit pata_platform_probe(struct platform_device *pdev)
232 {
233         struct resource *io_res;
234         struct resource *ctl_res;
235         struct resource *irq_res;
236         struct pata_platform_info *pp_info = pdev->dev.platform_data;
237
238         /*
239          * Simple resource validation ..
240          */
241         if ((pdev->num_resources != 3) && (pdev->num_resources != 2)) {
242                 dev_err(&pdev->dev, "invalid number of resources\n");
243                 return -EINVAL;
244         }
245
246         /*
247          * Get the I/O base first
248          */
249         io_res = platform_get_resource(pdev, IORESOURCE_IO, 0);
250         if (io_res == NULL) {
251                 io_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
252                 if (unlikely(io_res == NULL))
253                         return -EINVAL;
254         }
255
256         /*
257          * Then the CTL base
258          */
259         ctl_res = platform_get_resource(pdev, IORESOURCE_IO, 1);
260         if (ctl_res == NULL) {
261                 ctl_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
262                 if (unlikely(ctl_res == NULL))
263                         return -EINVAL;
264         }
265
266         /*
267          * And the IRQ
268          */
269         irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
270         if (irq_res)
271                 irq_res->flags = pp_info ? pp_info->irq_flags : 0;
272
273         return __pata_platform_probe(&pdev->dev, io_res, ctl_res, irq_res,
274                                      pp_info ? pp_info->ioport_shift : 0,
275                                      pio_mask);
276 }
277
278 static int __devexit pata_platform_remove(struct platform_device *pdev)
279 {
280         return __pata_platform_remove(&pdev->dev);
281 }
282
283 static struct platform_driver pata_platform_driver = {
284         .probe          = pata_platform_probe,
285         .remove         = __devexit_p(pata_platform_remove),
286         .driver = {
287                 .name           = DRV_NAME,
288                 .owner          = THIS_MODULE,
289         },
290 };
291
292 static int __init pata_platform_init(void)
293 {
294         return platform_driver_register(&pata_platform_driver);
295 }
296
297 static void __exit pata_platform_exit(void)
298 {
299         platform_driver_unregister(&pata_platform_driver);
300 }
301 module_init(pata_platform_init);
302 module_exit(pata_platform_exit);
303
304 module_param(pio_mask, int, 0);
305
306 MODULE_AUTHOR("Paul Mundt");
307 MODULE_DESCRIPTION("low-level driver for platform device ATA");
308 MODULE_LICENSE("GPL");
309 MODULE_VERSION(DRV_VERSION);