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