Home | History | Annotate | Line # | Download | only in sdmmc
sdmmc_cis.c revision 1.3 
      1 /*	$NetBSD: sdmmc_cis.c,v 1.3 2010/10/07 16:26:37 kiyohara Exp $	*/
      2 /*	$OpenBSD: sdmmc_cis.c,v 1.1 2006/06/01 21:53:41 uwe Exp $	*/
      3 
      4 /*
      5  * Copyright (c) 2006 Uwe Stuehler <uwe (at) openbsd.org>
      6  *
      7  * Permission to use, copy, modify, and distribute this software for any
      8  * purpose with or without fee is hereby granted, provided that the above
      9  * copyright notice and this permission notice appear in all copies.
     10  *
     11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
     12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     18  */
     19 
     20 /* Routines to decode the Card Information Structure of SD I/O cards */
     21 
     22 #include <sys/cdefs.h>
     23 __KERNEL_RCSID(0, "$NetBSD: sdmmc_cis.c,v 1.3 2010/10/07 16:26:37 kiyohara Exp $");
     24 
     25 #include <sys/param.h>
     26 #include <sys/systm.h>
     27 
     28 #include <dev/sdmmc/sdmmc_ioreg.h>
     29 #include <dev/sdmmc/sdmmcdevs.h>
     30 #include <dev/sdmmc/sdmmcvar.h>
     31 
     32 #include <dev/pcmcia/pcmciareg.h>
     33 
     34 #ifdef SDMMCCISDEBUG
     35 #define DPRINTF(s)	printf s
     36 #else
     37 #define DPRINTF(s)	/**/
     38 #endif
     39 
     40 static uint32_t sdmmc_cisptr(struct sdmmc_function *);
     41 static void decode_funce_common(struct sdmmc_function *, struct sdmmc_cis *,
     42 				int, uint32_t);
     43 static void decode_funce_function(struct sdmmc_function *, struct sdmmc_cis *,
     44 				  int, uint32_t);
     45 static void decode_vers_1(struct sdmmc_function *, struct sdmmc_cis *, int,
     46 			  uint32_t);
     47 
     48 static uint32_t
     49 sdmmc_cisptr(struct sdmmc_function *sf)
     50 {
     51 	uint32_t cisptr = 0;
     52 
     53 	/* CIS pointer stored in little-endian format. */
     54 	if (sf->number == 0) {
     55 		cisptr |= sdmmc_io_read_1(sf, SD_IO_CCCR_CISPTR + 0) << 0;
     56 		cisptr |= sdmmc_io_read_1(sf, SD_IO_CCCR_CISPTR + 1) << 8;
     57 		cisptr |= sdmmc_io_read_1(sf, SD_IO_CCCR_CISPTR + 2) << 16;
     58 	} else {
     59 		struct sdmmc_function *sf0 = sf->sc->sc_fn0;
     60 		int num = sf->number;
     61 
     62 		cisptr |= sdmmc_io_read_1(sf0, SD_IO_FBR(num) + 9) << 0;
     63 		cisptr |= sdmmc_io_read_1(sf0, SD_IO_FBR(num) + 10) << 8;
     64 		cisptr |= sdmmc_io_read_1(sf0, SD_IO_FBR(num) + 11) << 16;
     65 	}
     66 	return cisptr;
     67 }
     68 
     69 static void
     70 decode_funce_common(struct sdmmc_function *sf, struct sdmmc_cis *cis,
     71 		    int tpllen, uint32_t reg)
     72 {
     73 	static const int speed_val[] =
     74 	    { 0, 10, 12, 13, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 70, 80 };
     75 	static const int speed_unit[] = { 10, 100, 1000, 10000, };
     76 	struct sdmmc_function *sf0 = sf->sc->sc_fn0;
     77 	device_t dev = sf->sc->sc_dev;
     78 	int fn0_blk_size, max_tran_speed;
     79 
     80 	if (sf->number != 0) {
     81 		aprint_error_dev(dev,
     82 		    "CISTPL_FUNCE(common) found in function\n");
     83 		return;
     84 	}
     85 	if (tpllen < 4) {
     86 		aprint_error_dev(dev, "CISTPL_FUNCE(common) too short\n");
     87 		return;
     88 	}
     89 
     90 	fn0_blk_size = sdmmc_io_read_1(sf0, reg++);
     91 	fn0_blk_size |= sdmmc_io_read_1(sf0, reg++) << 8;
     92 	max_tran_speed = sdmmc_io_read_1(sf0, reg++);
     93 	sf->csd.tran_speed =
     94 	    speed_val[max_tran_speed >> 3] * speed_unit[max_tran_speed & 7];
     95 
     96 	DPRINTF(
     97 	    ("CISTPL_FUNCE: FN0_BLK_SIZE=0x%x, MAX_TRAN_SPEED=0x%x(%dkHz)\n",
     98 	    fn0_blk_size, max_tran_speed, sf->csd.tran_speed));
     99 }
    100 
    101 static void
    102 decode_funce_function(struct sdmmc_function *sf, struct sdmmc_cis *cis,
    103 		      int tpllen, uint32_t reg)
    104 {
    105 	struct sdmmc_function *sf0 = sf->sc->sc_fn0;
    106 	device_t dev = sf->sc->sc_dev;
    107 	int sdiox_cccrx, sdiox, max_blk_size;
    108 
    109 	sdiox_cccrx = sdmmc_io_read_1(sf0, SD_IO_CCCR_CCCR_SDIO_REV);
    110 	sdiox = SD_IO_CCCR_SDIO_REV(sdiox_cccrx);
    111 
    112 	if (sf->number == 0) {
    113 		aprint_error_dev(dev,
    114 		    "CISTPL_FUNCE(function) found in common\n");
    115 		return;
    116 	}
    117 	if (sdiox == CCCR_SDIO_REV_1_00 && tpllen < 0x1c) {
    118 		aprint_error_dev(dev,
    119 		    "CISTPL_FUNCE(function) too short (v1.00)\n");
    120 		return;
    121 	} else if (sdiox != CCCR_SDIO_REV_1_00 && tpllen < 0x2a) {
    122 		aprint_error_dev(dev, "CISTPL_FUNCE(function) too short\n");
    123 		return;
    124 	}
    125 
    126 	max_blk_size = sdmmc_io_read_1(sf0, reg + 11);
    127 	max_blk_size |= sdmmc_io_read_1(sf0, reg + 12) << 8;
    128 
    129 	DPRINTF(("CISTPL_FUNCE: MAX_BLK_SIZE=0x%x\n", max_blk_size));
    130 }
    131 
    132 static void
    133 decode_vers_1(struct sdmmc_function *sf, struct sdmmc_cis *cis, int tpllen,
    134 	      uint32_t reg)
    135 {
    136 	struct sdmmc_function *sf0 = sf->sc->sc_fn0;
    137 	device_t dev = sf->sc->sc_dev;
    138 	int start, ch, count, i;
    139 
    140 	if (tpllen < 2) {
    141 		aprint_error_dev(dev, "CISTPL_VERS_1 too short\n");
    142 		return;
    143 	}
    144 
    145 	cis->cis1_major = sdmmc_io_read_1(sf0, reg++);
    146 	cis->cis1_minor = sdmmc_io_read_1(sf0, reg++);
    147 
    148 	for (count = 0, start = 0, i = 0; (count < 4) && ((i + 4) < 256); i++) {
    149 		ch = sdmmc_io_read_1(sf0, reg + i);
    150 		if (ch == 0xff)
    151 			break;
    152 		cis->cis1_info_buf[i] = ch;
    153 		if (ch == 0) {
    154 			cis->cis1_info[count] = cis->cis1_info_buf + start;
    155 			start = i + 1;
    156 			count++;
    157 		}
    158 	}
    159 
    160 	DPRINTF(("CISTPL_VERS_1\n"));
    161 }
    162 
    163 int
    164 sdmmc_read_cis(struct sdmmc_function *sf, struct sdmmc_cis *cis)
    165 {
    166 	struct sdmmc_function *sf0 = sf->sc->sc_fn0;
    167 	device_t dev = sf->sc->sc_dev;
    168 	uint32_t reg;
    169 	uint8_t tplcode, tpllen;
    170 
    171 	memset(cis, 0, sizeof *cis);
    172 
    173 	reg = sdmmc_cisptr(sf);
    174 	if (reg < SD_IO_CIS_START ||
    175 	    reg >= (SD_IO_CIS_START + SD_IO_CIS_SIZE - 16)) {
    176 		aprint_error_dev(dev, "bad CIS ptr %#x\n", reg);
    177 		return 1;
    178 	}
    179 
    180 	for (;;) {
    181 		tplcode = sdmmc_io_read_1(sf0, reg++);
    182 
    183 		if (tplcode == PCMCIA_CISTPL_NULL) {
    184 			DPRINTF((" 00\nCISTPL_NONE\n"));
    185 			continue;
    186 		}
    187 
    188 		tpllen = sdmmc_io_read_1(sf0, reg++);
    189 		if (tplcode == PCMCIA_CISTPL_END || tpllen == 0) {
    190 			if (tplcode != 0xff)
    191 				aprint_error_dev(dev, "CIS parse error at %d, "
    192 				    "tuple code %#x, length %d\n",
    193 				    reg, tplcode, tpllen);
    194 			else {
    195 				DPRINTF((" ff\nCISTPL_END\n"));
    196 			}
    197 			break;
    198 		}
    199 
    200 #ifdef SDMMCCISDEBUG
    201 		{
    202 			int i;
    203 
    204 			/* print the tuple */
    205 			DPRINTF((" %02x %02x", tplcode, tpllen));
    206 
    207 			for (i = 0; i < tpllen; i++) {
    208 				DPRINTF((" %02x",
    209 				    sdmmc_io_read_1(sf0, reg + i)));
    210 				if ((i % 16) == 13)
    211 					DPRINTF(("\n"));
    212 			}
    213 			if ((i % 16) != 14)
    214 				DPRINTF(("\n"));
    215 		}
    216 #endif
    217 
    218 		switch (tplcode) {
    219 		case PCMCIA_CISTPL_FUNCE:
    220 			if (sdmmc_io_read_1(sf0, reg++) == 0)
    221 				decode_funce_common(sf, cis, tpllen, reg);
    222 			else
    223 				decode_funce_function(sf, cis, tpllen, reg);
    224 			reg += (tpllen - 1);
    225 			break;
    226 
    227 		case PCMCIA_CISTPL_FUNCID:
    228 			if (tpllen < 2) {
    229 				aprint_error_dev(dev,
    230 				    "bad CISTPL_FUNCID length\n");
    231 				reg += tpllen;
    232 				break;
    233 			}
    234 			cis->function = sdmmc_io_read_1(sf0, reg);
    235 			DPRINTF(("CISTPL_FUNCID\n"));
    236 			reg += tpllen;
    237 			break;
    238 
    239 		case PCMCIA_CISTPL_MANFID:
    240 			if (tpllen < 4) {
    241 				aprint_error_dev(dev,
    242 				    "bad CISTPL_MANFID length\n");
    243 				reg += tpllen;
    244 				break;
    245 			}
    246 			cis->manufacturer = sdmmc_io_read_1(sf0, reg++);
    247 			cis->manufacturer |= sdmmc_io_read_1(sf0, reg++) << 8;
    248 			cis->product = sdmmc_io_read_1(sf0, reg++);
    249 			cis->product |= sdmmc_io_read_1(sf0, reg++) << 8;
    250 			DPRINTF(("CISTPL_MANFID\n"));
    251 			break;
    252 
    253 		case PCMCIA_CISTPL_VERS_1:
    254 			decode_vers_1(sf, cis, tpllen, reg);
    255 			reg += tpllen;
    256 			break;
    257 
    258 		default:
    259 			aprint_error_dev(dev,
    260 			    "unknown tuple code %#x, length %d\n",
    261 			    tplcode, tpllen);
    262 			reg += tpllen;
    263 			break;
    264 		}
    265 	}
    266 
    267 	return 0;
    268 }
    269 
    270 void
    271 sdmmc_print_cis(struct sdmmc_function *sf)
    272 {
    273 	device_t dev = sf->sc->sc_dev;
    274 	struct sdmmc_cis *cis = &sf->cis;
    275 	int i;
    276 
    277 	printf("%s: CIS version %u.%u\n", device_xname(dev), cis->cis1_major,
    278 	    cis->cis1_minor);
    279 
    280 	printf("%s: CIS info: ", device_xname(dev));
    281 	for (i = 0; i < 4; i++) {
    282 		if (cis->cis1_info[i] == NULL)
    283 			break;
    284 		if (i != 0)
    285 			aprint_verbose(", ");
    286 		printf("%s", cis->cis1_info[i]);
    287 	}
    288 	printf("\n");
    289 
    290 	printf("%s: Manufacturer code 0x%x, product 0x%x\n", device_xname(dev),
    291 	    cis->manufacturer, cis->product);
    292 
    293 	printf("%s: function %d: ", device_xname(dev), sf->number);
    294 	printf("\n");
    295 }
    296 
    297 void
    298 sdmmc_check_cis_quirks(struct sdmmc_function *sf)
    299 {
    300 	char *p;
    301 	int i;
    302 
    303 	if (sf->cis.manufacturer == SDMMC_VENDOR_SPECTEC &&
    304 	    sf->cis.product == SDMMC_PRODUCT_SPECTEC_SDW820) {
    305 		/* This card lacks the VERS_1 tuple. */
    306 		static const char cis1_info[] =
    307 		    "Spectec\0SDIO WLAN Card\0SDW-820\0\0";
    308 
    309 		sf->cis.cis1_major = 0x01;
    310 		sf->cis.cis1_minor = 0x00;
    311 
    312 		p = sf->cis.cis1_info_buf;
    313 		strlcpy(p, cis1_info, sizeof(sf->cis.cis1_info_buf));
    314 		for (i = 0; i < 4; i++) {
    315 			sf->cis.cis1_info[i] = p;
    316 			p += strlen(p) + 1;
    317 		}
    318 	}
    319 }
    320