1 /**************************************************************************
3 * Copyright © 2009-2015 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 <drm/vmwgfx_drm.h>
34 #include <drm/drm_hashtab.h>
35 #include <linux/suspend.h>
36 #include <drm/ttm/ttm_bo_driver.h>
37 #include <drm/ttm/ttm_object.h>
38 #include <drm/ttm/ttm_lock.h>
39 #include <drm/ttm/ttm_execbuf_util.h>
40 #include <drm/ttm/ttm_module.h>
41 #include "vmwgfx_fence.h"
43 #define VMWGFX_DRIVER_DATE "20150810"
44 #define VMWGFX_DRIVER_MAJOR 2
45 #define VMWGFX_DRIVER_MINOR 9
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
53 #define VMWGFX_ENABLE_SCREEN_TARGET_OTABLE 1
56 * Perhaps we should have sysfs entries for these.
58 #define VMWGFX_NUM_GB_CONTEXT 256
59 #define VMWGFX_NUM_GB_SHADER 20000
60 #define VMWGFX_NUM_GB_SURFACE 32768
61 #define VMWGFX_NUM_GB_SCREEN_TARGET VMWGFX_MAX_DISPLAYS
62 #define VMWGFX_NUM_DXCONTEXT 256
63 #define VMWGFX_NUM_DXQUERY 512
64 #define VMWGFX_NUM_MOB (VMWGFX_NUM_GB_CONTEXT +\
65 VMWGFX_NUM_GB_SHADER +\
66 VMWGFX_NUM_GB_SURFACE +\
67 VMWGFX_NUM_GB_SCREEN_TARGET)
69 #define VMW_PL_GMR TTM_PL_PRIV0
70 #define VMW_PL_FLAG_GMR TTM_PL_FLAG_PRIV0
71 #define VMW_PL_MOB TTM_PL_PRIV1
72 #define VMW_PL_FLAG_MOB TTM_PL_FLAG_PRIV1
74 #define VMW_RES_CONTEXT ttm_driver_type0
75 #define VMW_RES_SURFACE ttm_driver_type1
76 #define VMW_RES_STREAM ttm_driver_type2
77 #define VMW_RES_FENCE ttm_driver_type3
78 #define VMW_RES_SHADER ttm_driver_type4
81 struct drm_master *locked_master;
82 struct ttm_object_file *tfile;
83 struct list_head fence_events;
87 struct vmw_dma_buffer {
88 struct ttm_buffer_object base;
89 struct list_head res_list;
91 /* Not ref-counted. Protected by binding_mutex */
92 struct vmw_resource *dx_query_ctx;
96 * struct vmw_validate_buffer - Carries validation info about buffers.
98 * @base: Validation info for TTM.
99 * @hash: Hash entry for quick lookup of the TTM buffer object.
101 * This structure contains also driver private validation info
102 * on top of the info needed by TTM.
104 struct vmw_validate_buffer {
105 struct ttm_validate_buffer base;
106 struct drm_hash_item hash;
107 bool validate_as_mob;
111 struct vmw_resource {
113 struct vmw_private *dev_priv;
116 unsigned long backup_size;
117 bool res_dirty; /* Protected by backup buffer reserved */
118 bool backup_dirty; /* Protected by backup buffer reserved */
119 struct vmw_dma_buffer *backup;
120 unsigned long backup_offset;
121 unsigned long pin_count; /* Protected by resource reserved */
122 const struct vmw_res_func *func;
123 struct list_head lru_head; /* Protected by the resource lock */
124 struct list_head mob_head; /* Protected by @backup reserved */
125 struct list_head binding_head; /* Protected by binding_mutex */
126 void (*res_free) (struct vmw_resource *res);
127 void (*hw_destroy) (struct vmw_resource *res);
132 * Resources that are managed using ioctls.
146 * Resources that are managed using command streams.
148 enum vmw_cmdbuf_res_type {
149 vmw_cmdbuf_res_shader,
153 struct vmw_cmdbuf_res_manager;
155 struct vmw_cursor_snooper {
156 struct drm_crtc *crtc;
161 struct vmw_framebuffer;
162 struct vmw_surface_offset;
165 struct vmw_resource res;
168 uint32_t mip_levels[DRM_VMW_MAX_SURFACE_FACES];
169 struct drm_vmw_size base_size;
170 struct drm_vmw_size *sizes;
174 /* TODO so far just a extra pointer */
175 struct vmw_cursor_snooper snooper;
176 struct vmw_surface_offset *offsets;
177 SVGA3dTextureFilter autogen_filter;
178 uint32_t multisample_count;
179 struct list_head view_list;
182 struct vmw_marker_queue {
183 struct list_head head;
189 struct vmw_fifo_state {
190 unsigned long reserved_size;
193 unsigned long static_buffer_size;
194 bool using_bounce_buffer;
195 uint32_t capabilities;
196 struct mutex fifo_mutex;
197 struct rw_semaphore rwsem;
198 struct vmw_marker_queue marker_queue;
202 struct vmw_relocation {
204 SVGAGuestPtr *location;
209 * struct vmw_res_cache_entry - resource information cache entry
211 * @valid: Whether the entry is valid, which also implies that the execbuf
212 * code holds a reference to the resource, and it's placed on the
214 * @handle: User-space handle of a resource.
215 * @res: Non-ref-counted pointer to the resource.
217 * Used to avoid frequent repeated user-space handle lookups of the
220 struct vmw_res_cache_entry {
223 struct vmw_resource *res;
224 struct vmw_resource_val_node *node;
228 * enum vmw_dma_map_mode - indicate how to perform TTM page dma mappings.
230 enum vmw_dma_map_mode {
231 vmw_dma_phys, /* Use physical page addresses */
232 vmw_dma_alloc_coherent, /* Use TTM coherent pages */
233 vmw_dma_map_populate, /* Unmap from DMA just after unpopulate */
234 vmw_dma_map_bind, /* Unmap from DMA just before unbind */
239 * struct vmw_sg_table - Scatter/gather table for binding, with additional
240 * device-specific information.
242 * @sgt: Pointer to a struct sg_table with binding information
243 * @num_regions: Number of regions with device-address contigous pages
245 struct vmw_sg_table {
246 enum vmw_dma_map_mode mode;
248 const dma_addr_t *addrs;
249 struct sg_table *sgt;
250 unsigned long num_regions;
251 unsigned long num_pages;
255 * struct vmw_piter - Page iterator that iterates over a list of pages
256 * and DMA addresses that could be either a scatter-gather list or
259 * @pages: Array of page pointers to the pages.
260 * @addrs: DMA addresses to the pages if coherent pages are used.
261 * @iter: Scatter-gather page iterator. Current position in SG list.
262 * @i: Current position in arrays.
263 * @num_pages: Number of pages total.
264 * @next: Function to advance the iterator. Returns false if past the list
265 * of pages, true otherwise.
266 * @dma_address: Function to return the DMA address of the current page.
270 const dma_addr_t *addrs;
271 struct sg_page_iter iter;
273 unsigned long num_pages;
274 bool (*next)(struct vmw_piter *);
275 dma_addr_t (*dma_address)(struct vmw_piter *);
276 struct page *(*page)(struct vmw_piter *);
280 * enum vmw_display_unit_type - Describes the display unit
282 enum vmw_display_unit_type {
285 vmw_du_screen_object,
290 struct vmw_sw_context{
291 struct drm_open_hash res_ht;
292 bool res_ht_initialized;
293 bool kernel; /**< is the called made from the kernel */
294 struct vmw_fpriv *fp;
295 struct list_head validate_nodes;
296 struct vmw_relocation relocs[VMWGFX_MAX_RELOCATIONS];
298 struct vmw_validate_buffer val_bufs[VMWGFX_MAX_VALIDATIONS];
299 uint32_t cur_val_buf;
300 uint32_t *cmd_bounce;
301 uint32_t cmd_bounce_size;
302 struct list_head resource_list;
303 struct list_head ctx_resource_list; /* For contexts and cotables */
304 struct vmw_dma_buffer *cur_query_bo;
305 struct list_head res_relocations;
307 struct vmw_res_cache_entry res_cache[vmw_res_max];
308 struct vmw_resource *last_query_ctx;
309 bool needs_post_query_barrier;
310 struct vmw_resource *error_resource;
311 struct vmw_ctx_binding_state *staged_bindings;
312 bool staged_bindings_inuse;
313 struct list_head staged_cmd_res;
314 struct vmw_resource_val_node *dx_ctx_node;
315 struct vmw_dma_buffer *dx_query_mob;
316 struct vmw_resource *dx_query_ctx;
317 struct vmw_cmdbuf_res_manager *man;
320 struct vmw_legacy_display;
324 struct ttm_lock lock;
327 struct vmw_vga_topology_state {
337 * struct vmw_otable - Guest Memory OBject table metadata
339 * @size: Size of the table (page-aligned).
340 * @page_table: Pointer to a struct vmw_mob holding the page table.
344 struct vmw_mob *page_table;
348 struct vmw_otable_batch {
349 unsigned num_otables;
350 struct vmw_otable *otables;
351 struct vmw_resource *context;
352 struct ttm_buffer_object *otable_bo;
356 struct ttm_bo_device bdev;
357 struct ttm_bo_global_ref bo_global_ref;
358 struct drm_global_reference mem_global_ref;
360 struct vmw_fifo_state fifo;
362 struct drm_device *dev;
363 unsigned long vmw_chipset;
364 unsigned int io_start;
367 uint32_t prim_bb_mem;
370 uint32_t fb_max_width;
371 uint32_t fb_max_height;
372 uint32_t texture_max_width;
373 uint32_t texture_max_height;
374 uint32_t stdu_max_width;
375 uint32_t stdu_max_height;
376 uint32_t initial_width;
377 uint32_t initial_height;
378 u32 __iomem *mmio_virt;
380 uint32_t capabilities;
381 uint32_t max_gmr_ids;
382 uint32_t max_gmr_pages;
383 uint32_t max_mob_pages;
384 uint32_t max_mob_size;
385 uint32_t memory_size;
396 struct vmw_vga_topology_state vga_save[VMWGFX_MAX_DISPLAYS];
401 uint32_t vga_pitchlock;
403 uint32_t num_displays;
410 enum vmw_display_unit_type active_display_unit;
411 struct vmw_legacy_display *ldu_priv;
412 struct vmw_screen_object_display *sou_priv;
413 struct vmw_overlay *overlay_priv;
416 * Context and surface management.
419 rwlock_t resource_lock;
420 struct idr res_idr[vmw_res_max];
422 * Block lastclose from racing with firstopen.
425 struct mutex init_mutex;
428 * A resource manager for kernel-only surfaces and
432 struct ttm_object_device *tdev;
439 wait_queue_head_t fence_queue;
440 wait_queue_head_t fifo_queue;
441 spinlock_t waiter_lock;
442 int fence_queue_waiters; /* Protected by waiter_lock */
443 int goal_queue_waiters; /* Protected by waiter_lock */
444 int cmdbuf_waiters; /* Protected by irq_lock */
445 int error_waiters; /* Protected by irq_lock */
446 atomic_t fifo_queue_waiters;
447 uint32_t last_read_seqno;
449 struct vmw_fence_manager *fman;
456 uint32_t traces_state;
457 uint32_t enable_state;
458 uint32_t config_done_state;
464 * Protected by the cmdbuf mutex.
467 struct vmw_sw_context ctx;
468 struct mutex cmdbuf_mutex;
469 struct mutex binding_mutex;
477 spinlock_t svga_lock;
483 struct vmw_master *active_master;
484 struct vmw_master fbdev_master;
485 struct notifier_block pm_nb;
487 bool refuse_hibernation;
489 struct mutex release_mutex;
490 atomic_t num_fifo_resources;
493 * Replace this with an rwsem as soon as we have down_xx_interruptible()
495 struct ttm_lock reservation_sem;
498 * Query processing. These members
499 * are protected by the cmdbuf mutex.
502 struct vmw_dma_buffer *dummy_query_bo;
503 struct vmw_dma_buffer *pinned_bo;
505 uint32_t query_cid_valid;
506 bool dummy_query_bo_pinned;
509 * Surface swapping. The "surface_lru" list is protected by the
510 * resource lock in order to be able to destroy a surface and take
511 * it off the lru atomically. "used_memory_size" is currently
512 * protected by the cmdbuf mutex for simplicity.
515 struct list_head res_lru[vmw_res_max];
516 uint32_t used_memory_size;
521 enum vmw_dma_map_mode map_mode;
526 struct vmw_otable_batch otable_batch;
528 struct vmw_cmdbuf_man *cman;
531 static inline struct vmw_surface *vmw_res_to_srf(struct vmw_resource *res)
533 return container_of(res, struct vmw_surface, res);
536 static inline struct vmw_private *vmw_priv(struct drm_device *dev)
538 return (struct vmw_private *)dev->dev_private;
541 static inline struct vmw_fpriv *vmw_fpriv(struct drm_file *file_priv)
543 return (struct vmw_fpriv *)file_priv->driver_priv;
546 static inline struct vmw_master *vmw_master(struct drm_master *master)
548 return (struct vmw_master *) master->driver_priv;
552 * The locking here is fine-grained, so that it is performed once
553 * for every read- and write operation. This is of course costly, but we
554 * don't perform much register access in the timing critical paths anyway.
555 * Instead we have the extra benefit of being sure that we don't forget
556 * the hw lock around register accesses.
558 static inline void vmw_write(struct vmw_private *dev_priv,
559 unsigned int offset, uint32_t value)
561 unsigned long irq_flags;
563 spin_lock_irqsave(&dev_priv->hw_lock, irq_flags);
564 outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
565 outl(value, dev_priv->io_start + VMWGFX_VALUE_PORT);
566 spin_unlock_irqrestore(&dev_priv->hw_lock, irq_flags);
569 static inline uint32_t vmw_read(struct vmw_private *dev_priv,
572 unsigned long irq_flags;
575 spin_lock_irqsave(&dev_priv->hw_lock, irq_flags);
576 outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
577 val = inl(dev_priv->io_start + VMWGFX_VALUE_PORT);
578 spin_unlock_irqrestore(&dev_priv->hw_lock, irq_flags);
583 extern void vmw_svga_enable(struct vmw_private *dev_priv);
584 extern void vmw_svga_disable(struct vmw_private *dev_priv);
588 * GMR utilities - vmwgfx_gmr.c
591 extern int vmw_gmr_bind(struct vmw_private *dev_priv,
592 const struct vmw_sg_table *vsgt,
593 unsigned long num_pages,
595 extern void vmw_gmr_unbind(struct vmw_private *dev_priv, int gmr_id);
598 * Resource utilities - vmwgfx_resource.c
600 struct vmw_user_resource_conv;
602 extern void vmw_resource_unreference(struct vmw_resource **p_res);
603 extern struct vmw_resource *vmw_resource_reference(struct vmw_resource *res);
604 extern struct vmw_resource *
605 vmw_resource_reference_unless_doomed(struct vmw_resource *res);
606 extern int vmw_resource_validate(struct vmw_resource *res);
607 extern int vmw_resource_reserve(struct vmw_resource *res, bool interruptible,
609 extern bool vmw_resource_needs_backup(const struct vmw_resource *res);
610 extern int vmw_user_lookup_handle(struct vmw_private *dev_priv,
611 struct ttm_object_file *tfile,
613 struct vmw_surface **out_surf,
614 struct vmw_dma_buffer **out_buf);
615 extern int vmw_user_resource_lookup_handle(
616 struct vmw_private *dev_priv,
617 struct ttm_object_file *tfile,
619 const struct vmw_user_resource_conv *converter,
620 struct vmw_resource **p_res);
621 extern void vmw_dmabuf_bo_free(struct ttm_buffer_object *bo);
622 extern int vmw_dmabuf_init(struct vmw_private *dev_priv,
623 struct vmw_dma_buffer *vmw_bo,
624 size_t size, struct ttm_placement *placement,
626 void (*bo_free) (struct ttm_buffer_object *bo));
627 extern int vmw_user_dmabuf_verify_access(struct ttm_buffer_object *bo,
628 struct ttm_object_file *tfile);
629 extern int vmw_user_dmabuf_alloc(struct vmw_private *dev_priv,
630 struct ttm_object_file *tfile,
634 struct vmw_dma_buffer **p_dma_buf,
635 struct ttm_base_object **p_base);
636 extern int vmw_user_dmabuf_reference(struct ttm_object_file *tfile,
637 struct vmw_dma_buffer *dma_buf,
639 extern int vmw_dmabuf_alloc_ioctl(struct drm_device *dev, void *data,
640 struct drm_file *file_priv);
641 extern int vmw_dmabuf_unref_ioctl(struct drm_device *dev, void *data,
642 struct drm_file *file_priv);
643 extern int vmw_user_dmabuf_synccpu_ioctl(struct drm_device *dev, void *data,
644 struct drm_file *file_priv);
645 extern uint32_t vmw_dmabuf_validate_node(struct ttm_buffer_object *bo,
646 uint32_t cur_validate_node);
647 extern void vmw_dmabuf_validate_clear(struct ttm_buffer_object *bo);
648 extern int vmw_user_dmabuf_lookup(struct ttm_object_file *tfile,
649 uint32_t id, struct vmw_dma_buffer **out,
650 struct ttm_base_object **base);
651 extern int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
652 struct drm_file *file_priv);
653 extern int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
654 struct drm_file *file_priv);
655 extern int vmw_user_stream_lookup(struct vmw_private *dev_priv,
656 struct ttm_object_file *tfile,
658 struct vmw_resource **out);
659 extern void vmw_resource_unreserve(struct vmw_resource *res,
661 struct vmw_dma_buffer *new_backup,
662 unsigned long new_backup_offset);
663 extern void vmw_resource_move_notify(struct ttm_buffer_object *bo,
664 struct ttm_mem_reg *mem);
665 extern void vmw_query_move_notify(struct ttm_buffer_object *bo,
666 struct ttm_mem_reg *mem);
667 extern int vmw_query_readback_all(struct vmw_dma_buffer *dx_query_mob);
668 extern void vmw_fence_single_bo(struct ttm_buffer_object *bo,
669 struct vmw_fence_obj *fence);
670 extern void vmw_resource_evict_all(struct vmw_private *dev_priv);
673 * DMA buffer helper routines - vmwgfx_dmabuf.c
675 extern int vmw_dmabuf_pin_in_placement(struct vmw_private *vmw_priv,
676 struct vmw_dma_buffer *bo,
677 struct ttm_placement *placement,
679 extern int vmw_dmabuf_pin_in_vram(struct vmw_private *dev_priv,
680 struct vmw_dma_buffer *buf,
682 extern int vmw_dmabuf_pin_in_vram_or_gmr(struct vmw_private *dev_priv,
683 struct vmw_dma_buffer *buf,
685 extern int vmw_dmabuf_pin_in_start_of_vram(struct vmw_private *vmw_priv,
686 struct vmw_dma_buffer *bo,
688 extern int vmw_dmabuf_unpin(struct vmw_private *vmw_priv,
689 struct vmw_dma_buffer *bo,
691 extern void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *buf,
693 extern void vmw_bo_pin_reserved(struct vmw_dma_buffer *bo, bool pin);
696 * Misc Ioctl functionality - vmwgfx_ioctl.c
699 extern int vmw_getparam_ioctl(struct drm_device *dev, void *data,
700 struct drm_file *file_priv);
701 extern int vmw_get_cap_3d_ioctl(struct drm_device *dev, void *data,
702 struct drm_file *file_priv);
703 extern int vmw_present_ioctl(struct drm_device *dev, void *data,
704 struct drm_file *file_priv);
705 extern int vmw_present_readback_ioctl(struct drm_device *dev, void *data,
706 struct drm_file *file_priv);
707 extern unsigned int vmw_fops_poll(struct file *filp,
708 struct poll_table_struct *wait);
709 extern ssize_t vmw_fops_read(struct file *filp, char __user *buffer,
710 size_t count, loff_t *offset);
713 * Fifo utilities - vmwgfx_fifo.c
716 extern int vmw_fifo_init(struct vmw_private *dev_priv,
717 struct vmw_fifo_state *fifo);
718 extern void vmw_fifo_release(struct vmw_private *dev_priv,
719 struct vmw_fifo_state *fifo);
720 extern void *vmw_fifo_reserve(struct vmw_private *dev_priv, uint32_t bytes);
722 vmw_fifo_reserve_dx(struct vmw_private *dev_priv, uint32_t bytes, int ctx_id);
723 extern void vmw_fifo_commit(struct vmw_private *dev_priv, uint32_t bytes);
724 extern void vmw_fifo_commit_flush(struct vmw_private *dev_priv, uint32_t bytes);
725 extern int vmw_fifo_send_fence(struct vmw_private *dev_priv,
727 extern void vmw_fifo_ping_host_locked(struct vmw_private *, uint32_t reason);
728 extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
729 extern bool vmw_fifo_have_3d(struct vmw_private *dev_priv);
730 extern bool vmw_fifo_have_pitchlock(struct vmw_private *dev_priv);
731 extern int vmw_fifo_emit_dummy_query(struct vmw_private *dev_priv,
733 extern int vmw_fifo_flush(struct vmw_private *dev_priv,
737 * TTM glue - vmwgfx_ttm_glue.c
740 extern int vmw_ttm_global_init(struct vmw_private *dev_priv);
741 extern void vmw_ttm_global_release(struct vmw_private *dev_priv);
742 extern int vmw_mmap(struct file *filp, struct vm_area_struct *vma);
745 * TTM buffer object driver - vmwgfx_buffer.c
748 extern const size_t vmw_tt_size;
749 extern struct ttm_placement vmw_vram_placement;
750 extern struct ttm_placement vmw_vram_ne_placement;
751 extern struct ttm_placement vmw_vram_sys_placement;
752 extern struct ttm_placement vmw_vram_gmr_placement;
753 extern struct ttm_placement vmw_vram_gmr_ne_placement;
754 extern struct ttm_placement vmw_sys_placement;
755 extern struct ttm_placement vmw_sys_ne_placement;
756 extern struct ttm_placement vmw_evictable_placement;
757 extern struct ttm_placement vmw_srf_placement;
758 extern struct ttm_placement vmw_mob_placement;
759 extern struct ttm_placement vmw_mob_ne_placement;
760 extern struct ttm_bo_driver vmw_bo_driver;
761 extern int vmw_dma_quiescent(struct drm_device *dev);
762 extern int vmw_bo_map_dma(struct ttm_buffer_object *bo);
763 extern void vmw_bo_unmap_dma(struct ttm_buffer_object *bo);
764 extern const struct vmw_sg_table *
765 vmw_bo_sg_table(struct ttm_buffer_object *bo);
766 extern void vmw_piter_start(struct vmw_piter *viter,
767 const struct vmw_sg_table *vsgt,
768 unsigned long p_offs);
771 * vmw_piter_next - Advance the iterator one page.
773 * @viter: Pointer to the iterator to advance.
775 * Returns false if past the list of pages, true otherwise.
777 static inline bool vmw_piter_next(struct vmw_piter *viter)
779 return viter->next(viter);
783 * vmw_piter_dma_addr - Return the DMA address of the current page.
785 * @viter: Pointer to the iterator
787 * Returns the DMA address of the page pointed to by @viter.
789 static inline dma_addr_t vmw_piter_dma_addr(struct vmw_piter *viter)
791 return viter->dma_address(viter);
795 * vmw_piter_page - Return a pointer to the current page.
797 * @viter: Pointer to the iterator
799 * Returns the DMA address of the page pointed to by @viter.
801 static inline struct page *vmw_piter_page(struct vmw_piter *viter)
803 return viter->page(viter);
807 * Command submission - vmwgfx_execbuf.c
810 extern int vmw_execbuf_ioctl(struct drm_device *dev, unsigned long data,
811 struct drm_file *file_priv, size_t size);
812 extern int vmw_execbuf_process(struct drm_file *file_priv,
813 struct vmw_private *dev_priv,
814 void __user *user_commands,
815 void *kernel_commands,
816 uint32_t command_size,
817 uint64_t throttle_us,
818 uint32_t dx_context_handle,
819 struct drm_vmw_fence_rep __user
821 struct vmw_fence_obj **out_fence);
822 extern void __vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv,
823 struct vmw_fence_obj *fence);
824 extern void vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv);
826 extern int vmw_execbuf_fence_commands(struct drm_file *file_priv,
827 struct vmw_private *dev_priv,
828 struct vmw_fence_obj **p_fence,
830 extern void vmw_execbuf_copy_fence_user(struct vmw_private *dev_priv,
831 struct vmw_fpriv *vmw_fp,
833 struct drm_vmw_fence_rep __user
835 struct vmw_fence_obj *fence,
836 uint32_t fence_handle);
837 extern int vmw_validate_single_buffer(struct vmw_private *dev_priv,
838 struct ttm_buffer_object *bo,
840 bool validate_as_mob);
844 * IRQs and wating - vmwgfx_irq.c
847 extern irqreturn_t vmw_irq_handler(int irq, void *arg);
848 extern int vmw_wait_seqno(struct vmw_private *dev_priv, bool lazy,
849 uint32_t seqno, bool interruptible,
850 unsigned long timeout);
851 extern void vmw_irq_preinstall(struct drm_device *dev);
852 extern int vmw_irq_postinstall(struct drm_device *dev);
853 extern void vmw_irq_uninstall(struct drm_device *dev);
854 extern bool vmw_seqno_passed(struct vmw_private *dev_priv,
856 extern int vmw_fallback_wait(struct vmw_private *dev_priv,
861 unsigned long timeout);
862 extern void vmw_update_seqno(struct vmw_private *dev_priv,
863 struct vmw_fifo_state *fifo_state);
864 extern void vmw_seqno_waiter_add(struct vmw_private *dev_priv);
865 extern void vmw_seqno_waiter_remove(struct vmw_private *dev_priv);
866 extern void vmw_goal_waiter_add(struct vmw_private *dev_priv);
867 extern void vmw_goal_waiter_remove(struct vmw_private *dev_priv);
868 extern void vmw_generic_waiter_add(struct vmw_private *dev_priv, u32 flag,
870 extern void vmw_generic_waiter_remove(struct vmw_private *dev_priv,
871 u32 flag, int *waiter_count);
874 * Rudimentary fence-like objects currently used only for throttling -
878 extern void vmw_marker_queue_init(struct vmw_marker_queue *queue);
879 extern void vmw_marker_queue_takedown(struct vmw_marker_queue *queue);
880 extern int vmw_marker_push(struct vmw_marker_queue *queue,
882 extern int vmw_marker_pull(struct vmw_marker_queue *queue,
883 uint32_t signaled_seqno);
884 extern int vmw_wait_lag(struct vmw_private *dev_priv,
885 struct vmw_marker_queue *queue, uint32_t us);
888 * Kernel framebuffer - vmwgfx_fb.c
891 int vmw_fb_init(struct vmw_private *vmw_priv);
892 int vmw_fb_close(struct vmw_private *dev_priv);
893 int vmw_fb_off(struct vmw_private *vmw_priv);
894 int vmw_fb_on(struct vmw_private *vmw_priv);
897 * Kernel modesetting - vmwgfx_kms.c
900 int vmw_kms_init(struct vmw_private *dev_priv);
901 int vmw_kms_close(struct vmw_private *dev_priv);
902 int vmw_kms_save_vga(struct vmw_private *vmw_priv);
903 int vmw_kms_restore_vga(struct vmw_private *vmw_priv);
904 int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
905 struct drm_file *file_priv);
906 void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv);
907 void vmw_kms_cursor_snoop(struct vmw_surface *srf,
908 struct ttm_object_file *tfile,
909 struct ttm_buffer_object *bo,
910 SVGA3dCmdHeader *header);
911 int vmw_kms_write_svga(struct vmw_private *vmw_priv,
912 unsigned width, unsigned height, unsigned pitch,
913 unsigned bpp, unsigned depth);
914 void vmw_kms_idle_workqueues(struct vmw_master *vmaster);
915 bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
918 u32 vmw_get_vblank_counter(struct drm_device *dev, int crtc);
919 int vmw_enable_vblank(struct drm_device *dev, int crtc);
920 void vmw_disable_vblank(struct drm_device *dev, int crtc);
921 int vmw_kms_present(struct vmw_private *dev_priv,
922 struct drm_file *file_priv,
923 struct vmw_framebuffer *vfb,
924 struct vmw_surface *surface,
925 uint32_t sid, int32_t destX, int32_t destY,
926 struct drm_vmw_rect *clips,
928 int vmw_kms_update_layout_ioctl(struct drm_device *dev, void *data,
929 struct drm_file *file_priv);
931 int vmw_dumb_create(struct drm_file *file_priv,
932 struct drm_device *dev,
933 struct drm_mode_create_dumb *args);
935 int vmw_dumb_map_offset(struct drm_file *file_priv,
936 struct drm_device *dev, uint32_t handle,
938 int vmw_dumb_destroy(struct drm_file *file_priv,
939 struct drm_device *dev,
941 extern int vmw_resource_pin(struct vmw_resource *res, bool interruptible);
942 extern void vmw_resource_unpin(struct vmw_resource *res);
943 extern enum vmw_res_type vmw_res_type(const struct vmw_resource *res);
946 * Overlay control - vmwgfx_overlay.c
949 int vmw_overlay_init(struct vmw_private *dev_priv);
950 int vmw_overlay_close(struct vmw_private *dev_priv);
951 int vmw_overlay_ioctl(struct drm_device *dev, void *data,
952 struct drm_file *file_priv);
953 int vmw_overlay_stop_all(struct vmw_private *dev_priv);
954 int vmw_overlay_resume_all(struct vmw_private *dev_priv);
955 int vmw_overlay_pause_all(struct vmw_private *dev_priv);
956 int vmw_overlay_claim(struct vmw_private *dev_priv, uint32_t *out);
957 int vmw_overlay_unref(struct vmw_private *dev_priv, uint32_t stream_id);
958 int vmw_overlay_num_overlays(struct vmw_private *dev_priv);
959 int vmw_overlay_num_free_overlays(struct vmw_private *dev_priv);
965 extern const struct ttm_mem_type_manager_func vmw_gmrid_manager_func;
968 * Prime - vmwgfx_prime.c
971 extern const struct dma_buf_ops vmw_prime_dmabuf_ops;
972 extern int vmw_prime_fd_to_handle(struct drm_device *dev,
973 struct drm_file *file_priv,
974 int fd, u32 *handle);
975 extern int vmw_prime_handle_to_fd(struct drm_device *dev,
976 struct drm_file *file_priv,
977 uint32_t handle, uint32_t flags,
981 * MemoryOBject management - vmwgfx_mob.c
984 extern int vmw_mob_bind(struct vmw_private *dev_priv, struct vmw_mob *mob,
985 const struct vmw_sg_table *vsgt,
986 unsigned long num_data_pages, int32_t mob_id);
987 extern void vmw_mob_unbind(struct vmw_private *dev_priv,
988 struct vmw_mob *mob);
989 extern void vmw_mob_destroy(struct vmw_mob *mob);
990 extern struct vmw_mob *vmw_mob_create(unsigned long data_pages);
991 extern int vmw_otables_setup(struct vmw_private *dev_priv);
992 extern void vmw_otables_takedown(struct vmw_private *dev_priv);
995 * Context management - vmwgfx_context.c
998 extern const struct vmw_user_resource_conv *user_context_converter;
1000 extern int vmw_context_check(struct vmw_private *dev_priv,
1001 struct ttm_object_file *tfile,
1003 struct vmw_resource **p_res);
1004 extern int vmw_context_define_ioctl(struct drm_device *dev, void *data,
1005 struct drm_file *file_priv);
1006 extern int vmw_extended_context_define_ioctl(struct drm_device *dev, void *data,
1007 struct drm_file *file_priv);
1008 extern int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
1009 struct drm_file *file_priv);
1010 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1011 extern struct vmw_cmdbuf_res_manager *
1012 vmw_context_res_man(struct vmw_resource *ctx);
1013 extern struct vmw_resource *vmw_context_cotable(struct vmw_resource *ctx,
1014 SVGACOTableType cotable_type);
1015 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1016 struct vmw_ctx_binding_state;
1017 extern struct vmw_ctx_binding_state *
1018 vmw_context_binding_state(struct vmw_resource *ctx);
1019 extern void vmw_dx_context_scrub_cotables(struct vmw_resource *ctx,
1021 extern int vmw_context_bind_dx_query(struct vmw_resource *ctx_res,
1022 struct vmw_dma_buffer *mob);
1023 extern struct vmw_dma_buffer *
1024 vmw_context_get_dx_query_mob(struct vmw_resource *ctx_res);
1028 * Surface management - vmwgfx_surface.c
1031 extern const struct vmw_user_resource_conv *user_surface_converter;
1033 extern void vmw_surface_res_free(struct vmw_resource *res);
1034 extern int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
1035 struct drm_file *file_priv);
1036 extern int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
1037 struct drm_file *file_priv);
1038 extern int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
1039 struct drm_file *file_priv);
1040 extern int vmw_gb_surface_define_ioctl(struct drm_device *dev, void *data,
1041 struct drm_file *file_priv);
1042 extern int vmw_gb_surface_reference_ioctl(struct drm_device *dev, void *data,
1043 struct drm_file *file_priv);
1044 extern int vmw_surface_check(struct vmw_private *dev_priv,
1045 struct ttm_object_file *tfile,
1046 uint32_t handle, int *id);
1047 extern int vmw_surface_validate(struct vmw_private *dev_priv,
1048 struct vmw_surface *srf);
1049 int vmw_surface_gb_priv_define(struct drm_device *dev,
1050 uint32_t user_accounting_size,
1051 uint32_t svga3d_flags,
1052 SVGA3dSurfaceFormat format,
1054 uint32_t num_mip_levels,
1055 uint32_t multisample_count,
1056 uint32_t array_size,
1057 struct drm_vmw_size size,
1058 struct vmw_surface **srf_out);
1061 * Shader management - vmwgfx_shader.c
1064 extern const struct vmw_user_resource_conv *user_shader_converter;
1066 extern int vmw_shader_define_ioctl(struct drm_device *dev, void *data,
1067 struct drm_file *file_priv);
1068 extern int vmw_shader_destroy_ioctl(struct drm_device *dev, void *data,
1069 struct drm_file *file_priv);
1070 extern int vmw_compat_shader_add(struct vmw_private *dev_priv,
1071 struct vmw_cmdbuf_res_manager *man,
1072 u32 user_key, const void *bytecode,
1073 SVGA3dShaderType shader_type,
1075 struct list_head *list);
1076 extern int vmw_shader_remove(struct vmw_cmdbuf_res_manager *man,
1077 u32 user_key, SVGA3dShaderType shader_type,
1078 struct list_head *list);
1079 extern int vmw_dx_shader_add(struct vmw_cmdbuf_res_manager *man,
1080 struct vmw_resource *ctx,
1082 SVGA3dShaderType shader_type,
1083 struct list_head *list);
1084 extern void vmw_dx_shader_cotable_list_scrub(struct vmw_private *dev_priv,
1085 struct list_head *list,
1088 extern struct vmw_resource *
1089 vmw_shader_lookup(struct vmw_cmdbuf_res_manager *man,
1090 u32 user_key, SVGA3dShaderType shader_type);
1093 * Command buffer managed resources - vmwgfx_cmdbuf_res.c
1096 extern struct vmw_cmdbuf_res_manager *
1097 vmw_cmdbuf_res_man_create(struct vmw_private *dev_priv);
1098 extern void vmw_cmdbuf_res_man_destroy(struct vmw_cmdbuf_res_manager *man);
1099 extern size_t vmw_cmdbuf_res_man_size(void);
1100 extern struct vmw_resource *
1101 vmw_cmdbuf_res_lookup(struct vmw_cmdbuf_res_manager *man,
1102 enum vmw_cmdbuf_res_type res_type,
1104 extern void vmw_cmdbuf_res_revert(struct list_head *list);
1105 extern void vmw_cmdbuf_res_commit(struct list_head *list);
1106 extern int vmw_cmdbuf_res_add(struct vmw_cmdbuf_res_manager *man,
1107 enum vmw_cmdbuf_res_type res_type,
1109 struct vmw_resource *res,
1110 struct list_head *list);
1111 extern int vmw_cmdbuf_res_remove(struct vmw_cmdbuf_res_manager *man,
1112 enum vmw_cmdbuf_res_type res_type,
1114 struct list_head *list,
1115 struct vmw_resource **res);
1118 * COTable management - vmwgfx_cotable.c
1120 extern const SVGACOTableType vmw_cotable_scrub_order[];
1121 extern struct vmw_resource *vmw_cotable_alloc(struct vmw_private *dev_priv,
1122 struct vmw_resource *ctx,
1124 extern int vmw_cotable_notify(struct vmw_resource *res, int id);
1125 extern int vmw_cotable_scrub(struct vmw_resource *res, bool readback);
1126 extern void vmw_cotable_add_resource(struct vmw_resource *ctx,
1127 struct list_head *head);
1130 * Command buffer managerment vmwgfx_cmdbuf.c
1132 struct vmw_cmdbuf_man;
1133 struct vmw_cmdbuf_header;
1135 extern struct vmw_cmdbuf_man *
1136 vmw_cmdbuf_man_create(struct vmw_private *dev_priv);
1137 extern int vmw_cmdbuf_set_pool_size(struct vmw_cmdbuf_man *man,
1138 size_t size, size_t default_size);
1139 extern void vmw_cmdbuf_remove_pool(struct vmw_cmdbuf_man *man);
1140 extern void vmw_cmdbuf_man_destroy(struct vmw_cmdbuf_man *man);
1141 extern int vmw_cmdbuf_idle(struct vmw_cmdbuf_man *man, bool interruptible,
1142 unsigned long timeout);
1143 extern void *vmw_cmdbuf_reserve(struct vmw_cmdbuf_man *man, size_t size,
1144 int ctx_id, bool interruptible,
1145 struct vmw_cmdbuf_header *header);
1146 extern void vmw_cmdbuf_commit(struct vmw_cmdbuf_man *man, size_t size,
1147 struct vmw_cmdbuf_header *header,
1149 extern void vmw_cmdbuf_tasklet_schedule(struct vmw_cmdbuf_man *man);
1150 extern void *vmw_cmdbuf_alloc(struct vmw_cmdbuf_man *man,
1151 size_t size, bool interruptible,
1152 struct vmw_cmdbuf_header **p_header);
1153 extern void vmw_cmdbuf_header_free(struct vmw_cmdbuf_header *header);
1154 extern int vmw_cmdbuf_cur_flush(struct vmw_cmdbuf_man *man,
1155 bool interruptible);
1159 * Inline helper functions
1162 static inline void vmw_surface_unreference(struct vmw_surface **srf)
1164 struct vmw_surface *tmp_srf = *srf;
1165 struct vmw_resource *res = &tmp_srf->res;
1168 vmw_resource_unreference(&res);
1171 static inline struct vmw_surface *vmw_surface_reference(struct vmw_surface *srf)
1173 (void) vmw_resource_reference(&srf->res);
1177 static inline void vmw_dmabuf_unreference(struct vmw_dma_buffer **buf)
1179 struct vmw_dma_buffer *tmp_buf = *buf;
1182 if (tmp_buf != NULL) {
1183 struct ttm_buffer_object *bo = &tmp_buf->base;
1189 static inline struct vmw_dma_buffer *vmw_dmabuf_reference(struct vmw_dma_buffer *buf)
1191 if (ttm_bo_reference(&buf->base))
1196 static inline struct ttm_mem_global *vmw_mem_glob(struct vmw_private *dev_priv)
1198 return (struct ttm_mem_global *) dev_priv->mem_global_ref.object;
1201 static inline void vmw_fifo_resource_inc(struct vmw_private *dev_priv)
1203 atomic_inc(&dev_priv->num_fifo_resources);
1206 static inline void vmw_fifo_resource_dec(struct vmw_private *dev_priv)
1208 atomic_dec(&dev_priv->num_fifo_resources);