Home | History | Annotate | Line # | Download | only in sdmmc
sdmmc_cis.c revision 1.5.10.1
      1 /*	$NetBSD: sdmmc_cis.c,v 1.5.10.1 2020/02/25 18:40:43 martin 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.5.10.1 2020/02/25 18:40:43 martin Exp $");
     24 
     25 #ifdef _KERNEL_OPT
     26 #include "opt_sdmmc.h"
     27 #endif
     28 
     29 #include <sys/param.h>
     30 #include <sys/systm.h>
     31 
     32 #include <dev/sdmmc/sdmmc_ioreg.h>
     33 #include <dev/sdmmc/sdmmcdevs.h>
     34 #include <dev/sdmmc/sdmmcvar.h>
     35 
     36 #include <dev/pcmcia/pcmciareg.h>
     37 
     38 #ifdef SDMMCCISDEBUG
     39 #define DPRINTF(s)	printf s
     40 #else
     41 #define DPRINTF(s)	/**/
     42 #endif
     43 
     44 static uint32_t sdmmc_cisptr(struct sdmmc_function *);
     45 static void decode_funce_common(struct sdmmc_function *, struct sdmmc_cis *,
     46 				int, uint32_t);
     47 static void decode_funce_function(struct sdmmc_function *, struct sdmmc_cis *,
     48 				  int, uint32_t);
     49 static void decode_vers_1(struct sdmmc_function *, struct sdmmc_cis *, int,
     50 			  uint32_t);
     51 
     52 static uint32_t
     53 sdmmc_cisptr(struct sdmmc_function *sf)
     54 {
     55 	uint32_t cisptr = 0;
     56 
     57 	/* CIS pointer stored in little-endian format. */
     58 	if (sf->number == 0) {
     59 		cisptr |= sdmmc_io_read_1(sf, SD_IO_CCCR_CISPTR + 0) << 0;
     60 		cisptr |= sdmmc_io_read_1(sf, SD_IO_CCCR_CISPTR + 1) << 8;
     61 		cisptr |= sdmmc_io_read_1(sf, SD_IO_CCCR_CISPTR + 2) << 16;
     62 	} else {
     63 		struct sdmmc_function *sf0 = sf->sc->sc_fn0;
     64 		int num = sf->number;
     65 
     66 		cisptr |= sdmmc_io_read_1(sf0, SD_IO_FBR(num) + 9) << 0;
     67 		cisptr |= sdmmc_io_read_1(sf0, SD_IO_FBR(num) + 10) << 8;
     68 		cisptr |= sdmmc_io_read_1(sf0, SD_IO_FBR(num) + 11) << 16;
     69 	}
     70 	return cisptr;
     71 }
     72 
     73 static void
     74 decode_funce_common(struct sdmmc_function *sf, struct sdmmc_cis *cis,
     75 		    int tpllen, uint32_t reg)
     76 {
     77 	static const int speed_val[] =
     78 	    { 0, 10, 12, 13, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 70, 80 };
     79 	static const int speed_unit[] = { 10, 100, 1000, 10000, };
     80 	struct sdmmc_function *sf0 = sf->sc->sc_fn0;
     81 	device_t dev = sf->sc->sc_dev;
     82 	int fn0_blk_size, max_tran_speed;
     83 
     84 	if (sf->number != 0) {
     85 		aprint_error_dev(dev,
     86 		    "CISTPL_FUNCE(common) found in function\n");
     87 		return;
     88 	}
     89 	if (tpllen < 4) {
     90 		aprint_error_dev(dev, "CISTPL_FUNCE(common) too short\n");
     91 		return;
     92 	}
     93 
     94 	fn0_blk_size = sdmmc_io_read_1(sf0, reg++);
     95 	fn0_blk_size |= sdmmc_io_read_1(sf0, reg++) << 8;
     96 	max_tran_speed = sdmmc_io_read_1(sf0, reg++);
     97 	sf->csd.tran_speed =
     98 	    speed_val[max_tran_speed >> 3] * speed_unit[max_tran_speed & 7];
     99 
    100 	DPRINTF(
    101 	    ("CISTPL_FUNCE: FN0_BLK_SIZE=0x%x, MAX_TRAN_SPEED=0x%x(%dkHz)\n",
    102 	    fn0_blk_size, max_tran_speed, sf->csd.tran_speed));
    103 }
    104 
    105 static void
    106 decode_funce_function(struct sdmmc_function *sf, struct sdmmc_cis *cis,
    107 		      int tpllen, uint32_t reg)
    108 {
    109 	struct sdmmc_function *sf0 = sf->sc->sc_fn0;
    110 	device_t dev = sf->sc->sc_dev;
    111 	int sdiox_cccrx, sdiox, max_blk_size;
    112 
    113 	sdiox_cccrx = sdmmc_io_read_1(sf0, SD_IO_CCCR_CCCR_SDIO_REV);
    114 	sdiox = SD_IO_CCCR_SDIO_REV(sdiox_cccrx);
    115 
    116 	if (sf->number == 0) {
    117 		aprint_error_dev(dev,
    118 		    "CISTPL_FUNCE(function) found in common\n");
    119 		return;
    120 	}
    121 	if (sdiox == CCCR_SDIO_REV_1_00 && tpllen < 0x1c) {
    122 		aprint_error_dev(dev,
    123 		    "CISTPL_FUNCE(function) too short (v1.00)\n");
    124 		return;
    125 	} else if (sdiox != CCCR_SDIO_REV_1_00 && tpllen < 0x2a) {
    126 		aprint_error_dev(dev, "CISTPL_FUNCE(function) too short\n");
    127 		return;
    128 	}
    129 
    130 	max_blk_size = sdmmc_io_read_1(sf0, reg + 11);
    131 	max_blk_size |= sdmmc_io_read_1(sf0, reg + 12) << 8;
    132 
    133 device_printf(dev, "MAX_BLK_SIZE%d = %d\n", sf->number, max_blk_size);
    134 	DPRINTF(("CISTPL_FUNCE: MAX_BLK_SIZE=0x%x\n", max_blk_size));
    135 }
    136 
    137 static void
    138 decode_vers_1(struct sdmmc_function *sf, struct sdmmc_cis *cis, int tpllen,
    139 	      uint32_t reg)
    140 {
    141 	struct sdmmc_function *sf0 = sf->sc->sc_fn0;
    142 	device_t dev = sf->sc->sc_dev;
    143 	int start, ch, count, i;
    144 
    145 	if (tpllen < 2) {
    146 		aprint_error_dev(dev, "CISTPL_VERS_1 too short\n");
    147 		return;
    148 	}
    149 
    150 	cis->cis1_major = sdmmc_io_read_1(sf0, reg++);
    151 	cis->cis1_minor = sdmmc_io_read_1(sf0, reg++);
    152 
    153 	for (count = 0, start = 0, i = 0; (count < 4) && ((i + 4) < 256); i++) {
    154 		ch = sdmmc_io_read_1(sf0, reg + i);
    155 		if (ch == 0xff)
    156 			break;
    157 		cis->cis1_info_buf[i] = ch;
    158 		if (ch == 0) {
    159 			cis->cis1_info[count] = cis->cis1_info_buf + start;
    160 			start = i + 1;
    161 			count++;
    162 		}
    163 	}
    164 
    165 	DPRINTF(("CISTPL_VERS_1\n"));
    166 }
    167 
    168 int
    169 sdmmc_read_cis(struct sdmmc_function *sf, struct sdmmc_cis *cis)
    170 {
    171 	struct sdmmc_function *sf0 = sf->sc->sc_fn0;
    172 	device_t dev = sf->sc->sc_dev;
    173 	uint32_t reg;
    174 	uint8_t tplcode, tpllen;
    175 
    176 	memset(cis, 0, sizeof *cis);
    177 
    178 	reg = sdmmc_cisptr(sf);
    179 	if (reg < SD_IO_CIS_START ||
    180 	    reg >= (SD_IO_CIS_START + SD_IO_CIS_SIZE - 16)) {
    181 		aprint_error_dev(dev, "bad CIS ptr %#x\n", reg);
    182 		return 1;
    183 	}
    184 
    185 	for (;;) {
    186 		tplcode = sdmmc_io_read_1(sf0, reg++);
    187 
    188 		if (tplcode == PCMCIA_CISTPL_NULL) {
    189 			DPRINTF((" 00\nCISTPL_NONE\n"));
    190 			continue;
    191 		}
    192 
    193 		tpllen = sdmmc_io_read_1(sf0, reg++);
    194 		if (tplcode == PCMCIA_CISTPL_END || tpllen == 0) {
    195 			if (tplcode != 0xff)
    196 				aprint_error_dev(dev, "CIS parse error at %d, "
    197 				    "tuple code %#x, length %d\n",
    198 				    reg, tplcode, tpllen);
    199 			else {
    200 				DPRINTF((" ff\nCISTPL_END\n"));
    201 			}
    202 			break;
    203 		}
    204 
    205 #ifdef SDMMCCISDEBUG
    206 		{
    207 			int i;
    208 
    209 			/* print the tuple */
    210 			DPRINTF((" %02x %02x", tplcode, tpllen));
    211 
    212 			for (i = 0; i < tpllen; i++) {
    213 				DPRINTF((" %02x",
    214 				    sdmmc_io_read_1(sf0, reg + i)));
    215 				if ((i % 16) == 13)
    216 					DPRINTF(("\n"));
    217 			}
    218 			if ((i % 16) != 14)
    219 				DPRINTF(("\n"));
    220 		}
    221 #endif
    222 
    223 		switch (tplcode) {
    224 		case PCMCIA_CISTPL_FUNCE:
    225 			if (sdmmc_io_read_1(sf0, reg++) == 0)
    226 				decode_funce_common(sf, cis, tpllen, reg);
    227 			else
    228 				decode_funce_function(sf, cis, tpllen, reg);
    229 			reg += (tpllen - 1);
    230 			break;
    231 
    232 		case PCMCIA_CISTPL_FUNCID:
    233 			if (tpllen < 2) {
    234 				aprint_error_dev(dev,
    235 				    "bad CISTPL_FUNCID length\n");
    236 				reg += tpllen;
    237 				break;
    238 			}
    239 			cis->function = sdmmc_io_read_1(sf0, reg);
    240 			DPRINTF(("CISTPL_FUNCID\n"));
    241 			reg += tpllen;
    242 			break;
    243 
    244 		case PCMCIA_CISTPL_MANFID:
    245 			if (tpllen < 4) {
    246 				aprint_error_dev(dev,
    247 				    "bad CISTPL_MANFID length\n");
    248 				reg += tpllen;
    249 				break;
    250 			}
    251 			cis->manufacturer = sdmmc_io_read_1(sf0, reg++);
    252 			cis->manufacturer |= sdmmc_io_read_1(sf0, reg++) << 8;
    253 			cis->product = sdmmc_io_read_1(sf0, reg++);
    254 			cis->product |= sdmmc_io_read_1(sf0, reg++) << 8;
    255 			DPRINTF(("CISTPL_MANFID\n"));
    256 			break;
    257 
    258 		case PCMCIA_CISTPL_VERS_1:
    259 			decode_vers_1(sf, cis, tpllen, reg);
    260 			reg += tpllen;
    261 			break;
    262 
    263 		case PCMCIA_CISTPL_SDIO:
    264 			aprint_normal_dev(dev, "SDIO function\n");
    265 			reg += tpllen;
    266 			break;
    267 
    268 		default:
    269 			/*
    270 			 * Tuple codes between 80h-8Fh are vendor unique.
    271 			 * Print a warning about all other codes.
    272 			 */
    273 			if ((tplcode & 0xf0) != 0x80)
    274 				aprint_error_dev(dev,
    275 				    "unknown tuple code %#x, length %d\n",
    276 				    tplcode, tpllen);
    277 			reg += tpllen;
    278 			break;
    279 		}
    280 	}
    281 
    282 	return 0;
    283 }
    284 
    285 void
    286 sdmmc_print_cis(struct sdmmc_function *sf)
    287 {
    288 	device_t dev = sf->sc->sc_dev;
    289 	struct sdmmc_cis *cis = &sf->cis;
    290 	int i;
    291 
    292 	printf("%s: CIS version %u.%u\n", device_xname(dev), cis->cis1_major,
    293 	    cis->cis1_minor);
    294 
    295 	printf("%s: CIS info: ", device_xname(dev));
    296 	for (i = 0; i < 4; i++) {
    297 		if (cis->cis1_info[i] == NULL)
    298 			break;
    299 		if (i != 0)
    300 			aprint_verbose(", ");
    301 		printf("%s", cis->cis1_info[i]);
    302 	}
    303 	printf("\n");
    304 
    305 	printf("%s: Manufacturer code 0x%x, product 0x%x\n", device_xname(dev),
    306 	    cis->manufacturer, cis->product);
    307 
    308 	printf("%s: function %d: ", device_xname(dev), sf->number);
    309 	printf("\n");
    310 }
    311 
    312 void
    313 sdmmc_check_cis_quirks(struct sdmmc_function *sf)
    314 {
    315 	char *p;
    316 	int i;
    317 
    318 	if (sf->cis.manufacturer == SDMMC_VENDOR_SPECTEC &&
    319 	    sf->cis.product == SDMMC_PRODUCT_SPECTEC_SDW820) {
    320 		/* This card lacks the VERS_1 tuple. */
    321 		static const char cis1_info[] =
    322 		    "Spectec\0SDIO WLAN Card\0SDW-820\0\0";
    323 
    324 		sf->cis.cis1_major = 0x01;
    325 		sf->cis.cis1_minor = 0x00;
    326 
    327 		p = sf->cis.cis1_info_buf;
    328 		strlcpy(p, cis1_info, sizeof(sf->cis.cis1_info_buf));
    329 		for (i = 0; i < 4; i++) {
    330 			sf->cis.cis1_info[i] = p;
    331 			p += strlen(p) + 1;
    332 		}
    333 	}
    334 }
    335