1 /* 2 * Copyright 2013 Red Hat Inc. 3 * 4 * Permission is hereby granted, free of charge, to any person obtaining a 5 * copy of this software and associated documentation files (the "Software"), 6 * to deal in the Software without restriction, including without limitation 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 * and/or sell copies of the Software, and to permit persons to whom the 9 * Software is furnished to do so, subject to the following conditions: 10 * 11 * The above copyright notice and this permission notice shall be included in 12 * all copies or substantial portions of the Software. 13 * 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR 18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 20 * OTHER DEALINGS IN THE SOFTWARE. 21 * 22 * Authors: Dave Airlie 23 * Alon Levy 24 */ 25 26 #ifndef QXL_DRV_H 27 #define QXL_DRV_H 28 29 /* 30 * Definitions taken from spice-protocol, plus kernel driver specific bits. 31 */ 32 33 #include <linux/dma-fence.h> 34 #include <linux/workqueue.h> 35 #include <linux/firmware.h> 36 #include <linux/platform_device.h> 37 38 #include <drm/drm_crtc.h> 39 #include <drm/drm_encoder.h> 40 #include <drm/drm_fb_helper.h> 41 #include <drm/drm_gem.h> 42 #include <drm/drmP.h> 43 #include <drm/ttm/ttm_bo_api.h> 44 #include <drm/ttm/ttm_bo_driver.h> 45 /* just for ttm_validate_buffer */ 46 #include <drm/ttm/ttm_execbuf_util.h> 47 #include <drm/ttm/ttm_module.h> 48 #include <drm/ttm/ttm_placement.h> 49 #include <drm/qxl_drm.h> 50 51 #include "qxl_dev.h" 52 53 #define DRIVER_AUTHOR "Dave Airlie" 54 55 #define DRIVER_NAME "qxl" 56 #define DRIVER_DESC "RH QXL" 57 #define DRIVER_DATE "20120117" 58 59 #define DRIVER_MAJOR 0 60 #define DRIVER_MINOR 1 61 #define DRIVER_PATCHLEVEL 0 62 63 #define QXL_DEBUGFS_MAX_COMPONENTS 32 64 65 extern int qxl_num_crtc; 66 extern int qxl_max_ioctls; 67 68 #define DRM_FILE_OFFSET 0x100000000ULL 69 #define DRM_FILE_PAGE_OFFSET (DRM_FILE_OFFSET >> PAGE_SHIFT) 70 71 #define QXL_INTERRUPT_MASK (\ 72 QXL_INTERRUPT_DISPLAY |\ 73 QXL_INTERRUPT_CURSOR |\ 74 QXL_INTERRUPT_IO_CMD |\ 75 QXL_INTERRUPT_CLIENT_MONITORS_CONFIG) 76 77 struct qxl_bo { 78 /* Protected by gem.mutex */ 79 struct list_head list; 80 /* Protected by tbo.reserved */ 81 struct ttm_place placements[3]; 82 struct ttm_placement placement; 83 struct ttm_buffer_object tbo; 84 struct ttm_bo_kmap_obj kmap; 85 unsigned int pin_count; 86 void *kptr; 87 unsigned int map_count; 88 int type; 89 90 /* Constant after initialization */ 91 struct drm_gem_object gem_base; 92 unsigned int is_primary:1; /* is this now a primary surface */ 93 unsigned int is_dumb:1; 94 struct qxl_bo *shadow; 95 unsigned int hw_surf_alloc:1; 96 struct qxl_surface surf; 97 uint32_t surface_id; 98 struct qxl_release *surf_create; 99 }; 100 #define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, gem_base) 101 #define to_qxl_bo(tobj) container_of((tobj), struct qxl_bo, tbo) 102 103 struct qxl_gem { 104 struct mutex mutex; 105 struct list_head objects; 106 }; 107 108 struct qxl_bo_list { 109 struct ttm_validate_buffer tv; 110 }; 111 112 struct qxl_crtc { 113 struct drm_crtc base; 114 int index; 115 116 struct qxl_bo *cursor_bo; 117 }; 118 119 struct qxl_output { 120 int index; 121 struct drm_connector base; 122 struct drm_encoder enc; 123 }; 124 125 #define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base) 126 #define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base) 127 #define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc) 128 129 struct qxl_mman { 130 struct ttm_bo_device bdev; 131 }; 132 133 struct qxl_memslot { 134 int index; 135 const char *name; 136 uint8_t generation; 137 uint64_t start_phys_addr; 138 uint64_t size; 139 uint64_t high_bits; 140 uint64_t gpu_offset; 141 }; 142 143 enum { 144 QXL_RELEASE_DRAWABLE, 145 QXL_RELEASE_SURFACE_CMD, 146 QXL_RELEASE_CURSOR_CMD, 147 }; 148 149 /* drm_ prefix to differentiate from qxl_release_info in 150 * spice-protocol/qxl_dev.h */ 151 #define QXL_MAX_RES 96 152 struct qxl_release { 153 struct dma_fence base; 154 155 int id; 156 int type; 157 struct qxl_bo *release_bo; 158 uint32_t release_offset; 159 uint32_t surface_release_id; 160 struct ww_acquire_ctx ticket; 161 struct list_head bos; 162 }; 163 164 struct qxl_drm_chunk { 165 struct list_head head; 166 struct qxl_bo *bo; 167 }; 168 169 struct qxl_drm_image { 170 struct qxl_bo *bo; 171 struct list_head chunk_list; 172 }; 173 174 struct qxl_fb_image { 175 struct qxl_device *qdev; 176 uint32_t pseudo_palette[16]; 177 struct fb_image fb_image; 178 uint32_t visual; 179 }; 180 181 struct qxl_draw_fill { 182 struct qxl_device *qdev; 183 struct qxl_rect rect; 184 uint32_t color; 185 uint16_t rop; 186 }; 187 188 /* 189 * Debugfs 190 */ 191 struct qxl_debugfs { 192 struct drm_info_list *files; 193 unsigned int num_files; 194 }; 195 196 int qxl_debugfs_add_files(struct qxl_device *rdev, 197 struct drm_info_list *files, 198 unsigned int nfiles); 199 int qxl_debugfs_fence_init(struct qxl_device *rdev); 200 201 struct qxl_device; 202 203 struct qxl_device { 204 struct drm_device ddev; 205 206 resource_size_t vram_base, vram_size; 207 resource_size_t surfaceram_base, surfaceram_size; 208 resource_size_t rom_base, rom_size; 209 struct qxl_rom *rom; 210 211 struct qxl_mode *modes; 212 struct qxl_bo *monitors_config_bo; 213 struct qxl_monitors_config *monitors_config; 214 215 /* last received client_monitors_config */ 216 struct qxl_monitors_config *client_monitors_config; 217 218 int io_base; 219 void *ram; 220 struct qxl_mman mman; 221 struct qxl_gem gem; 222 223 void *ram_physical; 224 225 struct qxl_ring *release_ring; 226 struct qxl_ring *command_ring; 227 struct qxl_ring *cursor_ring; 228 229 struct qxl_ram_header *ram_header; 230 231 struct qxl_bo *primary_bo; 232 struct qxl_bo *dumb_shadow_bo; 233 struct qxl_head *dumb_heads; 234 235 struct qxl_memslot main_slot; 236 struct qxl_memslot surfaces_slot; 237 238 spinlock_t release_lock; 239 struct idr release_idr; 240 uint32_t release_seqno; 241 spinlock_t release_idr_lock; 242 struct mutex async_io_mutex; 243 unsigned int last_sent_io_cmd; 244 245 /* interrupt handling */ 246 atomic_t irq_received; 247 atomic_t irq_received_display; 248 atomic_t irq_received_cursor; 249 atomic_t irq_received_io_cmd; 250 unsigned int irq_received_error; 251 wait_queue_head_t display_event; 252 wait_queue_head_t cursor_event; 253 wait_queue_head_t io_cmd_event; 254 struct work_struct client_monitors_config_work; 255 256 /* debugfs */ 257 struct qxl_debugfs debugfs[QXL_DEBUGFS_MAX_COMPONENTS]; 258 unsigned int debugfs_count; 259 260 struct mutex update_area_mutex; 261 262 struct idr surf_id_idr; 263 spinlock_t surf_id_idr_lock; 264 int last_alloced_surf_id; 265 266 struct mutex surf_evict_mutex; 267 struct io_mapping *vram_mapping; 268 struct io_mapping *surface_mapping; 269 270 /* */ 271 struct mutex release_mutex; 272 struct qxl_bo *current_release_bo[3]; 273 int current_release_bo_offset[3]; 274 275 struct work_struct gc_work; 276 277 struct drm_property *hotplug_mode_update_property; 278 int monitors_config_width; 279 int monitors_config_height; 280 }; 281 282 extern const struct drm_ioctl_desc qxl_ioctls[]; 283 extern int qxl_max_ioctl; 284 285 int qxl_device_init(struct qxl_device *qdev, struct drm_driver *drv, 286 struct pci_dev *pdev); 287 void qxl_device_fini(struct qxl_device *qdev); 288 289 int qxl_modeset_init(struct qxl_device *qdev); 290 void qxl_modeset_fini(struct qxl_device *qdev); 291 292 int qxl_bo_init(struct qxl_device *qdev); 293 void qxl_bo_fini(struct qxl_device *qdev); 294 295 void qxl_reinit_memslots(struct qxl_device *qdev); 296 int qxl_surf_evict(struct qxl_device *qdev); 297 int qxl_vram_evict(struct qxl_device *qdev); 298 299 struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header, 300 int element_size, 301 int n_elements, 302 int prod_notify, 303 bool set_prod_notify, 304 wait_queue_head_t *push_event); 305 void qxl_ring_free(struct qxl_ring *ring); 306 void qxl_ring_init_hdr(struct qxl_ring *ring); 307 int qxl_check_idle(struct qxl_ring *ring); 308 309 static inline uint64_t 310 qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo, 311 unsigned long offset) 312 { 313 struct qxl_memslot *slot = 314 (bo->tbo.mem.mem_type == TTM_PL_VRAM) 315 ? &qdev->main_slot : &qdev->surfaces_slot; 316 317 WARN_ON_ONCE((bo->tbo.offset & slot->gpu_offset) != slot->gpu_offset); 318 319 /* TODO - need to hold one of the locks to read tbo.offset */ 320 return slot->high_bits | (bo->tbo.offset - slot->gpu_offset + offset); 321 } 322 323 /* qxl_display.c */ 324 void qxl_display_read_client_monitors_config(struct qxl_device *qdev); 325 int qxl_create_monitors_object(struct qxl_device *qdev); 326 int qxl_destroy_monitors_object(struct qxl_device *qdev); 327 328 /* qxl_gem.c */ 329 void qxl_gem_init(struct qxl_device *qdev); 330 void qxl_gem_fini(struct qxl_device *qdev); 331 int qxl_gem_object_create(struct qxl_device *qdev, int size, 332 int alignment, int initial_domain, 333 bool discardable, bool kernel, 334 struct qxl_surface *surf, 335 struct drm_gem_object **obj); 336 int qxl_gem_object_create_with_handle(struct qxl_device *qdev, 337 struct drm_file *file_priv, 338 u32 domain, 339 size_t size, 340 struct qxl_surface *surf, 341 struct qxl_bo **qobj, 342 uint32_t *handle); 343 void qxl_gem_object_free(struct drm_gem_object *gobj); 344 int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv); 345 void qxl_gem_object_close(struct drm_gem_object *obj, 346 struct drm_file *file_priv); 347 void qxl_bo_force_delete(struct qxl_device *qdev); 348 int qxl_bo_kmap(struct qxl_bo *bo, void **ptr); 349 350 /* qxl_dumb.c */ 351 int qxl_mode_dumb_create(struct drm_file *file_priv, 352 struct drm_device *dev, 353 struct drm_mode_create_dumb *args); 354 int qxl_mode_dumb_mmap(struct drm_file *filp, 355 struct drm_device *dev, 356 uint32_t handle, uint64_t *offset_p); 357 358 /* qxl ttm */ 359 int qxl_ttm_init(struct qxl_device *qdev); 360 void qxl_ttm_fini(struct qxl_device *qdev); 361 int qxl_mmap(struct file *filp, struct vm_area_struct *vma); 362 363 /* qxl image */ 364 365 int qxl_image_init(struct qxl_device *qdev, 366 struct qxl_release *release, 367 struct qxl_drm_image *dimage, 368 const uint8_t *data, 369 int x, int y, int width, int height, 370 int depth, int stride); 371 int 372 qxl_image_alloc_objects(struct qxl_device *qdev, 373 struct qxl_release *release, 374 struct qxl_drm_image **image_ptr, 375 int height, int stride); 376 void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage); 377 378 void qxl_update_screen(struct qxl_device *qxl); 379 380 /* qxl io operations (qxl_cmd.c) */ 381 382 void qxl_io_create_primary(struct qxl_device *qdev, 383 struct qxl_bo *bo); 384 void qxl_io_destroy_primary(struct qxl_device *qdev); 385 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id); 386 void qxl_io_notify_oom(struct qxl_device *qdev); 387 388 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf, 389 const struct qxl_rect *area); 390 391 void qxl_io_reset(struct qxl_device *qdev); 392 void qxl_io_monitors_config(struct qxl_device *qdev); 393 int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible); 394 void qxl_io_flush_release(struct qxl_device *qdev); 395 void qxl_io_flush_surfaces(struct qxl_device *qdev); 396 397 union qxl_release_info *qxl_release_map(struct qxl_device *qdev, 398 struct qxl_release *release); 399 void qxl_release_unmap(struct qxl_device *qdev, 400 struct qxl_release *release, 401 union qxl_release_info *info); 402 int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo); 403 int qxl_release_reserve_list(struct qxl_release *release, bool no_intr); 404 void qxl_release_backoff_reserve_list(struct qxl_release *release); 405 void qxl_release_fence_buffer_objects(struct qxl_release *release); 406 407 int qxl_alloc_surface_release_reserved(struct qxl_device *qdev, 408 enum qxl_surface_cmd_type surface_cmd_type, 409 struct qxl_release *create_rel, 410 struct qxl_release **release); 411 int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size, 412 int type, struct qxl_release **release, 413 struct qxl_bo **rbo); 414 415 int 416 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release, 417 uint32_t type, bool interruptible); 418 int 419 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release, 420 uint32_t type, bool interruptible); 421 int qxl_alloc_bo_reserved(struct qxl_device *qdev, 422 struct qxl_release *release, 423 unsigned long size, 424 struct qxl_bo **_bo); 425 /* qxl drawing commands */ 426 427 void qxl_draw_dirty_fb(struct qxl_device *qdev, 428 struct drm_framebuffer *fb, 429 struct qxl_bo *bo, 430 unsigned int flags, unsigned int color, 431 struct drm_clip_rect *clips, 432 unsigned int num_clips, int inc, 433 uint32_t dumb_shadow_offset); 434 435 void qxl_release_free(struct qxl_device *qdev, 436 struct qxl_release *release); 437 438 /* used by qxl_debugfs_release */ 439 struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev, 440 uint64_t id); 441 442 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush); 443 int qxl_garbage_collect(struct qxl_device *qdev); 444 445 /* debugfs */ 446 447 int qxl_debugfs_init(struct drm_minor *minor); 448 int qxl_ttm_debugfs_init(struct qxl_device *qdev); 449 450 /* qxl_prime.c */ 451 int qxl_gem_prime_pin(struct drm_gem_object *obj); 452 void qxl_gem_prime_unpin(struct drm_gem_object *obj); 453 struct sg_table *qxl_gem_prime_get_sg_table(struct drm_gem_object *obj); 454 struct drm_gem_object *qxl_gem_prime_import_sg_table( 455 struct drm_device *dev, struct dma_buf_attachment *attach, 456 struct sg_table *sgt); 457 void *qxl_gem_prime_vmap(struct drm_gem_object *obj); 458 void qxl_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr); 459 int qxl_gem_prime_mmap(struct drm_gem_object *obj, 460 struct vm_area_struct *vma); 461 462 /* qxl_irq.c */ 463 int qxl_irq_init(struct qxl_device *qdev); 464 irqreturn_t qxl_irq_handler(int irq, void *arg); 465 466 int qxl_debugfs_add_files(struct qxl_device *qdev, 467 struct drm_info_list *files, 468 unsigned int nfiles); 469 470 int qxl_surface_id_alloc(struct qxl_device *qdev, 471 struct qxl_bo *surf); 472 void qxl_surface_id_dealloc(struct qxl_device *qdev, 473 uint32_t surface_id); 474 int qxl_hw_surface_alloc(struct qxl_device *qdev, 475 struct qxl_bo *surf); 476 int qxl_hw_surface_dealloc(struct qxl_device *qdev, 477 struct qxl_bo *surf); 478 479 int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo); 480 481 struct qxl_drv_surface * 482 qxl_surface_lookup(struct drm_device *dev, int surface_id); 483 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing); 484 485 #endif 486