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;
86 struct vmw_dma_buffer {
87 struct ttm_buffer_object base;
88 struct list_head res_list;
90 /* Not ref-counted. Protected by binding_mutex */
91 struct vmw_resource *dx_query_ctx;
95 * struct vmw_validate_buffer - Carries validation info about buffers.
97 * @base: Validation info for TTM.
98 * @hash: Hash entry for quick lookup of the TTM buffer object.
100 * This structure contains also driver private validation info
101 * on top of the info needed by TTM.
103 struct vmw_validate_buffer {
104 struct ttm_validate_buffer base;
105 struct drm_hash_item hash;
106 bool validate_as_mob;
110 struct vmw_resource {
112 struct vmw_private *dev_priv;
115 unsigned long backup_size;
116 bool res_dirty; /* Protected by backup buffer reserved */
117 bool backup_dirty; /* Protected by backup buffer reserved */
118 struct vmw_dma_buffer *backup;
119 unsigned long backup_offset;
120 unsigned long pin_count; /* Protected by resource reserved */
121 const struct vmw_res_func *func;
122 struct list_head lru_head; /* Protected by the resource lock */
123 struct list_head mob_head; /* Protected by @backup reserved */
124 struct list_head binding_head; /* Protected by binding_mutex */
125 void (*res_free) (struct vmw_resource *res);
126 void (*hw_destroy) (struct vmw_resource *res);
131 * Resources that are managed using ioctls.
145 * Resources that are managed using command streams.
147 enum vmw_cmdbuf_res_type {
148 vmw_cmdbuf_res_shader,
152 struct vmw_cmdbuf_res_manager;
154 struct vmw_cursor_snooper {
155 struct drm_crtc *crtc;
160 struct vmw_framebuffer;
161 struct vmw_surface_offset;
164 struct vmw_resource res;
167 uint32_t mip_levels[DRM_VMW_MAX_SURFACE_FACES];
168 struct drm_vmw_size base_size;
169 struct drm_vmw_size *sizes;
173 /* TODO so far just a extra pointer */
174 struct vmw_cursor_snooper snooper;
175 struct vmw_surface_offset *offsets;
176 SVGA3dTextureFilter autogen_filter;
177 uint32_t multisample_count;
178 struct list_head view_list;
181 struct vmw_marker_queue {
182 struct list_head head;
188 struct vmw_fifo_state {
189 unsigned long reserved_size;
192 unsigned long static_buffer_size;
193 bool using_bounce_buffer;
194 uint32_t capabilities;
195 struct mutex fifo_mutex;
196 struct rw_semaphore rwsem;
197 struct vmw_marker_queue marker_queue;
201 struct vmw_relocation {
203 SVGAGuestPtr *location;
208 * struct vmw_res_cache_entry - resource information cache entry
210 * @valid: Whether the entry is valid, which also implies that the execbuf
211 * code holds a reference to the resource, and it's placed on the
213 * @handle: User-space handle of a resource.
214 * @res: Non-ref-counted pointer to the resource.
216 * Used to avoid frequent repeated user-space handle lookups of the
219 struct vmw_res_cache_entry {
222 struct vmw_resource *res;
223 struct vmw_resource_val_node *node;
227 * enum vmw_dma_map_mode - indicate how to perform TTM page dma mappings.
229 enum vmw_dma_map_mode {
230 vmw_dma_phys, /* Use physical page addresses */
231 vmw_dma_alloc_coherent, /* Use TTM coherent pages */
232 vmw_dma_map_populate, /* Unmap from DMA just after unpopulate */
233 vmw_dma_map_bind, /* Unmap from DMA just before unbind */
238 * struct vmw_sg_table - Scatter/gather table for binding, with additional
239 * device-specific information.
241 * @sgt: Pointer to a struct sg_table with binding information
242 * @num_regions: Number of regions with device-address contiguous pages
244 struct vmw_sg_table {
245 enum vmw_dma_map_mode mode;
247 const dma_addr_t *addrs;
248 struct sg_table *sgt;
249 unsigned long num_regions;
250 unsigned long num_pages;
254 * struct vmw_piter - Page iterator that iterates over a list of pages
255 * and DMA addresses that could be either a scatter-gather list or
258 * @pages: Array of page pointers to the pages.
259 * @addrs: DMA addresses to the pages if coherent pages are used.
260 * @iter: Scatter-gather page iterator. Current position in SG list.
261 * @i: Current position in arrays.
262 * @num_pages: Number of pages total.
263 * @next: Function to advance the iterator. Returns false if past the list
264 * of pages, true otherwise.
265 * @dma_address: Function to return the DMA address of the current page.
269 const dma_addr_t *addrs;
270 struct sg_page_iter iter;
272 unsigned long num_pages;
273 bool (*next)(struct vmw_piter *);
274 dma_addr_t (*dma_address)(struct vmw_piter *);
275 struct page *(*page)(struct vmw_piter *);
279 * enum vmw_display_unit_type - Describes the display unit
281 enum vmw_display_unit_type {
284 vmw_du_screen_object,
289 struct vmw_sw_context{
290 struct drm_open_hash res_ht;
291 bool res_ht_initialized;
292 bool kernel; /**< is the called made from the kernel */
293 struct vmw_fpriv *fp;
294 struct list_head validate_nodes;
295 struct vmw_relocation relocs[VMWGFX_MAX_RELOCATIONS];
297 struct vmw_validate_buffer val_bufs[VMWGFX_MAX_VALIDATIONS];
298 uint32_t cur_val_buf;
299 uint32_t *cmd_bounce;
300 uint32_t cmd_bounce_size;
301 struct list_head resource_list;
302 struct list_head ctx_resource_list; /* For contexts and cotables */
303 struct vmw_dma_buffer *cur_query_bo;
304 struct list_head res_relocations;
306 struct vmw_res_cache_entry res_cache[vmw_res_max];
307 struct vmw_resource *last_query_ctx;
308 bool needs_post_query_barrier;
309 struct vmw_resource *error_resource;
310 struct vmw_ctx_binding_state *staged_bindings;
311 bool staged_bindings_inuse;
312 struct list_head staged_cmd_res;
313 struct vmw_resource_val_node *dx_ctx_node;
314 struct vmw_dma_buffer *dx_query_mob;
315 struct vmw_resource *dx_query_ctx;
316 struct vmw_cmdbuf_res_manager *man;
319 struct vmw_legacy_display;
323 struct ttm_lock lock;
326 struct vmw_vga_topology_state {
336 * struct vmw_otable - Guest Memory OBject table metadata
338 * @size: Size of the table (page-aligned).
339 * @page_table: Pointer to a struct vmw_mob holding the page table.
343 struct vmw_mob *page_table;
347 struct vmw_otable_batch {
348 unsigned num_otables;
349 struct vmw_otable *otables;
350 struct vmw_resource *context;
351 struct ttm_buffer_object *otable_bo;
355 struct ttm_bo_device bdev;
356 struct ttm_bo_global_ref bo_global_ref;
357 struct drm_global_reference mem_global_ref;
359 struct vmw_fifo_state fifo;
361 struct drm_device *dev;
362 unsigned long vmw_chipset;
363 unsigned int io_start;
366 uint32_t prim_bb_mem;
369 uint32_t fb_max_width;
370 uint32_t fb_max_height;
371 uint32_t texture_max_width;
372 uint32_t texture_max_height;
373 uint32_t stdu_max_width;
374 uint32_t stdu_max_height;
375 uint32_t initial_width;
376 uint32_t initial_height;
378 uint32_t capabilities;
379 uint32_t max_gmr_ids;
380 uint32_t max_gmr_pages;
381 uint32_t max_mob_pages;
382 uint32_t max_mob_size;
383 uint32_t memory_size;
394 struct vmw_vga_topology_state vga_save[VMWGFX_MAX_DISPLAYS];
399 uint32_t vga_pitchlock;
401 uint32_t num_displays;
408 enum vmw_display_unit_type active_display_unit;
409 struct vmw_legacy_display *ldu_priv;
410 struct vmw_screen_object_display *sou_priv;
411 struct vmw_overlay *overlay_priv;
414 * Context and surface management.
417 rwlock_t resource_lock;
418 struct idr res_idr[vmw_res_max];
420 * Block lastclose from racing with firstopen.
423 struct mutex init_mutex;
426 * A resource manager for kernel-only surfaces and
430 struct ttm_object_device *tdev;
437 wait_queue_head_t fence_queue;
438 wait_queue_head_t fifo_queue;
439 spinlock_t waiter_lock;
440 int fence_queue_waiters; /* Protected by waiter_lock */
441 int goal_queue_waiters; /* Protected by waiter_lock */
442 int cmdbuf_waiters; /* Protected by waiter_lock */
443 int error_waiters; /* Protected by waiter_lock */
444 int fifo_queue_waiters; /* Protected by waiter_lock */
445 uint32_t last_read_seqno;
446 struct vmw_fence_manager *fman;
447 uint32_t irq_mask; /* Updates protected by waiter_lock */
453 uint32_t traces_state;
454 uint32_t enable_state;
455 uint32_t config_done_state;
461 * Protected by the cmdbuf mutex.
464 struct vmw_sw_context ctx;
465 struct mutex cmdbuf_mutex;
466 struct mutex binding_mutex;
474 spinlock_t svga_lock;
480 struct vmw_master *active_master;
481 struct vmw_master fbdev_master;
482 struct notifier_block pm_nb;
484 bool refuse_hibernation;
486 struct mutex release_mutex;
487 atomic_t num_fifo_resources;
490 * Replace this with an rwsem as soon as we have down_xx_interruptible()
492 struct ttm_lock reservation_sem;
495 * Query processing. These members
496 * are protected by the cmdbuf mutex.
499 struct vmw_dma_buffer *dummy_query_bo;
500 struct vmw_dma_buffer *pinned_bo;
502 uint32_t query_cid_valid;
503 bool dummy_query_bo_pinned;
506 * Surface swapping. The "surface_lru" list is protected by the
507 * resource lock in order to be able to destroy a surface and take
508 * it off the lru atomically. "used_memory_size" is currently
509 * protected by the cmdbuf mutex for simplicity.
512 struct list_head res_lru[vmw_res_max];
513 uint32_t used_memory_size;
518 enum vmw_dma_map_mode map_mode;
523 struct vmw_otable_batch otable_batch;
525 struct vmw_cmdbuf_man *cman;
528 static inline struct vmw_surface *vmw_res_to_srf(struct vmw_resource *res)
530 return container_of(res, struct vmw_surface, res);
533 static inline struct vmw_private *vmw_priv(struct drm_device *dev)
535 return (struct vmw_private *)dev->dev_private;
538 static inline struct vmw_fpriv *vmw_fpriv(struct drm_file *file_priv)
540 return (struct vmw_fpriv *)file_priv->driver_priv;
543 static inline struct vmw_master *vmw_master(struct drm_master *master)
545 return (struct vmw_master *) master->driver_priv;
549 * The locking here is fine-grained, so that it is performed once
550 * for every read- and write operation. This is of course costly, but we
551 * don't perform much register access in the timing critical paths anyway.
552 * Instead we have the extra benefit of being sure that we don't forget
553 * the hw lock around register accesses.
555 static inline void vmw_write(struct vmw_private *dev_priv,
556 unsigned int offset, uint32_t value)
558 unsigned long irq_flags;
560 spin_lock_irqsave(&dev_priv->hw_lock, irq_flags);
561 outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
562 outl(value, dev_priv->io_start + VMWGFX_VALUE_PORT);
563 spin_unlock_irqrestore(&dev_priv->hw_lock, irq_flags);
566 static inline uint32_t vmw_read(struct vmw_private *dev_priv,
569 unsigned long irq_flags;
572 spin_lock_irqsave(&dev_priv->hw_lock, irq_flags);
573 outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
574 val = inl(dev_priv->io_start + VMWGFX_VALUE_PORT);
575 spin_unlock_irqrestore(&dev_priv->hw_lock, irq_flags);
580 extern void vmw_svga_enable(struct vmw_private *dev_priv);
581 extern void vmw_svga_disable(struct vmw_private *dev_priv);
585 * GMR utilities - vmwgfx_gmr.c
588 extern int vmw_gmr_bind(struct vmw_private *dev_priv,
589 const struct vmw_sg_table *vsgt,
590 unsigned long num_pages,
592 extern void vmw_gmr_unbind(struct vmw_private *dev_priv, int gmr_id);
595 * Resource utilities - vmwgfx_resource.c
597 struct vmw_user_resource_conv;
599 extern void vmw_resource_unreference(struct vmw_resource **p_res);
600 extern struct vmw_resource *vmw_resource_reference(struct vmw_resource *res);
601 extern struct vmw_resource *
602 vmw_resource_reference_unless_doomed(struct vmw_resource *res);
603 extern int vmw_resource_validate(struct vmw_resource *res);
604 extern int vmw_resource_reserve(struct vmw_resource *res, bool interruptible,
606 extern bool vmw_resource_needs_backup(const struct vmw_resource *res);
607 extern int vmw_user_lookup_handle(struct vmw_private *dev_priv,
608 struct ttm_object_file *tfile,
610 struct vmw_surface **out_surf,
611 struct vmw_dma_buffer **out_buf);
612 extern int vmw_user_resource_lookup_handle(
613 struct vmw_private *dev_priv,
614 struct ttm_object_file *tfile,
616 const struct vmw_user_resource_conv *converter,
617 struct vmw_resource **p_res);
618 extern void vmw_dmabuf_bo_free(struct ttm_buffer_object *bo);
619 extern int vmw_dmabuf_init(struct vmw_private *dev_priv,
620 struct vmw_dma_buffer *vmw_bo,
621 size_t size, struct ttm_placement *placement,
623 void (*bo_free) (struct ttm_buffer_object *bo));
624 extern int vmw_user_dmabuf_verify_access(struct ttm_buffer_object *bo,
625 struct ttm_object_file *tfile);
626 extern int vmw_user_dmabuf_alloc(struct vmw_private *dev_priv,
627 struct ttm_object_file *tfile,
631 struct vmw_dma_buffer **p_dma_buf,
632 struct ttm_base_object **p_base);
633 extern int vmw_user_dmabuf_reference(struct ttm_object_file *tfile,
634 struct vmw_dma_buffer *dma_buf,
636 extern int vmw_dmabuf_alloc_ioctl(struct drm_device *dev, void *data,
637 struct drm_file *file_priv);
638 extern int vmw_dmabuf_unref_ioctl(struct drm_device *dev, void *data,
639 struct drm_file *file_priv);
640 extern int vmw_user_dmabuf_synccpu_ioctl(struct drm_device *dev, void *data,
641 struct drm_file *file_priv);
642 extern uint32_t vmw_dmabuf_validate_node(struct ttm_buffer_object *bo,
643 uint32_t cur_validate_node);
644 extern void vmw_dmabuf_validate_clear(struct ttm_buffer_object *bo);
645 extern int vmw_user_dmabuf_lookup(struct ttm_object_file *tfile,
646 uint32_t id, struct vmw_dma_buffer **out,
647 struct ttm_base_object **base);
648 extern int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
649 struct drm_file *file_priv);
650 extern int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
651 struct drm_file *file_priv);
652 extern int vmw_user_stream_lookup(struct vmw_private *dev_priv,
653 struct ttm_object_file *tfile,
655 struct vmw_resource **out);
656 extern void vmw_resource_unreserve(struct vmw_resource *res,
658 struct vmw_dma_buffer *new_backup,
659 unsigned long new_backup_offset);
660 extern void vmw_resource_move_notify(struct ttm_buffer_object *bo,
661 struct ttm_mem_reg *mem);
662 extern void vmw_query_move_notify(struct ttm_buffer_object *bo,
663 struct ttm_mem_reg *mem);
664 extern int vmw_query_readback_all(struct vmw_dma_buffer *dx_query_mob);
665 extern void vmw_fence_single_bo(struct ttm_buffer_object *bo,
666 struct vmw_fence_obj *fence);
667 extern void vmw_resource_evict_all(struct vmw_private *dev_priv);
670 * DMA buffer helper routines - vmwgfx_dmabuf.c
672 extern int vmw_dmabuf_pin_in_placement(struct vmw_private *vmw_priv,
673 struct vmw_dma_buffer *bo,
674 struct ttm_placement *placement,
676 extern int vmw_dmabuf_pin_in_vram(struct vmw_private *dev_priv,
677 struct vmw_dma_buffer *buf,
679 extern int vmw_dmabuf_pin_in_vram_or_gmr(struct vmw_private *dev_priv,
680 struct vmw_dma_buffer *buf,
682 extern int vmw_dmabuf_pin_in_start_of_vram(struct vmw_private *vmw_priv,
683 struct vmw_dma_buffer *bo,
685 extern int vmw_dmabuf_unpin(struct vmw_private *vmw_priv,
686 struct vmw_dma_buffer *bo,
688 extern void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *buf,
690 extern void vmw_bo_pin_reserved(struct vmw_dma_buffer *bo, bool pin);
693 * Misc Ioctl functionality - vmwgfx_ioctl.c
696 extern int vmw_getparam_ioctl(struct drm_device *dev, void *data,
697 struct drm_file *file_priv);
698 extern int vmw_get_cap_3d_ioctl(struct drm_device *dev, void *data,
699 struct drm_file *file_priv);
700 extern int vmw_present_ioctl(struct drm_device *dev, void *data,
701 struct drm_file *file_priv);
702 extern int vmw_present_readback_ioctl(struct drm_device *dev, void *data,
703 struct drm_file *file_priv);
704 extern unsigned int vmw_fops_poll(struct file *filp,
705 struct poll_table_struct *wait);
706 extern ssize_t vmw_fops_read(struct file *filp, char __user *buffer,
707 size_t count, loff_t *offset);
710 * Fifo utilities - vmwgfx_fifo.c
713 extern int vmw_fifo_init(struct vmw_private *dev_priv,
714 struct vmw_fifo_state *fifo);
715 extern void vmw_fifo_release(struct vmw_private *dev_priv,
716 struct vmw_fifo_state *fifo);
717 extern void *vmw_fifo_reserve(struct vmw_private *dev_priv, uint32_t bytes);
719 vmw_fifo_reserve_dx(struct vmw_private *dev_priv, uint32_t bytes, int ctx_id);
720 extern void vmw_fifo_commit(struct vmw_private *dev_priv, uint32_t bytes);
721 extern void vmw_fifo_commit_flush(struct vmw_private *dev_priv, uint32_t bytes);
722 extern int vmw_fifo_send_fence(struct vmw_private *dev_priv,
724 extern void vmw_fifo_ping_host_locked(struct vmw_private *, uint32_t reason);
725 extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
726 extern bool vmw_fifo_have_3d(struct vmw_private *dev_priv);
727 extern bool vmw_fifo_have_pitchlock(struct vmw_private *dev_priv);
728 extern int vmw_fifo_emit_dummy_query(struct vmw_private *dev_priv,
730 extern int vmw_fifo_flush(struct vmw_private *dev_priv,
734 * TTM glue - vmwgfx_ttm_glue.c
737 extern int vmw_ttm_global_init(struct vmw_private *dev_priv);
738 extern void vmw_ttm_global_release(struct vmw_private *dev_priv);
739 extern int vmw_mmap(struct file *filp, struct vm_area_struct *vma);
742 * TTM buffer object driver - vmwgfx_buffer.c
745 extern const size_t vmw_tt_size;
746 extern struct ttm_placement vmw_vram_placement;
747 extern struct ttm_placement vmw_vram_ne_placement;
748 extern struct ttm_placement vmw_vram_sys_placement;
749 extern struct ttm_placement vmw_vram_gmr_placement;
750 extern struct ttm_placement vmw_vram_gmr_ne_placement;
751 extern struct ttm_placement vmw_sys_placement;
752 extern struct ttm_placement vmw_sys_ne_placement;
753 extern struct ttm_placement vmw_evictable_placement;
754 extern struct ttm_placement vmw_srf_placement;
755 extern struct ttm_placement vmw_mob_placement;
756 extern struct ttm_placement vmw_mob_ne_placement;
757 extern struct ttm_bo_driver vmw_bo_driver;
758 extern int vmw_dma_quiescent(struct drm_device *dev);
759 extern int vmw_bo_map_dma(struct ttm_buffer_object *bo);
760 extern void vmw_bo_unmap_dma(struct ttm_buffer_object *bo);
761 extern const struct vmw_sg_table *
762 vmw_bo_sg_table(struct ttm_buffer_object *bo);
763 extern void vmw_piter_start(struct vmw_piter *viter,
764 const struct vmw_sg_table *vsgt,
765 unsigned long p_offs);
768 * vmw_piter_next - Advance the iterator one page.
770 * @viter: Pointer to the iterator to advance.
772 * Returns false if past the list of pages, true otherwise.
774 static inline bool vmw_piter_next(struct vmw_piter *viter)
776 return viter->next(viter);
780 * vmw_piter_dma_addr - Return the DMA address of the current page.
782 * @viter: Pointer to the iterator
784 * Returns the DMA address of the page pointed to by @viter.
786 static inline dma_addr_t vmw_piter_dma_addr(struct vmw_piter *viter)
788 return viter->dma_address(viter);
792 * vmw_piter_page - Return a pointer to the current page.
794 * @viter: Pointer to the iterator
796 * Returns the DMA address of the page pointed to by @viter.
798 static inline struct page *vmw_piter_page(struct vmw_piter *viter)
800 return viter->page(viter);
804 * Command submission - vmwgfx_execbuf.c
807 extern int vmw_execbuf_ioctl(struct drm_device *dev, unsigned long data,
808 struct drm_file *file_priv, size_t size);
809 extern int vmw_execbuf_process(struct drm_file *file_priv,
810 struct vmw_private *dev_priv,
811 void __user *user_commands,
812 void *kernel_commands,
813 uint32_t command_size,
814 uint64_t throttle_us,
815 uint32_t dx_context_handle,
816 struct drm_vmw_fence_rep __user
818 struct vmw_fence_obj **out_fence);
819 extern void __vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv,
820 struct vmw_fence_obj *fence);
821 extern void vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv);
823 extern int vmw_execbuf_fence_commands(struct drm_file *file_priv,
824 struct vmw_private *dev_priv,
825 struct vmw_fence_obj **p_fence,
827 extern void vmw_execbuf_copy_fence_user(struct vmw_private *dev_priv,
828 struct vmw_fpriv *vmw_fp,
830 struct drm_vmw_fence_rep __user
832 struct vmw_fence_obj *fence,
833 uint32_t fence_handle);
834 extern int vmw_validate_single_buffer(struct vmw_private *dev_priv,
835 struct ttm_buffer_object *bo,
837 bool validate_as_mob);
841 * IRQs and wating - vmwgfx_irq.c
844 extern irqreturn_t vmw_irq_handler(int irq, void *arg);
845 extern int vmw_wait_seqno(struct vmw_private *dev_priv, bool lazy,
846 uint32_t seqno, bool interruptible,
847 unsigned long timeout);
848 extern void vmw_irq_preinstall(struct drm_device *dev);
849 extern int vmw_irq_postinstall(struct drm_device *dev);
850 extern void vmw_irq_uninstall(struct drm_device *dev);
851 extern bool vmw_seqno_passed(struct vmw_private *dev_priv,
853 extern int vmw_fallback_wait(struct vmw_private *dev_priv,
858 unsigned long timeout);
859 extern void vmw_update_seqno(struct vmw_private *dev_priv,
860 struct vmw_fifo_state *fifo_state);
861 extern void vmw_seqno_waiter_add(struct vmw_private *dev_priv);
862 extern void vmw_seqno_waiter_remove(struct vmw_private *dev_priv);
863 extern void vmw_goal_waiter_add(struct vmw_private *dev_priv);
864 extern void vmw_goal_waiter_remove(struct vmw_private *dev_priv);
865 extern void vmw_generic_waiter_add(struct vmw_private *dev_priv, u32 flag,
867 extern void vmw_generic_waiter_remove(struct vmw_private *dev_priv,
868 u32 flag, int *waiter_count);
871 * Rudimentary fence-like objects currently used only for throttling -
875 extern void vmw_marker_queue_init(struct vmw_marker_queue *queue);
876 extern void vmw_marker_queue_takedown(struct vmw_marker_queue *queue);
877 extern int vmw_marker_push(struct vmw_marker_queue *queue,
879 extern int vmw_marker_pull(struct vmw_marker_queue *queue,
880 uint32_t signaled_seqno);
881 extern int vmw_wait_lag(struct vmw_private *dev_priv,
882 struct vmw_marker_queue *queue, uint32_t us);
885 * Kernel framebuffer - vmwgfx_fb.c
888 int vmw_fb_init(struct vmw_private *vmw_priv);
889 int vmw_fb_close(struct vmw_private *dev_priv);
890 int vmw_fb_off(struct vmw_private *vmw_priv);
891 int vmw_fb_on(struct vmw_private *vmw_priv);
894 * Kernel modesetting - vmwgfx_kms.c
897 int vmw_kms_init(struct vmw_private *dev_priv);
898 int vmw_kms_close(struct vmw_private *dev_priv);
899 int vmw_kms_save_vga(struct vmw_private *vmw_priv);
900 int vmw_kms_restore_vga(struct vmw_private *vmw_priv);
901 int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
902 struct drm_file *file_priv);
903 void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv);
904 void vmw_kms_cursor_snoop(struct vmw_surface *srf,
905 struct ttm_object_file *tfile,
906 struct ttm_buffer_object *bo,
907 SVGA3dCmdHeader *header);
908 int vmw_kms_write_svga(struct vmw_private *vmw_priv,
909 unsigned width, unsigned height, unsigned pitch,
910 unsigned bpp, unsigned depth);
911 void vmw_kms_idle_workqueues(struct vmw_master *vmaster);
912 bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
915 u32 vmw_get_vblank_counter(struct drm_device *dev, unsigned int pipe);
916 int vmw_enable_vblank(struct drm_device *dev, unsigned int pipe);
917 void vmw_disable_vblank(struct drm_device *dev, unsigned int pipe);
918 int vmw_kms_present(struct vmw_private *dev_priv,
919 struct drm_file *file_priv,
920 struct vmw_framebuffer *vfb,
921 struct vmw_surface *surface,
922 uint32_t sid, int32_t destX, int32_t destY,
923 struct drm_vmw_rect *clips,
925 int vmw_kms_update_layout_ioctl(struct drm_device *dev, void *data,
926 struct drm_file *file_priv);
927 void vmw_kms_legacy_hotspot_clear(struct vmw_private *dev_priv);
929 int vmw_dumb_create(struct drm_file *file_priv,
930 struct drm_device *dev,
931 struct drm_mode_create_dumb *args);
933 int vmw_dumb_map_offset(struct drm_file *file_priv,
934 struct drm_device *dev, uint32_t handle,
936 int vmw_dumb_destroy(struct drm_file *file_priv,
937 struct drm_device *dev,
939 extern int vmw_resource_pin(struct vmw_resource *res, bool interruptible);
940 extern void vmw_resource_unpin(struct vmw_resource *res);
941 extern enum vmw_res_type vmw_res_type(const struct vmw_resource *res);
944 * Overlay control - vmwgfx_overlay.c
947 int vmw_overlay_init(struct vmw_private *dev_priv);
948 int vmw_overlay_close(struct vmw_private *dev_priv);
949 int vmw_overlay_ioctl(struct drm_device *dev, void *data,
950 struct drm_file *file_priv);
951 int vmw_overlay_stop_all(struct vmw_private *dev_priv);
952 int vmw_overlay_resume_all(struct vmw_private *dev_priv);
953 int vmw_overlay_pause_all(struct vmw_private *dev_priv);
954 int vmw_overlay_claim(struct vmw_private *dev_priv, uint32_t *out);
955 int vmw_overlay_unref(struct vmw_private *dev_priv, uint32_t stream_id);
956 int vmw_overlay_num_overlays(struct vmw_private *dev_priv);
957 int vmw_overlay_num_free_overlays(struct vmw_private *dev_priv);
963 extern const struct ttm_mem_type_manager_func vmw_gmrid_manager_func;
966 * Prime - vmwgfx_prime.c
969 extern const struct dma_buf_ops vmw_prime_dmabuf_ops;
970 extern int vmw_prime_fd_to_handle(struct drm_device *dev,
971 struct drm_file *file_priv,
972 int fd, u32 *handle);
973 extern int vmw_prime_handle_to_fd(struct drm_device *dev,
974 struct drm_file *file_priv,
975 uint32_t handle, uint32_t flags,
979 * MemoryOBject management - vmwgfx_mob.c
982 extern int vmw_mob_bind(struct vmw_private *dev_priv, struct vmw_mob *mob,
983 const struct vmw_sg_table *vsgt,
984 unsigned long num_data_pages, int32_t mob_id);
985 extern void vmw_mob_unbind(struct vmw_private *dev_priv,
986 struct vmw_mob *mob);
987 extern void vmw_mob_destroy(struct vmw_mob *mob);
988 extern struct vmw_mob *vmw_mob_create(unsigned long data_pages);
989 extern int vmw_otables_setup(struct vmw_private *dev_priv);
990 extern void vmw_otables_takedown(struct vmw_private *dev_priv);
993 * Context management - vmwgfx_context.c
996 extern const struct vmw_user_resource_conv *user_context_converter;
998 extern int vmw_context_check(struct vmw_private *dev_priv,
999 struct ttm_object_file *tfile,
1001 struct vmw_resource **p_res);
1002 extern int vmw_context_define_ioctl(struct drm_device *dev, void *data,
1003 struct drm_file *file_priv);
1004 extern int vmw_extended_context_define_ioctl(struct drm_device *dev, void *data,
1005 struct drm_file *file_priv);
1006 extern int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
1007 struct drm_file *file_priv);
1008 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1009 extern struct vmw_cmdbuf_res_manager *
1010 vmw_context_res_man(struct vmw_resource *ctx);
1011 extern struct vmw_resource *vmw_context_cotable(struct vmw_resource *ctx,
1012 SVGACOTableType cotable_type);
1013 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1014 struct vmw_ctx_binding_state;
1015 extern struct vmw_ctx_binding_state *
1016 vmw_context_binding_state(struct vmw_resource *ctx);
1017 extern void vmw_dx_context_scrub_cotables(struct vmw_resource *ctx,
1019 extern int vmw_context_bind_dx_query(struct vmw_resource *ctx_res,
1020 struct vmw_dma_buffer *mob);
1021 extern struct vmw_dma_buffer *
1022 vmw_context_get_dx_query_mob(struct vmw_resource *ctx_res);
1026 * Surface management - vmwgfx_surface.c
1029 extern const struct vmw_user_resource_conv *user_surface_converter;
1031 extern void vmw_surface_res_free(struct vmw_resource *res);
1032 extern int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
1033 struct drm_file *file_priv);
1034 extern int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
1035 struct drm_file *file_priv);
1036 extern int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
1037 struct drm_file *file_priv);
1038 extern int vmw_gb_surface_define_ioctl(struct drm_device *dev, void *data,
1039 struct drm_file *file_priv);
1040 extern int vmw_gb_surface_reference_ioctl(struct drm_device *dev, void *data,
1041 struct drm_file *file_priv);
1042 extern int vmw_surface_check(struct vmw_private *dev_priv,
1043 struct ttm_object_file *tfile,
1044 uint32_t handle, int *id);
1045 extern int vmw_surface_validate(struct vmw_private *dev_priv,
1046 struct vmw_surface *srf);
1047 int vmw_surface_gb_priv_define(struct drm_device *dev,
1048 uint32_t user_accounting_size,
1049 uint32_t svga3d_flags,
1050 SVGA3dSurfaceFormat format,
1052 uint32_t num_mip_levels,
1053 uint32_t multisample_count,
1054 uint32_t array_size,
1055 struct drm_vmw_size size,
1056 struct vmw_surface **srf_out);
1059 * Shader management - vmwgfx_shader.c
1062 extern const struct vmw_user_resource_conv *user_shader_converter;
1064 extern int vmw_shader_define_ioctl(struct drm_device *dev, void *data,
1065 struct drm_file *file_priv);
1066 extern int vmw_shader_destroy_ioctl(struct drm_device *dev, void *data,
1067 struct drm_file *file_priv);
1068 extern int vmw_compat_shader_add(struct vmw_private *dev_priv,
1069 struct vmw_cmdbuf_res_manager *man,
1070 u32 user_key, const void *bytecode,
1071 SVGA3dShaderType shader_type,
1073 struct list_head *list);
1074 extern int vmw_shader_remove(struct vmw_cmdbuf_res_manager *man,
1075 u32 user_key, SVGA3dShaderType shader_type,
1076 struct list_head *list);
1077 extern int vmw_dx_shader_add(struct vmw_cmdbuf_res_manager *man,
1078 struct vmw_resource *ctx,
1080 SVGA3dShaderType shader_type,
1081 struct list_head *list);
1082 extern void vmw_dx_shader_cotable_list_scrub(struct vmw_private *dev_priv,
1083 struct list_head *list,
1086 extern struct vmw_resource *
1087 vmw_shader_lookup(struct vmw_cmdbuf_res_manager *man,
1088 u32 user_key, SVGA3dShaderType shader_type);
1091 * Command buffer managed resources - vmwgfx_cmdbuf_res.c
1094 extern struct vmw_cmdbuf_res_manager *
1095 vmw_cmdbuf_res_man_create(struct vmw_private *dev_priv);
1096 extern void vmw_cmdbuf_res_man_destroy(struct vmw_cmdbuf_res_manager *man);
1097 extern size_t vmw_cmdbuf_res_man_size(void);
1098 extern struct vmw_resource *
1099 vmw_cmdbuf_res_lookup(struct vmw_cmdbuf_res_manager *man,
1100 enum vmw_cmdbuf_res_type res_type,
1102 extern void vmw_cmdbuf_res_revert(struct list_head *list);
1103 extern void vmw_cmdbuf_res_commit(struct list_head *list);
1104 extern int vmw_cmdbuf_res_add(struct vmw_cmdbuf_res_manager *man,
1105 enum vmw_cmdbuf_res_type res_type,
1107 struct vmw_resource *res,
1108 struct list_head *list);
1109 extern int vmw_cmdbuf_res_remove(struct vmw_cmdbuf_res_manager *man,
1110 enum vmw_cmdbuf_res_type res_type,
1112 struct list_head *list,
1113 struct vmw_resource **res);
1116 * COTable management - vmwgfx_cotable.c
1118 extern const SVGACOTableType vmw_cotable_scrub_order[];
1119 extern struct vmw_resource *vmw_cotable_alloc(struct vmw_private *dev_priv,
1120 struct vmw_resource *ctx,
1122 extern int vmw_cotable_notify(struct vmw_resource *res, int id);
1123 extern int vmw_cotable_scrub(struct vmw_resource *res, bool readback);
1124 extern void vmw_cotable_add_resource(struct vmw_resource *ctx,
1125 struct list_head *head);
1128 * Command buffer managerment vmwgfx_cmdbuf.c
1130 struct vmw_cmdbuf_man;
1131 struct vmw_cmdbuf_header;
1133 extern struct vmw_cmdbuf_man *
1134 vmw_cmdbuf_man_create(struct vmw_private *dev_priv);
1135 extern int vmw_cmdbuf_set_pool_size(struct vmw_cmdbuf_man *man,
1136 size_t size, size_t default_size);
1137 extern void vmw_cmdbuf_remove_pool(struct vmw_cmdbuf_man *man);
1138 extern void vmw_cmdbuf_man_destroy(struct vmw_cmdbuf_man *man);
1139 extern int vmw_cmdbuf_idle(struct vmw_cmdbuf_man *man, bool interruptible,
1140 unsigned long timeout);
1141 extern void *vmw_cmdbuf_reserve(struct vmw_cmdbuf_man *man, size_t size,
1142 int ctx_id, bool interruptible,
1143 struct vmw_cmdbuf_header *header);
1144 extern void vmw_cmdbuf_commit(struct vmw_cmdbuf_man *man, size_t size,
1145 struct vmw_cmdbuf_header *header,
1147 extern void vmw_cmdbuf_tasklet_schedule(struct vmw_cmdbuf_man *man);
1148 extern void *vmw_cmdbuf_alloc(struct vmw_cmdbuf_man *man,
1149 size_t size, bool interruptible,
1150 struct vmw_cmdbuf_header **p_header);
1151 extern void vmw_cmdbuf_header_free(struct vmw_cmdbuf_header *header);
1152 extern int vmw_cmdbuf_cur_flush(struct vmw_cmdbuf_man *man,
1153 bool interruptible);
1157 * Inline helper functions
1160 static inline void vmw_surface_unreference(struct vmw_surface **srf)
1162 struct vmw_surface *tmp_srf = *srf;
1163 struct vmw_resource *res = &tmp_srf->res;
1166 vmw_resource_unreference(&res);
1169 static inline struct vmw_surface *vmw_surface_reference(struct vmw_surface *srf)
1171 (void) vmw_resource_reference(&srf->res);
1175 static inline void vmw_dmabuf_unreference(struct vmw_dma_buffer **buf)
1177 struct vmw_dma_buffer *tmp_buf = *buf;
1180 if (tmp_buf != NULL) {
1181 struct ttm_buffer_object *bo = &tmp_buf->base;
1187 static inline struct vmw_dma_buffer *vmw_dmabuf_reference(struct vmw_dma_buffer *buf)
1189 if (ttm_bo_reference(&buf->base))
1194 static inline struct ttm_mem_global *vmw_mem_glob(struct vmw_private *dev_priv)
1196 return (struct ttm_mem_global *) dev_priv->mem_global_ref.object;
1199 static inline void vmw_fifo_resource_inc(struct vmw_private *dev_priv)
1201 atomic_inc(&dev_priv->num_fifo_resources);
1204 static inline void vmw_fifo_resource_dec(struct vmw_private *dev_priv)
1206 atomic_dec(&dev_priv->num_fifo_resources);
1210 * vmw_mmio_read - Perform a MMIO read from volatile memory
1212 * @addr: The address to read from
1214 * This function is intended to be equivalent to ioread32() on
1215 * memremap'd memory, but without byteswapping.
1217 static inline u32 vmw_mmio_read(u32 *addr)
1219 return READ_ONCE(*addr);
1223 * vmw_mmio_write - Perform a MMIO write to volatile memory
1225 * @addr: The address to write to
1227 * This function is intended to be equivalent to iowrite32 on
1228 * memremap'd memory, but without byteswapping.
1230 static inline void vmw_mmio_write(u32 value, u32 *addr)
1232 WRITE_ONCE(*addr, value);