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