2 * ds.c -- 16-bit PCMCIA core support
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.
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.
12 * (C) 1999 David A. Hinds
13 * (C) 2003 - 2006 Dominik Brodowski
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>
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>
34 #include "cs_internal.h"
35 #include "ds_internal.h"
37 /*====================================================================*/
39 /* Module parameters */
41 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
42 MODULE_DESCRIPTION("PCMCIA Driver Services");
43 MODULE_LICENSE("GPL");
48 module_param_named(pc_debug
, ds_pc_debug
, int, 0644);
50 #define ds_dbg(lvl, fmt, arg...) do { \
51 if (ds_pc_debug > (lvl)) \
52 printk(KERN_DEBUG "ds: " fmt , ## arg); \
55 #define ds_dbg(lvl, fmt, arg...) do { } while (0)
58 spinlock_t pcmcia_dev_list_lock
;
60 /*====================================================================*/
62 /* code which was in cs.c before */
64 /* String tables for error messages */
66 typedef struct lookup_t
{
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" }
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" }
159 static int pcmcia_report_error(struct pcmcia_device
*p_dev
, error_info_t
*err
)
167 printk(KERN_NOTICE
"%s: ", p_dev
->dev
.bus_id
);
169 for (i
= 0; i
< ARRAY_SIZE(service_table
); i
++)
170 if (service_table
[i
].key
== err
->func
)
172 if (i
< ARRAY_SIZE(service_table
))
173 serv
= service_table
[i
].msg
;
175 serv
= "Unknown service number";
177 for (i
= 0; i
< ARRAY_SIZE(error_table
); i
++)
178 if (error_table
[i
].key
== err
->retcode
)
180 if (i
< ARRAY_SIZE(error_table
))
181 printk("%s: %s\n", serv
, error_table
[i
].msg
);
183 printk("%s: Unknown error code %#x\n", serv
, err
->retcode
);
188 /* end of code which was in cs.c before */
190 /*======================================================================*/
192 void cs_error(struct pcmcia_device
*p_dev
, int func
, int ret
)
194 error_info_t err
= { func
, ret
};
195 pcmcia_report_error(p_dev
, &err
);
197 EXPORT_SYMBOL(cs_error
);
200 static void pcmcia_check_driver(struct pcmcia_driver
*p_drv
)
202 struct pcmcia_device_id
*did
= p_drv
->id_table
;
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
);
210 while (did
&& did
->match_flags
) {
211 for (i
=0; i
<4; i
++) {
212 if (!did
->prod_id
[i
])
215 hash
= crc32(0, did
->prod_id
[i
], strlen(did
->prod_id
[i
]));
216 if (hash
== did
->prod_id_hash
[i
])
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 "
234 /*======================================================================*/
238 * pcmcia_register_driver - register a PCMCIA driver with the bus core
240 * Registers a PCMCIA driver with the PCMCIA bus core.
242 int pcmcia_register_driver(struct pcmcia_driver
*driver
)
247 pcmcia_check_driver(driver
);
249 /* initialize common fields */
250 driver
->drv
.bus
= &pcmcia_bus_type
;
251 driver
->drv
.owner
= driver
->owner
;
253 ds_dbg(3, "registering driver %s\n", driver
->drv
.name
);
255 return driver_register(&driver
->drv
);
257 EXPORT_SYMBOL(pcmcia_register_driver
);
260 * pcmcia_unregister_driver - unregister a PCMCIA driver with the bus core
262 void pcmcia_unregister_driver(struct pcmcia_driver
*driver
)
264 ds_dbg(3, "unregistering driver %s\n", driver
->drv
.name
);
265 driver_unregister(&driver
->drv
);
267 EXPORT_SYMBOL(pcmcia_unregister_driver
);
270 /* pcmcia_device handling */
272 struct pcmcia_device
* pcmcia_get_dev(struct pcmcia_device
*p_dev
)
274 struct device
*tmp_dev
;
275 tmp_dev
= get_device(&p_dev
->dev
);
278 return to_pcmcia_dev(tmp_dev
);
281 void pcmcia_put_dev(struct pcmcia_device
*p_dev
)
284 put_device(&p_dev
->dev
);
287 static void pcmcia_release_function(struct kref
*ref
)
289 struct config_t
*c
= container_of(ref
, struct config_t
, ref
);
290 ds_dbg(1, "releasing config_t\n");
294 static void pcmcia_release_dev(struct device
*dev
)
296 struct pcmcia_device
*p_dev
= to_pcmcia_dev(dev
);
297 ds_dbg(1, "releasing device %s\n", p_dev
->dev
.bus_id
);
298 pcmcia_put_socket(p_dev
->socket
);
299 kfree(p_dev
->devname
);
300 kref_put(&p_dev
->function_config
->ref
, pcmcia_release_function
);
304 static void pcmcia_add_device_later(struct pcmcia_socket
*s
, int mfc
)
306 if (!s
->pcmcia_state
.device_add_pending
) {
307 ds_dbg(1, "scheduling to add %s secondary"
308 " device to %d\n", mfc
? "mfc" : "pfc", s
->sock
);
309 s
->pcmcia_state
.device_add_pending
= 1;
310 s
->pcmcia_state
.mfc_pfc
= mfc
;
311 schedule_work(&s
->device_add
);
316 static int pcmcia_device_probe(struct device
* dev
)
318 struct pcmcia_device
*p_dev
;
319 struct pcmcia_driver
*p_drv
;
320 struct pcmcia_device_id
*did
;
321 struct pcmcia_socket
*s
;
322 cistpl_config_t cis_config
;
325 dev
= get_device(dev
);
329 p_dev
= to_pcmcia_dev(dev
);
330 p_drv
= to_pcmcia_drv(dev
->driver
);
333 ds_dbg(1, "trying to bind %s to %s\n", p_dev
->dev
.bus_id
,
336 if ((!p_drv
->probe
) || (!p_dev
->function_config
) ||
337 (!try_module_get(p_drv
->owner
))) {
342 /* set up some more device information */
343 ret
= pccard_read_tuple(p_dev
->socket
, p_dev
->func
, CISTPL_CONFIG
,
346 p_dev
->conf
.ConfigBase
= cis_config
.base
;
347 p_dev
->conf
.Present
= cis_config
.rmask
[0];
349 printk(KERN_INFO
"pcmcia: could not parse base and rmask0 of CIS\n");
350 p_dev
->conf
.ConfigBase
= 0;
351 p_dev
->conf
.Present
= 0;
354 ret
= p_drv
->probe(p_dev
);
356 ds_dbg(1, "binding %s to %s failed with %d\n",
357 p_dev
->dev
.bus_id
, p_drv
->drv
.name
, ret
);
361 /* handle pseudo multifunction devices:
362 * there are at most two pseudo multifunction devices.
363 * if we're matching against the first, schedule a
364 * call which will then check whether there are two
365 * pseudo devices, and if not, add the second one.
367 did
= p_dev
->dev
.driver_data
;
368 if (did
&& (did
->match_flags
& PCMCIA_DEV_ID_MATCH_DEVICE_NO
) &&
369 (p_dev
->socket
->device_count
== 1) && (p_dev
->device_no
== 0))
370 pcmcia_add_device_later(p_dev
->socket
, 0);
374 module_put(p_drv
->owner
);
383 * Removes a PCMCIA card from the device tree and socket list.
385 static void pcmcia_card_remove(struct pcmcia_socket
*s
, struct pcmcia_device
*leftover
)
387 struct pcmcia_device
*p_dev
;
388 struct pcmcia_device
*tmp
;
391 ds_dbg(2, "pcmcia_card_remove(%d) %s\n", s
->sock
,
392 leftover
? leftover
->devname
: "");
399 /* unregister all pcmcia_devices registered with this socket, except leftover */
400 list_for_each_entry_safe(p_dev
, tmp
, &s
->devices_list
, socket_device_list
) {
401 if (p_dev
== leftover
)
404 spin_lock_irqsave(&pcmcia_dev_list_lock
, flags
);
405 list_del(&p_dev
->socket_device_list
);
407 spin_unlock_irqrestore(&pcmcia_dev_list_lock
, flags
);
409 ds_dbg(2, "unregistering device %s\n", p_dev
->dev
.bus_id
);
410 device_unregister(&p_dev
->dev
);
416 static int pcmcia_device_remove(struct device
* dev
)
418 struct pcmcia_device
*p_dev
;
419 struct pcmcia_driver
*p_drv
;
420 struct pcmcia_device_id
*did
;
423 p_dev
= to_pcmcia_dev(dev
);
424 p_drv
= to_pcmcia_drv(dev
->driver
);
426 ds_dbg(1, "removing device %s\n", p_dev
->dev
.bus_id
);
428 /* If we're removing the primary module driving a
429 * pseudo multi-function card, we need to unbind
432 did
= p_dev
->dev
.driver_data
;
433 if (did
&& (did
->match_flags
& PCMCIA_DEV_ID_MATCH_DEVICE_NO
) &&
434 (p_dev
->socket
->device_count
!= 0) &&
435 (p_dev
->device_no
== 0))
436 pcmcia_card_remove(p_dev
->socket
, p_dev
);
438 /* detach the "instance" */
443 p_drv
->remove(p_dev
);
445 p_dev
->dev_node
= NULL
;
447 /* check for proper unloading */
448 if (p_dev
->_irq
|| p_dev
->_io
|| p_dev
->_locked
)
449 printk(KERN_INFO
"pcmcia: driver %s did not release config properly\n",
452 for (i
= 0; i
< MAX_WIN
; i
++)
453 if (p_dev
->_win
& CLIENT_WIN_REQ(i
))
454 printk(KERN_INFO
"pcmcia: driver %s did not release windows properly\n",
457 /* references from pcmcia_probe_device */
458 pcmcia_put_dev(p_dev
);
459 module_put(p_drv
->owner
);
466 * pcmcia_device_query -- determine information about a pcmcia device
468 static int pcmcia_device_query(struct pcmcia_device
*p_dev
)
470 cistpl_manfid_t manf_id
;
471 cistpl_funcid_t func_id
;
472 cistpl_vers_1_t
*vers1
;
475 vers1
= kmalloc(sizeof(*vers1
), GFP_KERNEL
);
479 if (!pccard_read_tuple(p_dev
->socket
, p_dev
->func
,
480 CISTPL_MANFID
, &manf_id
)) {
481 p_dev
->manf_id
= manf_id
.manf
;
482 p_dev
->card_id
= manf_id
.card
;
483 p_dev
->has_manf_id
= 1;
484 p_dev
->has_card_id
= 1;
487 if (!pccard_read_tuple(p_dev
->socket
, p_dev
->func
,
488 CISTPL_FUNCID
, &func_id
)) {
489 p_dev
->func_id
= func_id
.func
;
490 p_dev
->has_func_id
= 1;
492 /* rule of thumb: cards with no FUNCID, but with
493 * common memory device geometry information, are
494 * probably memory cards (from pcmcia-cs) */
495 cistpl_device_geo_t
*devgeo
;
497 devgeo
= kmalloc(sizeof(*devgeo
), GFP_KERNEL
);
502 if (!pccard_read_tuple(p_dev
->socket
, p_dev
->func
,
503 CISTPL_DEVICE_GEO
, devgeo
)) {
504 ds_dbg(0, "mem device geometry probably means "
506 p_dev
->func_id
= CISTPL_FUNCID_MEMORY
;
507 p_dev
->has_func_id
= 1;
512 if (!pccard_read_tuple(p_dev
->socket
, p_dev
->func
, CISTPL_VERS_1
,
514 for (i
=0; i
< vers1
->ns
; i
++) {
518 tmp
= vers1
->str
+ vers1
->ofs
[i
];
520 length
= strlen(tmp
) + 1;
521 if ((length
< 2) || (length
> 255))
524 p_dev
->prod_id
[i
] = kmalloc(sizeof(char) * length
,
526 if (!p_dev
->prod_id
[i
])
529 p_dev
->prod_id
[i
] = strncpy(p_dev
->prod_id
[i
],
539 /* device_add_lock is needed to avoid double registration by cardmgr and kernel.
540 * Serializes pcmcia_device_add; will most likely be removed in future.
542 * While it has the caveat that adding new PCMCIA devices inside(!) device_register()
543 * won't work, this doesn't matter much at the moment: the driver core doesn't
546 static DEFINE_MUTEX(device_add_lock
);
548 struct pcmcia_device
* pcmcia_device_add(struct pcmcia_socket
*s
, unsigned int function
)
550 struct pcmcia_device
*p_dev
, *tmp_dev
;
554 s
= pcmcia_get_socket(s
);
558 mutex_lock(&device_add_lock
);
560 ds_dbg(3, "adding device to %d, function %d\n", s
->sock
, function
);
562 /* max of 4 devices per card */
563 if (s
->device_count
== 4)
566 p_dev
= kzalloc(sizeof(struct pcmcia_device
), GFP_KERNEL
);
571 p_dev
->device_no
= (s
->device_count
++);
572 p_dev
->func
= function
;
574 p_dev
->dev
.bus
= &pcmcia_bus_type
;
575 p_dev
->dev
.parent
= s
->dev
.parent
;
576 p_dev
->dev
.release
= pcmcia_release_dev
;
577 bus_id_len
= sprintf (p_dev
->dev
.bus_id
, "%d.%d", p_dev
->socket
->sock
, p_dev
->device_no
);
579 p_dev
->devname
= kmalloc(6 + bus_id_len
+ 1, GFP_KERNEL
);
582 sprintf (p_dev
->devname
, "pcmcia%s", p_dev
->dev
.bus_id
);
583 ds_dbg(3, "devname is %s\n", p_dev
->devname
);
585 spin_lock_irqsave(&pcmcia_dev_list_lock
, flags
);
588 * p_dev->function_config must be the same for all card functions.
589 * Note that this is serialized by the device_add_lock, so that
590 * only one such struct will be created.
592 list_for_each_entry(tmp_dev
, &s
->devices_list
, socket_device_list
)
593 if (p_dev
->func
== tmp_dev
->func
) {
594 p_dev
->function_config
= tmp_dev
->function_config
;
595 kref_get(&p_dev
->function_config
->ref
);
598 /* Add to the list in pcmcia_bus_socket */
599 list_add(&p_dev
->socket_device_list
, &s
->devices_list
);
601 spin_unlock_irqrestore(&pcmcia_dev_list_lock
, flags
);
603 if (!p_dev
->function_config
) {
604 ds_dbg(3, "creating config_t for %s\n", p_dev
->dev
.bus_id
);
605 p_dev
->function_config
= kzalloc(sizeof(struct config_t
),
607 if (!p_dev
->function_config
)
609 kref_init(&p_dev
->function_config
->ref
);
612 printk(KERN_NOTICE
"pcmcia: registering new device %s\n",
615 pcmcia_device_query(p_dev
);
617 if (device_register(&p_dev
->dev
))
620 mutex_unlock(&device_add_lock
);
625 spin_lock_irqsave(&pcmcia_dev_list_lock
, flags
);
626 list_del(&p_dev
->socket_device_list
);
627 spin_unlock_irqrestore(&pcmcia_dev_list_lock
, flags
);
630 kfree(p_dev
->devname
);
634 mutex_unlock(&device_add_lock
);
635 pcmcia_put_socket(s
);
641 static int pcmcia_card_add(struct pcmcia_socket
*s
)
644 cistpl_longlink_mfc_t mfc
;
645 unsigned int no_funcs
, i
;
648 if (!(s
->resource_setup_done
)) {
649 ds_dbg(3, "no resources available, delaying card_add\n");
650 return -EAGAIN
; /* try again, but later... */
653 if (pcmcia_validate_mem(s
)) {
654 ds_dbg(3, "validating mem resources failed, "
655 "delaying card_add\n");
656 return -EAGAIN
; /* try again, but later... */
659 ret
= pccard_validate_cis(s
, BIND_FN_ALL
, &cisinfo
);
660 if (ret
|| !cisinfo
.Chains
) {
661 ds_dbg(0, "invalid CIS or invalid resources\n");
665 if (!pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_LONGLINK_MFC
, &mfc
))
669 s
->functions
= no_funcs
;
671 for (i
=0; i
< no_funcs
; i
++)
672 pcmcia_device_add(s
, i
);
678 static void pcmcia_delayed_add_device(struct work_struct
*work
)
680 struct pcmcia_socket
*s
=
681 container_of(work
, struct pcmcia_socket
, device_add
);
682 ds_dbg(1, "adding additional device to %d\n", s
->sock
);
683 pcmcia_device_add(s
, s
->pcmcia_state
.mfc_pfc
);
684 s
->pcmcia_state
.device_add_pending
= 0;
685 s
->pcmcia_state
.mfc_pfc
= 0;
688 static int pcmcia_requery(struct device
*dev
, void * _data
)
690 struct pcmcia_device
*p_dev
= to_pcmcia_dev(dev
);
691 if (!p_dev
->dev
.driver
) {
692 ds_dbg(1, "update device information for %s\n",
694 pcmcia_device_query(p_dev
);
700 static void pcmcia_bus_rescan(struct pcmcia_socket
*skt
, int new_cis
)
706 /* must be called with skt_mutex held */
707 ds_dbg(0, "re-scanning socket %d\n", skt
->sock
);
709 spin_lock_irqsave(&pcmcia_dev_list_lock
, flags
);
710 if (list_empty(&skt
->devices_list
))
712 spin_unlock_irqrestore(&pcmcia_dev_list_lock
, flags
);
714 /* If this is because of a CIS override, start over */
715 if (new_cis
&& !no_devices
)
716 pcmcia_card_remove(skt
, NULL
);
718 /* if no devices were added for this socket yet because of
719 * missing resource information or other trouble, we need to
721 if (no_devices
|| new_cis
) {
722 ret
= pcmcia_card_add(skt
);
727 /* some device information might have changed because of a CIS
728 * update or because we can finally read it correctly... so
729 * determine it again, overwriting old values if necessary. */
730 bus_for_each_dev(&pcmcia_bus_type
, NULL
, NULL
, pcmcia_requery
);
732 /* we re-scan all devices, not just the ones connected to this
733 * socket. This does not matter, though. */
734 ret
= bus_rescan_devices(&pcmcia_bus_type
);
736 printk(KERN_INFO
"pcmcia: bus_rescan_devices failed\n");
739 #ifdef CONFIG_PCMCIA_LOAD_CIS
742 * pcmcia_load_firmware - load CIS from userspace if device-provided is broken
743 * @dev - the pcmcia device which needs a CIS override
744 * @filename - requested filename in /lib/firmware/
746 * This uses the in-kernel firmware loading mechanism to use a "fake CIS" if
747 * the one provided by the card is broken. The firmware files reside in
748 * /lib/firmware/ in userspace.
750 static int pcmcia_load_firmware(struct pcmcia_device
*dev
, char * filename
)
752 struct pcmcia_socket
*s
= dev
->socket
;
753 const struct firmware
*fw
;
759 cistpl_longlink_mfc_t mfc
;
764 ds_dbg(1, "trying to load CIS file %s\n", filename
);
766 if (strlen(filename
) > 14) {
767 printk(KERN_WARNING
"pcmcia: CIS filename is too long\n");
771 snprintf(path
, 20, "%s", filename
);
773 if (request_firmware(&fw
, path
, &dev
->dev
) == 0) {
774 if (fw
->size
>= CISTPL_MAX_CIS_SIZE
) {
776 printk(KERN_ERR
"pcmcia: CIS override is too big\n");
780 cis
= kzalloc(sizeof(cisdump_t
), GFP_KERNEL
);
786 cis
->Length
= fw
->size
+ 1;
787 memcpy(cis
->Data
, fw
->data
, fw
->size
);
789 if (!pcmcia_replace_cis(s
, cis
))
792 printk(KERN_ERR
"pcmcia: CIS override failed\n");
797 /* update information */
798 pcmcia_device_query(dev
);
800 /* does this cis override add or remove functions? */
801 old_funcs
= s
->functions
;
803 if (!pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_LONGLINK_MFC
, &mfc
))
807 s
->functions
= no_funcs
;
809 if (old_funcs
> no_funcs
)
810 pcmcia_card_remove(s
, dev
);
811 else if (no_funcs
> old_funcs
)
812 pcmcia_add_device_later(s
, 1);
815 release_firmware(fw
);
820 #else /* !CONFIG_PCMCIA_LOAD_CIS */
822 static inline int pcmcia_load_firmware(struct pcmcia_device
*dev
, char * filename
)
830 static inline int pcmcia_devmatch(struct pcmcia_device
*dev
,
831 struct pcmcia_device_id
*did
)
833 if (did
->match_flags
& PCMCIA_DEV_ID_MATCH_MANF_ID
) {
834 if ((!dev
->has_manf_id
) || (dev
->manf_id
!= did
->manf_id
))
838 if (did
->match_flags
& PCMCIA_DEV_ID_MATCH_CARD_ID
) {
839 if ((!dev
->has_card_id
) || (dev
->card_id
!= did
->card_id
))
843 if (did
->match_flags
& PCMCIA_DEV_ID_MATCH_FUNCTION
) {
844 if (dev
->func
!= did
->function
)
848 if (did
->match_flags
& PCMCIA_DEV_ID_MATCH_PROD_ID1
) {
849 if (!dev
->prod_id
[0])
851 if (strcmp(did
->prod_id
[0], dev
->prod_id
[0]))
855 if (did
->match_flags
& PCMCIA_DEV_ID_MATCH_PROD_ID2
) {
856 if (!dev
->prod_id
[1])
858 if (strcmp(did
->prod_id
[1], dev
->prod_id
[1]))
862 if (did
->match_flags
& PCMCIA_DEV_ID_MATCH_PROD_ID3
) {
863 if (!dev
->prod_id
[2])
865 if (strcmp(did
->prod_id
[2], dev
->prod_id
[2]))
869 if (did
->match_flags
& PCMCIA_DEV_ID_MATCH_PROD_ID4
) {
870 if (!dev
->prod_id
[3])
872 if (strcmp(did
->prod_id
[3], dev
->prod_id
[3]))
876 if (did
->match_flags
& PCMCIA_DEV_ID_MATCH_DEVICE_NO
) {
877 if (dev
->device_no
!= did
->device_no
)
881 if (did
->match_flags
& PCMCIA_DEV_ID_MATCH_FUNC_ID
) {
882 if ((!dev
->has_func_id
) || (dev
->func_id
!= did
->func_id
))
885 /* if this is a pseudo-multi-function device,
886 * we need explicit matches */
887 if (did
->match_flags
& PCMCIA_DEV_ID_MATCH_DEVICE_NO
)
892 /* also, FUNC_ID matching needs to be activated by userspace
893 * after it has re-checked that there is no possible module
894 * with a prod_id/manf_id/card_id match.
896 ds_dbg(0, "skipping FUNC_ID match for %s until userspace "
897 "interaction\n", dev
->dev
.bus_id
);
898 if (!dev
->allow_func_id_match
)
902 if (did
->match_flags
& PCMCIA_DEV_ID_MATCH_FAKE_CIS
) {
903 ds_dbg(0, "device %s needs a fake CIS\n", dev
->dev
.bus_id
);
904 if (!dev
->socket
->fake_cis
)
905 pcmcia_load_firmware(dev
, did
->cisfile
);
907 if (!dev
->socket
->fake_cis
)
911 if (did
->match_flags
& PCMCIA_DEV_ID_MATCH_ANONYMOUS
) {
916 if (dev
->has_manf_id
|| dev
->has_card_id
|| dev
->has_func_id
)
920 dev
->dev
.driver_data
= (void *) did
;
926 static int pcmcia_bus_match(struct device
* dev
, struct device_driver
* drv
) {
927 struct pcmcia_device
* p_dev
= to_pcmcia_dev(dev
);
928 struct pcmcia_driver
* p_drv
= to_pcmcia_drv(drv
);
929 struct pcmcia_device_id
*did
= p_drv
->id_table
;
931 #ifdef CONFIG_PCMCIA_IOCTL
932 /* matching by cardmgr */
933 if (p_dev
->cardmgr
== p_drv
) {
934 ds_dbg(0, "cardmgr matched %s to %s\n", dev
->bus_id
,
940 while (did
&& did
->match_flags
) {
941 ds_dbg(3, "trying to match %s to %s\n", dev
->bus_id
,
943 if (pcmcia_devmatch(p_dev
, did
)) {
944 ds_dbg(0, "matched %s to %s\n", dev
->bus_id
,
954 #ifdef CONFIG_HOTPLUG
956 static int pcmcia_bus_uevent(struct device
*dev
, char **envp
, int num_envp
,
957 char *buffer
, int buffer_size
)
959 struct pcmcia_device
*p_dev
;
961 u32 hash
[4] = { 0, 0, 0, 0};
966 p_dev
= to_pcmcia_dev(dev
);
968 /* calculate hashes */
969 for (i
=0; i
<4; i
++) {
970 if (!p_dev
->prod_id
[i
])
972 hash
[i
] = crc32(0, p_dev
->prod_id
[i
], strlen(p_dev
->prod_id
[i
]));
977 if (add_uevent_var(envp
, num_envp
, &i
,
978 buffer
, buffer_size
, &length
,
980 p_dev
->socket
->sock
))
983 if (add_uevent_var(envp
, num_envp
, &i
,
984 buffer
, buffer_size
, &length
,
989 if (add_uevent_var(envp
, num_envp
, &i
,
990 buffer
, buffer_size
, &length
,
991 "MODALIAS=pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
992 "pa%08Xpb%08Xpc%08Xpd%08X",
993 p_dev
->has_manf_id
? p_dev
->manf_id
: 0,
994 p_dev
->has_card_id
? p_dev
->card_id
: 0,
995 p_dev
->has_func_id
? p_dev
->func_id
: 0,
1011 static int pcmcia_bus_uevent(struct device
*dev
, char **envp
, int num_envp
,
1012 char *buffer
, int buffer_size
)
1019 /************************ per-device sysfs output ***************************/
1021 #define pcmcia_device_attr(field, test, format) \
1022 static ssize_t field##_show (struct device *dev, struct device_attribute *attr, char *buf) \
1024 struct pcmcia_device *p_dev = to_pcmcia_dev(dev); \
1025 return p_dev->test ? sprintf (buf, format, p_dev->field) : -ENODEV; \
1028 #define pcmcia_device_stringattr(name, field) \
1029 static ssize_t name##_show (struct device *dev, struct device_attribute *attr, char *buf) \
1031 struct pcmcia_device *p_dev = to_pcmcia_dev(dev); \
1032 return p_dev->field ? sprintf (buf, "%s\n", p_dev->field) : -ENODEV; \
1035 pcmcia_device_attr(func
, socket
, "0x%02x\n");
1036 pcmcia_device_attr(func_id
, has_func_id
, "0x%02x\n");
1037 pcmcia_device_attr(manf_id
, has_manf_id
, "0x%04x\n");
1038 pcmcia_device_attr(card_id
, has_card_id
, "0x%04x\n");
1039 pcmcia_device_stringattr(prod_id1
, prod_id
[0]);
1040 pcmcia_device_stringattr(prod_id2
, prod_id
[1]);
1041 pcmcia_device_stringattr(prod_id3
, prod_id
[2]);
1042 pcmcia_device_stringattr(prod_id4
, prod_id
[3]);
1045 static ssize_t
pcmcia_show_pm_state(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
1047 struct pcmcia_device
*p_dev
= to_pcmcia_dev(dev
);
1049 if (p_dev
->suspended
)
1050 return sprintf(buf
, "off\n");
1052 return sprintf(buf
, "on\n");
1055 static ssize_t
pcmcia_store_pm_state(struct device
*dev
, struct device_attribute
*attr
,
1056 const char *buf
, size_t count
)
1058 struct pcmcia_device
*p_dev
= to_pcmcia_dev(dev
);
1064 if ((!p_dev
->suspended
) && !strncmp(buf
, "off", 3))
1065 ret
= dpm_runtime_suspend(dev
, PMSG_SUSPEND
);
1066 else if (p_dev
->suspended
&& !strncmp(buf
, "on", 2))
1067 dpm_runtime_resume(dev
);
1069 return ret
? ret
: count
;
1073 static ssize_t
modalias_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
1075 struct pcmcia_device
*p_dev
= to_pcmcia_dev(dev
);
1077 u32 hash
[4] = { 0, 0, 0, 0};
1079 /* calculate hashes */
1080 for (i
=0; i
<4; i
++) {
1081 if (!p_dev
->prod_id
[i
])
1083 hash
[i
] = crc32(0,p_dev
->prod_id
[i
],strlen(p_dev
->prod_id
[i
]));
1085 return sprintf(buf
, "pcmcia:m%04Xc%04Xf%02Xfn%02Xpfn%02X"
1086 "pa%08Xpb%08Xpc%08Xpd%08X\n",
1087 p_dev
->has_manf_id
? p_dev
->manf_id
: 0,
1088 p_dev
->has_card_id
? p_dev
->card_id
: 0,
1089 p_dev
->has_func_id
? p_dev
->func_id
: 0,
1090 p_dev
->func
, p_dev
->device_no
,
1091 hash
[0], hash
[1], hash
[2], hash
[3]);
1094 static ssize_t
pcmcia_store_allow_func_id_match(struct device
*dev
,
1095 struct device_attribute
*attr
, const char *buf
, size_t count
)
1097 struct pcmcia_device
*p_dev
= to_pcmcia_dev(dev
);
1103 mutex_lock(&p_dev
->socket
->skt_mutex
);
1104 p_dev
->allow_func_id_match
= 1;
1105 mutex_unlock(&p_dev
->socket
->skt_mutex
);
1107 ret
= bus_rescan_devices(&pcmcia_bus_type
);
1109 printk(KERN_INFO
"pcmcia: bus_rescan_devices failed after "
1110 "allowing func_id matches\n");
1115 static struct device_attribute pcmcia_dev_attrs
[] = {
1116 __ATTR(function
, 0444, func_show
, NULL
),
1117 __ATTR(pm_state
, 0644, pcmcia_show_pm_state
, pcmcia_store_pm_state
),
1121 __ATTR_RO(prod_id1
),
1122 __ATTR_RO(prod_id2
),
1123 __ATTR_RO(prod_id3
),
1124 __ATTR_RO(prod_id4
),
1125 __ATTR_RO(modalias
),
1126 __ATTR(allow_func_id_match
, 0200, NULL
, pcmcia_store_allow_func_id_match
),
1130 /* PM support, also needed for reset */
1132 static int pcmcia_dev_suspend(struct device
* dev
, pm_message_t state
)
1134 struct pcmcia_device
*p_dev
= to_pcmcia_dev(dev
);
1135 struct pcmcia_driver
*p_drv
= NULL
;
1138 ds_dbg(2, "suspending %s\n", dev
->bus_id
);
1141 p_drv
= to_pcmcia_drv(dev
->driver
);
1146 if (p_drv
->suspend
) {
1147 ret
= p_drv
->suspend(p_dev
);
1149 printk(KERN_ERR
"pcmcia: device %s (driver %s) did "
1150 "not want to go to sleep (%d)\n",
1151 p_dev
->devname
, p_drv
->drv
.name
, ret
);
1156 if (p_dev
->device_no
== p_dev
->func
) {
1157 ds_dbg(2, "releasing configuration for %s\n", dev
->bus_id
);
1158 pcmcia_release_configuration(p_dev
);
1163 p_dev
->suspended
= 1;
1168 static int pcmcia_dev_resume(struct device
* dev
)
1170 struct pcmcia_device
*p_dev
= to_pcmcia_dev(dev
);
1171 struct pcmcia_driver
*p_drv
= NULL
;
1174 ds_dbg(2, "resuming %s\n", dev
->bus_id
);
1177 p_drv
= to_pcmcia_drv(dev
->driver
);
1182 if (p_dev
->device_no
== p_dev
->func
) {
1183 ds_dbg(2, "requesting configuration for %s\n", dev
->bus_id
);
1184 ret
= pcmcia_request_configuration(p_dev
, &p_dev
->conf
);
1190 ret
= p_drv
->resume(p_dev
);
1194 p_dev
->suspended
= 0;
1199 static int pcmcia_bus_suspend_callback(struct device
*dev
, void * _data
)
1201 struct pcmcia_socket
*skt
= _data
;
1202 struct pcmcia_device
*p_dev
= to_pcmcia_dev(dev
);
1204 if (p_dev
->socket
!= skt
)
1207 return dpm_runtime_suspend(dev
, PMSG_SUSPEND
);
1210 static int pcmcia_bus_resume_callback(struct device
*dev
, void * _data
)
1212 struct pcmcia_socket
*skt
= _data
;
1213 struct pcmcia_device
*p_dev
= to_pcmcia_dev(dev
);
1215 if (p_dev
->socket
!= skt
)
1218 dpm_runtime_resume(dev
);
1223 static int pcmcia_bus_resume(struct pcmcia_socket
*skt
)
1225 ds_dbg(2, "resuming socket %d\n", skt
->sock
);
1226 bus_for_each_dev(&pcmcia_bus_type
, NULL
, skt
, pcmcia_bus_resume_callback
);
1230 static int pcmcia_bus_suspend(struct pcmcia_socket
*skt
)
1232 ds_dbg(2, "suspending socket %d\n", skt
->sock
);
1233 if (bus_for_each_dev(&pcmcia_bus_type
, NULL
, skt
,
1234 pcmcia_bus_suspend_callback
)) {
1235 pcmcia_bus_resume(skt
);
1242 /*======================================================================
1244 The card status event handler.
1246 ======================================================================*/
1248 /* Normally, the event is passed to individual drivers after
1249 * informing userspace. Only for CS_EVENT_CARD_REMOVAL this
1250 * is inversed to maintain historic compatibility.
1253 static int ds_event(struct pcmcia_socket
*skt
, event_t event
, int priority
)
1255 struct pcmcia_socket
*s
= pcmcia_get_socket(skt
);
1258 printk(KERN_ERR
"PCMCIA obtaining reference to socket %p " \
1259 "failed, event 0x%x lost!\n", skt
, event
);
1263 ds_dbg(1, "ds_event(0x%06x, %d, 0x%p)\n",
1264 event
, priority
, skt
);
1267 case CS_EVENT_CARD_REMOVAL
:
1268 s
->pcmcia_state
.present
= 0;
1269 pcmcia_card_remove(skt
, NULL
);
1270 handle_event(skt
, event
);
1273 case CS_EVENT_CARD_INSERTION
:
1274 s
->pcmcia_state
.present
= 1;
1275 pcmcia_card_add(skt
);
1276 handle_event(skt
, event
);
1279 case CS_EVENT_EJECTION_REQUEST
:
1282 case CS_EVENT_PM_SUSPEND
:
1283 case CS_EVENT_PM_RESUME
:
1284 case CS_EVENT_RESET_PHYSICAL
:
1285 case CS_EVENT_CARD_RESET
:
1287 handle_event(skt
, event
);
1291 pcmcia_put_socket(s
);
1297 struct pcmcia_device
* pcmcia_dev_present(struct pcmcia_device
*_p_dev
)
1299 struct pcmcia_device
*p_dev
;
1300 struct pcmcia_device
*ret
= NULL
;
1302 p_dev
= pcmcia_get_dev(_p_dev
);
1306 if (!p_dev
->socket
->pcmcia_state
.present
)
1309 if (p_dev
->_removed
)
1312 if (p_dev
->suspended
)
1317 pcmcia_put_dev(p_dev
);
1320 EXPORT_SYMBOL(pcmcia_dev_present
);
1323 static struct pcmcia_callback pcmcia_bus_callback
= {
1324 .owner
= THIS_MODULE
,
1326 .requery
= pcmcia_bus_rescan
,
1327 .suspend
= pcmcia_bus_suspend
,
1328 .resume
= pcmcia_bus_resume
,
1331 static int __devinit
pcmcia_bus_add_socket(struct device
*dev
,
1332 struct class_interface
*class_intf
)
1334 struct pcmcia_socket
*socket
= dev_get_drvdata(dev
);
1337 socket
= pcmcia_get_socket(socket
);
1339 printk(KERN_ERR
"PCMCIA obtaining reference to socket %p failed\n", socket
);
1344 * Ugly. But we want to wait for the socket threads to have started up.
1345 * We really should let the drivers themselves drive some of this..
1349 #ifdef CONFIG_PCMCIA_IOCTL
1350 init_waitqueue_head(&socket
->queue
);
1352 INIT_LIST_HEAD(&socket
->devices_list
);
1353 INIT_WORK(&socket
->device_add
, pcmcia_delayed_add_device
);
1354 memset(&socket
->pcmcia_state
, 0, sizeof(u8
));
1355 socket
->device_count
= 0;
1357 ret
= pccard_register_pcmcia(socket
, &pcmcia_bus_callback
);
1359 printk(KERN_ERR
"PCMCIA registration PCCard core failed for socket %p\n", socket
);
1360 pcmcia_put_socket(socket
);
1367 static void pcmcia_bus_remove_socket(struct device
*dev
,
1368 struct class_interface
*class_intf
)
1370 struct pcmcia_socket
*socket
= dev_get_drvdata(dev
);
1375 socket
->pcmcia_state
.dead
= 1;
1376 pccard_register_pcmcia(socket
, NULL
);
1378 /* unregister any unbound devices */
1379 mutex_lock(&socket
->skt_mutex
);
1380 pcmcia_card_remove(socket
, NULL
);
1381 mutex_unlock(&socket
->skt_mutex
);
1383 pcmcia_put_socket(socket
);
1389 /* the pcmcia_bus_interface is used to handle pcmcia socket devices */
1390 static struct class_interface pcmcia_bus_interface
= {
1391 .class = &pcmcia_socket_class
,
1392 .add_dev
= &pcmcia_bus_add_socket
,
1393 .remove_dev
= &pcmcia_bus_remove_socket
,
1397 struct bus_type pcmcia_bus_type
= {
1399 .uevent
= pcmcia_bus_uevent
,
1400 .match
= pcmcia_bus_match
,
1401 .dev_attrs
= pcmcia_dev_attrs
,
1402 .probe
= pcmcia_device_probe
,
1403 .remove
= pcmcia_device_remove
,
1404 .suspend
= pcmcia_dev_suspend
,
1405 .resume
= pcmcia_dev_resume
,
1409 static int __init
init_pcmcia_bus(void)
1413 spin_lock_init(&pcmcia_dev_list_lock
);
1415 ret
= bus_register(&pcmcia_bus_type
);
1417 printk(KERN_WARNING
"pcmcia: bus_register error: %d\n", ret
);
1420 ret
= class_interface_register(&pcmcia_bus_interface
);
1423 "pcmcia: class_interface_register error: %d\n", ret
);
1424 bus_unregister(&pcmcia_bus_type
);
1428 pcmcia_setup_ioctl();
1432 fs_initcall(init_pcmcia_bus
); /* one level after subsys_initcall so that
1433 * pcmcia_socket_class is already registered */
1436 static void __exit
exit_pcmcia_bus(void)
1438 pcmcia_cleanup_ioctl();
1440 class_interface_unregister(&pcmcia_bus_interface
);
1442 bus_unregister(&pcmcia_bus_type
);
1444 module_exit(exit_pcmcia_bus
);