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