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