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/sched.h>
25 #include <linux/pci.h>
26 #include <linux/ioport.h>
28 #include <asm/byteorder.h>
30 #include <pcmcia/cs_types.h>
31 #include <pcmcia/ss.h>
32 #include <pcmcia/cs.h>
33 #include <pcmcia/bulkmem.h>
34 #include <pcmcia/cisreg.h>
35 #include <pcmcia/cistpl.h>
36 #include "cs_internal.h"
38 static const u_char mantissa[] = {
39 10, 12, 13, 15, 20, 25, 30, 35,
40 40, 45, 50, 55, 60, 70, 80, 90
43 static const u_int exponent[] = {
44 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000
47 /* Convert an extended speed byte to a time in nanoseconds */
48 #define SPEED_CVT(v) \
49 (mantissa[(((v)>>3)&15)-1] * exponent[(v)&7] / 10)
50 /* Convert a power byte to a current in 0.1 microamps */
51 #define POWER_CVT(v) \
52 (mantissa[((v)>>3)&15] * exponent[(v)&7] / 10)
53 #define POWER_SCALE(v) (exponent[(v)&7])
55 /* Upper limit on reasonable # of tuples */
56 #define MAX_TUPLES 200
58 /*====================================================================*/
60 /* Parameters that can be set with 'insmod' */
64 module_param(cis_width, int, 0444);
66 void release_cis_mem(struct pcmcia_socket *s)
68 if (s->cis_mem.flags & MAP_ACTIVE) {
69 s->cis_mem.flags &= ~MAP_ACTIVE;
70 s->ops->set_mem_map(s, &s->cis_mem);
72 release_resource(s->cis_mem.res);
73 kfree(s->cis_mem.res);
74 s->cis_mem.res = NULL;
80 EXPORT_SYMBOL(release_cis_mem);
83 * Map the card memory at "card_offset" into virtual space.
84 * If flags & MAP_ATTRIB, map the attribute space, otherwise
85 * map the memory space.
88 set_cis_map(struct pcmcia_socket *s, unsigned int card_offset, unsigned int flags)
90 pccard_mem_map *mem = &s->cis_mem;
93 if (!(s->features & SS_CAP_STATIC_MAP) && (mem->res == NULL)) {
94 mem->res = pcmcia_find_mem_region(0, s->map_size, s->map_size, 0, s);
95 if (mem->res == NULL) {
96 printk(KERN_NOTICE "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);
124 /*======================================================================
126 Low-level functions to read and write CIS memory. I think the
127 write routine is only useful for writing one-byte registers.
129 ======================================================================*/
131 /* Bits in attr field */
133 #define IS_INDIRECT 8
135 int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr, u_int addr,
136 u_int len, void *ptr)
138 void __iomem *sys, *end;
139 unsigned char *buf = ptr;
141 cs_dbg(s, 3, "pcmcia_read_cis_mem(%d, %#x, %u)\n", attr, addr, len);
143 if (attr & IS_INDIRECT) {
144 /* Indirect accesses use a bunch of special registers at fixed
145 locations in common memory */
146 u_char flags = ICTRL0_COMMON|ICTRL0_AUTOINC|ICTRL0_BYTEGRAN;
147 if (attr & IS_ATTR) {
149 flags = ICTRL0_AUTOINC;
152 sys = set_cis_map(s, 0, MAP_ACTIVE | ((cis_width) ? MAP_16BIT : 0));
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 flags = MAP_ACTIVE | ((cis_width) ? MAP_16BIT : 0);
175 card_offset = addr & ~(s->map_size-1);
177 sys = set_cis_map(s, card_offset, flags);
179 memset(ptr, 0xff, len);
182 end = sys + s->map_size;
183 sys = sys + (addr & (s->map_size-1));
184 for ( ; len > 0; len--, buf++, sys += inc) {
189 card_offset += s->map_size;
193 cs_dbg(s, 3, " %#2.2x %#2.2x %#2.2x %#2.2x ...\n",
194 *(u_char *)(ptr+0), *(u_char *)(ptr+1),
195 *(u_char *)(ptr+2), *(u_char *)(ptr+3));
198 EXPORT_SYMBOL(pcmcia_read_cis_mem);
201 void pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr, u_int addr,
202 u_int len, void *ptr)
204 void __iomem *sys, *end;
205 unsigned char *buf = ptr;
207 cs_dbg(s, 3, "pcmcia_write_cis_mem(%d, %#x, %u)\n", attr, addr, len);
209 if (attr & IS_INDIRECT) {
210 /* Indirect accesses use a bunch of special registers at fixed
211 locations in common memory */
212 u_char flags = ICTRL0_COMMON|ICTRL0_AUTOINC|ICTRL0_BYTEGRAN;
213 if (attr & IS_ATTR) {
215 flags = ICTRL0_AUTOINC;
218 sys = set_cis_map(s, 0, MAP_ACTIVE | ((cis_width) ? MAP_16BIT : 0));
220 return; /* FIXME: Error */
222 writeb(flags, sys+CISREG_ICTRL0);
223 writeb(addr & 0xff, sys+CISREG_IADDR0);
224 writeb((addr>>8) & 0xff, sys+CISREG_IADDR1);
225 writeb((addr>>16) & 0xff, sys+CISREG_IADDR2);
226 writeb((addr>>24) & 0xff, sys+CISREG_IADDR3);
227 for ( ; len > 0; len--, buf++)
228 writeb(*buf, sys+CISREG_IDATA0);
230 u_int inc = 1, card_offset, flags;
232 flags = MAP_ACTIVE | ((cis_width) ? MAP_16BIT : 0);
233 if (attr & IS_ATTR) {
239 card_offset = addr & ~(s->map_size-1);
241 sys = set_cis_map(s, card_offset, flags);
243 return; /* FIXME: error */
245 end = sys + s->map_size;
246 sys = sys + (addr & (s->map_size-1));
247 for ( ; len > 0; len--, buf++, sys += inc) {
252 card_offset += s->map_size;
257 EXPORT_SYMBOL(pcmcia_write_cis_mem);
260 /*======================================================================
262 This is a wrapper around read_cis_mem, with the same interface,
263 but which caches information, for cards whose CIS may not be
264 readable all the time.
266 ======================================================================*/
268 static void read_cis_cache(struct pcmcia_socket *s, int attr, u_int addr,
269 u_int len, void *ptr)
271 struct cis_cache_entry *cis;
275 if (s->fake_cis_len > addr+len)
276 memcpy(ptr, s->fake_cis+addr, len);
278 memset(ptr, 0xff, len);
282 list_for_each_entry(cis, &s->cis_cache, node) {
283 if (cis->addr == addr && cis->len == len && cis->attr == attr) {
284 memcpy(ptr, cis->cache, len);
289 #ifdef CONFIG_CARDBUS
290 if (s->state & SOCKET_CARDBUS)
291 ret = read_cb_mem(s, attr, addr, len, ptr);
294 ret = pcmcia_read_cis_mem(s, attr, addr, len, ptr);
297 /* Copy data into the cache */
298 cis = kmalloc(sizeof(struct cis_cache_entry) + len, GFP_KERNEL);
303 memcpy(cis->cache, ptr, len);
304 list_add(&cis->node, &s->cis_cache);
310 remove_cis_cache(struct pcmcia_socket *s, int attr, u_int addr, u_int len)
312 struct cis_cache_entry *cis;
314 list_for_each_entry(cis, &s->cis_cache, node)
315 if (cis->addr == addr && cis->len == len && cis->attr == attr) {
316 list_del(&cis->node);
322 void destroy_cis_cache(struct pcmcia_socket *s)
324 struct list_head *l, *n;
326 list_for_each_safe(l, n, &s->cis_cache) {
327 struct cis_cache_entry *cis = list_entry(l, struct cis_cache_entry, node);
329 list_del(&cis->node);
334 * If there was a fake CIS, destroy that as well.
339 EXPORT_SYMBOL(destroy_cis_cache);
341 /*======================================================================
343 This verifies if the CIS of a card matches what is in the CIS
346 ======================================================================*/
348 int verify_cis_cache(struct pcmcia_socket *s)
350 struct cis_cache_entry *cis;
353 buf = kmalloc(256, GFP_KERNEL);
356 list_for_each_entry(cis, &s->cis_cache, node) {
361 #ifdef CONFIG_CARDBUS
362 if (s->state & SOCKET_CARDBUS)
363 read_cb_mem(s, cis->attr, cis->addr, len, buf);
366 pcmcia_read_cis_mem(s, cis->attr, cis->addr, len, buf);
368 if (memcmp(buf, cis->cache, len) != 0) {
377 /*======================================================================
379 For really bad cards, we provide a facility for uploading a
382 ======================================================================*/
384 int pcmcia_replace_cis(struct pcmcia_socket *s, cisdump_t *cis)
388 if (cis->Length > CISTPL_MAX_CIS_SIZE)
390 s->fake_cis = kmalloc(cis->Length, GFP_KERNEL);
391 if (s->fake_cis == NULL)
392 return CS_OUT_OF_RESOURCE;
393 s->fake_cis_len = cis->Length;
394 memcpy(s->fake_cis, cis->Data, cis->Length);
397 EXPORT_SYMBOL(pcmcia_replace_cis);
399 /*======================================================================
401 The high-level CIS tuple services
403 ======================================================================*/
405 typedef struct tuple_flags {
412 #define LINK_SPACE(f) (((tuple_flags *)(&(f)))->link_space)
413 #define HAS_LINK(f) (((tuple_flags *)(&(f)))->has_link)
414 #define MFC_FN(f) (((tuple_flags *)(&(f)))->mfc_fn)
415 #define SPACE(f) (((tuple_flags *)(&(f)))->space)
417 int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int func, tuple_t *tuple);
419 int pccard_get_first_tuple(struct pcmcia_socket *s, unsigned int function, tuple_t *tuple)
422 return CS_BAD_HANDLE;
423 if (!(s->state & SOCKET_PRESENT))
425 tuple->TupleLink = tuple->Flags = 0;
426 #ifdef CONFIG_CARDBUS
427 if (s->state & SOCKET_CARDBUS) {
428 struct pci_dev *dev = s->cb_dev;
430 pci_bus_read_config_dword(dev->subordinate, 0, PCI_CARDBUS_CIS, &ptr);
431 tuple->CISOffset = ptr & ~7;
432 SPACE(tuple->Flags) = (ptr & 7);
436 /* Assume presence of a LONGLINK_C to address 0 */
437 tuple->CISOffset = tuple->LinkOffset = 0;
438 SPACE(tuple->Flags) = HAS_LINK(tuple->Flags) = 1;
440 if (!(s->state & SOCKET_CARDBUS) && (s->functions > 1) &&
441 !(tuple->Attributes & TUPLE_RETURN_COMMON)) {
442 cisdata_t req = tuple->DesiredTuple;
443 tuple->DesiredTuple = CISTPL_LONGLINK_MFC;
444 if (pccard_get_next_tuple(s, function, tuple) == CS_SUCCESS) {
445 tuple->DesiredTuple = CISTPL_LINKTARGET;
446 if (pccard_get_next_tuple(s, function, tuple) != CS_SUCCESS)
447 return CS_NO_MORE_ITEMS;
449 tuple->CISOffset = tuple->TupleLink = 0;
450 tuple->DesiredTuple = req;
452 return pccard_get_next_tuple(s, function, tuple);
454 EXPORT_SYMBOL(pccard_get_first_tuple);
456 static int follow_link(struct pcmcia_socket *s, tuple_t *tuple)
461 if (MFC_FN(tuple->Flags)) {
462 /* Get indirect link from the MFC tuple */
463 read_cis_cache(s, LINK_SPACE(tuple->Flags),
464 tuple->LinkOffset, 5, link);
465 ofs = le32_to_cpu(*(__le32 *)(link+1));
466 SPACE(tuple->Flags) = (link[0] == CISTPL_MFC_ATTR);
467 /* Move to the next indirect link */
468 tuple->LinkOffset += 5;
469 MFC_FN(tuple->Flags)--;
470 } else if (HAS_LINK(tuple->Flags)) {
471 ofs = tuple->LinkOffset;
472 SPACE(tuple->Flags) = LINK_SPACE(tuple->Flags);
473 HAS_LINK(tuple->Flags) = 0;
477 if (!(s->state & SOCKET_CARDBUS) && SPACE(tuple->Flags)) {
478 /* This is ugly, but a common CIS error is to code the long
479 link offset incorrectly, so we check the right spot... */
480 read_cis_cache(s, SPACE(tuple->Flags), ofs, 5, link);
481 if ((link[0] == CISTPL_LINKTARGET) && (link[1] >= 3) &&
482 (strncmp(link+2, "CIS", 3) == 0))
484 remove_cis_cache(s, SPACE(tuple->Flags), ofs, 5);
485 /* Then, we try the wrong spot... */
488 read_cis_cache(s, SPACE(tuple->Flags), ofs, 5, link);
489 if ((link[0] == CISTPL_LINKTARGET) && (link[1] >= 3) &&
490 (strncmp(link+2, "CIS", 3) == 0))
492 remove_cis_cache(s, SPACE(tuple->Flags), ofs, 5);
496 int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int function, tuple_t *tuple)
502 return CS_BAD_HANDLE;
503 if (!(s->state & SOCKET_PRESENT))
506 link[1] = tuple->TupleLink;
507 ofs = tuple->CISOffset + tuple->TupleLink;
508 attr = SPACE(tuple->Flags);
510 for (i = 0; i < MAX_TUPLES; i++) {
511 if (link[1] == 0xff) {
512 link[0] = CISTPL_END;
514 read_cis_cache(s, attr, ofs, 2, link);
515 if (link[0] == CISTPL_NULL) {
520 /* End of chain? Follow long link if possible */
521 if (link[0] == CISTPL_END) {
522 if ((ofs = follow_link(s, tuple)) < 0)
523 return CS_NO_MORE_ITEMS;
524 attr = SPACE(tuple->Flags);
525 read_cis_cache(s, attr, ofs, 2, link);
528 /* Is this a link tuple? Make a note of it */
529 if ((link[0] == CISTPL_LONGLINK_A) ||
530 (link[0] == CISTPL_LONGLINK_C) ||
531 (link[0] == CISTPL_LONGLINK_MFC) ||
532 (link[0] == CISTPL_LINKTARGET) ||
533 (link[0] == CISTPL_INDIRECT) ||
534 (link[0] == CISTPL_NO_LINK)) {
536 case CISTPL_LONGLINK_A:
537 HAS_LINK(tuple->Flags) = 1;
538 LINK_SPACE(tuple->Flags) = attr | IS_ATTR;
539 read_cis_cache(s, attr, ofs+2, 4, &tuple->LinkOffset);
541 case CISTPL_LONGLINK_C:
542 HAS_LINK(tuple->Flags) = 1;
543 LINK_SPACE(tuple->Flags) = attr & ~IS_ATTR;
544 read_cis_cache(s, attr, ofs+2, 4, &tuple->LinkOffset);
546 case CISTPL_INDIRECT:
547 HAS_LINK(tuple->Flags) = 1;
548 LINK_SPACE(tuple->Flags) = IS_ATTR | IS_INDIRECT;
549 tuple->LinkOffset = 0;
551 case CISTPL_LONGLINK_MFC:
552 tuple->LinkOffset = ofs + 3;
553 LINK_SPACE(tuple->Flags) = attr;
554 if (function == BIND_FN_ALL) {
555 /* Follow all the MFC links */
556 read_cis_cache(s, attr, ofs+2, 1, &tmp);
557 MFC_FN(tuple->Flags) = tmp;
559 /* Follow exactly one of the links */
560 MFC_FN(tuple->Flags) = 1;
561 tuple->LinkOffset += function * 5;
565 HAS_LINK(tuple->Flags) = 0;
568 if ((tuple->Attributes & TUPLE_RETURN_LINK) &&
569 (tuple->DesiredTuple == RETURN_FIRST_TUPLE))
572 if (tuple->DesiredTuple == RETURN_FIRST_TUPLE)
575 if (link[0] == tuple->DesiredTuple)
579 if (i == MAX_TUPLES) {
580 cs_dbg(s, 1, "cs: overrun in pcmcia_get_next_tuple\n");
581 return CS_NO_MORE_ITEMS;
584 tuple->TupleCode = link[0];
585 tuple->TupleLink = link[1];
586 tuple->CISOffset = ofs + 2;
589 EXPORT_SYMBOL(pccard_get_next_tuple);
591 /*====================================================================*/
593 #define _MIN(a, b) (((a) < (b)) ? (a) : (b))
595 int pccard_get_tuple_data(struct pcmcia_socket *s, tuple_t *tuple)
600 return CS_BAD_HANDLE;
602 if (tuple->TupleLink < tuple->TupleOffset)
603 return CS_NO_MORE_ITEMS;
604 len = tuple->TupleLink - tuple->TupleOffset;
605 tuple->TupleDataLen = tuple->TupleLink;
608 read_cis_cache(s, SPACE(tuple->Flags),
609 tuple->CISOffset + tuple->TupleOffset,
610 _MIN(len, tuple->TupleDataMax), tuple->TupleData);
613 EXPORT_SYMBOL(pccard_get_tuple_data);
616 /*======================================================================
618 Parsing routines for individual tuples
620 ======================================================================*/
622 static int parse_device(tuple_t *tuple, cistpl_device_t *device)
628 p = (u_char *)tuple->TupleData;
629 q = p + tuple->TupleDataLen;
632 for (i = 0; i < CISTPL_MAX_DEVICES; i++) {
634 if (*p == 0xff) break;
635 device->dev[i].type = (*p >> 4);
636 device->dev[i].wp = (*p & 0x08) ? 1 : 0;
638 case 0: device->dev[i].speed = 0; break;
639 case 1: device->dev[i].speed = 250; break;
640 case 2: device->dev[i].speed = 200; break;
641 case 3: device->dev[i].speed = 150; break;
642 case 4: device->dev[i].speed = 100; break;
644 if (++p == q) return CS_BAD_TUPLE;
645 device->dev[i].speed = SPEED_CVT(*p);
647 if (++p == q) return CS_BAD_TUPLE;
653 if (++p == q) return CS_BAD_TUPLE;
654 if (*p == 0xff) break;
656 if (scale == 7) return CS_BAD_TUPLE;
657 device->dev[i].size = ((*p >> 3) + 1) * (512 << (scale*2));
665 /*====================================================================*/
667 static int parse_checksum(tuple_t *tuple, cistpl_checksum_t *csum)
670 if (tuple->TupleDataLen < 5)
672 p = (u_char *)tuple->TupleData;
673 csum->addr = tuple->CISOffset+(short)le16_to_cpu(*(__le16 *)p)-2;
674 csum->len = le16_to_cpu(*(__le16 *)(p + 2));
679 /*====================================================================*/
681 static int parse_longlink(tuple_t *tuple, cistpl_longlink_t *link)
683 if (tuple->TupleDataLen < 4)
685 link->addr = le32_to_cpu(*(__le32 *)tuple->TupleData);
689 /*====================================================================*/
691 static int parse_longlink_mfc(tuple_t *tuple,
692 cistpl_longlink_mfc_t *link)
697 p = (u_char *)tuple->TupleData;
700 if (tuple->TupleDataLen <= link->nfn*5)
702 for (i = 0; i < link->nfn; i++) {
703 link->fn[i].space = *p; p++;
704 link->fn[i].addr = le32_to_cpu(*(__le32 *)p); p += 4;
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)
792 if (tuple->TupleDataLen < 4)
794 p = (__le16 *)tuple->TupleData;
795 m->manf = le16_to_cpu(p[0]);
796 m->card = le16_to_cpu(p[1]);
800 /*====================================================================*/
802 static int parse_funcid(tuple_t *tuple, cistpl_funcid_t *f)
805 if (tuple->TupleDataLen < 2)
807 p = (u_char *)tuple->TupleData;
813 /*====================================================================*/
815 static int parse_funce(tuple_t *tuple, cistpl_funce_t *f)
819 if (tuple->TupleDataLen < 1)
821 p = (u_char *)tuple->TupleData;
823 for (i = 1; i < tuple->TupleDataLen; i++)
828 /*====================================================================*/
830 static int parse_config(tuple_t *tuple, cistpl_config_t *config)
835 p = (u_char *)tuple->TupleData;
837 rmsz = (*p & 0x3c) >> 2;
838 if (tuple->TupleDataLen < rasz+rmsz+4)
840 config->last_idx = *(++p);
843 for (i = 0; i <= rasz; i++)
844 config->base += p[i] << (8*i);
846 for (i = 0; i < 4; i++)
847 config->rmask[i] = 0;
848 for (i = 0; i <= rmsz; i++)
849 config->rmask[i>>2] += p[i] << (8*(i%4));
850 config->subtuples = tuple->TupleDataLen - (rasz+rmsz+4);
854 /*======================================================================
856 The following routines are all used to parse the nightmarish
857 config table entries.
859 ======================================================================*/
861 static u_char *parse_power(u_char *p, u_char *q,
867 if (p == q) return NULL;
871 for (i = 0; i < 7; i++)
872 if (pwr->present & (1<<i)) {
873 if (p == q) return NULL;
874 pwr->param[i] = POWER_CVT(*p);
875 scale = POWER_SCALE(*p);
877 if (++p == q) return NULL;
878 if ((*p & 0x7f) < 100)
879 pwr->param[i] += (*p & 0x7f) * scale / 100;
881 pwr->flags |= CISTPL_POWER_HIGHZ_OK;
885 pwr->flags |= CISTPL_POWER_HIGHZ_REQ;
894 /*====================================================================*/
896 static u_char *parse_timing(u_char *p, u_char *q,
897 cistpl_timing_t *timing)
901 if (p == q) return NULL;
903 if ((scale & 3) != 3) {
904 if (++p == q) return NULL;
905 timing->wait = SPEED_CVT(*p);
906 timing->waitscale = exponent[scale & 3];
910 if ((scale & 7) != 7) {
911 if (++p == q) return NULL;
912 timing->ready = SPEED_CVT(*p);
913 timing->rdyscale = exponent[scale & 7];
918 if (++p == q) return NULL;
919 timing->reserved = SPEED_CVT(*p);
920 timing->rsvscale = exponent[scale];
922 timing->reserved = 0;
927 /*====================================================================*/
929 static u_char *parse_io(u_char *p, u_char *q, cistpl_io_t *io)
933 if (p == q) return NULL;
939 io->win[0].len = (1 << (io->flags & CISTPL_IO_LINES_MASK));
943 if (++p == q) return NULL;
944 io->nwin = (*p & 0x0f) + 1;
945 bsz = (*p & 0x30) >> 4;
947 lsz = (*p & 0xc0) >> 6;
951 for (i = 0; i < io->nwin; i++) {
954 for (j = 0; j < bsz; j++, p++) {
955 if (p == q) return NULL;
956 io->win[i].base += *p << (j*8);
958 for (j = 0; j < lsz; j++, p++) {
959 if (p == q) return NULL;
960 io->win[i].len += *p << (j*8);
966 /*====================================================================*/
968 static u_char *parse_mem(u_char *p, u_char *q, cistpl_mem_t *mem)
970 int i, j, asz, lsz, has_ha;
973 if (p == q) return NULL;
975 mem->nwin = (*p & 0x07) + 1;
976 lsz = (*p & 0x18) >> 3;
977 asz = (*p & 0x60) >> 5;
978 has_ha = (*p & 0x80);
979 if (++p == q) return NULL;
981 for (i = 0; i < mem->nwin; i++) {
983 for (j = 0; j < lsz; j++, p++) {
984 if (p == q) return NULL;
987 for (j = 0; j < asz; j++, p++) {
988 if (p == q) return NULL;
992 for (j = 0; j < asz; j++, p++) {
993 if (p == q) return NULL;
996 mem->win[i].len = len << 8;
997 mem->win[i].card_addr = ca << 8;
998 mem->win[i].host_addr = ha << 8;
1003 /*====================================================================*/
1005 static u_char *parse_irq(u_char *p, u_char *q, cistpl_irq_t *irq)
1007 if (p == q) return NULL;
1008 irq->IRQInfo1 = *p; p++;
1009 if (irq->IRQInfo1 & IRQ_INFO2_VALID) {
1010 if (p+2 > q) return NULL;
1011 irq->IRQInfo2 = (p[1]<<8) + p[0];
1017 /*====================================================================*/
1019 static int parse_cftable_entry(tuple_t *tuple,
1020 cistpl_cftable_entry_t *entry)
1022 u_char *p, *q, features;
1024 p = tuple->TupleData;
1025 q = p + tuple->TupleDataLen;
1026 entry->index = *p & 0x3f;
1029 entry->flags |= CISTPL_CFTABLE_DEFAULT;
1031 if (++p == q) return CS_BAD_TUPLE;
1033 entry->flags |= CISTPL_CFTABLE_BVDS;
1035 entry->flags |= CISTPL_CFTABLE_WP;
1037 entry->flags |= CISTPL_CFTABLE_RDYBSY;
1039 entry->flags |= CISTPL_CFTABLE_MWAIT;
1040 entry->interface = *p & 0x0f;
1042 entry->interface = 0;
1044 /* Process optional features */
1045 if (++p == q) return CS_BAD_TUPLE;
1049 if ((features & 3) > 0) {
1050 p = parse_power(p, q, &entry->vcc);
1051 if (p == NULL) return CS_BAD_TUPLE;
1053 entry->vcc.present = 0;
1054 if ((features & 3) > 1) {
1055 p = parse_power(p, q, &entry->vpp1);
1056 if (p == NULL) return CS_BAD_TUPLE;
1058 entry->vpp1.present = 0;
1059 if ((features & 3) > 2) {
1060 p = parse_power(p, q, &entry->vpp2);
1061 if (p == NULL) return CS_BAD_TUPLE;
1063 entry->vpp2.present = 0;
1065 /* Timing options */
1066 if (features & 0x04) {
1067 p = parse_timing(p, q, &entry->timing);
1068 if (p == NULL) return CS_BAD_TUPLE;
1070 entry->timing.wait = 0;
1071 entry->timing.ready = 0;
1072 entry->timing.reserved = 0;
1075 /* I/O window options */
1076 if (features & 0x08) {
1077 p = parse_io(p, q, &entry->io);
1078 if (p == NULL) return CS_BAD_TUPLE;
1082 /* Interrupt options */
1083 if (features & 0x10) {
1084 p = parse_irq(p, q, &entry->irq);
1085 if (p == NULL) return CS_BAD_TUPLE;
1087 entry->irq.IRQInfo1 = 0;
1089 switch (features & 0x60) {
1091 entry->mem.nwin = 0;
1094 entry->mem.nwin = 1;
1095 entry->mem.win[0].len = le16_to_cpu(*(__le16 *)p) << 8;
1096 entry->mem.win[0].card_addr = 0;
1097 entry->mem.win[0].host_addr = 0;
1099 if (p > q) return CS_BAD_TUPLE;
1102 entry->mem.nwin = 1;
1103 entry->mem.win[0].len = le16_to_cpu(*(__le16 *)p) << 8;
1104 entry->mem.win[0].card_addr =
1105 le16_to_cpu(*(__le16 *)(p+2)) << 8;
1106 entry->mem.win[0].host_addr = 0;
1108 if (p > q) return CS_BAD_TUPLE;
1111 p = parse_mem(p, q, &entry->mem);
1112 if (p == NULL) return CS_BAD_TUPLE;
1117 if (features & 0x80) {
1118 if (p == q) return CS_BAD_TUPLE;
1119 entry->flags |= (*p << 8);
1121 if (++p == q) return CS_BAD_TUPLE;
1125 entry->subtuples = q-p;
1130 /*====================================================================*/
1132 #ifdef CONFIG_CARDBUS
1134 static int parse_bar(tuple_t *tuple, cistpl_bar_t *bar)
1137 if (tuple->TupleDataLen < 6)
1138 return CS_BAD_TUPLE;
1139 p = (u_char *)tuple->TupleData;
1142 bar->size = le32_to_cpu(*(__le32 *)p);
1146 static int parse_config_cb(tuple_t *tuple, cistpl_config_t *config)
1150 p = (u_char *)tuple->TupleData;
1151 if ((*p != 3) || (tuple->TupleDataLen < 6))
1152 return CS_BAD_TUPLE;
1153 config->last_idx = *(++p);
1155 config->base = le32_to_cpu(*(__le32 *)p);
1156 config->subtuples = tuple->TupleDataLen - 6;
1160 static int parse_cftable_entry_cb(tuple_t *tuple,
1161 cistpl_cftable_entry_cb_t *entry)
1163 u_char *p, *q, features;
1165 p = tuple->TupleData;
1166 q = p + tuple->TupleDataLen;
1167 entry->index = *p & 0x3f;
1170 entry->flags |= CISTPL_CFTABLE_DEFAULT;
1172 /* Process optional features */
1173 if (++p == q) return CS_BAD_TUPLE;
1177 if ((features & 3) > 0) {
1178 p = parse_power(p, q, &entry->vcc);
1179 if (p == NULL) return CS_BAD_TUPLE;
1181 entry->vcc.present = 0;
1182 if ((features & 3) > 1) {
1183 p = parse_power(p, q, &entry->vpp1);
1184 if (p == NULL) return CS_BAD_TUPLE;
1186 entry->vpp1.present = 0;
1187 if ((features & 3) > 2) {
1188 p = parse_power(p, q, &entry->vpp2);
1189 if (p == NULL) return CS_BAD_TUPLE;
1191 entry->vpp2.present = 0;
1193 /* I/O window options */
1194 if (features & 0x08) {
1195 if (p == q) return CS_BAD_TUPLE;
1196 entry->io = *p; p++;
1200 /* Interrupt options */
1201 if (features & 0x10) {
1202 p = parse_irq(p, q, &entry->irq);
1203 if (p == NULL) return CS_BAD_TUPLE;
1205 entry->irq.IRQInfo1 = 0;
1207 if (features & 0x20) {
1208 if (p == q) return CS_BAD_TUPLE;
1209 entry->mem = *p; p++;
1214 if (features & 0x80) {
1215 if (p == q) return CS_BAD_TUPLE;
1216 entry->flags |= (*p << 8);
1218 if (++p == q) return CS_BAD_TUPLE;
1219 entry->flags |= (*p << 16);
1222 if (++p == q) return CS_BAD_TUPLE;
1226 entry->subtuples = q-p;
1233 /*====================================================================*/
1235 static int parse_device_geo(tuple_t *tuple, cistpl_device_geo_t *geo)
1240 p = (u_char *)tuple->TupleData;
1241 q = p + tuple->TupleDataLen;
1243 for (n = 0; n < CISTPL_MAX_DEVICES; n++) {
1245 geo->geo[n].buswidth = p[0];
1246 geo->geo[n].erase_block = 1 << (p[1]-1);
1247 geo->geo[n].read_block = 1 << (p[2]-1);
1248 geo->geo[n].write_block = 1 << (p[3]-1);
1249 geo->geo[n].partition = 1 << (p[4]-1);
1250 geo->geo[n].interleave = 1 << (p[5]-1);
1257 /*====================================================================*/
1259 static int parse_vers_2(tuple_t *tuple, cistpl_vers_2_t *v2)
1263 if (tuple->TupleDataLen < 10)
1264 return CS_BAD_TUPLE;
1266 p = tuple->TupleData;
1267 q = p + tuple->TupleDataLen;
1271 v2->dindex = le16_to_cpu(*(__le16 *)(p+2));
1276 return parse_strings(p, q, 2, v2->str, &v2->vendor, NULL);
1279 /*====================================================================*/
1281 static int parse_org(tuple_t *tuple, cistpl_org_t *org)
1286 p = tuple->TupleData;
1287 q = p + tuple->TupleDataLen;
1288 if (p == q) return CS_BAD_TUPLE;
1290 if (++p == q) return CS_BAD_TUPLE;
1291 for (i = 0; i < 30; i++) {
1293 if (*p == '\0') break;
1294 if (++p == q) return CS_BAD_TUPLE;
1299 /*====================================================================*/
1301 static int parse_format(tuple_t *tuple, cistpl_format_t *fmt)
1305 if (tuple->TupleDataLen < 10)
1306 return CS_BAD_TUPLE;
1308 p = tuple->TupleData;
1312 fmt->offset = le32_to_cpu(*(__le32 *)(p+2));
1313 fmt->length = le32_to_cpu(*(__le32 *)(p+6));
1318 /*====================================================================*/
1320 int pccard_parse_tuple(tuple_t *tuple, cisparse_t *parse)
1322 int ret = CS_SUCCESS;
1324 if (tuple->TupleDataLen > tuple->TupleDataMax)
1325 return CS_BAD_TUPLE;
1326 switch (tuple->TupleCode) {
1328 case CISTPL_DEVICE_A:
1329 ret = parse_device(tuple, &parse->device);
1331 #ifdef CONFIG_CARDBUS
1333 ret = parse_bar(tuple, &parse->bar);
1335 case CISTPL_CONFIG_CB:
1336 ret = parse_config_cb(tuple, &parse->config);
1338 case CISTPL_CFTABLE_ENTRY_CB:
1339 ret = parse_cftable_entry_cb(tuple, &parse->cftable_entry_cb);
1342 case CISTPL_CHECKSUM:
1343 ret = parse_checksum(tuple, &parse->checksum);
1345 case CISTPL_LONGLINK_A:
1346 case CISTPL_LONGLINK_C:
1347 ret = parse_longlink(tuple, &parse->longlink);
1349 case CISTPL_LONGLINK_MFC:
1350 ret = parse_longlink_mfc(tuple, &parse->longlink_mfc);
1353 ret = parse_vers_1(tuple, &parse->version_1);
1356 ret = parse_altstr(tuple, &parse->altstr);
1358 case CISTPL_JEDEC_A:
1359 case CISTPL_JEDEC_C:
1360 ret = parse_jedec(tuple, &parse->jedec);
1363 ret = parse_manfid(tuple, &parse->manfid);
1366 ret = parse_funcid(tuple, &parse->funcid);
1369 ret = parse_funce(tuple, &parse->funce);
1372 ret = parse_config(tuple, &parse->config);
1374 case CISTPL_CFTABLE_ENTRY:
1375 ret = parse_cftable_entry(tuple, &parse->cftable_entry);
1377 case CISTPL_DEVICE_GEO:
1378 case CISTPL_DEVICE_GEO_A:
1379 ret = parse_device_geo(tuple, &parse->device_geo);
1382 ret = parse_vers_2(tuple, &parse->vers_2);
1385 ret = parse_org(tuple, &parse->org);
1388 case CISTPL_FORMAT_A:
1389 ret = parse_format(tuple, &parse->format);
1391 case CISTPL_NO_LINK:
1392 case CISTPL_LINKTARGET:
1396 ret = CS_UNSUPPORTED_FUNCTION;
1401 EXPORT_SYMBOL(pccard_parse_tuple);
1403 /*======================================================================
1405 This is used internally by Card Services to look up CIS stuff.
1407 ======================================================================*/
1409 int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function, cisdata_t code, void *parse)
1415 buf = kmalloc(256, GFP_KERNEL);
1417 return CS_OUT_OF_RESOURCE;
1418 tuple.DesiredTuple = code;
1419 tuple.Attributes = TUPLE_RETURN_COMMON;
1420 ret = pccard_get_first_tuple(s, function, &tuple);
1421 if (ret != CS_SUCCESS) goto done;
1422 tuple.TupleData = buf;
1423 tuple.TupleOffset = 0;
1424 tuple.TupleDataMax = 255;
1425 ret = pccard_get_tuple_data(s, &tuple);
1426 if (ret != CS_SUCCESS) goto done;
1427 ret = pccard_parse_tuple(&tuple, parse);
1432 EXPORT_SYMBOL(pccard_read_tuple);
1434 /*======================================================================
1436 This tries to determine if a card has a sensible CIS. It returns
1437 the number of tuples in the CIS, or 0 if the CIS looks bad. The
1438 checks include making sure several critical tuples are present and
1439 valid; seeing if the total number of tuples is reasonable; and
1440 looking for tuples that use reserved codes.
1442 ======================================================================*/
1444 int pccard_validate_cis(struct pcmcia_socket *s, unsigned int function, cisinfo_t *info)
1448 int ret, reserved, dev_ok = 0, ident_ok = 0;
1451 return CS_BAD_HANDLE;
1453 tuple = kmalloc(sizeof(*tuple), GFP_KERNEL);
1455 return CS_OUT_OF_RESOURCE;
1456 p = kmalloc(sizeof(*p), GFP_KERNEL);
1459 return CS_OUT_OF_RESOURCE;
1462 info->Chains = reserved = 0;
1463 tuple->DesiredTuple = RETURN_FIRST_TUPLE;
1464 tuple->Attributes = TUPLE_RETURN_COMMON;
1465 ret = pccard_get_first_tuple(s, function, tuple);
1466 if (ret != CS_SUCCESS)
1469 /* First tuple should be DEVICE; we should really have either that
1470 or a CFTABLE_ENTRY of some sort */
1471 if ((tuple->TupleCode == CISTPL_DEVICE) ||
1472 (pccard_read_tuple(s, function, CISTPL_CFTABLE_ENTRY, p) == CS_SUCCESS) ||
1473 (pccard_read_tuple(s, function, CISTPL_CFTABLE_ENTRY_CB, p) == CS_SUCCESS))
1476 /* All cards should have a MANFID tuple, and/or a VERS_1 or VERS_2
1477 tuple, for card identification. Certain old D-Link and Linksys
1478 cards have only a broken VERS_2 tuple; hence the bogus test. */
1479 if ((pccard_read_tuple(s, function, CISTPL_MANFID, p) == CS_SUCCESS) ||
1480 (pccard_read_tuple(s, function, CISTPL_VERS_1, p) == CS_SUCCESS) ||
1481 (pccard_read_tuple(s, function, CISTPL_VERS_2, p) != CS_NO_MORE_ITEMS))
1484 if (!dev_ok && !ident_ok)
1487 for (info->Chains = 1; info->Chains < MAX_TUPLES; info->Chains++) {
1488 ret = pccard_get_next_tuple(s, function, tuple);
1489 if (ret != CS_SUCCESS) break;
1490 if (((tuple->TupleCode > 0x23) && (tuple->TupleCode < 0x40)) ||
1491 ((tuple->TupleCode > 0x47) && (tuple->TupleCode < 0x80)) ||
1492 ((tuple->TupleCode > 0x90) && (tuple->TupleCode < 0xff)))
1495 if ((info->Chains == MAX_TUPLES) || (reserved > 5) ||
1496 ((!dev_ok || !ident_ok) && (info->Chains > 10)))
1504 EXPORT_SYMBOL(pccard_validate_cis);