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