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