Home | History | Annotate | Line # | Download | only in cardbus
cardbus.c revision 1.67
      1 /*	$NetBSD: cardbus.c,v 1.67 2005/10/25 16:37:50 drochner Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1997, 1998, 1999 and 2000
      5  *     HAYAKAWA Koichi.  All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. All advertising materials mentioning features or use of this software
     16  *    must display the following acknowledgement:
     17  *	This product includes software developed by HAYAKAWA Koichi.
     18  * 4. The name of the author may not be used to endorse or promote products
     19  *    derived from this software without specific prior written permission.
     20  *
     21  *
     22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     24  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     25  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
     26  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     27  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
     28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     30  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
     31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     32  * POSSIBILITY OF SUCH DAMAGE.
     33  */
     34 
     35 #include <sys/cdefs.h>
     36 __KERNEL_RCSID(0, "$NetBSD: cardbus.c,v 1.67 2005/10/25 16:37:50 drochner Exp $");
     37 
     38 #include "opt_cardbus.h"
     39 
     40 #include <sys/param.h>
     41 #include <sys/systm.h>
     42 #include <sys/device.h>
     43 #include <sys/malloc.h>
     44 #include <sys/kernel.h>
     45 #include <sys/syslog.h>
     46 #include <sys/proc.h>
     47 #include <sys/reboot.h>		/* for AB_* needed by bootverbose */
     48 
     49 #include <machine/bus.h>
     50 
     51 #include <dev/cardbus/cardbusvar.h>
     52 #include <dev/pci/pcidevs.h>
     53 
     54 #include <dev/cardbus/cardbus_exrom.h>
     55 
     56 #include <dev/pci/pcivar.h>	/* XXX */
     57 #include <dev/pci/pcireg.h>	/* XXX */
     58 
     59 #include <dev/pcmcia/pcmciareg.h>
     60 
     61 #include "locators.h"
     62 
     63 #if defined CARDBUS_DEBUG
     64 #define STATIC
     65 #define DPRINTF(a) printf a
     66 #else
     67 #define STATIC static
     68 #define DPRINTF(a)
     69 #endif
     70 
     71 
     72 STATIC void cardbusattach(struct device *, struct device *, void *);
     73 STATIC int cardbusmatch(struct device *, struct cfdata *, void *);
     74 int cardbus_rescan(struct device *, const char *, const int *);
     75 void cardbus_childdetached(struct device *, struct device *);
     76 static int cardbusprint(void *, const char *);
     77 
     78 typedef void (*tuple_decode_func)(u_int8_t*, int, void*);
     79 
     80 static int decode_tuples(u_int8_t *, int, tuple_decode_func, void*);
     81 #ifdef CARDBUS_DEBUG
     82 static void print_tuple(u_int8_t*, int, void*);
     83 #endif
     84 
     85 static int cardbus_read_tuples(struct cardbus_attach_args *,
     86     cardbusreg_t, u_int8_t *, size_t);
     87 
     88 static void enable_function(struct cardbus_softc *, int, int);
     89 static void disable_function(struct cardbus_softc *, int);
     90 
     91 CFATTACH_DECL2(cardbus, sizeof(struct cardbus_softc),
     92     cardbusmatch, cardbusattach, NULL, NULL,
     93     cardbus_rescan, cardbus_childdetached);
     94 
     95 #ifndef __NetBSD_Version__
     96 struct cfdriver cardbus_cd = {
     97 	NULL, "cardbus", DV_DULL
     98 };
     99 #endif
    100 
    101 
    102 STATIC int
    103 cardbusmatch(struct device *parent, struct cfdata *cf, void *aux)
    104 {
    105 	struct cbslot_attach_args *cba = aux;
    106 
    107 	if (strcmp(cba->cba_busname, cf->cf_name)) {
    108 		DPRINTF(("cardbusmatch: busname differs %s <=> %s\n",
    109 		    cba->cba_busname, cf->cf_name));
    110 		return (0);
    111 	}
    112 
    113 	return (1);
    114 }
    115 
    116 STATIC void
    117 cardbusattach(struct device *parent, struct device *self, void *aux)
    118 {
    119 	struct cardbus_softc *sc = (void *)self;
    120 	struct cbslot_attach_args *cba = aux;
    121 
    122 	sc->sc_bus = cba->cba_bus;
    123 	sc->sc_intrline = cba->cba_intrline;
    124 	sc->sc_cacheline = cba->cba_cacheline;
    125 	sc->sc_lattimer = cba->cba_lattimer;
    126 
    127 	printf(": bus %d", sc->sc_bus);
    128 	if (bootverbose)
    129 		printf(" cacheline 0x%x, lattimer 0x%x", sc->sc_cacheline,
    130 		    sc->sc_lattimer);
    131 	printf("\n");
    132 
    133 	sc->sc_iot = cba->cba_iot;	/* CardBus I/O space tag */
    134 	sc->sc_memt = cba->cba_memt;	/* CardBus MEM space tag */
    135 	sc->sc_dmat = cba->cba_dmat;	/* DMA tag */
    136 	sc->sc_cc = cba->cba_cc;
    137 	sc->sc_cf = cba->cba_cf;
    138 
    139 #if rbus
    140 	sc->sc_rbus_iot = cba->cba_rbus_iot;
    141 	sc->sc_rbus_memt = cba->cba_rbus_memt;
    142 #endif
    143 }
    144 
    145 static int
    146 cardbus_read_tuples(struct cardbus_attach_args *ca, cardbusreg_t cis_ptr,
    147     u_int8_t *tuples, size_t len)
    148 {
    149 	struct cardbus_softc *sc = ca->ca_ct->ct_sc;
    150 	cardbus_chipset_tag_t cc = ca->ca_ct->ct_cc;
    151 	cardbus_function_tag_t cf = ca->ca_ct->ct_cf;
    152 	cardbustag_t tag = ca->ca_tag;
    153 	cardbusreg_t command;
    154 	bus_space_tag_t bar_tag;
    155 	bus_space_handle_t bar_memh;
    156 	bus_size_t bar_size;
    157 	bus_addr_t bar_addr;
    158 	cardbusreg_t reg;
    159 	int found = 0;
    160 	int cardbus_space = cis_ptr & CARDBUS_CIS_ASIMASK;
    161 	int i, j;
    162 
    163 	memset(tuples, 0, len);
    164 
    165 	cis_ptr = cis_ptr & CARDBUS_CIS_ADDRMASK;
    166 
    167 	switch (cardbus_space) {
    168 	case CARDBUS_CIS_ASI_TUPLE:
    169 		DPRINTF(("%s: reading CIS data from configuration space\n",
    170 		    sc->sc_dev.dv_xname));
    171 		for (i = cis_ptr, j = 0; i < 0xff; i += 4) {
    172 			u_int32_t e = (*cf->cardbus_conf_read)(cc, tag, i);
    173 			tuples[j] = 0xff & e;
    174 			e >>= 8;
    175 			tuples[j + 1] = 0xff & e;
    176 			e >>= 8;
    177 			tuples[j + 2] = 0xff & e;
    178 			e >>= 8;
    179 			tuples[j + 3] = 0xff & e;
    180 			j += 4;
    181 		}
    182 		found++;
    183 		break;
    184 
    185 	case CARDBUS_CIS_ASI_BAR0:
    186 	case CARDBUS_CIS_ASI_BAR1:
    187 	case CARDBUS_CIS_ASI_BAR2:
    188 	case CARDBUS_CIS_ASI_BAR3:
    189 	case CARDBUS_CIS_ASI_BAR4:
    190 	case CARDBUS_CIS_ASI_BAR5:
    191 	case CARDBUS_CIS_ASI_ROM:
    192 		if (cardbus_space == CARDBUS_CIS_ASI_ROM) {
    193 			reg = CARDBUS_ROM_REG;
    194 			DPRINTF(("%s: reading CIS data from ROM\n",
    195 			    sc->sc_dev.dv_xname));
    196 		} else {
    197 			reg = CARDBUS_BASE0_REG + (cardbus_space - 1) * 4;
    198 			DPRINTF(("%s: reading CIS data from BAR%d\n",
    199 			    sc->sc_dev.dv_xname, cardbus_space - 1));
    200 		}
    201 
    202 		/*
    203 		 * XXX zero register so mapreg_map doesn't get confused by old
    204 		 * contents.
    205 		 */
    206 		cardbus_conf_write(cc, cf, tag, reg, 0);
    207 		if (Cardbus_mapreg_map(ca->ca_ct, reg,
    208 		    CARDBUS_MAPREG_TYPE_MEM | PCI_MAPREG_MEM_TYPE_32BIT,
    209 		    0, &bar_tag, &bar_memh, &bar_addr, &bar_size)) {
    210 			printf("%s: failed to map memory\n",
    211 			    sc->sc_dev.dv_xname);
    212 			return (1);
    213 		}
    214 
    215 		if (cardbus_space == CARDBUS_CIS_ASI_ROM) {
    216 			cardbusreg_t exrom;
    217 			int save;
    218 			struct cardbus_rom_image_head rom_image;
    219 			struct cardbus_rom_image *p;
    220 
    221 			save = splhigh();
    222 			/* enable rom address decoder */
    223 			exrom = cardbus_conf_read(cc, cf, tag, reg);
    224 			cardbus_conf_write(cc, cf, tag, reg, exrom | 1);
    225 
    226 			command = cardbus_conf_read(cc, cf, tag,
    227 			    CARDBUS_COMMAND_STATUS_REG);
    228 			cardbus_conf_write(cc, cf, tag,
    229 			    CARDBUS_COMMAND_STATUS_REG,
    230 			    command | CARDBUS_COMMAND_MEM_ENABLE);
    231 
    232 			if (cardbus_read_exrom(ca->ca_memt, bar_memh,
    233 			    &rom_image))
    234 				goto out;
    235 
    236 			SIMPLEQ_FOREACH(p, &rom_image, next) {
    237 				if (p->rom_image ==
    238 				    CARDBUS_CIS_ASI_ROM_IMAGE(cis_ptr)) {
    239 					bus_space_read_region_1(p->romt,
    240 					    p->romh, CARDBUS_CIS_ADDR(cis_ptr),
    241 					    tuples, MIN(p->image_size, len));
    242 					found++;
    243 					break;
    244 				}
    245 			}
    246 			while ((p = SIMPLEQ_FIRST(&rom_image)) != NULL) {
    247 				SIMPLEQ_REMOVE_HEAD(&rom_image, next);
    248 				free(p, M_DEVBUF);
    249 			}
    250 		out:
    251 			exrom = cardbus_conf_read(cc, cf, tag, reg);
    252 			cardbus_conf_write(cc, cf, tag, reg, exrom & ~1);
    253 			splx(save);
    254 		} else {
    255 			command = cardbus_conf_read(cc, cf, tag,
    256 			    CARDBUS_COMMAND_STATUS_REG);
    257 			cardbus_conf_write(cc, cf, tag,
    258 			    CARDBUS_COMMAND_STATUS_REG,
    259 			    command | CARDBUS_COMMAND_MEM_ENABLE);
    260 			/* XXX byte order? */
    261 			bus_space_read_region_1(ca->ca_memt, bar_memh,
    262 			    cis_ptr, tuples, MIN(bar_size, len));
    263 			found++;
    264 		}
    265 		command = cardbus_conf_read(cc, cf, tag,
    266 		    CARDBUS_COMMAND_STATUS_REG);
    267 		cardbus_conf_write(cc, cf, tag, CARDBUS_COMMAND_STATUS_REG,
    268 		    command & ~CARDBUS_COMMAND_MEM_ENABLE);
    269 		cardbus_conf_write(cc, cf, tag, reg, 0);
    270 
    271 		Cardbus_mapreg_unmap(ca->ca_ct, reg, bar_tag, bar_memh,
    272 		    bar_size);
    273 		break;
    274 
    275 #ifdef DIAGNOSTIC
    276 	default:
    277 		panic("%s: bad CIS space (%d)", sc->sc_dev.dv_xname,
    278 		    cardbus_space);
    279 #endif
    280 	}
    281 	return (!found);
    282 }
    283 
    284 static void
    285 parse_tuple(u_int8_t *tuple, int len, void *data)
    286 {
    287 	struct cardbus_cis_info *cis = data;
    288 	char *p;
    289 	int i, bar_index;
    290 
    291 	switch (tuple[0]) {
    292 	case PCMCIA_CISTPL_MANFID:
    293 		if (tuple[1] != 4) {
    294 			DPRINTF(("%s: wrong length manufacturer id (%d)\n",
    295 			    __func__, tuple[1]));
    296 			break;
    297 		}
    298 		cis->manufacturer = tuple[2] | (tuple[3] << 8);
    299 		cis->product = tuple[4] | (tuple[5] << 8);
    300 		break;
    301 
    302 	case PCMCIA_CISTPL_VERS_1:
    303 		memcpy(cis->cis1_info_buf, tuple + 2, tuple[1]);
    304 		i = 0;
    305 		p = cis->cis1_info_buf + 2;
    306 		while (i <
    307 		    sizeof(cis->cis1_info) / sizeof(cis->cis1_info[0])) {
    308 			if (p >= cis->cis1_info_buf + tuple[1] || *p == '\xff')
    309 				break;
    310 			cis->cis1_info[i++] = p;
    311 			while (*p != '\0' && *p != '\xff')
    312 				p++;
    313 			if (*p == '\0')
    314 				p++;
    315 		}
    316 		break;
    317 
    318 	case PCMCIA_CISTPL_BAR:
    319 		if (tuple[1] != 6) {
    320 			DPRINTF(("%s: BAR with short length (%d)\n",
    321 			    __func__, tuple[1]));
    322 			break;
    323 		}
    324 		bar_index = tuple[2] & 7;
    325 		if (bar_index == 0) {
    326 			DPRINTF(("%s: invalid ASI in BAR tuple\n", __func__));
    327 			break;
    328 		}
    329 		bar_index--;
    330 		cis->bar[bar_index].flags = tuple[2];
    331 		cis->bar[bar_index].size =
    332 		    (tuple[4] << 0) |
    333 		    (tuple[5] << 8) |
    334 		    (tuple[6] << 16) |
    335 		    (tuple[7] << 24);
    336 		break;
    337 
    338 	case PCMCIA_CISTPL_FUNCID:
    339 		cis->funcid = tuple[2];
    340 		break;
    341 
    342 	case PCMCIA_CISTPL_FUNCE:
    343 		switch (cis->funcid) {
    344 		case PCMCIA_FUNCTION_SERIAL:
    345 			if (tuple[1] >= 2 &&
    346 			    /* XXX PCMCIA_TPLFE_TYPE_SERIAL_??? */
    347 			    tuple[2] == 0) {
    348 				cis->funce.serial.uart_type = tuple[3] & 0x1f;
    349 				cis->funce.serial.uart_present = 1;
    350 			}
    351 			break;
    352 
    353 		case PCMCIA_FUNCTION_NETWORK:
    354 			if (tuple[1] >= 8 &&
    355 			    tuple[2] == PCMCIA_TPLFE_TYPE_LAN_NID) {
    356 				if (tuple[3] >
    357 				    sizeof(cis->funce.network.netid)) {
    358 					DPRINTF(("%s: unknown network id type "
    359 					    "(len = %d)\n",
    360 					    __func__, tuple[3]));
    361 				} else {
    362 					cis->funce.network.netid_present = 1;
    363 					memcpy(cis->funce.network.netid,
    364 					    tuple + 4, tuple[3]);
    365 				}
    366 			}
    367 			break;
    368 		}
    369 		break;
    370 	}
    371 }
    372 
    373 /*
    374  * int cardbus_attach_card(struct cardbus_softc *sc)
    375  *
    376  *    This function attaches the card on the slot: turns on power,
    377  *    reads and analyses tuple, sets configuration index.
    378  *
    379  *    This function returns the number of recognised device functions.
    380  *    If no functions are recognised, return 0.
    381  */
    382 int
    383 cardbus_attach_card(struct cardbus_softc *sc)
    384 {
    385 	cardbus_chipset_tag_t cc;
    386 	cardbus_function_tag_t cf;
    387 	int cdstatus;
    388 	static int wildcard[CARDBUSCF_NLOCS] = {
    389 		CARDBUSCF_FUNCTION_DEFAULT
    390 	};
    391 
    392 	cc = sc->sc_cc;
    393 	cf = sc->sc_cf;
    394 
    395 	DPRINTF(("cardbus_attach_card: cb%d start\n", sc->sc_dev.dv_unit));
    396 
    397 	/* inspect initial voltage */
    398 	if ((cdstatus = (*cf->cardbus_ctrl)(cc, CARDBUS_CD)) == 0) {
    399 		DPRINTF(("cardbusattach: no CardBus card on cb%d\n",
    400 		    sc->sc_dev.dv_unit));
    401 		return (0);
    402 	}
    403 
    404 	cardbus_rescan(&sc->sc_dev, "cardbus", wildcard);
    405 	return (1); /* XXX */
    406 }
    407 
    408 int
    409 cardbus_rescan(struct device *self, const char *ifattr, const int *locators)
    410 {
    411 	struct cardbus_softc *sc = (struct cardbus_softc *)self;
    412 	cardbus_chipset_tag_t cc;
    413 	cardbus_function_tag_t cf;
    414 	cardbustag_t tag;
    415 	cardbusreg_t id, class, cis_ptr;
    416 	cardbusreg_t bhlc;
    417 	u_int8_t tuple[2048];
    418 	int cdstatus;
    419 	int function, nfunction;
    420 	struct device *csc;
    421 	cardbus_devfunc_t ct;
    422 
    423 	cc = sc->sc_cc;
    424 	cf = sc->sc_cf;
    425 
    426 	/* inspect initial voltage */
    427 	if ((cdstatus = (*cf->cardbus_ctrl)(cc, CARDBUS_CD)) == 0) {
    428 		DPRINTF(("cardbusattach: no CardBus card on cb%d\n",
    429 		    sc->sc_dev.dv_unit));
    430 		return (0);
    431 	}
    432 
    433 	/*
    434 	 * XXX use fake function 8 to keep power on during whole
    435 	 * configuration.
    436 	 */
    437 	enable_function(sc, cdstatus, 8);
    438 	function = 0;
    439 
    440 	tag = cardbus_make_tag(cc, cf, sc->sc_bus, function);
    441 
    442 	/*
    443 	 * Wait until power comes up.  Maxmum 500 ms.
    444 	 */
    445 	{
    446 		int i;
    447 
    448 		for (i = 0; i < 5; ++i) {
    449 			id = cardbus_conf_read(cc, cf, tag, CARDBUS_ID_REG);
    450 			if (id != 0xffffffff && id != 0) {
    451 				break;
    452 			}
    453 			if (cold) {	/* before kernel thread invoked */
    454 				delay(100 * 1000);
    455 			} else {	/* thread context */
    456 				if (tsleep((void *)sc, PCATCH, "cardbus",
    457 				    hz / 10) != EWOULDBLOCK) {
    458 					break;
    459 				}
    460 			}
    461 		}
    462 		if (i == 5) {
    463 			return (EIO);
    464 		}
    465 	}
    466 
    467 	bhlc = cardbus_conf_read(cc, cf, tag, CARDBUS_BHLC_REG);
    468 	DPRINTF(("%s bhlc 0x%08x -> ", sc->sc_dev.dv_xname, bhlc));
    469 	nfunction = CARDBUS_HDRTYPE_MULTIFN(bhlc) ? 8 : 1;
    470 
    471 	for (function = 0; function < nfunction; function++) {
    472 		struct cardbus_attach_args ca;
    473 		int locs[CARDBUSCF_NLOCS];
    474 
    475 		if (locators[CARDBUSCF_FUNCTION] !=
    476 		    CARDBUSCF_FUNCTION_DEFAULT &&
    477 		    locators[CARDBUSCF_FUNCTION] != function)
    478 			continue;
    479 
    480 		if (sc->sc_funcs[function])
    481 			continue;
    482 
    483 		tag = cardbus_make_tag(cc, cf, sc->sc_bus, function);
    484 
    485 		id = cardbus_conf_read(cc, cf, tag, CARDBUS_ID_REG);
    486 		class = cardbus_conf_read(cc, cf, tag, CARDBUS_CLASS_REG);
    487 		cis_ptr = cardbus_conf_read(cc, cf, tag, CARDBUS_CIS_REG);
    488 
    489 		/* Invalid vendor ID value? */
    490 		if (CARDBUS_VENDOR(id) == PCI_VENDOR_INVALID) {
    491 			continue;
    492 		}
    493 
    494 		DPRINTF(("cardbus_attach_card: "
    495 		    "Vendor 0x%x, Product 0x%x, CIS 0x%x\n",
    496 		    CARDBUS_VENDOR(id), CARDBUS_PRODUCT(id), cis_ptr));
    497 
    498 		enable_function(sc, cdstatus, function);
    499 
    500 		/* clean up every BAR */
    501 		cardbus_conf_write(cc, cf, tag, CARDBUS_BASE0_REG, 0);
    502 		cardbus_conf_write(cc, cf, tag, CARDBUS_BASE1_REG, 0);
    503 		cardbus_conf_write(cc, cf, tag, CARDBUS_BASE2_REG, 0);
    504 		cardbus_conf_write(cc, cf, tag, CARDBUS_BASE3_REG, 0);
    505 		cardbus_conf_write(cc, cf, tag, CARDBUS_BASE4_REG, 0);
    506 		cardbus_conf_write(cc, cf, tag, CARDBUS_BASE5_REG, 0);
    507 		cardbus_conf_write(cc, cf, tag, CARDBUS_ROM_REG, 0);
    508 
    509 		/* set initial latency and cacheline size */
    510 		bhlc = cardbus_conf_read(cc, cf, tag, CARDBUS_BHLC_REG);
    511 		DPRINTF(("%s func%d bhlc 0x%08x -> ", sc->sc_dev.dv_xname,
    512 		    function, bhlc));
    513 		bhlc &= ~((CARDBUS_LATTIMER_MASK << CARDBUS_LATTIMER_SHIFT) |
    514 		    (CARDBUS_CACHELINE_MASK << CARDBUS_CACHELINE_SHIFT));
    515 		bhlc |= (sc->sc_cacheline & CARDBUS_CACHELINE_MASK) <<
    516 		    CARDBUS_CACHELINE_SHIFT;
    517 		bhlc |= (sc->sc_lattimer & CARDBUS_LATTIMER_MASK) <<
    518 		    CARDBUS_LATTIMER_SHIFT;
    519 
    520 		cardbus_conf_write(cc, cf, tag, CARDBUS_BHLC_REG, bhlc);
    521 		bhlc = cardbus_conf_read(cc, cf, tag, CARDBUS_BHLC_REG);
    522 		DPRINTF(("0x%08x\n", bhlc));
    523 
    524 		if (CARDBUS_LATTIMER(bhlc) < 0x10) {
    525 			bhlc &= ~(CARDBUS_LATTIMER_MASK <<
    526 			    CARDBUS_LATTIMER_SHIFT);
    527 			bhlc |= (0x10 << CARDBUS_LATTIMER_SHIFT);
    528 			cardbus_conf_write(cc, cf, tag,
    529 			    CARDBUS_BHLC_REG, bhlc);
    530 		}
    531 
    532 		/*
    533 		 * We need to allocate the ct here, since we might
    534 		 * need it when reading the CIS
    535 		 */
    536 		if ((ct = malloc(sizeof(struct cardbus_devfunc),
    537 		    M_DEVBUF, M_NOWAIT)) == NULL) {
    538 			panic("no room for cardbus_tag");
    539 		}
    540 
    541 		ct->ct_cc = sc->sc_cc;
    542 		ct->ct_cf = sc->sc_cf;
    543 		ct->ct_bus = sc->sc_bus;
    544 		ct->ct_func = function;
    545 		ct->ct_sc = sc;
    546 		sc->sc_funcs[function] = ct;
    547 
    548 		memset(&ca, 0, sizeof(ca));
    549 
    550 		ca.ca_ct = ct;
    551 
    552 		ca.ca_iot = sc->sc_iot;
    553 		ca.ca_memt = sc->sc_memt;
    554 		ca.ca_dmat = sc->sc_dmat;
    555 
    556 #if rbus
    557 		ca.ca_rbus_iot = sc->sc_rbus_iot;
    558 		ca.ca_rbus_memt= sc->sc_rbus_memt;
    559 #endif
    560 
    561 		ca.ca_tag = tag;
    562 		ca.ca_bus = sc->sc_bus;
    563 		ca.ca_function = function;
    564 		ca.ca_id = id;
    565 		ca.ca_class = class;
    566 
    567 		ca.ca_intrline = sc->sc_intrline;
    568 
    569 		if (cis_ptr != 0) {
    570 			if (cardbus_read_tuples(&ca, cis_ptr,
    571 			    tuple, sizeof(tuple))) {
    572 				printf("cardbus_attach_card: "
    573 				    "failed to read CIS\n");
    574 			} else {
    575 #ifdef CARDBUS_DEBUG
    576 				decode_tuples(tuple, sizeof(tuple),
    577 				    print_tuple, NULL);
    578 #endif
    579 				decode_tuples(tuple, sizeof(tuple),
    580 				    parse_tuple, &ca.ca_cis);
    581 			}
    582 		}
    583 
    584 		locs[CARDBUSCF_FUNCTION] = function;
    585 
    586 		if ((csc = config_found_sm_loc((void *)sc, "cardbus", locs,
    587 		    &ca, cardbusprint, config_stdsubmatch)) == NULL) {
    588 			/* do not match */
    589 			disable_function(sc, function);
    590 			sc->sc_funcs[function] = NULL;
    591 			free(ct, M_DEVBUF);
    592 		} else {
    593 			/* found */
    594 			ct->ct_device = csc;
    595 		}
    596 	}
    597 	/*
    598 	 * XXX power down pseudo function 8 (this will power down the card
    599 	 * if no functions were attached).
    600 	 */
    601 	disable_function(sc, 8);
    602 
    603 	return (0);
    604 }
    605 
    606 static int
    607 cardbusprint(void *aux, const char *pnp)
    608 {
    609 	struct cardbus_attach_args *ca = aux;
    610 	char devinfo[256];
    611 	int i;
    612 
    613 	if (pnp) {
    614 		pci_devinfo(ca->ca_id, ca->ca_class, 1, devinfo,
    615 		    sizeof(devinfo));
    616 		for (i = 0; i < 4; i++) {
    617 			if (ca->ca_cis.cis1_info[i] == NULL)
    618 				break;
    619 			if (i)
    620 				aprint_normal(", ");
    621 			aprint_normal("%s", ca->ca_cis.cis1_info[i]);
    622 		}
    623 		aprint_verbose("%s(manufacturer 0x%x, product 0x%x)",
    624 		    i ? " " : "",
    625 		    ca->ca_cis.manufacturer, ca->ca_cis.product);
    626 		aprint_normal(" %s at %s", devinfo, pnp);
    627 	}
    628 	aprint_normal(" function %d", ca->ca_function);
    629 
    630 	return (UNCONF);
    631 }
    632 
    633 /*
    634  * void cardbus_detach_card(struct cardbus_softc *sc)
    635  *
    636  *    This function detaches the card on the slot: detach device data
    637  *    structure and turns off the power.
    638  *
    639  *    This function must not be called under interrupt context.
    640  */
    641 void
    642 cardbus_detach_card(struct cardbus_softc *sc)
    643 {
    644 	int f;
    645 	struct cardbus_devfunc *ct;
    646 
    647 	for (f = 0; f < 8; f++) {
    648 		ct = sc->sc_funcs[f];
    649 		if (!ct)
    650 			continue;
    651 
    652 		DPRINTF(("%s: detaching %s\n", sc->sc_dev.dv_xname,
    653 		    ct->ct_device->dv_xname));
    654 		/* call device detach function */
    655 
    656 		if (config_detach(ct->ct_device, 0) != 0) {
    657 			printf("%s: cannot detach dev %s, function %d\n",
    658 			    sc->sc_dev.dv_xname, ct->ct_device->dv_xname,
    659 			    ct->ct_func);
    660 		}
    661 	}
    662 
    663 	sc->sc_poweron_func = 0;
    664 	(*sc->sc_cf->cardbus_power)(sc->sc_cc,
    665 	    CARDBUS_VCC_0V | CARDBUS_VPP_0V);
    666 }
    667 
    668 void
    669 cardbus_childdetached(struct device *self, struct device *child)
    670 {
    671 	struct cardbus_softc *sc = (struct cardbus_softc *)self;
    672 	struct cardbus_devfunc *ct;
    673 
    674 	ct = sc->sc_funcs[child->dv_locators[CARDBUSCF_FUNCTION]];
    675 	KASSERT(ct->ct_device == child);
    676 
    677 	sc->sc_poweron_func &= ~(1 << ct->ct_func);
    678 	sc->sc_funcs[ct->ct_func] = NULL;
    679 	free(ct, M_DEVBUF);
    680 }
    681 
    682 /*
    683  * void *cardbus_intr_establish(cc, cf, irq, level, func, arg)
    684  *   Interrupt handler of pccard.
    685  *  args:
    686  *   cardbus_chipset_tag_t *cc
    687  *   int irq:
    688  */
    689 void *
    690 cardbus_intr_establish(cardbus_chipset_tag_t cc, cardbus_function_tag_t cf,
    691     cardbus_intr_handle_t irq, int level, int (*func)(void *), void *arg)
    692 {
    693 
    694 	DPRINTF(("- cardbus_intr_establish: irq %d\n", irq));
    695 	return ((*cf->cardbus_intr_establish)(cc, irq, level, func, arg));
    696 }
    697 
    698 /*
    699  * void cardbus_intr_disestablish(cc, cf, handler)
    700  *   Interrupt handler of pccard.
    701  *  args:
    702  *   cardbus_chipset_tag_t *cc
    703  */
    704 void
    705 cardbus_intr_disestablish(cardbus_chipset_tag_t cc, cardbus_function_tag_t cf,
    706     void *handler)
    707 {
    708 
    709 	DPRINTF(("- pccard_intr_disestablish\n"));
    710 	(*cf->cardbus_intr_disestablish)(cc, handler);
    711 }
    712 
    713 /*
    714  * XXX this should be merged with cardbus_function_{enable,disable},
    715  * but we don't have a ct when these functions are called.
    716  */
    717 static void
    718 enable_function(struct cardbus_softc *sc, int cdstatus, int function)
    719 {
    720 
    721 	if (sc->sc_poweron_func == 0) {
    722 		/* switch to 3V and/or wait for power to stabilize */
    723 		if (cdstatus & CARDBUS_3V_CARD) {
    724 			/*
    725 			 * sc_poweron_func must be substituted before
    726 			 * entering sleep, in order to avoid turn on
    727 			 * power twice.
    728 			 */
    729 			sc->sc_poweron_func |= (1 << function);
    730 			(*sc->sc_cf->cardbus_power)(sc->sc_cc, CARDBUS_VCC_3V);
    731 		} else {
    732 			/* No cards other than 3.3V cards. */
    733 			return;
    734 		}
    735 		(*sc->sc_cf->cardbus_ctrl)(sc->sc_cc, CARDBUS_RESET);
    736 	}
    737 	sc->sc_poweron_func |= (1 << function);
    738 }
    739 
    740 static void
    741 disable_function(struct cardbus_softc *sc, int function)
    742 {
    743 
    744 	sc->sc_poweron_func &= ~(1 << function);
    745 	if (sc->sc_poweron_func == 0) {
    746 		/* power-off because no functions are enabled */
    747 		(*sc->sc_cf->cardbus_power)(sc->sc_cc, CARDBUS_VCC_0V);
    748 	}
    749 }
    750 
    751 /*
    752  * int cardbus_function_enable(struct cardbus_softc *sc, int func)
    753  *
    754  *   This function enables a function on a card.  When no power is
    755  *  applied on the card, power will be applied on it.
    756  */
    757 int
    758 cardbus_function_enable(struct cardbus_softc *sc, int func)
    759 {
    760 	cardbus_chipset_tag_t cc = sc->sc_cc;
    761 	cardbus_function_tag_t cf = sc->sc_cf;
    762 	cardbusreg_t command;
    763 	cardbustag_t tag;
    764 
    765 	DPRINTF(("entering cardbus_function_enable...  "));
    766 
    767 	/* entering critical area */
    768 
    769 	/* XXX: sc_vold should be used */
    770 	enable_function(sc, CARDBUS_3V_CARD, func);
    771 
    772 	/* exiting critical area */
    773 
    774 	tag = cardbus_make_tag(cc, cf, sc->sc_bus, func);
    775 
    776 	command = cardbus_conf_read(cc, cf, tag, CARDBUS_COMMAND_STATUS_REG);
    777 	command |= (CARDBUS_COMMAND_MEM_ENABLE | CARDBUS_COMMAND_IO_ENABLE |
    778 	    CARDBUS_COMMAND_MASTER_ENABLE); /* XXX: good guess needed */
    779 
    780 	cardbus_conf_write(cc, cf, tag, CARDBUS_COMMAND_STATUS_REG, command);
    781 
    782 	cardbus_free_tag(cc, cf, tag);
    783 
    784 	DPRINTF(("%x\n", sc->sc_poweron_func));
    785 
    786 	return (0);
    787 }
    788 
    789 /*
    790  * int cardbus_function_disable(struct cardbus_softc *, int func)
    791  *
    792  *   This function disable a function on a card.  When no functions are
    793  *  enabled, it turns off the power.
    794  */
    795 int
    796 cardbus_function_disable(struct cardbus_softc *sc, int func)
    797 {
    798 
    799 	DPRINTF(("entering cardbus_function_disable...  "));
    800 
    801 	disable_function(sc, func);
    802 
    803 	return (0);
    804 }
    805 
    806 /*
    807  * int cardbus_get_capability(cardbus_chipset_tag_t cc,
    808  *	cardbus_function_tag_t cf, cardbustag_t tag, int capid, int *offset,
    809  *	cardbusreg_t *value)
    810  *
    811  *	Find the specified PCI capability.
    812  */
    813 int
    814 cardbus_get_capability(cardbus_chipset_tag_t cc, cardbus_function_tag_t cf,
    815     cardbustag_t tag, int capid, int *offset, cardbusreg_t *value)
    816 {
    817 	cardbusreg_t reg;
    818 	unsigned int ofs;
    819 
    820 	reg = cardbus_conf_read(cc, cf, tag, PCI_COMMAND_STATUS_REG);
    821 	if (!(reg & PCI_STATUS_CAPLIST_SUPPORT))
    822 		return (0);
    823 
    824 	ofs = PCI_CAPLIST_PTR(cardbus_conf_read(cc, cf, tag,
    825 	    PCI_CAPLISTPTR_REG));
    826 	while (ofs != 0) {
    827 #ifdef DIAGNOSTIC
    828 		if ((ofs & 3) || (ofs < 0x40))
    829 			panic("cardbus_get_capability");
    830 #endif
    831 		reg = cardbus_conf_read(cc, cf, tag, ofs);
    832 		if (PCI_CAPLIST_CAP(reg) == capid) {
    833 			if (offset)
    834 				*offset = ofs;
    835 			if (value)
    836 				*value = reg;
    837 			return (1);
    838 		}
    839 		ofs = PCI_CAPLIST_NEXT(reg);
    840 	}
    841 
    842 	return (0);
    843 }
    844 
    845 /*
    846  * below this line, there are some functions for decoding tuples.
    847  * They should go out from this file.
    848  */
    849 
    850 static u_int8_t *
    851 decode_tuple(u_int8_t *, u_int8_t *, tuple_decode_func, void *);
    852 
    853 static int
    854 decode_tuples(u_int8_t *tuple, int buflen, tuple_decode_func func, void *data)
    855 {
    856 	u_int8_t *tp = tuple;
    857 
    858 	if (PCMCIA_CISTPL_LINKTARGET != *tuple) {
    859 		DPRINTF(("WRONG TUPLE: 0x%x\n", *tuple));
    860 		return (0);
    861 	}
    862 
    863 	while ((tp = decode_tuple(tp, tuple + buflen, func, data)) != NULL)
    864 		;
    865 
    866 	return (1);
    867 }
    868 
    869 static u_int8_t *
    870 decode_tuple(u_int8_t *tuple, u_int8_t *end,
    871     tuple_decode_func func, void *data)
    872 {
    873 	u_int8_t type;
    874 	u_int8_t len;
    875 
    876 	type = tuple[0];
    877 	switch (type) {
    878 	case PCMCIA_CISTPL_NULL:
    879 	case PCMCIA_CISTPL_END:
    880 		len = 1;
    881 		break;
    882 	default:
    883 		if (tuple + 2 > end)
    884 			return (NULL);
    885 		len = tuple[1] + 2;
    886 		break;
    887 	}
    888 
    889 	if (tuple + len > end)
    890 		return (NULL);
    891 
    892 	(*func)(tuple, len, data);
    893 
    894 	if (type == PCMCIA_CISTPL_END || tuple + len == end)
    895 		return (NULL);
    896 
    897 	return (tuple + len);
    898 }
    899 
    900 /*
    901  * XXX: this is another reason why this code should be shared with PCI.
    902  */
    903 int
    904 cardbus_powerstate(cardbus_devfunc_t ct, pcitag_t tag, const int *newstate,
    905     int *oldstate)
    906 {
    907 	cardbus_chipset_tag_t cc = ct->ct_cc;
    908 	cardbus_function_tag_t cf = ct->ct_cf;
    909 
    910 	int offset;
    911 	pcireg_t value, cap, now;
    912 
    913 	if (!cardbus_get_capability(cc, cf, tag, PCI_CAP_PWRMGMT, &offset,
    914 	    &value))
    915 		return EOPNOTSUPP;
    916 
    917 	cap = value >> 16;
    918 	value = cardbus_conf_read(cc, cf, tag, offset + PCI_PMCSR);
    919 	now = value & PCI_PMCSR_STATE_MASK;
    920 	value &= ~PCI_PMCSR_STATE_MASK;
    921 	if (oldstate) {
    922 		switch (now) {
    923 		case PCI_PMCSR_STATE_D0:
    924 			*oldstate = PCI_PWR_D0;
    925 			break;
    926 		case PCI_PMCSR_STATE_D1:
    927 			*oldstate = PCI_PWR_D1;
    928 			break;
    929 		case PCI_PMCSR_STATE_D2:
    930 			*oldstate = PCI_PWR_D2;
    931 			break;
    932 		case PCI_PMCSR_STATE_D3:
    933 			*oldstate = PCI_PWR_D3;
    934 			break;
    935 		default:
    936 			return EINVAL;
    937 		}
    938 	}
    939 	if (newstate == NULL)
    940 		return 0;
    941 	switch (*newstate) {
    942 	case PCI_PWR_D0:
    943 		if (now == PCI_PMCSR_STATE_D0)
    944 			return 0;
    945 		value |= PCI_PMCSR_STATE_D0;
    946 		break;
    947 	case PCI_PWR_D1:
    948 		if (now == PCI_PMCSR_STATE_D1)
    949 			return 0;
    950 		if (now == PCI_PMCSR_STATE_D2 || now == PCI_PMCSR_STATE_D3)
    951 			return EINVAL;
    952 		if (!(cap & PCI_PMCR_D1SUPP))
    953 			return EOPNOTSUPP;
    954 		value |= PCI_PMCSR_STATE_D1;
    955 		break;
    956 	case PCI_PWR_D2:
    957 		if (now == PCI_PMCSR_STATE_D2)
    958 			return 0;
    959 		if (now == PCI_PMCSR_STATE_D3)
    960 			return EINVAL;
    961 		if (!(cap & PCI_PMCR_D2SUPP))
    962 			return EOPNOTSUPP;
    963 		value |= PCI_PMCSR_STATE_D2;
    964 		break;
    965 	case PCI_PWR_D3:
    966 		if (now == PCI_PMCSR_STATE_D3)
    967 			return 0;
    968 		value |= PCI_PMCSR_STATE_D3;
    969 		break;
    970 	default:
    971 		return EINVAL;
    972 	}
    973 	cardbus_conf_write(cc, cf, tag, offset + PCI_PMCSR, value);
    974 	DELAY(1000);
    975 
    976 	return 0;
    977 }
    978 
    979 int
    980 cardbus_setpowerstate(const char *dvname, cardbus_devfunc_t ct, pcitag_t tag,
    981     int newpwr)
    982 {
    983 	int oldpwr, error;
    984 
    985 	if ((error = cardbus_powerstate(ct, tag, &newpwr, &oldpwr)) != 0)
    986 		return error;
    987 
    988 	if (oldpwr == newpwr)
    989 		return 0;
    990 
    991 	if (oldpwr > newpwr) {
    992 		printf("%s: sleeping to power state D%d\n", dvname, oldpwr);
    993 		return 0;
    994 	}
    995 
    996 	/* oldpwr < newpwr */
    997 	switch (oldpwr) {
    998 	case PCI_PWR_D3:
    999 		/*
   1000 		 * XXX: This is because none of the devices do
   1001 		 * the necessary song and dance for now to wakeup
   1002 		 * Once this
   1003 		 */
   1004 		printf("%s: cannot wake up from power state D%d\n",
   1005 		    dvname, oldpwr);
   1006 		return EINVAL;
   1007 	default:
   1008 		printf("%s: waking up from power state D%d\n",
   1009 		    dvname, oldpwr);
   1010 		return 0;
   1011 	}
   1012 }
   1013 
   1014 
   1015 #ifdef CARDBUS_DEBUG
   1016 static const char *tuple_name(int);
   1017 static const char *tuple_names[] = {
   1018 	"TPL_NULL", "TPL_DEVICE", "Reserved", "Reserved", /* 0-3 */
   1019 	"CONFIG_CB", "CFTABLE_ENTRY_CB", "Reserved", "BAR", /* 4-7 */
   1020 	"Reserved", "Reserved", "Reserved", "Reserved", /* 8-B */
   1021 	"Reserved", "Reserved", "Reserved", "Reserved", /* C-F */
   1022 	"CHECKSUM", "LONGLINK_A", "LONGLINK_C", "LINKTARGET", /* 10-13 */
   1023 	"NO_LINK", "VERS_1", "ALTSTR", "DEVICE_A",
   1024 	"JEDEC_C", "JEDEC_A", "CONFIG", "CFTABLE_ENTRY",
   1025 	"DEVICE_OC", "DEVICE_OA", "DEVICE_GEO", "DEVICE_GEO_A",
   1026 	"MANFID", "FUNCID", "FUNCE", "SWIL", /* 20-23 */
   1027 	"Reserved", "Reserved", "Reserved", "Reserved", /* 24-27 */
   1028 	"Reserved", "Reserved", "Reserved", "Reserved", /* 28-2B */
   1029 	"Reserved", "Reserved", "Reserved", "Reserved", /* 2C-2F */
   1030 	"Reserved", "Reserved", "Reserved", "Reserved", /* 30-33 */
   1031 	"Reserved", "Reserved", "Reserved", "Reserved", /* 34-37 */
   1032 	"Reserved", "Reserved", "Reserved", "Reserved", /* 38-3B */
   1033 	"Reserved", "Reserved", "Reserved", "Reserved", /* 3C-3F */
   1034 	"VERS_2", "FORMAT", "GEOMETRY", "BYTEORDER",
   1035 	"DATE", "BATTERY", "ORG"
   1036 };
   1037 #define NAME_LEN(x) (sizeof x / sizeof(x[0]))
   1038 
   1039 static const char *
   1040 tuple_name(int type)
   1041 {
   1042 
   1043 	if (0 <= type && type < NAME_LEN(tuple_names)) {
   1044 		return (tuple_names[type]);
   1045 	} else if (type == 0xff) {
   1046 		return ("END");
   1047 	} else {
   1048 		return ("Reserved");
   1049 	}
   1050 }
   1051 
   1052 static void
   1053 print_tuple(u_int8_t *tuple, int len, void *data)
   1054 {
   1055 	int i;
   1056 
   1057 	printf("tuple: %s len %d\n", tuple_name(tuple[0]), len);
   1058 
   1059 	for (i = 0; i < len; ++i) {
   1060 		if (i % 16 == 0) {
   1061 			printf("  0x%2x:", i);
   1062 		}
   1063 		printf(" %x", tuple[i]);
   1064 		if (i % 16 == 15) {
   1065 			printf("\n");
   1066 		}
   1067 	}
   1068 	if (i % 16 != 0) {
   1069 		printf("\n");
   1070 	}
   1071 }
   1072 #endif
   1073