Loading...
Note: File does not exist in v3.1.
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Copyright 2012-2019 Red Hat
4 *
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.
8 *
9 * Authors: Matthew Garrett
10 * Dave Airlie
11 * Gerd Hoffmann
12 *
13 * Portions of this code derived from cirrusfb.c:
14 * drivers/video/cirrusfb.c - driver for Cirrus Logic chipsets
15 *
16 * Copyright 1999-2001 Jeff Garzik <jgarzik@pobox.com>
17 */
18
19#include <linux/console.h>
20#include <linux/dma-buf-map.h>
21#include <linux/module.h>
22#include <linux/pci.h>
23
24#include <video/cirrus.h>
25#include <video/vga.h>
26
27#include <drm/drm_aperture.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_fb_helper.h>
34#include <drm/drm_file.h>
35#include <drm/drm_format_helper.h>
36#include <drm/drm_fourcc.h>
37#include <drm/drm_gem_atomic_helper.h>
38#include <drm/drm_gem_framebuffer_helper.h>
39#include <drm/drm_gem_shmem_helper.h>
40#include <drm/drm_ioctl.h>
41#include <drm/drm_managed.h>
42#include <drm/drm_modeset_helper_vtables.h>
43#include <drm/drm_probe_helper.h>
44#include <drm/drm_simple_kms_helper.h>
45
46#define DRIVER_NAME "cirrus"
47#define DRIVER_DESC "qemu cirrus vga"
48#define DRIVER_DATE "2019"
49#define DRIVER_MAJOR 2
50#define DRIVER_MINOR 0
51
52#define CIRRUS_MAX_PITCH (0x1FF << 3) /* (4096 - 1) & ~111b bytes */
53#define CIRRUS_VRAM_SIZE (4 * 1024 * 1024) /* 4 MB */
54
55struct cirrus_device {
56 struct drm_device dev;
57 struct drm_simple_display_pipe pipe;
58 struct drm_connector conn;
59 unsigned int cpp;
60 unsigned int pitch;
61 void __iomem *vram;
62 void __iomem *mmio;
63};
64
65#define to_cirrus(_dev) container_of(_dev, struct cirrus_device, dev)
66
67/* ------------------------------------------------------------------ */
68/*
69 * The meat of this driver. The core passes us a mode and we have to program
70 * it. The modesetting here is the bare minimum required to satisfy the qemu
71 * emulation of this hardware, and running this against a real device is
72 * likely to result in an inadequately programmed mode. We've already had
73 * the opportunity to modify the mode, so whatever we receive here should
74 * be something that can be correctly programmed and displayed
75 */
76
77#define SEQ_INDEX 4
78#define SEQ_DATA 5
79
80static u8 rreg_seq(struct cirrus_device *cirrus, u8 reg)
81{
82 iowrite8(reg, cirrus->mmio + SEQ_INDEX);
83 return ioread8(cirrus->mmio + SEQ_DATA);
84}
85
86static void wreg_seq(struct cirrus_device *cirrus, u8 reg, u8 val)
87{
88 iowrite8(reg, cirrus->mmio + SEQ_INDEX);
89 iowrite8(val, cirrus->mmio + SEQ_DATA);
90}
91
92#define CRT_INDEX 0x14
93#define CRT_DATA 0x15
94
95static u8 rreg_crt(struct cirrus_device *cirrus, u8 reg)
96{
97 iowrite8(reg, cirrus->mmio + CRT_INDEX);
98 return ioread8(cirrus->mmio + CRT_DATA);
99}
100
101static void wreg_crt(struct cirrus_device *cirrus, u8 reg, u8 val)
102{
103 iowrite8(reg, cirrus->mmio + CRT_INDEX);
104 iowrite8(val, cirrus->mmio + CRT_DATA);
105}
106
107#define GFX_INDEX 0xe
108#define GFX_DATA 0xf
109
110static void wreg_gfx(struct cirrus_device *cirrus, u8 reg, u8 val)
111{
112 iowrite8(reg, cirrus->mmio + GFX_INDEX);
113 iowrite8(val, cirrus->mmio + GFX_DATA);
114}
115
116#define VGA_DAC_MASK 0x06
117
118static void wreg_hdr(struct cirrus_device *cirrus, u8 val)
119{
120 ioread8(cirrus->mmio + VGA_DAC_MASK);
121 ioread8(cirrus->mmio + VGA_DAC_MASK);
122 ioread8(cirrus->mmio + VGA_DAC_MASK);
123 ioread8(cirrus->mmio + VGA_DAC_MASK);
124 iowrite8(val, cirrus->mmio + VGA_DAC_MASK);
125}
126
127static int cirrus_convert_to(struct drm_framebuffer *fb)
128{
129 if (fb->format->cpp[0] == 4 && fb->pitches[0] > CIRRUS_MAX_PITCH) {
130 if (fb->width * 3 <= CIRRUS_MAX_PITCH)
131 /* convert from XR24 to RG24 */
132 return 3;
133 else
134 /* convert from XR24 to RG16 */
135 return 2;
136 }
137 return 0;
138}
139
140static int cirrus_cpp(struct drm_framebuffer *fb)
141{
142 int convert_cpp = cirrus_convert_to(fb);
143
144 if (convert_cpp)
145 return convert_cpp;
146 return fb->format->cpp[0];
147}
148
149static int cirrus_pitch(struct drm_framebuffer *fb)
150{
151 int convert_cpp = cirrus_convert_to(fb);
152
153 if (convert_cpp)
154 return convert_cpp * fb->width;
155 return fb->pitches[0];
156}
157
158static void cirrus_set_start_address(struct cirrus_device *cirrus, u32 offset)
159{
160 int idx;
161 u32 addr;
162 u8 tmp;
163
164 if (!drm_dev_enter(&cirrus->dev, &idx))
165 return;
166
167 addr = offset >> 2;
168 wreg_crt(cirrus, 0x0c, (u8)((addr >> 8) & 0xff));
169 wreg_crt(cirrus, 0x0d, (u8)(addr & 0xff));
170
171 tmp = rreg_crt(cirrus, 0x1b);
172 tmp &= 0xf2;
173 tmp |= (addr >> 16) & 0x01;
174 tmp |= (addr >> 15) & 0x0c;
175 wreg_crt(cirrus, 0x1b, tmp);
176
177 tmp = rreg_crt(cirrus, 0x1d);
178 tmp &= 0x7f;
179 tmp |= (addr >> 12) & 0x80;
180 wreg_crt(cirrus, 0x1d, tmp);
181
182 drm_dev_exit(idx);
183}
184
185static int cirrus_mode_set(struct cirrus_device *cirrus,
186 struct drm_display_mode *mode,
187 struct drm_framebuffer *fb)
188{
189 int hsyncstart, hsyncend, htotal, hdispend;
190 int vtotal, vdispend;
191 int tmp, idx;
192 int sr07 = 0, hdr = 0;
193
194 if (!drm_dev_enter(&cirrus->dev, &idx))
195 return -1;
196
197 htotal = mode->htotal / 8;
198 hsyncend = mode->hsync_end / 8;
199 hsyncstart = mode->hsync_start / 8;
200 hdispend = mode->hdisplay / 8;
201
202 vtotal = mode->vtotal;
203 vdispend = mode->vdisplay;
204
205 vdispend -= 1;
206 vtotal -= 2;
207
208 htotal -= 5;
209 hdispend -= 1;
210 hsyncstart += 1;
211 hsyncend += 1;
212
213 wreg_crt(cirrus, VGA_CRTC_V_SYNC_END, 0x20);
214 wreg_crt(cirrus, VGA_CRTC_H_TOTAL, htotal);
215 wreg_crt(cirrus, VGA_CRTC_H_DISP, hdispend);
216 wreg_crt(cirrus, VGA_CRTC_H_SYNC_START, hsyncstart);
217 wreg_crt(cirrus, VGA_CRTC_H_SYNC_END, hsyncend);
218 wreg_crt(cirrus, VGA_CRTC_V_TOTAL, vtotal & 0xff);
219 wreg_crt(cirrus, VGA_CRTC_V_DISP_END, vdispend & 0xff);
220
221 tmp = 0x40;
222 if ((vdispend + 1) & 512)
223 tmp |= 0x20;
224 wreg_crt(cirrus, VGA_CRTC_MAX_SCAN, tmp);
225
226 /*
227 * Overflow bits for values that don't fit in the standard registers
228 */
229 tmp = 0x10;
230 if (vtotal & 0x100)
231 tmp |= 0x01;
232 if (vdispend & 0x100)
233 tmp |= 0x02;
234 if ((vdispend + 1) & 0x100)
235 tmp |= 0x08;
236 if (vtotal & 0x200)
237 tmp |= 0x20;
238 if (vdispend & 0x200)
239 tmp |= 0x40;
240 wreg_crt(cirrus, VGA_CRTC_OVERFLOW, tmp);
241
242 tmp = 0;
243
244 /* More overflow bits */
245
246 if ((htotal + 5) & 0x40)
247 tmp |= 0x10;
248 if ((htotal + 5) & 0x80)
249 tmp |= 0x20;
250 if (vtotal & 0x100)
251 tmp |= 0x40;
252 if (vtotal & 0x200)
253 tmp |= 0x80;
254
255 wreg_crt(cirrus, CL_CRT1A, tmp);
256
257 /* Disable Hercules/CGA compatibility */
258 wreg_crt(cirrus, VGA_CRTC_MODE, 0x03);
259
260 sr07 = rreg_seq(cirrus, 0x07);
261 sr07 &= 0xe0;
262 hdr = 0;
263
264 cirrus->cpp = cirrus_cpp(fb);
265 switch (cirrus->cpp * 8) {
266 case 8:
267 sr07 |= 0x11;
268 break;
269 case 16:
270 sr07 |= 0x17;
271 hdr = 0xc1;
272 break;
273 case 24:
274 sr07 |= 0x15;
275 hdr = 0xc5;
276 break;
277 case 32:
278 sr07 |= 0x19;
279 hdr = 0xc5;
280 break;
281 default:
282 drm_dev_exit(idx);
283 return -1;
284 }
285
286 wreg_seq(cirrus, 0x7, sr07);
287
288 /* Program the pitch */
289 cirrus->pitch = cirrus_pitch(fb);
290 tmp = cirrus->pitch / 8;
291 wreg_crt(cirrus, VGA_CRTC_OFFSET, tmp);
292
293 /* Enable extended blanking and pitch bits, and enable full memory */
294 tmp = 0x22;
295 tmp |= (cirrus->pitch >> 7) & 0x10;
296 tmp |= (cirrus->pitch >> 6) & 0x40;
297 wreg_crt(cirrus, 0x1b, tmp);
298
299 /* Enable high-colour modes */
300 wreg_gfx(cirrus, VGA_GFX_MODE, 0x40);
301
302 /* And set graphics mode */
303 wreg_gfx(cirrus, VGA_GFX_MISC, 0x01);
304
305 wreg_hdr(cirrus, hdr);
306
307 cirrus_set_start_address(cirrus, 0);
308
309 /* Unblank (needed on S3 resume, vgabios doesn't do it then) */
310 outb(0x20, 0x3c0);
311
312 drm_dev_exit(idx);
313 return 0;
314}
315
316static int cirrus_fb_blit_rect(struct drm_framebuffer *fb, const struct dma_buf_map *map,
317 struct drm_rect *rect)
318{
319 struct cirrus_device *cirrus = to_cirrus(fb->dev);
320 void *vmap = map->vaddr; /* TODO: Use mapping abstraction properly */
321 int idx;
322
323 if (!drm_dev_enter(&cirrus->dev, &idx))
324 return -ENODEV;
325
326 if (cirrus->cpp == fb->format->cpp[0])
327 drm_fb_memcpy_dstclip(cirrus->vram, fb->pitches[0],
328 vmap, fb, rect);
329
330 else if (fb->format->cpp[0] == 4 && cirrus->cpp == 2)
331 drm_fb_xrgb8888_to_rgb565_dstclip(cirrus->vram,
332 cirrus->pitch,
333 vmap, fb, rect, false);
334
335 else if (fb->format->cpp[0] == 4 && cirrus->cpp == 3)
336 drm_fb_xrgb8888_to_rgb888_dstclip(cirrus->vram,
337 cirrus->pitch,
338 vmap, fb, rect);
339
340 else
341 WARN_ON_ONCE("cpp mismatch");
342
343 drm_dev_exit(idx);
344
345 return 0;
346}
347
348static int cirrus_fb_blit_fullscreen(struct drm_framebuffer *fb, const struct dma_buf_map *map)
349{
350 struct drm_rect fullscreen = {
351 .x1 = 0,
352 .x2 = fb->width,
353 .y1 = 0,
354 .y2 = fb->height,
355 };
356 return cirrus_fb_blit_rect(fb, map, &fullscreen);
357}
358
359static int cirrus_check_size(int width, int height,
360 struct drm_framebuffer *fb)
361{
362 int pitch = width * 2;
363
364 if (fb)
365 pitch = cirrus_pitch(fb);
366
367 if (pitch > CIRRUS_MAX_PITCH)
368 return -EINVAL;
369 if (pitch * height > CIRRUS_VRAM_SIZE)
370 return -EINVAL;
371 return 0;
372}
373
374/* ------------------------------------------------------------------ */
375/* cirrus connector */
376
377static int cirrus_conn_get_modes(struct drm_connector *conn)
378{
379 int count;
380
381 count = drm_add_modes_noedid(conn,
382 conn->dev->mode_config.max_width,
383 conn->dev->mode_config.max_height);
384 drm_set_preferred_mode(conn, 1024, 768);
385 return count;
386}
387
388static const struct drm_connector_helper_funcs cirrus_conn_helper_funcs = {
389 .get_modes = cirrus_conn_get_modes,
390};
391
392static const struct drm_connector_funcs cirrus_conn_funcs = {
393 .fill_modes = drm_helper_probe_single_connector_modes,
394 .destroy = drm_connector_cleanup,
395 .reset = drm_atomic_helper_connector_reset,
396 .atomic_duplicate_state = drm_atomic_helper_connector_duplicate_state,
397 .atomic_destroy_state = drm_atomic_helper_connector_destroy_state,
398};
399
400static int cirrus_conn_init(struct cirrus_device *cirrus)
401{
402 drm_connector_helper_add(&cirrus->conn, &cirrus_conn_helper_funcs);
403 return drm_connector_init(&cirrus->dev, &cirrus->conn,
404 &cirrus_conn_funcs, DRM_MODE_CONNECTOR_VGA);
405
406}
407
408/* ------------------------------------------------------------------ */
409/* cirrus (simple) display pipe */
410
411static enum drm_mode_status cirrus_pipe_mode_valid(struct drm_simple_display_pipe *pipe,
412 const struct drm_display_mode *mode)
413{
414 if (cirrus_check_size(mode->hdisplay, mode->vdisplay, NULL) < 0)
415 return MODE_BAD;
416 return MODE_OK;
417}
418
419static int cirrus_pipe_check(struct drm_simple_display_pipe *pipe,
420 struct drm_plane_state *plane_state,
421 struct drm_crtc_state *crtc_state)
422{
423 struct drm_framebuffer *fb = plane_state->fb;
424
425 if (!fb)
426 return 0;
427 return cirrus_check_size(fb->width, fb->height, fb);
428}
429
430static void cirrus_pipe_enable(struct drm_simple_display_pipe *pipe,
431 struct drm_crtc_state *crtc_state,
432 struct drm_plane_state *plane_state)
433{
434 struct cirrus_device *cirrus = to_cirrus(pipe->crtc.dev);
435 struct drm_shadow_plane_state *shadow_plane_state = to_drm_shadow_plane_state(plane_state);
436
437 cirrus_mode_set(cirrus, &crtc_state->mode, plane_state->fb);
438 cirrus_fb_blit_fullscreen(plane_state->fb, &shadow_plane_state->map[0]);
439}
440
441static void cirrus_pipe_update(struct drm_simple_display_pipe *pipe,
442 struct drm_plane_state *old_state)
443{
444 struct cirrus_device *cirrus = to_cirrus(pipe->crtc.dev);
445 struct drm_plane_state *state = pipe->plane.state;
446 struct drm_shadow_plane_state *shadow_plane_state = to_drm_shadow_plane_state(state);
447 struct drm_crtc *crtc = &pipe->crtc;
448 struct drm_rect rect;
449
450 if (state->fb && cirrus->cpp != cirrus_cpp(state->fb))
451 cirrus_mode_set(cirrus, &crtc->mode, state->fb);
452
453 if (drm_atomic_helper_damage_merged(old_state, state, &rect))
454 cirrus_fb_blit_rect(state->fb, &shadow_plane_state->map[0], &rect);
455}
456
457static const struct drm_simple_display_pipe_funcs cirrus_pipe_funcs = {
458 .mode_valid = cirrus_pipe_mode_valid,
459 .check = cirrus_pipe_check,
460 .enable = cirrus_pipe_enable,
461 .update = cirrus_pipe_update,
462 DRM_GEM_SIMPLE_DISPLAY_PIPE_SHADOW_PLANE_FUNCS,
463};
464
465static const uint32_t cirrus_formats[] = {
466 DRM_FORMAT_RGB565,
467 DRM_FORMAT_RGB888,
468 DRM_FORMAT_XRGB8888,
469};
470
471static const uint64_t cirrus_modifiers[] = {
472 DRM_FORMAT_MOD_LINEAR,
473 DRM_FORMAT_MOD_INVALID
474};
475
476static int cirrus_pipe_init(struct cirrus_device *cirrus)
477{
478 return drm_simple_display_pipe_init(&cirrus->dev,
479 &cirrus->pipe,
480 &cirrus_pipe_funcs,
481 cirrus_formats,
482 ARRAY_SIZE(cirrus_formats),
483 cirrus_modifiers,
484 &cirrus->conn);
485}
486
487/* ------------------------------------------------------------------ */
488/* cirrus framebuffers & mode config */
489
490static struct drm_framebuffer*
491cirrus_fb_create(struct drm_device *dev, struct drm_file *file_priv,
492 const struct drm_mode_fb_cmd2 *mode_cmd)
493{
494 if (mode_cmd->pixel_format != DRM_FORMAT_RGB565 &&
495 mode_cmd->pixel_format != DRM_FORMAT_RGB888 &&
496 mode_cmd->pixel_format != DRM_FORMAT_XRGB8888)
497 return ERR_PTR(-EINVAL);
498 if (cirrus_check_size(mode_cmd->width, mode_cmd->height, NULL) < 0)
499 return ERR_PTR(-EINVAL);
500 return drm_gem_fb_create_with_dirty(dev, file_priv, mode_cmd);
501}
502
503static const struct drm_mode_config_funcs cirrus_mode_config_funcs = {
504 .fb_create = cirrus_fb_create,
505 .atomic_check = drm_atomic_helper_check,
506 .atomic_commit = drm_atomic_helper_commit,
507};
508
509static int cirrus_mode_config_init(struct cirrus_device *cirrus)
510{
511 struct drm_device *dev = &cirrus->dev;
512 int ret;
513
514 ret = drmm_mode_config_init(dev);
515 if (ret)
516 return ret;
517
518 dev->mode_config.min_width = 0;
519 dev->mode_config.min_height = 0;
520 dev->mode_config.max_width = CIRRUS_MAX_PITCH / 2;
521 dev->mode_config.max_height = 1024;
522 dev->mode_config.preferred_depth = 16;
523 dev->mode_config.prefer_shadow = 0;
524 dev->mode_config.funcs = &cirrus_mode_config_funcs;
525
526 return 0;
527}
528
529/* ------------------------------------------------------------------ */
530
531DEFINE_DRM_GEM_FOPS(cirrus_fops);
532
533static const struct drm_driver cirrus_driver = {
534 .driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
535
536 .name = DRIVER_NAME,
537 .desc = DRIVER_DESC,
538 .date = DRIVER_DATE,
539 .major = DRIVER_MAJOR,
540 .minor = DRIVER_MINOR,
541
542 .fops = &cirrus_fops,
543 DRM_GEM_SHMEM_DRIVER_OPS,
544};
545
546static int cirrus_pci_probe(struct pci_dev *pdev,
547 const struct pci_device_id *ent)
548{
549 struct drm_device *dev;
550 struct cirrus_device *cirrus;
551 int ret;
552
553 ret = drm_aperture_remove_conflicting_pci_framebuffers(pdev, "cirrusdrmfb");
554 if (ret)
555 return ret;
556
557 ret = pcim_enable_device(pdev);
558 if (ret)
559 return ret;
560
561 ret = pci_request_regions(pdev, DRIVER_NAME);
562 if (ret)
563 return ret;
564
565 ret = -ENOMEM;
566 cirrus = devm_drm_dev_alloc(&pdev->dev, &cirrus_driver,
567 struct cirrus_device, dev);
568 if (IS_ERR(cirrus))
569 return PTR_ERR(cirrus);
570
571 dev = &cirrus->dev;
572
573 cirrus->vram = devm_ioremap(&pdev->dev, pci_resource_start(pdev, 0),
574 pci_resource_len(pdev, 0));
575 if (cirrus->vram == NULL)
576 return -ENOMEM;
577
578 cirrus->mmio = devm_ioremap(&pdev->dev, pci_resource_start(pdev, 1),
579 pci_resource_len(pdev, 1));
580 if (cirrus->mmio == NULL)
581 return -ENOMEM;
582
583 ret = cirrus_mode_config_init(cirrus);
584 if (ret)
585 return ret;
586
587 ret = cirrus_conn_init(cirrus);
588 if (ret < 0)
589 return ret;
590
591 ret = cirrus_pipe_init(cirrus);
592 if (ret < 0)
593 return ret;
594
595 drm_mode_config_reset(dev);
596
597 pci_set_drvdata(pdev, dev);
598 ret = drm_dev_register(dev, 0);
599 if (ret)
600 return ret;
601
602 drm_fbdev_generic_setup(dev, dev->mode_config.preferred_depth);
603 return 0;
604}
605
606static void cirrus_pci_remove(struct pci_dev *pdev)
607{
608 struct drm_device *dev = pci_get_drvdata(pdev);
609
610 drm_dev_unplug(dev);
611 drm_atomic_helper_shutdown(dev);
612}
613
614static const struct pci_device_id pciidlist[] = {
615 {
616 .vendor = PCI_VENDOR_ID_CIRRUS,
617 .device = PCI_DEVICE_ID_CIRRUS_5446,
618 /* only bind to the cirrus chip in qemu */
619 .subvendor = PCI_SUBVENDOR_ID_REDHAT_QUMRANET,
620 .subdevice = PCI_SUBDEVICE_ID_QEMU,
621 }, {
622 .vendor = PCI_VENDOR_ID_CIRRUS,
623 .device = PCI_DEVICE_ID_CIRRUS_5446,
624 .subvendor = PCI_VENDOR_ID_XEN,
625 .subdevice = 0x0001,
626 },
627 { /* end if list */ }
628};
629
630static struct pci_driver cirrus_pci_driver = {
631 .name = DRIVER_NAME,
632 .id_table = pciidlist,
633 .probe = cirrus_pci_probe,
634 .remove = cirrus_pci_remove,
635};
636
637static int __init cirrus_init(void)
638{
639 if (vgacon_text_force())
640 return -EINVAL;
641 return pci_register_driver(&cirrus_pci_driver);
642}
643
644static void __exit cirrus_exit(void)
645{
646 pci_unregister_driver(&cirrus_pci_driver);
647}
648
649module_init(cirrus_init);
650module_exit(cirrus_exit);
651
652MODULE_DEVICE_TABLE(pci, pciidlist);
653MODULE_LICENSE("GPL");