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