1 // SPDX-License-Identifier: GPL-2.0-or-later
3 #include <linux/module.h>
6 #include <drm/drm_aperture.h>
7 #include <drm/drm_atomic_helper.h>
8 #include <drm/drm_drv.h>
9 #include <drm/drm_edid.h>
10 #include <drm/drm_fb_helper.h>
11 #include <drm/drm_fourcc.h>
12 #include <drm/drm_framebuffer.h>
13 #include <drm/drm_gem_framebuffer_helper.h>
14 #include <drm/drm_gem_vram_helper.h>
15 #include <drm/drm_managed.h>
16 #include <drm/drm_module.h>
17 #include <drm/drm_probe_helper.h>
18 #include <drm/drm_simple_kms_helper.h>
20 #include <video/vga.h>
22 /* ---------------------------------------------------------------------- */
24 #define VBE_DISPI_IOPORT_INDEX 0x01CE
25 #define VBE_DISPI_IOPORT_DATA 0x01CF
27 #define VBE_DISPI_INDEX_ID 0x0
28 #define VBE_DISPI_INDEX_XRES 0x1
29 #define VBE_DISPI_INDEX_YRES 0x2
30 #define VBE_DISPI_INDEX_BPP 0x3
31 #define VBE_DISPI_INDEX_ENABLE 0x4
32 #define VBE_DISPI_INDEX_BANK 0x5
33 #define VBE_DISPI_INDEX_VIRT_WIDTH 0x6
34 #define VBE_DISPI_INDEX_VIRT_HEIGHT 0x7
35 #define VBE_DISPI_INDEX_X_OFFSET 0x8
36 #define VBE_DISPI_INDEX_Y_OFFSET 0x9
37 #define VBE_DISPI_INDEX_VIDEO_MEMORY_64K 0xa
39 #define VBE_DISPI_ID0 0xB0C0
40 #define VBE_DISPI_ID1 0xB0C1
41 #define VBE_DISPI_ID2 0xB0C2
42 #define VBE_DISPI_ID3 0xB0C3
43 #define VBE_DISPI_ID4 0xB0C4
44 #define VBE_DISPI_ID5 0xB0C5
46 #define VBE_DISPI_DISABLED 0x00
47 #define VBE_DISPI_ENABLED 0x01
48 #define VBE_DISPI_GETCAPS 0x02
49 #define VBE_DISPI_8BIT_DAC 0x20
50 #define VBE_DISPI_LFB_ENABLED 0x40
51 #define VBE_DISPI_NOCLEARMEM 0x80
53 static int bochs_modeset = -1;
54 static int defx = 1024;
55 static int defy = 768;
57 module_param_named(modeset, bochs_modeset, int, 0444);
58 MODULE_PARM_DESC(modeset, "enable/disable kernel modesetting");
60 module_param(defx, int, 0444);
61 module_param(defy, int, 0444);
62 MODULE_PARM_DESC(defx, "default x resolution");
63 MODULE_PARM_DESC(defy, "default y resolution");
65 /* ---------------------------------------------------------------------- */
78 unsigned long fb_base;
79 unsigned long fb_size;
80 unsigned long qext_size;
91 struct drm_device *dev;
92 struct drm_simple_display_pipe pipe;
93 struct drm_connector connector;
96 /* ---------------------------------------------------------------------- */
98 static void bochs_vga_writeb(struct bochs_device *bochs, u16 ioport, u8 val)
100 if (WARN_ON(ioport < 0x3c0 || ioport > 0x3df))
104 int offset = ioport - 0x3c0 + 0x400;
106 writeb(val, bochs->mmio + offset);
112 static u8 bochs_vga_readb(struct bochs_device *bochs, u16 ioport)
114 if (WARN_ON(ioport < 0x3c0 || ioport > 0x3df))
118 int offset = ioport - 0x3c0 + 0x400;
120 return readb(bochs->mmio + offset);
126 static u16 bochs_dispi_read(struct bochs_device *bochs, u16 reg)
131 int offset = 0x500 + (reg << 1);
133 ret = readw(bochs->mmio + offset);
135 outw(reg, VBE_DISPI_IOPORT_INDEX);
136 ret = inw(VBE_DISPI_IOPORT_DATA);
141 static void bochs_dispi_write(struct bochs_device *bochs, u16 reg, u16 val)
144 int offset = 0x500 + (reg << 1);
146 writew(val, bochs->mmio + offset);
148 outw(reg, VBE_DISPI_IOPORT_INDEX);
149 outw(val, VBE_DISPI_IOPORT_DATA);
153 static void bochs_hw_set_big_endian(struct bochs_device *bochs)
155 if (bochs->qext_size < 8)
158 writel(0xbebebebe, bochs->mmio + 0x604);
161 static void bochs_hw_set_little_endian(struct bochs_device *bochs)
163 if (bochs->qext_size < 8)
166 writel(0x1e1e1e1e, bochs->mmio + 0x604);
170 #define bochs_hw_set_native_endian(_b) bochs_hw_set_big_endian(_b)
172 #define bochs_hw_set_native_endian(_b) bochs_hw_set_little_endian(_b)
175 static int bochs_get_edid_block(void *data, u8 *buf,
176 unsigned int block, size_t len)
178 struct bochs_device *bochs = data;
179 size_t i, start = block * EDID_LENGTH;
181 if (start + len > 0x400 /* vga register offset */)
184 for (i = 0; i < len; i++)
185 buf[i] = readb(bochs->mmio + start + i);
190 static int bochs_hw_load_edid(struct bochs_device *bochs)
197 /* check header to detect whenever edid support is enabled in qemu */
198 bochs_get_edid_block(bochs, header, 0, ARRAY_SIZE(header));
199 if (drm_edid_header_is_valid(header) != 8)
203 bochs->edid = drm_do_get_edid(&bochs->connector,
204 bochs_get_edid_block, bochs);
205 if (bochs->edid == NULL)
211 static int bochs_hw_init(struct drm_device *dev)
213 struct bochs_device *bochs = dev->dev_private;
214 struct pci_dev *pdev = to_pci_dev(dev->dev);
215 unsigned long addr, size, mem, ioaddr, iosize;
218 if (pdev->resource[2].flags & IORESOURCE_MEM) {
219 /* mmio bar with vga and bochs registers present */
220 if (pci_request_region(pdev, 2, "bochs-drm") != 0) {
221 DRM_ERROR("Cannot request mmio region\n");
224 ioaddr = pci_resource_start(pdev, 2);
225 iosize = pci_resource_len(pdev, 2);
226 bochs->mmio = ioremap(ioaddr, iosize);
227 if (bochs->mmio == NULL) {
228 DRM_ERROR("Cannot map mmio region\n");
232 ioaddr = VBE_DISPI_IOPORT_INDEX;
234 if (!request_region(ioaddr, iosize, "bochs-drm")) {
235 DRM_ERROR("Cannot request ioports\n");
241 id = bochs_dispi_read(bochs, VBE_DISPI_INDEX_ID);
242 mem = bochs_dispi_read(bochs, VBE_DISPI_INDEX_VIDEO_MEMORY_64K)
244 if ((id & 0xfff0) != VBE_DISPI_ID0) {
245 DRM_ERROR("ID mismatch\n");
249 if ((pdev->resource[0].flags & IORESOURCE_MEM) == 0)
251 addr = pci_resource_start(pdev, 0);
252 size = pci_resource_len(pdev, 0);
256 DRM_ERROR("Size mismatch: pci=%ld, bochs=%ld\n",
258 size = min(size, mem);
261 if (pci_request_region(pdev, 0, "bochs-drm") != 0)
262 DRM_WARN("Cannot request framebuffer, boot fb still active?\n");
264 bochs->fb_map = ioremap(addr, size);
265 if (bochs->fb_map == NULL) {
266 DRM_ERROR("Cannot map framebuffer\n");
269 bochs->fb_base = addr;
270 bochs->fb_size = size;
272 DRM_INFO("Found bochs VGA, ID 0x%x.\n", id);
273 DRM_INFO("Framebuffer size %ld kB @ 0x%lx, %s @ 0x%lx.\n",
275 bochs->ioports ? "ioports" : "mmio",
278 if (bochs->mmio && pdev->revision >= 2) {
279 bochs->qext_size = readl(bochs->mmio + 0x600);
280 if (bochs->qext_size < 4 || bochs->qext_size > iosize) {
281 bochs->qext_size = 0;
284 DRM_DEBUG("Found qemu ext regs, size %ld\n",
286 bochs_hw_set_native_endian(bochs);
293 static void bochs_hw_fini(struct drm_device *dev)
295 struct bochs_device *bochs = dev->dev_private;
297 /* TODO: shot down existing vram mappings */
300 iounmap(bochs->mmio);
302 release_region(VBE_DISPI_IOPORT_INDEX, 2);
304 iounmap(bochs->fb_map);
305 pci_release_regions(to_pci_dev(dev->dev));
309 static void bochs_hw_blank(struct bochs_device *bochs, bool blank)
311 DRM_DEBUG_DRIVER("hw_blank %d\n", blank);
312 /* discard ar_flip_flop */
313 (void)bochs_vga_readb(bochs, VGA_IS1_RC);
314 /* blank or unblank; we need only update index and set 0x20 */
315 bochs_vga_writeb(bochs, VGA_ATT_W, blank ? 0 : 0x20);
318 static void bochs_hw_setmode(struct bochs_device *bochs, struct drm_display_mode *mode)
322 if (!drm_dev_enter(bochs->dev, &idx))
325 bochs->xres = mode->hdisplay;
326 bochs->yres = mode->vdisplay;
328 bochs->stride = mode->hdisplay * (bochs->bpp / 8);
329 bochs->yres_virtual = bochs->fb_size / bochs->stride;
331 DRM_DEBUG_DRIVER("%dx%d @ %d bpp, vy %d\n",
332 bochs->xres, bochs->yres, bochs->bpp,
333 bochs->yres_virtual);
335 bochs_hw_blank(bochs, false);
337 bochs_dispi_write(bochs, VBE_DISPI_INDEX_ENABLE, 0);
338 bochs_dispi_write(bochs, VBE_DISPI_INDEX_BPP, bochs->bpp);
339 bochs_dispi_write(bochs, VBE_DISPI_INDEX_XRES, bochs->xres);
340 bochs_dispi_write(bochs, VBE_DISPI_INDEX_YRES, bochs->yres);
341 bochs_dispi_write(bochs, VBE_DISPI_INDEX_BANK, 0);
342 bochs_dispi_write(bochs, VBE_DISPI_INDEX_VIRT_WIDTH, bochs->xres);
343 bochs_dispi_write(bochs, VBE_DISPI_INDEX_VIRT_HEIGHT,
344 bochs->yres_virtual);
345 bochs_dispi_write(bochs, VBE_DISPI_INDEX_X_OFFSET, 0);
346 bochs_dispi_write(bochs, VBE_DISPI_INDEX_Y_OFFSET, 0);
348 bochs_dispi_write(bochs, VBE_DISPI_INDEX_ENABLE,
349 VBE_DISPI_ENABLED | VBE_DISPI_LFB_ENABLED);
354 static void bochs_hw_setformat(struct bochs_device *bochs, const struct drm_format_info *format)
358 if (!drm_dev_enter(bochs->dev, &idx))
361 DRM_DEBUG_DRIVER("format %c%c%c%c\n",
362 (format->format >> 0) & 0xff,
363 (format->format >> 8) & 0xff,
364 (format->format >> 16) & 0xff,
365 (format->format >> 24) & 0xff);
367 switch (format->format) {
368 case DRM_FORMAT_XRGB8888:
369 bochs_hw_set_little_endian(bochs);
371 case DRM_FORMAT_BGRX8888:
372 bochs_hw_set_big_endian(bochs);
375 /* should not happen */
376 DRM_ERROR("%s: Huh? Got framebuffer format 0x%x",
377 __func__, format->format);
384 static void bochs_hw_setbase(struct bochs_device *bochs, int x, int y, int stride, u64 addr)
386 unsigned long offset;
387 unsigned int vx, vy, vwidth, idx;
389 if (!drm_dev_enter(bochs->dev, &idx))
392 bochs->stride = stride;
393 offset = (unsigned long)addr +
395 x * (bochs->bpp / 8);
396 vy = offset / bochs->stride;
397 vx = (offset % bochs->stride) * 8 / bochs->bpp;
398 vwidth = stride * 8 / bochs->bpp;
400 DRM_DEBUG_DRIVER("x %d, y %d, addr %llx -> offset %lx, vx %d, vy %d\n",
401 x, y, addr, offset, vx, vy);
402 bochs_dispi_write(bochs, VBE_DISPI_INDEX_VIRT_WIDTH, vwidth);
403 bochs_dispi_write(bochs, VBE_DISPI_INDEX_X_OFFSET, vx);
404 bochs_dispi_write(bochs, VBE_DISPI_INDEX_Y_OFFSET, vy);
409 /* ---------------------------------------------------------------------- */
411 static const uint32_t bochs_formats[] = {
416 static void bochs_plane_update(struct bochs_device *bochs, struct drm_plane_state *state)
418 struct drm_gem_vram_object *gbo;
421 if (!state->fb || !bochs->stride)
424 gbo = drm_gem_vram_of_gem(state->fb->obj[0]);
425 gpu_addr = drm_gem_vram_offset(gbo);
426 if (WARN_ON_ONCE(gpu_addr < 0))
427 return; /* Bug: we didn't pin the BO to VRAM in prepare_fb. */
429 bochs_hw_setbase(bochs,
432 state->fb->pitches[0],
433 state->fb->offsets[0] + gpu_addr);
434 bochs_hw_setformat(bochs, state->fb->format);
437 static void bochs_pipe_enable(struct drm_simple_display_pipe *pipe,
438 struct drm_crtc_state *crtc_state,
439 struct drm_plane_state *plane_state)
441 struct bochs_device *bochs = pipe->crtc.dev->dev_private;
443 bochs_hw_setmode(bochs, &crtc_state->mode);
444 bochs_plane_update(bochs, plane_state);
447 static void bochs_pipe_disable(struct drm_simple_display_pipe *pipe)
449 struct bochs_device *bochs = pipe->crtc.dev->dev_private;
451 bochs_hw_blank(bochs, true);
454 static void bochs_pipe_update(struct drm_simple_display_pipe *pipe,
455 struct drm_plane_state *old_state)
457 struct bochs_device *bochs = pipe->crtc.dev->dev_private;
459 bochs_plane_update(bochs, pipe->plane.state);
462 static const struct drm_simple_display_pipe_funcs bochs_pipe_funcs = {
463 .enable = bochs_pipe_enable,
464 .disable = bochs_pipe_disable,
465 .update = bochs_pipe_update,
466 .prepare_fb = drm_gem_vram_simple_display_pipe_prepare_fb,
467 .cleanup_fb = drm_gem_vram_simple_display_pipe_cleanup_fb,
470 static int bochs_connector_get_modes(struct drm_connector *connector)
472 struct bochs_device *bochs =
473 container_of(connector, struct bochs_device, connector);
477 count = drm_add_edid_modes(connector, bochs->edid);
480 count = drm_add_modes_noedid(connector, 8192, 8192);
481 drm_set_preferred_mode(connector, defx, defy);
486 static const struct drm_connector_helper_funcs bochs_connector_connector_helper_funcs = {
487 .get_modes = bochs_connector_get_modes,
490 static const struct drm_connector_funcs bochs_connector_connector_funcs = {
491 .fill_modes = drm_helper_probe_single_connector_modes,
492 .destroy = drm_connector_cleanup,
493 .reset = drm_atomic_helper_connector_reset,
494 .atomic_duplicate_state = drm_atomic_helper_connector_duplicate_state,
495 .atomic_destroy_state = drm_atomic_helper_connector_destroy_state,
498 static void bochs_connector_init(struct drm_device *dev)
500 struct bochs_device *bochs = dev->dev_private;
501 struct drm_connector *connector = &bochs->connector;
503 drm_connector_init(dev, connector, &bochs_connector_connector_funcs,
504 DRM_MODE_CONNECTOR_VIRTUAL);
505 drm_connector_helper_add(connector, &bochs_connector_connector_helper_funcs);
507 bochs_hw_load_edid(bochs);
509 DRM_INFO("Found EDID data blob.\n");
510 drm_connector_attach_edid_property(connector);
511 drm_connector_update_edid_property(connector, bochs->edid);
515 static struct drm_framebuffer *
516 bochs_gem_fb_create(struct drm_device *dev, struct drm_file *file,
517 const struct drm_mode_fb_cmd2 *mode_cmd)
519 if (mode_cmd->pixel_format != DRM_FORMAT_XRGB8888 &&
520 mode_cmd->pixel_format != DRM_FORMAT_BGRX8888)
521 return ERR_PTR(-EINVAL);
523 return drm_gem_fb_create(dev, file, mode_cmd);
526 static const struct drm_mode_config_funcs bochs_mode_funcs = {
527 .fb_create = bochs_gem_fb_create,
528 .mode_valid = drm_vram_helper_mode_valid,
529 .atomic_check = drm_atomic_helper_check,
530 .atomic_commit = drm_atomic_helper_commit,
533 static int bochs_kms_init(struct bochs_device *bochs)
537 ret = drmm_mode_config_init(bochs->dev);
541 bochs->dev->mode_config.max_width = 8192;
542 bochs->dev->mode_config.max_height = 8192;
544 bochs->dev->mode_config.fb_base = bochs->fb_base;
545 bochs->dev->mode_config.preferred_depth = 24;
546 bochs->dev->mode_config.prefer_shadow = 0;
547 bochs->dev->mode_config.prefer_shadow_fbdev = 1;
548 bochs->dev->mode_config.quirk_addfb_prefer_host_byte_order = true;
550 bochs->dev->mode_config.funcs = &bochs_mode_funcs;
552 bochs_connector_init(bochs->dev);
553 drm_simple_display_pipe_init(bochs->dev,
557 ARRAY_SIZE(bochs_formats),
561 drm_mode_config_reset(bochs->dev);
566 /* ---------------------------------------------------------------------- */
569 static int bochs_load(struct drm_device *dev)
571 struct bochs_device *bochs;
574 bochs = drmm_kzalloc(dev, sizeof(*bochs), GFP_KERNEL);
577 dev->dev_private = bochs;
580 ret = bochs_hw_init(dev);
584 ret = drmm_vram_helper_init(dev, bochs->fb_base, bochs->fb_size);
588 ret = bochs_kms_init(bochs);
595 DEFINE_DRM_GEM_FOPS(bochs_fops);
597 static const struct drm_driver bochs_driver = {
598 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
601 .desc = "bochs dispi vga interface (qemu stdvga)",
608 /* ---------------------------------------------------------------------- */
611 #ifdef CONFIG_PM_SLEEP
612 static int bochs_pm_suspend(struct device *dev)
614 struct drm_device *drm_dev = dev_get_drvdata(dev);
616 return drm_mode_config_helper_suspend(drm_dev);
619 static int bochs_pm_resume(struct device *dev)
621 struct drm_device *drm_dev = dev_get_drvdata(dev);
623 return drm_mode_config_helper_resume(drm_dev);
627 static const struct dev_pm_ops bochs_pm_ops = {
628 SET_SYSTEM_SLEEP_PM_OPS(bochs_pm_suspend,
632 /* ---------------------------------------------------------------------- */
635 static int bochs_pci_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
637 struct drm_device *dev;
638 unsigned long fbsize;
641 fbsize = pci_resource_len(pdev, 0);
642 if (fbsize < 4 * 1024 * 1024) {
643 DRM_ERROR("less than 4 MB video memory, ignoring device\n");
647 ret = drm_aperture_remove_conflicting_pci_framebuffers(pdev, &bochs_driver);
651 dev = drm_dev_alloc(&bochs_driver, &pdev->dev);
655 ret = pcim_enable_device(pdev);
659 pci_set_drvdata(pdev, dev);
661 ret = bochs_load(dev);
665 ret = drm_dev_register(dev, 0);
669 drm_fbdev_generic_setup(dev, 32);
677 static void bochs_pci_remove(struct pci_dev *pdev)
679 struct drm_device *dev = pci_get_drvdata(pdev);
682 drm_atomic_helper_shutdown(dev);
687 static const struct pci_device_id bochs_pci_tbl[] = {
691 .subvendor = PCI_SUBVENDOR_ID_REDHAT_QUMRANET,
692 .subdevice = PCI_SUBDEVICE_ID_QEMU,
693 .driver_data = BOCHS_QEMU_STDVGA,
698 .subvendor = PCI_ANY_ID,
699 .subdevice = PCI_ANY_ID,
700 .driver_data = BOCHS_UNKNOWN,
705 .subvendor = PCI_ANY_ID,
706 .subdevice = PCI_ANY_ID,
707 .driver_data = BOCHS_SIMICS,
709 { /* end of list */ }
712 static struct pci_driver bochs_pci_driver = {
714 .id_table = bochs_pci_tbl,
715 .probe = bochs_pci_probe,
716 .remove = bochs_pci_remove,
717 .driver.pm = &bochs_pm_ops,
720 /* ---------------------------------------------------------------------- */
721 /* module init/exit */
723 drm_module_pci_driver_if_modeset(bochs_pci_driver, bochs_modeset);
725 MODULE_DEVICE_TABLE(pci, bochs_pci_tbl);
727 MODULE_LICENSE("GPL");