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