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