VMM: Change virtio header include paths from linux to vmm
[akaros.git] / user / vmm / include / vmm / virtio_gpu.h
1 /*
2  * Virtio GPU Device
3  *
4  * Copyright Red Hat, Inc. 2013-2014
5  *
6  * Authors:
7  *     Dave Airlie <airlied@redhat.com>
8  *     Gerd Hoffmann <kraxel@redhat.com>
9  *
10  * This header is BSD licensed so anyone can use the definitions
11  * to implement compatible drivers/servers:
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. Neither the name of IBM nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL IBM OR
28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
31  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
32  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
33  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
34  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  */
37
38 #pragma once
39
40
41 #define VIRTIO_GPU_F_VIRGL 0
42
43 enum virtio_gpu_ctrl_type {
44         VIRTIO_GPU_UNDEFINED = 0,
45
46         /* 2d commands */
47         VIRTIO_GPU_CMD_GET_DISPLAY_INFO = 0x0100,
48         VIRTIO_GPU_CMD_RESOURCE_CREATE_2D,
49         VIRTIO_GPU_CMD_RESOURCE_UNREF,
50         VIRTIO_GPU_CMD_SET_SCANOUT,
51         VIRTIO_GPU_CMD_RESOURCE_FLUSH,
52         VIRTIO_GPU_CMD_TRANSFER_TO_HOST_2D,
53         VIRTIO_GPU_CMD_RESOURCE_ATTACH_BACKING,
54         VIRTIO_GPU_CMD_RESOURCE_DETACH_BACKING,
55         VIRTIO_GPU_CMD_GET_CAPSET_INFO,
56         VIRTIO_GPU_CMD_GET_CAPSET,
57
58         /* 3d commands */
59         VIRTIO_GPU_CMD_CTX_CREATE = 0x0200,
60         VIRTIO_GPU_CMD_CTX_DESTROY,
61         VIRTIO_GPU_CMD_CTX_ATTACH_RESOURCE,
62         VIRTIO_GPU_CMD_CTX_DETACH_RESOURCE,
63         VIRTIO_GPU_CMD_RESOURCE_CREATE_3D,
64         VIRTIO_GPU_CMD_TRANSFER_TO_HOST_3D,
65         VIRTIO_GPU_CMD_TRANSFER_FROM_HOST_3D,
66         VIRTIO_GPU_CMD_SUBMIT_3D,
67
68         /* cursor commands */
69         VIRTIO_GPU_CMD_UPDATE_CURSOR = 0x0300,
70         VIRTIO_GPU_CMD_MOVE_CURSOR,
71
72         /* success responses */
73         VIRTIO_GPU_RESP_OK_NODATA = 0x1100,
74         VIRTIO_GPU_RESP_OK_DISPLAY_INFO,
75         VIRTIO_GPU_RESP_OK_CAPSET_INFO,
76         VIRTIO_GPU_RESP_OK_CAPSET,
77
78         /* error responses */
79         VIRTIO_GPU_RESP_ERR_UNSPEC = 0x1200,
80         VIRTIO_GPU_RESP_ERR_OUT_OF_MEMORY,
81         VIRTIO_GPU_RESP_ERR_INVALID_SCANOUT_ID,
82         VIRTIO_GPU_RESP_ERR_INVALID_RESOURCE_ID,
83         VIRTIO_GPU_RESP_ERR_INVALID_CONTEXT_ID,
84         VIRTIO_GPU_RESP_ERR_INVALID_PARAMETER,
85 };
86
87 #define VIRTIO_GPU_FLAG_FENCE (1 << 0)
88
89 struct virtio_gpu_ctrl_hdr {
90         __le32 type;
91         __le32 flags;
92         __le64 fence_id;
93         __le32 ctx_id;
94         __le32 padding;
95 };
96
97 /* data passed in the cursor vq */
98
99 struct virtio_gpu_cursor_pos {
100         __le32 scanout_id;
101         __le32 x;
102         __le32 y;
103         __le32 padding;
104 };
105
106 /* VIRTIO_GPU_CMD_UPDATE_CURSOR, VIRTIO_GPU_CMD_MOVE_CURSOR */
107 struct virtio_gpu_update_cursor {
108         struct virtio_gpu_ctrl_hdr hdr;
109         struct virtio_gpu_cursor_pos pos;  /* update & move */
110         __le32 resource_id;           /* update only */
111         __le32 hot_x;                 /* update only */
112         __le32 hot_y;                 /* update only */
113         __le32 padding;
114 };
115
116 /* data passed in the control vq, 2d related */
117
118 struct virtio_gpu_rect {
119         __le32 x;
120         __le32 y;
121         __le32 width;
122         __le32 height;
123 };
124
125 /* VIRTIO_GPU_CMD_RESOURCE_UNREF */
126 struct virtio_gpu_resource_unref {
127         struct virtio_gpu_ctrl_hdr hdr;
128         __le32 resource_id;
129         __le32 padding;
130 };
131
132 /* VIRTIO_GPU_CMD_RESOURCE_CREATE_2D: create a 2d resource with a format */
133 struct virtio_gpu_resource_create_2d {
134         struct virtio_gpu_ctrl_hdr hdr;
135         __le32 resource_id;
136         __le32 format;
137         __le32 width;
138         __le32 height;
139 };
140
141 /* VIRTIO_GPU_CMD_SET_SCANOUT */
142 struct virtio_gpu_set_scanout {
143         struct virtio_gpu_ctrl_hdr hdr;
144         struct virtio_gpu_rect r;
145         __le32 scanout_id;
146         __le32 resource_id;
147 };
148
149 /* VIRTIO_GPU_CMD_RESOURCE_FLUSH */
150 struct virtio_gpu_resource_flush {
151         struct virtio_gpu_ctrl_hdr hdr;
152         struct virtio_gpu_rect r;
153         __le32 resource_id;
154         __le32 padding;
155 };
156
157 /* VIRTIO_GPU_CMD_TRANSFER_TO_HOST_2D: simple transfer to_host */
158 struct virtio_gpu_transfer_to_host_2d {
159         struct virtio_gpu_ctrl_hdr hdr;
160         struct virtio_gpu_rect r;
161         __le64 offset;
162         __le32 resource_id;
163         __le32 padding;
164 };
165
166 struct virtio_gpu_mem_entry {
167         __le64 addr;
168         __le32 length;
169         __le32 padding;
170 };
171
172 /* VIRTIO_GPU_CMD_RESOURCE_ATTACH_BACKING */
173 struct virtio_gpu_resource_attach_backing {
174         struct virtio_gpu_ctrl_hdr hdr;
175         __le32 resource_id;
176         __le32 nr_entries;
177 };
178
179 /* VIRTIO_GPU_CMD_RESOURCE_DETACH_BACKING */
180 struct virtio_gpu_resource_detach_backing {
181         struct virtio_gpu_ctrl_hdr hdr;
182         __le32 resource_id;
183         __le32 padding;
184 };
185
186 /* VIRTIO_GPU_RESP_OK_DISPLAY_INFO */
187 #define VIRTIO_GPU_MAX_SCANOUTS 16
188 struct virtio_gpu_resp_display_info {
189         struct virtio_gpu_ctrl_hdr hdr;
190         struct virtio_gpu_display_one {
191                 struct virtio_gpu_rect r;
192                 __le32 enabled;
193                 __le32 flags;
194         } pmodes[VIRTIO_GPU_MAX_SCANOUTS];
195 };
196
197 /* data passed in the control vq, 3d related */
198
199 struct virtio_gpu_box {
200         __le32 x, y, z;
201         __le32 w, h, d;
202 };
203
204 /* VIRTIO_GPU_CMD_TRANSFER_TO_HOST_3D, VIRTIO_GPU_CMD_TRANSFER_FROM_HOST_3D */
205 struct virtio_gpu_transfer_host_3d {
206         struct virtio_gpu_ctrl_hdr hdr;
207         struct virtio_gpu_box box;
208         __le64 offset;
209         __le32 resource_id;
210         __le32 level;
211         __le32 stride;
212         __le32 layer_stride;
213 };
214
215 /* VIRTIO_GPU_CMD_RESOURCE_CREATE_3D */
216 #define VIRTIO_GPU_RESOURCE_FLAG_Y_0_TOP (1 << 0)
217 struct virtio_gpu_resource_create_3d {
218         struct virtio_gpu_ctrl_hdr hdr;
219         __le32 resource_id;
220         __le32 target;
221         __le32 format;
222         __le32 bind;
223         __le32 width;
224         __le32 height;
225         __le32 depth;
226         __le32 array_size;
227         __le32 last_level;
228         __le32 nr_samples;
229         __le32 flags;
230         __le32 padding;
231 };
232
233 /* VIRTIO_GPU_CMD_CTX_CREATE */
234 struct virtio_gpu_ctx_create {
235         struct virtio_gpu_ctrl_hdr hdr;
236         __le32 nlen;
237         __le32 padding;
238         char debug_name[64];
239 };
240
241 /* VIRTIO_GPU_CMD_CTX_DESTROY */
242 struct virtio_gpu_ctx_destroy {
243         struct virtio_gpu_ctrl_hdr hdr;
244 };
245
246 /* VIRTIO_GPU_CMD_CTX_ATTACH_RESOURCE, VIRTIO_GPU_CMD_CTX_DETACH_RESOURCE */
247 struct virtio_gpu_ctx_resource {
248         struct virtio_gpu_ctrl_hdr hdr;
249         __le32 resource_id;
250         __le32 padding;
251 };
252
253 /* VIRTIO_GPU_CMD_SUBMIT_3D */
254 struct virtio_gpu_cmd_submit {
255         struct virtio_gpu_ctrl_hdr hdr;
256         __le32 size;
257         __le32 padding;
258 };
259
260 #define VIRTIO_GPU_CAPSET_VIRGL 1
261
262 /* VIRTIO_GPU_CMD_GET_CAPSET_INFO */
263 struct virtio_gpu_get_capset_info {
264         struct virtio_gpu_ctrl_hdr hdr;
265         __le32 capset_index;
266         __le32 padding;
267 };
268
269 /* VIRTIO_GPU_RESP_OK_CAPSET_INFO */
270 struct virtio_gpu_resp_capset_info {
271         struct virtio_gpu_ctrl_hdr hdr;
272         __le32 capset_id;
273         __le32 capset_max_version;
274         __le32 capset_max_size;
275         __le32 padding;
276 };
277
278 /* VIRTIO_GPU_CMD_GET_CAPSET */
279 struct virtio_gpu_get_capset {
280         struct virtio_gpu_ctrl_hdr hdr;
281         __le32 capset_id;
282         __le32 capset_version;
283 };
284
285 /* VIRTIO_GPU_RESP_OK_CAPSET */
286 struct virtio_gpu_resp_capset {
287         struct virtio_gpu_ctrl_hdr hdr;
288         __u8 capset_data[];
289 };
290
291 #define VIRTIO_GPU_EVENT_DISPLAY (1 << 0)
292
293 struct virtio_gpu_config {
294         __u32 events_read;
295         __u32 events_clear;
296         __u32 num_scanouts;
297         __u32 num_capsets;
298 };
299
300 /* simple formats for fbcon/X use */
301 enum virtio_gpu_formats {
302         VIRTIO_GPU_FORMAT_B8G8R8A8_UNORM  = 1,
303         VIRTIO_GPU_FORMAT_B8G8R8X8_UNORM  = 2,
304         VIRTIO_GPU_FORMAT_A8R8G8B8_UNORM  = 3,
305         VIRTIO_GPU_FORMAT_X8R8G8B8_UNORM  = 4,
306
307         VIRTIO_GPU_FORMAT_R8G8B8A8_UNORM  = 67,
308         VIRTIO_GPU_FORMAT_X8B8G8R8_UNORM  = 68,
309
310         VIRTIO_GPU_FORMAT_A8B8G8R8_UNORM  = 121,
311         VIRTIO_GPU_FORMAT_R8G8B8X8_UNORM  = 134,
312 };
313
314