VMM: Converted headers to use pragma once
[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 #include <linux/types.h>
41
42 #define VIRTIO_GPU_F_VIRGL 0
43
44 enum virtio_gpu_ctrl_type {
45         VIRTIO_GPU_UNDEFINED = 0,
46
47         /* 2d commands */
48         VIRTIO_GPU_CMD_GET_DISPLAY_INFO = 0x0100,
49         VIRTIO_GPU_CMD_RESOURCE_CREATE_2D,
50         VIRTIO_GPU_CMD_RESOURCE_UNREF,
51         VIRTIO_GPU_CMD_SET_SCANOUT,
52         VIRTIO_GPU_CMD_RESOURCE_FLUSH,
53         VIRTIO_GPU_CMD_TRANSFER_TO_HOST_2D,
54         VIRTIO_GPU_CMD_RESOURCE_ATTACH_BACKING,
55         VIRTIO_GPU_CMD_RESOURCE_DETACH_BACKING,
56         VIRTIO_GPU_CMD_GET_CAPSET_INFO,
57         VIRTIO_GPU_CMD_GET_CAPSET,
58
59         /* 3d commands */
60         VIRTIO_GPU_CMD_CTX_CREATE = 0x0200,
61         VIRTIO_GPU_CMD_CTX_DESTROY,
62         VIRTIO_GPU_CMD_CTX_ATTACH_RESOURCE,
63         VIRTIO_GPU_CMD_CTX_DETACH_RESOURCE,
64         VIRTIO_GPU_CMD_RESOURCE_CREATE_3D,
65         VIRTIO_GPU_CMD_TRANSFER_TO_HOST_3D,
66         VIRTIO_GPU_CMD_TRANSFER_FROM_HOST_3D,
67         VIRTIO_GPU_CMD_SUBMIT_3D,
68
69         /* cursor commands */
70         VIRTIO_GPU_CMD_UPDATE_CURSOR = 0x0300,
71         VIRTIO_GPU_CMD_MOVE_CURSOR,
72
73         /* success responses */
74         VIRTIO_GPU_RESP_OK_NODATA = 0x1100,
75         VIRTIO_GPU_RESP_OK_DISPLAY_INFO,
76         VIRTIO_GPU_RESP_OK_CAPSET_INFO,
77         VIRTIO_GPU_RESP_OK_CAPSET,
78
79         /* error responses */
80         VIRTIO_GPU_RESP_ERR_UNSPEC = 0x1200,
81         VIRTIO_GPU_RESP_ERR_OUT_OF_MEMORY,
82         VIRTIO_GPU_RESP_ERR_INVALID_SCANOUT_ID,
83         VIRTIO_GPU_RESP_ERR_INVALID_RESOURCE_ID,
84         VIRTIO_GPU_RESP_ERR_INVALID_CONTEXT_ID,
85         VIRTIO_GPU_RESP_ERR_INVALID_PARAMETER,
86 };
87
88 #define VIRTIO_GPU_FLAG_FENCE (1 << 0)
89
90 struct virtio_gpu_ctrl_hdr {
91         __le32 type;
92         __le32 flags;
93         __le64 fence_id;
94         __le32 ctx_id;
95         __le32 padding;
96 };
97
98 /* data passed in the cursor vq */
99
100 struct virtio_gpu_cursor_pos {
101         __le32 scanout_id;
102         __le32 x;
103         __le32 y;
104         __le32 padding;
105 };
106
107 /* VIRTIO_GPU_CMD_UPDATE_CURSOR, VIRTIO_GPU_CMD_MOVE_CURSOR */
108 struct virtio_gpu_update_cursor {
109         struct virtio_gpu_ctrl_hdr hdr;
110         struct virtio_gpu_cursor_pos pos;  /* update & move */
111         __le32 resource_id;           /* update only */
112         __le32 hot_x;                 /* update only */
113         __le32 hot_y;                 /* update only */
114         __le32 padding;
115 };
116
117 /* data passed in the control vq, 2d related */
118
119 struct virtio_gpu_rect {
120         __le32 x;
121         __le32 y;
122         __le32 width;
123         __le32 height;
124 };
125
126 /* VIRTIO_GPU_CMD_RESOURCE_UNREF */
127 struct virtio_gpu_resource_unref {
128         struct virtio_gpu_ctrl_hdr hdr;
129         __le32 resource_id;
130         __le32 padding;
131 };
132
133 /* VIRTIO_GPU_CMD_RESOURCE_CREATE_2D: create a 2d resource with a format */
134 struct virtio_gpu_resource_create_2d {
135         struct virtio_gpu_ctrl_hdr hdr;
136         __le32 resource_id;
137         __le32 format;
138         __le32 width;
139         __le32 height;
140 };
141
142 /* VIRTIO_GPU_CMD_SET_SCANOUT */
143 struct virtio_gpu_set_scanout {
144         struct virtio_gpu_ctrl_hdr hdr;
145         struct virtio_gpu_rect r;
146         __le32 scanout_id;
147         __le32 resource_id;
148 };
149
150 /* VIRTIO_GPU_CMD_RESOURCE_FLUSH */
151 struct virtio_gpu_resource_flush {
152         struct virtio_gpu_ctrl_hdr hdr;
153         struct virtio_gpu_rect r;
154         __le32 resource_id;
155         __le32 padding;
156 };
157
158 /* VIRTIO_GPU_CMD_TRANSFER_TO_HOST_2D: simple transfer to_host */
159 struct virtio_gpu_transfer_to_host_2d {
160         struct virtio_gpu_ctrl_hdr hdr;
161         struct virtio_gpu_rect r;
162         __le64 offset;
163         __le32 resource_id;
164         __le32 padding;
165 };
166
167 struct virtio_gpu_mem_entry {
168         __le64 addr;
169         __le32 length;
170         __le32 padding;
171 };
172
173 /* VIRTIO_GPU_CMD_RESOURCE_ATTACH_BACKING */
174 struct virtio_gpu_resource_attach_backing {
175         struct virtio_gpu_ctrl_hdr hdr;
176         __le32 resource_id;
177         __le32 nr_entries;
178 };
179
180 /* VIRTIO_GPU_CMD_RESOURCE_DETACH_BACKING */
181 struct virtio_gpu_resource_detach_backing {
182         struct virtio_gpu_ctrl_hdr hdr;
183         __le32 resource_id;
184         __le32 padding;
185 };
186
187 /* VIRTIO_GPU_RESP_OK_DISPLAY_INFO */
188 #define VIRTIO_GPU_MAX_SCANOUTS 16
189 struct virtio_gpu_resp_display_info {
190         struct virtio_gpu_ctrl_hdr hdr;
191         struct virtio_gpu_display_one {
192                 struct virtio_gpu_rect r;
193                 __le32 enabled;
194                 __le32 flags;
195         } pmodes[VIRTIO_GPU_MAX_SCANOUTS];
196 };
197
198 /* data passed in the control vq, 3d related */
199
200 struct virtio_gpu_box {
201         __le32 x, y, z;
202         __le32 w, h, d;
203 };
204
205 /* VIRTIO_GPU_CMD_TRANSFER_TO_HOST_3D, VIRTIO_GPU_CMD_TRANSFER_FROM_HOST_3D */
206 struct virtio_gpu_transfer_host_3d {
207         struct virtio_gpu_ctrl_hdr hdr;
208         struct virtio_gpu_box box;
209         __le64 offset;
210         __le32 resource_id;
211         __le32 level;
212         __le32 stride;
213         __le32 layer_stride;
214 };
215
216 /* VIRTIO_GPU_CMD_RESOURCE_CREATE_3D */
217 #define VIRTIO_GPU_RESOURCE_FLAG_Y_0_TOP (1 << 0)
218 struct virtio_gpu_resource_create_3d {
219         struct virtio_gpu_ctrl_hdr hdr;
220         __le32 resource_id;
221         __le32 target;
222         __le32 format;
223         __le32 bind;
224         __le32 width;
225         __le32 height;
226         __le32 depth;
227         __le32 array_size;
228         __le32 last_level;
229         __le32 nr_samples;
230         __le32 flags;
231         __le32 padding;
232 };
233
234 /* VIRTIO_GPU_CMD_CTX_CREATE */
235 struct virtio_gpu_ctx_create {
236         struct virtio_gpu_ctrl_hdr hdr;
237         __le32 nlen;
238         __le32 padding;
239         char debug_name[64];
240 };
241
242 /* VIRTIO_GPU_CMD_CTX_DESTROY */
243 struct virtio_gpu_ctx_destroy {
244         struct virtio_gpu_ctrl_hdr hdr;
245 };
246
247 /* VIRTIO_GPU_CMD_CTX_ATTACH_RESOURCE, VIRTIO_GPU_CMD_CTX_DETACH_RESOURCE */
248 struct virtio_gpu_ctx_resource {
249         struct virtio_gpu_ctrl_hdr hdr;
250         __le32 resource_id;
251         __le32 padding;
252 };
253
254 /* VIRTIO_GPU_CMD_SUBMIT_3D */
255 struct virtio_gpu_cmd_submit {
256         struct virtio_gpu_ctrl_hdr hdr;
257         __le32 size;
258         __le32 padding;
259 };
260
261 #define VIRTIO_GPU_CAPSET_VIRGL 1
262
263 /* VIRTIO_GPU_CMD_GET_CAPSET_INFO */
264 struct virtio_gpu_get_capset_info {
265         struct virtio_gpu_ctrl_hdr hdr;
266         __le32 capset_index;
267         __le32 padding;
268 };
269
270 /* VIRTIO_GPU_RESP_OK_CAPSET_INFO */
271 struct virtio_gpu_resp_capset_info {
272         struct virtio_gpu_ctrl_hdr hdr;
273         __le32 capset_id;
274         __le32 capset_max_version;
275         __le32 capset_max_size;
276         __le32 padding;
277 };
278
279 /* VIRTIO_GPU_CMD_GET_CAPSET */
280 struct virtio_gpu_get_capset {
281         struct virtio_gpu_ctrl_hdr hdr;
282         __le32 capset_id;
283         __le32 capset_version;
284 };
285
286 /* VIRTIO_GPU_RESP_OK_CAPSET */
287 struct virtio_gpu_resp_capset {
288         struct virtio_gpu_ctrl_hdr hdr;
289         __u8 capset_data[];
290 };
291
292 #define VIRTIO_GPU_EVENT_DISPLAY (1 << 0)
293
294 struct virtio_gpu_config {
295         __u32 events_read;
296         __u32 events_clear;
297         __u32 num_scanouts;
298         __u32 num_capsets;
299 };
300
301 /* simple formats for fbcon/X use */
302 enum virtio_gpu_formats {
303         VIRTIO_GPU_FORMAT_B8G8R8A8_UNORM  = 1,
304         VIRTIO_GPU_FORMAT_B8G8R8X8_UNORM  = 2,
305         VIRTIO_GPU_FORMAT_A8R8G8B8_UNORM  = 3,
306         VIRTIO_GPU_FORMAT_X8R8G8B8_UNORM  = 4,
307
308         VIRTIO_GPU_FORMAT_R8G8B8A8_UNORM  = 67,
309         VIRTIO_GPU_FORMAT_X8B8G8R8_UNORM  = 68,
310
311         VIRTIO_GPU_FORMAT_A8B8G8R8_UNORM  = 121,
312         VIRTIO_GPU_FORMAT_R8G8B8X8_UNORM  = 134,
313 };
314
315