xref: /linux/drivers/pcmcia/ds.c (revision ccea15f45eb0ab12d658f88b5d4be005cb2bb1a7)
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/cis/
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/cis/ 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 static int pcmcia_device_probe(struct device *dev);
302 static int pcmcia_device_remove(struct device * dev);
303 
304 int pcmcia_register_driver(struct pcmcia_driver *driver)
305 {
306 	if (!driver)
307 		return -EINVAL;
308 
309 	pcmcia_check_driver(driver);
310 
311 	/* initialize common fields */
312 	driver->drv.bus = &pcmcia_bus_type;
313 	driver->drv.owner = driver->owner;
314 
315 	return driver_register(&driver->drv);
316 }
317 EXPORT_SYMBOL(pcmcia_register_driver);
318 
319 /**
320  * pcmcia_unregister_driver - unregister a PCMCIA driver with the bus core
321  */
322 void pcmcia_unregister_driver(struct pcmcia_driver *driver)
323 {
324 	driver_unregister(&driver->drv);
325 }
326 EXPORT_SYMBOL(pcmcia_unregister_driver);
327 
328 
329 /* pcmcia_device handling */
330 
331 struct pcmcia_device * pcmcia_get_dev(struct pcmcia_device *p_dev)
332 {
333 	struct device *tmp_dev;
334 	tmp_dev = get_device(&p_dev->dev);
335 	if (!tmp_dev)
336 		return NULL;
337 	return to_pcmcia_dev(tmp_dev);
338 }
339 
340 void pcmcia_put_dev(struct pcmcia_device *p_dev)
341 {
342 	if (p_dev)
343 		put_device(&p_dev->dev);
344 }
345 
346 static void pcmcia_release_function(struct kref *ref)
347 {
348 	struct config_t *c = container_of(ref, struct config_t, ref);
349 	kfree(c);
350 }
351 
352 static void pcmcia_release_dev(struct device *dev)
353 {
354 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
355 	ds_dbg(1, "releasing dev %p\n", p_dev);
356 	pcmcia_put_socket(p_dev->socket);
357 	kfree(p_dev->devname);
358 	kref_put(&p_dev->function_config->ref, pcmcia_release_function);
359 	kfree(p_dev);
360 }
361 
362 static void pcmcia_add_pseudo_device(struct pcmcia_socket *s)
363 {
364 	if (!s->pcmcia_state.device_add_pending) {
365 		s->pcmcia_state.device_add_pending = 1;
366 		schedule_work(&s->device_add);
367 	}
368 	return;
369 }
370 
371 static int pcmcia_device_probe(struct device * dev)
372 {
373 	struct pcmcia_device *p_dev;
374 	struct pcmcia_driver *p_drv;
375 	struct pcmcia_device_id *did;
376 	struct pcmcia_socket *s;
377 	int ret = 0;
378 
379 	dev = get_device(dev);
380 	if (!dev)
381 		return -ENODEV;
382 
383 	p_dev = to_pcmcia_dev(dev);
384 	p_drv = to_pcmcia_drv(dev->driver);
385 	s = p_dev->socket;
386 
387 	if ((!p_drv->probe) || (!p_dev->function_config) ||
388 	    (!try_module_get(p_drv->owner))) {
389 		ret = -EINVAL;
390 		goto put_dev;
391 	}
392 
393 	ret = p_drv->probe(p_dev);
394 	if (ret)
395 		goto put_module;
396 
397 	/* handle pseudo multifunction devices:
398 	 * there are at most two pseudo multifunction devices.
399 	 * if we're matching against the first, schedule a
400 	 * call which will then check whether there are two
401 	 * pseudo devices, and if not, add the second one.
402 	 */
403 	did = (struct pcmcia_device_id *) p_dev->dev.driver_data;
404 	if (did && (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) &&
405 	    (p_dev->socket->device_count == 1) && (p_dev->device_no == 0))
406 		pcmcia_add_pseudo_device(p_dev->socket);
407 
408  put_module:
409 	if (ret)
410 		module_put(p_drv->owner);
411  put_dev:
412 	if (ret)
413 		put_device(dev);
414 	return (ret);
415 }
416 
417 
418 /*
419  * Removes a PCMCIA card from the device tree and socket list.
420  */
421 static void pcmcia_card_remove(struct pcmcia_socket *s, struct pcmcia_device *leftover)
422 {
423 	struct pcmcia_device	*p_dev;
424 	struct pcmcia_device	*tmp;
425 	unsigned long		flags;
426 
427 	ds_dbg(2, "unbind_request(%d)\n", s->sock);
428 
429 
430 	if (!leftover)
431 		s->device_count = 0;
432 	else
433 		s->device_count = 1;
434 
435 	/* unregister all pcmcia_devices registered with this socket, except leftover */
436 	list_for_each_entry_safe(p_dev, tmp, &s->devices_list, socket_device_list) {
437 		if (p_dev == leftover)
438 			continue;
439 
440 		spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
441 		list_del(&p_dev->socket_device_list);
442 		p_dev->_removed=1;
443 		spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
444 
445 		device_unregister(&p_dev->dev);
446 	}
447 
448 	return;
449 }
450 
451 
452 static int pcmcia_device_remove(struct device * dev)
453 {
454 	struct pcmcia_device *p_dev;
455 	struct pcmcia_driver *p_drv;
456 	struct pcmcia_device_id *did;
457 	int i;
458 
459 	p_dev = to_pcmcia_dev(dev);
460 	p_drv = to_pcmcia_drv(dev->driver);
461 
462 	/* If we're removing the primary module driving a
463 	 * pseudo multi-function card, we need to unbind
464 	 * all devices
465 	 */
466 	did = (struct pcmcia_device_id *) p_dev->dev.driver_data;
467 	if (did && (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) &&
468 	    (p_dev->socket->device_count != 0) &&
469 	    (p_dev->device_no == 0))
470 		pcmcia_card_remove(p_dev->socket, p_dev);
471 
472 	/* detach the "instance" */
473 	if (!p_drv)
474 		return 0;
475 
476 	if (p_drv->remove)
477 	       	p_drv->remove(p_dev);
478 
479 	/* check for proper unloading */
480 	if (p_dev->_irq || p_dev->_io || p_dev->_locked)
481 		printk(KERN_INFO "pcmcia: driver %s did not release config properly\n",
482 		       p_drv->drv.name);
483 
484 	for (i = 0; i < MAX_WIN; i++)
485 		if (p_dev->_win & CLIENT_WIN_REQ(i))
486 			printk(KERN_INFO "pcmcia: driver %s did not release windows properly\n",
487 			       p_drv->drv.name);
488 
489 	/* references from pcmcia_probe_device */
490 	pcmcia_put_dev(p_dev);
491 	module_put(p_drv->owner);
492 
493 	return 0;
494 }
495 
496 
497 /*
498  * pcmcia_device_query -- determine information about a pcmcia device
499  */
500 static int pcmcia_device_query(struct pcmcia_device *p_dev)
501 {
502 	cistpl_manfid_t manf_id;
503 	cistpl_funcid_t func_id;
504 	cistpl_vers_1_t	*vers1;
505 	unsigned int i;
506 
507 	vers1 = kmalloc(sizeof(*vers1), GFP_KERNEL);
508 	if (!vers1)
509 		return -ENOMEM;
510 
511 	if (!pccard_read_tuple(p_dev->socket, p_dev->func,
512 			       CISTPL_MANFID, &manf_id)) {
513 		p_dev->manf_id = manf_id.manf;
514 		p_dev->card_id = manf_id.card;
515 		p_dev->has_manf_id = 1;
516 		p_dev->has_card_id = 1;
517 	}
518 
519 	if (!pccard_read_tuple(p_dev->socket, p_dev->func,
520 			       CISTPL_FUNCID, &func_id)) {
521 		p_dev->func_id = func_id.func;
522 		p_dev->has_func_id = 1;
523 	} else {
524 		/* rule of thumb: cards with no FUNCID, but with
525 		 * common memory device geometry information, are
526 		 * probably memory cards (from pcmcia-cs) */
527 		cistpl_device_geo_t *devgeo;
528 
529 		devgeo = kmalloc(sizeof(*devgeo), GFP_KERNEL);
530 		if (!devgeo) {
531 			kfree(vers1);
532 			return -ENOMEM;
533 		}
534 		if (!pccard_read_tuple(p_dev->socket, p_dev->func,
535 				      CISTPL_DEVICE_GEO, devgeo)) {
536 			ds_dbg(0, "mem device geometry probably means "
537 			       "FUNCID_MEMORY\n");
538 			p_dev->func_id = CISTPL_FUNCID_MEMORY;
539 			p_dev->has_func_id = 1;
540 		}
541 		kfree(devgeo);
542 	}
543 
544 	if (!pccard_read_tuple(p_dev->socket, p_dev->func, CISTPL_VERS_1,
545 			       vers1)) {
546 		for (i=0; i < vers1->ns; i++) {
547 			char *tmp;
548 			unsigned int length;
549 
550 			tmp = vers1->str + vers1->ofs[i];
551 
552 			length = strlen(tmp) + 1;
553 			if ((length < 2) || (length > 255))
554 				continue;
555 
556 			p_dev->prod_id[i] = kmalloc(sizeof(char) * length,
557 						    GFP_KERNEL);
558 			if (!p_dev->prod_id[i])
559 				continue;
560 
561 			p_dev->prod_id[i] = strncpy(p_dev->prod_id[i],
562 						    tmp, length);
563 		}
564 	}
565 
566 	kfree(vers1);
567 	return 0;
568 }
569 
570 
571 /* device_add_lock is needed to avoid double registration by cardmgr and kernel.
572  * Serializes pcmcia_device_add; will most likely be removed in future.
573  *
574  * While it has the caveat that adding new PCMCIA devices inside(!) device_register()
575  * won't work, this doesn't matter much at the moment: the driver core doesn't
576  * support it either.
577  */
578 static DEFINE_MUTEX(device_add_lock);
579 
580 struct pcmcia_device * pcmcia_device_add(struct pcmcia_socket *s, unsigned int function)
581 {
582 	struct pcmcia_device *p_dev, *tmp_dev;
583 	unsigned long flags;
584 	int bus_id_len;
585 
586 	s = pcmcia_get_socket(s);
587 	if (!s)
588 		return NULL;
589 
590 	mutex_lock(&device_add_lock);
591 
592 	/* max of 2 devices per card */
593 	if (s->device_count == 2)
594 		goto err_put;
595 
596 	p_dev = kzalloc(sizeof(struct pcmcia_device), GFP_KERNEL);
597 	if (!p_dev)
598 		goto err_put;
599 
600 	p_dev->socket = s;
601 	p_dev->device_no = (s->device_count++);
602 	p_dev->func   = function;
603 	if (s->functions <= function)
604 		s->functions = function + 1;
605 
606 	p_dev->dev.bus = &pcmcia_bus_type;
607 	p_dev->dev.parent = s->dev.dev;
608 	p_dev->dev.release = pcmcia_release_dev;
609 	bus_id_len = sprintf (p_dev->dev.bus_id, "%d.%d", p_dev->socket->sock, p_dev->device_no);
610 
611 	p_dev->devname = kmalloc(6 + bus_id_len + 1, GFP_KERNEL);
612 	if (!p_dev->devname)
613 		goto err_free;
614 	sprintf (p_dev->devname, "pcmcia%s", p_dev->dev.bus_id);
615 
616 	/* compat */
617 	spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
618 
619 	/*
620 	 * p_dev->function_config must be the same for all card functions.
621 	 * Note that this is serialized by the device_add_lock, so that
622 	 * only one such struct will be created.
623 	 */
624         list_for_each_entry(tmp_dev, &s->devices_list, socket_device_list)
625                 if (p_dev->func == tmp_dev->func) {
626 			p_dev->function_config = tmp_dev->function_config;
627 			kref_get(&p_dev->function_config->ref);
628 		}
629 
630 	/* Add to the list in pcmcia_bus_socket */
631 	list_add_tail(&p_dev->socket_device_list, &s->devices_list);
632 
633 	spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
634 
635 	if (!p_dev->function_config) {
636 		p_dev->function_config = kzalloc(sizeof(struct config_t),
637 						 GFP_KERNEL);
638 		if (!p_dev->function_config)
639 			goto err_unreg;
640 		kref_init(&p_dev->function_config->ref);
641 	}
642 
643 	printk(KERN_NOTICE "pcmcia: registering new device %s\n",
644 	       p_dev->devname);
645 
646 	pcmcia_device_query(p_dev);
647 
648 	if (device_register(&p_dev->dev))
649 		goto err_unreg;
650 
651 	mutex_unlock(&device_add_lock);
652 
653 	return p_dev;
654 
655  err_unreg:
656 	spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
657 	list_del(&p_dev->socket_device_list);
658 	spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
659 
660  err_free:
661 	kfree(p_dev->devname);
662 	kfree(p_dev);
663 	s->device_count--;
664  err_put:
665 	mutex_unlock(&device_add_lock);
666 	pcmcia_put_socket(s);
667 
668 	return NULL;
669 }
670 
671 
672 static int pcmcia_card_add(struct pcmcia_socket *s)
673 {
674 	cisinfo_t cisinfo;
675 	cistpl_longlink_mfc_t mfc;
676 	unsigned int no_funcs, i;
677 	int ret = 0;
678 
679 	if (!(s->resource_setup_done))
680 		return -EAGAIN; /* try again, but later... */
681 
682 	if (pcmcia_validate_mem(s))
683 		return -EAGAIN; /* try again, but later... */
684 
685 	ret = pccard_validate_cis(s, BIND_FN_ALL, &cisinfo);
686 	if (ret || !cisinfo.Chains) {
687 		ds_dbg(0, "invalid CIS or invalid resources\n");
688 		return -ENODEV;
689 	}
690 
691 	if (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_LONGLINK_MFC, &mfc))
692 		no_funcs = mfc.nfn;
693 	else
694 		no_funcs = 1;
695 
696 	for (i=0; i < no_funcs; i++)
697 		pcmcia_device_add(s, i);
698 
699 	return (ret);
700 }
701 
702 
703 static void pcmcia_delayed_add_pseudo_device(void *data)
704 {
705 	struct pcmcia_socket *s = data;
706 	pcmcia_device_add(s, 0);
707 	s->pcmcia_state.device_add_pending = 0;
708 }
709 
710 static int pcmcia_requery(struct device *dev, void * _data)
711 {
712 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
713 	if (!p_dev->dev.driver)
714 		pcmcia_device_query(p_dev);
715 
716 	return 0;
717 }
718 
719 static void pcmcia_bus_rescan(struct pcmcia_socket *skt)
720 {
721 	int no_devices=0;
722 	unsigned long flags;
723 
724 	/* must be called with skt_mutex held */
725 	spin_lock_irqsave(&pcmcia_dev_list_lock, flags);
726 	if (list_empty(&skt->devices_list))
727 		no_devices=1;
728 	spin_unlock_irqrestore(&pcmcia_dev_list_lock, flags);
729 
730 	/* if no devices were added for this socket yet because of
731 	 * missing resource information or other trouble, we need to
732 	 * do this now. */
733 	if (no_devices) {
734 		int ret = pcmcia_card_add(skt);
735 		if (ret)
736 			return;
737 	}
738 
739 	/* some device information might have changed because of a CIS
740 	 * update or because we can finally read it correctly... so
741 	 * determine it again, overwriting old values if necessary. */
742 	bus_for_each_dev(&pcmcia_bus_type, NULL, NULL, pcmcia_requery);
743 
744 	/* we re-scan all devices, not just the ones connected to this
745 	 * socket. This does not matter, though. */
746 	bus_rescan_devices(&pcmcia_bus_type);
747 }
748 
749 static inline int pcmcia_devmatch(struct pcmcia_device *dev,
750 				  struct pcmcia_device_id *did)
751 {
752 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_MANF_ID) {
753 		if ((!dev->has_manf_id) || (dev->manf_id != did->manf_id))
754 			return 0;
755 	}
756 
757 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_CARD_ID) {
758 		if ((!dev->has_card_id) || (dev->card_id != did->card_id))
759 			return 0;
760 	}
761 
762 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNCTION) {
763 		if (dev->func != did->function)
764 			return 0;
765 	}
766 
767 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID1) {
768 		if (!dev->prod_id[0])
769 			return 0;
770 		if (strcmp(did->prod_id[0], dev->prod_id[0]))
771 			return 0;
772 	}
773 
774 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID2) {
775 		if (!dev->prod_id[1])
776 			return 0;
777 		if (strcmp(did->prod_id[1], dev->prod_id[1]))
778 			return 0;
779 	}
780 
781 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID3) {
782 		if (!dev->prod_id[2])
783 			return 0;
784 		if (strcmp(did->prod_id[2], dev->prod_id[2]))
785 			return 0;
786 	}
787 
788 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_PROD_ID4) {
789 		if (!dev->prod_id[3])
790 			return 0;
791 		if (strcmp(did->prod_id[3], dev->prod_id[3]))
792 			return 0;
793 	}
794 
795 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO) {
796 		if (dev->device_no != did->device_no)
797 			return 0;
798 	}
799 
800 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_FUNC_ID) {
801 		if ((!dev->has_func_id) || (dev->func_id != did->func_id))
802 			return 0;
803 
804 		/* if this is a pseudo-multi-function device,
805 		 * we need explicit matches */
806 		if (did->match_flags & PCMCIA_DEV_ID_MATCH_DEVICE_NO)
807 			return 0;
808 		if (dev->device_no)
809 			return 0;
810 
811 		/* also, FUNC_ID matching needs to be activated by userspace
812 		 * after it has re-checked that there is no possible module
813 		 * with a prod_id/manf_id/card_id match.
814 		 */
815 		if (!dev->allow_func_id_match)
816 			return 0;
817 	}
818 
819 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_FAKE_CIS) {
820 		if (!dev->socket->fake_cis)
821 			pcmcia_load_firmware(dev, did->cisfile);
822 
823 		if (!dev->socket->fake_cis)
824 			return 0;
825 	}
826 
827 	if (did->match_flags & PCMCIA_DEV_ID_MATCH_ANONYMOUS) {
828 		int i;
829 		for (i=0; i<4; i++)
830 			if (dev->prod_id[i])
831 				return 0;
832 		if (dev->has_manf_id || dev->has_card_id || dev->has_func_id)
833 			return 0;
834 	}
835 
836 	dev->dev.driver_data = (void *) did;
837 
838 	return 1;
839 }
840 
841 
842 static int pcmcia_bus_match(struct device * dev, struct device_driver * drv) {
843 	struct pcmcia_device * p_dev = to_pcmcia_dev(dev);
844 	struct pcmcia_driver * p_drv = to_pcmcia_drv(drv);
845 	struct pcmcia_device_id *did = p_drv->id_table;
846 
847 #ifdef CONFIG_PCMCIA_IOCTL
848 	/* matching by cardmgr */
849 	if (p_dev->cardmgr == p_drv)
850 		return 1;
851 #endif
852 
853 	while (did && did->match_flags) {
854 		if (pcmcia_devmatch(p_dev, did))
855 			return 1;
856 		did++;
857 	}
858 
859 	return 0;
860 }
861 
862 #ifdef CONFIG_HOTPLUG
863 
864 static int pcmcia_bus_uevent(struct device *dev, char **envp, int num_envp,
865 			     char *buffer, int buffer_size)
866 {
867 	struct pcmcia_device *p_dev;
868 	int i, length = 0;
869 	u32 hash[4] = { 0, 0, 0, 0};
870 
871 	if (!dev)
872 		return -ENODEV;
873 
874 	p_dev = to_pcmcia_dev(dev);
875 
876 	/* calculate hashes */
877 	for (i=0; i<4; i++) {
878 		if (!p_dev->prod_id[i])
879 			continue;
880 		hash[i] = crc32(0, p_dev->prod_id[i], strlen(p_dev->prod_id[i]));
881 	}
882 
883 	i = 0;
884 
885 	if (add_uevent_var(envp, num_envp, &i,
886 			   buffer, buffer_size, &length,
887 			   "SOCKET_NO=%u",
888 			   p_dev->socket->sock))
889 		return -ENOMEM;
890 
891 	if (add_uevent_var(envp, num_envp, &i,
892 			   buffer, buffer_size, &length,
893 			   "DEVICE_NO=%02X",
894 			   p_dev->device_no))
895 		return -ENOMEM;
896 
897 	if (add_uevent_var(envp, num_envp, &i,
898 			   buffer, buffer_size, &length,
899 			   "MODALIAS=pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
900 			   "pa%08Xpb%08Xpc%08Xpd%08X",
901 			   p_dev->has_manf_id ? p_dev->manf_id : 0,
902 			   p_dev->has_card_id ? p_dev->card_id : 0,
903 			   p_dev->has_func_id ? p_dev->func_id : 0,
904 			   p_dev->func,
905 			   p_dev->device_no,
906 			   hash[0],
907 			   hash[1],
908 			   hash[2],
909 			   hash[3]))
910 		return -ENOMEM;
911 
912 	envp[i] = NULL;
913 
914 	return 0;
915 }
916 
917 #else
918 
919 static int pcmcia_bus_uevent(struct device *dev, char **envp, int num_envp,
920 			      char *buffer, int buffer_size)
921 {
922 	return -ENODEV;
923 }
924 
925 #endif
926 
927 /************************ per-device sysfs output ***************************/
928 
929 #define pcmcia_device_attr(field, test, format)				\
930 static ssize_t field##_show (struct device *dev, struct device_attribute *attr, char *buf)		\
931 {									\
932 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);		\
933 	return p_dev->test ? sprintf (buf, format, p_dev->field) : -ENODEV; \
934 }
935 
936 #define pcmcia_device_stringattr(name, field)					\
937 static ssize_t name##_show (struct device *dev, struct device_attribute *attr, char *buf)		\
938 {									\
939 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);		\
940 	return p_dev->field ? sprintf (buf, "%s\n", p_dev->field) : -ENODEV; \
941 }
942 
943 pcmcia_device_attr(func, socket, "0x%02x\n");
944 pcmcia_device_attr(func_id, has_func_id, "0x%02x\n");
945 pcmcia_device_attr(manf_id, has_manf_id, "0x%04x\n");
946 pcmcia_device_attr(card_id, has_card_id, "0x%04x\n");
947 pcmcia_device_stringattr(prod_id1, prod_id[0]);
948 pcmcia_device_stringattr(prod_id2, prod_id[1]);
949 pcmcia_device_stringattr(prod_id3, prod_id[2]);
950 pcmcia_device_stringattr(prod_id4, prod_id[3]);
951 
952 
953 static ssize_t pcmcia_show_pm_state(struct device *dev, struct device_attribute *attr, char *buf)
954 {
955 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
956 
957 	if (p_dev->suspended)
958 		return sprintf(buf, "off\n");
959 	else
960 		return sprintf(buf, "on\n");
961 }
962 
963 static ssize_t pcmcia_store_pm_state(struct device *dev, struct device_attribute *attr,
964 				     const char *buf, size_t count)
965 {
966 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
967 	int ret = 0;
968 
969         if (!count)
970                 return -EINVAL;
971 
972 	if ((!p_dev->suspended) && !strncmp(buf, "off", 3))
973 		ret = dpm_runtime_suspend(dev, PMSG_SUSPEND);
974 	else if (p_dev->suspended && !strncmp(buf, "on", 2))
975 		dpm_runtime_resume(dev);
976 
977 	return ret ? ret : count;
978 }
979 
980 
981 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr, char *buf)
982 {
983 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
984 	int i;
985 	u32 hash[4] = { 0, 0, 0, 0};
986 
987 	/* calculate hashes */
988 	for (i=0; i<4; i++) {
989 		if (!p_dev->prod_id[i])
990 			continue;
991 		hash[i] = crc32(0,p_dev->prod_id[i],strlen(p_dev->prod_id[i]));
992 	}
993 	return sprintf(buf, "pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
994 				"pa%08Xpb%08Xpc%08Xpd%08X\n",
995 				p_dev->has_manf_id ? p_dev->manf_id : 0,
996 				p_dev->has_card_id ? p_dev->card_id : 0,
997 				p_dev->has_func_id ? p_dev->func_id : 0,
998 				p_dev->func, p_dev->device_no,
999 				hash[0], hash[1], hash[2], hash[3]);
1000 }
1001 
1002 static ssize_t pcmcia_store_allow_func_id_match(struct device *dev,
1003 		struct device_attribute *attr, const char *buf, size_t count)
1004 {
1005 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1006 
1007 	if (!count)
1008 		return -EINVAL;
1009 
1010 	mutex_lock(&p_dev->socket->skt_mutex);
1011 	p_dev->allow_func_id_match = 1;
1012 	mutex_unlock(&p_dev->socket->skt_mutex);
1013 
1014 	bus_rescan_devices(&pcmcia_bus_type);
1015 
1016 	return count;
1017 }
1018 
1019 static struct device_attribute pcmcia_dev_attrs[] = {
1020 	__ATTR(function, 0444, func_show, NULL),
1021 	__ATTR(pm_state, 0644, pcmcia_show_pm_state, pcmcia_store_pm_state),
1022 	__ATTR_RO(func_id),
1023 	__ATTR_RO(manf_id),
1024 	__ATTR_RO(card_id),
1025 	__ATTR_RO(prod_id1),
1026 	__ATTR_RO(prod_id2),
1027 	__ATTR_RO(prod_id3),
1028 	__ATTR_RO(prod_id4),
1029 	__ATTR_RO(modalias),
1030 	__ATTR(allow_func_id_match, 0200, NULL, pcmcia_store_allow_func_id_match),
1031 	__ATTR_NULL,
1032 };
1033 
1034 /* PM support, also needed for reset */
1035 
1036 static int pcmcia_dev_suspend(struct device * dev, pm_message_t state)
1037 {
1038 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1039 	struct pcmcia_driver *p_drv = NULL;
1040 	int ret = 0;
1041 
1042 	if (dev->driver)
1043 		p_drv = to_pcmcia_drv(dev->driver);
1044 
1045 	if (!p_drv)
1046 		goto out;
1047 
1048 	if (p_drv->suspend) {
1049 		ret = p_drv->suspend(p_dev);
1050 		if (ret)
1051 			goto out;
1052 	}
1053 
1054 	if (p_dev->device_no == p_dev->func)
1055 		pcmcia_release_configuration(p_dev);
1056 
1057  out:
1058 	if (!ret)
1059 		p_dev->suspended = 1;
1060 	return ret;
1061 }
1062 
1063 
1064 static int pcmcia_dev_resume(struct device * dev)
1065 {
1066 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1067         struct pcmcia_driver *p_drv = NULL;
1068 	int ret = 0;
1069 
1070 	if (dev->driver)
1071 		p_drv = to_pcmcia_drv(dev->driver);
1072 
1073 	if (!p_drv)
1074 		goto out;
1075 
1076 	if (p_dev->device_no == p_dev->func) {
1077 		ret = pcmcia_request_configuration(p_dev, &p_dev->conf);
1078 		if (ret)
1079 			goto out;
1080 	}
1081 
1082 	if (p_drv->resume)
1083 		ret = p_drv->resume(p_dev);
1084 
1085  out:
1086 	if (!ret)
1087 		p_dev->suspended = 0;
1088 	return ret;
1089 }
1090 
1091 
1092 static int pcmcia_bus_suspend_callback(struct device *dev, void * _data)
1093 {
1094 	struct pcmcia_socket *skt = _data;
1095 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1096 
1097 	if (p_dev->socket != skt)
1098 		return 0;
1099 
1100 	return dpm_runtime_suspend(dev, PMSG_SUSPEND);
1101 }
1102 
1103 static int pcmcia_bus_resume_callback(struct device *dev, void * _data)
1104 {
1105 	struct pcmcia_socket *skt = _data;
1106 	struct pcmcia_device *p_dev = to_pcmcia_dev(dev);
1107 
1108 	if (p_dev->socket != skt)
1109 		return 0;
1110 
1111 	dpm_runtime_resume(dev);
1112 
1113 	return 0;
1114 }
1115 
1116 static int pcmcia_bus_resume(struct pcmcia_socket *skt)
1117 {
1118 	bus_for_each_dev(&pcmcia_bus_type, NULL, skt, pcmcia_bus_resume_callback);
1119 	return 0;
1120 }
1121 
1122 static int pcmcia_bus_suspend(struct pcmcia_socket *skt)
1123 {
1124 	if (bus_for_each_dev(&pcmcia_bus_type, NULL, skt,
1125 			     pcmcia_bus_suspend_callback)) {
1126 		pcmcia_bus_resume(skt);
1127 		return -EIO;
1128 	}
1129 	return 0;
1130 }
1131 
1132 
1133 /*======================================================================
1134 
1135     The card status event handler.
1136 
1137 ======================================================================*/
1138 
1139 /* Normally, the event is passed to individual drivers after
1140  * informing userspace. Only for CS_EVENT_CARD_REMOVAL this
1141  * is inversed to maintain historic compatibility.
1142  */
1143 
1144 static int ds_event(struct pcmcia_socket *skt, event_t event, int priority)
1145 {
1146 	struct pcmcia_socket *s = pcmcia_get_socket(skt);
1147 
1148 	ds_dbg(1, "ds_event(0x%06x, %d, 0x%p)\n",
1149 	       event, priority, skt);
1150 
1151 	switch (event) {
1152 	case CS_EVENT_CARD_REMOVAL:
1153 		s->pcmcia_state.present = 0;
1154 		pcmcia_card_remove(skt, NULL);
1155 		handle_event(skt, event);
1156 		break;
1157 
1158 	case CS_EVENT_CARD_INSERTION:
1159 		s->pcmcia_state.present = 1;
1160 		pcmcia_card_add(skt);
1161 		handle_event(skt, event);
1162 		break;
1163 
1164 	case CS_EVENT_EJECTION_REQUEST:
1165 		break;
1166 
1167 	case CS_EVENT_PM_SUSPEND:
1168 	case CS_EVENT_PM_RESUME:
1169 	case CS_EVENT_RESET_PHYSICAL:
1170 	case CS_EVENT_CARD_RESET:
1171 	default:
1172 		handle_event(skt, event);
1173 		break;
1174     }
1175 
1176     pcmcia_put_socket(s);
1177 
1178     return 0;
1179 } /* ds_event */
1180 
1181 
1182 struct pcmcia_device * pcmcia_dev_present(struct pcmcia_device *_p_dev)
1183 {
1184 	struct pcmcia_device *p_dev;
1185 	struct pcmcia_device *ret = NULL;
1186 
1187 	p_dev = pcmcia_get_dev(_p_dev);
1188 	if (!p_dev)
1189 		return NULL;
1190 
1191 	if (!p_dev->socket->pcmcia_state.present)
1192 		goto out;
1193 
1194 	if (p_dev->_removed)
1195 		goto out;
1196 
1197 	if (p_dev->suspended)
1198 		goto out;
1199 
1200 	ret = p_dev;
1201  out:
1202 	pcmcia_put_dev(p_dev);
1203 	return ret;
1204 }
1205 EXPORT_SYMBOL(pcmcia_dev_present);
1206 
1207 
1208 static struct pcmcia_callback pcmcia_bus_callback = {
1209 	.owner = THIS_MODULE,
1210 	.event = ds_event,
1211 	.requery = pcmcia_bus_rescan,
1212 	.suspend = pcmcia_bus_suspend,
1213 	.resume = pcmcia_bus_resume,
1214 };
1215 
1216 static int __devinit pcmcia_bus_add_socket(struct class_device *class_dev,
1217 					   struct class_interface *class_intf)
1218 {
1219 	struct pcmcia_socket *socket = class_get_devdata(class_dev);
1220 	int ret;
1221 
1222 	socket = pcmcia_get_socket(socket);
1223 	if (!socket) {
1224 		printk(KERN_ERR "PCMCIA obtaining reference to socket %p failed\n", socket);
1225 		return -ENODEV;
1226 	}
1227 
1228 	/*
1229 	 * Ugly. But we want to wait for the socket threads to have started up.
1230 	 * We really should let the drivers themselves drive some of this..
1231 	 */
1232 	msleep(250);
1233 
1234 #ifdef CONFIG_PCMCIA_IOCTL
1235 	init_waitqueue_head(&socket->queue);
1236 #endif
1237 	INIT_LIST_HEAD(&socket->devices_list);
1238 	INIT_WORK(&socket->device_add, pcmcia_delayed_add_pseudo_device, socket);
1239 	memset(&socket->pcmcia_state, 0, sizeof(u8));
1240 	socket->device_count = 0;
1241 
1242 	ret = pccard_register_pcmcia(socket, &pcmcia_bus_callback);
1243 	if (ret) {
1244 		printk(KERN_ERR "PCMCIA registration PCCard core failed for socket %p\n", socket);
1245 		pcmcia_put_socket(socket);
1246 		return (ret);
1247 	}
1248 
1249 	return 0;
1250 }
1251 
1252 static void pcmcia_bus_remove_socket(struct class_device *class_dev,
1253 				     struct class_interface *class_intf)
1254 {
1255 	struct pcmcia_socket *socket = class_get_devdata(class_dev);
1256 
1257 	if (!socket)
1258 		return;
1259 
1260 	socket->pcmcia_state.dead = 1;
1261 	pccard_register_pcmcia(socket, NULL);
1262 
1263 	pcmcia_put_socket(socket);
1264 
1265 	return;
1266 }
1267 
1268 
1269 /* the pcmcia_bus_interface is used to handle pcmcia socket devices */
1270 static struct class_interface pcmcia_bus_interface = {
1271 	.class = &pcmcia_socket_class,
1272 	.add = &pcmcia_bus_add_socket,
1273 	.remove = &pcmcia_bus_remove_socket,
1274 };
1275 
1276 
1277 struct bus_type pcmcia_bus_type = {
1278 	.name = "pcmcia",
1279 	.uevent = pcmcia_bus_uevent,
1280 	.match = pcmcia_bus_match,
1281 	.dev_attrs = pcmcia_dev_attrs,
1282 	.probe = pcmcia_device_probe,
1283 	.remove = pcmcia_device_remove,
1284 	.suspend = pcmcia_dev_suspend,
1285 	.resume = pcmcia_dev_resume,
1286 };
1287 
1288 
1289 static int __init init_pcmcia_bus(void)
1290 {
1291 	spin_lock_init(&pcmcia_dev_list_lock);
1292 
1293 	bus_register(&pcmcia_bus_type);
1294 	class_interface_register(&pcmcia_bus_interface);
1295 
1296 	pcmcia_setup_ioctl();
1297 
1298 	return 0;
1299 }
1300 fs_initcall(init_pcmcia_bus); /* one level after subsys_initcall so that
1301 			       * pcmcia_socket_class is already registered */
1302 
1303 
1304 static void __exit exit_pcmcia_bus(void)
1305 {
1306 	pcmcia_cleanup_ioctl();
1307 
1308 	class_interface_unregister(&pcmcia_bus_interface);
1309 
1310 	bus_unregister(&pcmcia_bus_type);
1311 }
1312 module_exit(exit_pcmcia_bus);
1313 
1314 
1315 MODULE_ALIAS("ds");
1316