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