2 * Copyright 2013 Red Hat Inc.
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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.
22 * Authors: Dave Airlie
31 * Definitions taken from spice-protocol, plus kernel driver specific bits.
34 #include <linux/dma-fence.h>
35 #include <linux/workqueue.h>
36 #include <linux/firmware.h>
37 #include <linux/platform_device.h>
41 #include <ttm/ttm_bo_api.h>
42 #include <ttm/ttm_bo_driver.h>
43 #include <ttm/ttm_placement.h>
44 #include <ttm/ttm_module.h>
46 #include <drm/drm_encoder.h>
47 #include <drm/drm_gem.h>
49 /* just for ttm_validate_buffer */
50 #include <ttm/ttm_execbuf_util.h>
52 #include <drm/qxl_drm.h>
55 #define DRIVER_AUTHOR "Dave Airlie"
57 #define DRIVER_NAME "qxl"
58 #define DRIVER_DESC "RH QXL"
59 #define DRIVER_DATE "20120117"
61 #define DRIVER_MAJOR 0
62 #define DRIVER_MINOR 1
63 #define DRIVER_PATCHLEVEL 0
65 #define QXL_DEBUGFS_MAX_COMPONENTS 32
67 extern int qxl_log_level;
68 extern int qxl_num_crtc;
75 #define QXL_INFO(qdev, fmt, ...) do { \
76 if (qxl_log_level >= QXL_INFO_LEVEL) { \
77 qxl_io_log(qdev, fmt, __VA_ARGS__); \
80 #define QXL_DEBUG(qdev, fmt, ...) do { \
81 if (qxl_log_level >= QXL_DEBUG_LEVEL) { \
82 qxl_io_log(qdev, fmt, __VA_ARGS__); \
85 #define QXL_INFO_ONCE(qdev, fmt, ...) do { \
89 QXL_INFO(qdev, fmt, __VA_ARGS__); \
93 #define DRM_FILE_OFFSET 0x100000000ULL
94 #define DRM_FILE_PAGE_OFFSET (DRM_FILE_OFFSET >> PAGE_SHIFT)
96 #define QXL_INTERRUPT_MASK (\
97 QXL_INTERRUPT_DISPLAY |\
98 QXL_INTERRUPT_CURSOR |\
99 QXL_INTERRUPT_IO_CMD |\
100 QXL_INTERRUPT_CLIENT_MONITORS_CONFIG)
103 /* Protected by gem.mutex */
104 struct list_head list;
105 /* Protected by tbo.reserved */
106 struct ttm_place placements[3];
107 struct ttm_placement placement;
108 struct ttm_buffer_object tbo;
109 struct ttm_bo_kmap_obj kmap;
114 /* Constant after initialization */
115 struct drm_gem_object gem_base;
116 bool is_primary; /* is this now a primary surface */
118 struct qxl_surface surf;
120 struct qxl_release *surf_create;
122 #define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, gem_base)
123 #define to_qxl_bo(tobj) container_of((tobj), struct qxl_bo, tbo)
127 struct list_head objects;
131 struct ttm_validate_buffer tv;
135 struct drm_crtc base;
141 struct qxl_bo *cursor_bo;
146 struct drm_connector base;
147 struct drm_encoder enc;
150 struct qxl_framebuffer {
151 struct drm_framebuffer base;
152 struct drm_gem_object *obj;
155 #define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base)
156 #define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base)
157 #define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc)
158 #define to_qxl_framebuffer(x) container_of(x, struct qxl_framebuffer, base)
161 struct ttm_bo_global_ref bo_global_ref;
162 struct drm_global_reference mem_global_ref;
163 bool mem_global_referenced;
164 struct ttm_bo_device bdev;
167 struct qxl_mode_info {
169 struct qxl_mode *modes;
170 bool mode_config_initialized;
172 /* pointer to fbdev info structure */
173 struct qxl_fbdev *qfbdev;
179 uint64_t start_phys_addr;
180 uint64_t end_phys_addr;
185 QXL_RELEASE_DRAWABLE,
186 QXL_RELEASE_SURFACE_CMD,
187 QXL_RELEASE_CURSOR_CMD,
190 /* drm_ prefix to differentiate from qxl_release_info in
191 * spice-protocol/qxl_dev.h */
192 #define QXL_MAX_RES 96
194 struct dma_fence base;
198 uint32_t release_offset;
199 uint32_t surface_release_id;
200 struct ww_acquire_ctx ticket;
201 struct list_head bos;
204 struct qxl_drm_chunk {
205 struct list_head head;
209 struct qxl_drm_image {
211 struct list_head chunk_list;
214 struct qxl_fb_image {
215 struct qxl_device *qdev;
216 uint32_t pseudo_palette[16];
217 struct fb_image fb_image;
221 struct qxl_draw_fill {
222 struct qxl_device *qdev;
223 struct qxl_rect rect;
232 struct drm_info_list *files;
236 int qxl_debugfs_add_files(struct qxl_device *rdev,
237 struct drm_info_list *files,
239 int qxl_debugfs_fence_init(struct qxl_device *rdev);
240 void qxl_debugfs_remove_files(struct qxl_device *qdev);
246 struct drm_device *ddev;
247 struct pci_dev *pdev;
250 resource_size_t vram_base, vram_size;
251 resource_size_t surfaceram_base, surfaceram_size;
252 resource_size_t rom_base, rom_size;
255 struct qxl_mode *modes;
256 struct qxl_bo *monitors_config_bo;
257 struct qxl_monitors_config *monitors_config;
259 /* last received client_monitors_config */
260 struct qxl_monitors_config *client_monitors_config;
264 struct qxl_mman mman;
266 struct qxl_mode_info mode_info;
268 struct fb_info *fbdev_info;
269 struct qxl_framebuffer *fbdev_qfb;
272 struct qxl_ring *release_ring;
273 struct qxl_ring *command_ring;
274 struct qxl_ring *cursor_ring;
276 struct qxl_ram_header *ram_header;
278 bool primary_created;
280 struct qxl_memslot *mem_slots;
283 uint8_t main_mem_slot;
284 uint8_t surfaces_mem_slot;
285 uint8_t slot_id_bits;
286 uint8_t slot_gen_bits;
287 uint64_t va_slot_mask;
289 spinlock_t release_lock;
290 struct idr release_idr;
291 uint32_t release_seqno;
292 spinlock_t release_idr_lock;
293 struct mutex async_io_mutex;
294 unsigned int last_sent_io_cmd;
296 /* interrupt handling */
297 atomic_t irq_received;
298 atomic_t irq_received_display;
299 atomic_t irq_received_cursor;
300 atomic_t irq_received_io_cmd;
301 unsigned irq_received_error;
302 wait_queue_head_t display_event;
303 wait_queue_head_t cursor_event;
304 wait_queue_head_t io_cmd_event;
305 struct work_struct client_monitors_config_work;
308 struct qxl_debugfs debugfs[QXL_DEBUGFS_MAX_COMPONENTS];
309 unsigned debugfs_count;
311 struct mutex update_area_mutex;
313 struct idr surf_id_idr;
314 spinlock_t surf_id_idr_lock;
315 int last_alloced_surf_id;
317 struct mutex surf_evict_mutex;
318 struct io_mapping *vram_mapping;
319 struct io_mapping *surface_mapping;
322 struct mutex release_mutex;
323 struct qxl_bo *current_release_bo[3];
324 int current_release_bo_offset[3];
326 struct work_struct gc_work;
328 struct drm_property *hotplug_mode_update_property;
329 int monitors_config_width;
330 int monitors_config_height;
333 /* forward declaration for QXL_INFO_IO */
334 __printf(2,3) void qxl_io_log(struct qxl_device *qdev, const char *fmt, ...);
336 extern const struct drm_ioctl_desc qxl_ioctls[];
337 extern int qxl_max_ioctl;
339 int qxl_device_init(struct qxl_device *qdev, struct drm_device *ddev,
340 struct pci_dev *pdev, unsigned long flags);
341 void qxl_device_fini(struct qxl_device *qdev);
343 int qxl_modeset_init(struct qxl_device *qdev);
344 void qxl_modeset_fini(struct qxl_device *qdev);
346 int qxl_bo_init(struct qxl_device *qdev);
347 void qxl_bo_fini(struct qxl_device *qdev);
349 void qxl_reinit_memslots(struct qxl_device *qdev);
350 int qxl_surf_evict(struct qxl_device *qdev);
351 int qxl_vram_evict(struct qxl_device *qdev);
353 struct qxl_ring *qxl_ring_create(struct qxl_ring_header *header,
357 bool set_prod_notify,
358 wait_queue_head_t *push_event);
359 void qxl_ring_free(struct qxl_ring *ring);
360 void qxl_ring_init_hdr(struct qxl_ring *ring);
361 int qxl_check_idle(struct qxl_ring *ring);
364 qxl_fb_virtual_address(struct qxl_device *qdev, unsigned long physical)
366 QXL_INFO(qdev, "not implemented (%lu)\n", physical);
370 static inline uint64_t
371 qxl_bo_physical_address(struct qxl_device *qdev, struct qxl_bo *bo,
372 unsigned long offset)
374 int slot_id = bo->type == QXL_GEM_DOMAIN_VRAM ? qdev->main_mem_slot : qdev->surfaces_mem_slot;
375 struct qxl_memslot *slot = &(qdev->mem_slots[slot_id]);
377 /* TODO - need to hold one of the locks to read tbo.offset */
378 return slot->high_bits | (bo->tbo.offset + offset);
382 #define QXLFB_CONN_LIMIT 1
384 int qxl_fbdev_init(struct qxl_device *qdev);
385 void qxl_fbdev_fini(struct qxl_device *qdev);
386 int qxl_get_handle_for_primary_fb(struct qxl_device *qdev,
387 struct drm_file *file_priv,
389 void qxl_fbdev_set_suspend(struct qxl_device *qdev, int state);
392 void qxl_user_framebuffer_destroy(struct drm_framebuffer *fb);
394 qxl_framebuffer_init(struct drm_device *dev,
395 struct qxl_framebuffer *rfb,
396 const struct drm_mode_fb_cmd2 *mode_cmd,
397 struct drm_gem_object *obj,
398 const struct drm_framebuffer_funcs *funcs);
399 void qxl_display_read_client_monitors_config(struct qxl_device *qdev);
400 int qxl_create_monitors_object(struct qxl_device *qdev);
401 int qxl_destroy_monitors_object(struct qxl_device *qdev);
404 void qxl_gem_init(struct qxl_device *qdev);
405 void qxl_gem_fini(struct qxl_device *qdev);
406 int qxl_gem_object_create(struct qxl_device *qdev, int size,
407 int alignment, int initial_domain,
408 bool discardable, bool kernel,
409 struct qxl_surface *surf,
410 struct drm_gem_object **obj);
411 int qxl_gem_object_create_with_handle(struct qxl_device *qdev,
412 struct drm_file *file_priv,
415 struct qxl_surface *surf,
416 struct qxl_bo **qobj,
418 void qxl_gem_object_free(struct drm_gem_object *gobj);
419 int qxl_gem_object_open(struct drm_gem_object *obj, struct drm_file *file_priv);
420 void qxl_gem_object_close(struct drm_gem_object *obj,
421 struct drm_file *file_priv);
422 void qxl_bo_force_delete(struct qxl_device *qdev);
423 int qxl_bo_kmap(struct qxl_bo *bo, void **ptr);
426 int qxl_mode_dumb_create(struct drm_file *file_priv,
427 struct drm_device *dev,
428 struct drm_mode_create_dumb *args);
429 int qxl_mode_dumb_mmap(struct drm_file *filp,
430 struct drm_device *dev,
431 uint32_t handle, uint64_t *offset_p);
435 int qxl_ttm_init(struct qxl_device *qdev);
436 void qxl_ttm_fini(struct qxl_device *qdev);
437 int qxl_mmap(struct file *filp, struct vm_area_struct *vma);
441 int qxl_image_init(struct qxl_device *qdev,
442 struct qxl_release *release,
443 struct qxl_drm_image *dimage,
445 int x, int y, int width, int height,
446 int depth, int stride);
448 qxl_image_alloc_objects(struct qxl_device *qdev,
449 struct qxl_release *release,
450 struct qxl_drm_image **image_ptr,
451 int height, int stride);
452 void qxl_image_free_objects(struct qxl_device *qdev, struct qxl_drm_image *dimage);
454 void qxl_update_screen(struct qxl_device *qxl);
456 /* qxl io operations (qxl_cmd.c) */
458 void qxl_io_create_primary(struct qxl_device *qdev,
461 void qxl_io_destroy_primary(struct qxl_device *qdev);
462 void qxl_io_memslot_add(struct qxl_device *qdev, uint8_t id);
463 void qxl_io_notify_oom(struct qxl_device *qdev);
465 int qxl_io_update_area(struct qxl_device *qdev, struct qxl_bo *surf,
466 const struct qxl_rect *area);
468 void qxl_io_reset(struct qxl_device *qdev);
469 void qxl_io_monitors_config(struct qxl_device *qdev);
470 int qxl_ring_push(struct qxl_ring *ring, const void *new_elt, bool interruptible);
471 void qxl_io_flush_release(struct qxl_device *qdev);
472 void qxl_io_flush_surfaces(struct qxl_device *qdev);
474 union qxl_release_info *qxl_release_map(struct qxl_device *qdev,
475 struct qxl_release *release);
476 void qxl_release_unmap(struct qxl_device *qdev,
477 struct qxl_release *release,
478 union qxl_release_info *info);
479 int qxl_release_list_add(struct qxl_release *release, struct qxl_bo *bo);
480 int qxl_release_reserve_list(struct qxl_release *release, bool no_intr);
481 void qxl_release_backoff_reserve_list(struct qxl_release *release);
482 void qxl_release_fence_buffer_objects(struct qxl_release *release);
484 int qxl_alloc_surface_release_reserved(struct qxl_device *qdev,
485 enum qxl_surface_cmd_type surface_cmd_type,
486 struct qxl_release *create_rel,
487 struct qxl_release **release);
488 int qxl_alloc_release_reserved(struct qxl_device *qdev, unsigned long size,
489 int type, struct qxl_release **release,
490 struct qxl_bo **rbo);
493 qxl_push_command_ring_release(struct qxl_device *qdev, struct qxl_release *release,
494 uint32_t type, bool interruptible);
496 qxl_push_cursor_ring_release(struct qxl_device *qdev, struct qxl_release *release,
497 uint32_t type, bool interruptible);
498 int qxl_alloc_bo_reserved(struct qxl_device *qdev,
499 struct qxl_release *release,
501 struct qxl_bo **_bo);
502 /* qxl drawing commands */
504 void qxl_draw_opaque_fb(const struct qxl_fb_image *qxl_fb_image,
505 int stride /* filled in if 0 */);
507 void qxl_draw_dirty_fb(struct qxl_device *qdev,
508 struct qxl_framebuffer *qxl_fb,
510 unsigned flags, unsigned color,
511 struct drm_clip_rect *clips,
512 unsigned num_clips, int inc);
514 void qxl_draw_fill(struct qxl_draw_fill *qxl_draw_fill_rec);
516 void qxl_draw_copyarea(struct qxl_device *qdev,
517 u32 width, u32 height,
521 void qxl_release_free(struct qxl_device *qdev,
522 struct qxl_release *release);
524 /* used by qxl_debugfs_release */
525 struct qxl_release *qxl_release_from_id_locked(struct qxl_device *qdev,
528 bool qxl_queue_garbage_collect(struct qxl_device *qdev, bool flush);
529 int qxl_garbage_collect(struct qxl_device *qdev);
533 int qxl_debugfs_init(struct drm_minor *minor);
534 void qxl_debugfs_takedown(struct drm_minor *minor);
535 int qxl_ttm_debugfs_init(struct qxl_device *qdev);
538 int qxl_gem_prime_pin(struct drm_gem_object *obj);
539 void qxl_gem_prime_unpin(struct drm_gem_object *obj);
540 struct sg_table *qxl_gem_prime_get_sg_table(struct drm_gem_object *obj);
541 struct drm_gem_object *qxl_gem_prime_import_sg_table(
542 struct drm_device *dev, struct dma_buf_attachment *attach,
543 struct sg_table *sgt);
544 void *qxl_gem_prime_vmap(struct drm_gem_object *obj);
545 void qxl_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
546 int qxl_gem_prime_mmap(struct drm_gem_object *obj,
547 struct vm_area_struct *vma);
550 int qxl_irq_init(struct qxl_device *qdev);
551 irqreturn_t qxl_irq_handler(int irq, void *arg);
554 bool qxl_fbdev_qobj_is_fb(struct qxl_device *qdev, struct qxl_bo *qobj);
556 int qxl_debugfs_add_files(struct qxl_device *qdev,
557 struct drm_info_list *files,
560 int qxl_surface_id_alloc(struct qxl_device *qdev,
561 struct qxl_bo *surf);
562 void qxl_surface_id_dealloc(struct qxl_device *qdev,
563 uint32_t surface_id);
564 int qxl_hw_surface_alloc(struct qxl_device *qdev,
566 struct ttm_mem_reg *mem);
567 int qxl_hw_surface_dealloc(struct qxl_device *qdev,
568 struct qxl_bo *surf);
570 int qxl_bo_check_id(struct qxl_device *qdev, struct qxl_bo *bo);
572 struct qxl_drv_surface *
573 qxl_surface_lookup(struct drm_device *dev, int surface_id);
574 void qxl_surface_evict(struct qxl_device *qdev, struct qxl_bo *surf, bool freeing);