2 * cs.c -- Kernel Card Services - core services
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.
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.
12 * (C) 1999 David A. Hinds
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>
24 #include <linux/interrupt.h>
25 #include <linux/timer.h>
26 #include <linux/ioport.h>
27 #include <linux/delay.h>
29 #include <linux/device.h>
30 #include <linux/kthread.h>
31 #include <linux/freezer.h>
34 #include <pcmcia/ss.h>
35 #include <pcmcia/cistpl.h>
36 #include <pcmcia/cisreg.h>
37 #include <pcmcia/ds.h>
38 #include "cs_internal.h"
41 /* Module parameters */
43 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
44 MODULE_DESCRIPTION("Linux Kernel Card Services");
45 MODULE_LICENSE("GPL");
47 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0444)
49 INT_MODULE_PARM(setup_delay, 10); /* centiseconds */
50 INT_MODULE_PARM(resume_delay, 20); /* centiseconds */
51 INT_MODULE_PARM(shutdown_delay, 3); /* centiseconds */
52 INT_MODULE_PARM(vcc_settle, 40); /* centiseconds */
53 INT_MODULE_PARM(reset_time, 10); /* usecs */
54 INT_MODULE_PARM(unreset_delay, 10); /* centiseconds */
55 INT_MODULE_PARM(unreset_check, 10); /* centiseconds */
56 INT_MODULE_PARM(unreset_limit, 30); /* unreset_check's */
58 /* Access speed for attribute memory windows */
59 INT_MODULE_PARM(cis_speed, 300); /* ns */
62 socket_state_t dead_socket = {
63 .csc_mask = SS_DETECT,
65 EXPORT_SYMBOL(dead_socket);
68 /* List of all sockets, protected by a rwsem */
69 LIST_HEAD(pcmcia_socket_list);
70 EXPORT_SYMBOL(pcmcia_socket_list);
72 DECLARE_RWSEM(pcmcia_socket_list_rwsem);
73 EXPORT_SYMBOL(pcmcia_socket_list_rwsem);
76 struct pcmcia_socket *pcmcia_get_socket(struct pcmcia_socket *skt)
78 struct device *dev = get_device(&skt->dev);
81 return dev_get_drvdata(dev);
83 EXPORT_SYMBOL(pcmcia_get_socket);
86 void pcmcia_put_socket(struct pcmcia_socket *skt)
88 put_device(&skt->dev);
90 EXPORT_SYMBOL(pcmcia_put_socket);
93 static void pcmcia_release_socket(struct device *dev)
95 struct pcmcia_socket *socket = dev_get_drvdata(dev);
97 complete(&socket->socket_released);
100 static int pccardd(void *__skt);
103 * pcmcia_register_socket - add a new pcmcia socket device
104 * @socket: the &socket to register
106 int pcmcia_register_socket(struct pcmcia_socket *socket)
108 struct task_struct *tsk;
111 if (!socket || !socket->ops || !socket->dev.parent || !socket->resource_ops)
114 dev_dbg(&socket->dev, "pcmcia_register_socket(0x%p)\n", socket->ops);
116 /* try to obtain a socket number [yes, it gets ugly if we
117 * register more than 2^sizeof(unsigned int) pcmcia
118 * sockets... but the socket number is deprecated
119 * anyways, so I don't care] */
120 down_write(&pcmcia_socket_list_rwsem);
121 if (list_empty(&pcmcia_socket_list))
124 unsigned int found, i = 1;
125 struct pcmcia_socket *tmp;
128 list_for_each_entry(tmp, &pcmcia_socket_list, socket_list) {
134 socket->sock = i - 1;
136 list_add_tail(&socket->socket_list, &pcmcia_socket_list);
137 up_write(&pcmcia_socket_list_rwsem);
139 #ifndef CONFIG_CARDBUS
141 * If we do not support Cardbus, ensure that
142 * the Cardbus socket capability is disabled.
144 socket->features &= ~SS_CAP_CARDBUS;
147 /* set proper values in socket->dev */
148 dev_set_drvdata(&socket->dev, socket);
149 socket->dev.class = &pcmcia_socket_class;
150 dev_set_name(&socket->dev, "pcmcia_socket%u", socket->sock);
152 /* base address = 0, map = 0 */
153 socket->cis_mem.flags = 0;
154 socket->cis_mem.speed = cis_speed;
156 INIT_LIST_HEAD(&socket->cis_cache);
158 init_completion(&socket->socket_released);
159 init_completion(&socket->thread_done);
160 mutex_init(&socket->skt_mutex);
161 mutex_init(&socket->ops_mutex);
162 spin_lock_init(&socket->thread_lock);
164 if (socket->resource_ops->init) {
165 mutex_lock(&socket->ops_mutex);
166 ret = socket->resource_ops->init(socket);
167 mutex_unlock(&socket->ops_mutex);
172 tsk = kthread_run(pccardd, socket, "pccardd");
178 wait_for_completion(&socket->thread_done);
179 if (!socket->thread) {
180 dev_printk(KERN_WARNING, &socket->dev,
181 "PCMCIA: warning: socket thread did not start\n");
185 pcmcia_parse_events(socket, SS_DETECT);
188 * Let's try to get the PCMCIA module for 16-bit PCMCIA support.
189 * If it fails, it doesn't matter -- we still have 32-bit CardBus
190 * support to offer, so this is not a failure mode.
192 request_module_nowait("pcmcia");
197 down_write(&pcmcia_socket_list_rwsem);
198 list_del(&socket->socket_list);
199 up_write(&pcmcia_socket_list_rwsem);
201 } /* pcmcia_register_socket */
202 EXPORT_SYMBOL(pcmcia_register_socket);
206 * pcmcia_unregister_socket - remove a pcmcia socket device
207 * @socket: the &socket to unregister
209 void pcmcia_unregister_socket(struct pcmcia_socket *socket)
214 dev_dbg(&socket->dev, "pcmcia_unregister_socket(0x%p)\n", socket->ops);
217 kthread_stop(socket->thread);
219 /* remove from our own list */
220 down_write(&pcmcia_socket_list_rwsem);
221 list_del(&socket->socket_list);
222 up_write(&pcmcia_socket_list_rwsem);
224 /* wait for sysfs to drop all references */
225 if (socket->resource_ops->exit) {
226 mutex_lock(&socket->ops_mutex);
227 socket->resource_ops->exit(socket);
228 mutex_unlock(&socket->ops_mutex);
230 wait_for_completion(&socket->socket_released);
231 } /* pcmcia_unregister_socket */
232 EXPORT_SYMBOL(pcmcia_unregister_socket);
235 struct pcmcia_socket *pcmcia_get_socket_by_nr(unsigned int nr)
237 struct pcmcia_socket *s;
239 down_read(&pcmcia_socket_list_rwsem);
240 list_for_each_entry(s, &pcmcia_socket_list, socket_list)
242 up_read(&pcmcia_socket_list_rwsem);
245 up_read(&pcmcia_socket_list_rwsem);
250 EXPORT_SYMBOL(pcmcia_get_socket_by_nr);
252 static int socket_reset(struct pcmcia_socket *skt)
256 dev_dbg(&skt->dev, "reset\n");
258 skt->socket.flags |= SS_OUTPUT_ENA | SS_RESET;
259 skt->ops->set_socket(skt, &skt->socket);
260 udelay((long)reset_time);
262 skt->socket.flags &= ~SS_RESET;
263 skt->ops->set_socket(skt, &skt->socket);
265 msleep(unreset_delay * 10);
266 for (i = 0; i < unreset_limit; i++) {
267 skt->ops->get_status(skt, &status);
269 if (!(status & SS_DETECT))
272 if (status & SS_READY)
275 msleep(unreset_check * 10);
278 dev_printk(KERN_ERR, &skt->dev, "time out after reset.\n");
283 * socket_setup() and socket_shutdown() are called by the main event handler
284 * when card insertion and removal events are received.
285 * socket_setup() turns on socket power and resets the socket, in two stages.
286 * socket_shutdown() unconfigures a socket and turns off socket power.
288 static void socket_shutdown(struct pcmcia_socket *s)
292 dev_dbg(&s->dev, "shutdown\n");
295 s->callback->remove(s);
297 mutex_lock(&s->ops_mutex);
298 s->state &= SOCKET_INUSE | SOCKET_PRESENT;
299 msleep(shutdown_delay * 10);
300 s->state &= SOCKET_INUSE;
302 /* Blank out the socket state */
303 s->socket = dead_socket;
305 s->ops->set_socket(s, &s->socket);
311 /* From here on we can be sure that only we (that is, the
312 * pccardd thread) accesses this socket, and all (16-bit)
313 * PCMCIA interactions are gone. Therefore, release
314 * ops_mutex so that we don't get a sysfs-related lockdep
317 mutex_unlock(&s->ops_mutex);
319 #ifdef CONFIG_CARDBUS
323 /* give socket some time to power down */
326 s->ops->get_status(s, &status);
327 if (status & SS_POWERON) {
328 dev_printk(KERN_ERR, &s->dev,
329 "*** DANGER *** unable to remove socket power\n");
332 s->state &= ~SOCKET_INUSE;
335 static int socket_setup(struct pcmcia_socket *skt, int initial_delay)
339 dev_dbg(&skt->dev, "setup\n");
341 skt->ops->get_status(skt, &status);
342 if (!(status & SS_DETECT))
345 msleep(initial_delay * 10);
347 for (i = 0; i < 100; i++) {
348 skt->ops->get_status(skt, &status);
349 if (!(status & SS_DETECT))
352 if (!(status & SS_PENDING))
358 if (status & SS_PENDING) {
359 dev_printk(KERN_ERR, &skt->dev,
360 "voltage interrogation timed out.\n");
364 if (status & SS_CARDBUS) {
365 if (!(skt->features & SS_CAP_CARDBUS)) {
366 dev_printk(KERN_ERR, &skt->dev,
367 "cardbus cards are not supported.\n");
370 skt->state |= SOCKET_CARDBUS;
372 skt->state &= ~SOCKET_CARDBUS;
375 * Decode the card voltage requirements, and apply power to the card.
377 if (status & SS_3VCARD)
378 skt->socket.Vcc = skt->socket.Vpp = 33;
379 else if (!(status & SS_XVCARD))
380 skt->socket.Vcc = skt->socket.Vpp = 50;
382 dev_printk(KERN_ERR, &skt->dev, "unsupported voltage key.\n");
387 skt->power_hook(skt, HOOK_POWER_PRE);
389 skt->socket.flags = 0;
390 skt->ops->set_socket(skt, &skt->socket);
393 * Wait "vcc_settle" for the supply to stabilise.
395 msleep(vcc_settle * 10);
397 skt->ops->get_status(skt, &status);
398 if (!(status & SS_POWERON)) {
399 dev_printk(KERN_ERR, &skt->dev, "unable to apply power.\n");
403 status = socket_reset(skt);
406 skt->power_hook(skt, HOOK_POWER_POST);
412 * Handle card insertion. Setup the socket, reset the card,
413 * and then tell the rest of PCMCIA that a card is present.
415 static int socket_insert(struct pcmcia_socket *skt)
419 dev_dbg(&skt->dev, "insert\n");
421 mutex_lock(&skt->ops_mutex);
422 if (skt->state & SOCKET_INUSE) {
423 mutex_unlock(&skt->ops_mutex);
426 skt->state |= SOCKET_INUSE;
428 ret = socket_setup(skt, setup_delay);
430 skt->state |= SOCKET_PRESENT;
432 dev_printk(KERN_NOTICE, &skt->dev,
433 "pccard: %s card inserted into slot %d\n",
434 (skt->state & SOCKET_CARDBUS) ? "CardBus" : "PCMCIA",
437 #ifdef CONFIG_CARDBUS
438 if (skt->state & SOCKET_CARDBUS) {
440 skt->state |= SOCKET_CARDBUS_CONFIG;
443 dev_dbg(&skt->dev, "insert done\n");
444 mutex_unlock(&skt->ops_mutex);
446 if (!(skt->state & SOCKET_CARDBUS) && (skt->callback))
447 skt->callback->add(skt);
449 mutex_unlock(&skt->ops_mutex);
450 socket_shutdown(skt);
456 static int socket_suspend(struct pcmcia_socket *skt)
458 if (skt->state & SOCKET_SUSPEND)
461 mutex_lock(&skt->ops_mutex);
462 skt->suspended_state = skt->state;
464 skt->socket = dead_socket;
465 skt->ops->set_socket(skt, &skt->socket);
466 if (skt->ops->suspend)
467 skt->ops->suspend(skt);
468 skt->state |= SOCKET_SUSPEND;
469 mutex_unlock(&skt->ops_mutex);
473 static int socket_early_resume(struct pcmcia_socket *skt)
475 mutex_lock(&skt->ops_mutex);
476 skt->socket = dead_socket;
478 skt->ops->set_socket(skt, &skt->socket);
479 if (skt->state & SOCKET_PRESENT)
480 skt->resume_status = socket_setup(skt, resume_delay);
481 mutex_unlock(&skt->ops_mutex);
485 static int socket_late_resume(struct pcmcia_socket *skt)
489 mutex_lock(&skt->ops_mutex);
490 skt->state &= ~SOCKET_SUSPEND;
491 mutex_unlock(&skt->ops_mutex);
493 if (!(skt->state & SOCKET_PRESENT)) {
494 ret = socket_insert(skt);
500 if (skt->resume_status) {
501 socket_shutdown(skt);
505 if (skt->suspended_state != skt->state) {
507 "suspend state 0x%x != resume state 0x%x\n",
508 skt->suspended_state, skt->state);
510 socket_shutdown(skt);
511 return socket_insert(skt);
514 #ifdef CONFIG_CARDBUS
515 if (skt->state & SOCKET_CARDBUS) {
516 /* We can't be sure the CardBus card is the same
517 * as the one previously inserted. Therefore, remove
524 if (!(skt->state & SOCKET_CARDBUS) && (skt->callback))
525 skt->callback->early_resume(skt);
530 * Resume a socket. If a card is present, verify its CIS against
531 * our cached copy. If they are different, the card has been
532 * replaced, and we need to tell the drivers.
534 static int socket_resume(struct pcmcia_socket *skt)
536 if (!(skt->state & SOCKET_SUSPEND))
539 socket_early_resume(skt);
540 return socket_late_resume(skt);
543 static void socket_remove(struct pcmcia_socket *skt)
545 dev_printk(KERN_NOTICE, &skt->dev,
546 "pccard: card ejected from slot %d\n", skt->sock);
547 socket_shutdown(skt);
551 * Process a socket card detect status change.
553 * If we don't have a card already present, delay the detect event for
554 * about 20ms (to be on the safe side) before reading the socket status.
556 * Some i82365-based systems send multiple SS_DETECT events during card
557 * insertion, and the "card present" status bit seems to bounce. This
558 * will probably be true with GPIO-based card detection systems after
559 * the product has aged.
561 static void socket_detect_change(struct pcmcia_socket *skt)
563 if (!(skt->state & SOCKET_SUSPEND)) {
566 if (!(skt->state & SOCKET_PRESENT))
569 skt->ops->get_status(skt, &status);
570 if ((skt->state & SOCKET_PRESENT) &&
571 !(status & SS_DETECT))
573 if (!(skt->state & SOCKET_PRESENT) &&
574 (status & SS_DETECT))
579 static int pccardd(void *__skt)
581 struct pcmcia_socket *skt = __skt;
584 skt->thread = current;
585 skt->socket = dead_socket;
587 skt->ops->set_socket(skt, &skt->socket);
589 /* register with the device core */
590 ret = device_register(&skt->dev);
592 dev_printk(KERN_WARNING, &skt->dev,
593 "PCMCIA: unable to register socket\n");
595 complete(&skt->thread_done);
598 ret = pccard_sysfs_add_socket(&skt->dev);
600 dev_warn(&skt->dev, "err %d adding socket attributes\n", ret);
602 complete(&skt->thread_done);
604 /* wait for userspace to catch up */
611 unsigned int sysfs_events;
613 set_current_state(TASK_INTERRUPTIBLE);
615 spin_lock_irqsave(&skt->thread_lock, flags);
616 events = skt->thread_events;
617 skt->thread_events = 0;
618 sysfs_events = skt->sysfs_events;
619 skt->sysfs_events = 0;
620 spin_unlock_irqrestore(&skt->thread_lock, flags);
622 mutex_lock(&skt->skt_mutex);
623 if (events & SS_DETECT)
624 socket_detect_change(skt);
627 if (sysfs_events & PCMCIA_UEVENT_EJECT)
629 if (sysfs_events & PCMCIA_UEVENT_INSERT)
631 if ((sysfs_events & PCMCIA_UEVENT_SUSPEND) &&
632 !(skt->state & SOCKET_CARDBUS)) {
634 ret = skt->callback->suspend(skt);
642 if ((sysfs_events & PCMCIA_UEVENT_RESUME) &&
643 !(skt->state & SOCKET_CARDBUS)) {
644 ret = socket_resume(skt);
645 if (!ret && skt->callback)
646 skt->callback->resume(skt);
648 if ((sysfs_events & PCMCIA_UEVENT_REQUERY) &&
649 !(skt->state & SOCKET_CARDBUS)) {
650 if (!ret && skt->callback)
651 skt->callback->requery(skt);
654 mutex_unlock(&skt->skt_mutex);
656 if (events || sysfs_events)
659 if (kthread_should_stop())
665 /* make sure we are running before we exit */
666 set_current_state(TASK_RUNNING);
668 /* shut down socket, if a device is still present */
669 if (skt->state & SOCKET_PRESENT) {
670 mutex_lock(&skt->skt_mutex);
672 mutex_unlock(&skt->skt_mutex);
675 /* remove from the device core */
676 pccard_sysfs_remove_socket(&skt->dev);
677 device_unregister(&skt->dev);
683 * Yenta (at least) probes interrupts before registering the socket and
684 * starting the handler thread.
686 void pcmcia_parse_events(struct pcmcia_socket *s, u_int events)
689 dev_dbg(&s->dev, "parse_events: events %08x\n", events);
691 spin_lock_irqsave(&s->thread_lock, flags);
692 s->thread_events |= events;
693 spin_unlock_irqrestore(&s->thread_lock, flags);
695 wake_up_process(s->thread);
697 } /* pcmcia_parse_events */
698 EXPORT_SYMBOL(pcmcia_parse_events);
701 * pcmcia_parse_uevents() - tell pccardd to issue manual commands
702 * @s: the PCMCIA socket we wan't to command
703 * @events: events to pass to pccardd
705 * userspace-issued insert, eject, suspend and resume commands must be
706 * handled by pccardd to avoid any sysfs-related deadlocks. Valid events
707 * are PCMCIA_UEVENT_EJECT (for eject), PCMCIA_UEVENT__INSERT (for insert),
708 * PCMCIA_UEVENT_RESUME (for resume), PCMCIA_UEVENT_SUSPEND (for suspend)
709 * and PCMCIA_UEVENT_REQUERY (for re-querying the PCMCIA card).
711 void pcmcia_parse_uevents(struct pcmcia_socket *s, u_int events)
714 dev_dbg(&s->dev, "parse_uevents: events %08x\n", events);
716 spin_lock_irqsave(&s->thread_lock, flags);
717 s->sysfs_events |= events;
718 spin_unlock_irqrestore(&s->thread_lock, flags);
720 wake_up_process(s->thread);
723 EXPORT_SYMBOL(pcmcia_parse_uevents);
726 /* register pcmcia_callback */
727 int pccard_register_pcmcia(struct pcmcia_socket *s, struct pcmcia_callback *c)
731 /* s->skt_mutex also protects s->callback */
732 mutex_lock(&s->skt_mutex);
743 if ((s->state & (SOCKET_PRESENT|SOCKET_CARDBUS)) == SOCKET_PRESENT)
748 mutex_unlock(&s->skt_mutex);
752 EXPORT_SYMBOL(pccard_register_pcmcia);
755 /* I'm not sure which "reset" function this is supposed to use,
756 * but for now, it uses the low-level interface's reset, not the
760 int pcmcia_reset_card(struct pcmcia_socket *skt)
764 dev_dbg(&skt->dev, "resetting socket\n");
766 mutex_lock(&skt->skt_mutex);
768 if (!(skt->state & SOCKET_PRESENT)) {
769 dev_dbg(&skt->dev, "can't reset, not present\n");
773 if (skt->state & SOCKET_SUSPEND) {
774 dev_dbg(&skt->dev, "can't reset, suspended\n");
778 if (skt->state & SOCKET_CARDBUS) {
779 dev_dbg(&skt->dev, "can't reset, is cardbus\n");
785 skt->callback->suspend(skt);
786 mutex_lock(&skt->ops_mutex);
787 ret = socket_reset(skt);
788 mutex_unlock(&skt->ops_mutex);
789 if ((ret == 0) && (skt->callback))
790 skt->callback->resume(skt);
794 mutex_unlock(&skt->skt_mutex);
798 EXPORT_SYMBOL(pcmcia_reset_card);
801 static int pcmcia_socket_uevent(struct device *dev,
802 struct kobj_uevent_env *env)
804 struct pcmcia_socket *s = container_of(dev, struct pcmcia_socket, dev);
806 if (add_uevent_var(env, "SOCKET_NO=%u", s->sock))
813 static struct completion pcmcia_unload;
815 static void pcmcia_release_socket_class(struct class *data)
817 complete(&pcmcia_unload);
823 static int __pcmcia_pm_op(struct device *dev,
824 int (*callback) (struct pcmcia_socket *skt))
826 struct pcmcia_socket *s = container_of(dev, struct pcmcia_socket, dev);
829 mutex_lock(&s->skt_mutex);
831 mutex_unlock(&s->skt_mutex);
836 static int pcmcia_socket_dev_suspend_noirq(struct device *dev)
838 return __pcmcia_pm_op(dev, socket_suspend);
841 static int pcmcia_socket_dev_resume_noirq(struct device *dev)
843 return __pcmcia_pm_op(dev, socket_early_resume);
846 static int __used pcmcia_socket_dev_resume(struct device *dev)
848 return __pcmcia_pm_op(dev, socket_late_resume);
851 static const struct dev_pm_ops pcmcia_socket_pm_ops = {
852 /* dev_resume may be called with IRQs enabled */
853 SET_SYSTEM_SLEEP_PM_OPS(NULL,
854 pcmcia_socket_dev_resume)
856 /* late suspend must be called with IRQs disabled */
857 .suspend_noirq = pcmcia_socket_dev_suspend_noirq,
858 .freeze_noirq = pcmcia_socket_dev_suspend_noirq,
859 .poweroff_noirq = pcmcia_socket_dev_suspend_noirq,
861 /* early resume must be called with IRQs disabled */
862 .resume_noirq = pcmcia_socket_dev_resume_noirq,
863 .thaw_noirq = pcmcia_socket_dev_resume_noirq,
864 .restore_noirq = pcmcia_socket_dev_resume_noirq,
867 #define PCMCIA_SOCKET_CLASS_PM_OPS (&pcmcia_socket_pm_ops)
869 #else /* CONFIG_PM */
871 #define PCMCIA_SOCKET_CLASS_PM_OPS NULL
873 #endif /* CONFIG_PM */
875 struct class pcmcia_socket_class = {
876 .name = "pcmcia_socket",
877 .dev_uevent = pcmcia_socket_uevent,
878 .dev_release = pcmcia_release_socket,
879 .class_release = pcmcia_release_socket_class,
880 .pm = PCMCIA_SOCKET_CLASS_PM_OPS,
882 EXPORT_SYMBOL(pcmcia_socket_class);
885 static int __init init_pcmcia_cs(void)
887 init_completion(&pcmcia_unload);
888 return class_register(&pcmcia_socket_class);
891 static void __exit exit_pcmcia_cs(void)
893 class_unregister(&pcmcia_socket_class);
894 wait_for_completion(&pcmcia_unload);
897 subsys_initcall(init_pcmcia_cs);
898 module_exit(exit_pcmcia_cs);