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