2 * Copyright (c) 2003 M. Warner Losh. All Rights Reserved.
3 * Copyright (c) 2000,2001 Jonathan Chen. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $FreeBSD: src/sys/dev/cardbus/cardbus.c,v 1.28 2002/11/27 17:30:41 imp Exp $
27 * $DragonFly: src/sys/dev/pccard/cardbus/cardbus.c,v 1.13 2008/01/11 10:53:46 sephe Exp $
33 * much of the bus code was stolen directly from sys/pci/pci.c
34 * (Copyright (c) 1997, Stefan Esser <se@freebsd.org>)
36 * Written by Jonathan Chen <jon@freebsd.org>
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/malloc.h>
42 #include <sys/module.h>
43 #include <sys/kernel.h>
44 #include <sys/sysctl.h>
49 #include <sys/pciio.h>
50 #include <bus/pci/pcivar.h>
51 #include <bus/pci/pcireg.h>
52 #include <bus/pci/pci_private.h>
54 #include <dev/pccard/cardbus/cardbusreg.h>
55 #include <dev/pccard/cardbus/cardbusvar.h>
56 #include <dev/pccard/cardbus/cardbus_cis.h>
57 #include <bus/pccard/pccard_cis.h>
58 #include <bus/pccard/pccardvar.h>
64 SYSCTL_NODE(_hw, OID_AUTO, cardbus, CTLFLAG_RD, 0, "CardBus parameters");
66 int cardbus_debug = 0;
67 TUNABLE_INT("hw.cardbus.debug", &cardbus_debug);
68 SYSCTL_INT(_hw_cardbus, OID_AUTO, debug, CTLFLAG_RW,
72 int cardbus_cis_debug = 0;
73 TUNABLE_INT("hw.cardbus.cis_debug", &cardbus_cis_debug);
74 SYSCTL_INT(_hw_cardbus, OID_AUTO, cis_debug, CTLFLAG_RW,
75 &cardbus_cis_debug, 0,
78 #define DPRINTF(a) if (cardbus_debug) kprintf a
79 #define DEVPRINTF(x) if (cardbus_debug) device_printf x
82 static void cardbus_add_map(device_t cbdev, device_t child, int reg);
83 static int cardbus_alloc_resources(device_t cbdev, device_t child);
84 static int cardbus_attach(device_t cbdev);
85 static int cardbus_attach_card(device_t cbdev);
86 static int cardbus_barsort(const void *a, const void *b);
87 static int cardbus_detach(device_t cbdev);
88 static int cardbus_detach_card(device_t cbdev);
89 static void cardbus_device_setup_regs(device_t brdev, int b, int s, int f,
91 static void cardbus_driver_added(device_t cbdev, driver_t *driver);
92 static void cardbus_pickup_maps(device_t cbdev, device_t child);
93 static int cardbus_probe(device_t cbdev);
94 static int cardbus_read_ivar(device_t cbdev, device_t child, int which,
96 static void cardbus_release_all_resources(device_t cbdev,
97 struct cardbus_devinfo *dinfo);
98 static int cardbus_write_ivar(device_t cbdev, device_t child, int which,
102 * Resource allocation
105 * Adding a memory/io resource (sans CIS)
109 cardbus_add_map(device_t cbdev, device_t child, int reg)
111 struct cardbus_devinfo *dinfo = device_get_ivars(child);
112 struct resource_list_entry *rle;
117 SLIST_FOREACH(rle, &dinfo->pci.resources, link) {
122 if (reg == CARDBUS_ROM_REG)
123 testval = CARDBUS_ROM_ADDRMASK;
127 pci_write_config(child, reg, testval, 4);
128 testval = pci_read_config(child, reg, 4);
130 if (testval == ~0 || testval == 0)
133 if ((testval & 1) == 0)
134 type = SYS_RES_MEMORY;
136 type = SYS_RES_IOPORT;
138 size = CARDBUS_MAPREG_MEM_SIZE(testval);
140 device_printf(cbdev, "Resource not specified in CIS: "
141 "id=%x, size=%x\n", reg, size);
143 resource_list_add(&dinfo->pci.resources, type, reg, 0UL, ~0UL, size);
147 cardbus_pickup_maps(device_t cbdev, device_t child)
149 struct cardbus_devinfo *dinfo = device_get_ivars(child);
153 * Try to pick up any resources that was not specified in CIS.
154 * Maybe this isn't any longer necessary now that we have fixed
155 * CIS parsing and we should filter things here? XXX
157 for (reg = 0; reg < dinfo->pci.cfg.nummaps; reg++)
158 cardbus_add_map(cbdev, child, PCIR_BAR(reg));
162 cardbus_do_res(struct resource_list_entry *rle, device_t child, uint32_t start)
165 rle->end = start + rle->count - 1;
166 pci_write_config(child, rle->rid, rle->start, 4);
170 cardbus_barsort(const void *a, const void *b)
172 return ((*(const struct resource_list_entry * const *)b)->count -
173 (*(const struct resource_list_entry * const *)a)->count);
176 /* XXX this function is too long */
178 cardbus_alloc_resources(device_t cbdev, device_t child)
180 struct cardbus_devinfo *dinfo = device_get_ivars(child);
182 struct resource_list_entry *rle;
183 struct resource_list_entry **barlist;
185 uint32_t mem_psize = 0, mem_nsize = 0, io_size = 0;
186 struct resource *res;
191 SLIST_FOREACH(rle, &dinfo->pci.resources, link) {
196 barlist = kmalloc(sizeof(struct resource_list_entry*) * count, M_DEVBUF,
199 SLIST_FOREACH(rle, &dinfo->pci.resources, link) {
200 barlist[count] = rle;
201 if (rle->type == SYS_RES_IOPORT) {
202 io_size += rle->count;
203 } else if (rle->type == SYS_RES_MEMORY) {
204 if (dinfo->mprefetchable & BARBIT(rle->rid))
205 mem_psize += rle->count;
207 mem_nsize += rle->count;
213 * We want to allocate the largest resource first, so that our
214 * allocated memory is packed.
216 kqsort(barlist, count, sizeof(struct resource_list_entry *),
219 /* Allocate prefetchable memory */
221 for (tmp = 0; tmp < count; tmp++) {
223 if (rle->res == NULL &&
224 rle->type == SYS_RES_MEMORY &&
225 dinfo->mprefetchable & BARBIT(rle->rid)) {
226 flags = rman_make_alignment_flags(rle->count);
230 if (flags > 0) { /* If any prefetchable memory is requested... */
232 * First we allocate one big space for all resources of this
233 * type. We do this because our parent, pccbb, needs to open
234 * a window to forward all addresses within the window, and
235 * it would be best if nobody else has resources allocated
237 * (XXX: Perhaps there might be a better way to do this?)
240 res = bus_alloc_resource(cbdev, SYS_RES_MEMORY, &rid, 0,
241 (dinfo->mprefetchable & dinfo->mbelow1mb)?0xFFFFF:~0UL,
245 "Can't get memory for prefetch mem\n");
246 kfree(barlist, M_DEVBUF);
249 start = rman_get_start(res);
250 end = rman_get_end(res);
251 DEVPRINTF((cbdev, "Prefetchable memory at %x-%x\n", start, end));
253 * Now that we know the region is free, release it and hand it
254 * out piece by piece.
256 bus_release_resource(cbdev, SYS_RES_MEMORY, rid, res);
257 for (tmp = 0; tmp < count; tmp++) {
259 if (rle->type == SYS_RES_MEMORY &&
260 dinfo->mprefetchable & BARBIT(rle->rid)) {
261 cardbus_do_res(rle, child, start);
267 /* Allocate non-prefetchable memory */
269 for (tmp = 0; tmp < count; tmp++) {
271 if (rle->type == SYS_RES_MEMORY &&
272 (dinfo->mprefetchable & BARBIT(rle->rid)) == 0) {
273 flags = rman_make_alignment_flags(rle->count);
277 if (flags > 0) { /* If any non-prefetchable memory is requested... */
279 * First we allocate one big space for all resources of this
280 * type. We do this because our parent, pccbb, needs to open
281 * a window to forward all addresses within the window, and
282 * it would be best if nobody else has resources allocated
284 * (XXX: Perhaps there might be a better way to do this?)
287 res = bus_alloc_resource(cbdev, SYS_RES_MEMORY, &rid, 0,
288 ((~dinfo->mprefetchable) & dinfo->mbelow1mb)?0xFFFFF:~0UL,
292 "Can't get memory for non-prefetch mem\n");
293 kfree(barlist, M_DEVBUF);
296 start = rman_get_start(res);
297 end = rman_get_end(res);
298 DEVPRINTF((cbdev, "Non-prefetchable memory at %x-%x\n",
301 * Now that we know the region is free, release it and hand it
302 * out piece by piece.
304 bus_release_resource(cbdev, SYS_RES_MEMORY, rid, res);
305 for (tmp = 0; tmp < count; tmp++) {
307 if (rle->type == SYS_RES_MEMORY &&
308 (dinfo->mprefetchable & BARBIT(rle->rid)) == 0) {
309 cardbus_do_res(rle, child, start);
315 /* Allocate IO ports */
317 for (tmp = 0; tmp < count; tmp++) {
319 if (rle->type == SYS_RES_IOPORT) {
320 flags = rman_make_alignment_flags(rle->count);
324 if (flags > 0) { /* If any IO port is requested... */
326 * First we allocate one big space for all resources of this
327 * type. We do this because our parent, pccbb, needs to open
328 * a window to forward all addresses within the window, and
329 * it would be best if nobody else has resources allocated
331 * (XXX: Perhaps there might be a better way to do this?)
334 res = bus_alloc_resource(cbdev, SYS_RES_IOPORT, &rid, 0,
335 (dinfo->ibelow1mb)?0xFFFFF:~0UL, io_size, flags);
338 "Can't get memory for IO ports\n");
339 kfree(barlist, M_DEVBUF);
342 start = rman_get_start(res);
343 end = rman_get_end(res);
344 DEVPRINTF((cbdev, "IO port at %x-%x\n", start, end));
346 * Now that we know the region is free, release it and hand it
347 * out piece by piece.
349 bus_release_resource(cbdev, SYS_RES_IOPORT, rid, res);
350 for (tmp = 0; tmp < count; tmp++) {
352 if (rle->type == SYS_RES_IOPORT) {
353 cardbus_do_res(rle, child, start);
361 res = bus_alloc_resource_any(cbdev, SYS_RES_IRQ, &rid, RF_SHAREABLE);
363 device_printf(cbdev, "Can't get memory for irq\n");
364 kfree(barlist, M_DEVBUF);
367 start = rman_get_start(res);
368 end = rman_get_end(res);
369 bus_release_resource(cbdev, SYS_RES_IRQ, rid, res);
370 resource_list_add(&dinfo->pci.resources, SYS_RES_IRQ, rid, start, end,
372 dinfo->pci.cfg.intline = start;
373 pci_write_config(child, PCIR_INTLINE, start, 1);
375 kfree(barlist, M_DEVBUF);
379 /************************************************************************/
381 /************************************************************************/
384 cardbus_probe(device_t cbdev)
386 device_set_desc(cbdev, "CardBus bus");
391 cardbus_attach(device_t cbdev)
397 cardbus_detach(device_t cbdev)
399 cardbus_detach_card(cbdev);
404 cardbus_suspend(device_t self)
406 cardbus_detach_card(self);
411 cardbus_resume(device_t self)
416 /************************************************************************/
417 /* Attach/Detach card */
418 /************************************************************************/
421 cardbus_device_setup_regs(device_t brdev, int b, int s, int f, pcicfgregs *cfg)
423 PCIB_WRITE_CONFIG(brdev, b, s, f, PCIR_INTLINE,
424 pci_get_irq(device_get_parent(brdev)), 1);
425 cfg->intline = PCIB_READ_CONFIG(brdev, b, s, f, PCIR_INTLINE, 1);
427 PCIB_WRITE_CONFIG(brdev, b, s, f, PCIR_CACHELNSZ, 0x08, 1);
428 cfg->cachelnsz = PCIB_READ_CONFIG(brdev, b, s, f, PCIR_CACHELNSZ, 1);
430 PCIB_WRITE_CONFIG(brdev, b, s, f, PCIR_LATTIMER, 0xa8, 1);
431 cfg->lattimer = PCIB_READ_CONFIG(brdev, b, s, f, PCIR_LATTIMER, 1);
433 PCIB_WRITE_CONFIG(brdev, b, s, f, PCIR_MINGNT, 0x14, 1);
434 cfg->mingnt = PCIB_READ_CONFIG(brdev, b, s, f, PCIR_MINGNT, 1);
436 PCIB_WRITE_CONFIG(brdev, b, s, f, PCIR_MAXLAT, 0x14, 1);
437 cfg->maxlat = PCIB_READ_CONFIG(brdev, b, s, f, PCIR_MAXLAT, 1);
441 cardbus_attach_card(device_t cbdev)
443 device_t brdev = device_get_parent(cbdev);
445 int cardattached = 0;
446 int bus, slot, func, domain;
448 cardbus_detach_card(cbdev); /* detach existing cards */
449 POWER_ENABLE_SOCKET(brdev, cbdev);
450 bus = pcib_get_bus(brdev);
451 domain = pcib_get_domain(brdev);
452 /* For each function, set it up and try to attach a driver to it */
453 for (slot = 0; slot <= CARDBUS_SLOTMAX; slot++) {
454 int cardbusfunchigh = 0;
455 for (func = 0; func <= cardbusfunchigh; func++) {
456 struct cardbus_devinfo *dinfo;
458 dinfo = (struct cardbus_devinfo *)
459 pci_read_device(brdev, domain, bus, slot, func,
460 sizeof(struct cardbus_devinfo));
463 if (dinfo->pci.cfg.mfdev)
464 cardbusfunchigh = CARDBUS_FUNCMAX;
466 cardbus_device_setup_regs(brdev, bus, slot, func,
468 child = device_add_child(cbdev, NULL, -1);
470 DEVPRINTF((cbdev, "Cannot add child!\n"));
471 pci_freecfg((struct pci_devinfo *)dinfo);
474 dinfo->pci.cfg.dev = child;
475 resource_list_init(&dinfo->pci.resources);
476 device_set_ivars(child, dinfo);
477 if (cardbus_do_cis(cbdev, child) != 0) {
478 DEVPRINTF((cbdev, "Can't parse cis\n"));
479 pci_freecfg((struct pci_devinfo *)dinfo);
482 cardbus_pickup_maps(cbdev, child);
483 cardbus_alloc_resources(cbdev, child);
484 pci_print_verbose(&dinfo->pci);
485 if (device_probe_and_attach(child) != 0)
486 cardbus_release_all_resources(cbdev, dinfo);
492 if (cardattached > 0)
494 POWER_DISABLE_SOCKET(brdev, cbdev);
499 cardbus_detach_card(device_t cbdev)
506 device_get_children(cbdev, &devlist, &numdevs);
509 kfree(devlist, M_TEMP);
513 for (tmp = 0; tmp < numdevs; tmp++) {
514 struct cardbus_devinfo *dinfo = device_get_ivars(devlist[tmp]);
515 int status = device_get_state(devlist[tmp]);
517 if (dinfo->pci.cfg.dev != devlist[tmp])
518 device_printf(cbdev, "devinfo dev mismatch\n");
519 if (status == DS_ATTACHED || status == DS_BUSY)
520 device_detach(devlist[tmp]);
521 cardbus_release_all_resources(cbdev, dinfo);
522 device_delete_child(cbdev, devlist[tmp]);
523 pci_freecfg((struct pci_devinfo *)dinfo);
525 POWER_DISABLE_SOCKET(device_get_parent(cbdev), cbdev);
526 kfree(devlist, M_TEMP);
531 cardbus_driver_added(device_t cbdev, driver_t *driver)
537 struct cardbus_devinfo *dinfo;
539 DEVICE_IDENTIFY(driver, cbdev);
540 device_get_children(cbdev, &devlist, &numdevs);
542 * If there are no drivers attached, but there are children,
543 * then power the card up.
545 for (i = 0; i < numdevs; i++) {
547 if (device_get_state(dev) != DS_NOTPRESENT)
550 if (i > 0 && i == numdevs)
551 POWER_ENABLE_SOCKET(device_get_parent(cbdev), cbdev);
552 for (i = 0; i < numdevs; i++) {
554 if (device_get_state(dev) != DS_NOTPRESENT)
556 dinfo = device_get_ivars(dev);
557 pci_print_verbose(&dinfo->pci);
558 resource_list_init(&dinfo->pci.resources);
559 cardbus_do_cis(cbdev, dev);
560 cardbus_pickup_maps(cbdev, dev);
561 cardbus_alloc_resources(cbdev, dev);
562 if (device_probe_and_attach(dev) != 0)
563 cardbus_release_all_resources(cbdev, dinfo);
565 kfree(devlist, M_TEMP);
569 cardbus_release_all_resources(device_t cbdev, struct cardbus_devinfo *dinfo)
571 struct resource_list_entry *rle;
573 /* Free all allocated resources */
574 SLIST_FOREACH(rle, &dinfo->pci.resources, link) {
576 if (rman_get_device(rle->res) != cbdev)
577 device_printf(cbdev, "release_all_resource: "
578 "Resource still owned by child, oops. "
579 "(type=%d, rid=%d, addr=%lx)\n",
581 rman_get_start(rle->res));
582 BUS_RELEASE_RESOURCE(device_get_parent(cbdev),
583 cbdev, rle->type, rle->rid, rle->res);
586 * zero out config so the card won't acknowledge
587 * access to the space anymore
589 pci_write_config(dinfo->pci.cfg.dev, rle->rid, 0, 4);
592 resource_list_free(&dinfo->pci.resources);
595 /************************************************************************/
596 /* Other Bus Methods */
597 /************************************************************************/
600 cardbus_read_ivar(device_t cbdev, device_t child, int which, uintptr_t *result)
602 struct cardbus_devinfo *dinfo;
605 dinfo = device_get_ivars(child);
606 cfg = &dinfo->pci.cfg;
609 case PCI_IVAR_ETHADDR:
611 * The generic accessor doesn't deal with failure, so
612 * we set the return value, then return an error.
614 if (dinfo->fepresent & (1 << PCCARD_TPLFE_TYPE_LAN_NID)) {
615 *((uint8_t **) result) = dinfo->funce.lan.nid;
618 *((uint8_t **) result) = NULL;
621 return (pci_read_ivar(cbdev, child, which, result));
627 cardbus_write_ivar(device_t cbdev, device_t child, int which, uintptr_t value)
629 return(pci_write_ivar(cbdev, child, which, value));
632 static device_method_t cardbus_methods[] = {
633 /* Device interface */
634 DEVMETHOD(device_probe, cardbus_probe),
635 DEVMETHOD(device_attach, cardbus_attach),
636 DEVMETHOD(device_detach, cardbus_detach),
637 DEVMETHOD(device_suspend, cardbus_suspend),
638 DEVMETHOD(device_resume, cardbus_resume),
641 DEVMETHOD(bus_read_ivar, cardbus_read_ivar),
642 DEVMETHOD(bus_write_ivar, cardbus_write_ivar),
643 DEVMETHOD(bus_driver_added, cardbus_driver_added),
646 DEVMETHOD(card_attach_card, cardbus_attach_card),
647 DEVMETHOD(card_detach_card, cardbus_detach_card),
652 DEFINE_CLASS_1(cardbus, cardbus_driver, cardbus_methods, 0, pci_driver);
654 static devclass_t cardbus_devclass;
656 DRIVER_MODULE(cardbus, cbb, cardbus_driver, cardbus_devclass, 0, 0);
657 MODULE_VERSION(cardbus, 1);