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/config.h>
16 #include <linux/module.h>
17 #include <linux/moduleparam.h>
18 #include <linux/kernel.h>
19 #include <linux/string.h>
20 #include <linux/major.h>
21 #include <linux/errno.h>
22 #include <linux/timer.h>
23 #include <linux/slab.h>
25 #include <linux/sched.h>
26 #include <linux/pci.h>
27 #include <linux/ioport.h>
29 #include <asm/byteorder.h>
31 #include <pcmcia/cs_types.h>
32 #include <pcmcia/ss.h>
33 #include <pcmcia/cs.h>
34 #include <pcmcia/bulkmem.h>
35 #include <pcmcia/cisreg.h>
36 #include <pcmcia/cistpl.h>
37 #include "cs_internal.h"
39 static const u_char mantissa[] = {
40 10, 12, 13, 15, 20, 25, 30, 35,
41 40, 45, 50, 55, 60, 70, 80, 90
44 static const u_int exponent[] = {
45 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000
48 /* Convert an extended speed byte to a time in nanoseconds */
49 #define SPEED_CVT(v) \
50 (mantissa[(((v)>>3)&15)-1] * exponent[(v)&7] / 10)
51 /* Convert a power byte to a current in 0.1 microamps */
52 #define POWER_CVT(v) \
53 (mantissa[((v)>>3)&15] * exponent[(v)&7] / 10)
54 #define POWER_SCALE(v) (exponent[(v)&7])
56 /* Upper limit on reasonable # of tuples */
57 #define MAX_TUPLES 200
59 /*====================================================================*/
61 /* Parameters that can be set with 'insmod' */
63 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0444)
65 INT_MODULE_PARM(cis_width, 0); /* 16-bit CIS? */
67 void release_cis_mem(struct pcmcia_socket *s)
69 if (s->cis_mem.flags & MAP_ACTIVE) {
70 s->cis_mem.flags &= ~MAP_ACTIVE;
71 s->ops->set_mem_map(s, &s->cis_mem);
73 release_resource(s->cis_mem.res);
74 kfree(s->cis_mem.res);
75 s->cis_mem.res = NULL;
81 EXPORT_SYMBOL(release_cis_mem);
84 * Map the card memory at "card_offset" into virtual space.
85 * If flags & MAP_ATTRIB, map the attribute space, otherwise
86 * map the memory space.
89 set_cis_map(struct pcmcia_socket *s, unsigned int card_offset, unsigned int flags)
91 pccard_mem_map *mem = &s->cis_mem;
92 if (!(s->features & SS_CAP_STATIC_MAP) && mem->res == NULL) {
93 mem->res = pcmcia_find_mem_region(0, s->map_size, s->map_size, 0, s);
94 if (mem->res == NULL) {
95 printk(KERN_NOTICE "cs: unable to map card memory!\n");
98 s->cis_virt = ioremap(mem->res->start, s->map_size);
100 mem->card_start = card_offset;
102 s->ops->set_mem_map(s, mem);
103 if (s->features & SS_CAP_STATIC_MAP) {
105 iounmap(s->cis_virt);
106 s->cis_virt = ioremap(mem->static_start, s->map_size);
111 /*======================================================================
113 Low-level functions to read and write CIS memory. I think the
114 write routine is only useful for writing one-byte registers.
116 ======================================================================*/
118 /* Bits in attr field */
120 #define IS_INDIRECT 8
122 int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr, u_int addr,
123 u_int len, void *ptr)
125 void __iomem *sys, *end;
126 unsigned char *buf = ptr;
128 cs_dbg(s, 3, "pcmcia_read_cis_mem(%d, %#x, %u)\n", attr, addr, len);
130 if (attr & IS_INDIRECT) {
131 /* Indirect accesses use a bunch of special registers at fixed
132 locations in common memory */
133 u_char flags = ICTRL0_COMMON|ICTRL0_AUTOINC|ICTRL0_BYTEGRAN;
134 if (attr & IS_ATTR) {
136 flags = ICTRL0_AUTOINC;
139 sys = set_cis_map(s, 0, MAP_ACTIVE | ((cis_width) ? MAP_16BIT : 0));
141 memset(ptr, 0xff, len);
145 writeb(flags, sys+CISREG_ICTRL0);
146 writeb(addr & 0xff, sys+CISREG_IADDR0);
147 writeb((addr>>8) & 0xff, sys+CISREG_IADDR1);
148 writeb((addr>>16) & 0xff, sys+CISREG_IADDR2);
149 writeb((addr>>24) & 0xff, sys+CISREG_IADDR3);
150 for ( ; len > 0; len--, buf++)
151 *buf = readb(sys+CISREG_IDATA0);
153 u_int inc = 1, card_offset, flags;
155 flags = MAP_ACTIVE | ((cis_width) ? MAP_16BIT : 0);
162 card_offset = addr & ~(s->map_size-1);
164 sys = set_cis_map(s, card_offset, flags);
166 memset(ptr, 0xff, len);
169 end = sys + s->map_size;
170 sys = sys + (addr & (s->map_size-1));
171 for ( ; len > 0; len--, buf++, sys += inc) {
176 card_offset += s->map_size;
180 cs_dbg(s, 3, " %#2.2x %#2.2x %#2.2x %#2.2x ...\n",
181 *(u_char *)(ptr+0), *(u_char *)(ptr+1),
182 *(u_char *)(ptr+2), *(u_char *)(ptr+3));
185 EXPORT_SYMBOL(pcmcia_read_cis_mem);
188 void pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr, u_int addr,
189 u_int len, void *ptr)
191 void __iomem *sys, *end;
192 unsigned char *buf = ptr;
194 cs_dbg(s, 3, "pcmcia_write_cis_mem(%d, %#x, %u)\n", attr, addr, len);
196 if (attr & IS_INDIRECT) {
197 /* Indirect accesses use a bunch of special registers at fixed
198 locations in common memory */
199 u_char flags = ICTRL0_COMMON|ICTRL0_AUTOINC|ICTRL0_BYTEGRAN;
200 if (attr & IS_ATTR) {
202 flags = ICTRL0_AUTOINC;
205 sys = set_cis_map(s, 0, MAP_ACTIVE | ((cis_width) ? MAP_16BIT : 0));
207 return; /* FIXME: Error */
209 writeb(flags, sys+CISREG_ICTRL0);
210 writeb(addr & 0xff, sys+CISREG_IADDR0);
211 writeb((addr>>8) & 0xff, sys+CISREG_IADDR1);
212 writeb((addr>>16) & 0xff, sys+CISREG_IADDR2);
213 writeb((addr>>24) & 0xff, sys+CISREG_IADDR3);
214 for ( ; len > 0; len--, buf++)
215 writeb(*buf, sys+CISREG_IDATA0);
217 u_int inc = 1, card_offset, flags;
219 flags = MAP_ACTIVE | ((cis_width) ? MAP_16BIT : 0);
220 if (attr & IS_ATTR) {
226 card_offset = addr & ~(s->map_size-1);
228 sys = set_cis_map(s, card_offset, flags);
230 return; /* FIXME: error */
232 end = sys + s->map_size;
233 sys = sys + (addr & (s->map_size-1));
234 for ( ; len > 0; len--, buf++, sys += inc) {
239 card_offset += s->map_size;
244 EXPORT_SYMBOL(pcmcia_write_cis_mem);
247 /*======================================================================
249 This is a wrapper around read_cis_mem, with the same interface,
250 but which caches information, for cards whose CIS may not be
251 readable all the time.
253 ======================================================================*/
255 static void read_cis_cache(struct pcmcia_socket *s, int attr, u_int addr,
256 u_int len, void *ptr)
258 struct cis_cache_entry *cis;
262 if (s->fake_cis_len > addr+len)
263 memcpy(ptr, s->fake_cis+addr, len);
265 memset(ptr, 0xff, len);
269 list_for_each_entry(cis, &s->cis_cache, node) {
270 if (cis->addr == addr && cis->len == len && cis->attr == attr) {
271 memcpy(ptr, cis->cache, len);
276 #ifdef CONFIG_CARDBUS
277 if (s->state & SOCKET_CARDBUS)
278 ret = read_cb_mem(s, attr, addr, len, ptr);
281 ret = pcmcia_read_cis_mem(s, attr, addr, len, ptr);
284 /* Copy data into the cache */
285 cis = kmalloc(sizeof(struct cis_cache_entry) + len, GFP_KERNEL);
290 memcpy(cis->cache, ptr, len);
291 list_add(&cis->node, &s->cis_cache);
297 remove_cis_cache(struct pcmcia_socket *s, int attr, u_int addr, u_int len)
299 struct cis_cache_entry *cis;
301 list_for_each_entry(cis, &s->cis_cache, node)
302 if (cis->addr == addr && cis->len == len && cis->attr == attr) {
303 list_del(&cis->node);
309 void destroy_cis_cache(struct pcmcia_socket *s)
311 struct list_head *l, *n;
313 list_for_each_safe(l, n, &s->cis_cache) {
314 struct cis_cache_entry *cis = list_entry(l, struct cis_cache_entry, node);
316 list_del(&cis->node);
321 * If there was a fake CIS, destroy that as well.
328 EXPORT_SYMBOL(destroy_cis_cache);
330 /*======================================================================
332 This verifies if the CIS of a card matches what is in the CIS
335 ======================================================================*/
337 int verify_cis_cache(struct pcmcia_socket *s)
339 struct cis_cache_entry *cis;
342 buf = kmalloc(256, GFP_KERNEL);
345 list_for_each_entry(cis, &s->cis_cache, node) {
350 #ifdef CONFIG_CARDBUS
351 if (s->state & SOCKET_CARDBUS)
352 read_cb_mem(s, cis->attr, cis->addr, len, buf);
355 pcmcia_read_cis_mem(s, cis->attr, cis->addr, len, buf);
357 if (memcmp(buf, cis->cache, len) != 0) {
366 /*======================================================================
368 For really bad cards, we provide a facility for uploading a
371 ======================================================================*/
373 int pcmcia_replace_cis(struct pcmcia_socket *s, cisdump_t *cis)
375 if (s->fake_cis != NULL) {
379 if (cis->Length > CISTPL_MAX_CIS_SIZE)
381 s->fake_cis = kmalloc(cis->Length, GFP_KERNEL);
382 if (s->fake_cis == NULL)
383 return CS_OUT_OF_RESOURCE;
384 s->fake_cis_len = cis->Length;
385 memcpy(s->fake_cis, cis->Data, cis->Length);
389 /*======================================================================
391 The high-level CIS tuple services
393 ======================================================================*/
395 typedef struct tuple_flags {
402 #define LINK_SPACE(f) (((tuple_flags *)(&(f)))->link_space)
403 #define HAS_LINK(f) (((tuple_flags *)(&(f)))->has_link)
404 #define MFC_FN(f) (((tuple_flags *)(&(f)))->mfc_fn)
405 #define SPACE(f) (((tuple_flags *)(&(f)))->space)
407 int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int func, tuple_t *tuple);
409 int pccard_get_first_tuple(struct pcmcia_socket *s, unsigned int function, tuple_t *tuple)
412 return CS_BAD_HANDLE;
413 if (!(s->state & SOCKET_PRESENT))
415 tuple->TupleLink = tuple->Flags = 0;
416 #ifdef CONFIG_CARDBUS
417 if (s->state & SOCKET_CARDBUS) {
418 struct pci_dev *dev = s->cb_dev;
420 pci_bus_read_config_dword(dev->subordinate, 0, PCI_CARDBUS_CIS, &ptr);
421 tuple->CISOffset = ptr & ~7;
422 SPACE(tuple->Flags) = (ptr & 7);
426 /* Assume presence of a LONGLINK_C to address 0 */
427 tuple->CISOffset = tuple->LinkOffset = 0;
428 SPACE(tuple->Flags) = HAS_LINK(tuple->Flags) = 1;
430 if (!(s->state & SOCKET_CARDBUS) && (s->functions > 1) &&
431 !(tuple->Attributes & TUPLE_RETURN_COMMON)) {
432 cisdata_t req = tuple->DesiredTuple;
433 tuple->DesiredTuple = CISTPL_LONGLINK_MFC;
434 if (pccard_get_next_tuple(s, function, tuple) == CS_SUCCESS) {
435 tuple->DesiredTuple = CISTPL_LINKTARGET;
436 if (pccard_get_next_tuple(s, function, tuple) != CS_SUCCESS)
437 return CS_NO_MORE_ITEMS;
439 tuple->CISOffset = tuple->TupleLink = 0;
440 tuple->DesiredTuple = req;
442 return pccard_get_next_tuple(s, function, tuple);
444 EXPORT_SYMBOL(pccard_get_first_tuple);
446 static int follow_link(struct pcmcia_socket *s, tuple_t *tuple)
451 if (MFC_FN(tuple->Flags)) {
452 /* Get indirect link from the MFC tuple */
453 read_cis_cache(s, LINK_SPACE(tuple->Flags),
454 tuple->LinkOffset, 5, link);
455 ofs = le32_to_cpu(*(u_int *)(link+1));
456 SPACE(tuple->Flags) = (link[0] == CISTPL_MFC_ATTR);
457 /* Move to the next indirect link */
458 tuple->LinkOffset += 5;
459 MFC_FN(tuple->Flags)--;
460 } else if (HAS_LINK(tuple->Flags)) {
461 ofs = tuple->LinkOffset;
462 SPACE(tuple->Flags) = LINK_SPACE(tuple->Flags);
463 HAS_LINK(tuple->Flags) = 0;
467 if (!(s->state & SOCKET_CARDBUS) && SPACE(tuple->Flags)) {
468 /* This is ugly, but a common CIS error is to code the long
469 link offset incorrectly, so we check the right spot... */
470 read_cis_cache(s, SPACE(tuple->Flags), ofs, 5, link);
471 if ((link[0] == CISTPL_LINKTARGET) && (link[1] >= 3) &&
472 (strncmp(link+2, "CIS", 3) == 0))
474 remove_cis_cache(s, SPACE(tuple->Flags), ofs, 5);
475 /* Then, we try the wrong spot... */
478 read_cis_cache(s, SPACE(tuple->Flags), ofs, 5, link);
479 if ((link[0] == CISTPL_LINKTARGET) && (link[1] >= 3) &&
480 (strncmp(link+2, "CIS", 3) == 0))
482 remove_cis_cache(s, SPACE(tuple->Flags), ofs, 5);
486 int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int function, tuple_t *tuple)
492 return CS_BAD_HANDLE;
493 if (!(s->state & SOCKET_PRESENT))
496 link[1] = tuple->TupleLink;
497 ofs = tuple->CISOffset + tuple->TupleLink;
498 attr = SPACE(tuple->Flags);
500 for (i = 0; i < MAX_TUPLES; i++) {
501 if (link[1] == 0xff) {
502 link[0] = CISTPL_END;
504 read_cis_cache(s, attr, ofs, 2, link);
505 if (link[0] == CISTPL_NULL) {
510 /* End of chain? Follow long link if possible */
511 if (link[0] == CISTPL_END) {
512 if ((ofs = follow_link(s, tuple)) < 0)
513 return CS_NO_MORE_ITEMS;
514 attr = SPACE(tuple->Flags);
515 read_cis_cache(s, attr, ofs, 2, link);
518 /* Is this a link tuple? Make a note of it */
519 if ((link[0] == CISTPL_LONGLINK_A) ||
520 (link[0] == CISTPL_LONGLINK_C) ||
521 (link[0] == CISTPL_LONGLINK_MFC) ||
522 (link[0] == CISTPL_LINKTARGET) ||
523 (link[0] == CISTPL_INDIRECT) ||
524 (link[0] == CISTPL_NO_LINK)) {
526 case CISTPL_LONGLINK_A:
527 HAS_LINK(tuple->Flags) = 1;
528 LINK_SPACE(tuple->Flags) = attr | IS_ATTR;
529 read_cis_cache(s, attr, ofs+2, 4, &tuple->LinkOffset);
531 case CISTPL_LONGLINK_C:
532 HAS_LINK(tuple->Flags) = 1;
533 LINK_SPACE(tuple->Flags) = attr & ~IS_ATTR;
534 read_cis_cache(s, attr, ofs+2, 4, &tuple->LinkOffset);
536 case CISTPL_INDIRECT:
537 HAS_LINK(tuple->Flags) = 1;
538 LINK_SPACE(tuple->Flags) = IS_ATTR | IS_INDIRECT;
539 tuple->LinkOffset = 0;
541 case CISTPL_LONGLINK_MFC:
542 tuple->LinkOffset = ofs + 3;
543 LINK_SPACE(tuple->Flags) = attr;
544 if (function == BIND_FN_ALL) {
545 /* Follow all the MFC links */
546 read_cis_cache(s, attr, ofs+2, 1, &tmp);
547 MFC_FN(tuple->Flags) = tmp;
549 /* Follow exactly one of the links */
550 MFC_FN(tuple->Flags) = 1;
551 tuple->LinkOffset += function * 5;
555 HAS_LINK(tuple->Flags) = 0;
558 if ((tuple->Attributes & TUPLE_RETURN_LINK) &&
559 (tuple->DesiredTuple == RETURN_FIRST_TUPLE))
562 if (tuple->DesiredTuple == RETURN_FIRST_TUPLE)
565 if (link[0] == tuple->DesiredTuple)
569 if (i == MAX_TUPLES) {
570 cs_dbg(s, 1, "cs: overrun in pcmcia_get_next_tuple\n");
571 return CS_NO_MORE_ITEMS;
574 tuple->TupleCode = link[0];
575 tuple->TupleLink = link[1];
576 tuple->CISOffset = ofs + 2;
579 EXPORT_SYMBOL(pccard_get_next_tuple);
581 /*====================================================================*/
583 #define _MIN(a, b) (((a) < (b)) ? (a) : (b))
585 int pccard_get_tuple_data(struct pcmcia_socket *s, tuple_t *tuple)
590 return CS_BAD_HANDLE;
592 if (tuple->TupleLink < tuple->TupleOffset)
593 return CS_NO_MORE_ITEMS;
594 len = tuple->TupleLink - tuple->TupleOffset;
595 tuple->TupleDataLen = tuple->TupleLink;
598 read_cis_cache(s, SPACE(tuple->Flags),
599 tuple->CISOffset + tuple->TupleOffset,
600 _MIN(len, tuple->TupleDataMax), tuple->TupleData);
603 EXPORT_SYMBOL(pccard_get_tuple_data);
606 /*======================================================================
608 Parsing routines for individual tuples
610 ======================================================================*/
612 static int parse_device(tuple_t *tuple, cistpl_device_t *device)
618 p = (u_char *)tuple->TupleData;
619 q = p + tuple->TupleDataLen;
622 for (i = 0; i < CISTPL_MAX_DEVICES; i++) {
624 if (*p == 0xff) break;
625 device->dev[i].type = (*p >> 4);
626 device->dev[i].wp = (*p & 0x08) ? 1 : 0;
628 case 0: device->dev[i].speed = 0; break;
629 case 1: device->dev[i].speed = 250; break;
630 case 2: device->dev[i].speed = 200; break;
631 case 3: device->dev[i].speed = 150; break;
632 case 4: device->dev[i].speed = 100; break;
634 if (++p == q) return CS_BAD_TUPLE;
635 device->dev[i].speed = SPEED_CVT(*p);
637 if (++p == q) return CS_BAD_TUPLE;
643 if (++p == q) return CS_BAD_TUPLE;
644 if (*p == 0xff) break;
646 if (scale == 7) return CS_BAD_TUPLE;
647 device->dev[i].size = ((*p >> 3) + 1) * (512 << (scale*2));
655 /*====================================================================*/
657 static int parse_checksum(tuple_t *tuple, cistpl_checksum_t *csum)
660 if (tuple->TupleDataLen < 5)
662 p = (u_char *)tuple->TupleData;
663 csum->addr = tuple->CISOffset+(short)le16_to_cpu(*(u_short *)p)-2;
664 csum->len = le16_to_cpu(*(u_short *)(p + 2));
669 /*====================================================================*/
671 static int parse_longlink(tuple_t *tuple, cistpl_longlink_t *link)
673 if (tuple->TupleDataLen < 4)
675 link->addr = le32_to_cpu(*(u_int *)tuple->TupleData);
679 /*====================================================================*/
681 static int parse_longlink_mfc(tuple_t *tuple,
682 cistpl_longlink_mfc_t *link)
687 p = (u_char *)tuple->TupleData;
690 if (tuple->TupleDataLen <= link->nfn*5)
692 for (i = 0; i < link->nfn; i++) {
693 link->fn[i].space = *p; p++;
694 link->fn[i].addr = le32_to_cpu(*(u_int *)p); p += 4;
699 /*====================================================================*/
701 static int parse_strings(u_char *p, u_char *q, int max,
702 char *s, u_char *ofs, u_char *found)
706 if (p == q) return CS_BAD_TUPLE;
708 for (i = 0; i < max; i++) {
709 if (*p == 0xff) break;
713 s[j++] = (*p == 0xff) ? '\0' : *p;
714 if ((*p == '\0') || (*p == 0xff)) break;
715 if (++p == q) return CS_BAD_TUPLE;
717 if ((*p == 0xff) || (++p == q)) break;
723 return (ns == max) ? CS_SUCCESS : CS_BAD_TUPLE;
727 /*====================================================================*/
729 static int parse_vers_1(tuple_t *tuple, cistpl_vers_1_t *vers_1)
733 p = (u_char *)tuple->TupleData;
734 q = p + tuple->TupleDataLen;
736 vers_1->major = *p; p++;
737 vers_1->minor = *p; p++;
738 if (p >= q) return CS_BAD_TUPLE;
740 return parse_strings(p, q, CISTPL_VERS_1_MAX_PROD_STRINGS,
741 vers_1->str, vers_1->ofs, &vers_1->ns);
744 /*====================================================================*/
746 static int parse_altstr(tuple_t *tuple, cistpl_altstr_t *altstr)
750 p = (u_char *)tuple->TupleData;
751 q = p + tuple->TupleDataLen;
753 return parse_strings(p, q, CISTPL_MAX_ALTSTR_STRINGS,
754 altstr->str, altstr->ofs, &altstr->ns);
757 /*====================================================================*/
759 static int parse_jedec(tuple_t *tuple, cistpl_jedec_t *jedec)
764 p = (u_char *)tuple->TupleData;
765 q = p + tuple->TupleDataLen;
767 for (nid = 0; nid < CISTPL_MAX_DEVICES; nid++) {
769 jedec->id[nid].mfr = p[0];
770 jedec->id[nid].info = p[1];
777 /*====================================================================*/
779 static int parse_manfid(tuple_t *tuple, cistpl_manfid_t *m)
782 if (tuple->TupleDataLen < 4)
784 p = (u_short *)tuple->TupleData;
785 m->manf = le16_to_cpu(p[0]);
786 m->card = le16_to_cpu(p[1]);
790 /*====================================================================*/
792 static int parse_funcid(tuple_t *tuple, cistpl_funcid_t *f)
795 if (tuple->TupleDataLen < 2)
797 p = (u_char *)tuple->TupleData;
803 /*====================================================================*/
805 static int parse_funce(tuple_t *tuple, cistpl_funce_t *f)
809 if (tuple->TupleDataLen < 1)
811 p = (u_char *)tuple->TupleData;
813 for (i = 1; i < tuple->TupleDataLen; i++)
818 /*====================================================================*/
820 static int parse_config(tuple_t *tuple, cistpl_config_t *config)
825 p = (u_char *)tuple->TupleData;
827 rmsz = (*p & 0x3c) >> 2;
828 if (tuple->TupleDataLen < rasz+rmsz+4)
830 config->last_idx = *(++p);
833 for (i = 0; i <= rasz; i++)
834 config->base += p[i] << (8*i);
836 for (i = 0; i < 4; i++)
837 config->rmask[i] = 0;
838 for (i = 0; i <= rmsz; i++)
839 config->rmask[i>>2] += p[i] << (8*(i%4));
840 config->subtuples = tuple->TupleDataLen - (rasz+rmsz+4);
844 /*======================================================================
846 The following routines are all used to parse the nightmarish
847 config table entries.
849 ======================================================================*/
851 static u_char *parse_power(u_char *p, u_char *q,
857 if (p == q) return NULL;
861 for (i = 0; i < 7; i++)
862 if (pwr->present & (1<<i)) {
863 if (p == q) return NULL;
864 pwr->param[i] = POWER_CVT(*p);
865 scale = POWER_SCALE(*p);
867 if (++p == q) return NULL;
868 if ((*p & 0x7f) < 100)
869 pwr->param[i] += (*p & 0x7f) * scale / 100;
871 pwr->flags |= CISTPL_POWER_HIGHZ_OK;
875 pwr->flags |= CISTPL_POWER_HIGHZ_REQ;
884 /*====================================================================*/
886 static u_char *parse_timing(u_char *p, u_char *q,
887 cistpl_timing_t *timing)
891 if (p == q) return NULL;
893 if ((scale & 3) != 3) {
894 if (++p == q) return NULL;
895 timing->wait = SPEED_CVT(*p);
896 timing->waitscale = exponent[scale & 3];
900 if ((scale & 7) != 7) {
901 if (++p == q) return NULL;
902 timing->ready = SPEED_CVT(*p);
903 timing->rdyscale = exponent[scale & 7];
908 if (++p == q) return NULL;
909 timing->reserved = SPEED_CVT(*p);
910 timing->rsvscale = exponent[scale];
912 timing->reserved = 0;
917 /*====================================================================*/
919 static u_char *parse_io(u_char *p, u_char *q, cistpl_io_t *io)
923 if (p == q) return NULL;
929 io->win[0].len = (1 << (io->flags & CISTPL_IO_LINES_MASK));
933 if (++p == q) return NULL;
934 io->nwin = (*p & 0x0f) + 1;
935 bsz = (*p & 0x30) >> 4;
937 lsz = (*p & 0xc0) >> 6;
941 for (i = 0; i < io->nwin; i++) {
944 for (j = 0; j < bsz; j++, p++) {
945 if (p == q) return NULL;
946 io->win[i].base += *p << (j*8);
948 for (j = 0; j < lsz; j++, p++) {
949 if (p == q) return NULL;
950 io->win[i].len += *p << (j*8);
956 /*====================================================================*/
958 static u_char *parse_mem(u_char *p, u_char *q, cistpl_mem_t *mem)
960 int i, j, asz, lsz, has_ha;
963 if (p == q) return NULL;
965 mem->nwin = (*p & 0x07) + 1;
966 lsz = (*p & 0x18) >> 3;
967 asz = (*p & 0x60) >> 5;
968 has_ha = (*p & 0x80);
969 if (++p == q) return NULL;
971 for (i = 0; i < mem->nwin; i++) {
973 for (j = 0; j < lsz; j++, p++) {
974 if (p == q) return NULL;
977 for (j = 0; j < asz; j++, p++) {
978 if (p == q) return NULL;
982 for (j = 0; j < asz; j++, p++) {
983 if (p == q) return NULL;
986 mem->win[i].len = len << 8;
987 mem->win[i].card_addr = ca << 8;
988 mem->win[i].host_addr = ha << 8;
993 /*====================================================================*/
995 static u_char *parse_irq(u_char *p, u_char *q, cistpl_irq_t *irq)
997 if (p == q) return NULL;
998 irq->IRQInfo1 = *p; p++;
999 if (irq->IRQInfo1 & IRQ_INFO2_VALID) {
1000 if (p+2 > q) return NULL;
1001 irq->IRQInfo2 = (p[1]<<8) + p[0];
1007 /*====================================================================*/
1009 static int parse_cftable_entry(tuple_t *tuple,
1010 cistpl_cftable_entry_t *entry)
1012 u_char *p, *q, features;
1014 p = tuple->TupleData;
1015 q = p + tuple->TupleDataLen;
1016 entry->index = *p & 0x3f;
1019 entry->flags |= CISTPL_CFTABLE_DEFAULT;
1021 if (++p == q) return CS_BAD_TUPLE;
1023 entry->flags |= CISTPL_CFTABLE_BVDS;
1025 entry->flags |= CISTPL_CFTABLE_WP;
1027 entry->flags |= CISTPL_CFTABLE_RDYBSY;
1029 entry->flags |= CISTPL_CFTABLE_MWAIT;
1030 entry->interface = *p & 0x0f;
1032 entry->interface = 0;
1034 /* Process optional features */
1035 if (++p == q) return CS_BAD_TUPLE;
1039 if ((features & 3) > 0) {
1040 p = parse_power(p, q, &entry->vcc);
1041 if (p == NULL) return CS_BAD_TUPLE;
1043 entry->vcc.present = 0;
1044 if ((features & 3) > 1) {
1045 p = parse_power(p, q, &entry->vpp1);
1046 if (p == NULL) return CS_BAD_TUPLE;
1048 entry->vpp1.present = 0;
1049 if ((features & 3) > 2) {
1050 p = parse_power(p, q, &entry->vpp2);
1051 if (p == NULL) return CS_BAD_TUPLE;
1053 entry->vpp2.present = 0;
1055 /* Timing options */
1056 if (features & 0x04) {
1057 p = parse_timing(p, q, &entry->timing);
1058 if (p == NULL) return CS_BAD_TUPLE;
1060 entry->timing.wait = 0;
1061 entry->timing.ready = 0;
1062 entry->timing.reserved = 0;
1065 /* I/O window options */
1066 if (features & 0x08) {
1067 p = parse_io(p, q, &entry->io);
1068 if (p == NULL) return CS_BAD_TUPLE;
1072 /* Interrupt options */
1073 if (features & 0x10) {
1074 p = parse_irq(p, q, &entry->irq);
1075 if (p == NULL) return CS_BAD_TUPLE;
1077 entry->irq.IRQInfo1 = 0;
1079 switch (features & 0x60) {
1081 entry->mem.nwin = 0;
1084 entry->mem.nwin = 1;
1085 entry->mem.win[0].len = le16_to_cpu(*(u_short *)p) << 8;
1086 entry->mem.win[0].card_addr = 0;
1087 entry->mem.win[0].host_addr = 0;
1089 if (p > q) return CS_BAD_TUPLE;
1092 entry->mem.nwin = 1;
1093 entry->mem.win[0].len = le16_to_cpu(*(u_short *)p) << 8;
1094 entry->mem.win[0].card_addr =
1095 le16_to_cpu(*(u_short *)(p+2)) << 8;
1096 entry->mem.win[0].host_addr = 0;
1098 if (p > q) return CS_BAD_TUPLE;
1101 p = parse_mem(p, q, &entry->mem);
1102 if (p == NULL) return CS_BAD_TUPLE;
1107 if (features & 0x80) {
1108 if (p == q) return CS_BAD_TUPLE;
1109 entry->flags |= (*p << 8);
1111 if (++p == q) return CS_BAD_TUPLE;
1115 entry->subtuples = q-p;
1120 /*====================================================================*/
1122 #ifdef CONFIG_CARDBUS
1124 static int parse_bar(tuple_t *tuple, cistpl_bar_t *bar)
1127 if (tuple->TupleDataLen < 6)
1128 return CS_BAD_TUPLE;
1129 p = (u_char *)tuple->TupleData;
1132 bar->size = le32_to_cpu(*(u_int *)p);
1136 static int parse_config_cb(tuple_t *tuple, cistpl_config_t *config)
1140 p = (u_char *)tuple->TupleData;
1141 if ((*p != 3) || (tuple->TupleDataLen < 6))
1142 return CS_BAD_TUPLE;
1143 config->last_idx = *(++p);
1145 config->base = le32_to_cpu(*(u_int *)p);
1146 config->subtuples = tuple->TupleDataLen - 6;
1150 static int parse_cftable_entry_cb(tuple_t *tuple,
1151 cistpl_cftable_entry_cb_t *entry)
1153 u_char *p, *q, features;
1155 p = tuple->TupleData;
1156 q = p + tuple->TupleDataLen;
1157 entry->index = *p & 0x3f;
1160 entry->flags |= CISTPL_CFTABLE_DEFAULT;
1162 /* Process optional features */
1163 if (++p == q) return CS_BAD_TUPLE;
1167 if ((features & 3) > 0) {
1168 p = parse_power(p, q, &entry->vcc);
1169 if (p == NULL) return CS_BAD_TUPLE;
1171 entry->vcc.present = 0;
1172 if ((features & 3) > 1) {
1173 p = parse_power(p, q, &entry->vpp1);
1174 if (p == NULL) return CS_BAD_TUPLE;
1176 entry->vpp1.present = 0;
1177 if ((features & 3) > 2) {
1178 p = parse_power(p, q, &entry->vpp2);
1179 if (p == NULL) return CS_BAD_TUPLE;
1181 entry->vpp2.present = 0;
1183 /* I/O window options */
1184 if (features & 0x08) {
1185 if (p == q) return CS_BAD_TUPLE;
1186 entry->io = *p; p++;
1190 /* Interrupt options */
1191 if (features & 0x10) {
1192 p = parse_irq(p, q, &entry->irq);
1193 if (p == NULL) return CS_BAD_TUPLE;
1195 entry->irq.IRQInfo1 = 0;
1197 if (features & 0x20) {
1198 if (p == q) return CS_BAD_TUPLE;
1199 entry->mem = *p; p++;
1204 if (features & 0x80) {
1205 if (p == q) return CS_BAD_TUPLE;
1206 entry->flags |= (*p << 8);
1208 if (++p == q) return CS_BAD_TUPLE;
1209 entry->flags |= (*p << 16);
1212 if (++p == q) return CS_BAD_TUPLE;
1216 entry->subtuples = q-p;
1223 /*====================================================================*/
1225 static int parse_device_geo(tuple_t *tuple, cistpl_device_geo_t *geo)
1230 p = (u_char *)tuple->TupleData;
1231 q = p + tuple->TupleDataLen;
1233 for (n = 0; n < CISTPL_MAX_DEVICES; n++) {
1235 geo->geo[n].buswidth = p[0];
1236 geo->geo[n].erase_block = 1 << (p[1]-1);
1237 geo->geo[n].read_block = 1 << (p[2]-1);
1238 geo->geo[n].write_block = 1 << (p[3]-1);
1239 geo->geo[n].partition = 1 << (p[4]-1);
1240 geo->geo[n].interleave = 1 << (p[5]-1);
1247 /*====================================================================*/
1249 static int parse_vers_2(tuple_t *tuple, cistpl_vers_2_t *v2)
1253 if (tuple->TupleDataLen < 10)
1254 return CS_BAD_TUPLE;
1256 p = tuple->TupleData;
1257 q = p + tuple->TupleDataLen;
1261 v2->dindex = le16_to_cpu(*(u_short *)(p+2));
1266 return parse_strings(p, q, 2, v2->str, &v2->vendor, NULL);
1269 /*====================================================================*/
1271 static int parse_org(tuple_t *tuple, cistpl_org_t *org)
1276 p = tuple->TupleData;
1277 q = p + tuple->TupleDataLen;
1278 if (p == q) return CS_BAD_TUPLE;
1280 if (++p == q) return CS_BAD_TUPLE;
1281 for (i = 0; i < 30; i++) {
1283 if (*p == '\0') break;
1284 if (++p == q) return CS_BAD_TUPLE;
1289 /*====================================================================*/
1291 static int parse_format(tuple_t *tuple, cistpl_format_t *fmt)
1295 if (tuple->TupleDataLen < 10)
1296 return CS_BAD_TUPLE;
1298 p = tuple->TupleData;
1302 fmt->offset = le32_to_cpu(*(u_int *)(p+2));
1303 fmt->length = le32_to_cpu(*(u_int *)(p+6));
1308 /*====================================================================*/
1310 int pccard_parse_tuple(tuple_t *tuple, cisparse_t *parse)
1312 int ret = CS_SUCCESS;
1314 if (tuple->TupleDataLen > tuple->TupleDataMax)
1315 return CS_BAD_TUPLE;
1316 switch (tuple->TupleCode) {
1318 case CISTPL_DEVICE_A:
1319 ret = parse_device(tuple, &parse->device);
1321 #ifdef CONFIG_CARDBUS
1323 ret = parse_bar(tuple, &parse->bar);
1325 case CISTPL_CONFIG_CB:
1326 ret = parse_config_cb(tuple, &parse->config);
1328 case CISTPL_CFTABLE_ENTRY_CB:
1329 ret = parse_cftable_entry_cb(tuple, &parse->cftable_entry_cb);
1332 case CISTPL_CHECKSUM:
1333 ret = parse_checksum(tuple, &parse->checksum);
1335 case CISTPL_LONGLINK_A:
1336 case CISTPL_LONGLINK_C:
1337 ret = parse_longlink(tuple, &parse->longlink);
1339 case CISTPL_LONGLINK_MFC:
1340 ret = parse_longlink_mfc(tuple, &parse->longlink_mfc);
1343 ret = parse_vers_1(tuple, &parse->version_1);
1346 ret = parse_altstr(tuple, &parse->altstr);
1348 case CISTPL_JEDEC_A:
1349 case CISTPL_JEDEC_C:
1350 ret = parse_jedec(tuple, &parse->jedec);
1353 ret = parse_manfid(tuple, &parse->manfid);
1356 ret = parse_funcid(tuple, &parse->funcid);
1359 ret = parse_funce(tuple, &parse->funce);
1362 ret = parse_config(tuple, &parse->config);
1364 case CISTPL_CFTABLE_ENTRY:
1365 ret = parse_cftable_entry(tuple, &parse->cftable_entry);
1367 case CISTPL_DEVICE_GEO:
1368 case CISTPL_DEVICE_GEO_A:
1369 ret = parse_device_geo(tuple, &parse->device_geo);
1372 ret = parse_vers_2(tuple, &parse->vers_2);
1375 ret = parse_org(tuple, &parse->org);
1378 case CISTPL_FORMAT_A:
1379 ret = parse_format(tuple, &parse->format);
1381 case CISTPL_NO_LINK:
1382 case CISTPL_LINKTARGET:
1386 ret = CS_UNSUPPORTED_FUNCTION;
1391 EXPORT_SYMBOL(pccard_parse_tuple);
1393 /*======================================================================
1395 This is used internally by Card Services to look up CIS stuff.
1397 ======================================================================*/
1399 int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function, cisdata_t code, void *parse)
1405 buf = kmalloc(256, GFP_KERNEL);
1407 return CS_OUT_OF_RESOURCE;
1408 tuple.DesiredTuple = code;
1409 tuple.Attributes = TUPLE_RETURN_COMMON;
1410 ret = pccard_get_first_tuple(s, function, &tuple);
1411 if (ret != CS_SUCCESS) goto done;
1412 tuple.TupleData = buf;
1413 tuple.TupleOffset = 0;
1414 tuple.TupleDataMax = 255;
1415 ret = pccard_get_tuple_data(s, &tuple);
1416 if (ret != CS_SUCCESS) goto done;
1417 ret = pccard_parse_tuple(&tuple, parse);
1422 EXPORT_SYMBOL(pccard_read_tuple);
1424 /*======================================================================
1426 This tries to determine if a card has a sensible CIS. It returns
1427 the number of tuples in the CIS, or 0 if the CIS looks bad. The
1428 checks include making sure several critical tuples are present and
1429 valid; seeing if the total number of tuples is reasonable; and
1430 looking for tuples that use reserved codes.
1432 ======================================================================*/
1434 int pccard_validate_cis(struct pcmcia_socket *s, unsigned int function, cisinfo_t *info)
1438 int ret, reserved, dev_ok = 0, ident_ok = 0;
1441 return CS_BAD_HANDLE;
1443 tuple = kmalloc(sizeof(*tuple), GFP_KERNEL);
1445 return CS_OUT_OF_RESOURCE;
1446 p = kmalloc(sizeof(*p), GFP_KERNEL);
1449 return CS_OUT_OF_RESOURCE;
1452 info->Chains = reserved = 0;
1453 tuple->DesiredTuple = RETURN_FIRST_TUPLE;
1454 tuple->Attributes = TUPLE_RETURN_COMMON;
1455 ret = pccard_get_first_tuple(s, function, tuple);
1456 if (ret != CS_SUCCESS)
1459 /* First tuple should be DEVICE; we should really have either that
1460 or a CFTABLE_ENTRY of some sort */
1461 if ((tuple->TupleCode == CISTPL_DEVICE) ||
1462 (pccard_read_tuple(s, function, CISTPL_CFTABLE_ENTRY, p) == CS_SUCCESS) ||
1463 (pccard_read_tuple(s, function, CISTPL_CFTABLE_ENTRY_CB, p) == CS_SUCCESS))
1466 /* All cards should have a MANFID tuple, and/or a VERS_1 or VERS_2
1467 tuple, for card identification. Certain old D-Link and Linksys
1468 cards have only a broken VERS_2 tuple; hence the bogus test. */
1469 if ((pccard_read_tuple(s, function, CISTPL_MANFID, p) == CS_SUCCESS) ||
1470 (pccard_read_tuple(s, function, CISTPL_VERS_1, p) == CS_SUCCESS) ||
1471 (pccard_read_tuple(s, function, CISTPL_VERS_2, p) != CS_NO_MORE_ITEMS))
1474 if (!dev_ok && !ident_ok)
1477 for (info->Chains = 1; info->Chains < MAX_TUPLES; info->Chains++) {
1478 ret = pccard_get_next_tuple(s, function, tuple);
1479 if (ret != CS_SUCCESS) break;
1480 if (((tuple->TupleCode > 0x23) && (tuple->TupleCode < 0x40)) ||
1481 ((tuple->TupleCode > 0x47) && (tuple->TupleCode < 0x80)) ||
1482 ((tuple->TupleCode > 0x90) && (tuple->TupleCode < 0xff)))
1485 if ((info->Chains == MAX_TUPLES) || (reserved > 5) ||
1486 ((!dev_ok || !ident_ok) && (info->Chains > 10)))
1494 EXPORT_SYMBOL(pccard_validate_cis);