1 // SPDX-License-Identifier: GPL-2.0-only
3 * ds.c -- 16-bit PCMCIA core support
5 * The initial developer of the original code is David A. Hinds
7 * are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
9 * (C) 1999 David A. Hinds
10 * (C) 2003 - 2010 Dominik Brodowski
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/errno.h>
17 #include <linux/list.h>
18 #include <linux/delay.h>
19 #include <linux/workqueue.h>
20 #include <linux/crc32.h>
21 #include <linux/firmware.h>
22 #include <linux/kref.h>
23 #include <linux/dma-mapping.h>
24 #include <linux/slab.h>
26 #include <pcmcia/cistpl.h>
27 #include <pcmcia/ds.h>
28 #include <pcmcia/ss.h>
30 #include "cs_internal.h"
32 /*====================================================================*/
34 /* Module parameters */
37 MODULE_DESCRIPTION("PCMCIA Driver Services");
38 MODULE_LICENSE("GPL");
41 /*====================================================================*/
43 static void pcmcia_check_driver(struct pcmcia_driver *p_drv)
45 const struct pcmcia_device_id *did = p_drv->id_table;
49 if (!p_drv->probe || !p_drv->remove)
50 printk(KERN_DEBUG "pcmcia: %s lacks a requisite callback "
51 "function\n", p_drv->name);
53 while (did && did->match_flags) {
54 for (i = 0; i < 4; i++) {
58 hash = crc32(0, did->prod_id[i], strlen(did->prod_id[i]));
59 if (hash == did->prod_id_hash[i])
62 printk(KERN_DEBUG "pcmcia: %s: invalid hash for "
63 "product string \"%s\": is 0x%x, should "
64 "be 0x%x\n", p_drv->name, did->prod_id[i],
65 did->prod_id_hash[i], hash);
66 printk(KERN_DEBUG "pcmcia: see "
67 "Documentation/pcmcia/devicetable.rst for "
77 /*======================================================================*/
81 struct list_head node;
82 struct pcmcia_device_id id;
86 * new_id_store() - add a new PCMCIA device ID to this driver and re-probe devices
87 * @driver: target device driver
88 * @buf: buffer for scanning device ID data
91 * Adds a new dynamic PCMCIA device ID to this driver,
92 * and causes the driver to probe for all devices again.
95 new_id_store(struct device_driver *driver, const char *buf, size_t count)
97 struct pcmcia_dynid *dynid;
98 struct pcmcia_driver *pdrv = to_pcmcia_drv(driver);
99 __u16 match_flags, manf_id, card_id;
100 __u8 func_id, function, device_no;
101 __u32 prod_id_hash[4] = {0, 0, 0, 0};
105 fields = sscanf(buf, "%hx %hx %hx %hhx %hhx %hhx %x %x %x %x",
106 &match_flags, &manf_id, &card_id, &func_id, &function, &device_no,
107 &prod_id_hash[0], &prod_id_hash[1], &prod_id_hash[2], &prod_id_hash[3]);
111 dynid = kzalloc(sizeof(struct pcmcia_dynid), GFP_KERNEL);
115 dynid->id.match_flags = match_flags;
116 dynid->id.manf_id = manf_id;
117 dynid->id.card_id = card_id;
118 dynid->id.func_id = func_id;
119 dynid->id.function = function;
120 dynid->id.device_no = device_no;
121 memcpy(dynid->id.prod_id_hash, prod_id_hash, sizeof(__u32) * 4);
123 mutex_lock(&pdrv->dynids.lock);
124 list_add_tail(&dynid->node, &pdrv->dynids.list);
125 mutex_unlock(&pdrv->dynids.lock);
127 retval = driver_attach(&pdrv->drv);
133 static DRIVER_ATTR_WO(new_id);
136 pcmcia_free_dynids(struct pcmcia_driver *drv)
138 struct pcmcia_dynid *dynid, *n;
140 mutex_lock(&drv->dynids.lock);
141 list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
142 list_del(&dynid->node);
145 mutex_unlock(&drv->dynids.lock);
149 pcmcia_create_newid_file(struct pcmcia_driver *drv)
152 if (drv->probe != NULL)
153 error = driver_create_file(&drv->drv, &driver_attr_new_id);
158 pcmcia_remove_newid_file(struct pcmcia_driver *drv)
160 driver_remove_file(&drv->drv, &driver_attr_new_id);
164 * pcmcia_register_driver - register a PCMCIA driver with the bus core
165 * @driver: the &driver being registered
167 * Registers a PCMCIA driver with the PCMCIA bus core.
169 int pcmcia_register_driver(struct pcmcia_driver *driver)
176 pcmcia_check_driver(driver);
178 /* initialize common fields */
179 driver->drv.bus = &pcmcia_bus_type;
180 driver->drv.owner = driver->owner;
181 driver->drv.name = driver->name;
182 mutex_init(&driver->dynids.lock);
183 INIT_LIST_HEAD(&driver->dynids.list);
185 pr_debug("registering driver %s\n", driver->name);
187 error = driver_register(&driver->drv);
191 error = pcmcia_create_newid_file(driver);
193 driver_unregister(&driver->drv);
197 EXPORT_SYMBOL(pcmcia_register_driver);
200 * pcmcia_unregister_driver - unregister a PCMCIA driver with the bus core
201 * @driver: the &driver being unregistered
203 void pcmcia_unregister_driver(struct pcmcia_driver *driver)
205 pr_debug("unregistering driver %s\n", driver->name);
206 pcmcia_remove_newid_file(driver);
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);
221 return to_pcmcia_dev(tmp_dev);
224 static void pcmcia_put_dev(struct pcmcia_device *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");
237 static void pcmcia_release_dev(struct device *dev)
239 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
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);
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;
259 dev = get_device(dev);
263 p_dev = to_pcmcia_dev(dev);
264 p_drv = to_pcmcia_drv(dev->driver);
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))) {
275 /* set up some more device information */
276 ret = pccard_read_tuple(p_dev->socket, p_dev->func, CISTPL_CONFIG,
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,
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);
292 dev_dbg(dev, "binding to %s failed with %d\n",
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);
310 module_put(p_drv->owner);
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);
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)
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);
353 static int pcmcia_device_remove(struct device *dev)
355 struct pcmcia_device *p_dev;
356 struct pcmcia_driver *p_drv;
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
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" */
375 p_drv->remove(p_dev);
377 /* check for proper unloading */
378 if (p_dev->_irq || p_dev->_io || p_dev->_locked)
380 "pcmcia: driver %s did not release config properly\n",
383 for (i = 0; i < MAX_WIN; i++)
384 if (p_dev->_win & CLIENT_WIN_REQ(i))
386 "pcmcia: driver %s did not release window properly\n",
389 /* references from pcmcia_device_probe */
390 pcmcia_put_dev(p_dev);
391 module_put(p_drv->owner);
398 * pcmcia_device_query -- determine information about a pcmcia device
400 static int pcmcia_device_query(struct pcmcia_device *p_dev)
402 cistpl_manfid_t manf_id;
403 cistpl_funcid_t func_id;
404 cistpl_vers_1_t *vers1;
407 vers1 = kmalloc(sizeof(*vers1), GFP_KERNEL);
411 if (!pccard_read_tuple(p_dev->socket, BIND_FN_ALL,
412 CISTPL_MANFID, &manf_id)) {
413 mutex_lock(&p_dev->socket->ops_mutex);
414 p_dev->manf_id = manf_id.manf;
415 p_dev->card_id = manf_id.card;
416 p_dev->has_manf_id = 1;
417 p_dev->has_card_id = 1;
418 mutex_unlock(&p_dev->socket->ops_mutex);
421 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
422 CISTPL_FUNCID, &func_id)) {
423 mutex_lock(&p_dev->socket->ops_mutex);
424 p_dev->func_id = func_id.func;
425 p_dev->has_func_id = 1;
426 mutex_unlock(&p_dev->socket->ops_mutex);
428 /* rule of thumb: cards with no FUNCID, but with
429 * common memory device geometry information, are
430 * probably memory cards (from pcmcia-cs) */
431 cistpl_device_geo_t *devgeo;
433 devgeo = kmalloc(sizeof(*devgeo), GFP_KERNEL);
438 if (!pccard_read_tuple(p_dev->socket, p_dev->func,
439 CISTPL_DEVICE_GEO, devgeo)) {
441 "mem device geometry probably means "
443 mutex_lock(&p_dev->socket->ops_mutex);
444 p_dev->func_id = CISTPL_FUNCID_MEMORY;
445 p_dev->has_func_id = 1;
446 mutex_unlock(&p_dev->socket->ops_mutex);
451 if (!pccard_read_tuple(p_dev->socket, BIND_FN_ALL, CISTPL_VERS_1,
453 mutex_lock(&p_dev->socket->ops_mutex);
454 for (i = 0; i < min_t(unsigned int, 4, vers1->ns); i++) {
459 tmp = vers1->str + vers1->ofs[i];
461 length = strlen(tmp) + 1;
462 if ((length < 2) || (length > 255))
465 new = kstrdup(tmp, GFP_KERNEL);
469 tmp = p_dev->prod_id[i];
470 p_dev->prod_id[i] = new;
473 mutex_unlock(&p_dev->socket->ops_mutex);
481 static struct pcmcia_device *pcmcia_device_add(struct pcmcia_socket *s,
482 unsigned int function)
484 struct pcmcia_device *p_dev, *tmp_dev;
487 s = pcmcia_get_socket(s);
491 pr_debug("adding device to %d, function %d\n", s->sock, function);
493 p_dev = kzalloc(sizeof(struct pcmcia_device), GFP_KERNEL);
497 mutex_lock(&s->ops_mutex);
498 p_dev->device_no = (s->device_count++);
499 mutex_unlock(&s->ops_mutex);
501 /* max of 2 PFC devices */
502 if ((p_dev->device_no >= 2) && (function == 0))
505 /* max of 4 devices overall */
506 if (p_dev->device_no >= 4)
510 p_dev->func = function;
512 p_dev->dev.bus = &pcmcia_bus_type;
513 p_dev->dev.parent = s->dev.parent;
514 p_dev->dev.release = pcmcia_release_dev;
515 /* by default don't allow DMA */
517 p_dev->dev.dma_mask = &p_dev->dma_mask;
518 dev_set_name(&p_dev->dev, "%d.%d", p_dev->socket->sock, p_dev->device_no);
519 if (!dev_name(&p_dev->dev))
521 p_dev->devname = kasprintf(GFP_KERNEL, "pcmcia%s", dev_name(&p_dev->dev));
524 dev_dbg(&p_dev->dev, "devname is %s\n", p_dev->devname);
526 mutex_lock(&s->ops_mutex);
529 * p_dev->function_config must be the same for all card functions.
530 * Note that this is serialized by ops_mutex, so that only one
531 * such struct will be created.
533 list_for_each_entry(tmp_dev, &s->devices_list, socket_device_list)
534 if (p_dev->func == tmp_dev->func) {
535 p_dev->function_config = tmp_dev->function_config;
536 p_dev->irq = tmp_dev->irq;
537 kref_get(&p_dev->function_config->ref);
540 /* Add to the list in pcmcia_bus_socket */
541 list_add(&p_dev->socket_device_list, &s->devices_list);
543 if (pcmcia_setup_irq(p_dev))
544 dev_warn(&p_dev->dev,
545 "IRQ setup failed -- device might not work\n");
547 if (!p_dev->function_config) {
549 dev_dbg(&p_dev->dev, "creating config_t\n");
550 c = kzalloc(sizeof(struct config_t), GFP_KERNEL);
552 mutex_unlock(&s->ops_mutex);
555 p_dev->function_config = c;
557 for (i = 0; i < MAX_IO_WIN; i++) {
558 c->io[i].name = p_dev->devname;
559 c->io[i].flags = IORESOURCE_IO;
561 for (i = 0; i < MAX_WIN; i++) {
562 c->mem[i].name = p_dev->devname;
563 c->mem[i].flags = IORESOURCE_MEM;
566 for (i = 0; i < MAX_IO_WIN; i++)
567 p_dev->resource[i] = &p_dev->function_config->io[i];
568 for (; i < (MAX_IO_WIN + MAX_WIN); i++)
569 p_dev->resource[i] = &p_dev->function_config->mem[i-MAX_IO_WIN];
571 mutex_unlock(&s->ops_mutex);
573 dev_notice(&p_dev->dev, "pcmcia: registering new device %s (IRQ: %d)\n",
574 p_dev->devname, p_dev->irq);
576 pcmcia_device_query(p_dev);
578 if (device_register(&p_dev->dev))
584 mutex_lock(&s->ops_mutex);
585 list_del(&p_dev->socket_device_list);
586 mutex_unlock(&s->ops_mutex);
589 mutex_lock(&s->ops_mutex);
591 mutex_unlock(&s->ops_mutex);
593 for (i = 0; i < 4; i++)
594 kfree(p_dev->prod_id[i]);
595 kfree(p_dev->devname);
598 pcmcia_put_socket(s);
604 static int pcmcia_card_add(struct pcmcia_socket *s)
606 cistpl_longlink_mfc_t mfc;
607 unsigned int no_funcs, i, no_chains;
610 mutex_lock(&s->ops_mutex);
611 if (!(s->resource_setup_done)) {
613 "no resources available, delaying card_add\n");
614 mutex_unlock(&s->ops_mutex);
615 return -EAGAIN; /* try again, but later... */
618 if (pcmcia_validate_mem(s)) {
619 dev_dbg(&s->dev, "validating mem resources failed, "
620 "delaying card_add\n");
621 mutex_unlock(&s->ops_mutex);
622 return -EAGAIN; /* try again, but later... */
624 mutex_unlock(&s->ops_mutex);
626 ret = pccard_validate_cis(s, &no_chains);
627 if (ret || !no_chains) {
628 #if defined(CONFIG_MTD_PCMCIA_ANONYMOUS)
629 /* Set up as an anonymous card. If we don't have anonymous
630 memory support then just error the card as there is no
631 point trying to second guess.
633 Note: some cards have just a device entry, it may be
634 worth extending support to cover these in future */
636 dev_info(&s->dev, "no CIS, assuming an anonymous memory card.\n");
637 pcmcia_replace_cis(s, "\xFF", 1);
643 dev_dbg(&s->dev, "invalid CIS or invalid resources\n");
648 if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC, &mfc))
652 s->functions = no_funcs;
654 for (i = 0; i < no_funcs; i++)
655 pcmcia_device_add(s, i);
661 static int pcmcia_requery_callback(struct device *dev, void *_data)
663 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
664 if (!p_dev->dev.driver) {
665 dev_dbg(dev, "update device information\n");
666 pcmcia_device_query(p_dev);
673 static void pcmcia_requery(struct pcmcia_socket *s)
677 if (!(s->state & SOCKET_PRESENT))
680 if (s->functions == 0) {
685 /* some device information might have changed because of a CIS
686 * update or because we can finally read it correctly... so
687 * determine it again, overwriting old values if necessary. */
688 bus_for_each_dev(&pcmcia_bus_type, NULL, NULL, pcmcia_requery_callback);
690 /* if the CIS changed, we need to check whether the number of
691 * functions changed. */
693 int old_funcs, new_funcs;
694 cistpl_longlink_mfc_t mfc;
696 /* does this cis override add or remove functions? */
697 old_funcs = s->functions;
699 if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC,
704 if (old_funcs != new_funcs) {
705 /* we need to re-start */
706 pcmcia_card_remove(s, NULL);
712 /* If the PCMCIA device consists of two pseudo devices,
713 * call pcmcia_device_add() -- which will fail if both
714 * devices are already registered. */
715 mutex_lock(&s->ops_mutex);
716 has_pfc = s->pcmcia_pfc;
717 mutex_unlock(&s->ops_mutex);
719 pcmcia_device_add(s, 0);
721 /* we re-scan all devices, not just the ones connected to this
722 * socket. This does not matter, though. */
723 if (bus_rescan_devices(&pcmcia_bus_type))
724 dev_warn(&s->dev, "rescanning the bus failed\n");
728 #ifdef CONFIG_PCMCIA_LOAD_CIS
731 * pcmcia_load_firmware - load CIS from userspace if device-provided is broken
732 * @dev: the pcmcia device which needs a CIS override
733 * @filename: requested filename in /lib/firmware/
735 * This uses the in-kernel firmware loading mechanism to use a "fake CIS" if
736 * the one provided by the card is broken. The firmware files reside in
737 * /lib/firmware/ in userspace.
739 static int pcmcia_load_firmware(struct pcmcia_device *dev, char *filename)
741 struct pcmcia_socket *s = dev->socket;
742 const struct firmware *fw;
744 cistpl_longlink_mfc_t mfc;
745 int old_funcs, new_funcs = 1;
750 dev_dbg(&dev->dev, "trying to load CIS file %s\n", filename);
752 if (request_firmware(&fw, filename, &dev->dev) == 0) {
753 if (fw->size >= CISTPL_MAX_CIS_SIZE) {
755 dev_err(&dev->dev, "pcmcia: CIS override is too big\n");
759 if (!pcmcia_replace_cis(s, fw->data, fw->size))
762 dev_err(&dev->dev, "pcmcia: CIS override failed\n");
766 /* we need to re-start if the number of functions changed */
767 old_funcs = s->functions;
768 if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC,
772 if (old_funcs != new_funcs)
775 /* update information */
776 pcmcia_device_query(dev);
778 /* requery (as number of functions might have changed) */
779 pcmcia_parse_uevents(s, PCMCIA_UEVENT_REQUERY);
782 release_firmware(fw);
787 #else /* !CONFIG_PCMCIA_LOAD_CIS */
789 static inline int pcmcia_load_firmware(struct pcmcia_device *dev,
798 static inline int pcmcia_devmatch(struct pcmcia_device *dev,
799 const struct pcmcia_device_id *did)
801 if (did->match_flags & PCMCIA_DEV_ID_MATCH_MANF_ID) {
802 if ((!dev->has_manf_id) || (dev->manf_id != did->manf_id))
806 if (did->match_flags & PCMCIA_DEV_ID_MATCH_CARD_ID) {
807 if ((!dev->has_card_id) || (dev->card_id != did->card_id))
811 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNCTION) {
812 if (dev->func != did->function)
816 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID1) {
817 if (!dev->prod_id[0])
819 if (strcmp(did->prod_id[0], dev->prod_id[0]))
823 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID2) {
824 if (!dev->prod_id[1])
826 if (strcmp(did->prod_id[1], dev->prod_id[1]))
830 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID3) {
831 if (!dev->prod_id[2])
833 if (strcmp(did->prod_id[2], dev->prod_id[2]))
837 if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID4) {
838 if (!dev->prod_id[3])
840 if (strcmp(did->prod_id[3], dev->prod_id[3]))
844 if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) {
845 dev_dbg(&dev->dev, "this is a pseudo-multi-function device\n");
846 mutex_lock(&dev->socket->ops_mutex);
847 dev->socket->pcmcia_pfc = 1;
848 mutex_unlock(&dev->socket->ops_mutex);
849 if (dev->device_no != did->device_no)
853 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNC_ID) {
856 if ((!dev->has_func_id) || (dev->func_id != did->func_id))
859 /* if this is a pseudo-multi-function device,
860 * we need explicit matches */
861 if (dev->socket->pcmcia_pfc)
866 /* also, FUNC_ID matching needs to be activated by userspace
867 * after it has re-checked that there is no possible module
868 * with a prod_id/manf_id/card_id match.
870 mutex_lock(&dev->socket->ops_mutex);
871 ret = dev->allow_func_id_match;
872 mutex_unlock(&dev->socket->ops_mutex);
876 "skipping FUNC_ID match until userspace ACK\n");
881 if (did->match_flags & PCMCIA_DEV_ID_MATCH_FAKE_CIS) {
882 dev_dbg(&dev->dev, "device needs a fake CIS\n");
883 if (!dev->socket->fake_cis)
884 if (pcmcia_load_firmware(dev, did->cisfile))
888 if (did->match_flags & PCMCIA_DEV_ID_MATCH_ANONYMOUS) {
890 for (i = 0; i < 4; i++)
893 if (dev->has_manf_id || dev->has_card_id || dev->has_func_id)
901 static int pcmcia_bus_match(struct device *dev, struct device_driver *drv)
903 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
904 struct pcmcia_driver *p_drv = to_pcmcia_drv(drv);
905 const struct pcmcia_device_id *did = p_drv->id_table;
906 struct pcmcia_dynid *dynid;
908 /* match dynamic devices first */
909 mutex_lock(&p_drv->dynids.lock);
910 list_for_each_entry(dynid, &p_drv->dynids.list, node) {
911 dev_dbg(dev, "trying to match to %s\n", drv->name);
912 if (pcmcia_devmatch(p_dev, &dynid->id)) {
913 dev_dbg(dev, "matched to %s\n", drv->name);
914 mutex_unlock(&p_drv->dynids.lock);
918 mutex_unlock(&p_drv->dynids.lock);
920 while (did && did->match_flags) {
921 dev_dbg(dev, "trying to match to %s\n", drv->name);
922 if (pcmcia_devmatch(p_dev, did)) {
923 dev_dbg(dev, "matched to %s\n", drv->name);
932 static int pcmcia_bus_uevent(struct device *dev, struct kobj_uevent_env *env)
934 struct pcmcia_device *p_dev;
936 u32 hash[4] = { 0, 0, 0, 0};
941 p_dev = to_pcmcia_dev(dev);
943 /* calculate hashes */
944 for (i = 0; i < 4; i++) {
945 if (!p_dev->prod_id[i])
947 hash[i] = crc32(0, p_dev->prod_id[i], strlen(p_dev->prod_id[i]));
950 if (add_uevent_var(env, "SOCKET_NO=%u", p_dev->socket->sock))
953 if (add_uevent_var(env, "DEVICE_NO=%02X", p_dev->device_no))
956 if (add_uevent_var(env, "MODALIAS=pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
957 "pa%08Xpb%08Xpc%08Xpd%08X",
958 p_dev->has_manf_id ? p_dev->manf_id : 0,
959 p_dev->has_card_id ? p_dev->card_id : 0,
960 p_dev->has_func_id ? p_dev->func_id : 0,
972 /************************ runtime PM support ***************************/
974 static int pcmcia_dev_suspend(struct device *dev);
975 static int pcmcia_dev_resume(struct device *dev);
977 static int runtime_suspend(struct device *dev)
982 rc = pcmcia_dev_suspend(dev);
987 static int runtime_resume(struct device *dev)
992 rc = pcmcia_dev_resume(dev);
997 /************************ per-device sysfs output ***************************/
999 #define pcmcia_device_attr(field, test, format) \
1000 static ssize_t field##_show (struct device *dev, struct device_attribute *attr, char *buf) \
1002 struct pcmcia_device *p_dev = to_pcmcia_dev(dev); \
1003 return p_dev->test ? sprintf(buf, format, p_dev->field) : -ENODEV; \
1005 static DEVICE_ATTR_RO(field);
1007 #define pcmcia_device_stringattr(name, field) \
1008 static ssize_t name##_show (struct device *dev, struct device_attribute *attr, char *buf) \
1010 struct pcmcia_device *p_dev = to_pcmcia_dev(dev); \
1011 return p_dev->field ? sprintf(buf, "%s\n", p_dev->field) : -ENODEV; \
1013 static DEVICE_ATTR_RO(name);
1015 pcmcia_device_attr(func_id, has_func_id, "0x%02x\n");
1016 pcmcia_device_attr(manf_id, has_manf_id, "0x%04x\n");
1017 pcmcia_device_attr(card_id, has_card_id, "0x%04x\n");
1018 pcmcia_device_stringattr(prod_id1, prod_id[0]);
1019 pcmcia_device_stringattr(prod_id2, prod_id[1]);
1020 pcmcia_device_stringattr(prod_id3, prod_id[2]);
1021 pcmcia_device_stringattr(prod_id4, prod_id[3]);
1023 static ssize_t function_show(struct device *dev, struct device_attribute *attr,
1026 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1027 return p_dev->socket ? sprintf(buf, "0x%02x\n", p_dev->func) : -ENODEV;
1029 static DEVICE_ATTR_RO(function);
1031 static ssize_t resources_show(struct device *dev,
1032 struct device_attribute *attr, char *buf)
1034 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1038 for (i = 0; i < PCMCIA_NUM_RESOURCES; i++)
1039 str += sprintf(str, "%pr\n", p_dev->resource[i]);
1043 static DEVICE_ATTR_RO(resources);
1045 static ssize_t pm_state_show(struct device *dev, struct device_attribute *attr, char *buf)
1047 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1049 if (p_dev->suspended)
1050 return sprintf(buf, "off\n");
1052 return sprintf(buf, "on\n");
1055 static ssize_t pm_state_store(struct device *dev, struct device_attribute *attr,
1056 const char *buf, size_t count)
1058 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1064 if ((!p_dev->suspended) && !strncmp(buf, "off", 3))
1065 ret = runtime_suspend(dev);
1066 else if (p_dev->suspended && !strncmp(buf, "on", 2))
1067 ret = runtime_resume(dev);
1069 return ret ? ret : count;
1071 static DEVICE_ATTR_RW(pm_state);
1073 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
1075 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1077 u32 hash[4] = { 0, 0, 0, 0};
1079 /* calculate hashes */
1080 for (i = 0; i < 4; i++) {
1081 if (!p_dev->prod_id[i])
1083 hash[i] = crc32(0, p_dev->prod_id[i],
1084 strlen(p_dev->prod_id[i]));
1086 return sprintf(buf, "pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
1087 "pa%08Xpb%08Xpc%08Xpd%08X\n",
1088 p_dev->has_manf_id ? p_dev->manf_id : 0,
1089 p_dev->has_card_id ? p_dev->card_id : 0,
1090 p_dev->has_func_id ? p_dev->func_id : 0,
1091 p_dev->func, p_dev->device_no,
1092 hash[0], hash[1], hash[2], hash[3]);
1094 static DEVICE_ATTR_RO(modalias);
1096 static ssize_t allow_func_id_match_store(struct device *dev,
1097 struct device_attribute *attr, const char *buf, size_t count)
1099 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1104 mutex_lock(&p_dev->socket->ops_mutex);
1105 p_dev->allow_func_id_match = 1;
1106 mutex_unlock(&p_dev->socket->ops_mutex);
1107 pcmcia_parse_uevents(p_dev->socket, PCMCIA_UEVENT_REQUERY);
1111 static DEVICE_ATTR_WO(allow_func_id_match);
1113 static struct attribute *pcmcia_dev_attrs[] = {
1114 &dev_attr_resources.attr,
1115 &dev_attr_pm_state.attr,
1116 &dev_attr_function.attr,
1117 &dev_attr_func_id.attr,
1118 &dev_attr_manf_id.attr,
1119 &dev_attr_card_id.attr,
1120 &dev_attr_prod_id1.attr,
1121 &dev_attr_prod_id2.attr,
1122 &dev_attr_prod_id3.attr,
1123 &dev_attr_prod_id4.attr,
1124 &dev_attr_modalias.attr,
1125 &dev_attr_allow_func_id_match.attr,
1128 ATTRIBUTE_GROUPS(pcmcia_dev);
1130 /* PM support, also needed for reset */
1132 static int pcmcia_dev_suspend(struct device *dev)
1134 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1135 struct pcmcia_driver *p_drv = NULL;
1138 mutex_lock(&p_dev->socket->ops_mutex);
1139 if (p_dev->suspended) {
1140 mutex_unlock(&p_dev->socket->ops_mutex);
1143 p_dev->suspended = 1;
1144 mutex_unlock(&p_dev->socket->ops_mutex);
1146 dev_dbg(dev, "suspending\n");
1149 p_drv = to_pcmcia_drv(dev->driver);
1154 if (p_drv->suspend) {
1155 ret = p_drv->suspend(p_dev);
1158 "pcmcia: device %s (driver %s) did not want to go to sleep (%d)\n",
1159 p_dev->devname, p_drv->name, ret);
1160 mutex_lock(&p_dev->socket->ops_mutex);
1161 p_dev->suspended = 0;
1162 mutex_unlock(&p_dev->socket->ops_mutex);
1167 if (p_dev->device_no == p_dev->func) {
1168 dev_dbg(dev, "releasing configuration\n");
1169 pcmcia_release_configuration(p_dev);
1177 static int pcmcia_dev_resume(struct device *dev)
1179 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1180 struct pcmcia_driver *p_drv = NULL;
1183 mutex_lock(&p_dev->socket->ops_mutex);
1184 if (!p_dev->suspended) {
1185 mutex_unlock(&p_dev->socket->ops_mutex);
1188 p_dev->suspended = 0;
1189 mutex_unlock(&p_dev->socket->ops_mutex);
1191 dev_dbg(dev, "resuming\n");
1194 p_drv = to_pcmcia_drv(dev->driver);
1199 if (p_dev->device_no == p_dev->func) {
1200 dev_dbg(dev, "requesting configuration\n");
1201 ret = pcmcia_enable_device(p_dev);
1207 ret = p_drv->resume(p_dev);
1214 static int pcmcia_bus_suspend_callback(struct device *dev, void *_data)
1216 struct pcmcia_socket *skt = _data;
1217 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1219 if (p_dev->socket != skt || p_dev->suspended)
1222 return runtime_suspend(dev);
1225 static int pcmcia_bus_resume_callback(struct device *dev, void *_data)
1227 struct pcmcia_socket *skt = _data;
1228 struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1230 if (p_dev->socket != skt || !p_dev->suspended)
1233 runtime_resume(dev);
1238 static int pcmcia_bus_resume(struct pcmcia_socket *skt)
1240 dev_dbg(&skt->dev, "resuming socket %d\n", skt->sock);
1241 bus_for_each_dev(&pcmcia_bus_type, NULL, skt, pcmcia_bus_resume_callback);
1245 static int pcmcia_bus_suspend(struct pcmcia_socket *skt)
1247 dev_dbg(&skt->dev, "suspending socket %d\n", skt->sock);
1248 if (bus_for_each_dev(&pcmcia_bus_type, NULL, skt,
1249 pcmcia_bus_suspend_callback)) {
1250 pcmcia_bus_resume(skt);
1256 static int pcmcia_bus_remove(struct pcmcia_socket *skt)
1258 atomic_set(&skt->present, 0);
1259 pcmcia_card_remove(skt, NULL);
1261 mutex_lock(&skt->ops_mutex);
1262 destroy_cis_cache(skt);
1263 pcmcia_cleanup_irq(skt);
1264 mutex_unlock(&skt->ops_mutex);
1269 static int pcmcia_bus_add(struct pcmcia_socket *skt)
1271 atomic_set(&skt->present, 1);
1273 mutex_lock(&skt->ops_mutex);
1274 skt->pcmcia_pfc = 0;
1275 destroy_cis_cache(skt); /* to be on the safe side... */
1276 mutex_unlock(&skt->ops_mutex);
1278 pcmcia_card_add(skt);
1283 static int pcmcia_bus_early_resume(struct pcmcia_socket *skt)
1285 if (!verify_cis_cache(skt))
1288 dev_dbg(&skt->dev, "cis mismatch - different card\n");
1290 /* first, remove the card */
1291 pcmcia_bus_remove(skt);
1293 mutex_lock(&skt->ops_mutex);
1294 destroy_cis_cache(skt);
1295 kfree(skt->fake_cis);
1296 skt->fake_cis = NULL;
1298 mutex_unlock(&skt->ops_mutex);
1300 /* now, add the new card */
1301 pcmcia_bus_add(skt);
1307 * NOTE: This is racy. There's no guarantee the card will still be
1308 * physically present, even if the call to this function returns
1309 * non-NULL. Furthermore, the device driver most likely is unbound
1310 * almost immediately, so the timeframe where pcmcia_dev_present
1311 * returns NULL is probably really really small.
1313 struct pcmcia_device *pcmcia_dev_present(struct pcmcia_device *_p_dev)
1315 struct pcmcia_device *p_dev;
1316 struct pcmcia_device *ret = NULL;
1318 p_dev = pcmcia_get_dev(_p_dev);
1322 if (atomic_read(&p_dev->socket->present) != 0)
1325 pcmcia_put_dev(p_dev);
1328 EXPORT_SYMBOL(pcmcia_dev_present);
1331 static struct pcmcia_callback pcmcia_bus_callback = {
1332 .owner = THIS_MODULE,
1333 .add = pcmcia_bus_add,
1334 .remove = pcmcia_bus_remove,
1335 .requery = pcmcia_requery,
1336 .validate = pccard_validate_cis,
1337 .suspend = pcmcia_bus_suspend,
1338 .early_resume = pcmcia_bus_early_resume,
1339 .resume = pcmcia_bus_resume,
1342 static int pcmcia_bus_add_socket(struct device *dev,
1343 struct class_interface *class_intf)
1345 struct pcmcia_socket *socket = dev_get_drvdata(dev);
1348 socket = pcmcia_get_socket(socket);
1350 dev_err(dev, "PCMCIA obtaining reference to socket failed\n");
1354 ret = sysfs_create_bin_file(&dev->kobj, &pccard_cis_attr);
1356 dev_err(dev, "PCMCIA registration failed\n");
1357 pcmcia_put_socket(socket);
1361 INIT_LIST_HEAD(&socket->devices_list);
1362 socket->pcmcia_pfc = 0;
1363 socket->device_count = 0;
1364 atomic_set(&socket->present, 0);
1366 ret = pccard_register_pcmcia(socket, &pcmcia_bus_callback);
1368 dev_err(dev, "PCMCIA registration failed\n");
1369 pcmcia_put_socket(socket);
1376 static void pcmcia_bus_remove_socket(struct device *dev,
1377 struct class_interface *class_intf)
1379 struct pcmcia_socket *socket = dev_get_drvdata(dev);
1384 pccard_register_pcmcia(socket, NULL);
1386 /* unregister any unbound devices */
1387 mutex_lock(&socket->skt_mutex);
1388 pcmcia_card_remove(socket, NULL);
1389 release_cis_mem(socket);
1390 mutex_unlock(&socket->skt_mutex);
1392 sysfs_remove_bin_file(&dev->kobj, &pccard_cis_attr);
1394 pcmcia_put_socket(socket);
1400 /* the pcmcia_bus_interface is used to handle pcmcia socket devices */
1401 static struct class_interface pcmcia_bus_interface __refdata = {
1402 .class = &pcmcia_socket_class,
1403 .add_dev = &pcmcia_bus_add_socket,
1404 .remove_dev = &pcmcia_bus_remove_socket,
1407 static const struct dev_pm_ops pcmcia_bus_pm_ops = {
1408 SET_SYSTEM_SLEEP_PM_OPS(pcmcia_dev_suspend, pcmcia_dev_resume)
1411 struct bus_type pcmcia_bus_type = {
1413 .uevent = pcmcia_bus_uevent,
1414 .match = pcmcia_bus_match,
1415 .dev_groups = pcmcia_dev_groups,
1416 .probe = pcmcia_device_probe,
1417 .remove = pcmcia_device_remove,
1418 .pm = &pcmcia_bus_pm_ops,
1422 static int __init init_pcmcia_bus(void)
1426 ret = bus_register(&pcmcia_bus_type);
1428 printk(KERN_WARNING "pcmcia: bus_register error: %d\n", ret);
1431 ret = class_interface_register(&pcmcia_bus_interface);
1434 "pcmcia: class_interface_register error: %d\n", ret);
1435 bus_unregister(&pcmcia_bus_type);
1441 fs_initcall(init_pcmcia_bus); /* one level after subsys_initcall so that
1442 * pcmcia_socket_class is already registered */
1445 static void __exit exit_pcmcia_bus(void)
1447 class_interface_unregister(&pcmcia_bus_interface);
1449 bus_unregister(&pcmcia_bus_type);
1451 module_exit(exit_pcmcia_bus);