include cleanup: Update gfp.h and slab.h includes to prepare for breaking implicit...
[linux-2.6.git] / drivers / ata / pata_pcmcia.c
1 /*
2  *   pata_pcmcia.c - PCMCIA PATA controller driver.
3  *   Copyright 2005-2006 Red Hat Inc, all rights reserved.
4  *   PCMCIA ident update Copyright 2006 Marcin Juszkiewicz
5  *                                              <openembedded@hrw.one.pl>
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; either version 2, or (at your option)
10  *  any later version.
11  *
12  *  This program is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *  GNU General Public License for more details.
16  *
17  *  You should have received a copy of the GNU General Public License
18  *  along with this program; see the file COPYING.  If not, write to
19  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
20  *
21  *   Heavily based upon ide-cs.c
22  *   The initial developer of the original code is David A. Hinds
23  *   <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
24  *   are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
25  */
26
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/init.h>
30 #include <linux/blkdev.h>
31 #include <linux/delay.h>
32 #include <linux/slab.h>
33 #include <scsi/scsi_host.h>
34 #include <linux/ata.h>
35 #include <linux/libata.h>
36
37 #include <pcmcia/cs_types.h>
38 #include <pcmcia/cs.h>
39 #include <pcmcia/cistpl.h>
40 #include <pcmcia/ds.h>
41 #include <pcmcia/cisreg.h>
42 #include <pcmcia/ciscode.h>
43
44
45 #define DRV_NAME "pata_pcmcia"
46 #define DRV_VERSION "0.3.5"
47
48 /*
49  *      Private data structure to glue stuff together
50  */
51
52 struct ata_pcmcia_info {
53         struct pcmcia_device *pdev;
54         int             ndev;
55         dev_node_t      node;
56 };
57
58 /**
59  *      pcmcia_set_mode -       PCMCIA specific mode setup
60  *      @link: link
61  *      @r_failed_dev: Return pointer for failed device
62  *
63  *      Perform the tuning and setup of the devices and timings, which
64  *      for PCMCIA is the same as any other controller. We wrap it however
65  *      as we need to spot hardware with incorrect or missing master/slave
66  *      decode, which alas is embarrassingly common in the PC world
67  */
68
69 static int pcmcia_set_mode(struct ata_link *link, struct ata_device **r_failed_dev)
70 {
71         struct ata_device *master = &link->device[0];
72         struct ata_device *slave = &link->device[1];
73
74         if (!ata_dev_enabled(master) || !ata_dev_enabled(slave))
75                 return ata_do_set_mode(link, r_failed_dev);
76
77         if (memcmp(master->id + ATA_ID_FW_REV,  slave->id + ATA_ID_FW_REV,
78                            ATA_ID_FW_REV_LEN + ATA_ID_PROD_LEN) == 0) {
79                 /* Suspicious match, but could be two cards from
80                    the same vendor - check serial */
81                 if (memcmp(master->id + ATA_ID_SERNO, slave->id + ATA_ID_SERNO,
82                            ATA_ID_SERNO_LEN) == 0 && master->id[ATA_ID_SERNO] >> 8) {
83                         ata_dev_printk(slave, KERN_WARNING, "is a ghost device, ignoring.\n");
84                         ata_dev_disable(slave);
85                 }
86         }
87         return ata_do_set_mode(link, r_failed_dev);
88 }
89
90 /**
91  *      pcmcia_set_mode_8bit    -       PCMCIA specific mode setup
92  *      @link: link
93  *      @r_failed_dev: Return pointer for failed device
94  *
95  *      For the simple emulated 8bit stuff the less we do the better.
96  */
97
98 static int pcmcia_set_mode_8bit(struct ata_link *link,
99                                 struct ata_device **r_failed_dev)
100 {
101         return 0;
102 }
103
104 /**
105  *      ata_data_xfer_8bit       -      Transfer data by 8bit PIO
106  *      @dev: device to target
107  *      @buf: data buffer
108  *      @buflen: buffer length
109  *      @rw: read/write
110  *
111  *      Transfer data from/to the device data register by 8 bit PIO.
112  *
113  *      LOCKING:
114  *      Inherited from caller.
115  */
116
117 static unsigned int ata_data_xfer_8bit(struct ata_device *dev,
118                                 unsigned char *buf, unsigned int buflen, int rw)
119 {
120         struct ata_port *ap = dev->link->ap;
121
122         if (rw == READ)
123                 ioread8_rep(ap->ioaddr.data_addr, buf, buflen);
124         else
125                 iowrite8_rep(ap->ioaddr.data_addr, buf, buflen);
126
127         return buflen;
128 }
129
130 /**
131  *      pcmcia_8bit_drain_fifo - Stock FIFO drain logic for SFF controllers
132  *      @qc: command
133  *
134  *      Drain the FIFO and device of any stuck data following a command
135  *      failing to complete. In some cases this is necessary before a
136  *      reset will recover the device.
137  *
138  */
139  
140 static void pcmcia_8bit_drain_fifo(struct ata_queued_cmd *qc)
141 {
142         int count;
143         struct ata_port *ap;
144
145         /* We only need to flush incoming data when a command was running */
146         if (qc == NULL || qc->dma_dir == DMA_TO_DEVICE)
147                 return;
148
149         ap = qc->ap;
150
151         /* Drain up to 64K of data before we give up this recovery method */
152         for (count = 0; (ap->ops->sff_check_status(ap) & ATA_DRQ)
153                                                         && count++ < 65536;)
154                 ioread8(ap->ioaddr.data_addr);
155
156         if (count)
157                 ata_port_printk(ap, KERN_WARNING, "drained %d bytes to clear DRQ.\n",
158                                                                 count);
159
160 }
161
162 static struct scsi_host_template pcmcia_sht = {
163         ATA_PIO_SHT(DRV_NAME),
164 };
165
166 static struct ata_port_operations pcmcia_port_ops = {
167         .inherits       = &ata_sff_port_ops,
168         .sff_data_xfer  = ata_sff_data_xfer_noirq,
169         .cable_detect   = ata_cable_40wire,
170         .set_mode       = pcmcia_set_mode,
171 };
172
173 static struct ata_port_operations pcmcia_8bit_port_ops = {
174         .inherits       = &ata_sff_port_ops,
175         .sff_data_xfer  = ata_data_xfer_8bit,
176         .cable_detect   = ata_cable_40wire,
177         .set_mode       = pcmcia_set_mode_8bit,
178         .drain_fifo     = pcmcia_8bit_drain_fifo,
179 };
180
181
182 struct pcmcia_config_check {
183         unsigned long ctl_base;
184         int skip_vcc;
185         int is_kme;
186 };
187
188 static int pcmcia_check_one_config(struct pcmcia_device *pdev,
189                                    cistpl_cftable_entry_t *cfg,
190                                    cistpl_cftable_entry_t *dflt,
191                                    unsigned int vcc,
192                                    void *priv_data)
193 {
194         struct pcmcia_config_check *stk = priv_data;
195
196         /* Check for matching Vcc, unless we're desperate */
197         if (!stk->skip_vcc) {
198                 if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
199                         if (vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000)
200                                 return -ENODEV;
201                 } else if (dflt->vcc.present & (1 << CISTPL_POWER_VNOM)) {
202                         if (vcc != dflt->vcc.param[CISTPL_POWER_VNOM] / 10000)
203                                 return -ENODEV;
204                 }
205         }
206
207         if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
208                 pdev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
209         else if (dflt->vpp1.present & (1 << CISTPL_POWER_VNOM))
210                 pdev->conf.Vpp = dflt->vpp1.param[CISTPL_POWER_VNOM] / 10000;
211
212         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
213                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
214                 pdev->io.BasePort1 = io->win[0].base;
215                 pdev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
216                 if (!(io->flags & CISTPL_IO_16BIT))
217                         pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
218                 if (io->nwin == 2) {
219                         pdev->io.NumPorts1 = 8;
220                         pdev->io.BasePort2 = io->win[1].base;
221                         pdev->io.NumPorts2 = (stk->is_kme) ? 2 : 1;
222                         if (pcmcia_request_io(pdev, &pdev->io) != 0)
223                                 return -ENODEV;
224                         stk->ctl_base = pdev->io.BasePort2;
225                 } else if ((io->nwin == 1) && (io->win[0].len >= 16)) {
226                         pdev->io.NumPorts1 = io->win[0].len;
227                         pdev->io.NumPorts2 = 0;
228                         if (pcmcia_request_io(pdev, &pdev->io) != 0)
229                                 return -ENODEV;
230                         stk->ctl_base = pdev->io.BasePort1 + 0x0e;
231                 } else
232                         return -ENODEV;
233                 /* If we've got this far, we're done */
234                 return 0;
235         }
236         return -ENODEV;
237 }
238
239 /**
240  *      pcmcia_init_one         -       attach a PCMCIA interface
241  *      @pdev: pcmcia device
242  *
243  *      Register a PCMCIA IDE interface. Such interfaces are PIO 0 and
244  *      shared IRQ.
245  */
246
247 static int pcmcia_init_one(struct pcmcia_device *pdev)
248 {
249         struct ata_host *host;
250         struct ata_port *ap;
251         struct ata_pcmcia_info *info;
252         struct pcmcia_config_check *stk = NULL;
253         int is_kme = 0, ret = -ENOMEM, p;
254         unsigned long io_base, ctl_base;
255         void __iomem *io_addr, *ctl_addr;
256         int n_ports = 1;
257         struct ata_port_operations *ops = &pcmcia_port_ops;
258
259         info = kzalloc(sizeof(*info), GFP_KERNEL);
260         if (info == NULL)
261                 return -ENOMEM;
262
263         /* Glue stuff together. FIXME: We may be able to get rid of info with care */
264         info->pdev = pdev;
265         pdev->priv = info;
266
267         /* Set up attributes in order to probe card and get resources */
268         pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
269         pdev->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
270         pdev->io.IOAddrLines = 3;
271         pdev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
272         pdev->conf.Attributes = CONF_ENABLE_IRQ;
273         pdev->conf.IntType = INT_MEMORY_AND_IO;
274
275         /* See if we have a manufacturer identifier. Use it to set is_kme for
276            vendor quirks */
277         is_kme = ((pdev->manf_id == MANFID_KME) &&
278                   ((pdev->card_id == PRODID_KME_KXLC005_A) ||
279                    (pdev->card_id == PRODID_KME_KXLC005_B)));
280
281         /* Allocate resoure probing structures */
282
283         stk = kzalloc(sizeof(*stk), GFP_KERNEL);
284         if (!stk)
285                 goto out1;
286         stk->is_kme = is_kme;
287         stk->skip_vcc = io_base = ctl_base = 0;
288
289         if (pcmcia_loop_config(pdev, pcmcia_check_one_config, stk)) {
290                 stk->skip_vcc = 1;
291                 if (pcmcia_loop_config(pdev, pcmcia_check_one_config, stk))
292                         goto failed; /* No suitable config found */
293         }
294         io_base = pdev->io.BasePort1;
295         ctl_base = stk->ctl_base;
296         ret = pcmcia_request_irq(pdev, &pdev->irq);
297         if (ret)
298                 goto failed;
299
300         ret = pcmcia_request_configuration(pdev, &pdev->conf);
301         if (ret)
302                 goto failed;
303
304         /* iomap */
305         ret = -ENOMEM;
306         io_addr = devm_ioport_map(&pdev->dev, io_base, 8);
307         ctl_addr = devm_ioport_map(&pdev->dev, ctl_base, 1);
308         if (!io_addr || !ctl_addr)
309                 goto failed;
310
311         /* Success. Disable the IRQ nIEN line, do quirks */
312         iowrite8(0x02, ctl_addr);
313         if (is_kme)
314                 iowrite8(0x81, ctl_addr + 0x01);
315
316         /* FIXME: Could be more ports at base + 0x10 but we only deal with
317            one right now */
318         if (pdev->io.NumPorts1 >= 0x20)
319                 n_ports = 2;
320
321         if (pdev->manf_id == 0x0097 && pdev->card_id == 0x1620)
322                 ops = &pcmcia_8bit_port_ops;
323         /*
324          *      Having done the PCMCIA plumbing the ATA side is relatively
325          *      sane.
326          */
327         ret = -ENOMEM;
328         host = ata_host_alloc(&pdev->dev, n_ports);
329         if (!host)
330                 goto failed;
331
332         for (p = 0; p < n_ports; p++) {
333                 ap = host->ports[p];
334
335                 ap->ops = ops;
336                 ap->pio_mask = ATA_PIO0;        /* ISA so PIO 0 cycles */
337                 ap->flags |= ATA_FLAG_SLAVE_POSS;
338                 ap->ioaddr.cmd_addr = io_addr + 0x10 * p;
339                 ap->ioaddr.altstatus_addr = ctl_addr + 0x10 * p;
340                 ap->ioaddr.ctl_addr = ctl_addr + 0x10 * p;
341                 ata_sff_std_ports(&ap->ioaddr);
342
343                 ata_port_desc(ap, "cmd 0x%lx ctl 0x%lx", io_base, ctl_base);
344         }
345
346         /* activate */
347         ret = ata_host_activate(host, pdev->irq.AssignedIRQ, ata_sff_interrupt,
348                                 IRQF_SHARED, &pcmcia_sht);
349         if (ret)
350                 goto failed;
351
352         info->ndev = 1;
353         kfree(stk);
354         return 0;
355
356 failed:
357         kfree(stk);
358         info->ndev = 0;
359         pcmcia_disable_device(pdev);
360 out1:
361         kfree(info);
362         return ret;
363 }
364
365 /**
366  *      pcmcia_remove_one       -       unplug an pcmcia interface
367  *      @pdev: pcmcia device
368  *
369  *      A PCMCIA ATA device has been unplugged. Perform the needed
370  *      cleanup. Also called on module unload for any active devices.
371  */
372
373 static void pcmcia_remove_one(struct pcmcia_device *pdev)
374 {
375         struct ata_pcmcia_info *info = pdev->priv;
376         struct device *dev = &pdev->dev;
377
378         if (info != NULL) {
379                 /* If we have attached the device to the ATA layer, detach it */
380                 if (info->ndev) {
381                         struct ata_host *host = dev_get_drvdata(dev);
382                         ata_host_detach(host);
383                 }
384                 info->ndev = 0;
385                 pdev->priv = NULL;
386         }
387         pcmcia_disable_device(pdev);
388         kfree(info);
389 }
390
391 static struct pcmcia_device_id pcmcia_devices[] = {
392         PCMCIA_DEVICE_FUNC_ID(4),
393         PCMCIA_DEVICE_MANF_CARD(0x0000, 0x0000),        /* Corsair */
394         PCMCIA_DEVICE_MANF_CARD(0x0007, 0x0000),        /* Hitachi */
395         PCMCIA_DEVICE_MANF_CARD(0x000a, 0x0000),        /* I-O Data CFA */
396         PCMCIA_DEVICE_MANF_CARD(0x001c, 0x0001),        /* Mitsubishi CFA */
397         PCMCIA_DEVICE_MANF_CARD(0x0032, 0x0704),
398         PCMCIA_DEVICE_MANF_CARD(0x0032, 0x2904),
399         PCMCIA_DEVICE_MANF_CARD(0x0045, 0x0401),        /* SanDisk CFA */
400         PCMCIA_DEVICE_MANF_CARD(0x004f, 0x0000),        /* Kingston */
401         PCMCIA_DEVICE_MANF_CARD(0x0097, 0x1620),        /* TI emulated */
402         PCMCIA_DEVICE_MANF_CARD(0x0098, 0x0000),        /* Toshiba */
403         PCMCIA_DEVICE_MANF_CARD(0x00a4, 0x002d),
404         PCMCIA_DEVICE_MANF_CARD(0x00ce, 0x0000),        /* Samsung */
405         PCMCIA_DEVICE_MANF_CARD(0x0319, 0x0000),        /* Hitachi */
406         PCMCIA_DEVICE_MANF_CARD(0x2080, 0x0001),
407         PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0100),        /* Viking CFA */
408         PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0200),        /* Lexar, Viking CFA */
409         PCMCIA_DEVICE_PROD_ID123("Caravelle", "PSC-IDE ", "PSC000", 0x8c36137c, 0xd0693ab8, 0x2768a9f0),
410         PCMCIA_DEVICE_PROD_ID123("CDROM", "IDE", "MCD-601p", 0x1b9179ca, 0xede88951, 0x0d902f74),
411         PCMCIA_DEVICE_PROD_ID123("PCMCIA", "IDE CARD", "F1", 0x281f1c5d, 0x1907960c, 0xf7fde8b9),
412         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "CD-ROM", 0x78f308dc, 0x66536591),
413         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "PnPIDE", 0x78f308dc, 0x0c694728),
414         PCMCIA_DEVICE_PROD_ID12("CNF   ", "CD-ROM", 0x46d7db81, 0x66536591),
415         PCMCIA_DEVICE_PROD_ID12("CNF CD-M", "CD-ROM", 0x7d93b852, 0x66536591),
416         PCMCIA_DEVICE_PROD_ID12("Creative Technology Ltd.", "PCMCIA CD-ROM Interface Card", 0xff8c8a45, 0xfe8020c4),
417         PCMCIA_DEVICE_PROD_ID12("Digital Equipment Corporation.", "Digital Mobile Media CD-ROM", 0x17692a66, 0xef1dcbde),
418         PCMCIA_DEVICE_PROD_ID12("EXP", "CD+GAME", 0x6f58c983, 0x63c13aaf),
419         PCMCIA_DEVICE_PROD_ID12("EXP   ", "CD-ROM", 0x0a5c52fd, 0x66536591),
420         PCMCIA_DEVICE_PROD_ID12("EXP   ", "PnPIDE", 0x0a5c52fd, 0x0c694728),
421         PCMCIA_DEVICE_PROD_ID12("FREECOM", "PCCARD-IDE", 0x5714cbf7, 0x48e0ab8e),
422         PCMCIA_DEVICE_PROD_ID12("HITACHI", "FLASH", 0xf4f43949, 0x9eb86aae),
423         PCMCIA_DEVICE_PROD_ID12("HITACHI", "microdrive", 0xf4f43949, 0xa6d76178),
424         PCMCIA_DEVICE_PROD_ID12("Hyperstone", "Model1", 0x3d5b9ef5, 0xca6ab420),
425         PCMCIA_DEVICE_PROD_ID12("IBM", "microdrive", 0xb569a6e5, 0xa6d76178),
426         PCMCIA_DEVICE_PROD_ID12("IBM", "IBM17JSSFP20", 0xb569a6e5, 0xf2508753),
427         PCMCIA_DEVICE_PROD_ID12("KINGSTON", "CF8GB", 0x2e6d1829, 0xacbe682e),
428         PCMCIA_DEVICE_PROD_ID12("IO DATA", "CBIDE2      ", 0x547e66dc, 0x8671043b),
429         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDE", 0x547e66dc, 0x5c5ab149),
430         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDEII", 0x547e66dc, 0xb3662674),
431         PCMCIA_DEVICE_PROD_ID12("LOOKMEET", "CBIDE2      ", 0xe37be2b5, 0x8671043b),
432         PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF300", 0x7ed2ad87, 0x7e9e78ee),
433         PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF500", 0x7ed2ad87, 0x7a13045c),
434         PCMCIA_DEVICE_PROD_ID2("NinjaATA-", 0xebe0bd79),
435         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "CD-ROM", 0x281f1c5d, 0x66536591),
436         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "PnPIDE", 0x281f1c5d, 0x0c694728),
437         PCMCIA_DEVICE_PROD_ID12("SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", 0x4a3f0ba0, 0x322560e1),
438         PCMCIA_DEVICE_PROD_ID12("SEAGATE", "ST1", 0x87c1b330, 0xe1f30883),
439         PCMCIA_DEVICE_PROD_ID12("SAMSUNG", "04/05/06", 0x43d74cb4, 0x6a22777d),
440         PCMCIA_DEVICE_PROD_ID12("SMI VENDOR", "SMI PRODUCT", 0x30896c92, 0x703cc5f6),
441         PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "MK2001MPL", 0xb4585a1a, 0x3489e003),
442         PCMCIA_DEVICE_PROD_ID1("TRANSCEND    512M   ", 0xd0909443),
443         PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF45", 0x709b1bf1, 0xf68b6f32),
444         PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF80", 0x709b1bf1, 0x2a54d4b1),
445         PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS2GCF120", 0x709b1bf1, 0x969aa4f2),
446         PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS4GCF120", 0x709b1bf1, 0xf54a91c8),
447         PCMCIA_DEVICE_PROD_ID12("WIT", "IDE16", 0x244e5994, 0x3e232852),
448         PCMCIA_DEVICE_PROD_ID12("WEIDA", "TWTTI", 0xcc7cf69c, 0x212bb918),
449         PCMCIA_DEVICE_PROD_ID1("STI Flash", 0xe4a13209),
450         PCMCIA_DEVICE_PROD_ID12("STI", "Flash 5.0", 0xbf2df18d, 0x8cb57a0e),
451         PCMCIA_MFC_DEVICE_PROD_ID12(1, "SanDisk", "ConnectPlus", 0x7a954bd9, 0x74be00c6),
452         PCMCIA_DEVICE_PROD_ID2("Flash Card", 0x5a362506),
453         PCMCIA_DEVICE_NULL,
454 };
455
456 MODULE_DEVICE_TABLE(pcmcia, pcmcia_devices);
457
458 static struct pcmcia_driver pcmcia_driver = {
459         .owner          = THIS_MODULE,
460         .drv = {
461                 .name           = DRV_NAME,
462         },
463         .id_table       = pcmcia_devices,
464         .probe          = pcmcia_init_one,
465         .remove         = pcmcia_remove_one,
466 };
467
468 static int __init pcmcia_init(void)
469 {
470         return pcmcia_register_driver(&pcmcia_driver);
471 }
472
473 static void __exit pcmcia_exit(void)
474 {
475         pcmcia_unregister_driver(&pcmcia_driver);
476 }
477
478 MODULE_AUTHOR("Alan Cox");
479 MODULE_DESCRIPTION("low-level driver for PCMCIA ATA");
480 MODULE_LICENSE("GPL");
481 MODULE_VERSION(DRV_VERSION);
482
483 module_init(pcmcia_init);
484 module_exit(pcmcia_exit);