2 * cistpl.c -- 16-bit PCMCIA Card Information Structure parser
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 * The initial developer of the original code is David A. Hinds
9 * <dahinds@users.sourceforge.net>. Portions created by David A. Hinds
10 * are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
12 * (C) 1999 David A. Hinds
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/kernel.h>
18 #include <linux/string.h>
19 #include <linux/major.h>
20 #include <linux/errno.h>
21 #include <linux/timer.h>
22 #include <linux/slab.h>
24 #include <linux/pci.h>
25 #include <linux/ioport.h>
27 #include <asm/byteorder.h>
28 #include <asm/unaligned.h>
30 #include <pcmcia/cs_types.h>
31 #include <pcmcia/ss.h>
32 #include <pcmcia/cs.h>
33 #include <pcmcia/cisreg.h>
34 #include <pcmcia/cistpl.h>
35 #include "cs_internal.h"
37 static const u_char mantissa[] = {
38 10, 12, 13, 15, 20, 25, 30, 35,
39 40, 45, 50, 55, 60, 70, 80, 90
42 static const u_int exponent[] = {
43 1, 10, 100, 1000, 10000, 100000, 1000000, 10000000
46 /* Convert an extended speed byte to a time in nanoseconds */
47 #define SPEED_CVT(v) \
48 (mantissa[(((v)>>3)&15)-1] * exponent[(v)&7] / 10)
49 /* Convert a power byte to a current in 0.1 microamps */
50 #define POWER_CVT(v) \
51 (mantissa[((v)>>3)&15] * exponent[(v)&7] / 10)
52 #define POWER_SCALE(v) (exponent[(v)&7])
54 /* Upper limit on reasonable # of tuples */
55 #define MAX_TUPLES 200
57 /*====================================================================*/
59 /* Parameters that can be set with 'insmod' */
63 module_param(cis_width, int, 0444);
65 void release_cis_mem(struct pcmcia_socket *s)
67 if (s->cis_mem.flags & MAP_ACTIVE) {
68 s->cis_mem.flags &= ~MAP_ACTIVE;
69 s->ops->set_mem_map(s, &s->cis_mem);
71 release_resource(s->cis_mem.res);
72 kfree(s->cis_mem.res);
73 s->cis_mem.res = NULL;
79 EXPORT_SYMBOL(release_cis_mem);
82 * Map the card memory at "card_offset" into virtual space.
83 * If flags & MAP_ATTRIB, map the attribute space, otherwise
84 * map the memory space.
87 set_cis_map(struct pcmcia_socket *s, unsigned int card_offset, unsigned int flags)
89 pccard_mem_map *mem = &s->cis_mem;
92 if (!(s->features & SS_CAP_STATIC_MAP) && (mem->res == NULL)) {
93 mem->res = pcmcia_find_mem_region(0, s->map_size, s->map_size, 0, s);
94 if (mem->res == NULL) {
95 dev_printk(KERN_NOTICE, &s->dev,
96 "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 dev_dbg(&s->dev, "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 dev_dbg(&s->dev, " %#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 dev_dbg(&s->dev, "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 size_t 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);
355 dev_printk(KERN_WARNING, &s->dev,
356 "no memory for verifying CIS\n");
359 list_for_each_entry(cis, &s->cis_cache, node) {
364 #ifdef CONFIG_CARDBUS
365 if (s->state & SOCKET_CARDBUS)
366 read_cb_mem(s, cis->attr, cis->addr, len, buf);
369 pcmcia_read_cis_mem(s, cis->attr, cis->addr, len, buf);
371 if (memcmp(buf, cis->cache, len) != 0) {
380 /*======================================================================
382 For really bad cards, we provide a facility for uploading a
385 ======================================================================*/
387 int pcmcia_replace_cis(struct pcmcia_socket *s,
388 const u8 *data, const size_t len)
390 if (len > CISTPL_MAX_CIS_SIZE) {
391 dev_printk(KERN_WARNING, &s->dev, "replacement CIS too big\n");
395 s->fake_cis = kmalloc(len, GFP_KERNEL);
396 if (s->fake_cis == NULL) {
397 dev_printk(KERN_WARNING, &s->dev, "no memory to replace CIS\n");
400 s->fake_cis_len = len;
401 memcpy(s->fake_cis, data, len);
404 EXPORT_SYMBOL(pcmcia_replace_cis);
406 /*======================================================================
408 The high-level CIS tuple services
410 ======================================================================*/
412 typedef struct tuple_flags {
419 #define LINK_SPACE(f) (((tuple_flags *)(&(f)))->link_space)
420 #define HAS_LINK(f) (((tuple_flags *)(&(f)))->has_link)
421 #define MFC_FN(f) (((tuple_flags *)(&(f)))->mfc_fn)
422 #define SPACE(f) (((tuple_flags *)(&(f)))->space)
424 int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int func, tuple_t *tuple);
426 int pccard_get_first_tuple(struct pcmcia_socket *s, unsigned int function, tuple_t *tuple)
430 if (!(s->state & SOCKET_PRESENT))
432 tuple->TupleLink = tuple->Flags = 0;
433 #ifdef CONFIG_CARDBUS
434 if (s->state & SOCKET_CARDBUS) {
435 struct pci_dev *dev = s->cb_dev;
437 pci_bus_read_config_dword(dev->subordinate, 0, PCI_CARDBUS_CIS, &ptr);
438 tuple->CISOffset = ptr & ~7;
439 SPACE(tuple->Flags) = (ptr & 7);
443 /* Assume presence of a LONGLINK_C to address 0 */
444 tuple->CISOffset = tuple->LinkOffset = 0;
445 SPACE(tuple->Flags) = HAS_LINK(tuple->Flags) = 1;
447 if (!(s->state & SOCKET_CARDBUS) && (s->functions > 1) &&
448 !(tuple->Attributes & TUPLE_RETURN_COMMON)) {
449 cisdata_t req = tuple->DesiredTuple;
450 tuple->DesiredTuple = CISTPL_LONGLINK_MFC;
451 if (pccard_get_next_tuple(s, function, tuple) == 0) {
452 tuple->DesiredTuple = CISTPL_LINKTARGET;
453 if (pccard_get_next_tuple(s, function, tuple) != 0)
456 tuple->CISOffset = tuple->TupleLink = 0;
457 tuple->DesiredTuple = req;
459 return pccard_get_next_tuple(s, function, tuple);
461 EXPORT_SYMBOL(pccard_get_first_tuple);
463 static int follow_link(struct pcmcia_socket *s, tuple_t *tuple)
468 if (MFC_FN(tuple->Flags)) {
469 /* Get indirect link from the MFC tuple */
470 read_cis_cache(s, LINK_SPACE(tuple->Flags),
471 tuple->LinkOffset, 5, link);
472 ofs = get_unaligned_le32(link + 1);
473 SPACE(tuple->Flags) = (link[0] == CISTPL_MFC_ATTR);
474 /* Move to the next indirect link */
475 tuple->LinkOffset += 5;
476 MFC_FN(tuple->Flags)--;
477 } else if (HAS_LINK(tuple->Flags)) {
478 ofs = tuple->LinkOffset;
479 SPACE(tuple->Flags) = LINK_SPACE(tuple->Flags);
480 HAS_LINK(tuple->Flags) = 0;
484 if (!(s->state & SOCKET_CARDBUS) && SPACE(tuple->Flags)) {
485 /* This is ugly, but a common CIS error is to code the long
486 link offset incorrectly, so we check the right spot... */
487 read_cis_cache(s, SPACE(tuple->Flags), ofs, 5, link);
488 if ((link[0] == CISTPL_LINKTARGET) && (link[1] >= 3) &&
489 (strncmp(link+2, "CIS", 3) == 0))
491 remove_cis_cache(s, SPACE(tuple->Flags), ofs, 5);
492 /* Then, we try the wrong spot... */
495 read_cis_cache(s, SPACE(tuple->Flags), ofs, 5, link);
496 if ((link[0] == CISTPL_LINKTARGET) && (link[1] >= 3) &&
497 (strncmp(link+2, "CIS", 3) == 0))
499 remove_cis_cache(s, SPACE(tuple->Flags), ofs, 5);
503 int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int function, tuple_t *tuple)
510 if (!(s->state & SOCKET_PRESENT))
513 link[1] = tuple->TupleLink;
514 ofs = tuple->CISOffset + tuple->TupleLink;
515 attr = SPACE(tuple->Flags);
517 for (i = 0; i < MAX_TUPLES; i++) {
518 if (link[1] == 0xff) {
519 link[0] = CISTPL_END;
521 read_cis_cache(s, attr, ofs, 2, link);
522 if (link[0] == CISTPL_NULL) {
527 /* End of chain? Follow long link if possible */
528 if (link[0] == CISTPL_END) {
529 if ((ofs = follow_link(s, tuple)) < 0)
531 attr = SPACE(tuple->Flags);
532 read_cis_cache(s, attr, ofs, 2, link);
535 /* Is this a link tuple? Make a note of it */
536 if ((link[0] == CISTPL_LONGLINK_A) ||
537 (link[0] == CISTPL_LONGLINK_C) ||
538 (link[0] == CISTPL_LONGLINK_MFC) ||
539 (link[0] == CISTPL_LINKTARGET) ||
540 (link[0] == CISTPL_INDIRECT) ||
541 (link[0] == CISTPL_NO_LINK)) {
543 case CISTPL_LONGLINK_A:
544 HAS_LINK(tuple->Flags) = 1;
545 LINK_SPACE(tuple->Flags) = attr | IS_ATTR;
546 read_cis_cache(s, attr, ofs+2, 4, &tuple->LinkOffset);
548 case CISTPL_LONGLINK_C:
549 HAS_LINK(tuple->Flags) = 1;
550 LINK_SPACE(tuple->Flags) = attr & ~IS_ATTR;
551 read_cis_cache(s, attr, ofs+2, 4, &tuple->LinkOffset);
553 case CISTPL_INDIRECT:
554 HAS_LINK(tuple->Flags) = 1;
555 LINK_SPACE(tuple->Flags) = IS_ATTR | IS_INDIRECT;
556 tuple->LinkOffset = 0;
558 case CISTPL_LONGLINK_MFC:
559 tuple->LinkOffset = ofs + 3;
560 LINK_SPACE(tuple->Flags) = attr;
561 if (function == BIND_FN_ALL) {
562 /* Follow all the MFC links */
563 read_cis_cache(s, attr, ofs+2, 1, &tmp);
564 MFC_FN(tuple->Flags) = tmp;
566 /* Follow exactly one of the links */
567 MFC_FN(tuple->Flags) = 1;
568 tuple->LinkOffset += function * 5;
572 HAS_LINK(tuple->Flags) = 0;
575 if ((tuple->Attributes & TUPLE_RETURN_LINK) &&
576 (tuple->DesiredTuple == RETURN_FIRST_TUPLE))
579 if (tuple->DesiredTuple == RETURN_FIRST_TUPLE)
582 if (link[0] == tuple->DesiredTuple)
586 if (i == MAX_TUPLES) {
587 dev_dbg(&s->dev, "cs: overrun in pcmcia_get_next_tuple\n");
591 tuple->TupleCode = link[0];
592 tuple->TupleLink = link[1];
593 tuple->CISOffset = ofs + 2;
596 EXPORT_SYMBOL(pccard_get_next_tuple);
598 /*====================================================================*/
600 #define _MIN(a, b) (((a) < (b)) ? (a) : (b))
602 int pccard_get_tuple_data(struct pcmcia_socket *s, tuple_t *tuple)
609 if (tuple->TupleLink < tuple->TupleOffset)
611 len = tuple->TupleLink - tuple->TupleOffset;
612 tuple->TupleDataLen = tuple->TupleLink;
615 read_cis_cache(s, SPACE(tuple->Flags),
616 tuple->CISOffset + tuple->TupleOffset,
617 _MIN(len, tuple->TupleDataMax), tuple->TupleData);
620 EXPORT_SYMBOL(pccard_get_tuple_data);
623 /*======================================================================
625 Parsing routines for individual tuples
627 ======================================================================*/
629 static int parse_device(tuple_t *tuple, cistpl_device_t *device)
635 p = (u_char *)tuple->TupleData;
636 q = p + tuple->TupleDataLen;
639 for (i = 0; i < CISTPL_MAX_DEVICES; i++) {
641 if (*p == 0xff) break;
642 device->dev[i].type = (*p >> 4);
643 device->dev[i].wp = (*p & 0x08) ? 1 : 0;
645 case 0: device->dev[i].speed = 0; break;
646 case 1: device->dev[i].speed = 250; break;
647 case 2: device->dev[i].speed = 200; break;
648 case 3: device->dev[i].speed = 150; break;
649 case 4: device->dev[i].speed = 100; break;
653 device->dev[i].speed = SPEED_CVT(*p);
669 device->dev[i].size = ((*p >> 3) + 1) * (512 << (scale*2));
678 /*====================================================================*/
680 static int parse_checksum(tuple_t *tuple, cistpl_checksum_t *csum)
683 if (tuple->TupleDataLen < 5)
685 p = (u_char *) tuple->TupleData;
686 csum->addr = tuple->CISOffset + get_unaligned_le16(p) - 2;
687 csum->len = get_unaligned_le16(p + 2);
688 csum->sum = *(p + 4);
692 /*====================================================================*/
694 static int parse_longlink(tuple_t *tuple, cistpl_longlink_t *link)
696 if (tuple->TupleDataLen < 4)
698 link->addr = get_unaligned_le32(tuple->TupleData);
702 /*====================================================================*/
704 static int parse_longlink_mfc(tuple_t *tuple,
705 cistpl_longlink_mfc_t *link)
710 p = (u_char *)tuple->TupleData;
713 if (tuple->TupleDataLen <= link->nfn*5)
715 for (i = 0; i < link->nfn; i++) {
716 link->fn[i].space = *p; p++;
717 link->fn[i].addr = get_unaligned_le32(p);
723 /*====================================================================*/
725 static int parse_strings(u_char *p, u_char *q, int max,
726 char *s, u_char *ofs, u_char *found)
733 for (i = 0; i < max; i++) {
739 s[j++] = (*p == 0xff) ? '\0' : *p;
740 if ((*p == '\0') || (*p == 0xff)) break;
744 if ((*p == 0xff) || (++p == q)) break;
750 return (ns == max) ? 0 : -EINVAL;
754 /*====================================================================*/
756 static int parse_vers_1(tuple_t *tuple, cistpl_vers_1_t *vers_1)
760 p = (u_char *)tuple->TupleData;
761 q = p + tuple->TupleDataLen;
763 vers_1->major = *p; p++;
764 vers_1->minor = *p; p++;
768 return parse_strings(p, q, CISTPL_VERS_1_MAX_PROD_STRINGS,
769 vers_1->str, vers_1->ofs, &vers_1->ns);
772 /*====================================================================*/
774 static int parse_altstr(tuple_t *tuple, cistpl_altstr_t *altstr)
778 p = (u_char *)tuple->TupleData;
779 q = p + tuple->TupleDataLen;
781 return parse_strings(p, q, CISTPL_MAX_ALTSTR_STRINGS,
782 altstr->str, altstr->ofs, &altstr->ns);
785 /*====================================================================*/
787 static int parse_jedec(tuple_t *tuple, cistpl_jedec_t *jedec)
792 p = (u_char *)tuple->TupleData;
793 q = p + tuple->TupleDataLen;
795 for (nid = 0; nid < CISTPL_MAX_DEVICES; nid++) {
797 jedec->id[nid].mfr = p[0];
798 jedec->id[nid].info = p[1];
805 /*====================================================================*/
807 static int parse_manfid(tuple_t *tuple, cistpl_manfid_t *m)
809 if (tuple->TupleDataLen < 4)
811 m->manf = get_unaligned_le16(tuple->TupleData);
812 m->card = get_unaligned_le16(tuple->TupleData + 2);
816 /*====================================================================*/
818 static int parse_funcid(tuple_t *tuple, cistpl_funcid_t *f)
821 if (tuple->TupleDataLen < 2)
823 p = (u_char *)tuple->TupleData;
829 /*====================================================================*/
831 static int parse_funce(tuple_t *tuple, cistpl_funce_t *f)
835 if (tuple->TupleDataLen < 1)
837 p = (u_char *)tuple->TupleData;
839 for (i = 1; i < tuple->TupleDataLen; i++)
844 /*====================================================================*/
846 static int parse_config(tuple_t *tuple, cistpl_config_t *config)
851 p = (u_char *)tuple->TupleData;
853 rmsz = (*p & 0x3c) >> 2;
854 if (tuple->TupleDataLen < rasz+rmsz+4)
856 config->last_idx = *(++p);
859 for (i = 0; i <= rasz; i++)
860 config->base += p[i] << (8*i);
862 for (i = 0; i < 4; i++)
863 config->rmask[i] = 0;
864 for (i = 0; i <= rmsz; i++)
865 config->rmask[i>>2] += p[i] << (8*(i%4));
866 config->subtuples = tuple->TupleDataLen - (rasz+rmsz+4);
870 /*======================================================================
872 The following routines are all used to parse the nightmarish
873 config table entries.
875 ======================================================================*/
877 static u_char *parse_power(u_char *p, u_char *q,
883 if (p == q) return NULL;
887 for (i = 0; i < 7; i++)
888 if (pwr->present & (1<<i)) {
889 if (p == q) return NULL;
890 pwr->param[i] = POWER_CVT(*p);
891 scale = POWER_SCALE(*p);
893 if (++p == q) return NULL;
894 if ((*p & 0x7f) < 100)
895 pwr->param[i] += (*p & 0x7f) * scale / 100;
897 pwr->flags |= CISTPL_POWER_HIGHZ_OK;
901 pwr->flags |= CISTPL_POWER_HIGHZ_REQ;
910 /*====================================================================*/
912 static u_char *parse_timing(u_char *p, u_char *q,
913 cistpl_timing_t *timing)
917 if (p == q) return NULL;
919 if ((scale & 3) != 3) {
920 if (++p == q) return NULL;
921 timing->wait = SPEED_CVT(*p);
922 timing->waitscale = exponent[scale & 3];
926 if ((scale & 7) != 7) {
927 if (++p == q) return NULL;
928 timing->ready = SPEED_CVT(*p);
929 timing->rdyscale = exponent[scale & 7];
934 if (++p == q) return NULL;
935 timing->reserved = SPEED_CVT(*p);
936 timing->rsvscale = exponent[scale];
938 timing->reserved = 0;
943 /*====================================================================*/
945 static u_char *parse_io(u_char *p, u_char *q, cistpl_io_t *io)
949 if (p == q) return NULL;
955 io->win[0].len = (1 << (io->flags & CISTPL_IO_LINES_MASK));
959 if (++p == q) return NULL;
960 io->nwin = (*p & 0x0f) + 1;
961 bsz = (*p & 0x30) >> 4;
963 lsz = (*p & 0xc0) >> 6;
967 for (i = 0; i < io->nwin; i++) {
970 for (j = 0; j < bsz; j++, p++) {
971 if (p == q) return NULL;
972 io->win[i].base += *p << (j*8);
974 for (j = 0; j < lsz; j++, p++) {
975 if (p == q) return NULL;
976 io->win[i].len += *p << (j*8);
982 /*====================================================================*/
984 static u_char *parse_mem(u_char *p, u_char *q, cistpl_mem_t *mem)
986 int i, j, asz, lsz, has_ha;
989 if (p == q) return NULL;
991 mem->nwin = (*p & 0x07) + 1;
992 lsz = (*p & 0x18) >> 3;
993 asz = (*p & 0x60) >> 5;
994 has_ha = (*p & 0x80);
995 if (++p == q) return NULL;
997 for (i = 0; i < mem->nwin; i++) {
999 for (j = 0; j < lsz; j++, p++) {
1000 if (p == q) return NULL;
1003 for (j = 0; j < asz; j++, p++) {
1004 if (p == q) return NULL;
1008 for (j = 0; j < asz; j++, p++) {
1009 if (p == q) return NULL;
1012 mem->win[i].len = len << 8;
1013 mem->win[i].card_addr = ca << 8;
1014 mem->win[i].host_addr = ha << 8;
1019 /*====================================================================*/
1021 static u_char *parse_irq(u_char *p, u_char *q, cistpl_irq_t *irq)
1025 irq->IRQInfo1 = *p; p++;
1026 if (irq->IRQInfo1 & IRQ_INFO2_VALID) {
1029 irq->IRQInfo2 = (p[1]<<8) + p[0];
1035 /*====================================================================*/
1037 static int parse_cftable_entry(tuple_t *tuple,
1038 cistpl_cftable_entry_t *entry)
1040 u_char *p, *q, features;
1042 p = tuple->TupleData;
1043 q = p + tuple->TupleDataLen;
1044 entry->index = *p & 0x3f;
1047 entry->flags |= CISTPL_CFTABLE_DEFAULT;
1052 entry->flags |= CISTPL_CFTABLE_BVDS;
1054 entry->flags |= CISTPL_CFTABLE_WP;
1056 entry->flags |= CISTPL_CFTABLE_RDYBSY;
1058 entry->flags |= CISTPL_CFTABLE_MWAIT;
1059 entry->interface = *p & 0x0f;
1061 entry->interface = 0;
1063 /* Process optional features */
1069 if ((features & 3) > 0) {
1070 p = parse_power(p, q, &entry->vcc);
1074 entry->vcc.present = 0;
1075 if ((features & 3) > 1) {
1076 p = parse_power(p, q, &entry->vpp1);
1080 entry->vpp1.present = 0;
1081 if ((features & 3) > 2) {
1082 p = parse_power(p, q, &entry->vpp2);
1086 entry->vpp2.present = 0;
1088 /* Timing options */
1089 if (features & 0x04) {
1090 p = parse_timing(p, q, &entry->timing);
1094 entry->timing.wait = 0;
1095 entry->timing.ready = 0;
1096 entry->timing.reserved = 0;
1099 /* I/O window options */
1100 if (features & 0x08) {
1101 p = parse_io(p, q, &entry->io);
1107 /* Interrupt options */
1108 if (features & 0x10) {
1109 p = parse_irq(p, q, &entry->irq);
1113 entry->irq.IRQInfo1 = 0;
1115 switch (features & 0x60) {
1117 entry->mem.nwin = 0;
1120 entry->mem.nwin = 1;
1121 entry->mem.win[0].len = get_unaligned_le16(p) << 8;
1122 entry->mem.win[0].card_addr = 0;
1123 entry->mem.win[0].host_addr = 0;
1129 entry->mem.nwin = 1;
1130 entry->mem.win[0].len = get_unaligned_le16(p) << 8;
1131 entry->mem.win[0].card_addr = get_unaligned_le16(p + 2) << 8;
1132 entry->mem.win[0].host_addr = 0;
1138 p = parse_mem(p, q, &entry->mem);
1145 if (features & 0x80) {
1148 entry->flags |= (*p << 8);
1155 entry->subtuples = q-p;
1160 /*====================================================================*/
1162 #ifdef CONFIG_CARDBUS
1164 static int parse_bar(tuple_t *tuple, cistpl_bar_t *bar)
1167 if (tuple->TupleDataLen < 6)
1169 p = (u_char *)tuple->TupleData;
1172 bar->size = get_unaligned_le32(p);
1176 static int parse_config_cb(tuple_t *tuple, cistpl_config_t *config)
1180 p = (u_char *)tuple->TupleData;
1181 if ((*p != 3) || (tuple->TupleDataLen < 6))
1183 config->last_idx = *(++p);
1185 config->base = get_unaligned_le32(p);
1186 config->subtuples = tuple->TupleDataLen - 6;
1190 static int parse_cftable_entry_cb(tuple_t *tuple,
1191 cistpl_cftable_entry_cb_t *entry)
1193 u_char *p, *q, features;
1195 p = tuple->TupleData;
1196 q = p + tuple->TupleDataLen;
1197 entry->index = *p & 0x3f;
1200 entry->flags |= CISTPL_CFTABLE_DEFAULT;
1202 /* Process optional features */
1208 if ((features & 3) > 0) {
1209 p = parse_power(p, q, &entry->vcc);
1213 entry->vcc.present = 0;
1214 if ((features & 3) > 1) {
1215 p = parse_power(p, q, &entry->vpp1);
1219 entry->vpp1.present = 0;
1220 if ((features & 3) > 2) {
1221 p = parse_power(p, q, &entry->vpp2);
1225 entry->vpp2.present = 0;
1227 /* I/O window options */
1228 if (features & 0x08) {
1231 entry->io = *p; p++;
1235 /* Interrupt options */
1236 if (features & 0x10) {
1237 p = parse_irq(p, q, &entry->irq);
1241 entry->irq.IRQInfo1 = 0;
1243 if (features & 0x20) {
1246 entry->mem = *p; p++;
1251 if (features & 0x80) {
1254 entry->flags |= (*p << 8);
1258 entry->flags |= (*p << 16);
1266 entry->subtuples = q-p;
1273 /*====================================================================*/
1275 static int parse_device_geo(tuple_t *tuple, cistpl_device_geo_t *geo)
1280 p = (u_char *)tuple->TupleData;
1281 q = p + tuple->TupleDataLen;
1283 for (n = 0; n < CISTPL_MAX_DEVICES; n++) {
1285 geo->geo[n].buswidth = p[0];
1286 geo->geo[n].erase_block = 1 << (p[1]-1);
1287 geo->geo[n].read_block = 1 << (p[2]-1);
1288 geo->geo[n].write_block = 1 << (p[3]-1);
1289 geo->geo[n].partition = 1 << (p[4]-1);
1290 geo->geo[n].interleave = 1 << (p[5]-1);
1297 /*====================================================================*/
1299 static int parse_vers_2(tuple_t *tuple, cistpl_vers_2_t *v2)
1303 if (tuple->TupleDataLen < 10)
1306 p = tuple->TupleData;
1307 q = p + tuple->TupleDataLen;
1311 v2->dindex = get_unaligned_le16(p +2 );
1316 return parse_strings(p, q, 2, v2->str, &v2->vendor, NULL);
1319 /*====================================================================*/
1321 static int parse_org(tuple_t *tuple, cistpl_org_t *org)
1326 p = tuple->TupleData;
1327 q = p + tuple->TupleDataLen;
1333 for (i = 0; i < 30; i++) {
1335 if (*p == '\0') break;
1342 /*====================================================================*/
1344 static int parse_format(tuple_t *tuple, cistpl_format_t *fmt)
1348 if (tuple->TupleDataLen < 10)
1351 p = tuple->TupleData;
1355 fmt->offset = get_unaligned_le32(p + 2);
1356 fmt->length = get_unaligned_le32(p + 6);
1361 /*====================================================================*/
1363 int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse)
1367 if (tuple->TupleDataLen > tuple->TupleDataMax)
1369 switch (tuple->TupleCode) {
1371 case CISTPL_DEVICE_A:
1372 ret = parse_device(tuple, &parse->device);
1374 #ifdef CONFIG_CARDBUS
1376 ret = parse_bar(tuple, &parse->bar);
1378 case CISTPL_CONFIG_CB:
1379 ret = parse_config_cb(tuple, &parse->config);
1381 case CISTPL_CFTABLE_ENTRY_CB:
1382 ret = parse_cftable_entry_cb(tuple, &parse->cftable_entry_cb);
1385 case CISTPL_CHECKSUM:
1386 ret = parse_checksum(tuple, &parse->checksum);
1388 case CISTPL_LONGLINK_A:
1389 case CISTPL_LONGLINK_C:
1390 ret = parse_longlink(tuple, &parse->longlink);
1392 case CISTPL_LONGLINK_MFC:
1393 ret = parse_longlink_mfc(tuple, &parse->longlink_mfc);
1396 ret = parse_vers_1(tuple, &parse->version_1);
1399 ret = parse_altstr(tuple, &parse->altstr);
1401 case CISTPL_JEDEC_A:
1402 case CISTPL_JEDEC_C:
1403 ret = parse_jedec(tuple, &parse->jedec);
1406 ret = parse_manfid(tuple, &parse->manfid);
1409 ret = parse_funcid(tuple, &parse->funcid);
1412 ret = parse_funce(tuple, &parse->funce);
1415 ret = parse_config(tuple, &parse->config);
1417 case CISTPL_CFTABLE_ENTRY:
1418 ret = parse_cftable_entry(tuple, &parse->cftable_entry);
1420 case CISTPL_DEVICE_GEO:
1421 case CISTPL_DEVICE_GEO_A:
1422 ret = parse_device_geo(tuple, &parse->device_geo);
1425 ret = parse_vers_2(tuple, &parse->vers_2);
1428 ret = parse_org(tuple, &parse->org);
1431 case CISTPL_FORMAT_A:
1432 ret = parse_format(tuple, &parse->format);
1434 case CISTPL_NO_LINK:
1435 case CISTPL_LINKTARGET:
1443 pr_debug("parse_tuple failed %d\n", ret);
1446 EXPORT_SYMBOL(pcmcia_parse_tuple);
1448 /*======================================================================
1450 This is used internally by Card Services to look up CIS stuff.
1452 ======================================================================*/
1454 int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function, cisdata_t code, void *parse)
1460 buf = kmalloc(256, GFP_KERNEL);
1462 dev_printk(KERN_WARNING, &s->dev, "no memory to read tuple\n");
1465 tuple.DesiredTuple = code;
1466 tuple.Attributes = 0;
1467 if (function == BIND_FN_ALL)
1468 tuple.Attributes = TUPLE_RETURN_COMMON;
1469 ret = pccard_get_first_tuple(s, function, &tuple);
1472 tuple.TupleData = buf;
1473 tuple.TupleOffset = 0;
1474 tuple.TupleDataMax = 255;
1475 ret = pccard_get_tuple_data(s, &tuple);
1478 ret = pcmcia_parse_tuple(&tuple, parse);
1483 EXPORT_SYMBOL(pccard_read_tuple);
1487 * pccard_loop_tuple() - loop over tuples in the CIS
1488 * @s: the struct pcmcia_socket where the card is inserted
1489 * @function: the device function we loop for
1490 * @code: which CIS code shall we look for?
1491 * @parse: buffer where the tuple shall be parsed (or NULL, if no parse)
1492 * @priv_data: private data to be passed to the loop_tuple function.
1493 * @loop_tuple: function to call for each CIS entry of type @function. IT
1494 * gets passed the raw tuple, the paresed tuple (if @parse is
1495 * set) and @priv_data.
1497 * pccard_loop_tuple() loops over all CIS entries of type @function, and
1498 * calls the @loop_tuple function for each entry. If the call to @loop_tuple
1499 * returns 0, the loop exits. Returns 0 on success or errorcode otherwise.
1501 int pccard_loop_tuple(struct pcmcia_socket *s, unsigned int function,
1502 cisdata_t code, cisparse_t *parse, void *priv_data,
1503 int (*loop_tuple) (tuple_t *tuple,
1511 buf = kzalloc(256, GFP_KERNEL);
1513 dev_printk(KERN_WARNING, &s->dev, "no memory to read tuple\n");
1517 tuple.TupleData = buf;
1518 tuple.TupleDataMax = 255;
1519 tuple.TupleOffset = 0;
1520 tuple.DesiredTuple = code;
1521 tuple.Attributes = 0;
1523 ret = pccard_get_first_tuple(s, function, &tuple);
1525 if (pccard_get_tuple_data(s, &tuple))
1529 if (pcmcia_parse_tuple(&tuple, parse))
1532 ret = loop_tuple(&tuple, parse, priv_data);
1537 ret = pccard_get_next_tuple(s, function, &tuple);
1543 EXPORT_SYMBOL(pccard_loop_tuple);
1546 /*======================================================================
1548 This tries to determine if a card has a sensible CIS. It returns
1549 the number of tuples in the CIS, or 0 if the CIS looks bad. The
1550 checks include making sure several critical tuples are present and
1551 valid; seeing if the total number of tuples is reasonable; and
1552 looking for tuples that use reserved codes.
1554 ======================================================================*/
1556 int pccard_validate_cis(struct pcmcia_socket *s, unsigned int *info)
1560 unsigned int count = 0;
1561 int ret, reserved, dev_ok = 0, ident_ok = 0;
1566 tuple = kmalloc(sizeof(*tuple), GFP_KERNEL);
1567 if (tuple == NULL) {
1568 dev_printk(KERN_WARNING, &s->dev, "no memory to validate CIS\n");
1571 p = kmalloc(sizeof(*p), GFP_KERNEL);
1574 dev_printk(KERN_WARNING, &s->dev, "no memory to validate CIS\n");
1578 count = reserved = 0;
1579 tuple->DesiredTuple = RETURN_FIRST_TUPLE;
1580 tuple->Attributes = TUPLE_RETURN_COMMON;
1581 ret = pccard_get_first_tuple(s, BIND_FN_ALL, tuple);
1585 /* First tuple should be DEVICE; we should really have either that
1586 or a CFTABLE_ENTRY of some sort */
1587 if ((tuple->TupleCode == CISTPL_DEVICE) ||
1588 (pccard_read_tuple(s, BIND_FN_ALL, CISTPL_CFTABLE_ENTRY, p) == 0) ||
1589 (pccard_read_tuple(s, BIND_FN_ALL, CISTPL_CFTABLE_ENTRY_CB, p) == 0))
1592 /* All cards should have a MANFID tuple, and/or a VERS_1 or VERS_2
1593 tuple, for card identification. Certain old D-Link and Linksys
1594 cards have only a broken VERS_2 tuple; hence the bogus test. */
1595 if ((pccard_read_tuple(s, BIND_FN_ALL, CISTPL_MANFID, p) == 0) ||
1596 (pccard_read_tuple(s, BIND_FN_ALL, CISTPL_VERS_1, p) == 0) ||
1597 (pccard_read_tuple(s, BIND_FN_ALL, CISTPL_VERS_2, p) != -ENOSPC))
1600 if (!dev_ok && !ident_ok)
1603 for (count = 1; count < MAX_TUPLES; count++) {
1604 ret = pccard_get_next_tuple(s, BIND_FN_ALL, tuple);
1607 if (((tuple->TupleCode > 0x23) && (tuple->TupleCode < 0x40)) ||
1608 ((tuple->TupleCode > 0x47) && (tuple->TupleCode < 0x80)) ||
1609 ((tuple->TupleCode > 0x90) && (tuple->TupleCode < 0xff)))
1612 if ((count == MAX_TUPLES) || (reserved > 5) ||
1613 ((!dev_ok || !ident_ok) && (count > 10)))
1623 EXPORT_SYMBOL(pccard_validate_cis);