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