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 #define IN_CARD_SERVICES
36 #include <pcmcia/cs_types.h>
37 #include <pcmcia/ss.h>
38 #include <pcmcia/cs.h>
39 #include <pcmcia/cistpl.h>
40 #include <pcmcia/cisreg.h>
41 #include <pcmcia/ds.h>
42 #include "cs_internal.h"
45 /* Module parameters */
47 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
48 MODULE_DESCRIPTION("Linux Kernel Card Services");
49 MODULE_LICENSE("GPL");
51 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0444)
53 INT_MODULE_PARM(setup_delay, 10); /* centiseconds */
54 INT_MODULE_PARM(resume_delay, 20); /* centiseconds */
55 INT_MODULE_PARM(shutdown_delay, 3); /* centiseconds */
56 INT_MODULE_PARM(vcc_settle, 40); /* centiseconds */
57 INT_MODULE_PARM(reset_time, 10); /* usecs */
58 INT_MODULE_PARM(unreset_delay, 10); /* centiseconds */
59 INT_MODULE_PARM(unreset_check, 10); /* centiseconds */
60 INT_MODULE_PARM(unreset_limit, 30); /* unreset_check's */
62 /* Access speed for attribute memory windows */
63 INT_MODULE_PARM(cis_speed, 300); /* ns */
68 module_param(pc_debug, int, 0644);
70 int cs_debug_level(int level)
72 return pc_debug > level;
77 socket_state_t dead_socket = {
78 .csc_mask = SS_DETECT,
80 EXPORT_SYMBOL(dead_socket);
83 /* List of all sockets, protected by a rwsem */
84 LIST_HEAD(pcmcia_socket_list);
85 EXPORT_SYMBOL(pcmcia_socket_list);
87 DECLARE_RWSEM(pcmcia_socket_list_rwsem);
88 EXPORT_SYMBOL(pcmcia_socket_list_rwsem);
92 * Low-level PCMCIA socket drivers need to register with the PCCard
93 * core using pcmcia_register_socket.
95 * socket drivers are expected to use the following callbacks in their
97 * - pcmcia_socket_dev_suspend
98 * - pcmcia_socket_dev_resume
99 * These functions check for the appropriate struct pcmcia_soket arrays,
100 * and pass them to the low-level functions pcmcia_{suspend,resume}_socket
102 static int socket_resume(struct pcmcia_socket *skt);
103 static int socket_suspend(struct pcmcia_socket *skt);
105 int pcmcia_socket_dev_suspend(struct device *dev, pm_message_t state)
107 struct pcmcia_socket *socket;
109 down_read(&pcmcia_socket_list_rwsem);
110 list_for_each_entry(socket, &pcmcia_socket_list, socket_list) {
111 if (socket->dev.parent != dev)
113 mutex_lock(&socket->skt_mutex);
114 socket_suspend(socket);
115 mutex_unlock(&socket->skt_mutex);
117 up_read(&pcmcia_socket_list_rwsem);
121 EXPORT_SYMBOL(pcmcia_socket_dev_suspend);
123 int pcmcia_socket_dev_resume(struct device *dev)
125 struct pcmcia_socket *socket;
127 down_read(&pcmcia_socket_list_rwsem);
128 list_for_each_entry(socket, &pcmcia_socket_list, socket_list) {
129 if (socket->dev.parent != dev)
131 mutex_lock(&socket->skt_mutex);
132 socket_resume(socket);
133 mutex_unlock(&socket->skt_mutex);
135 up_read(&pcmcia_socket_list_rwsem);
139 EXPORT_SYMBOL(pcmcia_socket_dev_resume);
142 struct pcmcia_socket * pcmcia_get_socket(struct pcmcia_socket *skt)
144 struct device *dev = get_device(&skt->dev);
147 skt = dev_get_drvdata(dev);
148 if (!try_module_get(skt->owner)) {
149 put_device(&skt->dev);
154 EXPORT_SYMBOL(pcmcia_get_socket);
157 void pcmcia_put_socket(struct pcmcia_socket *skt)
159 module_put(skt->owner);
160 put_device(&skt->dev);
162 EXPORT_SYMBOL(pcmcia_put_socket);
165 static void pcmcia_release_socket(struct device *dev)
167 struct pcmcia_socket *socket = dev_get_drvdata(dev);
169 complete(&socket->socket_released);
172 static int pccardd(void *__skt);
175 * pcmcia_register_socket - add a new pcmcia socket device
176 * @socket: the &socket to register
178 int pcmcia_register_socket(struct pcmcia_socket *socket)
180 struct task_struct *tsk;
183 if (!socket || !socket->ops || !socket->dev.parent || !socket->resource_ops)
186 cs_dbg(socket, 0, "pcmcia_register_socket(0x%p)\n", socket->ops);
188 spin_lock_init(&socket->lock);
190 if (socket->resource_ops->init) {
191 ret = socket->resource_ops->init(socket);
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))
204 unsigned int found, i = 1;
205 struct pcmcia_socket *tmp;
208 list_for_each_entry(tmp, &pcmcia_socket_list, socket_list) {
214 socket->sock = i - 1;
216 list_add_tail(&socket->socket_list, &pcmcia_socket_list);
217 up_write(&pcmcia_socket_list_rwsem);
219 #ifndef CONFIG_CARDBUS
221 * If we do not support Cardbus, ensure that
222 * the Cardbus socket capability is disabled.
224 socket->features &= ~SS_CAP_CARDBUS;
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);
232 /* base address = 0, map = 0 */
233 socket->cis_mem.flags = 0;
234 socket->cis_mem.speed = cis_speed;
236 INIT_LIST_HEAD(&socket->cis_cache);
238 init_completion(&socket->socket_released);
239 init_completion(&socket->thread_done);
240 mutex_init(&socket->skt_mutex);
241 spin_lock_init(&socket->thread_lock);
243 tsk = kthread_run(pccardd, socket, "pccardd");
249 wait_for_completion(&socket->thread_done);
250 if (!socket->thread) {
251 printk(KERN_WARNING "PCMCIA: warning: socket thread for socket %p did not start\n", socket);
255 pcmcia_parse_events(socket, SS_DETECT);
260 down_write(&pcmcia_socket_list_rwsem);
261 list_del(&socket->socket_list);
262 up_write(&pcmcia_socket_list_rwsem);
264 } /* pcmcia_register_socket */
265 EXPORT_SYMBOL(pcmcia_register_socket);
269 * pcmcia_unregister_socket - remove a pcmcia socket device
270 * @socket: the &socket to unregister
272 void pcmcia_unregister_socket(struct pcmcia_socket *socket)
277 cs_dbg(socket, 0, "pcmcia_unregister_socket(0x%p)\n", socket->ops);
280 kthread_stop(socket->thread);
282 release_cis_mem(socket);
284 /* remove from our own list */
285 down_write(&pcmcia_socket_list_rwsem);
286 list_del(&socket->socket_list);
287 up_write(&pcmcia_socket_list_rwsem);
289 /* wait for sysfs to drop all references */
290 release_resource_db(socket);
291 wait_for_completion(&socket->socket_released);
292 } /* pcmcia_unregister_socket */
293 EXPORT_SYMBOL(pcmcia_unregister_socket);
296 struct pcmcia_socket * pcmcia_get_socket_by_nr(unsigned int nr)
298 struct pcmcia_socket *s;
300 down_read(&pcmcia_socket_list_rwsem);
301 list_for_each_entry(s, &pcmcia_socket_list, socket_list)
303 up_read(&pcmcia_socket_list_rwsem);
306 up_read(&pcmcia_socket_list_rwsem);
311 EXPORT_SYMBOL(pcmcia_get_socket_by_nr);
314 * The central event handler. Send_event() sends an event to the
315 * 16-bit subsystem, which then calls the relevant device drivers.
316 * Parse_events() interprets the event bits from
317 * a card status change report. Do_shutdown() handles the high
318 * priority stuff associated with a card removal.
321 /* NOTE: send_event needs to be called with skt->sem held. */
323 static int send_event(struct pcmcia_socket *s, event_t event, int priority)
327 if (s->state & SOCKET_CARDBUS)
330 cs_dbg(s, 1, "send_event(event %d, pri %d, callback 0x%p)\n",
331 event, priority, s->callback);
335 if (!try_module_get(s->callback->owner))
338 ret = s->callback->event(s, event, priority);
340 module_put(s->callback->owner);
345 static void socket_remove_drivers(struct pcmcia_socket *skt)
347 cs_dbg(skt, 4, "remove_drivers\n");
349 send_event(skt, CS_EVENT_CARD_REMOVAL, CS_EVENT_PRI_HIGH);
352 static int socket_reset(struct pcmcia_socket *skt)
356 cs_dbg(skt, 4, "reset\n");
358 skt->socket.flags |= SS_OUTPUT_ENA | SS_RESET;
359 skt->ops->set_socket(skt, &skt->socket);
360 udelay((long)reset_time);
362 skt->socket.flags &= ~SS_RESET;
363 skt->ops->set_socket(skt, &skt->socket);
365 msleep(unreset_delay * 10);
366 for (i = 0; i < unreset_limit; i++) {
367 skt->ops->get_status(skt, &status);
369 if (!(status & SS_DETECT))
372 if (status & SS_READY)
375 msleep(unreset_check * 10);
378 cs_err(skt, "time out after reset.\n");
379 return CS_GENERAL_FAILURE;
383 * socket_setup() and socket_shutdown() are called by the main event handler
384 * when card insertion and removal events are received.
385 * socket_setup() turns on socket power and resets the socket, in two stages.
386 * socket_shutdown() unconfigures a socket and turns off socket power.
388 static void socket_shutdown(struct pcmcia_socket *s)
392 cs_dbg(s, 4, "shutdown\n");
394 socket_remove_drivers(s);
395 s->state &= SOCKET_INUSE | SOCKET_PRESENT;
396 msleep(shutdown_delay * 10);
397 s->state &= SOCKET_INUSE;
399 /* Blank out the socket state */
400 s->socket = dead_socket;
402 s->ops->set_socket(s, &s->socket);
403 s->irq.AssignedIRQ = s->irq.Config = 0;
405 destroy_cis_cache(s);
406 #ifdef CONFIG_CARDBUS
411 /* give socket some time to power down */
414 s->ops->get_status(s, &status);
415 if (status & SS_POWERON) {
416 printk(KERN_ERR "PCMCIA: socket %p: *** DANGER *** unable to remove socket power\n", s);
422 static int socket_setup(struct pcmcia_socket *skt, int initial_delay)
426 cs_dbg(skt, 4, "setup\n");
428 skt->ops->get_status(skt, &status);
429 if (!(status & SS_DETECT))
432 msleep(initial_delay * 10);
434 for (i = 0; i < 100; i++) {
435 skt->ops->get_status(skt, &status);
436 if (!(status & SS_DETECT))
439 if (!(status & SS_PENDING))
445 if (status & SS_PENDING) {
446 cs_err(skt, "voltage interrogation timed out.\n");
447 return CS_GENERAL_FAILURE;
450 if (status & SS_CARDBUS) {
451 if (!(skt->features & SS_CAP_CARDBUS)) {
452 cs_err(skt, "cardbus cards are not supported.\n");
455 skt->state |= SOCKET_CARDBUS;
459 * Decode the card voltage requirements, and apply power to the card.
461 if (status & SS_3VCARD)
462 skt->socket.Vcc = skt->socket.Vpp = 33;
463 else if (!(status & SS_XVCARD))
464 skt->socket.Vcc = skt->socket.Vpp = 50;
466 cs_err(skt, "unsupported voltage key.\n");
471 skt->power_hook(skt, HOOK_POWER_PRE);
473 skt->socket.flags = 0;
474 skt->ops->set_socket(skt, &skt->socket);
477 * Wait "vcc_settle" for the supply to stabilise.
479 msleep(vcc_settle * 10);
481 skt->ops->get_status(skt, &status);
482 if (!(status & SS_POWERON)) {
483 cs_err(skt, "unable to apply power.\n");
487 status = socket_reset(skt);
490 skt->power_hook(skt, HOOK_POWER_POST);
496 * Handle card insertion. Setup the socket, reset the card,
497 * and then tell the rest of PCMCIA that a card is present.
499 static int socket_insert(struct pcmcia_socket *skt)
503 cs_dbg(skt, 4, "insert\n");
505 if (!cs_socket_get(skt))
508 ret = socket_setup(skt, setup_delay);
509 if (ret == CS_SUCCESS) {
510 skt->state |= SOCKET_PRESENT;
512 printk(KERN_NOTICE "pccard: %s card inserted into slot %d\n",
513 (skt->state & SOCKET_CARDBUS) ? "CardBus" : "PCMCIA",
516 #ifdef CONFIG_CARDBUS
517 if (skt->state & SOCKET_CARDBUS) {
519 skt->state |= SOCKET_CARDBUS_CONFIG;
522 cs_dbg(skt, 4, "insert done\n");
524 send_event(skt, CS_EVENT_CARD_INSERTION, CS_EVENT_PRI_LOW);
526 socket_shutdown(skt);
532 static int socket_suspend(struct pcmcia_socket *skt)
534 if (skt->state & SOCKET_SUSPEND)
537 send_event(skt, CS_EVENT_PM_SUSPEND, CS_EVENT_PRI_LOW);
538 skt->socket = dead_socket;
539 skt->ops->set_socket(skt, &skt->socket);
540 if (skt->ops->suspend)
541 skt->ops->suspend(skt);
542 skt->state |= SOCKET_SUSPEND;
548 * Resume a socket. If a card is present, verify its CIS against
549 * our cached copy. If they are different, the card has been
550 * replaced, and we need to tell the drivers.
552 static int socket_resume(struct pcmcia_socket *skt)
556 if (!(skt->state & SOCKET_SUSPEND))
559 skt->socket = dead_socket;
561 skt->ops->set_socket(skt, &skt->socket);
563 if (!(skt->state & SOCKET_PRESENT)) {
564 skt->state &= ~SOCKET_SUSPEND;
565 return socket_insert(skt);
568 ret = socket_setup(skt, resume_delay);
569 if (ret == CS_SUCCESS) {
571 * FIXME: need a better check here for cardbus cards.
573 if (verify_cis_cache(skt) != 0) {
574 cs_dbg(skt, 4, "cis mismatch - different card\n");
575 socket_remove_drivers(skt);
576 destroy_cis_cache(skt);
578 * Workaround: give DS time to schedule removal.
579 * Remove me once the 100ms delay is eliminated
583 send_event(skt, CS_EVENT_CARD_INSERTION, CS_EVENT_PRI_LOW);
585 cs_dbg(skt, 4, "cis matches cache\n");
586 send_event(skt, CS_EVENT_PM_RESUME, CS_EVENT_PRI_LOW);
589 socket_shutdown(skt);
592 skt->state &= ~SOCKET_SUSPEND;
597 static void socket_remove(struct pcmcia_socket *skt)
599 printk(KERN_NOTICE "pccard: card ejected from slot %d\n", skt->sock);
600 socket_shutdown(skt);
604 * Process a socket card detect status change.
606 * If we don't have a card already present, delay the detect event for
607 * about 20ms (to be on the safe side) before reading the socket status.
609 * Some i82365-based systems send multiple SS_DETECT events during card
610 * insertion, and the "card present" status bit seems to bounce. This
611 * will probably be true with GPIO-based card detection systems after
612 * the product has aged.
614 static void socket_detect_change(struct pcmcia_socket *skt)
616 if (!(skt->state & SOCKET_SUSPEND)) {
619 if (!(skt->state & SOCKET_PRESENT))
622 skt->ops->get_status(skt, &status);
623 if ((skt->state & SOCKET_PRESENT) &&
624 !(status & SS_DETECT))
626 if (!(skt->state & SOCKET_PRESENT) &&
627 (status & SS_DETECT))
632 static int pccardd(void *__skt)
634 struct pcmcia_socket *skt = __skt;
637 skt->thread = current;
638 skt->socket = dead_socket;
640 skt->ops->set_socket(skt, &skt->socket);
642 /* register with the device core */
643 ret = device_register(&skt->dev);
645 printk(KERN_WARNING "PCMCIA: unable to register socket 0x%p\n",
648 complete(&skt->thread_done);
651 ret = pccard_sysfs_add_socket(&skt->dev);
653 dev_warn(&skt->dev, "err %d adding socket attributes\n", ret);
655 complete(&skt->thread_done);
662 set_current_state(TASK_INTERRUPTIBLE);
664 spin_lock_irqsave(&skt->thread_lock, flags);
665 events = skt->thread_events;
666 skt->thread_events = 0;
667 spin_unlock_irqrestore(&skt->thread_lock, flags);
670 mutex_lock(&skt->skt_mutex);
671 if (events & SS_DETECT)
672 socket_detect_change(skt);
673 if (events & SS_BATDEAD)
674 send_event(skt, CS_EVENT_BATTERY_DEAD, CS_EVENT_PRI_LOW);
675 if (events & SS_BATWARN)
676 send_event(skt, CS_EVENT_BATTERY_LOW, CS_EVENT_PRI_LOW);
677 if (events & SS_READY)
678 send_event(skt, CS_EVENT_READY_CHANGE, CS_EVENT_PRI_LOW);
679 mutex_unlock(&skt->skt_mutex);
683 if (kthread_should_stop())
689 /* make sure we are running before we exit */
690 set_current_state(TASK_RUNNING);
692 /* remove from the device core */
693 pccard_sysfs_remove_socket(&skt->dev);
694 device_unregister(&skt->dev);
700 * Yenta (at least) probes interrupts before registering the socket and
701 * starting the handler thread.
703 void pcmcia_parse_events(struct pcmcia_socket *s, u_int events)
706 cs_dbg(s, 4, "parse_events: events %08x\n", events);
708 spin_lock_irqsave(&s->thread_lock, flags);
709 s->thread_events |= events;
710 spin_unlock_irqrestore(&s->thread_lock, flags);
712 wake_up_process(s->thread);
714 } /* pcmcia_parse_events */
715 EXPORT_SYMBOL(pcmcia_parse_events);
718 /* register pcmcia_callback */
719 int pccard_register_pcmcia(struct pcmcia_socket *s, struct pcmcia_callback *c)
723 /* s->skt_mutex also protects s->callback */
724 mutex_lock(&s->skt_mutex);
735 if ((s->state & (SOCKET_PRESENT|SOCKET_CARDBUS)) == SOCKET_PRESENT)
736 send_event(s, CS_EVENT_CARD_INSERTION, CS_EVENT_PRI_LOW);
740 mutex_unlock(&s->skt_mutex);
744 EXPORT_SYMBOL(pccard_register_pcmcia);
747 /* I'm not sure which "reset" function this is supposed to use,
748 * but for now, it uses the low-level interface's reset, not the
752 int pccard_reset_card(struct pcmcia_socket *skt)
756 cs_dbg(skt, 1, "resetting socket\n");
758 mutex_lock(&skt->skt_mutex);
760 if (!(skt->state & SOCKET_PRESENT)) {
764 if (skt->state & SOCKET_SUSPEND) {
768 if (skt->state & SOCKET_CARDBUS) {
769 ret = CS_UNSUPPORTED_FUNCTION;
773 ret = send_event(skt, CS_EVENT_RESET_REQUEST, CS_EVENT_PRI_LOW);
775 send_event(skt, CS_EVENT_RESET_PHYSICAL, CS_EVENT_PRI_LOW);
777 skt->callback->suspend(skt);
778 if (socket_reset(skt) == CS_SUCCESS) {
779 send_event(skt, CS_EVENT_CARD_RESET, CS_EVENT_PRI_LOW);
781 skt->callback->resume(skt);
787 mutex_unlock(&skt->skt_mutex);
791 EXPORT_SYMBOL(pccard_reset_card);
794 /* These shut down or wake up a socket. They are sort of user
795 * initiated versions of the APM suspend and resume actions.
797 int pcmcia_suspend_card(struct pcmcia_socket *skt)
801 cs_dbg(skt, 1, "suspending socket\n");
803 mutex_lock(&skt->skt_mutex);
805 if (!(skt->state & SOCKET_PRESENT)) {
809 if (skt->state & SOCKET_CARDBUS) {
810 ret = CS_UNSUPPORTED_FUNCTION;
814 ret = skt->callback->suspend(skt);
818 ret = socket_suspend(skt);
820 mutex_unlock(&skt->skt_mutex);
824 EXPORT_SYMBOL(pcmcia_suspend_card);
827 int pcmcia_resume_card(struct pcmcia_socket *skt)
831 cs_dbg(skt, 1, "waking up socket\n");
833 mutex_lock(&skt->skt_mutex);
835 if (!(skt->state & SOCKET_PRESENT)) {
839 if (skt->state & SOCKET_CARDBUS) {
840 ret = CS_UNSUPPORTED_FUNCTION;
843 ret = socket_resume(skt);
844 if (!ret && skt->callback)
845 skt->callback->resume(skt);
847 mutex_unlock(&skt->skt_mutex);
851 EXPORT_SYMBOL(pcmcia_resume_card);
854 /* These handle user requests to eject or insert a card. */
855 int pcmcia_eject_card(struct pcmcia_socket *skt)
859 cs_dbg(skt, 1, "user eject request\n");
861 mutex_lock(&skt->skt_mutex);
863 if (!(skt->state & SOCKET_PRESENT)) {
868 ret = send_event(skt, CS_EVENT_EJECTION_REQUEST, CS_EVENT_PRI_LOW);
877 mutex_unlock(&skt->skt_mutex);
881 EXPORT_SYMBOL(pcmcia_eject_card);
884 int pcmcia_insert_card(struct pcmcia_socket *skt)
888 cs_dbg(skt, 1, "user insert request\n");
890 mutex_lock(&skt->skt_mutex);
892 if (skt->state & SOCKET_PRESENT) {
896 if (socket_insert(skt) == CS_NO_CARD) {
902 mutex_unlock(&skt->skt_mutex);
906 EXPORT_SYMBOL(pcmcia_insert_card);
909 static int pcmcia_socket_uevent(struct device *dev,
910 struct kobj_uevent_env *env)
912 struct pcmcia_socket *s = container_of(dev, struct pcmcia_socket, dev);
914 if (add_uevent_var(env, "SOCKET_NO=%u", s->sock))
921 static struct completion pcmcia_unload;
923 static void pcmcia_release_socket_class(struct class *data)
925 complete(&pcmcia_unload);
929 struct class pcmcia_socket_class = {
930 .name = "pcmcia_socket",
931 .dev_uevent = pcmcia_socket_uevent,
932 .dev_release = pcmcia_release_socket,
933 .class_release = pcmcia_release_socket_class,
935 EXPORT_SYMBOL(pcmcia_socket_class);
938 static int __init init_pcmcia_cs(void)
940 init_completion(&pcmcia_unload);
941 return class_register(&pcmcia_socket_class);
944 static void __exit exit_pcmcia_cs(void)
946 class_unregister(&pcmcia_socket_class);
947 wait_for_completion(&pcmcia_unload);
950 subsys_initcall(init_pcmcia_cs);
951 module_exit(exit_pcmcia_cs);