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");
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); \
55 #define ds_dbg(lvl, fmt, arg...) do { } while (0)
58 spinlock_t pcmcia_dev_list_lock;
60 /*====================================================================*/
62 /* code which was in cs.c before */
64 /* String tables for error messages */
66 typedef struct lookup_t {
71 static const lookup_t error_table[] = {
72 { CS_SUCCESS, "Operation succeeded" },
73 { CS_BAD_ADAPTER, "Bad adapter" },
74 { CS_BAD_ATTRIBUTE, "Bad attribute", },
75 { CS_BAD_BASE, "Bad base address" },
76 { CS_BAD_EDC, "Bad EDC" },
77 { CS_BAD_IRQ, "Bad IRQ" },
78 { CS_BAD_OFFSET, "Bad offset" },
79 { CS_BAD_PAGE, "Bad page number" },
80 { CS_READ_FAILURE, "Read failure" },
81 { CS_BAD_SIZE, "Bad size" },
82 { CS_BAD_SOCKET, "Bad socket" },
83 { CS_BAD_TYPE, "Bad type" },
84 { CS_BAD_VCC, "Bad Vcc" },
85 { CS_BAD_VPP, "Bad Vpp" },
86 { CS_BAD_WINDOW, "Bad window" },
87 { CS_WRITE_FAILURE, "Write failure" },
88 { CS_NO_CARD, "No card present" },
89 { CS_UNSUPPORTED_FUNCTION, "Usupported function" },
90 { CS_UNSUPPORTED_MODE, "Unsupported mode" },
91 { CS_BAD_SPEED, "Bad speed" },
92 { CS_BUSY, "Resource busy" },
93 { CS_GENERAL_FAILURE, "General failure" },
94 { CS_WRITE_PROTECTED, "Write protected" },
95 { CS_BAD_ARG_LENGTH, "Bad argument length" },
96 { CS_BAD_ARGS, "Bad arguments" },
97 { CS_CONFIGURATION_LOCKED, "Configuration locked" },
98 { CS_IN_USE, "Resource in use" },
99 { CS_NO_MORE_ITEMS, "No more items" },
100 { CS_OUT_OF_RESOURCE, "Out of resource" },
101 { CS_BAD_HANDLE, "Bad handle" },
102 { CS_BAD_TUPLE, "Bad CIS tuple" }
106 static const lookup_t service_table[] = {
107 { AccessConfigurationRegister, "AccessConfigurationRegister" },
108 { AddSocketServices, "AddSocketServices" },
109 { AdjustResourceInfo, "AdjustResourceInfo" },
110 { CheckEraseQueue, "CheckEraseQueue" },
111 { CloseMemory, "CloseMemory" },
112 { DeregisterClient, "DeregisterClient" },
113 { DeregisterEraseQueue, "DeregisterEraseQueue" },
114 { GetCardServicesInfo, "GetCardServicesInfo" },
115 { GetClientInfo, "GetClientInfo" },
116 { GetConfigurationInfo, "GetConfigurationInfo" },
117 { GetEventMask, "GetEventMask" },
118 { GetFirstClient, "GetFirstClient" },
119 { GetFirstRegion, "GetFirstRegion" },
120 { GetFirstTuple, "GetFirstTuple" },
121 { GetNextClient, "GetNextClient" },
122 { GetNextRegion, "GetNextRegion" },
123 { GetNextTuple, "GetNextTuple" },
124 { GetStatus, "GetStatus" },
125 { GetTupleData, "GetTupleData" },
126 { MapMemPage, "MapMemPage" },
127 { ModifyConfiguration, "ModifyConfiguration" },
128 { ModifyWindow, "ModifyWindow" },
129 { OpenMemory, "OpenMemory" },
130 { ParseTuple, "ParseTuple" },
131 { ReadMemory, "ReadMemory" },
132 { RegisterClient, "RegisterClient" },
133 { RegisterEraseQueue, "RegisterEraseQueue" },
134 { RegisterMTD, "RegisterMTD" },
135 { ReleaseConfiguration, "ReleaseConfiguration" },
136 { ReleaseIO, "ReleaseIO" },
137 { ReleaseIRQ, "ReleaseIRQ" },
138 { ReleaseWindow, "ReleaseWindow" },
139 { RequestConfiguration, "RequestConfiguration" },
140 { RequestIO, "RequestIO" },
141 { RequestIRQ, "RequestIRQ" },
142 { RequestSocketMask, "RequestSocketMask" },
143 { RequestWindow, "RequestWindow" },
144 { ResetCard, "ResetCard" },
145 { SetEventMask, "SetEventMask" },
146 { ValidateCIS, "ValidateCIS" },
147 { WriteMemory, "WriteMemory" },
148 { BindDevice, "BindDevice" },
149 { BindMTD, "BindMTD" },
150 { ReportError, "ReportError" },
151 { SuspendCard, "SuspendCard" },
152 { ResumeCard, "ResumeCard" },
153 { EjectCard, "EjectCard" },
154 { InsertCard, "InsertCard" },
155 { ReplaceCIS, "ReplaceCIS" }
159 static int pcmcia_report_error(struct pcmcia_device *p_dev, error_info_t *err)
167 printk(KERN_NOTICE "%s: ", p_dev->dev.bus_id);
169 for (i = 0; i < ARRAY_SIZE(service_table); i++)
170 if (service_table[i].key == err->func)
172 if (i < ARRAY_SIZE(service_table))
173 serv = service_table[i].msg;
175 serv = "Unknown service number";
177 for (i = 0; i < ARRAY_SIZE(error_table); i++)
178 if (error_table[i].key == err->retcode)
180 if (i < ARRAY_SIZE(error_table))
181 printk("%s: %s\n", serv, error_table[i].msg);
183 printk("%s: Unknown error code %#x\n", serv, err->retcode);
188 /* end of code which was in cs.c before */
190 /*======================================================================*/
192 void cs_error(struct pcmcia_device *p_dev, int func, int ret)
194 error_info_t err = { func, ret };
195 pcmcia_report_error(p_dev, &err);
197 EXPORT_SYMBOL(cs_error);
200 static void pcmcia_check_driver(struct pcmcia_driver *p_drv)
202 struct pcmcia_device_id *did = p_drv->id_table;
206 if (!p_drv->probe || !p_drv->remove)
207 printk(KERN_DEBUG "pcmcia: %s lacks a requisite callback "
208 "function\n", p_drv->drv.name);
210 while (did && did->match_flags) {
211 for (i=0; i<4; i++) {
212 if (!did->prod_id[i])
215 hash = crc32(0, did->prod_id[i], strlen(did->prod_id[i]));
216 if (hash == did->prod_id_hash[i])
219 printk(KERN_DEBUG "pcmcia: %s: invalid hash for "
220 "product string \"%s\": is 0x%x, should "
221 "be 0x%x\n", p_drv->drv.name, did->prod_id[i],
222 did->prod_id_hash[i], hash);
223 printk(KERN_DEBUG "pcmcia: see "
224 "Documentation/pcmcia/devicetable.txt for "
234 /*======================================================================*/
237 struct pcmcia_dynid {
238 struct list_head node;
239 struct pcmcia_device_id id;
243 * pcmcia_store_new_id - add a new PCMCIA device ID to this driver and re-probe devices
244 * @driver: target device driver
245 * @buf: buffer for scanning device ID data
248 * Adds a new dynamic PCMCIA device ID to this driver,
249 * and causes the driver to probe for all devices again.
252 pcmcia_store_new_id(struct device_driver *driver, const char *buf, size_t count)
254 struct pcmcia_dynid *dynid;
255 struct pcmcia_driver *pdrv = to_pcmcia_drv(driver);
256 __u16 match_flags, manf_id, card_id;
257 __u8 func_id, function, device_no;
258 __u32 prod_id_hash[4] = {0, 0, 0, 0};
262 fields = sscanf(buf, "%hx %hx %hx %hhx %hhx %hhx %x %x %x %x",
263 &match_flags, &manf_id, &card_id, &func_id, &function, &device_no,
264 &prod_id_hash[0], &prod_id_hash[1], &prod_id_hash[2], &prod_id_hash[3]);
268 dynid = kzalloc(sizeof(struct pcmcia_dynid), GFP_KERNEL);
272 INIT_LIST_HEAD(&dynid->node);
273 dynid->id.match_flags = match_flags;
274 dynid->id.manf_id = manf_id;
275 dynid->id.card_id = card_id;
276 dynid->id.func_id = func_id;
277 dynid->id.function = function;
278 dynid->id.device_no = device_no;
279 memcpy(dynid->id.prod_id_hash, prod_id_hash, sizeof(__u32) * 4);
281 spin_lock(&pdrv->dynids.lock);
282 list_add_tail(&pdrv->dynids.list, &dynid->node);
283 spin_unlock(&pdrv->dynids.lock);
285 if (get_driver(&pdrv->drv)) {
286 retval = driver_attach(&pdrv->drv);
287 put_driver(&pdrv->drv);
294 static DRIVER_ATTR(new_id, S_IWUSR, NULL, pcmcia_store_new_id);
297 pcmcia_free_dynids(struct pcmcia_driver *drv)
299 struct pcmcia_dynid *dynid, *n;
301 spin_lock(&drv->dynids.lock);
302 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
303 list_del(&dynid->node);
306 spin_unlock(&drv->dynids.lock);
310 pcmcia_create_newid_file(struct pcmcia_driver *drv)
313 if (drv->probe != NULL)
314 error = driver_create_file(&drv->drv, &driver_attr_new_id);
320 * pcmcia_register_driver - register a PCMCIA driver with the bus core
321 * @driver: the &driver being registered
323 * Registers a PCMCIA driver with the PCMCIA bus core.
325 int pcmcia_register_driver(struct pcmcia_driver *driver)
332 pcmcia_check_driver(driver);
334 /* initialize common fields */
335 driver->drv.bus = &pcmcia_bus_type;
336 driver->drv.owner = driver->owner;
337 spin_lock_init(&driver->dynids.lock);
338 INIT_LIST_HEAD(&driver->dynids.list);
340 ds_dbg(3, "registering driver %s\n", driver->drv.name);
342 error = driver_register(&driver->drv);
346 error = pcmcia_create_newid_file(driver);
348 driver_unregister(&driver->drv);
352 EXPORT_SYMBOL(pcmcia_register_driver);
355 * pcmcia_unregister_driver - unregister a PCMCIA driver with the bus core
356 * @driver: the &driver being unregistered
358 void pcmcia_unregister_driver(struct pcmcia_driver *driver)
360 ds_dbg(3, "unregistering driver %s\n", driver->drv.name);
361 driver_unregister(&driver->drv);
362 pcmcia_free_dynids(driver);
364 EXPORT_SYMBOL(pcmcia_unregister_driver);
367 /* pcmcia_device handling */
369 struct pcmcia_device * pcmcia_get_dev(struct pcmcia_device *p_dev)
371 struct device *tmp_dev;
372 tmp_dev = get_device(&p_dev->dev);
375 return to_pcmcia_dev(tmp_dev);
378 void pcmcia_put_dev(struct pcmcia_device *p_dev)
381 put_device(&p_dev->dev);
384 static void pcmcia_release_function(struct kref *ref)
386 struct config_t *c = container_of(ref, struct config_t, ref);
387 ds_dbg(1, "releasing config_t\n");
391 static void pcmcia_release_dev(struct device *dev)
393 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
394 ds_dbg(1, "releasing device %s\n", p_dev->dev.bus_id);
395 pcmcia_put_socket(p_dev->socket);
396 kfree(p_dev->devname);
397 kref_put(&p_dev->function_config->ref, pcmcia_release_function);
401 static void pcmcia_add_device_later(struct pcmcia_socket *s, int mfc)
403 if (!s->pcmcia_state.device_add_pending) {
404 ds_dbg(1, "scheduling to add %s secondary"
405 " device to %d\n", mfc ? "mfc" : "pfc", s->sock);
406 s->pcmcia_state.device_add_pending = 1;
407 s->pcmcia_state.mfc_pfc = mfc;
408 schedule_work(&s->device_add);
413 static int pcmcia_device_probe(struct device * dev)
415 struct pcmcia_device *p_dev;
416 struct pcmcia_driver *p_drv;
417 struct pcmcia_device_id *did;
418 struct pcmcia_socket *s;
419 cistpl_config_t cis_config;
422 dev = get_device(dev);
426 p_dev = to_pcmcia_dev(dev);
427 p_drv = to_pcmcia_drv(dev->driver);
430 /* The PCMCIA code passes the match data in via dev->driver_data
431 * which is an ugly hack. Once the driver probe is called it may
432 * and often will overwrite the match data so we must save it first
434 * handle pseudo multifunction devices:
435 * there are at most two pseudo multifunction devices.
436 * if we're matching against the first, schedule a
437 * call which will then check whether there are two
438 * pseudo devices, and if not, add the second one.
440 did = p_dev->dev.driver_data;
442 ds_dbg(1, "trying to bind %s to %s\n", p_dev->dev.bus_id,
445 if ((!p_drv->probe) || (!p_dev->function_config) ||
446 (!try_module_get(p_drv->owner))) {
451 /* set up some more device information */
452 ret = pccard_read_tuple(p_dev->socket, p_dev->func, CISTPL_CONFIG,
455 p_dev->conf.ConfigBase = cis_config.base;
456 p_dev->conf.Present = cis_config.rmask[0];
458 printk(KERN_INFO "pcmcia: could not parse base and rmask0 of CIS\n");
459 p_dev->conf.ConfigBase = 0;
460 p_dev->conf.Present = 0;
463 ret = p_drv->probe(p_dev);
465 ds_dbg(1, "binding %s to %s failed with %d\n",
466 p_dev->dev.bus_id, p_drv->drv.name, ret);
470 if (did && (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) &&
471 (p_dev->socket->device_count == 1) && (p_dev->device_no == 0))
472 pcmcia_add_device_later(p_dev->socket, 0);
476 module_put(p_drv->owner);
485 * Removes a PCMCIA card from the device tree and socket list.
487 static void pcmcia_card_remove(struct pcmcia_socket *s, struct pcmcia_device *leftover)
489 struct pcmcia_device *p_dev;
490 struct pcmcia_device *tmp;
493 ds_dbg(2, "pcmcia_card_remove(%d) %s\n", s->sock,
494 leftover ? leftover->devname : "");
501 /* unregister all pcmcia_devices registered with this socket, except leftover */
502 list_for_each_entry_safe(p_dev, tmp, &s->devices_list, socket_device_list) {
503 if (p_dev == leftover)
506 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
507 list_del(&p_dev->socket_device_list);
509 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
511 ds_dbg(2, "unregistering device %s\n", p_dev->dev.bus_id);
512 device_unregister(&p_dev->dev);
518 static int pcmcia_device_remove(struct device * dev)
520 struct pcmcia_device *p_dev;
521 struct pcmcia_driver *p_drv;
522 struct pcmcia_device_id *did;
525 p_dev = to_pcmcia_dev(dev);
526 p_drv = to_pcmcia_drv(dev->driver);
528 ds_dbg(1, "removing device %s\n", p_dev->dev.bus_id);
530 /* If we're removing the primary module driving a
531 * pseudo multi-function card, we need to unbind
534 did = p_dev->dev.driver_data;
535 if (did && (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) &&
536 (p_dev->socket->device_count != 0) &&
537 (p_dev->device_no == 0))
538 pcmcia_card_remove(p_dev->socket, p_dev);
540 /* detach the "instance" */
545 p_drv->remove(p_dev);
547 p_dev->dev_node = NULL;
549 /* check for proper unloading */
550 if (p_dev->_irq || p_dev->_io || p_dev->_locked)
551 printk(KERN_INFO "pcmcia: driver %s did not release config properly\n",
554 for (i = 0; i < MAX_WIN; i++)
555 if (p_dev->_win & CLIENT_WIN_REQ(i))
556 printk(KERN_INFO "pcmcia: driver %s did not release windows properly\n",
559 /* references from pcmcia_probe_device */
560 pcmcia_put_dev(p_dev);
561 module_put(p_drv->owner);
568 * pcmcia_device_query -- determine information about a pcmcia device
570 static int pcmcia_device_query(struct pcmcia_device *p_dev)
572 cistpl_manfid_t manf_id;
573 cistpl_funcid_t func_id;
574 cistpl_vers_1_t *vers1;
577 vers1 = kmalloc(sizeof(*vers1), GFP_KERNEL);
581 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
582 CISTPL_MANFID, &manf_id)) {
583 p_dev->manf_id = manf_id.manf;
584 p_dev->card_id = manf_id.card;
585 p_dev->has_manf_id = 1;
586 p_dev->has_card_id = 1;
589 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
590 CISTPL_FUNCID, &func_id)) {
591 p_dev->func_id = func_id.func;
592 p_dev->has_func_id = 1;
594 /* rule of thumb: cards with no FUNCID, but with
595 * common memory device geometry information, are
596 * probably memory cards (from pcmcia-cs) */
597 cistpl_device_geo_t *devgeo;
599 devgeo = kmalloc(sizeof(*devgeo), GFP_KERNEL);
604 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
605 CISTPL_DEVICE_GEO, devgeo)) {
606 ds_dbg(0, "mem device geometry probably means "
608 p_dev->func_id = CISTPL_FUNCID_MEMORY;
609 p_dev->has_func_id = 1;
614 if (!pccard_read_tuple(p_dev->socket, p_dev->func, CISTPL_VERS_1,
616 for (i=0; i < vers1->ns; i++) {
620 tmp = vers1->str + vers1->ofs[i];
622 length = strlen(tmp) + 1;
623 if ((length < 2) || (length > 255))
626 p_dev->prod_id[i] = kmalloc(sizeof(char) * length,
628 if (!p_dev->prod_id[i])
631 p_dev->prod_id[i] = strncpy(p_dev->prod_id[i],
641 /* device_add_lock is needed to avoid double registration by cardmgr and kernel.
642 * Serializes pcmcia_device_add; will most likely be removed in future.
644 * While it has the caveat that adding new PCMCIA devices inside(!) device_register()
645 * won't work, this doesn't matter much at the moment: the driver core doesn't
648 static DEFINE_MUTEX(device_add_lock);
650 struct pcmcia_device * pcmcia_device_add(struct pcmcia_socket *s, unsigned int function)
652 struct pcmcia_device *p_dev, *tmp_dev;
656 s = pcmcia_get_socket(s);
660 mutex_lock(&device_add_lock);
662 ds_dbg(3, "adding device to %d, function %d\n", s->sock, function);
664 /* max of 4 devices per card */
665 if (s->device_count == 4)
668 p_dev = kzalloc(sizeof(struct pcmcia_device), GFP_KERNEL);
673 p_dev->device_no = (s->device_count++);
674 p_dev->func = function;
676 p_dev->dev.bus = &pcmcia_bus_type;
677 p_dev->dev.parent = s->dev.parent;
678 p_dev->dev.release = pcmcia_release_dev;
679 /* by default don't allow DMA */
680 p_dev->dma_mask = DMA_MASK_NONE;
681 p_dev->dev.dma_mask = &p_dev->dma_mask;
682 bus_id_len = sprintf (p_dev->dev.bus_id, "%d.%d", p_dev->socket->sock, p_dev->device_no);
684 p_dev->devname = kmalloc(6 + bus_id_len + 1, GFP_KERNEL);
687 sprintf (p_dev->devname, "pcmcia%s", p_dev->dev.bus_id);
688 ds_dbg(3, "devname is %s\n", p_dev->devname);
690 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
693 * p_dev->function_config must be the same for all card functions.
694 * Note that this is serialized by the device_add_lock, so that
695 * only one such struct will be created.
697 list_for_each_entry(tmp_dev, &s->devices_list, socket_device_list)
698 if (p_dev->func == tmp_dev->func) {
699 p_dev->function_config = tmp_dev->function_config;
700 kref_get(&p_dev->function_config->ref);
703 /* Add to the list in pcmcia_bus_socket */
704 list_add(&p_dev->socket_device_list, &s->devices_list);
706 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
708 if (!p_dev->function_config) {
709 ds_dbg(3, "creating config_t for %s\n", p_dev->dev.bus_id);
710 p_dev->function_config = kzalloc(sizeof(struct config_t),
712 if (!p_dev->function_config)
714 kref_init(&p_dev->function_config->ref);
717 printk(KERN_NOTICE "pcmcia: registering new device %s\n",
720 pcmcia_device_query(p_dev);
722 if (device_register(&p_dev->dev))
725 mutex_unlock(&device_add_lock);
730 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
731 list_del(&p_dev->socket_device_list);
732 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
735 kfree(p_dev->devname);
739 mutex_unlock(&device_add_lock);
740 pcmcia_put_socket(s);
746 static int pcmcia_card_add(struct pcmcia_socket *s)
748 cistpl_longlink_mfc_t mfc;
749 unsigned int no_funcs, i, no_chains;
752 if (!(s->resource_setup_done)) {
753 ds_dbg(3, "no resources available, delaying card_add\n");
754 return -EAGAIN; /* try again, but later... */
757 if (pcmcia_validate_mem(s)) {
758 ds_dbg(3, "validating mem resources failed, "
759 "delaying card_add\n");
760 return -EAGAIN; /* try again, but later... */
763 ret = pccard_validate_cis(s, BIND_FN_ALL, &no_chains);
764 if (ret || !no_chains) {
765 ds_dbg(0, "invalid CIS or invalid resources\n");
769 if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC, &mfc))
773 s->functions = no_funcs;
775 for (i=0; i < no_funcs; i++)
776 pcmcia_device_add(s, i);
782 static void pcmcia_delayed_add_device(struct work_struct *work)
784 struct pcmcia_socket *s =
785 container_of(work, struct pcmcia_socket, device_add);
786 ds_dbg(1, "adding additional device to %d\n", s->sock);
787 pcmcia_device_add(s, s->pcmcia_state.mfc_pfc);
788 s->pcmcia_state.device_add_pending = 0;
789 s->pcmcia_state.mfc_pfc = 0;
792 static int pcmcia_requery(struct device *dev, void * _data)
794 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
795 if (!p_dev->dev.driver) {
796 ds_dbg(1, "update device information for %s\n",
798 pcmcia_device_query(p_dev);
804 static void pcmcia_bus_rescan(struct pcmcia_socket *skt, int new_cis)
810 /* must be called with skt_mutex held */
811 ds_dbg(0, "re-scanning socket %d\n", skt->sock);
813 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
814 if (list_empty(&skt->devices_list))
816 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
818 /* If this is because of a CIS override, start over */
819 if (new_cis && !no_devices)
820 pcmcia_card_remove(skt, NULL);
822 /* if no devices were added for this socket yet because of
823 * missing resource information or other trouble, we need to
825 if (no_devices || new_cis) {
826 ret = pcmcia_card_add(skt);
831 /* some device information might have changed because of a CIS
832 * update or because we can finally read it correctly... so
833 * determine it again, overwriting old values if necessary. */
834 bus_for_each_dev(&pcmcia_bus_type, NULL, NULL, pcmcia_requery);
836 /* we re-scan all devices, not just the ones connected to this
837 * socket. This does not matter, though. */
838 ret = bus_rescan_devices(&pcmcia_bus_type);
840 printk(KERN_INFO "pcmcia: bus_rescan_devices failed\n");
843 #ifdef CONFIG_PCMCIA_LOAD_CIS
846 * pcmcia_load_firmware - load CIS from userspace if device-provided is broken
847 * @dev: the pcmcia device which needs a CIS override
848 * @filename: requested filename in /lib/firmware/
850 * This uses the in-kernel firmware loading mechanism to use a "fake CIS" if
851 * the one provided by the card is broken. The firmware files reside in
852 * /lib/firmware/ in userspace.
854 static int pcmcia_load_firmware(struct pcmcia_device *dev, char * filename)
856 struct pcmcia_socket *s = dev->socket;
857 const struct firmware *fw;
858 char path[FIRMWARE_NAME_MAX];
863 cistpl_longlink_mfc_t mfc;
868 ds_dbg(1, "trying to load CIS file %s\n", filename);
870 if (strlen(filename) > (FIRMWARE_NAME_MAX - 1)) {
871 printk(KERN_WARNING "pcmcia: CIS filename is too long [%s]\n",
876 snprintf(path, sizeof(path), "%s", filename);
878 if (request_firmware(&fw, path, &dev->dev) == 0) {
879 if (fw->size >= CISTPL_MAX_CIS_SIZE) {
881 printk(KERN_ERR "pcmcia: CIS override is too big\n");
885 cis = kzalloc(sizeof(cisdump_t), GFP_KERNEL);
891 cis->Length = fw->size + 1;
892 memcpy(cis->Data, fw->data, fw->size);
894 if (!pcmcia_replace_cis(s, cis))
897 printk(KERN_ERR "pcmcia: CIS override failed\n");
902 /* update information */
903 pcmcia_device_query(dev);
905 /* does this cis override add or remove functions? */
906 old_funcs = s->functions;
908 if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC, &mfc))
912 s->functions = no_funcs;
914 if (old_funcs > no_funcs)
915 pcmcia_card_remove(s, dev);
916 else if (no_funcs > old_funcs)
917 pcmcia_add_device_later(s, 1);
920 release_firmware(fw);
925 #else /* !CONFIG_PCMCIA_LOAD_CIS */
927 static inline int pcmcia_load_firmware(struct pcmcia_device *dev, char * filename)
935 static inline int pcmcia_devmatch(struct pcmcia_device *dev,
936 struct pcmcia_device_id *did)
938 if (did->match_flags & PCMCIA_DEV_ID_MATCH_MANF_ID) {
939 if ((!dev->has_manf_id) || (dev->manf_id != did->manf_id))
943 if (did->match_flags & PCMCIA_DEV_ID_MATCH_CARD_ID) {
944 if ((!dev->has_card_id) || (dev->card_id != did->card_id))
948 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNCTION) {
949 if (dev->func != did->function)
953 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID1) {
954 if (!dev->prod_id[0])
956 if (strcmp(did->prod_id[0], dev->prod_id[0]))
960 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID2) {
961 if (!dev->prod_id[1])
963 if (strcmp(did->prod_id[1], dev->prod_id[1]))
967 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID3) {
968 if (!dev->prod_id[2])
970 if (strcmp(did->prod_id[2], dev->prod_id[2]))
974 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID4) {
975 if (!dev->prod_id[3])
977 if (strcmp(did->prod_id[3], dev->prod_id[3]))
981 if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) {
982 if (dev->device_no != did->device_no)
986 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNC_ID) {
987 if ((!dev->has_func_id) || (dev->func_id != did->func_id))
990 /* if this is a pseudo-multi-function device,
991 * we need explicit matches */
992 if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO)
997 /* also, FUNC_ID matching needs to be activated by userspace
998 * after it has re-checked that there is no possible module
999 * with a prod_id/manf_id/card_id match.
1001 ds_dbg(0, "skipping FUNC_ID match for %s until userspace "
1002 "interaction\n", dev->dev.bus_id);
1003 if (!dev->allow_func_id_match)
1007 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FAKE_CIS) {
1008 ds_dbg(0, "device %s needs a fake CIS\n", dev->dev.bus_id);
1009 if (!dev->socket->fake_cis)
1010 pcmcia_load_firmware(dev, did->cisfile);
1012 if (!dev->socket->fake_cis)
1016 if (did->match_flags & PCMCIA_DEV_ID_MATCH_ANONYMOUS) {
1019 if (dev->prod_id[i])
1021 if (dev->has_manf_id || dev->has_card_id || dev->has_func_id)
1025 dev->dev.driver_data = (void *) did;
1031 static int pcmcia_bus_match(struct device * dev, struct device_driver * drv) {
1032 struct pcmcia_device * p_dev = to_pcmcia_dev(dev);
1033 struct pcmcia_driver * p_drv = to_pcmcia_drv(drv);
1034 struct pcmcia_device_id *did = p_drv->id_table;
1035 struct pcmcia_dynid *dynid;
1037 /* match dynamic devices first */
1038 spin_lock(&p_drv->dynids.lock);
1039 list_for_each_entry(dynid, &p_drv->dynids.list, node) {
1040 ds_dbg(3, "trying to match %s to %s\n", dev->bus_id,
1042 if (pcmcia_devmatch(p_dev, &dynid->id)) {
1043 ds_dbg(0, "matched %s to %s\n", dev->bus_id,
1045 spin_unlock(&p_drv->dynids.lock);
1049 spin_unlock(&p_drv->dynids.lock);
1051 #ifdef CONFIG_PCMCIA_IOCTL
1052 /* matching by cardmgr */
1053 if (p_dev->cardmgr == p_drv) {
1054 ds_dbg(0, "cardmgr matched %s to %s\n", dev->bus_id,
1060 while (did && did->match_flags) {
1061 ds_dbg(3, "trying to match %s to %s\n", dev->bus_id,
1063 if (pcmcia_devmatch(p_dev, did)) {
1064 ds_dbg(0, "matched %s to %s\n", dev->bus_id,
1074 #ifdef CONFIG_HOTPLUG
1076 static int pcmcia_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
1078 struct pcmcia_device *p_dev;
1080 u32 hash[4] = { 0, 0, 0, 0};
1085 p_dev = to_pcmcia_dev(dev);
1087 /* calculate hashes */
1088 for (i=0; i<4; i++) {
1089 if (!p_dev->prod_id[i])
1091 hash[i] = crc32(0, p_dev->prod_id[i], strlen(p_dev->prod_id[i]));
1094 if (add_uevent_var(env, "SOCKET_NO=%u", p_dev->socket->sock))
1097 if (add_uevent_var(env, "DEVICE_NO=%02X", p_dev->device_no))
1100 if (add_uevent_var(env, "MODALIAS=pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
1101 "pa%08Xpb%08Xpc%08Xpd%08X",
1102 p_dev->has_manf_id ? p_dev->manf_id : 0,
1103 p_dev->has_card_id ? p_dev->card_id : 0,
1104 p_dev->has_func_id ? p_dev->func_id : 0,
1118 static int pcmcia_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
1125 /************************ runtime PM support ***************************/
1127 static int pcmcia_dev_suspend(struct device *dev, pm_message_t state);
1128 static int pcmcia_dev_resume(struct device *dev);
1130 static int runtime_suspend(struct device *dev)
1135 rc = pcmcia_dev_suspend(dev, PMSG_SUSPEND);
1140 static void runtime_resume(struct device *dev)
1145 rc = pcmcia_dev_resume(dev);
1149 /************************ per-device sysfs output ***************************/
1151 #define pcmcia_device_attr(field, test, format) \
1152 static ssize_t field##_show (struct device *dev, struct device_attribute *attr, char *buf) \
1154 struct pcmcia_device *p_dev = to_pcmcia_dev(dev); \
1155 return p_dev->test ? sprintf (buf, format, p_dev->field) : -ENODEV; \
1158 #define pcmcia_device_stringattr(name, field) \
1159 static ssize_t name##_show (struct device *dev, struct device_attribute *attr, char *buf) \
1161 struct pcmcia_device *p_dev = to_pcmcia_dev(dev); \
1162 return p_dev->field ? sprintf (buf, "%s\n", p_dev->field) : -ENODEV; \
1165 pcmcia_device_attr(func, socket, "0x%02x\n");
1166 pcmcia_device_attr(func_id, has_func_id, "0x%02x\n");
1167 pcmcia_device_attr(manf_id, has_manf_id, "0x%04x\n");
1168 pcmcia_device_attr(card_id, has_card_id, "0x%04x\n");
1169 pcmcia_device_stringattr(prod_id1, prod_id[0]);
1170 pcmcia_device_stringattr(prod_id2, prod_id[1]);
1171 pcmcia_device_stringattr(prod_id3, prod_id[2]);
1172 pcmcia_device_stringattr(prod_id4, prod_id[3]);
1175 static ssize_t pcmcia_show_pm_state(struct device *dev, struct device_attribute *attr, char *buf)
1177 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1179 if (p_dev->suspended)
1180 return sprintf(buf, "off\n");
1182 return sprintf(buf, "on\n");
1185 static ssize_t pcmcia_store_pm_state(struct device *dev, struct device_attribute *attr,
1186 const char *buf, size_t count)
1188 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1194 if ((!p_dev->suspended) && !strncmp(buf, "off", 3))
1195 ret = runtime_suspend(dev);
1196 else if (p_dev->suspended && !strncmp(buf, "on", 2))
1197 runtime_resume(dev);
1199 return ret ? ret : count;
1203 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
1205 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1207 u32 hash[4] = { 0, 0, 0, 0};
1209 /* calculate hashes */
1210 for (i=0; i<4; i++) {
1211 if (!p_dev->prod_id[i])
1213 hash[i] = crc32(0,p_dev->prod_id[i],strlen(p_dev->prod_id[i]));
1215 return sprintf(buf, "pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
1216 "pa%08Xpb%08Xpc%08Xpd%08X\n",
1217 p_dev->has_manf_id ? p_dev->manf_id : 0,
1218 p_dev->has_card_id ? p_dev->card_id : 0,
1219 p_dev->has_func_id ? p_dev->func_id : 0,
1220 p_dev->func, p_dev->device_no,
1221 hash[0], hash[1], hash[2], hash[3]);
1224 static ssize_t pcmcia_store_allow_func_id_match(struct device *dev,
1225 struct device_attribute *attr, const char *buf, size_t count)
1227 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1233 mutex_lock(&p_dev->socket->skt_mutex);
1234 p_dev->allow_func_id_match = 1;
1235 mutex_unlock(&p_dev->socket->skt_mutex);
1237 ret = bus_rescan_devices(&pcmcia_bus_type);
1239 printk(KERN_INFO "pcmcia: bus_rescan_devices failed after "
1240 "allowing func_id matches\n");
1245 static struct device_attribute pcmcia_dev_attrs[] = {
1246 __ATTR(function, 0444, func_show, NULL),
1247 __ATTR(pm_state, 0644, pcmcia_show_pm_state, pcmcia_store_pm_state),
1251 __ATTR_RO(prod_id1),
1252 __ATTR_RO(prod_id2),
1253 __ATTR_RO(prod_id3),
1254 __ATTR_RO(prod_id4),
1255 __ATTR_RO(modalias),
1256 __ATTR(allow_func_id_match, 0200, NULL, pcmcia_store_allow_func_id_match),
1260 /* PM support, also needed for reset */
1262 static int pcmcia_dev_suspend(struct device * dev, pm_message_t state)
1264 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1265 struct pcmcia_driver *p_drv = NULL;
1268 if (p_dev->suspended)
1271 ds_dbg(2, "suspending %s\n", dev->bus_id);
1274 p_drv = to_pcmcia_drv(dev->driver);
1279 if (p_drv->suspend) {
1280 ret = p_drv->suspend(p_dev);
1282 printk(KERN_ERR "pcmcia: device %s (driver %s) did "
1283 "not want to go to sleep (%d)\n",
1284 p_dev->devname, p_drv->drv.name, ret);
1289 if (p_dev->device_no == p_dev->func) {
1290 ds_dbg(2, "releasing configuration for %s\n", dev->bus_id);
1291 pcmcia_release_configuration(p_dev);
1296 p_dev->suspended = 1;
1301 static int pcmcia_dev_resume(struct device * dev)
1303 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1304 struct pcmcia_driver *p_drv = NULL;
1307 if (!p_dev->suspended)
1310 ds_dbg(2, "resuming %s\n", dev->bus_id);
1313 p_drv = to_pcmcia_drv(dev->driver);
1318 if (p_dev->device_no == p_dev->func) {
1319 ds_dbg(2, "requesting configuration for %s\n", dev->bus_id);
1320 ret = pcmcia_request_configuration(p_dev, &p_dev->conf);
1326 ret = p_drv->resume(p_dev);
1330 p_dev->suspended = 0;
1335 static int pcmcia_bus_suspend_callback(struct device *dev, void * _data)
1337 struct pcmcia_socket *skt = _data;
1338 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1340 if (p_dev->socket != skt || p_dev->suspended)
1343 return runtime_suspend(dev);
1346 static int pcmcia_bus_resume_callback(struct device *dev, void * _data)
1348 struct pcmcia_socket *skt = _data;
1349 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1351 if (p_dev->socket != skt || !p_dev->suspended)
1354 runtime_resume(dev);
1359 static int pcmcia_bus_resume(struct pcmcia_socket *skt)
1361 ds_dbg(2, "resuming socket %d\n", skt->sock);
1362 bus_for_each_dev(&pcmcia_bus_type, NULL, skt, pcmcia_bus_resume_callback);
1366 static int pcmcia_bus_suspend(struct pcmcia_socket *skt)
1368 ds_dbg(2, "suspending socket %d\n", skt->sock);
1369 if (bus_for_each_dev(&pcmcia_bus_type, NULL, skt,
1370 pcmcia_bus_suspend_callback)) {
1371 pcmcia_bus_resume(skt);
1378 /*======================================================================
1380 The card status event handler.
1382 ======================================================================*/
1384 /* Normally, the event is passed to individual drivers after
1385 * informing userspace. Only for CS_EVENT_CARD_REMOVAL this
1386 * is inversed to maintain historic compatibility.
1389 static int ds_event(struct pcmcia_socket *skt, event_t event, int priority)
1391 struct pcmcia_socket *s = pcmcia_get_socket(skt);
1394 printk(KERN_ERR "PCMCIA obtaining reference to socket %p " \
1395 "failed, event 0x%x lost!\n", skt, event);
1399 ds_dbg(1, "ds_event(0x%06x, %d, 0x%p)\n",
1400 event, priority, skt);
1403 case CS_EVENT_CARD_REMOVAL:
1404 s->pcmcia_state.present = 0;
1405 pcmcia_card_remove(skt, NULL);
1406 handle_event(skt, event);
1409 case CS_EVENT_CARD_INSERTION:
1410 s->pcmcia_state.present = 1;
1411 pcmcia_card_add(skt);
1412 handle_event(skt, event);
1415 case CS_EVENT_EJECTION_REQUEST:
1418 case CS_EVENT_PM_SUSPEND:
1419 case CS_EVENT_PM_RESUME:
1420 case CS_EVENT_RESET_PHYSICAL:
1421 case CS_EVENT_CARD_RESET:
1423 handle_event(skt, event);
1427 pcmcia_put_socket(s);
1433 struct pcmcia_device * pcmcia_dev_present(struct pcmcia_device *_p_dev)
1435 struct pcmcia_device *p_dev;
1436 struct pcmcia_device *ret = NULL;
1438 p_dev = pcmcia_get_dev(_p_dev);
1442 if (!p_dev->socket->pcmcia_state.present)
1445 if (p_dev->_removed)
1448 if (p_dev->suspended)
1453 pcmcia_put_dev(p_dev);
1456 EXPORT_SYMBOL(pcmcia_dev_present);
1459 static struct pcmcia_callback pcmcia_bus_callback = {
1460 .owner = THIS_MODULE,
1462 .requery = pcmcia_bus_rescan,
1463 .suspend = pcmcia_bus_suspend,
1464 .resume = pcmcia_bus_resume,
1467 static int __devinit pcmcia_bus_add_socket(struct device *dev,
1468 struct class_interface *class_intf)
1470 struct pcmcia_socket *socket = dev_get_drvdata(dev);
1473 socket = pcmcia_get_socket(socket);
1475 printk(KERN_ERR "PCMCIA obtaining reference to socket %p failed\n", socket);
1480 * Ugly. But we want to wait for the socket threads to have started up.
1481 * We really should let the drivers themselves drive some of this..
1485 #ifdef CONFIG_PCMCIA_IOCTL
1486 init_waitqueue_head(&socket->queue);
1488 INIT_LIST_HEAD(&socket->devices_list);
1489 INIT_WORK(&socket->device_add, pcmcia_delayed_add_device);
1490 memset(&socket->pcmcia_state, 0, sizeof(u8));
1491 socket->device_count = 0;
1493 ret = pccard_register_pcmcia(socket, &pcmcia_bus_callback);
1495 printk(KERN_ERR "PCMCIA registration PCCard core failed for socket %p\n", socket);
1496 pcmcia_put_socket(socket);
1503 static void pcmcia_bus_remove_socket(struct device *dev,
1504 struct class_interface *class_intf)
1506 struct pcmcia_socket *socket = dev_get_drvdata(dev);
1511 socket->pcmcia_state.dead = 1;
1512 pccard_register_pcmcia(socket, NULL);
1514 /* unregister any unbound devices */
1515 mutex_lock(&socket->skt_mutex);
1516 pcmcia_card_remove(socket, NULL);
1517 mutex_unlock(&socket->skt_mutex);
1519 pcmcia_put_socket(socket);
1525 /* the pcmcia_bus_interface is used to handle pcmcia socket devices */
1526 static struct class_interface pcmcia_bus_interface __refdata = {
1527 .class = &pcmcia_socket_class,
1528 .add_dev = &pcmcia_bus_add_socket,
1529 .remove_dev = &pcmcia_bus_remove_socket,
1533 struct bus_type pcmcia_bus_type = {
1535 .uevent = pcmcia_bus_uevent,
1536 .match = pcmcia_bus_match,
1537 .dev_attrs = pcmcia_dev_attrs,
1538 .probe = pcmcia_device_probe,
1539 .remove = pcmcia_device_remove,
1540 .suspend = pcmcia_dev_suspend,
1541 .resume = pcmcia_dev_resume,
1545 static int __init init_pcmcia_bus(void)
1549 spin_lock_init(&pcmcia_dev_list_lock);
1551 ret = bus_register(&pcmcia_bus_type);
1553 printk(KERN_WARNING "pcmcia: bus_register error: %d\n", ret);
1556 ret = class_interface_register(&pcmcia_bus_interface);
1559 "pcmcia: class_interface_register error: %d\n", ret);
1560 bus_unregister(&pcmcia_bus_type);
1564 pcmcia_setup_ioctl();
1568 fs_initcall(init_pcmcia_bus); /* one level after subsys_initcall so that
1569 * pcmcia_socket_class is already registered */
1572 static void __exit exit_pcmcia_bus(void)
1574 pcmcia_cleanup_ioctl();
1576 class_interface_unregister(&pcmcia_bus_interface);
1578 bus_unregister(&pcmcia_bus_type);
1580 module_exit(exit_pcmcia_bus);