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 { CS_BAD_BASE, "Bad base address" },
79 { CS_BAD_IRQ, "Bad IRQ" },
80 { CS_BAD_OFFSET, "Bad offset" },
81 { CS_BAD_SIZE, "Bad size" },
82 { -EIO, "Input/Output error" },
83 { -ENODEV, "No card present" },
84 { -EINVAL, "Bad parameter" },
85 { CS_BAD_ARGS, "Bad arguments" },
86 { -EACCES, "Configuration locked" },
87 { -EBUSY, "Resource in use" },
88 { -ENOSPC, "No more items" },
89 { -ENOMEM, "Out of resource" },
90 { CS_BAD_TUPLE, "Bad CIS tuple" }
94 static const lookup_t service_table[] = {
95 { AccessConfigurationRegister, "AccessConfigurationRegister" },
96 { AddSocketServices, "AddSocketServices" },
97 { AdjustResourceInfo, "AdjustResourceInfo" },
98 { CheckEraseQueue, "CheckEraseQueue" },
99 { CloseMemory, "CloseMemory" },
100 { DeregisterClient, "DeregisterClient" },
101 { DeregisterEraseQueue, "DeregisterEraseQueue" },
102 { GetCardServicesInfo, "GetCardServicesInfo" },
103 { GetClientInfo, "GetClientInfo" },
104 { GetConfigurationInfo, "GetConfigurationInfo" },
105 { GetEventMask, "GetEventMask" },
106 { GetFirstClient, "GetFirstClient" },
107 { GetFirstRegion, "GetFirstRegion" },
108 { GetFirstTuple, "GetFirstTuple" },
109 { GetNextClient, "GetNextClient" },
110 { GetNextRegion, "GetNextRegion" },
111 { GetNextTuple, "GetNextTuple" },
112 { GetStatus, "GetStatus" },
113 { GetTupleData, "GetTupleData" },
114 { MapMemPage, "MapMemPage" },
115 { ModifyConfiguration, "ModifyConfiguration" },
116 { ModifyWindow, "ModifyWindow" },
117 { OpenMemory, "OpenMemory" },
118 { ParseTuple, "ParseTuple" },
119 { ReadMemory, "ReadMemory" },
120 { RegisterClient, "RegisterClient" },
121 { RegisterEraseQueue, "RegisterEraseQueue" },
122 { RegisterMTD, "RegisterMTD" },
123 { ReleaseConfiguration, "ReleaseConfiguration" },
124 { ReleaseIO, "ReleaseIO" },
125 { ReleaseIRQ, "ReleaseIRQ" },
126 { ReleaseWindow, "ReleaseWindow" },
127 { RequestConfiguration, "RequestConfiguration" },
128 { RequestIO, "RequestIO" },
129 { RequestIRQ, "RequestIRQ" },
130 { RequestSocketMask, "RequestSocketMask" },
131 { RequestWindow, "RequestWindow" },
132 { ResetCard, "ResetCard" },
133 { SetEventMask, "SetEventMask" },
134 { ValidateCIS, "ValidateCIS" },
135 { WriteMemory, "WriteMemory" },
136 { BindDevice, "BindDevice" },
137 { BindMTD, "BindMTD" },
138 { ReportError, "ReportError" },
139 { SuspendCard, "SuspendCard" },
140 { ResumeCard, "ResumeCard" },
141 { EjectCard, "EjectCard" },
142 { InsertCard, "InsertCard" },
143 { ReplaceCIS, "ReplaceCIS" }
147 static int pcmcia_report_error(struct pcmcia_device *p_dev, error_info_t *err)
155 printk(KERN_NOTICE "%s: ", p_dev->dev.bus_id);
157 for (i = 0; i < ARRAY_SIZE(service_table); i++)
158 if (service_table[i].key == err->func)
160 if (i < ARRAY_SIZE(service_table))
161 serv = service_table[i].msg;
163 serv = "Unknown service number";
165 for (i = 0; i < ARRAY_SIZE(error_table); i++)
166 if (error_table[i].key == err->retcode)
168 if (i < ARRAY_SIZE(error_table))
169 printk("%s: %s\n", serv, error_table[i].msg);
171 printk("%s: Unknown error code %#x\n", serv, err->retcode);
176 /* end of code which was in cs.c before */
178 /*======================================================================*/
180 void cs_error(struct pcmcia_device *p_dev, int func, int ret)
182 error_info_t err = { func, ret };
183 pcmcia_report_error(p_dev, &err);
185 EXPORT_SYMBOL(cs_error);
188 static void pcmcia_check_driver(struct pcmcia_driver *p_drv)
190 struct pcmcia_device_id *did = p_drv->id_table;
194 if (!p_drv->probe || !p_drv->remove)
195 printk(KERN_DEBUG "pcmcia: %s lacks a requisite callback "
196 "function\n", p_drv->drv.name);
198 while (did && did->match_flags) {
199 for (i=0; i<4; i++) {
200 if (!did->prod_id[i])
203 hash = crc32(0, did->prod_id[i], strlen(did->prod_id[i]));
204 if (hash == did->prod_id_hash[i])
207 printk(KERN_DEBUG "pcmcia: %s: invalid hash for "
208 "product string \"%s\": is 0x%x, should "
209 "be 0x%x\n", p_drv->drv.name, did->prod_id[i],
210 did->prod_id_hash[i], hash);
211 printk(KERN_DEBUG "pcmcia: see "
212 "Documentation/pcmcia/devicetable.txt for "
222 /*======================================================================*/
225 struct pcmcia_dynid {
226 struct list_head node;
227 struct pcmcia_device_id id;
231 * pcmcia_store_new_id - add a new PCMCIA device ID to this driver and re-probe devices
232 * @driver: target device driver
233 * @buf: buffer for scanning device ID data
236 * Adds a new dynamic PCMCIA device ID to this driver,
237 * and causes the driver to probe for all devices again.
240 pcmcia_store_new_id(struct device_driver *driver, const char *buf, size_t count)
242 struct pcmcia_dynid *dynid;
243 struct pcmcia_driver *pdrv = to_pcmcia_drv(driver);
244 __u16 match_flags, manf_id, card_id;
245 __u8 func_id, function, device_no;
246 __u32 prod_id_hash[4] = {0, 0, 0, 0};
250 fields = sscanf(buf, "%hx %hx %hx %hhx %hhx %hhx %x %x %x %x",
251 &match_flags, &manf_id, &card_id, &func_id, &function, &device_no,
252 &prod_id_hash[0], &prod_id_hash[1], &prod_id_hash[2], &prod_id_hash[3]);
256 dynid = kzalloc(sizeof(struct pcmcia_dynid), GFP_KERNEL);
260 INIT_LIST_HEAD(&dynid->node);
261 dynid->id.match_flags = match_flags;
262 dynid->id.manf_id = manf_id;
263 dynid->id.card_id = card_id;
264 dynid->id.func_id = func_id;
265 dynid->id.function = function;
266 dynid->id.device_no = device_no;
267 memcpy(dynid->id.prod_id_hash, prod_id_hash, sizeof(__u32) * 4);
269 spin_lock(&pdrv->dynids.lock);
270 list_add_tail(&pdrv->dynids.list, &dynid->node);
271 spin_unlock(&pdrv->dynids.lock);
273 if (get_driver(&pdrv->drv)) {
274 retval = driver_attach(&pdrv->drv);
275 put_driver(&pdrv->drv);
282 static DRIVER_ATTR(new_id, S_IWUSR, NULL, pcmcia_store_new_id);
285 pcmcia_free_dynids(struct pcmcia_driver *drv)
287 struct pcmcia_dynid *dynid, *n;
289 spin_lock(&drv->dynids.lock);
290 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
291 list_del(&dynid->node);
294 spin_unlock(&drv->dynids.lock);
298 pcmcia_create_newid_file(struct pcmcia_driver *drv)
301 if (drv->probe != NULL)
302 error = driver_create_file(&drv->drv, &driver_attr_new_id);
308 * pcmcia_register_driver - register a PCMCIA driver with the bus core
309 * @driver: the &driver being registered
311 * Registers a PCMCIA driver with the PCMCIA bus core.
313 int pcmcia_register_driver(struct pcmcia_driver *driver)
320 pcmcia_check_driver(driver);
322 /* initialize common fields */
323 driver->drv.bus = &pcmcia_bus_type;
324 driver->drv.owner = driver->owner;
325 spin_lock_init(&driver->dynids.lock);
326 INIT_LIST_HEAD(&driver->dynids.list);
328 ds_dbg(3, "registering driver %s\n", driver->drv.name);
330 error = driver_register(&driver->drv);
334 error = pcmcia_create_newid_file(driver);
336 driver_unregister(&driver->drv);
340 EXPORT_SYMBOL(pcmcia_register_driver);
343 * pcmcia_unregister_driver - unregister a PCMCIA driver with the bus core
344 * @driver: the &driver being unregistered
346 void pcmcia_unregister_driver(struct pcmcia_driver *driver)
348 ds_dbg(3, "unregistering driver %s\n", driver->drv.name);
349 driver_unregister(&driver->drv);
350 pcmcia_free_dynids(driver);
352 EXPORT_SYMBOL(pcmcia_unregister_driver);
355 /* pcmcia_device handling */
357 struct pcmcia_device * pcmcia_get_dev(struct pcmcia_device *p_dev)
359 struct device *tmp_dev;
360 tmp_dev = get_device(&p_dev->dev);
363 return to_pcmcia_dev(tmp_dev);
366 void pcmcia_put_dev(struct pcmcia_device *p_dev)
369 put_device(&p_dev->dev);
372 static void pcmcia_release_function(struct kref *ref)
374 struct config_t *c = container_of(ref, struct config_t, ref);
375 ds_dbg(1, "releasing config_t\n");
379 static void pcmcia_release_dev(struct device *dev)
381 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
382 ds_dev_dbg(1, dev, "releasing device\n");
383 pcmcia_put_socket(p_dev->socket);
384 kfree(p_dev->devname);
385 kref_put(&p_dev->function_config->ref, pcmcia_release_function);
389 static void pcmcia_add_device_later(struct pcmcia_socket *s, int mfc)
391 if (!s->pcmcia_state.device_add_pending) {
392 ds_dev_dbg(1, &s->dev, "scheduling to add %s secondary"
393 " device to %d\n", mfc ? "mfc" : "pfc", s->sock);
394 s->pcmcia_state.device_add_pending = 1;
395 s->pcmcia_state.mfc_pfc = mfc;
396 schedule_work(&s->device_add);
401 static int pcmcia_device_probe(struct device * dev)
403 struct pcmcia_device *p_dev;
404 struct pcmcia_driver *p_drv;
405 struct pcmcia_device_id *did;
406 struct pcmcia_socket *s;
407 cistpl_config_t cis_config;
410 dev = get_device(dev);
414 p_dev = to_pcmcia_dev(dev);
415 p_drv = to_pcmcia_drv(dev->driver);
418 ds_dev_dbg(1, dev, "trying to bind to %s\n", p_drv->drv.name);
420 if ((!p_drv->probe) || (!p_dev->function_config) ||
421 (!try_module_get(p_drv->owner))) {
426 /* set up some more device information */
427 ret = pccard_read_tuple(p_dev->socket, p_dev->func, CISTPL_CONFIG,
430 p_dev->conf.ConfigBase = cis_config.base;
431 p_dev->conf.Present = cis_config.rmask[0];
433 dev_printk(KERN_INFO, dev,
434 "pcmcia: could not parse base and rmask0 of CIS\n");
435 p_dev->conf.ConfigBase = 0;
436 p_dev->conf.Present = 0;
439 ret = p_drv->probe(p_dev);
441 ds_dev_dbg(1, dev, "binding to %s failed with %d\n",
442 p_drv->drv.name, ret);
446 /* handle pseudo multifunction devices:
447 * there are at most two pseudo multifunction devices.
448 * if we're matching against the first, schedule a
449 * call which will then check whether there are two
450 * pseudo devices, and if not, add the second one.
452 did = p_dev->dev.driver_data;
453 if (did && (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) &&
454 (p_dev->socket->device_count == 1) && (p_dev->device_no == 0))
455 pcmcia_add_device_later(p_dev->socket, 0);
459 module_put(p_drv->owner);
468 * Removes a PCMCIA card from the device tree and socket list.
470 static void pcmcia_card_remove(struct pcmcia_socket *s, struct pcmcia_device *leftover)
472 struct pcmcia_device *p_dev;
473 struct pcmcia_device *tmp;
476 ds_dev_dbg(2, leftover ? &leftover->dev : &s->dev,
477 "pcmcia_card_remove(%d) %s\n", s->sock,
478 leftover ? leftover->devname : "");
485 /* unregister all pcmcia_devices registered with this socket, except leftover */
486 list_for_each_entry_safe(p_dev, tmp, &s->devices_list, socket_device_list) {
487 if (p_dev == leftover)
490 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
491 list_del(&p_dev->socket_device_list);
493 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
495 ds_dev_dbg(2, &p_dev->dev, "unregistering device\n");
496 device_unregister(&p_dev->dev);
502 static int pcmcia_device_remove(struct device * dev)
504 struct pcmcia_device *p_dev;
505 struct pcmcia_driver *p_drv;
506 struct pcmcia_device_id *did;
509 p_dev = to_pcmcia_dev(dev);
510 p_drv = to_pcmcia_drv(dev->driver);
512 ds_dev_dbg(1, dev, "removing device\n");
514 /* If we're removing the primary module driving a
515 * pseudo multi-function card, we need to unbind
518 did = p_dev->dev.driver_data;
519 if (did && (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) &&
520 (p_dev->socket->device_count != 0) &&
521 (p_dev->device_no == 0))
522 pcmcia_card_remove(p_dev->socket, p_dev);
524 /* detach the "instance" */
529 p_drv->remove(p_dev);
531 p_dev->dev_node = NULL;
533 /* check for proper unloading */
534 if (p_dev->_irq || p_dev->_io || p_dev->_locked)
535 dev_printk(KERN_INFO, dev,
536 "pcmcia: driver %s did not release config properly\n",
539 for (i = 0; i < MAX_WIN; i++)
540 if (p_dev->_win & CLIENT_WIN_REQ(i))
541 dev_printk(KERN_INFO, dev,
542 "pcmcia: driver %s did not release window properly\n",
545 /* references from pcmcia_probe_device */
546 pcmcia_put_dev(p_dev);
547 module_put(p_drv->owner);
554 * pcmcia_device_query -- determine information about a pcmcia device
556 static int pcmcia_device_query(struct pcmcia_device *p_dev)
558 cistpl_manfid_t manf_id;
559 cistpl_funcid_t func_id;
560 cistpl_vers_1_t *vers1;
563 vers1 = kmalloc(sizeof(*vers1), GFP_KERNEL);
567 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
568 CISTPL_MANFID, &manf_id)) {
569 p_dev->manf_id = manf_id.manf;
570 p_dev->card_id = manf_id.card;
571 p_dev->has_manf_id = 1;
572 p_dev->has_card_id = 1;
575 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
576 CISTPL_FUNCID, &func_id)) {
577 p_dev->func_id = func_id.func;
578 p_dev->has_func_id = 1;
580 /* rule of thumb: cards with no FUNCID, but with
581 * common memory device geometry information, are
582 * probably memory cards (from pcmcia-cs) */
583 cistpl_device_geo_t *devgeo;
585 devgeo = kmalloc(sizeof(*devgeo), GFP_KERNEL);
590 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
591 CISTPL_DEVICE_GEO, devgeo)) {
592 ds_dev_dbg(0, &p_dev->dev,
593 "mem device geometry probably means "
595 p_dev->func_id = CISTPL_FUNCID_MEMORY;
596 p_dev->has_func_id = 1;
601 if (!pccard_read_tuple(p_dev->socket, p_dev->func, CISTPL_VERS_1,
603 for (i=0; i < vers1->ns; i++) {
607 tmp = vers1->str + vers1->ofs[i];
609 length = strlen(tmp) + 1;
610 if ((length < 2) || (length > 255))
613 p_dev->prod_id[i] = kmalloc(sizeof(char) * length,
615 if (!p_dev->prod_id[i])
618 p_dev->prod_id[i] = strncpy(p_dev->prod_id[i],
628 /* device_add_lock is needed to avoid double registration by cardmgr and kernel.
629 * Serializes pcmcia_device_add; will most likely be removed in future.
631 * While it has the caveat that adding new PCMCIA devices inside(!) device_register()
632 * won't work, this doesn't matter much at the moment: the driver core doesn't
635 static DEFINE_MUTEX(device_add_lock);
637 struct pcmcia_device * pcmcia_device_add(struct pcmcia_socket *s, unsigned int function)
639 struct pcmcia_device *p_dev, *tmp_dev;
643 s = pcmcia_get_socket(s);
647 mutex_lock(&device_add_lock);
649 ds_dbg(3, "adding device to %d, function %d\n", s->sock, function);
651 /* max of 4 devices per card */
652 if (s->device_count == 4)
655 p_dev = kzalloc(sizeof(struct pcmcia_device), GFP_KERNEL);
660 p_dev->device_no = (s->device_count++);
661 p_dev->func = function;
663 p_dev->dev.bus = &pcmcia_bus_type;
664 p_dev->dev.parent = s->dev.parent;
665 p_dev->dev.release = pcmcia_release_dev;
666 /* by default don't allow DMA */
667 p_dev->dma_mask = DMA_MASK_NONE;
668 p_dev->dev.dma_mask = &p_dev->dma_mask;
669 bus_id_len = sprintf (p_dev->dev.bus_id, "%d.%d", p_dev->socket->sock, p_dev->device_no);
671 p_dev->devname = kmalloc(6 + bus_id_len + 1, GFP_KERNEL);
674 sprintf (p_dev->devname, "pcmcia%s", p_dev->dev.bus_id);
675 ds_dev_dbg(3, &p_dev->dev, "devname is %s\n", p_dev->devname);
677 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
680 * p_dev->function_config must be the same for all card functions.
681 * Note that this is serialized by the device_add_lock, so that
682 * only one such struct will be created.
684 list_for_each_entry(tmp_dev, &s->devices_list, socket_device_list)
685 if (p_dev->func == tmp_dev->func) {
686 p_dev->function_config = tmp_dev->function_config;
687 kref_get(&p_dev->function_config->ref);
690 /* Add to the list in pcmcia_bus_socket */
691 list_add(&p_dev->socket_device_list, &s->devices_list);
693 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
695 if (!p_dev->function_config) {
696 ds_dev_dbg(3, &p_dev->dev, "creating config_t\n");
697 p_dev->function_config = kzalloc(sizeof(struct config_t),
699 if (!p_dev->function_config)
701 kref_init(&p_dev->function_config->ref);
704 dev_printk(KERN_NOTICE, &p_dev->dev,
705 "pcmcia: registering new device %s\n",
708 pcmcia_device_query(p_dev);
710 if (device_register(&p_dev->dev))
713 mutex_unlock(&device_add_lock);
718 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
719 list_del(&p_dev->socket_device_list);
720 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
723 kfree(p_dev->devname);
727 mutex_unlock(&device_add_lock);
728 pcmcia_put_socket(s);
734 static int pcmcia_card_add(struct pcmcia_socket *s)
736 cistpl_longlink_mfc_t mfc;
737 unsigned int no_funcs, i, no_chains;
740 if (!(s->resource_setup_done)) {
741 ds_dev_dbg(3, &s->dev,
742 "no resources available, delaying card_add\n");
743 return -EAGAIN; /* try again, but later... */
746 if (pcmcia_validate_mem(s)) {
747 ds_dev_dbg(3, &s->dev, "validating mem resources failed, "
748 "delaying card_add\n");
749 return -EAGAIN; /* try again, but later... */
752 ret = pccard_validate_cis(s, BIND_FN_ALL, &no_chains);
753 if (ret || !no_chains) {
754 ds_dev_dbg(0, &s->dev, "invalid CIS or invalid resources\n");
758 if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC, &mfc))
762 s->functions = no_funcs;
764 for (i=0; i < no_funcs; i++)
765 pcmcia_device_add(s, i);
771 static void pcmcia_delayed_add_device(struct work_struct *work)
773 struct pcmcia_socket *s =
774 container_of(work, struct pcmcia_socket, device_add);
775 ds_dev_dbg(1, &s->dev, "adding additional device to %d\n", s->sock);
776 pcmcia_device_add(s, s->pcmcia_state.mfc_pfc);
777 s->pcmcia_state.device_add_pending = 0;
778 s->pcmcia_state.mfc_pfc = 0;
781 static int pcmcia_requery(struct device *dev, void * _data)
783 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
784 if (!p_dev->dev.driver) {
785 ds_dev_dbg(1, dev, "update device information\n");
786 pcmcia_device_query(p_dev);
792 static void pcmcia_bus_rescan(struct pcmcia_socket *skt, int new_cis)
798 /* must be called with skt_mutex held */
799 ds_dev_dbg(0, &skt->dev, "re-scanning socket %d\n", skt->sock);
801 spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
802 if (list_empty(&skt->devices_list))
804 spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
806 /* If this is because of a CIS override, start over */
807 if (new_cis && !no_devices)
808 pcmcia_card_remove(skt, NULL);
810 /* if no devices were added for this socket yet because of
811 * missing resource information or other trouble, we need to
813 if (no_devices || new_cis) {
814 ret = pcmcia_card_add(skt);
819 /* some device information might have changed because of a CIS
820 * update or because we can finally read it correctly... so
821 * determine it again, overwriting old values if necessary. */
822 bus_for_each_dev(&pcmcia_bus_type, NULL, NULL, pcmcia_requery);
824 /* we re-scan all devices, not just the ones connected to this
825 * socket. This does not matter, though. */
826 ret = bus_rescan_devices(&pcmcia_bus_type);
828 printk(KERN_INFO "pcmcia: bus_rescan_devices failed\n");
831 #ifdef CONFIG_PCMCIA_LOAD_CIS
834 * pcmcia_load_firmware - load CIS from userspace if device-provided is broken
835 * @dev: the pcmcia device which needs a CIS override
836 * @filename: requested filename in /lib/firmware/
838 * This uses the in-kernel firmware loading mechanism to use a "fake CIS" if
839 * the one provided by the card is broken. The firmware files reside in
840 * /lib/firmware/ in userspace.
842 static int pcmcia_load_firmware(struct pcmcia_device *dev, char * filename)
844 struct pcmcia_socket *s = dev->socket;
845 const struct firmware *fw;
846 char path[FIRMWARE_NAME_MAX];
850 cistpl_longlink_mfc_t mfc;
855 ds_dev_dbg(1, &dev->dev, "trying to load CIS file %s\n", filename);
857 if (strlen(filename) > (FIRMWARE_NAME_MAX - 1)) {
858 dev_printk(KERN_WARNING, &dev->dev,
859 "pcmcia: CIS filename is too long [%s]\n",
864 snprintf(path, sizeof(path), "%s", filename);
866 if (request_firmware(&fw, path, &dev->dev) == 0) {
867 if (fw->size >= CISTPL_MAX_CIS_SIZE) {
869 dev_printk(KERN_ERR, &dev->dev,
870 "pcmcia: CIS override is too big\n");
874 if (!pcmcia_replace_cis(s, fw->data, fw->size))
877 dev_printk(KERN_ERR, &dev->dev,
878 "pcmcia: CIS override failed\n");
883 /* update information */
884 pcmcia_device_query(dev);
886 /* does this cis override add or remove functions? */
887 old_funcs = s->functions;
889 if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC, &mfc))
893 s->functions = no_funcs;
895 if (old_funcs > no_funcs)
896 pcmcia_card_remove(s, dev);
897 else if (no_funcs > old_funcs)
898 pcmcia_add_device_later(s, 1);
901 release_firmware(fw);
906 #else /* !CONFIG_PCMCIA_LOAD_CIS */
908 static inline int pcmcia_load_firmware(struct pcmcia_device *dev, char * filename)
916 static inline int pcmcia_devmatch(struct pcmcia_device *dev,
917 struct pcmcia_device_id *did)
919 if (did->match_flags & PCMCIA_DEV_ID_MATCH_MANF_ID) {
920 if ((!dev->has_manf_id) || (dev->manf_id != did->manf_id))
924 if (did->match_flags & PCMCIA_DEV_ID_MATCH_CARD_ID) {
925 if ((!dev->has_card_id) || (dev->card_id != did->card_id))
929 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNCTION) {
930 if (dev->func != did->function)
934 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID1) {
935 if (!dev->prod_id[0])
937 if (strcmp(did->prod_id[0], dev->prod_id[0]))
941 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID2) {
942 if (!dev->prod_id[1])
944 if (strcmp(did->prod_id[1], dev->prod_id[1]))
948 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID3) {
949 if (!dev->prod_id[2])
951 if (strcmp(did->prod_id[2], dev->prod_id[2]))
955 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID4) {
956 if (!dev->prod_id[3])
958 if (strcmp(did->prod_id[3], dev->prod_id[3]))
962 if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) {
963 if (dev->device_no != did->device_no)
967 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNC_ID) {
968 if ((!dev->has_func_id) || (dev->func_id != did->func_id))
971 /* if this is a pseudo-multi-function device,
972 * we need explicit matches */
973 if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO)
978 /* also, FUNC_ID matching needs to be activated by userspace
979 * after it has re-checked that there is no possible module
980 * with a prod_id/manf_id/card_id match.
982 ds_dev_dbg(0, &dev->dev,
983 "skipping FUNC_ID match until userspace interaction\n");
984 if (!dev->allow_func_id_match)
988 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FAKE_CIS) {
989 ds_dev_dbg(0, &dev->dev, "device needs a fake CIS\n");
990 if (!dev->socket->fake_cis)
991 pcmcia_load_firmware(dev, did->cisfile);
993 if (!dev->socket->fake_cis)
997 if (did->match_flags & PCMCIA_DEV_ID_MATCH_ANONYMOUS) {
1000 if (dev->prod_id[i])
1002 if (dev->has_manf_id || dev->has_card_id || dev->has_func_id)
1006 dev->dev.driver_data = (void *) did;
1012 static int pcmcia_bus_match(struct device * dev, struct device_driver * drv) {
1013 struct pcmcia_device * p_dev = to_pcmcia_dev(dev);
1014 struct pcmcia_driver * p_drv = to_pcmcia_drv(drv);
1015 struct pcmcia_device_id *did = p_drv->id_table;
1016 struct pcmcia_dynid *dynid;
1018 /* match dynamic devices first */
1019 spin_lock(&p_drv->dynids.lock);
1020 list_for_each_entry(dynid, &p_drv->dynids.list, node) {
1021 ds_dev_dbg(3, dev, "trying to match to %s\n", drv->name);
1022 if (pcmcia_devmatch(p_dev, &dynid->id)) {
1023 ds_dev_dbg(0, dev, "matched to %s\n", drv->name);
1024 spin_unlock(&p_drv->dynids.lock);
1028 spin_unlock(&p_drv->dynids.lock);
1030 #ifdef CONFIG_PCMCIA_IOCTL
1031 /* matching by cardmgr */
1032 if (p_dev->cardmgr == p_drv) {
1033 ds_dev_dbg(0, dev, "cardmgr matched to %s\n", drv->name);
1038 while (did && did->match_flags) {
1039 ds_dev_dbg(3, dev, "trying to match to %s\n", drv->name);
1040 if (pcmcia_devmatch(p_dev, did)) {
1041 ds_dev_dbg(0, dev, "matched to %s\n", drv->name);
1050 #ifdef CONFIG_HOTPLUG
1052 static int pcmcia_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
1054 struct pcmcia_device *p_dev;
1056 u32 hash[4] = { 0, 0, 0, 0};
1061 p_dev = to_pcmcia_dev(dev);
1063 /* calculate hashes */
1064 for (i=0; i<4; i++) {
1065 if (!p_dev->prod_id[i])
1067 hash[i] = crc32(0, p_dev->prod_id[i], strlen(p_dev->prod_id[i]));
1070 if (add_uevent_var(env, "SOCKET_NO=%u", p_dev->socket->sock))
1073 if (add_uevent_var(env, "DEVICE_NO=%02X", p_dev->device_no))
1076 if (add_uevent_var(env, "MODALIAS=pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
1077 "pa%08Xpb%08Xpc%08Xpd%08X",
1078 p_dev->has_manf_id ? p_dev->manf_id : 0,
1079 p_dev->has_card_id ? p_dev->card_id : 0,
1080 p_dev->has_func_id ? p_dev->func_id : 0,
1094 static int pcmcia_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
1101 /************************ runtime PM support ***************************/
1103 static int pcmcia_dev_suspend(struct device *dev, pm_message_t state);
1104 static int pcmcia_dev_resume(struct device *dev);
1106 static int runtime_suspend(struct device *dev)
1111 rc = pcmcia_dev_suspend(dev, PMSG_SUSPEND);
1116 static void runtime_resume(struct device *dev)
1121 rc = pcmcia_dev_resume(dev);
1125 /************************ per-device sysfs output ***************************/
1127 #define pcmcia_device_attr(field, test, format) \
1128 static ssize_t field##_show (struct device *dev, struct device_attribute *attr, char *buf) \
1130 struct pcmcia_device *p_dev = to_pcmcia_dev(dev); \
1131 return p_dev->test ? sprintf (buf, format, p_dev->field) : -ENODEV; \
1134 #define pcmcia_device_stringattr(name, field) \
1135 static ssize_t name##_show (struct device *dev, struct device_attribute *attr, char *buf) \
1137 struct pcmcia_device *p_dev = to_pcmcia_dev(dev); \
1138 return p_dev->field ? sprintf (buf, "%s\n", p_dev->field) : -ENODEV; \
1141 pcmcia_device_attr(func, socket, "0x%02x\n");
1142 pcmcia_device_attr(func_id, has_func_id, "0x%02x\n");
1143 pcmcia_device_attr(manf_id, has_manf_id, "0x%04x\n");
1144 pcmcia_device_attr(card_id, has_card_id, "0x%04x\n");
1145 pcmcia_device_stringattr(prod_id1, prod_id[0]);
1146 pcmcia_device_stringattr(prod_id2, prod_id[1]);
1147 pcmcia_device_stringattr(prod_id3, prod_id[2]);
1148 pcmcia_device_stringattr(prod_id4, prod_id[3]);
1151 static ssize_t pcmcia_show_pm_state(struct device *dev, struct device_attribute *attr, char *buf)
1153 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1155 if (p_dev->suspended)
1156 return sprintf(buf, "off\n");
1158 return sprintf(buf, "on\n");
1161 static ssize_t pcmcia_store_pm_state(struct device *dev, struct device_attribute *attr,
1162 const char *buf, size_t count)
1164 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1170 if ((!p_dev->suspended) && !strncmp(buf, "off", 3))
1171 ret = runtime_suspend(dev);
1172 else if (p_dev->suspended && !strncmp(buf, "on", 2))
1173 runtime_resume(dev);
1175 return ret ? ret : count;
1179 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
1181 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1183 u32 hash[4] = { 0, 0, 0, 0};
1185 /* calculate hashes */
1186 for (i=0; i<4; i++) {
1187 if (!p_dev->prod_id[i])
1189 hash[i] = crc32(0,p_dev->prod_id[i],strlen(p_dev->prod_id[i]));
1191 return sprintf(buf, "pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
1192 "pa%08Xpb%08Xpc%08Xpd%08X\n",
1193 p_dev->has_manf_id ? p_dev->manf_id : 0,
1194 p_dev->has_card_id ? p_dev->card_id : 0,
1195 p_dev->has_func_id ? p_dev->func_id : 0,
1196 p_dev->func, p_dev->device_no,
1197 hash[0], hash[1], hash[2], hash[3]);
1200 static ssize_t pcmcia_store_allow_func_id_match(struct device *dev,
1201 struct device_attribute *attr, const char *buf, size_t count)
1203 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1209 mutex_lock(&p_dev->socket->skt_mutex);
1210 p_dev->allow_func_id_match = 1;
1211 mutex_unlock(&p_dev->socket->skt_mutex);
1213 ret = bus_rescan_devices(&pcmcia_bus_type);
1215 printk(KERN_INFO "pcmcia: bus_rescan_devices failed after "
1216 "allowing func_id matches\n");
1221 static struct device_attribute pcmcia_dev_attrs[] = {
1222 __ATTR(function, 0444, func_show, NULL),
1223 __ATTR(pm_state, 0644, pcmcia_show_pm_state, pcmcia_store_pm_state),
1227 __ATTR_RO(prod_id1),
1228 __ATTR_RO(prod_id2),
1229 __ATTR_RO(prod_id3),
1230 __ATTR_RO(prod_id4),
1231 __ATTR_RO(modalias),
1232 __ATTR(allow_func_id_match, 0200, NULL, pcmcia_store_allow_func_id_match),
1236 /* PM support, also needed for reset */
1238 static int pcmcia_dev_suspend(struct device * dev, pm_message_t state)
1240 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1241 struct pcmcia_driver *p_drv = NULL;
1244 if (p_dev->suspended)
1247 ds_dev_dbg(2, dev, "suspending\n");
1250 p_drv = to_pcmcia_drv(dev->driver);
1255 if (p_drv->suspend) {
1256 ret = p_drv->suspend(p_dev);
1258 dev_printk(KERN_ERR, dev,
1259 "pcmcia: device %s (driver %s) did "
1260 "not want to go to sleep (%d)\n",
1261 p_dev->devname, p_drv->drv.name, ret);
1266 if (p_dev->device_no == p_dev->func) {
1267 ds_dev_dbg(2, dev, "releasing configuration\n");
1268 pcmcia_release_configuration(p_dev);
1273 p_dev->suspended = 1;
1278 static int pcmcia_dev_resume(struct device * dev)
1280 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1281 struct pcmcia_driver *p_drv = NULL;
1284 if (!p_dev->suspended)
1287 ds_dev_dbg(2, dev, "resuming\n");
1290 p_drv = to_pcmcia_drv(dev->driver);
1295 if (p_dev->device_no == p_dev->func) {
1296 ds_dev_dbg(2, dev, "requesting configuration\n");
1297 ret = pcmcia_request_configuration(p_dev, &p_dev->conf);
1303 ret = p_drv->resume(p_dev);
1307 p_dev->suspended = 0;
1312 static int pcmcia_bus_suspend_callback(struct device *dev, void * _data)
1314 struct pcmcia_socket *skt = _data;
1315 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1317 if (p_dev->socket != skt || p_dev->suspended)
1320 return runtime_suspend(dev);
1323 static int pcmcia_bus_resume_callback(struct device *dev, void * _data)
1325 struct pcmcia_socket *skt = _data;
1326 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1328 if (p_dev->socket != skt || !p_dev->suspended)
1331 runtime_resume(dev);
1336 static int pcmcia_bus_resume(struct pcmcia_socket *skt)
1338 ds_dev_dbg(2, &skt->dev, "resuming socket %d\n", skt->sock);
1339 bus_for_each_dev(&pcmcia_bus_type, NULL, skt, pcmcia_bus_resume_callback);
1343 static int pcmcia_bus_suspend(struct pcmcia_socket *skt)
1345 ds_dev_dbg(2, &skt->dev, "suspending socket %d\n", skt->sock);
1346 if (bus_for_each_dev(&pcmcia_bus_type, NULL, skt,
1347 pcmcia_bus_suspend_callback)) {
1348 pcmcia_bus_resume(skt);
1355 /*======================================================================
1357 The card status event handler.
1359 ======================================================================*/
1361 /* Normally, the event is passed to individual drivers after
1362 * informing userspace. Only for CS_EVENT_CARD_REMOVAL this
1363 * is inversed to maintain historic compatibility.
1366 static int ds_event(struct pcmcia_socket *skt, event_t event, int priority)
1368 struct pcmcia_socket *s = pcmcia_get_socket(skt);
1371 dev_printk(KERN_ERR, &skt->dev,
1372 "PCMCIA obtaining reference to socket " \
1373 "failed, event 0x%x lost!\n", event);
1377 ds_dev_dbg(1, &skt->dev, "ds_event(0x%06x, %d, 0x%p)\n",
1378 event, priority, skt);
1381 case CS_EVENT_CARD_REMOVAL:
1382 s->pcmcia_state.present = 0;
1383 pcmcia_card_remove(skt, NULL);
1384 handle_event(skt, event);
1387 case CS_EVENT_CARD_INSERTION:
1388 s->pcmcia_state.present = 1;
1389 pcmcia_card_add(skt);
1390 handle_event(skt, event);
1393 case CS_EVENT_EJECTION_REQUEST:
1396 case CS_EVENT_PM_SUSPEND:
1397 case CS_EVENT_PM_RESUME:
1398 case CS_EVENT_RESET_PHYSICAL:
1399 case CS_EVENT_CARD_RESET:
1401 handle_event(skt, event);
1405 pcmcia_put_socket(s);
1411 struct pcmcia_device * pcmcia_dev_present(struct pcmcia_device *_p_dev)
1413 struct pcmcia_device *p_dev;
1414 struct pcmcia_device *ret = NULL;
1416 p_dev = pcmcia_get_dev(_p_dev);
1420 if (!p_dev->socket->pcmcia_state.present)
1423 if (p_dev->_removed)
1426 if (p_dev->suspended)
1431 pcmcia_put_dev(p_dev);
1434 EXPORT_SYMBOL(pcmcia_dev_present);
1437 static struct pcmcia_callback pcmcia_bus_callback = {
1438 .owner = THIS_MODULE,
1440 .requery = pcmcia_bus_rescan,
1441 .suspend = pcmcia_bus_suspend,
1442 .resume = pcmcia_bus_resume,
1445 static int __devinit pcmcia_bus_add_socket(struct device *dev,
1446 struct class_interface *class_intf)
1448 struct pcmcia_socket *socket = dev_get_drvdata(dev);
1451 socket = pcmcia_get_socket(socket);
1453 dev_printk(KERN_ERR, dev,
1454 "PCMCIA obtaining reference to socket failed\n");
1459 * Ugly. But we want to wait for the socket threads to have started up.
1460 * We really should let the drivers themselves drive some of this..
1464 #ifdef CONFIG_PCMCIA_IOCTL
1465 init_waitqueue_head(&socket->queue);
1467 INIT_LIST_HEAD(&socket->devices_list);
1468 INIT_WORK(&socket->device_add, pcmcia_delayed_add_device);
1469 memset(&socket->pcmcia_state, 0, sizeof(u8));
1470 socket->device_count = 0;
1472 ret = pccard_register_pcmcia(socket, &pcmcia_bus_callback);
1474 dev_printk(KERN_ERR, dev, "PCMCIA registration failed\n");
1475 pcmcia_put_socket(socket);
1482 static void pcmcia_bus_remove_socket(struct device *dev,
1483 struct class_interface *class_intf)
1485 struct pcmcia_socket *socket = dev_get_drvdata(dev);
1490 socket->pcmcia_state.dead = 1;
1491 pccard_register_pcmcia(socket, NULL);
1493 /* unregister any unbound devices */
1494 mutex_lock(&socket->skt_mutex);
1495 pcmcia_card_remove(socket, NULL);
1496 mutex_unlock(&socket->skt_mutex);
1498 pcmcia_put_socket(socket);
1504 /* the pcmcia_bus_interface is used to handle pcmcia socket devices */
1505 static struct class_interface pcmcia_bus_interface __refdata = {
1506 .class = &pcmcia_socket_class,
1507 .add_dev = &pcmcia_bus_add_socket,
1508 .remove_dev = &pcmcia_bus_remove_socket,
1512 struct bus_type pcmcia_bus_type = {
1514 .uevent = pcmcia_bus_uevent,
1515 .match = pcmcia_bus_match,
1516 .dev_attrs = pcmcia_dev_attrs,
1517 .probe = pcmcia_device_probe,
1518 .remove = pcmcia_device_remove,
1519 .suspend = pcmcia_dev_suspend,
1520 .resume = pcmcia_dev_resume,
1524 static int __init init_pcmcia_bus(void)
1528 spin_lock_init(&pcmcia_dev_list_lock);
1530 ret = bus_register(&pcmcia_bus_type);
1532 printk(KERN_WARNING "pcmcia: bus_register error: %d\n", ret);
1535 ret = class_interface_register(&pcmcia_bus_interface);
1538 "pcmcia: class_interface_register error: %d\n", ret);
1539 bus_unregister(&pcmcia_bus_type);
1543 pcmcia_setup_ioctl();
1547 fs_initcall(init_pcmcia_bus); /* one level after subsys_initcall so that
1548 * pcmcia_socket_class is already registered */
1551 static void __exit exit_pcmcia_bus(void)
1553 pcmcia_cleanup_ioctl();
1555 class_interface_unregister(&pcmcia_bus_interface);
1557 bus_unregister(&pcmcia_bus_type);
1559 module_exit(exit_pcmcia_bus);