xref: /openbmc/qemu/hw/display/qxl.h (revision d7646f24)
1 #ifndef HW_QXL_H
2 #define HW_QXL_H 1
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 
44     enum qxl_mode      mode;
45     uint32_t           cmdflags;
46     int                generation;
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         void           *ptr;
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 
82     QemuMutex          track_lock;
83 
84     /* thread signaling */
85     QEMUBH             *update_irq;
86 
87     /* ram pci bar */
88     QXLRam             *ram;
89     VGACommonState     vga;
90     uint32_t           num_free_res;
91     QXLReleaseInfo     *last_release;
92     uint32_t           last_release_offset;
93     uint32_t           oom_running;
94     uint32_t           vgamem_size;
95 
96     /* rom pci bar */
97     QXLRom             shadow_rom;
98     QXLRom             *rom;
99     QXLModes           *modes;
100     uint32_t           rom_size;
101     MemoryRegion       rom_bar;
102 #if SPICE_SERVER_VERSION >= 0x000c06 /* release 0.12.6 */
103     uint16_t           max_outputs;
104 #endif
105 
106     /* vram pci bar */
107     uint32_t           vram_size;
108     MemoryRegion       vram_bar;
109     uint32_t           vram32_size;
110     MemoryRegion       vram32_bar;
111 
112     /* io bar */
113     MemoryRegion       io_bar;
114 
115     /* user-friendly properties (in megabytes) */
116     uint32_t          ram_size_mb;
117     uint32_t          vram_size_mb;
118     uint32_t          vram32_size_mb;
119     uint32_t          vgamem_size_mb;
120 
121     /* qxl_render_update state */
122     int                render_update_cookie_num;
123     int                num_dirty_rects;
124     QXLRect            dirty[QXL_NUM_DIRTY_RECTS];
125     QEMUBH            *update_area_bh;
126 } PCIQXLDevice;
127 
128 #define TYPE_PCI_QXL "pci-qxl"
129 #define PCI_QXL(obj) OBJECT_CHECK(PCIQXLDevice, (obj), TYPE_PCI_QXL)
130 
131 #define PANIC_ON(x) if ((x)) {                         \
132     printf("%s: PANIC %s failed\n", __FUNCTION__, #x); \
133     abort();                                           \
134 }
135 
136 #define dprint(_qxl, _level, _fmt, ...)                                 \
137     do {                                                                \
138         if (_qxl->debug >= _level) {                                    \
139             fprintf(stderr, "qxl-%d: ", _qxl->id);                      \
140             fprintf(stderr, _fmt, ## __VA_ARGS__);                      \
141         }                                                               \
142     } while (0)
143 
144 #define QXL_DEFAULT_REVISION QXL_REVISION_STABLE_V12
145 
146 /* qxl.c */
147 void *qxl_phys2virt(PCIQXLDevice *qxl, QXLPHYSICAL phys, int group_id);
148 void qxl_set_guest_bug(PCIQXLDevice *qxl, const char *msg, ...)
149     GCC_FMT_ATTR(2, 3);
150 
151 void qxl_spice_update_area(PCIQXLDevice *qxl, uint32_t surface_id,
152                            struct QXLRect *area, struct QXLRect *dirty_rects,
153                            uint32_t num_dirty_rects,
154                            uint32_t clear_dirty_region,
155                            qxl_async_io async, QXLCookie *cookie);
156 void qxl_spice_loadvm_commands(PCIQXLDevice *qxl, struct QXLCommandExt *ext,
157                                uint32_t count);
158 void qxl_spice_oom(PCIQXLDevice *qxl);
159 void qxl_spice_reset_memslots(PCIQXLDevice *qxl);
160 void qxl_spice_reset_image_cache(PCIQXLDevice *qxl);
161 void qxl_spice_reset_cursor(PCIQXLDevice *qxl);
162 
163 /* qxl-logger.c */
164 int qxl_log_cmd_cursor(PCIQXLDevice *qxl, QXLCursorCmd *cmd, int group_id);
165 int qxl_log_command(PCIQXLDevice *qxl, const char *ring, QXLCommandExt *ext);
166 
167 /* qxl-render.c */
168 void qxl_render_resize(PCIQXLDevice *qxl);
169 void qxl_render_update(PCIQXLDevice *qxl);
170 int qxl_render_cursor(PCIQXLDevice *qxl, QXLCommandExt *ext);
171 void qxl_render_update_area_done(PCIQXLDevice *qxl, QXLCookie *cookie);
172 void qxl_render_update_area_bh(void *opaque);
173 
174 #endif
175