xref: /linux/drivers/pcmcia/ds.c (revision f3d9478b2ce468c3115b02ecae7e975990697f15)
1 /*
2  * ds.c -- 16-bit PCMCIA core support
3  *
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.
7  *
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.
11  *
12  * (C) 1999		David A. Hinds
13  * (C) 2003 - 2006	Dominik Brodowski
14  */
15 
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 
27 #define IN_CARD_SERVICES
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>
33 
34 #include "cs_internal.h"
35 #include "ds_internal.h"
36 
37 /*====================================================================*/
38 
39 /* Module parameters */
40 
41 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
42 MODULE_DESCRIPTION("PCMCIA Driver Services");
43 MODULE_LICENSE("GPL");
44 
45 #ifdef DEBUG
46 int ds_pc_debug;
47 
48 module_param_named(pc_debug, ds_pc_debug, int, 0644);
49 
50 #define ds_dbg(lvl, fmt, arg...) do {				\
51 	if (ds_pc_debug > (lvl))					\
52 		printk(KERN_DEBUG "ds: " fmt , ## arg);		\
53 } while (0)
54 #else
55 #define ds_dbg(lvl, fmt, arg...) do { } while (0)
56 #endif
57 
58 spinlock_t pcmcia_dev_list_lock;
59 
60 /*====================================================================*/
61 
62 /* code which was in cs.c before */
63 
64 /* String tables for error messages */
65 
66 typedef struct lookup_t {
67     int key;
68     char *msg;
69 } lookup_t;
70 
71 static const lookup_t error_table[] = {
72     { CS_SUCCESS,		"Operation succeeded" },
73     { CS_BAD_ADAPTER,		"Bad adapter" },
74     { CS_BAD_ATTRIBUTE, 	"Bad attribute", },
75     { CS_BAD_BASE,		"Bad base address" },
76     { CS_BAD_EDC,		"Bad EDC" },
77     { CS_BAD_IRQ,		"Bad IRQ" },
78     { CS_BAD_OFFSET,		"Bad offset" },
79     { CS_BAD_PAGE,		"Bad page number" },
80     { CS_READ_FAILURE,		"Read failure" },
81     { CS_BAD_SIZE,		"Bad size" },
82     { CS_BAD_SOCKET,		"Bad socket" },
83     { CS_BAD_TYPE,		"Bad type" },
84     { CS_BAD_VCC,		"Bad Vcc" },
85     { CS_BAD_VPP,		"Bad Vpp" },
86     { CS_BAD_WINDOW,		"Bad window" },
87     { CS_WRITE_FAILURE,		"Write failure" },
88     { CS_NO_CARD,		"No card present" },
89     { CS_UNSUPPORTED_FUNCTION,	"Usupported function" },
90     { CS_UNSUPPORTED_MODE,	"Unsupported mode" },
91     { CS_BAD_SPEED,		"Bad speed" },
92     { CS_BUSY,			"Resource busy" },
93     { CS_GENERAL_FAILURE,	"General failure" },
94     { CS_WRITE_PROTECTED,	"Write protected" },
95     { CS_BAD_ARG_LENGTH,	"Bad argument length" },
96     { CS_BAD_ARGS,		"Bad arguments" },
97     { CS_CONFIGURATION_LOCKED,	"Configuration locked" },
98     { CS_IN_USE,		"Resource in use" },
99     { CS_NO_MORE_ITEMS,		"No more items" },
100     { CS_OUT_OF_RESOURCE,	"Out of resource" },
101     { CS_BAD_HANDLE,		"Bad handle" },
102     { CS_BAD_TUPLE,		"Bad CIS tuple" }
103 };
104 
105 
106 static const lookup_t service_table[] = {
107     { AccessConfigurationRegister,	"AccessConfigurationRegister" },
108     { AddSocketServices,		"AddSocketServices" },
109     { AdjustResourceInfo,		"AdjustResourceInfo" },
110     { CheckEraseQueue,			"CheckEraseQueue" },
111     { CloseMemory,			"CloseMemory" },
112     { DeregisterClient,			"DeregisterClient" },
113     { DeregisterEraseQueue,		"DeregisterEraseQueue" },
114     { GetCardServicesInfo,		"GetCardServicesInfo" },
115     { GetClientInfo,			"GetClientInfo" },
116     { GetConfigurationInfo,		"GetConfigurationInfo" },
117     { GetEventMask,			"GetEventMask" },
118     { GetFirstClient,			"GetFirstClient" },
119     { GetFirstRegion,			"GetFirstRegion" },
120     { GetFirstTuple,			"GetFirstTuple" },
121     { GetNextClient,			"GetNextClient" },
122     { GetNextRegion,			"GetNextRegion" },
123     { GetNextTuple,			"GetNextTuple" },
124     { GetStatus,			"GetStatus" },
125     { GetTupleData,			"GetTupleData" },
126     { MapMemPage,			"MapMemPage" },
127     { ModifyConfiguration,		"ModifyConfiguration" },
128     { ModifyWindow,			"ModifyWindow" },
129     { OpenMemory,			"OpenMemory" },
130     { ParseTuple,			"ParseTuple" },
131     { ReadMemory,			"ReadMemory" },
132     { RegisterClient,			"RegisterClient" },
133     { RegisterEraseQueue,		"RegisterEraseQueue" },
134     { RegisterMTD,			"RegisterMTD" },
135     { ReleaseConfiguration,		"ReleaseConfiguration" },
136     { ReleaseIO,			"ReleaseIO" },
137     { ReleaseIRQ,			"ReleaseIRQ" },
138     { ReleaseWindow,			"ReleaseWindow" },
139     { RequestConfiguration,		"RequestConfiguration" },
140     { RequestIO,			"RequestIO" },
141     { RequestIRQ,			"RequestIRQ" },
142     { RequestSocketMask,		"RequestSocketMask" },
143     { RequestWindow,			"RequestWindow" },
144     { ResetCard,			"ResetCard" },
145     { SetEventMask,			"SetEventMask" },
146     { ValidateCIS,			"ValidateCIS" },
147     { WriteMemory,			"WriteMemory" },
148     { BindDevice,			"BindDevice" },
149     { BindMTD,				"BindMTD" },
150     { ReportError,			"ReportError" },
151     { SuspendCard,			"SuspendCard" },
152     { ResumeCard,			"ResumeCard" },
153     { EjectCard,			"EjectCard" },
154     { InsertCard,			"InsertCard" },
155     { ReplaceCIS,			"ReplaceCIS" }
156 };
157 
158 
159 static int pcmcia_report_error(struct pcmcia_device *p_dev, error_info_t *err)
160 {
161 	int i;
162 	char *serv;
163 
164 	if (!p_dev)
165 		printk(KERN_NOTICE);
166 	else
167 		printk(KERN_NOTICE "%s: ", p_dev->dev.bus_id);
168 
169 	for (i = 0; i < ARRAY_SIZE(service_table); i++)
170 		if (service_table[i].key == err->func)
171 			break;
172 	if (i < ARRAY_SIZE(service_table))
173 		serv = service_table[i].msg;
174 	else
175 		serv = "Unknown service number";
176 
177 	for (i = 0; i < ARRAY_SIZE(error_table); i++)
178 		if (error_table[i].key == err->retcode)
179 			break;
180 	if (i < ARRAY_SIZE(error_table))
181 		printk("%s: %s\n", serv, error_table[i].msg);
182 	else
183 		printk("%s: Unknown error code %#x\n", serv, err->retcode);
184 
185 	return CS_SUCCESS;
186 } /* report_error */
187 
188 /* end of code which was in cs.c before */
189 
190 /*======================================================================*/
191 
192 void cs_error(struct pcmcia_device *p_dev, int func, int ret)
193 {
194 	error_info_t err = { func, ret };
195 	pcmcia_report_error(p_dev, &err);
196 }
197 EXPORT_SYMBOL(cs_error);
198 
199 
200 static void pcmcia_check_driver(struct pcmcia_driver *p_drv)
201 {
202 	struct pcmcia_device_id *did = p_drv->id_table;
203 	unsigned int i;
204 	u32 hash;
205 
206 	if (!p_drv->probe || !p_drv->remove)
207 		printk(KERN_DEBUG "pcmcia: %s lacks a requisite callback "
208 		       "function\n", p_drv->drv.name);
209 
210 	while (did && did->match_flags) {
211 		for (i=0; i<4; i++) {
212 			if (!did->prod_id[i])
213 				continue;
214 
215 			hash = crc32(0, did->prod_id[i], strlen(did->prod_id[i]));
216 			if (hash == did->prod_id_hash[i])
217 				continue;
218 
219 			printk(KERN_DEBUG "pcmcia: %s: invalid hash for "
220 			       "product string \"%s\": is 0x%x, should "
221 			       "be 0x%x\n", p_drv->drv.name, did->prod_id[i],
222 			       did->prod_id_hash[i], hash);
223 			printk(KERN_DEBUG "pcmcia: see "
224 				"Documentation/pcmcia/devicetable.txt for "
225 				"details\n");
226 		}
227 		did++;
228 	}
229 
230 	return;
231 }
232 
233 
234 #ifdef CONFIG_PCMCIA_LOAD_CIS
235 
236 /**
237  * pcmcia_load_firmware - load CIS from userspace if device-provided is broken
238  * @dev - the pcmcia device which needs a CIS override
239  * @filename - requested filename in /lib/firmware/
240  *
241  * This uses the in-kernel firmware loading mechanism to use a "fake CIS" if
242  * the one provided by the card is broken. The firmware files reside in
243  * /lib/firmware/ in userspace.
244  */
245 static int pcmcia_load_firmware(struct pcmcia_device *dev, char * filename)
246 {
247 	struct pcmcia_socket *s = dev->socket;
248 	const struct firmware *fw;
249 	char path[20];
250 	int ret=-ENOMEM;
251 	cisdump_t *cis;
252 
253 	if (!filename)
254 		return -EINVAL;
255 
256 	ds_dbg(1, "trying to load firmware %s\n", filename);
257 
258 	if (strlen(filename) > 14)
259 		return -EINVAL;
260 
261 	snprintf(path, 20, "%s", filename);
262 
263 	if (request_firmware(&fw, path, &dev->dev) == 0) {
264 		if (fw->size >= CISTPL_MAX_CIS_SIZE)
265 			goto release;
266 
267 		cis = kzalloc(sizeof(cisdump_t), GFP_KERNEL);
268 		if (!cis)
269 			goto release;
270 
271 		cis->Length = fw->size + 1;
272 		memcpy(cis->Data, fw->data, fw->size);
273 
274 		if (!pcmcia_replace_cis(s, cis))
275 			ret = 0;
276 	}
277  release:
278 	release_firmware(fw);
279 
280 	return (ret);
281 }
282 
283 #else /* !CONFIG_PCMCIA_LOAD_CIS */
284 
285 static inline int pcmcia_load_firmware(struct pcmcia_device *dev, char * filename)
286 {
287 	return -ENODEV;
288 }
289 
290 #endif
291 
292 
293 /*======================================================================*/
294 
295 
296 /**
297  * pcmcia_register_driver - register a PCMCIA driver with the bus core
298  *
299  * Registers a PCMCIA driver with the PCMCIA bus core.
300  */
301 int pcmcia_register_driver(struct pcmcia_driver *driver)
302 {
303 	if (!driver)
304 		return -EINVAL;
305 
306 	pcmcia_check_driver(driver);
307 
308 	/* initialize common fields */
309 	driver->drv.bus = &pcmcia_bus_type;
310 	driver->drv.owner = driver->owner;
311 
312 	return driver_register(&driver->drv);
313 }
314 EXPORT_SYMBOL(pcmcia_register_driver);
315 
316 /**
317  * pcmcia_unregister_driver - unregister a PCMCIA driver with the bus core
318  */
319 void pcmcia_unregister_driver(struct pcmcia_driver *driver)
320 {
321 	driver_unregister(&driver->drv);
322 }
323 EXPORT_SYMBOL(pcmcia_unregister_driver);
324 
325 
326 /* pcmcia_device handling */
327 
328 struct pcmcia_device * pcmcia_get_dev(struct pcmcia_device *p_dev)
329 {
330 	struct device *tmp_dev;
331 	tmp_dev = get_device(&p_dev->dev);
332 	if (!tmp_dev)
333 		return NULL;
334 	return to_pcmcia_dev(tmp_dev);
335 }
336 
337 void pcmcia_put_dev(struct pcmcia_device *p_dev)
338 {
339 	if (p_dev)
340 		put_device(&p_dev->dev);
341 }
342 
343 static void pcmcia_release_function(struct kref *ref)
344 {
345 	struct config_t *c = container_of(ref, struct config_t, ref);
346 	kfree(c);
347 }
348 
349 static void pcmcia_release_dev(struct device *dev)
350 {
351 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
352 	ds_dbg(1, "releasing dev %p\n", p_dev);
353 	pcmcia_put_socket(p_dev->socket);
354 	kfree(p_dev->devname);
355 	kref_put(&p_dev->function_config->ref, pcmcia_release_function);
356 	kfree(p_dev);
357 }
358 
359 static void pcmcia_add_pseudo_device(struct pcmcia_socket *s)
360 {
361 	if (!s->pcmcia_state.device_add_pending) {
362 		s->pcmcia_state.device_add_pending = 1;
363 		schedule_work(&s->device_add);
364 	}
365 	return;
366 }
367 
368 static int pcmcia_device_probe(struct device * dev)
369 {
370 	struct pcmcia_device *p_dev;
371 	struct pcmcia_driver *p_drv;
372 	struct pcmcia_device_id *did;
373 	struct pcmcia_socket *s;
374 	int ret = 0;
375 
376 	dev = get_device(dev);
377 	if (!dev)
378 		return -ENODEV;
379 
380 	p_dev = to_pcmcia_dev(dev);
381 	p_drv = to_pcmcia_drv(dev->driver);
382 	s = p_dev->socket;
383 
384 	if ((!p_drv->probe) || (!p_dev->function_config) ||
385 	    (!try_module_get(p_drv->owner))) {
386 		ret = -EINVAL;
387 		goto put_dev;
388 	}
389 
390 	ret = p_drv->probe(p_dev);
391 	if (ret)
392 		goto put_module;
393 
394 	/* handle pseudo multifunction devices:
395 	 * there are at most two pseudo multifunction devices.
396 	 * if we're matching against the first, schedule a
397 	 * call which will then check whether there are two
398 	 * pseudo devices, and if not, add the second one.
399 	 */
400 	did = p_dev->dev.driver_data;
401 	if (did && (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) &&
402 	    (p_dev->socket->device_count == 1) && (p_dev->device_no == 0))
403 		pcmcia_add_pseudo_device(p_dev->socket);
404 
405  put_module:
406 	if (ret)
407 		module_put(p_drv->owner);
408  put_dev:
409 	if (ret)
410 		put_device(dev);
411 	return (ret);
412 }
413 
414 
415 /*
416  * Removes a PCMCIA card from the device tree and socket list.
417  */
418 static void pcmcia_card_remove(struct pcmcia_socket *s, struct pcmcia_device *leftover)
419 {
420 	struct pcmcia_device	*p_dev;
421 	struct pcmcia_device	*tmp;
422 	unsigned long		flags;
423 
424 	ds_dbg(2, "unbind_request(%d)\n", s->sock);
425 
426 
427 	if (!leftover)
428 		s->device_count = 0;
429 	else
430 		s->device_count = 1;
431 
432 	/* unregister all pcmcia_devices registered with this socket, except leftover */
433 	list_for_each_entry_safe(p_dev, tmp, &s->devices_list, socket_device_list) {
434 		if (p_dev == leftover)
435 			continue;
436 
437 		spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
438 		list_del(&p_dev->socket_device_list);
439 		p_dev->_removed=1;
440 		spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
441 
442 		device_unregister(&p_dev->dev);
443 	}
444 
445 	return;
446 }
447 
448 static int pcmcia_device_remove(struct device * dev)
449 {
450 	struct pcmcia_device *p_dev;
451 	struct pcmcia_driver *p_drv;
452 	struct pcmcia_device_id *did;
453 	int i;
454 
455 	p_dev = to_pcmcia_dev(dev);
456 	p_drv = to_pcmcia_drv(dev->driver);
457 
458 	/* If we're removing the primary module driving a
459 	 * pseudo multi-function card, we need to unbind
460 	 * all devices
461 	 */
462 	did = p_dev->dev.driver_data;
463 	if (did && (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) &&
464 	    (p_dev->socket->device_count != 0) &&
465 	    (p_dev->device_no == 0))
466 		pcmcia_card_remove(p_dev->socket, p_dev);
467 
468 	/* detach the "instance" */
469 	if (!p_drv)
470 		return 0;
471 
472 	if (p_drv->remove)
473 	       	p_drv->remove(p_dev);
474 
475 	p_dev->dev_node = NULL;
476 
477 	/* check for proper unloading */
478 	if (p_dev->_irq || p_dev->_io || p_dev->_locked)
479 		printk(KERN_INFO "pcmcia: driver %s did not release config properly\n",
480 		       p_drv->drv.name);
481 
482 	for (i = 0; i < MAX_WIN; i++)
483 		if (p_dev->_win & CLIENT_WIN_REQ(i))
484 			printk(KERN_INFO "pcmcia: driver %s did not release windows properly\n",
485 			       p_drv->drv.name);
486 
487 	/* references from pcmcia_probe_device */
488 	pcmcia_put_dev(p_dev);
489 	module_put(p_drv->owner);
490 
491 	return 0;
492 }
493 
494 
495 /*
496  * pcmcia_device_query -- determine information about a pcmcia device
497  */
498 static int pcmcia_device_query(struct pcmcia_device *p_dev)
499 {
500 	cistpl_manfid_t manf_id;
501 	cistpl_funcid_t func_id;
502 	cistpl_vers_1_t	*vers1;
503 	unsigned int i;
504 
505 	vers1 = kmalloc(sizeof(*vers1), GFP_KERNEL);
506 	if (!vers1)
507 		return -ENOMEM;
508 
509 	if (!pccard_read_tuple(p_dev->socket, p_dev->func,
510 			       CISTPL_MANFID, &manf_id)) {
511 		p_dev->manf_id = manf_id.manf;
512 		p_dev->card_id = manf_id.card;
513 		p_dev->has_manf_id = 1;
514 		p_dev->has_card_id = 1;
515 	}
516 
517 	if (!pccard_read_tuple(p_dev->socket, p_dev->func,
518 			       CISTPL_FUNCID, &func_id)) {
519 		p_dev->func_id = func_id.func;
520 		p_dev->has_func_id = 1;
521 	} else {
522 		/* rule of thumb: cards with no FUNCID, but with
523 		 * common memory device geometry information, are
524 		 * probably memory cards (from pcmcia-cs) */
525 		cistpl_device_geo_t *devgeo;
526 
527 		devgeo = kmalloc(sizeof(*devgeo), GFP_KERNEL);
528 		if (!devgeo) {
529 			kfree(vers1);
530 			return -ENOMEM;
531 		}
532 		if (!pccard_read_tuple(p_dev->socket, p_dev->func,
533 				      CISTPL_DEVICE_GEO, devgeo)) {
534 			ds_dbg(0, "mem device geometry probably means "
535 			       "FUNCID_MEMORY\n");
536 			p_dev->func_id = CISTPL_FUNCID_MEMORY;
537 			p_dev->has_func_id = 1;
538 		}
539 		kfree(devgeo);
540 	}
541 
542 	if (!pccard_read_tuple(p_dev->socket, p_dev->func, CISTPL_VERS_1,
543 			       vers1)) {
544 		for (i=0; i < vers1->ns; i++) {
545 			char *tmp;
546 			unsigned int length;
547 
548 			tmp = vers1->str + vers1->ofs[i];
549 
550 			length = strlen(tmp) + 1;
551 			if ((length < 2) || (length > 255))
552 				continue;
553 
554 			p_dev->prod_id[i] = kmalloc(sizeof(char) * length,
555 						    GFP_KERNEL);
556 			if (!p_dev->prod_id[i])
557 				continue;
558 
559 			p_dev->prod_id[i] = strncpy(p_dev->prod_id[i],
560 						    tmp, length);
561 		}
562 	}
563 
564 	kfree(vers1);
565 	return 0;
566 }
567 
568 
569 /* device_add_lock is needed to avoid double registration by cardmgr and kernel.
570  * Serializes pcmcia_device_add; will most likely be removed in future.
571  *
572  * While it has the caveat that adding new PCMCIA devices inside(!) device_register()
573  * won't work, this doesn't matter much at the moment: the driver core doesn't
574  * support it either.
575  */
576 static DEFINE_MUTEX(device_add_lock);
577 
578 struct pcmcia_device * pcmcia_device_add(struct pcmcia_socket *s, unsigned int function)
579 {
580 	struct pcmcia_device *p_dev, *tmp_dev;
581 	unsigned long flags;
582 	int bus_id_len;
583 
584 	s = pcmcia_get_socket(s);
585 	if (!s)
586 		return NULL;
587 
588 	mutex_lock(&device_add_lock);
589 
590 	/* max of 2 devices per card */
591 	if (s->device_count == 2)
592 		goto err_put;
593 
594 	p_dev = kzalloc(sizeof(struct pcmcia_device), GFP_KERNEL);
595 	if (!p_dev)
596 		goto err_put;
597 
598 	p_dev->socket = s;
599 	p_dev->device_no = (s->device_count++);
600 	p_dev->func   = function;
601 	if (s->functions <= function)
602 		s->functions = function + 1;
603 
604 	p_dev->dev.bus = &pcmcia_bus_type;
605 	p_dev->dev.parent = s->dev.dev;
606 	p_dev->dev.release = pcmcia_release_dev;
607 	bus_id_len = sprintf (p_dev->dev.bus_id, "%d.%d", p_dev->socket->sock, p_dev->device_no);
608 
609 	p_dev->devname = kmalloc(6 + bus_id_len + 1, GFP_KERNEL);
610 	if (!p_dev->devname)
611 		goto err_free;
612 	sprintf (p_dev->devname, "pcmcia%s", p_dev->dev.bus_id);
613 
614 	/* compat */
615 	spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
616 
617 	/*
618 	 * p_dev->function_config must be the same for all card functions.
619 	 * Note that this is serialized by the device_add_lock, so that
620 	 * only one such struct will be created.
621 	 */
622         list_for_each_entry(tmp_dev, &s->devices_list, socket_device_list)
623                 if (p_dev->func == tmp_dev->func) {
624 			p_dev->function_config = tmp_dev->function_config;
625 			kref_get(&p_dev->function_config->ref);
626 		}
627 
628 	/* Add to the list in pcmcia_bus_socket */
629 	list_add(&p_dev->socket_device_list, &s->devices_list);
630 
631 	spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
632 
633 	if (!p_dev->function_config) {
634 		p_dev->function_config = kzalloc(sizeof(struct config_t),
635 						 GFP_KERNEL);
636 		if (!p_dev->function_config)
637 			goto err_unreg;
638 		kref_init(&p_dev->function_config->ref);
639 	}
640 
641 	printk(KERN_NOTICE "pcmcia: registering new device %s\n",
642 	       p_dev->devname);
643 
644 	pcmcia_device_query(p_dev);
645 
646 	if (device_register(&p_dev->dev))
647 		goto err_unreg;
648 
649 	mutex_unlock(&device_add_lock);
650 
651 	return p_dev;
652 
653  err_unreg:
654 	spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
655 	list_del(&p_dev->socket_device_list);
656 	spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
657 
658  err_free:
659 	kfree(p_dev->devname);
660 	kfree(p_dev);
661 	s->device_count--;
662  err_put:
663 	mutex_unlock(&device_add_lock);
664 	pcmcia_put_socket(s);
665 
666 	return NULL;
667 }
668 
669 
670 static int pcmcia_card_add(struct pcmcia_socket *s)
671 {
672 	cisinfo_t cisinfo;
673 	cistpl_longlink_mfc_t mfc;
674 	unsigned int no_funcs, i;
675 	int ret = 0;
676 
677 	if (!(s->resource_setup_done))
678 		return -EAGAIN; /* try again, but later... */
679 
680 	if (pcmcia_validate_mem(s))
681 		return -EAGAIN; /* try again, but later... */
682 
683 	ret = pccard_validate_cis(s, BIND_FN_ALL, &cisinfo);
684 	if (ret || !cisinfo.Chains) {
685 		ds_dbg(0, "invalid CIS or invalid resources\n");
686 		return -ENODEV;
687 	}
688 
689 	if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC, &mfc))
690 		no_funcs = mfc.nfn;
691 	else
692 		no_funcs = 1;
693 
694 	for (i=0; i < no_funcs; i++)
695 		pcmcia_device_add(s, i);
696 
697 	return (ret);
698 }
699 
700 
701 static void pcmcia_delayed_add_pseudo_device(void *data)
702 {
703 	struct pcmcia_socket *s = data;
704 	pcmcia_device_add(s, 0);
705 	s->pcmcia_state.device_add_pending = 0;
706 }
707 
708 static int pcmcia_requery(struct device *dev, void * _data)
709 {
710 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
711 	if (!p_dev->dev.driver)
712 		pcmcia_device_query(p_dev);
713 
714 	return 0;
715 }
716 
717 static void pcmcia_bus_rescan(struct pcmcia_socket *skt)
718 {
719 	int no_devices=0;
720 	unsigned long flags;
721 
722 	/* must be called with skt_mutex held */
723 	spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
724 	if (list_empty(&skt->devices_list))
725 		no_devices=1;
726 	spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
727 
728 	/* if no devices were added for this socket yet because of
729 	 * missing resource information or other trouble, we need to
730 	 * do this now. */
731 	if (no_devices) {
732 		int ret = pcmcia_card_add(skt);
733 		if (ret)
734 			return;
735 	}
736 
737 	/* some device information might have changed because of a CIS
738 	 * update or because we can finally read it correctly... so
739 	 * determine it again, overwriting old values if necessary. */
740 	bus_for_each_dev(&pcmcia_bus_type, NULL, NULL, pcmcia_requery);
741 
742 	/* we re-scan all devices, not just the ones connected to this
743 	 * socket. This does not matter, though. */
744 	bus_rescan_devices(&pcmcia_bus_type);
745 }
746 
747 static inline int pcmcia_devmatch(struct pcmcia_device *dev,
748 				  struct pcmcia_device_id *did)
749 {
750 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_MANF_ID) {
751 		if ((!dev->has_manf_id) || (dev->manf_id != did->manf_id))
752 			return 0;
753 	}
754 
755 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_CARD_ID) {
756 		if ((!dev->has_card_id) || (dev->card_id != did->card_id))
757 			return 0;
758 	}
759 
760 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNCTION) {
761 		if (dev->func != did->function)
762 			return 0;
763 	}
764 
765 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID1) {
766 		if (!dev->prod_id[0])
767 			return 0;
768 		if (strcmp(did->prod_id[0], dev->prod_id[0]))
769 			return 0;
770 	}
771 
772 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID2) {
773 		if (!dev->prod_id[1])
774 			return 0;
775 		if (strcmp(did->prod_id[1], dev->prod_id[1]))
776 			return 0;
777 	}
778 
779 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID3) {
780 		if (!dev->prod_id[2])
781 			return 0;
782 		if (strcmp(did->prod_id[2], dev->prod_id[2]))
783 			return 0;
784 	}
785 
786 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID4) {
787 		if (!dev->prod_id[3])
788 			return 0;
789 		if (strcmp(did->prod_id[3], dev->prod_id[3]))
790 			return 0;
791 	}
792 
793 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) {
794 		if (dev->device_no != did->device_no)
795 			return 0;
796 	}
797 
798 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNC_ID) {
799 		if ((!dev->has_func_id) || (dev->func_id != did->func_id))
800 			return 0;
801 
802 		/* if this is a pseudo-multi-function device,
803 		 * we need explicit matches */
804 		if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO)
805 			return 0;
806 		if (dev->device_no)
807 			return 0;
808 
809 		/* also, FUNC_ID matching needs to be activated by userspace
810 		 * after it has re-checked that there is no possible module
811 		 * with a prod_id/manf_id/card_id match.
812 		 */
813 		if (!dev->allow_func_id_match)
814 			return 0;
815 	}
816 
817 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_FAKE_CIS) {
818 		if (!dev->socket->fake_cis)
819 			pcmcia_load_firmware(dev, did->cisfile);
820 
821 		if (!dev->socket->fake_cis)
822 			return 0;
823 	}
824 
825 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_ANONYMOUS) {
826 		int i;
827 		for (i=0; i<4; i++)
828 			if (dev->prod_id[i])
829 				return 0;
830 		if (dev->has_manf_id || dev->has_card_id || dev->has_func_id)
831 			return 0;
832 	}
833 
834 	dev->dev.driver_data = (void *) did;
835 
836 	return 1;
837 }
838 
839 
840 static int pcmcia_bus_match(struct device * dev, struct device_driver * drv) {
841 	struct pcmcia_device * p_dev = to_pcmcia_dev(dev);
842 	struct pcmcia_driver * p_drv = to_pcmcia_drv(drv);
843 	struct pcmcia_device_id *did = p_drv->id_table;
844 
845 #ifdef CONFIG_PCMCIA_IOCTL
846 	/* matching by cardmgr */
847 	if (p_dev->cardmgr == p_drv)
848 		return 1;
849 #endif
850 
851 	while (did && did->match_flags) {
852 		if (pcmcia_devmatch(p_dev, did))
853 			return 1;
854 		did++;
855 	}
856 
857 	return 0;
858 }
859 
860 #ifdef CONFIG_HOTPLUG
861 
862 static int pcmcia_bus_uevent(struct device *dev, char **envp, int num_envp,
863 			     char *buffer, int buffer_size)
864 {
865 	struct pcmcia_device *p_dev;
866 	int i, length = 0;
867 	u32 hash[4] = { 0, 0, 0, 0};
868 
869 	if (!dev)
870 		return -ENODEV;
871 
872 	p_dev = to_pcmcia_dev(dev);
873 
874 	/* calculate hashes */
875 	for (i=0; i<4; i++) {
876 		if (!p_dev->prod_id[i])
877 			continue;
878 		hash[i] = crc32(0, p_dev->prod_id[i], strlen(p_dev->prod_id[i]));
879 	}
880 
881 	i = 0;
882 
883 	if (add_uevent_var(envp, num_envp, &i,
884 			   buffer, buffer_size, &length,
885 			   "SOCKET_NO=%u",
886 			   p_dev->socket->sock))
887 		return -ENOMEM;
888 
889 	if (add_uevent_var(envp, num_envp, &i,
890 			   buffer, buffer_size, &length,
891 			   "DEVICE_NO=%02X",
892 			   p_dev->device_no))
893 		return -ENOMEM;
894 
895 	if (add_uevent_var(envp, num_envp, &i,
896 			   buffer, buffer_size, &length,
897 			   "MODALIAS=pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
898 			   "pa%08Xpb%08Xpc%08Xpd%08X",
899 			   p_dev->has_manf_id ? p_dev->manf_id : 0,
900 			   p_dev->has_card_id ? p_dev->card_id : 0,
901 			   p_dev->has_func_id ? p_dev->func_id : 0,
902 			   p_dev->func,
903 			   p_dev->device_no,
904 			   hash[0],
905 			   hash[1],
906 			   hash[2],
907 			   hash[3]))
908 		return -ENOMEM;
909 
910 	envp[i] = NULL;
911 
912 	return 0;
913 }
914 
915 #else
916 
917 static int pcmcia_bus_uevent(struct device *dev, char **envp, int num_envp,
918 			      char *buffer, int buffer_size)
919 {
920 	return -ENODEV;
921 }
922 
923 #endif
924 
925 /************************ per-device sysfs output ***************************/
926 
927 #define pcmcia_device_attr(field, test, format)				\
928 static ssize_t field##_show (struct device *dev, struct device_attribute *attr, char *buf)		\
929 {									\
930 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);		\
931 	return p_dev->test ? sprintf (buf, format, p_dev->field) : -ENODEV; \
932 }
933 
934 #define pcmcia_device_stringattr(name, field)					\
935 static ssize_t name##_show (struct device *dev, struct device_attribute *attr, char *buf)		\
936 {									\
937 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);		\
938 	return p_dev->field ? sprintf (buf, "%s\n", p_dev->field) : -ENODEV; \
939 }
940 
941 pcmcia_device_attr(func, socket, "0x%02x\n");
942 pcmcia_device_attr(func_id, has_func_id, "0x%02x\n");
943 pcmcia_device_attr(manf_id, has_manf_id, "0x%04x\n");
944 pcmcia_device_attr(card_id, has_card_id, "0x%04x\n");
945 pcmcia_device_stringattr(prod_id1, prod_id[0]);
946 pcmcia_device_stringattr(prod_id2, prod_id[1]);
947 pcmcia_device_stringattr(prod_id3, prod_id[2]);
948 pcmcia_device_stringattr(prod_id4, prod_id[3]);
949 
950 
951 static ssize_t pcmcia_show_pm_state(struct device *dev, struct device_attribute *attr, char *buf)
952 {
953 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
954 
955 	if (p_dev->suspended)
956 		return sprintf(buf, "off\n");
957 	else
958 		return sprintf(buf, "on\n");
959 }
960 
961 static ssize_t pcmcia_store_pm_state(struct device *dev, struct device_attribute *attr,
962 				     const char *buf, size_t count)
963 {
964 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
965 	int ret = 0;
966 
967         if (!count)
968                 return -EINVAL;
969 
970 	if ((!p_dev->suspended) && !strncmp(buf, "off", 3))
971 		ret = dpm_runtime_suspend(dev, PMSG_SUSPEND);
972 	else if (p_dev->suspended && !strncmp(buf, "on", 2))
973 		dpm_runtime_resume(dev);
974 
975 	return ret ? ret : count;
976 }
977 
978 
979 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
980 {
981 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
982 	int i;
983 	u32 hash[4] = { 0, 0, 0, 0};
984 
985 	/* calculate hashes */
986 	for (i=0; i<4; i++) {
987 		if (!p_dev->prod_id[i])
988 			continue;
989 		hash[i] = crc32(0,p_dev->prod_id[i],strlen(p_dev->prod_id[i]));
990 	}
991 	return sprintf(buf, "pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
992 				"pa%08Xpb%08Xpc%08Xpd%08X\n",
993 				p_dev->has_manf_id ? p_dev->manf_id : 0,
994 				p_dev->has_card_id ? p_dev->card_id : 0,
995 				p_dev->has_func_id ? p_dev->func_id : 0,
996 				p_dev->func, p_dev->device_no,
997 				hash[0], hash[1], hash[2], hash[3]);
998 }
999 
1000 static ssize_t pcmcia_store_allow_func_id_match(struct device *dev,
1001 		struct device_attribute *attr, const char *buf, size_t count)
1002 {
1003 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1004 
1005 	if (!count)
1006 		return -EINVAL;
1007 
1008 	mutex_lock(&p_dev->socket->skt_mutex);
1009 	p_dev->allow_func_id_match = 1;
1010 	mutex_unlock(&p_dev->socket->skt_mutex);
1011 
1012 	bus_rescan_devices(&pcmcia_bus_type);
1013 
1014 	return count;
1015 }
1016 
1017 static struct device_attribute pcmcia_dev_attrs[] = {
1018 	__ATTR(function, 0444, func_show, NULL),
1019 	__ATTR(pm_state, 0644, pcmcia_show_pm_state, pcmcia_store_pm_state),
1020 	__ATTR_RO(func_id),
1021 	__ATTR_RO(manf_id),
1022 	__ATTR_RO(card_id),
1023 	__ATTR_RO(prod_id1),
1024 	__ATTR_RO(prod_id2),
1025 	__ATTR_RO(prod_id3),
1026 	__ATTR_RO(prod_id4),
1027 	__ATTR_RO(modalias),
1028 	__ATTR(allow_func_id_match, 0200, NULL, pcmcia_store_allow_func_id_match),
1029 	__ATTR_NULL,
1030 };
1031 
1032 /* PM support, also needed for reset */
1033 
1034 static int pcmcia_dev_suspend(struct device * dev, pm_message_t state)
1035 {
1036 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1037 	struct pcmcia_driver *p_drv = NULL;
1038 	int ret = 0;
1039 
1040 	if (dev->driver)
1041 		p_drv = to_pcmcia_drv(dev->driver);
1042 
1043 	if (!p_drv)
1044 		goto out;
1045 
1046 	if (p_drv->suspend) {
1047 		ret = p_drv->suspend(p_dev);
1048 		if (ret)
1049 			goto out;
1050 	}
1051 
1052 	if (p_dev->device_no == p_dev->func)
1053 		pcmcia_release_configuration(p_dev);
1054 
1055  out:
1056 	if (!ret)
1057 		p_dev->suspended = 1;
1058 	return ret;
1059 }
1060 
1061 
1062 static int pcmcia_dev_resume(struct device * dev)
1063 {
1064 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1065         struct pcmcia_driver *p_drv = NULL;
1066 	int ret = 0;
1067 
1068 	if (dev->driver)
1069 		p_drv = to_pcmcia_drv(dev->driver);
1070 
1071 	if (!p_drv)
1072 		goto out;
1073 
1074 	if (p_dev->device_no == p_dev->func) {
1075 		ret = pcmcia_request_configuration(p_dev, &p_dev->conf);
1076 		if (ret)
1077 			goto out;
1078 	}
1079 
1080 	if (p_drv->resume)
1081 		ret = p_drv->resume(p_dev);
1082 
1083  out:
1084 	if (!ret)
1085 		p_dev->suspended = 0;
1086 	return ret;
1087 }
1088 
1089 
1090 static int pcmcia_bus_suspend_callback(struct device *dev, void * _data)
1091 {
1092 	struct pcmcia_socket *skt = _data;
1093 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1094 
1095 	if (p_dev->socket != skt)
1096 		return 0;
1097 
1098 	return dpm_runtime_suspend(dev, PMSG_SUSPEND);
1099 }
1100 
1101 static int pcmcia_bus_resume_callback(struct device *dev, void * _data)
1102 {
1103 	struct pcmcia_socket *skt = _data;
1104 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1105 
1106 	if (p_dev->socket != skt)
1107 		return 0;
1108 
1109 	dpm_runtime_resume(dev);
1110 
1111 	return 0;
1112 }
1113 
1114 static int pcmcia_bus_resume(struct pcmcia_socket *skt)
1115 {
1116 	bus_for_each_dev(&pcmcia_bus_type, NULL, skt, pcmcia_bus_resume_callback);
1117 	return 0;
1118 }
1119 
1120 static int pcmcia_bus_suspend(struct pcmcia_socket *skt)
1121 {
1122 	if (bus_for_each_dev(&pcmcia_bus_type, NULL, skt,
1123 			     pcmcia_bus_suspend_callback)) {
1124 		pcmcia_bus_resume(skt);
1125 		return -EIO;
1126 	}
1127 	return 0;
1128 }
1129 
1130 
1131 /*======================================================================
1132 
1133     The card status event handler.
1134 
1135 ======================================================================*/
1136 
1137 /* Normally, the event is passed to individual drivers after
1138  * informing userspace. Only for CS_EVENT_CARD_REMOVAL this
1139  * is inversed to maintain historic compatibility.
1140  */
1141 
1142 static int ds_event(struct pcmcia_socket *skt, event_t event, int priority)
1143 {
1144 	struct pcmcia_socket *s = pcmcia_get_socket(skt);
1145 
1146 	if (!s) {
1147 		printk(KERN_ERR "PCMCIA obtaining reference to socket %p " \
1148 			"failed, event 0x%x lost!\n", skt, event);
1149 		return -ENODEV;
1150 	}
1151 
1152 	ds_dbg(1, "ds_event(0x%06x, %d, 0x%p)\n",
1153 	       event, priority, skt);
1154 
1155 	switch (event) {
1156 	case CS_EVENT_CARD_REMOVAL:
1157 		s->pcmcia_state.present = 0;
1158 		pcmcia_card_remove(skt, NULL);
1159 		handle_event(skt, event);
1160 		break;
1161 
1162 	case CS_EVENT_CARD_INSERTION:
1163 		s->pcmcia_state.present = 1;
1164 		pcmcia_card_add(skt);
1165 		handle_event(skt, event);
1166 		break;
1167 
1168 	case CS_EVENT_EJECTION_REQUEST:
1169 		break;
1170 
1171 	case CS_EVENT_PM_SUSPEND:
1172 	case CS_EVENT_PM_RESUME:
1173 	case CS_EVENT_RESET_PHYSICAL:
1174 	case CS_EVENT_CARD_RESET:
1175 	default:
1176 		handle_event(skt, event);
1177 		break;
1178     }
1179 
1180     pcmcia_put_socket(s);
1181 
1182     return 0;
1183 } /* ds_event */
1184 
1185 
1186 struct pcmcia_device * pcmcia_dev_present(struct pcmcia_device *_p_dev)
1187 {
1188 	struct pcmcia_device *p_dev;
1189 	struct pcmcia_device *ret = NULL;
1190 
1191 	p_dev = pcmcia_get_dev(_p_dev);
1192 	if (!p_dev)
1193 		return NULL;
1194 
1195 	if (!p_dev->socket->pcmcia_state.present)
1196 		goto out;
1197 
1198 	if (p_dev->_removed)
1199 		goto out;
1200 
1201 	if (p_dev->suspended)
1202 		goto out;
1203 
1204 	ret = p_dev;
1205  out:
1206 	pcmcia_put_dev(p_dev);
1207 	return ret;
1208 }
1209 EXPORT_SYMBOL(pcmcia_dev_present);
1210 
1211 
1212 static struct pcmcia_callback pcmcia_bus_callback = {
1213 	.owner = THIS_MODULE,
1214 	.event = ds_event,
1215 	.requery = pcmcia_bus_rescan,
1216 	.suspend = pcmcia_bus_suspend,
1217 	.resume = pcmcia_bus_resume,
1218 };
1219 
1220 static int __devinit pcmcia_bus_add_socket(struct class_device *class_dev,
1221 					   struct class_interface *class_intf)
1222 {
1223 	struct pcmcia_socket *socket = class_get_devdata(class_dev);
1224 	int ret;
1225 
1226 	socket = pcmcia_get_socket(socket);
1227 	if (!socket) {
1228 		printk(KERN_ERR "PCMCIA obtaining reference to socket %p failed\n", socket);
1229 		return -ENODEV;
1230 	}
1231 
1232 	/*
1233 	 * Ugly. But we want to wait for the socket threads to have started up.
1234 	 * We really should let the drivers themselves drive some of this..
1235 	 */
1236 	msleep(250);
1237 
1238 #ifdef CONFIG_PCMCIA_IOCTL
1239 	init_waitqueue_head(&socket->queue);
1240 #endif
1241 	INIT_LIST_HEAD(&socket->devices_list);
1242 	INIT_WORK(&socket->device_add, pcmcia_delayed_add_pseudo_device, socket);
1243 	memset(&socket->pcmcia_state, 0, sizeof(u8));
1244 	socket->device_count = 0;
1245 
1246 	ret = pccard_register_pcmcia(socket, &pcmcia_bus_callback);
1247 	if (ret) {
1248 		printk(KERN_ERR "PCMCIA registration PCCard core failed for socket %p\n", socket);
1249 		pcmcia_put_socket(socket);
1250 		return (ret);
1251 	}
1252 
1253 	return 0;
1254 }
1255 
1256 static void pcmcia_bus_remove_socket(struct class_device *class_dev,
1257 				     struct class_interface *class_intf)
1258 {
1259 	struct pcmcia_socket *socket = class_get_devdata(class_dev);
1260 
1261 	if (!socket)
1262 		return;
1263 
1264 	socket->pcmcia_state.dead = 1;
1265 	pccard_register_pcmcia(socket, NULL);
1266 
1267 	pcmcia_put_socket(socket);
1268 
1269 	return;
1270 }
1271 
1272 
1273 /* the pcmcia_bus_interface is used to handle pcmcia socket devices */
1274 static struct class_interface pcmcia_bus_interface = {
1275 	.class = &pcmcia_socket_class,
1276 	.add = &pcmcia_bus_add_socket,
1277 	.remove = &pcmcia_bus_remove_socket,
1278 };
1279 
1280 
1281 struct bus_type pcmcia_bus_type = {
1282 	.name = "pcmcia",
1283 	.uevent = pcmcia_bus_uevent,
1284 	.match = pcmcia_bus_match,
1285 	.dev_attrs = pcmcia_dev_attrs,
1286 	.probe = pcmcia_device_probe,
1287 	.remove = pcmcia_device_remove,
1288 	.suspend = pcmcia_dev_suspend,
1289 	.resume = pcmcia_dev_resume,
1290 };
1291 
1292 
1293 static int __init init_pcmcia_bus(void)
1294 {
1295 	spin_lock_init(&pcmcia_dev_list_lock);
1296 
1297 	bus_register(&pcmcia_bus_type);
1298 	class_interface_register(&pcmcia_bus_interface);
1299 
1300 	pcmcia_setup_ioctl();
1301 
1302 	return 0;
1303 }
1304 fs_initcall(init_pcmcia_bus); /* one level after subsys_initcall so that
1305 			       * pcmcia_socket_class is already registered */
1306 
1307 
1308 static void __exit exit_pcmcia_bus(void)
1309 {
1310 	pcmcia_cleanup_ioctl();
1311 
1312 	class_interface_unregister(&pcmcia_bus_interface);
1313 
1314 	bus_unregister(&pcmcia_bus_type);
1315 }
1316 module_exit(exit_pcmcia_bus);
1317 
1318 
1319 MODULE_ALIAS("ds");
1320