2 * QEMU VMware-SVGA "chipset".
4 * Copyright (c) 2007 Andrzej Zaborowski <balrog@zabor.org>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 #include "qemu/osdep.h"
26 #include "qemu/module.h"
27 #include "qemu/units.h"
28 #include "qapi/error.h"
30 #include "hw/loader.h"
33 #include "hw/pci/pci.h"
34 #include "hw/qdev-properties.h"
35 #include "migration/vmstate.h"
36 #include "qom/object.h"
41 #define HW_MOUSE_ACCEL
45 /* See http://vmware-svga.sf.net/ for some documentation on VMWare SVGA */
47 struct vmsvga_state_s
{
70 MemoryRegion fifo_ram
;
72 unsigned int fifo_size
;
80 #define REDRAW_FIFO_LEN 512
81 struct vmsvga_rect_s
{
83 } redraw_fifo
[REDRAW_FIFO_LEN
];
84 int redraw_fifo_first
, redraw_fifo_last
;
87 #define TYPE_VMWARE_SVGA "vmware-svga"
89 DECLARE_INSTANCE_CHECKER(struct pci_vmsvga_state_s
, VMWARE_SVGA
,
92 struct pci_vmsvga_state_s
{
97 struct vmsvga_state_s chip
;
101 #define SVGA_MAGIC 0x900000UL
102 #define SVGA_MAKE_ID(ver) (SVGA_MAGIC << 8 | (ver))
103 #define SVGA_ID_0 SVGA_MAKE_ID(0)
104 #define SVGA_ID_1 SVGA_MAKE_ID(1)
105 #define SVGA_ID_2 SVGA_MAKE_ID(2)
107 #define SVGA_LEGACY_BASE_PORT 0x4560
108 #define SVGA_INDEX_PORT 0x0
109 #define SVGA_VALUE_PORT 0x1
110 #define SVGA_BIOS_PORT 0x2
112 #define SVGA_VERSION_2
114 #ifdef SVGA_VERSION_2
115 # define SVGA_ID SVGA_ID_2
116 # define SVGA_IO_BASE SVGA_LEGACY_BASE_PORT
117 # define SVGA_IO_MUL 1
118 # define SVGA_FIFO_SIZE 0x10000
119 # define SVGA_PCI_DEVICE_ID PCI_DEVICE_ID_VMWARE_SVGA2
121 # define SVGA_ID SVGA_ID_1
122 # define SVGA_IO_BASE SVGA_LEGACY_BASE_PORT
123 # define SVGA_IO_MUL 4
124 # define SVGA_FIFO_SIZE 0x10000
125 # define SVGA_PCI_DEVICE_ID PCI_DEVICE_ID_VMWARE_SVGA
129 /* ID 0, 1 and 2 registers */
134 SVGA_REG_MAX_WIDTH
= 4,
135 SVGA_REG_MAX_HEIGHT
= 5,
137 SVGA_REG_BITS_PER_PIXEL
= 7, /* Current bpp in the guest */
138 SVGA_REG_PSEUDOCOLOR
= 8,
139 SVGA_REG_RED_MASK
= 9,
140 SVGA_REG_GREEN_MASK
= 10,
141 SVGA_REG_BLUE_MASK
= 11,
142 SVGA_REG_BYTES_PER_LINE
= 12,
143 SVGA_REG_FB_START
= 13,
144 SVGA_REG_FB_OFFSET
= 14,
145 SVGA_REG_VRAM_SIZE
= 15,
146 SVGA_REG_FB_SIZE
= 16,
148 /* ID 1 and 2 registers */
149 SVGA_REG_CAPABILITIES
= 17,
150 SVGA_REG_MEM_START
= 18, /* Memory for command FIFO */
151 SVGA_REG_MEM_SIZE
= 19,
152 SVGA_REG_CONFIG_DONE
= 20, /* Set when memory area configured */
153 SVGA_REG_SYNC
= 21, /* Write to force synchronization */
154 SVGA_REG_BUSY
= 22, /* Read to check if sync is done */
155 SVGA_REG_GUEST_ID
= 23, /* Set guest OS identifier */
156 SVGA_REG_CURSOR_ID
= 24, /* ID of cursor */
157 SVGA_REG_CURSOR_X
= 25, /* Set cursor X position */
158 SVGA_REG_CURSOR_Y
= 26, /* Set cursor Y position */
159 SVGA_REG_CURSOR_ON
= 27, /* Turn cursor on/off */
160 SVGA_REG_HOST_BITS_PER_PIXEL
= 28, /* Current bpp in the host */
161 SVGA_REG_SCRATCH_SIZE
= 29, /* Number of scratch registers */
162 SVGA_REG_MEM_REGS
= 30, /* Number of FIFO registers */
163 SVGA_REG_NUM_DISPLAYS
= 31, /* Number of guest displays */
164 SVGA_REG_PITCHLOCK
= 32, /* Fixed pitch for all modes */
166 SVGA_PALETTE_BASE
= 1024, /* Base of SVGA color map */
167 SVGA_PALETTE_END
= SVGA_PALETTE_BASE
+ 767,
168 SVGA_SCRATCH_BASE
= SVGA_PALETTE_BASE
+ 768,
171 #define SVGA_CAP_NONE 0
172 #define SVGA_CAP_RECT_FILL (1 << 0)
173 #define SVGA_CAP_RECT_COPY (1 << 1)
174 #define SVGA_CAP_RECT_PAT_FILL (1 << 2)
175 #define SVGA_CAP_LEGACY_OFFSCREEN (1 << 3)
176 #define SVGA_CAP_RASTER_OP (1 << 4)
177 #define SVGA_CAP_CURSOR (1 << 5)
178 #define SVGA_CAP_CURSOR_BYPASS (1 << 6)
179 #define SVGA_CAP_CURSOR_BYPASS_2 (1 << 7)
180 #define SVGA_CAP_8BIT_EMULATION (1 << 8)
181 #define SVGA_CAP_ALPHA_CURSOR (1 << 9)
182 #define SVGA_CAP_GLYPH (1 << 10)
183 #define SVGA_CAP_GLYPH_CLIPPING (1 << 11)
184 #define SVGA_CAP_OFFSCREEN_1 (1 << 12)
185 #define SVGA_CAP_ALPHA_BLEND (1 << 13)
186 #define SVGA_CAP_3D (1 << 14)
187 #define SVGA_CAP_EXTENDED_FIFO (1 << 15)
188 #define SVGA_CAP_MULTIMON (1 << 16)
189 #define SVGA_CAP_PITCHLOCK (1 << 17)
192 * FIFO offsets (seen as an array of 32-bit words)
196 * The original defined FIFO offsets
199 SVGA_FIFO_MAX
, /* The distance from MIN to MAX must be at least 10K */
204 * Additional offsets added as of SVGA_CAP_EXTENDED_FIFO
206 SVGA_FIFO_CAPABILITIES
= 4,
209 SVGA_FIFO_3D_HWVERSION
,
213 #define SVGA_FIFO_CAP_NONE 0
214 #define SVGA_FIFO_CAP_FENCE (1 << 0)
215 #define SVGA_FIFO_CAP_ACCELFRONT (1 << 1)
216 #define SVGA_FIFO_CAP_PITCHLOCK (1 << 2)
218 #define SVGA_FIFO_FLAG_NONE 0
219 #define SVGA_FIFO_FLAG_ACCELFRONT (1 << 0)
221 /* These values can probably be changed arbitrarily. */
222 #define SVGA_SCRATCH_SIZE 0x8000
223 #define SVGA_MAX_WIDTH ROUND_UP(2360, VNC_DIRTY_PIXELS_PER_BIT)
224 #define SVGA_MAX_HEIGHT 1770
227 # define GUEST_OS_BASE 0x5001
228 static const char *vmsvga_guest_id
[] = {
230 [0x01] = "Windows 3.1",
231 [0x02] = "Windows 95",
232 [0x03] = "Windows 98",
233 [0x04] = "Windows ME",
234 [0x05] = "Windows NT",
235 [0x06] = "Windows 2000",
238 [0x09] = "an unknown OS",
241 [0x0c] = "an unknown OS",
242 [0x0d] = "an unknown OS",
243 [0x0e] = "an unknown OS",
244 [0x0f] = "an unknown OS",
245 [0x10] = "an unknown OS",
246 [0x11] = "an unknown OS",
247 [0x12] = "an unknown OS",
248 [0x13] = "an unknown OS",
249 [0x14] = "an unknown OS",
250 [0x15] = "Windows 2003",
255 SVGA_CMD_INVALID_CMD
= 0,
257 SVGA_CMD_RECT_FILL
= 2,
258 SVGA_CMD_RECT_COPY
= 3,
259 SVGA_CMD_DEFINE_BITMAP
= 4,
260 SVGA_CMD_DEFINE_BITMAP_SCANLINE
= 5,
261 SVGA_CMD_DEFINE_PIXMAP
= 6,
262 SVGA_CMD_DEFINE_PIXMAP_SCANLINE
= 7,
263 SVGA_CMD_RECT_BITMAP_FILL
= 8,
264 SVGA_CMD_RECT_PIXMAP_FILL
= 9,
265 SVGA_CMD_RECT_BITMAP_COPY
= 10,
266 SVGA_CMD_RECT_PIXMAP_COPY
= 11,
267 SVGA_CMD_FREE_OBJECT
= 12,
268 SVGA_CMD_RECT_ROP_FILL
= 13,
269 SVGA_CMD_RECT_ROP_COPY
= 14,
270 SVGA_CMD_RECT_ROP_BITMAP_FILL
= 15,
271 SVGA_CMD_RECT_ROP_PIXMAP_FILL
= 16,
272 SVGA_CMD_RECT_ROP_BITMAP_COPY
= 17,
273 SVGA_CMD_RECT_ROP_PIXMAP_COPY
= 18,
274 SVGA_CMD_DEFINE_CURSOR
= 19,
275 SVGA_CMD_DISPLAY_CURSOR
= 20,
276 SVGA_CMD_MOVE_CURSOR
= 21,
277 SVGA_CMD_DEFINE_ALPHA_CURSOR
= 22,
278 SVGA_CMD_DRAW_GLYPH
= 23,
279 SVGA_CMD_DRAW_GLYPH_CLIPPED
= 24,
280 SVGA_CMD_UPDATE_VERBOSE
= 25,
281 SVGA_CMD_SURFACE_FILL
= 26,
282 SVGA_CMD_SURFACE_COPY
= 27,
283 SVGA_CMD_SURFACE_ALPHA_BLEND
= 28,
284 SVGA_CMD_FRONT_ROP_FILL
= 29,
288 /* Legal values for the SVGA_REG_CURSOR_ON register in cursor bypass mode */
290 SVGA_CURSOR_ON_HIDE
= 0,
291 SVGA_CURSOR_ON_SHOW
= 1,
292 SVGA_CURSOR_ON_REMOVE_FROM_FB
= 2,
293 SVGA_CURSOR_ON_RESTORE_TO_FB
= 3,
296 static inline bool vmsvga_verify_rect(DisplaySurface
*surface
,
298 int x
, int y
, int w
, int h
)
301 fprintf(stderr
, "%s: x was < 0 (%d)\n", name
, x
);
304 if (x
> SVGA_MAX_WIDTH
) {
305 fprintf(stderr
, "%s: x was > %d (%d)\n", name
, SVGA_MAX_WIDTH
, x
);
309 fprintf(stderr
, "%s: w was < 0 (%d)\n", name
, w
);
312 if (w
> SVGA_MAX_WIDTH
) {
313 fprintf(stderr
, "%s: w was > %d (%d)\n", name
, SVGA_MAX_WIDTH
, w
);
316 if (x
+ w
> surface_width(surface
)) {
317 fprintf(stderr
, "%s: width was > %d (x: %d, w: %d)\n",
318 name
, surface_width(surface
), x
, w
);
323 fprintf(stderr
, "%s: y was < 0 (%d)\n", name
, y
);
326 if (y
> SVGA_MAX_HEIGHT
) {
327 fprintf(stderr
, "%s: y was > %d (%d)\n", name
, SVGA_MAX_HEIGHT
, y
);
331 fprintf(stderr
, "%s: h was < 0 (%d)\n", name
, h
);
334 if (h
> SVGA_MAX_HEIGHT
) {
335 fprintf(stderr
, "%s: h was > %d (%d)\n", name
, SVGA_MAX_HEIGHT
, h
);
338 if (y
+ h
> surface_height(surface
)) {
339 fprintf(stderr
, "%s: update height > %d (y: %d, h: %d)\n",
340 name
, surface_height(surface
), y
, h
);
347 static inline void vmsvga_update_rect(struct vmsvga_state_s
*s
,
348 int x
, int y
, int w
, int h
)
350 DisplaySurface
*surface
= qemu_console_surface(s
->vga
.con
);
358 if (!vmsvga_verify_rect(surface
, __func__
, x
, y
, w
, h
)) {
359 /* go for a fullscreen update as fallback */
362 w
= surface_width(surface
);
363 h
= surface_height(surface
);
366 bypl
= surface_stride(surface
);
367 width
= surface_bytes_per_pixel(surface
) * w
;
368 start
= surface_bytes_per_pixel(surface
) * x
+ bypl
* y
;
369 src
= s
->vga
.vram_ptr
+ start
;
370 dst
= surface_data(surface
) + start
;
372 for (line
= h
; line
> 0; line
--, src
+= bypl
, dst
+= bypl
) {
373 memcpy(dst
, src
, width
);
375 dpy_gfx_update(s
->vga
.con
, x
, y
, w
, h
);
378 static inline void vmsvga_update_rect_delayed(struct vmsvga_state_s
*s
,
379 int x
, int y
, int w
, int h
)
381 struct vmsvga_rect_s
*rect
= &s
->redraw_fifo
[s
->redraw_fifo_last
++];
383 s
->redraw_fifo_last
&= REDRAW_FIFO_LEN
- 1;
390 static inline void vmsvga_update_rect_flush(struct vmsvga_state_s
*s
)
392 struct vmsvga_rect_s
*rect
;
394 if (s
->invalidated
) {
395 s
->redraw_fifo_first
= s
->redraw_fifo_last
;
398 /* Overlapping region updates can be optimised out here - if someone
399 * knows a smart algorithm to do that, please share. */
400 while (s
->redraw_fifo_first
!= s
->redraw_fifo_last
) {
401 rect
= &s
->redraw_fifo
[s
->redraw_fifo_first
++];
402 s
->redraw_fifo_first
&= REDRAW_FIFO_LEN
- 1;
403 vmsvga_update_rect(s
, rect
->x
, rect
->y
, rect
->w
, rect
->h
);
408 static inline int vmsvga_copy_rect(struct vmsvga_state_s
*s
,
409 int x0
, int y0
, int x1
, int y1
, int w
, int h
)
411 DisplaySurface
*surface
= qemu_console_surface(s
->vga
.con
);
412 uint8_t *vram
= s
->vga
.vram_ptr
;
413 int bypl
= surface_stride(surface
);
414 int bypp
= surface_bytes_per_pixel(surface
);
415 int width
= bypp
* w
;
419 if (!vmsvga_verify_rect(surface
, "vmsvga_copy_rect/src", x0
, y0
, w
, h
)) {
422 if (!vmsvga_verify_rect(surface
, "vmsvga_copy_rect/dst", x1
, y1
, w
, h
)) {
427 ptr
[0] = vram
+ bypp
* x0
+ bypl
* (y0
+ h
- 1);
428 ptr
[1] = vram
+ bypp
* x1
+ bypl
* (y1
+ h
- 1);
429 for (; line
> 0; line
--, ptr
[0] -= bypl
, ptr
[1] -= bypl
) {
430 memmove(ptr
[1], ptr
[0], width
);
433 ptr
[0] = vram
+ bypp
* x0
+ bypl
* y0
;
434 ptr
[1] = vram
+ bypp
* x1
+ bypl
* y1
;
435 for (; line
> 0; line
--, ptr
[0] += bypl
, ptr
[1] += bypl
) {
436 memmove(ptr
[1], ptr
[0], width
);
440 vmsvga_update_rect_delayed(s
, x1
, y1
, w
, h
);
446 static inline int vmsvga_fill_rect(struct vmsvga_state_s
*s
,
447 uint32_t c
, int x
, int y
, int w
, int h
)
449 DisplaySurface
*surface
= qemu_console_surface(s
->vga
.con
);
450 int bypl
= surface_stride(surface
);
451 int width
= surface_bytes_per_pixel(surface
) * w
;
459 if (!vmsvga_verify_rect(surface
, __func__
, x
, y
, w
, h
)) {
468 fst
= s
->vga
.vram_ptr
+ surface_bytes_per_pixel(surface
) * x
+ bypl
* y
;
473 for (column
= width
; column
> 0; column
--) {
475 if (src
- col
== surface_bytes_per_pixel(surface
)) {
480 for (; line
> 0; line
--) {
482 memcpy(dst
, fst
, width
);
486 vmsvga_update_rect_delayed(s
, x
, y
, w
, h
);
491 struct vmsvga_cursor_definition_s
{
499 uint32_t image
[4096];
502 #define SVGA_BITMAP_SIZE(w, h) ((((w) + 31) >> 5) * (h))
503 #define SVGA_PIXMAP_SIZE(w, h, bpp) (((((w) * (bpp)) + 31) >> 5) * (h))
505 #ifdef HW_MOUSE_ACCEL
506 static inline void vmsvga_cursor_define(struct vmsvga_state_s
*s
,
507 struct vmsvga_cursor_definition_s
*c
)
512 qc
= cursor_alloc(c
->width
, c
->height
);
513 qc
->hot_x
= c
->hot_x
;
514 qc
->hot_y
= c
->hot_y
;
517 cursor_set_mono(qc
, 0xffffff, 0x000000, (void *)c
->image
,
520 cursor_print_ascii_art(qc
, "vmware/mono");
524 /* fill alpha channel from mask, set color to zero */
525 cursor_set_mono(qc
, 0x000000, 0x000000, (void *)c
->mask
,
527 /* add in rgb values */
528 pixels
= c
->width
* c
->height
;
529 for (i
= 0; i
< pixels
; i
++) {
530 qc
->data
[i
] |= c
->image
[i
] & 0xffffff;
533 cursor_print_ascii_art(qc
, "vmware/32bit");
537 fprintf(stderr
, "%s: unhandled bpp %d, using fallback cursor\n",
540 qc
= cursor_builtin_left_ptr();
543 dpy_cursor_define(s
->vga
.con
, qc
);
548 static inline int vmsvga_fifo_length(struct vmsvga_state_s
*s
)
552 if (!s
->config
|| !s
->enable
) {
556 s
->fifo_min
= le32_to_cpu(s
->fifo
[SVGA_FIFO_MIN
]);
557 s
->fifo_max
= le32_to_cpu(s
->fifo
[SVGA_FIFO_MAX
]);
558 s
->fifo_next
= le32_to_cpu(s
->fifo
[SVGA_FIFO_NEXT
]);
559 s
->fifo_stop
= le32_to_cpu(s
->fifo
[SVGA_FIFO_STOP
]);
561 /* Check range and alignment. */
562 if ((s
->fifo_min
| s
->fifo_max
| s
->fifo_next
| s
->fifo_stop
) & 3) {
565 if (s
->fifo_min
< sizeof(uint32_t) * 4) {
568 if (s
->fifo_max
> SVGA_FIFO_SIZE
||
569 s
->fifo_min
>= SVGA_FIFO_SIZE
||
570 s
->fifo_stop
>= SVGA_FIFO_SIZE
||
571 s
->fifo_next
>= SVGA_FIFO_SIZE
) {
574 if (s
->fifo_max
< s
->fifo_min
+ 10 * KiB
) {
578 num
= s
->fifo_next
- s
->fifo_stop
;
580 num
+= s
->fifo_max
- s
->fifo_min
;
585 static inline uint32_t vmsvga_fifo_read_raw(struct vmsvga_state_s
*s
)
587 uint32_t cmd
= s
->fifo
[s
->fifo_stop
>> 2];
590 if (s
->fifo_stop
>= s
->fifo_max
) {
591 s
->fifo_stop
= s
->fifo_min
;
593 s
->fifo
[SVGA_FIFO_STOP
] = cpu_to_le32(s
->fifo_stop
);
597 static inline uint32_t vmsvga_fifo_read(struct vmsvga_state_s
*s
)
599 return le32_to_cpu(vmsvga_fifo_read_raw(s
));
602 static void vmsvga_fifo_run(struct vmsvga_state_s
*s
)
604 uint32_t cmd
, colour
;
605 int args
, len
, maxloop
= 1024;
606 int x
, y
, dx
, dy
, width
, height
;
607 struct vmsvga_cursor_definition_s cursor
;
610 len
= vmsvga_fifo_length(s
);
611 while (len
> 0 && --maxloop
> 0) {
612 /* May need to go back to the start of the command if incomplete */
613 cmd_start
= s
->fifo_stop
;
615 switch (cmd
= vmsvga_fifo_read(s
)) {
616 case SVGA_CMD_UPDATE
:
617 case SVGA_CMD_UPDATE_VERBOSE
:
623 x
= vmsvga_fifo_read(s
);
624 y
= vmsvga_fifo_read(s
);
625 width
= vmsvga_fifo_read(s
);
626 height
= vmsvga_fifo_read(s
);
627 vmsvga_update_rect_delayed(s
, x
, y
, width
, height
);
630 case SVGA_CMD_RECT_FILL
:
636 colour
= vmsvga_fifo_read(s
);
637 x
= vmsvga_fifo_read(s
);
638 y
= vmsvga_fifo_read(s
);
639 width
= vmsvga_fifo_read(s
);
640 height
= vmsvga_fifo_read(s
);
642 if (vmsvga_fill_rect(s
, colour
, x
, y
, width
, height
) == 0) {
649 case SVGA_CMD_RECT_COPY
:
655 x
= vmsvga_fifo_read(s
);
656 y
= vmsvga_fifo_read(s
);
657 dx
= vmsvga_fifo_read(s
);
658 dy
= vmsvga_fifo_read(s
);
659 width
= vmsvga_fifo_read(s
);
660 height
= vmsvga_fifo_read(s
);
662 if (vmsvga_copy_rect(s
, x
, y
, dx
, dy
, width
, height
) == 0) {
669 case SVGA_CMD_DEFINE_CURSOR
:
675 cursor
.id
= vmsvga_fifo_read(s
);
676 cursor
.hot_x
= vmsvga_fifo_read(s
);
677 cursor
.hot_y
= vmsvga_fifo_read(s
);
678 cursor
.width
= x
= vmsvga_fifo_read(s
);
679 cursor
.height
= y
= vmsvga_fifo_read(s
);
681 cursor
.bpp
= vmsvga_fifo_read(s
);
683 args
= SVGA_BITMAP_SIZE(x
, y
) + SVGA_PIXMAP_SIZE(x
, y
, cursor
.bpp
);
684 if (cursor
.width
> 256
685 || cursor
.height
> 256
687 || SVGA_BITMAP_SIZE(x
, y
) > ARRAY_SIZE(cursor
.mask
)
688 || SVGA_PIXMAP_SIZE(x
, y
, cursor
.bpp
)
689 > ARRAY_SIZE(cursor
.image
)) {
698 for (args
= 0; args
< SVGA_BITMAP_SIZE(x
, y
); args
++) {
699 cursor
.mask
[args
] = vmsvga_fifo_read_raw(s
);
701 for (args
= 0; args
< SVGA_PIXMAP_SIZE(x
, y
, cursor
.bpp
); args
++) {
702 cursor
.image
[args
] = vmsvga_fifo_read_raw(s
);
704 #ifdef HW_MOUSE_ACCEL
705 vmsvga_cursor_define(s
, &cursor
);
713 * Other commands that we at least know the number of arguments
714 * for so we can avoid FIFO desync if driver uses them illegally.
716 case SVGA_CMD_DEFINE_ALPHA_CURSOR
:
724 x
= vmsvga_fifo_read(s
);
725 y
= vmsvga_fifo_read(s
);
728 case SVGA_CMD_RECT_ROP_FILL
:
731 case SVGA_CMD_RECT_ROP_COPY
:
734 case SVGA_CMD_DRAW_GLYPH_CLIPPED
:
741 args
= 7 + (vmsvga_fifo_read(s
) >> 2);
743 case SVGA_CMD_SURFACE_ALPHA_BLEND
:
748 * Other commands that are not listed as depending on any
749 * CAPABILITIES bits, but are not described in the README either.
751 case SVGA_CMD_SURFACE_FILL
:
752 case SVGA_CMD_SURFACE_COPY
:
753 case SVGA_CMD_FRONT_ROP_FILL
:
755 case SVGA_CMD_INVALID_CMD
:
768 printf("%s: Unknown command 0x%02x in SVGA command FIFO\n",
773 s
->fifo_stop
= cmd_start
;
774 s
->fifo
[SVGA_FIFO_STOP
] = cpu_to_le32(s
->fifo_stop
);
782 static uint32_t vmsvga_index_read(void *opaque
, uint32_t address
)
784 struct vmsvga_state_s
*s
= opaque
;
789 static void vmsvga_index_write(void *opaque
, uint32_t address
, uint32_t index
)
791 struct vmsvga_state_s
*s
= opaque
;
796 static uint32_t vmsvga_value_read(void *opaque
, uint32_t address
)
799 struct vmsvga_state_s
*s
= opaque
;
800 DisplaySurface
*surface
= qemu_console_surface(s
->vga
.con
);
809 case SVGA_REG_ENABLE
:
814 ret
= s
->new_width
? s
->new_width
: surface_width(surface
);
817 case SVGA_REG_HEIGHT
:
818 ret
= s
->new_height
? s
->new_height
: surface_height(surface
);
821 case SVGA_REG_MAX_WIDTH
:
822 ret
= SVGA_MAX_WIDTH
;
825 case SVGA_REG_MAX_HEIGHT
:
826 ret
= SVGA_MAX_HEIGHT
;
830 ret
= (s
->new_depth
== 32) ? 24 : s
->new_depth
;
833 case SVGA_REG_BITS_PER_PIXEL
:
834 case SVGA_REG_HOST_BITS_PER_PIXEL
:
838 case SVGA_REG_PSEUDOCOLOR
:
842 case SVGA_REG_RED_MASK
:
843 pf
= qemu_default_pixelformat(s
->new_depth
);
847 case SVGA_REG_GREEN_MASK
:
848 pf
= qemu_default_pixelformat(s
->new_depth
);
852 case SVGA_REG_BLUE_MASK
:
853 pf
= qemu_default_pixelformat(s
->new_depth
);
857 case SVGA_REG_BYTES_PER_LINE
:
859 ret
= (s
->new_depth
* s
->new_width
) / 8;
861 ret
= surface_stride(surface
);
865 case SVGA_REG_FB_START
: {
866 struct pci_vmsvga_state_s
*pci_vmsvga
867 = container_of(s
, struct pci_vmsvga_state_s
, chip
);
868 ret
= pci_get_bar_addr(PCI_DEVICE(pci_vmsvga
), 1);
872 case SVGA_REG_FB_OFFSET
:
876 case SVGA_REG_VRAM_SIZE
:
877 ret
= s
->vga
.vram_size
; /* No physical VRAM besides the framebuffer */
880 case SVGA_REG_FB_SIZE
:
881 ret
= s
->vga
.vram_size
;
884 case SVGA_REG_CAPABILITIES
:
885 caps
= SVGA_CAP_NONE
;
887 caps
|= SVGA_CAP_RECT_COPY
;
890 caps
|= SVGA_CAP_RECT_FILL
;
892 #ifdef HW_MOUSE_ACCEL
893 if (dpy_cursor_define_supported(s
->vga
.con
)) {
894 caps
|= SVGA_CAP_CURSOR
| SVGA_CAP_CURSOR_BYPASS_2
|
895 SVGA_CAP_CURSOR_BYPASS
;
901 case SVGA_REG_MEM_START
: {
902 struct pci_vmsvga_state_s
*pci_vmsvga
903 = container_of(s
, struct pci_vmsvga_state_s
, chip
);
904 ret
= pci_get_bar_addr(PCI_DEVICE(pci_vmsvga
), 2);
908 case SVGA_REG_MEM_SIZE
:
912 case SVGA_REG_CONFIG_DONE
:
921 case SVGA_REG_GUEST_ID
:
925 case SVGA_REG_CURSOR_ID
:
929 case SVGA_REG_CURSOR_X
:
933 case SVGA_REG_CURSOR_Y
:
937 case SVGA_REG_CURSOR_ON
:
941 case SVGA_REG_SCRATCH_SIZE
:
942 ret
= s
->scratch_size
;
945 case SVGA_REG_MEM_REGS
:
946 case SVGA_REG_NUM_DISPLAYS
:
947 case SVGA_REG_PITCHLOCK
:
948 case SVGA_PALETTE_BASE
... SVGA_PALETTE_END
:
953 if (s
->index
>= SVGA_SCRATCH_BASE
&&
954 s
->index
< SVGA_SCRATCH_BASE
+ s
->scratch_size
) {
955 ret
= s
->scratch
[s
->index
- SVGA_SCRATCH_BASE
];
958 qemu_log_mask(LOG_GUEST_ERROR
,
959 "%s: Bad register %02x\n", __func__
, s
->index
);
964 if (s
->index
>= SVGA_SCRATCH_BASE
) {
965 trace_vmware_scratch_read(s
->index
, ret
);
966 } else if (s
->index
>= SVGA_PALETTE_BASE
) {
967 trace_vmware_palette_read(s
->index
, ret
);
969 trace_vmware_value_read(s
->index
, ret
);
974 static void vmsvga_value_write(void *opaque
, uint32_t address
, uint32_t value
)
976 struct vmsvga_state_s
*s
= opaque
;
978 if (s
->index
>= SVGA_SCRATCH_BASE
) {
979 trace_vmware_scratch_write(s
->index
, value
);
980 } else if (s
->index
>= SVGA_PALETTE_BASE
) {
981 trace_vmware_palette_write(s
->index
, value
);
983 trace_vmware_value_write(s
->index
, value
);
987 if (value
== SVGA_ID_2
|| value
== SVGA_ID_1
|| value
== SVGA_ID_0
) {
992 case SVGA_REG_ENABLE
:
995 s
->vga
.hw_ops
->invalidate(&s
->vga
);
996 if (s
->enable
&& s
->config
) {
997 vga_dirty_log_stop(&s
->vga
);
999 vga_dirty_log_start(&s
->vga
);
1003 case SVGA_REG_WIDTH
:
1004 if (value
<= SVGA_MAX_WIDTH
) {
1005 s
->new_width
= value
;
1008 qemu_log_mask(LOG_GUEST_ERROR
,
1009 "%s: Bad width: %i\n", __func__
, value
);
1013 case SVGA_REG_HEIGHT
:
1014 if (value
<= SVGA_MAX_HEIGHT
) {
1015 s
->new_height
= value
;
1018 qemu_log_mask(LOG_GUEST_ERROR
,
1019 "%s: Bad height: %i\n", __func__
, value
);
1023 case SVGA_REG_BITS_PER_PIXEL
:
1025 qemu_log_mask(LOG_GUEST_ERROR
,
1026 "%s: Bad bits per pixel: %i bits\n", __func__
, value
);
1032 case SVGA_REG_CONFIG_DONE
:
1034 s
->fifo
= (uint32_t *) s
->fifo_ptr
;
1035 vga_dirty_log_stop(&s
->vga
);
1037 s
->config
= !!value
;
1042 vmsvga_fifo_run(s
); /* Or should we just wait for update_display? */
1045 case SVGA_REG_GUEST_ID
:
1048 if (value
>= GUEST_OS_BASE
&& value
< GUEST_OS_BASE
+
1049 ARRAY_SIZE(vmsvga_guest_id
)) {
1050 printf("%s: guest runs %s.\n", __func__
,
1051 vmsvga_guest_id
[value
- GUEST_OS_BASE
]);
1056 case SVGA_REG_CURSOR_ID
:
1057 s
->cursor
.id
= value
;
1060 case SVGA_REG_CURSOR_X
:
1061 s
->cursor
.x
= value
;
1064 case SVGA_REG_CURSOR_Y
:
1065 s
->cursor
.y
= value
;
1068 case SVGA_REG_CURSOR_ON
:
1069 s
->cursor
.on
|= (value
== SVGA_CURSOR_ON_SHOW
);
1070 s
->cursor
.on
&= (value
!= SVGA_CURSOR_ON_HIDE
);
1071 #ifdef HW_MOUSE_ACCEL
1072 if (value
<= SVGA_CURSOR_ON_SHOW
) {
1073 dpy_mouse_set(s
->vga
.con
, s
->cursor
.x
, s
->cursor
.y
, s
->cursor
.on
);
1078 case SVGA_REG_DEPTH
:
1079 case SVGA_REG_MEM_REGS
:
1080 case SVGA_REG_NUM_DISPLAYS
:
1081 case SVGA_REG_PITCHLOCK
:
1082 case SVGA_PALETTE_BASE
... SVGA_PALETTE_END
:
1086 if (s
->index
>= SVGA_SCRATCH_BASE
&&
1087 s
->index
< SVGA_SCRATCH_BASE
+ s
->scratch_size
) {
1088 s
->scratch
[s
->index
- SVGA_SCRATCH_BASE
] = value
;
1091 qemu_log_mask(LOG_GUEST_ERROR
,
1092 "%s: Bad register %02x\n", __func__
, s
->index
);
1096 static uint32_t vmsvga_bios_read(void *opaque
, uint32_t address
)
1098 printf("%s: what are we supposed to return?\n", __func__
);
1102 static void vmsvga_bios_write(void *opaque
, uint32_t address
, uint32_t data
)
1104 printf("%s: what are we supposed to do with (%08x)?\n", __func__
, data
);
1107 static inline void vmsvga_check_size(struct vmsvga_state_s
*s
)
1109 DisplaySurface
*surface
= qemu_console_surface(s
->vga
.con
);
1111 if (s
->new_width
!= surface_width(surface
) ||
1112 s
->new_height
!= surface_height(surface
) ||
1113 s
->new_depth
!= surface_bits_per_pixel(surface
)) {
1114 int stride
= (s
->new_depth
* s
->new_width
) / 8;
1115 pixman_format_code_t format
=
1116 qemu_default_pixman_format(s
->new_depth
, true);
1117 trace_vmware_setmode(s
->new_width
, s
->new_height
, s
->new_depth
);
1118 surface
= qemu_create_displaysurface_from(s
->new_width
, s
->new_height
,
1121 dpy_gfx_replace_surface(s
->vga
.con
, surface
);
1126 static void vmsvga_update_display(void *opaque
)
1128 struct vmsvga_state_s
*s
= opaque
;
1130 if (!s
->enable
|| !s
->config
) {
1131 /* in standard vga mode */
1132 s
->vga
.hw_ops
->gfx_update(&s
->vga
);
1136 vmsvga_check_size(s
);
1139 vmsvga_update_rect_flush(s
);
1141 if (s
->invalidated
) {
1143 dpy_gfx_update_full(s
->vga
.con
);
1147 static void vmsvga_reset(DeviceState
*dev
)
1149 struct pci_vmsvga_state_s
*pci
= VMWARE_SVGA(dev
);
1150 struct vmsvga_state_s
*s
= &pci
->chip
;
1155 s
->svgaid
= SVGA_ID
;
1157 s
->redraw_fifo_first
= 0;
1158 s
->redraw_fifo_last
= 0;
1161 vga_dirty_log_start(&s
->vga
);
1164 static void vmsvga_invalidate_display(void *opaque
)
1166 struct vmsvga_state_s
*s
= opaque
;
1168 s
->vga
.hw_ops
->invalidate(&s
->vga
);
1175 static void vmsvga_text_update(void *opaque
, console_ch_t
*chardata
)
1177 struct vmsvga_state_s
*s
= opaque
;
1179 if (s
->vga
.hw_ops
->text_update
) {
1180 s
->vga
.hw_ops
->text_update(&s
->vga
, chardata
);
1184 static int vmsvga_post_load(void *opaque
, int version_id
)
1186 struct vmsvga_state_s
*s
= opaque
;
1190 s
->fifo
= (uint32_t *) s
->fifo_ptr
;
1195 static const VMStateDescription vmstate_vmware_vga_internal
= {
1196 .name
= "vmware_vga_internal",
1198 .minimum_version_id
= 0,
1199 .post_load
= vmsvga_post_load
,
1200 .fields
= (VMStateField
[]) {
1201 VMSTATE_INT32_EQUAL(new_depth
, struct vmsvga_state_s
, NULL
),
1202 VMSTATE_INT32(enable
, struct vmsvga_state_s
),
1203 VMSTATE_INT32(config
, struct vmsvga_state_s
),
1204 VMSTATE_INT32(cursor
.id
, struct vmsvga_state_s
),
1205 VMSTATE_INT32(cursor
.x
, struct vmsvga_state_s
),
1206 VMSTATE_INT32(cursor
.y
, struct vmsvga_state_s
),
1207 VMSTATE_INT32(cursor
.on
, struct vmsvga_state_s
),
1208 VMSTATE_INT32(index
, struct vmsvga_state_s
),
1209 VMSTATE_VARRAY_INT32(scratch
, struct vmsvga_state_s
,
1210 scratch_size
, 0, vmstate_info_uint32
, uint32_t),
1211 VMSTATE_INT32(new_width
, struct vmsvga_state_s
),
1212 VMSTATE_INT32(new_height
, struct vmsvga_state_s
),
1213 VMSTATE_UINT32(guest
, struct vmsvga_state_s
),
1214 VMSTATE_UINT32(svgaid
, struct vmsvga_state_s
),
1215 VMSTATE_INT32(syncing
, struct vmsvga_state_s
),
1216 VMSTATE_UNUSED(4), /* was fb_size */
1217 VMSTATE_END_OF_LIST()
1221 static const VMStateDescription vmstate_vmware_vga
= {
1222 .name
= "vmware_vga",
1224 .minimum_version_id
= 0,
1225 .fields
= (VMStateField
[]) {
1226 VMSTATE_PCI_DEVICE(parent_obj
, struct pci_vmsvga_state_s
),
1227 VMSTATE_STRUCT(chip
, struct pci_vmsvga_state_s
, 0,
1228 vmstate_vmware_vga_internal
, struct vmsvga_state_s
),
1229 VMSTATE_END_OF_LIST()
1233 static const GraphicHwOps vmsvga_ops
= {
1234 .invalidate
= vmsvga_invalidate_display
,
1235 .gfx_update
= vmsvga_update_display
,
1236 .text_update
= vmsvga_text_update
,
1239 static void vmsvga_init(DeviceState
*dev
, struct vmsvga_state_s
*s
,
1240 MemoryRegion
*address_space
, MemoryRegion
*io
)
1242 s
->scratch_size
= SVGA_SCRATCH_SIZE
;
1243 s
->scratch
= g_malloc(s
->scratch_size
* 4);
1245 s
->vga
.con
= graphic_console_init(dev
, 0, &vmsvga_ops
, s
);
1247 s
->fifo_size
= SVGA_FIFO_SIZE
;
1248 memory_region_init_ram(&s
->fifo_ram
, NULL
, "vmsvga.fifo", s
->fifo_size
,
1250 s
->fifo_ptr
= memory_region_get_ram_ptr(&s
->fifo_ram
);
1252 vga_common_init(&s
->vga
, OBJECT(dev
));
1253 vga_init(&s
->vga
, OBJECT(dev
), address_space
, io
, true);
1254 vmstate_register(NULL
, 0, &vmstate_vga_common
, &s
->vga
);
1258 static uint64_t vmsvga_io_read(void *opaque
, hwaddr addr
, unsigned size
)
1260 struct vmsvga_state_s
*s
= opaque
;
1263 case SVGA_IO_MUL
* SVGA_INDEX_PORT
: return vmsvga_index_read(s
, addr
);
1264 case SVGA_IO_MUL
* SVGA_VALUE_PORT
: return vmsvga_value_read(s
, addr
);
1265 case SVGA_IO_MUL
* SVGA_BIOS_PORT
: return vmsvga_bios_read(s
, addr
);
1266 default: return -1u;
1270 static void vmsvga_io_write(void *opaque
, hwaddr addr
,
1271 uint64_t data
, unsigned size
)
1273 struct vmsvga_state_s
*s
= opaque
;
1276 case SVGA_IO_MUL
* SVGA_INDEX_PORT
:
1277 vmsvga_index_write(s
, addr
, data
);
1279 case SVGA_IO_MUL
* SVGA_VALUE_PORT
:
1280 vmsvga_value_write(s
, addr
, data
);
1282 case SVGA_IO_MUL
* SVGA_BIOS_PORT
:
1283 vmsvga_bios_write(s
, addr
, data
);
1288 static const MemoryRegionOps vmsvga_io_ops
= {
1289 .read
= vmsvga_io_read
,
1290 .write
= vmsvga_io_write
,
1291 .endianness
= DEVICE_LITTLE_ENDIAN
,
1293 .min_access_size
= 4,
1294 .max_access_size
= 4,
1302 static void pci_vmsvga_realize(PCIDevice
*dev
, Error
**errp
)
1304 struct pci_vmsvga_state_s
*s
= VMWARE_SVGA(dev
);
1306 dev
->config
[PCI_CACHE_LINE_SIZE
] = 0x08;
1307 dev
->config
[PCI_LATENCY_TIMER
] = 0x40;
1308 dev
->config
[PCI_INTERRUPT_LINE
] = 0xff; /* End */
1310 memory_region_init_io(&s
->io_bar
, OBJECT(dev
), &vmsvga_io_ops
, &s
->chip
,
1312 memory_region_set_flush_coalesced(&s
->io_bar
);
1313 pci_register_bar(dev
, 0, PCI_BASE_ADDRESS_SPACE_IO
, &s
->io_bar
);
1315 vmsvga_init(DEVICE(dev
), &s
->chip
,
1316 pci_address_space(dev
), pci_address_space_io(dev
));
1318 pci_register_bar(dev
, 1, PCI_BASE_ADDRESS_MEM_PREFETCH
,
1320 pci_register_bar(dev
, 2, PCI_BASE_ADDRESS_MEM_PREFETCH
,
1324 static Property vga_vmware_properties
[] = {
1325 DEFINE_PROP_UINT32("vgamem_mb", struct pci_vmsvga_state_s
,
1326 chip
.vga
.vram_size_mb
, 16),
1327 DEFINE_PROP_BOOL("global-vmstate", struct pci_vmsvga_state_s
,
1328 chip
.vga
.global_vmstate
, false),
1329 DEFINE_PROP_END_OF_LIST(),
1332 static void vmsvga_class_init(ObjectClass
*klass
, void *data
)
1334 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1335 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1337 k
->realize
= pci_vmsvga_realize
;
1338 k
->romfile
= "vgabios-vmware.bin";
1339 k
->vendor_id
= PCI_VENDOR_ID_VMWARE
;
1340 k
->device_id
= SVGA_PCI_DEVICE_ID
;
1341 k
->class_id
= PCI_CLASS_DISPLAY_VGA
;
1342 k
->subsystem_vendor_id
= PCI_VENDOR_ID_VMWARE
;
1343 k
->subsystem_id
= SVGA_PCI_DEVICE_ID
;
1344 dc
->reset
= vmsvga_reset
;
1345 dc
->vmsd
= &vmstate_vmware_vga
;
1346 device_class_set_props(dc
, vga_vmware_properties
);
1347 dc
->hotpluggable
= false;
1348 set_bit(DEVICE_CATEGORY_DISPLAY
, dc
->categories
);
1351 static const TypeInfo vmsvga_info
= {
1352 .name
= TYPE_VMWARE_SVGA
,
1353 .parent
= TYPE_PCI_DEVICE
,
1354 .instance_size
= sizeof(struct pci_vmsvga_state_s
),
1355 .class_init
= vmsvga_class_init
,
1356 .interfaces
= (InterfaceInfo
[]) {
1357 { INTERFACE_CONVENTIONAL_PCI_DEVICE
},
1362 static void vmsvga_register_types(void)
1364 type_register_static(&vmsvga_info
);
1367 type_init(vmsvga_register_types
)