[SCSI] bnx2fc: Add driver documentation
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / pcmcia / ds.c
blob749c2a16012c582bca165db93f14cf4c21ec5293
1 /*
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 - 2010 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>
27 #include <linux/slab.h>
29 #include <pcmcia/cistpl.h>
30 #include <pcmcia/ds.h>
31 #include <pcmcia/ss.h>
33 #include "cs_internal.h"
35 /*====================================================================*/
37 /* Module parameters */
39 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
40 MODULE_DESCRIPTION("PCMCIA Driver Services");
41 MODULE_LICENSE("GPL");
44 /*====================================================================*/
46 static void pcmcia_check_driver(struct pcmcia_driver *p_drv)
48 const struct pcmcia_device_id *did = p_drv->id_table;
49 unsigned int i;
50 u32 hash;
52 if (!p_drv->probe || !p_drv->remove)
53 printk(KERN_DEBUG "pcmcia: %s lacks a requisite callback "
54 "function\n", p_drv->name);
56 while (did && did->match_flags) {
57 for (i = 0; i < 4; i++) {
58 if (!did->prod_id[i])
59 continue;
61 hash = crc32(0, did->prod_id[i], strlen(did->prod_id[i]));
62 if (hash == did->prod_id_hash[i])
63 continue;
65 printk(KERN_DEBUG "pcmcia: %s: invalid hash for "
66 "product string \"%s\": is 0x%x, should "
67 "be 0x%x\n", p_drv->name, did->prod_id[i],
68 did->prod_id_hash[i], hash);
69 printk(KERN_DEBUG "pcmcia: see "
70 "Documentation/pcmcia/devicetable.txt for "
71 "details\n");
73 did++;
76 return;
80 /*======================================================================*/
83 struct pcmcia_dynid {
84 struct list_head node;
85 struct pcmcia_device_id id;
88 /**
89 * pcmcia_store_new_id - add a new PCMCIA device ID to this driver and re-probe devices
90 * @driver: target device driver
91 * @buf: buffer for scanning device ID data
92 * @count: input size
94 * Adds a new dynamic PCMCIA device ID to this driver,
95 * and causes the driver to probe for all devices again.
97 static ssize_t
98 pcmcia_store_new_id(struct device_driver *driver, const char *buf, size_t count)
100 struct pcmcia_dynid *dynid;
101 struct pcmcia_driver *pdrv = to_pcmcia_drv(driver);
102 __u16 match_flags, manf_id, card_id;
103 __u8 func_id, function, device_no;
104 __u32 prod_id_hash[4] = {0, 0, 0, 0};
105 int fields = 0;
106 int retval = 0;
108 fields = sscanf(buf, "%hx %hx %hx %hhx %hhx %hhx %x %x %x %x",
109 &match_flags, &manf_id, &card_id, &func_id, &function, &device_no,
110 &prod_id_hash[0], &prod_id_hash[1], &prod_id_hash[2], &prod_id_hash[3]);
111 if (fields < 6)
112 return -EINVAL;
114 dynid = kzalloc(sizeof(struct pcmcia_dynid), GFP_KERNEL);
115 if (!dynid)
116 return -ENOMEM;
118 dynid->id.match_flags = match_flags;
119 dynid->id.manf_id = manf_id;
120 dynid->id.card_id = card_id;
121 dynid->id.func_id = func_id;
122 dynid->id.function = function;
123 dynid->id.device_no = device_no;
124 memcpy(dynid->id.prod_id_hash, prod_id_hash, sizeof(__u32) * 4);
126 mutex_lock(&pdrv->dynids.lock);
127 list_add_tail(&dynid->node, &pdrv->dynids.list);
128 mutex_unlock(&pdrv->dynids.lock);
130 if (get_driver(&pdrv->drv)) {
131 retval = driver_attach(&pdrv->drv);
132 put_driver(&pdrv->drv);
135 if (retval)
136 return retval;
137 return count;
139 static DRIVER_ATTR(new_id, S_IWUSR, NULL, pcmcia_store_new_id);
141 static void
142 pcmcia_free_dynids(struct pcmcia_driver *drv)
144 struct pcmcia_dynid *dynid, *n;
146 mutex_lock(&drv->dynids.lock);
147 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
148 list_del(&dynid->node);
149 kfree(dynid);
151 mutex_unlock(&drv->dynids.lock);
154 static int
155 pcmcia_create_newid_file(struct pcmcia_driver *drv)
157 int error = 0;
158 if (drv->probe != NULL)
159 error = driver_create_file(&drv->drv, &driver_attr_new_id);
160 return error;
165 * pcmcia_register_driver - register a PCMCIA driver with the bus core
166 * @driver: the &driver being registered
168 * Registers a PCMCIA driver with the PCMCIA bus core.
170 int pcmcia_register_driver(struct pcmcia_driver *driver)
172 int error;
174 if (!driver)
175 return -EINVAL;
177 pcmcia_check_driver(driver);
179 /* initialize common fields */
180 driver->drv.bus = &pcmcia_bus_type;
181 driver->drv.owner = driver->owner;
182 driver->drv.name = driver->name;
183 mutex_init(&driver->dynids.lock);
184 INIT_LIST_HEAD(&driver->dynids.list);
186 pr_debug("registering driver %s\n", driver->name);
188 error = driver_register(&driver->drv);
189 if (error < 0)
190 return error;
192 error = pcmcia_create_newid_file(driver);
193 if (error)
194 driver_unregister(&driver->drv);
196 return error;
198 EXPORT_SYMBOL(pcmcia_register_driver);
201 * pcmcia_unregister_driver - unregister a PCMCIA driver with the bus core
202 * @driver: the &driver being unregistered
204 void pcmcia_unregister_driver(struct pcmcia_driver *driver)
206 pr_debug("unregistering driver %s\n", driver->name);
207 driver_unregister(&driver->drv);
208 pcmcia_free_dynids(driver);
210 EXPORT_SYMBOL(pcmcia_unregister_driver);
213 /* pcmcia_device handling */
215 static struct pcmcia_device *pcmcia_get_dev(struct pcmcia_device *p_dev)
217 struct device *tmp_dev;
218 tmp_dev = get_device(&p_dev->dev);
219 if (!tmp_dev)
220 return NULL;
221 return to_pcmcia_dev(tmp_dev);
224 static void pcmcia_put_dev(struct pcmcia_device *p_dev)
226 if (p_dev)
227 put_device(&p_dev->dev);
230 static void pcmcia_release_function(struct kref *ref)
232 struct config_t *c = container_of(ref, struct config_t, ref);
233 pr_debug("releasing config_t\n");
234 kfree(c);
237 static void pcmcia_release_dev(struct device *dev)
239 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
240 int i;
241 dev_dbg(dev, "releasing device\n");
242 pcmcia_put_socket(p_dev->socket);
243 for (i = 0; i < 4; i++)
244 kfree(p_dev->prod_id[i]);
245 kfree(p_dev->devname);
246 kref_put(&p_dev->function_config->ref, pcmcia_release_function);
247 kfree(p_dev);
251 static int pcmcia_device_probe(struct device *dev)
253 struct pcmcia_device *p_dev;
254 struct pcmcia_driver *p_drv;
255 struct pcmcia_socket *s;
256 cistpl_config_t cis_config;
257 int ret = 0;
259 dev = get_device(dev);
260 if (!dev)
261 return -ENODEV;
263 p_dev = to_pcmcia_dev(dev);
264 p_drv = to_pcmcia_drv(dev->driver);
265 s = p_dev->socket;
267 dev_dbg(dev, "trying to bind to %s\n", p_drv->name);
269 if ((!p_drv->probe) || (!p_dev->function_config) ||
270 (!try_module_get(p_drv->owner))) {
271 ret = -EINVAL;
272 goto put_dev;
275 /* set up some more device information */
276 ret = pccard_read_tuple(p_dev->socket, p_dev->func, CISTPL_CONFIG,
277 &cis_config);
278 if (!ret) {
279 p_dev->config_base = cis_config.base;
280 p_dev->config_regs = cis_config.rmask[0];
281 dev_dbg(dev, "base %x, regs %x", p_dev->config_base,
282 p_dev->config_regs);
283 } else {
284 dev_printk(KERN_INFO, dev,
285 "pcmcia: could not parse base and rmask0 of CIS\n");
286 p_dev->config_base = 0;
287 p_dev->config_regs = 0;
290 ret = p_drv->probe(p_dev);
291 if (ret) {
292 dev_dbg(dev, "binding to %s failed with %d\n",
293 p_drv->name, ret);
294 goto put_module;
296 dev_dbg(dev, "%s bound: Vpp %d.%d, idx %x, IRQ %d", p_drv->name,
297 p_dev->vpp/10, p_dev->vpp%10, p_dev->config_index, p_dev->irq);
298 dev_dbg(dev, "resources: ioport %pR %pR iomem %pR %pR %pR",
299 p_dev->resource[0], p_dev->resource[1], p_dev->resource[2],
300 p_dev->resource[3], p_dev->resource[4]);
302 mutex_lock(&s->ops_mutex);
303 if ((s->pcmcia_pfc) &&
304 (p_dev->socket->device_count == 1) && (p_dev->device_no == 0))
305 pcmcia_parse_uevents(s, PCMCIA_UEVENT_REQUERY);
306 mutex_unlock(&s->ops_mutex);
308 put_module:
309 if (ret)
310 module_put(p_drv->owner);
311 put_dev:
312 if (ret)
313 put_device(dev);
314 return ret;
319 * Removes a PCMCIA card from the device tree and socket list.
321 static void pcmcia_card_remove(struct pcmcia_socket *s, struct pcmcia_device *leftover)
323 struct pcmcia_device *p_dev;
324 struct pcmcia_device *tmp;
326 dev_dbg(leftover ? &leftover->dev : &s->dev,
327 "pcmcia_card_remove(%d) %s\n", s->sock,
328 leftover ? leftover->devname : "");
330 mutex_lock(&s->ops_mutex);
331 if (!leftover)
332 s->device_count = 0;
333 else
334 s->device_count = 1;
335 mutex_unlock(&s->ops_mutex);
337 /* unregister all pcmcia_devices registered with this socket, except leftover */
338 list_for_each_entry_safe(p_dev, tmp, &s->devices_list, socket_device_list) {
339 if (p_dev == leftover)
340 continue;
342 mutex_lock(&s->ops_mutex);
343 list_del(&p_dev->socket_device_list);
344 mutex_unlock(&s->ops_mutex);
346 dev_dbg(&p_dev->dev, "unregistering device\n");
347 device_unregister(&p_dev->dev);
350 return;
353 static int pcmcia_device_remove(struct device *dev)
355 struct pcmcia_device *p_dev;
356 struct pcmcia_driver *p_drv;
357 int i;
359 p_dev = to_pcmcia_dev(dev);
360 p_drv = to_pcmcia_drv(dev->driver);
362 dev_dbg(dev, "removing device\n");
364 /* If we're removing the primary module driving a
365 * pseudo multi-function card, we need to unbind
366 * all devices
368 if ((p_dev->socket->pcmcia_pfc) &&
369 (p_dev->socket->device_count > 0) &&
370 (p_dev->device_no == 0))
371 pcmcia_card_remove(p_dev->socket, p_dev);
373 /* detach the "instance" */
374 if (!p_drv)
375 return 0;
377 if (p_drv->remove)
378 p_drv->remove(p_dev);
380 /* check for proper unloading */
381 if (p_dev->_irq || p_dev->_io || p_dev->_locked)
382 dev_printk(KERN_INFO, dev,
383 "pcmcia: driver %s did not release config properly\n",
384 p_drv->name);
386 for (i = 0; i < MAX_WIN; i++)
387 if (p_dev->_win & CLIENT_WIN_REQ(i))
388 dev_printk(KERN_INFO, dev,
389 "pcmcia: driver %s did not release window properly\n",
390 p_drv->name);
392 /* references from pcmcia_probe_device */
393 pcmcia_put_dev(p_dev);
394 module_put(p_drv->owner);
396 return 0;
401 * pcmcia_device_query -- determine information about a pcmcia device
403 static int pcmcia_device_query(struct pcmcia_device *p_dev)
405 cistpl_manfid_t manf_id;
406 cistpl_funcid_t func_id;
407 cistpl_vers_1_t *vers1;
408 unsigned int i;
410 vers1 = kmalloc(sizeof(*vers1), GFP_KERNEL);
411 if (!vers1)
412 return -ENOMEM;
414 if (!pccard_read_tuple(p_dev->socket, BIND_FN_ALL,
415 CISTPL_MANFID, &manf_id)) {
416 mutex_lock(&p_dev->socket->ops_mutex);
417 p_dev->manf_id = manf_id.manf;
418 p_dev->card_id = manf_id.card;
419 p_dev->has_manf_id = 1;
420 p_dev->has_card_id = 1;
421 mutex_unlock(&p_dev->socket->ops_mutex);
424 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
425 CISTPL_FUNCID, &func_id)) {
426 mutex_lock(&p_dev->socket->ops_mutex);
427 p_dev->func_id = func_id.func;
428 p_dev->has_func_id = 1;
429 mutex_unlock(&p_dev->socket->ops_mutex);
430 } else {
431 /* rule of thumb: cards with no FUNCID, but with
432 * common memory device geometry information, are
433 * probably memory cards (from pcmcia-cs) */
434 cistpl_device_geo_t *devgeo;
436 devgeo = kmalloc(sizeof(*devgeo), GFP_KERNEL);
437 if (!devgeo) {
438 kfree(vers1);
439 return -ENOMEM;
441 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
442 CISTPL_DEVICE_GEO, devgeo)) {
443 dev_dbg(&p_dev->dev,
444 "mem device geometry probably means "
445 "FUNCID_MEMORY\n");
446 mutex_lock(&p_dev->socket->ops_mutex);
447 p_dev->func_id = CISTPL_FUNCID_MEMORY;
448 p_dev->has_func_id = 1;
449 mutex_unlock(&p_dev->socket->ops_mutex);
451 kfree(devgeo);
454 if (!pccard_read_tuple(p_dev->socket, BIND_FN_ALL, CISTPL_VERS_1,
455 vers1)) {
456 mutex_lock(&p_dev->socket->ops_mutex);
457 for (i = 0; i < min_t(unsigned int, 4, vers1->ns); i++) {
458 char *tmp;
459 unsigned int length;
460 char *new;
462 tmp = vers1->str + vers1->ofs[i];
464 length = strlen(tmp) + 1;
465 if ((length < 2) || (length > 255))
466 continue;
468 new = kmalloc(sizeof(char) * length, GFP_KERNEL);
469 if (!new)
470 continue;
472 new = strncpy(new, tmp, length);
474 tmp = p_dev->prod_id[i];
475 p_dev->prod_id[i] = new;
476 kfree(tmp);
478 mutex_unlock(&p_dev->socket->ops_mutex);
481 kfree(vers1);
482 return 0;
486 static struct pcmcia_device *pcmcia_device_add(struct pcmcia_socket *s,
487 unsigned int function)
489 struct pcmcia_device *p_dev, *tmp_dev;
490 int i;
492 s = pcmcia_get_socket(s);
493 if (!s)
494 return NULL;
496 pr_debug("adding device to %d, function %d\n", s->sock, function);
498 p_dev = kzalloc(sizeof(struct pcmcia_device), GFP_KERNEL);
499 if (!p_dev)
500 goto err_put;
502 mutex_lock(&s->ops_mutex);
503 p_dev->device_no = (s->device_count++);
504 mutex_unlock(&s->ops_mutex);
506 /* max of 2 PFC devices */
507 if ((p_dev->device_no >= 2) && (function == 0))
508 goto err_free;
510 /* max of 4 devices overall */
511 if (p_dev->device_no >= 4)
512 goto err_free;
514 p_dev->socket = s;
515 p_dev->func = function;
517 p_dev->dev.bus = &pcmcia_bus_type;
518 p_dev->dev.parent = s->dev.parent;
519 p_dev->dev.release = pcmcia_release_dev;
520 /* by default don't allow DMA */
521 p_dev->dma_mask = DMA_MASK_NONE;
522 p_dev->dev.dma_mask = &p_dev->dma_mask;
523 dev_set_name(&p_dev->dev, "%d.%d", p_dev->socket->sock, p_dev->device_no);
524 if (!dev_name(&p_dev->dev))
525 goto err_free;
526 p_dev->devname = kasprintf(GFP_KERNEL, "pcmcia%s", dev_name(&p_dev->dev));
527 if (!p_dev->devname)
528 goto err_free;
529 dev_dbg(&p_dev->dev, "devname is %s\n", p_dev->devname);
531 mutex_lock(&s->ops_mutex);
534 * p_dev->function_config must be the same for all card functions.
535 * Note that this is serialized by ops_mutex, so that only one
536 * such struct will be created.
538 list_for_each_entry(tmp_dev, &s->devices_list, socket_device_list)
539 if (p_dev->func == tmp_dev->func) {
540 p_dev->function_config = tmp_dev->function_config;
541 p_dev->irq = tmp_dev->irq;
542 kref_get(&p_dev->function_config->ref);
545 /* Add to the list in pcmcia_bus_socket */
546 list_add(&p_dev->socket_device_list, &s->devices_list);
548 if (pcmcia_setup_irq(p_dev))
549 dev_warn(&p_dev->dev,
550 "IRQ setup failed -- device might not work\n");
552 if (!p_dev->function_config) {
553 config_t *c;
554 dev_dbg(&p_dev->dev, "creating config_t\n");
555 c = kzalloc(sizeof(struct config_t), GFP_KERNEL);
556 if (!c) {
557 mutex_unlock(&s->ops_mutex);
558 goto err_unreg;
560 p_dev->function_config = c;
561 kref_init(&c->ref);
562 for (i = 0; i < MAX_IO_WIN; i++) {
563 c->io[i].name = p_dev->devname;
564 c->io[i].flags = IORESOURCE_IO;
566 for (i = 0; i< MAX_WIN; i++) {
567 c->mem[i].name = p_dev->devname;
568 c->mem[i].flags = IORESOURCE_MEM;
571 for (i = 0; i < MAX_IO_WIN; i++)
572 p_dev->resource[i] = &p_dev->function_config->io[i];
573 for (; i < (MAX_IO_WIN + MAX_WIN); i++)
574 p_dev->resource[i] = &p_dev->function_config->mem[i-MAX_IO_WIN];
576 mutex_unlock(&s->ops_mutex);
578 dev_printk(KERN_NOTICE, &p_dev->dev,
579 "pcmcia: registering new device %s (IRQ: %d)\n",
580 p_dev->devname, p_dev->irq);
582 pcmcia_device_query(p_dev);
584 if (device_register(&p_dev->dev))
585 goto err_unreg;
587 return p_dev;
589 err_unreg:
590 mutex_lock(&s->ops_mutex);
591 list_del(&p_dev->socket_device_list);
592 mutex_unlock(&s->ops_mutex);
594 err_free:
595 mutex_lock(&s->ops_mutex);
596 s->device_count--;
597 mutex_unlock(&s->ops_mutex);
599 for (i = 0; i < 4; i++)
600 kfree(p_dev->prod_id[i]);
601 kfree(p_dev->devname);
602 kfree(p_dev);
603 err_put:
604 pcmcia_put_socket(s);
606 return NULL;
610 static int pcmcia_card_add(struct pcmcia_socket *s)
612 cistpl_longlink_mfc_t mfc;
613 unsigned int no_funcs, i, no_chains;
614 int ret = -EAGAIN;
616 mutex_lock(&s->ops_mutex);
617 if (!(s->resource_setup_done)) {
618 dev_dbg(&s->dev,
619 "no resources available, delaying card_add\n");
620 mutex_unlock(&s->ops_mutex);
621 return -EAGAIN; /* try again, but later... */
624 if (pcmcia_validate_mem(s)) {
625 dev_dbg(&s->dev, "validating mem resources failed, "
626 "delaying card_add\n");
627 mutex_unlock(&s->ops_mutex);
628 return -EAGAIN; /* try again, but later... */
630 mutex_unlock(&s->ops_mutex);
632 ret = pccard_validate_cis(s, &no_chains);
633 if (ret || !no_chains) {
634 dev_dbg(&s->dev, "invalid CIS or invalid resources\n");
635 return -ENODEV;
638 if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC, &mfc))
639 no_funcs = mfc.nfn;
640 else
641 no_funcs = 1;
642 s->functions = no_funcs;
644 for (i = 0; i < no_funcs; i++)
645 pcmcia_device_add(s, i);
647 return ret;
651 static int pcmcia_requery_callback(struct device *dev, void * _data)
653 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
654 if (!p_dev->dev.driver) {
655 dev_dbg(dev, "update device information\n");
656 pcmcia_device_query(p_dev);
659 return 0;
663 static void pcmcia_requery(struct pcmcia_socket *s)
665 int has_pfc;
667 if (s->functions == 0) {
668 pcmcia_card_add(s);
669 return;
672 /* some device information might have changed because of a CIS
673 * update or because we can finally read it correctly... so
674 * determine it again, overwriting old values if necessary. */
675 bus_for_each_dev(&pcmcia_bus_type, NULL, NULL, pcmcia_requery_callback);
677 /* if the CIS changed, we need to check whether the number of
678 * functions changed. */
679 if (s->fake_cis) {
680 int old_funcs, new_funcs;
681 cistpl_longlink_mfc_t mfc;
683 /* does this cis override add or remove functions? */
684 old_funcs = s->functions;
686 if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC,
687 &mfc))
688 new_funcs = mfc.nfn;
689 else
690 new_funcs = 1;
691 if (old_funcs != new_funcs) {
692 /* we need to re-start */
693 pcmcia_card_remove(s, NULL);
694 s->functions = 0;
695 pcmcia_card_add(s);
699 /* If the PCMCIA device consists of two pseudo devices,
700 * call pcmcia_device_add() -- which will fail if both
701 * devices are already registered. */
702 mutex_lock(&s->ops_mutex);
703 has_pfc = s->pcmcia_pfc;
704 mutex_unlock(&s->ops_mutex);
705 if (has_pfc)
706 pcmcia_device_add(s, 0);
708 /* we re-scan all devices, not just the ones connected to this
709 * socket. This does not matter, though. */
710 if (bus_rescan_devices(&pcmcia_bus_type))
711 dev_warn(&s->dev, "rescanning the bus failed\n");
715 #ifdef CONFIG_PCMCIA_LOAD_CIS
718 * pcmcia_load_firmware - load CIS from userspace if device-provided is broken
719 * @dev: the pcmcia device which needs a CIS override
720 * @filename: requested filename in /lib/firmware/
722 * This uses the in-kernel firmware loading mechanism to use a "fake CIS" if
723 * the one provided by the card is broken. The firmware files reside in
724 * /lib/firmware/ in userspace.
726 static int pcmcia_load_firmware(struct pcmcia_device *dev, char * filename)
728 struct pcmcia_socket *s = dev->socket;
729 const struct firmware *fw;
730 int ret = -ENOMEM;
731 cistpl_longlink_mfc_t mfc;
732 int old_funcs, new_funcs = 1;
734 if (!filename)
735 return -EINVAL;
737 dev_dbg(&dev->dev, "trying to load CIS file %s\n", filename);
739 if (request_firmware(&fw, filename, &dev->dev) == 0) {
740 if (fw->size >= CISTPL_MAX_CIS_SIZE) {
741 ret = -EINVAL;
742 dev_printk(KERN_ERR, &dev->dev,
743 "pcmcia: CIS override is too big\n");
744 goto release;
747 if (!pcmcia_replace_cis(s, fw->data, fw->size))
748 ret = 0;
749 else {
750 dev_printk(KERN_ERR, &dev->dev,
751 "pcmcia: CIS override failed\n");
752 goto release;
755 /* we need to re-start if the number of functions changed */
756 old_funcs = s->functions;
757 if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC,
758 &mfc))
759 new_funcs = mfc.nfn;
761 if (old_funcs != new_funcs)
762 ret = -EBUSY;
764 /* update information */
765 pcmcia_device_query(dev);
767 /* requery (as number of functions might have changed) */
768 pcmcia_parse_uevents(s, PCMCIA_UEVENT_REQUERY);
770 release:
771 release_firmware(fw);
773 return ret;
776 #else /* !CONFIG_PCMCIA_LOAD_CIS */
778 static inline int pcmcia_load_firmware(struct pcmcia_device *dev, char * filename)
780 return -ENODEV;
783 #endif
786 static inline int pcmcia_devmatch(struct pcmcia_device *dev,
787 const struct pcmcia_device_id *did)
789 if (did->match_flags & PCMCIA_DEV_ID_MATCH_MANF_ID) {
790 if ((!dev->has_manf_id) || (dev->manf_id != did->manf_id))
791 return 0;
794 if (did->match_flags & PCMCIA_DEV_ID_MATCH_CARD_ID) {
795 if ((!dev->has_card_id) || (dev->card_id != did->card_id))
796 return 0;
799 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNCTION) {
800 if (dev->func != did->function)
801 return 0;
804 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID1) {
805 if (!dev->prod_id[0])
806 return 0;
807 if (strcmp(did->prod_id[0], dev->prod_id[0]))
808 return 0;
811 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID2) {
812 if (!dev->prod_id[1])
813 return 0;
814 if (strcmp(did->prod_id[1], dev->prod_id[1]))
815 return 0;
818 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID3) {
819 if (!dev->prod_id[2])
820 return 0;
821 if (strcmp(did->prod_id[2], dev->prod_id[2]))
822 return 0;
825 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID4) {
826 if (!dev->prod_id[3])
827 return 0;
828 if (strcmp(did->prod_id[3], dev->prod_id[3]))
829 return 0;
832 if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) {
833 dev_dbg(&dev->dev, "this is a pseudo-multi-function device\n");
834 mutex_lock(&dev->socket->ops_mutex);
835 dev->socket->pcmcia_pfc = 1;
836 mutex_unlock(&dev->socket->ops_mutex);
837 if (dev->device_no != did->device_no)
838 return 0;
841 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNC_ID) {
842 int ret;
844 if ((!dev->has_func_id) || (dev->func_id != did->func_id))
845 return 0;
847 /* if this is a pseudo-multi-function device,
848 * we need explicit matches */
849 if (dev->socket->pcmcia_pfc)
850 return 0;
851 if (dev->device_no)
852 return 0;
854 /* also, FUNC_ID matching needs to be activated by userspace
855 * after it has re-checked that there is no possible module
856 * with a prod_id/manf_id/card_id match.
858 mutex_lock(&dev->socket->ops_mutex);
859 ret = dev->allow_func_id_match;
860 mutex_unlock(&dev->socket->ops_mutex);
862 if (!ret) {
863 dev_dbg(&dev->dev,
864 "skipping FUNC_ID match until userspace ACK\n");
865 return 0;
869 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FAKE_CIS) {
870 dev_dbg(&dev->dev, "device needs a fake CIS\n");
871 if (!dev->socket->fake_cis)
872 if (pcmcia_load_firmware(dev, did->cisfile))
873 return 0;
876 if (did->match_flags & PCMCIA_DEV_ID_MATCH_ANONYMOUS) {
877 int i;
878 for (i = 0; i < 4; i++)
879 if (dev->prod_id[i])
880 return 0;
881 if (dev->has_manf_id || dev->has_card_id || dev->has_func_id)
882 return 0;
885 return 1;
889 static int pcmcia_bus_match(struct device *dev, struct device_driver *drv)
891 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
892 struct pcmcia_driver *p_drv = to_pcmcia_drv(drv);
893 const struct pcmcia_device_id *did = p_drv->id_table;
894 struct pcmcia_dynid *dynid;
896 /* match dynamic devices first */
897 mutex_lock(&p_drv->dynids.lock);
898 list_for_each_entry(dynid, &p_drv->dynids.list, node) {
899 dev_dbg(dev, "trying to match to %s\n", drv->name);
900 if (pcmcia_devmatch(p_dev, &dynid->id)) {
901 dev_dbg(dev, "matched to %s\n", drv->name);
902 mutex_unlock(&p_drv->dynids.lock);
903 return 1;
906 mutex_unlock(&p_drv->dynids.lock);
908 while (did && did->match_flags) {
909 dev_dbg(dev, "trying to match to %s\n", drv->name);
910 if (pcmcia_devmatch(p_dev, did)) {
911 dev_dbg(dev, "matched to %s\n", drv->name);
912 return 1;
914 did++;
917 return 0;
920 #ifdef CONFIG_HOTPLUG
922 static int pcmcia_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
924 struct pcmcia_device *p_dev;
925 int i;
926 u32 hash[4] = { 0, 0, 0, 0};
928 if (!dev)
929 return -ENODEV;
931 p_dev = to_pcmcia_dev(dev);
933 /* calculate hashes */
934 for (i = 0; i < 4; i++) {
935 if (!p_dev->prod_id[i])
936 continue;
937 hash[i] = crc32(0, p_dev->prod_id[i], strlen(p_dev->prod_id[i]));
940 if (add_uevent_var(env, "SOCKET_NO=%u", p_dev->socket->sock))
941 return -ENOMEM;
943 if (add_uevent_var(env, "DEVICE_NO=%02X", p_dev->device_no))
944 return -ENOMEM;
946 if (add_uevent_var(env, "MODALIAS=pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
947 "pa%08Xpb%08Xpc%08Xpd%08X",
948 p_dev->has_manf_id ? p_dev->manf_id : 0,
949 p_dev->has_card_id ? p_dev->card_id : 0,
950 p_dev->has_func_id ? p_dev->func_id : 0,
951 p_dev->func,
952 p_dev->device_no,
953 hash[0],
954 hash[1],
955 hash[2],
956 hash[3]))
957 return -ENOMEM;
959 return 0;
962 #else
964 static int pcmcia_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
966 return -ENODEV;
969 #endif
971 /************************ runtime PM support ***************************/
973 static int pcmcia_dev_suspend(struct device *dev, pm_message_t state);
974 static int pcmcia_dev_resume(struct device *dev);
976 static int runtime_suspend(struct device *dev)
978 int rc;
980 device_lock(dev);
981 rc = pcmcia_dev_suspend(dev, PMSG_SUSPEND);
982 device_unlock(dev);
983 return rc;
986 static int runtime_resume(struct device *dev)
988 int rc;
990 device_lock(dev);
991 rc = pcmcia_dev_resume(dev);
992 device_unlock(dev);
993 return rc;
996 /************************ per-device sysfs output ***************************/
998 #define pcmcia_device_attr(field, test, format) \
999 static ssize_t field##_show (struct device *dev, struct device_attribute *attr, char *buf) \
1001 struct pcmcia_device *p_dev = to_pcmcia_dev(dev); \
1002 return p_dev->test ? sprintf(buf, format, p_dev->field) : -ENODEV; \
1005 #define pcmcia_device_stringattr(name, field) \
1006 static ssize_t name##_show (struct device *dev, struct device_attribute *attr, char *buf) \
1008 struct pcmcia_device *p_dev = to_pcmcia_dev(dev); \
1009 return p_dev->field ? sprintf(buf, "%s\n", p_dev->field) : -ENODEV; \
1012 pcmcia_device_attr(func, socket, "0x%02x\n");
1013 pcmcia_device_attr(func_id, has_func_id, "0x%02x\n");
1014 pcmcia_device_attr(manf_id, has_manf_id, "0x%04x\n");
1015 pcmcia_device_attr(card_id, has_card_id, "0x%04x\n");
1016 pcmcia_device_stringattr(prod_id1, prod_id[0]);
1017 pcmcia_device_stringattr(prod_id2, prod_id[1]);
1018 pcmcia_device_stringattr(prod_id3, prod_id[2]);
1019 pcmcia_device_stringattr(prod_id4, prod_id[3]);
1021 static ssize_t pcmcia_show_resources(struct device *dev,
1022 struct device_attribute *attr, char *buf)
1024 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1025 char *str = buf;
1026 int i;
1028 for (i = 0; i < PCMCIA_NUM_RESOURCES; i++)
1029 str += sprintf(str, "%pr\n", p_dev->resource[i]);
1031 return str - buf;
1034 static ssize_t pcmcia_show_pm_state(struct device *dev, struct device_attribute *attr, char *buf)
1036 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1038 if (p_dev->suspended)
1039 return sprintf(buf, "off\n");
1040 else
1041 return sprintf(buf, "on\n");
1044 static ssize_t pcmcia_store_pm_state(struct device *dev, struct device_attribute *attr,
1045 const char *buf, size_t count)
1047 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1048 int ret = 0;
1050 if (!count)
1051 return -EINVAL;
1053 if ((!p_dev->suspended) && !strncmp(buf, "off", 3))
1054 ret = runtime_suspend(dev);
1055 else if (p_dev->suspended && !strncmp(buf, "on", 2))
1056 ret = runtime_resume(dev);
1058 return ret ? ret : count;
1062 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
1064 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1065 int i;
1066 u32 hash[4] = { 0, 0, 0, 0};
1068 /* calculate hashes */
1069 for (i = 0; i < 4; i++) {
1070 if (!p_dev->prod_id[i])
1071 continue;
1072 hash[i] = crc32(0, p_dev->prod_id[i],
1073 strlen(p_dev->prod_id[i]));
1075 return sprintf(buf, "pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
1076 "pa%08Xpb%08Xpc%08Xpd%08X\n",
1077 p_dev->has_manf_id ? p_dev->manf_id : 0,
1078 p_dev->has_card_id ? p_dev->card_id : 0,
1079 p_dev->has_func_id ? p_dev->func_id : 0,
1080 p_dev->func, p_dev->device_no,
1081 hash[0], hash[1], hash[2], hash[3]);
1084 static ssize_t pcmcia_store_allow_func_id_match(struct device *dev,
1085 struct device_attribute *attr, const char *buf, size_t count)
1087 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1089 if (!count)
1090 return -EINVAL;
1092 mutex_lock(&p_dev->socket->ops_mutex);
1093 p_dev->allow_func_id_match = 1;
1094 mutex_unlock(&p_dev->socket->ops_mutex);
1095 pcmcia_parse_uevents(p_dev->socket, PCMCIA_UEVENT_REQUERY);
1097 return count;
1100 static struct device_attribute pcmcia_dev_attrs[] = {
1101 __ATTR(function, 0444, func_show, NULL),
1102 __ATTR(pm_state, 0644, pcmcia_show_pm_state, pcmcia_store_pm_state),
1103 __ATTR(resources, 0444, pcmcia_show_resources, NULL),
1104 __ATTR_RO(func_id),
1105 __ATTR_RO(manf_id),
1106 __ATTR_RO(card_id),
1107 __ATTR_RO(prod_id1),
1108 __ATTR_RO(prod_id2),
1109 __ATTR_RO(prod_id3),
1110 __ATTR_RO(prod_id4),
1111 __ATTR_RO(modalias),
1112 __ATTR(allow_func_id_match, 0200, NULL, pcmcia_store_allow_func_id_match),
1113 __ATTR_NULL,
1116 /* PM support, also needed for reset */
1118 static int pcmcia_dev_suspend(struct device *dev, pm_message_t state)
1120 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1121 struct pcmcia_driver *p_drv = NULL;
1122 int ret = 0;
1124 mutex_lock(&p_dev->socket->ops_mutex);
1125 if (p_dev->suspended) {
1126 mutex_unlock(&p_dev->socket->ops_mutex);
1127 return 0;
1129 p_dev->suspended = 1;
1130 mutex_unlock(&p_dev->socket->ops_mutex);
1132 dev_dbg(dev, "suspending\n");
1134 if (dev->driver)
1135 p_drv = to_pcmcia_drv(dev->driver);
1137 if (!p_drv)
1138 goto out;
1140 if (p_drv->suspend) {
1141 ret = p_drv->suspend(p_dev);
1142 if (ret) {
1143 dev_printk(KERN_ERR, dev,
1144 "pcmcia: device %s (driver %s) did "
1145 "not want to go to sleep (%d)\n",
1146 p_dev->devname, p_drv->name, ret);
1147 mutex_lock(&p_dev->socket->ops_mutex);
1148 p_dev->suspended = 0;
1149 mutex_unlock(&p_dev->socket->ops_mutex);
1150 goto out;
1154 if (p_dev->device_no == p_dev->func) {
1155 dev_dbg(dev, "releasing configuration\n");
1156 pcmcia_release_configuration(p_dev);
1159 out:
1160 return ret;
1164 static int pcmcia_dev_resume(struct device *dev)
1166 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1167 struct pcmcia_driver *p_drv = NULL;
1168 int ret = 0;
1170 mutex_lock(&p_dev->socket->ops_mutex);
1171 if (!p_dev->suspended) {
1172 mutex_unlock(&p_dev->socket->ops_mutex);
1173 return 0;
1175 p_dev->suspended = 0;
1176 mutex_unlock(&p_dev->socket->ops_mutex);
1178 dev_dbg(dev, "resuming\n");
1180 if (dev->driver)
1181 p_drv = to_pcmcia_drv(dev->driver);
1183 if (!p_drv)
1184 goto out;
1186 if (p_dev->device_no == p_dev->func) {
1187 dev_dbg(dev, "requesting configuration\n");
1188 ret = pcmcia_enable_device(p_dev);
1189 if (ret)
1190 goto out;
1193 if (p_drv->resume)
1194 ret = p_drv->resume(p_dev);
1196 out:
1197 return ret;
1201 static int pcmcia_bus_suspend_callback(struct device *dev, void * _data)
1203 struct pcmcia_socket *skt = _data;
1204 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1206 if (p_dev->socket != skt || p_dev->suspended)
1207 return 0;
1209 return runtime_suspend(dev);
1212 static int pcmcia_bus_resume_callback(struct device *dev, void * _data)
1214 struct pcmcia_socket *skt = _data;
1215 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1217 if (p_dev->socket != skt || !p_dev->suspended)
1218 return 0;
1220 runtime_resume(dev);
1222 return 0;
1225 static int pcmcia_bus_resume(struct pcmcia_socket *skt)
1227 dev_dbg(&skt->dev, "resuming socket %d\n", skt->sock);
1228 bus_for_each_dev(&pcmcia_bus_type, NULL, skt, pcmcia_bus_resume_callback);
1229 return 0;
1232 static int pcmcia_bus_suspend(struct pcmcia_socket *skt)
1234 dev_dbg(&skt->dev, "suspending socket %d\n", skt->sock);
1235 if (bus_for_each_dev(&pcmcia_bus_type, NULL, skt,
1236 pcmcia_bus_suspend_callback)) {
1237 pcmcia_bus_resume(skt);
1238 return -EIO;
1240 return 0;
1243 static int pcmcia_bus_remove(struct pcmcia_socket *skt)
1245 atomic_set(&skt->present, 0);
1246 pcmcia_card_remove(skt, NULL);
1248 mutex_lock(&skt->ops_mutex);
1249 destroy_cis_cache(skt);
1250 pcmcia_cleanup_irq(skt);
1251 mutex_unlock(&skt->ops_mutex);
1253 return 0;
1256 static int pcmcia_bus_add(struct pcmcia_socket *skt)
1258 atomic_set(&skt->present, 1);
1260 mutex_lock(&skt->ops_mutex);
1261 skt->pcmcia_pfc = 0;
1262 destroy_cis_cache(skt); /* to be on the safe side... */
1263 mutex_unlock(&skt->ops_mutex);
1265 pcmcia_card_add(skt);
1267 return 0;
1270 static int pcmcia_bus_early_resume(struct pcmcia_socket *skt)
1272 if (!verify_cis_cache(skt)) {
1273 pcmcia_put_socket(skt);
1274 return 0;
1277 dev_dbg(&skt->dev, "cis mismatch - different card\n");
1279 /* first, remove the card */
1280 pcmcia_bus_remove(skt);
1282 mutex_lock(&skt->ops_mutex);
1283 destroy_cis_cache(skt);
1284 kfree(skt->fake_cis);
1285 skt->fake_cis = NULL;
1286 skt->functions = 0;
1287 mutex_unlock(&skt->ops_mutex);
1289 /* now, add the new card */
1290 pcmcia_bus_add(skt);
1291 return 0;
1296 * NOTE: This is racy. There's no guarantee the card will still be
1297 * physically present, even if the call to this function returns
1298 * non-NULL. Furthermore, the device driver most likely is unbound
1299 * almost immediately, so the timeframe where pcmcia_dev_present
1300 * returns NULL is probably really really small.
1302 struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *_p_dev)
1304 struct pcmcia_device *p_dev;
1305 struct pcmcia_device *ret = NULL;
1307 p_dev = pcmcia_get_dev(_p_dev);
1308 if (!p_dev)
1309 return NULL;
1311 if (atomic_read(&p_dev->socket->present) != 0)
1312 ret = p_dev;
1314 pcmcia_put_dev(p_dev);
1315 return ret;
1317 EXPORT_SYMBOL(pcmcia_dev_present);
1320 static struct pcmcia_callback pcmcia_bus_callback = {
1321 .owner = THIS_MODULE,
1322 .add = pcmcia_bus_add,
1323 .remove = pcmcia_bus_remove,
1324 .requery = pcmcia_requery,
1325 .validate = pccard_validate_cis,
1326 .suspend = pcmcia_bus_suspend,
1327 .early_resume = pcmcia_bus_early_resume,
1328 .resume = pcmcia_bus_resume,
1331 static int __devinit pcmcia_bus_add_socket(struct device *dev,
1332 struct class_interface *class_intf)
1334 struct pcmcia_socket *socket = dev_get_drvdata(dev);
1335 int ret;
1337 socket = pcmcia_get_socket(socket);
1338 if (!socket) {
1339 dev_printk(KERN_ERR, dev,
1340 "PCMCIA obtaining reference to socket failed\n");
1341 return -ENODEV;
1344 ret = sysfs_create_bin_file(&dev->kobj, &pccard_cis_attr);
1345 if (ret) {
1346 dev_printk(KERN_ERR, dev, "PCMCIA registration failed\n");
1347 pcmcia_put_socket(socket);
1348 return ret;
1351 INIT_LIST_HEAD(&socket->devices_list);
1352 socket->pcmcia_pfc = 0;
1353 socket->device_count = 0;
1354 atomic_set(&socket->present, 0);
1356 ret = pccard_register_pcmcia(socket, &pcmcia_bus_callback);
1357 if (ret) {
1358 dev_printk(KERN_ERR, dev, "PCMCIA registration failed\n");
1359 pcmcia_put_socket(socket);
1360 return ret;
1363 return 0;
1366 static void pcmcia_bus_remove_socket(struct device *dev,
1367 struct class_interface *class_intf)
1369 struct pcmcia_socket *socket = dev_get_drvdata(dev);
1371 if (!socket)
1372 return;
1374 pccard_register_pcmcia(socket, NULL);
1376 /* unregister any unbound devices */
1377 mutex_lock(&socket->skt_mutex);
1378 pcmcia_card_remove(socket, NULL);
1379 release_cis_mem(socket);
1380 mutex_unlock(&socket->skt_mutex);
1382 sysfs_remove_bin_file(&dev->kobj, &pccard_cis_attr);
1384 pcmcia_put_socket(socket);
1386 return;
1390 /* the pcmcia_bus_interface is used to handle pcmcia socket devices */
1391 static struct class_interface pcmcia_bus_interface __refdata = {
1392 .class = &pcmcia_socket_class,
1393 .add_dev = &pcmcia_bus_add_socket,
1394 .remove_dev = &pcmcia_bus_remove_socket,
1398 struct bus_type pcmcia_bus_type = {
1399 .name = "pcmcia",
1400 .uevent = pcmcia_bus_uevent,
1401 .match = pcmcia_bus_match,
1402 .dev_attrs = pcmcia_dev_attrs,
1403 .probe = pcmcia_device_probe,
1404 .remove = pcmcia_device_remove,
1405 .suspend = pcmcia_dev_suspend,
1406 .resume = pcmcia_dev_resume,
1410 static int __init init_pcmcia_bus(void)
1412 int ret;
1414 ret = bus_register(&pcmcia_bus_type);
1415 if (ret < 0) {
1416 printk(KERN_WARNING "pcmcia: bus_register error: %d\n", ret);
1417 return ret;
1419 ret = class_interface_register(&pcmcia_bus_interface);
1420 if (ret < 0) {
1421 printk(KERN_WARNING
1422 "pcmcia: class_interface_register error: %d\n", ret);
1423 bus_unregister(&pcmcia_bus_type);
1424 return ret;
1427 return 0;
1429 fs_initcall(init_pcmcia_bus); /* one level after subsys_initcall so that
1430 * pcmcia_socket_class is already registered */
1433 static void __exit exit_pcmcia_bus(void)
1435 class_interface_unregister(&pcmcia_bus_interface);
1437 bus_unregister(&pcmcia_bus_type);
1439 module_exit(exit_pcmcia_bus);
1442 MODULE_ALIAS("ds");