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