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