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