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