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_NUM_OUTPUTS 1
60 #define QXL_DEBUGFS_MAX_COMPONENTS 32
62 extern int qxl_log_level
;
69 #define QXL_INFO(qdev, fmt, ...) do { \
70 if (qxl_log_level >= QXL_INFO_LEVEL) { \
71 qxl_io_log(qdev, fmt, __VA_ARGS__); \
74 #define QXL_DEBUG(qdev, fmt, ...) do { \
75 if (qxl_log_level >= QXL_DEBUG_LEVEL) { \
76 qxl_io_log(qdev, fmt, __VA_ARGS__); \
79 #define QXL_INFO_ONCE(qdev, fmt, ...) do { \
83 QXL_INFO(qdev, fmt, __VA_ARGS__); \
87 #define DRM_FILE_OFFSET 0x100000000ULL
88 #define DRM_FILE_PAGE_OFFSET (DRM_FILE_OFFSET >> PAGE_SHIFT)
90 #define QXL_INTERRUPT_MASK (\
91 QXL_INTERRUPT_DISPLAY |\
92 QXL_INTERRUPT_CURSOR |\
93 QXL_INTERRUPT_IO_CMD |\
94 QXL_INTERRUPT_CLIENT_MONITORS_CONFIG)
97 struct qxl_device
*qdev
;
98 uint32_t num_active_releases
;
99 uint32_t *release_ids
;
100 struct radix_tree_root tree
;
104 /* Protected by gem.mutex */
105 struct list_head list
;
106 /* Protected by tbo.reserved */
108 struct ttm_placement placement
;
109 struct ttm_buffer_object tbo
;
110 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_fence fence
; /* per bo fence - list of releases */
121 struct qxl_release
*surf_create
;
122 atomic_t reserve_count
;
124 #define gem_to_qxl_bo(gobj) container_of((gobj), struct qxl_bo, gem_base)
128 struct list_head objects
;
132 struct list_head lhead
;
136 struct qxl_reloc_list
{
137 struct list_head bos
;
141 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, base)
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
;
259 * last created framebuffer with fb_create
260 * only used by debugfs dumbppm
262 struct qxl_framebuffer
*active_user_framebuffer
;
264 struct fb_info
*fbdev_info
;
265 struct qxl_framebuffer
*fbdev_qfb
;
268 struct qxl_ring
*release_ring
;
269 struct qxl_ring
*command_ring
;
270 struct qxl_ring
*cursor_ring
;
272 struct qxl_ram_header
*ram_header
;
275 bool primary_created
;
277 struct qxl_memslot
*mem_slots
;
280 uint8_t main_mem_slot
;
281 uint8_t surfaces_mem_slot
;
282 uint8_t slot_id_bits
;
283 uint8_t slot_gen_bits
;
284 uint64_t va_slot_mask
;
286 struct idr release_idr
;
287 spinlock_t release_idr_lock
;
288 struct mutex async_io_mutex
;
289 unsigned int last_sent_io_cmd
;
291 /* interrupt handling */
292 atomic_t irq_received
;
293 atomic_t irq_received_display
;
294 atomic_t irq_received_cursor
;
295 atomic_t irq_received_io_cmd
;
296 unsigned irq_received_error
;
297 wait_queue_head_t display_event
;
298 wait_queue_head_t cursor_event
;
299 wait_queue_head_t io_cmd_event
;
300 struct work_struct client_monitors_config_work
;
303 struct qxl_debugfs debugfs
[QXL_DEBUGFS_MAX_COMPONENTS
];
304 unsigned debugfs_count
;
306 struct mutex update_area_mutex
;
308 struct idr surf_id_idr
;
309 spinlock_t surf_id_idr_lock
;
310 int last_alloced_surf_id
;
312 struct mutex surf_evict_mutex
;
313 struct io_mapping
*vram_mapping
;
314 struct io_mapping
*surface_mapping
;
317 struct mutex release_mutex
;
318 struct qxl_bo
*current_release_bo
[3];
319 int current_release_bo_offset
[3];
321 struct workqueue_struct
*gc_queue
;
322 struct work_struct gc_work
;
326 /* forward declaration for QXL_INFO_IO */
327 void qxl_io_log(struct qxl_device
*qdev
, const char *fmt
, ...);
329 extern struct drm_ioctl_desc qxl_ioctls
[];
330 extern int qxl_max_ioctl
;
332 int qxl_driver_load(struct drm_device
*dev
, unsigned long flags
);
333 int qxl_driver_unload(struct drm_device
*dev
);
335 int qxl_modeset_init(struct qxl_device
*qdev
);
336 void qxl_modeset_fini(struct qxl_device
*qdev
);
338 int qxl_bo_init(struct qxl_device
*qdev
);
339 void qxl_bo_fini(struct qxl_device
*qdev
);
341 struct qxl_ring
*qxl_ring_create(struct qxl_ring_header
*header
,
345 bool set_prod_notify
,
346 wait_queue_head_t
*push_event
);
347 void qxl_ring_free(struct qxl_ring
*ring
);
350 qxl_fb_virtual_address(struct qxl_device
*qdev
, unsigned long physical
)
352 QXL_INFO(qdev
, "not implemented (%lu)\n", physical
);
356 static inline uint64_t
357 qxl_bo_physical_address(struct qxl_device
*qdev
, struct qxl_bo
*bo
,
358 unsigned long offset
)
360 int slot_id
= bo
->type
== QXL_GEM_DOMAIN_VRAM
? qdev
->main_mem_slot
: qdev
->surfaces_mem_slot
;
361 struct qxl_memslot
*slot
= &(qdev
->mem_slots
[slot_id
]);
363 /* TODO - need to hold one of the locks to read tbo.offset */
364 return slot
->high_bits
| (bo
->tbo
.offset
+ offset
);
368 #define QXLFB_CONN_LIMIT 1
370 int qxl_fbdev_init(struct qxl_device
*qdev
);
371 void qxl_fbdev_fini(struct qxl_device
*qdev
);
372 int qxl_get_handle_for_primary_fb(struct qxl_device
*qdev
,
373 struct drm_file
*file_priv
,
378 qxl_framebuffer_init(struct drm_device
*dev
,
379 struct qxl_framebuffer
*rfb
,
380 struct drm_mode_fb_cmd2
*mode_cmd
,
381 struct drm_gem_object
*obj
);
382 void qxl_display_read_client_monitors_config(struct qxl_device
*qdev
);
383 void qxl_send_monitors_config(struct qxl_device
*qdev
);
385 /* used by qxl_debugfs only */
386 void qxl_crtc_set_from_monitors_config(struct qxl_device
*qdev
);
387 void qxl_alloc_client_monitors_config(struct qxl_device
*qdev
, unsigned count
);
390 int qxl_gem_init(struct qxl_device
*qdev
);
391 void qxl_gem_fini(struct qxl_device
*qdev
);
392 int qxl_gem_object_create(struct qxl_device
*qdev
, int size
,
393 int alignment
, int initial_domain
,
394 bool discardable
, bool kernel
,
395 struct qxl_surface
*surf
,
396 struct drm_gem_object
**obj
);
397 int qxl_gem_object_pin(struct drm_gem_object
*obj
, uint32_t pin_domain
,
399 void qxl_gem_object_unpin(struct drm_gem_object
*obj
);
400 int qxl_gem_object_create_with_handle(struct qxl_device
*qdev
,
401 struct drm_file
*file_priv
,
404 struct qxl_surface
*surf
,
405 struct qxl_bo
**qobj
,
407 int qxl_gem_object_init(struct drm_gem_object
*obj
);
408 void qxl_gem_object_free(struct drm_gem_object
*gobj
);
409 int qxl_gem_object_open(struct drm_gem_object
*obj
, struct drm_file
*file_priv
);
410 void qxl_gem_object_close(struct drm_gem_object
*obj
,
411 struct drm_file
*file_priv
);
412 void qxl_bo_force_delete(struct qxl_device
*qdev
);
413 int qxl_bo_kmap(struct qxl_bo
*bo
, void **ptr
);
416 int qxl_mode_dumb_create(struct drm_file
*file_priv
,
417 struct drm_device
*dev
,
418 struct drm_mode_create_dumb
*args
);
419 int qxl_mode_dumb_destroy(struct drm_file
*file_priv
,
420 struct drm_device
*dev
,
422 int qxl_mode_dumb_mmap(struct drm_file
*filp
,
423 struct drm_device
*dev
,
424 uint32_t handle
, uint64_t *offset_p
);
428 int qxl_ttm_init(struct qxl_device
*qdev
);
429 void qxl_ttm_fini(struct qxl_device
*qdev
);
430 int qxl_mmap(struct file
*filp
, struct vm_area_struct
*vma
);
434 int qxl_image_create(struct qxl_device
*qdev
,
435 struct qxl_release
*release
,
436 struct qxl_bo
**image_bo
,
438 int x
, int y
, int width
, int height
,
439 int depth
, int stride
);
440 void qxl_update_screen(struct qxl_device
*qxl
);
442 /* qxl io operations (qxl_cmd.c) */
444 void qxl_io_create_primary(struct qxl_device
*qdev
,
445 unsigned width
, unsigned height
, unsigned offset
,
447 void qxl_io_destroy_primary(struct qxl_device
*qdev
);
448 void qxl_io_memslot_add(struct qxl_device
*qdev
, uint8_t id
);
449 void qxl_io_notify_oom(struct qxl_device
*qdev
);
451 int qxl_io_update_area(struct qxl_device
*qdev
, struct qxl_bo
*surf
,
452 const struct qxl_rect
*area
);
454 void qxl_io_reset(struct qxl_device
*qdev
);
455 void qxl_io_monitors_config(struct qxl_device
*qdev
);
456 int qxl_ring_push(struct qxl_ring
*ring
, const void *new_elt
, bool interruptible
);
457 void qxl_io_flush_release(struct qxl_device
*qdev
);
458 void qxl_io_flush_surfaces(struct qxl_device
*qdev
);
460 int qxl_release_reserve(struct qxl_device
*qdev
,
461 struct qxl_release
*release
, bool no_wait
);
462 void qxl_release_unreserve(struct qxl_device
*qdev
,
463 struct qxl_release
*release
);
464 union qxl_release_info
*qxl_release_map(struct qxl_device
*qdev
,
465 struct qxl_release
*release
);
466 void qxl_release_unmap(struct qxl_device
*qdev
,
467 struct qxl_release
*release
,
468 union qxl_release_info
*info
);
470 * qxl_bo_add_resource.
473 void qxl_bo_add_resource(struct qxl_bo
*main_bo
, struct qxl_bo
*resource
);
475 int qxl_alloc_surface_release_reserved(struct qxl_device
*qdev
,
476 enum qxl_surface_cmd_type surface_cmd_type
,
477 struct qxl_release
*create_rel
,
478 struct qxl_release
**release
);
479 int qxl_alloc_release_reserved(struct qxl_device
*qdev
, unsigned long size
,
480 int type
, struct qxl_release
**release
,
481 struct qxl_bo
**rbo
);
482 int qxl_fence_releaseable(struct qxl_device
*qdev
,
483 struct qxl_release
*release
);
485 qxl_push_command_ring_release(struct qxl_device
*qdev
, struct qxl_release
*release
,
486 uint32_t type
, bool interruptible
);
488 qxl_push_cursor_ring_release(struct qxl_device
*qdev
, struct qxl_release
*release
,
489 uint32_t type
, bool interruptible
);
490 int qxl_alloc_bo_reserved(struct qxl_device
*qdev
, unsigned long size
,
491 struct qxl_bo
**_bo
);
492 /* qxl drawing commands */
494 void qxl_draw_opaque_fb(const struct qxl_fb_image
*qxl_fb_image
,
495 int stride
/* filled in if 0 */);
497 void qxl_draw_dirty_fb(struct qxl_device
*qdev
,
498 struct qxl_framebuffer
*qxl_fb
,
500 unsigned flags
, unsigned color
,
501 struct drm_clip_rect
*clips
,
502 unsigned num_clips
, int inc
);
504 void qxl_draw_fill(struct qxl_draw_fill
*qxl_draw_fill_rec
);
506 void qxl_draw_copyarea(struct qxl_device
*qdev
,
507 u32 width
, u32 height
,
512 qxl_release_alloc(struct qxl_device
*qdev
, int type
,
513 struct qxl_release
**ret
);
515 void qxl_release_free(struct qxl_device
*qdev
,
516 struct qxl_release
*release
);
517 void qxl_release_add_res(struct qxl_device
*qdev
,
518 struct qxl_release
*release
,
520 /* used by qxl_debugfs_release */
521 struct qxl_release
*qxl_release_from_id_locked(struct qxl_device
*qdev
,
524 bool qxl_queue_garbage_collect(struct qxl_device
*qdev
, bool flush
);
525 int qxl_garbage_collect(struct qxl_device
*qdev
);
529 int qxl_debugfs_init(struct drm_minor
*minor
);
530 void qxl_debugfs_takedown(struct drm_minor
*minor
);
533 int qxl_irq_init(struct qxl_device
*qdev
);
534 irqreturn_t
qxl_irq_handler(DRM_IRQ_ARGS
);
537 int qxl_fb_init(struct qxl_device
*qdev
);
539 int qxl_debugfs_add_files(struct qxl_device
*qdev
,
540 struct drm_info_list
*files
,
543 int qxl_surface_id_alloc(struct qxl_device
*qdev
,
544 struct qxl_bo
*surf
);
545 void qxl_surface_id_dealloc(struct qxl_device
*qdev
,
546 uint32_t surface_id
);
547 int qxl_hw_surface_alloc(struct qxl_device
*qdev
,
549 struct ttm_mem_reg
*mem
);
550 int qxl_hw_surface_dealloc(struct qxl_device
*qdev
,
551 struct qxl_bo
*surf
);
553 int qxl_bo_check_id(struct qxl_device
*qdev
, struct qxl_bo
*bo
);
555 struct qxl_drv_surface
*
556 qxl_surface_lookup(struct drm_device
*dev
, int surface_id
);
557 void qxl_surface_evict(struct qxl_device
*qdev
, struct qxl_bo
*surf
, bool freeing
);
558 int qxl_update_surface(struct qxl_device
*qdev
, struct qxl_bo
*surf
);
561 int qxl_fence_add_release(struct qxl_fence
*qfence
, uint32_t rel_id
);
562 int qxl_fence_remove_release(struct qxl_fence
*qfence
, uint32_t rel_id
);
563 int qxl_fence_init(struct qxl_device
*qdev
, struct qxl_fence
*qfence
);
564 void qxl_fence_fini(struct qxl_fence
*qfence
);