qxl_drv.h revision 1.1.1.1.32.1
1 /* $NetBSD: qxl_drv.h,v 1.1.1.1.32.1 2019/06/10 22:08:24 christos Exp $ */ 2 3 /* 4 * Copyright 2013 Red Hat Inc. 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a 7 * copy of this software and associated documentation files (the "Software"), 8 * to deal in the Software without restriction, including without limitation 9 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 10 * and/or sell copies of the Software, and to permit persons to whom the 11 * Software is furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in 14 * all copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 19 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR 20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 22 * OTHER DEALINGS IN THE SOFTWARE. 23 * 24 * Authors: Dave Airlie 25 * Alon Levy 26 */ 27 28 29 #ifndef QXL_DRV_H 30 #define QXL_DRV_H 31 32 /* 33 * Definitions taken from spice-protocol, plus kernel driver specific bits. 34 */ 35 36 #include <linux/fence.h> 37 #include <linux/workqueue.h> 38 #include <linux/firmware.h> 39 #include <linux/platform_device.h> 40 41 #include "drmP.h" 42 #include "drm_crtc.h" 43 #include <ttm/ttm_bo_api.h> 44 #include <ttm/ttm_bo_driver.h> 45 #include <ttm/ttm_placement.h> 46 #include <ttm/ttm_module.h> 47 48 #include <drm/drm_gem.h> 49 50 /* just for ttm_validate_buffer */ 51 #include <ttm/ttm_execbuf_util.h> 52 53 #include <drm/qxl_drm.h> 54 #include "qxl_dev.h" 55 56 #define DRIVER_AUTHOR "Dave Airlie" 57 58 #define DRIVER_NAME "qxl" 59 #define DRIVER_DESC "RH QXL" 60 #define DRIVER_DATE "20120117" 61 62 #define DRIVER_MAJOR 0 63 #define DRIVER_MINOR 1 64 #define DRIVER_PATCHLEVEL 0 65 66 #define QXL_DEBUGFS_MAX_COMPONENTS 32 67 68 extern int qxl_log_level; 69 extern int qxl_num_crtc; 70 71 enum { 72 QXL_INFO_LEVEL = 1, 73 QXL_DEBUG_LEVEL = 2, 74 }; 75 76 #define QXL_INFO(qdev, fmt, ...) do { \ 77 if (qxl_log_level >= QXL_INFO_LEVEL) { \ 78 qxl_io_log(qdev, fmt, __VA_ARGS__); \ 79 } \ 80 } while (0) 81 #define QXL_DEBUG(qdev, fmt, ...) do { \ 82 if (qxl_log_level >= QXL_DEBUG_LEVEL) { \ 83 qxl_io_log(qdev, fmt, __VA_ARGS__); \ 84 } \ 85 } while (0) 86 #define QXL_INFO_ONCE(qdev, fmt, ...) do { \ 87 static int done; \ 88 if (!done) { \ 89 done = 1; \ 90 QXL_INFO(qdev, fmt, __VA_ARGS__); \ 91 } \ 92 } while (0) 93 94 #define DRM_FILE_OFFSET 0x100000000ULL 95 #define DRM_FILE_PAGE_OFFSET (DRM_FILE_OFFSET >> PAGE_SHIFT) 96 97 #define QXL_INTERRUPT_MASK (\ 98 QXL_INTERRUPT_DISPLAY |\ 99 QXL_INTERRUPT_CURSOR |\ 100 QXL_INTERRUPT_IO_CMD |\ 101 QXL_INTERRUPT_CLIENT_MONITORS_CONFIG) 102 103 struct qxl_bo { 104 /* Protected by gem.mutex */ 105 struct list_head list; 106 /* Protected by tbo.reserved */ 107 struct ttm_place placements[3]; 108 struct ttm_placement placement; 109 struct ttm_buffer_object tbo; 110 struct ttm_bo_kmap_obj kmap; 111 unsigned pin_count; 112 void *kptr; 113 int type; 114 115 /* Constant after initialization */ 116 struct drm_gem_object gem_base; 117 bool is_primary; /* is this now a primary surface */ 118 bool hw_surf_alloc; 119 struct qxl_surface surf; 120 uint32_t surface_id; 121 struct qxl_release *surf_create; 122 }; 123 #define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, gem_base) 124 #define to_qxl_bo(tobj) container_of((tobj), struct qxl_bo, tbo) 125 126 struct qxl_gem { 127 struct mutex mutex; 128 struct list_head objects; 129 }; 130 131 struct qxl_bo_list { 132 struct ttm_validate_buffer tv; 133 }; 134 135 struct qxl_crtc { 136 struct drm_crtc base; 137 int index; 138 int cur_x; 139 int cur_y; 140 int hot_spot_x; 141 int hot_spot_y; 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 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 device *dev; 246 struct drm_device *ddev; 247 struct pci_dev *pdev; 248 unsigned long flags; 249 250 resource_size_t vram_base, vram_size; 251 resource_size_t surfaceram_base, surfaceram_size; 252 resource_size_t rom_base, rom_size; 253 struct qxl_rom *rom; 254 255 struct qxl_mode *modes; 256 struct qxl_bo *monitors_config_bo; 257 struct qxl_monitors_config *monitors_config; 258 259 /* last received client_monitors_config */ 260 struct qxl_monitors_config *client_monitors_config; 261 262 int io_base; 263 void *ram; 264 struct qxl_mman mman; 265 struct qxl_gem gem; 266 struct qxl_mode_info mode_info; 267 268 struct fb_info *fbdev_info; 269 struct qxl_framebuffer *fbdev_qfb; 270 void *ram_physical; 271 272 struct qxl_ring *release_ring; 273 struct qxl_ring *command_ring; 274 struct qxl_ring *cursor_ring; 275 276 struct qxl_ram_header *ram_header; 277 278 bool primary_created; 279 280 struct qxl_memslot *mem_slots; 281 uint8_t n_mem_slots; 282 283 uint8_t main_mem_slot; 284 uint8_t surfaces_mem_slot; 285 uint8_t slot_id_bits; 286 uint8_t slot_gen_bits; 287 uint64_t va_slot_mask; 288 289 spinlock_t release_lock; 290 struct idr release_idr; 291 uint32_t release_seqno; 292 spinlock_t release_idr_lock; 293 struct mutex async_io_mutex; 294 unsigned int last_sent_io_cmd; 295 296 /* interrupt handling */ 297 atomic_t irq_received; 298 atomic_t irq_received_display; 299 atomic_t irq_received_cursor; 300 atomic_t irq_received_io_cmd; 301 unsigned irq_received_error; 302 wait_queue_head_t display_event; 303 wait_queue_head_t cursor_event; 304 wait_queue_head_t io_cmd_event; 305 struct work_struct client_monitors_config_work; 306 307 /* debugfs */ 308 struct qxl_debugfs debugfs[QXL_DEBUGFS_MAX_COMPONENTS]; 309 unsigned debugfs_count; 310 311 struct mutex update_area_mutex; 312 313 struct idr surf_id_idr; 314 spinlock_t surf_id_idr_lock; 315 int last_alloced_surf_id; 316 317 struct mutex surf_evict_mutex; 318 struct io_mapping *vram_mapping; 319 struct io_mapping *surface_mapping; 320 321 /* */ 322 struct mutex release_mutex; 323 struct qxl_bo *current_release_bo[3]; 324 int current_release_bo_offset[3]; 325 326 struct workqueue_struct *gc_queue; 327 struct work_struct gc_work; 328 329 struct work_struct fb_work; 330 331 struct drm_property *hotplug_mode_update_property; 332 int monitors_config_width; 333 int monitors_config_height; 334 }; 335 336 /* forward declaration for QXL_INFO_IO */ 337 __printf(2,3) void qxl_io_log(struct qxl_device *qdev, const char *fmt, ...); 338 339 extern const struct drm_ioctl_desc qxl_ioctls[]; 340 extern int qxl_max_ioctl; 341 342 int qxl_driver_load(struct drm_device *dev, unsigned long flags); 343 int qxl_driver_unload(struct drm_device *dev); 344 345 int qxl_modeset_init(struct qxl_device *qdev); 346 void qxl_modeset_fini(struct qxl_device *qdev); 347 348 int qxl_bo_init(struct qxl_device *qdev); 349 void qxl_bo_fini(struct qxl_device *qdev); 350 351 void qxl_reinit_memslots(struct qxl_device *qdev); 352 int qxl_surf_evict(struct qxl_device *qdev); 353 int qxl_vram_evict(struct qxl_device *qdev); 354 355 struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header, 356 int element_size, 357 int n_elements, 358 int prod_notify, 359 bool set_prod_notify, 360 wait_queue_head_t *push_event); 361 void qxl_ring_free(struct qxl_ring *ring); 362 void qxl_ring_init_hdr(struct qxl_ring *ring); 363 int qxl_check_idle(struct qxl_ring *ring); 364 365 static inline void * 366 qxl_fb_virtual_address(struct qxl_device *qdev, unsigned long physical) 367 { 368 QXL_INFO(qdev, "not implemented (%lu)\n", physical); 369 return 0; 370 } 371 372 static inline uint64_t 373 qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo, 374 unsigned long offset) 375 { 376 int slot_id = bo->type == QXL_GEM_DOMAIN_VRAM ? qdev->main_mem_slot : qdev->surfaces_mem_slot; 377 struct qxl_memslot *slot = &(qdev->mem_slots[slot_id]); 378 379 /* TODO - need to hold one of the locks to read tbo.offset */ 380 return slot->high_bits | (bo->tbo.offset + offset); 381 } 382 383 /* qxl_fb.c */ 384 #define QXLFB_CONN_LIMIT 1 385 386 int qxl_fbdev_init(struct qxl_device *qdev); 387 void qxl_fbdev_fini(struct qxl_device *qdev); 388 int qxl_get_handle_for_primary_fb(struct qxl_device *qdev, 389 struct drm_file *file_priv, 390 uint32_t *handle); 391 void qxl_fbdev_set_suspend(struct qxl_device *qdev, int state); 392 393 /* qxl_display.c */ 394 int 395 qxl_framebuffer_init(struct drm_device *dev, 396 struct qxl_framebuffer *rfb, 397 struct drm_mode_fb_cmd2 *mode_cmd, 398 struct drm_gem_object *obj); 399 void qxl_display_read_client_monitors_config(struct qxl_device *qdev); 400 void qxl_send_monitors_config(struct qxl_device *qdev); 401 int qxl_create_monitors_object(struct qxl_device *qdev); 402 int qxl_destroy_monitors_object(struct qxl_device *qdev); 403 404 /* used by qxl_debugfs only */ 405 void qxl_crtc_set_from_monitors_config(struct qxl_device *qdev); 406 void qxl_alloc_client_monitors_config(struct qxl_device *qdev, unsigned count); 407 408 /* qxl_gem.c */ 409 int qxl_gem_init(struct qxl_device *qdev); 410 void qxl_gem_fini(struct qxl_device *qdev); 411 int qxl_gem_object_create(struct qxl_device *qdev, int size, 412 int alignment, int initial_domain, 413 bool discardable, bool kernel, 414 struct qxl_surface *surf, 415 struct drm_gem_object **obj); 416 int qxl_gem_object_create_with_handle(struct qxl_device *qdev, 417 struct drm_file *file_priv, 418 u32 domain, 419 size_t size, 420 struct qxl_surface *surf, 421 struct qxl_bo **qobj, 422 uint32_t *handle); 423 void qxl_gem_object_free(struct drm_gem_object *gobj); 424 int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv); 425 void qxl_gem_object_close(struct drm_gem_object *obj, 426 struct drm_file *file_priv); 427 void qxl_bo_force_delete(struct qxl_device *qdev); 428 int qxl_bo_kmap(struct qxl_bo *bo, void **ptr); 429 430 /* qxl_dumb.c */ 431 int qxl_mode_dumb_create(struct drm_file *file_priv, 432 struct drm_device *dev, 433 struct drm_mode_create_dumb *args); 434 int qxl_mode_dumb_mmap(struct drm_file *filp, 435 struct drm_device *dev, 436 uint32_t handle, uint64_t *offset_p); 437 438 439 /* qxl ttm */ 440 int qxl_ttm_init(struct qxl_device *qdev); 441 void qxl_ttm_fini(struct qxl_device *qdev); 442 int qxl_mmap(struct file *filp, struct vm_area_struct *vma); 443 444 /* qxl image */ 445 446 int qxl_image_init(struct qxl_device *qdev, 447 struct qxl_release *release, 448 struct qxl_drm_image *dimage, 449 const uint8_t *data, 450 int x, int y, int width, int height, 451 int depth, int stride); 452 int 453 qxl_image_alloc_objects(struct qxl_device *qdev, 454 struct qxl_release *release, 455 struct qxl_drm_image **image_ptr, 456 int height, int stride); 457 void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage); 458 459 void qxl_update_screen(struct qxl_device *qxl); 460 461 /* qxl io operations (qxl_cmd.c) */ 462 463 void qxl_io_create_primary(struct qxl_device *qdev, 464 unsigned offset, 465 struct qxl_bo *bo); 466 void qxl_io_destroy_primary(struct qxl_device *qdev); 467 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id); 468 void qxl_io_notify_oom(struct qxl_device *qdev); 469 470 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf, 471 const struct qxl_rect *area); 472 473 void qxl_io_reset(struct qxl_device *qdev); 474 void qxl_io_monitors_config(struct qxl_device *qdev); 475 int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible); 476 void qxl_io_flush_release(struct qxl_device *qdev); 477 void qxl_io_flush_surfaces(struct qxl_device *qdev); 478 479 union qxl_release_info *qxl_release_map(struct qxl_device *qdev, 480 struct qxl_release *release); 481 void qxl_release_unmap(struct qxl_device *qdev, 482 struct qxl_release *release, 483 union qxl_release_info *info); 484 int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo); 485 int qxl_release_reserve_list(struct qxl_release *release, bool no_intr); 486 void qxl_release_backoff_reserve_list(struct qxl_release *release); 487 void qxl_release_fence_buffer_objects(struct qxl_release *release); 488 489 int qxl_alloc_surface_release_reserved(struct qxl_device *qdev, 490 enum qxl_surface_cmd_type surface_cmd_type, 491 struct qxl_release *create_rel, 492 struct qxl_release **release); 493 int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size, 494 int type, struct qxl_release **release, 495 struct qxl_bo **rbo); 496 497 int 498 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release, 499 uint32_t type, bool interruptible); 500 int 501 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release, 502 uint32_t type, bool interruptible); 503 int qxl_alloc_bo_reserved(struct qxl_device *qdev, 504 struct qxl_release *release, 505 unsigned long size, 506 struct qxl_bo **_bo); 507 /* qxl drawing commands */ 508 509 void qxl_draw_opaque_fb(const struct qxl_fb_image *qxl_fb_image, 510 int stride /* filled in if 0 */); 511 512 void qxl_draw_dirty_fb(struct qxl_device *qdev, 513 struct qxl_framebuffer *qxl_fb, 514 struct qxl_bo *bo, 515 unsigned flags, unsigned color, 516 struct drm_clip_rect *clips, 517 unsigned num_clips, int inc); 518 519 void qxl_draw_fill(struct qxl_draw_fill *qxl_draw_fill_rec); 520 521 void qxl_draw_copyarea(struct qxl_device *qdev, 522 u32 width, u32 height, 523 u32 sx, u32 sy, 524 u32 dx, u32 dy); 525 526 void qxl_release_free(struct qxl_device *qdev, 527 struct qxl_release *release); 528 529 /* used by qxl_debugfs_release */ 530 struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev, 531 uint64_t id); 532 533 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush); 534 int qxl_garbage_collect(struct qxl_device *qdev); 535 536 /* debugfs */ 537 538 int qxl_debugfs_init(struct drm_minor *minor); 539 void qxl_debugfs_takedown(struct drm_minor *minor); 540 541 /* qxl_prime.c */ 542 int qxl_gem_prime_pin(struct drm_gem_object *obj); 543 void qxl_gem_prime_unpin(struct drm_gem_object *obj); 544 struct sg_table *qxl_gem_prime_get_sg_table(struct drm_gem_object *obj); 545 struct drm_gem_object *qxl_gem_prime_import_sg_table( 546 struct drm_device *dev, struct dma_buf_attachment *attach, 547 struct sg_table *sgt); 548 void *qxl_gem_prime_vmap(struct drm_gem_object *obj); 549 void qxl_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr); 550 int qxl_gem_prime_mmap(struct drm_gem_object *obj, 551 struct vm_area_struct *vma); 552 553 /* qxl_irq.c */ 554 int qxl_irq_init(struct qxl_device *qdev); 555 irqreturn_t qxl_irq_handler(int irq, void *arg); 556 557 /* qxl_fb.c */ 558 int qxl_fb_init(struct qxl_device *qdev); 559 bool qxl_fbdev_qobj_is_fb(struct qxl_device *qdev, struct qxl_bo *qobj); 560 561 int qxl_debugfs_add_files(struct qxl_device *qdev, 562 struct drm_info_list *files, 563 unsigned nfiles); 564 565 int qxl_surface_id_alloc(struct qxl_device *qdev, 566 struct qxl_bo *surf); 567 void qxl_surface_id_dealloc(struct qxl_device *qdev, 568 uint32_t surface_id); 569 int qxl_hw_surface_alloc(struct qxl_device *qdev, 570 struct qxl_bo *surf, 571 struct ttm_mem_reg *mem); 572 int qxl_hw_surface_dealloc(struct qxl_device *qdev, 573 struct qxl_bo *surf); 574 575 int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo); 576 577 struct qxl_drv_surface * 578 qxl_surface_lookup(struct drm_device *dev, int surface_id); 579 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing); 580 int qxl_update_surface(struct qxl_device *qdev, struct qxl_bo *surf); 581 582 #endif 583
Indexes created Wed Oct 15 16:09:53 GMT 2025