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