8cccd1b81ee24b533a0f18d490c70b86cf865a85
[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 <alan@redhat.com>, 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.3"
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 static struct scsi_host_template pcmcia_sht = {
131         ATA_PIO_SHT(DRV_NAME),
132 };
133
134 static struct ata_port_operations pcmcia_port_ops = {
135         .inherits       = &ata_sff_port_ops,
136         .sff_data_xfer  = ata_sff_data_xfer_noirq,
137         .cable_detect   = ata_cable_40wire,
138         .set_mode       = pcmcia_set_mode,
139 };
140
141 static struct ata_port_operations pcmcia_8bit_port_ops = {
142         .inherits       = &ata_sff_port_ops,
143         .sff_data_xfer  = ata_data_xfer_8bit,
144         .cable_detect   = ata_cable_40wire,
145         .set_mode       = pcmcia_set_mode_8bit,
146 };
147
148 #define CS_CHECK(fn, ret) \
149 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
150
151
152 struct pcmcia_config_check {
153         config_info_t conf;
154         cistpl_cftable_entry_t dflt;
155         unsigned long ctl_base;
156         int skip_vcc;
157         int is_kme;
158 };
159
160 static int pcmcia_check_one_config(struct pcmcia_device *pdev,
161                                    cistpl_cftable_entry_t *cfg,
162                                    void *priv_data)
163 {
164         struct pcmcia_config_check *stk = priv_data;
165
166         /* Check for matching Vcc, unless we're desperate */
167         if (!stk->skip_vcc) {
168                 if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
169                         if (stk->conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000)
170                                 goto next_entry;
171                 } else if (stk->dflt.vcc.present & (1 << CISTPL_POWER_VNOM)) {
172                         if (stk->conf.Vcc != stk->dflt.vcc.param[CISTPL_POWER_VNOM] / 10000)
173                                 goto next_entry;
174                 }
175         }
176
177         if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
178                 pdev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
179         else if (stk->dflt.vpp1.present & (1 << CISTPL_POWER_VNOM))
180                 pdev->conf.Vpp = stk->dflt.vpp1.param[CISTPL_POWER_VNOM] / 10000;
181
182         if ((cfg->io.nwin > 0) || (stk->dflt.io.nwin > 0)) {
183                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &stk->dflt.io;
184                 pdev->conf.ConfigIndex = cfg->index;
185                 pdev->io.BasePort1 = io->win[0].base;
186                 pdev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
187                 if (!(io->flags & CISTPL_IO_16BIT))
188                         pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
189                 if (io->nwin == 2) {
190                         pdev->io.NumPorts1 = 8;
191                         pdev->io.BasePort2 = io->win[1].base;
192                         pdev->io.NumPorts2 = (stk->is_kme) ? 2 : 1;
193                         if (pcmcia_request_io(pdev, &pdev->io) != 0)
194                                 goto next_entry;
195                         stk->ctl_base = pdev->io.BasePort2;
196                 } else if ((io->nwin == 1) && (io->win[0].len >= 16)) {
197                         pdev->io.NumPorts1 = io->win[0].len;
198                         pdev->io.NumPorts2 = 0;
199                         if (pcmcia_request_io(pdev, &pdev->io) != 0)
200                                 goto next_entry;
201                         stk->ctl_base = pdev->io.BasePort1 + 0x0e;
202                 } else
203                         goto next_entry;
204                 /* If we've got this far, we're done */
205                 return 0;
206         }
207 next_entry:
208         if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
209                 memcpy(&stk->dflt, cfg, sizeof(stk->dflt));
210
211         return -ENODEV;
212 }
213
214 /**
215  *      pcmcia_init_one         -       attach a PCMCIA interface
216  *      @pdev: pcmcia device
217  *
218  *      Register a PCMCIA IDE interface. Such interfaces are PIO 0 and
219  *      shared IRQ.
220  */
221
222 static int pcmcia_init_one(struct pcmcia_device *pdev)
223 {
224         struct ata_host *host;
225         struct ata_port *ap;
226         struct ata_pcmcia_info *info;
227         struct pcmcia_config_check *stk = NULL;
228         int last_ret = 0, last_fn = 0, is_kme = 0, ret = -ENOMEM, p;
229         unsigned long io_base, ctl_base;
230         void __iomem *io_addr, *ctl_addr;
231         int n_ports = 1;
232         struct ata_port_operations *ops = &pcmcia_port_ops;
233
234         info = kzalloc(sizeof(*info), GFP_KERNEL);
235         if (info == NULL)
236                 return -ENOMEM;
237
238         /* Glue stuff together. FIXME: We may be able to get rid of info with care */
239         info->pdev = pdev;
240         pdev->priv = info;
241
242         /* Set up attributes in order to probe card and get resources */
243         pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
244         pdev->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
245         pdev->io.IOAddrLines = 3;
246         pdev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
247         pdev->irq.IRQInfo1 = IRQ_LEVEL_ID;
248         pdev->conf.Attributes = CONF_ENABLE_IRQ;
249         pdev->conf.IntType = INT_MEMORY_AND_IO;
250
251         /* See if we have a manufacturer identifier. Use it to set is_kme for
252            vendor quirks */
253         is_kme = ((pdev->manf_id == MANFID_KME) &&
254                   ((pdev->card_id == PRODID_KME_KXLC005_A) ||
255                    (pdev->card_id == PRODID_KME_KXLC005_B)));
256
257         /* Allocate resoure probing structures */
258
259         stk = kzalloc(sizeof(*stk), GFP_KERNEL);
260         if (!stk)
261                 goto out1;
262         stk->is_kme = is_kme;
263
264         /* Not sure if this is right... look up the current Vcc */
265         CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(pdev, &stk->conf));
266         stk->skip_vcc = io_base = ctl_base = 0;
267         if (pcmcia_loop_config(pdev, pcmcia_check_one_config, stk)) {
268                 memset(&stk->dflt, 0, sizeof(stk->dflt));
269                 stk->skip_vcc = 1;
270                 if (pcmcia_loop_config(pdev, pcmcia_check_one_config, stk))
271                         goto failed; /* No suitable config found */
272         }
273         io_base = pdev->io.BasePort1;
274         ctl_base = stk->ctl_base;
275         CS_CHECK(RequestIRQ, pcmcia_request_irq(pdev, &pdev->irq));
276         CS_CHECK(RequestConfiguration, pcmcia_request_configuration(pdev, &pdev->conf));
277
278         /* iomap */
279         ret = -ENOMEM;
280         io_addr = devm_ioport_map(&pdev->dev, io_base, 8);
281         ctl_addr = devm_ioport_map(&pdev->dev, ctl_base, 1);
282         if (!io_addr || !ctl_addr)
283                 goto failed;
284
285         /* Success. Disable the IRQ nIEN line, do quirks */
286         iowrite8(0x02, ctl_addr);
287         if (is_kme)
288                 iowrite8(0x81, ctl_addr + 0x01);
289
290         /* FIXME: Could be more ports at base + 0x10 but we only deal with
291            one right now */
292         if (pdev->io.NumPorts1 >= 0x20)
293                 n_ports = 2;
294
295         if (pdev->manf_id == 0x0097 && pdev->card_id == 0x1620)
296                 ops = &pcmcia_8bit_port_ops;
297         /*
298          *      Having done the PCMCIA plumbing the ATA side is relatively
299          *      sane.
300          */
301         ret = -ENOMEM;
302         host = ata_host_alloc(&pdev->dev, n_ports);
303         if (!host)
304                 goto failed;
305
306         for (p = 0; p < n_ports; p++) {
307                 ap = host->ports[p];
308
309                 ap->ops = ops;
310                 ap->pio_mask = 1;               /* ISA so PIO 0 cycles */
311                 ap->flags |= ATA_FLAG_SLAVE_POSS;
312                 ap->ioaddr.cmd_addr = io_addr + 0x10 * p;
313                 ap->ioaddr.altstatus_addr = ctl_addr + 0x10 * p;
314                 ap->ioaddr.ctl_addr = ctl_addr + 0x10 * p;
315                 ata_sff_std_ports(&ap->ioaddr);
316
317                 ata_port_desc(ap, "cmd 0x%lx ctl 0x%lx", io_base, ctl_base);
318         }
319
320         /* activate */
321         ret = ata_host_activate(host, pdev->irq.AssignedIRQ, ata_sff_interrupt,
322                                 IRQF_SHARED, &pcmcia_sht);
323         if (ret)
324                 goto failed;
325
326         info->ndev = 1;
327         kfree(stk);
328         return 0;
329
330 cs_failed:
331         cs_error(pdev, last_fn, last_ret);
332 failed:
333         kfree(stk);
334         info->ndev = 0;
335         pcmcia_disable_device(pdev);
336 out1:
337         kfree(info);
338         return ret;
339 }
340
341 /**
342  *      pcmcia_remove_one       -       unplug an pcmcia interface
343  *      @pdev: pcmcia device
344  *
345  *      A PCMCIA ATA device has been unplugged. Perform the needed
346  *      cleanup. Also called on module unload for any active devices.
347  */
348
349 static void pcmcia_remove_one(struct pcmcia_device *pdev)
350 {
351         struct ata_pcmcia_info *info = pdev->priv;
352         struct device *dev = &pdev->dev;
353
354         if (info != NULL) {
355                 /* If we have attached the device to the ATA layer, detach it */
356                 if (info->ndev) {
357                         struct ata_host *host = dev_get_drvdata(dev);
358                         ata_host_detach(host);
359                 }
360                 info->ndev = 0;
361                 pdev->priv = NULL;
362         }
363         pcmcia_disable_device(pdev);
364         kfree(info);
365 }
366
367 static struct pcmcia_device_id pcmcia_devices[] = {
368         PCMCIA_DEVICE_FUNC_ID(4),
369         PCMCIA_DEVICE_MANF_CARD(0x0000, 0x0000),        /* Corsair */
370         PCMCIA_DEVICE_MANF_CARD(0x0007, 0x0000),        /* Hitachi */
371         PCMCIA_DEVICE_MANF_CARD(0x000a, 0x0000),        /* I-O Data CFA */
372         PCMCIA_DEVICE_MANF_CARD(0x001c, 0x0001),        /* Mitsubishi CFA */
373         PCMCIA_DEVICE_MANF_CARD(0x0032, 0x0704),
374         PCMCIA_DEVICE_MANF_CARD(0x0032, 0x2904),
375         PCMCIA_DEVICE_MANF_CARD(0x0045, 0x0401),        /* SanDisk CFA */
376         PCMCIA_DEVICE_MANF_CARD(0x0097, 0x1620),        /* TI emulated */
377         PCMCIA_DEVICE_MANF_CARD(0x0098, 0x0000),        /* Toshiba */
378         PCMCIA_DEVICE_MANF_CARD(0x00a4, 0x002d),
379         PCMCIA_DEVICE_MANF_CARD(0x00ce, 0x0000),        /* Samsung */
380         PCMCIA_DEVICE_MANF_CARD(0x0319, 0x0000),        /* Hitachi */
381         PCMCIA_DEVICE_MANF_CARD(0x2080, 0x0001),
382         PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0100),        /* Viking CFA */
383         PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0200),        /* Lexar, Viking CFA */
384         PCMCIA_DEVICE_PROD_ID123("Caravelle", "PSC-IDE ", "PSC000", 0x8c36137c, 0xd0693ab8, 0x2768a9f0),
385         PCMCIA_DEVICE_PROD_ID123("CDROM", "IDE", "MCD-601p", 0x1b9179ca, 0xede88951, 0x0d902f74),
386         PCMCIA_DEVICE_PROD_ID123("PCMCIA", "IDE CARD", "F1", 0x281f1c5d, 0x1907960c, 0xf7fde8b9),
387         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "CD-ROM", 0x78f308dc, 0x66536591),
388         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "PnPIDE", 0x78f308dc, 0x0c694728),
389         PCMCIA_DEVICE_PROD_ID12("CNF CD-M", "CD-ROM", 0x7d93b852, 0x66536591),
390         PCMCIA_DEVICE_PROD_ID12("Creative Technology Ltd.", "PCMCIA CD-ROM Interface Card", 0xff8c8a45, 0xfe8020c4),
391         PCMCIA_DEVICE_PROD_ID12("Digital Equipment Corporation.", "Digital Mobile Media CD-ROM", 0x17692a66, 0xef1dcbde),
392         PCMCIA_DEVICE_PROD_ID12("EXP", "CD+GAME", 0x6f58c983, 0x63c13aaf),
393         PCMCIA_DEVICE_PROD_ID12("EXP   ", "CD-ROM", 0x0a5c52fd, 0x66536591),
394         PCMCIA_DEVICE_PROD_ID12("EXP   ", "PnPIDE", 0x0a5c52fd, 0x0c694728),
395         PCMCIA_DEVICE_PROD_ID12("FREECOM", "PCCARD-IDE", 0x5714cbf7, 0x48e0ab8e),
396         PCMCIA_DEVICE_PROD_ID12("Hyperstone", "Model1", 0x3d5b9ef5, 0xca6ab420),
397         PCMCIA_DEVICE_PROD_ID12("HITACHI", "FLASH", 0xf4f43949, 0x9eb86aae),
398         PCMCIA_DEVICE_PROD_ID12("HITACHI", "microdrive", 0xf4f43949, 0xa6d76178),
399         PCMCIA_DEVICE_PROD_ID12("IBM", "microdrive", 0xb569a6e5, 0xa6d76178),
400         PCMCIA_DEVICE_PROD_ID12("IBM", "IBM17JSSFP20", 0xb569a6e5, 0xf2508753),
401         PCMCIA_DEVICE_PROD_ID12("KINGSTON", "CF8GB", 0x2e6d1829, 0xacbe682e),
402         PCMCIA_DEVICE_PROD_ID12("IO DATA", "CBIDE2      ", 0x547e66dc, 0x8671043b),
403         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDE", 0x547e66dc, 0x5c5ab149),
404         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDEII", 0x547e66dc, 0xb3662674),
405         PCMCIA_DEVICE_PROD_ID12("LOOKMEET", "CBIDE2      ", 0xe37be2b5, 0x8671043b),
406         PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF300", 0x7ed2ad87, 0x7e9e78ee),
407         PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF500", 0x7ed2ad87, 0x7a13045c),
408         PCMCIA_DEVICE_PROD_ID2("NinjaATA-", 0xebe0bd79),
409         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "CD-ROM", 0x281f1c5d, 0x66536591),
410         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "PnPIDE", 0x281f1c5d, 0x0c694728),
411         PCMCIA_DEVICE_PROD_ID12("SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", 0x4a3f0ba0, 0x322560e1),
412         PCMCIA_DEVICE_PROD_ID12("SEAGATE", "ST1", 0x87c1b330, 0xe1f30883),
413         PCMCIA_DEVICE_PROD_ID12("SAMSUNG", "04/05/06", 0x43d74cb4, 0x6a22777d),
414         PCMCIA_DEVICE_PROD_ID12("SMI VENDOR", "SMI PRODUCT", 0x30896c92, 0x703cc5f6),
415         PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "MK2001MPL", 0xb4585a1a, 0x3489e003),
416         PCMCIA_DEVICE_PROD_ID1("TRANSCEND    512M   ", 0xd0909443),
417         PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF45", 0x709b1bf1, 0xf68b6f32),
418         PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF80", 0x709b1bf1, 0x2a54d4b1),
419         PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS2GCF120", 0x709b1bf1, 0x969aa4f2),
420         PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS4GCF120", 0x709b1bf1, 0xf54a91c8),
421         PCMCIA_DEVICE_PROD_ID12("WIT", "IDE16", 0x244e5994, 0x3e232852),
422         PCMCIA_DEVICE_PROD_ID12("WEIDA", "TWTTI", 0xcc7cf69c, 0x212bb918),
423         PCMCIA_DEVICE_PROD_ID1("STI Flash", 0xe4a13209),
424         PCMCIA_DEVICE_PROD_ID12("STI", "Flash 5.0", 0xbf2df18d, 0x8cb57a0e),
425         PCMCIA_MFC_DEVICE_PROD_ID12(1, "SanDisk", "ConnectPlus", 0x7a954bd9, 0x74be00c6),
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);