xref: /openbmc/linux/drivers/pcmcia/cs.c (revision 8e9e793d) 
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 	kfree(s->config);
335 	s->config = NULL;
336 
337 	{
338 		int status;
339 		s->ops->get_status(s, &status);
340 		if (status & SS_POWERON) {
341 			printk(KERN_ERR "PCMCIA: socket %p: *** DANGER *** unable to remove socket power\n", s);
342 		}
343 	}
344 } /* shutdown_socket */
345 
346 
347 /**
348  * The central event handler.  Send_event() sends an event to the
349  * 16-bit subsystem, which then calls the relevant device drivers.
350  * Parse_events() interprets the event bits from
351  * a card status change report.  Do_shutdown() handles the high
352  * priority stuff associated with a card removal.
353  */
354 
355 /* NOTE: send_event needs to be called with skt->sem held. */
356 
357 static int send_event(struct pcmcia_socket *s, event_t event, int priority)
358 {
359 	int ret;
360 
361 	if (s->state & SOCKET_CARDBUS)
362 		return 0;
363 
364 	cs_dbg(s, 1, "send_event(event %d, pri %d, callback 0x%p)\n",
365 	   event, priority, s->callback);
366 
367 	if (!s->callback)
368 		return 0;
369 	if (!try_module_get(s->callback->owner))
370 		return 0;
371 
372 	ret = s->callback->event(s, event, priority);
373 
374 	module_put(s->callback->owner);
375 
376 	return ret;
377 }
378 
379 static void socket_remove_drivers(struct pcmcia_socket *skt)
380 {
381 	cs_dbg(skt, 4, "remove_drivers\n");
382 
383 	send_event(skt, CS_EVENT_CARD_REMOVAL, CS_EVENT_PRI_HIGH);
384 }
385 
386 static void socket_shutdown(struct pcmcia_socket *skt)
387 {
388 	cs_dbg(skt, 4, "shutdown\n");
389 
390 	socket_remove_drivers(skt);
391 	skt->state &= SOCKET_INUSE|SOCKET_PRESENT;
392 	msleep(shutdown_delay * 10);
393 	skt->state &= SOCKET_INUSE;
394 	shutdown_socket(skt);
395 }
396 
397 static int socket_reset(struct pcmcia_socket *skt)
398 {
399 	int status, i;
400 
401 	cs_dbg(skt, 4, "reset\n");
402 
403 	skt->socket.flags |= SS_OUTPUT_ENA | SS_RESET;
404 	skt->ops->set_socket(skt, &skt->socket);
405 	udelay((long)reset_time);
406 
407 	skt->socket.flags &= ~SS_RESET;
408 	skt->ops->set_socket(skt, &skt->socket);
409 
410 	msleep(unreset_delay * 10);
411 	for (i = 0; i < unreset_limit; i++) {
412 		skt->ops->get_status(skt, &status);
413 
414 		if (!(status & SS_DETECT))
415 			return CS_NO_CARD;
416 
417 		if (status & SS_READY)
418 			return CS_SUCCESS;
419 
420 		msleep(unreset_check * 10);
421 	}
422 
423 	cs_err(skt, "time out after reset.\n");
424 	return CS_GENERAL_FAILURE;
425 }
426 
427 static int socket_setup(struct pcmcia_socket *skt, int initial_delay)
428 {
429 	int status, i;
430 
431 	cs_dbg(skt, 4, "setup\n");
432 
433 	skt->ops->get_status(skt, &status);
434 	if (!(status & SS_DETECT))
435 		return CS_NO_CARD;
436 
437 	msleep(initial_delay * 10);
438 
439 	for (i = 0; i < 100; i++) {
440 		skt->ops->get_status(skt, &status);
441 		if (!(status & SS_DETECT))
442 			return CS_NO_CARD;
443 
444 		if (!(status & SS_PENDING))
445 			break;
446 
447 		msleep(100);
448 	}
449 
450 	if (status & SS_PENDING) {
451 		cs_err(skt, "voltage interrogation timed out.\n");
452 		return CS_GENERAL_FAILURE;
453 	}
454 
455 	if (status & SS_CARDBUS) {
456 		if (!(skt->features & SS_CAP_CARDBUS)) {
457 			cs_err(skt, "cardbus cards are not supported.\n");
458 			return CS_BAD_TYPE;
459 		}
460 		skt->state |= SOCKET_CARDBUS;
461 	}
462 
463 	/*
464 	 * Decode the card voltage requirements, and apply power to the card.
465 	 */
466 	if (status & SS_3VCARD)
467 		skt->socket.Vcc = skt->socket.Vpp = 33;
468 	else if (!(status & SS_XVCARD))
469 		skt->socket.Vcc = skt->socket.Vpp = 50;
470 	else {
471 		cs_err(skt, "unsupported voltage key.\n");
472 		return CS_BAD_TYPE;
473 	}
474 
475 	if (skt->power_hook)
476 		skt->power_hook(skt, HOOK_POWER_PRE);
477 
478 	skt->socket.flags = 0;
479 	skt->ops->set_socket(skt, &skt->socket);
480 
481 	/*
482 	 * Wait "vcc_settle" for the supply to stabilise.
483 	 */
484 	msleep(vcc_settle * 10);
485 
486 	skt->ops->get_status(skt, &status);
487 	if (!(status & SS_POWERON)) {
488 		cs_err(skt, "unable to apply power.\n");
489 		return CS_BAD_TYPE;
490 	}
491 
492 	status = socket_reset(skt);
493 
494 	if (skt->power_hook)
495 		skt->power_hook(skt, HOOK_POWER_POST);
496 
497 	return status;
498 }
499 
500 /*
501  * Handle card insertion.  Setup the socket, reset the card,
502  * and then tell the rest of PCMCIA that a card is present.
503  */
504 static int socket_insert(struct pcmcia_socket *skt)
505 {
506 	int ret;
507 
508 	cs_dbg(skt, 4, "insert\n");
509 
510 	if (!cs_socket_get(skt))
511 		return CS_NO_CARD;
512 
513 	ret = socket_setup(skt, setup_delay);
514 	if (ret == CS_SUCCESS) {
515 		skt->state |= SOCKET_PRESENT;
516 
517 		printk(KERN_NOTICE "pccard: %s card inserted into slot %d\n",
518 		       (skt->state & SOCKET_CARDBUS) ? "CardBus" : "PCMCIA",
519 		       skt->sock);
520 
521 #ifdef CONFIG_CARDBUS
522 		if (skt->state & SOCKET_CARDBUS) {
523 			cb_alloc(skt);
524 			skt->state |= SOCKET_CARDBUS_CONFIG;
525 		}
526 #endif
527 		cs_dbg(skt, 4, "insert done\n");
528 
529 		send_event(skt, CS_EVENT_CARD_INSERTION, CS_EVENT_PRI_LOW);
530 	} else {
531 		socket_shutdown(skt);
532 		cs_socket_put(skt);
533 	}
534 
535 	return ret;
536 }
537 
538 static int socket_suspend(struct pcmcia_socket *skt)
539 {
540 	if (skt->state & SOCKET_SUSPEND)
541 		return CS_IN_USE;
542 
543 	send_event(skt, CS_EVENT_PM_SUSPEND, CS_EVENT_PRI_LOW);
544 	skt->socket = dead_socket;
545 	skt->ops->set_socket(skt, &skt->socket);
546 	if (skt->ops->suspend)
547 		skt->ops->suspend(skt);
548 	skt->state |= SOCKET_SUSPEND;
549 
550 	return CS_SUCCESS;
551 }
552 
553 /*
554  * Resume a socket.  If a card is present, verify its CIS against
555  * our cached copy.  If they are different, the card has been
556  * replaced, and we need to tell the drivers.
557  */
558 static int socket_resume(struct pcmcia_socket *skt)
559 {
560 	int ret;
561 
562 	if (!(skt->state & SOCKET_SUSPEND))
563 		return CS_IN_USE;
564 
565 	skt->socket = dead_socket;
566 	skt->ops->init(skt);
567 	skt->ops->set_socket(skt, &skt->socket);
568 
569 	if (!(skt->state & SOCKET_PRESENT)) {
570 		skt->state &= ~SOCKET_SUSPEND;
571 		return socket_insert(skt);
572 	}
573 
574 	ret = socket_setup(skt, resume_delay);
575 	if (ret == CS_SUCCESS) {
576 		/*
577 		 * FIXME: need a better check here for cardbus cards.
578 		 */
579 		if (verify_cis_cache(skt) != 0) {
580 			cs_dbg(skt, 4, "cis mismatch - different card\n");
581 			socket_remove_drivers(skt);
582 			destroy_cis_cache(skt);
583 			/*
584 			 * Workaround: give DS time to schedule removal.
585 			 * Remove me once the 100ms delay is eliminated
586 			 * in ds.c
587 			 */
588 			msleep(200);
589 			send_event(skt, CS_EVENT_CARD_INSERTION, CS_EVENT_PRI_LOW);
590 		} else {
591 			cs_dbg(skt, 4, "cis matches cache\n");
592 			send_event(skt, CS_EVENT_PM_RESUME, CS_EVENT_PRI_LOW);
593 		}
594 	} else {
595 		socket_shutdown(skt);
596 		cs_socket_put(skt);
597 	}
598 
599 	skt->state &= ~SOCKET_SUSPEND;
600 
601 	return CS_SUCCESS;
602 }
603 
604 static void socket_remove(struct pcmcia_socket *skt)
605 {
606 	printk(KERN_NOTICE "pccard: card ejected from slot %d\n", skt->sock);
607 	socket_shutdown(skt);
608 	cs_socket_put(skt);
609 }
610 
611 /*
612  * Process a socket card detect status change.
613  *
614  * If we don't have a card already present, delay the detect event for
615  * about 20ms (to be on the safe side) before reading the socket status.
616  *
617  * Some i82365-based systems send multiple SS_DETECT events during card
618  * insertion, and the "card present" status bit seems to bounce.  This
619  * will probably be true with GPIO-based card detection systems after
620  * the product has aged.
621  */
622 static void socket_detect_change(struct pcmcia_socket *skt)
623 {
624 	if (!(skt->state & SOCKET_SUSPEND)) {
625 		int status;
626 
627 		if (!(skt->state & SOCKET_PRESENT))
628 			msleep(20);
629 
630 		skt->ops->get_status(skt, &status);
631 		if ((skt->state & SOCKET_PRESENT) &&
632 		     !(status & SS_DETECT))
633 			socket_remove(skt);
634 		if (!(skt->state & SOCKET_PRESENT) &&
635 		    (status & SS_DETECT))
636 			socket_insert(skt);
637 	}
638 }
639 
640 static int pccardd(void *__skt)
641 {
642 	struct pcmcia_socket *skt = __skt;
643 	DECLARE_WAITQUEUE(wait, current);
644 	int ret;
645 
646 	daemonize("pccardd");
647 
648 	skt->thread = current;
649 	skt->socket = dead_socket;
650 	skt->ops->init(skt);
651 	skt->ops->set_socket(skt, &skt->socket);
652 
653 	/* register with the device core */
654 	ret = class_device_register(&skt->dev);
655 	if (ret) {
656 		printk(KERN_WARNING "PCMCIA: unable to register socket 0x%p\n",
657 			skt);
658 		skt->thread = NULL;
659 		complete_and_exit(&skt->thread_done, 0);
660 	}
661 
662 	add_wait_queue(&skt->thread_wait, &wait);
663 	complete(&skt->thread_done);
664 
665 	for (;;) {
666 		unsigned long flags;
667 		unsigned int events;
668 
669 		set_current_state(TASK_INTERRUPTIBLE);
670 
671 		spin_lock_irqsave(&skt->thread_lock, flags);
672 		events = skt->thread_events;
673 		skt->thread_events = 0;
674 		spin_unlock_irqrestore(&skt->thread_lock, flags);
675 
676 		if (events) {
677 			down(&skt->skt_sem);
678 			if (events & SS_DETECT)
679 				socket_detect_change(skt);
680 			if (events & SS_BATDEAD)
681 				send_event(skt, CS_EVENT_BATTERY_DEAD, CS_EVENT_PRI_LOW);
682 			if (events & SS_BATWARN)
683 				send_event(skt, CS_EVENT_BATTERY_LOW, CS_EVENT_PRI_LOW);
684 			if (events & SS_READY)
685 				send_event(skt, CS_EVENT_READY_CHANGE, CS_EVENT_PRI_LOW);
686 			up(&skt->skt_sem);
687 			continue;
688 		}
689 
690 		if (!skt->thread)
691 			break;
692 
693 		schedule();
694 		try_to_freeze();
695 	}
696 	/* make sure we are running before we exit */
697 	set_current_state(TASK_RUNNING);
698 
699 	remove_wait_queue(&skt->thread_wait, &wait);
700 
701 	/* remove from the device core */
702 	class_device_unregister(&skt->dev);
703 
704 	complete_and_exit(&skt->thread_done, 0);
705 }
706 
707 /*
708  * Yenta (at least) probes interrupts before registering the socket and
709  * starting the handler thread.
710  */
711 void pcmcia_parse_events(struct pcmcia_socket *s, u_int events)
712 {
713 	cs_dbg(s, 4, "parse_events: events %08x\n", events);
714 	if (s->thread) {
715 		spin_lock(&s->thread_lock);
716 		s->thread_events |= events;
717 		spin_unlock(&s->thread_lock);
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_sem also protects s->callback */
731 	down(&s->skt_sem);
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 	up(&s->skt_sem);
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 	down(&skt->skt_sem);
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 	up(&skt->skt_sem);
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 	down(&skt->skt_sem);
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 	up(&skt->skt_sem);
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 	down(&skt->skt_sem);
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 	up(&skt->skt_sem);
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 	down(&skt->skt_sem);
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 	up(&skt->skt_sem);
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 	down(&skt->skt_sem);
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 	up(&skt->skt_sem);
910 
911 	return ret;
912 } /* insert_card */
913 EXPORT_SYMBOL(pcmcia_insert_card);
914 
915 
916 static int pcmcia_socket_uevent(struct class_device *dev, char **envp,
917 			        int num_envp, char *buffer, int buffer_size)
918 {
919 	struct pcmcia_socket *s = container_of(dev, struct pcmcia_socket, dev);
920 	int i = 0, length = 0;
921 
922 	if (add_uevent_var(envp, num_envp, &i, buffer, buffer_size,
923 			   &length, "SOCKET_NO=%u", s->sock))
924 		return -ENOMEM;
925 
926 	envp[i] = NULL;
927 
928 	return 0;
929 }
930 
931 
932 static struct completion pcmcia_unload;
933 
934 static void pcmcia_release_socket_class(struct class *data)
935 {
936 	complete(&pcmcia_unload);
937 }
938 
939 
940 struct class pcmcia_socket_class = {
941 	.name = "pcmcia_socket",
942 	.uevent = pcmcia_socket_uevent,
943 	.release = pcmcia_release_socket,
944 	.class_release = pcmcia_release_socket_class,
945 };
946 EXPORT_SYMBOL(pcmcia_socket_class);
947 
948 
949 static int __init init_pcmcia_cs(void)
950 {
951 	int ret;
952 
953 	init_completion(&pcmcia_unload);
954 	ret = class_register(&pcmcia_socket_class);
955 	if (ret)
956 		return (ret);
957 	return class_interface_register(&pccard_sysfs_interface);
958 }
959 
960 static void __exit exit_pcmcia_cs(void)
961 {
962 	class_interface_unregister(&pccard_sysfs_interface);
963 	class_unregister(&pcmcia_socket_class);
964 
965 	wait_for_completion(&pcmcia_unload);
966 }
967 
968 subsys_initcall(init_pcmcia_cs);
969 module_exit(exit_pcmcia_cs);
970 
971