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