1 /**************************************************************************
3 * Copyright © 2009 VMware, Inc., Palo Alto, CA., USA
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
24 * USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
28 #ifndef _VMWGFX_DRV_H_
29 #define _VMWGFX_DRV_H_
31 #include "vmwgfx_reg.h"
33 #include "vmwgfx_drm.h"
34 #include "drm_hashtab.h"
35 #include "linux/suspend.h"
36 #include "ttm/ttm_bo_driver.h"
37 #include "ttm/ttm_object.h"
38 #include "ttm/ttm_lock.h"
39 #include "ttm/ttm_execbuf_util.h"
40 #include "ttm/ttm_module.h"
41 #include "vmwgfx_fence.h"
43 #define VMWGFX_DRIVER_DATE "20110927"
44 #define VMWGFX_DRIVER_MAJOR 2
45 #define VMWGFX_DRIVER_MINOR 1
46 #define VMWGFX_DRIVER_PATCHLEVEL 0
47 #define VMWGFX_FILE_PAGE_OFFSET 0x00100000
48 #define VMWGFX_FIFO_STATIC_SIZE (1024*1024)
49 #define VMWGFX_MAX_RELOCATIONS 2048
50 #define VMWGFX_MAX_VALIDATIONS 2048
51 #define VMWGFX_MAX_DISPLAYS 16
52 #define VMWGFX_CMD_BOUNCE_INIT_SIZE 32768
54 #define VMW_PL_GMR TTM_PL_PRIV0
55 #define VMW_PL_FLAG_GMR TTM_PL_FLAG_PRIV0
57 #define VMW_RES_CONTEXT ttm_driver_type0
58 #define VMW_RES_SURFACE ttm_driver_type1
59 #define VMW_RES_STREAM ttm_driver_type2
60 #define VMW_RES_FENCE ttm_driver_type3
63 struct drm_master
*locked_master
;
64 struct ttm_object_file
*tfile
;
67 struct vmw_dma_buffer
{
68 struct ttm_buffer_object base
;
69 struct list_head validate_list
;
71 uint32_t cur_validate_node
;
72 bool on_validate_list
;
77 struct vmw_private
*dev_priv
;
80 enum ttm_object_type res_type
;
82 void (*remove_from_lists
) (struct vmw_resource
*res
);
83 void (*hw_destroy
) (struct vmw_resource
*res
);
84 void (*res_free
) (struct vmw_resource
*res
);
85 struct list_head validate_head
;
86 struct list_head query_head
; /* Protected by the cmdbuf mutex */
87 /* TODO is a generic snooper needed? */
89 void (*snoop
)(struct vmw_resource
*res
,
90 struct ttm_object_file
*tfile
,
91 SVGA3dCmdHeader
*header
);
96 struct vmw_cursor_snooper
{
97 struct drm_crtc
*crtc
;
102 struct vmw_framebuffer
;
103 struct vmw_surface_offset
;
106 struct vmw_resource res
;
107 struct list_head lru_head
; /* Protected by the resource lock */
110 uint32_t mip_levels
[DRM_VMW_MAX_SURFACE_FACES
];
111 struct drm_vmw_size
*sizes
;
116 /* TODO so far just a extra pointer */
117 struct vmw_cursor_snooper snooper
;
118 struct ttm_buffer_object
*backup
;
119 struct vmw_surface_offset
*offsets
;
120 uint32_t backup_size
;
123 struct vmw_marker_queue
{
124 struct list_head head
;
126 struct timespec lag_time
;
130 struct vmw_fifo_state
{
131 unsigned long reserved_size
;
132 __le32
*dynamic_buffer
;
133 __le32
*static_buffer
;
134 unsigned long static_buffer_size
;
135 bool using_bounce_buffer
;
136 uint32_t capabilities
;
137 struct mutex fifo_mutex
;
138 struct rw_semaphore rwsem
;
139 struct vmw_marker_queue marker_queue
;
142 struct vmw_relocation
{
143 SVGAGuestPtr
*location
;
147 struct vmw_sw_context
{
151 bool kernel
; /**< is the called made from the kernel */
152 struct vmw_resource
*cur_ctx
;
154 uint32_t sid_translation
;
156 struct ttm_object_file
*tfile
;
157 struct list_head validate_nodes
;
158 struct vmw_relocation relocs
[VMWGFX_MAX_RELOCATIONS
];
160 struct ttm_validate_buffer val_bufs
[VMWGFX_MAX_VALIDATIONS
];
161 uint32_t cur_val_buf
;
162 uint32_t *cmd_bounce
;
163 uint32_t cmd_bounce_size
;
164 struct list_head resource_list
;
165 uint32_t fence_flags
;
166 struct list_head query_list
;
167 struct ttm_buffer_object
*cur_query_bo
;
168 uint32_t cur_query_cid
;
169 bool query_cid_valid
;
172 struct vmw_legacy_display
;
176 struct ttm_lock lock
;
177 struct mutex fb_surf_mutex
;
178 struct list_head fb_surf
;
181 struct vmw_vga_topology_state
{
190 struct ttm_bo_device bdev
;
191 struct ttm_bo_global_ref bo_global_ref
;
192 struct drm_global_reference mem_global_ref
;
194 struct vmw_fifo_state fifo
;
196 struct drm_device
*dev
;
197 unsigned long vmw_chipset
;
198 unsigned int io_start
;
203 uint32_t fb_max_width
;
204 uint32_t fb_max_height
;
205 __le32 __iomem
*mmio_virt
;
207 uint32_t capabilities
;
208 uint32_t max_gmr_descriptors
;
209 uint32_t max_gmr_ids
;
210 uint32_t max_gmr_pages
;
211 uint32_t memory_size
;
213 struct mutex hw_mutex
;
219 struct vmw_vga_topology_state vga_save
[VMWGFX_MAX_DISPLAYS
];
224 uint32_t vga_pitchlock
;
226 uint32_t num_displays
;
233 struct vmw_legacy_display
*ldu_priv
;
234 struct vmw_screen_object_display
*sou_priv
;
235 struct vmw_overlay
*overlay_priv
;
238 * Context and surface management.
241 rwlock_t resource_lock
;
242 struct idr context_idr
;
243 struct idr surface_idr
;
244 struct idr stream_idr
;
247 * Block lastclose from racing with firstopen.
250 struct mutex init_mutex
;
253 * A resource manager for kernel-only surfaces and
257 struct ttm_object_device
*tdev
;
264 wait_queue_head_t fence_queue
;
265 wait_queue_head_t fifo_queue
;
266 int fence_queue_waiters
; /* Protected by hw_mutex */
267 atomic_t fifo_queue_waiters
;
268 uint32_t last_read_seqno
;
270 struct vmw_fence_manager
*fman
;
276 uint32_t traces_state
;
277 uint32_t enable_state
;
278 uint32_t config_done_state
;
284 * Protected by the cmdbuf mutex.
287 struct vmw_sw_context ctx
;
288 struct mutex cmdbuf_mutex
;
302 struct vmw_master
*active_master
;
303 struct vmw_master fbdev_master
;
304 struct notifier_block pm_nb
;
307 struct mutex release_mutex
;
308 uint32_t num_3d_resources
;
311 * Query processing. These members
312 * are protected by the cmdbuf mutex.
315 struct ttm_buffer_object
*dummy_query_bo
;
316 struct ttm_buffer_object
*pinned_bo
;
318 bool dummy_query_bo_pinned
;
321 * Surface swapping. The "surface_lru" list is protected by the
322 * resource lock in order to be able to destroy a surface and take
323 * it off the lru atomically. "used_memory_size" is currently
324 * protected by the cmdbuf mutex for simplicity.
327 struct list_head surface_lru
;
328 uint32_t used_memory_size
;
331 static inline struct vmw_private
*vmw_priv(struct drm_device
*dev
)
333 return (struct vmw_private
*)dev
->dev_private
;
336 static inline struct vmw_fpriv
*vmw_fpriv(struct drm_file
*file_priv
)
338 return (struct vmw_fpriv
*)file_priv
->driver_priv
;
341 static inline struct vmw_master
*vmw_master(struct drm_master
*master
)
343 return (struct vmw_master
*) master
->driver_priv
;
346 static inline void vmw_write(struct vmw_private
*dev_priv
,
347 unsigned int offset
, uint32_t value
)
349 outl(offset
, dev_priv
->io_start
+ VMWGFX_INDEX_PORT
);
350 outl(value
, dev_priv
->io_start
+ VMWGFX_VALUE_PORT
);
353 static inline uint32_t vmw_read(struct vmw_private
*dev_priv
,
358 outl(offset
, dev_priv
->io_start
+ VMWGFX_INDEX_PORT
);
359 val
= inl(dev_priv
->io_start
+ VMWGFX_VALUE_PORT
);
363 int vmw_3d_resource_inc(struct vmw_private
*dev_priv
, bool unhide_svga
);
364 void vmw_3d_resource_dec(struct vmw_private
*dev_priv
, bool hide_svga
);
367 * GMR utilities - vmwgfx_gmr.c
370 extern int vmw_gmr_bind(struct vmw_private
*dev_priv
,
371 struct page
*pages
[],
372 unsigned long num_pages
,
374 extern void vmw_gmr_unbind(struct vmw_private
*dev_priv
, int gmr_id
);
377 * Resource utilities - vmwgfx_resource.c
380 extern struct vmw_resource
*vmw_context_alloc(struct vmw_private
*dev_priv
);
381 extern void vmw_resource_unreference(struct vmw_resource
**p_res
);
382 extern struct vmw_resource
*vmw_resource_reference(struct vmw_resource
*res
);
383 extern int vmw_context_destroy_ioctl(struct drm_device
*dev
, void *data
,
384 struct drm_file
*file_priv
);
385 extern int vmw_context_define_ioctl(struct drm_device
*dev
, void *data
,
386 struct drm_file
*file_priv
);
387 extern int vmw_context_check(struct vmw_private
*dev_priv
,
388 struct ttm_object_file
*tfile
,
390 struct vmw_resource
**p_res
);
391 extern void vmw_surface_res_free(struct vmw_resource
*res
);
392 extern int vmw_surface_init(struct vmw_private
*dev_priv
,
393 struct vmw_surface
*srf
,
394 void (*res_free
) (struct vmw_resource
*res
));
395 extern int vmw_user_surface_lookup_handle(struct vmw_private
*dev_priv
,
396 struct ttm_object_file
*tfile
,
398 struct vmw_surface
**out
);
399 extern int vmw_surface_destroy_ioctl(struct drm_device
*dev
, void *data
,
400 struct drm_file
*file_priv
);
401 extern int vmw_surface_define_ioctl(struct drm_device
*dev
, void *data
,
402 struct drm_file
*file_priv
);
403 extern int vmw_surface_reference_ioctl(struct drm_device
*dev
, void *data
,
404 struct drm_file
*file_priv
);
405 extern int vmw_surface_check(struct vmw_private
*dev_priv
,
406 struct ttm_object_file
*tfile
,
407 uint32_t handle
, int *id
);
408 extern int vmw_surface_validate(struct vmw_private
*dev_priv
,
409 struct vmw_surface
*srf
);
410 extern void vmw_dmabuf_bo_free(struct ttm_buffer_object
*bo
);
411 extern int vmw_dmabuf_init(struct vmw_private
*dev_priv
,
412 struct vmw_dma_buffer
*vmw_bo
,
413 size_t size
, struct ttm_placement
*placement
,
415 void (*bo_free
) (struct ttm_buffer_object
*bo
));
416 extern int vmw_dmabuf_alloc_ioctl(struct drm_device
*dev
, void *data
,
417 struct drm_file
*file_priv
);
418 extern int vmw_dmabuf_unref_ioctl(struct drm_device
*dev
, void *data
,
419 struct drm_file
*file_priv
);
420 extern uint32_t vmw_dmabuf_validate_node(struct ttm_buffer_object
*bo
,
421 uint32_t cur_validate_node
);
422 extern void vmw_dmabuf_validate_clear(struct ttm_buffer_object
*bo
);
423 extern int vmw_user_dmabuf_lookup(struct ttm_object_file
*tfile
,
424 uint32_t id
, struct vmw_dma_buffer
**out
);
425 extern int vmw_stream_claim_ioctl(struct drm_device
*dev
, void *data
,
426 struct drm_file
*file_priv
);
427 extern int vmw_stream_unref_ioctl(struct drm_device
*dev
, void *data
,
428 struct drm_file
*file_priv
);
429 extern int vmw_user_stream_lookup(struct vmw_private
*dev_priv
,
430 struct ttm_object_file
*tfile
,
432 struct vmw_resource
**out
);
433 extern void vmw_resource_unreserve(struct list_head
*list
);
436 * DMA buffer helper routines - vmwgfx_dmabuf.c
438 extern int vmw_dmabuf_to_placement(struct vmw_private
*vmw_priv
,
439 struct vmw_dma_buffer
*bo
,
440 struct ttm_placement
*placement
,
442 extern int vmw_dmabuf_to_vram(struct vmw_private
*dev_priv
,
443 struct vmw_dma_buffer
*buf
,
444 bool pin
, bool interruptible
);
445 extern int vmw_dmabuf_to_vram_or_gmr(struct vmw_private
*dev_priv
,
446 struct vmw_dma_buffer
*buf
,
447 bool pin
, bool interruptible
);
448 extern int vmw_dmabuf_to_start_of_vram(struct vmw_private
*vmw_priv
,
449 struct vmw_dma_buffer
*bo
,
450 bool pin
, bool interruptible
);
451 extern int vmw_dmabuf_unpin(struct vmw_private
*vmw_priv
,
452 struct vmw_dma_buffer
*bo
,
454 extern void vmw_bo_get_guest_ptr(const struct ttm_buffer_object
*buf
,
456 extern void vmw_bo_pin(struct ttm_buffer_object
*bo
, bool pin
);
459 * Misc Ioctl functionality - vmwgfx_ioctl.c
462 extern int vmw_getparam_ioctl(struct drm_device
*dev
, void *data
,
463 struct drm_file
*file_priv
);
464 extern int vmw_get_cap_3d_ioctl(struct drm_device
*dev
, void *data
,
465 struct drm_file
*file_priv
);
466 extern int vmw_present_ioctl(struct drm_device
*dev
, void *data
,
467 struct drm_file
*file_priv
);
468 extern int vmw_present_readback_ioctl(struct drm_device
*dev
, void *data
,
469 struct drm_file
*file_priv
);
472 * Fifo utilities - vmwgfx_fifo.c
475 extern int vmw_fifo_init(struct vmw_private
*dev_priv
,
476 struct vmw_fifo_state
*fifo
);
477 extern void vmw_fifo_release(struct vmw_private
*dev_priv
,
478 struct vmw_fifo_state
*fifo
);
479 extern void *vmw_fifo_reserve(struct vmw_private
*dev_priv
, uint32_t bytes
);
480 extern void vmw_fifo_commit(struct vmw_private
*dev_priv
, uint32_t bytes
);
481 extern int vmw_fifo_send_fence(struct vmw_private
*dev_priv
,
483 extern void vmw_fifo_ping_host(struct vmw_private
*dev_priv
, uint32_t reason
);
484 extern bool vmw_fifo_have_3d(struct vmw_private
*dev_priv
);
485 extern bool vmw_fifo_have_pitchlock(struct vmw_private
*dev_priv
);
486 extern int vmw_fifo_emit_dummy_query(struct vmw_private
*dev_priv
,
490 * TTM glue - vmwgfx_ttm_glue.c
493 extern int vmw_ttm_global_init(struct vmw_private
*dev_priv
);
494 extern void vmw_ttm_global_release(struct vmw_private
*dev_priv
);
495 extern int vmw_mmap(struct file
*filp
, struct vm_area_struct
*vma
);
498 * TTM buffer object driver - vmwgfx_buffer.c
501 extern struct ttm_placement vmw_vram_placement
;
502 extern struct ttm_placement vmw_vram_ne_placement
;
503 extern struct ttm_placement vmw_vram_sys_placement
;
504 extern struct ttm_placement vmw_vram_gmr_placement
;
505 extern struct ttm_placement vmw_vram_gmr_ne_placement
;
506 extern struct ttm_placement vmw_sys_placement
;
507 extern struct ttm_placement vmw_evictable_placement
;
508 extern struct ttm_placement vmw_srf_placement
;
509 extern struct ttm_bo_driver vmw_bo_driver
;
510 extern int vmw_dma_quiescent(struct drm_device
*dev
);
513 * Command submission - vmwgfx_execbuf.c
516 extern int vmw_execbuf_ioctl(struct drm_device
*dev
, void *data
,
517 struct drm_file
*file_priv
);
518 extern int vmw_execbuf_process(struct drm_file
*file_priv
,
519 struct vmw_private
*dev_priv
,
520 void __user
*user_commands
,
521 void *kernel_commands
,
522 uint32_t command_size
,
523 uint64_t throttle_us
,
524 struct drm_vmw_fence_rep __user
528 vmw_execbuf_release_pinned_bo(struct vmw_private
*dev_priv
,
529 bool only_on_cid_match
, uint32_t cid
);
531 extern int vmw_execbuf_fence_commands(struct drm_file
*file_priv
,
532 struct vmw_private
*dev_priv
,
533 struct vmw_fence_obj
**p_fence
,
538 * IRQs and wating - vmwgfx_irq.c
541 extern irqreturn_t
vmw_irq_handler(DRM_IRQ_ARGS
);
542 extern int vmw_wait_seqno(struct vmw_private
*dev_priv
, bool lazy
,
543 uint32_t seqno
, bool interruptible
,
544 unsigned long timeout
);
545 extern void vmw_irq_preinstall(struct drm_device
*dev
);
546 extern int vmw_irq_postinstall(struct drm_device
*dev
);
547 extern void vmw_irq_uninstall(struct drm_device
*dev
);
548 extern bool vmw_seqno_passed(struct vmw_private
*dev_priv
,
550 extern int vmw_fallback_wait(struct vmw_private
*dev_priv
,
555 unsigned long timeout
);
556 extern void vmw_update_seqno(struct vmw_private
*dev_priv
,
557 struct vmw_fifo_state
*fifo_state
);
558 extern void vmw_seqno_waiter_add(struct vmw_private
*dev_priv
);
559 extern void vmw_seqno_waiter_remove(struct vmw_private
*dev_priv
);
562 * Rudimentary fence-like objects currently used only for throttling -
566 extern void vmw_marker_queue_init(struct vmw_marker_queue
*queue
);
567 extern void vmw_marker_queue_takedown(struct vmw_marker_queue
*queue
);
568 extern int vmw_marker_push(struct vmw_marker_queue
*queue
,
570 extern int vmw_marker_pull(struct vmw_marker_queue
*queue
,
571 uint32_t signaled_seqno
);
572 extern int vmw_wait_lag(struct vmw_private
*dev_priv
,
573 struct vmw_marker_queue
*queue
, uint32_t us
);
576 * Kernel framebuffer - vmwgfx_fb.c
579 int vmw_fb_init(struct vmw_private
*vmw_priv
);
580 int vmw_fb_close(struct vmw_private
*dev_priv
);
581 int vmw_fb_off(struct vmw_private
*vmw_priv
);
582 int vmw_fb_on(struct vmw_private
*vmw_priv
);
585 * Kernel modesetting - vmwgfx_kms.c
588 int vmw_kms_init(struct vmw_private
*dev_priv
);
589 int vmw_kms_close(struct vmw_private
*dev_priv
);
590 int vmw_kms_save_vga(struct vmw_private
*vmw_priv
);
591 int vmw_kms_restore_vga(struct vmw_private
*vmw_priv
);
592 int vmw_kms_cursor_bypass_ioctl(struct drm_device
*dev
, void *data
,
593 struct drm_file
*file_priv
);
594 void vmw_kms_cursor_post_execbuf(struct vmw_private
*dev_priv
);
595 void vmw_kms_cursor_snoop(struct vmw_surface
*srf
,
596 struct ttm_object_file
*tfile
,
597 struct ttm_buffer_object
*bo
,
598 SVGA3dCmdHeader
*header
);
599 int vmw_kms_write_svga(struct vmw_private
*vmw_priv
,
600 unsigned width
, unsigned height
, unsigned pitch
,
601 unsigned bpp
, unsigned depth
);
602 void vmw_kms_idle_workqueues(struct vmw_master
*vmaster
);
603 bool vmw_kms_validate_mode_vram(struct vmw_private
*dev_priv
,
606 u32
vmw_get_vblank_counter(struct drm_device
*dev
, int crtc
);
607 int vmw_kms_present(struct vmw_private
*dev_priv
,
608 struct drm_file
*file_priv
,
609 struct vmw_framebuffer
*vfb
,
610 struct vmw_surface
*surface
,
611 uint32_t sid
, int32_t destX
, int32_t destY
,
612 struct drm_vmw_rect
*clips
,
614 int vmw_kms_readback(struct vmw_private
*dev_priv
,
615 struct drm_file
*file_priv
,
616 struct vmw_framebuffer
*vfb
,
617 struct drm_vmw_fence_rep __user
*user_fence_rep
,
618 struct drm_vmw_rect
*clips
,
622 * Overlay control - vmwgfx_overlay.c
625 int vmw_overlay_init(struct vmw_private
*dev_priv
);
626 int vmw_overlay_close(struct vmw_private
*dev_priv
);
627 int vmw_overlay_ioctl(struct drm_device
*dev
, void *data
,
628 struct drm_file
*file_priv
);
629 int vmw_overlay_stop_all(struct vmw_private
*dev_priv
);
630 int vmw_overlay_resume_all(struct vmw_private
*dev_priv
);
631 int vmw_overlay_pause_all(struct vmw_private
*dev_priv
);
632 int vmw_overlay_claim(struct vmw_private
*dev_priv
, uint32_t *out
);
633 int vmw_overlay_unref(struct vmw_private
*dev_priv
, uint32_t stream_id
);
634 int vmw_overlay_num_overlays(struct vmw_private
*dev_priv
);
635 int vmw_overlay_num_free_overlays(struct vmw_private
*dev_priv
);
641 extern const struct ttm_mem_type_manager_func vmw_gmrid_manager_func
;
644 * Inline helper functions
647 static inline void vmw_surface_unreference(struct vmw_surface
**srf
)
649 struct vmw_surface
*tmp_srf
= *srf
;
650 struct vmw_resource
*res
= &tmp_srf
->res
;
653 vmw_resource_unreference(&res
);
656 static inline struct vmw_surface
*vmw_surface_reference(struct vmw_surface
*srf
)
658 (void) vmw_resource_reference(&srf
->res
);
662 static inline void vmw_dmabuf_unreference(struct vmw_dma_buffer
**buf
)
664 struct vmw_dma_buffer
*tmp_buf
= *buf
;
665 struct ttm_buffer_object
*bo
= &tmp_buf
->base
;
671 static inline struct vmw_dma_buffer
*vmw_dmabuf_reference(struct vmw_dma_buffer
*buf
)
673 if (ttm_bo_reference(&buf
->base
))
678 static inline struct ttm_mem_global
*vmw_mem_glob(struct vmw_private
*dev_priv
)
680 return (struct ttm_mem_global
*) dev_priv
->mem_global_ref
.object
;