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