2 * ds.c -- 16-bit PCMCIA core support
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
13 * (C) 2003 - 2006 Dominik Brodowski
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/init.h>
19 #include <linux/errno.h>
20 #include <linux/list.h>
21 #include <linux/delay.h>
22 #include <linux/workqueue.h>
23 #include <linux/crc32.h>
24 #include <linux/firmware.h>
25 #include <linux/kref.h>
26 #include <linux/dma-mapping.h>
28 #include <pcmcia/cs_types.h>
29 #include <pcmcia/cs.h>
30 #include <pcmcia/cistpl.h>
31 #include <pcmcia/ds.h>
32 #include <pcmcia/ss.h>
34 #include "cs_internal.h"
35 #include "ds_internal.h"
37 /*====================================================================*/
39 /* Module parameters */
41 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
42 MODULE_DESCRIPTION("PCMCIA Driver Services");
43 MODULE_LICENSE("GPL");
45 #ifdef CONFIG_PCMCIA_DEBUG
48 module_param_named(pc_debug, ds_pc_debug, int, 0644);
50 #define ds_dbg(lvl, fmt, arg...) do { \
51 if (ds_pc_debug > (lvl)) \
52 printk(KERN_DEBUG "ds: " fmt , ## arg); \
54 #define ds_dev_dbg(lvl, dev, fmt, arg...) do { \
55 if (ds_pc_debug > (lvl)) \
56 dev_printk(KERN_DEBUG, dev, "ds: " fmt , ## arg); \
59 #define ds_dbg(lvl, fmt, arg...) do { } while (0)
60 #define ds_dev_dbg(lvl, dev, fmt, arg...) do { } while (0)
63 spinlock_t pcmcia_dev_list_lock;
65 /*====================================================================*/
67 /* code which was in cs.c before */
69 /* String tables for error messages */
71 typedef struct lookup_t {
76 static const lookup_t error_table[] = {
77 { 0, "Operation succeeded" },
78 { -EIO, "Input/Output error" },
79 { -ENODEV, "No card present" },
80 { -EINVAL, "Bad parameter" },
81 { -EACCES, "Configuration locked" },
82 { -EBUSY, "Resource in use" },
83 { -ENOSPC, "No more items" },
84 { -ENOMEM, "Out of resource" },
85 { CS_BAD_TUPLE, "Bad CIS tuple" }
89 static const lookup_t service_table[] = {
90 { AccessConfigurationRegister, "AccessConfigurationRegister" },
91 { AddSocketServices, "AddSocketServices" },
92 { AdjustResourceInfo, "AdjustResourceInfo" },
93 { CheckEraseQueue, "CheckEraseQueue" },
94 { CloseMemory, "CloseMemory" },
95 { DeregisterClient, "DeregisterClient" },
96 { DeregisterEraseQueue, "DeregisterEraseQueue" },
97 { GetCardServicesInfo, "GetCardServicesInfo" },
98 { GetClientInfo, "GetClientInfo" },
99 { GetConfigurationInfo, "GetConfigurationInfo" },
100 { GetEventMask, "GetEventMask" },
101 { GetFirstClient, "GetFirstClient" },
102 { GetFirstRegion, "GetFirstRegion" },
103 { GetFirstTuple, "GetFirstTuple" },
104 { GetNextClient, "GetNextClient" },
105 { GetNextRegion, "GetNextRegion" },
106 { GetNextTuple, "GetNextTuple" },
107 { GetStatus, "GetStatus" },
108 { GetTupleData, "GetTupleData" },
109 { MapMemPage, "MapMemPage" },
110 { ModifyConfiguration, "ModifyConfiguration" },
111 { ModifyWindow, "ModifyWindow" },
112 { OpenMemory, "OpenMemory" },
113 { ParseTuple, "ParseTuple" },
114 { ReadMemory, "ReadMemory" },
115 { RegisterClient, "RegisterClient" },
116 { RegisterEraseQueue, "RegisterEraseQueue" },
117 { RegisterMTD, "RegisterMTD" },
118 { ReleaseConfiguration, "ReleaseConfiguration" },
119 { ReleaseIO, "ReleaseIO" },
120 { ReleaseIRQ, "ReleaseIRQ" },
121 { ReleaseWindow, "ReleaseWindow" },
122 { RequestConfiguration, "RequestConfiguration" },
123 { RequestIO, "RequestIO" },
124 { RequestIRQ, "RequestIRQ" },
125 { RequestSocketMask, "RequestSocketMask" },
126 { RequestWindow, "RequestWindow" },
127 { ResetCard, "ResetCard" },
128 { SetEventMask, "SetEventMask" },
129 { ValidateCIS, "ValidateCIS" },
130 { WriteMemory, "WriteMemory" },
131 { BindDevice, "BindDevice" },
132 { BindMTD, "BindMTD" },
133 { ReportError, "ReportError" },
134 { SuspendCard, "SuspendCard" },
135 { ResumeCard, "ResumeCard" },
136 { EjectCard, "EjectCard" },
137 { InsertCard, "InsertCard" },
138 { ReplaceCIS, "ReplaceCIS" }
142 static int pcmcia_report_error(struct pcmcia_device *p_dev, error_info_t *err)
150 printk(KERN_NOTICE "%s: ", p_dev->dev.bus_id);
152 for (i = 0; i < ARRAY_SIZE(service_table); i++)
153 if (service_table[i].key == err->func)
155 if (i < ARRAY_SIZE(service_table))
156 serv = service_table[i].msg;
158 serv = "Unknown service number";
160 for (i = 0; i < ARRAY_SIZE(error_table); i++)
161 if (error_table[i].key == err->retcode)
163 if (i < ARRAY_SIZE(error_table))
164 printk("%s: %s\n", serv, error_table[i].msg);
166 printk("%s: Unknown error code %#x\n", serv, err->retcode);
171 /* end of code which was in cs.c before */
173 /*======================================================================*/
175 void cs_error(struct pcmcia_device *p_dev, int func, int ret)
177 error_info_t err = { func, ret };
178 pcmcia_report_error(p_dev, &err);
180 EXPORT_SYMBOL(cs_error);
183 static void pcmcia_check_driver(struct pcmcia_driver *p_drv)
185 struct pcmcia_device_id *did = p_drv->id_table;
189 if (!p_drv->probe || !p_drv->remove)
190 printk(KERN_DEBUG "pcmcia: %s lacks a requisite callback "
191 "function\n", p_drv->drv.name);
193 while (did && did->match_flags) {
194 for (i=0; i<4; i++) {
195 if (!did->prod_id[i])
198 hash = crc32(0, did->prod_id[i], strlen(did->prod_id[i]));
199 if (hash == did->prod_id_hash[i])
202 printk(KERN_DEBUG "pcmcia: %s: invalid hash for "
203 "product string \"%s\": is 0x%x, should "
204 "be 0x%x\n", p_drv->drv.name, did->prod_id[i],
205 did->prod_id_hash[i], hash);
206 printk(KERN_DEBUG "pcmcia: see "
207 "Documentation/pcmcia/devicetable.txt for "
217 /*======================================================================*/
220 struct pcmcia_dynid {
221 struct list_head node;
222 struct pcmcia_device_id id;
226 * pcmcia_store_new_id - add a new PCMCIA device ID to this driver and re-probe devices
227 * @driver: target device driver
228 * @buf: buffer for scanning device ID data
231 * Adds a new dynamic PCMCIA device ID to this driver,
232 * and causes the driver to probe for all devices again.
235 pcmcia_store_new_id(struct device_driver *driver, const char *buf, size_t count)
237 struct pcmcia_dynid *dynid;
238 struct pcmcia_driver *pdrv = to_pcmcia_drv(driver);
239 __u16 match_flags, manf_id, card_id;
240 __u8 func_id, function, device_no;
241 __u32 prod_id_hash[4] = {0, 0, 0, 0};
245 fields = sscanf(buf, "%hx %hx %hx %hhx %hhx %hhx %x %x %x %x",
246 &match_flags, &manf_id, &card_id, &func_id, &function, &device_no,
247 &prod_id_hash[0], &prod_id_hash[1], &prod_id_hash[2], &prod_id_hash[3]);
251 dynid = kzalloc(sizeof(struct pcmcia_dynid), GFP_KERNEL);
255 INIT_LIST_HEAD(&dynid->node);
256 dynid->id.match_flags = match_flags;
257 dynid->id.manf_id = manf_id;
258 dynid->id.card_id = card_id;
259 dynid->id.func_id = func_id;
260 dynid->id.function = function;
261 dynid->id.device_no = device_no;
262 memcpy(dynid->id.prod_id_hash, prod_id_hash, sizeof(__u32) * 4);
264 spin_lock(&pdrv->dynids.lock);
265 list_add_tail(&pdrv->dynids.list, &dynid->node);
266 spin_unlock(&pdrv->dynids.lock);
268 if (get_driver(&pdrv->drv)) {
269 retval = driver_attach(&pdrv->drv);
270 put_driver(&pdrv->drv);
277 static DRIVER_ATTR(new_id, S_IWUSR, NULL, pcmcia_store_new_id);
280 pcmcia_free_dynids(struct pcmcia_driver *drv)
282 struct pcmcia_dynid *dynid, *n;
284 spin_lock(&drv->dynids.lock);
285 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
286 list_del(&dynid->node);
289 spin_unlock(&drv->dynids.lock);
293 pcmcia_create_newid_file(struct pcmcia_driver *drv)
296 if (drv->probe != NULL)
297 error = driver_create_file(&drv->drv, &driver_attr_new_id);
303 * pcmcia_register_driver - register a PCMCIA driver with the bus core
304 * @driver: the &driver being registered
306 * Registers a PCMCIA driver with the PCMCIA bus core.
308 int pcmcia_register_driver(struct pcmcia_driver *driver)
315 pcmcia_check_driver(driver);
317 /* initialize common fields */
318 driver->drv.bus = &pcmcia_bus_type;
319 driver->drv.owner = driver->owner;
320 spin_lock_init(&driver->dynids.lock);
321 INIT_LIST_HEAD(&driver->dynids.list);
323 ds_dbg(3, "registering driver %s\n", driver->drv.name);
325 error = driver_register(&driver->drv);
329 error = pcmcia_create_newid_file(driver);
331 driver_unregister(&driver->drv);
335 EXPORT_SYMBOL(pcmcia_register_driver);
338 * pcmcia_unregister_driver - unregister a PCMCIA driver with the bus core
339 * @driver: the &driver being unregistered
341 void pcmcia_unregister_driver(struct pcmcia_driver *driver)
343 ds_dbg(3, "unregistering driver %s\n", driver->drv.name);
344 driver_unregister(&driver->drv);
345 pcmcia_free_dynids(driver);
347 EXPORT_SYMBOL(pcmcia_unregister_driver);
350 /* pcmcia_device handling */
352 struct pcmcia_device * pcmcia_get_dev(struct pcmcia_device *p_dev)
354 struct device *tmp_dev;
355 tmp_dev = get_device(&p_dev->dev);
358 return to_pcmcia_dev(tmp_dev);
361 void pcmcia_put_dev(struct pcmcia_device *p_dev)
364 put_device(&p_dev->dev);
367 static void pcmcia_release_function(struct kref *ref)
369 struct config_t *c = container_of(ref, struct config_t, ref);
370 ds_dbg(1, "releasing config_t\n");
374 static void pcmcia_release_dev(struct device *dev)
376 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
377 ds_dev_dbg(1, dev, "releasing device\n");
378 pcmcia_put_socket(p_dev->socket);
379 kfree(p_dev->devname);
380 kref_put(&p_dev->function_config->ref, pcmcia_release_function);
384 static void pcmcia_add_device_later(struct pcmcia_socket *s, int mfc)
386 if (!s->pcmcia_state.device_add_pending) {
387 ds_dev_dbg(1, &s->dev, "scheduling to add %s secondary"
388 " device to %d\n", mfc ? "mfc" : "pfc", s->sock);
389 s->pcmcia_state.device_add_pending = 1;
390 s->pcmcia_state.mfc_pfc = mfc;
391 schedule_work(&s->device_add);
396 static int pcmcia_device_probe(struct device * dev)
398 struct pcmcia_device *p_dev;
399 struct pcmcia_driver *p_drv;
400 struct pcmcia_device_id *did;
401 struct pcmcia_socket *s;
402 cistpl_config_t cis_config;
405 dev = get_device(dev);
409 p_dev = to_pcmcia_dev(dev);
410 p_drv = to_pcmcia_drv(dev->driver);
413 ds_dev_dbg(1, dev, "trying to bind to %s\n", p_drv->drv.name);
415 if ((!p_drv->probe) || (!p_dev->function_config) ||
416 (!try_module_get(p_drv->owner))) {
421 /* set up some more device information */
422 ret = pccard_read_tuple(p_dev->socket, p_dev->func, CISTPL_CONFIG,
425 p_dev->conf.ConfigBase = cis_config.base;
426 p_dev->conf.Present = cis_config.rmask[0];
428 dev_printk(KERN_INFO, dev,
429 "pcmcia: could not parse base and rmask0 of CIS\n");
430 p_dev->conf.ConfigBase = 0;
431 p_dev->conf.Present = 0;
434 ret = p_drv->probe(p_dev);
436 ds_dev_dbg(1, dev, "binding to %s failed with %d\n",
437 p_drv->drv.name, ret);
441 /* handle pseudo multifunction devices:
442 * there are at most two pseudo multifunction devices.
443 * if we're matching against the first, schedule a
444 * call which will then check whether there are two
445 * pseudo devices, and if not, add the second one.
447 did = p_dev->dev.driver_data;
448 if (did && (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) &&
449 (p_dev->socket->device_count == 1) && (p_dev->device_no == 0))
450 pcmcia_add_device_later(p_dev->socket, 0);
454 module_put(p_drv->owner);
463 * Removes a PCMCIA card from the device tree and socket list.
465 static void pcmcia_card_remove(struct pcmcia_socket *s, struct pcmcia_device *leftover)
467 struct pcmcia_device *p_dev;
468 struct pcmcia_device *tmp;
471 ds_dev_dbg(2, leftover ? &leftover->dev : &s->dev,
472 "pcmcia_card_remove(%d) %s\n", s->sock,
473 leftover ? leftover->devname : "");
480 /* unregister all pcmcia_devices registered with this socket, except leftover */
481 list_for_each_entry_safe(p_dev, tmp, &s->devices_list, socket_device_list) {
482 if (p_dev == leftover)
485 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
486 list_del(&p_dev->socket_device_list);
488 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
490 ds_dev_dbg(2, &p_dev->dev, "unregistering device\n");
491 device_unregister(&p_dev->dev);
497 static int pcmcia_device_remove(struct device * dev)
499 struct pcmcia_device *p_dev;
500 struct pcmcia_driver *p_drv;
501 struct pcmcia_device_id *did;
504 p_dev = to_pcmcia_dev(dev);
505 p_drv = to_pcmcia_drv(dev->driver);
507 ds_dev_dbg(1, dev, "removing device\n");
509 /* If we're removing the primary module driving a
510 * pseudo multi-function card, we need to unbind
513 did = p_dev->dev.driver_data;
514 if (did && (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) &&
515 (p_dev->socket->device_count != 0) &&
516 (p_dev->device_no == 0))
517 pcmcia_card_remove(p_dev->socket, p_dev);
519 /* detach the "instance" */
524 p_drv->remove(p_dev);
526 p_dev->dev_node = NULL;
528 /* check for proper unloading */
529 if (p_dev->_irq || p_dev->_io || p_dev->_locked)
530 dev_printk(KERN_INFO, dev,
531 "pcmcia: driver %s did not release config properly\n",
534 for (i = 0; i < MAX_WIN; i++)
535 if (p_dev->_win & CLIENT_WIN_REQ(i))
536 dev_printk(KERN_INFO, dev,
537 "pcmcia: driver %s did not release window properly\n",
540 /* references from pcmcia_probe_device */
541 pcmcia_put_dev(p_dev);
542 module_put(p_drv->owner);
549 * pcmcia_device_query -- determine information about a pcmcia device
551 static int pcmcia_device_query(struct pcmcia_device *p_dev)
553 cistpl_manfid_t manf_id;
554 cistpl_funcid_t func_id;
555 cistpl_vers_1_t *vers1;
558 vers1 = kmalloc(sizeof(*vers1), GFP_KERNEL);
562 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
563 CISTPL_MANFID, &manf_id)) {
564 p_dev->manf_id = manf_id.manf;
565 p_dev->card_id = manf_id.card;
566 p_dev->has_manf_id = 1;
567 p_dev->has_card_id = 1;
570 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
571 CISTPL_FUNCID, &func_id)) {
572 p_dev->func_id = func_id.func;
573 p_dev->has_func_id = 1;
575 /* rule of thumb: cards with no FUNCID, but with
576 * common memory device geometry information, are
577 * probably memory cards (from pcmcia-cs) */
578 cistpl_device_geo_t *devgeo;
580 devgeo = kmalloc(sizeof(*devgeo), GFP_KERNEL);
585 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
586 CISTPL_DEVICE_GEO, devgeo)) {
587 ds_dev_dbg(0, &p_dev->dev,
588 "mem device geometry probably means "
590 p_dev->func_id = CISTPL_FUNCID_MEMORY;
591 p_dev->has_func_id = 1;
596 if (!pccard_read_tuple(p_dev->socket, p_dev->func, CISTPL_VERS_1,
598 for (i=0; i < vers1->ns; i++) {
602 tmp = vers1->str + vers1->ofs[i];
604 length = strlen(tmp) + 1;
605 if ((length < 2) || (length > 255))
608 p_dev->prod_id[i] = kmalloc(sizeof(char) * length,
610 if (!p_dev->prod_id[i])
613 p_dev->prod_id[i] = strncpy(p_dev->prod_id[i],
623 /* device_add_lock is needed to avoid double registration by cardmgr and kernel.
624 * Serializes pcmcia_device_add; will most likely be removed in future.
626 * While it has the caveat that adding new PCMCIA devices inside(!) device_register()
627 * won't work, this doesn't matter much at the moment: the driver core doesn't
630 static DEFINE_MUTEX(device_add_lock);
632 struct pcmcia_device * pcmcia_device_add(struct pcmcia_socket *s, unsigned int function)
634 struct pcmcia_device *p_dev, *tmp_dev;
638 s = pcmcia_get_socket(s);
642 mutex_lock(&device_add_lock);
644 ds_dbg(3, "adding device to %d, function %d\n", s->sock, function);
646 /* max of 4 devices per card */
647 if (s->device_count == 4)
650 p_dev = kzalloc(sizeof(struct pcmcia_device), GFP_KERNEL);
655 p_dev->device_no = (s->device_count++);
656 p_dev->func = function;
658 p_dev->dev.bus = &pcmcia_bus_type;
659 p_dev->dev.parent = s->dev.parent;
660 p_dev->dev.release = pcmcia_release_dev;
661 /* by default don't allow DMA */
662 p_dev->dma_mask = DMA_MASK_NONE;
663 p_dev->dev.dma_mask = &p_dev->dma_mask;
664 bus_id_len = sprintf (p_dev->dev.bus_id, "%d.%d", p_dev->socket->sock, p_dev->device_no);
666 p_dev->devname = kmalloc(6 + bus_id_len + 1, GFP_KERNEL);
669 sprintf (p_dev->devname, "pcmcia%s", p_dev->dev.bus_id);
670 ds_dev_dbg(3, &p_dev->dev, "devname is %s\n", p_dev->devname);
672 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
675 * p_dev->function_config must be the same for all card functions.
676 * Note that this is serialized by the device_add_lock, so that
677 * only one such struct will be created.
679 list_for_each_entry(tmp_dev, &s->devices_list, socket_device_list)
680 if (p_dev->func == tmp_dev->func) {
681 p_dev->function_config = tmp_dev->function_config;
682 kref_get(&p_dev->function_config->ref);
685 /* Add to the list in pcmcia_bus_socket */
686 list_add(&p_dev->socket_device_list, &s->devices_list);
688 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
690 if (!p_dev->function_config) {
691 ds_dev_dbg(3, &p_dev->dev, "creating config_t\n");
692 p_dev->function_config = kzalloc(sizeof(struct config_t),
694 if (!p_dev->function_config)
696 kref_init(&p_dev->function_config->ref);
699 dev_printk(KERN_NOTICE, &p_dev->dev,
700 "pcmcia: registering new device %s\n",
703 pcmcia_device_query(p_dev);
705 if (device_register(&p_dev->dev))
708 mutex_unlock(&device_add_lock);
713 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
714 list_del(&p_dev->socket_device_list);
715 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
718 kfree(p_dev->devname);
722 mutex_unlock(&device_add_lock);
723 pcmcia_put_socket(s);
729 static int pcmcia_card_add(struct pcmcia_socket *s)
731 cistpl_longlink_mfc_t mfc;
732 unsigned int no_funcs, i, no_chains;
735 if (!(s->resource_setup_done)) {
736 ds_dev_dbg(3, &s->dev,
737 "no resources available, delaying card_add\n");
738 return -EAGAIN; /* try again, but later... */
741 if (pcmcia_validate_mem(s)) {
742 ds_dev_dbg(3, &s->dev, "validating mem resources failed, "
743 "delaying card_add\n");
744 return -EAGAIN; /* try again, but later... */
747 ret = pccard_validate_cis(s, BIND_FN_ALL, &no_chains);
748 if (ret || !no_chains) {
749 ds_dev_dbg(0, &s->dev, "invalid CIS or invalid resources\n");
753 if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC, &mfc))
757 s->functions = no_funcs;
759 for (i=0; i < no_funcs; i++)
760 pcmcia_device_add(s, i);
766 static void pcmcia_delayed_add_device(struct work_struct *work)
768 struct pcmcia_socket *s =
769 container_of(work, struct pcmcia_socket, device_add);
770 ds_dev_dbg(1, &s->dev, "adding additional device to %d\n", s->sock);
771 pcmcia_device_add(s, s->pcmcia_state.mfc_pfc);
772 s->pcmcia_state.device_add_pending = 0;
773 s->pcmcia_state.mfc_pfc = 0;
776 static int pcmcia_requery(struct device *dev, void * _data)
778 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
779 if (!p_dev->dev.driver) {
780 ds_dev_dbg(1, dev, "update device information\n");
781 pcmcia_device_query(p_dev);
787 static void pcmcia_bus_rescan(struct pcmcia_socket *skt, int new_cis)
793 /* must be called with skt_mutex held */
794 ds_dev_dbg(0, &skt->dev, "re-scanning socket %d\n", skt->sock);
796 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
797 if (list_empty(&skt->devices_list))
799 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
801 /* If this is because of a CIS override, start over */
802 if (new_cis && !no_devices)
803 pcmcia_card_remove(skt, NULL);
805 /* if no devices were added for this socket yet because of
806 * missing resource information or other trouble, we need to
808 if (no_devices || new_cis) {
809 ret = pcmcia_card_add(skt);
814 /* some device information might have changed because of a CIS
815 * update or because we can finally read it correctly... so
816 * determine it again, overwriting old values if necessary. */
817 bus_for_each_dev(&pcmcia_bus_type, NULL, NULL, pcmcia_requery);
819 /* we re-scan all devices, not just the ones connected to this
820 * socket. This does not matter, though. */
821 ret = bus_rescan_devices(&pcmcia_bus_type);
823 printk(KERN_INFO "pcmcia: bus_rescan_devices failed\n");
826 #ifdef CONFIG_PCMCIA_LOAD_CIS
829 * pcmcia_load_firmware - load CIS from userspace if device-provided is broken
830 * @dev: the pcmcia device which needs a CIS override
831 * @filename: requested filename in /lib/firmware/
833 * This uses the in-kernel firmware loading mechanism to use a "fake CIS" if
834 * the one provided by the card is broken. The firmware files reside in
835 * /lib/firmware/ in userspace.
837 static int pcmcia_load_firmware(struct pcmcia_device *dev, char * filename)
839 struct pcmcia_socket *s = dev->socket;
840 const struct firmware *fw;
841 char path[FIRMWARE_NAME_MAX];
845 cistpl_longlink_mfc_t mfc;
850 ds_dev_dbg(1, &dev->dev, "trying to load CIS file %s\n", filename);
852 if (strlen(filename) > (FIRMWARE_NAME_MAX - 1)) {
853 dev_printk(KERN_WARNING, &dev->dev,
854 "pcmcia: CIS filename is too long [%s]\n",
859 snprintf(path, sizeof(path), "%s", filename);
861 if (request_firmware(&fw, path, &dev->dev) == 0) {
862 if (fw->size >= CISTPL_MAX_CIS_SIZE) {
864 dev_printk(KERN_ERR, &dev->dev,
865 "pcmcia: CIS override is too big\n");
869 if (!pcmcia_replace_cis(s, fw->data, fw->size))
872 dev_printk(KERN_ERR, &dev->dev,
873 "pcmcia: CIS override failed\n");
878 /* update information */
879 pcmcia_device_query(dev);
881 /* does this cis override add or remove functions? */
882 old_funcs = s->functions;
884 if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC, &mfc))
888 s->functions = no_funcs;
890 if (old_funcs > no_funcs)
891 pcmcia_card_remove(s, dev);
892 else if (no_funcs > old_funcs)
893 pcmcia_add_device_later(s, 1);
896 release_firmware(fw);
901 #else /* !CONFIG_PCMCIA_LOAD_CIS */
903 static inline int pcmcia_load_firmware(struct pcmcia_device *dev, char * filename)
911 static inline int pcmcia_devmatch(struct pcmcia_device *dev,
912 struct pcmcia_device_id *did)
914 if (did->match_flags & PCMCIA_DEV_ID_MATCH_MANF_ID) {
915 if ((!dev->has_manf_id) || (dev->manf_id != did->manf_id))
919 if (did->match_flags & PCMCIA_DEV_ID_MATCH_CARD_ID) {
920 if ((!dev->has_card_id) || (dev->card_id != did->card_id))
924 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNCTION) {
925 if (dev->func != did->function)
929 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID1) {
930 if (!dev->prod_id[0])
932 if (strcmp(did->prod_id[0], dev->prod_id[0]))
936 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID2) {
937 if (!dev->prod_id[1])
939 if (strcmp(did->prod_id[1], dev->prod_id[1]))
943 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID3) {
944 if (!dev->prod_id[2])
946 if (strcmp(did->prod_id[2], dev->prod_id[2]))
950 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID4) {
951 if (!dev->prod_id[3])
953 if (strcmp(did->prod_id[3], dev->prod_id[3]))
957 if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) {
958 if (dev->device_no != did->device_no)
962 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNC_ID) {
963 if ((!dev->has_func_id) || (dev->func_id != did->func_id))
966 /* if this is a pseudo-multi-function device,
967 * we need explicit matches */
968 if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO)
973 /* also, FUNC_ID matching needs to be activated by userspace
974 * after it has re-checked that there is no possible module
975 * with a prod_id/manf_id/card_id match.
977 ds_dev_dbg(0, &dev->dev,
978 "skipping FUNC_ID match until userspace interaction\n");
979 if (!dev->allow_func_id_match)
983 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FAKE_CIS) {
984 ds_dev_dbg(0, &dev->dev, "device needs a fake CIS\n");
985 if (!dev->socket->fake_cis)
986 pcmcia_load_firmware(dev, did->cisfile);
988 if (!dev->socket->fake_cis)
992 if (did->match_flags & PCMCIA_DEV_ID_MATCH_ANONYMOUS) {
997 if (dev->has_manf_id || dev->has_card_id || dev->has_func_id)
1001 dev->dev.driver_data = (void *) did;
1007 static int pcmcia_bus_match(struct device * dev, struct device_driver * drv) {
1008 struct pcmcia_device * p_dev = to_pcmcia_dev(dev);
1009 struct pcmcia_driver * p_drv = to_pcmcia_drv(drv);
1010 struct pcmcia_device_id *did = p_drv->id_table;
1011 struct pcmcia_dynid *dynid;
1013 /* match dynamic devices first */
1014 spin_lock(&p_drv->dynids.lock);
1015 list_for_each_entry(dynid, &p_drv->dynids.list, node) {
1016 ds_dev_dbg(3, dev, "trying to match to %s\n", drv->name);
1017 if (pcmcia_devmatch(p_dev, &dynid->id)) {
1018 ds_dev_dbg(0, dev, "matched to %s\n", drv->name);
1019 spin_unlock(&p_drv->dynids.lock);
1023 spin_unlock(&p_drv->dynids.lock);
1025 #ifdef CONFIG_PCMCIA_IOCTL
1026 /* matching by cardmgr */
1027 if (p_dev->cardmgr == p_drv) {
1028 ds_dev_dbg(0, dev, "cardmgr matched to %s\n", drv->name);
1033 while (did && did->match_flags) {
1034 ds_dev_dbg(3, dev, "trying to match to %s\n", drv->name);
1035 if (pcmcia_devmatch(p_dev, did)) {
1036 ds_dev_dbg(0, dev, "matched to %s\n", drv->name);
1045 #ifdef CONFIG_HOTPLUG
1047 static int pcmcia_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
1049 struct pcmcia_device *p_dev;
1051 u32 hash[4] = { 0, 0, 0, 0};
1056 p_dev = to_pcmcia_dev(dev);
1058 /* calculate hashes */
1059 for (i=0; i<4; i++) {
1060 if (!p_dev->prod_id[i])
1062 hash[i] = crc32(0, p_dev->prod_id[i], strlen(p_dev->prod_id[i]));
1065 if (add_uevent_var(env, "SOCKET_NO=%u", p_dev->socket->sock))
1068 if (add_uevent_var(env, "DEVICE_NO=%02X", p_dev->device_no))
1071 if (add_uevent_var(env, "MODALIAS=pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
1072 "pa%08Xpb%08Xpc%08Xpd%08X",
1073 p_dev->has_manf_id ? p_dev->manf_id : 0,
1074 p_dev->has_card_id ? p_dev->card_id : 0,
1075 p_dev->has_func_id ? p_dev->func_id : 0,
1089 static int pcmcia_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
1096 /************************ runtime PM support ***************************/
1098 static int pcmcia_dev_suspend(struct device *dev, pm_message_t state);
1099 static int pcmcia_dev_resume(struct device *dev);
1101 static int runtime_suspend(struct device *dev)
1106 rc = pcmcia_dev_suspend(dev, PMSG_SUSPEND);
1111 static void runtime_resume(struct device *dev)
1116 rc = pcmcia_dev_resume(dev);
1120 /************************ per-device sysfs output ***************************/
1122 #define pcmcia_device_attr(field, test, format) \
1123 static ssize_t field##_show (struct device *dev, struct device_attribute *attr, char *buf) \
1125 struct pcmcia_device *p_dev = to_pcmcia_dev(dev); \
1126 return p_dev->test ? sprintf (buf, format, p_dev->field) : -ENODEV; \
1129 #define pcmcia_device_stringattr(name, field) \
1130 static ssize_t name##_show (struct device *dev, struct device_attribute *attr, char *buf) \
1132 struct pcmcia_device *p_dev = to_pcmcia_dev(dev); \
1133 return p_dev->field ? sprintf (buf, "%s\n", p_dev->field) : -ENODEV; \
1136 pcmcia_device_attr(func, socket, "0x%02x\n");
1137 pcmcia_device_attr(func_id, has_func_id, "0x%02x\n");
1138 pcmcia_device_attr(manf_id, has_manf_id, "0x%04x\n");
1139 pcmcia_device_attr(card_id, has_card_id, "0x%04x\n");
1140 pcmcia_device_stringattr(prod_id1, prod_id[0]);
1141 pcmcia_device_stringattr(prod_id2, prod_id[1]);
1142 pcmcia_device_stringattr(prod_id3, prod_id[2]);
1143 pcmcia_device_stringattr(prod_id4, prod_id[3]);
1146 static ssize_t pcmcia_show_pm_state(struct device *dev, struct device_attribute *attr, char *buf)
1148 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1150 if (p_dev->suspended)
1151 return sprintf(buf, "off\n");
1153 return sprintf(buf, "on\n");
1156 static ssize_t pcmcia_store_pm_state(struct device *dev, struct device_attribute *attr,
1157 const char *buf, size_t count)
1159 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1165 if ((!p_dev->suspended) && !strncmp(buf, "off", 3))
1166 ret = runtime_suspend(dev);
1167 else if (p_dev->suspended && !strncmp(buf, "on", 2))
1168 runtime_resume(dev);
1170 return ret ? ret : count;
1174 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
1176 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1178 u32 hash[4] = { 0, 0, 0, 0};
1180 /* calculate hashes */
1181 for (i=0; i<4; i++) {
1182 if (!p_dev->prod_id[i])
1184 hash[i] = crc32(0,p_dev->prod_id[i],strlen(p_dev->prod_id[i]));
1186 return sprintf(buf, "pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
1187 "pa%08Xpb%08Xpc%08Xpd%08X\n",
1188 p_dev->has_manf_id ? p_dev->manf_id : 0,
1189 p_dev->has_card_id ? p_dev->card_id : 0,
1190 p_dev->has_func_id ? p_dev->func_id : 0,
1191 p_dev->func, p_dev->device_no,
1192 hash[0], hash[1], hash[2], hash[3]);
1195 static ssize_t pcmcia_store_allow_func_id_match(struct device *dev,
1196 struct device_attribute *attr, const char *buf, size_t count)
1198 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1204 mutex_lock(&p_dev->socket->skt_mutex);
1205 p_dev->allow_func_id_match = 1;
1206 mutex_unlock(&p_dev->socket->skt_mutex);
1208 ret = bus_rescan_devices(&pcmcia_bus_type);
1210 printk(KERN_INFO "pcmcia: bus_rescan_devices failed after "
1211 "allowing func_id matches\n");
1216 static struct device_attribute pcmcia_dev_attrs[] = {
1217 __ATTR(function, 0444, func_show, NULL),
1218 __ATTR(pm_state, 0644, pcmcia_show_pm_state, pcmcia_store_pm_state),
1222 __ATTR_RO(prod_id1),
1223 __ATTR_RO(prod_id2),
1224 __ATTR_RO(prod_id3),
1225 __ATTR_RO(prod_id4),
1226 __ATTR_RO(modalias),
1227 __ATTR(allow_func_id_match, 0200, NULL, pcmcia_store_allow_func_id_match),
1231 /* PM support, also needed for reset */
1233 static int pcmcia_dev_suspend(struct device * dev, pm_message_t state)
1235 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1236 struct pcmcia_driver *p_drv = NULL;
1239 if (p_dev->suspended)
1242 ds_dev_dbg(2, dev, "suspending\n");
1245 p_drv = to_pcmcia_drv(dev->driver);
1250 if (p_drv->suspend) {
1251 ret = p_drv->suspend(p_dev);
1253 dev_printk(KERN_ERR, dev,
1254 "pcmcia: device %s (driver %s) did "
1255 "not want to go to sleep (%d)\n",
1256 p_dev->devname, p_drv->drv.name, ret);
1261 if (p_dev->device_no == p_dev->func) {
1262 ds_dev_dbg(2, dev, "releasing configuration\n");
1263 pcmcia_release_configuration(p_dev);
1268 p_dev->suspended = 1;
1273 static int pcmcia_dev_resume(struct device * dev)
1275 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1276 struct pcmcia_driver *p_drv = NULL;
1279 if (!p_dev->suspended)
1282 ds_dev_dbg(2, dev, "resuming\n");
1285 p_drv = to_pcmcia_drv(dev->driver);
1290 if (p_dev->device_no == p_dev->func) {
1291 ds_dev_dbg(2, dev, "requesting configuration\n");
1292 ret = pcmcia_request_configuration(p_dev, &p_dev->conf);
1298 ret = p_drv->resume(p_dev);
1302 p_dev->suspended = 0;
1307 static int pcmcia_bus_suspend_callback(struct device *dev, void * _data)
1309 struct pcmcia_socket *skt = _data;
1310 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1312 if (p_dev->socket != skt || p_dev->suspended)
1315 return runtime_suspend(dev);
1318 static int pcmcia_bus_resume_callback(struct device *dev, void * _data)
1320 struct pcmcia_socket *skt = _data;
1321 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1323 if (p_dev->socket != skt || !p_dev->suspended)
1326 runtime_resume(dev);
1331 static int pcmcia_bus_resume(struct pcmcia_socket *skt)
1333 ds_dev_dbg(2, &skt->dev, "resuming socket %d\n", skt->sock);
1334 bus_for_each_dev(&pcmcia_bus_type, NULL, skt, pcmcia_bus_resume_callback);
1338 static int pcmcia_bus_suspend(struct pcmcia_socket *skt)
1340 ds_dev_dbg(2, &skt->dev, "suspending socket %d\n", skt->sock);
1341 if (bus_for_each_dev(&pcmcia_bus_type, NULL, skt,
1342 pcmcia_bus_suspend_callback)) {
1343 pcmcia_bus_resume(skt);
1350 /*======================================================================
1352 The card status event handler.
1354 ======================================================================*/
1356 /* Normally, the event is passed to individual drivers after
1357 * informing userspace. Only for CS_EVENT_CARD_REMOVAL this
1358 * is inversed to maintain historic compatibility.
1361 static int ds_event(struct pcmcia_socket *skt, event_t event, int priority)
1363 struct pcmcia_socket *s = pcmcia_get_socket(skt);
1366 dev_printk(KERN_ERR, &skt->dev,
1367 "PCMCIA obtaining reference to socket " \
1368 "failed, event 0x%x lost!\n", event);
1372 ds_dev_dbg(1, &skt->dev, "ds_event(0x%06x, %d, 0x%p)\n",
1373 event, priority, skt);
1376 case CS_EVENT_CARD_REMOVAL:
1377 s->pcmcia_state.present = 0;
1378 pcmcia_card_remove(skt, NULL);
1379 handle_event(skt, event);
1382 case CS_EVENT_CARD_INSERTION:
1383 s->pcmcia_state.present = 1;
1384 pcmcia_card_add(skt);
1385 handle_event(skt, event);
1388 case CS_EVENT_EJECTION_REQUEST:
1391 case CS_EVENT_PM_SUSPEND:
1392 case CS_EVENT_PM_RESUME:
1393 case CS_EVENT_RESET_PHYSICAL:
1394 case CS_EVENT_CARD_RESET:
1396 handle_event(skt, event);
1400 pcmcia_put_socket(s);
1406 struct pcmcia_device * pcmcia_dev_present(struct pcmcia_device *_p_dev)
1408 struct pcmcia_device *p_dev;
1409 struct pcmcia_device *ret = NULL;
1411 p_dev = pcmcia_get_dev(_p_dev);
1415 if (!p_dev->socket->pcmcia_state.present)
1418 if (p_dev->_removed)
1421 if (p_dev->suspended)
1426 pcmcia_put_dev(p_dev);
1429 EXPORT_SYMBOL(pcmcia_dev_present);
1432 static struct pcmcia_callback pcmcia_bus_callback = {
1433 .owner = THIS_MODULE,
1435 .requery = pcmcia_bus_rescan,
1436 .suspend = pcmcia_bus_suspend,
1437 .resume = pcmcia_bus_resume,
1440 static int __devinit pcmcia_bus_add_socket(struct device *dev,
1441 struct class_interface *class_intf)
1443 struct pcmcia_socket *socket = dev_get_drvdata(dev);
1446 socket = pcmcia_get_socket(socket);
1448 dev_printk(KERN_ERR, dev,
1449 "PCMCIA obtaining reference to socket failed\n");
1454 * Ugly. But we want to wait for the socket threads to have started up.
1455 * We really should let the drivers themselves drive some of this..
1459 #ifdef CONFIG_PCMCIA_IOCTL
1460 init_waitqueue_head(&socket->queue);
1462 INIT_LIST_HEAD(&socket->devices_list);
1463 INIT_WORK(&socket->device_add, pcmcia_delayed_add_device);
1464 memset(&socket->pcmcia_state, 0, sizeof(u8));
1465 socket->device_count = 0;
1467 ret = pccard_register_pcmcia(socket, &pcmcia_bus_callback);
1469 dev_printk(KERN_ERR, dev, "PCMCIA registration failed\n");
1470 pcmcia_put_socket(socket);
1477 static void pcmcia_bus_remove_socket(struct device *dev,
1478 struct class_interface *class_intf)
1480 struct pcmcia_socket *socket = dev_get_drvdata(dev);
1485 socket->pcmcia_state.dead = 1;
1486 pccard_register_pcmcia(socket, NULL);
1488 /* unregister any unbound devices */
1489 mutex_lock(&socket->skt_mutex);
1490 pcmcia_card_remove(socket, NULL);
1491 mutex_unlock(&socket->skt_mutex);
1493 pcmcia_put_socket(socket);
1499 /* the pcmcia_bus_interface is used to handle pcmcia socket devices */
1500 static struct class_interface pcmcia_bus_interface __refdata = {
1501 .class = &pcmcia_socket_class,
1502 .add_dev = &pcmcia_bus_add_socket,
1503 .remove_dev = &pcmcia_bus_remove_socket,
1507 struct bus_type pcmcia_bus_type = {
1509 .uevent = pcmcia_bus_uevent,
1510 .match = pcmcia_bus_match,
1511 .dev_attrs = pcmcia_dev_attrs,
1512 .probe = pcmcia_device_probe,
1513 .remove = pcmcia_device_remove,
1514 .suspend = pcmcia_dev_suspend,
1515 .resume = pcmcia_dev_resume,
1519 static int __init init_pcmcia_bus(void)
1523 spin_lock_init(&pcmcia_dev_list_lock);
1525 ret = bus_register(&pcmcia_bus_type);
1527 printk(KERN_WARNING "pcmcia: bus_register error: %d\n", ret);
1530 ret = class_interface_register(&pcmcia_bus_interface);
1533 "pcmcia: class_interface_register error: %d\n", ret);
1534 bus_unregister(&pcmcia_bus_type);
1538 pcmcia_setup_ioctl();
1542 fs_initcall(init_pcmcia_bus); /* one level after subsys_initcall so that
1543 * pcmcia_socket_class is already registered */
1546 static void __exit exit_pcmcia_bus(void)
1548 pcmcia_cleanup_ioctl();
1550 class_interface_unregister(&pcmcia_bus_interface);
1552 bus_unregister(&pcmcia_bus_type);
1554 module_exit(exit_pcmcia_bus);