1 /*======================================================================
3 A driver for PCMCIA IDE/ATA disk cards
5 ide-cs.c 1.3 2002/10/26 05:45:31
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/
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.
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.
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.
32 ======================================================================*/
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>
47 #include <asm/system.h>
49 #include <pcmcia/version.h>
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>
57 /*====================================================================*/
59 /* Module parameters */
61 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
62 MODULE_DESCRIPTION("PCMCIA ATA/IDE card driver");
63 MODULE_LICENSE("Dual MPL/GPL");
65 #define INT_MODULE_PARM(n, v) static int n = v; MODULE_PARM(n, "i")
67 /* Bit map of interrupts to choose from */
68 INT_MODULE_PARM(irq_mask, 0xdeb8);
69 static int irq_list[4] = { -1 };
70 MODULE_PARM(irq_list, "1-4i");
73 INT_MODULE_PARM(pc_debug, PCMCIA_DEBUG);
74 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
75 static char *version =
76 "ide-cs.c 1.3 2002/10/26 05:45:31 (David Hinds)";
78 #define DEBUG(n, args...)
81 /*====================================================================*/
83 static const char ide_major[] = {
84 IDE0_MAJOR, IDE1_MAJOR, IDE2_MAJOR, IDE3_MAJOR,
85 IDE4_MAJOR, IDE5_MAJOR
88 typedef struct ide_info_t {
95 static void ide_release(dev_link_t *);
96 static int ide_event(event_t event, int priority,
97 event_callback_args_t *args);
99 static dev_info_t dev_info = "ide-cs";
101 static dev_link_t *ide_attach(void);
102 static void ide_detach(dev_link_t *);
104 static dev_link_t *dev_list = NULL;
106 /*======================================================================
108 ide_attach() creates an "instance" of the driver, allocating
109 local data structures for one device. The device is registered
112 ======================================================================*/
114 static dev_link_t *ide_attach(void)
118 client_reg_t client_reg;
121 DEBUG(0, "ide_attach()\n");
123 /* Create new ide device */
124 info = kmalloc(sizeof(*info), GFP_KERNEL);
125 if (!info) return NULL;
126 memset(info, 0, sizeof(*info));
127 link = &info->link; link->priv = info;
129 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
130 link->io.Attributes2 = IO_DATA_PATH_WIDTH_8;
131 link->io.IOAddrLines = 3;
132 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
133 link->irq.IRQInfo1 = IRQ_INFO2_VALID|IRQ_LEVEL_ID;
134 if (irq_list[0] == -1)
135 link->irq.IRQInfo2 = irq_mask;
137 for (i = 0; i < 4; i++)
138 link->irq.IRQInfo2 |= 1 << irq_list[i];
139 link->conf.Attributes = CONF_ENABLE_IRQ;
141 link->conf.IntType = INT_MEMORY_AND_IO;
143 /* Register with Card Services */
144 link->next = dev_list;
146 client_reg.dev_info = &dev_info;
147 client_reg.Attributes = INFO_IO_CLIENT | INFO_CARD_SHARE;
148 client_reg.EventMask =
149 CS_EVENT_CARD_INSERTION | CS_EVENT_CARD_REMOVAL |
150 CS_EVENT_RESET_PHYSICAL | CS_EVENT_CARD_RESET |
151 CS_EVENT_PM_SUSPEND | CS_EVENT_PM_RESUME;
152 client_reg.event_handler = &ide_event;
153 client_reg.Version = 0x0210;
154 client_reg.event_callback_args.client_data = link;
155 ret = pcmcia_register_client(&link->handle, &client_reg);
156 if (ret != CS_SUCCESS) {
157 cs_error(link->handle, RegisterClient, ret);
165 /*======================================================================
167 This deletes a driver "instance". The device is de-registered
168 with Card Services. If it has been released, all local data
169 structures are freed. Otherwise, the structures will be freed
170 when the device is released.
172 ======================================================================*/
174 static void ide_detach(dev_link_t *link)
179 DEBUG(0, "ide_detach(0x%p)\n", link);
181 /* Locate device structure */
182 for (linkp = &dev_list; *linkp; linkp = &(*linkp)->next)
183 if (*linkp == link) break;
187 if (link->state & DEV_CONFIG)
191 ret = pcmcia_deregister_client(link->handle);
192 if (ret != CS_SUCCESS)
193 cs_error(link->handle, DeregisterClient, ret);
196 /* Unlink, free device structure */
202 static int idecs_register(unsigned long io, unsigned long ctl, unsigned long irq)
205 memset(&hw, 0, sizeof(hw));
206 ide_init_hwif_ports(&hw, io, ctl, NULL);
208 hw.chipset = ide_pci;
209 return ide_register_hw(&hw, NULL);
212 /*======================================================================
214 ide_config() is scheduled to run after a CARD_INSERTION event
215 is received, to configure the PCMCIA socket, and to make the
216 ide device available to the system.
218 ======================================================================*/
220 #define CS_CHECK(fn, ret) \
221 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
223 void ide_config(dev_link_t *link)
225 client_handle_t handle = link->handle;
226 ide_info_t *info = link->priv;
232 cistpl_cftable_entry_t dflt;
234 cistpl_cftable_entry_t *cfg;
235 int i, pass, last_ret = 0, last_fn = 0, hd, is_kme = 0;
236 unsigned long io_base, ctl_base;
238 DEBUG(0, "ide_config(0x%p)\n", link);
240 stk = kmalloc(sizeof(*stk), GFP_KERNEL);
241 if (!stk) goto err_mem;
242 memset(stk, 0, sizeof(*stk));
243 cfg = &stk->parse.cftable_entry;
245 tuple.TupleData = (cisdata_t *)&stk->buf;
246 tuple.TupleOffset = 0;
247 tuple.TupleDataMax = 255;
248 tuple.Attributes = 0;
249 tuple.DesiredTuple = CISTPL_CONFIG;
250 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
251 CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
252 CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &stk->parse));
253 link->conf.ConfigBase = stk->parse.config.base;
254 link->conf.Present = stk->parse.config.rmask[0];
256 tuple.DesiredTuple = CISTPL_MANFID;
257 if (!pcmcia_get_first_tuple(handle, &tuple) &&
258 !pcmcia_get_tuple_data(handle, &tuple) &&
259 !pcmcia_parse_tuple(handle, &tuple, &stk->parse))
260 is_kme = ((stk->parse.manfid.manf == MANFID_KME) &&
261 ((stk->parse.manfid.card == PRODID_KME_KXLC005_A) ||
262 (stk->parse.manfid.card == PRODID_KME_KXLC005_B)));
265 link->state |= DEV_CONFIG;
267 /* Not sure if this is right... look up the current Vcc */
268 CS_CHECK(GetConfigurationInfo, pcmcia_get_configuration_info(handle, &stk->conf));
269 link->conf.Vcc = stk->conf.Vcc;
271 pass = io_base = ctl_base = 0;
272 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
273 tuple.Attributes = 0;
274 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
276 if (pcmcia_get_tuple_data(handle, &tuple) != 0) goto next_entry;
277 if (pcmcia_parse_tuple(handle, &tuple, &stk->parse) != 0) goto next_entry;
279 /* Check for matching Vcc, unless we're desperate */
281 if (cfg->vcc.present & (1 << CISTPL_POWER_VNOM)) {
282 if (stk->conf.Vcc != cfg->vcc.param[CISTPL_POWER_VNOM] / 10000)
284 } else if (stk->dflt.vcc.present & (1 << CISTPL_POWER_VNOM)) {
285 if (stk->conf.Vcc != stk->dflt.vcc.param[CISTPL_POWER_VNOM] / 10000)
290 if (cfg->vpp1.present & (1 << CISTPL_POWER_VNOM))
291 link->conf.Vpp1 = link->conf.Vpp2 =
292 cfg->vpp1.param[CISTPL_POWER_VNOM] / 10000;
293 else if (stk->dflt.vpp1.present & (1 << CISTPL_POWER_VNOM))
294 link->conf.Vpp1 = link->conf.Vpp2 =
295 stk->dflt.vpp1.param[CISTPL_POWER_VNOM] / 10000;
297 if ((cfg->io.nwin > 0) || (stk->dflt.io.nwin > 0)) {
298 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &stk->dflt.io;
299 link->conf.ConfigIndex = cfg->index;
300 link->io.BasePort1 = io->win[0].base;
301 link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
302 if (!(io->flags & CISTPL_IO_16BIT))
303 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
305 link->io.NumPorts1 = 8;
306 link->io.BasePort2 = io->win[1].base;
307 link->io.NumPorts2 = (is_kme) ? 2 : 1;
308 if (pcmcia_request_io(link->handle, &link->io) != 0)
310 io_base = link->io.BasePort1;
311 ctl_base = link->io.BasePort2;
312 } else if ((io->nwin == 1) && (io->win[0].len >= 16)) {
313 link->io.NumPorts1 = io->win[0].len;
314 link->io.NumPorts2 = 0;
315 if (pcmcia_request_io(link->handle, &link->io) != 0)
317 io_base = link->io.BasePort1;
318 ctl_base = link->io.BasePort1 + 0x0e;
319 } else goto next_entry;
320 /* If we've got this far, we're done */
325 if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
326 memcpy(&stk->dflt, cfg, sizeof(stk->dflt));
328 CS_CHECK(GetNextTuple, pcmcia_get_next_tuple(handle, &tuple));
329 } else if (pcmcia_get_next_tuple(handle, &tuple) != 0) {
330 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
331 memset(&stk->dflt, 0, sizeof(stk->dflt));
336 CS_CHECK(RequestIRQ, pcmcia_request_irq(handle, &link->irq));
337 CS_CHECK(RequestConfiguration, pcmcia_request_configuration(handle, &link->conf));
339 /* disable drive interrupts during IDE probe */
340 outb(0x02, ctl_base);
342 /* special setup for KXLC005 card */
344 outb(0x81, ctl_base+1);
346 /* retry registration in case device is still spinning up */
347 for (hd = -1, i = 0; i < 10; i++) {
348 hd = idecs_register(io_base, ctl_base, link->irq.AssignedIRQ);
350 if (link->io.NumPorts1 == 0x20) {
351 outb(0x02, ctl_base + 0x10);
352 hd = idecs_register(io_base + 0x10, ctl_base + 0x10,
353 link->irq.AssignedIRQ);
360 __set_current_state(TASK_UNINTERRUPTIBLE);
361 schedule_timeout(HZ/10);
365 printk(KERN_NOTICE "ide-cs: ide_register() at 0x%3lx & 0x%3lx"
366 ", irq %u failed\n", io_base, ctl_base,
367 link->irq.AssignedIRQ);
372 sprintf(info->node.dev_name, "hd%c", 'a' + (hd * 2));
373 info->node.major = ide_major[hd];
374 info->node.minor = 0;
376 link->dev = &info->node;
377 printk(KERN_INFO "ide-cs: %s: Vcc = %d.%d, Vpp = %d.%d\n",
378 info->node.dev_name, link->conf.Vcc / 10, link->conf.Vcc % 10,
379 link->conf.Vpp1 / 10, link->conf.Vpp1 % 10);
381 link->state &= ~DEV_CONFIG_PENDING;
386 printk(KERN_NOTICE "ide-cs: ide_config failed memory allocation\n");
390 cs_error(link->handle, last_fn, last_ret);
394 link->state &= ~DEV_CONFIG_PENDING;
397 /*======================================================================
399 After a card is removed, ide_release() will unregister the net
400 device, and release the PCMCIA configuration. If the device is
401 still open, this will be postponed until it is closed.
403 ======================================================================*/
405 void ide_release(dev_link_t *link)
407 ide_info_t *info = link->priv;
409 DEBUG(0, "ide_release(0x%p)\n", link);
412 /* FIXME: if this fails we need to queue the cleanup somehow
413 -- need to investigate the required PCMCIA magic */
414 ide_unregister(info->hd);
415 /* deal with brain dead IDE resource management */
416 request_region(link->io.BasePort1, link->io.NumPorts1,
417 info->node.dev_name);
418 if (link->io.NumPorts2)
419 request_region(link->io.BasePort2, link->io.NumPorts2,
420 info->node.dev_name);
425 pcmcia_release_configuration(link->handle);
426 pcmcia_release_io(link->handle, &link->io);
427 pcmcia_release_irq(link->handle, &link->irq);
429 link->state &= ~DEV_CONFIG;
433 /*======================================================================
435 The card status event handler. Mostly, this schedules other
436 stuff to run after an event is received. A CARD_REMOVAL event
437 also sets some flags to discourage the ide drivers from
438 talking to the ports.
440 ======================================================================*/
442 int ide_event(event_t event, int priority,
443 event_callback_args_t *args)
445 dev_link_t *link = args->client_data;
447 DEBUG(1, "ide_event(0x%06x)\n", event);
450 case CS_EVENT_CARD_REMOVAL:
451 link->state &= ~DEV_PRESENT;
452 if (link->state & DEV_CONFIG)
455 case CS_EVENT_CARD_INSERTION:
456 link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
459 case CS_EVENT_PM_SUSPEND:
460 link->state |= DEV_SUSPEND;
461 /* Fall through... */
462 case CS_EVENT_RESET_PHYSICAL:
463 if (link->state & DEV_CONFIG)
464 pcmcia_release_configuration(link->handle);
466 case CS_EVENT_PM_RESUME:
467 link->state &= ~DEV_SUSPEND;
468 /* Fall through... */
469 case CS_EVENT_CARD_RESET:
471 pcmcia_request_configuration(link->handle, &link->conf);
477 static struct pcmcia_driver ide_cs_driver = {
478 .owner = THIS_MODULE,
482 .attach = ide_attach,
483 .detach = ide_detach,
486 static int __init init_ide_cs(void)
488 return pcmcia_register_driver(&ide_cs_driver);
491 static void __exit exit_ide_cs(void)
493 pcmcia_unregister_driver(&ide_cs_driver);
494 while (dev_list != NULL)
495 ide_detach(dev_list);
498 module_init(init_ide_cs);
499 module_exit(exit_ide_cs);