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 <pcmcia/ds.h>
32 #include "cs_internal.h"
34 static const u_char mantissa
[] = {
35 10, 12, 13, 15, 20, 25, 30, 35,
36 40, 45, 50, 55, 60, 70, 80, 90
39 static const u_int exponent
[] = {
40 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000
43 /* Convert an extended speed byte to a time in nanoseconds */
44 #define SPEED_CVT(v) \
45 (mantissa[(((v)>>3)&15)-1] * exponent[(v)&7] / 10)
46 /* Convert a power byte to a current in 0.1 microamps */
47 #define POWER_CVT(v) \
48 (mantissa[((v)>>3)&15] * exponent[(v)&7] / 10)
49 #define POWER_SCALE(v) (exponent[(v)&7])
51 /* Upper limit on reasonable # of tuples */
52 #define MAX_TUPLES 200
54 /* Bits in IRQInfo1 field */
55 #define IRQ_INFO2_VALID 0x10
59 module_param(cis_width
, int, 0444);
61 void release_cis_mem(struct pcmcia_socket
*s
)
63 mutex_lock(&s
->ops_mutex
);
64 if (s
->cis_mem
.flags
& MAP_ACTIVE
) {
65 s
->cis_mem
.flags
&= ~MAP_ACTIVE
;
66 s
->ops
->set_mem_map(s
, &s
->cis_mem
);
68 release_resource(s
->cis_mem
.res
);
69 kfree(s
->cis_mem
.res
);
70 s
->cis_mem
.res
= NULL
;
75 mutex_unlock(&s
->ops_mutex
);
79 * set_cis_map() - map the card memory at "card_offset" into virtual space.
81 * If flags & MAP_ATTRIB, map the attribute space, otherwise
82 * map the memory space.
84 * Must be called with ops_mutex held.
86 static void __iomem
*set_cis_map(struct pcmcia_socket
*s
,
87 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
,
95 if (mem
->res
== NULL
) {
96 dev_notice(&s
->dev
, "cs: unable to map card memory!\n");
102 if (!(s
->features
& SS_CAP_STATIC_MAP
) && (!s
->cis_virt
))
103 s
->cis_virt
= ioremap(mem
->res
->start
, s
->map_size
);
105 mem
->card_start
= card_offset
;
108 ret
= s
->ops
->set_mem_map(s
, mem
);
110 iounmap(s
->cis_virt
);
115 if (s
->features
& SS_CAP_STATIC_MAP
) {
117 iounmap(s
->cis_virt
);
118 s
->cis_virt
= ioremap(mem
->static_start
, s
->map_size
);
125 /* Bits in attr field */
127 #define IS_INDIRECT 8
130 * pcmcia_read_cis_mem() - low-level function to read CIS memory
132 * must be called with ops_mutex held
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 dev_dbg(&s
->dev
, "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
|
152 ((cis_width
) ? MAP_16BIT
: 0));
154 dev_dbg(&s
->dev
, "could not map memory\n");
155 memset(ptr
, 0xff, len
);
159 writeb(flags
, sys
+CISREG_ICTRL0
);
160 writeb(addr
& 0xff, sys
+CISREG_IADDR0
);
161 writeb((addr
>>8) & 0xff, sys
+CISREG_IADDR1
);
162 writeb((addr
>>16) & 0xff, sys
+CISREG_IADDR2
);
163 writeb((addr
>>24) & 0xff, sys
+CISREG_IADDR3
);
164 for ( ; len
> 0; len
--, buf
++)
165 *buf
= readb(sys
+CISREG_IDATA0
);
167 u_int inc
= 1, card_offset
, flags
;
169 if (addr
> CISTPL_MAX_CIS_SIZE
) {
171 "attempt to read CIS mem at addr %#x", addr
);
172 memset(ptr
, 0xff, len
);
176 flags
= MAP_ACTIVE
| ((cis_width
) ? MAP_16BIT
: 0);
183 card_offset
= addr
& ~(s
->map_size
-1);
185 sys
= set_cis_map(s
, card_offset
, flags
);
187 dev_dbg(&s
->dev
, "could not map memory\n");
188 memset(ptr
, 0xff, len
);
191 end
= sys
+ s
->map_size
;
192 sys
= sys
+ (addr
& (s
->map_size
-1));
193 for ( ; len
> 0; len
--, buf
++, sys
+= inc
) {
198 card_offset
+= s
->map_size
;
202 dev_dbg(&s
->dev
, " %#2.2x %#2.2x %#2.2x %#2.2x ...\n",
203 *(u_char
*)(ptr
+0), *(u_char
*)(ptr
+1),
204 *(u_char
*)(ptr
+2), *(u_char
*)(ptr
+3));
210 * pcmcia_write_cis_mem() - low-level function to write CIS memory
212 * Probably only useful for writing one-byte registers. Must be called
213 * with ops_mutex held.
215 int pcmcia_write_cis_mem(struct pcmcia_socket
*s
, int attr
, u_int addr
,
216 u_int len
, void *ptr
)
218 void __iomem
*sys
, *end
;
219 unsigned char *buf
= ptr
;
222 "pcmcia_write_cis_mem(%d, %#x, %u)\n", attr
, addr
, len
);
224 if (attr
& IS_INDIRECT
) {
225 /* Indirect accesses use a bunch of special registers at fixed
226 locations in common memory */
227 u_char flags
= ICTRL0_COMMON
|ICTRL0_AUTOINC
|ICTRL0_BYTEGRAN
;
228 if (attr
& IS_ATTR
) {
230 flags
= ICTRL0_AUTOINC
;
233 sys
= set_cis_map(s
, 0, MAP_ACTIVE
|
234 ((cis_width
) ? MAP_16BIT
: 0));
236 dev_dbg(&s
->dev
, "could not map memory\n");
240 writeb(flags
, sys
+CISREG_ICTRL0
);
241 writeb(addr
& 0xff, sys
+CISREG_IADDR0
);
242 writeb((addr
>>8) & 0xff, sys
+CISREG_IADDR1
);
243 writeb((addr
>>16) & 0xff, sys
+CISREG_IADDR2
);
244 writeb((addr
>>24) & 0xff, sys
+CISREG_IADDR3
);
245 for ( ; len
> 0; len
--, buf
++)
246 writeb(*buf
, sys
+CISREG_IDATA0
);
248 u_int inc
= 1, card_offset
, flags
;
250 flags
= MAP_ACTIVE
| ((cis_width
) ? MAP_16BIT
: 0);
251 if (attr
& IS_ATTR
) {
257 card_offset
= addr
& ~(s
->map_size
-1);
259 sys
= set_cis_map(s
, card_offset
, flags
);
261 dev_dbg(&s
->dev
, "could not map memory\n");
265 end
= sys
+ s
->map_size
;
266 sys
= sys
+ (addr
& (s
->map_size
-1));
267 for ( ; len
> 0; len
--, buf
++, sys
+= inc
) {
272 card_offset
+= s
->map_size
;
281 * read_cis_cache() - read CIS memory or its associated cache
283 * This is a wrapper around read_cis_mem, with the same interface,
284 * but which caches information, for cards whose CIS may not be
285 * readable all the time.
287 static int read_cis_cache(struct pcmcia_socket
*s
, int attr
, u_int addr
,
288 size_t len
, void *ptr
)
290 struct cis_cache_entry
*cis
;
293 if (s
->state
& SOCKET_CARDBUS
)
296 mutex_lock(&s
->ops_mutex
);
298 if (s
->fake_cis_len
>= addr
+len
)
299 memcpy(ptr
, s
->fake_cis
+addr
, len
);
301 memset(ptr
, 0xff, len
);
304 mutex_unlock(&s
->ops_mutex
);
308 list_for_each_entry(cis
, &s
->cis_cache
, node
) {
309 if (cis
->addr
== addr
&& cis
->len
== len
&& cis
->attr
== attr
) {
310 memcpy(ptr
, cis
->cache
, len
);
311 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 list_add(&cis
->node
, &s
->cis_cache
);
329 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.
356 void destroy_cis_cache(struct pcmcia_socket
*s
)
358 struct list_head
*l
, *n
;
359 struct cis_cache_entry
*cis
;
361 list_for_each_safe(l
, n
, &s
->cis_cache
) {
362 cis
= list_entry(l
, struct cis_cache_entry
, node
);
363 list_del(&cis
->node
);
369 * verify_cis_cache() - does the CIS match what is in the CIS cache?
371 int verify_cis_cache(struct pcmcia_socket
*s
)
373 struct cis_cache_entry
*cis
;
377 if (s
->state
& SOCKET_CARDBUS
)
380 buf
= kmalloc(256, GFP_KERNEL
);
382 dev_warn(&s
->dev
, "no memory for verifying CIS\n");
385 mutex_lock(&s
->ops_mutex
);
386 list_for_each_entry(cis
, &s
->cis_cache
, node
) {
392 ret
= pcmcia_read_cis_mem(s
, cis
->attr
, cis
->addr
, len
, buf
);
393 if (ret
|| memcmp(buf
, cis
->cache
, len
) != 0) {
395 mutex_unlock(&s
->ops_mutex
);
400 mutex_unlock(&s
->ops_mutex
);
405 * pcmcia_replace_cis() - use a replacement CIS instead of the card's CIS
407 * For really bad cards, we provide a facility for uploading a
410 int pcmcia_replace_cis(struct pcmcia_socket
*s
,
411 const u8
*data
, const size_t len
)
413 if (len
> CISTPL_MAX_CIS_SIZE
) {
414 dev_warn(&s
->dev
, "replacement CIS too big\n");
417 mutex_lock(&s
->ops_mutex
);
419 s
->fake_cis
= kmalloc(len
, GFP_KERNEL
);
420 if (s
->fake_cis
== NULL
) {
421 dev_warn(&s
->dev
, "no memory to replace CIS\n");
422 mutex_unlock(&s
->ops_mutex
);
425 s
->fake_cis_len
= len
;
426 memcpy(s
->fake_cis
, data
, len
);
427 dev_info(&s
->dev
, "Using replacement CIS\n");
428 mutex_unlock(&s
->ops_mutex
);
432 /* The high-level CIS tuple services */
441 #define LINK_SPACE(f) (((struct tuple_flags *)(&(f)))->link_space)
442 #define HAS_LINK(f) (((struct tuple_flags *)(&(f)))->has_link)
443 #define MFC_FN(f) (((struct tuple_flags *)(&(f)))->mfc_fn)
444 #define SPACE(f) (((struct tuple_flags *)(&(f)))->space)
446 int pccard_get_first_tuple(struct pcmcia_socket
*s
, unsigned int function
,
452 if (!(s
->state
& SOCKET_PRESENT
) || (s
->state
& SOCKET_CARDBUS
))
454 tuple
->TupleLink
= tuple
->Flags
= 0;
456 /* Assume presence of a LONGLINK_C to address 0 */
457 tuple
->CISOffset
= tuple
->LinkOffset
= 0;
458 SPACE(tuple
->Flags
) = HAS_LINK(tuple
->Flags
) = 1;
460 if ((s
->functions
> 1) && !(tuple
->Attributes
& TUPLE_RETURN_COMMON
)) {
461 cisdata_t req
= tuple
->DesiredTuple
;
462 tuple
->DesiredTuple
= CISTPL_LONGLINK_MFC
;
463 if (pccard_get_next_tuple(s
, function
, tuple
) == 0) {
464 tuple
->DesiredTuple
= CISTPL_LINKTARGET
;
465 if (pccard_get_next_tuple(s
, function
, tuple
) != 0)
468 tuple
->CISOffset
= tuple
->TupleLink
= 0;
469 tuple
->DesiredTuple
= req
;
471 return pccard_get_next_tuple(s
, function
, tuple
);
474 static int follow_link(struct pcmcia_socket
*s
, tuple_t
*tuple
)
480 if (MFC_FN(tuple
->Flags
)) {
481 /* Get indirect link from the MFC tuple */
482 ret
= read_cis_cache(s
, LINK_SPACE(tuple
->Flags
),
483 tuple
->LinkOffset
, 5, link
);
486 ofs
= get_unaligned_le32(link
+ 1);
487 SPACE(tuple
->Flags
) = (link
[0] == CISTPL_MFC_ATTR
);
488 /* Move to the next indirect link */
489 tuple
->LinkOffset
+= 5;
490 MFC_FN(tuple
->Flags
)--;
491 } else if (HAS_LINK(tuple
->Flags
)) {
492 ofs
= tuple
->LinkOffset
;
493 SPACE(tuple
->Flags
) = LINK_SPACE(tuple
->Flags
);
494 HAS_LINK(tuple
->Flags
) = 0;
498 if (SPACE(tuple
->Flags
)) {
499 /* This is ugly, but a common CIS error is to code the long
500 link offset incorrectly, so we check the right spot... */
501 ret
= read_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5, link
);
504 if ((link
[0] == CISTPL_LINKTARGET
) && (link
[1] >= 3) &&
505 (strncmp(link
+2, "CIS", 3) == 0))
507 remove_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5);
508 /* Then, we try the wrong spot... */
511 ret
= read_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5, link
);
514 if ((link
[0] == CISTPL_LINKTARGET
) && (link
[1] >= 3) &&
515 (strncmp(link
+2, "CIS", 3) == 0))
517 remove_cis_cache(s
, SPACE(tuple
->Flags
), ofs
, 5);
521 int pccard_get_next_tuple(struct pcmcia_socket
*s
, unsigned int function
,
530 if (!(s
->state
& SOCKET_PRESENT
) || (s
->state
& SOCKET_CARDBUS
))
533 link
[1] = tuple
->TupleLink
;
534 ofs
= tuple
->CISOffset
+ tuple
->TupleLink
;
535 attr
= SPACE(tuple
->Flags
);
537 for (i
= 0; i
< MAX_TUPLES
; i
++) {
539 link
[0] = CISTPL_END
;
541 ret
= read_cis_cache(s
, attr
, ofs
, 2, link
);
544 if (link
[0] == CISTPL_NULL
) {
550 /* End of chain? Follow long link if possible */
551 if (link
[0] == CISTPL_END
) {
552 ofs
= follow_link(s
, tuple
);
555 attr
= SPACE(tuple
->Flags
);
556 ret
= read_cis_cache(s
, attr
, ofs
, 2, link
);
561 /* Is this a link tuple? Make a note of it */
562 if ((link
[0] == CISTPL_LONGLINK_A
) ||
563 (link
[0] == CISTPL_LONGLINK_C
) ||
564 (link
[0] == CISTPL_LONGLINK_MFC
) ||
565 (link
[0] == CISTPL_LINKTARGET
) ||
566 (link
[0] == CISTPL_INDIRECT
) ||
567 (link
[0] == CISTPL_NO_LINK
)) {
569 case CISTPL_LONGLINK_A
:
570 HAS_LINK(tuple
->Flags
) = 1;
571 LINK_SPACE(tuple
->Flags
) = attr
| IS_ATTR
;
572 ret
= read_cis_cache(s
, attr
, ofs
+2, 4,
577 case CISTPL_LONGLINK_C
:
578 HAS_LINK(tuple
->Flags
) = 1;
579 LINK_SPACE(tuple
->Flags
) = attr
& ~IS_ATTR
;
580 ret
= read_cis_cache(s
, attr
, ofs
+2, 4,
585 case CISTPL_INDIRECT
:
586 HAS_LINK(tuple
->Flags
) = 1;
587 LINK_SPACE(tuple
->Flags
) = IS_ATTR
|
589 tuple
->LinkOffset
= 0;
591 case CISTPL_LONGLINK_MFC
:
592 tuple
->LinkOffset
= ofs
+ 3;
593 LINK_SPACE(tuple
->Flags
) = attr
;
594 if (function
== BIND_FN_ALL
) {
595 /* Follow all the MFC links */
596 ret
= read_cis_cache(s
, attr
, ofs
+2,
600 MFC_FN(tuple
->Flags
) = tmp
;
602 /* Follow exactly one of the links */
603 MFC_FN(tuple
->Flags
) = 1;
604 tuple
->LinkOffset
+= function
* 5;
608 HAS_LINK(tuple
->Flags
) = 0;
611 if ((tuple
->Attributes
& TUPLE_RETURN_LINK
) &&
612 (tuple
->DesiredTuple
== RETURN_FIRST_TUPLE
))
615 if (tuple
->DesiredTuple
== RETURN_FIRST_TUPLE
)
618 if (link
[0] == tuple
->DesiredTuple
)
622 if (i
== MAX_TUPLES
) {
623 dev_dbg(&s
->dev
, "cs: overrun in pcmcia_get_next_tuple\n");
627 tuple
->TupleCode
= link
[0];
628 tuple
->TupleLink
= link
[1];
629 tuple
->CISOffset
= ofs
+ 2;
633 int pccard_get_tuple_data(struct pcmcia_socket
*s
, tuple_t
*tuple
)
641 if (tuple
->TupleLink
< tuple
->TupleOffset
)
643 len
= tuple
->TupleLink
- tuple
->TupleOffset
;
644 tuple
->TupleDataLen
= tuple
->TupleLink
;
647 ret
= read_cis_cache(s
, SPACE(tuple
->Flags
),
648 tuple
->CISOffset
+ tuple
->TupleOffset
,
649 min(len
, (u_int
) tuple
->TupleDataMax
),
657 /* Parsing routines for individual tuples */
659 static int parse_device(tuple_t
*tuple
, cistpl_device_t
*device
)
665 p
= (u_char
*)tuple
->TupleData
;
666 q
= p
+ tuple
->TupleDataLen
;
669 for (i
= 0; i
< CISTPL_MAX_DEVICES
; i
++) {
673 device
->dev
[i
].type
= (*p
>> 4);
674 device
->dev
[i
].wp
= (*p
& 0x08) ? 1 : 0;
677 device
->dev
[i
].speed
= 0;
680 device
->dev
[i
].speed
= 250;
683 device
->dev
[i
].speed
= 200;
686 device
->dev
[i
].speed
= 150;
689 device
->dev
[i
].speed
= 100;
694 device
->dev
[i
].speed
= SPEED_CVT(*p
);
710 device
->dev
[i
].size
= ((*p
>> 3) + 1) * (512 << (scale
*2));
720 static int parse_checksum(tuple_t
*tuple
, cistpl_checksum_t
*csum
)
723 if (tuple
->TupleDataLen
< 5)
725 p
= (u_char
*) tuple
->TupleData
;
726 csum
->addr
= tuple
->CISOffset
+ get_unaligned_le16(p
) - 2;
727 csum
->len
= get_unaligned_le16(p
+ 2);
728 csum
->sum
= *(p
+ 4);
733 static int parse_longlink(tuple_t
*tuple
, cistpl_longlink_t
*link
)
735 if (tuple
->TupleDataLen
< 4)
737 link
->addr
= get_unaligned_le32(tuple
->TupleData
);
742 static int parse_longlink_mfc(tuple_t
*tuple
, cistpl_longlink_mfc_t
*link
)
747 p
= (u_char
*)tuple
->TupleData
;
750 if (tuple
->TupleDataLen
<= link
->nfn
*5)
752 for (i
= 0; i
< link
->nfn
; i
++) {
753 link
->fn
[i
].space
= *p
; p
++;
754 link
->fn
[i
].addr
= get_unaligned_le32(p
);
761 static int parse_strings(u_char
*p
, u_char
*q
, int max
,
762 char *s
, u_char
*ofs
, u_char
*found
)
769 for (i
= 0; i
< max
; i
++) {
775 s
[j
++] = (*p
== 0xff) ? '\0' : *p
;
776 if ((*p
== '\0') || (*p
== 0xff))
781 if ((*p
== 0xff) || (++p
== q
))
789 return (ns
== max
) ? 0 : -EINVAL
;
793 static int parse_vers_1(tuple_t
*tuple
, cistpl_vers_1_t
*vers_1
)
797 p
= (u_char
*)tuple
->TupleData
;
798 q
= p
+ tuple
->TupleDataLen
;
800 vers_1
->major
= *p
; p
++;
801 vers_1
->minor
= *p
; p
++;
805 return parse_strings(p
, q
, CISTPL_VERS_1_MAX_PROD_STRINGS
,
806 vers_1
->str
, vers_1
->ofs
, &vers_1
->ns
);
810 static int parse_altstr(tuple_t
*tuple
, cistpl_altstr_t
*altstr
)
814 p
= (u_char
*)tuple
->TupleData
;
815 q
= p
+ tuple
->TupleDataLen
;
817 return parse_strings(p
, q
, CISTPL_MAX_ALTSTR_STRINGS
,
818 altstr
->str
, altstr
->ofs
, &altstr
->ns
);
822 static int parse_jedec(tuple_t
*tuple
, cistpl_jedec_t
*jedec
)
827 p
= (u_char
*)tuple
->TupleData
;
828 q
= p
+ tuple
->TupleDataLen
;
830 for (nid
= 0; nid
< CISTPL_MAX_DEVICES
; nid
++) {
833 jedec
->id
[nid
].mfr
= p
[0];
834 jedec
->id
[nid
].info
= p
[1];
842 static int parse_manfid(tuple_t
*tuple
, cistpl_manfid_t
*m
)
844 if (tuple
->TupleDataLen
< 4)
846 m
->manf
= get_unaligned_le16(tuple
->TupleData
);
847 m
->card
= get_unaligned_le16(tuple
->TupleData
+ 2);
852 static int parse_funcid(tuple_t
*tuple
, cistpl_funcid_t
*f
)
855 if (tuple
->TupleDataLen
< 2)
857 p
= (u_char
*)tuple
->TupleData
;
864 static int parse_funce(tuple_t
*tuple
, cistpl_funce_t
*f
)
868 if (tuple
->TupleDataLen
< 1)
870 p
= (u_char
*)tuple
->TupleData
;
872 for (i
= 1; i
< tuple
->TupleDataLen
; i
++)
878 static int parse_config(tuple_t
*tuple
, cistpl_config_t
*config
)
883 p
= (u_char
*)tuple
->TupleData
;
885 rmsz
= (*p
& 0x3c) >> 2;
886 if (tuple
->TupleDataLen
< rasz
+rmsz
+4)
888 config
->last_idx
= *(++p
);
891 for (i
= 0; i
<= rasz
; i
++)
892 config
->base
+= p
[i
] << (8*i
);
894 for (i
= 0; i
< 4; i
++)
895 config
->rmask
[i
] = 0;
896 for (i
= 0; i
<= rmsz
; i
++)
897 config
->rmask
[i
>>2] += p
[i
] << (8*(i
%4));
898 config
->subtuples
= tuple
->TupleDataLen
- (rasz
+rmsz
+4);
902 /* The following routines are all used to parse the nightmarish
903 * config table entries.
906 static u_char
*parse_power(u_char
*p
, u_char
*q
, cistpl_power_t
*pwr
)
916 for (i
= 0; i
< 7; i
++)
917 if (pwr
->present
& (1<<i
)) {
920 pwr
->param
[i
] = POWER_CVT(*p
);
921 scale
= POWER_SCALE(*p
);
925 if ((*p
& 0x7f) < 100)
927 (*p
& 0x7f) * scale
/ 100;
929 pwr
->flags
|= CISTPL_POWER_HIGHZ_OK
;
933 pwr
->flags
|= CISTPL_POWER_HIGHZ_REQ
;
943 static u_char
*parse_timing(u_char
*p
, u_char
*q
, cistpl_timing_t
*timing
)
950 if ((scale
& 3) != 3) {
953 timing
->wait
= SPEED_CVT(*p
);
954 timing
->waitscale
= exponent
[scale
& 3];
958 if ((scale
& 7) != 7) {
961 timing
->ready
= SPEED_CVT(*p
);
962 timing
->rdyscale
= exponent
[scale
& 7];
969 timing
->reserved
= SPEED_CVT(*p
);
970 timing
->rsvscale
= exponent
[scale
];
972 timing
->reserved
= 0;
978 static u_char
*parse_io(u_char
*p
, u_char
*q
, cistpl_io_t
*io
)
989 io
->win
[0].len
= (1 << (io
->flags
& CISTPL_IO_LINES_MASK
));
995 io
->nwin
= (*p
& 0x0f) + 1;
996 bsz
= (*p
& 0x30) >> 4;
999 lsz
= (*p
& 0xc0) >> 6;
1004 for (i
= 0; i
< io
->nwin
; i
++) {
1005 io
->win
[i
].base
= 0;
1007 for (j
= 0; j
< bsz
; j
++, p
++) {
1010 io
->win
[i
].base
+= *p
<< (j
*8);
1012 for (j
= 0; j
< lsz
; j
++, p
++) {
1015 io
->win
[i
].len
+= *p
<< (j
*8);
1022 static u_char
*parse_mem(u_char
*p
, u_char
*q
, cistpl_mem_t
*mem
)
1024 int i
, j
, asz
, lsz
, has_ha
;
1030 mem
->nwin
= (*p
& 0x07) + 1;
1031 lsz
= (*p
& 0x18) >> 3;
1032 asz
= (*p
& 0x60) >> 5;
1033 has_ha
= (*p
& 0x80);
1037 for (i
= 0; i
< mem
->nwin
; i
++) {
1039 for (j
= 0; j
< lsz
; j
++, p
++) {
1044 for (j
= 0; j
< asz
; j
++, p
++) {
1050 for (j
= 0; j
< asz
; j
++, p
++) {
1055 mem
->win
[i
].len
= len
<< 8;
1056 mem
->win
[i
].card_addr
= ca
<< 8;
1057 mem
->win
[i
].host_addr
= ha
<< 8;
1063 static u_char
*parse_irq(u_char
*p
, u_char
*q
, cistpl_irq_t
*irq
)
1067 irq
->IRQInfo1
= *p
; p
++;
1068 if (irq
->IRQInfo1
& IRQ_INFO2_VALID
) {
1071 irq
->IRQInfo2
= (p
[1]<<8) + p
[0];
1078 static int parse_cftable_entry(tuple_t
*tuple
,
1079 cistpl_cftable_entry_t
*entry
)
1081 u_char
*p
, *q
, features
;
1083 p
= tuple
->TupleData
;
1084 q
= p
+ tuple
->TupleDataLen
;
1085 entry
->index
= *p
& 0x3f;
1088 entry
->flags
|= CISTPL_CFTABLE_DEFAULT
;
1093 entry
->flags
|= CISTPL_CFTABLE_BVDS
;
1095 entry
->flags
|= CISTPL_CFTABLE_WP
;
1097 entry
->flags
|= CISTPL_CFTABLE_RDYBSY
;
1099 entry
->flags
|= CISTPL_CFTABLE_MWAIT
;
1100 entry
->interface
= *p
& 0x0f;
1102 entry
->interface
= 0;
1104 /* Process optional features */
1110 if ((features
& 3) > 0) {
1111 p
= parse_power(p
, q
, &entry
->vcc
);
1115 entry
->vcc
.present
= 0;
1116 if ((features
& 3) > 1) {
1117 p
= parse_power(p
, q
, &entry
->vpp1
);
1121 entry
->vpp1
.present
= 0;
1122 if ((features
& 3) > 2) {
1123 p
= parse_power(p
, q
, &entry
->vpp2
);
1127 entry
->vpp2
.present
= 0;
1129 /* Timing options */
1130 if (features
& 0x04) {
1131 p
= parse_timing(p
, q
, &entry
->timing
);
1135 entry
->timing
.wait
= 0;
1136 entry
->timing
.ready
= 0;
1137 entry
->timing
.reserved
= 0;
1140 /* I/O window options */
1141 if (features
& 0x08) {
1142 p
= parse_io(p
, q
, &entry
->io
);
1148 /* Interrupt options */
1149 if (features
& 0x10) {
1150 p
= parse_irq(p
, q
, &entry
->irq
);
1154 entry
->irq
.IRQInfo1
= 0;
1156 switch (features
& 0x60) {
1158 entry
->mem
.nwin
= 0;
1161 entry
->mem
.nwin
= 1;
1162 entry
->mem
.win
[0].len
= get_unaligned_le16(p
) << 8;
1163 entry
->mem
.win
[0].card_addr
= 0;
1164 entry
->mem
.win
[0].host_addr
= 0;
1170 entry
->mem
.nwin
= 1;
1171 entry
->mem
.win
[0].len
= get_unaligned_le16(p
) << 8;
1172 entry
->mem
.win
[0].card_addr
= get_unaligned_le16(p
+ 2) << 8;
1173 entry
->mem
.win
[0].host_addr
= 0;
1179 p
= parse_mem(p
, q
, &entry
->mem
);
1186 if (features
& 0x80) {
1189 entry
->flags
|= (*p
<< 8);
1196 entry
->subtuples
= q
-p
;
1202 static int parse_device_geo(tuple_t
*tuple
, cistpl_device_geo_t
*geo
)
1207 p
= (u_char
*)tuple
->TupleData
;
1208 q
= p
+ tuple
->TupleDataLen
;
1210 for (n
= 0; n
< CISTPL_MAX_DEVICES
; n
++) {
1213 geo
->geo
[n
].buswidth
= p
[0];
1214 geo
->geo
[n
].erase_block
= 1 << (p
[1]-1);
1215 geo
->geo
[n
].read_block
= 1 << (p
[2]-1);
1216 geo
->geo
[n
].write_block
= 1 << (p
[3]-1);
1217 geo
->geo
[n
].partition
= 1 << (p
[4]-1);
1218 geo
->geo
[n
].interleave
= 1 << (p
[5]-1);
1226 static int parse_vers_2(tuple_t
*tuple
, cistpl_vers_2_t
*v2
)
1230 if (tuple
->TupleDataLen
< 10)
1233 p
= tuple
->TupleData
;
1234 q
= p
+ tuple
->TupleDataLen
;
1238 v2
->dindex
= get_unaligned_le16(p
+ 2);
1243 return parse_strings(p
, q
, 2, v2
->str
, &v2
->vendor
, NULL
);
1247 static int parse_org(tuple_t
*tuple
, cistpl_org_t
*org
)
1252 p
= tuple
->TupleData
;
1253 q
= p
+ tuple
->TupleDataLen
;
1259 for (i
= 0; i
< 30; i
++) {
1270 static int parse_format(tuple_t
*tuple
, cistpl_format_t
*fmt
)
1274 if (tuple
->TupleDataLen
< 10)
1277 p
= tuple
->TupleData
;
1281 fmt
->offset
= get_unaligned_le32(p
+ 2);
1282 fmt
->length
= get_unaligned_le32(p
+ 6);
1288 int pcmcia_parse_tuple(tuple_t
*tuple
, cisparse_t
*parse
)
1292 if (tuple
->TupleDataLen
> tuple
->TupleDataMax
)
1294 switch (tuple
->TupleCode
) {
1296 case CISTPL_DEVICE_A
:
1297 ret
= parse_device(tuple
, &parse
->device
);
1299 case CISTPL_CHECKSUM
:
1300 ret
= parse_checksum(tuple
, &parse
->checksum
);
1302 case CISTPL_LONGLINK_A
:
1303 case CISTPL_LONGLINK_C
:
1304 ret
= parse_longlink(tuple
, &parse
->longlink
);
1306 case CISTPL_LONGLINK_MFC
:
1307 ret
= parse_longlink_mfc(tuple
, &parse
->longlink_mfc
);
1310 ret
= parse_vers_1(tuple
, &parse
->version_1
);
1313 ret
= parse_altstr(tuple
, &parse
->altstr
);
1315 case CISTPL_JEDEC_A
:
1316 case CISTPL_JEDEC_C
:
1317 ret
= parse_jedec(tuple
, &parse
->jedec
);
1320 ret
= parse_manfid(tuple
, &parse
->manfid
);
1323 ret
= parse_funcid(tuple
, &parse
->funcid
);
1326 ret
= parse_funce(tuple
, &parse
->funce
);
1329 ret
= parse_config(tuple
, &parse
->config
);
1331 case CISTPL_CFTABLE_ENTRY
:
1332 ret
= parse_cftable_entry(tuple
, &parse
->cftable_entry
);
1334 case CISTPL_DEVICE_GEO
:
1335 case CISTPL_DEVICE_GEO_A
:
1336 ret
= parse_device_geo(tuple
, &parse
->device_geo
);
1339 ret
= parse_vers_2(tuple
, &parse
->vers_2
);
1342 ret
= parse_org(tuple
, &parse
->org
);
1345 case CISTPL_FORMAT_A
:
1346 ret
= parse_format(tuple
, &parse
->format
);
1348 case CISTPL_NO_LINK
:
1349 case CISTPL_LINKTARGET
:
1357 pr_debug("parse_tuple failed %d\n", ret
);
1360 EXPORT_SYMBOL(pcmcia_parse_tuple
);
1364 * pccard_validate_cis() - check whether card has a sensible CIS
1365 * @s: the struct pcmcia_socket we are to check
1366 * @info: returns the number of tuples in the (valid) CIS, or 0
1368 * This tries to determine if a card has a sensible CIS. In @info, it
1369 * returns the number of tuples in the CIS, or 0 if the CIS looks bad. The
1370 * checks include making sure several critical tuples are present and
1371 * valid; seeing if the total number of tuples is reasonable; and
1372 * looking for tuples that use reserved codes.
1374 * The function returns 0 on success.
1376 int pccard_validate_cis(struct pcmcia_socket
*s
, unsigned int *info
)
1380 unsigned int count
= 0;
1381 int ret
, reserved
, dev_ok
= 0, ident_ok
= 0;
1386 if (s
->functions
|| !(s
->state
& SOCKET_PRESENT
)) {
1391 /* We do not want to validate the CIS cache... */
1392 mutex_lock(&s
->ops_mutex
);
1393 destroy_cis_cache(s
);
1394 mutex_unlock(&s
->ops_mutex
);
1396 tuple
= kmalloc(sizeof(*tuple
), GFP_KERNEL
);
1397 if (tuple
== NULL
) {
1398 dev_warn(&s
->dev
, "no memory to validate CIS\n");
1401 p
= kmalloc(sizeof(*p
), GFP_KERNEL
);
1404 dev_warn(&s
->dev
, "no memory to validate CIS\n");
1408 count
= reserved
= 0;
1409 tuple
->DesiredTuple
= RETURN_FIRST_TUPLE
;
1410 tuple
->Attributes
= TUPLE_RETURN_COMMON
;
1411 ret
= pccard_get_first_tuple(s
, BIND_FN_ALL
, tuple
);
1415 /* First tuple should be DEVICE; we should really have either that
1416 or a CFTABLE_ENTRY of some sort */
1417 if ((tuple
->TupleCode
== CISTPL_DEVICE
) ||
1418 (!pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_CFTABLE_ENTRY
, p
)) ||
1419 (!pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_CFTABLE_ENTRY_CB
, p
)))
1422 /* All cards should have a MANFID tuple, and/or a VERS_1 or VERS_2
1423 tuple, for card identification. Certain old D-Link and Linksys
1424 cards have only a broken VERS_2 tuple; hence the bogus test. */
1425 if ((pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_MANFID
, p
) == 0) ||
1426 (pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_VERS_1
, p
) == 0) ||
1427 (pccard_read_tuple(s
, BIND_FN_ALL
, CISTPL_VERS_2
, p
) != -ENOSPC
))
1430 if (!dev_ok
&& !ident_ok
)
1433 for (count
= 1; count
< MAX_TUPLES
; count
++) {
1434 ret
= pccard_get_next_tuple(s
, BIND_FN_ALL
, tuple
);
1437 if (((tuple
->TupleCode
> 0x23) && (tuple
->TupleCode
< 0x40)) ||
1438 ((tuple
->TupleCode
> 0x47) && (tuple
->TupleCode
< 0x80)) ||
1439 ((tuple
->TupleCode
> 0x90) && (tuple
->TupleCode
< 0xff)))
1442 if ((count
== MAX_TUPLES
) || (reserved
> 5) ||
1443 ((!dev_ok
|| !ident_ok
) && (count
> 10)))
1449 /* invalidate CIS cache on failure */
1450 if (!dev_ok
|| !ident_ok
|| !count
) {
1451 mutex_lock(&s
->ops_mutex
);
1452 destroy_cis_cache(s
);
1453 mutex_unlock(&s
->ops_mutex
);
1454 /* We differentiate between dev_ok, ident_ok and count
1455 failures to allow for an override for anonymous cards
1457 if (!dev_ok
|| !ident_ok
)
1471 #define to_socket(_dev) container_of(_dev, struct pcmcia_socket, dev)
1473 static ssize_t
pccard_extract_cis(struct pcmcia_socket
*s
, char *buf
,
1474 loff_t off
, size_t count
)
1480 u_char
*tuplebuffer
;
1483 tuplebuffer
= kmalloc_array(256, sizeof(u_char
), GFP_KERNEL
);
1487 tempbuffer
= kmalloc_array(258, sizeof(u_char
), GFP_KERNEL
);
1493 memset(&tuple
, 0, sizeof(tuple_t
));
1495 tuple
.Attributes
= TUPLE_RETURN_LINK
| TUPLE_RETURN_COMMON
;
1496 tuple
.DesiredTuple
= RETURN_FIRST_TUPLE
;
1497 tuple
.TupleOffset
= 0;
1499 status
= pccard_get_first_tuple(s
, BIND_FN_ALL
, &tuple
);
1501 tuple
.TupleData
= tuplebuffer
;
1502 tuple
.TupleDataMax
= 255;
1503 memset(tuplebuffer
, 0, sizeof(u_char
) * 255);
1505 status
= pccard_get_tuple_data(s
, &tuple
);
1509 if (off
< (pointer
+ 2 + tuple
.TupleDataLen
)) {
1510 tempbuffer
[0] = tuple
.TupleCode
& 0xff;
1511 tempbuffer
[1] = tuple
.TupleLink
& 0xff;
1512 for (i
= 0; i
< tuple
.TupleDataLen
; i
++)
1513 tempbuffer
[i
+ 2] = tuplebuffer
[i
] & 0xff;
1515 for (i
= 0; i
< (2 + tuple
.TupleDataLen
); i
++) {
1516 if (((i
+ pointer
) >= off
) &&
1517 (i
+ pointer
) < (off
+ count
)) {
1518 buf
[ret
] = tempbuffer
[i
];
1524 pointer
+= 2 + tuple
.TupleDataLen
;
1526 if (pointer
>= (off
+ count
))
1529 if (tuple
.TupleCode
== CISTPL_END
)
1531 status
= pccard_get_next_tuple(s
, BIND_FN_ALL
, &tuple
);
1542 static ssize_t
pccard_show_cis(struct file
*filp
, struct kobject
*kobj
,
1543 struct bin_attribute
*bin_attr
,
1544 char *buf
, loff_t off
, size_t count
)
1546 unsigned int size
= 0x200;
1551 struct pcmcia_socket
*s
;
1552 unsigned int chains
= 1;
1554 if (off
+ count
> size
)
1557 s
= to_socket(container_of(kobj
, struct device
, kobj
));
1559 if (!(s
->state
& SOCKET_PRESENT
))
1561 if (!s
->functions
&& pccard_validate_cis(s
, &chains
))
1566 count
= pccard_extract_cis(s
, buf
, off
, count
);
1573 static ssize_t
pccard_store_cis(struct file
*filp
, struct kobject
*kobj
,
1574 struct bin_attribute
*bin_attr
,
1575 char *buf
, loff_t off
, size_t count
)
1577 struct pcmcia_socket
*s
;
1580 error
= security_locked_down(LOCKDOWN_PCMCIA_CIS
);
1584 s
= to_socket(container_of(kobj
, struct device
, kobj
));
1589 if (count
>= CISTPL_MAX_CIS_SIZE
)
1592 if (!(s
->state
& SOCKET_PRESENT
))
1595 error
= pcmcia_replace_cis(s
, buf
, count
);
1599 pcmcia_parse_uevents(s
, PCMCIA_UEVENT_REQUERY
);
1605 const struct bin_attribute pccard_cis_attr
= {
1606 .attr
= { .name
= "cis", .mode
= S_IRUGO
| S_IWUSR
},
1608 .read
= pccard_show_cis
,
1609 .write
= pccard_store_cis
,