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 27 #ifndef QXL_DRV_H 28 #define QXL_DRV_H 29 30 /* 31 * Definitions taken from spice-protocol, plus kernel driver specific bits. 32 */ 33 34 #include <linux/dma-fence.h> 35 #include <linux/workqueue.h> 36 #include <linux/firmware.h> 37 #include <linux/platform_device.h> 38 39 #include "drmP.h" 40 #include "drm_crtc.h" 41 #include <ttm/ttm_bo_api.h> 42 #include <ttm/ttm_bo_driver.h> 43 #include <ttm/ttm_placement.h> 44 #include <ttm/ttm_module.h> 45 46 #include <drm/drm_encoder.h> 47 #include <drm/drm_gem.h> 48 49 /* just for ttm_validate_buffer */ 50 #include <ttm/ttm_execbuf_util.h> 51 52 #include <drm/qxl_drm.h> 53 #include "qxl_dev.h" 54 55 #define DRIVER_AUTHOR "Dave Airlie" 56 57 #define DRIVER_NAME "qxl" 58 #define DRIVER_DESC "RH QXL" 59 #define DRIVER_DATE "20120117" 60 61 #define DRIVER_MAJOR 0 62 #define DRIVER_MINOR 1 63 #define DRIVER_PATCHLEVEL 0 64 65 #define QXL_DEBUGFS_MAX_COMPONENTS 32 66 67 extern int qxl_log_level; 68 extern int qxl_num_crtc; 69 70 enum { 71 QXL_INFO_LEVEL = 1, 72 QXL_DEBUG_LEVEL = 2, 73 }; 74 75 #define QXL_INFO(qdev, fmt, ...) do { \ 76 if (qxl_log_level >= QXL_INFO_LEVEL) { \ 77 qxl_io_log(qdev, fmt, __VA_ARGS__); \ 78 } \ 79 } while (0) 80 #define QXL_DEBUG(qdev, fmt, ...) do { \ 81 if (qxl_log_level >= QXL_DEBUG_LEVEL) { \ 82 qxl_io_log(qdev, fmt, __VA_ARGS__); \ 83 } \ 84 } while (0) 85 #define QXL_INFO_ONCE(qdev, fmt, ...) do { \ 86 static int done; \ 87 if (!done) { \ 88 done = 1; \ 89 QXL_INFO(qdev, fmt, __VA_ARGS__); \ 90 } \ 91 } while (0) 92 93 #define DRM_FILE_OFFSET 0x100000000ULL 94 #define DRM_FILE_PAGE_OFFSET (DRM_FILE_OFFSET >> PAGE_SHIFT) 95 96 #define QXL_INTERRUPT_MASK (\ 97 QXL_INTERRUPT_DISPLAY |\ 98 QXL_INTERRUPT_CURSOR |\ 99 QXL_INTERRUPT_IO_CMD |\ 100 QXL_INTERRUPT_CLIENT_MONITORS_CONFIG) 101 102 struct qxl_bo { 103 /* Protected by gem.mutex */ 104 struct list_head list; 105 /* Protected by tbo.reserved */ 106 struct ttm_place placements[3]; 107 struct ttm_placement placement; 108 struct ttm_buffer_object tbo; 109 struct ttm_bo_kmap_obj kmap; 110 unsigned pin_count; 111 void *kptr; 112 int type; 113 114 /* Constant after initialization */ 115 struct drm_gem_object gem_base; 116 bool is_primary; /* is this now a primary surface */ 117 bool hw_surf_alloc; 118 struct qxl_surface surf; 119 uint32_t surface_id; 120 struct qxl_release *surf_create; 121 }; 122 #define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, gem_base) 123 #define to_qxl_bo(tobj) container_of((tobj), struct qxl_bo, tbo) 124 125 struct qxl_gem { 126 struct mutex mutex; 127 struct list_head objects; 128 }; 129 130 struct qxl_bo_list { 131 struct ttm_validate_buffer tv; 132 }; 133 134 struct qxl_crtc { 135 struct drm_crtc base; 136 int index; 137 int cur_x; 138 int cur_y; 139 int hot_spot_x; 140 int hot_spot_y; 141 struct qxl_bo *cursor_bo; 142 }; 143 144 struct qxl_output { 145 int index; 146 struct drm_connector base; 147 struct drm_encoder enc; 148 }; 149 150 struct qxl_framebuffer { 151 struct drm_framebuffer base; 152 struct drm_gem_object *obj; 153 }; 154 155 #define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base) 156 #define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base) 157 #define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc) 158 #define to_qxl_framebuffer(x) container_of(x, struct qxl_framebuffer, base) 159 160 struct qxl_mman { 161 struct ttm_bo_global_ref bo_global_ref; 162 struct drm_global_reference mem_global_ref; 163 bool mem_global_referenced; 164 struct ttm_bo_device bdev; 165 }; 166 167 struct qxl_mode_info { 168 int num_modes; 169 struct qxl_mode *modes; 170 bool mode_config_initialized; 171 172 /* pointer to fbdev info structure */ 173 struct qxl_fbdev *qfbdev; 174 }; 175 176 177 struct qxl_memslot { 178 uint8_t generation; 179 uint64_t start_phys_addr; 180 uint64_t end_phys_addr; 181 uint64_t high_bits; 182 }; 183 184 enum { 185 QXL_RELEASE_DRAWABLE, 186 QXL_RELEASE_SURFACE_CMD, 187 QXL_RELEASE_CURSOR_CMD, 188 }; 189 190 /* drm_ prefix to differentiate from qxl_release_info in 191 * spice-protocol/qxl_dev.h */ 192 #define QXL_MAX_RES 96 193 struct qxl_release { 194 struct dma_fence base; 195 196 int id; 197 int type; 198 uint32_t release_offset; 199 uint32_t surface_release_id; 200 struct ww_acquire_ctx ticket; 201 struct list_head bos; 202 }; 203 204 struct qxl_drm_chunk { 205 struct list_head head; 206 struct qxl_bo *bo; 207 }; 208 209 struct qxl_drm_image { 210 struct qxl_bo *bo; 211 struct list_head chunk_list; 212 }; 213 214 struct qxl_fb_image { 215 struct qxl_device *qdev; 216 uint32_t pseudo_palette[16]; 217 struct fb_image fb_image; 218 uint32_t visual; 219 }; 220 221 struct qxl_draw_fill { 222 struct qxl_device *qdev; 223 struct qxl_rect rect; 224 uint32_t color; 225 uint16_t rop; 226 }; 227 228 /* 229 * Debugfs 230 */ 231 struct qxl_debugfs { 232 struct drm_info_list *files; 233 unsigned num_files; 234 }; 235 236 int qxl_debugfs_add_files(struct qxl_device *rdev, 237 struct drm_info_list *files, 238 unsigned nfiles); 239 int qxl_debugfs_fence_init(struct qxl_device *rdev); 240 void qxl_debugfs_remove_files(struct qxl_device *qdev); 241 242 struct qxl_device; 243 244 struct qxl_device { 245 struct drm_device ddev; 246 unsigned long flags; 247 248 resource_size_t vram_base, vram_size; 249 resource_size_t surfaceram_base, surfaceram_size; 250 resource_size_t rom_base, rom_size; 251 struct qxl_rom *rom; 252 253 struct qxl_mode *modes; 254 struct qxl_bo *monitors_config_bo; 255 struct qxl_monitors_config *monitors_config; 256 257 /* last received client_monitors_config */ 258 struct qxl_monitors_config *client_monitors_config; 259 260 int io_base; 261 void *ram; 262 struct qxl_mman mman; 263 struct qxl_gem gem; 264 struct qxl_mode_info mode_info; 265 266 struct fb_info *fbdev_info; 267 struct qxl_framebuffer *fbdev_qfb; 268 void *ram_physical; 269 270 struct qxl_ring *release_ring; 271 struct qxl_ring *command_ring; 272 struct qxl_ring *cursor_ring; 273 274 struct qxl_ram_header *ram_header; 275 276 bool primary_created; 277 278 struct qxl_memslot *mem_slots; 279 uint8_t n_mem_slots; 280 281 uint8_t main_mem_slot; 282 uint8_t surfaces_mem_slot; 283 uint8_t slot_id_bits; 284 uint8_t slot_gen_bits; 285 uint64_t va_slot_mask; 286 287 spinlock_t release_lock; 288 struct idr release_idr; 289 uint32_t release_seqno; 290 spinlock_t release_idr_lock; 291 struct mutex async_io_mutex; 292 unsigned int last_sent_io_cmd; 293 294 /* interrupt handling */ 295 atomic_t irq_received; 296 atomic_t irq_received_display; 297 atomic_t irq_received_cursor; 298 atomic_t irq_received_io_cmd; 299 unsigned irq_received_error; 300 wait_queue_head_t display_event; 301 wait_queue_head_t cursor_event; 302 wait_queue_head_t io_cmd_event; 303 struct work_struct client_monitors_config_work; 304 305 /* debugfs */ 306 struct qxl_debugfs debugfs[QXL_DEBUGFS_MAX_COMPONENTS]; 307 unsigned debugfs_count; 308 309 struct mutex update_area_mutex; 310 311 struct idr surf_id_idr; 312 spinlock_t surf_id_idr_lock; 313 int last_alloced_surf_id; 314 315 struct mutex surf_evict_mutex; 316 struct io_mapping *vram_mapping; 317 struct io_mapping *surface_mapping; 318 319 /* */ 320 struct mutex release_mutex; 321 struct qxl_bo *current_release_bo[3]; 322 int current_release_bo_offset[3]; 323 324 struct work_struct gc_work; 325 326 struct drm_property *hotplug_mode_update_property; 327 int monitors_config_width; 328 int monitors_config_height; 329 }; 330 331 /* forward declaration for QXL_INFO_IO */ 332 __printf(2,3) void qxl_io_log(struct qxl_device *qdev, const char *fmt, ...); 333 334 extern const struct drm_ioctl_desc qxl_ioctls[]; 335 extern int qxl_max_ioctl; 336 337 int qxl_device_init(struct qxl_device *qdev, struct drm_driver *drv, 338 struct pci_dev *pdev, unsigned long flags); 339 void qxl_device_fini(struct qxl_device *qdev); 340 341 int qxl_modeset_init(struct qxl_device *qdev); 342 void qxl_modeset_fini(struct qxl_device *qdev); 343 344 int qxl_bo_init(struct qxl_device *qdev); 345 void qxl_bo_fini(struct qxl_device *qdev); 346 347 void qxl_reinit_memslots(struct qxl_device *qdev); 348 int qxl_surf_evict(struct qxl_device *qdev); 349 int qxl_vram_evict(struct qxl_device *qdev); 350 351 struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header, 352 int element_size, 353 int n_elements, 354 int prod_notify, 355 bool set_prod_notify, 356 wait_queue_head_t *push_event); 357 void qxl_ring_free(struct qxl_ring *ring); 358 void qxl_ring_init_hdr(struct qxl_ring *ring); 359 int qxl_check_idle(struct qxl_ring *ring); 360 361 static inline void * 362 qxl_fb_virtual_address(struct qxl_device *qdev, unsigned long physical) 363 { 364 QXL_INFO(qdev, "not implemented (%lu)\n", physical); 365 return 0; 366 } 367 368 static inline uint64_t 369 qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo, 370 unsigned long offset) 371 { 372 int slot_id = bo->type == QXL_GEM_DOMAIN_VRAM ? qdev->main_mem_slot : qdev->surfaces_mem_slot; 373 struct qxl_memslot *slot = &(qdev->mem_slots[slot_id]); 374 375 /* TODO - need to hold one of the locks to read tbo.offset */ 376 return slot->high_bits | (bo->tbo.offset + offset); 377 } 378 379 /* qxl_fb.c */ 380 #define QXLFB_CONN_LIMIT 1 381 382 int qxl_fbdev_init(struct qxl_device *qdev); 383 void qxl_fbdev_fini(struct qxl_device *qdev); 384 int qxl_get_handle_for_primary_fb(struct qxl_device *qdev, 385 struct drm_file *file_priv, 386 uint32_t *handle); 387 void qxl_fbdev_set_suspend(struct qxl_device *qdev, int state); 388 389 /* qxl_display.c */ 390 void qxl_user_framebuffer_destroy(struct drm_framebuffer *fb); 391 int 392 qxl_framebuffer_init(struct drm_device *dev, 393 struct qxl_framebuffer *rfb, 394 const struct drm_mode_fb_cmd2 *mode_cmd, 395 struct drm_gem_object *obj, 396 const struct drm_framebuffer_funcs *funcs); 397 void qxl_display_read_client_monitors_config(struct qxl_device *qdev); 398 int qxl_create_monitors_object(struct qxl_device *qdev); 399 int qxl_destroy_monitors_object(struct qxl_device *qdev); 400 401 /* qxl_gem.c */ 402 void qxl_gem_init(struct qxl_device *qdev); 403 void qxl_gem_fini(struct qxl_device *qdev); 404 int qxl_gem_object_create(struct qxl_device *qdev, int size, 405 int alignment, int initial_domain, 406 bool discardable, bool kernel, 407 struct qxl_surface *surf, 408 struct drm_gem_object **obj); 409 int qxl_gem_object_create_with_handle(struct qxl_device *qdev, 410 struct drm_file *file_priv, 411 u32 domain, 412 size_t size, 413 struct qxl_surface *surf, 414 struct qxl_bo **qobj, 415 uint32_t *handle); 416 void qxl_gem_object_free(struct drm_gem_object *gobj); 417 int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv); 418 void qxl_gem_object_close(struct drm_gem_object *obj, 419 struct drm_file *file_priv); 420 void qxl_bo_force_delete(struct qxl_device *qdev); 421 int qxl_bo_kmap(struct qxl_bo *bo, void **ptr); 422 423 /* qxl_dumb.c */ 424 int qxl_mode_dumb_create(struct drm_file *file_priv, 425 struct drm_device *dev, 426 struct drm_mode_create_dumb *args); 427 int qxl_mode_dumb_mmap(struct drm_file *filp, 428 struct drm_device *dev, 429 uint32_t handle, uint64_t *offset_p); 430 431 432 /* qxl ttm */ 433 int qxl_ttm_init(struct qxl_device *qdev); 434 void qxl_ttm_fini(struct qxl_device *qdev); 435 int qxl_mmap(struct file *filp, struct vm_area_struct *vma); 436 437 /* qxl image */ 438 439 int qxl_image_init(struct qxl_device *qdev, 440 struct qxl_release *release, 441 struct qxl_drm_image *dimage, 442 const uint8_t *data, 443 int x, int y, int width, int height, 444 int depth, int stride); 445 int 446 qxl_image_alloc_objects(struct qxl_device *qdev, 447 struct qxl_release *release, 448 struct qxl_drm_image **image_ptr, 449 int height, int stride); 450 void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage); 451 452 void qxl_update_screen(struct qxl_device *qxl); 453 454 /* qxl io operations (qxl_cmd.c) */ 455 456 void qxl_io_create_primary(struct qxl_device *qdev, 457 unsigned offset, 458 struct qxl_bo *bo); 459 void qxl_io_destroy_primary(struct qxl_device *qdev); 460 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id); 461 void qxl_io_notify_oom(struct qxl_device *qdev); 462 463 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf, 464 const struct qxl_rect *area); 465 466 void qxl_io_reset(struct qxl_device *qdev); 467 void qxl_io_monitors_config(struct qxl_device *qdev); 468 int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible); 469 void qxl_io_flush_release(struct qxl_device *qdev); 470 void qxl_io_flush_surfaces(struct qxl_device *qdev); 471 472 union qxl_release_info *qxl_release_map(struct qxl_device *qdev, 473 struct qxl_release *release); 474 void qxl_release_unmap(struct qxl_device *qdev, 475 struct qxl_release *release, 476 union qxl_release_info *info); 477 int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo); 478 int qxl_release_reserve_list(struct qxl_release *release, bool no_intr); 479 void qxl_release_backoff_reserve_list(struct qxl_release *release); 480 void qxl_release_fence_buffer_objects(struct qxl_release *release); 481 482 int qxl_alloc_surface_release_reserved(struct qxl_device *qdev, 483 enum qxl_surface_cmd_type surface_cmd_type, 484 struct qxl_release *create_rel, 485 struct qxl_release **release); 486 int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size, 487 int type, struct qxl_release **release, 488 struct qxl_bo **rbo); 489 490 int 491 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release, 492 uint32_t type, bool interruptible); 493 int 494 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release, 495 uint32_t type, bool interruptible); 496 int qxl_alloc_bo_reserved(struct qxl_device *qdev, 497 struct qxl_release *release, 498 unsigned long size, 499 struct qxl_bo **_bo); 500 /* qxl drawing commands */ 501 502 void qxl_draw_opaque_fb(const struct qxl_fb_image *qxl_fb_image, 503 int stride /* filled in if 0 */); 504 505 void qxl_draw_dirty_fb(struct qxl_device *qdev, 506 struct qxl_framebuffer *qxl_fb, 507 struct qxl_bo *bo, 508 unsigned flags, unsigned color, 509 struct drm_clip_rect *clips, 510 unsigned num_clips, int inc); 511 512 void qxl_draw_fill(struct qxl_draw_fill *qxl_draw_fill_rec); 513 514 void qxl_draw_copyarea(struct qxl_device *qdev, 515 u32 width, u32 height, 516 u32 sx, u32 sy, 517 u32 dx, u32 dy); 518 519 void qxl_release_free(struct qxl_device *qdev, 520 struct qxl_release *release); 521 522 /* used by qxl_debugfs_release */ 523 struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev, 524 uint64_t id); 525 526 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush); 527 int qxl_garbage_collect(struct qxl_device *qdev); 528 529 /* debugfs */ 530 531 int qxl_debugfs_init(struct drm_minor *minor); 532 void qxl_debugfs_takedown(struct drm_minor *minor); 533 int qxl_ttm_debugfs_init(struct qxl_device *qdev); 534 535 /* qxl_prime.c */ 536 int qxl_gem_prime_pin(struct drm_gem_object *obj); 537 void qxl_gem_prime_unpin(struct drm_gem_object *obj); 538 struct sg_table *qxl_gem_prime_get_sg_table(struct drm_gem_object *obj); 539 struct drm_gem_object *qxl_gem_prime_import_sg_table( 540 struct drm_device *dev, struct dma_buf_attachment *attach, 541 struct sg_table *sgt); 542 void *qxl_gem_prime_vmap(struct drm_gem_object *obj); 543 void qxl_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr); 544 int qxl_gem_prime_mmap(struct drm_gem_object *obj, 545 struct vm_area_struct *vma); 546 547 /* qxl_irq.c */ 548 int qxl_irq_init(struct qxl_device *qdev); 549 irqreturn_t qxl_irq_handler(int irq, void *arg); 550 551 /* qxl_fb.c */ 552 bool qxl_fbdev_qobj_is_fb(struct qxl_device *qdev, struct qxl_bo *qobj); 553 554 int qxl_debugfs_add_files(struct qxl_device *qdev, 555 struct drm_info_list *files, 556 unsigned nfiles); 557 558 int qxl_surface_id_alloc(struct qxl_device *qdev, 559 struct qxl_bo *surf); 560 void qxl_surface_id_dealloc(struct qxl_device *qdev, 561 uint32_t surface_id); 562 int qxl_hw_surface_alloc(struct qxl_device *qdev, 563 struct qxl_bo *surf, 564 struct ttm_mem_reg *mem); 565 int qxl_hw_surface_dealloc(struct qxl_device *qdev, 566 struct qxl_bo *surf); 567 568 int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo); 569 570 struct qxl_drv_surface * 571 qxl_surface_lookup(struct drm_device *dev, int surface_id); 572 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing); 573 574 #endif 575