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/iosys-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.h>
28 #include <drm/drm_atomic_helper.h>
29 #include <drm/drm_atomic_state_helper.h>
30 #include <drm/drm_connector.h>
31 #include <drm/drm_damage_helper.h>
32 #include <drm/drm_drv.h>
33 #include <drm/drm_edid.h>
34 #include <drm/drm_fbdev_generic.h>
35 #include <drm/drm_file.h>
36 #include <drm/drm_format_helper.h>
37 #include <drm/drm_fourcc.h>
38 #include <drm/drm_framebuffer.h>
39 #include <drm/drm_gem_atomic_helper.h>
40 #include <drm/drm_gem_framebuffer_helper.h>
41 #include <drm/drm_gem_shmem_helper.h>
42 #include <drm/drm_ioctl.h>
43 #include <drm/drm_managed.h>
44 #include <drm/drm_modeset_helper_vtables.h>
45 #include <drm/drm_module.h>
46 #include <drm/drm_probe_helper.h>
48 #define DRIVER_NAME "cirrus"
49 #define DRIVER_DESC "qemu cirrus vga"
50 #define DRIVER_DATE "2019"
51 #define DRIVER_MAJOR 2
52 #define DRIVER_MINOR 0
54 #define CIRRUS_MAX_PITCH (0x1FF << 3) /* (4096 - 1) & ~111b bytes */
55 #define CIRRUS_VRAM_SIZE (4 * 1024 * 1024) /* 4 MB */
57 struct cirrus_device {
58 struct drm_device dev;
60 /* modesetting pipeline */
61 struct drm_plane primary_plane;
63 struct drm_encoder encoder;
64 struct drm_connector connector;
71 #define to_cirrus(_dev) container_of(_dev, struct cirrus_device, dev)
73 struct cirrus_primary_plane_state {
74 struct drm_shadow_plane_state base;
76 /* HW scanout buffer */
77 const struct drm_format_info *format;
81 static inline struct cirrus_primary_plane_state *
82 to_cirrus_primary_plane_state(struct drm_plane_state *plane_state)
84 return container_of(plane_state, struct cirrus_primary_plane_state, base.base);
87 /* ------------------------------------------------------------------ */
89 * The meat of this driver. The core passes us a mode and we have to program
90 * it. The modesetting here is the bare minimum required to satisfy the qemu
91 * emulation of this hardware, and running this against a real device is
92 * likely to result in an inadequately programmed mode. We've already had
93 * the opportunity to modify the mode, so whatever we receive here should
94 * be something that can be correctly programmed and displayed
100 static u8 rreg_seq(struct cirrus_device *cirrus, u8 reg)
102 iowrite8(reg, cirrus->mmio + SEQ_INDEX);
103 return ioread8(cirrus->mmio + SEQ_DATA);
106 static void wreg_seq(struct cirrus_device *cirrus, u8 reg, u8 val)
108 iowrite8(reg, cirrus->mmio + SEQ_INDEX);
109 iowrite8(val, cirrus->mmio + SEQ_DATA);
112 #define CRT_INDEX 0x14
113 #define CRT_DATA 0x15
115 static u8 rreg_crt(struct cirrus_device *cirrus, u8 reg)
117 iowrite8(reg, cirrus->mmio + CRT_INDEX);
118 return ioread8(cirrus->mmio + CRT_DATA);
121 static void wreg_crt(struct cirrus_device *cirrus, u8 reg, u8 val)
123 iowrite8(reg, cirrus->mmio + CRT_INDEX);
124 iowrite8(val, cirrus->mmio + CRT_DATA);
127 #define GFX_INDEX 0xe
130 static void wreg_gfx(struct cirrus_device *cirrus, u8 reg, u8 val)
132 iowrite8(reg, cirrus->mmio + GFX_INDEX);
133 iowrite8(val, cirrus->mmio + GFX_DATA);
136 #define VGA_DAC_MASK 0x06
138 static void wreg_hdr(struct cirrus_device *cirrus, u8 val)
140 ioread8(cirrus->mmio + VGA_DAC_MASK);
141 ioread8(cirrus->mmio + VGA_DAC_MASK);
142 ioread8(cirrus->mmio + VGA_DAC_MASK);
143 ioread8(cirrus->mmio + VGA_DAC_MASK);
144 iowrite8(val, cirrus->mmio + VGA_DAC_MASK);
147 static const struct drm_format_info *cirrus_convert_to(struct drm_framebuffer *fb)
149 if (fb->format->format == DRM_FORMAT_XRGB8888 && fb->pitches[0] > CIRRUS_MAX_PITCH) {
150 if (fb->width * 3 <= CIRRUS_MAX_PITCH)
151 /* convert from XR24 to RG24 */
152 return drm_format_info(DRM_FORMAT_RGB888);
154 /* convert from XR24 to RG16 */
155 return drm_format_info(DRM_FORMAT_RGB565);
160 static const struct drm_format_info *cirrus_format(struct drm_framebuffer *fb)
162 const struct drm_format_info *format = cirrus_convert_to(fb);
169 static int cirrus_pitch(struct drm_framebuffer *fb)
171 const struct drm_format_info *format = cirrus_convert_to(fb);
174 return drm_format_info_min_pitch(format, 0, fb->width);
175 return fb->pitches[0];
178 static void cirrus_set_start_address(struct cirrus_device *cirrus, u32 offset)
184 wreg_crt(cirrus, 0x0c, (u8)((addr >> 8) & 0xff));
185 wreg_crt(cirrus, 0x0d, (u8)(addr & 0xff));
187 tmp = rreg_crt(cirrus, 0x1b);
189 tmp |= (addr >> 16) & 0x01;
190 tmp |= (addr >> 15) & 0x0c;
191 wreg_crt(cirrus, 0x1b, tmp);
193 tmp = rreg_crt(cirrus, 0x1d);
195 tmp |= (addr >> 12) & 0x80;
196 wreg_crt(cirrus, 0x1d, tmp);
199 static void cirrus_mode_set(struct cirrus_device *cirrus,
200 struct drm_display_mode *mode)
202 int hsyncstart, hsyncend, htotal, hdispend;
203 int vtotal, vdispend;
206 htotal = mode->htotal / 8;
207 hsyncend = mode->hsync_end / 8;
208 hsyncstart = mode->hsync_start / 8;
209 hdispend = mode->hdisplay / 8;
211 vtotal = mode->vtotal;
212 vdispend = mode->vdisplay;
222 wreg_crt(cirrus, VGA_CRTC_V_SYNC_END, 0x20);
223 wreg_crt(cirrus, VGA_CRTC_H_TOTAL, htotal);
224 wreg_crt(cirrus, VGA_CRTC_H_DISP, hdispend);
225 wreg_crt(cirrus, VGA_CRTC_H_SYNC_START, hsyncstart);
226 wreg_crt(cirrus, VGA_CRTC_H_SYNC_END, hsyncend);
227 wreg_crt(cirrus, VGA_CRTC_V_TOTAL, vtotal & 0xff);
228 wreg_crt(cirrus, VGA_CRTC_V_DISP_END, vdispend & 0xff);
231 if ((vdispend + 1) & 512)
233 wreg_crt(cirrus, VGA_CRTC_MAX_SCAN, tmp);
236 * Overflow bits for values that don't fit in the standard registers
241 if (vdispend & 0x100)
243 if ((vdispend + 1) & 0x100)
247 if (vdispend & 0x200)
249 wreg_crt(cirrus, VGA_CRTC_OVERFLOW, tmp);
253 /* More overflow bits */
255 if ((htotal + 5) & 0x40)
257 if ((htotal + 5) & 0x80)
264 wreg_crt(cirrus, CL_CRT1A, tmp);
266 /* Disable Hercules/CGA compatibility */
267 wreg_crt(cirrus, VGA_CRTC_MODE, 0x03);
270 static void cirrus_format_set(struct cirrus_device *cirrus,
271 const struct drm_format_info *format)
275 sr07 = rreg_seq(cirrus, 0x07);
278 switch (format->format) {
283 case DRM_FORMAT_RGB565:
287 case DRM_FORMAT_RGB888:
291 case DRM_FORMAT_XRGB8888:
299 wreg_seq(cirrus, 0x7, sr07);
301 /* Enable high-colour modes */
302 wreg_gfx(cirrus, VGA_GFX_MODE, 0x40);
304 /* And set graphics mode */
305 wreg_gfx(cirrus, VGA_GFX_MISC, 0x01);
307 wreg_hdr(cirrus, hdr);
310 static void cirrus_pitch_set(struct cirrus_device *cirrus, unsigned int pitch)
314 /* Program the pitch */
316 wreg_crt(cirrus, VGA_CRTC_OFFSET, cr13);
318 /* Enable extended blanking and pitch bits, and enable full memory */
320 cr1b |= (pitch >> 7) & 0x10;
321 cr1b |= (pitch >> 6) & 0x40;
322 wreg_crt(cirrus, 0x1b, cr1b);
324 cirrus_set_start_address(cirrus, 0);
327 /* ------------------------------------------------------------------ */
328 /* cirrus display pipe */
330 static const uint32_t cirrus_primary_plane_formats[] = {
336 static const uint64_t cirrus_primary_plane_format_modifiers[] = {
337 DRM_FORMAT_MOD_LINEAR,
338 DRM_FORMAT_MOD_INVALID
341 static int cirrus_primary_plane_helper_atomic_check(struct drm_plane *plane,
342 struct drm_atomic_state *state)
344 struct drm_plane_state *new_plane_state = drm_atomic_get_new_plane_state(state, plane);
345 struct cirrus_primary_plane_state *new_primary_plane_state =
346 to_cirrus_primary_plane_state(new_plane_state);
347 struct drm_framebuffer *fb = new_plane_state->fb;
348 struct drm_crtc *new_crtc = new_plane_state->crtc;
349 struct drm_crtc_state *new_crtc_state = NULL;
354 new_crtc_state = drm_atomic_get_new_crtc_state(state, new_crtc);
356 ret = drm_atomic_helper_check_plane_state(new_plane_state, new_crtc_state,
357 DRM_PLANE_NO_SCALING,
358 DRM_PLANE_NO_SCALING,
362 else if (!new_plane_state->visible)
365 pitch = cirrus_pitch(fb);
367 /* validate size constraints */
368 if (pitch > CIRRUS_MAX_PITCH)
370 else if (pitch * fb->height > CIRRUS_VRAM_SIZE)
373 new_primary_plane_state->format = cirrus_format(fb);
374 new_primary_plane_state->pitch = pitch;
379 static void cirrus_primary_plane_helper_atomic_update(struct drm_plane *plane,
380 struct drm_atomic_state *state)
382 struct cirrus_device *cirrus = to_cirrus(plane->dev);
383 struct drm_plane_state *plane_state = drm_atomic_get_new_plane_state(state, plane);
384 struct cirrus_primary_plane_state *primary_plane_state =
385 to_cirrus_primary_plane_state(plane_state);
386 struct drm_shadow_plane_state *shadow_plane_state = to_drm_shadow_plane_state(plane_state);
387 struct drm_framebuffer *fb = plane_state->fb;
388 const struct drm_format_info *format = primary_plane_state->format;
389 unsigned int pitch = primary_plane_state->pitch;
390 struct drm_plane_state *old_plane_state = drm_atomic_get_old_plane_state(state, plane);
391 struct cirrus_primary_plane_state *old_primary_plane_state =
392 to_cirrus_primary_plane_state(old_plane_state);
393 struct iosys_map vaddr = IOSYS_MAP_INIT_VADDR_IOMEM(cirrus->vram);
394 struct drm_atomic_helper_damage_iter iter;
395 struct drm_rect damage;
401 if (!drm_dev_enter(&cirrus->dev, &idx))
404 if (old_primary_plane_state->format != format)
405 cirrus_format_set(cirrus, format);
406 if (old_primary_plane_state->pitch != pitch)
407 cirrus_pitch_set(cirrus, pitch);
409 drm_atomic_helper_damage_iter_init(&iter, old_plane_state, plane_state);
410 drm_atomic_for_each_plane_damage(&iter, &damage) {
411 unsigned int offset = drm_fb_clip_offset(pitch, format, &damage);
412 struct iosys_map dst = IOSYS_MAP_INIT_OFFSET(&vaddr, offset);
414 drm_fb_blit(&dst, &pitch, format->format, shadow_plane_state->data, fb, &damage);
420 static const struct drm_plane_helper_funcs cirrus_primary_plane_helper_funcs = {
421 DRM_GEM_SHADOW_PLANE_HELPER_FUNCS,
422 .atomic_check = cirrus_primary_plane_helper_atomic_check,
423 .atomic_update = cirrus_primary_plane_helper_atomic_update,
426 static struct drm_plane_state *
427 cirrus_primary_plane_atomic_duplicate_state(struct drm_plane *plane)
429 struct drm_plane_state *plane_state = plane->state;
430 struct cirrus_primary_plane_state *primary_plane_state =
431 to_cirrus_primary_plane_state(plane_state);
432 struct cirrus_primary_plane_state *new_primary_plane_state;
433 struct drm_shadow_plane_state *new_shadow_plane_state;
438 new_primary_plane_state = kzalloc(sizeof(*new_primary_plane_state), GFP_KERNEL);
439 if (!new_primary_plane_state)
441 new_shadow_plane_state = &new_primary_plane_state->base;
443 __drm_gem_duplicate_shadow_plane_state(plane, new_shadow_plane_state);
444 new_primary_plane_state->format = primary_plane_state->format;
445 new_primary_plane_state->pitch = primary_plane_state->pitch;
447 return &new_shadow_plane_state->base;
450 static void cirrus_primary_plane_atomic_destroy_state(struct drm_plane *plane,
451 struct drm_plane_state *plane_state)
453 struct cirrus_primary_plane_state *primary_plane_state =
454 to_cirrus_primary_plane_state(plane_state);
456 __drm_gem_destroy_shadow_plane_state(&primary_plane_state->base);
457 kfree(primary_plane_state);
460 static void cirrus_reset_primary_plane(struct drm_plane *plane)
462 struct cirrus_primary_plane_state *primary_plane_state;
465 cirrus_primary_plane_atomic_destroy_state(plane, plane->state);
466 plane->state = NULL; /* must be set to NULL here */
469 primary_plane_state = kzalloc(sizeof(*primary_plane_state), GFP_KERNEL);
470 if (!primary_plane_state)
472 __drm_gem_reset_shadow_plane(plane, &primary_plane_state->base);
475 static const struct drm_plane_funcs cirrus_primary_plane_funcs = {
476 .update_plane = drm_atomic_helper_update_plane,
477 .disable_plane = drm_atomic_helper_disable_plane,
478 .destroy = drm_plane_cleanup,
479 .reset = cirrus_reset_primary_plane,
480 .atomic_duplicate_state = cirrus_primary_plane_atomic_duplicate_state,
481 .atomic_destroy_state = cirrus_primary_plane_atomic_destroy_state,
484 static int cirrus_crtc_helper_atomic_check(struct drm_crtc *crtc, struct drm_atomic_state *state)
486 struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
489 if (!crtc_state->enable)
492 ret = drm_atomic_helper_check_crtc_primary_plane(crtc_state);
499 static void cirrus_crtc_helper_atomic_enable(struct drm_crtc *crtc,
500 struct drm_atomic_state *state)
502 struct cirrus_device *cirrus = to_cirrus(crtc->dev);
503 struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
506 if (!drm_dev_enter(&cirrus->dev, &idx))
509 cirrus_mode_set(cirrus, &crtc_state->mode);
511 /* Unblank (needed on S3 resume, vgabios doesn't do it then) */
512 outb(VGA_AR_ENABLE_DISPLAY, VGA_ATT_W);
517 static const struct drm_crtc_helper_funcs cirrus_crtc_helper_funcs = {
518 .atomic_check = cirrus_crtc_helper_atomic_check,
519 .atomic_enable = cirrus_crtc_helper_atomic_enable,
522 static const struct drm_crtc_funcs cirrus_crtc_funcs = {
523 .reset = drm_atomic_helper_crtc_reset,
524 .destroy = drm_crtc_cleanup,
525 .set_config = drm_atomic_helper_set_config,
526 .page_flip = drm_atomic_helper_page_flip,
527 .atomic_duplicate_state = drm_atomic_helper_crtc_duplicate_state,
528 .atomic_destroy_state = drm_atomic_helper_crtc_destroy_state,
531 static const struct drm_encoder_funcs cirrus_encoder_funcs = {
532 .destroy = drm_encoder_cleanup,
535 static int cirrus_connector_helper_get_modes(struct drm_connector *connector)
539 count = drm_add_modes_noedid(connector,
540 connector->dev->mode_config.max_width,
541 connector->dev->mode_config.max_height);
542 drm_set_preferred_mode(connector, 1024, 768);
546 static const struct drm_connector_helper_funcs cirrus_connector_helper_funcs = {
547 .get_modes = cirrus_connector_helper_get_modes,
550 static const struct drm_connector_funcs cirrus_connector_funcs = {
551 .fill_modes = drm_helper_probe_single_connector_modes,
552 .destroy = drm_connector_cleanup,
553 .reset = drm_atomic_helper_connector_reset,
554 .atomic_duplicate_state = drm_atomic_helper_connector_duplicate_state,
555 .atomic_destroy_state = drm_atomic_helper_connector_destroy_state,
558 static int cirrus_pipe_init(struct cirrus_device *cirrus)
560 struct drm_device *dev = &cirrus->dev;
561 struct drm_plane *primary_plane;
562 struct drm_crtc *crtc;
563 struct drm_encoder *encoder;
564 struct drm_connector *connector;
567 primary_plane = &cirrus->primary_plane;
568 ret = drm_universal_plane_init(dev, primary_plane, 0,
569 &cirrus_primary_plane_funcs,
570 cirrus_primary_plane_formats,
571 ARRAY_SIZE(cirrus_primary_plane_formats),
572 cirrus_primary_plane_format_modifiers,
573 DRM_PLANE_TYPE_PRIMARY, NULL);
576 drm_plane_helper_add(primary_plane, &cirrus_primary_plane_helper_funcs);
577 drm_plane_enable_fb_damage_clips(primary_plane);
579 crtc = &cirrus->crtc;
580 ret = drm_crtc_init_with_planes(dev, crtc, primary_plane, NULL,
581 &cirrus_crtc_funcs, NULL);
584 drm_crtc_helper_add(crtc, &cirrus_crtc_helper_funcs);
586 encoder = &cirrus->encoder;
587 ret = drm_encoder_init(dev, encoder, &cirrus_encoder_funcs,
588 DRM_MODE_ENCODER_DAC, NULL);
591 encoder->possible_crtcs = drm_crtc_mask(crtc);
593 connector = &cirrus->connector;
594 ret = drm_connector_init(dev, connector, &cirrus_connector_funcs,
595 DRM_MODE_CONNECTOR_VGA);
598 drm_connector_helper_add(connector, &cirrus_connector_helper_funcs);
600 ret = drm_connector_attach_encoder(connector, encoder);
607 /* ------------------------------------------------------------------ */
608 /* cirrus framebuffers & mode config */
610 static enum drm_mode_status cirrus_mode_config_mode_valid(struct drm_device *dev,
611 const struct drm_display_mode *mode)
613 const struct drm_format_info *format = drm_format_info(DRM_FORMAT_XRGB8888);
614 uint64_t pitch = drm_format_info_min_pitch(format, 0, mode->hdisplay);
616 if (pitch * mode->vdisplay > CIRRUS_VRAM_SIZE)
622 static const struct drm_mode_config_funcs cirrus_mode_config_funcs = {
623 .fb_create = drm_gem_fb_create_with_dirty,
624 .mode_valid = cirrus_mode_config_mode_valid,
625 .atomic_check = drm_atomic_helper_check,
626 .atomic_commit = drm_atomic_helper_commit,
629 static int cirrus_mode_config_init(struct cirrus_device *cirrus)
631 struct drm_device *dev = &cirrus->dev;
634 ret = drmm_mode_config_init(dev);
638 dev->mode_config.min_width = 0;
639 dev->mode_config.min_height = 0;
640 dev->mode_config.max_width = CIRRUS_MAX_PITCH / 2;
641 dev->mode_config.max_height = 1024;
642 dev->mode_config.preferred_depth = 16;
643 dev->mode_config.prefer_shadow = 0;
644 dev->mode_config.funcs = &cirrus_mode_config_funcs;
649 /* ------------------------------------------------------------------ */
651 DEFINE_DRM_GEM_FOPS(cirrus_fops);
653 static const struct drm_driver cirrus_driver = {
654 .driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
659 .major = DRIVER_MAJOR,
660 .minor = DRIVER_MINOR,
662 .fops = &cirrus_fops,
663 DRM_GEM_SHMEM_DRIVER_OPS,
666 static int cirrus_pci_probe(struct pci_dev *pdev,
667 const struct pci_device_id *ent)
669 struct drm_device *dev;
670 struct cirrus_device *cirrus;
673 ret = drm_aperture_remove_conflicting_pci_framebuffers(pdev, &cirrus_driver);
677 ret = pcim_enable_device(pdev);
681 ret = pci_request_regions(pdev, DRIVER_NAME);
686 cirrus = devm_drm_dev_alloc(&pdev->dev, &cirrus_driver,
687 struct cirrus_device, dev);
689 return PTR_ERR(cirrus);
693 cirrus->vram = devm_ioremap(&pdev->dev, pci_resource_start(pdev, 0),
694 pci_resource_len(pdev, 0));
695 if (cirrus->vram == NULL)
698 cirrus->mmio = devm_ioremap(&pdev->dev, pci_resource_start(pdev, 1),
699 pci_resource_len(pdev, 1));
700 if (cirrus->mmio == NULL)
703 ret = cirrus_mode_config_init(cirrus);
707 ret = cirrus_pipe_init(cirrus);
711 drm_mode_config_reset(dev);
713 pci_set_drvdata(pdev, dev);
714 ret = drm_dev_register(dev, 0);
718 drm_fbdev_generic_setup(dev, 16);
722 static void cirrus_pci_remove(struct pci_dev *pdev)
724 struct drm_device *dev = pci_get_drvdata(pdev);
727 drm_atomic_helper_shutdown(dev);
730 static const struct pci_device_id pciidlist[] = {
732 .vendor = PCI_VENDOR_ID_CIRRUS,
733 .device = PCI_DEVICE_ID_CIRRUS_5446,
734 /* only bind to the cirrus chip in qemu */
735 .subvendor = PCI_SUBVENDOR_ID_REDHAT_QUMRANET,
736 .subdevice = PCI_SUBDEVICE_ID_QEMU,
738 .vendor = PCI_VENDOR_ID_CIRRUS,
739 .device = PCI_DEVICE_ID_CIRRUS_5446,
740 .subvendor = PCI_VENDOR_ID_XEN,
743 { /* end if list */ }
746 static struct pci_driver cirrus_pci_driver = {
748 .id_table = pciidlist,
749 .probe = cirrus_pci_probe,
750 .remove = cirrus_pci_remove,
753 drm_module_pci_driver(cirrus_pci_driver)
755 MODULE_DEVICE_TABLE(pci, pciidlist);
756 MODULE_LICENSE("GPL");