xref: /openbmc/qemu/hw/display/qxl.h (revision a68694cd)
1 #ifndef HW_QXL_H
2 #define HW_QXL_H
3 
4 
5 #include "hw/pci/pci.h"
6 #include "vga_int.h"
7 #include "qemu/thread.h"
8 
9 #include "ui/qemu-spice.h"
10 #include "ui/spice-display.h"
11 #include "qom/object.h"
12 
13 enum qxl_mode {
14     QXL_MODE_UNDEFINED,
15     QXL_MODE_VGA,
16     QXL_MODE_COMPAT, /* spice 0.4.x */
17     QXL_MODE_NATIVE,
18 };
19 
20 #ifndef QXL_VRAM64_RANGE_INDEX
21 #define QXL_VRAM64_RANGE_INDEX 4
22 #endif
23 
24 #define QXL_UNDEFINED_IO UINT32_MAX
25 
26 #define QXL_NUM_DIRTY_RECTS 64
27 
28 #define QXL_PAGE_BITS 12
29 #define QXL_PAGE_SIZE (1 << QXL_PAGE_BITS);
30 
31 struct PCIQXLDevice {
32     PCIDevice          pci;
33     PortioList         vga_port_list;
34     SimpleSpiceDisplay ssd;
35     int                id;
36     bool               have_vga;
37     uint32_t           debug;
38     uint32_t           guestdebug;
39     uint32_t           cmdlog;
40 
41     uint32_t           guest_bug;
42     Error              *migration_blocker;
43 
44     enum qxl_mode      mode;
45     uint32_t           cmdflags;
46     uint32_t           revision;
47 
48     int32_t            num_memslots;
49 
50     uint32_t           current_async;
51     QemuMutex          async_lock;
52 
53     struct guest_slots {
54         QXLMemSlot     slot;
55         MemoryRegion   *mr;
56         uint64_t       offset;
57         uint64_t       size;
58         uint64_t       delta;
59         uint32_t       active;
60     } guest_slots[NUM_MEMSLOTS];
61 
62     struct guest_primary {
63         QXLSurfaceCreate surface;
64         uint32_t       commands;
65         uint32_t       resized;
66         int32_t        qxl_stride;
67         uint32_t       abs_stride;
68         uint32_t       bits_pp;
69         uint32_t       bytes_pp;
70         uint8_t        *data;
71     } guest_primary;
72 
73     struct surfaces {
74         QXLPHYSICAL    *cmds;
75         uint32_t       count;
76         uint32_t       max;
77     } guest_surfaces;
78     QXLPHYSICAL        guest_cursor;
79 
80     QXLPHYSICAL        guest_monitors_config;
81     uint32_t           guest_head0_width;
82     uint32_t           guest_head0_height;
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 };
131 typedef struct PCIQXLDevice PCIQXLDevice;
132 
133 #define TYPE_PCI_QXL "pci-qxl"
134 DECLARE_INSTANCE_CHECKER(PCIQXLDevice, PCI_QXL,
135                          TYPE_PCI_QXL)
136 
137 #define PANIC_ON(x) if ((x)) {                         \
138     printf("%s: PANIC %s failed\n", __func__, #x); \
139     abort();                                           \
140 }
141 
142 #define dprint(_qxl, _level, _fmt, ...)                                 \
143     do {                                                                \
144         if (_qxl->debug >= _level) {                                    \
145             fprintf(stderr, "qxl-%d: ", _qxl->id);                      \
146             fprintf(stderr, _fmt, ## __VA_ARGS__);                      \
147         }                                                               \
148     } while (0)
149 
150 #define QXL_DEFAULT_REVISION (QXL_REVISION_STABLE_V12 + 1)
151 
152 /* qxl.c */
153 void *qxl_phys2virt(PCIQXLDevice *qxl, QXLPHYSICAL phys, int group_id);
154 void qxl_set_guest_bug(PCIQXLDevice *qxl, const char *msg, ...)
155     GCC_FMT_ATTR(2, 3);
156 
157 void qxl_spice_update_area(PCIQXLDevice *qxl, uint32_t surface_id,
158                            struct QXLRect *area, struct QXLRect *dirty_rects,
159                            uint32_t num_dirty_rects,
160                            uint32_t clear_dirty_region,
161                            qxl_async_io async, QXLCookie *cookie);
162 void qxl_spice_loadvm_commands(PCIQXLDevice *qxl, struct QXLCommandExt *ext,
163                                uint32_t count);
164 void qxl_spice_oom(PCIQXLDevice *qxl);
165 void qxl_spice_reset_memslots(PCIQXLDevice *qxl);
166 void qxl_spice_reset_image_cache(PCIQXLDevice *qxl);
167 void qxl_spice_reset_cursor(PCIQXLDevice *qxl);
168 
169 /* qxl-logger.c */
170 int qxl_log_cmd_cursor(PCIQXLDevice *qxl, QXLCursorCmd *cmd, int group_id);
171 int qxl_log_command(PCIQXLDevice *qxl, const char *ring, QXLCommandExt *ext);
172 
173 /* qxl-render.c */
174 void qxl_render_resize(PCIQXLDevice *qxl);
175 void qxl_render_update(PCIQXLDevice *qxl);
176 int qxl_render_cursor(PCIQXLDevice *qxl, QXLCommandExt *ext);
177 void qxl_render_update_area_done(PCIQXLDevice *qxl, QXLCookie *cookie);
178 void qxl_render_update_area_bh(void *opaque);
179 
180 #endif
181