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