xref: /openbmc/qemu/include/ui/spice-display.h (revision 3588185b)
1 /*
2  * Copyright (C) 2010 Red Hat, Inc.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 or
7  * (at your option) version 3 of the License.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #include <spice/ipc_ring.h>
19 #include <spice/enums.h>
20 #include <spice/qxl_dev.h>
21 
22 #include "qemu/thread.h"
23 #include "ui/qemu-pixman.h"
24 #include "sysemu/sysemu.h"
25 
26 #define NUM_MEMSLOTS 8
27 #define MEMSLOT_GENERATION_BITS 8
28 #define MEMSLOT_SLOT_BITS 8
29 
30 #define MEMSLOT_GROUP_HOST  0
31 #define MEMSLOT_GROUP_GUEST 1
32 #define NUM_MEMSLOTS_GROUPS 2
33 
34 /*
35  * Internal enum to differenciate between options for
36  * io calls that have a sync (old) version and an _async (new)
37  * version:
38  *  QXL_SYNC: use the old version
39  *  QXL_ASYNC: use the new version and make sure there are no two
40  *   happening at the same time. This is used for guest initiated
41  *   calls
42  */
43 typedef enum qxl_async_io {
44     QXL_SYNC,
45     QXL_ASYNC,
46 } qxl_async_io;
47 
48 enum {
49     QXL_COOKIE_TYPE_IO,
50     QXL_COOKIE_TYPE_RENDER_UPDATE_AREA,
51     QXL_COOKIE_TYPE_POST_LOAD_MONITORS_CONFIG,
52 };
53 
54 typedef struct QXLCookie {
55     int      type;
56     uint64_t io;
57     union {
58         uint32_t surface_id;
59         QXLRect area;
60         struct {
61             QXLRect area;
62             int redraw;
63         } render;
64     } u;
65 } QXLCookie;
66 
67 QXLCookie *qxl_cookie_new(int type, uint64_t io);
68 
69 typedef struct SimpleSpiceDisplay SimpleSpiceDisplay;
70 typedef struct SimpleSpiceUpdate SimpleSpiceUpdate;
71 
72 struct SimpleSpiceDisplay {
73     DisplayState *ds;
74     void *buf;
75     int bufsize;
76     QXLWorker *worker;
77     QXLInstance qxl;
78     uint32_t unique;
79     pixman_image_t *surface;
80     pixman_image_t *mirror;
81     int32_t num_surfaces;
82 
83     QXLRect dirty;
84     int notify;
85 
86     /*
87      * All struct members below this comment can be accessed from
88      * both spice server and qemu (iothread) context and any access
89      * to them must be protected by the lock.
90      */
91     QemuMutex lock;
92     QTAILQ_HEAD(, SimpleSpiceUpdate) updates;
93     QEMUCursor *cursor;
94     int mouse_x, mouse_y;
95 };
96 
97 struct SimpleSpiceUpdate {
98     QXLDrawable drawable;
99     QXLImage image;
100     QXLCommandExt ext;
101     uint8_t *bitmap;
102     QTAILQ_ENTRY(SimpleSpiceUpdate) next;
103 };
104 
105 int qemu_spice_rect_is_empty(const QXLRect* r);
106 void qemu_spice_rect_union(QXLRect *dest, const QXLRect *r);
107 
108 void qemu_spice_destroy_update(SimpleSpiceDisplay *sdpy, SimpleSpiceUpdate *update);
109 void qemu_spice_create_host_memslot(SimpleSpiceDisplay *ssd);
110 void qemu_spice_create_host_primary(SimpleSpiceDisplay *ssd);
111 void qemu_spice_destroy_host_primary(SimpleSpiceDisplay *ssd);
112 void qemu_spice_vm_change_state_handler(void *opaque, int running,
113                                         RunState state);
114 void qemu_spice_display_init_common(SimpleSpiceDisplay *ssd, DisplayState *ds);
115 
116 void qemu_spice_display_update(SimpleSpiceDisplay *ssd,
117                                int x, int y, int w, int h);
118 void qemu_spice_display_resize(SimpleSpiceDisplay *ssd);
119 void qemu_spice_display_refresh(SimpleSpiceDisplay *ssd);
120 void qemu_spice_cursor_refresh_unlocked(SimpleSpiceDisplay *ssd);
121 
122 void qemu_spice_add_memslot(SimpleSpiceDisplay *ssd, QXLDevMemSlot *memslot,
123                             qxl_async_io async);
124 void qemu_spice_del_memslot(SimpleSpiceDisplay *ssd, uint32_t gid,
125                             uint32_t sid);
126 void qemu_spice_create_primary_surface(SimpleSpiceDisplay *ssd, uint32_t id,
127                                        QXLDevSurfaceCreate *surface,
128                                        qxl_async_io async);
129 void qemu_spice_destroy_primary_surface(SimpleSpiceDisplay *ssd,
130                                         uint32_t id, qxl_async_io async);
131 void qemu_spice_wakeup(SimpleSpiceDisplay *ssd);
132 void qemu_spice_display_start(void);
133 void qemu_spice_display_stop(void);
134 int qemu_spice_display_is_running(SimpleSpiceDisplay *ssd);
135