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