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 mutex_lock(&s->ops_mutex);
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;
79 mutex_unlock(&s->ops_mutex);
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 mutex_lock(&s->ops_mutex);
94 if (!(s->features & SS_CAP_STATIC_MAP) && (mem->res == NULL)) {
95 mem->res = pcmcia_find_mem_region(0, s->map_size, s->map_size, 0, s);
96 if (mem->res == NULL) {
97 dev_printk(KERN_NOTICE, &s->dev,
98 "cs: unable to map card memory!\n");
99 mutex_unlock(&s->ops_mutex);
105 if (!(s->features & SS_CAP_STATIC_MAP) && (!s->cis_virt))
106 s->cis_virt = ioremap(mem->res->start, s->map_size);
108 mem->card_start = card_offset;
111 ret = s->ops->set_mem_map(s, mem);
113 iounmap(s->cis_virt);
115 mutex_unlock(&s->ops_mutex);
119 if (s->features & SS_CAP_STATIC_MAP) {
121 iounmap(s->cis_virt);
122 s->cis_virt = ioremap(mem->static_start, s->map_size);
125 mutex_unlock(&s->ops_mutex);
129 /*======================================================================
131 Low-level functions to read and write CIS memory. I think the
132 write routine is only useful for writing one-byte registers.
134 ======================================================================*/
136 /* Bits in attr field */
138 #define IS_INDIRECT 8
140 int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr, u_int addr,
141 u_int len, void *ptr)
143 void __iomem *sys, *end;
144 unsigned char *buf = ptr;
146 dev_dbg(&s->dev, "pcmcia_read_cis_mem(%d, %#x, %u)\n", attr, addr, len);
148 if (attr & IS_INDIRECT) {
149 /* Indirect accesses use a bunch of special registers at fixed
150 locations in common memory */
151 u_char flags = ICTRL0_COMMON|ICTRL0_AUTOINC|ICTRL0_BYTEGRAN;
152 if (attr & IS_ATTR) {
154 flags = ICTRL0_AUTOINC;
157 sys = set_cis_map(s, 0, MAP_ACTIVE | ((cis_width) ? MAP_16BIT : 0));
159 memset(ptr, 0xff, len);
163 writeb(flags, sys+CISREG_ICTRL0);
164 writeb(addr & 0xff, sys+CISREG_IADDR0);
165 writeb((addr>>8) & 0xff, sys+CISREG_IADDR1);
166 writeb((addr>>16) & 0xff, sys+CISREG_IADDR2);
167 writeb((addr>>24) & 0xff, sys+CISREG_IADDR3);
168 for ( ; len > 0; len--, buf++)
169 *buf = readb(sys+CISREG_IDATA0);
171 u_int inc = 1, card_offset, flags;
173 flags = MAP_ACTIVE | ((cis_width) ? MAP_16BIT : 0);
180 card_offset = addr & ~(s->map_size-1);
182 sys = set_cis_map(s, card_offset, flags);
184 memset(ptr, 0xff, len);
187 end = sys + s->map_size;
188 sys = sys + (addr & (s->map_size-1));
189 for ( ; len > 0; len--, buf++, sys += inc) {
194 card_offset += s->map_size;
198 dev_dbg(&s->dev, " %#2.2x %#2.2x %#2.2x %#2.2x ...\n",
199 *(u_char *)(ptr+0), *(u_char *)(ptr+1),
200 *(u_char *)(ptr+2), *(u_char *)(ptr+3));
205 void pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr, u_int addr,
206 u_int len, void *ptr)
208 void __iomem *sys, *end;
209 unsigned char *buf = ptr;
211 dev_dbg(&s->dev, "pcmcia_write_cis_mem(%d, %#x, %u)\n", attr, addr, len);
213 if (attr & IS_INDIRECT) {
214 /* Indirect accesses use a bunch of special registers at fixed
215 locations in common memory */
216 u_char flags = ICTRL0_COMMON|ICTRL0_AUTOINC|ICTRL0_BYTEGRAN;
217 if (attr & IS_ATTR) {
219 flags = ICTRL0_AUTOINC;
222 sys = set_cis_map(s, 0, MAP_ACTIVE | ((cis_width) ? MAP_16BIT : 0));
224 return; /* FIXME: Error */
226 writeb(flags, sys+CISREG_ICTRL0);
227 writeb(addr & 0xff, sys+CISREG_IADDR0);
228 writeb((addr>>8) & 0xff, sys+CISREG_IADDR1);
229 writeb((addr>>16) & 0xff, sys+CISREG_IADDR2);
230 writeb((addr>>24) & 0xff, sys+CISREG_IADDR3);
231 for ( ; len > 0; len--, buf++)
232 writeb(*buf, sys+CISREG_IDATA0);
234 u_int inc = 1, card_offset, flags;
236 flags = MAP_ACTIVE | ((cis_width) ? MAP_16BIT : 0);
237 if (attr & IS_ATTR) {
243 card_offset = addr & ~(s->map_size-1);
245 sys = set_cis_map(s, card_offset, flags);
247 return; /* FIXME: error */
249 end = sys + s->map_size;
250 sys = sys + (addr & (s->map_size-1));
251 for ( ; len > 0; len--, buf++, sys += inc) {
256 card_offset += s->map_size;
263 /*======================================================================
265 This is a wrapper around read_cis_mem, with the same interface,
266 but which caches information, for cards whose CIS may not be
267 readable all the time.
269 ======================================================================*/
271 static void read_cis_cache(struct pcmcia_socket *s, int attr, u_int addr,
272 size_t len, void *ptr)
274 struct cis_cache_entry *cis;
277 if (s->state & SOCKET_CARDBUS)
280 mutex_lock(&s->ops_mutex);
282 if (s->fake_cis_len >= addr+len)
283 memcpy(ptr, s->fake_cis+addr, len);
285 memset(ptr, 0xff, len);
286 mutex_unlock(&s->ops_mutex);
290 list_for_each_entry(cis, &s->cis_cache, node) {
291 if (cis->addr == addr && cis->len == len && cis->attr == attr) {
292 memcpy(ptr, cis->cache, len);
293 mutex_unlock(&s->ops_mutex);
297 mutex_unlock(&s->ops_mutex);
299 ret = pcmcia_read_cis_mem(s, attr, addr, len, ptr);
302 /* Copy data into the cache */
303 cis = kmalloc(sizeof(struct cis_cache_entry) + len, GFP_KERNEL);
308 memcpy(cis->cache, ptr, len);
309 mutex_lock(&s->ops_mutex);
310 list_add(&cis->node, &s->cis_cache);
311 mutex_unlock(&s->ops_mutex);
317 remove_cis_cache(struct pcmcia_socket *s, int attr, u_int addr, u_int len)
319 struct cis_cache_entry *cis;
321 mutex_lock(&s->ops_mutex);
322 list_for_each_entry(cis, &s->cis_cache, node)
323 if (cis->addr == addr && cis->len == len && cis->attr == attr) {
324 list_del(&cis->node);
328 mutex_unlock(&s->ops_mutex);
332 * destroy_cis_cache() - destroy the CIS cache
333 * @s: pcmcia_socket for which CIS cache shall be destroyed
335 * This destroys the CIS cache but keeps any fake CIS alive. Must be
336 * called with ops_mutex held.
339 void destroy_cis_cache(struct pcmcia_socket *s)
341 struct list_head *l, *n;
342 struct cis_cache_entry *cis;
344 list_for_each_safe(l, n, &s->cis_cache) {
345 cis = list_entry(l, struct cis_cache_entry, node);
346 list_del(&cis->node);
351 /*======================================================================
353 This verifies if the CIS of a card matches what is in the CIS
356 ======================================================================*/
358 int verify_cis_cache(struct pcmcia_socket *s)
360 struct cis_cache_entry *cis;
363 if (s->state & SOCKET_CARDBUS)
366 buf = kmalloc(256, GFP_KERNEL);
368 dev_printk(KERN_WARNING, &s->dev,
369 "no memory for verifying CIS\n");
372 list_for_each_entry(cis, &s->cis_cache, node) {
378 pcmcia_read_cis_mem(s, cis->attr, cis->addr, len, buf);
380 if (memcmp(buf, cis->cache, len) != 0) {
389 /*======================================================================
391 For really bad cards, we provide a facility for uploading a
394 ======================================================================*/
396 int pcmcia_replace_cis(struct pcmcia_socket *s,
397 const u8 *data, const size_t len)
399 if (len > CISTPL_MAX_CIS_SIZE) {
400 dev_printk(KERN_WARNING, &s->dev, "replacement CIS too big\n");
403 mutex_lock(&s->ops_mutex);
405 s->fake_cis = kmalloc(len, GFP_KERNEL);
406 if (s->fake_cis == NULL) {
407 dev_printk(KERN_WARNING, &s->dev, "no memory to replace CIS\n");
408 mutex_unlock(&s->ops_mutex);
411 s->fake_cis_len = len;
412 memcpy(s->fake_cis, data, len);
413 mutex_unlock(&s->ops_mutex);
417 /*======================================================================
419 The high-level CIS tuple services
421 ======================================================================*/
423 typedef struct tuple_flags {
430 #define LINK_SPACE(f) (((tuple_flags *)(&(f)))->link_space)
431 #define HAS_LINK(f) (((tuple_flags *)(&(f)))->has_link)
432 #define MFC_FN(f) (((tuple_flags *)(&(f)))->mfc_fn)
433 #define SPACE(f) (((tuple_flags *)(&(f)))->space)
435 int pccard_get_first_tuple(struct pcmcia_socket *s, unsigned int function, tuple_t *tuple)
440 if (!(s->state & SOCKET_PRESENT) || (s->state & SOCKET_CARDBUS))
442 tuple->TupleLink = tuple->Flags = 0;
444 /* Assume presence of a LONGLINK_C to address 0 */
445 tuple->CISOffset = tuple->LinkOffset = 0;
446 SPACE(tuple->Flags) = HAS_LINK(tuple->Flags) = 1;
448 if ((s->functions > 1) && !(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);
462 static int follow_link(struct pcmcia_socket *s, tuple_t *tuple)
467 if (MFC_FN(tuple->Flags)) {
468 /* Get indirect link from the MFC tuple */
469 read_cis_cache(s, LINK_SPACE(tuple->Flags),
470 tuple->LinkOffset, 5, link);
471 ofs = get_unaligned_le32(link + 1);
472 SPACE(tuple->Flags) = (link[0] == CISTPL_MFC_ATTR);
473 /* Move to the next indirect link */
474 tuple->LinkOffset += 5;
475 MFC_FN(tuple->Flags)--;
476 } else if (HAS_LINK(tuple->Flags)) {
477 ofs = tuple->LinkOffset;
478 SPACE(tuple->Flags) = LINK_SPACE(tuple->Flags);
479 HAS_LINK(tuple->Flags) = 0;
483 if (SPACE(tuple->Flags)) {
484 /* This is ugly, but a common CIS error is to code the long
485 link offset incorrectly, so we check the right spot... */
486 read_cis_cache(s, SPACE(tuple->Flags), ofs, 5, link);
487 if ((link[0] == CISTPL_LINKTARGET) && (link[1] >= 3) &&
488 (strncmp(link+2, "CIS", 3) == 0))
490 remove_cis_cache(s, SPACE(tuple->Flags), ofs, 5);
491 /* Then, we try the wrong spot... */
494 read_cis_cache(s, SPACE(tuple->Flags), ofs, 5, link);
495 if ((link[0] == CISTPL_LINKTARGET) && (link[1] >= 3) &&
496 (strncmp(link+2, "CIS", 3) == 0))
498 remove_cis_cache(s, SPACE(tuple->Flags), ofs, 5);
502 int pccard_get_next_tuple(struct pcmcia_socket *s, unsigned int function, tuple_t *tuple)
509 if (!(s->state & SOCKET_PRESENT) || (s->state & SOCKET_CARDBUS))
512 link[1] = tuple->TupleLink;
513 ofs = tuple->CISOffset + tuple->TupleLink;
514 attr = SPACE(tuple->Flags);
516 for (i = 0; i < MAX_TUPLES; i++) {
517 if (link[1] == 0xff) {
518 link[0] = CISTPL_END;
520 read_cis_cache(s, attr, ofs, 2, link);
521 if (link[0] == CISTPL_NULL) {
526 /* End of chain? Follow long link if possible */
527 if (link[0] == CISTPL_END) {
528 ofs = follow_link(s, tuple);
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;
597 /*====================================================================*/
599 #define _MIN(a, b) (((a) < (b)) ? (a) : (b))
601 int pccard_get_tuple_data(struct pcmcia_socket *s, tuple_t *tuple)
608 if (tuple->TupleLink < tuple->TupleOffset)
610 len = tuple->TupleLink - tuple->TupleOffset;
611 tuple->TupleDataLen = tuple->TupleLink;
614 read_cis_cache(s, SPACE(tuple->Flags),
615 tuple->CISOffset + tuple->TupleOffset,
616 _MIN(len, tuple->TupleDataMax), tuple->TupleData);
621 /*======================================================================
623 Parsing routines for individual tuples
625 ======================================================================*/
627 static int parse_device(tuple_t *tuple, cistpl_device_t *device)
633 p = (u_char *)tuple->TupleData;
634 q = p + tuple->TupleDataLen;
637 for (i = 0; i < CISTPL_MAX_DEVICES; i++) {
641 device->dev[i].type = (*p >> 4);
642 device->dev[i].wp = (*p & 0x08) ? 1 : 0;
645 device->dev[i].speed = 0;
648 device->dev[i].speed = 250;
651 device->dev[i].speed = 200;
654 device->dev[i].speed = 150;
657 device->dev[i].speed = 100;
662 device->dev[i].speed = SPEED_CVT(*p);
678 device->dev[i].size = ((*p >> 3) + 1) * (512 << (scale*2));
687 /*====================================================================*/
689 static int parse_checksum(tuple_t *tuple, cistpl_checksum_t *csum)
692 if (tuple->TupleDataLen < 5)
694 p = (u_char *) tuple->TupleData;
695 csum->addr = tuple->CISOffset + get_unaligned_le16(p) - 2;
696 csum->len = get_unaligned_le16(p + 2);
697 csum->sum = *(p + 4);
701 /*====================================================================*/
703 static int parse_longlink(tuple_t *tuple, cistpl_longlink_t *link)
705 if (tuple->TupleDataLen < 4)
707 link->addr = get_unaligned_le32(tuple->TupleData);
711 /*====================================================================*/
713 static int parse_longlink_mfc(tuple_t *tuple,
714 cistpl_longlink_mfc_t *link)
719 p = (u_char *)tuple->TupleData;
722 if (tuple->TupleDataLen <= link->nfn*5)
724 for (i = 0; i < link->nfn; i++) {
725 link->fn[i].space = *p; p++;
726 link->fn[i].addr = get_unaligned_le32(p);
732 /*====================================================================*/
734 static int parse_strings(u_char *p, u_char *q, int max,
735 char *s, u_char *ofs, u_char *found)
742 for (i = 0; i < max; i++) {
748 s[j++] = (*p == 0xff) ? '\0' : *p;
749 if ((*p == '\0') || (*p == 0xff))
754 if ((*p == 0xff) || (++p == q))
761 return (ns == max) ? 0 : -EINVAL;
765 /*====================================================================*/
767 static int parse_vers_1(tuple_t *tuple, cistpl_vers_1_t *vers_1)
771 p = (u_char *)tuple->TupleData;
772 q = p + tuple->TupleDataLen;
774 vers_1->major = *p; p++;
775 vers_1->minor = *p; p++;
779 return parse_strings(p, q, CISTPL_VERS_1_MAX_PROD_STRINGS,
780 vers_1->str, vers_1->ofs, &vers_1->ns);
783 /*====================================================================*/
785 static int parse_altstr(tuple_t *tuple, cistpl_altstr_t *altstr)
789 p = (u_char *)tuple->TupleData;
790 q = p + tuple->TupleDataLen;
792 return parse_strings(p, q, CISTPL_MAX_ALTSTR_STRINGS,
793 altstr->str, altstr->ofs, &altstr->ns);
796 /*====================================================================*/
798 static int parse_jedec(tuple_t *tuple, cistpl_jedec_t *jedec)
803 p = (u_char *)tuple->TupleData;
804 q = p + tuple->TupleDataLen;
806 for (nid = 0; nid < CISTPL_MAX_DEVICES; nid++) {
809 jedec->id[nid].mfr = p[0];
810 jedec->id[nid].info = p[1];
817 /*====================================================================*/
819 static int parse_manfid(tuple_t *tuple, cistpl_manfid_t *m)
821 if (tuple->TupleDataLen < 4)
823 m->manf = get_unaligned_le16(tuple->TupleData);
824 m->card = get_unaligned_le16(tuple->TupleData + 2);
828 /*====================================================================*/
830 static int parse_funcid(tuple_t *tuple, cistpl_funcid_t *f)
833 if (tuple->TupleDataLen < 2)
835 p = (u_char *)tuple->TupleData;
841 /*====================================================================*/
843 static int parse_funce(tuple_t *tuple, cistpl_funce_t *f)
847 if (tuple->TupleDataLen < 1)
849 p = (u_char *)tuple->TupleData;
851 for (i = 1; i < tuple->TupleDataLen; i++)
856 /*====================================================================*/
858 static int parse_config(tuple_t *tuple, cistpl_config_t *config)
863 p = (u_char *)tuple->TupleData;
865 rmsz = (*p & 0x3c) >> 2;
866 if (tuple->TupleDataLen < rasz+rmsz+4)
868 config->last_idx = *(++p);
871 for (i = 0; i <= rasz; i++)
872 config->base += p[i] << (8*i);
874 for (i = 0; i < 4; i++)
875 config->rmask[i] = 0;
876 for (i = 0; i <= rmsz; i++)
877 config->rmask[i>>2] += p[i] << (8*(i%4));
878 config->subtuples = tuple->TupleDataLen - (rasz+rmsz+4);
882 /*======================================================================
884 The following routines are all used to parse the nightmarish
885 config table entries.
887 ======================================================================*/
889 static u_char *parse_power(u_char *p, u_char *q,
900 for (i = 0; i < 7; i++)
901 if (pwr->present & (1<<i)) {
904 pwr->param[i] = POWER_CVT(*p);
905 scale = POWER_SCALE(*p);
909 if ((*p & 0x7f) < 100)
910 pwr->param[i] += (*p & 0x7f) * scale / 100;
912 pwr->flags |= CISTPL_POWER_HIGHZ_OK;
916 pwr->flags |= CISTPL_POWER_HIGHZ_REQ;
925 /*====================================================================*/
927 static u_char *parse_timing(u_char *p, u_char *q,
928 cistpl_timing_t *timing)
935 if ((scale & 3) != 3) {
938 timing->wait = SPEED_CVT(*p);
939 timing->waitscale = exponent[scale & 3];
943 if ((scale & 7) != 7) {
946 timing->ready = SPEED_CVT(*p);
947 timing->rdyscale = exponent[scale & 7];
954 timing->reserved = SPEED_CVT(*p);
955 timing->rsvscale = exponent[scale];
957 timing->reserved = 0;
962 /*====================================================================*/
964 static u_char *parse_io(u_char *p, u_char *q, cistpl_io_t *io)
975 io->win[0].len = (1 << (io->flags & CISTPL_IO_LINES_MASK));
981 io->nwin = (*p & 0x0f) + 1;
982 bsz = (*p & 0x30) >> 4;
985 lsz = (*p & 0xc0) >> 6;
990 for (i = 0; i < io->nwin; i++) {
993 for (j = 0; j < bsz; j++, p++) {
996 io->win[i].base += *p << (j*8);
998 for (j = 0; j < lsz; j++, p++) {
1001 io->win[i].len += *p << (j*8);
1007 /*====================================================================*/
1009 static u_char *parse_mem(u_char *p, u_char *q, cistpl_mem_t *mem)
1011 int i, j, asz, lsz, has_ha;
1017 mem->nwin = (*p & 0x07) + 1;
1018 lsz = (*p & 0x18) >> 3;
1019 asz = (*p & 0x60) >> 5;
1020 has_ha = (*p & 0x80);
1024 for (i = 0; i < mem->nwin; i++) {
1026 for (j = 0; j < lsz; j++, p++) {
1031 for (j = 0; j < asz; j++, p++) {
1037 for (j = 0; j < asz; j++, p++) {
1042 mem->win[i].len = len << 8;
1043 mem->win[i].card_addr = ca << 8;
1044 mem->win[i].host_addr = ha << 8;
1049 /*====================================================================*/
1051 static u_char *parse_irq(u_char *p, u_char *q, cistpl_irq_t *irq)
1055 irq->IRQInfo1 = *p; p++;
1056 if (irq->IRQInfo1 & IRQ_INFO2_VALID) {
1059 irq->IRQInfo2 = (p[1]<<8) + p[0];
1065 /*====================================================================*/
1067 static int parse_cftable_entry(tuple_t *tuple,
1068 cistpl_cftable_entry_t *entry)
1070 u_char *p, *q, features;
1072 p = tuple->TupleData;
1073 q = p + tuple->TupleDataLen;
1074 entry->index = *p & 0x3f;
1077 entry->flags |= CISTPL_CFTABLE_DEFAULT;
1082 entry->flags |= CISTPL_CFTABLE_BVDS;
1084 entry->flags |= CISTPL_CFTABLE_WP;
1086 entry->flags |= CISTPL_CFTABLE_RDYBSY;
1088 entry->flags |= CISTPL_CFTABLE_MWAIT;
1089 entry->interface = *p & 0x0f;
1091 entry->interface = 0;
1093 /* Process optional features */
1099 if ((features & 3) > 0) {
1100 p = parse_power(p, q, &entry->vcc);
1104 entry->vcc.present = 0;
1105 if ((features & 3) > 1) {
1106 p = parse_power(p, q, &entry->vpp1);
1110 entry->vpp1.present = 0;
1111 if ((features & 3) > 2) {
1112 p = parse_power(p, q, &entry->vpp2);
1116 entry->vpp2.present = 0;
1118 /* Timing options */
1119 if (features & 0x04) {
1120 p = parse_timing(p, q, &entry->timing);
1124 entry->timing.wait = 0;
1125 entry->timing.ready = 0;
1126 entry->timing.reserved = 0;
1129 /* I/O window options */
1130 if (features & 0x08) {
1131 p = parse_io(p, q, &entry->io);
1137 /* Interrupt options */
1138 if (features & 0x10) {
1139 p = parse_irq(p, q, &entry->irq);
1143 entry->irq.IRQInfo1 = 0;
1145 switch (features & 0x60) {
1147 entry->mem.nwin = 0;
1150 entry->mem.nwin = 1;
1151 entry->mem.win[0].len = get_unaligned_le16(p) << 8;
1152 entry->mem.win[0].card_addr = 0;
1153 entry->mem.win[0].host_addr = 0;
1159 entry->mem.nwin = 1;
1160 entry->mem.win[0].len = get_unaligned_le16(p) << 8;
1161 entry->mem.win[0].card_addr = get_unaligned_le16(p + 2) << 8;
1162 entry->mem.win[0].host_addr = 0;
1168 p = parse_mem(p, q, &entry->mem);
1175 if (features & 0x80) {
1178 entry->flags |= (*p << 8);
1185 entry->subtuples = q-p;
1190 /*====================================================================*/
1192 static int parse_device_geo(tuple_t *tuple, cistpl_device_geo_t *geo)
1197 p = (u_char *)tuple->TupleData;
1198 q = p + tuple->TupleDataLen;
1200 for (n = 0; n < CISTPL_MAX_DEVICES; n++) {
1203 geo->geo[n].buswidth = p[0];
1204 geo->geo[n].erase_block = 1 << (p[1]-1);
1205 geo->geo[n].read_block = 1 << (p[2]-1);
1206 geo->geo[n].write_block = 1 << (p[3]-1);
1207 geo->geo[n].partition = 1 << (p[4]-1);
1208 geo->geo[n].interleave = 1 << (p[5]-1);
1215 /*====================================================================*/
1217 static int parse_vers_2(tuple_t *tuple, cistpl_vers_2_t *v2)
1221 if (tuple->TupleDataLen < 10)
1224 p = tuple->TupleData;
1225 q = p + tuple->TupleDataLen;
1229 v2->dindex = get_unaligned_le16(p + 2);
1234 return parse_strings(p, q, 2, v2->str, &v2->vendor, NULL);
1237 /*====================================================================*/
1239 static int parse_org(tuple_t *tuple, cistpl_org_t *org)
1244 p = tuple->TupleData;
1245 q = p + tuple->TupleDataLen;
1251 for (i = 0; i < 30; i++) {
1261 /*====================================================================*/
1263 static int parse_format(tuple_t *tuple, cistpl_format_t *fmt)
1267 if (tuple->TupleDataLen < 10)
1270 p = tuple->TupleData;
1274 fmt->offset = get_unaligned_le32(p + 2);
1275 fmt->length = get_unaligned_le32(p + 6);
1280 /*====================================================================*/
1282 int pcmcia_parse_tuple(tuple_t *tuple, cisparse_t *parse)
1286 if (tuple->TupleDataLen > tuple->TupleDataMax)
1288 switch (tuple->TupleCode) {
1290 case CISTPL_DEVICE_A:
1291 ret = parse_device(tuple, &parse->device);
1293 case CISTPL_CHECKSUM:
1294 ret = parse_checksum(tuple, &parse->checksum);
1296 case CISTPL_LONGLINK_A:
1297 case CISTPL_LONGLINK_C:
1298 ret = parse_longlink(tuple, &parse->longlink);
1300 case CISTPL_LONGLINK_MFC:
1301 ret = parse_longlink_mfc(tuple, &parse->longlink_mfc);
1304 ret = parse_vers_1(tuple, &parse->version_1);
1307 ret = parse_altstr(tuple, &parse->altstr);
1309 case CISTPL_JEDEC_A:
1310 case CISTPL_JEDEC_C:
1311 ret = parse_jedec(tuple, &parse->jedec);
1314 ret = parse_manfid(tuple, &parse->manfid);
1317 ret = parse_funcid(tuple, &parse->funcid);
1320 ret = parse_funce(tuple, &parse->funce);
1323 ret = parse_config(tuple, &parse->config);
1325 case CISTPL_CFTABLE_ENTRY:
1326 ret = parse_cftable_entry(tuple, &parse->cftable_entry);
1328 case CISTPL_DEVICE_GEO:
1329 case CISTPL_DEVICE_GEO_A:
1330 ret = parse_device_geo(tuple, &parse->device_geo);
1333 ret = parse_vers_2(tuple, &parse->vers_2);
1336 ret = parse_org(tuple, &parse->org);
1339 case CISTPL_FORMAT_A:
1340 ret = parse_format(tuple, &parse->format);
1342 case CISTPL_NO_LINK:
1343 case CISTPL_LINKTARGET:
1351 pr_debug("parse_tuple failed %d\n", ret);
1354 EXPORT_SYMBOL(pcmcia_parse_tuple);
1356 /*======================================================================
1358 This is used internally by Card Services to look up CIS stuff.
1360 ======================================================================*/
1362 int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function, cisdata_t code, void *parse)
1368 buf = kmalloc(256, GFP_KERNEL);
1370 dev_printk(KERN_WARNING, &s->dev, "no memory to read tuple\n");
1373 tuple.DesiredTuple = code;
1374 tuple.Attributes = 0;
1375 if (function == BIND_FN_ALL)
1376 tuple.Attributes = TUPLE_RETURN_COMMON;
1377 ret = pccard_get_first_tuple(s, function, &tuple);
1380 tuple.TupleData = buf;
1381 tuple.TupleOffset = 0;
1382 tuple.TupleDataMax = 255;
1383 ret = pccard_get_tuple_data(s, &tuple);
1386 ret = pcmcia_parse_tuple(&tuple, parse);
1394 * pccard_loop_tuple() - loop over tuples in the CIS
1395 * @s: the struct pcmcia_socket where the card is inserted
1396 * @function: the device function we loop for
1397 * @code: which CIS code shall we look for?
1398 * @parse: buffer where the tuple shall be parsed (or NULL, if no parse)
1399 * @priv_data: private data to be passed to the loop_tuple function.
1400 * @loop_tuple: function to call for each CIS entry of type @function. IT
1401 * gets passed the raw tuple, the paresed tuple (if @parse is
1402 * set) and @priv_data.
1404 * pccard_loop_tuple() loops over all CIS entries of type @function, and
1405 * calls the @loop_tuple function for each entry. If the call to @loop_tuple
1406 * returns 0, the loop exits. Returns 0 on success or errorcode otherwise.
1408 int pccard_loop_tuple(struct pcmcia_socket *s, unsigned int function,
1409 cisdata_t code, cisparse_t *parse, void *priv_data,
1410 int (*loop_tuple) (tuple_t *tuple,
1418 buf = kzalloc(256, GFP_KERNEL);
1420 dev_printk(KERN_WARNING, &s->dev, "no memory to read tuple\n");
1424 tuple.TupleData = buf;
1425 tuple.TupleDataMax = 255;
1426 tuple.TupleOffset = 0;
1427 tuple.DesiredTuple = code;
1428 tuple.Attributes = 0;
1430 ret = pccard_get_first_tuple(s, function, &tuple);
1432 if (pccard_get_tuple_data(s, &tuple))
1436 if (pcmcia_parse_tuple(&tuple, parse))
1439 ret = loop_tuple(&tuple, parse, priv_data);
1444 ret = pccard_get_next_tuple(s, function, &tuple);
1453 * pccard_validate_cis() - check whether card has a sensible CIS
1454 * @s: the struct pcmcia_socket we are to check
1455 * @info: returns the number of tuples in the (valid) CIS, or 0
1457 * This tries to determine if a card has a sensible CIS. In @info, it
1458 * returns the number of tuples in the CIS, or 0 if the CIS looks bad. The
1459 * checks include making sure several critical tuples are present and
1460 * valid; seeing if the total number of tuples is reasonable; and
1461 * looking for tuples that use reserved codes.
1463 * The function returns 0 on success.
1465 int pccard_validate_cis(struct pcmcia_socket *s, unsigned int *info)
1469 unsigned int count = 0;
1470 int ret, reserved, dev_ok = 0, ident_ok = 0;
1475 /* We do not want to validate the CIS cache... */
1476 mutex_lock(&s->ops_mutex);
1477 destroy_cis_cache(s);
1478 mutex_unlock(&s->ops_mutex);
1480 tuple = kmalloc(sizeof(*tuple), GFP_KERNEL);
1481 if (tuple == NULL) {
1482 dev_warn(&s->dev, "no memory to validate CIS\n");
1485 p = kmalloc(sizeof(*p), GFP_KERNEL);
1488 dev_warn(&s->dev, "no memory to validate CIS\n");
1492 count = reserved = 0;
1493 tuple->DesiredTuple = RETURN_FIRST_TUPLE;
1494 tuple->Attributes = TUPLE_RETURN_COMMON;
1495 ret = pccard_get_first_tuple(s, BIND_FN_ALL, tuple);
1499 /* First tuple should be DEVICE; we should really have either that
1500 or a CFTABLE_ENTRY of some sort */
1501 if ((tuple->TupleCode == CISTPL_DEVICE) ||
1502 (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_CFTABLE_ENTRY, p)) ||
1503 (!pccard_read_tuple(s, BIND_FN_ALL, CISTPL_CFTABLE_ENTRY_CB, p)))
1506 /* All cards should have a MANFID tuple, and/or a VERS_1 or VERS_2
1507 tuple, for card identification. Certain old D-Link and Linksys
1508 cards have only a broken VERS_2 tuple; hence the bogus test. */
1509 if ((pccard_read_tuple(s, BIND_FN_ALL, CISTPL_MANFID, p) == 0) ||
1510 (pccard_read_tuple(s, BIND_FN_ALL, CISTPL_VERS_1, p) == 0) ||
1511 (pccard_read_tuple(s, BIND_FN_ALL, CISTPL_VERS_2, p) != -ENOSPC))
1514 if (!dev_ok && !ident_ok)
1517 for (count = 1; count < MAX_TUPLES; count++) {
1518 ret = pccard_get_next_tuple(s, BIND_FN_ALL, tuple);
1521 if (((tuple->TupleCode > 0x23) && (tuple->TupleCode < 0x40)) ||
1522 ((tuple->TupleCode > 0x47) && (tuple->TupleCode < 0x80)) ||
1523 ((tuple->TupleCode > 0x90) && (tuple->TupleCode < 0xff)))
1526 if ((count == MAX_TUPLES) || (reserved > 5) ||
1527 ((!dev_ok || !ident_ok) && (count > 10)))
1533 /* invalidate CIS cache on failure */
1534 if (!dev_ok || !ident_ok || !count) {
1535 mutex_lock(&s->ops_mutex);
1536 destroy_cis_cache(s);
1537 mutex_unlock(&s->ops_mutex);
1549 #define to_socket(_dev) container_of(_dev, struct pcmcia_socket, dev)
1551 static ssize_t pccard_extract_cis(struct pcmcia_socket *s, char *buf,
1552 loff_t off, size_t count)
1558 u_char *tuplebuffer;
1561 tuplebuffer = kmalloc(sizeof(u_char) * 256, GFP_KERNEL);
1565 tempbuffer = kmalloc(sizeof(u_char) * 258, GFP_KERNEL);
1571 memset(&tuple, 0, sizeof(tuple_t));
1573 tuple.Attributes = TUPLE_RETURN_LINK | TUPLE_RETURN_COMMON;
1574 tuple.DesiredTuple = RETURN_FIRST_TUPLE;
1575 tuple.TupleOffset = 0;
1577 status = pccard_get_first_tuple(s, BIND_FN_ALL, &tuple);
1579 tuple.TupleData = tuplebuffer;
1580 tuple.TupleDataMax = 255;
1581 memset(tuplebuffer, 0, sizeof(u_char) * 255);
1583 status = pccard_get_tuple_data(s, &tuple);
1587 if (off < (pointer + 2 + tuple.TupleDataLen)) {
1588 tempbuffer[0] = tuple.TupleCode & 0xff;
1589 tempbuffer[1] = tuple.TupleLink & 0xff;
1590 for (i = 0; i < tuple.TupleDataLen; i++)
1591 tempbuffer[i + 2] = tuplebuffer[i] & 0xff;
1593 for (i = 0; i < (2 + tuple.TupleDataLen); i++) {
1594 if (((i + pointer) >= off) &&
1595 (i + pointer) < (off + count)) {
1596 buf[ret] = tempbuffer[i];
1602 pointer += 2 + tuple.TupleDataLen;
1604 if (pointer >= (off + count))
1607 if (tuple.TupleCode == CISTPL_END)
1609 status = pccard_get_next_tuple(s, BIND_FN_ALL, &tuple);
1620 static ssize_t pccard_show_cis(struct kobject *kobj,
1621 struct bin_attribute *bin_attr,
1622 char *buf, loff_t off, size_t count)
1624 unsigned int size = 0x200;
1629 struct pcmcia_socket *s;
1630 unsigned int chains;
1632 if (off + count > size)
1635 s = to_socket(container_of(kobj, struct device, kobj));
1637 if (!(s->state & SOCKET_PRESENT))
1639 if (pccard_validate_cis(s, &chains))
1644 count = pccard_extract_cis(s, buf, off, count);
1651 static ssize_t pccard_store_cis(struct kobject *kobj,
1652 struct bin_attribute *bin_attr,
1653 char *buf, loff_t off, size_t count)
1655 struct pcmcia_socket *s;
1658 s = to_socket(container_of(kobj, struct device, kobj));
1663 if (count >= CISTPL_MAX_CIS_SIZE)
1666 if (!(s->state & SOCKET_PRESENT))
1669 error = pcmcia_replace_cis(s, buf, count);
1673 mutex_lock(&s->skt_mutex);
1674 if ((s->callback) && (s->state & SOCKET_PRESENT) &&
1675 !(s->state & SOCKET_CARDBUS)) {
1676 if (try_module_get(s->callback->owner)) {
1677 s->callback->requery(s, 1);
1678 module_put(s->callback->owner);
1681 mutex_unlock(&s->skt_mutex);
1687 struct bin_attribute pccard_cis_attr = {
1688 .attr = { .name = "cis", .mode = S_IRUGO | S_IWUSR },
1690 .read = pccard_show_cis,
1691 .write = pccard_store_cis,