1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
2 /**************************************************************************
3  *
4  * Copyright 2009-2015 VMware, Inc., Palo Alto, CA., USA
5  *
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:
13  *
14  * The above copyright notice and this permission notice (including the
15  * next paragraph) shall be included in all copies or substantial portions
16  * of the Software.
17  *
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.
25  *
26  **************************************************************************/
27 
28 #ifndef _VMWGFX_DRV_H_
29 #define _VMWGFX_DRV_H_
30 
31 #include <linux/suspend.h>
32 #include <linux/sync_file.h>
33 
34 #include <drm/drm_auth.h>
35 #include <drm/drm_device.h>
36 #include <drm/drm_file.h>
37 #include <drm/drm_hashtab.h>
38 #include <drm/drm_rect.h>
39 
40 #include <drm/ttm/ttm_bo_driver.h>
41 #include <drm/ttm/ttm_execbuf_util.h>
42 #include <drm/ttm/ttm_module.h>
43 
44 #include "ttm_lock.h"
45 #include "ttm_object.h"
46 
47 #include "vmwgfx_fence.h"
48 #include "vmwgfx_reg.h"
49 #include "vmwgfx_validation.h"
50 
51 /*
52  * FIXME: vmwgfx_drm.h needs to be last due to dependencies.
53  * uapi headers should not depend on header files outside uapi/.
54  */
55 #include <drm/vmwgfx_drm.h>
56 
57 
58 #define VMWGFX_DRIVER_NAME "vmwgfx"
59 #define VMWGFX_DRIVER_DATE "20200114"
60 #define VMWGFX_DRIVER_MAJOR 2
61 #define VMWGFX_DRIVER_MINOR 17
62 #define VMWGFX_DRIVER_PATCHLEVEL 0
63 #define VMWGFX_FIFO_STATIC_SIZE (1024*1024)
64 #define VMWGFX_MAX_RELOCATIONS 2048
65 #define VMWGFX_MAX_VALIDATIONS 2048
66 #define VMWGFX_MAX_DISPLAYS 16
67 #define VMWGFX_CMD_BOUNCE_INIT_SIZE 32768
68 #define VMWGFX_ENABLE_SCREEN_TARGET_OTABLE 1
69 
70 /*
71  * Perhaps we should have sysfs entries for these.
72  */
73 #define VMWGFX_NUM_GB_CONTEXT 256
74 #define VMWGFX_NUM_GB_SHADER 20000
75 #define VMWGFX_NUM_GB_SURFACE 32768
76 #define VMWGFX_NUM_GB_SCREEN_TARGET VMWGFX_MAX_DISPLAYS
77 #define VMWGFX_NUM_DXCONTEXT 256
78 #define VMWGFX_NUM_DXQUERY 512
79 #define VMWGFX_NUM_MOB (VMWGFX_NUM_GB_CONTEXT +\
80 			VMWGFX_NUM_GB_SHADER +\
81 			VMWGFX_NUM_GB_SURFACE +\
82 			VMWGFX_NUM_GB_SCREEN_TARGET)
83 
84 #define VMW_PL_GMR (TTM_PL_PRIV + 0)
85 #define VMW_PL_FLAG_GMR (TTM_PL_FLAG_PRIV << 0)
86 #define VMW_PL_MOB (TTM_PL_PRIV + 1)
87 #define VMW_PL_FLAG_MOB (TTM_PL_FLAG_PRIV << 1)
88 
89 #define VMW_RES_CONTEXT ttm_driver_type0
90 #define VMW_RES_SURFACE ttm_driver_type1
91 #define VMW_RES_STREAM ttm_driver_type2
92 #define VMW_RES_FENCE ttm_driver_type3
93 #define VMW_RES_SHADER ttm_driver_type4
94 
95 struct vmw_fpriv {
96 	struct ttm_object_file *tfile;
97 	bool gb_aware; /* user-space is guest-backed aware */
98 };
99 
100 /**
101  * struct vmw_buffer_object - TTM buffer object with vmwgfx additions
102  * @base: The TTM buffer object
103  * @res_tree: RB tree of resources using this buffer object as a backing MOB
104  * @pin_count: pin depth
105  * @cpu_writers: Number of synccpu write grabs. Protected by reservation when
106  * increased. May be decreased without reservation.
107  * @dx_query_ctx: DX context if this buffer object is used as a DX query MOB
108  * @map: Kmap object for semi-persistent mappings
109  * @res_prios: Eviction priority counts for attached resources
110  * @dirty: structure for user-space dirty-tracking
111  */
112 struct vmw_buffer_object {
113 	struct ttm_buffer_object base;
114 	struct rb_root res_tree;
115 	s32 pin_count;
116 	atomic_t cpu_writers;
117 	/* Not ref-counted.  Protected by binding_mutex */
118 	struct vmw_resource *dx_query_ctx;
119 	/* Protected by reservation */
120 	struct ttm_bo_kmap_obj map;
121 	u32 res_prios[TTM_MAX_BO_PRIORITY];
122 	struct vmw_bo_dirty *dirty;
123 };
124 
125 /**
126  * struct vmw_validate_buffer - Carries validation info about buffers.
127  *
128  * @base: Validation info for TTM.
129  * @hash: Hash entry for quick lookup of the TTM buffer object.
130  *
131  * This structure contains also driver private validation info
132  * on top of the info needed by TTM.
133  */
134 struct vmw_validate_buffer {
135 	struct ttm_validate_buffer base;
136 	struct drm_hash_item hash;
137 	bool validate_as_mob;
138 };
139 
140 struct vmw_res_func;
141 
142 
143 /**
144  * struct vmw-resource - base class for hardware resources
145  *
146  * @kref: For refcounting.
147  * @dev_priv: Pointer to the device private for this resource. Immutable.
148  * @id: Device id. Protected by @dev_priv::resource_lock.
149  * @backup_size: Backup buffer size. Immutable.
150  * @res_dirty: Resource contains data not yet in the backup buffer. Protected
151  * by resource reserved.
152  * @backup_dirty: Backup buffer contains data not yet in the HW resource.
153  * Protected by resource reserved.
154  * @coherent: Emulate coherency by tracking vm accesses.
155  * @backup: The backup buffer if any. Protected by resource reserved.
156  * @backup_offset: Offset into the backup buffer if any. Protected by resource
157  * reserved. Note that only a few resource types can have a @backup_offset
158  * different from zero.
159  * @pin_count: The pin count for this resource. A pinned resource has a
160  * pin-count greater than zero. It is not on the resource LRU lists and its
161  * backup buffer is pinned. Hence it can't be evicted.
162  * @func: Method vtable for this resource. Immutable.
163  * @mob_node; Node for the MOB backup rbtree. Protected by @backup reserved.
164  * @lru_head: List head for the LRU list. Protected by @dev_priv::resource_lock.
165  * @binding_head: List head for the context binding list. Protected by
166  * the @dev_priv::binding_mutex
167  * @res_free: The resource destructor.
168  * @hw_destroy: Callback to destroy the resource on the device, as part of
169  * resource destruction.
170  */
171 struct vmw_resource_dirty;
172 struct vmw_resource {
173 	struct kref kref;
174 	struct vmw_private *dev_priv;
175 	int id;
176 	u32 used_prio;
177 	unsigned long backup_size;
178 	u32 res_dirty : 1;
179 	u32 backup_dirty : 1;
180 	u32 coherent : 1;
181 	struct vmw_buffer_object *backup;
182 	unsigned long backup_offset;
183 	unsigned long pin_count;
184 	const struct vmw_res_func *func;
185 	struct rb_node mob_node;
186 	struct list_head lru_head;
187 	struct list_head binding_head;
188 	struct vmw_resource_dirty *dirty;
189 	void (*res_free) (struct vmw_resource *res);
190 	void (*hw_destroy) (struct vmw_resource *res);
191 };
192 
193 
194 /*
195  * Resources that are managed using ioctls.
196  */
197 enum vmw_res_type {
198 	vmw_res_context,
199 	vmw_res_surface,
200 	vmw_res_stream,
201 	vmw_res_shader,
202 	vmw_res_dx_context,
203 	vmw_res_cotable,
204 	vmw_res_view,
205 	vmw_res_max
206 };
207 
208 /*
209  * Resources that are managed using command streams.
210  */
211 enum vmw_cmdbuf_res_type {
212 	vmw_cmdbuf_res_shader,
213 	vmw_cmdbuf_res_view
214 };
215 
216 struct vmw_cmdbuf_res_manager;
217 
218 struct vmw_cursor_snooper {
219 	size_t age;
220 	uint32_t *image;
221 };
222 
223 struct vmw_framebuffer;
224 struct vmw_surface_offset;
225 
226 struct vmw_surface {
227 	struct vmw_resource res;
228 	SVGA3dSurfaceAllFlags flags;
229 	uint32_t format;
230 	uint32_t mip_levels[DRM_VMW_MAX_SURFACE_FACES];
231 	struct drm_vmw_size base_size;
232 	struct drm_vmw_size *sizes;
233 	uint32_t num_sizes;
234 	bool scanout;
235 	uint32_t array_size;
236 	/* TODO so far just a extra pointer */
237 	struct vmw_cursor_snooper snooper;
238 	struct vmw_surface_offset *offsets;
239 	SVGA3dTextureFilter autogen_filter;
240 	uint32_t multisample_count;
241 	struct list_head view_list;
242 	SVGA3dMSPattern multisample_pattern;
243 	SVGA3dMSQualityLevel quality_level;
244 };
245 
246 struct vmw_marker_queue {
247 	struct list_head head;
248 	u64 lag;
249 	u64 lag_time;
250 	spinlock_t lock;
251 };
252 
253 struct vmw_fifo_state {
254 	unsigned long reserved_size;
255 	u32 *dynamic_buffer;
256 	u32 *static_buffer;
257 	unsigned long static_buffer_size;
258 	bool using_bounce_buffer;
259 	uint32_t capabilities;
260 	struct mutex fifo_mutex;
261 	struct rw_semaphore rwsem;
262 	struct vmw_marker_queue marker_queue;
263 	bool dx;
264 };
265 
266 /**
267  * struct vmw_res_cache_entry - resource information cache entry
268  * @handle: User-space handle of a resource.
269  * @res: Non-ref-counted pointer to the resource.
270  * @valid_handle: Whether the @handle member is valid.
271  * @valid: Whether the entry is valid, which also implies that the execbuf
272  * code holds a reference to the resource, and it's placed on the
273  * validation list.
274  *
275  * Used to avoid frequent repeated user-space handle lookups of the
276  * same resource.
277  */
278 struct vmw_res_cache_entry {
279 	uint32_t handle;
280 	struct vmw_resource *res;
281 	void *private;
282 	unsigned short valid_handle;
283 	unsigned short valid;
284 };
285 
286 /**
287  * enum vmw_dma_map_mode - indicate how to perform TTM page dma mappings.
288  */
289 enum vmw_dma_map_mode {
290 	vmw_dma_phys,           /* Use physical page addresses */
291 	vmw_dma_alloc_coherent, /* Use TTM coherent pages */
292 	vmw_dma_map_populate,   /* Unmap from DMA just after unpopulate */
293 	vmw_dma_map_bind,       /* Unmap from DMA just before unbind */
294 	vmw_dma_map_max
295 };
296 
297 /**
298  * struct vmw_sg_table - Scatter/gather table for binding, with additional
299  * device-specific information.
300  *
301  * @sgt: Pointer to a struct sg_table with binding information
302  * @num_regions: Number of regions with device-address contiguous pages
303  */
304 struct vmw_sg_table {
305 	enum vmw_dma_map_mode mode;
306 	struct page **pages;
307 	const dma_addr_t *addrs;
308 	struct sg_table *sgt;
309 	unsigned long num_regions;
310 	unsigned long num_pages;
311 };
312 
313 /**
314  * struct vmw_piter - Page iterator that iterates over a list of pages
315  * and DMA addresses that could be either a scatter-gather list or
316  * arrays
317  *
318  * @pages: Array of page pointers to the pages.
319  * @addrs: DMA addresses to the pages if coherent pages are used.
320  * @iter: Scatter-gather page iterator. Current position in SG list.
321  * @i: Current position in arrays.
322  * @num_pages: Number of pages total.
323  * @next: Function to advance the iterator. Returns false if past the list
324  * of pages, true otherwise.
325  * @dma_address: Function to return the DMA address of the current page.
326  */
327 struct vmw_piter {
328 	struct page **pages;
329 	const dma_addr_t *addrs;
330 	struct sg_dma_page_iter iter;
331 	unsigned long i;
332 	unsigned long num_pages;
333 	bool (*next)(struct vmw_piter *);
334 	dma_addr_t (*dma_address)(struct vmw_piter *);
335 	struct page *(*page)(struct vmw_piter *);
336 };
337 
338 /*
339  * enum vmw_display_unit_type - Describes the display unit
340  */
341 enum vmw_display_unit_type {
342 	vmw_du_invalid = 0,
343 	vmw_du_legacy,
344 	vmw_du_screen_object,
345 	vmw_du_screen_target
346 };
347 
348 struct vmw_validation_context;
349 struct vmw_ctx_validation_info;
350 
351 /**
352  * struct vmw_sw_context - Command submission context
353  * @res_ht: Pointer hash table used to find validation duplicates
354  * @kernel: Whether the command buffer originates from kernel code rather
355  * than from user-space
356  * @fp: If @kernel is false, points to the file of the client. Otherwise
357  * NULL
358  * @cmd_bounce: Command bounce buffer used for command validation before
359  * copying to fifo space
360  * @cmd_bounce_size: Current command bounce buffer size
361  * @cur_query_bo: Current buffer object used as query result buffer
362  * @bo_relocations: List of buffer object relocations
363  * @res_relocations: List of resource relocations
364  * @buf_start: Pointer to start of memory where command validation takes
365  * place
366  * @res_cache: Cache of recently looked up resources
367  * @last_query_ctx: Last context that submitted a query
368  * @needs_post_query_barrier: Whether a query barrier is needed after
369  * command submission
370  * @staged_bindings: Cached per-context binding tracker
371  * @staged_bindings_inuse: Whether the cached per-context binding tracker
372  * is in use
373  * @staged_cmd_res: List of staged command buffer managed resources in this
374  * command buffer
375  * @ctx_list: List of context resources referenced in this command buffer
376  * @dx_ctx_node: Validation metadata of the current DX context
377  * @dx_query_mob: The MOB used for DX queries
378  * @dx_query_ctx: The DX context used for the last DX query
379  * @man: Pointer to the command buffer managed resource manager
380  * @ctx: The validation context
381  */
382 struct vmw_sw_context{
383 	struct drm_open_hash res_ht;
384 	bool res_ht_initialized;
385 	bool kernel;
386 	struct vmw_fpriv *fp;
387 	uint32_t *cmd_bounce;
388 	uint32_t cmd_bounce_size;
389 	struct vmw_buffer_object *cur_query_bo;
390 	struct list_head bo_relocations;
391 	struct list_head res_relocations;
392 	uint32_t *buf_start;
393 	struct vmw_res_cache_entry res_cache[vmw_res_max];
394 	struct vmw_resource *last_query_ctx;
395 	bool needs_post_query_barrier;
396 	struct vmw_ctx_binding_state *staged_bindings;
397 	bool staged_bindings_inuse;
398 	struct list_head staged_cmd_res;
399 	struct list_head ctx_list;
400 	struct vmw_ctx_validation_info *dx_ctx_node;
401 	struct vmw_buffer_object *dx_query_mob;
402 	struct vmw_resource *dx_query_ctx;
403 	struct vmw_cmdbuf_res_manager *man;
404 	struct vmw_validation_context *ctx;
405 };
406 
407 struct vmw_legacy_display;
408 struct vmw_overlay;
409 
410 struct vmw_vga_topology_state {
411 	uint32_t width;
412 	uint32_t height;
413 	uint32_t primary;
414 	uint32_t pos_x;
415 	uint32_t pos_y;
416 };
417 
418 
419 /*
420  * struct vmw_otable - Guest Memory OBject table metadata
421  *
422  * @size:           Size of the table (page-aligned).
423  * @page_table:     Pointer to a struct vmw_mob holding the page table.
424  */
425 struct vmw_otable {
426 	unsigned long size;
427 	struct vmw_mob *page_table;
428 	bool enabled;
429 };
430 
431 struct vmw_otable_batch {
432 	unsigned num_otables;
433 	struct vmw_otable *otables;
434 	struct vmw_resource *context;
435 	struct ttm_buffer_object *otable_bo;
436 };
437 
438 enum {
439 	VMW_IRQTHREAD_FENCE,
440 	VMW_IRQTHREAD_CMDBUF,
441 	VMW_IRQTHREAD_MAX
442 };
443 
444 /**
445  * enum vmw_sm_type - Graphics context capability supported by device.
446  * @VMW_SM_LEGACY: Pre DX context.
447  * @VMW_SM_4: Context support upto SM4.
448  * @VMW_SM_4_1: Context support upto SM4_1.
449  * @VMW_SM_MAX: Should be the last.
450  */
451 enum vmw_sm_type {
452 	VMW_SM_LEGACY = 0,
453 	VMW_SM_4,
454 	VMW_SM_4_1,
455 	VMW_SM_MAX
456 };
457 
458 struct vmw_private {
459 	struct ttm_bo_device bdev;
460 
461 	struct vmw_fifo_state fifo;
462 
463 	struct drm_device *dev;
464 	struct drm_vma_offset_manager vma_manager;
465 	unsigned long vmw_chipset;
466 	unsigned int io_start;
467 	uint32_t vram_start;
468 	uint32_t vram_size;
469 	uint32_t prim_bb_mem;
470 	uint32_t mmio_start;
471 	uint32_t mmio_size;
472 	uint32_t fb_max_width;
473 	uint32_t fb_max_height;
474 	uint32_t texture_max_width;
475 	uint32_t texture_max_height;
476 	uint32_t stdu_max_width;
477 	uint32_t stdu_max_height;
478 	uint32_t initial_width;
479 	uint32_t initial_height;
480 	u32 *mmio_virt;
481 	uint32_t capabilities;
482 	uint32_t capabilities2;
483 	uint32_t max_gmr_ids;
484 	uint32_t max_gmr_pages;
485 	uint32_t max_mob_pages;
486 	uint32_t max_mob_size;
487 	uint32_t memory_size;
488 	bool has_gmr;
489 	bool has_mob;
490 	spinlock_t hw_lock;
491 	spinlock_t cap_lock;
492 	bool assume_16bpp;
493 
494 	enum vmw_sm_type sm_type;
495 
496 	/*
497 	 * Framebuffer info.
498 	 */
499 
500 	void *fb_info;
501 	enum vmw_display_unit_type active_display_unit;
502 	struct vmw_legacy_display *ldu_priv;
503 	struct vmw_overlay *overlay_priv;
504 	struct drm_property *hotplug_mode_update_property;
505 	struct drm_property *implicit_placement_property;
506 	struct mutex global_kms_state_mutex;
507 	spinlock_t cursor_lock;
508 	struct drm_atomic_state *suspend_state;
509 
510 	/*
511 	 * Context and surface management.
512 	 */
513 
514 	spinlock_t resource_lock;
515 	struct idr res_idr[vmw_res_max];
516 
517 	/*
518 	 * A resource manager for kernel-only surfaces and
519 	 * contexts.
520 	 */
521 
522 	struct ttm_object_device *tdev;
523 
524 	/*
525 	 * Fencing and IRQs.
526 	 */
527 
528 	atomic_t marker_seq;
529 	wait_queue_head_t fence_queue;
530 	wait_queue_head_t fifo_queue;
531 	spinlock_t waiter_lock;
532 	int fence_queue_waiters; /* Protected by waiter_lock */
533 	int goal_queue_waiters; /* Protected by waiter_lock */
534 	int cmdbuf_waiters; /* Protected by waiter_lock */
535 	int error_waiters; /* Protected by waiter_lock */
536 	int fifo_queue_waiters; /* Protected by waiter_lock */
537 	uint32_t last_read_seqno;
538 	struct vmw_fence_manager *fman;
539 	uint32_t irq_mask; /* Updates protected by waiter_lock */
540 
541 	/*
542 	 * Device state
543 	 */
544 
545 	uint32_t traces_state;
546 	uint32_t enable_state;
547 	uint32_t config_done_state;
548 
549 	/**
550 	 * Execbuf
551 	 */
552 	/**
553 	 * Protected by the cmdbuf mutex.
554 	 */
555 
556 	struct vmw_sw_context ctx;
557 	struct mutex cmdbuf_mutex;
558 	struct mutex binding_mutex;
559 
560 	/**
561 	 * Operating mode.
562 	 */
563 
564 	bool stealth;
565 	bool enable_fb;
566 	spinlock_t svga_lock;
567 
568 	/**
569 	 * PM management.
570 	 */
571 	struct notifier_block pm_nb;
572 	bool refuse_hibernation;
573 	bool suspend_locked;
574 
575 	struct mutex release_mutex;
576 	atomic_t num_fifo_resources;
577 
578 	/*
579 	 * Replace this with an rwsem as soon as we have down_xx_interruptible()
580 	 */
581 	struct ttm_lock reservation_sem;
582 
583 	/*
584 	 * Query processing. These members
585 	 * are protected by the cmdbuf mutex.
586 	 */
587 
588 	struct vmw_buffer_object *dummy_query_bo;
589 	struct vmw_buffer_object *pinned_bo;
590 	uint32_t query_cid;
591 	uint32_t query_cid_valid;
592 	bool dummy_query_bo_pinned;
593 
594 	/*
595 	 * Surface swapping. The "surface_lru" list is protected by the
596 	 * resource lock in order to be able to destroy a surface and take
597 	 * it off the lru atomically. "used_memory_size" is currently
598 	 * protected by the cmdbuf mutex for simplicity.
599 	 */
600 
601 	struct list_head res_lru[vmw_res_max];
602 	uint32_t used_memory_size;
603 
604 	/*
605 	 * DMA mapping stuff.
606 	 */
607 	enum vmw_dma_map_mode map_mode;
608 
609 	/*
610 	 * Guest Backed stuff
611 	 */
612 	struct vmw_otable_batch otable_batch;
613 
614 	struct vmw_cmdbuf_man *cman;
615 	DECLARE_BITMAP(irqthread_pending, VMW_IRQTHREAD_MAX);
616 
617 	/* Validation memory reservation */
618 	struct vmw_validation_mem vvm;
619 };
620 
621 static inline struct vmw_surface *vmw_res_to_srf(struct vmw_resource *res)
622 {
623 	return container_of(res, struct vmw_surface, res);
624 }
625 
626 static inline struct vmw_private *vmw_priv(struct drm_device *dev)
627 {
628 	return (struct vmw_private *)dev->dev_private;
629 }
630 
631 static inline struct vmw_fpriv *vmw_fpriv(struct drm_file *file_priv)
632 {
633 	return (struct vmw_fpriv *)file_priv->driver_priv;
634 }
635 
636 /*
637  * The locking here is fine-grained, so that it is performed once
638  * for every read- and write operation. This is of course costly, but we
639  * don't perform much register access in the timing critical paths anyway.
640  * Instead we have the extra benefit of being sure that we don't forget
641  * the hw lock around register accesses.
642  */
643 static inline void vmw_write(struct vmw_private *dev_priv,
644 			     unsigned int offset, uint32_t value)
645 {
646 	spin_lock(&dev_priv->hw_lock);
647 	outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
648 	outl(value, dev_priv->io_start + VMWGFX_VALUE_PORT);
649 	spin_unlock(&dev_priv->hw_lock);
650 }
651 
652 static inline uint32_t vmw_read(struct vmw_private *dev_priv,
653 				unsigned int offset)
654 {
655 	u32 val;
656 
657 	spin_lock(&dev_priv->hw_lock);
658 	outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
659 	val = inl(dev_priv->io_start + VMWGFX_VALUE_PORT);
660 	spin_unlock(&dev_priv->hw_lock);
661 
662 	return val;
663 }
664 
665 /**
666  * has_sm4_context - Does the device support SM4 context.
667  * @dev_priv: Device private.
668  *
669  * Return: Bool value if device support SM4 context or not.
670  */
671 static inline bool has_sm4_context(const struct vmw_private *dev_priv)
672 {
673 	return (dev_priv->sm_type >= VMW_SM_4);
674 }
675 
676 /**
677  * has_sm4_1_context - Does the device support SM4_1 context.
678  * @dev_priv: Device private.
679  *
680  * Return: Bool value if device support SM4_1 context or not.
681  */
682 static inline bool has_sm4_1_context(const struct vmw_private *dev_priv)
683 {
684 	return (dev_priv->sm_type >= VMW_SM_4_1);
685 }
686 
687 extern void vmw_svga_enable(struct vmw_private *dev_priv);
688 extern void vmw_svga_disable(struct vmw_private *dev_priv);
689 
690 
691 /**
692  * GMR utilities - vmwgfx_gmr.c
693  */
694 
695 extern int vmw_gmr_bind(struct vmw_private *dev_priv,
696 			const struct vmw_sg_table *vsgt,
697 			unsigned long num_pages,
698 			int gmr_id);
699 extern void vmw_gmr_unbind(struct vmw_private *dev_priv, int gmr_id);
700 
701 /**
702  * Resource utilities - vmwgfx_resource.c
703  */
704 struct vmw_user_resource_conv;
705 
706 extern void vmw_resource_unreference(struct vmw_resource **p_res);
707 extern struct vmw_resource *vmw_resource_reference(struct vmw_resource *res);
708 extern struct vmw_resource *
709 vmw_resource_reference_unless_doomed(struct vmw_resource *res);
710 extern int vmw_resource_validate(struct vmw_resource *res, bool intr,
711 				 bool dirtying);
712 extern int vmw_resource_reserve(struct vmw_resource *res, bool interruptible,
713 				bool no_backup);
714 extern bool vmw_resource_needs_backup(const struct vmw_resource *res);
715 extern int vmw_user_lookup_handle(struct vmw_private *dev_priv,
716 				  struct ttm_object_file *tfile,
717 				  uint32_t handle,
718 				  struct vmw_surface **out_surf,
719 				  struct vmw_buffer_object **out_buf);
720 extern int vmw_user_resource_lookup_handle(
721 	struct vmw_private *dev_priv,
722 	struct ttm_object_file *tfile,
723 	uint32_t handle,
724 	const struct vmw_user_resource_conv *converter,
725 	struct vmw_resource **p_res);
726 extern struct vmw_resource *
727 vmw_user_resource_noref_lookup_handle(struct vmw_private *dev_priv,
728 				      struct ttm_object_file *tfile,
729 				      uint32_t handle,
730 				      const struct vmw_user_resource_conv *
731 				      converter);
732 extern int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
733 				  struct drm_file *file_priv);
734 extern int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
735 				  struct drm_file *file_priv);
736 extern int vmw_user_stream_lookup(struct vmw_private *dev_priv,
737 				  struct ttm_object_file *tfile,
738 				  uint32_t *inout_id,
739 				  struct vmw_resource **out);
740 extern void vmw_resource_unreserve(struct vmw_resource *res,
741 				   bool dirty_set,
742 				   bool dirty,
743 				   bool switch_backup,
744 				   struct vmw_buffer_object *new_backup,
745 				   unsigned long new_backup_offset);
746 extern void vmw_query_move_notify(struct ttm_buffer_object *bo,
747 				  struct ttm_mem_reg *mem);
748 extern int vmw_query_readback_all(struct vmw_buffer_object *dx_query_mob);
749 extern void vmw_resource_evict_all(struct vmw_private *dev_priv);
750 extern void vmw_resource_unbind_list(struct vmw_buffer_object *vbo);
751 void vmw_resource_mob_attach(struct vmw_resource *res);
752 void vmw_resource_mob_detach(struct vmw_resource *res);
753 void vmw_resource_dirty_update(struct vmw_resource *res, pgoff_t start,
754 			       pgoff_t end);
755 int vmw_resources_clean(struct vmw_buffer_object *vbo, pgoff_t start,
756 			pgoff_t end, pgoff_t *num_prefault);
757 
758 /**
759  * vmw_resource_mob_attached - Whether a resource currently has a mob attached
760  * @res: The resource
761  *
762  * Return: true if the resource has a mob attached, false otherwise.
763  */
764 static inline bool vmw_resource_mob_attached(const struct vmw_resource *res)
765 {
766 	return !RB_EMPTY_NODE(&res->mob_node);
767 }
768 
769 /**
770  * vmw_user_resource_noref_release - release a user resource pointer looked up
771  * without reference
772  */
773 static inline void vmw_user_resource_noref_release(void)
774 {
775 	ttm_base_object_noref_release();
776 }
777 
778 /**
779  * Buffer object helper functions - vmwgfx_bo.c
780  */
781 extern int vmw_bo_pin_in_placement(struct vmw_private *vmw_priv,
782 				   struct vmw_buffer_object *bo,
783 				   struct ttm_placement *placement,
784 				   bool interruptible);
785 extern int vmw_bo_pin_in_vram(struct vmw_private *dev_priv,
786 			      struct vmw_buffer_object *buf,
787 			      bool interruptible);
788 extern int vmw_bo_pin_in_vram_or_gmr(struct vmw_private *dev_priv,
789 				     struct vmw_buffer_object *buf,
790 				     bool interruptible);
791 extern int vmw_bo_pin_in_start_of_vram(struct vmw_private *vmw_priv,
792 				       struct vmw_buffer_object *bo,
793 				       bool interruptible);
794 extern int vmw_bo_unpin(struct vmw_private *vmw_priv,
795 			struct vmw_buffer_object *bo,
796 			bool interruptible);
797 extern void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *buf,
798 				 SVGAGuestPtr *ptr);
799 extern void vmw_bo_pin_reserved(struct vmw_buffer_object *bo, bool pin);
800 extern void vmw_bo_bo_free(struct ttm_buffer_object *bo);
801 extern int vmw_bo_init(struct vmw_private *dev_priv,
802 		       struct vmw_buffer_object *vmw_bo,
803 		       size_t size, struct ttm_placement *placement,
804 		       bool interuptable,
805 		       void (*bo_free)(struct ttm_buffer_object *bo));
806 extern int vmw_user_bo_verify_access(struct ttm_buffer_object *bo,
807 				     struct ttm_object_file *tfile);
808 extern int vmw_user_bo_alloc(struct vmw_private *dev_priv,
809 			     struct ttm_object_file *tfile,
810 			     uint32_t size,
811 			     bool shareable,
812 			     uint32_t *handle,
813 			     struct vmw_buffer_object **p_dma_buf,
814 			     struct ttm_base_object **p_base);
815 extern int vmw_user_bo_reference(struct ttm_object_file *tfile,
816 				 struct vmw_buffer_object *dma_buf,
817 				 uint32_t *handle);
818 extern int vmw_bo_alloc_ioctl(struct drm_device *dev, void *data,
819 			      struct drm_file *file_priv);
820 extern int vmw_bo_unref_ioctl(struct drm_device *dev, void *data,
821 			      struct drm_file *file_priv);
822 extern int vmw_user_bo_synccpu_ioctl(struct drm_device *dev, void *data,
823 				     struct drm_file *file_priv);
824 extern int vmw_user_bo_lookup(struct ttm_object_file *tfile,
825 			      uint32_t id, struct vmw_buffer_object **out,
826 			      struct ttm_base_object **base);
827 extern void vmw_bo_fence_single(struct ttm_buffer_object *bo,
828 				struct vmw_fence_obj *fence);
829 extern void *vmw_bo_map_and_cache(struct vmw_buffer_object *vbo);
830 extern void vmw_bo_unmap(struct vmw_buffer_object *vbo);
831 extern void vmw_bo_move_notify(struct ttm_buffer_object *bo,
832 			       struct ttm_mem_reg *mem);
833 extern void vmw_bo_swap_notify(struct ttm_buffer_object *bo);
834 extern struct vmw_buffer_object *
835 vmw_user_bo_noref_lookup(struct ttm_object_file *tfile, u32 handle);
836 
837 /**
838  * vmw_user_bo_noref_release - release a buffer object pointer looked up
839  * without reference
840  */
841 static inline void vmw_user_bo_noref_release(void)
842 {
843 	ttm_base_object_noref_release();
844 }
845 
846 /**
847  * vmw_bo_adjust_prio - Adjust the buffer object eviction priority
848  * according to attached resources
849  * @vbo: The struct vmw_buffer_object
850  */
851 static inline void vmw_bo_prio_adjust(struct vmw_buffer_object *vbo)
852 {
853 	int i = ARRAY_SIZE(vbo->res_prios);
854 
855 	while (i--) {
856 		if (vbo->res_prios[i]) {
857 			vbo->base.priority = i;
858 			return;
859 		}
860 	}
861 
862 	vbo->base.priority = 3;
863 }
864 
865 /**
866  * vmw_bo_prio_add - Notify a buffer object of a newly attached resource
867  * eviction priority
868  * @vbo: The struct vmw_buffer_object
869  * @prio: The resource priority
870  *
871  * After being notified, the code assigns the highest resource eviction priority
872  * to the backing buffer object (mob).
873  */
874 static inline void vmw_bo_prio_add(struct vmw_buffer_object *vbo, int prio)
875 {
876 	if (vbo->res_prios[prio]++ == 0)
877 		vmw_bo_prio_adjust(vbo);
878 }
879 
880 /**
881  * vmw_bo_prio_del - Notify a buffer object of a resource with a certain
882  * priority being removed
883  * @vbo: The struct vmw_buffer_object
884  * @prio: The resource priority
885  *
886  * After being notified, the code assigns the highest resource eviction priority
887  * to the backing buffer object (mob).
888  */
889 static inline void vmw_bo_prio_del(struct vmw_buffer_object *vbo, int prio)
890 {
891 	if (--vbo->res_prios[prio] == 0)
892 		vmw_bo_prio_adjust(vbo);
893 }
894 
895 /**
896  * Misc Ioctl functionality - vmwgfx_ioctl.c
897  */
898 
899 extern int vmw_getparam_ioctl(struct drm_device *dev, void *data,
900 			      struct drm_file *file_priv);
901 extern int vmw_get_cap_3d_ioctl(struct drm_device *dev, void *data,
902 				struct drm_file *file_priv);
903 extern int vmw_present_ioctl(struct drm_device *dev, void *data,
904 			     struct drm_file *file_priv);
905 extern int vmw_present_readback_ioctl(struct drm_device *dev, void *data,
906 				      struct drm_file *file_priv);
907 extern __poll_t vmw_fops_poll(struct file *filp,
908 				  struct poll_table_struct *wait);
909 extern ssize_t vmw_fops_read(struct file *filp, char __user *buffer,
910 			     size_t count, loff_t *offset);
911 
912 /**
913  * Fifo utilities - vmwgfx_fifo.c
914  */
915 
916 extern int vmw_fifo_init(struct vmw_private *dev_priv,
917 			 struct vmw_fifo_state *fifo);
918 extern void vmw_fifo_release(struct vmw_private *dev_priv,
919 			     struct vmw_fifo_state *fifo);
920 extern void *
921 vmw_fifo_reserve_dx(struct vmw_private *dev_priv, uint32_t bytes, int ctx_id);
922 extern void vmw_fifo_commit(struct vmw_private *dev_priv, uint32_t bytes);
923 extern void vmw_fifo_commit_flush(struct vmw_private *dev_priv, uint32_t bytes);
924 extern int vmw_fifo_send_fence(struct vmw_private *dev_priv,
925 			       uint32_t *seqno);
926 extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
927 extern bool vmw_fifo_have_3d(struct vmw_private *dev_priv);
928 extern bool vmw_fifo_have_pitchlock(struct vmw_private *dev_priv);
929 extern int vmw_fifo_emit_dummy_query(struct vmw_private *dev_priv,
930 				     uint32_t cid);
931 extern int vmw_fifo_flush(struct vmw_private *dev_priv,
932 			  bool interruptible);
933 
934 #define VMW_FIFO_RESERVE_DX(__priv, __bytes, __ctx_id)                        \
935 ({                                                                            \
936 	vmw_fifo_reserve_dx(__priv, __bytes, __ctx_id) ? : ({                 \
937 		DRM_ERROR("FIFO reserve failed at %s for %u bytes\n",         \
938 			  __func__, (unsigned int) __bytes);                  \
939 		NULL;                                                         \
940 	});                                                                   \
941 })
942 
943 #define VMW_FIFO_RESERVE(__priv, __bytes)                                     \
944 	VMW_FIFO_RESERVE_DX(__priv, __bytes, SVGA3D_INVALID_ID)
945 
946 /**
947  * TTM glue - vmwgfx_ttm_glue.c
948  */
949 
950 extern int vmw_mmap(struct file *filp, struct vm_area_struct *vma);
951 
952 extern void vmw_validation_mem_init_ttm(struct vmw_private *dev_priv,
953 					size_t gran);
954 /**
955  * TTM buffer object driver - vmwgfx_ttm_buffer.c
956  */
957 
958 extern const size_t vmw_tt_size;
959 extern struct ttm_placement vmw_vram_placement;
960 extern struct ttm_placement vmw_vram_ne_placement;
961 extern struct ttm_placement vmw_vram_sys_placement;
962 extern struct ttm_placement vmw_vram_gmr_placement;
963 extern struct ttm_placement vmw_vram_gmr_ne_placement;
964 extern struct ttm_placement vmw_sys_placement;
965 extern struct ttm_placement vmw_sys_ne_placement;
966 extern struct ttm_placement vmw_evictable_placement;
967 extern struct ttm_placement vmw_srf_placement;
968 extern struct ttm_placement vmw_mob_placement;
969 extern struct ttm_placement vmw_mob_ne_placement;
970 extern struct ttm_placement vmw_nonfixed_placement;
971 extern struct ttm_bo_driver vmw_bo_driver;
972 extern int vmw_bo_map_dma(struct ttm_buffer_object *bo);
973 extern void vmw_bo_unmap_dma(struct ttm_buffer_object *bo);
974 extern const struct vmw_sg_table *
975 vmw_bo_sg_table(struct ttm_buffer_object *bo);
976 extern void vmw_piter_start(struct vmw_piter *viter,
977 			    const struct vmw_sg_table *vsgt,
978 			    unsigned long p_offs);
979 
980 /**
981  * vmw_piter_next - Advance the iterator one page.
982  *
983  * @viter: Pointer to the iterator to advance.
984  *
985  * Returns false if past the list of pages, true otherwise.
986  */
987 static inline bool vmw_piter_next(struct vmw_piter *viter)
988 {
989 	return viter->next(viter);
990 }
991 
992 /**
993  * vmw_piter_dma_addr - Return the DMA address of the current page.
994  *
995  * @viter: Pointer to the iterator
996  *
997  * Returns the DMA address of the page pointed to by @viter.
998  */
999 static inline dma_addr_t vmw_piter_dma_addr(struct vmw_piter *viter)
1000 {
1001 	return viter->dma_address(viter);
1002 }
1003 
1004 /**
1005  * vmw_piter_page - Return a pointer to the current page.
1006  *
1007  * @viter: Pointer to the iterator
1008  *
1009  * Returns the DMA address of the page pointed to by @viter.
1010  */
1011 static inline struct page *vmw_piter_page(struct vmw_piter *viter)
1012 {
1013 	return viter->page(viter);
1014 }
1015 
1016 /**
1017  * Command submission - vmwgfx_execbuf.c
1018  */
1019 
1020 extern int vmw_execbuf_ioctl(struct drm_device *dev, void *data,
1021 			     struct drm_file *file_priv);
1022 extern int vmw_execbuf_process(struct drm_file *file_priv,
1023 			       struct vmw_private *dev_priv,
1024 			       void __user *user_commands,
1025 			       void *kernel_commands,
1026 			       uint32_t command_size,
1027 			       uint64_t throttle_us,
1028 			       uint32_t dx_context_handle,
1029 			       struct drm_vmw_fence_rep __user
1030 			       *user_fence_rep,
1031 			       struct vmw_fence_obj **out_fence,
1032 			       uint32_t flags);
1033 extern void __vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv,
1034 					    struct vmw_fence_obj *fence);
1035 extern void vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv);
1036 
1037 extern int vmw_execbuf_fence_commands(struct drm_file *file_priv,
1038 				      struct vmw_private *dev_priv,
1039 				      struct vmw_fence_obj **p_fence,
1040 				      uint32_t *p_handle);
1041 extern void vmw_execbuf_copy_fence_user(struct vmw_private *dev_priv,
1042 					struct vmw_fpriv *vmw_fp,
1043 					int ret,
1044 					struct drm_vmw_fence_rep __user
1045 					*user_fence_rep,
1046 					struct vmw_fence_obj *fence,
1047 					uint32_t fence_handle,
1048 					int32_t out_fence_fd,
1049 					struct sync_file *sync_file);
1050 bool vmw_cmd_describe(const void *buf, u32 *size, char const **cmd);
1051 
1052 /**
1053  * IRQs and wating - vmwgfx_irq.c
1054  */
1055 
1056 extern int vmw_wait_seqno(struct vmw_private *dev_priv, bool lazy,
1057 			  uint32_t seqno, bool interruptible,
1058 			  unsigned long timeout);
1059 extern int vmw_irq_install(struct drm_device *dev, int irq);
1060 extern void vmw_irq_uninstall(struct drm_device *dev);
1061 extern bool vmw_seqno_passed(struct vmw_private *dev_priv,
1062 				uint32_t seqno);
1063 extern int vmw_fallback_wait(struct vmw_private *dev_priv,
1064 			     bool lazy,
1065 			     bool fifo_idle,
1066 			     uint32_t seqno,
1067 			     bool interruptible,
1068 			     unsigned long timeout);
1069 extern void vmw_update_seqno(struct vmw_private *dev_priv,
1070 				struct vmw_fifo_state *fifo_state);
1071 extern void vmw_seqno_waiter_add(struct vmw_private *dev_priv);
1072 extern void vmw_seqno_waiter_remove(struct vmw_private *dev_priv);
1073 extern void vmw_goal_waiter_add(struct vmw_private *dev_priv);
1074 extern void vmw_goal_waiter_remove(struct vmw_private *dev_priv);
1075 extern void vmw_generic_waiter_add(struct vmw_private *dev_priv, u32 flag,
1076 				   int *waiter_count);
1077 extern void vmw_generic_waiter_remove(struct vmw_private *dev_priv,
1078 				      u32 flag, int *waiter_count);
1079 
1080 /**
1081  * Rudimentary fence-like objects currently used only for throttling -
1082  * vmwgfx_marker.c
1083  */
1084 
1085 extern void vmw_marker_queue_init(struct vmw_marker_queue *queue);
1086 extern void vmw_marker_queue_takedown(struct vmw_marker_queue *queue);
1087 extern int vmw_marker_push(struct vmw_marker_queue *queue,
1088 			   uint32_t seqno);
1089 extern int vmw_marker_pull(struct vmw_marker_queue *queue,
1090 			   uint32_t signaled_seqno);
1091 extern int vmw_wait_lag(struct vmw_private *dev_priv,
1092 			struct vmw_marker_queue *queue, uint32_t us);
1093 
1094 /**
1095  * Kernel framebuffer - vmwgfx_fb.c
1096  */
1097 
1098 int vmw_fb_init(struct vmw_private *vmw_priv);
1099 int vmw_fb_close(struct vmw_private *dev_priv);
1100 int vmw_fb_off(struct vmw_private *vmw_priv);
1101 int vmw_fb_on(struct vmw_private *vmw_priv);
1102 
1103 /**
1104  * Kernel modesetting - vmwgfx_kms.c
1105  */
1106 
1107 int vmw_kms_init(struct vmw_private *dev_priv);
1108 int vmw_kms_close(struct vmw_private *dev_priv);
1109 int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
1110 				struct drm_file *file_priv);
1111 void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv);
1112 void vmw_kms_cursor_snoop(struct vmw_surface *srf,
1113 			  struct ttm_object_file *tfile,
1114 			  struct ttm_buffer_object *bo,
1115 			  SVGA3dCmdHeader *header);
1116 int vmw_kms_write_svga(struct vmw_private *vmw_priv,
1117 		       unsigned width, unsigned height, unsigned pitch,
1118 		       unsigned bpp, unsigned depth);
1119 bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
1120 				uint32_t pitch,
1121 				uint32_t height);
1122 u32 vmw_get_vblank_counter(struct drm_crtc *crtc);
1123 int vmw_enable_vblank(struct drm_crtc *crtc);
1124 void vmw_disable_vblank(struct drm_crtc *crtc);
1125 int vmw_kms_present(struct vmw_private *dev_priv,
1126 		    struct drm_file *file_priv,
1127 		    struct vmw_framebuffer *vfb,
1128 		    struct vmw_surface *surface,
1129 		    uint32_t sid, int32_t destX, int32_t destY,
1130 		    struct drm_vmw_rect *clips,
1131 		    uint32_t num_clips);
1132 int vmw_kms_update_layout_ioctl(struct drm_device *dev, void *data,
1133 				struct drm_file *file_priv);
1134 void vmw_kms_legacy_hotspot_clear(struct vmw_private *dev_priv);
1135 int vmw_kms_suspend(struct drm_device *dev);
1136 int vmw_kms_resume(struct drm_device *dev);
1137 void vmw_kms_lost_device(struct drm_device *dev);
1138 
1139 int vmw_dumb_create(struct drm_file *file_priv,
1140 		    struct drm_device *dev,
1141 		    struct drm_mode_create_dumb *args);
1142 
1143 int vmw_dumb_map_offset(struct drm_file *file_priv,
1144 			struct drm_device *dev, uint32_t handle,
1145 			uint64_t *offset);
1146 int vmw_dumb_destroy(struct drm_file *file_priv,
1147 		     struct drm_device *dev,
1148 		     uint32_t handle);
1149 extern int vmw_resource_pin(struct vmw_resource *res, bool interruptible);
1150 extern void vmw_resource_unpin(struct vmw_resource *res);
1151 extern enum vmw_res_type vmw_res_type(const struct vmw_resource *res);
1152 
1153 /**
1154  * Overlay control - vmwgfx_overlay.c
1155  */
1156 
1157 int vmw_overlay_init(struct vmw_private *dev_priv);
1158 int vmw_overlay_close(struct vmw_private *dev_priv);
1159 int vmw_overlay_ioctl(struct drm_device *dev, void *data,
1160 		      struct drm_file *file_priv);
1161 int vmw_overlay_resume_all(struct vmw_private *dev_priv);
1162 int vmw_overlay_pause_all(struct vmw_private *dev_priv);
1163 int vmw_overlay_claim(struct vmw_private *dev_priv, uint32_t *out);
1164 int vmw_overlay_unref(struct vmw_private *dev_priv, uint32_t stream_id);
1165 int vmw_overlay_num_overlays(struct vmw_private *dev_priv);
1166 int vmw_overlay_num_free_overlays(struct vmw_private *dev_priv);
1167 
1168 /**
1169  * GMR Id manager
1170  */
1171 
1172 extern const struct ttm_mem_type_manager_func vmw_gmrid_manager_func;
1173 
1174 /**
1175  * Prime - vmwgfx_prime.c
1176  */
1177 
1178 extern const struct dma_buf_ops vmw_prime_dmabuf_ops;
1179 extern int vmw_prime_fd_to_handle(struct drm_device *dev,
1180 				  struct drm_file *file_priv,
1181 				  int fd, u32 *handle);
1182 extern int vmw_prime_handle_to_fd(struct drm_device *dev,
1183 				  struct drm_file *file_priv,
1184 				  uint32_t handle, uint32_t flags,
1185 				  int *prime_fd);
1186 
1187 /*
1188  * MemoryOBject management -  vmwgfx_mob.c
1189  */
1190 struct vmw_mob;
1191 extern int vmw_mob_bind(struct vmw_private *dev_priv, struct vmw_mob *mob,
1192 			const struct vmw_sg_table *vsgt,
1193 			unsigned long num_data_pages, int32_t mob_id);
1194 extern void vmw_mob_unbind(struct vmw_private *dev_priv,
1195 			   struct vmw_mob *mob);
1196 extern void vmw_mob_destroy(struct vmw_mob *mob);
1197 extern struct vmw_mob *vmw_mob_create(unsigned long data_pages);
1198 extern int vmw_otables_setup(struct vmw_private *dev_priv);
1199 extern void vmw_otables_takedown(struct vmw_private *dev_priv);
1200 
1201 /*
1202  * Context management - vmwgfx_context.c
1203  */
1204 
1205 extern const struct vmw_user_resource_conv *user_context_converter;
1206 
1207 extern int vmw_context_define_ioctl(struct drm_device *dev, void *data,
1208 				    struct drm_file *file_priv);
1209 extern int vmw_extended_context_define_ioctl(struct drm_device *dev, void *data,
1210 					     struct drm_file *file_priv);
1211 extern int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
1212 				     struct drm_file *file_priv);
1213 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1214 extern struct vmw_cmdbuf_res_manager *
1215 vmw_context_res_man(struct vmw_resource *ctx);
1216 extern struct vmw_resource *vmw_context_cotable(struct vmw_resource *ctx,
1217 						SVGACOTableType cotable_type);
1218 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1219 struct vmw_ctx_binding_state;
1220 extern struct vmw_ctx_binding_state *
1221 vmw_context_binding_state(struct vmw_resource *ctx);
1222 extern void vmw_dx_context_scrub_cotables(struct vmw_resource *ctx,
1223 					  bool readback);
1224 extern int vmw_context_bind_dx_query(struct vmw_resource *ctx_res,
1225 				     struct vmw_buffer_object *mob);
1226 extern struct vmw_buffer_object *
1227 vmw_context_get_dx_query_mob(struct vmw_resource *ctx_res);
1228 
1229 
1230 /*
1231  * Surface management - vmwgfx_surface.c
1232  */
1233 
1234 extern const struct vmw_user_resource_conv *user_surface_converter;
1235 
1236 extern int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
1237 				     struct drm_file *file_priv);
1238 extern int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
1239 				    struct drm_file *file_priv);
1240 extern int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
1241 				       struct drm_file *file_priv);
1242 extern int vmw_gb_surface_define_ioctl(struct drm_device *dev, void *data,
1243 				       struct drm_file *file_priv);
1244 extern int vmw_gb_surface_reference_ioctl(struct drm_device *dev, void *data,
1245 					  struct drm_file *file_priv);
1246 int vmw_surface_gb_priv_define(struct drm_device *dev,
1247 			       uint32_t user_accounting_size,
1248 			       SVGA3dSurfaceAllFlags svga3d_flags,
1249 			       SVGA3dSurfaceFormat format,
1250 			       bool for_scanout,
1251 			       uint32_t num_mip_levels,
1252 			       uint32_t multisample_count,
1253 			       uint32_t array_size,
1254 			       struct drm_vmw_size size,
1255 			       SVGA3dMSPattern multisample_pattern,
1256 			       SVGA3dMSQualityLevel quality_level,
1257 			       struct vmw_surface **srf_out);
1258 extern int vmw_gb_surface_define_ext_ioctl(struct drm_device *dev,
1259 					   void *data,
1260 					   struct drm_file *file_priv);
1261 extern int vmw_gb_surface_reference_ext_ioctl(struct drm_device *dev,
1262 					      void *data,
1263 					      struct drm_file *file_priv);
1264 
1265 /*
1266  * Shader management - vmwgfx_shader.c
1267  */
1268 
1269 extern const struct vmw_user_resource_conv *user_shader_converter;
1270 
1271 extern int vmw_shader_define_ioctl(struct drm_device *dev, void *data,
1272 				   struct drm_file *file_priv);
1273 extern int vmw_shader_destroy_ioctl(struct drm_device *dev, void *data,
1274 				    struct drm_file *file_priv);
1275 extern int vmw_compat_shader_add(struct vmw_private *dev_priv,
1276 				 struct vmw_cmdbuf_res_manager *man,
1277 				 u32 user_key, const void *bytecode,
1278 				 SVGA3dShaderType shader_type,
1279 				 size_t size,
1280 				 struct list_head *list);
1281 extern int vmw_shader_remove(struct vmw_cmdbuf_res_manager *man,
1282 			     u32 user_key, SVGA3dShaderType shader_type,
1283 			     struct list_head *list);
1284 extern int vmw_dx_shader_add(struct vmw_cmdbuf_res_manager *man,
1285 			     struct vmw_resource *ctx,
1286 			     u32 user_key,
1287 			     SVGA3dShaderType shader_type,
1288 			     struct list_head *list);
1289 extern void vmw_dx_shader_cotable_list_scrub(struct vmw_private *dev_priv,
1290 					     struct list_head *list,
1291 					     bool readback);
1292 
1293 extern struct vmw_resource *
1294 vmw_shader_lookup(struct vmw_cmdbuf_res_manager *man,
1295 		  u32 user_key, SVGA3dShaderType shader_type);
1296 
1297 /*
1298  * Command buffer managed resources - vmwgfx_cmdbuf_res.c
1299  */
1300 
1301 extern struct vmw_cmdbuf_res_manager *
1302 vmw_cmdbuf_res_man_create(struct vmw_private *dev_priv);
1303 extern void vmw_cmdbuf_res_man_destroy(struct vmw_cmdbuf_res_manager *man);
1304 extern size_t vmw_cmdbuf_res_man_size(void);
1305 extern struct vmw_resource *
1306 vmw_cmdbuf_res_lookup(struct vmw_cmdbuf_res_manager *man,
1307 		      enum vmw_cmdbuf_res_type res_type,
1308 		      u32 user_key);
1309 extern void vmw_cmdbuf_res_revert(struct list_head *list);
1310 extern void vmw_cmdbuf_res_commit(struct list_head *list);
1311 extern int vmw_cmdbuf_res_add(struct vmw_cmdbuf_res_manager *man,
1312 			      enum vmw_cmdbuf_res_type res_type,
1313 			      u32 user_key,
1314 			      struct vmw_resource *res,
1315 			      struct list_head *list);
1316 extern int vmw_cmdbuf_res_remove(struct vmw_cmdbuf_res_manager *man,
1317 				 enum vmw_cmdbuf_res_type res_type,
1318 				 u32 user_key,
1319 				 struct list_head *list,
1320 				 struct vmw_resource **res);
1321 
1322 /*
1323  * COTable management - vmwgfx_cotable.c
1324  */
1325 extern const SVGACOTableType vmw_cotable_scrub_order[];
1326 extern struct vmw_resource *vmw_cotable_alloc(struct vmw_private *dev_priv,
1327 					      struct vmw_resource *ctx,
1328 					      u32 type);
1329 extern int vmw_cotable_notify(struct vmw_resource *res, int id);
1330 extern int vmw_cotable_scrub(struct vmw_resource *res, bool readback);
1331 extern void vmw_cotable_add_resource(struct vmw_resource *ctx,
1332 				     struct list_head *head);
1333 
1334 /*
1335  * Command buffer managerment vmwgfx_cmdbuf.c
1336  */
1337 struct vmw_cmdbuf_man;
1338 struct vmw_cmdbuf_header;
1339 
1340 extern struct vmw_cmdbuf_man *
1341 vmw_cmdbuf_man_create(struct vmw_private *dev_priv);
1342 extern int vmw_cmdbuf_set_pool_size(struct vmw_cmdbuf_man *man,
1343 				    size_t size, size_t default_size);
1344 extern void vmw_cmdbuf_remove_pool(struct vmw_cmdbuf_man *man);
1345 extern void vmw_cmdbuf_man_destroy(struct vmw_cmdbuf_man *man);
1346 extern int vmw_cmdbuf_idle(struct vmw_cmdbuf_man *man, bool interruptible,
1347 			   unsigned long timeout);
1348 extern void *vmw_cmdbuf_reserve(struct vmw_cmdbuf_man *man, size_t size,
1349 				int ctx_id, bool interruptible,
1350 				struct vmw_cmdbuf_header *header);
1351 extern void vmw_cmdbuf_commit(struct vmw_cmdbuf_man *man, size_t size,
1352 			      struct vmw_cmdbuf_header *header,
1353 			      bool flush);
1354 extern void *vmw_cmdbuf_alloc(struct vmw_cmdbuf_man *man,
1355 			      size_t size, bool interruptible,
1356 			      struct vmw_cmdbuf_header **p_header);
1357 extern void vmw_cmdbuf_header_free(struct vmw_cmdbuf_header *header);
1358 extern int vmw_cmdbuf_cur_flush(struct vmw_cmdbuf_man *man,
1359 				bool interruptible);
1360 extern void vmw_cmdbuf_irqthread(struct vmw_cmdbuf_man *man);
1361 
1362 /* CPU blit utilities - vmwgfx_blit.c */
1363 
1364 /**
1365  * struct vmw_diff_cpy - CPU blit information structure
1366  *
1367  * @rect: The output bounding box rectangle.
1368  * @line: The current line of the blit.
1369  * @line_offset: Offset of the current line segment.
1370  * @cpp: Bytes per pixel (granularity information).
1371  * @memcpy: Which memcpy function to use.
1372  */
1373 struct vmw_diff_cpy {
1374 	struct drm_rect rect;
1375 	size_t line;
1376 	size_t line_offset;
1377 	int cpp;
1378 	void (*do_cpy)(struct vmw_diff_cpy *diff, u8 *dest, const u8 *src,
1379 		       size_t n);
1380 };
1381 
1382 #define VMW_CPU_BLIT_INITIALIZER {	\
1383 	.do_cpy = vmw_memcpy,		\
1384 }
1385 
1386 #define VMW_CPU_BLIT_DIFF_INITIALIZER(_cpp) {	  \
1387 	.line = 0,				  \
1388 	.line_offset = 0,			  \
1389 	.rect = { .x1 = INT_MAX/2,		  \
1390 		  .y1 = INT_MAX/2,		  \
1391 		  .x2 = INT_MIN/2,		  \
1392 		  .y2 = INT_MIN/2		  \
1393 	},					  \
1394 	.cpp = _cpp,				  \
1395 	.do_cpy = vmw_diff_memcpy,		  \
1396 }
1397 
1398 void vmw_diff_memcpy(struct vmw_diff_cpy *diff, u8 *dest, const u8 *src,
1399 		     size_t n);
1400 
1401 void vmw_memcpy(struct vmw_diff_cpy *diff, u8 *dest, const u8 *src, size_t n);
1402 
1403 int vmw_bo_cpu_blit(struct ttm_buffer_object *dst,
1404 		    u32 dst_offset, u32 dst_stride,
1405 		    struct ttm_buffer_object *src,
1406 		    u32 src_offset, u32 src_stride,
1407 		    u32 w, u32 h,
1408 		    struct vmw_diff_cpy *diff);
1409 
1410 /* Host messaging -vmwgfx_msg.c: */
1411 int vmw_host_get_guestinfo(const char *guest_info_param,
1412 			   char *buffer, size_t *length);
1413 int vmw_host_log(const char *log);
1414 int vmw_msg_ioctl(struct drm_device *dev, void *data,
1415 		  struct drm_file *file_priv);
1416 
1417 /* VMW logging */
1418 
1419 /**
1420  * VMW_DEBUG_USER - Debug output for user-space debugging.
1421  *
1422  * @fmt: printf() like format string.
1423  *
1424  * This macro is for logging user-space error and debugging messages for e.g.
1425  * command buffer execution errors due to malformed commands, invalid context,
1426  * etc.
1427  */
1428 #define VMW_DEBUG_USER(fmt, ...)                                              \
1429 	DRM_DEBUG_DRIVER(fmt, ##__VA_ARGS__)
1430 
1431 /* Resource dirtying - vmwgfx_page_dirty.c */
1432 void vmw_bo_dirty_scan(struct vmw_buffer_object *vbo);
1433 int vmw_bo_dirty_add(struct vmw_buffer_object *vbo);
1434 void vmw_bo_dirty_transfer_to_res(struct vmw_resource *res);
1435 void vmw_bo_dirty_clear_res(struct vmw_resource *res);
1436 void vmw_bo_dirty_release(struct vmw_buffer_object *vbo);
1437 void vmw_bo_dirty_unmap(struct vmw_buffer_object *vbo,
1438 			pgoff_t start, pgoff_t end);
1439 vm_fault_t vmw_bo_vm_fault(struct vm_fault *vmf);
1440 vm_fault_t vmw_bo_vm_mkwrite(struct vm_fault *vmf);
1441 
1442 /**
1443  * VMW_DEBUG_KMS - Debug output for kernel mode-setting
1444  *
1445  * This macro is for debugging vmwgfx mode-setting code.
1446  */
1447 #define VMW_DEBUG_KMS(fmt, ...)                                               \
1448 	DRM_DEBUG_DRIVER(fmt, ##__VA_ARGS__)
1449 
1450 /**
1451  * Inline helper functions
1452  */
1453 
1454 static inline void vmw_surface_unreference(struct vmw_surface **srf)
1455 {
1456 	struct vmw_surface *tmp_srf = *srf;
1457 	struct vmw_resource *res = &tmp_srf->res;
1458 	*srf = NULL;
1459 
1460 	vmw_resource_unreference(&res);
1461 }
1462 
1463 static inline struct vmw_surface *vmw_surface_reference(struct vmw_surface *srf)
1464 {
1465 	(void) vmw_resource_reference(&srf->res);
1466 	return srf;
1467 }
1468 
1469 static inline void vmw_bo_unreference(struct vmw_buffer_object **buf)
1470 {
1471 	struct vmw_buffer_object *tmp_buf = *buf;
1472 
1473 	*buf = NULL;
1474 	if (tmp_buf != NULL) {
1475 		ttm_bo_put(&tmp_buf->base);
1476 	}
1477 }
1478 
1479 static inline struct vmw_buffer_object *
1480 vmw_bo_reference(struct vmw_buffer_object *buf)
1481 {
1482 	ttm_bo_get(&buf->base);
1483 	return buf;
1484 }
1485 
1486 static inline struct ttm_mem_global *vmw_mem_glob(struct vmw_private *dev_priv)
1487 {
1488 	return &ttm_mem_glob;
1489 }
1490 
1491 static inline void vmw_fifo_resource_inc(struct vmw_private *dev_priv)
1492 {
1493 	atomic_inc(&dev_priv->num_fifo_resources);
1494 }
1495 
1496 static inline void vmw_fifo_resource_dec(struct vmw_private *dev_priv)
1497 {
1498 	atomic_dec(&dev_priv->num_fifo_resources);
1499 }
1500 
1501 /**
1502  * vmw_mmio_read - Perform a MMIO read from volatile memory
1503  *
1504  * @addr: The address to read from
1505  *
1506  * This function is intended to be equivalent to ioread32() on
1507  * memremap'd memory, but without byteswapping.
1508  */
1509 static inline u32 vmw_mmio_read(u32 *addr)
1510 {
1511 	return READ_ONCE(*addr);
1512 }
1513 
1514 /**
1515  * vmw_mmio_write - Perform a MMIO write to volatile memory
1516  *
1517  * @addr: The address to write to
1518  *
1519  * This function is intended to be equivalent to iowrite32 on
1520  * memremap'd memory, but without byteswapping.
1521  */
1522 static inline void vmw_mmio_write(u32 value, u32 *addr)
1523 {
1524 	WRITE_ONCE(*addr, value);
1525 }
1526 #endif
1527