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