2 * Copyright (c) 2005 John Baldwin <jhb@FreeBSD.org>
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
31 * Simple driver for PCI VGA display devices. Drivers such as agp(4) and
32 * drm(4) should attach as children of this device.
34 * XXX: The vgapci name is a hack until we somehow merge the isa vga driver
38 #include <sys/param.h>
40 #include <sys/kernel.h>
41 #include <sys/module.h>
43 #include <sys/sysctl.h>
44 #include <sys/systm.h>
46 #if defined(__amd64__) || defined(__i386__) || defined(__ia64__)
51 #include <dev/pci/pcireg.h>
52 #include <dev/pci/pcivar.h>
55 struct resource *vr_res;
59 struct vga_pci_softc {
60 device_t vga_msi_child; /* Child driver using MSI. */
61 struct vga_resource vga_bars[PCIR_MAX_BAR_0 + 1];
62 struct vga_resource vga_bios;
67 static struct vga_resource *lookup_res(struct vga_pci_softc *sc, int rid);
68 static struct resource *vga_pci_alloc_resource(device_t dev, device_t child,
69 int type, int *rid, u_long start, u_long end, u_long count, u_int flags);
70 static int vga_pci_release_resource(device_t dev, device_t child, int type,
71 int rid, struct resource *r);
73 int vga_pci_default_unit = -1;
74 TUNABLE_INT("hw.pci.default_vgapci_unit", &vga_pci_default_unit);
75 SYSCTL_INT(_hw_pci, OID_AUTO, default_vgapci_unit, CTLFLAG_RDTUN,
76 &vga_pci_default_unit, -1, "Default VGA-compatible display");
79 vga_pci_is_boot_display(device_t dev)
85 /* Check that the given device is a video card */
86 if ((pci_get_class(dev) != PCIC_DISPLAY &&
87 (pci_get_class(dev) != PCIC_OLD ||
88 pci_get_subclass(dev) != PCIS_OLD_VGA)))
91 unit = device_get_unit(dev);
93 if (vga_pci_default_unit >= 0) {
95 * The boot display device was determined by a previous
96 * call to this function, or the user forced it using
97 * the hw.pci.default_vgapci_unit tunable.
99 return (vga_pci_default_unit == unit);
103 * The primary video card used as a boot display must have the
104 * "I/O" and "Memory Address Space Decoding" bits set in its
107 * Furthermore, if the card is attached to a bridge, instead of
108 * the root PCI bus, the bridge must have the "VGA Enable" bit
109 * set in its Control register.
112 pcib = device_get_parent(device_get_parent(dev));
113 if (device_get_devclass(device_get_parent(pcib)) ==
114 devclass_find("pci")) {
116 * The parent bridge is a PCI-to-PCI bridge: check the
117 * value of the "VGA Enable" bit.
119 config = pci_read_config(pcib, PCIR_BRIDGECTL_1, 2);
120 if ((config & PCIB_BCR_VGA_ENABLE) == 0)
124 config = pci_read_config(dev, PCIR_COMMAND, 2);
125 if ((config & (PCIM_CMD_PORTEN | PCIM_CMD_MEMEN)) == 0)
128 /* This video card is the boot display: record its unit number. */
129 vga_pci_default_unit = unit;
130 device_set_flags(dev, 1);
136 vga_pci_map_bios(device_t dev, size_t *size)
139 struct resource *res;
141 #if defined(__amd64__) || defined(__i386__) || defined(__ia64__)
142 if (vga_pci_is_boot_display(dev)) {
144 * On x86, the System BIOS copy the default display
145 * device's Video BIOS at a fixed location in system
146 * memory (0xC0000, 128 kBytes long) at boot time.
148 * We use this copy for the default boot device, because
149 * the original ROM may not be valid after boot.
152 *size = VGA_PCI_BIOS_SHADOW_SIZE;
153 return (pmap_mapbios(VGA_PCI_BIOS_SHADOW_ADDR, *size));
158 res = vga_pci_alloc_resource(dev, NULL, SYS_RES_MEMORY, &rid, 0ul,
164 *size = rman_get_size(res);
165 return (rman_get_virtual(res));
169 vga_pci_unmap_bios(device_t dev, void *bios)
171 struct vga_resource *vr;
177 #if defined(__amd64__) || defined(__i386__) || defined(__ia64__)
178 if (vga_pci_is_boot_display(dev)) {
179 /* We mapped the BIOS shadow copy located at 0xC0000. */
180 pmap_unmapdev((vm_offset_t)bios, VGA_PCI_BIOS_SHADOW_SIZE);
187 * Look up the PCIR_BIOS resource in our softc. It should match
188 * the address we returned previously.
190 vr = lookup_res(device_get_softc(dev), PCIR_BIOS);
191 KASSERT(vr->vr_res != NULL, ("vga_pci_unmap_bios: bios not mapped"));
192 KASSERT(rman_get_virtual(vr->vr_res) == bios,
193 ("vga_pci_unmap_bios: mismatch"));
194 vga_pci_release_resource(dev, NULL, SYS_RES_MEMORY, PCIR_BIOS,
199 vga_pci_probe(device_t dev)
202 switch (pci_get_class(dev)) {
206 if (pci_get_subclass(dev) != PCIS_OLD_VGA)
213 /* Probe default display. */
214 vga_pci_is_boot_display(dev);
216 device_set_desc(dev, "VGA-compatible display");
217 return (BUS_PROBE_GENERIC);
221 vga_pci_attach(device_t dev)
224 bus_generic_probe(dev);
226 /* Always create a drm child for now to make it easier on drm. */
227 device_add_child(dev, "drm", -1);
228 device_add_child(dev, "drmn", -1);
229 bus_generic_attach(dev);
231 if (vga_pci_is_boot_display(dev))
232 device_printf(dev, "Boot video device\n");
238 vga_pci_suspend(device_t dev)
241 return (bus_generic_suspend(dev));
245 vga_pci_resume(device_t dev)
248 return (bus_generic_resume(dev));
254 vga_pci_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
257 return (BUS_READ_IVAR(device_get_parent(dev), dev, which, result));
261 vga_pci_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
268 vga_pci_setup_intr(device_t dev, device_t child, struct resource *irq,
269 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
272 return (BUS_SETUP_INTR(device_get_parent(dev), dev, irq, flags,
273 filter, intr, arg, cookiep));
277 vga_pci_teardown_intr(device_t dev, device_t child, struct resource *irq,
280 return (BUS_TEARDOWN_INTR(device_get_parent(dev), dev, irq, cookie));
283 static struct vga_resource *
284 lookup_res(struct vga_pci_softc *sc, int rid)
288 if (rid == PCIR_BIOS)
289 return (&sc->vga_bios);
290 bar = PCI_RID2BAR(rid);
291 if (bar >= 0 && bar <= PCIR_MAX_BAR_0)
292 return (&sc->vga_bars[bar]);
296 static struct resource *
297 vga_pci_alloc_resource(device_t dev, device_t child, int type, int *rid,
298 u_long start, u_long end, u_long count, u_int flags)
300 struct vga_resource *vr;
306 * For BARs, we cache the resource so that we only allocate it
307 * from the PCI bus once.
309 vr = lookup_res(device_get_softc(dev), *rid);
312 if (vr->vr_res == NULL)
313 vr->vr_res = bus_alloc_resource(dev, type, rid, start,
315 if (vr->vr_res != NULL)
319 return (bus_alloc_resource(dev, type, rid, start, end, count, flags));
323 vga_pci_release_resource(device_t dev, device_t child, int type, int rid,
326 struct vga_resource *vr;
333 * For BARs, we release the resource from the PCI bus
334 * when the last child reference goes away.
336 vr = lookup_res(device_get_softc(dev), rid);
339 if (vr->vr_res == NULL)
341 KASSERT(vr->vr_res == r, ("vga_pci resource mismatch"));
342 if (vr->vr_refs > 1) {
346 KASSERT(vr->vr_refs > 0,
347 ("vga_pci resource reference count underflow"));
348 error = bus_release_resource(dev, type, rid, r);
356 return (bus_release_resource(dev, type, rid, r));
362 vga_pci_read_config(device_t dev, device_t child, int reg, int width)
365 return (pci_read_config(dev, reg, width));
369 vga_pci_write_config(device_t dev, device_t child, int reg,
370 uint32_t val, int width)
373 pci_write_config(dev, reg, val, width);
377 vga_pci_enable_busmaster(device_t dev, device_t child)
380 return (pci_enable_busmaster(dev));
384 vga_pci_disable_busmaster(device_t dev, device_t child)
387 return (pci_disable_busmaster(dev));
391 vga_pci_enable_io(device_t dev, device_t child, int space)
394 device_printf(dev, "child %s requested pci_enable_io\n",
395 device_get_nameunit(child));
396 return (pci_enable_io(dev, space));
400 vga_pci_disable_io(device_t dev, device_t child, int space)
403 device_printf(dev, "child %s requested pci_disable_io\n",
404 device_get_nameunit(child));
405 return (pci_disable_io(dev, space));
409 vga_pci_get_vpd_ident(device_t dev, device_t child, const char **identptr)
412 return (pci_get_vpd_ident(dev, identptr));
416 vga_pci_get_vpd_readonly(device_t dev, device_t child, const char *kw,
420 return (pci_get_vpd_readonly(dev, kw, vptr));
424 vga_pci_set_powerstate(device_t dev, device_t child, int state)
427 device_printf(dev, "child %s requested pci_set_powerstate\n",
428 device_get_nameunit(child));
429 return (pci_set_powerstate(dev, state));
433 vga_pci_get_powerstate(device_t dev, device_t child)
436 device_printf(dev, "child %s requested pci_get_powerstate\n",
437 device_get_nameunit(child));
438 return (pci_get_powerstate(dev));
442 vga_pci_assign_interrupt(device_t dev, device_t child)
445 device_printf(dev, "child %s requested pci_assign_interrupt\n",
446 device_get_nameunit(child));
447 return (PCI_ASSIGN_INTERRUPT(device_get_parent(dev), dev));
451 vga_pci_find_cap(device_t dev, device_t child, int capability,
455 return (pci_find_cap(dev, capability, capreg));
459 vga_pci_find_extcap(device_t dev, device_t child, int capability,
463 return (pci_find_extcap(dev, capability, capreg));
467 vga_pci_find_htcap(device_t dev, device_t child, int capability,
471 return (pci_find_htcap(dev, capability, capreg));
475 vga_pci_alloc_msi(device_t dev, device_t child, int *count)
477 struct vga_pci_softc *sc;
480 sc = device_get_softc(dev);
481 if (sc->vga_msi_child != NULL)
483 error = pci_alloc_msi(dev, count);
485 sc->vga_msi_child = child;
490 vga_pci_alloc_msix(device_t dev, device_t child, int *count)
492 struct vga_pci_softc *sc;
495 sc = device_get_softc(dev);
496 if (sc->vga_msi_child != NULL)
498 error = pci_alloc_msix(dev, count);
500 sc->vga_msi_child = child;
505 vga_pci_remap_msix(device_t dev, device_t child, int count,
506 const u_int *vectors)
508 struct vga_pci_softc *sc;
510 sc = device_get_softc(dev);
511 if (sc->vga_msi_child != child)
513 return (pci_remap_msix(dev, count, vectors));
517 vga_pci_release_msi(device_t dev, device_t child)
519 struct vga_pci_softc *sc;
522 sc = device_get_softc(dev);
523 if (sc->vga_msi_child != child)
525 error = pci_release_msi(dev);
527 sc->vga_msi_child = NULL;
532 vga_pci_msi_count(device_t dev, device_t child)
535 return (pci_msi_count(dev));
539 vga_pci_msix_count(device_t dev, device_t child)
542 return (pci_msix_count(dev));
546 vga_pci_get_dma_tag(device_t bus, device_t child)
549 return (bus_get_dma_tag(bus));
552 static device_method_t vga_pci_methods[] = {
553 /* Device interface */
554 DEVMETHOD(device_probe, vga_pci_probe),
555 DEVMETHOD(device_attach, vga_pci_attach),
556 DEVMETHOD(device_shutdown, bus_generic_shutdown),
557 DEVMETHOD(device_suspend, vga_pci_suspend),
558 DEVMETHOD(device_resume, vga_pci_resume),
561 DEVMETHOD(bus_read_ivar, vga_pci_read_ivar),
562 DEVMETHOD(bus_write_ivar, vga_pci_write_ivar),
563 DEVMETHOD(bus_setup_intr, vga_pci_setup_intr),
564 DEVMETHOD(bus_teardown_intr, vga_pci_teardown_intr),
565 DEVMETHOD(bus_alloc_resource, vga_pci_alloc_resource),
566 DEVMETHOD(bus_release_resource, vga_pci_release_resource),
567 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
568 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
569 DEVMETHOD(bus_get_dma_tag, vga_pci_get_dma_tag),
572 DEVMETHOD(pci_read_config, vga_pci_read_config),
573 DEVMETHOD(pci_write_config, vga_pci_write_config),
574 DEVMETHOD(pci_enable_busmaster, vga_pci_enable_busmaster),
575 DEVMETHOD(pci_disable_busmaster, vga_pci_disable_busmaster),
576 DEVMETHOD(pci_enable_io, vga_pci_enable_io),
577 DEVMETHOD(pci_disable_io, vga_pci_disable_io),
578 DEVMETHOD(pci_get_vpd_ident, vga_pci_get_vpd_ident),
579 DEVMETHOD(pci_get_vpd_readonly, vga_pci_get_vpd_readonly),
580 DEVMETHOD(pci_get_powerstate, vga_pci_get_powerstate),
581 DEVMETHOD(pci_set_powerstate, vga_pci_set_powerstate),
582 DEVMETHOD(pci_assign_interrupt, vga_pci_assign_interrupt),
583 DEVMETHOD(pci_find_cap, vga_pci_find_cap),
584 DEVMETHOD(pci_find_extcap, vga_pci_find_extcap),
585 DEVMETHOD(pci_find_htcap, vga_pci_find_htcap),
586 DEVMETHOD(pci_alloc_msi, vga_pci_alloc_msi),
587 DEVMETHOD(pci_alloc_msix, vga_pci_alloc_msix),
588 DEVMETHOD(pci_remap_msix, vga_pci_remap_msix),
589 DEVMETHOD(pci_release_msi, vga_pci_release_msi),
590 DEVMETHOD(pci_msi_count, vga_pci_msi_count),
591 DEVMETHOD(pci_msix_count, vga_pci_msix_count),
596 static driver_t vga_pci_driver = {
599 sizeof(struct vga_pci_softc),
602 static devclass_t vga_devclass;
604 DRIVER_MODULE(vgapci, pci, vga_pci_driver, vga_devclass, 0, 0);