2 * cistpl.c -- 16-bit PCMCIA Card Information Structure parser
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
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/kernel.h>
18 #include <linux/string.h>
19 #include <linux/major.h>
20 #include <linux/errno.h>
21 #include <linux/timer.h>
22 #include <linux/slab.h>
24 #include <linux/pci.h>
25 #include <linux/ioport.h>
27 #include <asm/byteorder.h>
28 #include <asm/unaligned.h>
30 #include <pcmcia/cs_types.h>
31 #include <pcmcia/ss.h>
32 #include <pcmcia/cs.h>
33 #include <pcmcia/cisreg.h>
34 #include <pcmcia/cistpl.h>
35 #include "cs_internal.h"
37 static const u_char mantissa
[] = {
38 10, 12, 13, 15, 20, 25, 30, 35,
39 40, 45, 50, 55, 60, 70, 80, 90
42 static const u_int exponent
[] = {
43 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000
46 /* Convert an extended speed byte to a time in nanoseconds */
47 #define SPEED_CVT(v) \
48 (mantissa[(((v)>>3)&15)-1] * exponent[(v)&7] / 10)
49 /* Convert a power byte to a current in 0.1 microamps */
50 #define POWER_CVT(v) \
51 (mantissa[((v)>>3)&15] * exponent[(v)&7] / 10)
52 #define POWER_SCALE(v) (exponent[(v)&7])
54 /* Upper limit on reasonable # of tuples */
55 #define MAX_TUPLES 200
57 /*====================================================================*/
59 /* Parameters that can be set with 'insmod' */
63 module_param(cis_width
, int, 0444);
65 void release_cis_mem(struct pcmcia_socket
*s
)
67 mutex_lock(&s
->ops_mutex
);
68 if (s
->cis_mem
.flags
& MAP_ACTIVE
) {
69 s
->cis_mem
.flags
&= ~MAP_ACTIVE
;
70 s
->ops
->set_mem_map(s
, &s
->cis_mem
);
72 release_resource(s
->cis_mem
.res
);
73 kfree(s
->cis_mem
.res
);
74 s
->cis_mem
.res
= NULL
;
79 mutex_unlock(&s
->ops_mutex
);
83 * Map the card memory at "card_offset" into virtual space.
84 * If flags & MAP_ATTRIB, map the attribute space, otherwise
85 * map the memory space.
87 * Must be called with ops_mutex held.
90 set_cis_map(struct pcmcia_socket
*s
, unsigned int card_offset
, unsigned int flags
)
92 pccard_mem_map
*mem
= &s
->cis_mem
;
95 if (!(s
->features
& SS_CAP_STATIC_MAP
) && (mem
->res
== NULL
)) {
96 mem
->res
= pcmcia_find_mem_region(0, s
->map_size
, s
->map_size
, 0, s
);
97 if (mem
->res
== NULL
) {
98 dev_printk(KERN_NOTICE
, &s
->dev
,
99 "cs: unable to map card memory!\n");
105 if (!(s
->features
& SS_CAP_STATIC_MAP
) && (!s
->cis_virt
))
106 s
->cis_virt
= ioremap(mem
->res
->start
, s
->map_size
);
108 mem
->card_start
= card_offset
;
111 ret
= s
->ops
->set_mem_map(s
, mem
);
113 iounmap(s
->cis_virt
);
118 if (s
->features
& SS_CAP_STATIC_MAP
) {
120 iounmap(s
->cis_virt
);
121 s
->cis_virt
= ioremap(mem
->static_start
, s
->map_size
);
127 /*======================================================================
129 Low-level functions to read and write CIS memory. I think the
130 write routine is only useful for writing one-byte registers.
132 ======================================================================*/
134 /* Bits in attr field */
136 #define IS_INDIRECT 8
138 int pcmcia_read_cis_mem(struct pcmcia_socket
*s
, int attr
, u_int addr
,
139 u_int len
, void *ptr
)
141 void __iomem
*sys
, *end
;
142 unsigned char *buf
= ptr
;
144 dev_dbg(&s
->dev
, "pcmcia_read_cis_mem(%d, %#x, %u)\n", attr
, addr
, len
);
146 mutex_lock(&s
->ops_mutex
);
147 if (attr
& IS_INDIRECT
) {
148 /* Indirect accesses use a bunch of special registers at fixed
149 locations in common memory */
150 u_char flags
= ICTRL0_COMMON
|ICTRL0_AUTOINC
|ICTRL0_BYTEGRAN
;
151 if (attr
& IS_ATTR
) {
153 flags
= ICTRL0_AUTOINC
;
156 sys
= set_cis_map(s
, 0, MAP_ACTIVE
| ((cis_width
) ? MAP_16BIT
: 0));
158 dev_dbg(&s
->dev
, "could not map memory\n");
159 memset(ptr
, 0xff, len
);
160 mutex_unlock(&s
->ops_mutex
);
164 writeb(flags
, sys
+CISREG_ICTRL0
);
165 writeb(addr
& 0xff, sys
+CISREG_IADDR0
);
166 writeb((addr
>>8) & 0xff, sys
+CISREG_IADDR1
);
167 writeb((addr
>>16) & 0xff, sys
+CISREG_IADDR2
);
168 writeb((addr
>>24) & 0xff, sys
+CISREG_IADDR3
);
169 for ( ; len
> 0; len
--, buf
++)
170 *buf
= readb(sys
+CISREG_IDATA0
);
172 u_int inc
= 1, card_offset
, flags
;
174 if (addr
> CISTPL_MAX_CIS_SIZE
)
175 dev_dbg(&s
->dev
, "attempt to read CIS mem at addr %#x", addr
);
177 flags
= MAP_ACTIVE
| ((cis_width
) ? MAP_16BIT
: 0);
184 card_offset
= addr
& ~(s
->map_size
-1);
186 sys
= set_cis_map(s
, card_offset
, flags
);
188 dev_dbg(&s
->dev
, "could not map memory\n");
189 memset(ptr
, 0xff, len
);
190 mutex_unlock(&s
->ops_mutex
);
193 end
= sys
+ s
->map_size
;
194 sys
= sys
+ (addr
& (s
->map_size
-1));
195 for ( ; len
> 0; len
--, buf
++, sys
+= inc
) {
200 card_offset
+= s
->map_size
;
204 mutex_unlock(&s
->ops_mutex
);
205 dev_dbg(&s
->dev
, " %#2.2x %#2.2x %#2.2x %#2.2x ...\n",
206 *(u_char
*)(ptr
+0), *(u_char
*)(ptr
+1),
207 *(u_char
*)(ptr
+2), *(u_char
*)(ptr
+3));
212 void pcmcia_write_cis_mem(struct pcmcia_socket
*s
, int attr
, u_int addr
,
213 u_int len
, void *ptr
)
215 void __iomem
*sys
, *end
;
216 unsigned char *buf
= ptr
;
218 dev_dbg(&s
->dev
, "pcmcia_write_cis_mem(%d, %#x, %u)\n", attr
, addr
, len
);
220 mutex_lock(&s
->ops_mutex
);
221 if (attr
& IS_INDIRECT
) {
222 /* Indirect accesses use a bunch of special registers at fixed
223 locations in common memory */
224 u_char flags
= ICTRL0_COMMON
|ICTRL0_AUTOINC
|ICTRL0_BYTEGRAN
;
225 if (attr
& IS_ATTR
) {
227 flags
= ICTRL0_AUTOINC
;
230 sys
= set_cis_map(s
, 0, MAP_ACTIVE
| ((cis_width
) ? MAP_16BIT
: 0));
232 dev_dbg(&s
->dev
, "could not map memory\n");
233 mutex_unlock(&s
->ops_mutex
);
234 return; /* FIXME: Error */
237 writeb(flags
, sys
+CISREG_ICTRL0
);
238 writeb(addr
& 0xff, sys
+CISREG_IADDR0
);
239 writeb((addr
>>8) & 0xff, sys
+CISREG_IADDR1
);
240 writeb((addr
>>16) & 0xff, sys
+CISREG_IADDR2
);
241 writeb((addr
>>24) & 0xff, sys
+CISREG_IADDR3
);
242 for ( ; len
> 0; len
--, buf
++)
243 writeb(*buf
, sys
+CISREG_IDATA0
);
245 u_int inc
= 1, card_offset
, flags
;
247 flags
= MAP_ACTIVE
| ((cis_width
) ? MAP_16BIT
: 0);
248 if (attr
& IS_ATTR
) {
254 card_offset
= addr
& ~(s
->map_size
-1);
256 sys
= set_cis_map(s
, card_offset
, flags
);
258 dev_dbg(&s
->dev
, "could not map memory\n");
259 mutex_unlock(&s
->ops_mutex
);
260 return; /* FIXME: error */
263 end
= sys
+ s
->map_size
;
264 sys
= sys
+ (addr
& (s
->map_size
-1));
265 for ( ; len
> 0; len
--, buf
++, sys
+= inc
) {
270 card_offset
+= s
->map_size
;
274 mutex_unlock(&s
->ops_mutex
);
278 /*======================================================================
280 This is a wrapper around read_cis_mem, with the same interface,
281 but which caches information, for cards whose CIS may not be
282 readable all the time.
284 ======================================================================*/
286 static int read_cis_cache(struct pcmcia_socket
*s
, int attr
, u_int addr
,
287 size_t len
, void *ptr
)
289 struct cis_cache_entry
*cis
;
292 if (s
->state
& SOCKET_CARDBUS
)
295 mutex_lock(&s
->ops_mutex
);
297 if (s
->fake_cis_len
>= addr
+len
)
298 memcpy(ptr
, s
->fake_cis
+addr
, len
);
300 memset(ptr
, 0xff, len
);
303 mutex_unlock(&s
->ops_mutex
);
307 list_for_each_entry(cis
, &s
->cis_cache
, node
) {
308 if (cis
->addr
== addr
&& cis
->len
== len
&& cis
->attr
== attr
) {
309 memcpy(ptr
, cis
->cache
, len
);
310 mutex_unlock(&s
->ops_mutex
);
314 mutex_unlock(&s
->ops_mutex
);
316 ret
= pcmcia_read_cis_mem(s
, attr
, addr
, len
, ptr
);
319 /* Copy data into the cache */
320 cis
= kmalloc(sizeof(struct cis_cache_entry
) + len
, GFP_KERNEL
);
325 memcpy(cis
->cache
, ptr
, len
);
326 mutex_lock(&s
->ops_mutex
);
327 list_add(&cis
->node
, &s
->cis_cache
);
328 mutex_unlock(&s
->ops_mutex
);
335 remove_cis_cache(struct pcmcia_socket
*s
, int attr
, u_int addr
, u_int len
)
337 struct cis_cache_entry
*cis
;
339 mutex_lock(&s
->ops_mutex
);
340 list_for_each_entry(cis
, &s
->cis_cache
, node
)
341 if (cis
->addr
== addr
&& cis
->len
== len
&& cis
->attr
== attr
) {
342 list_del(&cis
->node
);
346 mutex_unlock(&s
->ops_mutex
);
350 * destroy_cis_cache() - destroy the CIS cache
351 * @s: pcmcia_socket for which CIS cache shall be destroyed
353 * This destroys the CIS cache but keeps any fake CIS alive. Must be
354 * called with ops_mutex held.
357 void destroy_cis_cache(struct pcmcia_socket
*s
)
359 struct list_head
*l
, *n
;
360 struct cis_cache_entry
*cis
;
362 list_for_each_safe(l
, n
, &s
->cis_cache
) {
363 cis
= list_entry(l
, struct cis_cache_entry
, node
);
364 list_del(&cis
->node
);
369 /*======================================================================
371 This verifies if the CIS of a card matches what is in the CIS
374 ======================================================================*/
376 int verify_cis_cache(struct pcmcia_socket
*s
)
378 struct cis_cache_entry
*cis
;
382 if (s
->state
& SOCKET_CARDBUS
)
385 buf
= kmalloc(256, GFP_KERNEL
);
387 dev_printk(KERN_WARNING
, &s
->dev
,
388 "no memory for verifying CIS\n");
391 list_for_each_entry(cis
, &s
->cis_cache
, node
) {
397 ret
= pcmcia_read_cis_mem(s
, cis
->attr
, cis
->addr
, len
, buf
);
398 if (ret
|| memcmp(buf
, cis
->cache
, len
) != 0) {
407 /*======================================================================
409 For really bad cards, we provide a facility for uploading a
412 ======================================================================*/
414 int pcmcia_replace_cis(struct pcmcia_socket
*s
,
415 const u8
*data
, const size_t len
)
417 if (len
> CISTPL_MAX_CIS_SIZE
) {
418 dev_printk(KERN_WARNING
, &s
->dev
, "replacement CIS too big\n");
421 mutex_lock(&s
->ops_mutex
);
423 s
->fake_cis
= kmalloc(len
, GFP_KERNEL
);
424 if (s
->fake_cis
== NULL
) {
425 dev_printk(KERN_WARNING
, &s
->dev
, "no memory to replace CIS\n");
426 mutex_unlock(&s
->ops_mutex
);
429 s
->fake_cis_len
= len
;
430 memcpy(s
->fake_cis
, data
, len
);
431 dev_info(&s
->dev
, "Using replacement CIS\n");
432 mutex_unlock(&s
->ops_mutex
);
436 /*======================================================================
438 The high-level CIS tuple services
440 ======================================================================*/
442 typedef struct tuple_flags
{
449 #define LINK_SPACE(f) (((tuple_flags *)(&(f)))->link_space)
450 #define HAS_LINK(f) (((tuple_flags *)(&(f)))->has_link)
451 #define MFC_FN(f) (((tuple_flags *)(&(f)))->mfc_fn)
452 #define SPACE(f) (((tuple_flags *)(&(f)))->space)
454 int pccard_get_first_tuple(struct pcmcia_socket
*s
, unsigned int function
, tuple_t
*tuple
)
459 if (!(s
->state
& SOCKET_PRESENT
) || (s
->state
& SOCKET_CARDBUS
))
461 tuple
->TupleLink
= tuple
->Flags
= 0;
463 /* Assume presence of a LONGLINK_C to address 0 */
464 tuple
->CISOffset
= tuple
->LinkOffset
= 0;
465 SPACE(tuple
->Flags
) = HAS_LINK(tuple
->Flags
) = 1;
467 if ((s
->functions
> 1) && !(tuple
->Attributes
& TUPLE_RETURN_COMMON
)) {
468 cisdata_t req
= tuple
->DesiredTuple
;
469 tuple
->DesiredTuple
= CISTPL_LONGLINK_MFC
;
470 if (pccard_get_next_tuple(s
, function
, tuple
) == 0) {
471 tuple
->DesiredTuple
= CISTPL_LINKTARGET
;
472 if (pccard_get_next_tuple(s
, function
, tuple
) != 0)
475 tuple
->CISOffset
= tuple
->TupleLink
= 0;
476 tuple
->DesiredTuple
= req
;
478 return pccard_get_next_tuple(s
, function
, tuple
);
481 static int follow_link(struct pcmcia_socket
*s
, tuple_t
*tuple
)
487 if (MFC_FN(tuple
->Flags
)) {
488 /* Get indirect link from the MFC tuple */
489 ret
= read_cis_cache(s
, LINK_SPACE(tuple
->Flags
),
490 tuple
->LinkOffset
, 5, link
);
493 ofs
= get_unaligned_le32(link
+ 1);
494 SPACE(tuple
->Flags
) = (link
[0] == CISTPL_MFC_ATTR
);
495 /* Move to the next indirect link */
496 tuple
->LinkOffset
+= 5;
497 MFC_FN(tuple
->Flags
)--;
498 } else if (HAS_LINK(tuple
->Flags
)) {
499 ofs
= tuple
->LinkOffset
;
500 SPACE(tuple
->Flags
) = LINK_SPACE(tuple
->Flags
);
501 HAS_LINK(tuple
->Flags
) = 0;
505 if (SPACE(tuple
->Flags
)) {
506 /* This is ugly, but a common CIS error is to code the long
507 link offset incorrectly, so we check the right spot... */
508 ret
= read_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5, link
);
511 if ((link
[0] == CISTPL_LINKTARGET
) && (link
[1] >= 3) &&
512 (strncmp(link
+2, "CIS", 3) == 0))
514 remove_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5);
515 /* Then, we try the wrong spot... */
518 ret
= read_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5, link
);
521 if ((link
[0] == CISTPL_LINKTARGET
) && (link
[1] >= 3) &&
522 (strncmp(link
+2, "CIS", 3) == 0))
524 remove_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5);
528 int pccard_get_next_tuple(struct pcmcia_socket
*s
, unsigned int function
, tuple_t
*tuple
)
536 if (!(s
->state
& SOCKET_PRESENT
) || (s
->state
& SOCKET_CARDBUS
))
539 link
[1] = tuple
->TupleLink
;
540 ofs
= tuple
->CISOffset
+ tuple
->TupleLink
;
541 attr
= SPACE(tuple
->Flags
);
543 for (i
= 0; i
< MAX_TUPLES
; i
++) {
544 if (link
[1] == 0xff) {
545 link
[0] = CISTPL_END
;
547 ret
= read_cis_cache(s
, attr
, ofs
, 2, link
);
550 if (link
[0] == CISTPL_NULL
) {
555 /* End of chain? Follow long link if possible */
556 if (link
[0] == CISTPL_END
) {
557 ofs
= follow_link(s
, tuple
);
560 attr
= SPACE(tuple
->Flags
);
561 ret
= read_cis_cache(s
, attr
, ofs
, 2, link
);
566 /* Is this a link tuple? Make a note of it */
567 if ((link
[0] == CISTPL_LONGLINK_A
) ||
568 (link
[0] == CISTPL_LONGLINK_C
) ||
569 (link
[0] == CISTPL_LONGLINK_MFC
) ||
570 (link
[0] == CISTPL_LINKTARGET
) ||
571 (link
[0] == CISTPL_INDIRECT
) ||
572 (link
[0] == CISTPL_NO_LINK
)) {
574 case CISTPL_LONGLINK_A
:
575 HAS_LINK(tuple
->Flags
) = 1;
576 LINK_SPACE(tuple
->Flags
) = attr
| IS_ATTR
;
577 ret
= read_cis_cache(s
, attr
, ofs
+2, 4, &tuple
->LinkOffset
);
581 case CISTPL_LONGLINK_C
:
582 HAS_LINK(tuple
->Flags
) = 1;
583 LINK_SPACE(tuple
->Flags
) = attr
& ~IS_ATTR
;
584 ret
= read_cis_cache(s
, attr
, ofs
+2, 4, &tuple
->LinkOffset
);
588 case CISTPL_INDIRECT
:
589 HAS_LINK(tuple
->Flags
) = 1;
590 LINK_SPACE(tuple
->Flags
) = IS_ATTR
| IS_INDIRECT
;
591 tuple
->LinkOffset
= 0;
593 case CISTPL_LONGLINK_MFC
:
594 tuple
->LinkOffset
= ofs
+ 3;
595 LINK_SPACE(tuple
->Flags
) = attr
;
596 if (function
== BIND_FN_ALL
) {
597 /* Follow all the MFC links */
598 ret
= read_cis_cache(s
, attr
, ofs
+2, 1, &tmp
);
601 MFC_FN(tuple
->Flags
) = tmp
;
603 /* Follow exactly one of the links */
604 MFC_FN(tuple
->Flags
) = 1;
605 tuple
->LinkOffset
+= function
* 5;
609 HAS_LINK(tuple
->Flags
) = 0;
612 if ((tuple
->Attributes
& TUPLE_RETURN_LINK
) &&
613 (tuple
->DesiredTuple
== RETURN_FIRST_TUPLE
))
616 if (tuple
->DesiredTuple
== RETURN_FIRST_TUPLE
)
619 if (link
[0] == tuple
->DesiredTuple
)
623 if (i
== MAX_TUPLES
) {
624 dev_dbg(&s
->dev
, "cs: overrun in pcmcia_get_next_tuple\n");
628 tuple
->TupleCode
= link
[0];
629 tuple
->TupleLink
= link
[1];
630 tuple
->CISOffset
= ofs
+ 2;
634 /*====================================================================*/
636 #define _MIN(a, b) (((a) < (b)) ? (a) : (b))
638 int pccard_get_tuple_data(struct pcmcia_socket
*s
, tuple_t
*tuple
)
646 if (tuple
->TupleLink
< tuple
->TupleOffset
)
648 len
= tuple
->TupleLink
- tuple
->TupleOffset
;
649 tuple
->TupleDataLen
= tuple
->TupleLink
;
652 ret
= read_cis_cache(s
, SPACE(tuple
->Flags
),
653 tuple
->CISOffset
+ tuple
->TupleOffset
,
654 _MIN(len
, tuple
->TupleDataMax
), tuple
->TupleData
);
661 /*======================================================================
663 Parsing routines for individual tuples
665 ======================================================================*/
667 static int parse_device(tuple_t
*tuple
, cistpl_device_t
*device
)
673 p
= (u_char
*)tuple
->TupleData
;
674 q
= p
+ tuple
->TupleDataLen
;
677 for (i
= 0; i
< CISTPL_MAX_DEVICES
; i
++) {
681 device
->dev
[i
].type
= (*p
>> 4);
682 device
->dev
[i
].wp
= (*p
& 0x08) ? 1 : 0;
685 device
->dev
[i
].speed
= 0;
688 device
->dev
[i
].speed
= 250;
691 device
->dev
[i
].speed
= 200;
694 device
->dev
[i
].speed
= 150;
697 device
->dev
[i
].speed
= 100;
702 device
->dev
[i
].speed
= SPEED_CVT(*p
);
718 device
->dev
[i
].size
= ((*p
>> 3) + 1) * (512 << (scale
*2));
727 /*====================================================================*/
729 static int parse_checksum(tuple_t
*tuple
, cistpl_checksum_t
*csum
)
732 if (tuple
->TupleDataLen
< 5)
734 p
= (u_char
*) tuple
->TupleData
;
735 csum
->addr
= tuple
->CISOffset
+ get_unaligned_le16(p
) - 2;
736 csum
->len
= get_unaligned_le16(p
+ 2);
737 csum
->sum
= *(p
+ 4);
741 /*====================================================================*/
743 static int parse_longlink(tuple_t
*tuple
, cistpl_longlink_t
*link
)
745 if (tuple
->TupleDataLen
< 4)
747 link
->addr
= get_unaligned_le32(tuple
->TupleData
);
751 /*====================================================================*/
753 static int parse_longlink_mfc(tuple_t
*tuple
,
754 cistpl_longlink_mfc_t
*link
)
759 p
= (u_char
*)tuple
->TupleData
;
762 if (tuple
->TupleDataLen
<= link
->nfn
*5)
764 for (i
= 0; i
< link
->nfn
; i
++) {
765 link
->fn
[i
].space
= *p
; p
++;
766 link
->fn
[i
].addr
= get_unaligned_le32(p
);
772 /*====================================================================*/
774 static int parse_strings(u_char
*p
, u_char
*q
, int max
,
775 char *s
, u_char
*ofs
, u_char
*found
)
782 for (i
= 0; i
< max
; i
++) {
788 s
[j
++] = (*p
== 0xff) ? '\0' : *p
;
789 if ((*p
== '\0') || (*p
== 0xff))
794 if ((*p
== 0xff) || (++p
== q
))
801 return (ns
== max
) ? 0 : -EINVAL
;
805 /*====================================================================*/
807 static int parse_vers_1(tuple_t
*tuple
, cistpl_vers_1_t
*vers_1
)
811 p
= (u_char
*)tuple
->TupleData
;
812 q
= p
+ tuple
->TupleDataLen
;
814 vers_1
->major
= *p
; p
++;
815 vers_1
->minor
= *p
; p
++;
819 return parse_strings(p
, q
, CISTPL_VERS_1_MAX_PROD_STRINGS
,
820 vers_1
->str
, vers_1
->ofs
, &vers_1
->ns
);
823 /*====================================================================*/
825 static int parse_altstr(tuple_t
*tuple
, cistpl_altstr_t
*altstr
)
829 p
= (u_char
*)tuple
->TupleData
;
830 q
= p
+ tuple
->TupleDataLen
;
832 return parse_strings(p
, q
, CISTPL_MAX_ALTSTR_STRINGS
,
833 altstr
->str
, altstr
->ofs
, &altstr
->ns
);
836 /*====================================================================*/
838 static int parse_jedec(tuple_t
*tuple
, cistpl_jedec_t
*jedec
)
843 p
= (u_char
*)tuple
->TupleData
;
844 q
= p
+ tuple
->TupleDataLen
;
846 for (nid
= 0; nid
< CISTPL_MAX_DEVICES
; nid
++) {
849 jedec
->id
[nid
].mfr
= p
[0];
850 jedec
->id
[nid
].info
= p
[1];
857 /*====================================================================*/
859 static int parse_manfid(tuple_t
*tuple
, cistpl_manfid_t
*m
)
861 if (tuple
->TupleDataLen
< 4)
863 m
->manf
= get_unaligned_le16(tuple
->TupleData
);
864 m
->card
= get_unaligned_le16(tuple
->TupleData
+ 2);
868 /*====================================================================*/
870 static int parse_funcid(tuple_t
*tuple
, cistpl_funcid_t
*f
)
873 if (tuple
->TupleDataLen
< 2)
875 p
= (u_char
*)tuple
->TupleData
;
881 /*====================================================================*/
883 static int parse_funce(tuple_t
*tuple
, cistpl_funce_t
*f
)
887 if (tuple
->TupleDataLen
< 1)
889 p
= (u_char
*)tuple
->TupleData
;
891 for (i
= 1; i
< tuple
->TupleDataLen
; i
++)
896 /*====================================================================*/
898 static int parse_config(tuple_t
*tuple
, cistpl_config_t
*config
)
903 p
= (u_char
*)tuple
->TupleData
;
905 rmsz
= (*p
& 0x3c) >> 2;
906 if (tuple
->TupleDataLen
< rasz
+rmsz
+4)
908 config
->last_idx
= *(++p
);
911 for (i
= 0; i
<= rasz
; i
++)
912 config
->base
+= p
[i
] << (8*i
);
914 for (i
= 0; i
< 4; i
++)
915 config
->rmask
[i
] = 0;
916 for (i
= 0; i
<= rmsz
; i
++)
917 config
->rmask
[i
>>2] += p
[i
] << (8*(i
%4));
918 config
->subtuples
= tuple
->TupleDataLen
- (rasz
+rmsz
+4);
922 /*======================================================================
924 The following routines are all used to parse the nightmarish
925 config table entries.
927 ======================================================================*/
929 static u_char
*parse_power(u_char
*p
, u_char
*q
,
940 for (i
= 0; i
< 7; i
++)
941 if (pwr
->present
& (1<<i
)) {
944 pwr
->param
[i
] = POWER_CVT(*p
);
945 scale
= POWER_SCALE(*p
);
949 if ((*p
& 0x7f) < 100)
950 pwr
->param
[i
] += (*p
& 0x7f) * scale
/ 100;
952 pwr
->flags
|= CISTPL_POWER_HIGHZ_OK
;
956 pwr
->flags
|= CISTPL_POWER_HIGHZ_REQ
;
965 /*====================================================================*/
967 static u_char
*parse_timing(u_char
*p
, u_char
*q
,
968 cistpl_timing_t
*timing
)
975 if ((scale
& 3) != 3) {
978 timing
->wait
= SPEED_CVT(*p
);
979 timing
->waitscale
= exponent
[scale
& 3];
983 if ((scale
& 7) != 7) {
986 timing
->ready
= SPEED_CVT(*p
);
987 timing
->rdyscale
= exponent
[scale
& 7];
994 timing
->reserved
= SPEED_CVT(*p
);
995 timing
->rsvscale
= exponent
[scale
];
997 timing
->reserved
= 0;
1002 /*====================================================================*/
1004 static u_char
*parse_io(u_char
*p
, u_char
*q
, cistpl_io_t
*io
)
1014 io
->win
[0].base
= 0;
1015 io
->win
[0].len
= (1 << (io
->flags
& CISTPL_IO_LINES_MASK
));
1021 io
->nwin
= (*p
& 0x0f) + 1;
1022 bsz
= (*p
& 0x30) >> 4;
1025 lsz
= (*p
& 0xc0) >> 6;
1030 for (i
= 0; i
< io
->nwin
; i
++) {
1031 io
->win
[i
].base
= 0;
1033 for (j
= 0; j
< bsz
; j
++, p
++) {
1036 io
->win
[i
].base
+= *p
<< (j
*8);
1038 for (j
= 0; j
< lsz
; j
++, p
++) {
1041 io
->win
[i
].len
+= *p
<< (j
*8);
1047 /*====================================================================*/
1049 static u_char
*parse_mem(u_char
*p
, u_char
*q
, cistpl_mem_t
*mem
)
1051 int i
, j
, asz
, lsz
, has_ha
;
1057 mem
->nwin
= (*p
& 0x07) + 1;
1058 lsz
= (*p
& 0x18) >> 3;
1059 asz
= (*p
& 0x60) >> 5;
1060 has_ha
= (*p
& 0x80);
1064 for (i
= 0; i
< mem
->nwin
; i
++) {
1066 for (j
= 0; j
< lsz
; j
++, p
++) {
1071 for (j
= 0; j
< asz
; j
++, p
++) {
1077 for (j
= 0; j
< asz
; j
++, p
++) {
1082 mem
->win
[i
].len
= len
<< 8;
1083 mem
->win
[i
].card_addr
= ca
<< 8;
1084 mem
->win
[i
].host_addr
= ha
<< 8;
1089 /*====================================================================*/
1091 static u_char
*parse_irq(u_char
*p
, u_char
*q
, cistpl_irq_t
*irq
)
1095 irq
->IRQInfo1
= *p
; p
++;
1096 if (irq
->IRQInfo1
& IRQ_INFO2_VALID
) {
1099 irq
->IRQInfo2
= (p
[1]<<8) + p
[0];
1105 /*====================================================================*/
1107 static int parse_cftable_entry(tuple_t
*tuple
,
1108 cistpl_cftable_entry_t
*entry
)
1110 u_char
*p
, *q
, features
;
1112 p
= tuple
->TupleData
;
1113 q
= p
+ tuple
->TupleDataLen
;
1114 entry
->index
= *p
& 0x3f;
1117 entry
->flags
|= CISTPL_CFTABLE_DEFAULT
;
1122 entry
->flags
|= CISTPL_CFTABLE_BVDS
;
1124 entry
->flags
|= CISTPL_CFTABLE_WP
;
1126 entry
->flags
|= CISTPL_CFTABLE_RDYBSY
;
1128 entry
->flags
|= CISTPL_CFTABLE_MWAIT
;
1129 entry
->interface
= *p
& 0x0f;
1131 entry
->interface
= 0;
1133 /* Process optional features */
1139 if ((features
& 3) > 0) {
1140 p
= parse_power(p
, q
, &entry
->vcc
);
1144 entry
->vcc
.present
= 0;
1145 if ((features
& 3) > 1) {
1146 p
= parse_power(p
, q
, &entry
->vpp1
);
1150 entry
->vpp1
.present
= 0;
1151 if ((features
& 3) > 2) {
1152 p
= parse_power(p
, q
, &entry
->vpp2
);
1156 entry
->vpp2
.present
= 0;
1158 /* Timing options */
1159 if (features
& 0x04) {
1160 p
= parse_timing(p
, q
, &entry
->timing
);
1164 entry
->timing
.wait
= 0;
1165 entry
->timing
.ready
= 0;
1166 entry
->timing
.reserved
= 0;
1169 /* I/O window options */
1170 if (features
& 0x08) {
1171 p
= parse_io(p
, q
, &entry
->io
);
1177 /* Interrupt options */
1178 if (features
& 0x10) {
1179 p
= parse_irq(p
, q
, &entry
->irq
);
1183 entry
->irq
.IRQInfo1
= 0;
1185 switch (features
& 0x60) {
1187 entry
->mem
.nwin
= 0;
1190 entry
->mem
.nwin
= 1;
1191 entry
->mem
.win
[0].len
= get_unaligned_le16(p
) << 8;
1192 entry
->mem
.win
[0].card_addr
= 0;
1193 entry
->mem
.win
[0].host_addr
= 0;
1199 entry
->mem
.nwin
= 1;
1200 entry
->mem
.win
[0].len
= get_unaligned_le16(p
) << 8;
1201 entry
->mem
.win
[0].card_addr
= get_unaligned_le16(p
+ 2) << 8;
1202 entry
->mem
.win
[0].host_addr
= 0;
1208 p
= parse_mem(p
, q
, &entry
->mem
);
1215 if (features
& 0x80) {
1218 entry
->flags
|= (*p
<< 8);
1225 entry
->subtuples
= q
-p
;
1230 /*====================================================================*/
1232 static int parse_device_geo(tuple_t
*tuple
, cistpl_device_geo_t
*geo
)
1237 p
= (u_char
*)tuple
->TupleData
;
1238 q
= p
+ tuple
->TupleDataLen
;
1240 for (n
= 0; n
< CISTPL_MAX_DEVICES
; n
++) {
1243 geo
->geo
[n
].buswidth
= p
[0];
1244 geo
->geo
[n
].erase_block
= 1 << (p
[1]-1);
1245 geo
->geo
[n
].read_block
= 1 << (p
[2]-1);
1246 geo
->geo
[n
].write_block
= 1 << (p
[3]-1);
1247 geo
->geo
[n
].partition
= 1 << (p
[4]-1);
1248 geo
->geo
[n
].interleave
= 1 << (p
[5]-1);
1255 /*====================================================================*/
1257 static int parse_vers_2(tuple_t
*tuple
, cistpl_vers_2_t
*v2
)
1261 if (tuple
->TupleDataLen
< 10)
1264 p
= tuple
->TupleData
;
1265 q
= p
+ tuple
->TupleDataLen
;
1269 v2
->dindex
= get_unaligned_le16(p
+ 2);
1274 return parse_strings(p
, q
, 2, v2
->str
, &v2
->vendor
, NULL
);
1277 /*====================================================================*/
1279 static int parse_org(tuple_t
*tuple
, cistpl_org_t
*org
)
1284 p
= tuple
->TupleData
;
1285 q
= p
+ tuple
->TupleDataLen
;
1291 for (i
= 0; i
< 30; i
++) {
1301 /*====================================================================*/
1303 static int parse_format(tuple_t
*tuple
, cistpl_format_t
*fmt
)
1307 if (tuple
->TupleDataLen
< 10)
1310 p
= tuple
->TupleData
;
1314 fmt
->offset
= get_unaligned_le32(p
+ 2);
1315 fmt
->length
= get_unaligned_le32(p
+ 6);
1320 /*====================================================================*/
1322 int pcmcia_parse_tuple(tuple_t
*tuple
, cisparse_t
*parse
)
1326 if (tuple
->TupleDataLen
> tuple
->TupleDataMax
)
1328 switch (tuple
->TupleCode
) {
1330 case CISTPL_DEVICE_A
:
1331 ret
= parse_device(tuple
, &parse
->device
);
1333 case CISTPL_CHECKSUM
:
1334 ret
= parse_checksum(tuple
, &parse
->checksum
);
1336 case CISTPL_LONGLINK_A
:
1337 case CISTPL_LONGLINK_C
:
1338 ret
= parse_longlink(tuple
, &parse
->longlink
);
1340 case CISTPL_LONGLINK_MFC
:
1341 ret
= parse_longlink_mfc(tuple
, &parse
->longlink_mfc
);
1344 ret
= parse_vers_1(tuple
, &parse
->version_1
);
1347 ret
= parse_altstr(tuple
, &parse
->altstr
);
1349 case CISTPL_JEDEC_A
:
1350 case CISTPL_JEDEC_C
:
1351 ret
= parse_jedec(tuple
, &parse
->jedec
);
1354 ret
= parse_manfid(tuple
, &parse
->manfid
);
1357 ret
= parse_funcid(tuple
, &parse
->funcid
);
1360 ret
= parse_funce(tuple
, &parse
->funce
);
1363 ret
= parse_config(tuple
, &parse
->config
);
1365 case CISTPL_CFTABLE_ENTRY
:
1366 ret
= parse_cftable_entry(tuple
, &parse
->cftable_entry
);
1368 case CISTPL_DEVICE_GEO
:
1369 case CISTPL_DEVICE_GEO_A
:
1370 ret
= parse_device_geo(tuple
, &parse
->device_geo
);
1373 ret
= parse_vers_2(tuple
, &parse
->vers_2
);
1376 ret
= parse_org(tuple
, &parse
->org
);
1379 case CISTPL_FORMAT_A
:
1380 ret
= parse_format(tuple
, &parse
->format
);
1382 case CISTPL_NO_LINK
:
1383 case CISTPL_LINKTARGET
:
1391 pr_debug("parse_tuple failed %d\n", ret
);
1394 EXPORT_SYMBOL(pcmcia_parse_tuple
);
1396 /*======================================================================
1398 This is used internally by Card Services to look up CIS stuff.
1400 ======================================================================*/
1402 int pccard_read_tuple(struct pcmcia_socket
*s
, unsigned int function
, cisdata_t code
, void *parse
)
1408 buf
= kmalloc(256, GFP_KERNEL
);
1410 dev_printk(KERN_WARNING
, &s
->dev
, "no memory to read tuple\n");
1413 tuple
.DesiredTuple
= code
;
1414 tuple
.Attributes
= 0;
1415 if (function
== BIND_FN_ALL
)
1416 tuple
.Attributes
= TUPLE_RETURN_COMMON
;
1417 ret
= pccard_get_first_tuple(s
, function
, &tuple
);
1420 tuple
.TupleData
= buf
;
1421 tuple
.TupleOffset
= 0;
1422 tuple
.TupleDataMax
= 255;
1423 ret
= pccard_get_tuple_data(s
, &tuple
);
1426 ret
= pcmcia_parse_tuple(&tuple
, parse
);
1434 * pccard_loop_tuple() - loop over tuples in the CIS
1435 * @s: the struct pcmcia_socket where the card is inserted
1436 * @function: the device function we loop for
1437 * @code: which CIS code shall we look for?
1438 * @parse: buffer where the tuple shall be parsed (or NULL, if no parse)
1439 * @priv_data: private data to be passed to the loop_tuple function.
1440 * @loop_tuple: function to call for each CIS entry of type @function. IT
1441 * gets passed the raw tuple, the paresed tuple (if @parse is
1442 * set) and @priv_data.
1444 * pccard_loop_tuple() loops over all CIS entries of type @function, and
1445 * calls the @loop_tuple function for each entry. If the call to @loop_tuple
1446 * returns 0, the loop exits. Returns 0 on success or errorcode otherwise.
1448 int pccard_loop_tuple(struct pcmcia_socket
*s
, unsigned int function
,
1449 cisdata_t code
, cisparse_t
*parse
, void *priv_data
,
1450 int (*loop_tuple
) (tuple_t
*tuple
,
1458 buf
= kzalloc(256, GFP_KERNEL
);
1460 dev_printk(KERN_WARNING
, &s
->dev
, "no memory to read tuple\n");
1464 tuple
.TupleData
= buf
;
1465 tuple
.TupleDataMax
= 255;
1466 tuple
.TupleOffset
= 0;
1467 tuple
.DesiredTuple
= code
;
1468 tuple
.Attributes
= 0;
1470 ret
= pccard_get_first_tuple(s
, function
, &tuple
);
1472 if (pccard_get_tuple_data(s
, &tuple
))
1476 if (pcmcia_parse_tuple(&tuple
, parse
))
1479 ret
= loop_tuple(&tuple
, parse
, priv_data
);
1484 ret
= pccard_get_next_tuple(s
, function
, &tuple
);
1493 * pccard_validate_cis() - check whether card has a sensible CIS
1494 * @s: the struct pcmcia_socket we are to check
1495 * @info: returns the number of tuples in the (valid) CIS, or 0
1497 * This tries to determine if a card has a sensible CIS. In @info, it
1498 * returns the number of tuples in the CIS, or 0 if the CIS looks bad. The
1499 * checks include making sure several critical tuples are present and
1500 * valid; seeing if the total number of tuples is reasonable; and
1501 * looking for tuples that use reserved codes.
1503 * The function returns 0 on success.
1505 int pccard_validate_cis(struct pcmcia_socket
*s
, unsigned int *info
)
1509 unsigned int count
= 0;
1510 int ret
, reserved
, dev_ok
= 0, ident_ok
= 0;
1515 /* We do not want to validate the CIS cache... */
1516 mutex_lock(&s
->ops_mutex
);
1517 destroy_cis_cache(s
);
1518 mutex_unlock(&s
->ops_mutex
);
1520 tuple
= kmalloc(sizeof(*tuple
), GFP_KERNEL
);
1521 if (tuple
== NULL
) {
1522 dev_warn(&s
->dev
, "no memory to validate CIS\n");
1525 p
= kmalloc(sizeof(*p
), GFP_KERNEL
);
1528 dev_warn(&s
->dev
, "no memory to validate CIS\n");
1532 count
= reserved
= 0;
1533 tuple
->DesiredTuple
= RETURN_FIRST_TUPLE
;
1534 tuple
->Attributes
= TUPLE_RETURN_COMMON
;
1535 ret
= pccard_get_first_tuple(s
, BIND_FN_ALL
, tuple
);
1539 /* First tuple should be DEVICE; we should really have either that
1540 or a CFTABLE_ENTRY of some sort */
1541 if ((tuple
->TupleCode
== CISTPL_DEVICE
) ||
1542 (!pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_CFTABLE_ENTRY
, p
)) ||
1543 (!pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_CFTABLE_ENTRY_CB
, p
)))
1546 /* All cards should have a MANFID tuple, and/or a VERS_1 or VERS_2
1547 tuple, for card identification. Certain old D-Link and Linksys
1548 cards have only a broken VERS_2 tuple; hence the bogus test. */
1549 if ((pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_MANFID
, p
) == 0) ||
1550 (pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_VERS_1
, p
) == 0) ||
1551 (pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_VERS_2
, p
) != -ENOSPC
))
1554 if (!dev_ok
&& !ident_ok
)
1557 for (count
= 1; count
< MAX_TUPLES
; count
++) {
1558 ret
= pccard_get_next_tuple(s
, BIND_FN_ALL
, tuple
);
1561 if (((tuple
->TupleCode
> 0x23) && (tuple
->TupleCode
< 0x40)) ||
1562 ((tuple
->TupleCode
> 0x47) && (tuple
->TupleCode
< 0x80)) ||
1563 ((tuple
->TupleCode
> 0x90) && (tuple
->TupleCode
< 0xff)))
1566 if ((count
== MAX_TUPLES
) || (reserved
> 5) ||
1567 ((!dev_ok
|| !ident_ok
) && (count
> 10)))
1573 /* invalidate CIS cache on failure */
1574 if (!dev_ok
|| !ident_ok
|| !count
) {
1575 mutex_lock(&s
->ops_mutex
);
1576 destroy_cis_cache(s
);
1577 mutex_unlock(&s
->ops_mutex
);
1589 #define to_socket(_dev) container_of(_dev, struct pcmcia_socket, dev)
1591 static ssize_t
pccard_extract_cis(struct pcmcia_socket
*s
, char *buf
,
1592 loff_t off
, size_t count
)
1598 u_char
*tuplebuffer
;
1601 tuplebuffer
= kmalloc(sizeof(u_char
) * 256, GFP_KERNEL
);
1605 tempbuffer
= kmalloc(sizeof(u_char
) * 258, GFP_KERNEL
);
1611 memset(&tuple
, 0, sizeof(tuple_t
));
1613 tuple
.Attributes
= TUPLE_RETURN_LINK
| TUPLE_RETURN_COMMON
;
1614 tuple
.DesiredTuple
= RETURN_FIRST_TUPLE
;
1615 tuple
.TupleOffset
= 0;
1617 status
= pccard_get_first_tuple(s
, BIND_FN_ALL
, &tuple
);
1619 tuple
.TupleData
= tuplebuffer
;
1620 tuple
.TupleDataMax
= 255;
1621 memset(tuplebuffer
, 0, sizeof(u_char
) * 255);
1623 status
= pccard_get_tuple_data(s
, &tuple
);
1627 if (off
< (pointer
+ 2 + tuple
.TupleDataLen
)) {
1628 tempbuffer
[0] = tuple
.TupleCode
& 0xff;
1629 tempbuffer
[1] = tuple
.TupleLink
& 0xff;
1630 for (i
= 0; i
< tuple
.TupleDataLen
; i
++)
1631 tempbuffer
[i
+ 2] = tuplebuffer
[i
] & 0xff;
1633 for (i
= 0; i
< (2 + tuple
.TupleDataLen
); i
++) {
1634 if (((i
+ pointer
) >= off
) &&
1635 (i
+ pointer
) < (off
+ count
)) {
1636 buf
[ret
] = tempbuffer
[i
];
1642 pointer
+= 2 + tuple
.TupleDataLen
;
1644 if (pointer
>= (off
+ count
))
1647 if (tuple
.TupleCode
== CISTPL_END
)
1649 status
= pccard_get_next_tuple(s
, BIND_FN_ALL
, &tuple
);
1660 static ssize_t
pccard_show_cis(struct kobject
*kobj
,
1661 struct bin_attribute
*bin_attr
,
1662 char *buf
, loff_t off
, size_t count
)
1664 unsigned int size
= 0x200;
1669 struct pcmcia_socket
*s
;
1670 unsigned int chains
;
1672 if (off
+ count
> size
)
1675 s
= to_socket(container_of(kobj
, struct device
, kobj
));
1677 if (!(s
->state
& SOCKET_PRESENT
))
1679 if (pccard_validate_cis(s
, &chains
))
1684 count
= pccard_extract_cis(s
, buf
, off
, count
);
1691 static ssize_t
pccard_store_cis(struct kobject
*kobj
,
1692 struct bin_attribute
*bin_attr
,
1693 char *buf
, loff_t off
, size_t count
)
1695 struct pcmcia_socket
*s
;
1698 s
= to_socket(container_of(kobj
, struct device
, kobj
));
1703 if (count
>= CISTPL_MAX_CIS_SIZE
)
1706 if (!(s
->state
& SOCKET_PRESENT
))
1709 error
= pcmcia_replace_cis(s
, buf
, count
);
1713 pcmcia_parse_uevents(s
, PCMCIA_UEVENT_REQUERY
);
1719 struct bin_attribute pccard_cis_attr
= {
1720 .attr
= { .name
= "cis", .mode
= S_IRUGO
| S_IWUSR
},
1722 .read
= pccard_show_cis
,
1723 .write
= pccard_store_cis
,