2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2005 John Baldwin <jhb@FreeBSD.org>
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.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
32 * Simple driver for PCI VGA display devices. Drivers such as agp(4) and
33 * drm(4) should attach as children of this device.
35 * XXX: The vgapci name is a hack until we somehow merge the isa vga driver
39 #include <sys/param.h>
41 #include <sys/kernel.h>
42 #include <sys/module.h>
44 #include <sys/sysctl.h>
45 #include <sys/systm.h>
47 #if defined(__amd64__) || defined(__i386__)
52 #include <dev/pci/pcireg.h>
53 #include <dev/pci/pcivar.h>
55 #include <compat/x86bios/x86bios.h> /* To re-POST the card. */
58 struct resource *vr_res;
62 struct vga_pci_softc {
63 device_t vga_msi_child; /* Child driver using MSI. */
64 struct vga_resource vga_bars[PCIR_MAX_BAR_0 + 1];
65 struct vga_resource vga_bios;
70 static struct vga_resource *lookup_res(struct vga_pci_softc *sc, int rid);
71 static struct resource *vga_pci_alloc_resource(device_t dev, device_t child,
72 int type, int *rid, rman_res_t start, rman_res_t end, rman_res_t count,
74 static int vga_pci_release_resource(device_t dev, device_t child, int type,
75 int rid, struct resource *r);
77 int vga_pci_default_unit = -1;
78 SYSCTL_INT(_hw_pci, OID_AUTO, default_vgapci_unit, CTLFLAG_RDTUN,
79 &vga_pci_default_unit, -1, "Default VGA-compatible display");
82 vga_pci_is_boot_display(device_t dev)
88 /* Check that the given device is a video card */
89 if ((pci_get_class(dev) != PCIC_DISPLAY &&
90 (pci_get_class(dev) != PCIC_OLD ||
91 pci_get_subclass(dev) != PCIS_OLD_VGA)))
94 unit = device_get_unit(dev);
96 if (vga_pci_default_unit >= 0) {
98 * The boot display device was determined by a previous
99 * call to this function, or the user forced it using
100 * the hw.pci.default_vgapci_unit tunable.
102 return (vga_pci_default_unit == unit);
106 * The primary video card used as a boot display must have the
107 * "I/O" and "Memory Address Space Decoding" bits set in its
110 * Furthermore, if the card is attached to a bridge, instead of
111 * the root PCI bus, the bridge must have the "VGA Enable" bit
112 * set in its Control register.
115 pcib = device_get_parent(device_get_parent(dev));
116 if (device_get_devclass(device_get_parent(pcib)) ==
117 devclass_find("pci")) {
119 * The parent bridge is a PCI-to-PCI bridge: check the
120 * value of the "VGA Enable" bit.
122 config = pci_read_config(pcib, PCIR_BRIDGECTL_1, 2);
123 if ((config & PCIB_BCR_VGA_ENABLE) == 0)
127 config = pci_read_config(dev, PCIR_COMMAND, 2);
128 if ((config & (PCIM_CMD_PORTEN | PCIM_CMD_MEMEN)) == 0)
132 * Disable interrupts until a chipset driver is loaded for
133 * this PCI device. Else unhandled display adapter interrupts
134 * might freeze the CPU.
136 pci_write_config(dev, PCIR_COMMAND, config | PCIM_CMD_INTxDIS, 2);
138 /* This video card is the boot display: record its unit number. */
139 vga_pci_default_unit = unit;
140 device_set_flags(dev, 1);
146 vga_pci_reset(device_t dev)
150 * FLR is unsupported on GPUs so attempt a power-management reset by cycling
151 * the device in/out of D3 state.
152 * PCI spec says we can only go into D3 state from D0 state.
153 * Transition from D[12] into D0 before going to D3 state.
155 ps = pci_get_powerstate(dev);
156 if (ps != PCI_POWERSTATE_D0 && ps != PCI_POWERSTATE_D3)
157 pci_set_powerstate(dev, PCI_POWERSTATE_D0);
158 if (pci_get_powerstate(dev) != PCI_POWERSTATE_D3)
159 pci_set_powerstate(dev, PCI_POWERSTATE_D3);
160 pci_set_powerstate(dev, ps);
164 vga_pci_map_bios(device_t dev, size_t *size)
166 struct vga_resource *vr;
167 struct resource *res;
171 volatile unsigned char *bios;
174 #if defined(__amd64__) || defined(__i386__)
175 if (vga_pci_is_boot_display(dev)) {
177 * On x86, the System BIOS copy the default display
178 * device's Video BIOS at a fixed location in system
179 * memory (0xC0000, 128 kBytes long) at boot time.
181 * We use this copy for the default boot device, because
182 * the original ROM may not be valid after boot.
185 *size = VGA_PCI_BIOS_SHADOW_SIZE;
186 return (pmap_mapbios(VGA_PCI_BIOS_SHADOW_ADDR, *size));
190 pcib = device_get_parent(device_get_parent(dev));
191 if (device_get_devclass(device_get_parent(pcib)) ==
192 devclass_find("pci")) {
194 * The parent bridge is a PCI-to-PCI bridge: check the
195 * value of the "VGA Enable" bit.
197 config = pci_read_config(pcib, PCIR_BRIDGECTL_1, 2);
198 if ((config & PCIB_BCR_VGA_ENABLE) == 0) {
199 config |= PCIB_BCR_VGA_ENABLE;
200 pci_write_config(pcib, PCIR_BRIDGECTL_1, config, 2);
204 switch(pci_read_config(dev, PCIR_HDRTYPE, 1)) {
205 case PCIM_HDRTYPE_BRIDGE:
208 case PCIM_HDRTYPE_CARDBUS:
217 res = vga_pci_alloc_resource(dev, NULL, SYS_RES_MEMORY, &rid, 0,
221 device_printf(dev, "vga_pci_alloc_resource failed\n");
224 bios = rman_get_virtual(res);
225 *size = rman_get_size(res);
226 for (found = i = 0; i < hz; i++) {
227 found = (bios[0] == 0x55 && bios[1] == 0xaa);
233 return (__DEVOLATILE(void *, bios));
235 device_printf(dev, "initial ROM mapping failed -- resetting\n");
241 rom_addr = pci_read_config(dev, rid, 4);
243 rom_addr |= rman_get_start(res) | 0x1;
244 pci_write_config(dev, rid, rom_addr, 4);
245 vr = lookup_res(device_get_softc(dev), rid);
246 vga_pci_release_resource(dev, NULL, SYS_RES_MEMORY, rid,
252 res = vga_pci_alloc_resource(dev, NULL, SYS_RES_MEMORY, &rid, 0,
255 device_printf(dev, "vga_pci_alloc_resource failed\n");
258 bios = rman_get_virtual(res);
259 *size = rman_get_size(res);
260 for (found = i = 0; i < 3*hz; i++) {
261 found = (bios[0] == 0x55 && bios[1] == 0xaa);
267 return (__DEVOLATILE(void *, bios));
268 device_printf(dev, "ROM mapping failed\n");
269 vr = lookup_res(device_get_softc(dev), rid);
270 vga_pci_release_resource(dev, NULL, SYS_RES_MEMORY, rid,
276 vga_pci_unmap_bios(device_t dev, void *bios)
278 struct vga_resource *vr;
285 #if defined(__amd64__) || defined(__i386__)
286 if (vga_pci_is_boot_display(dev)) {
287 /* We mapped the BIOS shadow copy located at 0xC0000. */
288 pmap_unmapdev((vm_offset_t)bios, VGA_PCI_BIOS_SHADOW_SIZE);
293 switch(pci_read_config(dev, PCIR_HDRTYPE, 1)) {
294 case PCIM_HDRTYPE_BRIDGE:
297 case PCIM_HDRTYPE_CARDBUS:
307 * Look up the PCIR_BIOS resource in our softc. It should match
308 * the address we returned previously.
310 vr = lookup_res(device_get_softc(dev), rid);
311 KASSERT(vr->vr_res != NULL, ("vga_pci_unmap_bios: bios not mapped"));
312 KASSERT(rman_get_virtual(vr->vr_res) == bios,
313 ("vga_pci_unmap_bios: mismatch"));
314 vga_pci_release_resource(dev, NULL, SYS_RES_MEMORY, rid,
319 vga_pci_repost(device_t dev)
321 #if defined(__amd64__) || defined(__i386__)
324 if (!vga_pci_is_boot_display(dev))
327 if (x86bios_get_orm(VGA_PCI_BIOS_SHADOW_ADDR) == NULL)
330 x86bios_init_regs(®s);
332 regs.R_AH = pci_get_bus(dev);
333 regs.R_AL = (pci_get_slot(dev) << 3) | (pci_get_function(dev) & 0x07);
336 device_printf(dev, "REPOSTing\n");
337 x86bios_call(®s, X86BIOS_PHYSTOSEG(VGA_PCI_BIOS_SHADOW_ADDR + 3),
338 X86BIOS_PHYSTOOFF(VGA_PCI_BIOS_SHADOW_ADDR + 3));
340 x86bios_get_intr(0x10);
349 vga_pci_probe(device_t dev)
352 switch (pci_get_class(dev)) {
356 if (pci_get_subclass(dev) != PCIS_OLD_VGA)
363 /* Probe default display. */
364 vga_pci_is_boot_display(dev);
366 device_set_desc(dev, "VGA-compatible display");
367 return (BUS_PROBE_GENERIC);
371 vga_pci_attach(device_t dev)
374 bus_generic_probe(dev);
376 /* Always create a drm child for now to make it easier on drm. */
377 device_add_child(dev, "drm", -1);
378 device_add_child(dev, "drmn", -1);
379 bus_generic_attach(dev);
381 if (vga_pci_is_boot_display(dev))
382 device_printf(dev, "Boot video device\n");
388 vga_pci_suspend(device_t dev)
391 return (bus_generic_suspend(dev));
395 vga_pci_detach(device_t dev)
399 error = bus_generic_detach(dev);
401 error = device_delete_children(dev);
406 vga_pci_resume(device_t dev)
409 return (bus_generic_resume(dev));
415 vga_pci_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
418 return (BUS_READ_IVAR(device_get_parent(dev), dev, which, result));
422 vga_pci_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
429 vga_pci_setup_intr(device_t dev, device_t child, struct resource *irq,
430 int flags, driver_filter_t *filter, driver_intr_t *intr, void *arg,
433 return (BUS_SETUP_INTR(device_get_parent(dev), dev, irq, flags,
434 filter, intr, arg, cookiep));
438 vga_pci_teardown_intr(device_t dev, device_t child, struct resource *irq,
441 return (BUS_TEARDOWN_INTR(device_get_parent(dev), dev, irq, cookie));
444 static struct vga_resource *
445 lookup_res(struct vga_pci_softc *sc, int rid)
449 if (rid == PCIR_BIOS)
450 return (&sc->vga_bios);
451 bar = PCI_RID2BAR(rid);
452 if (bar >= 0 && bar <= PCIR_MAX_BAR_0)
453 return (&sc->vga_bars[bar]);
457 static struct resource *
458 vga_pci_alloc_resource(device_t dev, device_t child, int type, int *rid,
459 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
461 struct vga_resource *vr;
467 * For BARs, we cache the resource so that we only allocate it
468 * from the PCI bus once.
470 vr = lookup_res(device_get_softc(dev), *rid);
473 if (vr->vr_res == NULL)
474 vr->vr_res = bus_alloc_resource(dev, type, rid, start,
476 if (vr->vr_res != NULL)
480 return (bus_alloc_resource(dev, type, rid, start, end, count, flags));
484 vga_pci_release_resource(device_t dev, device_t child, int type, int rid,
487 struct vga_resource *vr;
494 * For BARs, we release the resource from the PCI bus
495 * when the last child reference goes away.
497 vr = lookup_res(device_get_softc(dev), rid);
500 if (vr->vr_res == NULL)
502 KASSERT(vr->vr_res == r, ("vga_pci resource mismatch"));
503 if (vr->vr_refs > 1) {
507 KASSERT(vr->vr_refs > 0,
508 ("vga_pci resource reference count underflow"));
509 error = bus_release_resource(dev, type, rid, r);
517 return (bus_release_resource(dev, type, rid, r));
523 vga_pci_read_config(device_t dev, device_t child, int reg, int width)
526 return (pci_read_config(dev, reg, width));
530 vga_pci_write_config(device_t dev, device_t child, int reg,
531 uint32_t val, int width)
534 pci_write_config(dev, reg, val, width);
538 vga_pci_enable_busmaster(device_t dev, device_t child)
541 return (pci_enable_busmaster(dev));
545 vga_pci_disable_busmaster(device_t dev, device_t child)
548 return (pci_disable_busmaster(dev));
552 vga_pci_enable_io(device_t dev, device_t child, int space)
555 device_printf(dev, "child %s requested pci_enable_io\n",
556 device_get_nameunit(child));
557 return (pci_enable_io(dev, space));
561 vga_pci_disable_io(device_t dev, device_t child, int space)
564 device_printf(dev, "child %s requested pci_disable_io\n",
565 device_get_nameunit(child));
566 return (pci_disable_io(dev, space));
570 vga_pci_get_vpd_ident(device_t dev, device_t child, const char **identptr)
573 return (pci_get_vpd_ident(dev, identptr));
577 vga_pci_get_vpd_readonly(device_t dev, device_t child, const char *kw,
581 return (pci_get_vpd_readonly(dev, kw, vptr));
585 vga_pci_set_powerstate(device_t dev, device_t child, int state)
588 device_printf(dev, "child %s requested pci_set_powerstate\n",
589 device_get_nameunit(child));
590 return (pci_set_powerstate(dev, state));
594 vga_pci_get_powerstate(device_t dev, device_t child)
597 device_printf(dev, "child %s requested pci_get_powerstate\n",
598 device_get_nameunit(child));
599 return (pci_get_powerstate(dev));
603 vga_pci_assign_interrupt(device_t dev, device_t child)
606 device_printf(dev, "child %s requested pci_assign_interrupt\n",
607 device_get_nameunit(child));
608 return (PCI_ASSIGN_INTERRUPT(device_get_parent(dev), dev));
612 vga_pci_find_cap(device_t dev, device_t child, int capability,
616 return (pci_find_cap(dev, capability, capreg));
620 vga_pci_find_next_cap(device_t dev, device_t child, int capability,
621 int start, int *capreg)
624 return (pci_find_next_cap(dev, capability, start, capreg));
628 vga_pci_find_extcap(device_t dev, device_t child, int capability,
632 return (pci_find_extcap(dev, capability, capreg));
636 vga_pci_find_next_extcap(device_t dev, device_t child, int capability,
637 int start, int *capreg)
640 return (pci_find_next_extcap(dev, capability, start, capreg));
644 vga_pci_find_htcap(device_t dev, device_t child, int capability,
648 return (pci_find_htcap(dev, capability, capreg));
652 vga_pci_find_next_htcap(device_t dev, device_t child, int capability,
653 int start, int *capreg)
656 return (pci_find_next_htcap(dev, capability, start, capreg));
660 vga_pci_alloc_msi(device_t dev, device_t child, int *count)
662 struct vga_pci_softc *sc;
665 sc = device_get_softc(dev);
666 if (sc->vga_msi_child != NULL)
668 error = pci_alloc_msi(dev, count);
670 sc->vga_msi_child = child;
675 vga_pci_alloc_msix(device_t dev, device_t child, int *count)
677 struct vga_pci_softc *sc;
680 sc = device_get_softc(dev);
681 if (sc->vga_msi_child != NULL)
683 error = pci_alloc_msix(dev, count);
685 sc->vga_msi_child = child;
690 vga_pci_remap_msix(device_t dev, device_t child, int count,
691 const u_int *vectors)
693 struct vga_pci_softc *sc;
695 sc = device_get_softc(dev);
696 if (sc->vga_msi_child != child)
698 return (pci_remap_msix(dev, count, vectors));
702 vga_pci_release_msi(device_t dev, device_t child)
704 struct vga_pci_softc *sc;
707 sc = device_get_softc(dev);
708 if (sc->vga_msi_child != child)
710 error = pci_release_msi(dev);
712 sc->vga_msi_child = NULL;
717 vga_pci_msi_count(device_t dev, device_t child)
720 return (pci_msi_count(dev));
724 vga_pci_msix_count(device_t dev, device_t child)
727 return (pci_msix_count(dev));
731 vga_pci_get_dma_tag(device_t bus, device_t child)
734 return (bus_get_dma_tag(bus));
737 static device_method_t vga_pci_methods[] = {
738 /* Device interface */
739 DEVMETHOD(device_probe, vga_pci_probe),
740 DEVMETHOD(device_attach, vga_pci_attach),
741 DEVMETHOD(device_shutdown, bus_generic_shutdown),
742 DEVMETHOD(device_suspend, vga_pci_suspend),
743 DEVMETHOD(device_detach, vga_pci_detach),
744 DEVMETHOD(device_resume, vga_pci_resume),
747 DEVMETHOD(bus_read_ivar, vga_pci_read_ivar),
748 DEVMETHOD(bus_write_ivar, vga_pci_write_ivar),
749 DEVMETHOD(bus_setup_intr, vga_pci_setup_intr),
750 DEVMETHOD(bus_teardown_intr, vga_pci_teardown_intr),
751 DEVMETHOD(bus_alloc_resource, vga_pci_alloc_resource),
752 DEVMETHOD(bus_release_resource, vga_pci_release_resource),
753 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
754 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
755 DEVMETHOD(bus_get_dma_tag, vga_pci_get_dma_tag),
758 DEVMETHOD(pci_read_config, vga_pci_read_config),
759 DEVMETHOD(pci_write_config, vga_pci_write_config),
760 DEVMETHOD(pci_enable_busmaster, vga_pci_enable_busmaster),
761 DEVMETHOD(pci_disable_busmaster, vga_pci_disable_busmaster),
762 DEVMETHOD(pci_enable_io, vga_pci_enable_io),
763 DEVMETHOD(pci_disable_io, vga_pci_disable_io),
764 DEVMETHOD(pci_get_vpd_ident, vga_pci_get_vpd_ident),
765 DEVMETHOD(pci_get_vpd_readonly, vga_pci_get_vpd_readonly),
766 DEVMETHOD(pci_get_powerstate, vga_pci_get_powerstate),
767 DEVMETHOD(pci_set_powerstate, vga_pci_set_powerstate),
768 DEVMETHOD(pci_assign_interrupt, vga_pci_assign_interrupt),
769 DEVMETHOD(pci_find_cap, vga_pci_find_cap),
770 DEVMETHOD(pci_find_next_cap, vga_pci_find_next_cap),
771 DEVMETHOD(pci_find_extcap, vga_pci_find_extcap),
772 DEVMETHOD(pci_find_next_extcap, vga_pci_find_next_extcap),
773 DEVMETHOD(pci_find_htcap, vga_pci_find_htcap),
774 DEVMETHOD(pci_find_next_htcap, vga_pci_find_next_htcap),
775 DEVMETHOD(pci_alloc_msi, vga_pci_alloc_msi),
776 DEVMETHOD(pci_alloc_msix, vga_pci_alloc_msix),
777 DEVMETHOD(pci_remap_msix, vga_pci_remap_msix),
778 DEVMETHOD(pci_release_msi, vga_pci_release_msi),
779 DEVMETHOD(pci_msi_count, vga_pci_msi_count),
780 DEVMETHOD(pci_msix_count, vga_pci_msix_count),
784 static driver_t vga_pci_driver = {
787 sizeof(struct vga_pci_softc),
790 static devclass_t vga_devclass;
792 DRIVER_MODULE(vgapci, pci, vga_pci_driver, vga_devclass, 0, 0);
793 MODULE_DEPEND(vgapci, x86bios, 1, 1, 1);