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