3b5b55f85e23d35b087f84ce49aa9fefe8015528
[linux-3.10.git] / drivers / ide / legacy / ide-cs.c
1 /*======================================================================
2
3     A driver for PCMCIA IDE/ATA disk cards
4
5     ide-cs.c 1.3 2002/10/26 05:45:31
6
7     The contents of this file are subject to the Mozilla Public
8     License Version 1.1 (the "License"); you may not use this file
9     except in compliance with the License. You may obtain a copy of
10     the License at http://www.mozilla.org/MPL/
11
12     Software distributed under the License is distributed on an "AS
13     IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
14     implied. See the License for the specific language governing
15     rights and limitations under the License.
16
17     The initial developer of the original code is David A. Hinds
18     <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
19     are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
20
21     Alternatively, the contents of this file may be used under the
22     terms of the GNU General Public License version 2 (the "GPL"), in
23     which case the provisions of the GPL are applicable instead of the
24     above.  If you wish to allow the use of your version of this file
25     only under the terms of the GPL and not to allow others to use
26     your version of this file under the MPL, indicate your decision
27     by deleting the provisions above and replace them with the notice
28     and other provisions required by the GPL.  If you do not delete
29     the provisions above, a recipient may use your version of this
30     file under either the MPL or the GPL.
31     
32 ======================================================================*/
33
34 #include <linux/module.h>
35 #include <linux/kernel.h>
36 #include <linux/init.h>
37 #include <linux/sched.h>
38 #include <linux/ptrace.h>
39 #include <linux/slab.h>
40 #include <linux/string.h>
41 #include <linux/timer.h>
42 #include <linux/ioport.h>
43 #include <linux/ide.h>
44 #include <linux/hdreg.h>
45 #include <linux/major.h>
46 #include <linux/delay.h>
47 #include <asm/io.h>
48 #include <asm/system.h>
49
50 #include <pcmcia/cs_types.h>
51 #include <pcmcia/cs.h>
52 #include <pcmcia/cistpl.h>
53 #include <pcmcia/ds.h>
54 #include <pcmcia/cisreg.h>
55 #include <pcmcia/ciscode.h>
56
57 /*====================================================================*/
58
59 /* Module parameters */
60
61 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
62 MODULE_DESCRIPTION("PCMCIA ATA/IDE card driver");
63 MODULE_LICENSE("Dual MPL/GPL");
64
65 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0)
66
67 #ifdef PCMCIA_DEBUG
68 INT_MODULE_PARM(pc_debug, PCMCIA_DEBUG);
69 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
70 static char *version =
71 "ide-cs.c 1.3 2002/10/26 05:45:31 (David Hinds)";
72 #else
73 #define DEBUG(n, args...)
74 #endif
75
76 /*====================================================================*/
77
78 static const char ide_major[] = {
79     IDE0_MAJOR, IDE1_MAJOR, IDE2_MAJOR, IDE3_MAJOR,
80     IDE4_MAJOR, IDE5_MAJOR
81 };
82
83 typedef struct ide_info_t {
84     dev_link_t  link;
85     int         ndev;
86     dev_node_t  node;
87     int         hd;
88 } ide_info_t;
89
90 static void ide_release(dev_link_t *);
91 static void ide_config(dev_link_t *);
92
93 static void ide_detach(struct pcmcia_device *p_dev);
94
95
96
97
98 /*======================================================================
99
100     ide_attach() creates an "instance" of the driver, allocating
101     local data structures for one device.  The device is registered
102     with Card Services.
103
104 ======================================================================*/
105
106 static int ide_attach(struct pcmcia_device *p_dev)
107 {
108     ide_info_t *info;
109     dev_link_t *link;
110
111     DEBUG(0, "ide_attach()\n");
112
113     /* Create new ide device */
114     info = kzalloc(sizeof(*info), GFP_KERNEL);
115     if (!info)
116         return -ENOMEM;
117     link = &info->link; link->priv = info;
118
119     link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
120     link->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
121     link->io.IOAddrLines = 3;
122     link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
123     link->irq.IRQInfo1 = IRQ_LEVEL_ID;
124     link->conf.Attributes = CONF_ENABLE_IRQ;
125     link->conf.IntType = INT_MEMORY_AND_IO;
126
127     link->handle = p_dev;
128     p_dev->instance = link;
129
130     link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
131     ide_config(link);
132
133     return 0;
134 } /* ide_attach */
135
136 /*======================================================================
137
138     This deletes a driver "instance".  The device is de-registered
139     with Card Services.  If it has been released, all local data
140     structures are freed.  Otherwise, the structures will be freed
141     when the device is released.
142
143 ======================================================================*/
144
145 static void ide_detach(struct pcmcia_device *p_dev)
146 {
147     dev_link_t *link = dev_to_instance(p_dev);
148
149     DEBUG(0, "ide_detach(0x%p)\n", link);
150
151     if (link->state & DEV_CONFIG)
152         ide_release(link);
153
154     kfree(link->priv);
155 } /* ide_detach */
156
157 static int idecs_register(unsigned long io, unsigned long ctl, unsigned long irq, struct pcmcia_device *handle)
158 {
159     hw_regs_t hw;
160     memset(&hw, 0, sizeof(hw));
161     ide_init_hwif_ports(&hw, io, ctl, NULL);
162     hw.irq = irq;
163     hw.chipset = ide_pci;
164     hw.dev = &handle->dev;
165     return ide_register_hw_with_fixup(&hw, NULL, ide_undecoded_slave);
166 }
167
168 /*======================================================================
169
170     ide_config() is scheduled to run after a CARD_INSERTION event
171     is received, to configure the PCMCIA socket, and to make the
172     ide device available to the system.
173
174 ======================================================================*/
175
176 #define CS_CHECK(fn, ret) \
177 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
178
179 static void ide_config(dev_link_t *link)
180 {
181     client_handle_t handle = link->handle;
182     ide_info_t *info = link->priv;
183     tuple_t tuple;
184     struct {
185         u_short         buf[128];
186         cisparse_t      parse;
187         config_info_t   conf;
188         cistpl_cftable_entry_t dflt;
189     } *stk = NULL;
190     cistpl_cftable_entry_t *cfg;
191     int i, pass, last_ret = 0, last_fn = 0, hd, is_kme = 0;
192     unsigned long io_base, ctl_base;
193
194     DEBUG(0, "ide_config(0x%p)\n", link);
195
196     stk = kzalloc(sizeof(*stk), GFP_KERNEL);
197     if (!stk) goto err_mem;
198     cfg = &stk->parse.cftable_entry;
199
200     tuple.TupleData = (cisdata_t *)&stk->buf;
201     tuple.TupleOffset = 0;
202     tuple.TupleDataMax = 255;
203     tuple.Attributes = 0;
204     tuple.DesiredTuple = CISTPL_CONFIG;
205     CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
206     CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
207     CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &stk->parse));
208     link->conf.ConfigBase = stk->parse.config.base;
209     link->conf.Present = stk->parse.config.rmask[0];
210
211     tuple.DesiredTuple = CISTPL_MANFID;
212     if (!pcmcia_get_first_tuple(handle, &tuple) &&
213         !pcmcia_get_tuple_data(handle, &tuple) &&
214         !pcmcia_parse_tuple(handle, &tuple, &stk->parse))
215         is_kme = ((stk->parse.manfid.manf == MANFID_KME) &&
216                   ((stk->parse.manfid.card == PRODID_KME_KXLC005_A) ||
217                    (stk->parse.manfid.card == PRODID_KME_KXLC005_B)));
218
219     /* Configure card */
220     link->state |= DEV_CONFIG;
221
222     /* Not sure if this is right... look up the current Vcc */
223     CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(handle, &stk->conf));
224
225     pass = io_base = ctl_base = 0;
226     tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
227     tuple.Attributes = 0;
228     CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
229     while (1) {
230         if (pcmcia_get_tuple_data(handle, &tuple) != 0) goto next_entry;
231         if (pcmcia_parse_tuple(handle, &tuple, &stk->parse) != 0) goto next_entry;
232
233         /* Check for matching Vcc, unless we're desperate */
234         if (!pass) {
235             if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
236                 if (stk->conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000)
237                     goto next_entry;
238             } else if (stk->dflt.vcc.present & (1 << CISTPL_POWER_VNOM)) {
239                 if (stk->conf.Vcc != stk->dflt.vcc.param[CISTPL_POWER_VNOM] / 10000)
240                     goto next_entry;
241             }
242         }
243
244         if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
245             link->conf.Vpp =
246                 cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
247         else if (stk->dflt.vpp1.present & (1 << CISTPL_POWER_VNOM))
248             link->conf.Vpp =
249                 stk->dflt.vpp1.param[CISTPL_POWER_VNOM] / 10000;
250
251         if ((cfg->io.nwin > 0) || (stk->dflt.io.nwin > 0)) {
252             cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &stk->dflt.io;
253             link->conf.ConfigIndex = cfg->index;
254             link->io.BasePort1 = io->win[0].base;
255             link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
256             if (!(io->flags & CISTPL_IO_16BIT))
257                 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
258             if (io->nwin == 2) {
259                 link->io.NumPorts1 = 8;
260                 link->io.BasePort2 = io->win[1].base;
261                 link->io.NumPorts2 = (is_kme) ? 2 : 1;
262                 if (pcmcia_request_io(link->handle, &link->io) != 0)
263                         goto next_entry;
264                 io_base = link->io.BasePort1;
265                 ctl_base = link->io.BasePort2;
266             } else if ((io->nwin == 1) && (io->win[0].len >= 16)) {
267                 link->io.NumPorts1 = io->win[0].len;
268                 link->io.NumPorts2 = 0;
269                 if (pcmcia_request_io(link->handle, &link->io) != 0)
270                         goto next_entry;
271                 io_base = link->io.BasePort1;
272                 ctl_base = link->io.BasePort1 + 0x0e;
273             } else goto next_entry;
274             /* If we've got this far, we're done */
275             break;
276         }
277
278     next_entry:
279         if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
280             memcpy(&stk->dflt, cfg, sizeof(stk->dflt));
281         if (pass) {
282             CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(handle, &tuple));
283         } else if (pcmcia_get_next_tuple(handle, &tuple) != 0) {
284             CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
285             memset(&stk->dflt, 0, sizeof(stk->dflt));
286             pass++;
287         }
288     }
289
290     CS_CHECK(RequestIRQ, pcmcia_request_irq(handle, &link->irq));
291     CS_CHECK(RequestConfiguration, pcmcia_request_configuration(handle, &link->conf));
292
293     /* disable drive interrupts during IDE probe */
294     outb(0x02, ctl_base);
295
296     /* special setup for KXLC005 card */
297     if (is_kme)
298         outb(0x81, ctl_base+1);
299
300     /* retry registration in case device is still spinning up */
301     for (hd = -1, i = 0; i < 10; i++) {
302         hd = idecs_register(io_base, ctl_base, link->irq.AssignedIRQ, handle);
303         if (hd >= 0) break;
304         if (link->io.NumPorts1 == 0x20) {
305             outb(0x02, ctl_base + 0x10);
306             hd = idecs_register(io_base + 0x10, ctl_base + 0x10,
307                                 link->irq.AssignedIRQ, handle);
308             if (hd >= 0) {
309                 io_base += 0x10;
310                 ctl_base += 0x10;
311                 break;
312             }
313         }
314         msleep(100);
315     }
316
317     if (hd < 0) {
318         printk(KERN_NOTICE "ide-cs: ide_register() at 0x%3lx & 0x%3lx"
319                ", irq %u failed\n", io_base, ctl_base,
320                link->irq.AssignedIRQ);
321         goto failed;
322     }
323
324     info->ndev = 1;
325     sprintf(info->node.dev_name, "hd%c", 'a' + (hd * 2));
326     info->node.major = ide_major[hd];
327     info->node.minor = 0;
328     info->hd = hd;
329     link->dev = &info->node;
330     printk(KERN_INFO "ide-cs: %s: Vpp = %d.%d\n",
331            info->node.dev_name, link->conf.Vpp / 10, link->conf.Vpp % 10);
332
333     link->state &= ~DEV_CONFIG_PENDING;
334     kfree(stk);
335     return;
336
337 err_mem:
338     printk(KERN_NOTICE "ide-cs: ide_config failed memory allocation\n");
339     goto failed;
340
341 cs_failed:
342     cs_error(link->handle, last_fn, last_ret);
343 failed:
344     kfree(stk);
345     ide_release(link);
346     link->state &= ~DEV_CONFIG_PENDING;
347 } /* ide_config */
348
349 /*======================================================================
350
351     After a card is removed, ide_release() will unregister the net
352     device, and release the PCMCIA configuration.  If the device is
353     still open, this will be postponed until it is closed.
354     
355 ======================================================================*/
356
357 void ide_release(dev_link_t *link)
358 {
359     ide_info_t *info = link->priv;
360     
361     DEBUG(0, "ide_release(0x%p)\n", link);
362
363     if (info->ndev) {
364         /* FIXME: if this fails we need to queue the cleanup somehow
365            -- need to investigate the required PCMCIA magic */
366         ide_unregister(info->hd);
367     }
368     info->ndev = 0;
369
370     pcmcia_disable_device(link->handle);
371 } /* ide_release */
372
373
374 /*======================================================================
375
376     The card status event handler.  Mostly, this schedules other
377     stuff to run after an event is received.  A CARD_REMOVAL event
378     also sets some flags to discourage the ide drivers from
379     talking to the ports.
380     
381 ======================================================================*/
382
383 static struct pcmcia_device_id ide_ids[] = {
384         PCMCIA_DEVICE_FUNC_ID(4),
385         PCMCIA_DEVICE_MANF_CARD(0x0007, 0x0000),        /* Hitachi */
386         PCMCIA_DEVICE_MANF_CARD(0x0032, 0x0704),
387         PCMCIA_DEVICE_MANF_CARD(0x0045, 0x0401),
388         PCMCIA_DEVICE_MANF_CARD(0x0098, 0x0000),        /* Toshiba */
389         PCMCIA_DEVICE_MANF_CARD(0x00a4, 0x002d),
390         PCMCIA_DEVICE_MANF_CARD(0x00ce, 0x0000),        /* Samsung */
391         PCMCIA_DEVICE_MANF_CARD(0x0319, 0x0000),        /* Hitachi */
392         PCMCIA_DEVICE_MANF_CARD(0x2080, 0x0001),
393         PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0200),        /* Lexar */
394         PCMCIA_DEVICE_PROD_ID123("Caravelle", "PSC-IDE ", "PSC000", 0x8c36137c, 0xd0693ab8, 0x2768a9f0),
395         PCMCIA_DEVICE_PROD_ID123("CDROM", "IDE", "MCD-601p", 0x1b9179ca, 0xede88951, 0x0d902f74),
396         PCMCIA_DEVICE_PROD_ID123("PCMCIA", "IDE CARD", "F1", 0x281f1c5d, 0x1907960c, 0xf7fde8b9),
397         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "CD-ROM", 0x78f308dc, 0x66536591),
398         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "PnPIDE", 0x78f308dc, 0x0c694728),
399         PCMCIA_DEVICE_PROD_ID12("CNF CD-M", "CD-ROM", 0x7d93b852, 0x66536591),
400         PCMCIA_DEVICE_PROD_ID12("Creative Technology Ltd.", "PCMCIA CD-ROM Interface Card", 0xff8c8a45, 0xfe8020c4),
401         PCMCIA_DEVICE_PROD_ID12("Digital Equipment Corporation.", "Digital Mobile Media CD-ROM", 0x17692a66, 0xef1dcbde),
402         PCMCIA_DEVICE_PROD_ID12("EXP", "CD+GAME", 0x6f58c983, 0x63c13aaf),
403         PCMCIA_DEVICE_PROD_ID12("EXP   ", "CD-ROM", 0x0a5c52fd, 0x66536591),
404         PCMCIA_DEVICE_PROD_ID12("EXP   ", "PnPIDE", 0x0a5c52fd, 0x0c694728),
405         PCMCIA_DEVICE_PROD_ID12("FREECOM", "PCCARD-IDE", 0x5714cbf7, 0x48e0ab8e),
406         PCMCIA_DEVICE_PROD_ID12("HITACHI", "FLASH", 0xf4f43949, 0x9eb86aae),
407         PCMCIA_DEVICE_PROD_ID12("HITACHI", "microdrive", 0xf4f43949, 0xa6d76178),
408         PCMCIA_DEVICE_PROD_ID12("IBM", "IBM17JSSFP20", 0xb569a6e5, 0xf2508753),
409         PCMCIA_DEVICE_PROD_ID12("IO DATA", "CBIDE2      ", 0x547e66dc, 0x8671043b),
410         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDE", 0x547e66dc, 0x5c5ab149),
411         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDEII", 0x547e66dc, 0xb3662674),
412         PCMCIA_DEVICE_PROD_ID12("LOOKMEET", "CBIDE2      ", 0xe37be2b5, 0x8671043b),
413         PCMCIA_DEVICE_PROD_ID2("NinjaATA-", 0xebe0bd79),
414         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "CD-ROM", 0x281f1c5d, 0x66536591),
415         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "PnPIDE", 0x281f1c5d, 0x0c694728),
416         PCMCIA_DEVICE_PROD_ID12("SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", 0x4a3f0ba0, 0x322560e1),
417         PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "MK2001MPL", 0xb4585a1a, 0x3489e003),
418         PCMCIA_DEVICE_PROD_ID1("TRANSCEND    512M   ", 0xd0909443),
419         PCMCIA_DEVICE_PROD_ID12("WIT", "IDE16", 0x244e5994, 0x3e232852),
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_NULL,
424 };
425 MODULE_DEVICE_TABLE(pcmcia, ide_ids);
426
427 static struct pcmcia_driver ide_cs_driver = {
428         .owner          = THIS_MODULE,
429         .drv            = {
430                 .name   = "ide-cs",
431         },
432         .probe          = ide_attach,
433         .remove         = ide_detach,
434         .id_table       = ide_ids,
435 };
436
437 static int __init init_ide_cs(void)
438 {
439         return pcmcia_register_driver(&ide_cs_driver);
440 }
441
442 static void __exit exit_ide_cs(void)
443 {
444         pcmcia_unregister_driver(&ide_cs_driver);
445 }
446
447 late_initcall(init_ide_cs);
448 module_exit(exit_ide_cs);