1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright 2012-2019 Red Hat
5 * This file is subject to the terms and conditions of the GNU General
6 * Public License version 2. See the file COPYING in the main
7 * directory of this archive for more details.
9 * Authors: Matthew Garrett
13 * Portions of this code derived from cirrusfb.c:
14 * drivers/video/cirrusfb.c - driver for Cirrus Logic chipsets
19 #include <linux/dma-buf-map.h>
20 #include <linux/module.h>
21 #include <linux/pci.h>
23 #include <video/cirrus.h>
24 #include <video/vga.h>
26 #include <drm/drm_aperture.h>
27 #include <drm/drm_atomic_helper.h>
28 #include <drm/drm_atomic_state_helper.h>
29 #include <drm/drm_connector.h>
30 #include <drm/drm_damage_helper.h>
31 #include <drm/drm_drv.h>
32 #include <drm/drm_fb_helper.h>
33 #include <drm/drm_file.h>
34 #include <drm/drm_format_helper.h>
35 #include <drm/drm_fourcc.h>
36 #include <drm/drm_gem_atomic_helper.h>
37 #include <drm/drm_gem_framebuffer_helper.h>
38 #include <drm/drm_gem_shmem_helper.h>
39 #include <drm/drm_ioctl.h>
40 #include <drm/drm_managed.h>
41 #include <drm/drm_modeset_helper_vtables.h>
42 #include <drm/drm_probe_helper.h>
43 #include <drm/drm_simple_kms_helper.h>
45 #define DRIVER_NAME "cirrus"
46 #define DRIVER_DESC "qemu cirrus vga"
47 #define DRIVER_DATE "2019"
48 #define DRIVER_MAJOR 2
49 #define DRIVER_MINOR 0
51 #define CIRRUS_MAX_PITCH (0x1FF << 3) /* (4096 - 1) & ~111b bytes */
52 #define CIRRUS_VRAM_SIZE (4 * 1024 * 1024) /* 4 MB */
54 struct cirrus_device {
55 struct drm_device dev;
56 struct drm_simple_display_pipe pipe;
57 struct drm_connector conn;
64 #define to_cirrus(_dev) container_of(_dev, struct cirrus_device, dev)
66 /* ------------------------------------------------------------------ */
68 * The meat of this driver. The core passes us a mode and we have to program
69 * it. The modesetting here is the bare minimum required to satisfy the qemu
70 * emulation of this hardware, and running this against a real device is
71 * likely to result in an inadequately programmed mode. We've already had
72 * the opportunity to modify the mode, so whatever we receive here should
73 * be something that can be correctly programmed and displayed
79 static u8 rreg_seq(struct cirrus_device *cirrus, u8 reg)
81 iowrite8(reg, cirrus->mmio + SEQ_INDEX);
82 return ioread8(cirrus->mmio + SEQ_DATA);
85 static void wreg_seq(struct cirrus_device *cirrus, u8 reg, u8 val)
87 iowrite8(reg, cirrus->mmio + SEQ_INDEX);
88 iowrite8(val, cirrus->mmio + SEQ_DATA);
91 #define CRT_INDEX 0x14
94 static u8 rreg_crt(struct cirrus_device *cirrus, u8 reg)
96 iowrite8(reg, cirrus->mmio + CRT_INDEX);
97 return ioread8(cirrus->mmio + CRT_DATA);
100 static void wreg_crt(struct cirrus_device *cirrus, u8 reg, u8 val)
102 iowrite8(reg, cirrus->mmio + CRT_INDEX);
103 iowrite8(val, cirrus->mmio + CRT_DATA);
106 #define GFX_INDEX 0xe
109 static void wreg_gfx(struct cirrus_device *cirrus, u8 reg, u8 val)
111 iowrite8(reg, cirrus->mmio + GFX_INDEX);
112 iowrite8(val, cirrus->mmio + GFX_DATA);
115 #define VGA_DAC_MASK 0x06
117 static void wreg_hdr(struct cirrus_device *cirrus, u8 val)
119 ioread8(cirrus->mmio + VGA_DAC_MASK);
120 ioread8(cirrus->mmio + VGA_DAC_MASK);
121 ioread8(cirrus->mmio + VGA_DAC_MASK);
122 ioread8(cirrus->mmio + VGA_DAC_MASK);
123 iowrite8(val, cirrus->mmio + VGA_DAC_MASK);
126 static int cirrus_convert_to(struct drm_framebuffer *fb)
128 if (fb->format->cpp[0] == 4 && fb->pitches[0] > CIRRUS_MAX_PITCH) {
129 if (fb->width * 3 <= CIRRUS_MAX_PITCH)
130 /* convert from XR24 to RG24 */
133 /* convert from XR24 to RG16 */
139 static int cirrus_cpp(struct drm_framebuffer *fb)
141 int convert_cpp = cirrus_convert_to(fb);
145 return fb->format->cpp[0];
148 static int cirrus_pitch(struct drm_framebuffer *fb)
150 int convert_cpp = cirrus_convert_to(fb);
153 return convert_cpp * fb->width;
154 return fb->pitches[0];
157 static void cirrus_set_start_address(struct cirrus_device *cirrus, u32 offset)
163 if (!drm_dev_enter(&cirrus->dev, &idx))
167 wreg_crt(cirrus, 0x0c, (u8)((addr >> 8) & 0xff));
168 wreg_crt(cirrus, 0x0d, (u8)(addr & 0xff));
170 tmp = rreg_crt(cirrus, 0x1b);
172 tmp |= (addr >> 16) & 0x01;
173 tmp |= (addr >> 15) & 0x0c;
174 wreg_crt(cirrus, 0x1b, tmp);
176 tmp = rreg_crt(cirrus, 0x1d);
178 tmp |= (addr >> 12) & 0x80;
179 wreg_crt(cirrus, 0x1d, tmp);
184 static int cirrus_mode_set(struct cirrus_device *cirrus,
185 struct drm_display_mode *mode,
186 struct drm_framebuffer *fb)
188 int hsyncstart, hsyncend, htotal, hdispend;
189 int vtotal, vdispend;
191 int sr07 = 0, hdr = 0;
193 if (!drm_dev_enter(&cirrus->dev, &idx))
196 htotal = mode->htotal / 8;
197 hsyncend = mode->hsync_end / 8;
198 hsyncstart = mode->hsync_start / 8;
199 hdispend = mode->hdisplay / 8;
201 vtotal = mode->vtotal;
202 vdispend = mode->vdisplay;
212 wreg_crt(cirrus, VGA_CRTC_V_SYNC_END, 0x20);
213 wreg_crt(cirrus, VGA_CRTC_H_TOTAL, htotal);
214 wreg_crt(cirrus, VGA_CRTC_H_DISP, hdispend);
215 wreg_crt(cirrus, VGA_CRTC_H_SYNC_START, hsyncstart);
216 wreg_crt(cirrus, VGA_CRTC_H_SYNC_END, hsyncend);
217 wreg_crt(cirrus, VGA_CRTC_V_TOTAL, vtotal & 0xff);
218 wreg_crt(cirrus, VGA_CRTC_V_DISP_END, vdispend & 0xff);
221 if ((vdispend + 1) & 512)
223 wreg_crt(cirrus, VGA_CRTC_MAX_SCAN, tmp);
226 * Overflow bits for values that don't fit in the standard registers
231 if (vdispend & 0x100)
233 if ((vdispend + 1) & 0x100)
237 if (vdispend & 0x200)
239 wreg_crt(cirrus, VGA_CRTC_OVERFLOW, tmp);
243 /* More overflow bits */
245 if ((htotal + 5) & 0x40)
247 if ((htotal + 5) & 0x80)
254 wreg_crt(cirrus, CL_CRT1A, tmp);
256 /* Disable Hercules/CGA compatibility */
257 wreg_crt(cirrus, VGA_CRTC_MODE, 0x03);
259 sr07 = rreg_seq(cirrus, 0x07);
263 cirrus->cpp = cirrus_cpp(fb);
264 switch (cirrus->cpp * 8) {
285 wreg_seq(cirrus, 0x7, sr07);
287 /* Program the pitch */
288 cirrus->pitch = cirrus_pitch(fb);
289 tmp = cirrus->pitch / 8;
290 wreg_crt(cirrus, VGA_CRTC_OFFSET, tmp);
292 /* Enable extended blanking and pitch bits, and enable full memory */
294 tmp |= (cirrus->pitch >> 7) & 0x10;
295 tmp |= (cirrus->pitch >> 6) & 0x40;
296 wreg_crt(cirrus, 0x1b, tmp);
298 /* Enable high-colour modes */
299 wreg_gfx(cirrus, VGA_GFX_MODE, 0x40);
301 /* And set graphics mode */
302 wreg_gfx(cirrus, VGA_GFX_MISC, 0x01);
304 wreg_hdr(cirrus, hdr);
306 cirrus_set_start_address(cirrus, 0);
308 /* Unblank (needed on S3 resume, vgabios doesn't do it then) */
315 static int cirrus_fb_blit_rect(struct drm_framebuffer *fb, const struct dma_buf_map *map,
316 struct drm_rect *rect)
318 struct cirrus_device *cirrus = to_cirrus(fb->dev);
319 void __iomem *dst = cirrus->vram;
320 void *vmap = map->vaddr; /* TODO: Use mapping abstraction properly */
323 if (!drm_dev_enter(&cirrus->dev, &idx))
326 if (cirrus->cpp == fb->format->cpp[0]) {
327 dst += drm_fb_clip_offset(fb->pitches[0], fb->format, rect);
328 drm_fb_memcpy_toio(dst, fb->pitches[0], vmap, fb, rect);
330 } else if (fb->format->cpp[0] == 4 && cirrus->cpp == 2) {
331 dst += drm_fb_clip_offset(cirrus->pitch, fb->format, rect);
332 drm_fb_xrgb8888_to_rgb565_toio(dst, cirrus->pitch, vmap, fb, rect, false);
334 } else if (fb->format->cpp[0] == 4 && cirrus->cpp == 3) {
335 dst += drm_fb_clip_offset(cirrus->pitch, fb->format, rect);
336 drm_fb_xrgb8888_to_rgb888_toio(dst, cirrus->pitch, vmap, fb, rect);
339 WARN_ON_ONCE("cpp mismatch");
347 static int cirrus_fb_blit_fullscreen(struct drm_framebuffer *fb, const struct dma_buf_map *map)
349 struct drm_rect fullscreen = {
355 return cirrus_fb_blit_rect(fb, map, &fullscreen);
358 static int cirrus_check_size(int width, int height,
359 struct drm_framebuffer *fb)
361 int pitch = width * 2;
364 pitch = cirrus_pitch(fb);
366 if (pitch > CIRRUS_MAX_PITCH)
368 if (pitch * height > CIRRUS_VRAM_SIZE)
373 /* ------------------------------------------------------------------ */
374 /* cirrus connector */
376 static int cirrus_conn_get_modes(struct drm_connector *conn)
380 count = drm_add_modes_noedid(conn,
381 conn->dev->mode_config.max_width,
382 conn->dev->mode_config.max_height);
383 drm_set_preferred_mode(conn, 1024, 768);
387 static const struct drm_connector_helper_funcs cirrus_conn_helper_funcs = {
388 .get_modes = cirrus_conn_get_modes,
391 static const struct drm_connector_funcs cirrus_conn_funcs = {
392 .fill_modes = drm_helper_probe_single_connector_modes,
393 .destroy = drm_connector_cleanup,
394 .reset = drm_atomic_helper_connector_reset,
395 .atomic_duplicate_state = drm_atomic_helper_connector_duplicate_state,
396 .atomic_destroy_state = drm_atomic_helper_connector_destroy_state,
399 static int cirrus_conn_init(struct cirrus_device *cirrus)
401 drm_connector_helper_add(&cirrus->conn, &cirrus_conn_helper_funcs);
402 return drm_connector_init(&cirrus->dev, &cirrus->conn,
403 &cirrus_conn_funcs, DRM_MODE_CONNECTOR_VGA);
407 /* ------------------------------------------------------------------ */
408 /* cirrus (simple) display pipe */
410 static enum drm_mode_status cirrus_pipe_mode_valid(struct drm_simple_display_pipe *pipe,
411 const struct drm_display_mode *mode)
413 if (cirrus_check_size(mode->hdisplay, mode->vdisplay, NULL) < 0)
418 static int cirrus_pipe_check(struct drm_simple_display_pipe *pipe,
419 struct drm_plane_state *plane_state,
420 struct drm_crtc_state *crtc_state)
422 struct drm_framebuffer *fb = plane_state->fb;
426 return cirrus_check_size(fb->width, fb->height, fb);
429 static void cirrus_pipe_enable(struct drm_simple_display_pipe *pipe,
430 struct drm_crtc_state *crtc_state,
431 struct drm_plane_state *plane_state)
433 struct cirrus_device *cirrus = to_cirrus(pipe->crtc.dev);
434 struct drm_shadow_plane_state *shadow_plane_state = to_drm_shadow_plane_state(plane_state);
436 cirrus_mode_set(cirrus, &crtc_state->mode, plane_state->fb);
437 cirrus_fb_blit_fullscreen(plane_state->fb, &shadow_plane_state->data[0]);
440 static void cirrus_pipe_update(struct drm_simple_display_pipe *pipe,
441 struct drm_plane_state *old_state)
443 struct cirrus_device *cirrus = to_cirrus(pipe->crtc.dev);
444 struct drm_plane_state *state = pipe->plane.state;
445 struct drm_shadow_plane_state *shadow_plane_state = to_drm_shadow_plane_state(state);
446 struct drm_crtc *crtc = &pipe->crtc;
447 struct drm_rect rect;
449 if (state->fb && cirrus->cpp != cirrus_cpp(state->fb))
450 cirrus_mode_set(cirrus, &crtc->mode, state->fb);
452 if (drm_atomic_helper_damage_merged(old_state, state, &rect))
453 cirrus_fb_blit_rect(state->fb, &shadow_plane_state->data[0], &rect);
456 static const struct drm_simple_display_pipe_funcs cirrus_pipe_funcs = {
457 .mode_valid = cirrus_pipe_mode_valid,
458 .check = cirrus_pipe_check,
459 .enable = cirrus_pipe_enable,
460 .update = cirrus_pipe_update,
461 DRM_GEM_SIMPLE_DISPLAY_PIPE_SHADOW_PLANE_FUNCS,
464 static const uint32_t cirrus_formats[] = {
470 static const uint64_t cirrus_modifiers[] = {
471 DRM_FORMAT_MOD_LINEAR,
472 DRM_FORMAT_MOD_INVALID
475 static int cirrus_pipe_init(struct cirrus_device *cirrus)
477 return drm_simple_display_pipe_init(&cirrus->dev,
481 ARRAY_SIZE(cirrus_formats),
486 /* ------------------------------------------------------------------ */
487 /* cirrus framebuffers & mode config */
489 static struct drm_framebuffer*
490 cirrus_fb_create(struct drm_device *dev, struct drm_file *file_priv,
491 const struct drm_mode_fb_cmd2 *mode_cmd)
493 if (mode_cmd->pixel_format != DRM_FORMAT_RGB565 &&
494 mode_cmd->pixel_format != DRM_FORMAT_RGB888 &&
495 mode_cmd->pixel_format != DRM_FORMAT_XRGB8888)
496 return ERR_PTR(-EINVAL);
497 if (cirrus_check_size(mode_cmd->width, mode_cmd->height, NULL) < 0)
498 return ERR_PTR(-EINVAL);
499 return drm_gem_fb_create_with_dirty(dev, file_priv, mode_cmd);
502 static const struct drm_mode_config_funcs cirrus_mode_config_funcs = {
503 .fb_create = cirrus_fb_create,
504 .atomic_check = drm_atomic_helper_check,
505 .atomic_commit = drm_atomic_helper_commit,
508 static int cirrus_mode_config_init(struct cirrus_device *cirrus)
510 struct drm_device *dev = &cirrus->dev;
513 ret = drmm_mode_config_init(dev);
517 dev->mode_config.min_width = 0;
518 dev->mode_config.min_height = 0;
519 dev->mode_config.max_width = CIRRUS_MAX_PITCH / 2;
520 dev->mode_config.max_height = 1024;
521 dev->mode_config.preferred_depth = 16;
522 dev->mode_config.prefer_shadow = 0;
523 dev->mode_config.funcs = &cirrus_mode_config_funcs;
528 /* ------------------------------------------------------------------ */
530 DEFINE_DRM_GEM_FOPS(cirrus_fops);
532 static const struct drm_driver cirrus_driver = {
533 .driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
538 .major = DRIVER_MAJOR,
539 .minor = DRIVER_MINOR,
541 .fops = &cirrus_fops,
542 DRM_GEM_SHMEM_DRIVER_OPS,
545 static int cirrus_pci_probe(struct pci_dev *pdev,
546 const struct pci_device_id *ent)
548 struct drm_device *dev;
549 struct cirrus_device *cirrus;
552 ret = drm_aperture_remove_conflicting_pci_framebuffers(pdev, &cirrus_driver);
556 ret = pcim_enable_device(pdev);
560 ret = pci_request_regions(pdev, DRIVER_NAME);
565 cirrus = devm_drm_dev_alloc(&pdev->dev, &cirrus_driver,
566 struct cirrus_device, dev);
568 return PTR_ERR(cirrus);
572 cirrus->vram = devm_ioremap(&pdev->dev, pci_resource_start(pdev, 0),
573 pci_resource_len(pdev, 0));
574 if (cirrus->vram == NULL)
577 cirrus->mmio = devm_ioremap(&pdev->dev, pci_resource_start(pdev, 1),
578 pci_resource_len(pdev, 1));
579 if (cirrus->mmio == NULL)
582 ret = cirrus_mode_config_init(cirrus);
586 ret = cirrus_conn_init(cirrus);
590 ret = cirrus_pipe_init(cirrus);
594 drm_mode_config_reset(dev);
596 pci_set_drvdata(pdev, dev);
597 ret = drm_dev_register(dev, 0);
601 drm_fbdev_generic_setup(dev, dev->mode_config.preferred_depth);
605 static void cirrus_pci_remove(struct pci_dev *pdev)
607 struct drm_device *dev = pci_get_drvdata(pdev);
610 drm_atomic_helper_shutdown(dev);
613 static const struct pci_device_id pciidlist[] = {
615 .vendor = PCI_VENDOR_ID_CIRRUS,
616 .device = PCI_DEVICE_ID_CIRRUS_5446,
617 /* only bind to the cirrus chip in qemu */
618 .subvendor = PCI_SUBVENDOR_ID_REDHAT_QUMRANET,
619 .subdevice = PCI_SUBDEVICE_ID_QEMU,
621 .vendor = PCI_VENDOR_ID_CIRRUS,
622 .device = PCI_DEVICE_ID_CIRRUS_5446,
623 .subvendor = PCI_VENDOR_ID_XEN,
626 { /* end if list */ }
629 static struct pci_driver cirrus_pci_driver = {
631 .id_table = pciidlist,
632 .probe = cirrus_pci_probe,
633 .remove = cirrus_pci_remove,
636 static int __init cirrus_init(void)
638 if (drm_firmware_drivers_only())
641 return pci_register_driver(&cirrus_pci_driver);
644 static void __exit cirrus_exit(void)
646 pci_unregister_driver(&cirrus_pci_driver);
649 module_init(cirrus_init);
650 module_exit(cirrus_exit);
652 MODULE_DEVICE_TABLE(pci, pciidlist);
653 MODULE_LICENSE("GPL");