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