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