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/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_gem.h>
48 /* just for ttm_validate_buffer */
49 #include <ttm/ttm_execbuf_util.h>
51 #include <drm/qxl_drm.h>
54 #define DRIVER_AUTHOR "Dave Airlie"
56 #define DRIVER_NAME "qxl"
57 #define DRIVER_DESC "RH QXL"
58 #define DRIVER_DATE "20120117"
60 #define DRIVER_MAJOR 0
61 #define DRIVER_MINOR 1
62 #define DRIVER_PATCHLEVEL 0
64 #define QXL_DEBUGFS_MAX_COMPONENTS 32
66 extern int qxl_log_level
;
67 extern int qxl_num_crtc
;
74 #define QXL_INFO(qdev, fmt, ...) do { \
75 if (qxl_log_level >= QXL_INFO_LEVEL) { \
76 qxl_io_log(qdev, fmt, __VA_ARGS__); \
79 #define QXL_DEBUG(qdev, fmt, ...) do { \
80 if (qxl_log_level >= QXL_DEBUG_LEVEL) { \
81 qxl_io_log(qdev, fmt, __VA_ARGS__); \
84 #define QXL_INFO_ONCE(qdev, fmt, ...) do { \
88 QXL_INFO(qdev, fmt, __VA_ARGS__); \
92 #define DRM_FILE_OFFSET 0x100000000ULL
93 #define DRM_FILE_PAGE_OFFSET (DRM_FILE_OFFSET >> PAGE_SHIFT)
95 #define QXL_INTERRUPT_MASK (\
96 QXL_INTERRUPT_DISPLAY |\
97 QXL_INTERRUPT_CURSOR |\
98 QXL_INTERRUPT_IO_CMD |\
99 QXL_INTERRUPT_CLIENT_MONITORS_CONFIG)
102 /* Protected by gem.mutex */
103 struct list_head list
;
104 /* Protected by tbo.reserved */
105 struct ttm_place placements
[3];
106 struct ttm_placement placement
;
107 struct ttm_buffer_object tbo
;
108 struct ttm_bo_kmap_obj kmap
;
113 /* Constant after initialization */
114 struct drm_gem_object gem_base
;
115 bool is_primary
; /* is this now a primary surface */
117 struct qxl_surface surf
;
119 struct qxl_release
*surf_create
;
121 #define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, gem_base)
122 #define to_qxl_bo(tobj) container_of((tobj), struct qxl_bo, tbo)
126 struct list_head objects
;
130 struct ttm_validate_buffer tv
;
134 struct drm_crtc base
;
144 struct drm_connector base
;
145 struct drm_encoder enc
;
148 struct qxl_framebuffer
{
149 struct drm_framebuffer base
;
150 struct drm_gem_object
*obj
;
153 #define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base)
154 #define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base)
155 #define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc)
156 #define to_qxl_framebuffer(x) container_of(x, struct qxl_framebuffer, base)
159 struct ttm_bo_global_ref bo_global_ref
;
160 struct drm_global_reference mem_global_ref
;
161 bool mem_global_referenced
;
162 struct ttm_bo_device bdev
;
165 struct qxl_mode_info
{
167 struct qxl_mode
*modes
;
168 bool mode_config_initialized
;
170 /* pointer to fbdev info structure */
171 struct qxl_fbdev
*qfbdev
;
177 uint64_t start_phys_addr
;
178 uint64_t end_phys_addr
;
183 QXL_RELEASE_DRAWABLE
,
184 QXL_RELEASE_SURFACE_CMD
,
185 QXL_RELEASE_CURSOR_CMD
,
188 /* drm_ prefix to differentiate from qxl_release_info in
189 * spice-protocol/qxl_dev.h */
190 #define QXL_MAX_RES 96
196 uint32_t release_offset
;
197 uint32_t surface_release_id
;
198 struct ww_acquire_ctx ticket
;
199 struct list_head bos
;
202 struct qxl_drm_chunk
{
203 struct list_head head
;
207 struct qxl_drm_image
{
209 struct list_head chunk_list
;
212 struct qxl_fb_image
{
213 struct qxl_device
*qdev
;
214 uint32_t pseudo_palette
[16];
215 struct fb_image fb_image
;
219 struct qxl_draw_fill
{
220 struct qxl_device
*qdev
;
221 struct qxl_rect rect
;
230 struct drm_info_list
*files
;
234 int qxl_debugfs_add_files(struct qxl_device
*rdev
,
235 struct drm_info_list
*files
,
237 int qxl_debugfs_fence_init(struct qxl_device
*rdev
);
238 void qxl_debugfs_remove_files(struct qxl_device
*qdev
);
244 struct drm_device
*ddev
;
245 struct pci_dev
*pdev
;
248 resource_size_t vram_base
, vram_size
;
249 resource_size_t surfaceram_base
, surfaceram_size
;
250 resource_size_t rom_base
, rom_size
;
253 struct qxl_mode
*modes
;
254 struct qxl_bo
*monitors_config_bo
;
255 struct qxl_monitors_config
*monitors_config
;
257 /* last received client_monitors_config */
258 struct qxl_monitors_config
*client_monitors_config
;
262 struct qxl_mman mman
;
264 struct qxl_mode_info mode_info
;
266 struct fb_info
*fbdev_info
;
267 struct qxl_framebuffer
*fbdev_qfb
;
270 struct qxl_ring
*release_ring
;
271 struct qxl_ring
*command_ring
;
272 struct qxl_ring
*cursor_ring
;
274 struct qxl_ram_header
*ram_header
;
276 bool primary_created
;
278 struct qxl_memslot
*mem_slots
;
281 uint8_t main_mem_slot
;
282 uint8_t surfaces_mem_slot
;
283 uint8_t slot_id_bits
;
284 uint8_t slot_gen_bits
;
285 uint64_t va_slot_mask
;
287 spinlock_t release_lock
;
288 struct idr release_idr
;
289 uint32_t release_seqno
;
290 spinlock_t release_idr_lock
;
291 struct mutex async_io_mutex
;
292 unsigned int last_sent_io_cmd
;
294 /* interrupt handling */
295 atomic_t irq_received
;
296 atomic_t irq_received_display
;
297 atomic_t irq_received_cursor
;
298 atomic_t irq_received_io_cmd
;
299 unsigned irq_received_error
;
300 wait_queue_head_t display_event
;
301 wait_queue_head_t cursor_event
;
302 wait_queue_head_t io_cmd_event
;
303 struct work_struct client_monitors_config_work
;
306 struct qxl_debugfs debugfs
[QXL_DEBUGFS_MAX_COMPONENTS
];
307 unsigned debugfs_count
;
309 struct mutex update_area_mutex
;
311 struct idr surf_id_idr
;
312 spinlock_t surf_id_idr_lock
;
313 int last_alloced_surf_id
;
315 struct mutex surf_evict_mutex
;
316 struct io_mapping
*vram_mapping
;
317 struct io_mapping
*surface_mapping
;
320 struct mutex release_mutex
;
321 struct qxl_bo
*current_release_bo
[3];
322 int current_release_bo_offset
[3];
324 struct work_struct gc_work
;
326 struct drm_property
*hotplug_mode_update_property
;
327 int monitors_config_width
;
328 int monitors_config_height
;
331 /* forward declaration for QXL_INFO_IO */
332 __printf(2,3) void qxl_io_log(struct qxl_device
*qdev
, const char *fmt
, ...);
334 extern const struct drm_ioctl_desc qxl_ioctls
[];
335 extern int qxl_max_ioctl
;
337 int qxl_driver_load(struct drm_device
*dev
, unsigned long flags
);
338 int qxl_driver_unload(struct drm_device
*dev
);
340 int qxl_modeset_init(struct qxl_device
*qdev
);
341 void qxl_modeset_fini(struct qxl_device
*qdev
);
343 int qxl_bo_init(struct qxl_device
*qdev
);
344 void qxl_bo_fini(struct qxl_device
*qdev
);
346 void qxl_reinit_memslots(struct qxl_device
*qdev
);
347 int qxl_surf_evict(struct qxl_device
*qdev
);
348 int qxl_vram_evict(struct qxl_device
*qdev
);
350 struct qxl_ring
*qxl_ring_create(struct qxl_ring_header
*header
,
354 bool set_prod_notify
,
355 wait_queue_head_t
*push_event
);
356 void qxl_ring_free(struct qxl_ring
*ring
);
357 void qxl_ring_init_hdr(struct qxl_ring
*ring
);
358 int qxl_check_idle(struct qxl_ring
*ring
);
361 qxl_fb_virtual_address(struct qxl_device
*qdev
, unsigned long physical
)
363 QXL_INFO(qdev
, "not implemented (%lu)\n", physical
);
367 static inline uint64_t
368 qxl_bo_physical_address(struct qxl_device
*qdev
, struct qxl_bo
*bo
,
369 unsigned long offset
)
371 int slot_id
= bo
->type
== QXL_GEM_DOMAIN_VRAM
? qdev
->main_mem_slot
: qdev
->surfaces_mem_slot
;
372 struct qxl_memslot
*slot
= &(qdev
->mem_slots
[slot_id
]);
374 /* TODO - need to hold one of the locks to read tbo.offset */
375 return slot
->high_bits
| (bo
->tbo
.offset
+ offset
);
379 #define QXLFB_CONN_LIMIT 1
381 int qxl_fbdev_init(struct qxl_device
*qdev
);
382 void qxl_fbdev_fini(struct qxl_device
*qdev
);
383 int qxl_get_handle_for_primary_fb(struct qxl_device
*qdev
,
384 struct drm_file
*file_priv
,
386 void qxl_fbdev_set_suspend(struct qxl_device
*qdev
, int state
);
389 void qxl_user_framebuffer_destroy(struct drm_framebuffer
*fb
);
391 qxl_framebuffer_init(struct drm_device
*dev
,
392 struct qxl_framebuffer
*rfb
,
393 const struct drm_mode_fb_cmd2
*mode_cmd
,
394 struct drm_gem_object
*obj
,
395 const struct drm_framebuffer_funcs
*funcs
);
396 void qxl_display_read_client_monitors_config(struct qxl_device
*qdev
);
397 void qxl_send_monitors_config(struct qxl_device
*qdev
);
398 int qxl_create_monitors_object(struct qxl_device
*qdev
);
399 int qxl_destroy_monitors_object(struct qxl_device
*qdev
);
401 /* used by qxl_debugfs only */
402 void qxl_crtc_set_from_monitors_config(struct qxl_device
*qdev
);
403 void qxl_alloc_client_monitors_config(struct qxl_device
*qdev
, unsigned count
);
406 int qxl_gem_init(struct qxl_device
*qdev
);
407 void qxl_gem_fini(struct qxl_device
*qdev
);
408 int qxl_gem_object_create(struct qxl_device
*qdev
, int size
,
409 int alignment
, int initial_domain
,
410 bool discardable
, bool kernel
,
411 struct qxl_surface
*surf
,
412 struct drm_gem_object
**obj
);
413 int qxl_gem_object_create_with_handle(struct qxl_device
*qdev
,
414 struct drm_file
*file_priv
,
417 struct qxl_surface
*surf
,
418 struct qxl_bo
**qobj
,
420 void qxl_gem_object_free(struct drm_gem_object
*gobj
);
421 int qxl_gem_object_open(struct drm_gem_object
*obj
, struct drm_file
*file_priv
);
422 void qxl_gem_object_close(struct drm_gem_object
*obj
,
423 struct drm_file
*file_priv
);
424 void qxl_bo_force_delete(struct qxl_device
*qdev
);
425 int qxl_bo_kmap(struct qxl_bo
*bo
, void **ptr
);
428 int qxl_mode_dumb_create(struct drm_file
*file_priv
,
429 struct drm_device
*dev
,
430 struct drm_mode_create_dumb
*args
);
431 int qxl_mode_dumb_mmap(struct drm_file
*filp
,
432 struct drm_device
*dev
,
433 uint32_t handle
, uint64_t *offset_p
);
437 int qxl_ttm_init(struct qxl_device
*qdev
);
438 void qxl_ttm_fini(struct qxl_device
*qdev
);
439 int qxl_mmap(struct file
*filp
, struct vm_area_struct
*vma
);
443 int qxl_image_init(struct qxl_device
*qdev
,
444 struct qxl_release
*release
,
445 struct qxl_drm_image
*dimage
,
447 int x
, int y
, int width
, int height
,
448 int depth
, int stride
);
450 qxl_image_alloc_objects(struct qxl_device
*qdev
,
451 struct qxl_release
*release
,
452 struct qxl_drm_image
**image_ptr
,
453 int height
, int stride
);
454 void qxl_image_free_objects(struct qxl_device
*qdev
, struct qxl_drm_image
*dimage
);
456 void qxl_update_screen(struct qxl_device
*qxl
);
458 /* qxl io operations (qxl_cmd.c) */
460 void qxl_io_create_primary(struct qxl_device
*qdev
,
463 void qxl_io_destroy_primary(struct qxl_device
*qdev
);
464 void qxl_io_memslot_add(struct qxl_device
*qdev
, uint8_t id
);
465 void qxl_io_notify_oom(struct qxl_device
*qdev
);
467 int qxl_io_update_area(struct qxl_device
*qdev
, struct qxl_bo
*surf
,
468 const struct qxl_rect
*area
);
470 void qxl_io_reset(struct qxl_device
*qdev
);
471 void qxl_io_monitors_config(struct qxl_device
*qdev
);
472 int qxl_ring_push(struct qxl_ring
*ring
, const void *new_elt
, bool interruptible
);
473 void qxl_io_flush_release(struct qxl_device
*qdev
);
474 void qxl_io_flush_surfaces(struct qxl_device
*qdev
);
476 union qxl_release_info
*qxl_release_map(struct qxl_device
*qdev
,
477 struct qxl_release
*release
);
478 void qxl_release_unmap(struct qxl_device
*qdev
,
479 struct qxl_release
*release
,
480 union qxl_release_info
*info
);
481 int qxl_release_list_add(struct qxl_release
*release
, struct qxl_bo
*bo
);
482 int qxl_release_reserve_list(struct qxl_release
*release
, bool no_intr
);
483 void qxl_release_backoff_reserve_list(struct qxl_release
*release
);
484 void qxl_release_fence_buffer_objects(struct qxl_release
*release
);
486 int qxl_alloc_surface_release_reserved(struct qxl_device
*qdev
,
487 enum qxl_surface_cmd_type surface_cmd_type
,
488 struct qxl_release
*create_rel
,
489 struct qxl_release
**release
);
490 int qxl_alloc_release_reserved(struct qxl_device
*qdev
, unsigned long size
,
491 int type
, struct qxl_release
**release
,
492 struct qxl_bo
**rbo
);
495 qxl_push_command_ring_release(struct qxl_device
*qdev
, struct qxl_release
*release
,
496 uint32_t type
, bool interruptible
);
498 qxl_push_cursor_ring_release(struct qxl_device
*qdev
, struct qxl_release
*release
,
499 uint32_t type
, bool interruptible
);
500 int qxl_alloc_bo_reserved(struct qxl_device
*qdev
,
501 struct qxl_release
*release
,
503 struct qxl_bo
**_bo
);
504 /* qxl drawing commands */
506 void qxl_draw_opaque_fb(const struct qxl_fb_image
*qxl_fb_image
,
507 int stride
/* filled in if 0 */);
509 void qxl_draw_dirty_fb(struct qxl_device
*qdev
,
510 struct qxl_framebuffer
*qxl_fb
,
512 unsigned flags
, unsigned color
,
513 struct drm_clip_rect
*clips
,
514 unsigned num_clips
, int inc
);
516 void qxl_draw_fill(struct qxl_draw_fill
*qxl_draw_fill_rec
);
518 void qxl_draw_copyarea(struct qxl_device
*qdev
,
519 u32 width
, u32 height
,
523 void qxl_release_free(struct qxl_device
*qdev
,
524 struct qxl_release
*release
);
526 /* used by qxl_debugfs_release */
527 struct qxl_release
*qxl_release_from_id_locked(struct qxl_device
*qdev
,
530 bool qxl_queue_garbage_collect(struct qxl_device
*qdev
, bool flush
);
531 int qxl_garbage_collect(struct qxl_device
*qdev
);
535 int qxl_debugfs_init(struct drm_minor
*minor
);
536 void qxl_debugfs_takedown(struct drm_minor
*minor
);
539 int qxl_gem_prime_pin(struct drm_gem_object
*obj
);
540 void qxl_gem_prime_unpin(struct drm_gem_object
*obj
);
541 struct sg_table
*qxl_gem_prime_get_sg_table(struct drm_gem_object
*obj
);
542 struct drm_gem_object
*qxl_gem_prime_import_sg_table(
543 struct drm_device
*dev
, struct dma_buf_attachment
*attach
,
544 struct sg_table
*sgt
);
545 void *qxl_gem_prime_vmap(struct drm_gem_object
*obj
);
546 void qxl_gem_prime_vunmap(struct drm_gem_object
*obj
, void *vaddr
);
547 int qxl_gem_prime_mmap(struct drm_gem_object
*obj
,
548 struct vm_area_struct
*vma
);
551 int qxl_irq_init(struct qxl_device
*qdev
);
552 irqreturn_t
qxl_irq_handler(int irq
, void *arg
);
555 bool qxl_fbdev_qobj_is_fb(struct qxl_device
*qdev
, struct qxl_bo
*qobj
);
557 int qxl_debugfs_add_files(struct qxl_device
*qdev
,
558 struct drm_info_list
*files
,
561 int qxl_surface_id_alloc(struct qxl_device
*qdev
,
562 struct qxl_bo
*surf
);
563 void qxl_surface_id_dealloc(struct qxl_device
*qdev
,
564 uint32_t surface_id
);
565 int qxl_hw_surface_alloc(struct qxl_device
*qdev
,
567 struct ttm_mem_reg
*mem
);
568 int qxl_hw_surface_dealloc(struct qxl_device
*qdev
,
569 struct qxl_bo
*surf
);
571 int qxl_bo_check_id(struct qxl_device
*qdev
, struct qxl_bo
*bo
);
573 struct qxl_drv_surface
*
574 qxl_surface_lookup(struct drm_device
*dev
, int surface_id
);
575 void qxl_surface_evict(struct qxl_device
*qdev
, struct qxl_bo
*surf
, bool freeing
);
576 int qxl_update_surface(struct qxl_device
*qdev
, struct qxl_bo
*surf
);