1 /*-
2 * Copyright (c) 2005 John Baldwin <jhb@FreeBSD.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 * 3. Neither the name of the author nor the names of any co-contributors
14 * may be used to endorse or promote products derived from this software
15 * without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD: src/sys/dev/pci/vga_pci.c,v 1.5.8.1 2009/04/15 03:14:26 kensmith Exp $
30 */
31
32 /*
33 * Simple driver for PCI VGA display devices. Drivers such as agp(4) and
34 * drm(4) should attach as children of this device.
35 *
36 * XXX: The vgapci name is a hack until we somehow merge the isa vga driver
37 * in or rename it.
38 */
39
40 #include <sys/param.h>
41 #include <sys/bus.h>
42 #include <sys/kernel.h>
43 #include <sys/module.h>
44 #include <sys/rman.h>
45 #include <sys/sysctl.h>
46 #include <sys/systm.h>
47
48 #include <machine/pmap.h>
49
50 #include <bus/pci/pcireg.h>
51 #include <bus/pci/pcivar.h>
52
53 struct vga_resource {
54 struct resource *vr_res;
55 int vr_refs;
56 };
57
58 struct vga_pci_softc {
59 device_t vga_msi_child; /* Child driver using MSI. */
60 struct vga_resource vga_bars[PCIR_MAX_BAR_0 + 1];
61 struct vga_resource vga_bios;
62 };
63
64 SYSCTL_DECL(_hw_pci);
65
66 static struct vga_resource *lookup_res(struct vga_pci_softc *sc, int rid);
67 static struct resource *vga_pci_alloc_resource(device_t dev, device_t child,
68 int type, int *rid, u_long start, u_long end, u_long count, u_int flags,
69 int cpuid);
70 static int vga_pci_release_resource(device_t dev, device_t child, int type,
71 int rid, struct resource *r);
72
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_RD,
76 &vga_pci_default_unit, -1, "Default VGA-compatible display");
77
78 int
vga_pci_is_boot_display(device_t dev)79 vga_pci_is_boot_display(device_t dev)
80 {
81 int unit;
82 device_t pcib;
83 uint16_t config;
84
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)))
89 return (0);
90
91 unit = device_get_unit(dev);
92
93 if (vga_pci_default_unit >= 0) {
94 /*
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.
98 */
99 return (vga_pci_default_unit == unit);
100 }
101
102 /*
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
105 * Command register.
106 *
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.
110 */
111
112 pcib = device_get_parent(device_get_parent(dev));
113 if (device_get_devclass(device_get_parent(pcib)) ==
114 devclass_find("pci")) {
115 /*
116 * The parent bridge is a PCI-to-PCI bridge: check the
117 * value of the "VGA Enable" bit.
118 */
119 config = pci_read_config(pcib, PCIR_BRIDGECTL_1, 2);
120 if ((config & PCIB_BCR_VGA_ENABLE) == 0)
121 return (0);
122 }
123
124 config = pci_read_config(dev, PCIR_COMMAND, 2);
125 if ((config & (PCIM_CMD_PORTEN | PCIM_CMD_MEMEN)) == 0)
126 return (0);
127
128 /* This video card is the boot display: record its unit number. */
129 vga_pci_default_unit = unit;
130 device_set_flags(dev, 1);
131
132 return (1);
133 }
134
135 void *
vga_pci_map_bios(device_t dev,size_t * size)136 vga_pci_map_bios(device_t dev, size_t *size)
137 {
138 int rid;
139 struct resource *res;
140
141 if (vga_pci_is_boot_display(dev)) {
142 /*
143 * On x86, the System BIOS copy the default display
144 * device's Video BIOS at a fixed location in system
145 * memory (0xC0000, 128 kBytes long) at boot time.
146 *
147 * We use this copy for the default boot device, because
148 * the original ROM may not be valid after boot.
149 */
150
151 *size = VGA_PCI_BIOS_SHADOW_SIZE;
152 return (pmap_mapbios(VGA_PCI_BIOS_SHADOW_ADDR, *size));
153 }
154
155 rid = PCIR_BIOS;
156 res = vga_pci_alloc_resource(dev, NULL, SYS_RES_MEMORY, &rid, 0ul,
157 ~0ul, 1, RF_ACTIVE, -1);
158 if (res == NULL) {
159 return (NULL);
160 }
161
162 *size = rman_get_size(res);
163 return (rman_get_virtual(res));
164 }
165
166 void
vga_pci_unmap_bios(device_t dev,void * bios)167 vga_pci_unmap_bios(device_t dev, void *bios)
168 {
169 struct vga_resource *vr;
170
171 if (bios == NULL) {
172 return;
173 }
174
175 if (vga_pci_is_boot_display(dev)) {
176 /* We mapped the BIOS shadow copy located at 0xC0000. */
177 pmap_unmapdev((vm_offset_t)bios, VGA_PCI_BIOS_SHADOW_SIZE);
178
179 return;
180 }
181
182 /*
183 * Look up the PCIR_BIOS resource in our softc. It should match
184 * the address we returned previously.
185 */
186 vr = lookup_res(device_get_softc(dev), PCIR_BIOS);
187 KASSERT(vr->vr_res != NULL, ("vga_pci_unmap_bios: bios not mapped"));
188 KASSERT(rman_get_virtual(vr->vr_res) == bios,
189 ("vga_pci_unmap_bios: mismatch"));
190 vga_pci_release_resource(dev, NULL, SYS_RES_MEMORY, PCIR_BIOS,
191 vr->vr_res);
192 }
193
194 static int
vga_pci_probe(device_t dev)195 vga_pci_probe(device_t dev)
196 {
197
198 switch (pci_get_class(dev)) {
199 case PCIC_DISPLAY:
200 break;
201 case PCIC_OLD:
202 if (pci_get_subclass(dev) != PCIS_OLD_VGA)
203 return (ENXIO);
204 break;
205 default:
206 return (ENXIO);
207 }
208
209 /* Probe default display. */
210 vga_pci_is_boot_display(dev);
211
212 device_set_desc(dev, "VGA-compatible display");
213 return (BUS_PROBE_GENERIC);
214 }
215
216 static int
vga_pci_attach(device_t dev)217 vga_pci_attach(device_t dev)
218 {
219
220 bus_generic_probe(dev);
221
222 /* Always create a drm child for now to make it easier on drm. */
223 device_add_child(dev, "drm", -1);
224 bus_generic_attach(dev);
225
226 if (vga_pci_is_boot_display(dev))
227 device_printf(dev, "Boot video device\n");
228
229 return (0);
230 }
231
232 static int
vga_pci_suspend(device_t dev)233 vga_pci_suspend(device_t dev)
234 {
235
236 return (bus_generic_suspend(dev));
237 }
238
239 static int
vga_pci_resume(device_t dev)240 vga_pci_resume(device_t dev)
241 {
242
243 return (bus_generic_resume(dev));
244 }
245
246 /* Bus interface. */
247
248 static int
vga_pci_read_ivar(device_t dev,device_t child,int which,uintptr_t * result)249 vga_pci_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
250 {
251
252 return (BUS_READ_IVAR(device_get_parent(dev), dev, which, result));
253 }
254
255 static int
vga_pci_write_ivar(device_t dev,device_t child,int which,uintptr_t value)256 vga_pci_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
257 {
258
259 return (EINVAL);
260 }
261
262 static int
vga_pci_setup_intr(device_t dev,device_t child,struct resource * irq,int flags,driver_intr_t * intr,void * arg,void ** cookiep,lwkt_serialize_t serializer,const char * desc)263 vga_pci_setup_intr(device_t dev, device_t child, struct resource *irq,
264 int flags, driver_intr_t *intr, void *arg, void **cookiep,
265 lwkt_serialize_t serializer, const char *desc)
266 {
267
268 return (BUS_SETUP_INTR(device_get_parent(dev), dev, irq, flags,
269 intr, arg, cookiep, serializer, desc));
270 }
271
272 static int
vga_pci_teardown_intr(device_t dev,device_t child,struct resource * irq,void * cookie)273 vga_pci_teardown_intr(device_t dev, device_t child, struct resource *irq,
274 void *cookie)
275 {
276
277 return (BUS_TEARDOWN_INTR(device_get_parent(dev), dev, irq, cookie));
278 }
279
280 static struct vga_resource *
lookup_res(struct vga_pci_softc * sc,int rid)281 lookup_res(struct vga_pci_softc *sc, int rid)
282 {
283 int bar;
284
285 if (rid == PCIR_BIOS)
286 return (&sc->vga_bios);
287 bar = PCI_RID2BAR(rid);
288 if (bar >= 0 && bar <= PCIR_MAX_BAR_0)
289 return (&sc->vga_bars[bar]);
290 return (NULL);
291 }
292
293 static struct resource *
vga_pci_alloc_resource(device_t dev,device_t child,int type,int * rid,u_long start,u_long end,u_long count,u_int flags,int cpuid __unused)294 vga_pci_alloc_resource(device_t dev, device_t child, int type, int *rid,
295 u_long start, u_long end, u_long count, u_int flags, int cpuid __unused)
296 {
297 struct vga_resource *vr;
298
299 switch (type) {
300 case SYS_RES_MEMORY:
301 case SYS_RES_IOPORT:
302 /*
303 * For BARs, we cache the resource so that we only allocate it
304 * from the PCI bus once.
305 */
306 vr = lookup_res(device_get_softc(dev), *rid);
307 if (vr == NULL)
308 return (NULL);
309 if (vr->vr_res == NULL)
310 vr->vr_res = bus_alloc_resource(dev, type, rid, start,
311 end, count, flags);
312 if (vr->vr_res != NULL)
313 vr->vr_refs++;
314 return (vr->vr_res);
315 }
316 return (bus_alloc_resource(dev, type, rid, start, end, count, flags));
317 }
318
319 static int
vga_pci_release_resource(device_t dev,device_t child,int type,int rid,struct resource * r)320 vga_pci_release_resource(device_t dev, device_t child, int type, int rid,
321 struct resource *r)
322 {
323 struct vga_resource *vr;
324
325 switch (type) {
326 case SYS_RES_MEMORY:
327 case SYS_RES_IOPORT:
328 /*
329 * Stop caching the resource when refs drops to 0
330 */
331 vr = lookup_res(device_get_softc(dev), rid);
332 if (vr && vr->vr_refs > 0) {
333 if (--vr->vr_refs > 0)
334 return(0);
335 vr->vr_res = NULL;
336 /* fall through */
337 }
338 /* fall through */
339 break;
340 }
341 return (bus_release_resource(dev, type, rid, r));
342 }
343
344 /* PCI interface. */
345
346 static uint32_t
vga_pci_read_config(device_t dev,device_t child,int reg,int width)347 vga_pci_read_config(device_t dev, device_t child, int reg, int width)
348 {
349
350 return (pci_read_config(dev, reg, width));
351 }
352
353 static void
vga_pci_write_config(device_t dev,device_t child,int reg,uint32_t val,int width)354 vga_pci_write_config(device_t dev, device_t child, int reg,
355 uint32_t val, int width)
356 {
357
358 pci_write_config(dev, reg, val, width);
359 }
360
361 static int
vga_pci_enable_busmaster(device_t dev,device_t child)362 vga_pci_enable_busmaster(device_t dev, device_t child)
363 {
364
365 return (pci_enable_busmaster(dev));
366 }
367
368 static int
vga_pci_disable_busmaster(device_t dev,device_t child)369 vga_pci_disable_busmaster(device_t dev, device_t child)
370 {
371
372 return (pci_disable_busmaster(dev));
373 }
374
375 static int
vga_pci_enable_io(device_t dev,device_t child,int space)376 vga_pci_enable_io(device_t dev, device_t child, int space)
377 {
378
379 device_printf(dev, "child %s requested pci_enable_io\n",
380 device_get_nameunit(child));
381 return (pci_enable_io(dev, space));
382 }
383
384 static int
vga_pci_disable_io(device_t dev,device_t child,int space)385 vga_pci_disable_io(device_t dev, device_t child, int space)
386 {
387
388 device_printf(dev, "child %s requested pci_disable_io\n",
389 device_get_nameunit(child));
390 return (pci_disable_io(dev, space));
391 }
392
393 static int
vga_pci_get_vpd_ident(device_t dev,device_t child,const char ** identptr)394 vga_pci_get_vpd_ident(device_t dev, device_t child, const char **identptr)
395 {
396
397 return (pci_get_vpd_ident(dev, identptr));
398 }
399
400 static int
vga_pci_get_vpd_readonly(device_t dev,device_t child,const char * kw,const char ** vptr)401 vga_pci_get_vpd_readonly(device_t dev, device_t child, const char *kw,
402 const char **vptr)
403 {
404
405 return (pci_get_vpd_readonly(dev, kw, vptr));
406 }
407
408 static int
vga_pci_set_powerstate(device_t dev,device_t child,int state)409 vga_pci_set_powerstate(device_t dev, device_t child, int state)
410 {
411
412 return (pci_set_powerstate(dev, state));
413 }
414
415 static int
vga_pci_get_powerstate(device_t dev,device_t child)416 vga_pci_get_powerstate(device_t dev, device_t child)
417 {
418
419 return (pci_get_powerstate(dev));
420 }
421
422 static int
vga_pci_assign_interrupt(device_t dev,device_t child)423 vga_pci_assign_interrupt(device_t dev, device_t child)
424 {
425
426 device_printf(dev, "child %s requested pci_assign_interrupt\n",
427 device_get_nameunit(child));
428 return (PCI_ASSIGN_INTERRUPT(device_get_parent(dev), dev));
429 }
430
431 static int
vga_pci_find_extcap(device_t dev,device_t child,int capability,int * capreg)432 vga_pci_find_extcap(device_t dev, device_t child, int capability,
433 int *capreg)
434 {
435
436 return (pci_find_extcap(dev, capability, capreg));
437 }
438
439 static int
vga_pci_alloc_msi(device_t dev,device_t child,int * rid,int count,int cpuid)440 vga_pci_alloc_msi(device_t dev, device_t child, int *rid, int count,
441 int cpuid)
442 {
443 struct vga_pci_softc *sc;
444 int error;
445
446 sc = device_get_softc(dev);
447 if (sc->vga_msi_child != NULL)
448 return (EBUSY);
449 error = pci_alloc_msi(dev, rid, count, cpuid);
450 if (error == 0)
451 sc->vga_msi_child = child;
452 return (error);
453 }
454
455 static int
vga_pci_release_msi(device_t dev,device_t child)456 vga_pci_release_msi(device_t dev, device_t child)
457 {
458 struct vga_pci_softc *sc;
459 int error;
460
461 sc = device_get_softc(dev);
462 if (sc->vga_msi_child != child)
463 return (ENXIO);
464 error = pci_release_msi(dev);
465 if (error == 0)
466 sc->vga_msi_child = NULL;
467 return (error);
468 }
469
470 static int
vga_pci_msi_count(device_t dev,device_t child)471 vga_pci_msi_count(device_t dev, device_t child)
472 {
473
474 return (pci_msi_count(dev));
475 }
476
477 static device_method_t vga_pci_methods[] = {
478 /* Device interface */
479 DEVMETHOD(device_probe, vga_pci_probe),
480 DEVMETHOD(device_attach, vga_pci_attach),
481 DEVMETHOD(device_shutdown, bus_generic_shutdown),
482 DEVMETHOD(device_suspend, vga_pci_suspend),
483 DEVMETHOD(device_resume, vga_pci_resume),
484
485 /* Bus interface */
486 DEVMETHOD(bus_read_ivar, vga_pci_read_ivar),
487 DEVMETHOD(bus_write_ivar, vga_pci_write_ivar),
488 DEVMETHOD(bus_setup_intr, vga_pci_setup_intr),
489 DEVMETHOD(bus_teardown_intr, vga_pci_teardown_intr),
490
491 DEVMETHOD(bus_alloc_resource, vga_pci_alloc_resource),
492 DEVMETHOD(bus_release_resource, vga_pci_release_resource),
493 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
494 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
495
496 /* PCI interface */
497 DEVMETHOD(pci_read_config, vga_pci_read_config),
498 DEVMETHOD(pci_write_config, vga_pci_write_config),
499 DEVMETHOD(pci_enable_busmaster, vga_pci_enable_busmaster),
500 DEVMETHOD(pci_disable_busmaster, vga_pci_disable_busmaster),
501 DEVMETHOD(pci_enable_io, vga_pci_enable_io),
502 DEVMETHOD(pci_disable_io, vga_pci_disable_io),
503 DEVMETHOD(pci_get_vpd_ident, vga_pci_get_vpd_ident),
504 DEVMETHOD(pci_get_vpd_readonly, vga_pci_get_vpd_readonly),
505 DEVMETHOD(pci_get_powerstate, vga_pci_get_powerstate),
506 DEVMETHOD(pci_set_powerstate, vga_pci_set_powerstate),
507 DEVMETHOD(pci_assign_interrupt, vga_pci_assign_interrupt),
508 DEVMETHOD(pci_find_extcap, vga_pci_find_extcap),
509 DEVMETHOD(pci_alloc_msi, vga_pci_alloc_msi),
510 DEVMETHOD(pci_release_msi, vga_pci_release_msi),
511 DEVMETHOD(pci_msi_count, vga_pci_msi_count),
512
513 DEVMETHOD_END
514 };
515
516 static driver_t vga_pci_driver = {
517 "vgapci",
518 vga_pci_methods,
519 sizeof(struct vga_pci_softc),
520 };
521
522 static devclass_t vga_devclass;
523
524 DRIVER_MODULE(vgapci, pci, vga_pci_driver, vga_devclass, NULL, NULL);
525