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/workqueue.h>
35 #include <linux/firmware.h>
36 #include <linux/platform_device.h>
40 #include <ttm/ttm_bo_api.h>
41 #include <ttm/ttm_bo_driver.h>
42 #include <ttm/ttm_placement.h>
43 #include <ttm/ttm_module.h>
45 #include <drm/qxl_drm.h>
48 #define DRIVER_AUTHOR "Dave Airlie"
50 #define DRIVER_NAME "qxl"
51 #define DRIVER_DESC "RH QXL"
52 #define DRIVER_DATE "20120117"
54 #define DRIVER_MAJOR 0
55 #define DRIVER_MINOR 1
56 #define DRIVER_PATCHLEVEL 0
58 #define QXL_DEBUGFS_MAX_COMPONENTS 32
60 extern int qxl_log_level
;
61 extern int qxl_num_crtc
;
68 #define QXL_INFO(qdev, fmt, ...) do { \
69 if (qxl_log_level >= QXL_INFO_LEVEL) { \
70 qxl_io_log(qdev, fmt, __VA_ARGS__); \
73 #define QXL_DEBUG(qdev, fmt, ...) do { \
74 if (qxl_log_level >= QXL_DEBUG_LEVEL) { \
75 qxl_io_log(qdev, fmt, __VA_ARGS__); \
78 #define QXL_INFO_ONCE(qdev, fmt, ...) do { \
82 QXL_INFO(qdev, fmt, __VA_ARGS__); \
86 #define DRM_FILE_OFFSET 0x100000000ULL
87 #define DRM_FILE_PAGE_OFFSET (DRM_FILE_OFFSET >> PAGE_SHIFT)
89 #define QXL_INTERRUPT_MASK (\
90 QXL_INTERRUPT_DISPLAY |\
91 QXL_INTERRUPT_CURSOR |\
92 QXL_INTERRUPT_IO_CMD |\
93 QXL_INTERRUPT_CLIENT_MONITORS_CONFIG)
96 struct qxl_device
*qdev
;
97 uint32_t num_active_releases
;
98 uint32_t *release_ids
;
99 struct radix_tree_root tree
;
103 /* Protected by gem.mutex */
104 struct list_head list
;
105 /* Protected by tbo.reserved */
107 struct ttm_placement placement
;
108 struct ttm_buffer_object tbo
;
109 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_fence fence
; /* per bo fence - list of releases */
120 struct qxl_release
*surf_create
;
121 atomic_t reserve_count
;
123 #define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, gem_base)
127 struct list_head objects
;
131 struct list_head lhead
;
135 struct qxl_reloc_list
{
136 struct list_head bos
;
140 struct drm_crtc base
;
148 struct drm_connector base
;
149 struct drm_encoder enc
;
152 struct qxl_framebuffer
{
153 struct drm_framebuffer base
;
154 struct drm_gem_object
*obj
;
157 #define to_qxl_crtc(x) container_of(x, struct qxl_crtc, base)
158 #define drm_connector_to_qxl_output(x) container_of(x, struct qxl_output, base)
159 #define drm_encoder_to_qxl_output(x) container_of(x, struct qxl_output, enc)
160 #define to_qxl_framebuffer(x) container_of(x, struct qxl_framebuffer, base)
163 struct ttm_bo_global_ref bo_global_ref
;
164 struct drm_global_reference mem_global_ref
;
165 bool mem_global_referenced
;
166 struct ttm_bo_device bdev
;
169 struct qxl_mode_info
{
171 struct qxl_mode
*modes
;
172 bool mode_config_initialized
;
174 /* pointer to fbdev info structure */
175 struct qxl_fbdev
*qfbdev
;
181 uint64_t start_phys_addr
;
182 uint64_t end_phys_addr
;
187 QXL_RELEASE_DRAWABLE
,
188 QXL_RELEASE_SURFACE_CMD
,
189 QXL_RELEASE_CURSOR_CMD
,
192 /* drm_ prefix to differentiate from qxl_release_info in
193 * spice-protocol/qxl_dev.h */
194 #define QXL_MAX_RES 96
199 uint32_t release_offset
;
200 uint32_t surface_release_id
;
201 struct qxl_bo
*bos
[QXL_MAX_RES
];
204 struct qxl_fb_image
{
205 struct qxl_device
*qdev
;
206 uint32_t pseudo_palette
[16];
207 struct fb_image fb_image
;
211 struct qxl_draw_fill
{
212 struct qxl_device
*qdev
;
213 struct qxl_rect rect
;
222 struct drm_info_list
*files
;
226 int qxl_debugfs_add_files(struct qxl_device
*rdev
,
227 struct drm_info_list
*files
,
229 int qxl_debugfs_fence_init(struct qxl_device
*rdev
);
230 void qxl_debugfs_remove_files(struct qxl_device
*qdev
);
236 struct drm_device
*ddev
;
237 struct pci_dev
*pdev
;
240 resource_size_t vram_base
, vram_size
;
241 resource_size_t surfaceram_base
, surfaceram_size
;
242 resource_size_t rom_base
, rom_size
;
245 struct qxl_mode
*modes
;
246 struct qxl_bo
*monitors_config_bo
;
247 struct qxl_monitors_config
*monitors_config
;
249 /* last received client_monitors_config */
250 struct qxl_monitors_config
*client_monitors_config
;
254 struct qxl_mman mman
;
256 struct qxl_mode_info mode_info
;
258 struct fb_info
*fbdev_info
;
259 struct qxl_framebuffer
*fbdev_qfb
;
262 struct qxl_ring
*release_ring
;
263 struct qxl_ring
*command_ring
;
264 struct qxl_ring
*cursor_ring
;
266 struct qxl_ram_header
*ram_header
;
268 bool primary_created
;
270 struct qxl_memslot
*mem_slots
;
273 uint8_t main_mem_slot
;
274 uint8_t surfaces_mem_slot
;
275 uint8_t slot_id_bits
;
276 uint8_t slot_gen_bits
;
277 uint64_t va_slot_mask
;
279 struct idr release_idr
;
280 spinlock_t release_idr_lock
;
281 struct mutex async_io_mutex
;
282 unsigned int last_sent_io_cmd
;
284 /* interrupt handling */
285 atomic_t irq_received
;
286 atomic_t irq_received_display
;
287 atomic_t irq_received_cursor
;
288 atomic_t irq_received_io_cmd
;
289 unsigned irq_received_error
;
290 wait_queue_head_t display_event
;
291 wait_queue_head_t cursor_event
;
292 wait_queue_head_t io_cmd_event
;
293 struct work_struct client_monitors_config_work
;
296 struct qxl_debugfs debugfs
[QXL_DEBUGFS_MAX_COMPONENTS
];
297 unsigned debugfs_count
;
299 struct mutex update_area_mutex
;
301 struct idr surf_id_idr
;
302 spinlock_t surf_id_idr_lock
;
303 int last_alloced_surf_id
;
305 struct mutex surf_evict_mutex
;
306 struct io_mapping
*vram_mapping
;
307 struct io_mapping
*surface_mapping
;
310 struct mutex release_mutex
;
311 struct qxl_bo
*current_release_bo
[3];
312 int current_release_bo_offset
[3];
314 struct workqueue_struct
*gc_queue
;
315 struct work_struct gc_work
;
319 /* forward declaration for QXL_INFO_IO */
320 void qxl_io_log(struct qxl_device
*qdev
, const char *fmt
, ...);
322 extern struct drm_ioctl_desc qxl_ioctls
[];
323 extern int qxl_max_ioctl
;
325 int qxl_driver_load(struct drm_device
*dev
, unsigned long flags
);
326 int qxl_driver_unload(struct drm_device
*dev
);
328 int qxl_modeset_init(struct qxl_device
*qdev
);
329 void qxl_modeset_fini(struct qxl_device
*qdev
);
331 int qxl_bo_init(struct qxl_device
*qdev
);
332 void qxl_bo_fini(struct qxl_device
*qdev
);
334 void qxl_reinit_memslots(struct qxl_device
*qdev
);
335 int qxl_surf_evict(struct qxl_device
*qdev
);
337 struct qxl_ring
*qxl_ring_create(struct qxl_ring_header
*header
,
341 bool set_prod_notify
,
342 wait_queue_head_t
*push_event
);
343 void qxl_ring_free(struct qxl_ring
*ring
);
344 void qxl_ring_init_hdr(struct qxl_ring
*ring
);
345 int qxl_check_idle(struct qxl_ring
*ring
);
348 qxl_fb_virtual_address(struct qxl_device
*qdev
, unsigned long physical
)
350 QXL_INFO(qdev
, "not implemented (%lu)\n", physical
);
354 static inline uint64_t
355 qxl_bo_physical_address(struct qxl_device
*qdev
, struct qxl_bo
*bo
,
356 unsigned long offset
)
358 int slot_id
= bo
->type
== QXL_GEM_DOMAIN_VRAM
? qdev
->main_mem_slot
: qdev
->surfaces_mem_slot
;
359 struct qxl_memslot
*slot
= &(qdev
->mem_slots
[slot_id
]);
361 /* TODO - need to hold one of the locks to read tbo.offset */
362 return slot
->high_bits
| (bo
->tbo
.offset
+ offset
);
366 #define QXLFB_CONN_LIMIT 1
368 int qxl_fbdev_init(struct qxl_device
*qdev
);
369 void qxl_fbdev_fini(struct qxl_device
*qdev
);
370 int qxl_get_handle_for_primary_fb(struct qxl_device
*qdev
,
371 struct drm_file
*file_priv
,
373 void qxl_fbdev_set_suspend(struct qxl_device
*qdev
, int state
);
377 qxl_framebuffer_init(struct drm_device
*dev
,
378 struct qxl_framebuffer
*rfb
,
379 struct drm_mode_fb_cmd2
*mode_cmd
,
380 struct drm_gem_object
*obj
);
381 void qxl_display_read_client_monitors_config(struct qxl_device
*qdev
);
382 void qxl_send_monitors_config(struct qxl_device
*qdev
);
383 int qxl_create_monitors_object(struct qxl_device
*qdev
);
384 int qxl_destroy_monitors_object(struct qxl_device
*qdev
);
386 /* used by qxl_debugfs only */
387 void qxl_crtc_set_from_monitors_config(struct qxl_device
*qdev
);
388 void qxl_alloc_client_monitors_config(struct qxl_device
*qdev
, unsigned count
);
391 int qxl_gem_init(struct qxl_device
*qdev
);
392 void qxl_gem_fini(struct qxl_device
*qdev
);
393 int qxl_gem_object_create(struct qxl_device
*qdev
, int size
,
394 int alignment
, int initial_domain
,
395 bool discardable
, bool kernel
,
396 struct qxl_surface
*surf
,
397 struct drm_gem_object
**obj
);
398 int qxl_gem_object_pin(struct drm_gem_object
*obj
, uint32_t pin_domain
,
400 void qxl_gem_object_unpin(struct drm_gem_object
*obj
);
401 int qxl_gem_object_create_with_handle(struct qxl_device
*qdev
,
402 struct drm_file
*file_priv
,
405 struct qxl_surface
*surf
,
406 struct qxl_bo
**qobj
,
408 int qxl_gem_object_init(struct drm_gem_object
*obj
);
409 void qxl_gem_object_free(struct drm_gem_object
*gobj
);
410 int qxl_gem_object_open(struct drm_gem_object
*obj
, struct drm_file
*file_priv
);
411 void qxl_gem_object_close(struct drm_gem_object
*obj
,
412 struct drm_file
*file_priv
);
413 void qxl_bo_force_delete(struct qxl_device
*qdev
);
414 int qxl_bo_kmap(struct qxl_bo
*bo
, void **ptr
);
417 int qxl_mode_dumb_create(struct drm_file
*file_priv
,
418 struct drm_device
*dev
,
419 struct drm_mode_create_dumb
*args
);
420 int qxl_mode_dumb_destroy(struct drm_file
*file_priv
,
421 struct drm_device
*dev
,
423 int qxl_mode_dumb_mmap(struct drm_file
*filp
,
424 struct drm_device
*dev
,
425 uint32_t handle
, uint64_t *offset_p
);
429 int qxl_ttm_init(struct qxl_device
*qdev
);
430 void qxl_ttm_fini(struct qxl_device
*qdev
);
431 int qxl_mmap(struct file
*filp
, struct vm_area_struct
*vma
);
435 int qxl_image_create(struct qxl_device
*qdev
,
436 struct qxl_release
*release
,
437 struct qxl_bo
**image_bo
,
439 int x
, int y
, int width
, int height
,
440 int depth
, int stride
);
441 void qxl_update_screen(struct qxl_device
*qxl
);
443 /* qxl io operations (qxl_cmd.c) */
445 void qxl_io_create_primary(struct qxl_device
*qdev
,
448 void qxl_io_destroy_primary(struct qxl_device
*qdev
);
449 void qxl_io_memslot_add(struct qxl_device
*qdev
, uint8_t id
);
450 void qxl_io_notify_oom(struct qxl_device
*qdev
);
452 int qxl_io_update_area(struct qxl_device
*qdev
, struct qxl_bo
*surf
,
453 const struct qxl_rect
*area
);
455 void qxl_io_reset(struct qxl_device
*qdev
);
456 void qxl_io_monitors_config(struct qxl_device
*qdev
);
457 int qxl_ring_push(struct qxl_ring
*ring
, const void *new_elt
, bool interruptible
);
458 void qxl_io_flush_release(struct qxl_device
*qdev
);
459 void qxl_io_flush_surfaces(struct qxl_device
*qdev
);
461 int qxl_release_reserve(struct qxl_device
*qdev
,
462 struct qxl_release
*release
, bool no_wait
);
463 void qxl_release_unreserve(struct qxl_device
*qdev
,
464 struct qxl_release
*release
);
465 union qxl_release_info
*qxl_release_map(struct qxl_device
*qdev
,
466 struct qxl_release
*release
);
467 void qxl_release_unmap(struct qxl_device
*qdev
,
468 struct qxl_release
*release
,
469 union qxl_release_info
*info
);
471 * qxl_bo_add_resource.
474 void qxl_bo_add_resource(struct qxl_bo
*main_bo
, struct qxl_bo
*resource
);
476 int qxl_alloc_surface_release_reserved(struct qxl_device
*qdev
,
477 enum qxl_surface_cmd_type surface_cmd_type
,
478 struct qxl_release
*create_rel
,
479 struct qxl_release
**release
);
480 int qxl_alloc_release_reserved(struct qxl_device
*qdev
, unsigned long size
,
481 int type
, struct qxl_release
**release
,
482 struct qxl_bo
**rbo
);
483 int qxl_fence_releaseable(struct qxl_device
*qdev
,
484 struct qxl_release
*release
);
486 qxl_push_command_ring_release(struct qxl_device
*qdev
, struct qxl_release
*release
,
487 uint32_t type
, bool interruptible
);
489 qxl_push_cursor_ring_release(struct qxl_device
*qdev
, struct qxl_release
*release
,
490 uint32_t type
, bool interruptible
);
491 int qxl_alloc_bo_reserved(struct qxl_device
*qdev
, unsigned long size
,
492 struct qxl_bo
**_bo
);
493 /* qxl drawing commands */
495 void qxl_draw_opaque_fb(const struct qxl_fb_image
*qxl_fb_image
,
496 int stride
/* filled in if 0 */);
498 void qxl_draw_dirty_fb(struct qxl_device
*qdev
,
499 struct qxl_framebuffer
*qxl_fb
,
501 unsigned flags
, unsigned color
,
502 struct drm_clip_rect
*clips
,
503 unsigned num_clips
, int inc
);
505 void qxl_draw_fill(struct qxl_draw_fill
*qxl_draw_fill_rec
);
507 void qxl_draw_copyarea(struct qxl_device
*qdev
,
508 u32 width
, u32 height
,
513 qxl_release_alloc(struct qxl_device
*qdev
, int type
,
514 struct qxl_release
**ret
);
516 void qxl_release_free(struct qxl_device
*qdev
,
517 struct qxl_release
*release
);
518 void qxl_release_add_res(struct qxl_device
*qdev
,
519 struct qxl_release
*release
,
521 /* used by qxl_debugfs_release */
522 struct qxl_release
*qxl_release_from_id_locked(struct qxl_device
*qdev
,
525 bool qxl_queue_garbage_collect(struct qxl_device
*qdev
, bool flush
);
526 int qxl_garbage_collect(struct qxl_device
*qdev
);
530 int qxl_debugfs_init(struct drm_minor
*minor
);
531 void qxl_debugfs_takedown(struct drm_minor
*minor
);
534 int qxl_irq_init(struct qxl_device
*qdev
);
535 irqreturn_t
qxl_irq_handler(DRM_IRQ_ARGS
);
538 int qxl_fb_init(struct qxl_device
*qdev
);
539 bool qxl_fbdev_qobj_is_fb(struct qxl_device
*qdev
, struct qxl_bo
*qobj
);
541 int qxl_debugfs_add_files(struct qxl_device
*qdev
,
542 struct drm_info_list
*files
,
545 int qxl_surface_id_alloc(struct qxl_device
*qdev
,
546 struct qxl_bo
*surf
);
547 void qxl_surface_id_dealloc(struct qxl_device
*qdev
,
548 uint32_t surface_id
);
549 int qxl_hw_surface_alloc(struct qxl_device
*qdev
,
551 struct ttm_mem_reg
*mem
);
552 int qxl_hw_surface_dealloc(struct qxl_device
*qdev
,
553 struct qxl_bo
*surf
);
555 int qxl_bo_check_id(struct qxl_device
*qdev
, struct qxl_bo
*bo
);
557 struct qxl_drv_surface
*
558 qxl_surface_lookup(struct drm_device
*dev
, int surface_id
);
559 void qxl_surface_evict(struct qxl_device
*qdev
, struct qxl_bo
*surf
, bool freeing
);
560 int qxl_update_surface(struct qxl_device
*qdev
, struct qxl_bo
*surf
);
563 int qxl_fence_add_release(struct qxl_fence
*qfence
, uint32_t rel_id
);
564 int qxl_fence_remove_release(struct qxl_fence
*qfence
, uint32_t rel_id
);
565 int qxl_fence_init(struct qxl_device
*qdev
, struct qxl_fence
*qfence
);
566 void qxl_fence_fini(struct qxl_fence
*qfence
);