drivers/gpu/drm/virtio/virtgpu_drv.h

   1 /*
   2  * Copyright (C) 2015 Red Hat, Inc.
   3  * All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the
  14  * next paragraph) shall be included in all copies or substantial
  15  * portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  20  * IN NO EVENT SHALL THE COPYRIGHT OWNER(S) AND/OR ITS SUPPLIERS BE
  21  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  22  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  23  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 #ifndef VIRTIO_DRV_H
  27 #define VIRTIO_DRV_H
  28
  29 #include <linux/dma-direction.h>
  30 #include <linux/virtio.h>
  31 #include <linux/virtio_ids.h>
  32 #include <linux/virtio_config.h>
  33 #include <linux/virtio_gpu.h>
  34
  35 #include <drm/drm_atomic.h>
  36 #include <drm/drm_drv.h>
  37 #include <drm/drm_encoder.h>
  38 #include <drm/drm_fb_helper.h>
  39 #include <drm/drm_fourcc.h>
  40 #include <drm/drm_gem.h>
  41 #include <drm/drm_gem_shmem_helper.h>
  42 #include <drm/drm_ioctl.h>
  43 #include <drm/drm_probe_helper.h>
  44 #include <drm/virtgpu_drm.h>
  45
  46 #define DRIVER_NAME "virtio_gpu"
  47 #define DRIVER_DESC "virtio GPU"
  48 #define DRIVER_DATE "0"
  49
  50 #define DRIVER_MAJOR 0
  51 #define DRIVER_MINOR 1
  52 #define DRIVER_PATCHLEVEL 0
  53
  54 #define STATE_INITIALIZING 0
  55 #define STATE_OK 1
  56 #define STATE_ERR 2
  57
  58 #define MAX_CAPSET_ID 63
  59
  60 struct virtio_gpu_object_params {
  61         unsigned long size;
  62         bool dumb;
  63         /* 3d */
  64         bool virgl;
  65         bool blob;
  66
  67         /* classic resources only */
  68         uint32_t format;
  69         uint32_t width;
  70         uint32_t height;
  71         uint32_t target;
  72         uint32_t bind;
  73         uint32_t depth;
  74         uint32_t array_size;
  75         uint32_t last_level;
  76         uint32_t nr_samples;
  77         uint32_t flags;
  78
  79         /* blob resources only */
  80         uint32_t ctx_id;
  81         uint32_t blob_mem;
  82         uint32_t blob_flags;
  83         uint64_t blob_id;
  84 };
  85
  86 struct virtio_gpu_object {
  87         struct drm_gem_shmem_object base;
  88         uint32_t hw_res_handle;
  89         bool dumb;
  90         bool created;
  91         bool host3d_blob, guest_blob;
  92         uint32_t blob_mem, blob_flags;
  93
  94         int uuid_state;
  95         uuid_t uuid;
  96 };
  97 #define gem_to_virtio_gpu_obj(gobj) \
  98         container_of((gobj), struct virtio_gpu_object, base.base)
  99
 100 struct virtio_gpu_object_shmem {
 101         struct virtio_gpu_object base;
 102         struct sg_table *pages;
 103         uint32_t mapped;
 104 };
 105
 106 struct virtio_gpu_object_vram {
 107         struct virtio_gpu_object base;
 108         uint32_t map_state;
 109         uint32_t map_info;
 110         struct drm_mm_node vram_node;
 111 };
 112
 113 #define to_virtio_gpu_shmem(virtio_gpu_object) \
 114         container_of((virtio_gpu_object), struct virtio_gpu_object_shmem, base)
 115
 116 #define to_virtio_gpu_vram(virtio_gpu_object) \
 117         container_of((virtio_gpu_object), struct virtio_gpu_object_vram, base)
 118
 119 struct virtio_gpu_object_array {
 120         struct ww_acquire_ctx ticket;
 121         struct list_head next;
 122         u32 nents, total;
 123         struct drm_gem_object *objs[];
 124 };
 125
 126 struct virtio_gpu_vbuffer;
 127 struct virtio_gpu_device;
 128
 129 typedef void (*virtio_gpu_resp_cb)(struct virtio_gpu_device *vgdev,
 130                                    struct virtio_gpu_vbuffer *vbuf);
 131
 132 struct virtio_gpu_fence_driver {
 133         atomic64_t       last_fence_id;
 134         uint64_t         current_fence_id;
 135         uint64_t         context;
 136         struct list_head fences;
 137         spinlock_t       lock;
 138 };
 139
 140 struct virtio_gpu_fence {
 141         struct dma_fence f;
 142         uint64_t fence_id;
 143         struct virtio_gpu_fence_driver *drv;
 144         struct list_head node;
 145 };
 146
 147 struct virtio_gpu_vbuffer {
 148         char *buf;
 149         int size;
 150
 151         void *data_buf;
 152         uint32_t data_size;
 153
 154         char *resp_buf;
 155         int resp_size;
 156         virtio_gpu_resp_cb resp_cb;
 157         void *resp_cb_data;
 158
 159         struct virtio_gpu_object_array *objs;
 160         struct list_head list;
 161 };
 162
 163 struct virtio_gpu_output {
 164         int index;
 165         struct drm_crtc crtc;
 166         struct drm_connector conn;
 167         struct drm_encoder enc;
 168         struct virtio_gpu_display_one info;
 169         struct virtio_gpu_update_cursor cursor;
 170         struct edid *edid;
 171         int cur_x;
 172         int cur_y;
 173         bool needs_modeset;
 174 };
 175 #define drm_crtc_to_virtio_gpu_output(x) \
 176         container_of(x, struct virtio_gpu_output, crtc)
 177
 178 struct virtio_gpu_framebuffer {
 179         struct drm_framebuffer base;
 180         struct virtio_gpu_fence *fence;
 181 };
 182 #define to_virtio_gpu_framebuffer(x) \
 183         container_of(x, struct virtio_gpu_framebuffer, base)
 184
 185 struct virtio_gpu_queue {
 186         struct virtqueue *vq;
 187         spinlock_t qlock;
 188         wait_queue_head_t ack_queue;
 189         struct work_struct dequeue_work;
 190 };
 191
 192 struct virtio_gpu_drv_capset {
 193         uint32_t id;
 194         uint32_t max_version;
 195         uint32_t max_size;
 196 };
 197
 198 struct virtio_gpu_drv_cap_cache {
 199         struct list_head head;
 200         void *caps_cache;
 201         uint32_t id;
 202         uint32_t version;
 203         uint32_t size;
 204         atomic_t is_valid;
 205 };
 206
 207 struct virtio_gpu_device {
 208         struct device *dev;
 209         struct drm_device *ddev;
 210
 211         struct virtio_device *vdev;
 212
 213         struct virtio_gpu_output outputs[VIRTIO_GPU_MAX_SCANOUTS];
 214         uint32_t num_scanouts;
 215
 216         struct virtio_gpu_queue ctrlq;
 217         struct virtio_gpu_queue cursorq;
 218         struct kmem_cache *vbufs;
 219
 220         atomic_t pending_commands;
 221
 222         struct ida      resource_ida;
 223
 224         wait_queue_head_t resp_wq;
 225         /* current display info */
 226         spinlock_t display_info_lock;
 227         bool display_info_pending;
 228
 229         struct virtio_gpu_fence_driver fence_drv;
 230
 231         struct ida      ctx_id_ida;
 232
 233         bool has_virgl_3d;
 234         bool has_edid;
 235         bool has_indirect;
 236         bool has_resource_assign_uuid;
 237         bool has_resource_blob;
 238         bool has_host_visible;
 239         struct virtio_shm_region host_visible_region;
 240         struct drm_mm host_visible_mm;
 241
 242         struct work_struct config_changed_work;
 243
 244         struct work_struct obj_free_work;
 245         spinlock_t obj_free_lock;
 246         struct list_head obj_free_list;
 247
 248         struct virtio_gpu_drv_capset *capsets;
 249         uint32_t num_capsets;
 250         uint64_t capset_id_mask;
 251         struct list_head cap_cache;
 252
 253         /* protects uuid state when exporting */
 254         spinlock_t resource_export_lock;
 255         /* protects map state and host_visible_mm */
 256         spinlock_t host_visible_lock;
 257 };
 258
 259 struct virtio_gpu_fpriv {
 260         uint32_t ctx_id;
 261         bool context_created;
 262         struct mutex context_lock;
 263 };
 264
 265 /* virtgpu_ioctl.c */
 266 #define DRM_VIRTIO_NUM_IOCTLS 11
 267 extern struct drm_ioctl_desc virtio_gpu_ioctls[DRM_VIRTIO_NUM_IOCTLS];
 268 void virtio_gpu_create_context(struct drm_device *dev, struct drm_file *file);
 269
 270 /* virtgpu_kms.c */
 271 int virtio_gpu_init(struct drm_device *dev);
 272 void virtio_gpu_deinit(struct drm_device *dev);
 273 void virtio_gpu_release(struct drm_device *dev);
 274 int virtio_gpu_driver_open(struct drm_device *dev, struct drm_file *file);
 275 void virtio_gpu_driver_postclose(struct drm_device *dev, struct drm_file *file);
 276
 277 /* virtgpu_gem.c */
 278 int virtio_gpu_gem_object_open(struct drm_gem_object *obj,
 279                                struct drm_file *file);
 280 void virtio_gpu_gem_object_close(struct drm_gem_object *obj,
 281                                  struct drm_file *file);
 282 int virtio_gpu_mode_dumb_create(struct drm_file *file_priv,
 283                                 struct drm_device *dev,
 284                                 struct drm_mode_create_dumb *args);
 285 int virtio_gpu_mode_dumb_mmap(struct drm_file *file_priv,
 286                               struct drm_device *dev,
 287                               uint32_t handle, uint64_t *offset_p);
 288
 289 struct virtio_gpu_object_array *virtio_gpu_array_alloc(u32 nents);
 290 struct virtio_gpu_object_array*
 291 virtio_gpu_array_from_handles(struct drm_file *drm_file, u32 *handles, u32 nents);
 292 void virtio_gpu_array_add_obj(struct virtio_gpu_object_array *objs,
 293                               struct drm_gem_object *obj);
 294 int virtio_gpu_array_lock_resv(struct virtio_gpu_object_array *objs);
 295 void virtio_gpu_array_unlock_resv(struct virtio_gpu_object_array *objs);
 296 void virtio_gpu_array_add_fence(struct virtio_gpu_object_array *objs,
 297                                 struct dma_fence *fence);
 298 void virtio_gpu_array_put_free(struct virtio_gpu_object_array *objs);
 299 void virtio_gpu_array_put_free_delayed(struct virtio_gpu_device *vgdev,
 300                                        struct virtio_gpu_object_array *objs);
 301 void virtio_gpu_array_put_free_work(struct work_struct *work);
 302
 303 /* virtgpu_vq.c */
 304 int virtio_gpu_alloc_vbufs(struct virtio_gpu_device *vgdev);
 305 void virtio_gpu_free_vbufs(struct virtio_gpu_device *vgdev);
 306 void virtio_gpu_cmd_create_resource(struct virtio_gpu_device *vgdev,
 307                                     struct virtio_gpu_object *bo,
 308                                     struct virtio_gpu_object_params *params,
 309                                     struct virtio_gpu_object_array *objs,
 310                                     struct virtio_gpu_fence *fence);
 311 void virtio_gpu_cmd_unref_resource(struct virtio_gpu_device *vgdev,
 312                                    struct virtio_gpu_object *bo);
 313 void virtio_gpu_cmd_transfer_to_host_2d(struct virtio_gpu_device *vgdev,
 314                                         uint64_t offset,
 315                                         uint32_t width, uint32_t height,
 316                                         uint32_t x, uint32_t y,
 317                                         struct virtio_gpu_object_array *objs,
 318                                         struct virtio_gpu_fence *fence);
 319 void virtio_gpu_cmd_resource_flush(struct virtio_gpu_device *vgdev,
 320                                    uint32_t resource_id,
 321                                    uint32_t x, uint32_t y,
 322                                    uint32_t width, uint32_t height,
 323                                    struct virtio_gpu_object_array *objs,
 324                                    struct virtio_gpu_fence *fence);
 325 void virtio_gpu_cmd_set_scanout(struct virtio_gpu_device *vgdev,
 326                                 uint32_t scanout_id, uint32_t resource_id,
 327                                 uint32_t width, uint32_t height,
 328                                 uint32_t x, uint32_t y);
 329 void virtio_gpu_object_attach(struct virtio_gpu_device *vgdev,
 330                               struct virtio_gpu_object *obj,
 331                               struct virtio_gpu_mem_entry *ents,
 332                               unsigned int nents);
 333 int virtio_gpu_attach_status_page(struct virtio_gpu_device *vgdev);
 334 int virtio_gpu_detach_status_page(struct virtio_gpu_device *vgdev);
 335 void virtio_gpu_cursor_ping(struct virtio_gpu_device *vgdev,
 336                             struct virtio_gpu_output *output);
 337 int virtio_gpu_cmd_get_display_info(struct virtio_gpu_device *vgdev);
 338 int virtio_gpu_cmd_get_capset_info(struct virtio_gpu_device *vgdev, int idx);
 339 int virtio_gpu_cmd_get_capset(struct virtio_gpu_device *vgdev,
 340                               int idx, int version,
 341                               struct virtio_gpu_drv_cap_cache **cache_p);
 342 int virtio_gpu_cmd_get_edids(struct virtio_gpu_device *vgdev);
 343 void virtio_gpu_cmd_context_create(struct virtio_gpu_device *vgdev, uint32_t id,
 344                                    uint32_t nlen, const char *name);
 345 void virtio_gpu_cmd_context_destroy(struct virtio_gpu_device *vgdev,
 346                                     uint32_t id);
 347 void virtio_gpu_cmd_context_attach_resource(struct virtio_gpu_device *vgdev,
 348                                             uint32_t ctx_id,
 349                                             struct virtio_gpu_object_array *objs);
 350 void virtio_gpu_cmd_context_detach_resource(struct virtio_gpu_device *vgdev,
 351                                             uint32_t ctx_id,
 352                                             struct virtio_gpu_object_array *objs);
 353 void virtio_gpu_cmd_submit(struct virtio_gpu_device *vgdev,
 354                            void *data, uint32_t data_size,
 355                            uint32_t ctx_id,
 356                            struct virtio_gpu_object_array *objs,
 357                            struct virtio_gpu_fence *fence);
 358 void virtio_gpu_cmd_transfer_from_host_3d(struct virtio_gpu_device *vgdev,
 359                                           uint32_t ctx_id,
 360                                           uint64_t offset, uint32_t level,
 361                                           uint32_t stride,
 362                                           uint32_t layer_stride,
 363                                           struct drm_virtgpu_3d_box *box,
 364                                           struct virtio_gpu_object_array *objs,
 365                                           struct virtio_gpu_fence *fence);
 366 void virtio_gpu_cmd_transfer_to_host_3d(struct virtio_gpu_device *vgdev,
 367                                         uint32_t ctx_id,
 368                                         uint64_t offset, uint32_t level,
 369                                         uint32_t stride,
 370                                         uint32_t layer_stride,
 371                                         struct drm_virtgpu_3d_box *box,
 372                                         struct virtio_gpu_object_array *objs,
 373                                         struct virtio_gpu_fence *fence);
 374 void
 375 virtio_gpu_cmd_resource_create_3d(struct virtio_gpu_device *vgdev,
 376                                   struct virtio_gpu_object *bo,
 377                                   struct virtio_gpu_object_params *params,
 378                                   struct virtio_gpu_object_array *objs,
 379                                   struct virtio_gpu_fence *fence);
 380 void virtio_gpu_ctrl_ack(struct virtqueue *vq);
 381 void virtio_gpu_cursor_ack(struct virtqueue *vq);
 382 void virtio_gpu_fence_ack(struct virtqueue *vq);
 383 void virtio_gpu_dequeue_ctrl_func(struct work_struct *work);
 384 void virtio_gpu_dequeue_cursor_func(struct work_struct *work);
 385 void virtio_gpu_dequeue_fence_func(struct work_struct *work);
 386
 387 void virtio_gpu_notify(struct virtio_gpu_device *vgdev);
 388
 389 int
 390 virtio_gpu_cmd_resource_assign_uuid(struct virtio_gpu_device *vgdev,
 391                                     struct virtio_gpu_object_array *objs);
 392
 393 int virtio_gpu_cmd_map(struct virtio_gpu_device *vgdev,
 394                        struct virtio_gpu_object_array *objs, uint64_t offset);
 395
 396 void virtio_gpu_cmd_unmap(struct virtio_gpu_device *vgdev,
 397                           struct virtio_gpu_object *bo);
 398
 399 void
 400 virtio_gpu_cmd_resource_create_blob(struct virtio_gpu_device *vgdev,
 401                                     struct virtio_gpu_object *bo,
 402                                     struct virtio_gpu_object_params *params,
 403                                     struct virtio_gpu_mem_entry *ents,
 404                                     uint32_t nents);
 405 void
 406 virtio_gpu_cmd_set_scanout_blob(struct virtio_gpu_device *vgdev,
 407                                 uint32_t scanout_id,
 408                                 struct virtio_gpu_object *bo,
 409                                 struct drm_framebuffer *fb,
 410                                 uint32_t width, uint32_t height,
 411                                 uint32_t x, uint32_t y);
 412
 413 /* virtgpu_display.c */
 414 int virtio_gpu_modeset_init(struct virtio_gpu_device *vgdev);
 415 void virtio_gpu_modeset_fini(struct virtio_gpu_device *vgdev);
 416
 417 /* virtgpu_plane.c */
 418 uint32_t virtio_gpu_translate_format(uint32_t drm_fourcc);
 419 struct drm_plane *virtio_gpu_plane_init(struct virtio_gpu_device *vgdev,
 420                                         enum drm_plane_type type,
 421                                         int index);
 422
 423 /* virtgpu_fence.c */
 424 struct virtio_gpu_fence *virtio_gpu_fence_alloc(
 425         struct virtio_gpu_device *vgdev);
 426 void virtio_gpu_fence_emit(struct virtio_gpu_device *vgdev,
 427                           struct virtio_gpu_ctrl_hdr *cmd_hdr,
 428                           struct virtio_gpu_fence *fence);
 429 void virtio_gpu_fence_event_process(struct virtio_gpu_device *vdev,
 430                                     u64 fence_id);
 431
 432 /* virtgpu_object.c */
 433 void virtio_gpu_cleanup_object(struct virtio_gpu_object *bo);
 434 struct drm_gem_object *virtio_gpu_create_object(struct drm_device *dev,
 435                                                 size_t size);
 436 int virtio_gpu_object_create(struct virtio_gpu_device *vgdev,
 437                              struct virtio_gpu_object_params *params,
 438                              struct virtio_gpu_object **bo_ptr,
 439                              struct virtio_gpu_fence *fence);
 440
 441 bool virtio_gpu_is_shmem(struct virtio_gpu_object *bo);
 442
 443 int virtio_gpu_resource_id_get(struct virtio_gpu_device *vgdev,
 444                                uint32_t *resid);
 445 /* virtgpu_prime.c */
 446 int virtio_gpu_resource_assign_uuid(struct virtio_gpu_device *vgdev,
 447                                     struct virtio_gpu_object *bo);
 448 struct dma_buf *virtgpu_gem_prime_export(struct drm_gem_object *obj,
 449                                          int flags);
 450 struct drm_gem_object *virtgpu_gem_prime_import(struct drm_device *dev,
 451                                                 struct dma_buf *buf);
 452 int virtgpu_gem_prime_get_uuid(struct drm_gem_object *obj,
 453                                uuid_t *uuid);
 454 struct drm_gem_object *virtgpu_gem_prime_import_sg_table(
 455         struct drm_device *dev, struct dma_buf_attachment *attach,
 456         struct sg_table *sgt);
 457
 458 /* virtgpu_debugfs.c */
 459 void virtio_gpu_debugfs_init(struct drm_minor *minor);
 460
 461 /* virtgpu_vram.c */
 462 bool virtio_gpu_is_vram(struct virtio_gpu_object *bo);
 463 int virtio_gpu_vram_create(struct virtio_gpu_device *vgdev,
 464                            struct virtio_gpu_object_params *params,
 465                            struct virtio_gpu_object **bo_ptr);
 466 struct sg_table *virtio_gpu_vram_map_dma_buf(struct virtio_gpu_object *bo,
 467                                              struct device *dev,
 468                                              enum dma_data_direction dir);
 469 void virtio_gpu_vram_unmap_dma_buf(struct device *dev,
 470                                    struct sg_table *sgt,
 471                                    enum dma_data_direction dir);
 472
 473 #endif