1 // SPDX-License-Identifier: GPL-2.0-only
3 * cistpl.c -- 16-bit PCMCIA Card Information Structure parser
5 * The initial developer of the original code is David A. Hinds
6 * <dahinds@users.sourceforge.net>. Portions created by David A. Hinds
7 * are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
9 * (C) 1999 David A. Hinds
12 #include <linux/module.h>
13 #include <linux/moduleparam.h>
14 #include <linux/kernel.h>
15 #include <linux/string.h>
16 #include <linux/major.h>
17 #include <linux/errno.h>
18 #include <linux/timer.h>
19 #include <linux/slab.h>
21 #include <linux/pci.h>
22 #include <linux/ioport.h>
24 #include <linux/security.h>
25 #include <asm/byteorder.h>
26 #include <asm/unaligned.h>
28 #include <pcmcia/ss.h>
29 #include <pcmcia/cisreg.h>
30 #include <pcmcia/cistpl.h>
31 #include "cs_internal.h"
33 static const u_char mantissa
[] = {
34 10, 12, 13, 15, 20, 25, 30, 35,
35 40, 45, 50, 55, 60, 70, 80, 90
38 static const u_int exponent
[] = {
39 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000
42 /* Convert an extended speed byte to a time in nanoseconds */
43 #define SPEED_CVT(v) \
44 (mantissa[(((v)>>3)&15)-1] * exponent[(v)&7] / 10)
45 /* Convert a power byte to a current in 0.1 microamps */
46 #define POWER_CVT(v) \
47 (mantissa[((v)>>3)&15] * exponent[(v)&7] / 10)
48 #define POWER_SCALE(v) (exponent[(v)&7])
50 /* Upper limit on reasonable # of tuples */
51 #define MAX_TUPLES 200
53 /* Bits in IRQInfo1 field */
54 #define IRQ_INFO2_VALID 0x10
58 module_param(cis_width
, int, 0444);
60 void release_cis_mem(struct pcmcia_socket
*s
)
62 mutex_lock(&s
->ops_mutex
);
63 if (s
->cis_mem
.flags
& MAP_ACTIVE
) {
64 s
->cis_mem
.flags
&= ~MAP_ACTIVE
;
65 s
->ops
->set_mem_map(s
, &s
->cis_mem
);
67 release_resource(s
->cis_mem
.res
);
68 kfree(s
->cis_mem
.res
);
69 s
->cis_mem
.res
= NULL
;
74 mutex_unlock(&s
->ops_mutex
);
78 * set_cis_map() - map the card memory at "card_offset" into virtual space.
80 * If flags & MAP_ATTRIB, map the attribute space, otherwise
81 * map the memory space.
83 * Must be called with ops_mutex held.
85 static void __iomem
*set_cis_map(struct pcmcia_socket
*s
,
86 unsigned int card_offset
, unsigned int flags
)
88 pccard_mem_map
*mem
= &s
->cis_mem
;
91 if (!(s
->features
& SS_CAP_STATIC_MAP
) && (mem
->res
== NULL
)) {
92 mem
->res
= pcmcia_find_mem_region(0, s
->map_size
,
94 if (mem
->res
== NULL
) {
95 dev_notice(&s
->dev
, "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
);
124 /* Bits in attr field */
126 #define IS_INDIRECT 8
129 * pcmcia_read_cis_mem() - low-level function to read CIS memory
131 * must be called with ops_mutex held
133 int pcmcia_read_cis_mem(struct pcmcia_socket
*s
, int attr
, u_int addr
,
134 u_int len
, void *ptr
)
136 void __iomem
*sys
, *end
;
137 unsigned char *buf
= ptr
;
139 dev_dbg(&s
->dev
, "pcmcia_read_cis_mem(%d, %#x, %u)\n", attr
, addr
, len
);
141 if (attr
& IS_INDIRECT
) {
142 /* Indirect accesses use a bunch of special registers at fixed
143 locations in common memory */
144 u_char flags
= ICTRL0_COMMON
|ICTRL0_AUTOINC
|ICTRL0_BYTEGRAN
;
145 if (attr
& IS_ATTR
) {
147 flags
= ICTRL0_AUTOINC
;
150 sys
= set_cis_map(s
, 0, MAP_ACTIVE
|
151 ((cis_width
) ? MAP_16BIT
: 0));
153 dev_dbg(&s
->dev
, "could not map memory\n");
154 memset(ptr
, 0xff, len
);
158 writeb(flags
, sys
+CISREG_ICTRL0
);
159 writeb(addr
& 0xff, sys
+CISREG_IADDR0
);
160 writeb((addr
>>8) & 0xff, sys
+CISREG_IADDR1
);
161 writeb((addr
>>16) & 0xff, sys
+CISREG_IADDR2
);
162 writeb((addr
>>24) & 0xff, sys
+CISREG_IADDR3
);
163 for ( ; len
> 0; len
--, buf
++)
164 *buf
= readb(sys
+CISREG_IDATA0
);
166 u_int inc
= 1, card_offset
, flags
;
168 if (addr
> CISTPL_MAX_CIS_SIZE
) {
170 "attempt to read CIS mem at addr %#x", addr
);
171 memset(ptr
, 0xff, len
);
175 flags
= MAP_ACTIVE
| ((cis_width
) ? MAP_16BIT
: 0);
182 card_offset
= addr
& ~(s
->map_size
-1);
184 sys
= set_cis_map(s
, card_offset
, flags
);
186 dev_dbg(&s
->dev
, "could not map memory\n");
187 memset(ptr
, 0xff, len
);
190 end
= sys
+ s
->map_size
;
191 sys
= sys
+ (addr
& (s
->map_size
-1));
192 for ( ; len
> 0; len
--, buf
++, sys
+= inc
) {
197 card_offset
+= s
->map_size
;
201 dev_dbg(&s
->dev
, " %#2.2x %#2.2x %#2.2x %#2.2x ...\n",
202 *(u_char
*)(ptr
+0), *(u_char
*)(ptr
+1),
203 *(u_char
*)(ptr
+2), *(u_char
*)(ptr
+3));
209 * pcmcia_write_cis_mem() - low-level function to write CIS memory
211 * Probably only useful for writing one-byte registers. Must be called
212 * with ops_mutex held.
214 int pcmcia_write_cis_mem(struct pcmcia_socket
*s
, int attr
, u_int addr
,
215 u_int len
, void *ptr
)
217 void __iomem
*sys
, *end
;
218 unsigned char *buf
= ptr
;
221 "pcmcia_write_cis_mem(%d, %#x, %u)\n", attr
, addr
, len
);
223 if (attr
& IS_INDIRECT
) {
224 /* Indirect accesses use a bunch of special registers at fixed
225 locations in common memory */
226 u_char flags
= ICTRL0_COMMON
|ICTRL0_AUTOINC
|ICTRL0_BYTEGRAN
;
227 if (attr
& IS_ATTR
) {
229 flags
= ICTRL0_AUTOINC
;
232 sys
= set_cis_map(s
, 0, MAP_ACTIVE
|
233 ((cis_width
) ? MAP_16BIT
: 0));
235 dev_dbg(&s
->dev
, "could not map memory\n");
239 writeb(flags
, sys
+CISREG_ICTRL0
);
240 writeb(addr
& 0xff, sys
+CISREG_IADDR0
);
241 writeb((addr
>>8) & 0xff, sys
+CISREG_IADDR1
);
242 writeb((addr
>>16) & 0xff, sys
+CISREG_IADDR2
);
243 writeb((addr
>>24) & 0xff, sys
+CISREG_IADDR3
);
244 for ( ; len
> 0; len
--, buf
++)
245 writeb(*buf
, sys
+CISREG_IDATA0
);
247 u_int inc
= 1, card_offset
, flags
;
249 flags
= MAP_ACTIVE
| ((cis_width
) ? MAP_16BIT
: 0);
250 if (attr
& IS_ATTR
) {
256 card_offset
= addr
& ~(s
->map_size
-1);
258 sys
= set_cis_map(s
, card_offset
, flags
);
260 dev_dbg(&s
->dev
, "could not map memory\n");
264 end
= sys
+ s
->map_size
;
265 sys
= sys
+ (addr
& (s
->map_size
-1));
266 for ( ; len
> 0; len
--, buf
++, sys
+= inc
) {
271 card_offset
+= s
->map_size
;
280 * read_cis_cache() - read CIS memory or its associated cache
282 * This is a wrapper around read_cis_mem, with the same interface,
283 * but which caches information, for cards whose CIS may not be
284 * readable all the time.
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
);
315 ret
= pcmcia_read_cis_mem(s
, attr
, addr
, len
, ptr
);
318 /* Copy data into the cache */
319 cis
= kmalloc(sizeof(struct cis_cache_entry
) + len
, GFP_KERNEL
);
324 memcpy(cis
->cache
, ptr
, len
);
325 list_add(&cis
->node
, &s
->cis_cache
);
328 mutex_unlock(&s
->ops_mutex
);
334 remove_cis_cache(struct pcmcia_socket
*s
, int attr
, u_int addr
, u_int len
)
336 struct cis_cache_entry
*cis
;
338 mutex_lock(&s
->ops_mutex
);
339 list_for_each_entry(cis
, &s
->cis_cache
, node
)
340 if (cis
->addr
== addr
&& cis
->len
== len
&& cis
->attr
== attr
) {
341 list_del(&cis
->node
);
345 mutex_unlock(&s
->ops_mutex
);
349 * destroy_cis_cache() - destroy the CIS cache
350 * @s: pcmcia_socket for which CIS cache shall be destroyed
352 * This destroys the CIS cache but keeps any fake CIS alive. Must be
353 * called with ops_mutex held.
355 void destroy_cis_cache(struct pcmcia_socket
*s
)
357 struct list_head
*l
, *n
;
358 struct cis_cache_entry
*cis
;
360 list_for_each_safe(l
, n
, &s
->cis_cache
) {
361 cis
= list_entry(l
, struct cis_cache_entry
, node
);
362 list_del(&cis
->node
);
368 * verify_cis_cache() - does the CIS match what is in the CIS cache?
370 int verify_cis_cache(struct pcmcia_socket
*s
)
372 struct cis_cache_entry
*cis
;
376 if (s
->state
& SOCKET_CARDBUS
)
379 buf
= kmalloc(256, GFP_KERNEL
);
381 dev_warn(&s
->dev
, "no memory for verifying CIS\n");
384 mutex_lock(&s
->ops_mutex
);
385 list_for_each_entry(cis
, &s
->cis_cache
, node
) {
391 ret
= pcmcia_read_cis_mem(s
, cis
->attr
, cis
->addr
, len
, buf
);
392 if (ret
|| memcmp(buf
, cis
->cache
, len
) != 0) {
394 mutex_unlock(&s
->ops_mutex
);
399 mutex_unlock(&s
->ops_mutex
);
404 * pcmcia_replace_cis() - use a replacement CIS instead of the card's CIS
406 * For really bad cards, we provide a facility for uploading a
409 int pcmcia_replace_cis(struct pcmcia_socket
*s
,
410 const u8
*data
, const size_t len
)
412 if (len
> CISTPL_MAX_CIS_SIZE
) {
413 dev_warn(&s
->dev
, "replacement CIS too big\n");
416 mutex_lock(&s
->ops_mutex
);
418 s
->fake_cis
= kmalloc(len
, GFP_KERNEL
);
419 if (s
->fake_cis
== NULL
) {
420 dev_warn(&s
->dev
, "no memory to replace CIS\n");
421 mutex_unlock(&s
->ops_mutex
);
424 s
->fake_cis_len
= len
;
425 memcpy(s
->fake_cis
, data
, len
);
426 dev_info(&s
->dev
, "Using replacement CIS\n");
427 mutex_unlock(&s
->ops_mutex
);
431 /* The high-level CIS tuple services */
440 #define LINK_SPACE(f) (((struct tuple_flags *)(&(f)))->link_space)
441 #define HAS_LINK(f) (((struct tuple_flags *)(&(f)))->has_link)
442 #define MFC_FN(f) (((struct tuple_flags *)(&(f)))->mfc_fn)
443 #define SPACE(f) (((struct tuple_flags *)(&(f)))->space)
445 int pccard_get_first_tuple(struct pcmcia_socket
*s
, unsigned int function
,
451 if (!(s
->state
& SOCKET_PRESENT
) || (s
->state
& SOCKET_CARDBUS
))
453 tuple
->TupleLink
= tuple
->Flags
= 0;
455 /* Assume presence of a LONGLINK_C to address 0 */
456 tuple
->CISOffset
= tuple
->LinkOffset
= 0;
457 SPACE(tuple
->Flags
) = HAS_LINK(tuple
->Flags
) = 1;
459 if ((s
->functions
> 1) && !(tuple
->Attributes
& TUPLE_RETURN_COMMON
)) {
460 cisdata_t req
= tuple
->DesiredTuple
;
461 tuple
->DesiredTuple
= CISTPL_LONGLINK_MFC
;
462 if (pccard_get_next_tuple(s
, function
, tuple
) == 0) {
463 tuple
->DesiredTuple
= CISTPL_LINKTARGET
;
464 if (pccard_get_next_tuple(s
, function
, tuple
) != 0)
467 tuple
->CISOffset
= tuple
->TupleLink
= 0;
468 tuple
->DesiredTuple
= req
;
470 return pccard_get_next_tuple(s
, function
, tuple
);
473 static int follow_link(struct pcmcia_socket
*s
, tuple_t
*tuple
)
479 if (MFC_FN(tuple
->Flags
)) {
480 /* Get indirect link from the MFC tuple */
481 ret
= read_cis_cache(s
, LINK_SPACE(tuple
->Flags
),
482 tuple
->LinkOffset
, 5, link
);
485 ofs
= get_unaligned_le32(link
+ 1);
486 SPACE(tuple
->Flags
) = (link
[0] == CISTPL_MFC_ATTR
);
487 /* Move to the next indirect link */
488 tuple
->LinkOffset
+= 5;
489 MFC_FN(tuple
->Flags
)--;
490 } else if (HAS_LINK(tuple
->Flags
)) {
491 ofs
= tuple
->LinkOffset
;
492 SPACE(tuple
->Flags
) = LINK_SPACE(tuple
->Flags
);
493 HAS_LINK(tuple
->Flags
) = 0;
497 if (SPACE(tuple
->Flags
)) {
498 /* This is ugly, but a common CIS error is to code the long
499 link offset incorrectly, so we check the right spot... */
500 ret
= read_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5, link
);
503 if ((link
[0] == CISTPL_LINKTARGET
) && (link
[1] >= 3) &&
504 (strncmp(link
+2, "CIS", 3) == 0))
506 remove_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5);
507 /* Then, we try the wrong spot... */
510 ret
= read_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5, link
);
513 if ((link
[0] == CISTPL_LINKTARGET
) && (link
[1] >= 3) &&
514 (strncmp(link
+2, "CIS", 3) == 0))
516 remove_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5);
520 int pccard_get_next_tuple(struct pcmcia_socket
*s
, unsigned int function
,
529 if (!(s
->state
& SOCKET_PRESENT
) || (s
->state
& SOCKET_CARDBUS
))
532 link
[1] = tuple
->TupleLink
;
533 ofs
= tuple
->CISOffset
+ tuple
->TupleLink
;
534 attr
= SPACE(tuple
->Flags
);
536 for (i
= 0; i
< MAX_TUPLES
; i
++) {
538 link
[0] = CISTPL_END
;
540 ret
= read_cis_cache(s
, attr
, ofs
, 2, link
);
543 if (link
[0] == CISTPL_NULL
) {
549 /* End of chain? Follow long link if possible */
550 if (link
[0] == CISTPL_END
) {
551 ofs
= follow_link(s
, tuple
);
554 attr
= SPACE(tuple
->Flags
);
555 ret
= read_cis_cache(s
, attr
, ofs
, 2, link
);
560 /* Is this a link tuple? Make a note of it */
561 if ((link
[0] == CISTPL_LONGLINK_A
) ||
562 (link
[0] == CISTPL_LONGLINK_C
) ||
563 (link
[0] == CISTPL_LONGLINK_MFC
) ||
564 (link
[0] == CISTPL_LINKTARGET
) ||
565 (link
[0] == CISTPL_INDIRECT
) ||
566 (link
[0] == CISTPL_NO_LINK
)) {
568 case CISTPL_LONGLINK_A
:
569 HAS_LINK(tuple
->Flags
) = 1;
570 LINK_SPACE(tuple
->Flags
) = attr
| IS_ATTR
;
571 ret
= read_cis_cache(s
, attr
, ofs
+2, 4,
576 case CISTPL_LONGLINK_C
:
577 HAS_LINK(tuple
->Flags
) = 1;
578 LINK_SPACE(tuple
->Flags
) = attr
& ~IS_ATTR
;
579 ret
= read_cis_cache(s
, attr
, ofs
+2, 4,
584 case CISTPL_INDIRECT
:
585 HAS_LINK(tuple
->Flags
) = 1;
586 LINK_SPACE(tuple
->Flags
) = IS_ATTR
|
588 tuple
->LinkOffset
= 0;
590 case CISTPL_LONGLINK_MFC
:
591 tuple
->LinkOffset
= ofs
+ 3;
592 LINK_SPACE(tuple
->Flags
) = attr
;
593 if (function
== BIND_FN_ALL
) {
594 /* Follow all the MFC links */
595 ret
= read_cis_cache(s
, attr
, ofs
+2,
599 MFC_FN(tuple
->Flags
) = tmp
;
601 /* Follow exactly one of the links */
602 MFC_FN(tuple
->Flags
) = 1;
603 tuple
->LinkOffset
+= function
* 5;
607 HAS_LINK(tuple
->Flags
) = 0;
610 if ((tuple
->Attributes
& TUPLE_RETURN_LINK
) &&
611 (tuple
->DesiredTuple
== RETURN_FIRST_TUPLE
))
614 if (tuple
->DesiredTuple
== RETURN_FIRST_TUPLE
)
617 if (link
[0] == tuple
->DesiredTuple
)
621 if (i
== MAX_TUPLES
) {
622 dev_dbg(&s
->dev
, "cs: overrun in pcmcia_get_next_tuple\n");
626 tuple
->TupleCode
= link
[0];
627 tuple
->TupleLink
= link
[1];
628 tuple
->CISOffset
= ofs
+ 2;
632 int pccard_get_tuple_data(struct pcmcia_socket
*s
, tuple_t
*tuple
)
640 if (tuple
->TupleLink
< tuple
->TupleOffset
)
642 len
= tuple
->TupleLink
- tuple
->TupleOffset
;
643 tuple
->TupleDataLen
= tuple
->TupleLink
;
646 ret
= read_cis_cache(s
, SPACE(tuple
->Flags
),
647 tuple
->CISOffset
+ tuple
->TupleOffset
,
648 min(len
, (u_int
) tuple
->TupleDataMax
),
656 /* Parsing routines for individual tuples */
658 static int parse_device(tuple_t
*tuple
, cistpl_device_t
*device
)
664 p
= (u_char
*)tuple
->TupleData
;
665 q
= p
+ tuple
->TupleDataLen
;
668 for (i
= 0; i
< CISTPL_MAX_DEVICES
; i
++) {
672 device
->dev
[i
].type
= (*p
>> 4);
673 device
->dev
[i
].wp
= (*p
& 0x08) ? 1 : 0;
676 device
->dev
[i
].speed
= 0;
679 device
->dev
[i
].speed
= 250;
682 device
->dev
[i
].speed
= 200;
685 device
->dev
[i
].speed
= 150;
688 device
->dev
[i
].speed
= 100;
693 device
->dev
[i
].speed
= SPEED_CVT(*p
);
709 device
->dev
[i
].size
= ((*p
>> 3) + 1) * (512 << (scale
*2));
719 static int parse_checksum(tuple_t
*tuple
, cistpl_checksum_t
*csum
)
722 if (tuple
->TupleDataLen
< 5)
724 p
= (u_char
*) tuple
->TupleData
;
725 csum
->addr
= tuple
->CISOffset
+ get_unaligned_le16(p
) - 2;
726 csum
->len
= get_unaligned_le16(p
+ 2);
727 csum
->sum
= *(p
+ 4);
732 static int parse_longlink(tuple_t
*tuple
, cistpl_longlink_t
*link
)
734 if (tuple
->TupleDataLen
< 4)
736 link
->addr
= get_unaligned_le32(tuple
->TupleData
);
741 static int parse_longlink_mfc(tuple_t
*tuple
, cistpl_longlink_mfc_t
*link
)
746 p
= (u_char
*)tuple
->TupleData
;
749 if (tuple
->TupleDataLen
<= link
->nfn
*5)
751 for (i
= 0; i
< link
->nfn
; i
++) {
752 link
->fn
[i
].space
= *p
; p
++;
753 link
->fn
[i
].addr
= get_unaligned_le32(p
);
760 static int parse_strings(u_char
*p
, u_char
*q
, int max
,
761 char *s
, u_char
*ofs
, u_char
*found
)
768 for (i
= 0; i
< max
; i
++) {
774 s
[j
++] = (*p
== 0xff) ? '\0' : *p
;
775 if ((*p
== '\0') || (*p
== 0xff))
780 if ((*p
== 0xff) || (++p
== q
))
788 return (ns
== max
) ? 0 : -EINVAL
;
792 static int parse_vers_1(tuple_t
*tuple
, cistpl_vers_1_t
*vers_1
)
796 p
= (u_char
*)tuple
->TupleData
;
797 q
= p
+ tuple
->TupleDataLen
;
799 vers_1
->major
= *p
; p
++;
800 vers_1
->minor
= *p
; p
++;
804 return parse_strings(p
, q
, CISTPL_VERS_1_MAX_PROD_STRINGS
,
805 vers_1
->str
, vers_1
->ofs
, &vers_1
->ns
);
809 static int parse_altstr(tuple_t
*tuple
, cistpl_altstr_t
*altstr
)
813 p
= (u_char
*)tuple
->TupleData
;
814 q
= p
+ tuple
->TupleDataLen
;
816 return parse_strings(p
, q
, CISTPL_MAX_ALTSTR_STRINGS
,
817 altstr
->str
, altstr
->ofs
, &altstr
->ns
);
821 static int parse_jedec(tuple_t
*tuple
, cistpl_jedec_t
*jedec
)
826 p
= (u_char
*)tuple
->TupleData
;
827 q
= p
+ tuple
->TupleDataLen
;
829 for (nid
= 0; nid
< CISTPL_MAX_DEVICES
; nid
++) {
832 jedec
->id
[nid
].mfr
= p
[0];
833 jedec
->id
[nid
].info
= p
[1];
841 static int parse_manfid(tuple_t
*tuple
, cistpl_manfid_t
*m
)
843 if (tuple
->TupleDataLen
< 4)
845 m
->manf
= get_unaligned_le16(tuple
->TupleData
);
846 m
->card
= get_unaligned_le16(tuple
->TupleData
+ 2);
851 static int parse_funcid(tuple_t
*tuple
, cistpl_funcid_t
*f
)
854 if (tuple
->TupleDataLen
< 2)
856 p
= (u_char
*)tuple
->TupleData
;
863 static int parse_funce(tuple_t
*tuple
, cistpl_funce_t
*f
)
867 if (tuple
->TupleDataLen
< 1)
869 p
= (u_char
*)tuple
->TupleData
;
871 for (i
= 1; i
< tuple
->TupleDataLen
; i
++)
877 static int parse_config(tuple_t
*tuple
, cistpl_config_t
*config
)
882 p
= (u_char
*)tuple
->TupleData
;
884 rmsz
= (*p
& 0x3c) >> 2;
885 if (tuple
->TupleDataLen
< rasz
+rmsz
+4)
887 config
->last_idx
= *(++p
);
890 for (i
= 0; i
<= rasz
; i
++)
891 config
->base
+= p
[i
] << (8*i
);
893 for (i
= 0; i
< 4; i
++)
894 config
->rmask
[i
] = 0;
895 for (i
= 0; i
<= rmsz
; i
++)
896 config
->rmask
[i
>>2] += p
[i
] << (8*(i
%4));
897 config
->subtuples
= tuple
->TupleDataLen
- (rasz
+rmsz
+4);
901 /* The following routines are all used to parse the nightmarish
902 * config table entries.
905 static u_char
*parse_power(u_char
*p
, u_char
*q
, cistpl_power_t
*pwr
)
915 for (i
= 0; i
< 7; i
++)
916 if (pwr
->present
& (1<<i
)) {
919 pwr
->param
[i
] = POWER_CVT(*p
);
920 scale
= POWER_SCALE(*p
);
924 if ((*p
& 0x7f) < 100)
926 (*p
& 0x7f) * scale
/ 100;
928 pwr
->flags
|= CISTPL_POWER_HIGHZ_OK
;
932 pwr
->flags
|= CISTPL_POWER_HIGHZ_REQ
;
942 static u_char
*parse_timing(u_char
*p
, u_char
*q
, cistpl_timing_t
*timing
)
949 if ((scale
& 3) != 3) {
952 timing
->wait
= SPEED_CVT(*p
);
953 timing
->waitscale
= exponent
[scale
& 3];
957 if ((scale
& 7) != 7) {
960 timing
->ready
= SPEED_CVT(*p
);
961 timing
->rdyscale
= exponent
[scale
& 7];
968 timing
->reserved
= SPEED_CVT(*p
);
969 timing
->rsvscale
= exponent
[scale
];
971 timing
->reserved
= 0;
977 static u_char
*parse_io(u_char
*p
, u_char
*q
, cistpl_io_t
*io
)
988 io
->win
[0].len
= (1 << (io
->flags
& CISTPL_IO_LINES_MASK
));
994 io
->nwin
= (*p
& 0x0f) + 1;
995 bsz
= (*p
& 0x30) >> 4;
998 lsz
= (*p
& 0xc0) >> 6;
1003 for (i
= 0; i
< io
->nwin
; i
++) {
1004 io
->win
[i
].base
= 0;
1006 for (j
= 0; j
< bsz
; j
++, p
++) {
1009 io
->win
[i
].base
+= *p
<< (j
*8);
1011 for (j
= 0; j
< lsz
; j
++, p
++) {
1014 io
->win
[i
].len
+= *p
<< (j
*8);
1021 static u_char
*parse_mem(u_char
*p
, u_char
*q
, cistpl_mem_t
*mem
)
1023 int i
, j
, asz
, lsz
, has_ha
;
1029 mem
->nwin
= (*p
& 0x07) + 1;
1030 lsz
= (*p
& 0x18) >> 3;
1031 asz
= (*p
& 0x60) >> 5;
1032 has_ha
= (*p
& 0x80);
1036 for (i
= 0; i
< mem
->nwin
; i
++) {
1038 for (j
= 0; j
< lsz
; j
++, p
++) {
1043 for (j
= 0; j
< asz
; j
++, p
++) {
1049 for (j
= 0; j
< asz
; j
++, p
++) {
1054 mem
->win
[i
].len
= len
<< 8;
1055 mem
->win
[i
].card_addr
= ca
<< 8;
1056 mem
->win
[i
].host_addr
= ha
<< 8;
1062 static u_char
*parse_irq(u_char
*p
, u_char
*q
, cistpl_irq_t
*irq
)
1066 irq
->IRQInfo1
= *p
; p
++;
1067 if (irq
->IRQInfo1
& IRQ_INFO2_VALID
) {
1070 irq
->IRQInfo2
= (p
[1]<<8) + p
[0];
1077 static int parse_cftable_entry(tuple_t
*tuple
,
1078 cistpl_cftable_entry_t
*entry
)
1080 u_char
*p
, *q
, features
;
1082 p
= tuple
->TupleData
;
1083 q
= p
+ tuple
->TupleDataLen
;
1084 entry
->index
= *p
& 0x3f;
1087 entry
->flags
|= CISTPL_CFTABLE_DEFAULT
;
1092 entry
->flags
|= CISTPL_CFTABLE_BVDS
;
1094 entry
->flags
|= CISTPL_CFTABLE_WP
;
1096 entry
->flags
|= CISTPL_CFTABLE_RDYBSY
;
1098 entry
->flags
|= CISTPL_CFTABLE_MWAIT
;
1099 entry
->interface
= *p
& 0x0f;
1101 entry
->interface
= 0;
1103 /* Process optional features */
1109 if ((features
& 3) > 0) {
1110 p
= parse_power(p
, q
, &entry
->vcc
);
1114 entry
->vcc
.present
= 0;
1115 if ((features
& 3) > 1) {
1116 p
= parse_power(p
, q
, &entry
->vpp1
);
1120 entry
->vpp1
.present
= 0;
1121 if ((features
& 3) > 2) {
1122 p
= parse_power(p
, q
, &entry
->vpp2
);
1126 entry
->vpp2
.present
= 0;
1128 /* Timing options */
1129 if (features
& 0x04) {
1130 p
= parse_timing(p
, q
, &entry
->timing
);
1134 entry
->timing
.wait
= 0;
1135 entry
->timing
.ready
= 0;
1136 entry
->timing
.reserved
= 0;
1139 /* I/O window options */
1140 if (features
& 0x08) {
1141 p
= parse_io(p
, q
, &entry
->io
);
1147 /* Interrupt options */
1148 if (features
& 0x10) {
1149 p
= parse_irq(p
, q
, &entry
->irq
);
1153 entry
->irq
.IRQInfo1
= 0;
1155 switch (features
& 0x60) {
1157 entry
->mem
.nwin
= 0;
1160 entry
->mem
.nwin
= 1;
1161 entry
->mem
.win
[0].len
= get_unaligned_le16(p
) << 8;
1162 entry
->mem
.win
[0].card_addr
= 0;
1163 entry
->mem
.win
[0].host_addr
= 0;
1169 entry
->mem
.nwin
= 1;
1170 entry
->mem
.win
[0].len
= get_unaligned_le16(p
) << 8;
1171 entry
->mem
.win
[0].card_addr
= get_unaligned_le16(p
+ 2) << 8;
1172 entry
->mem
.win
[0].host_addr
= 0;
1178 p
= parse_mem(p
, q
, &entry
->mem
);
1185 if (features
& 0x80) {
1188 entry
->flags
|= (*p
<< 8);
1195 entry
->subtuples
= q
-p
;
1201 static int parse_device_geo(tuple_t
*tuple
, cistpl_device_geo_t
*geo
)
1206 p
= (u_char
*)tuple
->TupleData
;
1207 q
= p
+ tuple
->TupleDataLen
;
1209 for (n
= 0; n
< CISTPL_MAX_DEVICES
; n
++) {
1212 geo
->geo
[n
].buswidth
= p
[0];
1213 geo
->geo
[n
].erase_block
= 1 << (p
[1]-1);
1214 geo
->geo
[n
].read_block
= 1 << (p
[2]-1);
1215 geo
->geo
[n
].write_block
= 1 << (p
[3]-1);
1216 geo
->geo
[n
].partition
= 1 << (p
[4]-1);
1217 geo
->geo
[n
].interleave
= 1 << (p
[5]-1);
1225 static int parse_vers_2(tuple_t
*tuple
, cistpl_vers_2_t
*v2
)
1229 if (tuple
->TupleDataLen
< 10)
1232 p
= tuple
->TupleData
;
1233 q
= p
+ tuple
->TupleDataLen
;
1237 v2
->dindex
= get_unaligned_le16(p
+ 2);
1242 return parse_strings(p
, q
, 2, v2
->str
, &v2
->vendor
, NULL
);
1246 static int parse_org(tuple_t
*tuple
, cistpl_org_t
*org
)
1251 p
= tuple
->TupleData
;
1252 q
= p
+ tuple
->TupleDataLen
;
1258 for (i
= 0; i
< 30; i
++) {
1269 static int parse_format(tuple_t
*tuple
, cistpl_format_t
*fmt
)
1273 if (tuple
->TupleDataLen
< 10)
1276 p
= tuple
->TupleData
;
1280 fmt
->offset
= get_unaligned_le32(p
+ 2);
1281 fmt
->length
= get_unaligned_le32(p
+ 6);
1287 int pcmcia_parse_tuple(tuple_t
*tuple
, cisparse_t
*parse
)
1291 if (tuple
->TupleDataLen
> tuple
->TupleDataMax
)
1293 switch (tuple
->TupleCode
) {
1295 case CISTPL_DEVICE_A
:
1296 ret
= parse_device(tuple
, &parse
->device
);
1298 case CISTPL_CHECKSUM
:
1299 ret
= parse_checksum(tuple
, &parse
->checksum
);
1301 case CISTPL_LONGLINK_A
:
1302 case CISTPL_LONGLINK_C
:
1303 ret
= parse_longlink(tuple
, &parse
->longlink
);
1305 case CISTPL_LONGLINK_MFC
:
1306 ret
= parse_longlink_mfc(tuple
, &parse
->longlink_mfc
);
1309 ret
= parse_vers_1(tuple
, &parse
->version_1
);
1312 ret
= parse_altstr(tuple
, &parse
->altstr
);
1314 case CISTPL_JEDEC_A
:
1315 case CISTPL_JEDEC_C
:
1316 ret
= parse_jedec(tuple
, &parse
->jedec
);
1319 ret
= parse_manfid(tuple
, &parse
->manfid
);
1322 ret
= parse_funcid(tuple
, &parse
->funcid
);
1325 ret
= parse_funce(tuple
, &parse
->funce
);
1328 ret
= parse_config(tuple
, &parse
->config
);
1330 case CISTPL_CFTABLE_ENTRY
:
1331 ret
= parse_cftable_entry(tuple
, &parse
->cftable_entry
);
1333 case CISTPL_DEVICE_GEO
:
1334 case CISTPL_DEVICE_GEO_A
:
1335 ret
= parse_device_geo(tuple
, &parse
->device_geo
);
1338 ret
= parse_vers_2(tuple
, &parse
->vers_2
);
1341 ret
= parse_org(tuple
, &parse
->org
);
1344 case CISTPL_FORMAT_A
:
1345 ret
= parse_format(tuple
, &parse
->format
);
1347 case CISTPL_NO_LINK
:
1348 case CISTPL_LINKTARGET
:
1356 pr_debug("parse_tuple failed %d\n", ret
);
1359 EXPORT_SYMBOL(pcmcia_parse_tuple
);
1363 * pccard_validate_cis() - check whether card has a sensible CIS
1364 * @s: the struct pcmcia_socket we are to check
1365 * @info: returns the number of tuples in the (valid) CIS, or 0
1367 * This tries to determine if a card has a sensible CIS. In @info, it
1368 * returns the number of tuples in the CIS, or 0 if the CIS looks bad. The
1369 * checks include making sure several critical tuples are present and
1370 * valid; seeing if the total number of tuples is reasonable; and
1371 * looking for tuples that use reserved codes.
1373 * The function returns 0 on success.
1375 int pccard_validate_cis(struct pcmcia_socket
*s
, unsigned int *info
)
1379 unsigned int count
= 0;
1380 int ret
, reserved
, dev_ok
= 0, ident_ok
= 0;
1385 if (s
->functions
|| !(s
->state
& SOCKET_PRESENT
)) {
1390 /* We do not want to validate the CIS cache... */
1391 mutex_lock(&s
->ops_mutex
);
1392 destroy_cis_cache(s
);
1393 mutex_unlock(&s
->ops_mutex
);
1395 tuple
= kmalloc(sizeof(*tuple
), GFP_KERNEL
);
1396 if (tuple
== NULL
) {
1397 dev_warn(&s
->dev
, "no memory to validate CIS\n");
1400 p
= kmalloc(sizeof(*p
), GFP_KERNEL
);
1403 dev_warn(&s
->dev
, "no memory to validate CIS\n");
1407 count
= reserved
= 0;
1408 tuple
->DesiredTuple
= RETURN_FIRST_TUPLE
;
1409 tuple
->Attributes
= TUPLE_RETURN_COMMON
;
1410 ret
= pccard_get_first_tuple(s
, BIND_FN_ALL
, tuple
);
1414 /* First tuple should be DEVICE; we should really have either that
1415 or a CFTABLE_ENTRY of some sort */
1416 if ((tuple
->TupleCode
== CISTPL_DEVICE
) ||
1417 (!pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_CFTABLE_ENTRY
, p
)) ||
1418 (!pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_CFTABLE_ENTRY_CB
, p
)))
1421 /* All cards should have a MANFID tuple, and/or a VERS_1 or VERS_2
1422 tuple, for card identification. Certain old D-Link and Linksys
1423 cards have only a broken VERS_2 tuple; hence the bogus test. */
1424 if ((pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_MANFID
, p
) == 0) ||
1425 (pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_VERS_1
, p
) == 0) ||
1426 (pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_VERS_2
, p
) != -ENOSPC
))
1429 if (!dev_ok
&& !ident_ok
)
1432 for (count
= 1; count
< MAX_TUPLES
; count
++) {
1433 ret
= pccard_get_next_tuple(s
, BIND_FN_ALL
, tuple
);
1436 if (((tuple
->TupleCode
> 0x23) && (tuple
->TupleCode
< 0x40)) ||
1437 ((tuple
->TupleCode
> 0x47) && (tuple
->TupleCode
< 0x80)) ||
1438 ((tuple
->TupleCode
> 0x90) && (tuple
->TupleCode
< 0xff)))
1441 if ((count
== MAX_TUPLES
) || (reserved
> 5) ||
1442 ((!dev_ok
|| !ident_ok
) && (count
> 10)))
1448 /* invalidate CIS cache on failure */
1449 if (!dev_ok
|| !ident_ok
|| !count
) {
1450 mutex_lock(&s
->ops_mutex
);
1451 destroy_cis_cache(s
);
1452 mutex_unlock(&s
->ops_mutex
);
1453 /* We differentiate between dev_ok, ident_ok and count
1454 failures to allow for an override for anonymous cards
1456 if (!dev_ok
|| !ident_ok
)
1470 #define to_socket(_dev) container_of(_dev, struct pcmcia_socket, dev)
1472 static ssize_t
pccard_extract_cis(struct pcmcia_socket
*s
, char *buf
,
1473 loff_t off
, size_t count
)
1479 u_char
*tuplebuffer
;
1482 tuplebuffer
= kmalloc_array(256, sizeof(u_char
), GFP_KERNEL
);
1486 tempbuffer
= kmalloc_array(258, sizeof(u_char
), GFP_KERNEL
);
1492 memset(&tuple
, 0, sizeof(tuple_t
));
1494 tuple
.Attributes
= TUPLE_RETURN_LINK
| TUPLE_RETURN_COMMON
;
1495 tuple
.DesiredTuple
= RETURN_FIRST_TUPLE
;
1496 tuple
.TupleOffset
= 0;
1498 status
= pccard_get_first_tuple(s
, BIND_FN_ALL
, &tuple
);
1500 tuple
.TupleData
= tuplebuffer
;
1501 tuple
.TupleDataMax
= 255;
1502 memset(tuplebuffer
, 0, sizeof(u_char
) * 255);
1504 status
= pccard_get_tuple_data(s
, &tuple
);
1508 if (off
< (pointer
+ 2 + tuple
.TupleDataLen
)) {
1509 tempbuffer
[0] = tuple
.TupleCode
& 0xff;
1510 tempbuffer
[1] = tuple
.TupleLink
& 0xff;
1511 for (i
= 0; i
< tuple
.TupleDataLen
; i
++)
1512 tempbuffer
[i
+ 2] = tuplebuffer
[i
] & 0xff;
1514 for (i
= 0; i
< (2 + tuple
.TupleDataLen
); i
++) {
1515 if (((i
+ pointer
) >= off
) &&
1516 (i
+ pointer
) < (off
+ count
)) {
1517 buf
[ret
] = tempbuffer
[i
];
1523 pointer
+= 2 + tuple
.TupleDataLen
;
1525 if (pointer
>= (off
+ count
))
1528 if (tuple
.TupleCode
== CISTPL_END
)
1530 status
= pccard_get_next_tuple(s
, BIND_FN_ALL
, &tuple
);
1541 static ssize_t
pccard_show_cis(struct file
*filp
, struct kobject
*kobj
,
1542 struct bin_attribute
*bin_attr
,
1543 char *buf
, loff_t off
, size_t count
)
1545 unsigned int size
= 0x200;
1550 struct pcmcia_socket
*s
;
1551 unsigned int chains
= 1;
1553 if (off
+ count
> size
)
1556 s
= to_socket(container_of(kobj
, struct device
, kobj
));
1558 if (!(s
->state
& SOCKET_PRESENT
))
1560 if (!s
->functions
&& pccard_validate_cis(s
, &chains
))
1565 count
= pccard_extract_cis(s
, buf
, off
, count
);
1572 static ssize_t
pccard_store_cis(struct file
*filp
, struct kobject
*kobj
,
1573 struct bin_attribute
*bin_attr
,
1574 char *buf
, loff_t off
, size_t count
)
1576 struct pcmcia_socket
*s
;
1579 error
= security_locked_down(LOCKDOWN_PCMCIA_CIS
);
1583 s
= to_socket(container_of(kobj
, struct device
, kobj
));
1588 if (count
>= CISTPL_MAX_CIS_SIZE
)
1591 if (!(s
->state
& SOCKET_PRESENT
))
1594 error
= pcmcia_replace_cis(s
, buf
, count
);
1598 pcmcia_parse_uevents(s
, PCMCIA_UEVENT_REQUERY
);
1604 const struct bin_attribute pccard_cis_attr
= {
1605 .attr
= { .name
= "cis", .mode
= S_IRUGO
| S_IWUSR
},
1607 .read
= pccard_show_cis
,
1608 .write
= pccard_store_cis
,