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>
32 #include <asm/system.h>
35 #include <pcmcia/cs_types.h>
36 #include <pcmcia/ss.h>
37 #include <pcmcia/cs.h>
38 #include <pcmcia/cistpl.h>
39 #include <pcmcia/cisreg.h>
40 #include <pcmcia/ds.h>
41 #include "cs_internal.h"
44 /* Module parameters */
46 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
47 MODULE_DESCRIPTION("Linux Kernel Card Services");
48 MODULE_LICENSE("GPL");
50 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0444)
52 INT_MODULE_PARM(setup_delay, 10); /* centiseconds */
53 INT_MODULE_PARM(resume_delay, 20); /* centiseconds */
54 INT_MODULE_PARM(shutdown_delay, 3); /* centiseconds */
55 INT_MODULE_PARM(vcc_settle, 40); /* centiseconds */
56 INT_MODULE_PARM(reset_time, 10); /* usecs */
57 INT_MODULE_PARM(unreset_delay, 10); /* centiseconds */
58 INT_MODULE_PARM(unreset_check, 10); /* centiseconds */
59 INT_MODULE_PARM(unreset_limit, 30); /* unreset_check's */
61 /* Access speed for attribute memory windows */
62 INT_MODULE_PARM(cis_speed, 300); /* ns */
65 socket_state_t dead_socket = {
66 .csc_mask = SS_DETECT,
68 EXPORT_SYMBOL(dead_socket);
71 /* List of all sockets, protected by a rwsem */
72 LIST_HEAD(pcmcia_socket_list);
73 EXPORT_SYMBOL(pcmcia_socket_list);
75 DECLARE_RWSEM(pcmcia_socket_list_rwsem);
76 EXPORT_SYMBOL(pcmcia_socket_list_rwsem);
80 * Low-level PCMCIA socket drivers need to register with the PCCard
81 * core using pcmcia_register_socket.
83 * socket drivers are expected to use the following callbacks in their
85 * - pcmcia_socket_dev_suspend
86 * - pcmcia_socket_dev_resume
87 * These functions check for the appropriate struct pcmcia_soket arrays,
88 * and pass them to the low-level functions pcmcia_{suspend,resume}_socket
90 static int socket_resume(struct pcmcia_socket *skt);
91 static int socket_suspend(struct pcmcia_socket *skt);
93 int pcmcia_socket_dev_suspend(struct device *dev)
95 struct pcmcia_socket *socket;
97 down_read(&pcmcia_socket_list_rwsem);
98 list_for_each_entry(socket, &pcmcia_socket_list, socket_list) {
99 if (socket->dev.parent != dev)
101 mutex_lock(&socket->skt_mutex);
102 socket_suspend(socket);
103 mutex_unlock(&socket->skt_mutex);
105 up_read(&pcmcia_socket_list_rwsem);
109 EXPORT_SYMBOL(pcmcia_socket_dev_suspend);
111 int pcmcia_socket_dev_resume(struct device *dev)
113 struct pcmcia_socket *socket;
115 down_read(&pcmcia_socket_list_rwsem);
116 list_for_each_entry(socket, &pcmcia_socket_list, socket_list) {
117 if (socket->dev.parent != dev)
119 mutex_lock(&socket->skt_mutex);
120 socket_resume(socket);
121 mutex_unlock(&socket->skt_mutex);
123 up_read(&pcmcia_socket_list_rwsem);
127 EXPORT_SYMBOL(pcmcia_socket_dev_resume);
130 struct pcmcia_socket * pcmcia_get_socket(struct pcmcia_socket *skt)
132 struct device *dev = get_device(&skt->dev);
135 skt = dev_get_drvdata(dev);
136 if (!try_module_get(skt->owner)) {
137 put_device(&skt->dev);
142 EXPORT_SYMBOL(pcmcia_get_socket);
145 void pcmcia_put_socket(struct pcmcia_socket *skt)
147 module_put(skt->owner);
148 put_device(&skt->dev);
150 EXPORT_SYMBOL(pcmcia_put_socket);
153 static void pcmcia_release_socket(struct device *dev)
155 struct pcmcia_socket *socket = dev_get_drvdata(dev);
157 complete(&socket->socket_released);
160 static int pccardd(void *__skt);
163 * pcmcia_register_socket - add a new pcmcia socket device
164 * @socket: the &socket to register
166 int pcmcia_register_socket(struct pcmcia_socket *socket)
168 struct task_struct *tsk;
171 if (!socket || !socket->ops || !socket->dev.parent || !socket->resource_ops)
174 dev_dbg(&socket->dev, "pcmcia_register_socket(0x%p)\n", socket->ops);
176 spin_lock_init(&socket->lock);
178 /* try to obtain a socket number [yes, it gets ugly if we
179 * register more than 2^sizeof(unsigned int) pcmcia
180 * sockets... but the socket number is deprecated
181 * anyways, so I don't care] */
182 down_write(&pcmcia_socket_list_rwsem);
183 if (list_empty(&pcmcia_socket_list))
186 unsigned int found, i = 1;
187 struct pcmcia_socket *tmp;
190 list_for_each_entry(tmp, &pcmcia_socket_list, socket_list) {
196 socket->sock = i - 1;
198 list_add_tail(&socket->socket_list, &pcmcia_socket_list);
199 up_write(&pcmcia_socket_list_rwsem);
201 #ifndef CONFIG_CARDBUS
203 * If we do not support Cardbus, ensure that
204 * the Cardbus socket capability is disabled.
206 socket->features &= ~SS_CAP_CARDBUS;
209 /* set proper values in socket->dev */
210 dev_set_drvdata(&socket->dev, socket);
211 socket->dev.class = &pcmcia_socket_class;
212 dev_set_name(&socket->dev, "pcmcia_socket%u", socket->sock);
214 /* base address = 0, map = 0 */
215 socket->cis_mem.flags = 0;
216 socket->cis_mem.speed = cis_speed;
218 INIT_LIST_HEAD(&socket->cis_cache);
220 init_completion(&socket->socket_released);
221 init_completion(&socket->thread_done);
222 mutex_init(&socket->skt_mutex);
223 spin_lock_init(&socket->thread_lock);
225 if (socket->resource_ops->init) {
226 ret = socket->resource_ops->init(socket);
231 tsk = kthread_run(pccardd, socket, "pccardd");
237 wait_for_completion(&socket->thread_done);
238 if (!socket->thread) {
239 dev_printk(KERN_WARNING, &socket->dev,
240 "PCMCIA: warning: socket thread did not start\n");
244 pcmcia_parse_events(socket, SS_DETECT);
249 down_write(&pcmcia_socket_list_rwsem);
250 list_del(&socket->socket_list);
251 up_write(&pcmcia_socket_list_rwsem);
253 } /* pcmcia_register_socket */
254 EXPORT_SYMBOL(pcmcia_register_socket);
258 * pcmcia_unregister_socket - remove a pcmcia socket device
259 * @socket: the &socket to unregister
261 void pcmcia_unregister_socket(struct pcmcia_socket *socket)
266 dev_dbg(&socket->dev, "pcmcia_unregister_socket(0x%p)\n", socket->ops);
269 kthread_stop(socket->thread);
271 release_cis_mem(socket);
273 /* remove from our own list */
274 down_write(&pcmcia_socket_list_rwsem);
275 list_del(&socket->socket_list);
276 up_write(&pcmcia_socket_list_rwsem);
278 /* wait for sysfs to drop all references */
279 release_resource_db(socket);
280 wait_for_completion(&socket->socket_released);
281 } /* pcmcia_unregister_socket */
282 EXPORT_SYMBOL(pcmcia_unregister_socket);
285 struct pcmcia_socket * pcmcia_get_socket_by_nr(unsigned int nr)
287 struct pcmcia_socket *s;
289 down_read(&pcmcia_socket_list_rwsem);
290 list_for_each_entry(s, &pcmcia_socket_list, socket_list)
292 up_read(&pcmcia_socket_list_rwsem);
295 up_read(&pcmcia_socket_list_rwsem);
300 EXPORT_SYMBOL(pcmcia_get_socket_by_nr);
303 * The central event handler. Send_event() sends an event to the
304 * 16-bit subsystem, which then calls the relevant device drivers.
305 * Parse_events() interprets the event bits from
306 * a card status change report. Do_shutdown() handles the high
307 * priority stuff associated with a card removal.
310 /* NOTE: send_event needs to be called with skt->sem held. */
312 static int send_event(struct pcmcia_socket *s, event_t event, int priority)
316 if (s->state & SOCKET_CARDBUS)
319 dev_dbg(&s->dev, "send_event(event %d, pri %d, callback 0x%p)\n",
320 event, priority, s->callback);
324 if (!try_module_get(s->callback->owner))
327 ret = s->callback->event(s, event, priority);
329 module_put(s->callback->owner);
334 static void socket_remove_drivers(struct pcmcia_socket *skt)
336 dev_dbg(&skt->dev, "remove_drivers\n");
338 send_event(skt, CS_EVENT_CARD_REMOVAL, CS_EVENT_PRI_HIGH);
341 static int socket_reset(struct pcmcia_socket *skt)
345 dev_dbg(&skt->dev, "reset\n");
347 skt->socket.flags |= SS_OUTPUT_ENA | SS_RESET;
348 skt->ops->set_socket(skt, &skt->socket);
349 udelay((long)reset_time);
351 skt->socket.flags &= ~SS_RESET;
352 skt->ops->set_socket(skt, &skt->socket);
354 msleep(unreset_delay * 10);
355 for (i = 0; i < unreset_limit; i++) {
356 skt->ops->get_status(skt, &status);
358 if (!(status & SS_DETECT))
361 if (status & SS_READY)
364 msleep(unreset_check * 10);
367 dev_printk(KERN_ERR, &skt->dev, "time out after reset.\n");
372 * socket_setup() and socket_shutdown() are called by the main event handler
373 * when card insertion and removal events are received.
374 * socket_setup() turns on socket power and resets the socket, in two stages.
375 * socket_shutdown() unconfigures a socket and turns off socket power.
377 static void socket_shutdown(struct pcmcia_socket *s)
381 dev_dbg(&s->dev, "shutdown\n");
383 socket_remove_drivers(s);
384 s->state &= SOCKET_INUSE | SOCKET_PRESENT;
385 msleep(shutdown_delay * 10);
386 s->state &= SOCKET_INUSE;
388 /* Blank out the socket state */
389 s->socket = dead_socket;
391 s->ops->set_socket(s, &s->socket);
392 s->irq.AssignedIRQ = s->irq.Config = 0;
394 destroy_cis_cache(s);
395 #ifdef CONFIG_CARDBUS
400 /* give socket some time to power down */
403 s->ops->get_status(s, &status);
404 if (status & SS_POWERON) {
405 dev_printk(KERN_ERR, &s->dev,
406 "*** DANGER *** unable to remove socket power\n");
412 static int socket_setup(struct pcmcia_socket *skt, int initial_delay)
416 dev_dbg(&skt->dev, "setup\n");
418 skt->ops->get_status(skt, &status);
419 if (!(status & SS_DETECT))
422 msleep(initial_delay * 10);
424 for (i = 0; i < 100; i++) {
425 skt->ops->get_status(skt, &status);
426 if (!(status & SS_DETECT))
429 if (!(status & SS_PENDING))
435 if (status & SS_PENDING) {
436 dev_printk(KERN_ERR, &skt->dev,
437 "voltage interrogation timed out.\n");
441 if (status & SS_CARDBUS) {
442 if (!(skt->features & SS_CAP_CARDBUS)) {
443 dev_printk(KERN_ERR, &skt->dev,
444 "cardbus cards are not supported.\n");
447 skt->state |= SOCKET_CARDBUS;
451 * Decode the card voltage requirements, and apply power to the card.
453 if (status & SS_3VCARD)
454 skt->socket.Vcc = skt->socket.Vpp = 33;
455 else if (!(status & SS_XVCARD))
456 skt->socket.Vcc = skt->socket.Vpp = 50;
458 dev_printk(KERN_ERR, &skt->dev, "unsupported voltage key.\n");
463 skt->power_hook(skt, HOOK_POWER_PRE);
465 skt->socket.flags = 0;
466 skt->ops->set_socket(skt, &skt->socket);
469 * Wait "vcc_settle" for the supply to stabilise.
471 msleep(vcc_settle * 10);
473 skt->ops->get_status(skt, &status);
474 if (!(status & SS_POWERON)) {
475 dev_printk(KERN_ERR, &skt->dev, "unable to apply power.\n");
479 status = socket_reset(skt);
482 skt->power_hook(skt, HOOK_POWER_POST);
488 * Handle card insertion. Setup the socket, reset the card,
489 * and then tell the rest of PCMCIA that a card is present.
491 static int socket_insert(struct pcmcia_socket *skt)
495 dev_dbg(&skt->dev, "insert\n");
497 if (!cs_socket_get(skt))
500 ret = socket_setup(skt, setup_delay);
502 skt->state |= SOCKET_PRESENT;
504 dev_printk(KERN_NOTICE, &skt->dev,
505 "pccard: %s card inserted into slot %d\n",
506 (skt->state & SOCKET_CARDBUS) ? "CardBus" : "PCMCIA",
509 #ifdef CONFIG_CARDBUS
510 if (skt->state & SOCKET_CARDBUS) {
512 skt->state |= SOCKET_CARDBUS_CONFIG;
515 dev_dbg(&skt->dev, "insert done\n");
517 send_event(skt, CS_EVENT_CARD_INSERTION, CS_EVENT_PRI_LOW);
519 socket_shutdown(skt);
525 static int socket_suspend(struct pcmcia_socket *skt)
527 if (skt->state & SOCKET_SUSPEND)
530 send_event(skt, CS_EVENT_PM_SUSPEND, CS_EVENT_PRI_LOW);
531 skt->socket = dead_socket;
532 skt->ops->set_socket(skt, &skt->socket);
533 if (skt->ops->suspend)
534 skt->ops->suspend(skt);
535 skt->state |= SOCKET_SUSPEND;
541 * Resume a socket. If a card is present, verify its CIS against
542 * our cached copy. If they are different, the card has been
543 * replaced, and we need to tell the drivers.
545 static int socket_resume(struct pcmcia_socket *skt)
549 if (!(skt->state & SOCKET_SUSPEND))
552 skt->socket = dead_socket;
554 skt->ops->set_socket(skt, &skt->socket);
556 if (!(skt->state & SOCKET_PRESENT)) {
557 skt->state &= ~SOCKET_SUSPEND;
558 return socket_insert(skt);
561 ret = socket_setup(skt, resume_delay);
564 * FIXME: need a better check here for cardbus cards.
566 if (verify_cis_cache(skt) != 0) {
567 dev_dbg(&skt->dev, "cis mismatch - different card\n");
568 socket_remove_drivers(skt);
569 destroy_cis_cache(skt);
571 * Workaround: give DS time to schedule removal.
572 * Remove me once the 100ms delay is eliminated
576 send_event(skt, CS_EVENT_CARD_INSERTION, CS_EVENT_PRI_LOW);
578 dev_dbg(&skt->dev, "cis matches cache\n");
579 send_event(skt, CS_EVENT_PM_RESUME, CS_EVENT_PRI_LOW);
582 socket_shutdown(skt);
585 skt->state &= ~SOCKET_SUSPEND;
590 static void socket_remove(struct pcmcia_socket *skt)
592 dev_printk(KERN_NOTICE, &skt->dev,
593 "pccard: card ejected from slot %d\n", skt->sock);
594 socket_shutdown(skt);
598 * Process a socket card detect status change.
600 * If we don't have a card already present, delay the detect event for
601 * about 20ms (to be on the safe side) before reading the socket status.
603 * Some i82365-based systems send multiple SS_DETECT events during card
604 * insertion, and the "card present" status bit seems to bounce. This
605 * will probably be true with GPIO-based card detection systems after
606 * the product has aged.
608 static void socket_detect_change(struct pcmcia_socket *skt)
610 if (!(skt->state & SOCKET_SUSPEND)) {
613 if (!(skt->state & SOCKET_PRESENT))
616 skt->ops->get_status(skt, &status);
617 if ((skt->state & SOCKET_PRESENT) &&
618 !(status & SS_DETECT))
620 if (!(skt->state & SOCKET_PRESENT) &&
621 (status & SS_DETECT))
626 static int pccardd(void *__skt)
628 struct pcmcia_socket *skt = __skt;
631 skt->thread = current;
632 skt->socket = dead_socket;
634 skt->ops->set_socket(skt, &skt->socket);
636 /* register with the device core */
637 ret = device_register(&skt->dev);
639 dev_printk(KERN_WARNING, &skt->dev,
640 "PCMCIA: unable to register socket\n");
642 complete(&skt->thread_done);
645 ret = pccard_sysfs_add_socket(&skt->dev);
647 dev_warn(&skt->dev, "err %d adding socket attributes\n", ret);
649 complete(&skt->thread_done);
656 set_current_state(TASK_INTERRUPTIBLE);
658 spin_lock_irqsave(&skt->thread_lock, flags);
659 events = skt->thread_events;
660 skt->thread_events = 0;
661 spin_unlock_irqrestore(&skt->thread_lock, flags);
664 mutex_lock(&skt->skt_mutex);
665 if (events & SS_DETECT)
666 socket_detect_change(skt);
667 if (events & SS_BATDEAD)
668 send_event(skt, CS_EVENT_BATTERY_DEAD, CS_EVENT_PRI_LOW);
669 if (events & SS_BATWARN)
670 send_event(skt, CS_EVENT_BATTERY_LOW, CS_EVENT_PRI_LOW);
671 if (events & SS_READY)
672 send_event(skt, CS_EVENT_READY_CHANGE, CS_EVENT_PRI_LOW);
673 mutex_unlock(&skt->skt_mutex);
677 if (kthread_should_stop())
683 /* make sure we are running before we exit */
684 set_current_state(TASK_RUNNING);
686 /* remove from the device core */
687 pccard_sysfs_remove_socket(&skt->dev);
688 device_unregister(&skt->dev);
694 * Yenta (at least) probes interrupts before registering the socket and
695 * starting the handler thread.
697 void pcmcia_parse_events(struct pcmcia_socket *s, u_int events)
700 dev_dbg(&s->dev, "parse_events: events %08x\n", events);
702 spin_lock_irqsave(&s->thread_lock, flags);
703 s->thread_events |= events;
704 spin_unlock_irqrestore(&s->thread_lock, flags);
706 wake_up_process(s->thread);
708 } /* pcmcia_parse_events */
709 EXPORT_SYMBOL(pcmcia_parse_events);
712 /* register pcmcia_callback */
713 int pccard_register_pcmcia(struct pcmcia_socket *s, struct pcmcia_callback *c)
717 /* s->skt_mutex also protects s->callback */
718 mutex_lock(&s->skt_mutex);
729 if ((s->state & (SOCKET_PRESENT|SOCKET_CARDBUS)) == SOCKET_PRESENT)
730 send_event(s, CS_EVENT_CARD_INSERTION, CS_EVENT_PRI_LOW);
734 mutex_unlock(&s->skt_mutex);
738 EXPORT_SYMBOL(pccard_register_pcmcia);
741 /* I'm not sure which "reset" function this is supposed to use,
742 * but for now, it uses the low-level interface's reset, not the
746 int pcmcia_reset_card(struct pcmcia_socket *skt)
750 dev_dbg(&skt->dev, "resetting socket\n");
752 mutex_lock(&skt->skt_mutex);
754 if (!(skt->state & SOCKET_PRESENT)) {
755 dev_dbg(&skt->dev, "can't reset, not present\n");
759 if (skt->state & SOCKET_SUSPEND) {
760 dev_dbg(&skt->dev, "can't reset, suspended\n");
764 if (skt->state & SOCKET_CARDBUS) {
765 dev_dbg(&skt->dev, "can't reset, is cardbus\n");
770 ret = send_event(skt, CS_EVENT_RESET_REQUEST, CS_EVENT_PRI_LOW);
772 send_event(skt, CS_EVENT_RESET_PHYSICAL, CS_EVENT_PRI_LOW);
774 skt->callback->suspend(skt);
775 if (socket_reset(skt) == 0) {
776 send_event(skt, CS_EVENT_CARD_RESET, CS_EVENT_PRI_LOW);
778 skt->callback->resume(skt);
784 mutex_unlock(&skt->skt_mutex);
788 EXPORT_SYMBOL(pcmcia_reset_card);
791 /* These shut down or wake up a socket. They are sort of user
792 * initiated versions of the APM suspend and resume actions.
794 int pcmcia_suspend_card(struct pcmcia_socket *skt)
798 dev_dbg(&skt->dev, "suspending socket\n");
800 mutex_lock(&skt->skt_mutex);
802 if (!(skt->state & SOCKET_PRESENT)) {
806 if (skt->state & SOCKET_CARDBUS) {
811 ret = skt->callback->suspend(skt);
815 ret = socket_suspend(skt);
817 mutex_unlock(&skt->skt_mutex);
821 EXPORT_SYMBOL(pcmcia_suspend_card);
824 int pcmcia_resume_card(struct pcmcia_socket *skt)
828 dev_dbg(&skt->dev, "waking up socket\n");
830 mutex_lock(&skt->skt_mutex);
832 if (!(skt->state & SOCKET_PRESENT)) {
836 if (skt->state & SOCKET_CARDBUS) {
840 ret = socket_resume(skt);
841 if (!ret && skt->callback)
842 skt->callback->resume(skt);
844 mutex_unlock(&skt->skt_mutex);
848 EXPORT_SYMBOL(pcmcia_resume_card);
851 /* These handle user requests to eject or insert a card. */
852 int pcmcia_eject_card(struct pcmcia_socket *skt)
856 dev_dbg(&skt->dev, "user eject request\n");
858 mutex_lock(&skt->skt_mutex);
860 if (!(skt->state & SOCKET_PRESENT)) {
865 ret = send_event(skt, CS_EVENT_EJECTION_REQUEST, CS_EVENT_PRI_LOW);
874 mutex_unlock(&skt->skt_mutex);
878 EXPORT_SYMBOL(pcmcia_eject_card);
881 int pcmcia_insert_card(struct pcmcia_socket *skt)
885 dev_dbg(&skt->dev, "user insert request\n");
887 mutex_lock(&skt->skt_mutex);
889 if (skt->state & SOCKET_PRESENT) {
893 if (socket_insert(skt) == -ENODEV) {
899 mutex_unlock(&skt->skt_mutex);
903 EXPORT_SYMBOL(pcmcia_insert_card);
906 static int pcmcia_socket_uevent(struct device *dev,
907 struct kobj_uevent_env *env)
909 struct pcmcia_socket *s = container_of(dev, struct pcmcia_socket, dev);
911 if (add_uevent_var(env, "SOCKET_NO=%u", s->sock))
918 static struct completion pcmcia_unload;
920 static void pcmcia_release_socket_class(struct class *data)
922 complete(&pcmcia_unload);
926 struct class pcmcia_socket_class = {
927 .name = "pcmcia_socket",
928 .dev_uevent = pcmcia_socket_uevent,
929 .dev_release = pcmcia_release_socket,
930 .class_release = pcmcia_release_socket_class,
932 EXPORT_SYMBOL(pcmcia_socket_class);
935 static int __init init_pcmcia_cs(void)
937 init_completion(&pcmcia_unload);
938 return class_register(&pcmcia_socket_class);
941 static void __exit exit_pcmcia_cs(void)
943 class_unregister(&pcmcia_socket_class);
944 wait_for_completion(&pcmcia_unload);
947 subsys_initcall(init_pcmcia_cs);
948 module_exit(exit_pcmcia_cs);