xref: /netbsd-src/sys/dev/cardbus/cardbus.c (revision 0df165c04d0a9ca1adde9ed2b890344c937954a6)
1 /*	$NetBSD: cardbus.c,v 1.78 2007/11/16 20:25:47 dyoung 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.78 2007/11/16 20:25:47 dyoung 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 <sys/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 = device_private(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_max_lattimer = MIN(0xf8, cba->cba_max_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_max_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_CIS_ASI_BAR(cardbus_space);
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",
396 		 device_unit(&sc->sc_dev)));
397 
398 	/* inspect initial voltage */
399 	if ((cdstatus = (*cf->cardbus_ctrl)(cc, CARDBUS_CD)) == 0) {
400 		DPRINTF(("%s: no CardBus card on cb%d\n", __func__,
401 		    device_unit(&sc->sc_dev)));
402 		return (0);
403 	}
404 
405 	cardbus_rescan(&sc->sc_dev, "cardbus", wildcard);
406 	return (1); /* XXX */
407 }
408 
409 int
410 cardbus_rescan(struct device *self, const char *ifattr,
411     const int *locators)
412 {
413 	struct cardbus_softc *sc = device_private(self);
414 	cardbus_chipset_tag_t cc;
415 	cardbus_function_tag_t cf;
416 	cardbustag_t tag;
417 	cardbusreg_t id, class, cis_ptr;
418 	cardbusreg_t bhlc, icr, lattimer;
419 	int cdstatus;
420 	int function, nfunction;
421 	struct device *csc;
422 	cardbus_devfunc_t ct;
423 
424 	cc = sc->sc_cc;
425 	cf = sc->sc_cf;
426 
427 	/* inspect initial voltage */
428 	if ((cdstatus = (*cf->cardbus_ctrl)(cc, CARDBUS_CD)) == 0) {
429 		DPRINTF(("%s: no CardBus card on cb%d\n", __func__,
430 		    device_unit(&sc->sc_dev)));
431 		return (0);
432 	}
433 
434 	/*
435 	 * XXX use fake function 8 to keep power on during whole
436 	 * configuration.
437 	 */
438 	enable_function(sc, cdstatus, 8);
439 	function = 0;
440 
441 	tag = cardbus_make_tag(cc, cf, sc->sc_bus, function);
442 
443 	/*
444 	 * Wait until power comes up.  Maxmum 500 ms.
445 	 *
446 	 * XXX What is this for?  The bridge driver ought to have waited
447 	 * XXX already.
448 	 */
449 	{
450 		int i;
451 
452 		for (i = 0; i < 5; ++i) {
453 			id = cardbus_conf_read(cc, cf, tag, CARDBUS_ID_REG);
454 			if (id != 0xffffffff && id != 0) {
455 				break;
456 			}
457 			if (cold) {	/* before kernel thread invoked */
458 				delay(100 * 1000);
459 			} else {	/* thread context */
460 				if (tsleep((void *)sc, PCATCH, "cardbus",
461 				    hz / 10) != EWOULDBLOCK) {
462 					break;
463 				}
464 			}
465 		}
466 		if (i == 5) {
467 			return (EIO);
468 		}
469 	}
470 
471 	bhlc = cardbus_conf_read(cc, cf, tag, CARDBUS_BHLC_REG);
472 	DPRINTF(("%s bhlc 0x%08x -> ", sc->sc_dev.dv_xname, bhlc));
473 	nfunction = CARDBUS_HDRTYPE_MULTIFN(bhlc) ? 8 : 1;
474 
475 	for (function = 0; function < nfunction; function++) {
476 		struct cardbus_attach_args ca;
477 		int locs[CARDBUSCF_NLOCS];
478 
479 		if (locators[CARDBUSCF_FUNCTION] !=
480 		    CARDBUSCF_FUNCTION_DEFAULT &&
481 		    locators[CARDBUSCF_FUNCTION] != function)
482 			continue;
483 
484 		if (sc->sc_funcs[function])
485 			continue;
486 
487 		tag = cardbus_make_tag(cc, cf, sc->sc_bus, function);
488 
489 		id = cardbus_conf_read(cc, cf, tag, CARDBUS_ID_REG);
490 		class = cardbus_conf_read(cc, cf, tag, CARDBUS_CLASS_REG);
491 		cis_ptr = cardbus_conf_read(cc, cf, tag, CARDBUS_CIS_REG);
492 
493 		/* Invalid vendor ID value? */
494 		if (CARDBUS_VENDOR(id) == PCI_VENDOR_INVALID) {
495 			continue;
496 		}
497 
498 		DPRINTF(("cardbus_attach_card: "
499 		    "Vendor 0x%x, Product 0x%x, CIS 0x%x\n",
500 		    CARDBUS_VENDOR(id), CARDBUS_PRODUCT(id), cis_ptr));
501 
502 		enable_function(sc, cdstatus, function);
503 
504 		/* clean up every BAR */
505 		cardbus_conf_write(cc, cf, tag, CARDBUS_BASE0_REG, 0);
506 		cardbus_conf_write(cc, cf, tag, CARDBUS_BASE1_REG, 0);
507 		cardbus_conf_write(cc, cf, tag, CARDBUS_BASE2_REG, 0);
508 		cardbus_conf_write(cc, cf, tag, CARDBUS_BASE3_REG, 0);
509 		cardbus_conf_write(cc, cf, tag, CARDBUS_BASE4_REG, 0);
510 		cardbus_conf_write(cc, cf, tag, CARDBUS_BASE5_REG, 0);
511 		cardbus_conf_write(cc, cf, tag, CARDBUS_ROM_REG, 0);
512 
513 		/* set initial latency and cacheline size */
514 		bhlc = cardbus_conf_read(cc, cf, tag, CARDBUS_BHLC_REG);
515 		icr = cardbus_conf_read(cc, cf, tag, CARDBUS_INTERRUPT_REG);
516 		DPRINTF(("%s func%d icr 0x%08x bhlc 0x%08x -> ",
517 		    device_xname(&sc->sc_dev), function, icr, bhlc));
518 		bhlc &= ~(CARDBUS_CACHELINE_MASK << CARDBUS_CACHELINE_SHIFT);
519 		bhlc |= (sc->sc_cacheline & CARDBUS_CACHELINE_MASK) <<
520 		    CARDBUS_CACHELINE_SHIFT;
521 		/*
522 		 * Set the initial value of the Latency Timer.
523 		 *
524 		 * While a PCI device owns the bus, its Latency
525 		 * Timer counts down bus cycles from its initial
526 		 * value to 0.  Minimum Grant tells for how long
527 		 * the device wants to own the bus once it gets
528 		 * access, in units of 250ns.
529 		 *
530 		 * On a 33 MHz bus, there are 8 cycles per 250ns.
531 		 * So I multiply the Minimum Grant by 8 to find
532 		 * out the initial value of the Latency Timer.
533 		 *
534 		 * Avoid setting a Latency Timer less than 0x10,
535 		 * since the old code did not do that.
536 		 */
537 		lattimer =
538 		    MIN(sc->sc_max_lattimer, MAX(0x10, 8 * PCI_MIN_GNT(icr)));
539 		if (PCI_LATTIMER(bhlc) < lattimer) {
540 			bhlc &= ~(PCI_LATTIMER_MASK << PCI_LATTIMER_SHIFT);
541 			bhlc |= (lattimer << PCI_LATTIMER_SHIFT);
542 		}
543 
544 		cardbus_conf_write(cc, cf, tag, CARDBUS_BHLC_REG, bhlc);
545 		bhlc = cardbus_conf_read(cc, cf, tag, CARDBUS_BHLC_REG);
546 		DPRINTF(("0x%08x\n", bhlc));
547 
548 		/*
549 		 * We need to allocate the ct here, since we might
550 		 * need it when reading the CIS
551 		 */
552 		if ((ct = malloc(sizeof(struct cardbus_devfunc),
553 		    M_DEVBUF, M_NOWAIT)) == NULL) {
554 			panic("no room for cardbus_tag");
555 		}
556 
557 		ct->ct_bhlc = bhlc;
558 		ct->ct_cc = sc->sc_cc;
559 		ct->ct_cf = sc->sc_cf;
560 		ct->ct_bus = sc->sc_bus;
561 		ct->ct_func = function;
562 		ct->ct_sc = sc;
563 		sc->sc_funcs[function] = ct;
564 
565 		memset(&ca, 0, sizeof(ca));
566 
567 		ca.ca_ct = ct;
568 
569 		ca.ca_iot = sc->sc_iot;
570 		ca.ca_memt = sc->sc_memt;
571 		ca.ca_dmat = sc->sc_dmat;
572 
573 #if rbus
574 		ca.ca_rbus_iot = sc->sc_rbus_iot;
575 		ca.ca_rbus_memt= sc->sc_rbus_memt;
576 #endif
577 
578 		ca.ca_tag = tag;
579 		ca.ca_bus = sc->sc_bus;
580 		ca.ca_function = function;
581 		ca.ca_id = id;
582 		ca.ca_class = class;
583 
584 		ca.ca_intrline = sc->sc_intrline;
585 
586 		if (cis_ptr != 0) {
587 #define TUPLESIZE 2048
588 			u_int8_t *tuple = malloc(TUPLESIZE, M_DEVBUF, M_WAITOK);
589 			if (cardbus_read_tuples(&ca, cis_ptr,
590 			    tuple, TUPLESIZE)) {
591 				printf("cardbus_attach_card: "
592 				    "failed to read CIS\n");
593 			} else {
594 #ifdef CARDBUS_DEBUG
595 				decode_tuples(tuple, TUPLESIZE,
596 				    print_tuple, NULL);
597 #endif
598 				decode_tuples(tuple, TUPLESIZE,
599 				    parse_tuple, &ca.ca_cis);
600 			}
601 			free(tuple, M_DEVBUF);
602 		}
603 
604 		locs[CARDBUSCF_FUNCTION] = function;
605 
606 		if ((csc = config_found_sm_loc((void *)sc, "cardbus", locs,
607 		    &ca, cardbusprint, config_stdsubmatch)) == NULL) {
608 			/* do not match */
609 			disable_function(sc, function);
610 			sc->sc_funcs[function] = NULL;
611 			free(ct, M_DEVBUF);
612 		} else {
613 			/* found */
614 			ct->ct_device = csc;
615 		}
616 	}
617 	/*
618 	 * XXX power down pseudo function 8 (this will power down the card
619 	 * if no functions were attached).
620 	 */
621 	disable_function(sc, 8);
622 
623 	return (0);
624 }
625 
626 static int
627 cardbusprint(void *aux, const char *pnp)
628 {
629 	struct cardbus_attach_args *ca = aux;
630 	char devinfo[256];
631 	int i;
632 
633 	if (pnp) {
634 		pci_devinfo(ca->ca_id, ca->ca_class, 1, devinfo,
635 		    sizeof(devinfo));
636 		for (i = 0; i < 4; i++) {
637 			if (ca->ca_cis.cis1_info[i] == NULL)
638 				break;
639 			if (i)
640 				aprint_normal(", ");
641 			aprint_normal("%s", ca->ca_cis.cis1_info[i]);
642 		}
643 		aprint_verbose("%s(manufacturer 0x%x, product 0x%x)",
644 		    i ? " " : "",
645 		    ca->ca_cis.manufacturer, ca->ca_cis.product);
646 		aprint_normal(" %s at %s", devinfo, pnp);
647 	}
648 	aprint_normal(" function %d", ca->ca_function);
649 
650 	return (UNCONF);
651 }
652 
653 /*
654  * void cardbus_detach_card(struct cardbus_softc *sc)
655  *
656  *    This function detaches the card on the slot: detach device data
657  *    structure and turns off the power.
658  *
659  *    This function must not be called under interrupt context.
660  */
661 void
662 cardbus_detach_card(struct cardbus_softc *sc)
663 {
664 	int f;
665 	struct cardbus_devfunc *ct;
666 
667 	for (f = 0; f < 8; f++) {
668 		ct = sc->sc_funcs[f];
669 		if (!ct)
670 			continue;
671 
672 		DPRINTF(("%s: detaching %s\n", sc->sc_dev.dv_xname,
673 		    ct->ct_device->dv_xname));
674 		/* call device detach function */
675 
676 		if (config_detach(ct->ct_device, 0) != 0) {
677 			printf("%s: cannot detach dev %s, function %d\n",
678 			    sc->sc_dev.dv_xname, ct->ct_device->dv_xname,
679 			    ct->ct_func);
680 		}
681 	}
682 
683 	sc->sc_poweron_func = 0;
684 	(*sc->sc_cf->cardbus_power)(sc->sc_cc,
685 	    CARDBUS_VCC_0V | CARDBUS_VPP_0V);
686 }
687 
688 void
689 cardbus_childdetached(struct device *self, struct device *child)
690 {
691 	struct cardbus_softc *sc = device_private(self);
692 	struct cardbus_devfunc *ct;
693 
694 	ct = sc->sc_funcs[device_locator(child, CARDBUSCF_FUNCTION)];
695 	KASSERT(ct->ct_device == child);
696 
697 	sc->sc_poweron_func &= ~(1 << ct->ct_func);
698 	sc->sc_funcs[ct->ct_func] = NULL;
699 	free(ct, M_DEVBUF);
700 }
701 
702 /*
703  * void *cardbus_intr_establish(cc, cf, irq, level, func, arg)
704  *   Interrupt handler of pccard.
705  *  args:
706  *   cardbus_chipset_tag_t *cc
707  *   int irq:
708  */
709 void *
710 cardbus_intr_establish(cardbus_chipset_tag_t cc, cardbus_function_tag_t cf,
711     cardbus_intr_handle_t irq, int level, int (*func)(void *), void *arg)
712 {
713 
714 	DPRINTF(("- cardbus_intr_establish: irq %d\n", irq));
715 	return ((*cf->cardbus_intr_establish)(cc, irq, level, func, arg));
716 }
717 
718 /*
719  * void cardbus_intr_disestablish(cc, cf, handler)
720  *   Interrupt handler of pccard.
721  *  args:
722  *   cardbus_chipset_tag_t *cc
723  */
724 void
725 cardbus_intr_disestablish(cardbus_chipset_tag_t cc, cardbus_function_tag_t cf,
726     void *handler)
727 {
728 
729 	DPRINTF(("- pccard_intr_disestablish\n"));
730 	(*cf->cardbus_intr_disestablish)(cc, handler);
731 }
732 
733 /*
734  * XXX this should be merged with cardbus_function_{enable,disable},
735  * but we don't have a ct when these functions are called.
736  */
737 static void
738 enable_function(struct cardbus_softc *sc, int cdstatus, int function)
739 {
740 
741 	if (sc->sc_poweron_func == 0) {
742 		/* switch to 3V and/or wait for power to stabilize */
743 		if (cdstatus & CARDBUS_3V_CARD) {
744 			/*
745 			 * sc_poweron_func must be substituted before
746 			 * entering sleep, in order to avoid turn on
747 			 * power twice.
748 			 */
749 			sc->sc_poweron_func |= (1 << function);
750 			(*sc->sc_cf->cardbus_power)(sc->sc_cc, CARDBUS_VCC_3V);
751 		} else {
752 			/* No cards other than 3.3V cards. */
753 			return;
754 		}
755 		(*sc->sc_cf->cardbus_ctrl)(sc->sc_cc, CARDBUS_RESET);
756 	}
757 	sc->sc_poweron_func |= (1 << function);
758 }
759 
760 static void
761 disable_function(struct cardbus_softc *sc, int function)
762 {
763 
764 	sc->sc_poweron_func &= ~(1 << function);
765 	if (sc->sc_poweron_func == 0) {
766 		/* power-off because no functions are enabled */
767 		(*sc->sc_cf->cardbus_power)(sc->sc_cc, CARDBUS_VCC_0V);
768 	}
769 }
770 
771 /*
772  * int cardbus_function_enable(struct cardbus_softc *sc, int func)
773  *
774  *   This function enables a function on a card.  When no power is
775  *  applied on the card, power will be applied on it.
776  */
777 int
778 cardbus_function_enable(struct cardbus_softc *sc, int func)
779 {
780 	cardbus_chipset_tag_t cc = sc->sc_cc;
781 	cardbus_function_tag_t cf = sc->sc_cf;
782 	cardbus_devfunc_t ct;
783 	cardbusreg_t command;
784 	cardbustag_t tag;
785 
786 	DPRINTF(("entering cardbus_function_enable...  "));
787 
788 	/* entering critical area */
789 
790 	/* XXX: sc_vold should be used */
791 	enable_function(sc, CARDBUS_3V_CARD, func);
792 
793 	/* exiting critical area */
794 
795 	tag = cardbus_make_tag(cc, cf, sc->sc_bus, func);
796 
797 	command = cardbus_conf_read(cc, cf, tag, CARDBUS_COMMAND_STATUS_REG);
798 	command |= (CARDBUS_COMMAND_MEM_ENABLE | CARDBUS_COMMAND_IO_ENABLE |
799 	    CARDBUS_COMMAND_MASTER_ENABLE); /* XXX: good guess needed */
800 
801 	cardbus_conf_write(cc, cf, tag, CARDBUS_COMMAND_STATUS_REG, command);
802 
803 	if ((ct = sc->sc_funcs[func]) != NULL)
804 		Cardbus_conf_write(ct, tag, CARDBUS_BHLC_REG, ct->ct_bhlc);
805 
806 	cardbus_free_tag(cc, cf, tag);
807 
808 	DPRINTF(("%x\n", sc->sc_poweron_func));
809 
810 	return (0);
811 }
812 
813 /*
814  * int cardbus_function_disable(struct cardbus_softc *, int func)
815  *
816  *   This function disable a function on a card.  When no functions are
817  *  enabled, it turns off the power.
818  */
819 int
820 cardbus_function_disable(struct cardbus_softc *sc, int func)
821 {
822 
823 	DPRINTF(("entering cardbus_function_disable...  "));
824 
825 	disable_function(sc, func);
826 
827 	return (0);
828 }
829 
830 /*
831  * int cardbus_get_capability(cardbus_chipset_tag_t cc,
832  *	cardbus_function_tag_t cf, cardbustag_t tag, int capid, int *offset,
833  *	cardbusreg_t *value)
834  *
835  *	Find the specified PCI capability.
836  */
837 int
838 cardbus_get_capability(cardbus_chipset_tag_t cc, cardbus_function_tag_t cf,
839     cardbustag_t tag, int capid, int *offset, cardbusreg_t *value)
840 {
841 	cardbusreg_t reg;
842 	unsigned int ofs;
843 
844 	reg = cardbus_conf_read(cc, cf, tag, PCI_COMMAND_STATUS_REG);
845 	if (!(reg & PCI_STATUS_CAPLIST_SUPPORT))
846 		return (0);
847 
848 	ofs = PCI_CAPLIST_PTR(cardbus_conf_read(cc, cf, tag,
849 	    PCI_CAPLISTPTR_REG));
850 	while (ofs != 0) {
851 #ifdef DIAGNOSTIC
852 		if ((ofs & 3) || (ofs < 0x40))
853 			panic("cardbus_get_capability");
854 #endif
855 		reg = cardbus_conf_read(cc, cf, tag, ofs);
856 		if (PCI_CAPLIST_CAP(reg) == capid) {
857 			if (offset)
858 				*offset = ofs;
859 			if (value)
860 				*value = reg;
861 			return (1);
862 		}
863 		ofs = PCI_CAPLIST_NEXT(reg);
864 	}
865 
866 	return (0);
867 }
868 
869 /*
870  * below this line, there are some functions for decoding tuples.
871  * They should go out from this file.
872  */
873 
874 static u_int8_t *
875 decode_tuple(u_int8_t *, u_int8_t *, tuple_decode_func, void *);
876 
877 static int
878 decode_tuples(u_int8_t *tuple, int buflen, tuple_decode_func func, void *data)
879 {
880 	u_int8_t *tp = tuple;
881 
882 	if (PCMCIA_CISTPL_LINKTARGET != *tuple) {
883 		DPRINTF(("WRONG TUPLE: 0x%x\n", *tuple));
884 		return (0);
885 	}
886 
887 	while ((tp = decode_tuple(tp, tuple + buflen, func, data)) != NULL)
888 		;
889 
890 	return (1);
891 }
892 
893 static u_int8_t *
894 decode_tuple(u_int8_t *tuple, u_int8_t *end,
895     tuple_decode_func func, void *data)
896 {
897 	u_int8_t type;
898 	u_int8_t len;
899 
900 	type = tuple[0];
901 	switch (type) {
902 	case PCMCIA_CISTPL_NULL:
903 	case PCMCIA_CISTPL_END:
904 		len = 1;
905 		break;
906 	default:
907 		if (tuple + 2 > end)
908 			return (NULL);
909 		len = tuple[1] + 2;
910 		break;
911 	}
912 
913 	if (tuple + len > end)
914 		return (NULL);
915 
916 	(*func)(tuple, len, data);
917 
918 	if (type == PCMCIA_CISTPL_END || tuple + len == end)
919 		return (NULL);
920 
921 	return (tuple + len);
922 }
923 
924 /*
925  * XXX: this is another reason why this code should be shared with PCI.
926  */
927 int
928 cardbus_powerstate(cardbus_devfunc_t ct, pcitag_t tag, const int *newstate,
929     int *oldstate)
930 {
931 	cardbus_chipset_tag_t cc = ct->ct_cc;
932 	cardbus_function_tag_t cf = ct->ct_cf;
933 
934 	int offset;
935 	pcireg_t value, cap, now;
936 
937 	if (!cardbus_get_capability(cc, cf, tag, PCI_CAP_PWRMGMT, &offset,
938 	    &value))
939 		return EOPNOTSUPP;
940 
941 	cap = value >> 16;
942 	value = cardbus_conf_read(cc, cf, tag, offset + PCI_PMCSR);
943 	now = value & PCI_PMCSR_STATE_MASK;
944 	value &= ~PCI_PMCSR_STATE_MASK;
945 	if (oldstate) {
946 		switch (now) {
947 		case PCI_PMCSR_STATE_D0:
948 			*oldstate = PCI_PWR_D0;
949 			break;
950 		case PCI_PMCSR_STATE_D1:
951 			*oldstate = PCI_PWR_D1;
952 			break;
953 		case PCI_PMCSR_STATE_D2:
954 			*oldstate = PCI_PWR_D2;
955 			break;
956 		case PCI_PMCSR_STATE_D3:
957 			*oldstate = PCI_PWR_D3;
958 			break;
959 		default:
960 			return EINVAL;
961 		}
962 	}
963 	if (newstate == NULL)
964 		return 0;
965 	switch (*newstate) {
966 	case PCI_PWR_D0:
967 		if (now == PCI_PMCSR_STATE_D0)
968 			return 0;
969 		value |= PCI_PMCSR_STATE_D0;
970 		break;
971 	case PCI_PWR_D1:
972 		if (now == PCI_PMCSR_STATE_D1)
973 			return 0;
974 		if (now == PCI_PMCSR_STATE_D2 || now == PCI_PMCSR_STATE_D3)
975 			return EINVAL;
976 		if (!(cap & PCI_PMCR_D1SUPP))
977 			return EOPNOTSUPP;
978 		value |= PCI_PMCSR_STATE_D1;
979 		break;
980 	case PCI_PWR_D2:
981 		if (now == PCI_PMCSR_STATE_D2)
982 			return 0;
983 		if (now == PCI_PMCSR_STATE_D3)
984 			return EINVAL;
985 		if (!(cap & PCI_PMCR_D2SUPP))
986 			return EOPNOTSUPP;
987 		value |= PCI_PMCSR_STATE_D2;
988 		break;
989 	case PCI_PWR_D3:
990 		if (now == PCI_PMCSR_STATE_D3)
991 			return 0;
992 		value |= PCI_PMCSR_STATE_D3;
993 		break;
994 	default:
995 		return EINVAL;
996 	}
997 	cardbus_conf_write(cc, cf, tag, offset + PCI_PMCSR, value);
998 	DELAY(1000);
999 
1000 	return 0;
1001 }
1002 
1003 int
1004 cardbus_setpowerstate(const char *dvname, cardbus_devfunc_t ct, pcitag_t tag,
1005     int newpwr)
1006 {
1007 	int oldpwr, error;
1008 
1009 	if ((error = cardbus_powerstate(ct, tag, &newpwr, &oldpwr)) != 0)
1010 		return error;
1011 
1012 	if (oldpwr == newpwr)
1013 		return 0;
1014 
1015 	if (oldpwr > newpwr) {
1016 		printf("%s: sleeping to power state D%d\n", dvname, oldpwr);
1017 		return 0;
1018 	}
1019 
1020 	/* oldpwr < newpwr */
1021 	switch (oldpwr) {
1022 	case PCI_PWR_D3:
1023 		/*
1024 		 * XXX: This is because none of the devices do
1025 		 * the necessary song and dance for now to wakeup
1026 		 * Once this
1027 		 */
1028 		printf("%s: cannot wake up from power state D%d\n",
1029 		    dvname, oldpwr);
1030 		return EINVAL;
1031 	default:
1032 		printf("%s: waking up from power state D%d\n",
1033 		    dvname, oldpwr);
1034 		return 0;
1035 	}
1036 }
1037 
1038 
1039 #ifdef CARDBUS_DEBUG
1040 static const char *tuple_name(int);
1041 static const char *tuple_names[] = {
1042 	"TPL_NULL", "TPL_DEVICE", "Reserved", "Reserved", /* 0-3 */
1043 	"CONFIG_CB", "CFTABLE_ENTRY_CB", "Reserved", "BAR", /* 4-7 */
1044 	"Reserved", "Reserved", "Reserved", "Reserved", /* 8-B */
1045 	"Reserved", "Reserved", "Reserved", "Reserved", /* C-F */
1046 	"CHECKSUM", "LONGLINK_A", "LONGLINK_C", "LINKTARGET", /* 10-13 */
1047 	"NO_LINK", "VERS_1", "ALTSTR", "DEVICE_A",
1048 	"JEDEC_C", "JEDEC_A", "CONFIG", "CFTABLE_ENTRY",
1049 	"DEVICE_OC", "DEVICE_OA", "DEVICE_GEO", "DEVICE_GEO_A",
1050 	"MANFID", "FUNCID", "FUNCE", "SWIL", /* 20-23 */
1051 	"Reserved", "Reserved", "Reserved", "Reserved", /* 24-27 */
1052 	"Reserved", "Reserved", "Reserved", "Reserved", /* 28-2B */
1053 	"Reserved", "Reserved", "Reserved", "Reserved", /* 2C-2F */
1054 	"Reserved", "Reserved", "Reserved", "Reserved", /* 30-33 */
1055 	"Reserved", "Reserved", "Reserved", "Reserved", /* 34-37 */
1056 	"Reserved", "Reserved", "Reserved", "Reserved", /* 38-3B */
1057 	"Reserved", "Reserved", "Reserved", "Reserved", /* 3C-3F */
1058 	"VERS_2", "FORMAT", "GEOMETRY", "BYTEORDER",
1059 	"DATE", "BATTERY", "ORG"
1060 };
1061 #define NAME_LEN(x) (sizeof x / sizeof(x[0]))
1062 
1063 static const char *
1064 tuple_name(int type)
1065 {
1066 
1067 	if (0 <= type && type < NAME_LEN(tuple_names)) {
1068 		return (tuple_names[type]);
1069 	} else if (type == 0xff) {
1070 		return ("END");
1071 	} else {
1072 		return ("Reserved");
1073 	}
1074 }
1075 
1076 static void
1077 print_tuple(u_int8_t *tuple, int len, void *data)
1078 {
1079 	int i;
1080 
1081 	printf("tuple: %s len %d\n", tuple_name(tuple[0]), len);
1082 
1083 	for (i = 0; i < len; ++i) {
1084 		if (i % 16 == 0) {
1085 			printf("  0x%2x:", i);
1086 		}
1087 		printf(" %x", tuple[i]);
1088 		if (i % 16 == 15) {
1089 			printf("\n");
1090 		}
1091 	}
1092 	if (i % 16 != 0) {
1093 		printf("\n");
1094 	}
1095 }
1096 #endif
1097