pcmcia: do not lock socket driver module in pcmcia_get_socket()
[safe/jmp/linux-2.6] / drivers / pcmcia / cs.c
1 /*
2  * cs.c -- Kernel Card Services - core services
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation.
7  *
8  * The initial developer of the original code is David A. Hinds
9  * <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
10  * are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
11  *
12  * (C) 1999             David A. Hinds
13  */
14
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/init.h>
18 #include <linux/kernel.h>
19 #include <linux/string.h>
20 #include <linux/major.h>
21 #include <linux/errno.h>
22 #include <linux/slab.h>
23 #include <linux/mm.h>
24 #include <linux/interrupt.h>
25 #include <linux/timer.h>
26 #include <linux/ioport.h>
27 #include <linux/delay.h>
28 #include <linux/pm.h>
29 #include <linux/device.h>
30 #include <linux/kthread.h>
31 #include <linux/freezer.h>
32 #include <asm/system.h>
33 #include <asm/irq.h>
34
35 #include <pcmcia/cs_types.h>
36 #include <pcmcia/ss.h>
37 #include <pcmcia/cs.h>
38 #include <pcmcia/cistpl.h>
39 #include <pcmcia/cisreg.h>
40 #include <pcmcia/ds.h>
41 #include "cs_internal.h"
42
43
44 /* Module parameters */
45
46 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
47 MODULE_DESCRIPTION("Linux Kernel Card Services");
48 MODULE_LICENSE("GPL");
49
50 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0444)
51
52 INT_MODULE_PARM(setup_delay,    10);            /* centiseconds */
53 INT_MODULE_PARM(resume_delay,   20);            /* centiseconds */
54 INT_MODULE_PARM(shutdown_delay, 3);             /* centiseconds */
55 INT_MODULE_PARM(vcc_settle,     40);            /* centiseconds */
56 INT_MODULE_PARM(reset_time,     10);            /* usecs */
57 INT_MODULE_PARM(unreset_delay,  10);            /* centiseconds */
58 INT_MODULE_PARM(unreset_check,  10);            /* centiseconds */
59 INT_MODULE_PARM(unreset_limit,  30);            /* unreset_check's */
60
61 /* Access speed for attribute memory windows */
62 INT_MODULE_PARM(cis_speed,      300);           /* ns */
63
64
65 socket_state_t dead_socket = {
66         .csc_mask       = SS_DETECT,
67 };
68 EXPORT_SYMBOL(dead_socket);
69
70
71 /* List of all sockets, protected by a rwsem */
72 LIST_HEAD(pcmcia_socket_list);
73 EXPORT_SYMBOL(pcmcia_socket_list);
74
75 DECLARE_RWSEM(pcmcia_socket_list_rwsem);
76 EXPORT_SYMBOL(pcmcia_socket_list_rwsem);
77
78
79 /*
80  * Low-level PCMCIA socket drivers need to register with the PCCard
81  * core using pcmcia_register_socket.
82  *
83  * socket drivers are expected to use the following callbacks in their
84  * .drv struct:
85  *  - pcmcia_socket_dev_suspend
86  *  - pcmcia_socket_dev_resume
87  * These functions check for the appropriate struct pcmcia_soket arrays,
88  * and pass them to the low-level functions pcmcia_{suspend,resume}_socket
89  */
90 static int socket_early_resume(struct pcmcia_socket *skt);
91 static int socket_late_resume(struct pcmcia_socket *skt);
92 static int socket_resume(struct pcmcia_socket *skt);
93 static int socket_suspend(struct pcmcia_socket *skt);
94
95 static void pcmcia_socket_dev_run(struct device *dev,
96                                   int (*cb)(struct pcmcia_socket *))
97 {
98         struct pcmcia_socket *socket;
99
100         down_read(&pcmcia_socket_list_rwsem);
101         list_for_each_entry(socket, &pcmcia_socket_list, socket_list) {
102                 if (socket->dev.parent != dev)
103                         continue;
104                 mutex_lock(&socket->skt_mutex);
105                 cb(socket);
106                 mutex_unlock(&socket->skt_mutex);
107         }
108         up_read(&pcmcia_socket_list_rwsem);
109 }
110
111 int pcmcia_socket_dev_suspend(struct device *dev)
112 {
113         pcmcia_socket_dev_run(dev, socket_suspend);
114         return 0;
115 }
116 EXPORT_SYMBOL(pcmcia_socket_dev_suspend);
117
118 void pcmcia_socket_dev_early_resume(struct device *dev)
119 {
120         pcmcia_socket_dev_run(dev, socket_early_resume);
121 }
122 EXPORT_SYMBOL(pcmcia_socket_dev_early_resume);
123
124 void pcmcia_socket_dev_late_resume(struct device *dev)
125 {
126         pcmcia_socket_dev_run(dev, socket_late_resume);
127 }
128 EXPORT_SYMBOL(pcmcia_socket_dev_late_resume);
129
130 int pcmcia_socket_dev_resume(struct device *dev)
131 {
132         pcmcia_socket_dev_run(dev, socket_resume);
133         return 0;
134 }
135 EXPORT_SYMBOL(pcmcia_socket_dev_resume);
136
137
138 struct pcmcia_socket *pcmcia_get_socket(struct pcmcia_socket *skt)
139 {
140         struct device *dev = get_device(&skt->dev);
141         if (!dev)
142                 return NULL;
143         return dev_get_drvdata(dev);
144 }
145 EXPORT_SYMBOL(pcmcia_get_socket);
146
147
148 void pcmcia_put_socket(struct pcmcia_socket *skt)
149 {
150         put_device(&skt->dev);
151 }
152 EXPORT_SYMBOL(pcmcia_put_socket);
153
154
155 static void pcmcia_release_socket(struct device *dev)
156 {
157         struct pcmcia_socket *socket = dev_get_drvdata(dev);
158
159         complete(&socket->socket_released);
160 }
161
162 static int pccardd(void *__skt);
163
164 /**
165  * pcmcia_register_socket - add a new pcmcia socket device
166  * @socket: the &socket to register
167  */
168 int pcmcia_register_socket(struct pcmcia_socket *socket)
169 {
170         struct task_struct *tsk;
171         int ret;
172
173         if (!socket || !socket->ops || !socket->dev.parent || !socket->resource_ops)
174                 return -EINVAL;
175
176         dev_dbg(&socket->dev, "pcmcia_register_socket(0x%p)\n", socket->ops);
177
178         spin_lock_init(&socket->lock);
179
180         /* try to obtain a socket number [yes, it gets ugly if we
181          * register more than 2^sizeof(unsigned int) pcmcia
182          * sockets... but the socket number is deprecated
183          * anyways, so I don't care] */
184         down_write(&pcmcia_socket_list_rwsem);
185         if (list_empty(&pcmcia_socket_list))
186                 socket->sock = 0;
187         else {
188                 unsigned int found, i = 1;
189                 struct pcmcia_socket *tmp;
190                 do {
191                         found = 1;
192                         list_for_each_entry(tmp, &pcmcia_socket_list, socket_list) {
193                                 if (tmp->sock == i)
194                                         found = 0;
195                         }
196                         i++;
197                 } while (!found);
198                 socket->sock = i - 1;
199         }
200         list_add_tail(&socket->socket_list, &pcmcia_socket_list);
201         up_write(&pcmcia_socket_list_rwsem);
202
203 #ifndef CONFIG_CARDBUS
204         /*
205          * If we do not support Cardbus, ensure that
206          * the Cardbus socket capability is disabled.
207          */
208         socket->features &= ~SS_CAP_CARDBUS;
209 #endif
210
211         /* set proper values in socket->dev */
212         dev_set_drvdata(&socket->dev, socket);
213         socket->dev.class = &pcmcia_socket_class;
214         dev_set_name(&socket->dev, "pcmcia_socket%u", socket->sock);
215
216         /* base address = 0, map = 0 */
217         socket->cis_mem.flags = 0;
218         socket->cis_mem.speed = cis_speed;
219
220         INIT_LIST_HEAD(&socket->cis_cache);
221
222         init_completion(&socket->socket_released);
223         init_completion(&socket->thread_done);
224         mutex_init(&socket->skt_mutex);
225         spin_lock_init(&socket->thread_lock);
226
227         if (socket->resource_ops->init) {
228                 ret = socket->resource_ops->init(socket);
229                 if (ret)
230                         goto err;
231         }
232
233         tsk = kthread_run(pccardd, socket, "pccardd");
234         if (IS_ERR(tsk)) {
235                 ret = PTR_ERR(tsk);
236                 goto err;
237         }
238
239         wait_for_completion(&socket->thread_done);
240         if (!socket->thread) {
241                 dev_printk(KERN_WARNING, &socket->dev,
242                            "PCMCIA: warning: socket thread did not start\n");
243                 return -EIO;
244         }
245
246         pcmcia_parse_events(socket, SS_DETECT);
247
248         /*
249          * Let's try to get the PCMCIA module for 16-bit PCMCIA support.
250          * If it fails, it doesn't matter -- we still have 32-bit CardBus
251          * support to offer, so this is not a failure mode.
252          */
253         request_module_nowait("pcmcia");
254
255         return 0;
256
257  err:
258         down_write(&pcmcia_socket_list_rwsem);
259         list_del(&socket->socket_list);
260         up_write(&pcmcia_socket_list_rwsem);
261         return ret;
262 } /* pcmcia_register_socket */
263 EXPORT_SYMBOL(pcmcia_register_socket);
264
265
266 /**
267  * pcmcia_unregister_socket - remove a pcmcia socket device
268  * @socket: the &socket to unregister
269  */
270 void pcmcia_unregister_socket(struct pcmcia_socket *socket)
271 {
272         if (!socket)
273                 return;
274
275         dev_dbg(&socket->dev, "pcmcia_unregister_socket(0x%p)\n", socket->ops);
276
277         if (socket->thread)
278                 kthread_stop(socket->thread);
279
280         /* remove from our own list */
281         down_write(&pcmcia_socket_list_rwsem);
282         list_del(&socket->socket_list);
283         up_write(&pcmcia_socket_list_rwsem);
284
285         /* wait for sysfs to drop all references */
286         release_resource_db(socket);
287         wait_for_completion(&socket->socket_released);
288 } /* pcmcia_unregister_socket */
289 EXPORT_SYMBOL(pcmcia_unregister_socket);
290
291
292 struct pcmcia_socket *pcmcia_get_socket_by_nr(unsigned int nr)
293 {
294         struct pcmcia_socket *s;
295
296         down_read(&pcmcia_socket_list_rwsem);
297         list_for_each_entry(s, &pcmcia_socket_list, socket_list)
298                 if (s->sock == nr) {
299                         up_read(&pcmcia_socket_list_rwsem);
300                         return s;
301                 }
302         up_read(&pcmcia_socket_list_rwsem);
303
304         return NULL;
305
306 }
307 EXPORT_SYMBOL(pcmcia_get_socket_by_nr);
308
309 /*
310  * The central event handler.  Send_event() sends an event to the
311  * 16-bit subsystem, which then calls the relevant device drivers.
312  * Parse_events() interprets the event bits from
313  * a card status change report.  Do_shutdown() handles the high
314  * priority stuff associated with a card removal.
315  */
316
317 /* NOTE: send_event needs to be called with skt->sem held. */
318
319 static int send_event(struct pcmcia_socket *s, event_t event, int priority)
320 {
321         int ret;
322
323         if ((s->state & SOCKET_CARDBUS) && (event != CS_EVENT_CARD_REMOVAL))
324                 return 0;
325
326         dev_dbg(&s->dev, "send_event(event %d, pri %d, callback 0x%p)\n",
327            event, priority, s->callback);
328
329         if (!s->callback)
330                 return 0;
331         if (!try_module_get(s->callback->owner))
332                 return 0;
333
334         ret = s->callback->event(s, event, priority);
335
336         module_put(s->callback->owner);
337
338         return ret;
339 }
340
341 static int socket_reset(struct pcmcia_socket *skt)
342 {
343         int status, i;
344
345         dev_dbg(&skt->dev, "reset\n");
346
347         skt->socket.flags |= SS_OUTPUT_ENA | SS_RESET;
348         skt->ops->set_socket(skt, &skt->socket);
349         udelay((long)reset_time);
350
351         skt->socket.flags &= ~SS_RESET;
352         skt->ops->set_socket(skt, &skt->socket);
353
354         msleep(unreset_delay * 10);
355         for (i = 0; i < unreset_limit; i++) {
356                 skt->ops->get_status(skt, &status);
357
358                 if (!(status & SS_DETECT))
359                         return -ENODEV;
360
361                 if (status & SS_READY)
362                         return 0;
363
364                 msleep(unreset_check * 10);
365         }
366
367         dev_printk(KERN_ERR, &skt->dev, "time out after reset.\n");
368         return -ETIMEDOUT;
369 }
370
371 /*
372  * socket_setup() and socket_shutdown() are called by the main event handler
373  * when card insertion and removal events are received.
374  * socket_setup() turns on socket power and resets the socket, in two stages.
375  * socket_shutdown() unconfigures a socket and turns off socket power.
376  */
377 static void socket_shutdown(struct pcmcia_socket *s)
378 {
379         int status;
380
381         dev_dbg(&s->dev, "shutdown\n");
382
383         send_event(s, CS_EVENT_CARD_REMOVAL, CS_EVENT_PRI_HIGH);
384         s->state &= SOCKET_INUSE | SOCKET_PRESENT;
385         msleep(shutdown_delay * 10);
386         s->state &= SOCKET_INUSE;
387
388         /* Blank out the socket state */
389         s->socket = dead_socket;
390         s->ops->init(s);
391         s->ops->set_socket(s, &s->socket);
392         s->irq.AssignedIRQ = s->irq.Config = 0;
393         s->lock_count = 0;
394         kfree(s->fake_cis);
395         s->fake_cis = NULL;
396 #ifdef CONFIG_CARDBUS
397         cb_free(s);
398 #endif
399         s->functions = 0;
400
401         /* give socket some time to power down */
402         msleep(100);
403
404         s->ops->get_status(s, &status);
405         if (status & SS_POWERON) {
406                 dev_printk(KERN_ERR, &s->dev,
407                            "*** DANGER *** unable to remove socket power\n");
408         }
409
410         cs_socket_put(s);
411 }
412
413 static int socket_setup(struct pcmcia_socket *skt, int initial_delay)
414 {
415         int status, i;
416
417         dev_dbg(&skt->dev, "setup\n");
418
419         skt->ops->get_status(skt, &status);
420         if (!(status & SS_DETECT))
421                 return -ENODEV;
422
423         msleep(initial_delay * 10);
424
425         for (i = 0; i < 100; i++) {
426                 skt->ops->get_status(skt, &status);
427                 if (!(status & SS_DETECT))
428                         return -ENODEV;
429
430                 if (!(status & SS_PENDING))
431                         break;
432
433                 msleep(100);
434         }
435
436         if (status & SS_PENDING) {
437                 dev_printk(KERN_ERR, &skt->dev,
438                            "voltage interrogation timed out.\n");
439                 return -ETIMEDOUT;
440         }
441
442         if (status & SS_CARDBUS) {
443                 if (!(skt->features & SS_CAP_CARDBUS)) {
444                         dev_printk(KERN_ERR, &skt->dev,
445                                 "cardbus cards are not supported.\n");
446                         return -EINVAL;
447                 }
448                 skt->state |= SOCKET_CARDBUS;
449         } else
450                 skt->state &= ~SOCKET_CARDBUS;
451
452         /*
453          * Decode the card voltage requirements, and apply power to the card.
454          */
455         if (status & SS_3VCARD)
456                 skt->socket.Vcc = skt->socket.Vpp = 33;
457         else if (!(status & SS_XVCARD))
458                 skt->socket.Vcc = skt->socket.Vpp = 50;
459         else {
460                 dev_printk(KERN_ERR, &skt->dev, "unsupported voltage key.\n");
461                 return -EIO;
462         }
463
464         if (skt->power_hook)
465                 skt->power_hook(skt, HOOK_POWER_PRE);
466
467         skt->socket.flags = 0;
468         skt->ops->set_socket(skt, &skt->socket);
469
470         /*
471          * Wait "vcc_settle" for the supply to stabilise.
472          */
473         msleep(vcc_settle * 10);
474
475         skt->ops->get_status(skt, &status);
476         if (!(status & SS_POWERON)) {
477                 dev_printk(KERN_ERR, &skt->dev, "unable to apply power.\n");
478                 return -EIO;
479         }
480
481         status = socket_reset(skt);
482
483         if (skt->power_hook)
484                 skt->power_hook(skt, HOOK_POWER_POST);
485
486         return status;
487 }
488
489 /*
490  * Handle card insertion.  Setup the socket, reset the card,
491  * and then tell the rest of PCMCIA that a card is present.
492  */
493 static int socket_insert(struct pcmcia_socket *skt)
494 {
495         int ret;
496
497         dev_dbg(&skt->dev, "insert\n");
498
499         if (!cs_socket_get(skt))
500                 return -ENODEV;
501
502         ret = socket_setup(skt, setup_delay);
503         if (ret == 0) {
504                 skt->state |= SOCKET_PRESENT;
505
506                 dev_printk(KERN_NOTICE, &skt->dev,
507                            "pccard: %s card inserted into slot %d\n",
508                            (skt->state & SOCKET_CARDBUS) ? "CardBus" : "PCMCIA",
509                            skt->sock);
510
511 #ifdef CONFIG_CARDBUS
512                 if (skt->state & SOCKET_CARDBUS) {
513                         cb_alloc(skt);
514                         skt->state |= SOCKET_CARDBUS_CONFIG;
515                 }
516 #endif
517                 dev_dbg(&skt->dev, "insert done\n");
518
519                 send_event(skt, CS_EVENT_CARD_INSERTION, CS_EVENT_PRI_LOW);
520         } else {
521                 socket_shutdown(skt);
522         }
523
524         return ret;
525 }
526
527 static int socket_suspend(struct pcmcia_socket *skt)
528 {
529         if (skt->state & SOCKET_SUSPEND)
530                 return -EBUSY;
531
532         skt->suspended_state = skt->state;
533
534         send_event(skt, CS_EVENT_PM_SUSPEND, CS_EVENT_PRI_LOW);
535         skt->socket = dead_socket;
536         skt->ops->set_socket(skt, &skt->socket);
537         if (skt->ops->suspend)
538                 skt->ops->suspend(skt);
539         skt->state |= SOCKET_SUSPEND;
540
541         return 0;
542 }
543
544 static int socket_early_resume(struct pcmcia_socket *skt)
545 {
546         skt->socket = dead_socket;
547         skt->ops->init(skt);
548         skt->ops->set_socket(skt, &skt->socket);
549         if (skt->state & SOCKET_PRESENT)
550                 skt->resume_status = socket_setup(skt, resume_delay);
551         return 0;
552 }
553
554 static int socket_late_resume(struct pcmcia_socket *skt)
555 {
556         skt->state &= ~SOCKET_SUSPEND;
557
558         if (!(skt->state & SOCKET_PRESENT))
559                 return socket_insert(skt);
560
561         if (skt->resume_status) {
562                 socket_shutdown(skt);
563                 return 0;
564         }
565
566         if (skt->suspended_state != skt->state) {
567                 dev_dbg(&skt->dev,
568                         "suspend state 0x%x != resume state 0x%x\n",
569                         skt->suspended_state, skt->state);
570
571                 socket_shutdown(skt);
572                 return socket_insert(skt);
573         }
574
575 #ifdef CONFIG_CARDBUS
576         if (skt->state & SOCKET_CARDBUS) {
577                 /* We can't be sure the CardBus card is the same
578                  * as the one previously inserted. Therefore, remove
579                  * and re-add... */
580                 cb_free(skt);
581                 cb_alloc(skt);
582                 return 0;
583         }
584 #endif
585
586         send_event(skt, CS_EVENT_PM_RESUME, CS_EVENT_PRI_LOW);
587         return 0;
588 }
589
590 /*
591  * Resume a socket.  If a card is present, verify its CIS against
592  * our cached copy.  If they are different, the card has been
593  * replaced, and we need to tell the drivers.
594  */
595 static int socket_resume(struct pcmcia_socket *skt)
596 {
597         if (!(skt->state & SOCKET_SUSPEND))
598                 return -EBUSY;
599
600         socket_early_resume(skt);
601         return socket_late_resume(skt);
602 }
603
604 static void socket_remove(struct pcmcia_socket *skt)
605 {
606         dev_printk(KERN_NOTICE, &skt->dev,
607                    "pccard: card ejected from slot %d\n", skt->sock);
608         socket_shutdown(skt);
609 }
610
611 /*
612  * Process a socket card detect status change.
613  *
614  * If we don't have a card already present, delay the detect event for
615  * about 20ms (to be on the safe side) before reading the socket status.
616  *
617  * Some i82365-based systems send multiple SS_DETECT events during card
618  * insertion, and the "card present" status bit seems to bounce.  This
619  * will probably be true with GPIO-based card detection systems after
620  * the product has aged.
621  */
622 static void socket_detect_change(struct pcmcia_socket *skt)
623 {
624         if (!(skt->state & SOCKET_SUSPEND)) {
625                 int status;
626
627                 if (!(skt->state & SOCKET_PRESENT))
628                         msleep(20);
629
630                 skt->ops->get_status(skt, &status);
631                 if ((skt->state & SOCKET_PRESENT) &&
632                      !(status & SS_DETECT))
633                         socket_remove(skt);
634                 if (!(skt->state & SOCKET_PRESENT) &&
635                     (status & SS_DETECT))
636                         socket_insert(skt);
637         }
638 }
639
640 static int pccardd(void *__skt)
641 {
642         struct pcmcia_socket *skt = __skt;
643         int ret;
644
645         skt->thread = current;
646         skt->socket = dead_socket;
647         skt->ops->init(skt);
648         skt->ops->set_socket(skt, &skt->socket);
649
650         /* register with the device core */
651         ret = device_register(&skt->dev);
652         if (ret) {
653                 dev_printk(KERN_WARNING, &skt->dev,
654                            "PCMCIA: unable to register socket\n");
655                 skt->thread = NULL;
656                 complete(&skt->thread_done);
657                 return 0;
658         }
659         ret = pccard_sysfs_add_socket(&skt->dev);
660         if (ret)
661                 dev_warn(&skt->dev, "err %d adding socket attributes\n", ret);
662
663         complete(&skt->thread_done);
664
665         set_freezable();
666         for (;;) {
667                 unsigned long flags;
668                 unsigned int events;
669
670                 set_current_state(TASK_INTERRUPTIBLE);
671
672                 spin_lock_irqsave(&skt->thread_lock, flags);
673                 events = skt->thread_events;
674                 skt->thread_events = 0;
675                 spin_unlock_irqrestore(&skt->thread_lock, flags);
676
677                 if (events) {
678                         mutex_lock(&skt->skt_mutex);
679                         if (events & SS_DETECT)
680                                 socket_detect_change(skt);
681                         if (events & SS_BATDEAD)
682                                 send_event(skt, CS_EVENT_BATTERY_DEAD, CS_EVENT_PRI_LOW);
683                         if (events & SS_BATWARN)
684                                 send_event(skt, CS_EVENT_BATTERY_LOW, CS_EVENT_PRI_LOW);
685                         if (events & SS_READY)
686                                 send_event(skt, CS_EVENT_READY_CHANGE, CS_EVENT_PRI_LOW);
687                         mutex_unlock(&skt->skt_mutex);
688                         continue;
689                 }
690
691                 if (kthread_should_stop())
692                         break;
693
694                 schedule();
695                 try_to_freeze();
696         }
697         /* make sure we are running before we exit */
698         set_current_state(TASK_RUNNING);
699
700         /* remove from the device core */
701         pccard_sysfs_remove_socket(&skt->dev);
702         device_unregister(&skt->dev);
703
704         return 0;
705 }
706
707 /*
708  * Yenta (at least) probes interrupts before registering the socket and
709  * starting the handler thread.
710  */
711 void pcmcia_parse_events(struct pcmcia_socket *s, u_int events)
712 {
713         unsigned long flags;
714         dev_dbg(&s->dev, "parse_events: events %08x\n", events);
715         if (s->thread) {
716                 spin_lock_irqsave(&s->thread_lock, flags);
717                 s->thread_events |= events;
718                 spin_unlock_irqrestore(&s->thread_lock, flags);
719
720                 wake_up_process(s->thread);
721         }
722 } /* pcmcia_parse_events */
723 EXPORT_SYMBOL(pcmcia_parse_events);
724
725
726 /* register pcmcia_callback */
727 int pccard_register_pcmcia(struct pcmcia_socket *s, struct pcmcia_callback *c)
728 {
729         int ret = 0;
730
731         /* s->skt_mutex also protects s->callback */
732         mutex_lock(&s->skt_mutex);
733
734         if (c) {
735                 /* registration */
736                 if (s->callback) {
737                         ret = -EBUSY;
738                         goto err;
739                 }
740
741                 s->callback = c;
742
743                 if ((s->state & (SOCKET_PRESENT|SOCKET_CARDBUS)) == SOCKET_PRESENT)
744                         send_event(s, CS_EVENT_CARD_INSERTION, CS_EVENT_PRI_LOW);
745         } else
746                 s->callback = NULL;
747  err:
748         mutex_unlock(&s->skt_mutex);
749
750         return ret;
751 }
752 EXPORT_SYMBOL(pccard_register_pcmcia);
753
754
755 /* I'm not sure which "reset" function this is supposed to use,
756  * but for now, it uses the low-level interface's reset, not the
757  * CIS register.
758  */
759
760 int pcmcia_reset_card(struct pcmcia_socket *skt)
761 {
762         int ret;
763
764         dev_dbg(&skt->dev, "resetting socket\n");
765
766         mutex_lock(&skt->skt_mutex);
767         do {
768                 if (!(skt->state & SOCKET_PRESENT)) {
769                         dev_dbg(&skt->dev, "can't reset, not present\n");
770                         ret = -ENODEV;
771                         break;
772                 }
773                 if (skt->state & SOCKET_SUSPEND) {
774                         dev_dbg(&skt->dev, "can't reset, suspended\n");
775                         ret = -EBUSY;
776                         break;
777                 }
778                 if (skt->state & SOCKET_CARDBUS) {
779                         dev_dbg(&skt->dev, "can't reset, is cardbus\n");
780                         ret = -EPERM;
781                         break;
782                 }
783
784                 ret = send_event(skt, CS_EVENT_RESET_REQUEST, CS_EVENT_PRI_LOW);
785                 if (ret == 0) {
786                         send_event(skt, CS_EVENT_RESET_PHYSICAL, CS_EVENT_PRI_LOW);
787                         if (skt->callback)
788                                 skt->callback->suspend(skt);
789                         if (socket_reset(skt) == 0) {
790                                 send_event(skt, CS_EVENT_CARD_RESET, CS_EVENT_PRI_LOW);
791                                 if (skt->callback)
792                                         skt->callback->resume(skt);
793                         }
794                 }
795
796                 ret = 0;
797         } while (0);
798         mutex_unlock(&skt->skt_mutex);
799
800         return ret;
801 } /* reset_card */
802 EXPORT_SYMBOL(pcmcia_reset_card);
803
804
805 /* These shut down or wake up a socket.  They are sort of user
806  * initiated versions of the APM suspend and resume actions.
807  */
808 int pcmcia_suspend_card(struct pcmcia_socket *skt)
809 {
810         int ret;
811
812         dev_dbg(&skt->dev, "suspending socket\n");
813
814         mutex_lock(&skt->skt_mutex);
815         do {
816                 if (!(skt->state & SOCKET_PRESENT)) {
817                         ret = -ENODEV;
818                         break;
819                 }
820                 if (skt->state & SOCKET_CARDBUS) {
821                         ret = -EPERM;
822                         break;
823                 }
824                 if (skt->callback) {
825                         ret = skt->callback->suspend(skt);
826                         if (ret)
827                                 break;
828                 }
829                 ret = socket_suspend(skt);
830         } while (0);
831         mutex_unlock(&skt->skt_mutex);
832
833         return ret;
834 } /* suspend_card */
835 EXPORT_SYMBOL(pcmcia_suspend_card);
836
837
838 int pcmcia_resume_card(struct pcmcia_socket *skt)
839 {
840         int ret;
841
842         dev_dbg(&skt->dev, "waking up socket\n");
843
844         mutex_lock(&skt->skt_mutex);
845         do {
846                 if (!(skt->state & SOCKET_PRESENT)) {
847                         ret = -ENODEV;
848                         break;
849                 }
850                 if (skt->state & SOCKET_CARDBUS) {
851                         ret = -EPERM;
852                         break;
853                 }
854                 ret = socket_resume(skt);
855                 if (!ret && skt->callback)
856                         skt->callback->resume(skt);
857         } while (0);
858         mutex_unlock(&skt->skt_mutex);
859
860         return ret;
861 } /* resume_card */
862 EXPORT_SYMBOL(pcmcia_resume_card);
863
864
865 /* These handle user requests to eject or insert a card. */
866 int pcmcia_eject_card(struct pcmcia_socket *skt)
867 {
868         int ret;
869
870         dev_dbg(&skt->dev, "user eject request\n");
871
872         mutex_lock(&skt->skt_mutex);
873         do {
874                 if (!(skt->state & SOCKET_PRESENT)) {
875                         ret = -ENODEV;
876                         break;
877                 }
878
879                 ret = send_event(skt, CS_EVENT_EJECTION_REQUEST, CS_EVENT_PRI_LOW);
880                 if (ret != 0) {
881                         ret = -EINVAL;
882                         break;
883                 }
884
885                 socket_remove(skt);
886                 ret = 0;
887         } while (0);
888         mutex_unlock(&skt->skt_mutex);
889
890         return ret;
891 } /* eject_card */
892 EXPORT_SYMBOL(pcmcia_eject_card);
893
894
895 int pcmcia_insert_card(struct pcmcia_socket *skt)
896 {
897         int ret;
898
899         dev_dbg(&skt->dev, "user insert request\n");
900
901         mutex_lock(&skt->skt_mutex);
902         do {
903                 if (skt->state & SOCKET_PRESENT) {
904                         ret = -EBUSY;
905                         break;
906                 }
907                 if (socket_insert(skt) == -ENODEV) {
908                         ret = -ENODEV;
909                         break;
910                 }
911                 ret = 0;
912         } while (0);
913         mutex_unlock(&skt->skt_mutex);
914
915         return ret;
916 } /* insert_card */
917 EXPORT_SYMBOL(pcmcia_insert_card);
918
919
920 static int pcmcia_socket_uevent(struct device *dev,
921                                 struct kobj_uevent_env *env)
922 {
923         struct pcmcia_socket *s = container_of(dev, struct pcmcia_socket, dev);
924
925         if (add_uevent_var(env, "SOCKET_NO=%u", s->sock))
926                 return -ENOMEM;
927
928         return 0;
929 }
930
931
932 static struct completion pcmcia_unload;
933
934 static void pcmcia_release_socket_class(struct class *data)
935 {
936         complete(&pcmcia_unload);
937 }
938
939
940 struct class pcmcia_socket_class = {
941         .name = "pcmcia_socket",
942         .dev_uevent = pcmcia_socket_uevent,
943         .dev_release = pcmcia_release_socket,
944         .class_release = pcmcia_release_socket_class,
945 };
946 EXPORT_SYMBOL(pcmcia_socket_class);
947
948
949 static int __init init_pcmcia_cs(void)
950 {
951         init_completion(&pcmcia_unload);
952         return class_register(&pcmcia_socket_class);
953 }
954
955 static void __exit exit_pcmcia_cs(void)
956 {
957         class_unregister(&pcmcia_socket_class);
958         wait_for_completion(&pcmcia_unload);
959 }
960
961 subsys_initcall(init_pcmcia_cs);
962 module_exit(exit_pcmcia_cs);
963