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