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