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_add_files(struct qxl_device *rdev, 194 struct drm_info_list *files, 195 unsigned int nfiles); 196 int qxl_debugfs_fence_init(struct qxl_device *rdev); 197 198 struct qxl_device; 199 200 struct qxl_device { 201 struct drm_device ddev; 202 203 resource_size_t vram_base, vram_size; 204 resource_size_t surfaceram_base, surfaceram_size; 205 resource_size_t rom_base, rom_size; 206 struct qxl_rom *rom; 207 208 struct qxl_mode *modes; 209 struct qxl_bo *monitors_config_bo; 210 struct qxl_monitors_config *monitors_config; 211 212 /* last received client_monitors_config */ 213 struct qxl_monitors_config *client_monitors_config; 214 215 int io_base; 216 void *ram; 217 struct qxl_mman mman; 218 struct qxl_gem gem; 219 220 void *ram_physical; 221 222 struct qxl_ring *release_ring; 223 struct qxl_ring *command_ring; 224 struct qxl_ring *cursor_ring; 225 226 struct qxl_ram_header *ram_header; 227 228 struct qxl_bo *primary_bo; 229 struct qxl_bo *dumb_shadow_bo; 230 struct qxl_head *dumb_heads; 231 232 struct qxl_memslot main_slot; 233 struct qxl_memslot surfaces_slot; 234 235 spinlock_t release_lock; 236 struct idr release_idr; 237 uint32_t release_seqno; 238 spinlock_t release_idr_lock; 239 struct mutex async_io_mutex; 240 unsigned int last_sent_io_cmd; 241 242 /* interrupt handling */ 243 atomic_t irq_received; 244 atomic_t irq_received_display; 245 atomic_t irq_received_cursor; 246 atomic_t irq_received_io_cmd; 247 unsigned int irq_received_error; 248 wait_queue_head_t display_event; 249 wait_queue_head_t cursor_event; 250 wait_queue_head_t io_cmd_event; 251 struct work_struct client_monitors_config_work; 252 253 /* debugfs */ 254 struct qxl_debugfs debugfs[QXL_DEBUGFS_MAX_COMPONENTS]; 255 unsigned int debugfs_count; 256 257 struct mutex update_area_mutex; 258 259 struct idr surf_id_idr; 260 spinlock_t surf_id_idr_lock; 261 int last_alloced_surf_id; 262 263 struct mutex surf_evict_mutex; 264 struct io_mapping *vram_mapping; 265 struct io_mapping *surface_mapping; 266 267 /* */ 268 struct mutex release_mutex; 269 struct qxl_bo *current_release_bo[3]; 270 int current_release_bo_offset[3]; 271 272 struct work_struct gc_work; 273 274 struct drm_property *hotplug_mode_update_property; 275 int monitors_config_width; 276 int monitors_config_height; 277 }; 278 279 extern const struct drm_ioctl_desc qxl_ioctls[]; 280 extern int qxl_max_ioctl; 281 282 int qxl_device_init(struct qxl_device *qdev, struct drm_driver *drv, 283 struct pci_dev *pdev); 284 void qxl_device_fini(struct qxl_device *qdev); 285 286 int qxl_modeset_init(struct qxl_device *qdev); 287 void qxl_modeset_fini(struct qxl_device *qdev); 288 289 int qxl_bo_init(struct qxl_device *qdev); 290 void qxl_bo_fini(struct qxl_device *qdev); 291 292 void qxl_reinit_memslots(struct qxl_device *qdev); 293 int qxl_surf_evict(struct qxl_device *qdev); 294 int qxl_vram_evict(struct qxl_device *qdev); 295 296 struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header, 297 int element_size, 298 int n_elements, 299 int prod_notify, 300 bool set_prod_notify, 301 wait_queue_head_t *push_event); 302 void qxl_ring_free(struct qxl_ring *ring); 303 void qxl_ring_init_hdr(struct qxl_ring *ring); 304 int qxl_check_idle(struct qxl_ring *ring); 305 306 static inline uint64_t 307 qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo, 308 unsigned long offset) 309 { 310 struct qxl_memslot *slot = 311 (bo->tbo.mem.mem_type == TTM_PL_VRAM) 312 ? &qdev->main_slot : &qdev->surfaces_slot; 313 314 WARN_ON_ONCE((bo->tbo.offset & slot->gpu_offset) != slot->gpu_offset); 315 316 /* TODO - need to hold one of the locks to read tbo.offset */ 317 return slot->high_bits | (bo->tbo.offset - slot->gpu_offset + offset); 318 } 319 320 /* qxl_display.c */ 321 void qxl_display_read_client_monitors_config(struct qxl_device *qdev); 322 int qxl_create_monitors_object(struct qxl_device *qdev); 323 int qxl_destroy_monitors_object(struct qxl_device *qdev); 324 325 /* qxl_gem.c */ 326 void qxl_gem_init(struct qxl_device *qdev); 327 void qxl_gem_fini(struct qxl_device *qdev); 328 int qxl_gem_object_create(struct qxl_device *qdev, int size, 329 int alignment, int initial_domain, 330 bool discardable, bool kernel, 331 struct qxl_surface *surf, 332 struct drm_gem_object **obj); 333 int qxl_gem_object_create_with_handle(struct qxl_device *qdev, 334 struct drm_file *file_priv, 335 u32 domain, 336 size_t size, 337 struct qxl_surface *surf, 338 struct qxl_bo **qobj, 339 uint32_t *handle); 340 void qxl_gem_object_free(struct drm_gem_object *gobj); 341 int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv); 342 void qxl_gem_object_close(struct drm_gem_object *obj, 343 struct drm_file *file_priv); 344 void qxl_bo_force_delete(struct qxl_device *qdev); 345 int qxl_bo_kmap(struct qxl_bo *bo, void **ptr); 346 347 /* qxl_dumb.c */ 348 int qxl_mode_dumb_create(struct drm_file *file_priv, 349 struct drm_device *dev, 350 struct drm_mode_create_dumb *args); 351 int qxl_mode_dumb_mmap(struct drm_file *filp, 352 struct drm_device *dev, 353 uint32_t handle, uint64_t *offset_p); 354 355 /* qxl ttm */ 356 int qxl_ttm_init(struct qxl_device *qdev); 357 void qxl_ttm_fini(struct qxl_device *qdev); 358 int qxl_ttm_io_mem_reserve(struct ttm_bo_device *bdev, 359 struct ttm_mem_reg *mem); 360 361 /* qxl image */ 362 363 int qxl_image_init(struct qxl_device *qdev, 364 struct qxl_release *release, 365 struct qxl_drm_image *dimage, 366 const uint8_t *data, 367 int x, int y, int width, int height, 368 int depth, int stride); 369 int 370 qxl_image_alloc_objects(struct qxl_device *qdev, 371 struct qxl_release *release, 372 struct qxl_drm_image **image_ptr, 373 int height, int stride); 374 void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage); 375 376 void qxl_update_screen(struct qxl_device *qxl); 377 378 /* qxl io operations (qxl_cmd.c) */ 379 380 void qxl_io_create_primary(struct qxl_device *qdev, 381 struct qxl_bo *bo); 382 void qxl_io_destroy_primary(struct qxl_device *qdev); 383 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id); 384 void qxl_io_notify_oom(struct qxl_device *qdev); 385 386 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf, 387 const struct qxl_rect *area); 388 389 void qxl_io_reset(struct qxl_device *qdev); 390 void qxl_io_monitors_config(struct qxl_device *qdev); 391 int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible); 392 void qxl_io_flush_release(struct qxl_device *qdev); 393 void qxl_io_flush_surfaces(struct qxl_device *qdev); 394 395 union qxl_release_info *qxl_release_map(struct qxl_device *qdev, 396 struct qxl_release *release); 397 void qxl_release_unmap(struct qxl_device *qdev, 398 struct qxl_release *release, 399 union qxl_release_info *info); 400 int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo); 401 int qxl_release_reserve_list(struct qxl_release *release, bool no_intr); 402 void qxl_release_backoff_reserve_list(struct qxl_release *release); 403 void qxl_release_fence_buffer_objects(struct qxl_release *release); 404 405 int qxl_alloc_surface_release_reserved(struct qxl_device *qdev, 406 enum qxl_surface_cmd_type surface_cmd_type, 407 struct qxl_release *create_rel, 408 struct qxl_release **release); 409 int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size, 410 int type, struct qxl_release **release, 411 struct qxl_bo **rbo); 412 413 int 414 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release, 415 uint32_t type, bool interruptible); 416 int 417 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release, 418 uint32_t type, bool interruptible); 419 int qxl_alloc_bo_reserved(struct qxl_device *qdev, 420 struct qxl_release *release, 421 unsigned long size, 422 struct qxl_bo **_bo); 423 /* qxl drawing commands */ 424 425 void qxl_draw_dirty_fb(struct qxl_device *qdev, 426 struct drm_framebuffer *fb, 427 struct qxl_bo *bo, 428 unsigned int flags, unsigned int color, 429 struct drm_clip_rect *clips, 430 unsigned int num_clips, int inc, 431 uint32_t dumb_shadow_offset); 432 433 void qxl_release_free(struct qxl_device *qdev, 434 struct qxl_release *release); 435 436 /* used by qxl_debugfs_release */ 437 struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev, 438 uint64_t id); 439 440 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush); 441 int qxl_garbage_collect(struct qxl_device *qdev); 442 443 /* debugfs */ 444 445 int qxl_debugfs_init(struct drm_minor *minor); 446 int qxl_ttm_debugfs_init(struct qxl_device *qdev); 447 448 /* qxl_prime.c */ 449 int qxl_gem_prime_pin(struct drm_gem_object *obj); 450 void qxl_gem_prime_unpin(struct drm_gem_object *obj); 451 struct sg_table *qxl_gem_prime_get_sg_table(struct drm_gem_object *obj); 452 struct drm_gem_object *qxl_gem_prime_import_sg_table( 453 struct drm_device *dev, struct dma_buf_attachment *attach, 454 struct sg_table *sgt); 455 void *qxl_gem_prime_vmap(struct drm_gem_object *obj); 456 void qxl_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr); 457 int qxl_gem_prime_mmap(struct drm_gem_object *obj, 458 struct vm_area_struct *vma); 459 460 /* qxl_irq.c */ 461 int qxl_irq_init(struct qxl_device *qdev); 462 irqreturn_t qxl_irq_handler(int irq, void *arg); 463 464 int qxl_debugfs_add_files(struct qxl_device *qdev, 465 struct drm_info_list *files, 466 unsigned int nfiles); 467 468 int qxl_surface_id_alloc(struct qxl_device *qdev, 469 struct qxl_bo *surf); 470 void qxl_surface_id_dealloc(struct qxl_device *qdev, 471 uint32_t surface_id); 472 int qxl_hw_surface_alloc(struct qxl_device *qdev, 473 struct qxl_bo *surf); 474 int qxl_hw_surface_dealloc(struct qxl_device *qdev, 475 struct qxl_bo *surf); 476 477 int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo); 478 479 struct qxl_drv_surface * 480 qxl_surface_lookup(struct drm_device *dev, int surface_id); 481 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing); 482 483 #endif 484