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/config.h>
20 #include <linux/string.h>
21 #include <linux/major.h>
22 #include <linux/errno.h>
23 #include <linux/slab.h>
25 #include <linux/interrupt.h>
26 #include <linux/timer.h>
27 #include <linux/ioport.h>
28 #include <linux/delay.h>
30 #include <linux/pci.h>
31 #include <linux/device.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/bulkmem.h>
40 #include <pcmcia/cistpl.h>
41 #include <pcmcia/cisreg.h>
42 #include <pcmcia/ds.h>
43 #include "cs_internal.h"
46 /* Module parameters */
48 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
49 MODULE_DESCRIPTION("Linux Kernel Card Services");
50 MODULE_LICENSE("GPL");
52 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0444)
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 */
63 /* Access speed for attribute memory windows */
64 INT_MODULE_PARM(cis_speed, 300); /* ns */
69 module_param(pc_debug, int, 0644);
71 int cs_debug_level(int level)
73 return pc_debug > level;
78 socket_state_t dead_socket = {
79 .csc_mask = SS_DETECT,
81 EXPORT_SYMBOL(dead_socket);
84 /* List of all sockets, protected by a rwsem */
85 LIST_HEAD(pcmcia_socket_list);
86 EXPORT_SYMBOL(pcmcia_socket_list);
88 DECLARE_RWSEM(pcmcia_socket_list_rwsem);
89 EXPORT_SYMBOL(pcmcia_socket_list_rwsem);
93 * Low-level PCMCIA socket drivers need to register with the PCCard
94 * core using pcmcia_register_socket.
96 * socket drivers are expected to use the following callbacks in their
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
103 static int socket_resume(struct pcmcia_socket *skt);
104 static int socket_suspend(struct pcmcia_socket *skt);
106 int pcmcia_socket_dev_suspend(struct device *dev, pm_message_t state)
108 struct pcmcia_socket *socket;
110 down_read(&pcmcia_socket_list_rwsem);
111 list_for_each_entry(socket, &pcmcia_socket_list, socket_list) {
112 if (socket->dev.dev != dev)
114 down(&socket->skt_sem);
115 socket_suspend(socket);
116 up(&socket->skt_sem);
118 up_read(&pcmcia_socket_list_rwsem);
122 EXPORT_SYMBOL(pcmcia_socket_dev_suspend);
124 int pcmcia_socket_dev_resume(struct device *dev)
126 struct pcmcia_socket *socket;
128 down_read(&pcmcia_socket_list_rwsem);
129 list_for_each_entry(socket, &pcmcia_socket_list, socket_list) {
130 if (socket->dev.dev != dev)
132 down(&socket->skt_sem);
133 socket_resume(socket);
134 up(&socket->skt_sem);
136 up_read(&pcmcia_socket_list_rwsem);
140 EXPORT_SYMBOL(pcmcia_socket_dev_resume);
143 struct pcmcia_socket * pcmcia_get_socket(struct pcmcia_socket *skt)
145 struct class_device *cl_dev = class_device_get(&skt->dev);
148 skt = class_get_devdata(cl_dev);
149 if (!try_module_get(skt->owner)) {
150 class_device_put(&skt->dev);
155 EXPORT_SYMBOL(pcmcia_get_socket);
158 void pcmcia_put_socket(struct pcmcia_socket *skt)
160 module_put(skt->owner);
161 class_device_put(&skt->dev);
163 EXPORT_SYMBOL(pcmcia_put_socket);
166 static void pcmcia_release_socket(struct class_device *class_dev)
168 struct pcmcia_socket *socket = class_get_devdata(class_dev);
170 complete(&socket->socket_released);
173 static int pccardd(void *__skt);
176 * pcmcia_register_socket - add a new pcmcia socket device
178 int pcmcia_register_socket(struct pcmcia_socket *socket)
182 if (!socket || !socket->ops || !socket->dev.dev || !socket->resource_ops)
185 cs_dbg(socket, 0, "pcmcia_register_socket(0x%p)\n", socket->ops);
187 spin_lock_init(&socket->lock);
189 if (socket->resource_ops->init) {
190 ret = socket->resource_ops->init(socket);
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))
203 unsigned int found, i = 1;
204 struct pcmcia_socket *tmp;
207 list_for_each_entry(tmp, &pcmcia_socket_list, socket_list) {
213 socket->sock = i - 1;
215 list_add_tail(&socket->socket_list, &pcmcia_socket_list);
216 up_write(&pcmcia_socket_list_rwsem);
218 #ifndef CONFIG_CARDBUS
220 * If we do not support Cardbus, ensure that
221 * the Cardbus socket capability is disabled.
223 socket->features &= ~SS_CAP_CARDBUS;
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);
231 /* base address = 0, map = 0 */
232 socket->cis_mem.flags = 0;
233 socket->cis_mem.speed = cis_speed;
235 INIT_LIST_HEAD(&socket->cis_cache);
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);
243 ret = kernel_thread(pccardd, socket, CLONE_KERNEL);
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);
252 pcmcia_parse_events(socket, SS_DETECT);
257 down_write(&pcmcia_socket_list_rwsem);
258 list_del(&socket->socket_list);
259 up_write(&pcmcia_socket_list_rwsem);
261 } /* pcmcia_register_socket */
262 EXPORT_SYMBOL(pcmcia_register_socket);
266 * pcmcia_unregister_socket - remove a pcmcia socket device
268 void pcmcia_unregister_socket(struct pcmcia_socket *socket)
273 cs_dbg(socket, 0, "pcmcia_unregister_socket(0x%p)\n", socket->ops);
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);
281 release_cis_mem(socket);
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);
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);
295 struct pcmcia_socket * pcmcia_get_socket_by_nr(unsigned int nr)
297 struct pcmcia_socket *s;
299 down_read(&pcmcia_socket_list_rwsem);
300 list_for_each_entry(s, &pcmcia_socket_list, socket_list)
302 up_read(&pcmcia_socket_list_rwsem);
305 up_read(&pcmcia_socket_list_rwsem);
310 EXPORT_SYMBOL(pcmcia_get_socket_by_nr);
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.
319 static void shutdown_socket(struct pcmcia_socket *s)
321 cs_dbg(s, 1, "shutdown_socket\n");
323 /* Blank out the socket state */
324 s->socket = dead_socket;
326 s->ops->set_socket(s, &s->socket);
327 s->irq.AssignedIRQ = s->irq.Config = 0;
329 destroy_cis_cache(s);
330 #ifdef CONFIG_CARDBUS
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);
346 } /* shutdown_socket */
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.
357 /* NOTE: send_event needs to be called with skt->sem held. */
359 static int send_event(struct pcmcia_socket *s, event_t event, int priority)
363 if (s->state & SOCKET_CARDBUS)
366 cs_dbg(s, 1, "send_event(event %d, pri %d, callback 0x%p)\n",
367 event, priority, s->callback);
371 if (!try_module_get(s->callback->owner))
374 ret = s->callback->event(s, event, priority);
376 module_put(s->callback->owner);
381 static void socket_remove_drivers(struct pcmcia_socket *skt)
383 cs_dbg(skt, 4, "remove_drivers\n");
385 send_event(skt, CS_EVENT_CARD_REMOVAL, CS_EVENT_PRI_HIGH);
388 static void socket_shutdown(struct pcmcia_socket *skt)
390 cs_dbg(skt, 4, "shutdown\n");
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);
399 static int socket_reset(struct pcmcia_socket *skt)
403 cs_dbg(skt, 4, "reset\n");
405 skt->socket.flags |= SS_OUTPUT_ENA | SS_RESET;
406 skt->ops->set_socket(skt, &skt->socket);
407 udelay((long)reset_time);
409 skt->socket.flags &= ~SS_RESET;
410 skt->ops->set_socket(skt, &skt->socket);
412 msleep(unreset_delay * 10);
413 for (i = 0; i < unreset_limit; i++) {
414 skt->ops->get_status(skt, &status);
416 if (!(status & SS_DETECT))
419 if (status & SS_READY)
422 msleep(unreset_check * 10);
425 cs_err(skt, "time out after reset.\n");
426 return CS_GENERAL_FAILURE;
429 static int socket_setup(struct pcmcia_socket *skt, int initial_delay)
433 cs_dbg(skt, 4, "setup\n");
435 skt->ops->get_status(skt, &status);
436 if (!(status & SS_DETECT))
439 msleep(initial_delay * 10);
441 for (i = 0; i < 100; i++) {
442 skt->ops->get_status(skt, &status);
443 if (!(status & SS_DETECT))
446 if (!(status & SS_PENDING))
452 if (status & SS_PENDING) {
453 cs_err(skt, "voltage interrogation timed out.\n");
454 return CS_GENERAL_FAILURE;
457 if (status & SS_CARDBUS) {
458 if (!(skt->features & SS_CAP_CARDBUS)) {
459 cs_err(skt, "cardbus cards are not supported.\n");
462 skt->state |= SOCKET_CARDBUS;
466 * Decode the card voltage requirements, and apply power to the card.
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;
473 cs_err(skt, "unsupported voltage key.\n");
478 skt->power_hook(skt, HOOK_POWER_PRE);
480 skt->socket.flags = 0;
481 skt->ops->set_socket(skt, &skt->socket);
484 * Wait "vcc_settle" for the supply to stabilise.
486 msleep(vcc_settle * 10);
488 skt->ops->get_status(skt, &status);
489 if (!(status & SS_POWERON)) {
490 cs_err(skt, "unable to apply power.\n");
494 status = socket_reset(skt);
497 skt->power_hook(skt, HOOK_POWER_POST);
503 * Handle card insertion. Setup the socket, reset the card,
504 * and then tell the rest of PCMCIA that a card is present.
506 static int socket_insert(struct pcmcia_socket *skt)
510 cs_dbg(skt, 4, "insert\n");
512 if (!cs_socket_get(skt))
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) {
521 skt->state |= SOCKET_CARDBUS_CONFIG;
524 cs_dbg(skt, 4, "insert done\n");
526 send_event(skt, CS_EVENT_CARD_INSERTION, CS_EVENT_PRI_LOW);
528 socket_shutdown(skt);
535 static int socket_suspend(struct pcmcia_socket *skt)
537 if (skt->state & SOCKET_SUSPEND)
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;
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.
555 static int socket_resume(struct pcmcia_socket *skt)
559 if (!(skt->state & SOCKET_SUSPEND))
562 skt->socket = dead_socket;
564 skt->ops->set_socket(skt, &skt->socket);
566 if (!(skt->state & SOCKET_PRESENT)) {
567 skt->state &= ~SOCKET_SUSPEND;
568 return socket_insert(skt);
571 ret = socket_setup(skt, resume_delay);
572 if (ret == CS_SUCCESS) {
574 * FIXME: need a better check here for cardbus cards.
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);
581 * Workaround: give DS time to schedule removal.
582 * Remove me once the 100ms delay is eliminated
586 send_event(skt, CS_EVENT_CARD_INSERTION, CS_EVENT_PRI_LOW);
588 cs_dbg(skt, 4, "cis matches cache\n");
589 send_event(skt, CS_EVENT_PM_RESUME, CS_EVENT_PRI_LOW);
592 socket_shutdown(skt);
596 skt->state &= ~SOCKET_SUSPEND;
601 static void socket_remove(struct pcmcia_socket *skt)
603 socket_shutdown(skt);
608 * Process a socket card detect status change.
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.
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.
618 static void socket_detect_change(struct pcmcia_socket *skt)
620 if (!(skt->state & SOCKET_SUSPEND)) {
623 if (!(skt->state & SOCKET_PRESENT))
626 skt->ops->get_status(skt, &status);
627 if ((skt->state & SOCKET_PRESENT) &&
628 !(status & SS_DETECT))
630 if (!(skt->state & SOCKET_PRESENT) &&
631 (status & SS_DETECT))
636 static int pccardd(void *__skt)
638 struct pcmcia_socket *skt = __skt;
639 DECLARE_WAITQUEUE(wait, current);
642 daemonize("pccardd");
644 skt->thread = current;
645 skt->socket = dead_socket;
647 skt->ops->set_socket(skt, &skt->socket);
649 /* register with the device core */
650 ret = class_device_register(&skt->dev);
652 printk(KERN_WARNING "PCMCIA: unable to register socket 0x%p\n",
655 complete_and_exit(&skt->thread_done, 0);
657 complete(&skt->thread_done);
659 add_wait_queue(&skt->thread_wait, &wait);
664 set_current_state(TASK_INTERRUPTIBLE);
666 spin_lock_irqsave(&skt->thread_lock, flags);
667 events = skt->thread_events;
668 skt->thread_events = 0;
669 spin_unlock_irqrestore(&skt->thread_lock, flags);
673 if (events & SS_DETECT)
674 socket_detect_change(skt);
675 if (events & SS_BATDEAD)
676 send_event(skt, CS_EVENT_BATTERY_DEAD, CS_EVENT_PRI_LOW);
677 if (events & SS_BATWARN)
678 send_event(skt, CS_EVENT_BATTERY_LOW, CS_EVENT_PRI_LOW);
679 if (events & SS_READY)
680 send_event(skt, CS_EVENT_READY_CHANGE, CS_EVENT_PRI_LOW);
691 remove_wait_queue(&skt->thread_wait, &wait);
693 /* remove from the device core */
694 class_device_unregister(&skt->dev);
696 complete_and_exit(&skt->thread_done, 0);
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)
705 cs_dbg(s, 4, "parse_events: events %08x\n", events);
707 spin_lock(&s->thread_lock);
708 s->thread_events |= events;
709 spin_unlock(&s->thread_lock);
711 wake_up(&s->thread_wait);
713 } /* pcmcia_parse_events */
714 EXPORT_SYMBOL(pcmcia_parse_events);
717 /* register pcmcia_callback */
718 int pccard_register_pcmcia(struct pcmcia_socket *s, struct pcmcia_callback *c)
722 /* s->skt_sem also protects s->callback */
734 if ((s->state & (SOCKET_PRESENT|SOCKET_CARDBUS)) == SOCKET_PRESENT)
735 send_event(s, CS_EVENT_CARD_INSERTION, CS_EVENT_PRI_LOW);
743 EXPORT_SYMBOL(pccard_register_pcmcia);
746 /* I'm not sure which "reset" function this is supposed to use,
747 * but for now, it uses the low-level interface's reset, not the
751 int pccard_reset_card(struct pcmcia_socket *skt)
755 cs_dbg(skt, 1, "resetting socket\n");
759 if (!(skt->state & SOCKET_PRESENT)) {
763 if (skt->state & SOCKET_SUSPEND) {
767 if (skt->state & SOCKET_CARDBUS) {
768 ret = CS_UNSUPPORTED_FUNCTION;
772 ret = send_event(skt, CS_EVENT_RESET_REQUEST, CS_EVENT_PRI_LOW);
774 send_event(skt, CS_EVENT_RESET_PHYSICAL, CS_EVENT_PRI_LOW);
775 if (socket_reset(skt) == CS_SUCCESS)
776 send_event(skt, CS_EVENT_CARD_RESET, CS_EVENT_PRI_LOW);
785 EXPORT_SYMBOL(pccard_reset_card);
788 /* These shut down or wake up a socket. They are sort of user
789 * initiated versions of the APM suspend and resume actions.
791 int pcmcia_suspend_card(struct pcmcia_socket *skt)
795 cs_dbg(skt, 1, "suspending socket\n");
799 if (!(skt->state & SOCKET_PRESENT)) {
803 if (skt->state & SOCKET_CARDBUS) {
804 ret = CS_UNSUPPORTED_FUNCTION;
807 ret = socket_suspend(skt);
813 EXPORT_SYMBOL(pcmcia_suspend_card);
816 int pcmcia_resume_card(struct pcmcia_socket *skt)
820 cs_dbg(skt, 1, "waking up socket\n");
824 if (!(skt->state & SOCKET_PRESENT)) {
828 if (skt->state & SOCKET_CARDBUS) {
829 ret = CS_UNSUPPORTED_FUNCTION;
832 ret = socket_resume(skt);
838 EXPORT_SYMBOL(pcmcia_resume_card);
841 /* These handle user requests to eject or insert a card. */
842 int pcmcia_eject_card(struct pcmcia_socket *skt)
846 cs_dbg(skt, 1, "user eject request\n");
850 if (!(skt->state & SOCKET_PRESENT)) {
855 ret = send_event(skt, CS_EVENT_EJECTION_REQUEST, CS_EVENT_PRI_LOW);
868 EXPORT_SYMBOL(pcmcia_eject_card);
871 int pcmcia_insert_card(struct pcmcia_socket *skt)
875 cs_dbg(skt, 1, "user insert request\n");
879 if (skt->state & SOCKET_PRESENT) {
883 if (socket_insert(skt) == CS_NO_CARD) {
893 EXPORT_SYMBOL(pcmcia_insert_card);
896 static int pcmcia_socket_hotplug(struct class_device *dev, char **envp,
897 int num_envp, char *buffer, int buffer_size)
899 struct pcmcia_socket *s = container_of(dev, struct pcmcia_socket, dev);
900 int i = 0, length = 0;
902 if (add_hotplug_env_var(envp, num_envp, &i, buffer, buffer_size,
903 &length, "SOCKET_NO=%u", s->sock))
912 static struct completion pcmcia_unload;
914 static void pcmcia_release_socket_class(struct class *data)
916 complete(&pcmcia_unload);
920 struct class pcmcia_socket_class = {
921 .name = "pcmcia_socket",
922 .hotplug = pcmcia_socket_hotplug,
923 .release = pcmcia_release_socket,
924 .class_release = pcmcia_release_socket_class,
926 EXPORT_SYMBOL(pcmcia_socket_class);
929 static int __init init_pcmcia_cs(void)
933 init_completion(&pcmcia_unload);
934 ret = class_register(&pcmcia_socket_class);
937 return class_interface_register(&pccard_sysfs_interface);
940 static void __exit exit_pcmcia_cs(void)
942 class_interface_unregister(&pccard_sysfs_interface);
943 class_unregister(&pcmcia_socket_class);
945 wait_for_completion(&pcmcia_unload);
948 subsys_initcall(init_pcmcia_cs);
949 module_exit(exit_pcmcia_cs);