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