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 if (s
->cis_mem
.flags
& MAP_ACTIVE
) {
68 s
->cis_mem
.flags
&= ~MAP_ACTIVE
;
69 s
->ops
->set_mem_map(s
, &s
->cis_mem
);
71 release_resource(s
->cis_mem
.res
);
72 kfree(s
->cis_mem
.res
);
73 s
->cis_mem
.res
= NULL
;
79 EXPORT_SYMBOL(release_cis_mem
);
82 * Map the card memory at "card_offset" into virtual space.
83 * If flags & MAP_ATTRIB, map the attribute space, otherwise
84 * map the memory space.
87 set_cis_map(struct pcmcia_socket
*s
, unsigned int card_offset
, unsigned int flags
)
89 pccard_mem_map
*mem
= &s
->cis_mem
;
92 if (!(s
->features
& SS_CAP_STATIC_MAP
) && (mem
->res
== NULL
)) {
93 mem
->res
= pcmcia_find_mem_region(0, s
->map_size
, s
->map_size
, 0, s
);
94 if (mem
->res
== NULL
) {
95 printk(KERN_NOTICE
"cs: unable to map card memory!\n");
101 if (!(s
->features
& SS_CAP_STATIC_MAP
) && (!s
->cis_virt
))
102 s
->cis_virt
= ioremap(mem
->res
->start
, s
->map_size
);
104 mem
->card_start
= card_offset
;
107 ret
= s
->ops
->set_mem_map(s
, mem
);
109 iounmap(s
->cis_virt
);
114 if (s
->features
& SS_CAP_STATIC_MAP
) {
116 iounmap(s
->cis_virt
);
117 s
->cis_virt
= ioremap(mem
->static_start
, s
->map_size
);
123 /*======================================================================
125 Low-level functions to read and write CIS memory. I think the
126 write routine is only useful for writing one-byte registers.
128 ======================================================================*/
130 /* Bits in attr field */
132 #define IS_INDIRECT 8
134 int pcmcia_read_cis_mem(struct pcmcia_socket
*s
, int attr
, u_int addr
,
135 u_int len
, void *ptr
)
137 void __iomem
*sys
, *end
;
138 unsigned char *buf
= ptr
;
140 cs_dbg(s
, 3, "pcmcia_read_cis_mem(%d, %#x, %u)\n", attr
, addr
, len
);
142 if (attr
& IS_INDIRECT
) {
143 /* Indirect accesses use a bunch of special registers at fixed
144 locations in common memory */
145 u_char flags
= ICTRL0_COMMON
|ICTRL0_AUTOINC
|ICTRL0_BYTEGRAN
;
146 if (attr
& IS_ATTR
) {
148 flags
= ICTRL0_AUTOINC
;
151 sys
= set_cis_map(s
, 0, MAP_ACTIVE
| ((cis_width
) ? MAP_16BIT
: 0));
153 memset(ptr
, 0xff, len
);
157 writeb(flags
, sys
+CISREG_ICTRL0
);
158 writeb(addr
& 0xff, sys
+CISREG_IADDR0
);
159 writeb((addr
>>8) & 0xff, sys
+CISREG_IADDR1
);
160 writeb((addr
>>16) & 0xff, sys
+CISREG_IADDR2
);
161 writeb((addr
>>24) & 0xff, sys
+CISREG_IADDR3
);
162 for ( ; len
> 0; len
--, buf
++)
163 *buf
= readb(sys
+CISREG_IDATA0
);
165 u_int inc
= 1, card_offset
, flags
;
167 flags
= MAP_ACTIVE
| ((cis_width
) ? MAP_16BIT
: 0);
174 card_offset
= addr
& ~(s
->map_size
-1);
176 sys
= set_cis_map(s
, card_offset
, flags
);
178 memset(ptr
, 0xff, len
);
181 end
= sys
+ s
->map_size
;
182 sys
= sys
+ (addr
& (s
->map_size
-1));
183 for ( ; len
> 0; len
--, buf
++, sys
+= inc
) {
188 card_offset
+= s
->map_size
;
192 cs_dbg(s
, 3, " %#2.2x %#2.2x %#2.2x %#2.2x ...\n",
193 *(u_char
*)(ptr
+0), *(u_char
*)(ptr
+1),
194 *(u_char
*)(ptr
+2), *(u_char
*)(ptr
+3));
197 EXPORT_SYMBOL(pcmcia_read_cis_mem
);
200 void pcmcia_write_cis_mem(struct pcmcia_socket
*s
, int attr
, u_int addr
,
201 u_int len
, void *ptr
)
203 void __iomem
*sys
, *end
;
204 unsigned char *buf
= ptr
;
206 cs_dbg(s
, 3, "pcmcia_write_cis_mem(%d, %#x, %u)\n", attr
, addr
, len
);
208 if (attr
& IS_INDIRECT
) {
209 /* Indirect accesses use a bunch of special registers at fixed
210 locations in common memory */
211 u_char flags
= ICTRL0_COMMON
|ICTRL0_AUTOINC
|ICTRL0_BYTEGRAN
;
212 if (attr
& IS_ATTR
) {
214 flags
= ICTRL0_AUTOINC
;
217 sys
= set_cis_map(s
, 0, MAP_ACTIVE
| ((cis_width
) ? MAP_16BIT
: 0));
219 return; /* FIXME: Error */
221 writeb(flags
, sys
+CISREG_ICTRL0
);
222 writeb(addr
& 0xff, sys
+CISREG_IADDR0
);
223 writeb((addr
>>8) & 0xff, sys
+CISREG_IADDR1
);
224 writeb((addr
>>16) & 0xff, sys
+CISREG_IADDR2
);
225 writeb((addr
>>24) & 0xff, sys
+CISREG_IADDR3
);
226 for ( ; len
> 0; len
--, buf
++)
227 writeb(*buf
, sys
+CISREG_IDATA0
);
229 u_int inc
= 1, card_offset
, flags
;
231 flags
= MAP_ACTIVE
| ((cis_width
) ? MAP_16BIT
: 0);
232 if (attr
& IS_ATTR
) {
238 card_offset
= addr
& ~(s
->map_size
-1);
240 sys
= set_cis_map(s
, card_offset
, flags
);
242 return; /* FIXME: error */
244 end
= sys
+ s
->map_size
;
245 sys
= sys
+ (addr
& (s
->map_size
-1));
246 for ( ; len
> 0; len
--, buf
++, sys
+= inc
) {
251 card_offset
+= s
->map_size
;
256 EXPORT_SYMBOL(pcmcia_write_cis_mem
);
259 /*======================================================================
261 This is a wrapper around read_cis_mem, with the same interface,
262 but which caches information, for cards whose CIS may not be
263 readable all the time.
265 ======================================================================*/
267 static void read_cis_cache(struct pcmcia_socket
*s
, int attr
, u_int addr
,
268 u_int len
, void *ptr
)
270 struct cis_cache_entry
*cis
;
274 if (s
->fake_cis_len
> addr
+len
)
275 memcpy(ptr
, s
->fake_cis
+addr
, len
);
277 memset(ptr
, 0xff, len
);
281 list_for_each_entry(cis
, &s
->cis_cache
, node
) {
282 if (cis
->addr
== addr
&& cis
->len
== len
&& cis
->attr
== attr
) {
283 memcpy(ptr
, cis
->cache
, len
);
288 #ifdef CONFIG_CARDBUS
289 if (s
->state
& SOCKET_CARDBUS
)
290 ret
= read_cb_mem(s
, attr
, addr
, len
, ptr
);
293 ret
= pcmcia_read_cis_mem(s
, attr
, addr
, len
, ptr
);
296 /* Copy data into the cache */
297 cis
= kmalloc(sizeof(struct cis_cache_entry
) + len
, GFP_KERNEL
);
302 memcpy(cis
->cache
, ptr
, len
);
303 list_add(&cis
->node
, &s
->cis_cache
);
309 remove_cis_cache(struct pcmcia_socket
*s
, int attr
, u_int addr
, u_int len
)
311 struct cis_cache_entry
*cis
;
313 list_for_each_entry(cis
, &s
->cis_cache
, node
)
314 if (cis
->addr
== addr
&& cis
->len
== len
&& cis
->attr
== attr
) {
315 list_del(&cis
->node
);
321 void destroy_cis_cache(struct pcmcia_socket
*s
)
323 struct list_head
*l
, *n
;
325 list_for_each_safe(l
, n
, &s
->cis_cache
) {
326 struct cis_cache_entry
*cis
= list_entry(l
, struct cis_cache_entry
, node
);
328 list_del(&cis
->node
);
333 * If there was a fake CIS, destroy that as well.
338 EXPORT_SYMBOL(destroy_cis_cache
);
340 /*======================================================================
342 This verifies if the CIS of a card matches what is in the CIS
345 ======================================================================*/
347 int verify_cis_cache(struct pcmcia_socket
*s
)
349 struct cis_cache_entry
*cis
;
352 buf
= kmalloc(256, GFP_KERNEL
);
355 list_for_each_entry(cis
, &s
->cis_cache
, node
) {
360 #ifdef CONFIG_CARDBUS
361 if (s
->state
& SOCKET_CARDBUS
)
362 read_cb_mem(s
, cis
->attr
, cis
->addr
, len
, buf
);
365 pcmcia_read_cis_mem(s
, cis
->attr
, cis
->addr
, len
, buf
);
367 if (memcmp(buf
, cis
->cache
, len
) != 0) {
376 /*======================================================================
378 For really bad cards, we provide a facility for uploading a
381 ======================================================================*/
383 int pcmcia_replace_cis(struct pcmcia_socket
*s
, cisdump_t
*cis
)
387 if (cis
->Length
> CISTPL_MAX_CIS_SIZE
)
389 s
->fake_cis
= kmalloc(cis
->Length
, GFP_KERNEL
);
390 if (s
->fake_cis
== NULL
)
391 return CS_OUT_OF_RESOURCE
;
392 s
->fake_cis_len
= cis
->Length
;
393 memcpy(s
->fake_cis
, cis
->Data
, cis
->Length
);
396 EXPORT_SYMBOL(pcmcia_replace_cis
);
398 /*======================================================================
400 The high-level CIS tuple services
402 ======================================================================*/
404 typedef struct tuple_flags
{
411 #define LINK_SPACE(f) (((tuple_flags *)(&(f)))->link_space)
412 #define HAS_LINK(f) (((tuple_flags *)(&(f)))->has_link)
413 #define MFC_FN(f) (((tuple_flags *)(&(f)))->mfc_fn)
414 #define SPACE(f) (((tuple_flags *)(&(f)))->space)
416 int pccard_get_next_tuple(struct pcmcia_socket
*s
, unsigned int func
, tuple_t
*tuple
);
418 int pccard_get_first_tuple(struct pcmcia_socket
*s
, unsigned int function
, tuple_t
*tuple
)
421 return CS_BAD_HANDLE
;
422 if (!(s
->state
& SOCKET_PRESENT
))
424 tuple
->TupleLink
= tuple
->Flags
= 0;
425 #ifdef CONFIG_CARDBUS
426 if (s
->state
& SOCKET_CARDBUS
) {
427 struct pci_dev
*dev
= s
->cb_dev
;
429 pci_bus_read_config_dword(dev
->subordinate
, 0, PCI_CARDBUS_CIS
, &ptr
);
430 tuple
->CISOffset
= ptr
& ~7;
431 SPACE(tuple
->Flags
) = (ptr
& 7);
435 /* Assume presence of a LONGLINK_C to address 0 */
436 tuple
->CISOffset
= tuple
->LinkOffset
= 0;
437 SPACE(tuple
->Flags
) = HAS_LINK(tuple
->Flags
) = 1;
439 if (!(s
->state
& SOCKET_CARDBUS
) && (s
->functions
> 1) &&
440 !(tuple
->Attributes
& TUPLE_RETURN_COMMON
)) {
441 cisdata_t req
= tuple
->DesiredTuple
;
442 tuple
->DesiredTuple
= CISTPL_LONGLINK_MFC
;
443 if (pccard_get_next_tuple(s
, function
, tuple
) == CS_SUCCESS
) {
444 tuple
->DesiredTuple
= CISTPL_LINKTARGET
;
445 if (pccard_get_next_tuple(s
, function
, tuple
) != CS_SUCCESS
)
446 return CS_NO_MORE_ITEMS
;
448 tuple
->CISOffset
= tuple
->TupleLink
= 0;
449 tuple
->DesiredTuple
= req
;
451 return pccard_get_next_tuple(s
, function
, tuple
);
453 EXPORT_SYMBOL(pccard_get_first_tuple
);
455 static int follow_link(struct pcmcia_socket
*s
, tuple_t
*tuple
)
460 if (MFC_FN(tuple
->Flags
)) {
461 /* Get indirect link from the MFC tuple */
462 read_cis_cache(s
, LINK_SPACE(tuple
->Flags
),
463 tuple
->LinkOffset
, 5, link
);
464 ofs
= get_unaligned_le32(link
+ 1);
465 SPACE(tuple
->Flags
) = (link
[0] == CISTPL_MFC_ATTR
);
466 /* Move to the next indirect link */
467 tuple
->LinkOffset
+= 5;
468 MFC_FN(tuple
->Flags
)--;
469 } else if (HAS_LINK(tuple
->Flags
)) {
470 ofs
= tuple
->LinkOffset
;
471 SPACE(tuple
->Flags
) = LINK_SPACE(tuple
->Flags
);
472 HAS_LINK(tuple
->Flags
) = 0;
476 if (!(s
->state
& SOCKET_CARDBUS
) && SPACE(tuple
->Flags
)) {
477 /* This is ugly, but a common CIS error is to code the long
478 link offset incorrectly, so we check the right spot... */
479 read_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5, link
);
480 if ((link
[0] == CISTPL_LINKTARGET
) && (link
[1] >= 3) &&
481 (strncmp(link
+2, "CIS", 3) == 0))
483 remove_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5);
484 /* Then, we try the wrong spot... */
487 read_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5, link
);
488 if ((link
[0] == CISTPL_LINKTARGET
) && (link
[1] >= 3) &&
489 (strncmp(link
+2, "CIS", 3) == 0))
491 remove_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5);
495 int pccard_get_next_tuple(struct pcmcia_socket
*s
, unsigned int function
, tuple_t
*tuple
)
501 return CS_BAD_HANDLE
;
502 if (!(s
->state
& SOCKET_PRESENT
))
505 link
[1] = tuple
->TupleLink
;
506 ofs
= tuple
->CISOffset
+ tuple
->TupleLink
;
507 attr
= SPACE(tuple
->Flags
);
509 for (i
= 0; i
< MAX_TUPLES
; i
++) {
510 if (link
[1] == 0xff) {
511 link
[0] = CISTPL_END
;
513 read_cis_cache(s
, attr
, ofs
, 2, link
);
514 if (link
[0] == CISTPL_NULL
) {
519 /* End of chain? Follow long link if possible */
520 if (link
[0] == CISTPL_END
) {
521 if ((ofs
= follow_link(s
, tuple
)) < 0)
522 return CS_NO_MORE_ITEMS
;
523 attr
= SPACE(tuple
->Flags
);
524 read_cis_cache(s
, attr
, ofs
, 2, link
);
527 /* Is this a link tuple? Make a note of it */
528 if ((link
[0] == CISTPL_LONGLINK_A
) ||
529 (link
[0] == CISTPL_LONGLINK_C
) ||
530 (link
[0] == CISTPL_LONGLINK_MFC
) ||
531 (link
[0] == CISTPL_LINKTARGET
) ||
532 (link
[0] == CISTPL_INDIRECT
) ||
533 (link
[0] == CISTPL_NO_LINK
)) {
535 case CISTPL_LONGLINK_A
:
536 HAS_LINK(tuple
->Flags
) = 1;
537 LINK_SPACE(tuple
->Flags
) = attr
| IS_ATTR
;
538 read_cis_cache(s
, attr
, ofs
+2, 4, &tuple
->LinkOffset
);
540 case CISTPL_LONGLINK_C
:
541 HAS_LINK(tuple
->Flags
) = 1;
542 LINK_SPACE(tuple
->Flags
) = attr
& ~IS_ATTR
;
543 read_cis_cache(s
, attr
, ofs
+2, 4, &tuple
->LinkOffset
);
545 case CISTPL_INDIRECT
:
546 HAS_LINK(tuple
->Flags
) = 1;
547 LINK_SPACE(tuple
->Flags
) = IS_ATTR
| IS_INDIRECT
;
548 tuple
->LinkOffset
= 0;
550 case CISTPL_LONGLINK_MFC
:
551 tuple
->LinkOffset
= ofs
+ 3;
552 LINK_SPACE(tuple
->Flags
) = attr
;
553 if (function
== BIND_FN_ALL
) {
554 /* Follow all the MFC links */
555 read_cis_cache(s
, attr
, ofs
+2, 1, &tmp
);
556 MFC_FN(tuple
->Flags
) = tmp
;
558 /* Follow exactly one of the links */
559 MFC_FN(tuple
->Flags
) = 1;
560 tuple
->LinkOffset
+= function
* 5;
564 HAS_LINK(tuple
->Flags
) = 0;
567 if ((tuple
->Attributes
& TUPLE_RETURN_LINK
) &&
568 (tuple
->DesiredTuple
== RETURN_FIRST_TUPLE
))
571 if (tuple
->DesiredTuple
== RETURN_FIRST_TUPLE
)
574 if (link
[0] == tuple
->DesiredTuple
)
578 if (i
== MAX_TUPLES
) {
579 cs_dbg(s
, 1, "cs: overrun in pcmcia_get_next_tuple\n");
580 return CS_NO_MORE_ITEMS
;
583 tuple
->TupleCode
= link
[0];
584 tuple
->TupleLink
= link
[1];
585 tuple
->CISOffset
= ofs
+ 2;
588 EXPORT_SYMBOL(pccard_get_next_tuple
);
590 /*====================================================================*/
592 #define _MIN(a, b) (((a) < (b)) ? (a) : (b))
594 int pccard_get_tuple_data(struct pcmcia_socket
*s
, tuple_t
*tuple
)
599 return CS_BAD_HANDLE
;
601 if (tuple
->TupleLink
< tuple
->TupleOffset
)
602 return CS_NO_MORE_ITEMS
;
603 len
= tuple
->TupleLink
- tuple
->TupleOffset
;
604 tuple
->TupleDataLen
= tuple
->TupleLink
;
607 read_cis_cache(s
, SPACE(tuple
->Flags
),
608 tuple
->CISOffset
+ tuple
->TupleOffset
,
609 _MIN(len
, tuple
->TupleDataMax
), tuple
->TupleData
);
612 EXPORT_SYMBOL(pccard_get_tuple_data
);
615 /*======================================================================
617 Parsing routines for individual tuples
619 ======================================================================*/
621 static int parse_device(tuple_t
*tuple
, cistpl_device_t
*device
)
627 p
= (u_char
*)tuple
->TupleData
;
628 q
= p
+ tuple
->TupleDataLen
;
631 for (i
= 0; i
< CISTPL_MAX_DEVICES
; i
++) {
633 if (*p
== 0xff) break;
634 device
->dev
[i
].type
= (*p
>> 4);
635 device
->dev
[i
].wp
= (*p
& 0x08) ? 1 : 0;
637 case 0: device
->dev
[i
].speed
= 0; break;
638 case 1: device
->dev
[i
].speed
= 250; break;
639 case 2: device
->dev
[i
].speed
= 200; break;
640 case 3: device
->dev
[i
].speed
= 150; break;
641 case 4: device
->dev
[i
].speed
= 100; break;
643 if (++p
== q
) return CS_BAD_TUPLE
;
644 device
->dev
[i
].speed
= SPEED_CVT(*p
);
646 if (++p
== q
) return CS_BAD_TUPLE
;
652 if (++p
== q
) return CS_BAD_TUPLE
;
653 if (*p
== 0xff) break;
655 if (scale
== 7) return CS_BAD_TUPLE
;
656 device
->dev
[i
].size
= ((*p
>> 3) + 1) * (512 << (scale
*2));
664 /*====================================================================*/
666 static int parse_checksum(tuple_t
*tuple
, cistpl_checksum_t
*csum
)
669 if (tuple
->TupleDataLen
< 5)
671 p
= (u_char
*) tuple
->TupleData
;
672 csum
->addr
= tuple
->CISOffset
+ get_unaligned_le16(p
) - 2;
673 csum
->len
= get_unaligned_le16(p
+ 2);
674 csum
->sum
= *(p
+ 4);
678 /*====================================================================*/
680 static int parse_longlink(tuple_t
*tuple
, cistpl_longlink_t
*link
)
682 if (tuple
->TupleDataLen
< 4)
684 link
->addr
= get_unaligned_le32(tuple
->TupleData
);
688 /*====================================================================*/
690 static int parse_longlink_mfc(tuple_t
*tuple
,
691 cistpl_longlink_mfc_t
*link
)
696 p
= (u_char
*)tuple
->TupleData
;
699 if (tuple
->TupleDataLen
<= link
->nfn
*5)
701 for (i
= 0; i
< link
->nfn
; i
++) {
702 link
->fn
[i
].space
= *p
; p
++;
703 link
->fn
[i
].addr
= get_unaligned_le32(p
);
709 /*====================================================================*/
711 static int parse_strings(u_char
*p
, u_char
*q
, int max
,
712 char *s
, u_char
*ofs
, u_char
*found
)
716 if (p
== q
) return CS_BAD_TUPLE
;
718 for (i
= 0; i
< max
; i
++) {
719 if (*p
== 0xff) break;
723 s
[j
++] = (*p
== 0xff) ? '\0' : *p
;
724 if ((*p
== '\0') || (*p
== 0xff)) break;
725 if (++p
== q
) return CS_BAD_TUPLE
;
727 if ((*p
== 0xff) || (++p
== q
)) break;
733 return (ns
== max
) ? CS_SUCCESS
: CS_BAD_TUPLE
;
737 /*====================================================================*/
739 static int parse_vers_1(tuple_t
*tuple
, cistpl_vers_1_t
*vers_1
)
743 p
= (u_char
*)tuple
->TupleData
;
744 q
= p
+ tuple
->TupleDataLen
;
746 vers_1
->major
= *p
; p
++;
747 vers_1
->minor
= *p
; p
++;
748 if (p
>= q
) return CS_BAD_TUPLE
;
750 return parse_strings(p
, q
, CISTPL_VERS_1_MAX_PROD_STRINGS
,
751 vers_1
->str
, vers_1
->ofs
, &vers_1
->ns
);
754 /*====================================================================*/
756 static int parse_altstr(tuple_t
*tuple
, cistpl_altstr_t
*altstr
)
760 p
= (u_char
*)tuple
->TupleData
;
761 q
= p
+ tuple
->TupleDataLen
;
763 return parse_strings(p
, q
, CISTPL_MAX_ALTSTR_STRINGS
,
764 altstr
->str
, altstr
->ofs
, &altstr
->ns
);
767 /*====================================================================*/
769 static int parse_jedec(tuple_t
*tuple
, cistpl_jedec_t
*jedec
)
774 p
= (u_char
*)tuple
->TupleData
;
775 q
= p
+ tuple
->TupleDataLen
;
777 for (nid
= 0; nid
< CISTPL_MAX_DEVICES
; nid
++) {
779 jedec
->id
[nid
].mfr
= p
[0];
780 jedec
->id
[nid
].info
= p
[1];
787 /*====================================================================*/
789 static int parse_manfid(tuple_t
*tuple
, cistpl_manfid_t
*m
)
791 if (tuple
->TupleDataLen
< 4)
793 m
->manf
= get_unaligned_le16(tuple
->TupleData
);
794 m
->card
= get_unaligned_le16(tuple
->TupleData
+ 2);
798 /*====================================================================*/
800 static int parse_funcid(tuple_t
*tuple
, cistpl_funcid_t
*f
)
803 if (tuple
->TupleDataLen
< 2)
805 p
= (u_char
*)tuple
->TupleData
;
811 /*====================================================================*/
813 static int parse_funce(tuple_t
*tuple
, cistpl_funce_t
*f
)
817 if (tuple
->TupleDataLen
< 1)
819 p
= (u_char
*)tuple
->TupleData
;
821 for (i
= 1; i
< tuple
->TupleDataLen
; i
++)
826 /*====================================================================*/
828 static int parse_config(tuple_t
*tuple
, cistpl_config_t
*config
)
833 p
= (u_char
*)tuple
->TupleData
;
835 rmsz
= (*p
& 0x3c) >> 2;
836 if (tuple
->TupleDataLen
< rasz
+rmsz
+4)
838 config
->last_idx
= *(++p
);
841 for (i
= 0; i
<= rasz
; i
++)
842 config
->base
+= p
[i
] << (8*i
);
844 for (i
= 0; i
< 4; i
++)
845 config
->rmask
[i
] = 0;
846 for (i
= 0; i
<= rmsz
; i
++)
847 config
->rmask
[i
>>2] += p
[i
] << (8*(i
%4));
848 config
->subtuples
= tuple
->TupleDataLen
- (rasz
+rmsz
+4);
852 /*======================================================================
854 The following routines are all used to parse the nightmarish
855 config table entries.
857 ======================================================================*/
859 static u_char
*parse_power(u_char
*p
, u_char
*q
,
865 if (p
== q
) return NULL
;
869 for (i
= 0; i
< 7; i
++)
870 if (pwr
->present
& (1<<i
)) {
871 if (p
== q
) return NULL
;
872 pwr
->param
[i
] = POWER_CVT(*p
);
873 scale
= POWER_SCALE(*p
);
875 if (++p
== q
) return NULL
;
876 if ((*p
& 0x7f) < 100)
877 pwr
->param
[i
] += (*p
& 0x7f) * scale
/ 100;
879 pwr
->flags
|= CISTPL_POWER_HIGHZ_OK
;
883 pwr
->flags
|= CISTPL_POWER_HIGHZ_REQ
;
892 /*====================================================================*/
894 static u_char
*parse_timing(u_char
*p
, u_char
*q
,
895 cistpl_timing_t
*timing
)
899 if (p
== q
) return NULL
;
901 if ((scale
& 3) != 3) {
902 if (++p
== q
) return NULL
;
903 timing
->wait
= SPEED_CVT(*p
);
904 timing
->waitscale
= exponent
[scale
& 3];
908 if ((scale
& 7) != 7) {
909 if (++p
== q
) return NULL
;
910 timing
->ready
= SPEED_CVT(*p
);
911 timing
->rdyscale
= exponent
[scale
& 7];
916 if (++p
== q
) return NULL
;
917 timing
->reserved
= SPEED_CVT(*p
);
918 timing
->rsvscale
= exponent
[scale
];
920 timing
->reserved
= 0;
925 /*====================================================================*/
927 static u_char
*parse_io(u_char
*p
, u_char
*q
, cistpl_io_t
*io
)
931 if (p
== q
) return NULL
;
937 io
->win
[0].len
= (1 << (io
->flags
& CISTPL_IO_LINES_MASK
));
941 if (++p
== q
) return NULL
;
942 io
->nwin
= (*p
& 0x0f) + 1;
943 bsz
= (*p
& 0x30) >> 4;
945 lsz
= (*p
& 0xc0) >> 6;
949 for (i
= 0; i
< io
->nwin
; i
++) {
952 for (j
= 0; j
< bsz
; j
++, p
++) {
953 if (p
== q
) return NULL
;
954 io
->win
[i
].base
+= *p
<< (j
*8);
956 for (j
= 0; j
< lsz
; j
++, p
++) {
957 if (p
== q
) return NULL
;
958 io
->win
[i
].len
+= *p
<< (j
*8);
964 /*====================================================================*/
966 static u_char
*parse_mem(u_char
*p
, u_char
*q
, cistpl_mem_t
*mem
)
968 int i
, j
, asz
, lsz
, has_ha
;
971 if (p
== q
) return NULL
;
973 mem
->nwin
= (*p
& 0x07) + 1;
974 lsz
= (*p
& 0x18) >> 3;
975 asz
= (*p
& 0x60) >> 5;
976 has_ha
= (*p
& 0x80);
977 if (++p
== q
) return NULL
;
979 for (i
= 0; i
< mem
->nwin
; i
++) {
981 for (j
= 0; j
< lsz
; j
++, p
++) {
982 if (p
== q
) return NULL
;
985 for (j
= 0; j
< asz
; j
++, p
++) {
986 if (p
== q
) return NULL
;
990 for (j
= 0; j
< asz
; j
++, p
++) {
991 if (p
== q
) return NULL
;
994 mem
->win
[i
].len
= len
<< 8;
995 mem
->win
[i
].card_addr
= ca
<< 8;
996 mem
->win
[i
].host_addr
= ha
<< 8;
1001 /*====================================================================*/
1003 static u_char
*parse_irq(u_char
*p
, u_char
*q
, cistpl_irq_t
*irq
)
1005 if (p
== q
) return NULL
;
1006 irq
->IRQInfo1
= *p
; p
++;
1007 if (irq
->IRQInfo1
& IRQ_INFO2_VALID
) {
1008 if (p
+2 > q
) return NULL
;
1009 irq
->IRQInfo2
= (p
[1]<<8) + p
[0];
1015 /*====================================================================*/
1017 static int parse_cftable_entry(tuple_t
*tuple
,
1018 cistpl_cftable_entry_t
*entry
)
1020 u_char
*p
, *q
, features
;
1022 p
= tuple
->TupleData
;
1023 q
= p
+ tuple
->TupleDataLen
;
1024 entry
->index
= *p
& 0x3f;
1027 entry
->flags
|= CISTPL_CFTABLE_DEFAULT
;
1029 if (++p
== q
) return CS_BAD_TUPLE
;
1031 entry
->flags
|= CISTPL_CFTABLE_BVDS
;
1033 entry
->flags
|= CISTPL_CFTABLE_WP
;
1035 entry
->flags
|= CISTPL_CFTABLE_RDYBSY
;
1037 entry
->flags
|= CISTPL_CFTABLE_MWAIT
;
1038 entry
->interface
= *p
& 0x0f;
1040 entry
->interface
= 0;
1042 /* Process optional features */
1043 if (++p
== q
) return CS_BAD_TUPLE
;
1047 if ((features
& 3) > 0) {
1048 p
= parse_power(p
, q
, &entry
->vcc
);
1049 if (p
== NULL
) return CS_BAD_TUPLE
;
1051 entry
->vcc
.present
= 0;
1052 if ((features
& 3) > 1) {
1053 p
= parse_power(p
, q
, &entry
->vpp1
);
1054 if (p
== NULL
) return CS_BAD_TUPLE
;
1056 entry
->vpp1
.present
= 0;
1057 if ((features
& 3) > 2) {
1058 p
= parse_power(p
, q
, &entry
->vpp2
);
1059 if (p
== NULL
) return CS_BAD_TUPLE
;
1061 entry
->vpp2
.present
= 0;
1063 /* Timing options */
1064 if (features
& 0x04) {
1065 p
= parse_timing(p
, q
, &entry
->timing
);
1066 if (p
== NULL
) return CS_BAD_TUPLE
;
1068 entry
->timing
.wait
= 0;
1069 entry
->timing
.ready
= 0;
1070 entry
->timing
.reserved
= 0;
1073 /* I/O window options */
1074 if (features
& 0x08) {
1075 p
= parse_io(p
, q
, &entry
->io
);
1076 if (p
== NULL
) return CS_BAD_TUPLE
;
1080 /* Interrupt options */
1081 if (features
& 0x10) {
1082 p
= parse_irq(p
, q
, &entry
->irq
);
1083 if (p
== NULL
) return CS_BAD_TUPLE
;
1085 entry
->irq
.IRQInfo1
= 0;
1087 switch (features
& 0x60) {
1089 entry
->mem
.nwin
= 0;
1092 entry
->mem
.nwin
= 1;
1093 entry
->mem
.win
[0].len
= get_unaligned_le16(p
) << 8;
1094 entry
->mem
.win
[0].card_addr
= 0;
1095 entry
->mem
.win
[0].host_addr
= 0;
1097 if (p
> q
) return CS_BAD_TUPLE
;
1100 entry
->mem
.nwin
= 1;
1101 entry
->mem
.win
[0].len
= get_unaligned_le16(p
) << 8;
1102 entry
->mem
.win
[0].card_addr
= get_unaligned_le16(p
+ 2) << 8;
1103 entry
->mem
.win
[0].host_addr
= 0;
1105 if (p
> q
) return CS_BAD_TUPLE
;
1108 p
= parse_mem(p
, q
, &entry
->mem
);
1109 if (p
== NULL
) return CS_BAD_TUPLE
;
1114 if (features
& 0x80) {
1115 if (p
== q
) return CS_BAD_TUPLE
;
1116 entry
->flags
|= (*p
<< 8);
1118 if (++p
== q
) return CS_BAD_TUPLE
;
1122 entry
->subtuples
= q
-p
;
1127 /*====================================================================*/
1129 #ifdef CONFIG_CARDBUS
1131 static int parse_bar(tuple_t
*tuple
, cistpl_bar_t
*bar
)
1134 if (tuple
->TupleDataLen
< 6)
1135 return CS_BAD_TUPLE
;
1136 p
= (u_char
*)tuple
->TupleData
;
1139 bar
->size
= get_unaligned_le32(p
);
1143 static int parse_config_cb(tuple_t
*tuple
, cistpl_config_t
*config
)
1147 p
= (u_char
*)tuple
->TupleData
;
1148 if ((*p
!= 3) || (tuple
->TupleDataLen
< 6))
1149 return CS_BAD_TUPLE
;
1150 config
->last_idx
= *(++p
);
1152 config
->base
= get_unaligned_le32(p
);
1153 config
->subtuples
= tuple
->TupleDataLen
- 6;
1157 static int parse_cftable_entry_cb(tuple_t
*tuple
,
1158 cistpl_cftable_entry_cb_t
*entry
)
1160 u_char
*p
, *q
, features
;
1162 p
= tuple
->TupleData
;
1163 q
= p
+ tuple
->TupleDataLen
;
1164 entry
->index
= *p
& 0x3f;
1167 entry
->flags
|= CISTPL_CFTABLE_DEFAULT
;
1169 /* Process optional features */
1170 if (++p
== q
) return CS_BAD_TUPLE
;
1174 if ((features
& 3) > 0) {
1175 p
= parse_power(p
, q
, &entry
->vcc
);
1176 if (p
== NULL
) return CS_BAD_TUPLE
;
1178 entry
->vcc
.present
= 0;
1179 if ((features
& 3) > 1) {
1180 p
= parse_power(p
, q
, &entry
->vpp1
);
1181 if (p
== NULL
) return CS_BAD_TUPLE
;
1183 entry
->vpp1
.present
= 0;
1184 if ((features
& 3) > 2) {
1185 p
= parse_power(p
, q
, &entry
->vpp2
);
1186 if (p
== NULL
) return CS_BAD_TUPLE
;
1188 entry
->vpp2
.present
= 0;
1190 /* I/O window options */
1191 if (features
& 0x08) {
1192 if (p
== q
) return CS_BAD_TUPLE
;
1193 entry
->io
= *p
; p
++;
1197 /* Interrupt options */
1198 if (features
& 0x10) {
1199 p
= parse_irq(p
, q
, &entry
->irq
);
1200 if (p
== NULL
) return CS_BAD_TUPLE
;
1202 entry
->irq
.IRQInfo1
= 0;
1204 if (features
& 0x20) {
1205 if (p
== q
) return CS_BAD_TUPLE
;
1206 entry
->mem
= *p
; p
++;
1211 if (features
& 0x80) {
1212 if (p
== q
) return CS_BAD_TUPLE
;
1213 entry
->flags
|= (*p
<< 8);
1215 if (++p
== q
) return CS_BAD_TUPLE
;
1216 entry
->flags
|= (*p
<< 16);
1219 if (++p
== q
) return CS_BAD_TUPLE
;
1223 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
++) {
1242 geo
->geo
[n
].buswidth
= p
[0];
1243 geo
->geo
[n
].erase_block
= 1 << (p
[1]-1);
1244 geo
->geo
[n
].read_block
= 1 << (p
[2]-1);
1245 geo
->geo
[n
].write_block
= 1 << (p
[3]-1);
1246 geo
->geo
[n
].partition
= 1 << (p
[4]-1);
1247 geo
->geo
[n
].interleave
= 1 << (p
[5]-1);
1254 /*====================================================================*/
1256 static int parse_vers_2(tuple_t
*tuple
, cistpl_vers_2_t
*v2
)
1260 if (tuple
->TupleDataLen
< 10)
1261 return CS_BAD_TUPLE
;
1263 p
= tuple
->TupleData
;
1264 q
= p
+ tuple
->TupleDataLen
;
1268 v2
->dindex
= get_unaligned_le16(p
+2 );
1273 return parse_strings(p
, q
, 2, v2
->str
, &v2
->vendor
, NULL
);
1276 /*====================================================================*/
1278 static int parse_org(tuple_t
*tuple
, cistpl_org_t
*org
)
1283 p
= tuple
->TupleData
;
1284 q
= p
+ tuple
->TupleDataLen
;
1285 if (p
== q
) return CS_BAD_TUPLE
;
1287 if (++p
== q
) return CS_BAD_TUPLE
;
1288 for (i
= 0; i
< 30; i
++) {
1290 if (*p
== '\0') break;
1291 if (++p
== q
) return CS_BAD_TUPLE
;
1296 /*====================================================================*/
1298 static int parse_format(tuple_t
*tuple
, cistpl_format_t
*fmt
)
1302 if (tuple
->TupleDataLen
< 10)
1303 return CS_BAD_TUPLE
;
1305 p
= tuple
->TupleData
;
1309 fmt
->offset
= get_unaligned_le32(p
+ 2);
1310 fmt
->length
= get_unaligned_le32(p
+ 6);
1315 /*====================================================================*/
1317 int pccard_parse_tuple(tuple_t
*tuple
, cisparse_t
*parse
)
1319 int ret
= CS_SUCCESS
;
1321 if (tuple
->TupleDataLen
> tuple
->TupleDataMax
)
1322 return CS_BAD_TUPLE
;
1323 switch (tuple
->TupleCode
) {
1325 case CISTPL_DEVICE_A
:
1326 ret
= parse_device(tuple
, &parse
->device
);
1328 #ifdef CONFIG_CARDBUS
1330 ret
= parse_bar(tuple
, &parse
->bar
);
1332 case CISTPL_CONFIG_CB
:
1333 ret
= parse_config_cb(tuple
, &parse
->config
);
1335 case CISTPL_CFTABLE_ENTRY_CB
:
1336 ret
= parse_cftable_entry_cb(tuple
, &parse
->cftable_entry_cb
);
1339 case CISTPL_CHECKSUM
:
1340 ret
= parse_checksum(tuple
, &parse
->checksum
);
1342 case CISTPL_LONGLINK_A
:
1343 case CISTPL_LONGLINK_C
:
1344 ret
= parse_longlink(tuple
, &parse
->longlink
);
1346 case CISTPL_LONGLINK_MFC
:
1347 ret
= parse_longlink_mfc(tuple
, &parse
->longlink_mfc
);
1350 ret
= parse_vers_1(tuple
, &parse
->version_1
);
1353 ret
= parse_altstr(tuple
, &parse
->altstr
);
1355 case CISTPL_JEDEC_A
:
1356 case CISTPL_JEDEC_C
:
1357 ret
= parse_jedec(tuple
, &parse
->jedec
);
1360 ret
= parse_manfid(tuple
, &parse
->manfid
);
1363 ret
= parse_funcid(tuple
, &parse
->funcid
);
1366 ret
= parse_funce(tuple
, &parse
->funce
);
1369 ret
= parse_config(tuple
, &parse
->config
);
1371 case CISTPL_CFTABLE_ENTRY
:
1372 ret
= parse_cftable_entry(tuple
, &parse
->cftable_entry
);
1374 case CISTPL_DEVICE_GEO
:
1375 case CISTPL_DEVICE_GEO_A
:
1376 ret
= parse_device_geo(tuple
, &parse
->device_geo
);
1379 ret
= parse_vers_2(tuple
, &parse
->vers_2
);
1382 ret
= parse_org(tuple
, &parse
->org
);
1385 case CISTPL_FORMAT_A
:
1386 ret
= parse_format(tuple
, &parse
->format
);
1388 case CISTPL_NO_LINK
:
1389 case CISTPL_LINKTARGET
:
1393 ret
= CS_UNSUPPORTED_FUNCTION
;
1398 EXPORT_SYMBOL(pccard_parse_tuple
);
1400 /*======================================================================
1402 This is used internally by Card Services to look up CIS stuff.
1404 ======================================================================*/
1406 int pccard_read_tuple(struct pcmcia_socket
*s
, unsigned int function
, cisdata_t code
, void *parse
)
1412 buf
= kmalloc(256, GFP_KERNEL
);
1414 return CS_OUT_OF_RESOURCE
;
1415 tuple
.DesiredTuple
= code
;
1416 tuple
.Attributes
= TUPLE_RETURN_COMMON
;
1417 ret
= pccard_get_first_tuple(s
, function
, &tuple
);
1418 if (ret
!= CS_SUCCESS
) goto done
;
1419 tuple
.TupleData
= buf
;
1420 tuple
.TupleOffset
= 0;
1421 tuple
.TupleDataMax
= 255;
1422 ret
= pccard_get_tuple_data(s
, &tuple
);
1423 if (ret
!= CS_SUCCESS
) goto done
;
1424 ret
= pccard_parse_tuple(&tuple
, parse
);
1429 EXPORT_SYMBOL(pccard_read_tuple
);
1431 /*======================================================================
1433 This tries to determine if a card has a sensible CIS. It returns
1434 the number of tuples in the CIS, or 0 if the CIS looks bad. The
1435 checks include making sure several critical tuples are present and
1436 valid; seeing if the total number of tuples is reasonable; and
1437 looking for tuples that use reserved codes.
1439 ======================================================================*/
1441 int pccard_validate_cis(struct pcmcia_socket
*s
, unsigned int function
, unsigned int *info
)
1445 unsigned int count
= 0;
1446 int ret
, reserved
, dev_ok
= 0, ident_ok
= 0;
1449 return CS_BAD_HANDLE
;
1451 tuple
= kmalloc(sizeof(*tuple
), GFP_KERNEL
);
1453 return CS_OUT_OF_RESOURCE
;
1454 p
= kmalloc(sizeof(*p
), GFP_KERNEL
);
1457 return CS_OUT_OF_RESOURCE
;
1460 count
= reserved
= 0;
1461 tuple
->DesiredTuple
= RETURN_FIRST_TUPLE
;
1462 tuple
->Attributes
= TUPLE_RETURN_COMMON
;
1463 ret
= pccard_get_first_tuple(s
, function
, tuple
);
1464 if (ret
!= CS_SUCCESS
)
1467 /* First tuple should be DEVICE; we should really have either that
1468 or a CFTABLE_ENTRY of some sort */
1469 if ((tuple
->TupleCode
== CISTPL_DEVICE
) ||
1470 (pccard_read_tuple(s
, function
, CISTPL_CFTABLE_ENTRY
, p
) == CS_SUCCESS
) ||
1471 (pccard_read_tuple(s
, function
, CISTPL_CFTABLE_ENTRY_CB
, p
) == CS_SUCCESS
))
1474 /* All cards should have a MANFID tuple, and/or a VERS_1 or VERS_2
1475 tuple, for card identification. Certain old D-Link and Linksys
1476 cards have only a broken VERS_2 tuple; hence the bogus test. */
1477 if ((pccard_read_tuple(s
, function
, CISTPL_MANFID
, p
) == CS_SUCCESS
) ||
1478 (pccard_read_tuple(s
, function
, CISTPL_VERS_1
, p
) == CS_SUCCESS
) ||
1479 (pccard_read_tuple(s
, function
, CISTPL_VERS_2
, p
) != CS_NO_MORE_ITEMS
))
1482 if (!dev_ok
&& !ident_ok
)
1485 for (count
= 1; count
< MAX_TUPLES
; count
++) {
1486 ret
= pccard_get_next_tuple(s
, function
, tuple
);
1487 if (ret
!= CS_SUCCESS
) break;
1488 if (((tuple
->TupleCode
> 0x23) && (tuple
->TupleCode
< 0x40)) ||
1489 ((tuple
->TupleCode
> 0x47) && (tuple
->TupleCode
< 0x80)) ||
1490 ((tuple
->TupleCode
> 0x90) && (tuple
->TupleCode
< 0xff)))
1493 if ((count
== MAX_TUPLES
) || (reserved
> 5) ||
1494 ((!dev_ok
|| !ident_ok
) && (count
> 10)))
1504 EXPORT_SYMBOL(pccard_validate_cis
);