5a9b24950f9935cf1f1fa6e2c660037cab49bf8f
[linux-3.10.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.2.11"
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 static struct scsi_host_template pcmcia_sht = {
58         .module                 = THIS_MODULE,
59         .name                   = DRV_NAME,
60         .ioctl                  = ata_scsi_ioctl,
61         .queuecommand           = ata_scsi_queuecmd,
62         .can_queue              = ATA_DEF_QUEUE,
63         .this_id                = ATA_SHT_THIS_ID,
64         .sg_tablesize           = LIBATA_MAX_PRD,
65         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
66         .emulated               = ATA_SHT_EMULATED,
67         .use_clustering         = ATA_SHT_USE_CLUSTERING,
68         .proc_name              = DRV_NAME,
69         .dma_boundary           = ATA_DMA_BOUNDARY,
70         .slave_configure        = ata_scsi_slave_config,
71         .slave_destroy          = ata_scsi_slave_destroy,
72         .bios_param             = ata_std_bios_param,
73 };
74
75 static struct ata_port_operations pcmcia_port_ops = {
76         .port_disable   = ata_port_disable,
77         .tf_load        = ata_tf_load,
78         .tf_read        = ata_tf_read,
79         .check_status   = ata_check_status,
80         .exec_command   = ata_exec_command,
81         .dev_select     = ata_std_dev_select,
82
83         .freeze         = ata_bmdma_freeze,
84         .thaw           = ata_bmdma_thaw,
85         .error_handler  = ata_bmdma_error_handler,
86         .post_internal_cmd = ata_bmdma_post_internal_cmd,
87
88         .qc_prep        = ata_qc_prep,
89         .qc_issue       = ata_qc_issue_prot,
90
91         .data_xfer      = ata_pio_data_xfer_noirq,
92
93         .irq_handler    = ata_interrupt,
94         .irq_clear      = ata_bmdma_irq_clear,
95
96         .port_start     = ata_port_start,
97 };
98
99 #define CS_CHECK(fn, ret) \
100 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
101
102 /**
103  *      pcmcia_init_one         -       attach a PCMCIA interface
104  *      @pdev: pcmcia device
105  *
106  *      Register a PCMCIA IDE interface. Such interfaces are PIO 0 and
107  *      shared IRQ.
108  */
109
110 static int pcmcia_init_one(struct pcmcia_device *pdev)
111 {
112         struct ata_probe_ent ae;
113         struct ata_pcmcia_info *info;
114         tuple_t tuple;
115         struct {
116                 unsigned short buf[128];
117                 cisparse_t parse;
118                 config_info_t conf;
119                 cistpl_cftable_entry_t dflt;
120         } *stk = NULL;
121         cistpl_cftable_entry_t *cfg;
122         int pass, last_ret = 0, last_fn = 0, is_kme = 0, ret = -ENOMEM;
123         unsigned long io_base, ctl_base;
124
125         info = kzalloc(sizeof(*info), GFP_KERNEL);
126         if (info == NULL)
127                 return -ENOMEM;
128
129         /* Glue stuff together. FIXME: We may be able to get rid of info with care */
130         info->pdev = pdev;
131         pdev->priv = info;
132
133         /* Set up attributes in order to probe card and get resources */
134         pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
135         pdev->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
136         pdev->io.IOAddrLines = 3;
137         pdev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
138         pdev->irq.IRQInfo1 = IRQ_LEVEL_ID;
139         pdev->conf.Attributes = CONF_ENABLE_IRQ;
140         pdev->conf.IntType = INT_MEMORY_AND_IO;
141
142         /* Allocate resoure probing structures */
143
144         stk = kzalloc(sizeof(*stk), GFP_KERNEL);
145         if (!stk)
146                 goto out1;
147
148         cfg = &stk->parse.cftable_entry;
149
150         /* Tuples we are walking */
151         tuple.TupleData = (cisdata_t *)&stk->buf;
152         tuple.TupleOffset = 0;
153         tuple.TupleDataMax = 255;
154         tuple.Attributes = 0;
155
156         /* See if we have a manufacturer identifier. Use it to set is_kme for
157            vendor quirks */
158         is_kme = ((pdev->manf_id == MANFID_KME) &&
159                   ((pdev->card_id == PRODID_KME_KXLC005_A) ||
160                    (pdev->card_id == PRODID_KME_KXLC005_B)));
161
162         /* Not sure if this is right... look up the current Vcc */
163         CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(pdev, &stk->conf));
164 /*      link->conf.Vcc = stk->conf.Vcc; */
165
166         pass = io_base = ctl_base = 0;
167         tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
168         tuple.Attributes = 0;
169         CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(pdev, &tuple));
170
171         /* Now munch the resources looking for a suitable set */
172         while (1) {
173                 if (pcmcia_get_tuple_data(pdev, &tuple) != 0)
174                         goto next_entry;
175                 if (pcmcia_parse_tuple(pdev, &tuple, &stk->parse) != 0)
176                         goto next_entry;
177                 /* Check for matching Vcc, unless we're desperate */
178                 if (!pass) {
179                         if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
180                                 if (stk->conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000)
181                                         goto next_entry;
182                         } else if (stk->dflt.vcc.present & (1 << CISTPL_POWER_VNOM)) {
183                                 if (stk->conf.Vcc != stk->dflt.vcc.param[CISTPL_POWER_VNOM] / 10000)
184                                         goto next_entry;
185                         }
186                 }
187
188                 if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
189                         pdev->conf.Vpp = cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
190                 else if (stk->dflt.vpp1.present & (1 << CISTPL_POWER_VNOM))
191                         pdev->conf.Vpp = stk->dflt.vpp1.param[CISTPL_POWER_VNOM] / 10000;
192
193                 if ((cfg->io.nwin > 0) || (stk->dflt.io.nwin > 0)) {
194                         cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &stk->dflt.io;
195                         pdev->conf.ConfigIndex = cfg->index;
196                         pdev->io.BasePort1 = io->win[0].base;
197                         pdev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
198                         if (!(io->flags & CISTPL_IO_16BIT))
199                                 pdev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
200                         if (io->nwin == 2) {
201                                 pdev->io.NumPorts1 = 8;
202                                 pdev->io.BasePort2 = io->win[1].base;
203                                 pdev->io.NumPorts2 = (is_kme) ? 2 : 1;
204                                 if (pcmcia_request_io(pdev, &pdev->io) != 0)
205                                         goto next_entry;
206                                 io_base = pdev->io.BasePort1;
207                                 ctl_base = pdev->io.BasePort2;
208                         } else if ((io->nwin == 1) && (io->win[0].len >= 16)) {
209                                 pdev->io.NumPorts1 = io->win[0].len;
210                                 pdev->io.NumPorts2 = 0;
211                                 if (pcmcia_request_io(pdev, &pdev->io) != 0)
212                                         goto next_entry;
213                                 io_base = pdev->io.BasePort1;
214                                 ctl_base = pdev->io.BasePort1 + 0x0e;
215                         } else goto next_entry;
216                         /* If we've got this far, we're done */
217                         break;
218                 }
219 next_entry:
220                 if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
221                         memcpy(&stk->dflt, cfg, sizeof(stk->dflt));
222                 if (pass) {
223                         CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(pdev, &tuple));
224                 } else if (pcmcia_get_next_tuple(pdev, &tuple) != 0) {
225                         CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(pdev, &tuple));
226                         memset(&stk->dflt, 0, sizeof(stk->dflt));
227                         pass++;
228                 }
229         }
230
231         CS_CHECK(RequestIRQ, pcmcia_request_irq(pdev, &pdev->irq));
232         CS_CHECK(RequestConfiguration, pcmcia_request_configuration(pdev, &pdev->conf));
233
234         /* Success. Disable the IRQ nIEN line, do quirks */
235         outb(0x02, ctl_base);
236         if (is_kme)
237                 outb(0x81, ctl_base + 0x01);
238
239         /* FIXME: Could be more ports at base + 0x10 but we only deal with
240            one right now */
241         if (pdev->io.NumPorts1 >= 0x20)
242                 printk(KERN_WARNING DRV_NAME ": second channel not yet supported.\n");
243
244         /*
245          *      Having done the PCMCIA plumbing the ATA side is relatively
246          *      sane.
247          */
248
249         memset(&ae, 0, sizeof(struct ata_probe_ent));
250         INIT_LIST_HEAD(&ae.node);
251         ae.dev = &pdev->dev;
252         ae.port_ops = &pcmcia_port_ops;
253         ae.sht = &pcmcia_sht;
254         ae.n_ports = 1;
255         ae.pio_mask = 1;                /* ISA so PIO 0 cycles */
256         ae.irq = pdev->irq.AssignedIRQ;
257         ae.irq_flags = SA_SHIRQ;
258         ae.port_flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST;
259         ae.port[0].cmd_addr = io_base;
260         ae.port[0].altstatus_addr = ctl_base;
261         ae.port[0].ctl_addr = ctl_base;
262         ata_std_ports(&ae.port[0]);
263
264         if (ata_device_add(&ae) == 0)
265                 goto failed;
266
267         info->ndev = 1;
268         kfree(stk);
269         return 0;
270
271 cs_failed:
272         cs_error(pdev, last_fn, last_ret);
273 failed:
274         kfree(stk);
275         info->ndev = 0;
276         pcmcia_disable_device(pdev);
277 out1:
278         kfree(info);
279         return ret;
280 }
281
282 /**
283  *      pcmcia_remove_one       -       unplug an pcmcia interface
284  *      @pdev: pcmcia device
285  *
286  *      A PCMCIA ATA device has been unplugged. Perform the needed
287  *      cleanup. Also called on module unload for any active devices.
288  */
289
290 static void pcmcia_remove_one(struct pcmcia_device *pdev)
291 {
292         struct ata_pcmcia_info *info = pdev->priv;
293         struct device *dev = &pdev->dev;
294
295         if (info != NULL) {
296                 /* If we have attached the device to the ATA layer, detach it */
297                 if (info->ndev) {
298                         struct ata_host *host = dev_get_drvdata(dev);
299                         ata_host_detach(host);
300                         dev_set_drvdata(dev, NULL);
301                 }
302                 info->ndev = 0;
303                 pdev->priv = NULL;
304         }
305         pcmcia_disable_device(pdev);
306         kfree(info);
307 }
308
309 static struct pcmcia_device_id pcmcia_devices[] = {
310         PCMCIA_DEVICE_FUNC_ID(4),
311         PCMCIA_DEVICE_MANF_CARD(0x0007, 0x0000),        /* Hitachi */
312         PCMCIA_DEVICE_MANF_CARD(0x0032, 0x0704),
313         PCMCIA_DEVICE_MANF_CARD(0x0045, 0x0401),
314         PCMCIA_DEVICE_MANF_CARD(0x0098, 0x0000),        /* Toshiba */
315         PCMCIA_DEVICE_MANF_CARD(0x00a4, 0x002d),
316         PCMCIA_DEVICE_MANF_CARD(0x00ce, 0x0000),        /* Samsung */
317         PCMCIA_DEVICE_MANF_CARD(0x0319, 0x0000),        /* Hitachi */
318         PCMCIA_DEVICE_MANF_CARD(0x2080, 0x0001),
319         PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0200),        /* Lexar */
320         PCMCIA_DEVICE_PROD_ID123("Caravelle", "PSC-IDE ", "PSC000", 0x8c36137c, 0xd0693ab8, 0x2768a9f0),
321         PCMCIA_DEVICE_PROD_ID123("CDROM", "IDE", "MCD-601p", 0x1b9179ca, 0xede88951, 0x0d902f74),
322         PCMCIA_DEVICE_PROD_ID123("PCMCIA", "IDE CARD", "F1", 0x281f1c5d, 0x1907960c, 0xf7fde8b9),
323         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "CD-ROM", 0x78f308dc, 0x66536591),
324         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "PnPIDE", 0x78f308dc, 0x0c694728),
325         PCMCIA_DEVICE_PROD_ID12("CNF CD-M", "CD-ROM", 0x7d93b852, 0x66536591),
326         PCMCIA_DEVICE_PROD_ID12("Creative Technology Ltd.", "PCMCIA CD-ROM Interface Card", 0xff8c8a45, 0xfe8020c4),
327         PCMCIA_DEVICE_PROD_ID12("Digital Equipment Corporation.", "Digital Mobile Media CD-ROM", 0x17692a66, 0xef1dcbde),
328         PCMCIA_DEVICE_PROD_ID12("EXP", "CD+GAME", 0x6f58c983, 0x63c13aaf),
329         PCMCIA_DEVICE_PROD_ID12("EXP   ", "CD-ROM", 0x0a5c52fd, 0x66536591),
330         PCMCIA_DEVICE_PROD_ID12("EXP   ", "PnPIDE", 0x0a5c52fd, 0x0c694728),
331         PCMCIA_DEVICE_PROD_ID12("FREECOM", "PCCARD-IDE", 0x5714cbf7, 0x48e0ab8e),
332         PCMCIA_DEVICE_PROD_ID12("HITACHI", "FLASH", 0xf4f43949, 0x9eb86aae),
333         PCMCIA_DEVICE_PROD_ID12("HITACHI", "microdrive", 0xf4f43949, 0xa6d76178),
334         PCMCIA_DEVICE_PROD_ID12("IBM", "microdrive", 0xb569a6e5, 0xa6d76178),
335         PCMCIA_DEVICE_PROD_ID12("IBM", "IBM17JSSFP20", 0xb569a6e5, 0xf2508753),
336         PCMCIA_DEVICE_PROD_ID12("IO DATA", "CBIDE2      ", 0x547e66dc, 0x8671043b),
337         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDE", 0x547e66dc, 0x5c5ab149),
338         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDEII", 0x547e66dc, 0xb3662674),
339         PCMCIA_DEVICE_PROD_ID12("LOOKMEET", "CBIDE2      ", 0xe37be2b5, 0x8671043b),
340         PCMCIA_DEVICE_PROD_ID12("M-Systems", "CF500", 0x7ed2ad87, 0x7a13045c),
341         PCMCIA_DEVICE_PROD_ID2("NinjaATA-", 0xebe0bd79),
342         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "CD-ROM", 0x281f1c5d, 0x66536591),
343         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "PnPIDE", 0x281f1c5d, 0x0c694728),
344         PCMCIA_DEVICE_PROD_ID12("SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", 0x4a3f0ba0, 0x322560e1),
345         PCMCIA_DEVICE_PROD_ID12("SEAGATE", "ST1", 0x87c1b330, 0xe1f30883),
346         PCMCIA_DEVICE_PROD_ID12("SAMSUNG", "04/05/06", 0x43d74cb4, 0x6a22777d),
347         PCMCIA_DEVICE_PROD_ID12("SMI VENDOR", "SMI PRODUCT", 0x30896c92, 0x703cc5f6),
348         PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "MK2001MPL", 0xb4585a1a, 0x3489e003),
349         PCMCIA_DEVICE_PROD_ID1("TRANSCEND    512M   ", 0xd0909443),
350         PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS1GCF80", 0x709b1bf1, 0x2a54d4b1),
351         PCMCIA_DEVICE_PROD_ID12("TRANSCEND", "TS4GCF120", 0x709b1bf1, 0xf54a91c8),
352         PCMCIA_DEVICE_PROD_ID12("WIT", "IDE16", 0x244e5994, 0x3e232852),
353         PCMCIA_DEVICE_PROD_ID12("WEIDA", "TWTTI", 0xcc7cf69c, 0x212bb918),
354         PCMCIA_DEVICE_PROD_ID1("STI Flash", 0xe4a13209),
355         PCMCIA_DEVICE_PROD_ID12("STI", "Flash 5.0", 0xbf2df18d, 0x8cb57a0e),
356         PCMCIA_MFC_DEVICE_PROD_ID12(1, "SanDisk", "ConnectPlus", 0x7a954bd9, 0x74be00c6),
357         PCMCIA_DEVICE_NULL,
358 };
359
360 MODULE_DEVICE_TABLE(pcmcia, pcmcia_devices);
361
362 static struct pcmcia_driver pcmcia_driver = {
363         .owner          = THIS_MODULE,
364         .drv = {
365                 .name           = DRV_NAME,
366         },
367         .id_table       = pcmcia_devices,
368         .probe          = pcmcia_init_one,
369         .remove         = pcmcia_remove_one,
370 };
371
372 static int __init pcmcia_init(void)
373 {
374         return pcmcia_register_driver(&pcmcia_driver);
375 }
376
377 static void __exit pcmcia_exit(void)
378 {
379         pcmcia_unregister_driver(&pcmcia_driver);
380 }
381
382 MODULE_AUTHOR("Alan Cox");
383 MODULE_DESCRIPTION("low-level driver for PCMCIA ATA");
384 MODULE_LICENSE("GPL");
385 MODULE_VERSION(DRV_VERSION);
386
387 module_init(pcmcia_init);
388 module_exit(pcmcia_exit);