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