[PATCH] pcmcia: embed dev_link_t into struct pcmcia_device
[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         struct pcmcia_device    *p_dev;
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 = dev_to_instance(p_dev);
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
118     info->p_dev = p_dev;
119     link->priv = info;
120
121     link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
122     link->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
123     link->io.IOAddrLines = 3;
124     link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
125     link->irq.IRQInfo1 = IRQ_LEVEL_ID;
126     link->conf.Attributes = CONF_ENABLE_IRQ;
127     link->conf.IntType = INT_MEMORY_AND_IO;
128
129     link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
130     ide_config(link);
131
132     return 0;
133 } /* ide_attach */
134
135 /*======================================================================
136
137     This deletes a driver "instance".  The device is de-registered
138     with Card Services.  If it has been released, all local data
139     structures are freed.  Otherwise, the structures will be freed
140     when the device is released.
141
142 ======================================================================*/
143
144 static void ide_detach(struct pcmcia_device *p_dev)
145 {
146     dev_link_t *link = dev_to_instance(p_dev);
147
148     DEBUG(0, "ide_detach(0x%p)\n", link);
149
150     if (link->state & DEV_CONFIG)
151         ide_release(link);
152
153     kfree(link->priv);
154 } /* ide_detach */
155
156 static int idecs_register(unsigned long io, unsigned long ctl, unsigned long irq, struct pcmcia_device *handle)
157 {
158     hw_regs_t hw;
159     memset(&hw, 0, sizeof(hw));
160     ide_init_hwif_ports(&hw, io, ctl, NULL);
161     hw.irq = irq;
162     hw.chipset = ide_pci;
163     hw.dev = &handle->dev;
164     return ide_register_hw_with_fixup(&hw, NULL, ide_undecoded_slave);
165 }
166
167 /*======================================================================
168
169     ide_config() is scheduled to run after a CARD_INSERTION event
170     is received, to configure the PCMCIA socket, and to make the
171     ide device available to the system.
172
173 ======================================================================*/
174
175 #define CS_CHECK(fn, ret) \
176 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
177
178 static void ide_config(dev_link_t *link)
179 {
180     client_handle_t handle = link->handle;
181     ide_info_t *info = link->priv;
182     tuple_t tuple;
183     struct {
184         u_short         buf[128];
185         cisparse_t      parse;
186         config_info_t   conf;
187         cistpl_cftable_entry_t dflt;
188     } *stk = NULL;
189     cistpl_cftable_entry_t *cfg;
190     int i, pass, last_ret = 0, last_fn = 0, hd, is_kme = 0;
191     unsigned long io_base, ctl_base;
192
193     DEBUG(0, "ide_config(0x%p)\n", link);
194
195     stk = kzalloc(sizeof(*stk), GFP_KERNEL);
196     if (!stk) goto err_mem;
197     cfg = &stk->parse.cftable_entry;
198
199     tuple.TupleData = (cisdata_t *)&stk->buf;
200     tuple.TupleOffset = 0;
201     tuple.TupleDataMax = 255;
202     tuple.Attributes = 0;
203     tuple.DesiredTuple = CISTPL_CONFIG;
204     CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
205     CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
206     CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &stk->parse));
207     link->conf.ConfigBase = stk->parse.config.base;
208     link->conf.Present = stk->parse.config.rmask[0];
209
210     tuple.DesiredTuple = CISTPL_MANFID;
211     if (!pcmcia_get_first_tuple(handle, &tuple) &&
212         !pcmcia_get_tuple_data(handle, &tuple) &&
213         !pcmcia_parse_tuple(handle, &tuple, &stk->parse))
214         is_kme = ((stk->parse.manfid.manf == MANFID_KME) &&
215                   ((stk->parse.manfid.card == PRODID_KME_KXLC005_A) ||
216                    (stk->parse.manfid.card == PRODID_KME_KXLC005_B)));
217
218     /* Configure card */
219     link->state |= DEV_CONFIG;
220
221     /* Not sure if this is right... look up the current Vcc */
222     CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(handle, &stk->conf));
223
224     pass = io_base = ctl_base = 0;
225     tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
226     tuple.Attributes = 0;
227     CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
228     while (1) {
229         if (pcmcia_get_tuple_data(handle, &tuple) != 0) goto next_entry;
230         if (pcmcia_parse_tuple(handle, &tuple, &stk->parse) != 0) goto next_entry;
231
232         /* Check for matching Vcc, unless we're desperate */
233         if (!pass) {
234             if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
235                 if (stk->conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000)
236                     goto next_entry;
237             } else if (stk->dflt.vcc.present & (1 << CISTPL_POWER_VNOM)) {
238                 if (stk->conf.Vcc != stk->dflt.vcc.param[CISTPL_POWER_VNOM] / 10000)
239                     goto next_entry;
240             }
241         }
242
243         if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
244             link->conf.Vpp =
245                 cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
246         else if (stk->dflt.vpp1.present & (1 << CISTPL_POWER_VNOM))
247             link->conf.Vpp =
248                 stk->dflt.vpp1.param[CISTPL_POWER_VNOM] / 10000;
249
250         if ((cfg->io.nwin > 0) || (stk->dflt.io.nwin > 0)) {
251             cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &stk->dflt.io;
252             link->conf.ConfigIndex = cfg->index;
253             link->io.BasePort1 = io->win[0].base;
254             link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
255             if (!(io->flags & CISTPL_IO_16BIT))
256                 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
257             if (io->nwin == 2) {
258                 link->io.NumPorts1 = 8;
259                 link->io.BasePort2 = io->win[1].base;
260                 link->io.NumPorts2 = (is_kme) ? 2 : 1;
261                 if (pcmcia_request_io(link->handle, &link->io) != 0)
262                         goto next_entry;
263                 io_base = link->io.BasePort1;
264                 ctl_base = link->io.BasePort2;
265             } else if ((io->nwin == 1) && (io->win[0].len >= 16)) {
266                 link->io.NumPorts1 = io->win[0].len;
267                 link->io.NumPorts2 = 0;
268                 if (pcmcia_request_io(link->handle, &link->io) != 0)
269                         goto next_entry;
270                 io_base = link->io.BasePort1;
271                 ctl_base = link->io.BasePort1 + 0x0e;
272             } else goto next_entry;
273             /* If we've got this far, we're done */
274             break;
275         }
276
277     next_entry:
278         if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
279             memcpy(&stk->dflt, cfg, sizeof(stk->dflt));
280         if (pass) {
281             CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(handle, &tuple));
282         } else if (pcmcia_get_next_tuple(handle, &tuple) != 0) {
283             CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
284             memset(&stk->dflt, 0, sizeof(stk->dflt));
285             pass++;
286         }
287     }
288
289     CS_CHECK(RequestIRQ, pcmcia_request_irq(handle, &link->irq));
290     CS_CHECK(RequestConfiguration, pcmcia_request_configuration(handle, &link->conf));
291
292     /* disable drive interrupts during IDE probe */
293     outb(0x02, ctl_base);
294
295     /* special setup for KXLC005 card */
296     if (is_kme)
297         outb(0x81, ctl_base+1);
298
299     /* retry registration in case device is still spinning up */
300     for (hd = -1, i = 0; i < 10; i++) {
301         hd = idecs_register(io_base, ctl_base, link->irq.AssignedIRQ, handle);
302         if (hd >= 0) break;
303         if (link->io.NumPorts1 == 0x20) {
304             outb(0x02, ctl_base + 0x10);
305             hd = idecs_register(io_base + 0x10, ctl_base + 0x10,
306                                 link->irq.AssignedIRQ, handle);
307             if (hd >= 0) {
308                 io_base += 0x10;
309                 ctl_base += 0x10;
310                 break;
311             }
312         }
313         msleep(100);
314     }
315
316     if (hd < 0) {
317         printk(KERN_NOTICE "ide-cs: ide_register() at 0x%3lx & 0x%3lx"
318                ", irq %u failed\n", io_base, ctl_base,
319                link->irq.AssignedIRQ);
320         goto failed;
321     }
322
323     info->ndev = 1;
324     sprintf(info->node.dev_name, "hd%c", 'a' + (hd * 2));
325     info->node.major = ide_major[hd];
326     info->node.minor = 0;
327     info->hd = hd;
328     link->dev_node = &info->node;
329     printk(KERN_INFO "ide-cs: %s: Vpp = %d.%d\n",
330            info->node.dev_name, link->conf.Vpp / 10, link->conf.Vpp % 10);
331
332     link->state &= ~DEV_CONFIG_PENDING;
333     kfree(stk);
334     return;
335
336 err_mem:
337     printk(KERN_NOTICE "ide-cs: ide_config failed memory allocation\n");
338     goto failed;
339
340 cs_failed:
341     cs_error(link->handle, last_fn, last_ret);
342 failed:
343     kfree(stk);
344     ide_release(link);
345     link->state &= ~DEV_CONFIG_PENDING;
346 } /* ide_config */
347
348 /*======================================================================
349
350     After a card is removed, ide_release() will unregister the net
351     device, and release the PCMCIA configuration.  If the device is
352     still open, this will be postponed until it is closed.
353     
354 ======================================================================*/
355
356 void ide_release(dev_link_t *link)
357 {
358     ide_info_t *info = link->priv;
359     
360     DEBUG(0, "ide_release(0x%p)\n", link);
361
362     if (info->ndev) {
363         /* FIXME: if this fails we need to queue the cleanup somehow
364            -- need to investigate the required PCMCIA magic */
365         ide_unregister(info->hd);
366     }
367     info->ndev = 0;
368
369     pcmcia_disable_device(link->handle);
370 } /* ide_release */
371
372
373 /*======================================================================
374
375     The card status event handler.  Mostly, this schedules other
376     stuff to run after an event is received.  A CARD_REMOVAL event
377     also sets some flags to discourage the ide drivers from
378     talking to the ports.
379     
380 ======================================================================*/
381
382 static struct pcmcia_device_id ide_ids[] = {
383         PCMCIA_DEVICE_FUNC_ID(4),
384         PCMCIA_DEVICE_MANF_CARD(0x0007, 0x0000),        /* Hitachi */
385         PCMCIA_DEVICE_MANF_CARD(0x0032, 0x0704),
386         PCMCIA_DEVICE_MANF_CARD(0x0045, 0x0401),
387         PCMCIA_DEVICE_MANF_CARD(0x0098, 0x0000),        /* Toshiba */
388         PCMCIA_DEVICE_MANF_CARD(0x00a4, 0x002d),
389         PCMCIA_DEVICE_MANF_CARD(0x00ce, 0x0000),        /* Samsung */
390         PCMCIA_DEVICE_MANF_CARD(0x0319, 0x0000),        /* Hitachi */
391         PCMCIA_DEVICE_MANF_CARD(0x2080, 0x0001),
392         PCMCIA_DEVICE_MANF_CARD(0x4e01, 0x0200),        /* Lexar */
393         PCMCIA_DEVICE_PROD_ID123("Caravelle", "PSC-IDE ", "PSC000", 0x8c36137c, 0xd0693ab8, 0x2768a9f0),
394         PCMCIA_DEVICE_PROD_ID123("CDROM", "IDE", "MCD-601p", 0x1b9179ca, 0xede88951, 0x0d902f74),
395         PCMCIA_DEVICE_PROD_ID123("PCMCIA", "IDE CARD", "F1", 0x281f1c5d, 0x1907960c, 0xf7fde8b9),
396         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "CD-ROM", 0x78f308dc, 0x66536591),
397         PCMCIA_DEVICE_PROD_ID12("ARGOSY", "PnPIDE", 0x78f308dc, 0x0c694728),
398         PCMCIA_DEVICE_PROD_ID12("CNF CD-M", "CD-ROM", 0x7d93b852, 0x66536591),
399         PCMCIA_DEVICE_PROD_ID12("Creative Technology Ltd.", "PCMCIA CD-ROM Interface Card", 0xff8c8a45, 0xfe8020c4),
400         PCMCIA_DEVICE_PROD_ID12("Digital Equipment Corporation.", "Digital Mobile Media CD-ROM", 0x17692a66, 0xef1dcbde),
401         PCMCIA_DEVICE_PROD_ID12("EXP", "CD+GAME", 0x6f58c983, 0x63c13aaf),
402         PCMCIA_DEVICE_PROD_ID12("EXP   ", "CD-ROM", 0x0a5c52fd, 0x66536591),
403         PCMCIA_DEVICE_PROD_ID12("EXP   ", "PnPIDE", 0x0a5c52fd, 0x0c694728),
404         PCMCIA_DEVICE_PROD_ID12("FREECOM", "PCCARD-IDE", 0x5714cbf7, 0x48e0ab8e),
405         PCMCIA_DEVICE_PROD_ID12("HITACHI", "FLASH", 0xf4f43949, 0x9eb86aae),
406         PCMCIA_DEVICE_PROD_ID12("HITACHI", "microdrive", 0xf4f43949, 0xa6d76178),
407         PCMCIA_DEVICE_PROD_ID12("IBM", "IBM17JSSFP20", 0xb569a6e5, 0xf2508753),
408         PCMCIA_DEVICE_PROD_ID12("IO DATA", "CBIDE2      ", 0x547e66dc, 0x8671043b),
409         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDE", 0x547e66dc, 0x5c5ab149),
410         PCMCIA_DEVICE_PROD_ID12("IO DATA", "PCIDEII", 0x547e66dc, 0xb3662674),
411         PCMCIA_DEVICE_PROD_ID12("LOOKMEET", "CBIDE2      ", 0xe37be2b5, 0x8671043b),
412         PCMCIA_DEVICE_PROD_ID2("NinjaATA-", 0xebe0bd79),
413         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "CD-ROM", 0x281f1c5d, 0x66536591),
414         PCMCIA_DEVICE_PROD_ID12("PCMCIA", "PnPIDE", 0x281f1c5d, 0x0c694728),
415         PCMCIA_DEVICE_PROD_ID12("SHUTTLE TECHNOLOGY LTD.", "PCCARD-IDE/ATAPI Adapter", 0x4a3f0ba0, 0x322560e1),
416         PCMCIA_DEVICE_PROD_ID12("TOSHIBA", "MK2001MPL", 0xb4585a1a, 0x3489e003),
417         PCMCIA_DEVICE_PROD_ID1("TRANSCEND    512M   ", 0xd0909443),
418         PCMCIA_DEVICE_PROD_ID12("WIT", "IDE16", 0x244e5994, 0x3e232852),
419         PCMCIA_DEVICE_PROD_ID1("STI Flash", 0xe4a13209),
420         PCMCIA_DEVICE_PROD_ID12("STI", "Flash 5.0", 0xbf2df18d, 0x8cb57a0e),
421         PCMCIA_MFC_DEVICE_PROD_ID12(1, "SanDisk", "ConnectPlus", 0x7a954bd9, 0x74be00c6),
422         PCMCIA_DEVICE_NULL,
423 };
424 MODULE_DEVICE_TABLE(pcmcia, ide_ids);
425
426 static struct pcmcia_driver ide_cs_driver = {
427         .owner          = THIS_MODULE,
428         .drv            = {
429                 .name   = "ide-cs",
430         },
431         .probe          = ide_attach,
432         .remove         = ide_detach,
433         .id_table       = ide_ids,
434 };
435
436 static int __init init_ide_cs(void)
437 {
438         return pcmcia_register_driver(&ide_cs_driver);
439 }
440
441 static void __exit exit_ide_cs(void)
442 {
443         pcmcia_unregister_driver(&ide_cs_driver);
444 }
445
446 late_initcall(init_ide_cs);
447 module_exit(exit_ide_cs);