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/virtio.h>
  30 #include <linux/virtio_ids.h>
  31 #include <linux/virtio_config.h>
  32 #include <linux/virtio_gpu.h>
  33
  34 #include <drm/drmP.h>
  35 #include <drm/drm_gem.h>
  36 #include <drm/drm_atomic.h>
  37 #include <drm/drm_crtc_helper.h>
  38 #include <drm/drm_encoder.h>
  39 #include <drm/drm_fb_helper.h>
  40 #include <drm/ttm/ttm_bo_api.h>
  41 #include <drm/ttm/ttm_bo_driver.h>
  42 #include <drm/ttm/ttm_placement.h>
  43 #include <drm/ttm/ttm_module.h>
  44
  45 #define DRIVER_NAME "virtio_gpu"
  46 #define DRIVER_DESC "virtio GPU"
  47 #define DRIVER_DATE "0"
  48
  49 #define DRIVER_MAJOR 0
  50 #define DRIVER_MINOR 1
  51 #define DRIVER_PATCHLEVEL 0
  52
  53 /* virtgpu_drm_bus.c */
  54 int drm_virtio_init(struct drm_driver *driver, struct virtio_device *vdev);
  55
  56 struct virtio_gpu_object {
  57         struct drm_gem_object gem_base;
  58         uint32_t hw_res_handle;
  59
  60         struct sg_table *pages;
  61         uint32_t mapped;
  62         void *vmap;
  63         bool dumb;
  64         struct ttm_place                placement_code;
  65         struct ttm_placement            placement;
  66         struct ttm_buffer_object        tbo;
  67         struct ttm_bo_kmap_obj          kmap;
  68         bool created;
  69 };
  70 #define gem_to_virtio_gpu_obj(gobj) \
  71         container_of((gobj), struct virtio_gpu_object, gem_base)
  72
  73 struct virtio_gpu_vbuffer;
  74 struct virtio_gpu_device;
  75
  76 typedef void (*virtio_gpu_resp_cb)(struct virtio_gpu_device *vgdev,
  77                                    struct virtio_gpu_vbuffer *vbuf);
  78
  79 struct virtio_gpu_fence_driver {
  80         atomic64_t       last_seq;
  81         uint64_t         sync_seq;
  82         uint64_t         context;
  83         struct list_head fences;
  84         spinlock_t       lock;
  85 };
  86
  87 struct virtio_gpu_fence {
  88         struct dma_fence f;
  89         struct virtio_gpu_fence_driver *drv;
  90         struct list_head node;
  91         uint64_t seq;
  92 };
  93 #define to_virtio_fence(x) \
  94         container_of(x, struct virtio_gpu_fence, f)
  95
  96 struct virtio_gpu_vbuffer {
  97         char *buf;
  98         int size;
  99
 100         void *data_buf;
 101         uint32_t data_size;
 102
 103         char *resp_buf;
 104         int resp_size;
 105
 106         virtio_gpu_resp_cb resp_cb;
 107
 108         struct list_head list;
 109 };
 110
 111 struct virtio_gpu_output {
 112         int index;
 113         struct drm_crtc crtc;
 114         struct drm_connector conn;
 115         struct drm_encoder enc;
 116         struct virtio_gpu_display_one info;
 117         struct virtio_gpu_update_cursor cursor;
 118         int cur_x;
 119         int cur_y;
 120         bool enabled;
 121 };
 122 #define drm_crtc_to_virtio_gpu_output(x) \
 123         container_of(x, struct virtio_gpu_output, crtc)
 124 #define drm_connector_to_virtio_gpu_output(x) \
 125         container_of(x, struct virtio_gpu_output, conn)
 126 #define drm_encoder_to_virtio_gpu_output(x) \
 127         container_of(x, struct virtio_gpu_output, enc)
 128
 129 struct virtio_gpu_framebuffer {
 130         struct drm_framebuffer base;
 131         int x1, y1, x2, y2; /* dirty rect */
 132         spinlock_t dirty_lock;
 133         uint32_t hw_res_handle;
 134         struct virtio_gpu_fence *fence;
 135 };
 136 #define to_virtio_gpu_framebuffer(x) \
 137         container_of(x, struct virtio_gpu_framebuffer, base)
 138
 139 struct virtio_gpu_fbdev {
 140         struct drm_fb_helper           helper;
 141         struct virtio_gpu_framebuffer  vgfb;
 142         struct virtio_gpu_device       *vgdev;
 143         struct delayed_work            work;
 144 };
 145
 146 struct virtio_gpu_mman {
 147         struct ttm_bo_device            bdev;
 148 };
 149
 150 struct virtio_gpu_fbdev;
 151
 152 struct virtio_gpu_queue {
 153         struct virtqueue *vq;
 154         spinlock_t qlock;
 155         wait_queue_head_t ack_queue;
 156         struct work_struct dequeue_work;
 157 };
 158
 159 struct virtio_gpu_drv_capset {
 160         uint32_t id;
 161         uint32_t max_version;
 162         uint32_t max_size;
 163 };
 164
 165 struct virtio_gpu_drv_cap_cache {
 166         struct list_head head;
 167         void *caps_cache;
 168         uint32_t id;
 169         uint32_t version;
 170         uint32_t size;
 171         atomic_t is_valid;
 172 };
 173
 174 struct virtio_gpu_device {
 175         struct device *dev;
 176         struct drm_device *ddev;
 177
 178         struct virtio_device *vdev;
 179
 180         struct virtio_gpu_mman mman;
 181
 182         /* pointer to fbdev info structure */
 183         struct virtio_gpu_fbdev *vgfbdev;
 184         struct virtio_gpu_output outputs[VIRTIO_GPU_MAX_SCANOUTS];
 185         uint32_t num_scanouts;
 186
 187         struct virtio_gpu_queue ctrlq;
 188         struct virtio_gpu_queue cursorq;
 189         struct kmem_cache *vbufs;
 190         bool vqs_ready;
 191
 192         struct ida      resource_ida;
 193
 194         wait_queue_head_t resp_wq;
 195         /* current display info */
 196         spinlock_t display_info_lock;
 197         bool display_info_pending;
 198
 199         struct virtio_gpu_fence_driver fence_drv;
 200
 201         struct ida      ctx_id_ida;
 202
 203         bool has_virgl_3d;
 204
 205         struct work_struct config_changed_work;
 206
 207         struct virtio_gpu_drv_capset *capsets;
 208         uint32_t num_capsets;
 209         struct list_head cap_cache;
 210 };
 211
 212 struct virtio_gpu_fpriv {
 213         uint32_t ctx_id;
 214 };
 215
 216 /* virtio_ioctl.c */
 217 #define DRM_VIRTIO_NUM_IOCTLS 10
 218 extern struct drm_ioctl_desc virtio_gpu_ioctls[DRM_VIRTIO_NUM_IOCTLS];
 219
 220 /* virtio_kms.c */
 221 int virtio_gpu_driver_load(struct drm_device *dev, unsigned long flags);
 222 void virtio_gpu_driver_unload(struct drm_device *dev);
 223 int virtio_gpu_driver_open(struct drm_device *dev, struct drm_file *file);
 224 void virtio_gpu_driver_postclose(struct drm_device *dev, struct drm_file *file);
 225
 226 /* virtio_gem.c */
 227 void virtio_gpu_gem_free_object(struct drm_gem_object *gem_obj);
 228 int virtio_gpu_gem_init(struct virtio_gpu_device *vgdev);
 229 void virtio_gpu_gem_fini(struct virtio_gpu_device *vgdev);
 230 int virtio_gpu_gem_create(struct drm_file *file,
 231                           struct drm_device *dev,
 232                           uint64_t size,
 233                           struct drm_gem_object **obj_p,
 234                           uint32_t *handle_p);
 235 int virtio_gpu_gem_object_open(struct drm_gem_object *obj,
 236                                struct drm_file *file);
 237 void virtio_gpu_gem_object_close(struct drm_gem_object *obj,
 238                                  struct drm_file *file);
 239 struct virtio_gpu_object *virtio_gpu_alloc_object(struct drm_device *dev,
 240                                                   size_t size, bool kernel,
 241                                                   bool pinned);
 242 int virtio_gpu_mode_dumb_create(struct drm_file *file_priv,
 243                                 struct drm_device *dev,
 244                                 struct drm_mode_create_dumb *args);
 245 int virtio_gpu_mode_dumb_mmap(struct drm_file *file_priv,
 246                               struct drm_device *dev,
 247                               uint32_t handle, uint64_t *offset_p);
 248
 249 /* virtio_fb */
 250 #define VIRTIO_GPUFB_CONN_LIMIT 1
 251 int virtio_gpu_fbdev_init(struct virtio_gpu_device *vgdev);
 252 void virtio_gpu_fbdev_fini(struct virtio_gpu_device *vgdev);
 253 int virtio_gpu_surface_dirty(struct virtio_gpu_framebuffer *qfb,
 254                              struct drm_clip_rect *clips,
 255                              unsigned int num_clips);
 256 /* virtio vg */
 257 int virtio_gpu_alloc_vbufs(struct virtio_gpu_device *vgdev);
 258 void virtio_gpu_free_vbufs(struct virtio_gpu_device *vgdev);
 259 void virtio_gpu_cmd_create_resource(struct virtio_gpu_device *vgdev,
 260                                     struct virtio_gpu_object *bo,
 261                                     uint32_t format,
 262                                     uint32_t width,
 263                                     uint32_t height);
 264 void virtio_gpu_cmd_unref_resource(struct virtio_gpu_device *vgdev,
 265                                    uint32_t resource_id);
 266 void virtio_gpu_cmd_transfer_to_host_2d(struct virtio_gpu_device *vgdev,
 267                                         struct virtio_gpu_object *bo,
 268                                         uint64_t offset,
 269                                         __le32 width, __le32 height,
 270                                         __le32 x, __le32 y,
 271                                         struct virtio_gpu_fence **fence);
 272 void virtio_gpu_cmd_resource_flush(struct virtio_gpu_device *vgdev,
 273                                    uint32_t resource_id,
 274                                    uint32_t x, uint32_t y,
 275                                    uint32_t width, uint32_t height);
 276 void virtio_gpu_cmd_set_scanout(struct virtio_gpu_device *vgdev,
 277                                 uint32_t scanout_id, uint32_t resource_id,
 278                                 uint32_t width, uint32_t height,
 279                                 uint32_t x, uint32_t y);
 280 int virtio_gpu_object_attach(struct virtio_gpu_device *vgdev,
 281                              struct virtio_gpu_object *obj,
 282                              struct virtio_gpu_fence **fence);
 283 void virtio_gpu_object_detach(struct virtio_gpu_device *vgdev,
 284                               struct virtio_gpu_object *obj);
 285 int virtio_gpu_attach_status_page(struct virtio_gpu_device *vgdev);
 286 int virtio_gpu_detach_status_page(struct virtio_gpu_device *vgdev);
 287 void virtio_gpu_cursor_ping(struct virtio_gpu_device *vgdev,
 288                             struct virtio_gpu_output *output);
 289 int virtio_gpu_cmd_get_display_info(struct virtio_gpu_device *vgdev);
 290 int virtio_gpu_cmd_get_capset_info(struct virtio_gpu_device *vgdev, int idx);
 291 int virtio_gpu_cmd_get_capset(struct virtio_gpu_device *vgdev,
 292                               int idx, int version,
 293                               struct virtio_gpu_drv_cap_cache **cache_p);
 294 void virtio_gpu_cmd_context_create(struct virtio_gpu_device *vgdev, uint32_t id,
 295                                    uint32_t nlen, const char *name);
 296 void virtio_gpu_cmd_context_destroy(struct virtio_gpu_device *vgdev,
 297                                     uint32_t id);
 298 void virtio_gpu_cmd_context_attach_resource(struct virtio_gpu_device *vgdev,
 299                                             uint32_t ctx_id,
 300                                             uint32_t resource_id);
 301 void virtio_gpu_cmd_context_detach_resource(struct virtio_gpu_device *vgdev,
 302                                             uint32_t ctx_id,
 303                                             uint32_t resource_id);
 304 void virtio_gpu_cmd_submit(struct virtio_gpu_device *vgdev,
 305                            void *data, uint32_t data_size,
 306                            uint32_t ctx_id, struct virtio_gpu_fence **fence);
 307 void virtio_gpu_cmd_transfer_from_host_3d(struct virtio_gpu_device *vgdev,
 308                                           uint32_t resource_id, uint32_t ctx_id,
 309                                           uint64_t offset, uint32_t level,
 310                                           struct virtio_gpu_box *box,
 311                                           struct virtio_gpu_fence **fence);
 312 void virtio_gpu_cmd_transfer_to_host_3d(struct virtio_gpu_device *vgdev,
 313                                         struct virtio_gpu_object *bo,
 314                                         uint32_t ctx_id,
 315                                         uint64_t offset, uint32_t level,
 316                                         struct virtio_gpu_box *box,
 317                                         struct virtio_gpu_fence **fence);
 318 void
 319 virtio_gpu_cmd_resource_create_3d(struct virtio_gpu_device *vgdev,
 320                                   struct virtio_gpu_object *bo,
 321                                   struct virtio_gpu_resource_create_3d *rc_3d,
 322                                   struct virtio_gpu_fence **fence);
 323 void virtio_gpu_ctrl_ack(struct virtqueue *vq);
 324 void virtio_gpu_cursor_ack(struct virtqueue *vq);
 325 void virtio_gpu_fence_ack(struct virtqueue *vq);
 326 void virtio_gpu_dequeue_ctrl_func(struct work_struct *work);
 327 void virtio_gpu_dequeue_cursor_func(struct work_struct *work);
 328 void virtio_gpu_dequeue_fence_func(struct work_struct *work);
 329
 330 /* virtio_gpu_display.c */
 331 int virtio_gpu_framebuffer_init(struct drm_device *dev,
 332                                 struct virtio_gpu_framebuffer *vgfb,
 333                                 const struct drm_mode_fb_cmd2 *mode_cmd,
 334                                 struct drm_gem_object *obj);
 335 int virtio_gpu_modeset_init(struct virtio_gpu_device *vgdev);
 336 void virtio_gpu_modeset_fini(struct virtio_gpu_device *vgdev);
 337
 338 /* virtio_gpu_plane.c */
 339 uint32_t virtio_gpu_translate_format(uint32_t drm_fourcc);
 340 struct drm_plane *virtio_gpu_plane_init(struct virtio_gpu_device *vgdev,
 341                                         enum drm_plane_type type,
 342                                         int index);
 343
 344 /* virtio_gpu_ttm.c */
 345 int virtio_gpu_ttm_init(struct virtio_gpu_device *vgdev);
 346 void virtio_gpu_ttm_fini(struct virtio_gpu_device *vgdev);
 347 int virtio_gpu_mmap(struct file *filp, struct vm_area_struct *vma);
 348
 349 /* virtio_gpu_fence.c */
 350 struct virtio_gpu_fence *virtio_gpu_fence_alloc(
 351         struct virtio_gpu_device *vgdev);
 352 void virtio_gpu_fence_cleanup(struct virtio_gpu_fence *fence);
 353 int virtio_gpu_fence_emit(struct virtio_gpu_device *vgdev,
 354                           struct virtio_gpu_ctrl_hdr *cmd_hdr,
 355                           struct virtio_gpu_fence **fence);
 356 void virtio_gpu_fence_event_process(struct virtio_gpu_device *vdev,
 357                                     u64 last_seq);
 358
 359 /* virtio_gpu_object */
 360 int virtio_gpu_object_create(struct virtio_gpu_device *vgdev,
 361                              unsigned long size, bool kernel, bool pinned,
 362                              struct virtio_gpu_object **bo_ptr);
 363 void virtio_gpu_object_kunmap(struct virtio_gpu_object *bo);
 364 int virtio_gpu_object_kmap(struct virtio_gpu_object *bo);
 365 int virtio_gpu_object_get_sg_table(struct virtio_gpu_device *qdev,
 366                                    struct virtio_gpu_object *bo);
 367 void virtio_gpu_object_free_sg_table(struct virtio_gpu_object *bo);
 368 int virtio_gpu_object_wait(struct virtio_gpu_object *bo, bool no_wait);
 369
 370 /* virtgpu_prime.c */
 371 int virtgpu_gem_prime_pin(struct drm_gem_object *obj);
 372 void virtgpu_gem_prime_unpin(struct drm_gem_object *obj);
 373 struct sg_table *virtgpu_gem_prime_get_sg_table(struct drm_gem_object *obj);
 374 struct drm_gem_object *virtgpu_gem_prime_import_sg_table(
 375         struct drm_device *dev, struct dma_buf_attachment *attach,
 376         struct sg_table *sgt);
 377 void *virtgpu_gem_prime_vmap(struct drm_gem_object *obj);
 378 void virtgpu_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
 379 int virtgpu_gem_prime_mmap(struct drm_gem_object *obj,
 380                            struct vm_area_struct *vma);
 381
 382 static inline struct virtio_gpu_object*
 383 virtio_gpu_object_ref(struct virtio_gpu_object *bo)
 384 {
 385         ttm_bo_get(&bo->tbo);
 386         return bo;
 387 }
 388
 389 static inline void virtio_gpu_object_unref(struct virtio_gpu_object **bo)
 390 {
 391         struct ttm_buffer_object *tbo;
 392
 393         if ((*bo) == NULL)
 394                 return;
 395         tbo = &((*bo)->tbo);
 396         ttm_bo_put(tbo);
 397         *bo = NULL;
 398 }
 399
 400 static inline u64 virtio_gpu_object_mmap_offset(struct virtio_gpu_object *bo)
 401 {
 402         return drm_vma_node_offset_addr(&bo->tbo.vma_node);
 403 }
 404
 405 static inline int virtio_gpu_object_reserve(struct virtio_gpu_object *bo,
 406                                          bool no_wait)
 407 {
 408         int r;
 409
 410         r = ttm_bo_reserve(&bo->tbo, true, no_wait, NULL);
 411         if (unlikely(r != 0)) {
 412                 if (r != -ERESTARTSYS) {
 413                         struct virtio_gpu_device *qdev =
 414                                 bo->gem_base.dev->dev_private;
 415                         dev_err(qdev->dev, "%p reserve failed\n", bo);
 416                 }
 417                 return r;
 418         }
 419         return 0;
 420 }
 421
 422 static inline void virtio_gpu_object_unreserve(struct virtio_gpu_object *bo)
 423 {
 424         ttm_bo_unreserve(&bo->tbo);
 425 }
 426
 427 /* virgl debufs */
 428 int virtio_gpu_debugfs_init(struct drm_minor *minor);
 429
 430 #endif