xref: /openbmc/qemu/hw/display/qxl.h (revision a9ded601)
1 #ifndef HW_QXL_H
2 #define HW_QXL_H
3 
4 #include "qemu-common.h"
5 
6 #include "ui/console.h"
7 #include "hw/hw.h"
8 #include "hw/pci/pci.h"
9 #include "vga_int.h"
10 #include "qemu/thread.h"
11 
12 #include "ui/qemu-spice.h"
13 #include "ui/spice-display.h"
14 
15 enum qxl_mode {
16     QXL_MODE_UNDEFINED,
17     QXL_MODE_VGA,
18     QXL_MODE_COMPAT, /* spice 0.4.x */
19     QXL_MODE_NATIVE,
20 };
21 
22 #ifndef QXL_VRAM64_RANGE_INDEX
23 #define QXL_VRAM64_RANGE_INDEX 4
24 #endif
25 
26 #define QXL_UNDEFINED_IO UINT32_MAX
27 
28 #define QXL_NUM_DIRTY_RECTS 64
29 
30 #define QXL_PAGE_BITS 12
31 #define QXL_PAGE_SIZE (1 << QXL_PAGE_BITS);
32 
33 typedef struct PCIQXLDevice {
34     PCIDevice          pci;
35     PortioList         vga_port_list;
36     SimpleSpiceDisplay ssd;
37     int                id;
38     uint32_t           debug;
39     uint32_t           guestdebug;
40     uint32_t           cmdlog;
41 
42     uint32_t           guest_bug;
43     Error              *migration_blocker;
44 
45     enum qxl_mode      mode;
46     uint32_t           cmdflags;
47     int                generation;
48     uint32_t           revision;
49 
50     int32_t            num_memslots;
51 
52     uint32_t           current_async;
53     QemuMutex          async_lock;
54 
55     struct guest_slots {
56         QXLMemSlot     slot;
57         MemoryRegion   *mr;
58         uint64_t       offset;
59         uint64_t       size;
60         uint64_t       delta;
61         uint32_t       active;
62     } guest_slots[NUM_MEMSLOTS];
63 
64     struct guest_primary {
65         QXLSurfaceCreate surface;
66         uint32_t       commands;
67         uint32_t       resized;
68         int32_t        qxl_stride;
69         uint32_t       abs_stride;
70         uint32_t       bits_pp;
71         uint32_t       bytes_pp;
72         uint8_t        *data;
73     } guest_primary;
74 
75     struct surfaces {
76         QXLPHYSICAL    *cmds;
77         uint32_t       count;
78         uint32_t       max;
79     } guest_surfaces;
80     QXLPHYSICAL        guest_cursor;
81 
82     QXLPHYSICAL        guest_monitors_config;
83 
84     QemuMutex          track_lock;
85 
86     /* thread signaling */
87     QEMUBH             *update_irq;
88 
89     /* ram pci bar */
90     QXLRam             *ram;
91     VGACommonState     vga;
92     uint32_t           num_free_res;
93     QXLReleaseInfo     *last_release;
94     uint32_t           last_release_offset;
95     uint32_t           oom_running;
96     uint32_t           vgamem_size;
97 
98     /* rom pci bar */
99     QXLRom             shadow_rom;
100     QXLRom             *rom;
101     QXLModes           *modes;
102     uint32_t           rom_size;
103     MemoryRegion       rom_bar;
104 #if SPICE_SERVER_VERSION >= 0x000c06 /* release 0.12.6 */
105     uint16_t           max_outputs;
106 #endif
107 
108     /* vram pci bar */
109     uint64_t           vram_size;
110     MemoryRegion       vram_bar;
111     uint64_t           vram32_size;
112     MemoryRegion       vram32_bar;
113 
114     /* io bar */
115     MemoryRegion       io_bar;
116 
117     /* user-friendly properties (in megabytes) */
118     uint32_t          ram_size_mb;
119     uint32_t          vram_size_mb;
120     uint32_t          vram32_size_mb;
121     uint32_t          vgamem_size_mb;
122     uint32_t          xres;
123     uint32_t          yres;
124 
125     /* qxl_render_update state */
126     int                render_update_cookie_num;
127     int                num_dirty_rects;
128     QXLRect            dirty[QXL_NUM_DIRTY_RECTS];
129     QEMUBH            *update_area_bh;
130 } PCIQXLDevice;
131 
132 #define TYPE_PCI_QXL "pci-qxl"
133 #define PCI_QXL(obj) OBJECT_CHECK(PCIQXLDevice, (obj), TYPE_PCI_QXL)
134 
135 #define PANIC_ON(x) if ((x)) {                         \
136     printf("%s: PANIC %s failed\n", __FUNCTION__, #x); \
137     abort();                                           \
138 }
139 
140 #define dprint(_qxl, _level, _fmt, ...)                                 \
141     do {                                                                \
142         if (_qxl->debug >= _level) {                                    \
143             fprintf(stderr, "qxl-%d: ", _qxl->id);                      \
144             fprintf(stderr, _fmt, ## __VA_ARGS__);                      \
145         }                                                               \
146     } while (0)
147 
148 #define QXL_DEFAULT_REVISION QXL_REVISION_STABLE_V12
149 
150 /* qxl.c */
151 void *qxl_phys2virt(PCIQXLDevice *qxl, QXLPHYSICAL phys, int group_id);
152 void qxl_set_guest_bug(PCIQXLDevice *qxl, const char *msg, ...)
153     GCC_FMT_ATTR(2, 3);
154 
155 void qxl_spice_update_area(PCIQXLDevice *qxl, uint32_t surface_id,
156                            struct QXLRect *area, struct QXLRect *dirty_rects,
157                            uint32_t num_dirty_rects,
158                            uint32_t clear_dirty_region,
159                            qxl_async_io async, QXLCookie *cookie);
160 void qxl_spice_loadvm_commands(PCIQXLDevice *qxl, struct QXLCommandExt *ext,
161                                uint32_t count);
162 void qxl_spice_oom(PCIQXLDevice *qxl);
163 void qxl_spice_reset_memslots(PCIQXLDevice *qxl);
164 void qxl_spice_reset_image_cache(PCIQXLDevice *qxl);
165 void qxl_spice_reset_cursor(PCIQXLDevice *qxl);
166 
167 /* qxl-logger.c */
168 int qxl_log_cmd_cursor(PCIQXLDevice *qxl, QXLCursorCmd *cmd, int group_id);
169 int qxl_log_command(PCIQXLDevice *qxl, const char *ring, QXLCommandExt *ext);
170 
171 /* qxl-render.c */
172 void qxl_render_resize(PCIQXLDevice *qxl);
173 void qxl_render_update(PCIQXLDevice *qxl);
174 int qxl_render_cursor(PCIQXLDevice *qxl, QXLCommandExt *ext);
175 void qxl_render_update_area_done(PCIQXLDevice *qxl, QXLCookie *cookie);
176 void qxl_render_update_area_bh(void *opaque);
177 
178 #endif
179