1 /* $NetBSD: pcmcia.c,v 1.23 2000/07/28 19:17:02 drochner Exp $ */
4 * Copyright (c) 1997 Marc Horowitz. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. All advertising materials mentioning features or use of this software
15 * must display the following acknowledgement:
16 * This product includes software developed by Marc Horowitz.
17 * 4. The name of the author may not be used to endorse or promote products
18 * derived from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/malloc.h>
38 #include <sys/module.h>
39 #include <sys/kernel.h>
40 #include <sys/queue.h>
41 #include <sys/sysctl.h>
42 #include <sys/types.h>
45 #include <machine/bus.h>
47 #include <machine/resource.h>
49 #include <net/ethernet.h>
51 #include <dev/pccard/pccardreg.h>
52 #include <dev/pccard/pccardvar.h>
53 #include <dev/pccard/pccardvarp.h>
54 #include <dev/pccard/pccard_cis.h>
62 static SYSCTL_NODE(_hw, OID_AUTO, pccard, CTLFLAG_RD, 0, "PCCARD parameters");
65 TUNABLE_INT("hw.pccard.debug", &pccard_debug);
66 SYSCTL_INT(_hw_pccard, OID_AUTO, debug, CTLFLAG_RW,
70 int pccard_cis_debug = 0;
71 TUNABLE_INT("hw.pccard.cis_debug", &pccard_cis_debug);
72 SYSCTL_INT(_hw_pccard, OID_AUTO, cis_debug, CTLFLAG_RW,
73 &pccard_cis_debug, 0, "pccard CIS debug");
76 #define DPRINTF(arg) if (pccard_debug) printf arg
77 #define DEVPRINTF(arg) if (pccard_debug) device_printf arg
78 #define PRVERBOSE(arg) printf arg
79 #define DEVPRVERBOSE(arg) device_printf arg
82 #define DEVPRINTF(arg)
83 #define PRVERBOSE(arg) if (bootverbose) printf arg
84 #define DEVPRVERBOSE(arg) if (bootverbose) device_printf arg
87 static int pccard_ccr_read(struct pccard_function *pf, int ccr);
88 static void pccard_ccr_write(struct pccard_function *pf, int ccr, int val);
89 static int pccard_attach_card(device_t dev);
90 static int pccard_detach_card(device_t dev);
91 static void pccard_function_init(struct pccard_function *pf, int entry);
92 static void pccard_function_free(struct pccard_function *pf);
93 static int pccard_function_enable(struct pccard_function *pf);
94 static void pccard_function_disable(struct pccard_function *pf);
95 static int pccard_probe(device_t dev);
96 static int pccard_attach(device_t dev);
97 static int pccard_detach(device_t dev);
98 static void pccard_print_resources(struct resource_list *rl,
99 const char *name, int type, int count, const char *format);
100 static int pccard_print_child(device_t dev, device_t child);
101 static int pccard_set_resource(device_t dev, device_t child, int type,
102 int rid, u_long start, u_long count);
103 static int pccard_get_resource(device_t dev, device_t child, int type,
104 int rid, u_long *startp, u_long *countp);
105 static void pccard_delete_resource(device_t dev, device_t child, int type,
107 static int pccard_set_res_flags(device_t dev, device_t child, int type,
108 int rid, u_long flags);
109 static int pccard_set_memory_offset(device_t dev, device_t child, int rid,
110 uint32_t offset, uint32_t *deltap);
111 static int pccard_probe_and_attach_child(device_t dev, device_t child,
112 struct pccard_function *pf);
113 static void pccard_probe_nomatch(device_t cbdev, device_t child);
114 static int pccard_read_ivar(device_t bus, device_t child, int which,
116 static void pccard_driver_added(device_t dev, driver_t *driver);
117 static struct resource *pccard_alloc_resource(device_t dev,
118 device_t child, int type, int *rid, u_long start,
119 u_long end, u_long count, u_int flags);
120 static int pccard_release_resource(device_t dev, device_t child, int type,
121 int rid, struct resource *r);
122 static void pccard_child_detached(device_t parent, device_t dev);
123 static int pccard_filter(void *arg);
124 static void pccard_intr(void *arg);
125 static int pccard_setup_intr(device_t dev, device_t child,
126 struct resource *irq, int flags, driver_filter_t *filt,
127 driver_intr_t *intr, void *arg, void **cookiep);
128 static int pccard_teardown_intr(device_t dev, device_t child,
129 struct resource *r, void *cookie);
131 static const struct pccard_product *
132 pccard_do_product_lookup(device_t bus, device_t dev,
133 const struct pccard_product *tab, size_t ent_size,
134 pccard_product_match_fn matchfn);
138 pccard_ccr_read(struct pccard_function *pf, int ccr)
140 return (bus_space_read_1(pf->pf_ccrt, pf->pf_ccrh,
141 pf->pf_ccr_offset + ccr));
145 pccard_ccr_write(struct pccard_function *pf, int ccr, int val)
147 if ((pf->ccr_mask) & (1 << (ccr / 2))) {
148 bus_space_write_1(pf->pf_ccrt, pf->pf_ccrh,
149 pf->pf_ccr_offset + ccr, val);
154 pccard_set_default_descr(device_t dev)
156 const char *vendorstr, *prodstr;
157 uint32_t vendor, prod;
160 if (pccard_get_vendor_str(dev, &vendorstr))
162 if (pccard_get_product_str(dev, &prodstr))
164 if (vendorstr != NULL && prodstr != NULL) {
165 str = malloc(strlen(vendorstr) + strlen(prodstr) + 2, M_DEVBUF,
167 sprintf(str, "%s %s", vendorstr, prodstr);
168 device_set_desc_copy(dev, str);
171 if (pccard_get_vendor(dev, &vendor))
173 if (pccard_get_product(dev, &prod))
175 str = malloc(100, M_DEVBUF, M_WAITOK);
176 snprintf(str, 100, "vendor=%#x product=%#x", vendor, prod);
177 device_set_desc_copy(dev, str);
184 pccard_attach_card(device_t dev)
186 struct pccard_softc *sc = PCCARD_SOFTC(dev);
187 struct pccard_function *pf;
188 struct pccard_ivar *ivar;
192 if (!STAILQ_EMPTY(&sc->card.pf_head)) {
193 if (bootverbose || pccard_debug)
194 device_printf(dev, "Card already inserted.\n");
197 DEVPRINTF((dev, "chip_socket_enable\n"));
198 POWER_ENABLE_SOCKET(device_get_parent(dev), dev);
200 DEVPRINTF((dev, "read_cis\n"));
203 DEVPRINTF((dev, "check_cis_quirks\n"));
204 pccard_check_cis_quirks(dev);
207 * bail now if the card has no functions, or if there was an error in
211 if (sc->card.error) {
212 device_printf(dev, "CARD ERROR!\n");
215 if (STAILQ_EMPTY(&sc->card.pf_head)) {
216 device_printf(dev, "Card has no functions!\n");
220 if (bootverbose || pccard_debug)
221 pccard_print_cis(dev);
223 DEVPRINTF((dev, "functions scanning\n"));
225 STAILQ_FOREACH(pf, &sc->card.pf_head, pf_list) {
227 if (STAILQ_EMPTY(&pf->cfe_head)) {
229 "Function %d has no config entries.!\n", i);
236 DEVPRINTF((dev, "Card has %d functions. pccard_mfc is %d\n", i + 1,
239 STAILQ_FOREACH(pf, &sc->card.pf_head, pf_list) {
240 if (STAILQ_EMPTY(&pf->cfe_head))
242 ivar = malloc(sizeof(struct pccard_ivar), M_DEVBUF,
244 resource_list_init(&ivar->resources);
245 child = device_add_child(dev, NULL, -1);
246 device_set_ivars(child, ivar);
249 pccard_probe_and_attach_child(dev, child, pf);
255 pccard_probe_and_attach_child(device_t dev, device_t child,
256 struct pccard_function *pf)
258 struct pccard_softc *sc = PCCARD_SOFTC(dev);
262 * In NetBSD, the drivers are responsible for activating each
263 * function of a card and selecting the config to use. In
264 * FreeBSD, all that's done automatically in the typical lazy
265 * way we do device resoruce allocation (except we pick the
266 * cfe up front). This is the biggest depature from the
267 * inherited NetBSD model, apart from the FreeBSD resource code.
269 * This seems to work well in practice for most cards.
270 * However, there are two cases that are problematic. If a
271 * driver wishes to pick and chose which config entry to use,
272 * then this method falls down. These are usually older
273 * cards. In addition, there are some cards that have
274 * multiple hardware units on the cards, but presents only one
275 * CIS chain. These cards are combination cards, but only one
276 * of these units can be on at a time.
278 * To overcome this limitation, while preserving the basic
279 * model, the probe routine can select a cfe and try to
280 * activate it. If that succeeds, then we'll keep track of
281 * and let that information persist until we attach the card.
282 * Probe routines that do this MUST return 0, and cannot
283 * participate in the bidding process for a device. This
284 * seems harsh until you realize that if a probe routine knows
285 * enough to override the cfe we pick, then chances are very
286 * very good that it is the only driver that could hope to
287 * cope with the card. Bidding is for generic drivers, and
288 * while some of them may also match, none of them will do
289 * configuration override.
291 error = device_probe(child);
294 pccard_function_init(pf, -1);
295 if (sc->sc_enabled_count == 0)
296 POWER_ENABLE_SOCKET(device_get_parent(dev), dev);
297 if (pccard_function_enable(pf) == 0 &&
298 pccard_set_default_descr(child) == 0 &&
299 device_attach(child) == 0) {
300 DEVPRINTF((sc->dev, "function %d CCR at %d offset %#x "
301 "mask %#x: %#x %#x %#x %#x, %#x %#x %#x %#x, %#x\n",
302 pf->number, pf->pf_ccr_window, pf->pf_ccr_offset,
303 pf->ccr_mask, pccard_ccr_read(pf, 0x00),
304 pccard_ccr_read(pf, 0x02), pccard_ccr_read(pf, 0x04),
305 pccard_ccr_read(pf, 0x06), pccard_ccr_read(pf, 0x0A),
306 pccard_ccr_read(pf, 0x0C), pccard_ccr_read(pf, 0x0E),
307 pccard_ccr_read(pf, 0x10), pccard_ccr_read(pf, 0x12)));
313 * Probe may fail AND also try to select a cfe, if so, free
314 * it. This is how we do cfe override. Or the attach fails.
315 * Either way, we have to clean up.
318 pccard_function_disable(pf);
320 pccard_function_free(pf);
325 pccard_detach_card(device_t dev)
327 struct pccard_softc *sc = PCCARD_SOFTC(dev);
328 struct pccard_function *pf;
329 struct pccard_config_entry *cfe;
330 struct pccard_ivar *devi;
334 * We are running on either the PCCARD socket's event thread
335 * or in user context detaching a device by user request.
337 STAILQ_FOREACH(pf, &sc->card.pf_head, pf_list) {
340 state = device_get_state(pf->dev);
341 if (state == DS_ATTACHED || state == DS_BUSY)
342 device_detach(pf->dev);
344 pccard_function_disable(pf);
345 pccard_function_free(pf);
346 devi = PCCARD_IVAR(pf->dev);
347 device_delete_child(dev, pf->dev);
348 free(devi, M_DEVBUF);
350 if (sc->sc_enabled_count == 0)
351 POWER_DISABLE_SOCKET(device_get_parent(dev), dev);
353 while (NULL != (pf = STAILQ_FIRST(&sc->card.pf_head))) {
354 while (NULL != (cfe = STAILQ_FIRST(&pf->cfe_head))) {
355 STAILQ_REMOVE_HEAD(&pf->cfe_head, cfe_list);
358 STAILQ_REMOVE_HEAD(&sc->card.pf_head, pf_list);
361 STAILQ_INIT(&sc->card.pf_head);
365 static const struct pccard_product *
366 pccard_do_product_lookup(device_t bus, device_t dev,
367 const struct pccard_product *tab, size_t ent_size,
368 pccard_product_match_fn matchfn)
370 const struct pccard_product *ent;
374 const char *vendorstr;
380 if (sizeof *ent > ent_size)
381 panic("pccard_product_lookup: bogus ent_size %jd",
382 (intmax_t) ent_size);
384 if (pccard_get_vendor(dev, &vendor))
386 if (pccard_get_product(dev, &prod))
388 if (pccard_get_vendor_str(dev, &vendorstr))
390 if (pccard_get_product_str(dev, &prodstr))
392 if (pccard_get_cis3_str(dev, &cis3str))
394 if (pccard_get_cis4_str(dev, &cis4str))
396 for (ent = tab; ent->pp_vendor != 0; ent =
397 (const struct pccard_product *) ((const char *) ent + ent_size)) {
399 if (ent->pp_vendor == PCCARD_VENDOR_ANY &&
400 ent->pp_product == PCCARD_PRODUCT_ANY &&
401 ent->pp_cis[0] == NULL &&
402 ent->pp_cis[1] == NULL) {
405 "Total wildcard entry ignored for %s\n",
409 if (matches && ent->pp_vendor != PCCARD_VENDOR_ANY &&
410 vendor != ent->pp_vendor)
412 if (matches && ent->pp_product != PCCARD_PRODUCT_ANY &&
413 prod != ent->pp_product)
415 if (matches && ent->pp_cis[0] &&
416 (vendorstr == NULL ||
417 strcmp(ent->pp_cis[0], vendorstr) != 0))
419 if (matches && ent->pp_cis[1] &&
421 strcmp(ent->pp_cis[1], prodstr) != 0))
423 if (matches && ent->pp_cis[2] &&
425 strcmp(ent->pp_cis[2], cis3str) != 0))
427 if (matches && ent->pp_cis[3] &&
429 strcmp(ent->pp_cis[3], cis4str) != 0))
432 matches = (*matchfn)(dev, ent, matches);
440 * @brief pccard_select_cfe
442 * Select a cfe entry to use. Should be called from the pccard's probe
443 * routine after it knows for sure that it wants this card.
445 * XXX I think we need to make this symbol be static, ala the kobj stuff
446 * we do for everything else. This is a quick hack.
449 pccard_select_cfe(device_t dev, int entry)
451 struct pccard_ivar *devi = PCCARD_IVAR(dev);
452 struct pccard_function *pf = devi->pf;
454 pccard_function_init(pf, entry);
455 return (pf->cfe ? 0 : ENOMEM);
459 * Initialize a PCCARD function. May be called as long as the function is
462 * Note: pccard_function_init should not keep resources allocated. It should
463 * only set them up ala isa pnp, set the values in the rl lists, and return.
464 * Any resource held after pccard_function_init is called is a bug. However,
465 * the bus routines to get the resources also assume that pccard_function_init
466 * does this, so they need to be fixed too.
469 pccard_function_init(struct pccard_function *pf, int entry)
471 struct pccard_config_entry *cfe;
472 struct pccard_ivar *devi = PCCARD_IVAR(pf->dev);
473 struct resource_list *rl = &devi->resources;
474 struct resource_list_entry *rle;
475 struct resource *r = 0;
476 struct pccard_ce_iospace *ios;
477 struct pccard_ce_memspace *mems;
479 u_long start, end, len;
482 if (pf->pf_flags & PFF_ENABLED) {
483 printf("pccard_function_init: function is enabled");
488 * Driver probe routine requested a specific entry already
495 * walk the list of configuration entries until we find one that
496 * we can allocate all the resources to.
498 bus = device_get_parent(pf->dev);
499 STAILQ_FOREACH(cfe, &pf->cfe_head, cfe_list) {
500 if (cfe->iftype != PCCARD_IFTYPE_IO)
502 if (entry != -1 && cfe->number != entry)
505 for (i = 0; i < cfe->num_iospace; i++) {
506 ios = cfe->iospace + i;
509 end = start + ios->length - 1;
512 DEVPRINTF((bus, "I/O rid %d start %#lx end %#lx\n",
516 r = bus_alloc_resource(bus, SYS_RES_IOPORT, &rid,
517 start, end, len, rman_make_alignment_flags(len));
519 DEVPRINTF((bus, "I/O rid %d failed\n", i));
522 rle = resource_list_add(rl, SYS_RES_IOPORT,
523 rid, rman_get_start(r), rman_get_end(r), len);
525 panic("Cannot add resource rid %d IOPORT", rid);
529 for (i = 0; i < cfe->num_memspace; i++) {
530 mems = cfe->memspace + i;
531 start = mems->cardaddr + mems->hostaddr;
533 end = start + mems->length - 1;
536 DEVPRINTF((bus, "Memory rid %d start %#lx end %#lx\ncardaddr %#lx hostaddr %#lx length %#lx\n",
537 i, start, end, mems->cardaddr, mems->hostaddr,
541 r = bus_alloc_resource(bus, SYS_RES_MEMORY, &rid,
542 start, end, len, rman_make_alignment_flags(len));
544 DEVPRINTF((bus, "Memory rid %d failed\n", i));
545 // goto not_this_one;
548 rle = resource_list_add(rl, SYS_RES_MEMORY,
549 rid, rman_get_start(r), rman_get_end(r), len);
551 panic("Cannot add resource rid %d MEM", rid);
556 DEVPRINTF((bus, "Neither memory nor I/O mapped\n"));
561 r = bus_alloc_resource_any(bus, SYS_RES_IRQ, &rid,
564 DEVPRINTF((bus, "IRQ rid %d failed\n", rid));
567 rle = resource_list_add(rl, SYS_RES_IRQ, rid,
568 rman_get_start(r), rman_get_end(r), 1);
570 panic("Cannot add resource rid %d IRQ", rid);
573 /* If we get to here, we've allocated all we need */
577 DEVPRVERBOSE((bus, "Allocation failed for cfe %d\n",
579 resource_list_purge(rl);
584 * Free resources allocated by pccard_function_init(), May be called as long
585 * as the function is disabled.
587 * NOTE: This function should be unnecessary. pccard_function_init should
588 * never keep resources initialized.
591 pccard_function_free(struct pccard_function *pf)
593 struct pccard_ivar *devi = PCCARD_IVAR(pf->dev);
594 struct resource_list_entry *rle;
596 if (pf->pf_flags & PFF_ENABLED) {
597 printf("pccard_function_free: function is enabled");
601 STAILQ_FOREACH(rle, &devi->resources, link) {
603 if (rman_get_device(rle->res) != pf->sc->dev)
604 device_printf(pf->sc->dev,
605 "function_free: Resource still owned by "
607 "(type=%d, rid=%d, addr=%#lx)\n",
609 rman_get_start(rle->res));
610 BUS_RELEASE_RESOURCE(device_get_parent(pf->sc->dev),
611 pf->sc->dev, rle->type, rle->rid, rle->res);
615 resource_list_free(&devi->resources);
619 pccard_mfc_adjust_iobase(struct pccard_function *pf, bus_addr_t addr,
620 bus_addr_t offset, bus_size_t size)
622 bus_size_t iosize, tmp;
625 if (pf->pf_mfc_iomax == 0) {
626 pf->pf_mfc_iobase = addr + offset;
627 pf->pf_mfc_iomax = pf->pf_mfc_iobase + size;
629 /* this makes the assumption that nothing overlaps */
630 if (pf->pf_mfc_iobase > addr + offset)
631 pf->pf_mfc_iobase = addr + offset;
632 if (pf->pf_mfc_iomax < addr + offset + size)
633 pf->pf_mfc_iomax = addr + offset + size;
637 tmp = pf->pf_mfc_iomax - pf->pf_mfc_iobase;
638 /* round up to nearest (2^n)-1 */
639 for (iosize = 1; iosize < tmp; iosize <<= 1)
643 DEVPRINTF((pf->dev, "MFC: I/O base %#jx IOSIZE %#jx\n",
644 (uintmax_t)pf->pf_mfc_iobase, (uintmax_t)(iosize + 1)));
645 pccard_ccr_write(pf, PCCARD_CCR_IOBASE0,
646 pf->pf_mfc_iobase & 0xff);
647 pccard_ccr_write(pf, PCCARD_CCR_IOBASE1,
648 (pf->pf_mfc_iobase >> 8) & 0xff);
649 pccard_ccr_write(pf, PCCARD_CCR_IOBASE2, 0);
650 pccard_ccr_write(pf, PCCARD_CCR_IOBASE3, 0);
651 pccard_ccr_write(pf, PCCARD_CCR_IOSIZE, iosize);
654 /* Enable a PCCARD function */
656 pccard_function_enable(struct pccard_function *pf)
658 struct pccard_function *tmp;
660 device_t dev = pf->sc->dev;
662 if (pf->cfe == NULL) {
663 DEVPRVERBOSE((dev, "No config entry could be allocated.\n"));
667 if (pf->pf_flags & PFF_ENABLED)
669 pf->sc->sc_enabled_count++;
672 * it's possible for different functions' CCRs to be in the same
673 * underlying page. Check for that.
675 STAILQ_FOREACH(tmp, &pf->sc->card.pf_head, pf_list) {
676 if ((tmp->pf_flags & PFF_ENABLED) &&
677 (pf->ccr_base >= (tmp->ccr_base - tmp->pf_ccr_offset)) &&
678 ((pf->ccr_base + PCCARD_CCR_SIZE) <=
679 (tmp->ccr_base - tmp->pf_ccr_offset +
680 tmp->pf_ccr_realsize))) {
681 pf->pf_ccrt = tmp->pf_ccrt;
682 pf->pf_ccrh = tmp->pf_ccrh;
683 pf->pf_ccr_realsize = tmp->pf_ccr_realsize;
686 * pf->pf_ccr_offset = (tmp->pf_ccr_offset -
687 * tmp->ccr_base) + pf->ccr_base;
689 /* pf->pf_ccr_offset =
690 (tmp->pf_ccr_offset + pf->ccr_base) -
692 pf->pf_ccr_window = tmp->pf_ccr_window;
698 pf->ccr_res = bus_alloc_resource(dev, SYS_RES_MEMORY,
699 &pf->ccr_rid, 0, ~0, PCCARD_MEM_PAGE_SIZE, RF_ACTIVE);
702 DEVPRINTF((dev, "ccr_res == %#lx-%#lx, base=%#x\n",
703 rman_get_start(pf->ccr_res), rman_get_end(pf->ccr_res),
705 CARD_SET_RES_FLAGS(device_get_parent(dev), dev, SYS_RES_MEMORY,
706 pf->ccr_rid, PCCARD_A_MEM_ATTR);
707 CARD_SET_MEMORY_OFFSET(device_get_parent(dev), dev,
708 pf->ccr_rid, pf->ccr_base, &pf->pf_ccr_offset);
709 pf->pf_ccrt = rman_get_bustag(pf->ccr_res);
710 pf->pf_ccrh = rman_get_bushandle(pf->ccr_res);
711 pf->pf_ccr_realsize = 1;
714 reg = (pf->cfe->number & PCCARD_CCR_OPTION_CFINDEX);
715 reg |= PCCARD_CCR_OPTION_LEVIREQ;
716 if (pccard_mfc(pf->sc)) {
717 reg |= (PCCARD_CCR_OPTION_FUNC_ENABLE |
718 PCCARD_CCR_OPTION_ADDR_DECODE);
719 /* PCCARD_CCR_OPTION_IRQ_ENABLE set elsewhere as needed */
721 pccard_ccr_write(pf, PCCARD_CCR_OPTION, reg);
724 if ((pf->cfe->flags & PCCARD_CFE_IO16) == 0)
725 reg |= PCCARD_CCR_STATUS_IOIS8;
726 if (pf->cfe->flags & PCCARD_CFE_AUDIO)
727 reg |= PCCARD_CCR_STATUS_AUDIO;
728 pccard_ccr_write(pf, PCCARD_CCR_STATUS, reg);
730 pccard_ccr_write(pf, PCCARD_CCR_SOCKETCOPY, 0);
732 if (pccard_mfc(pf->sc))
733 pccard_mfc_adjust_iobase(pf, 0, 0, 0);
737 STAILQ_FOREACH(tmp, &pf->sc->card.pf_head, pf_list) {
738 device_printf(tmp->sc->dev,
739 "function %d CCR at %d offset %#x: "
740 "%#x %#x %#x %#x, %#x %#x %#x %#x, %#x\n",
741 tmp->number, tmp->pf_ccr_window,
743 pccard_ccr_read(tmp, 0x00),
744 pccard_ccr_read(tmp, 0x02),
745 pccard_ccr_read(tmp, 0x04),
746 pccard_ccr_read(tmp, 0x06),
747 pccard_ccr_read(tmp, 0x0A),
748 pccard_ccr_read(tmp, 0x0C),
749 pccard_ccr_read(tmp, 0x0E),
750 pccard_ccr_read(tmp, 0x10),
751 pccard_ccr_read(tmp, 0x12));
755 pf->pf_flags |= PFF_ENABLED;
760 * Decrement the reference count, and power down the socket, if
763 pf->sc->sc_enabled_count--;
764 DEVPRINTF((dev, "bad --enabled_count = %d\n", pf->sc->sc_enabled_count));
769 /* Disable PCCARD function. */
771 pccard_function_disable(struct pccard_function *pf)
773 struct pccard_function *tmp;
774 device_t dev = pf->sc->dev;
777 panic("pccard_function_disable: function not initialized");
779 if ((pf->pf_flags & PFF_ENABLED) == 0)
781 if (pf->intr_handler != NULL) {
782 struct pccard_ivar *devi = PCCARD_IVAR(pf->dev);
783 struct resource_list_entry *rle =
784 resource_list_find(&devi->resources, SYS_RES_IRQ, 0);
786 panic("Can't disable an interrupt with no IRQ res\n");
787 BUS_TEARDOWN_INTR(dev, pf->dev, rle->res,
788 pf->intr_handler_cookie);
792 * it's possible for different functions' CCRs to be in the same
793 * underlying page. Check for that. Note we mark us as disabled
794 * first to avoid matching ourself.
797 pf->pf_flags &= ~PFF_ENABLED;
798 STAILQ_FOREACH(tmp, &pf->sc->card.pf_head, pf_list) {
799 if ((tmp->pf_flags & PFF_ENABLED) &&
800 (pf->ccr_base >= (tmp->ccr_base - tmp->pf_ccr_offset)) &&
801 ((pf->ccr_base + PCCARD_CCR_SIZE) <=
802 (tmp->ccr_base - tmp->pf_ccr_offset +
803 tmp->pf_ccr_realsize)))
807 /* Not used by anyone else; unmap the CCR. */
809 bus_release_resource(dev, SYS_RES_MEMORY, pf->ccr_rid,
815 * Decrement the reference count, and power down the socket, if
818 pf->sc->sc_enabled_count--;
821 #define PCCARD_NPORT 2
822 #define PCCARD_NMEM 5
823 #define PCCARD_NIRQ 1
824 #define PCCARD_NDRQ 0
827 pccard_probe(device_t dev)
829 device_set_desc(dev, "16-bit PCCard bus");
834 pccard_attach(device_t dev)
836 struct pccard_softc *sc = PCCARD_SOFTC(dev);
840 sc->sc_enabled_count = 0;
841 if ((err = pccard_device_create(sc)) != 0)
843 STAILQ_INIT(&sc->card.pf_head);
844 return (bus_generic_attach(dev));
848 pccard_detach(device_t dev)
850 pccard_detach_card(dev);
851 pccard_device_destroy(device_get_softc(dev));
856 pccard_suspend(device_t self)
858 pccard_detach_card(self);
864 pccard_resume(device_t self)
870 pccard_print_resources(struct resource_list *rl, const char *name, int type,
871 int count, const char *format)
873 struct resource_list_entry *rle;
878 for (i = 0; i < count; i++) {
879 rle = resource_list_find(rl, type, i);
882 printf(" %s ", name);
883 else if (printed > 0)
886 printf(format, rle->start);
887 if (rle->count > 1) {
889 printf(format, rle->start + rle->count - 1);
892 /* check the first few regardless */
899 pccard_print_child(device_t dev, device_t child)
901 struct pccard_ivar *devi = PCCARD_IVAR(child);
902 struct resource_list *rl = &devi->resources;
905 retval += bus_print_child_header(dev, child);
906 retval += printf(" at");
909 pccard_print_resources(rl, "port", SYS_RES_IOPORT,
910 PCCARD_NPORT, "%#lx");
911 pccard_print_resources(rl, "iomem", SYS_RES_MEMORY,
912 PCCARD_NMEM, "%#lx");
913 pccard_print_resources(rl, "irq", SYS_RES_IRQ, PCCARD_NIRQ,
915 pccard_print_resources(rl, "drq", SYS_RES_DRQ, PCCARD_NDRQ,
917 retval += printf(" function %d config %d", devi->pf->number,
918 devi->pf->cfe->number);
921 retval += bus_print_child_footer(dev, child);
927 pccard_set_resource(device_t dev, device_t child, int type, int rid,
928 u_long start, u_long count)
930 struct pccard_ivar *devi = PCCARD_IVAR(child);
931 struct resource_list *rl = &devi->resources;
933 if (type != SYS_RES_IOPORT && type != SYS_RES_MEMORY
934 && type != SYS_RES_IRQ && type != SYS_RES_DRQ)
938 if (type == SYS_RES_IOPORT && rid >= PCCARD_NPORT)
940 if (type == SYS_RES_MEMORY && rid >= PCCARD_NMEM)
942 if (type == SYS_RES_IRQ && rid >= PCCARD_NIRQ)
944 if (type == SYS_RES_DRQ && rid >= PCCARD_NDRQ)
947 resource_list_add(rl, type, rid, start, start + count - 1, count);
948 if (NULL != resource_list_alloc(rl, device_get_parent(dev), dev,
949 type, &rid, start, start + count - 1, count, 0))
956 pccard_get_resource(device_t dev, device_t child, int type, int rid,
957 u_long *startp, u_long *countp)
959 struct pccard_ivar *devi = PCCARD_IVAR(child);
960 struct resource_list *rl = &devi->resources;
961 struct resource_list_entry *rle;
963 rle = resource_list_find(rl, type, rid);
968 *startp = rle->start;
970 *countp = rle->count;
976 pccard_delete_resource(device_t dev, device_t child, int type, int rid)
978 struct pccard_ivar *devi = PCCARD_IVAR(child);
979 struct resource_list *rl = &devi->resources;
980 resource_list_delete(rl, type, rid);
984 pccard_set_res_flags(device_t dev, device_t child, int type, int rid,
987 return (CARD_SET_RES_FLAGS(device_get_parent(dev), child, type,
992 pccard_set_memory_offset(device_t dev, device_t child, int rid,
993 uint32_t offset, uint32_t *deltap)
996 return (CARD_SET_MEMORY_OFFSET(device_get_parent(dev), child, rid,
1001 pccard_probe_nomatch(device_t bus, device_t child)
1003 struct pccard_ivar *devi = PCCARD_IVAR(child);
1004 struct pccard_function *pf = devi->pf;
1005 struct pccard_softc *sc = PCCARD_SOFTC(bus);
1008 device_printf(bus, "<unknown card>");
1009 printf(" (manufacturer=0x%04x, product=0x%04x, function_type=%d) "
1010 "at function %d\n", sc->card.manufacturer, sc->card.product,
1011 pf->function, pf->number);
1012 device_printf(bus, " CIS info: ");
1013 for (i = 0; sc->card.cis1_info[i] != NULL && i < 4; i++)
1014 printf("%s%s", i > 0 ? ", " : "", sc->card.cis1_info[i]);
1020 pccard_child_location_str(device_t bus, device_t child, char *buf,
1023 struct pccard_ivar *devi = PCCARD_IVAR(child);
1024 struct pccard_function *pf = devi->pf;
1026 snprintf(buf, buflen, "function=%d", pf->number);
1030 /* XXX Maybe this should be in subr_bus? */
1032 pccard_safe_quote(char *dst, const char *src, size_t len)
1034 char *walker = dst, *ep = dst + len - 1;
1038 while (src != NULL && walker < ep)
1041 if (ep - walker < 2)
1051 pccard_child_pnpinfo_str(device_t bus, device_t child, char *buf,
1054 struct pccard_ivar *devi = PCCARD_IVAR(child);
1055 struct pccard_function *pf = devi->pf;
1056 struct pccard_softc *sc = PCCARD_SOFTC(bus);
1057 char cis0[128], cis1[128];
1059 pccard_safe_quote(cis0, sc->card.cis1_info[0], sizeof(cis0));
1060 pccard_safe_quote(cis1, sc->card.cis1_info[1], sizeof(cis1));
1061 snprintf(buf, buflen, "manufacturer=0x%04x product=0x%04x "
1062 "cisvendor=\"%s\" cisproduct=\"%s\" function_type=%d",
1063 sc->card.manufacturer, sc->card.product, cis0, cis1, pf->function);
1068 pccard_read_ivar(device_t bus, device_t child, int which, uintptr_t *result)
1070 struct pccard_ivar *devi = PCCARD_IVAR(child);
1071 struct pccard_function *pf = devi->pf;
1072 struct pccard_softc *sc = PCCARD_SOFTC(bus);
1075 panic("No pccard function pointer");
1079 case PCCARD_IVAR_FUNCE_DISK:
1080 *(uint16_t *)result = pf->pf_funce_disk_interface |
1081 (pf->pf_funce_disk_power << 8);
1083 case PCCARD_IVAR_ETHADDR:
1084 bcopy(pf->pf_funce_lan_nid, result, ETHER_ADDR_LEN);
1086 case PCCARD_IVAR_VENDOR:
1087 *(uint32_t *)result = sc->card.manufacturer;
1089 case PCCARD_IVAR_PRODUCT:
1090 *(uint32_t *)result = sc->card.product;
1092 case PCCARD_IVAR_PRODEXT:
1093 *(uint16_t *)result = sc->card.prodext;
1095 case PCCARD_IVAR_FUNCTION:
1096 *(uint32_t *)result = pf->function;
1098 case PCCARD_IVAR_FUNCTION_NUMBER:
1099 *(uint32_t *)result = pf->number;
1101 case PCCARD_IVAR_VENDOR_STR:
1102 *(const char **)result = sc->card.cis1_info[0];
1104 case PCCARD_IVAR_PRODUCT_STR:
1105 *(const char **)result = sc->card.cis1_info[1];
1107 case PCCARD_IVAR_CIS3_STR:
1108 *(const char **)result = sc->card.cis1_info[2];
1110 case PCCARD_IVAR_CIS4_STR:
1111 *(const char **)result = sc->card.cis1_info[3];
1118 pccard_driver_added(device_t dev, driver_t *driver)
1120 struct pccard_softc *sc = PCCARD_SOFTC(dev);
1121 struct pccard_function *pf;
1124 STAILQ_FOREACH(pf, &sc->card.pf_head, pf_list) {
1125 if (STAILQ_EMPTY(&pf->cfe_head))
1128 if (device_get_state(child) != DS_NOTPRESENT)
1130 pccard_probe_and_attach_child(dev, child, pf);
1135 static struct resource *
1136 pccard_alloc_resource(device_t dev, device_t child, int type, int *rid,
1137 u_long start, u_long end, u_long count, u_int flags)
1139 struct pccard_ivar *dinfo;
1140 struct resource_list_entry *rle = 0;
1141 int passthrough = (device_get_parent(child) != dev);
1142 int isdefault = (start == 0 && end == ~0UL && count == 1);
1143 struct resource *r = NULL;
1145 /* XXX I'm no longer sure this is right */
1147 return (BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
1148 type, rid, start, end, count, flags));
1151 dinfo = device_get_ivars(child);
1152 rle = resource_list_find(&dinfo->resources, type, *rid);
1154 if (rle == NULL && isdefault)
1155 return (NULL); /* no resource of that type/rid */
1156 if (rle == NULL || rle->res == NULL) {
1157 /* XXX Need to adjust flags */
1158 r = bus_alloc_resource(dev, type, rid, start, end,
1162 resource_list_add(&dinfo->resources, type, *rid,
1163 rman_get_start(r), rman_get_end(r), count);
1164 rle = resource_list_find(&dinfo->resources, type, *rid);
1170 * If dev doesn't own the device, then we can't give this device
1173 if (rman_get_device(rle->res) != dev)
1175 rman_set_device(rle->res, child);
1176 if (flags & RF_ACTIVE)
1177 BUS_ACTIVATE_RESOURCE(dev, child, type, *rid, rle->res);
1180 device_printf(dev, "WARNING: Resource not reserved by pccard\n");
1185 pccard_release_resource(device_t dev, device_t child, int type, int rid,
1188 struct pccard_ivar *dinfo;
1189 int passthrough = (device_get_parent(child) != dev);
1190 struct resource_list_entry *rle = 0;
1193 return BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
1196 dinfo = device_get_ivars(child);
1198 rle = resource_list_find(&dinfo->resources, type, rid);
1201 device_printf(dev, "Allocated resource not found, "
1202 "%d %#x %#lx %#lx\n",
1203 type, rid, rman_get_start(r), rman_get_size(r));
1207 device_printf(dev, "Allocated resource not recorded\n");
1211 * Deactivate the resource (since it is being released), and
1212 * assign it to the bus.
1214 BUS_DEACTIVATE_RESOURCE(dev, child, type, rid, rle->res);
1215 rman_set_device(rle->res, dev);
1220 pccard_child_detached(device_t parent, device_t dev)
1222 struct pccard_ivar *ivar = PCCARD_IVAR(dev);
1223 struct pccard_function *pf = ivar->pf;
1225 pccard_function_disable(pf);
1229 pccard_filter(void *arg)
1231 struct pccard_function *pf = (struct pccard_function*) arg;
1236 * MFC cards know if they interrupted, so we have to ack the
1237 * interrupt and call the ISR. Non-MFC cards don't have these
1238 * bits, so they always get called. Many non-MFC cards have
1239 * this bit set always upon read, but some do not.
1241 * We always ack the interrupt, even if there's no ISR
1242 * for the card. This is done on the theory that acking
1243 * the interrupt will pacify the card enough to keep an
1244 * interrupt storm from happening. Of course this won't
1245 * help in the non-MFC case.
1247 * This has no impact for MPSAFEness of the client drivers.
1248 * We register this with whatever flags the intr_handler
1249 * was registered with. All these functions are MPSAFE.
1251 if (pccard_mfc(pf->sc)) {
1252 reg = pccard_ccr_read(pf, PCCARD_CCR_STATUS);
1253 if (reg & PCCARD_CCR_STATUS_INTR)
1254 pccard_ccr_write(pf, PCCARD_CCR_STATUS,
1255 reg & ~PCCARD_CCR_STATUS_INTR);
1260 if (pf->intr_filter != NULL)
1261 return (pf->intr_filter(pf->intr_handler_arg));
1262 return (FILTER_SCHEDULE_THREAD);
1264 return (FILTER_STRAY);
1268 pccard_intr(void *arg)
1270 struct pccard_function *pf = (struct pccard_function*) arg;
1272 pf->intr_handler(pf->intr_handler_arg);
1276 pccard_setup_intr(device_t dev, device_t child, struct resource *irq,
1277 int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg,
1280 struct pccard_softc *sc = PCCARD_SOFTC(dev);
1281 struct pccard_ivar *ivar = PCCARD_IVAR(child);
1282 struct pccard_function *pf = ivar->pf;
1285 if (pf->intr_filter != NULL || pf->intr_handler != NULL)
1286 panic("Only one interrupt handler per function allowed");
1287 err = bus_generic_setup_intr(dev, child, irq, flags, pccard_filter,
1288 intr ? pccard_intr : NULL, pf, cookiep);
1291 pf->intr_filter = filt;
1292 pf->intr_handler = intr;
1293 pf->intr_handler_arg = arg;
1294 pf->intr_handler_cookie = *cookiep;
1295 if (pccard_mfc(sc)) {
1296 pccard_ccr_write(pf, PCCARD_CCR_OPTION,
1297 pccard_ccr_read(pf, PCCARD_CCR_OPTION) |
1298 PCCARD_CCR_OPTION_IREQ_ENABLE);
1304 pccard_teardown_intr(device_t dev, device_t child, struct resource *r,
1307 struct pccard_softc *sc = PCCARD_SOFTC(dev);
1308 struct pccard_ivar *ivar = PCCARD_IVAR(child);
1309 struct pccard_function *pf = ivar->pf;
1312 if (pccard_mfc(sc)) {
1313 pccard_ccr_write(pf, PCCARD_CCR_OPTION,
1314 pccard_ccr_read(pf, PCCARD_CCR_OPTION) &
1315 ~PCCARD_CCR_OPTION_IREQ_ENABLE);
1317 ret = bus_generic_teardown_intr(dev, child, r, cookie);
1319 pf->intr_handler = NULL;
1320 pf->intr_handler_arg = NULL;
1321 pf->intr_handler_cookie = NULL;
1328 pccard_activate_resource(device_t brdev, device_t child, int type, int rid,
1331 struct pccard_ivar *ivar = PCCARD_IVAR(child);
1332 struct pccard_function *pf = ivar->pf;
1335 case SYS_RES_IOPORT:
1337 * We need to adjust IOBASE[01] and IOSIZE if we're an MFC
1340 if (pccard_mfc(pf->sc))
1341 pccard_mfc_adjust_iobase(pf, rman_get_start(r), 0,
1347 return (bus_generic_activate_resource(brdev, child, type, rid, r));
1351 pccard_deactivate_resource(device_t brdev, device_t child, int type,
1352 int rid, struct resource *r)
1354 /* XXX undo pccard_activate_resource? XXX */
1355 return (bus_generic_deactivate_resource(brdev, child, type, rid, r));
1359 pccard_attr_read_impl(device_t brdev, device_t child, uint32_t offset,
1362 struct pccard_ivar *devi = PCCARD_IVAR(child);
1363 struct pccard_function *pf = devi->pf;
1366 * Optimization. Most of the time, devices want to access
1367 * the same page of the attribute memory that the CCR is in.
1368 * We take advantage of this fact here.
1370 if (offset / PCCARD_MEM_PAGE_SIZE ==
1371 pf->ccr_base / PCCARD_MEM_PAGE_SIZE)
1372 *val = bus_space_read_1(pf->pf_ccrt, pf->pf_ccrh,
1373 offset % PCCARD_MEM_PAGE_SIZE);
1375 CARD_SET_MEMORY_OFFSET(brdev, child, pf->ccr_rid, offset,
1377 *val = bus_space_read_1(pf->pf_ccrt, pf->pf_ccrh, offset);
1378 CARD_SET_MEMORY_OFFSET(brdev, child, pf->ccr_rid, pf->ccr_base,
1385 pccard_attr_write_impl(device_t brdev, device_t child, uint32_t offset,
1388 struct pccard_ivar *devi = PCCARD_IVAR(child);
1389 struct pccard_function *pf = devi->pf;
1392 * Optimization. Most of the time, devices want to access
1393 * the same page of the attribute memory that the CCR is in.
1394 * We take advantage of this fact here.
1396 if (offset / PCCARD_MEM_PAGE_SIZE ==
1397 pf->ccr_base / PCCARD_MEM_PAGE_SIZE)
1398 bus_space_write_1(pf->pf_ccrt, pf->pf_ccrh,
1399 offset % PCCARD_MEM_PAGE_SIZE, val);
1401 CARD_SET_MEMORY_OFFSET(brdev, child, pf->ccr_rid, offset,
1403 bus_space_write_1(pf->pf_ccrt, pf->pf_ccrh, offset, val);
1404 CARD_SET_MEMORY_OFFSET(brdev, child, pf->ccr_rid, pf->ccr_base,
1412 pccard_ccr_read_impl(device_t brdev, device_t child, uint32_t offset,
1415 struct pccard_ivar *devi = PCCARD_IVAR(child);
1417 *val = pccard_ccr_read(devi->pf, offset);
1418 DEVPRINTF((child, "ccr_read of %#x (%#x) is %#x\n", offset,
1419 devi->pf->pf_ccr_offset, *val));
1424 pccard_ccr_write_impl(device_t brdev, device_t child, uint32_t offset,
1427 struct pccard_ivar *devi = PCCARD_IVAR(child);
1428 struct pccard_function *pf = devi->pf;
1431 * Can't use pccard_ccr_write since client drivers may access
1432 * registers not contained in the 'mask' if they are non-standard.
1434 DEVPRINTF((child, "ccr_write of %#x to %#x (%#x)\n", val, offset,
1435 devi->pf->pf_ccr_offset));
1436 bus_space_write_1(pf->pf_ccrt, pf->pf_ccrh, pf->pf_ccr_offset + offset,
1442 static device_method_t pccard_methods[] = {
1443 /* Device interface */
1444 DEVMETHOD(device_probe, pccard_probe),
1445 DEVMETHOD(device_attach, pccard_attach),
1446 DEVMETHOD(device_detach, pccard_detach),
1447 DEVMETHOD(device_shutdown, bus_generic_shutdown),
1448 DEVMETHOD(device_suspend, pccard_suspend),
1449 DEVMETHOD(device_resume, pccard_resume),
1452 DEVMETHOD(bus_print_child, pccard_print_child),
1453 DEVMETHOD(bus_driver_added, pccard_driver_added),
1454 DEVMETHOD(bus_child_detached, pccard_child_detached),
1455 DEVMETHOD(bus_alloc_resource, pccard_alloc_resource),
1456 DEVMETHOD(bus_release_resource, pccard_release_resource),
1457 DEVMETHOD(bus_activate_resource, pccard_activate_resource),
1458 DEVMETHOD(bus_deactivate_resource, pccard_deactivate_resource),
1459 DEVMETHOD(bus_setup_intr, pccard_setup_intr),
1460 DEVMETHOD(bus_teardown_intr, pccard_teardown_intr),
1461 DEVMETHOD(bus_set_resource, pccard_set_resource),
1462 DEVMETHOD(bus_get_resource, pccard_get_resource),
1463 DEVMETHOD(bus_delete_resource, pccard_delete_resource),
1464 DEVMETHOD(bus_probe_nomatch, pccard_probe_nomatch),
1465 DEVMETHOD(bus_read_ivar, pccard_read_ivar),
1466 DEVMETHOD(bus_child_pnpinfo_str, pccard_child_pnpinfo_str),
1467 DEVMETHOD(bus_child_location_str, pccard_child_location_str),
1469 /* Card Interface */
1470 DEVMETHOD(card_set_res_flags, pccard_set_res_flags),
1471 DEVMETHOD(card_set_memory_offset, pccard_set_memory_offset),
1472 DEVMETHOD(card_attach_card, pccard_attach_card),
1473 DEVMETHOD(card_detach_card, pccard_detach_card),
1474 DEVMETHOD(card_do_product_lookup, pccard_do_product_lookup),
1475 DEVMETHOD(card_cis_scan, pccard_scan_cis),
1476 DEVMETHOD(card_attr_read, pccard_attr_read_impl),
1477 DEVMETHOD(card_attr_write, pccard_attr_write_impl),
1478 DEVMETHOD(card_ccr_read, pccard_ccr_read_impl),
1479 DEVMETHOD(card_ccr_write, pccard_ccr_write_impl),
1484 static driver_t pccard_driver = {
1487 sizeof(struct pccard_softc)
1490 devclass_t pccard_devclass;
1492 /* Maybe we need to have a slot device? */
1493 DRIVER_MODULE(pccard, pcic, pccard_driver, pccard_devclass, 0, 0);
1494 DRIVER_MODULE(pccard, cbb, pccard_driver, pccard_devclass, 0, 0);
1495 MODULE_VERSION(pccard, 1);