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 	 * Currently requested_layout_mutex is used to protect the gui
470 	 * positionig state in display unit. With that use case currently this
471 	 * mutex is only taken during layout ioctl and atomic check_modeset.
472 	 * Other display unit state can be protected with this mutex but that
473 	 * needs careful consideration.
474 	 */
475 	struct mutex requested_layout_mutex;
476 
477 	/*
478 	 * Framebuffer info.
479 	 */
480 
481 	void *fb_info;
482 	enum vmw_display_unit_type active_display_unit;
483 	struct vmw_legacy_display *ldu_priv;
484 	struct vmw_overlay *overlay_priv;
485 	struct drm_property *hotplug_mode_update_property;
486 	struct drm_property *implicit_placement_property;
487 	unsigned num_implicit;
488 	struct vmw_framebuffer *implicit_fb;
489 	struct mutex global_kms_state_mutex;
490 	spinlock_t cursor_lock;
491 	struct drm_atomic_state *suspend_state;
492 
493 	/*
494 	 * Context and surface management.
495 	 */
496 
497 	spinlock_t resource_lock;
498 	struct idr res_idr[vmw_res_max];
499 	/*
500 	 * Block lastclose from racing with firstopen.
501 	 */
502 
503 	struct mutex init_mutex;
504 
505 	/*
506 	 * A resource manager for kernel-only surfaces and
507 	 * contexts.
508 	 */
509 
510 	struct ttm_object_device *tdev;
511 
512 	/*
513 	 * Fencing and IRQs.
514 	 */
515 
516 	atomic_t marker_seq;
517 	wait_queue_head_t fence_queue;
518 	wait_queue_head_t fifo_queue;
519 	spinlock_t waiter_lock;
520 	int fence_queue_waiters; /* Protected by waiter_lock */
521 	int goal_queue_waiters; /* Protected by waiter_lock */
522 	int cmdbuf_waiters; /* Protected by waiter_lock */
523 	int error_waiters; /* Protected by waiter_lock */
524 	int fifo_queue_waiters; /* Protected by waiter_lock */
525 	uint32_t last_read_seqno;
526 	struct vmw_fence_manager *fman;
527 	uint32_t irq_mask; /* Updates protected by waiter_lock */
528 
529 	/*
530 	 * Device state
531 	 */
532 
533 	uint32_t traces_state;
534 	uint32_t enable_state;
535 	uint32_t config_done_state;
536 
537 	/**
538 	 * Execbuf
539 	 */
540 	/**
541 	 * Protected by the cmdbuf mutex.
542 	 */
543 
544 	struct vmw_sw_context ctx;
545 	struct mutex cmdbuf_mutex;
546 	struct mutex binding_mutex;
547 
548 	/**
549 	 * Operating mode.
550 	 */
551 
552 	bool stealth;
553 	bool enable_fb;
554 	spinlock_t svga_lock;
555 
556 	/**
557 	 * Master management.
558 	 */
559 
560 	struct vmw_master *active_master;
561 	struct vmw_master fbdev_master;
562 	struct notifier_block pm_nb;
563 	bool refuse_hibernation;
564 	bool suspend_locked;
565 
566 	struct mutex release_mutex;
567 	atomic_t num_fifo_resources;
568 
569 	/*
570 	 * Replace this with an rwsem as soon as we have down_xx_interruptible()
571 	 */
572 	struct ttm_lock reservation_sem;
573 
574 	/*
575 	 * Query processing. These members
576 	 * are protected by the cmdbuf mutex.
577 	 */
578 
579 	struct vmw_buffer_object *dummy_query_bo;
580 	struct vmw_buffer_object *pinned_bo;
581 	uint32_t query_cid;
582 	uint32_t query_cid_valid;
583 	bool dummy_query_bo_pinned;
584 
585 	/*
586 	 * Surface swapping. The "surface_lru" list is protected by the
587 	 * resource lock in order to be able to destroy a surface and take
588 	 * it off the lru atomically. "used_memory_size" is currently
589 	 * protected by the cmdbuf mutex for simplicity.
590 	 */
591 
592 	struct list_head res_lru[vmw_res_max];
593 	uint32_t used_memory_size;
594 
595 	/*
596 	 * DMA mapping stuff.
597 	 */
598 	enum vmw_dma_map_mode map_mode;
599 
600 	/*
601 	 * Guest Backed stuff
602 	 */
603 	struct vmw_otable_batch otable_batch;
604 
605 	struct vmw_cmdbuf_man *cman;
606 	DECLARE_BITMAP(irqthread_pending, VMW_IRQTHREAD_MAX);
607 };
608 
609 static inline struct vmw_surface *vmw_res_to_srf(struct vmw_resource *res)
610 {
611 	return container_of(res, struct vmw_surface, res);
612 }
613 
614 static inline struct vmw_private *vmw_priv(struct drm_device *dev)
615 {
616 	return (struct vmw_private *)dev->dev_private;
617 }
618 
619 static inline struct vmw_fpriv *vmw_fpriv(struct drm_file *file_priv)
620 {
621 	return (struct vmw_fpriv *)file_priv->driver_priv;
622 }
623 
624 static inline struct vmw_master *vmw_master(struct drm_master *master)
625 {
626 	return (struct vmw_master *) master->driver_priv;
627 }
628 
629 /*
630  * The locking here is fine-grained, so that it is performed once
631  * for every read- and write operation. This is of course costly, but we
632  * don't perform much register access in the timing critical paths anyway.
633  * Instead we have the extra benefit of being sure that we don't forget
634  * the hw lock around register accesses.
635  */
636 static inline void vmw_write(struct vmw_private *dev_priv,
637 			     unsigned int offset, uint32_t value)
638 {
639 	spin_lock(&dev_priv->hw_lock);
640 	outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
641 	outl(value, dev_priv->io_start + VMWGFX_VALUE_PORT);
642 	spin_unlock(&dev_priv->hw_lock);
643 }
644 
645 static inline uint32_t vmw_read(struct vmw_private *dev_priv,
646 				unsigned int offset)
647 {
648 	u32 val;
649 
650 	spin_lock(&dev_priv->hw_lock);
651 	outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
652 	val = inl(dev_priv->io_start + VMWGFX_VALUE_PORT);
653 	spin_unlock(&dev_priv->hw_lock);
654 
655 	return val;
656 }
657 
658 extern void vmw_svga_enable(struct vmw_private *dev_priv);
659 extern void vmw_svga_disable(struct vmw_private *dev_priv);
660 
661 
662 /**
663  * GMR utilities - vmwgfx_gmr.c
664  */
665 
666 extern int vmw_gmr_bind(struct vmw_private *dev_priv,
667 			const struct vmw_sg_table *vsgt,
668 			unsigned long num_pages,
669 			int gmr_id);
670 extern void vmw_gmr_unbind(struct vmw_private *dev_priv, int gmr_id);
671 
672 /**
673  * Resource utilities - vmwgfx_resource.c
674  */
675 struct vmw_user_resource_conv;
676 
677 extern void vmw_resource_unreference(struct vmw_resource **p_res);
678 extern struct vmw_resource *vmw_resource_reference(struct vmw_resource *res);
679 extern struct vmw_resource *
680 vmw_resource_reference_unless_doomed(struct vmw_resource *res);
681 extern int vmw_resource_validate(struct vmw_resource *res, bool intr);
682 extern int vmw_resource_reserve(struct vmw_resource *res, bool interruptible,
683 				bool no_backup);
684 extern bool vmw_resource_needs_backup(const struct vmw_resource *res);
685 extern int vmw_user_lookup_handle(struct vmw_private *dev_priv,
686 				  struct ttm_object_file *tfile,
687 				  uint32_t handle,
688 				  struct vmw_surface **out_surf,
689 				  struct vmw_buffer_object **out_buf);
690 extern int vmw_user_resource_lookup_handle(
691 	struct vmw_private *dev_priv,
692 	struct ttm_object_file *tfile,
693 	uint32_t handle,
694 	const struct vmw_user_resource_conv *converter,
695 	struct vmw_resource **p_res);
696 extern struct vmw_resource *
697 vmw_user_resource_noref_lookup_handle(struct vmw_private *dev_priv,
698 				      struct ttm_object_file *tfile,
699 				      uint32_t handle,
700 				      const struct vmw_user_resource_conv *
701 				      converter);
702 extern int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
703 				  struct drm_file *file_priv);
704 extern int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
705 				  struct drm_file *file_priv);
706 extern int vmw_user_stream_lookup(struct vmw_private *dev_priv,
707 				  struct ttm_object_file *tfile,
708 				  uint32_t *inout_id,
709 				  struct vmw_resource **out);
710 extern void vmw_resource_unreserve(struct vmw_resource *res,
711 				   bool switch_backup,
712 				   struct vmw_buffer_object *new_backup,
713 				   unsigned long new_backup_offset);
714 extern void vmw_query_move_notify(struct ttm_buffer_object *bo,
715 				  struct ttm_mem_reg *mem);
716 extern int vmw_query_readback_all(struct vmw_buffer_object *dx_query_mob);
717 extern void vmw_resource_evict_all(struct vmw_private *dev_priv);
718 extern void vmw_resource_unbind_list(struct vmw_buffer_object *vbo);
719 
720 /**
721  * vmw_user_resource_noref_release - release a user resource pointer looked up
722  * without reference
723  */
724 static inline void vmw_user_resource_noref_release(void)
725 {
726 	ttm_base_object_noref_release();
727 }
728 
729 /**
730  * Buffer object helper functions - vmwgfx_bo.c
731  */
732 extern int vmw_bo_pin_in_placement(struct vmw_private *vmw_priv,
733 				   struct vmw_buffer_object *bo,
734 				   struct ttm_placement *placement,
735 				   bool interruptible);
736 extern int vmw_bo_pin_in_vram(struct vmw_private *dev_priv,
737 			      struct vmw_buffer_object *buf,
738 			      bool interruptible);
739 extern int vmw_bo_pin_in_vram_or_gmr(struct vmw_private *dev_priv,
740 				     struct vmw_buffer_object *buf,
741 				     bool interruptible);
742 extern int vmw_bo_pin_in_start_of_vram(struct vmw_private *vmw_priv,
743 				       struct vmw_buffer_object *bo,
744 				       bool interruptible);
745 extern int vmw_bo_unpin(struct vmw_private *vmw_priv,
746 			struct vmw_buffer_object *bo,
747 			bool interruptible);
748 extern void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *buf,
749 				 SVGAGuestPtr *ptr);
750 extern void vmw_bo_pin_reserved(struct vmw_buffer_object *bo, bool pin);
751 extern void vmw_bo_bo_free(struct ttm_buffer_object *bo);
752 extern int vmw_bo_init(struct vmw_private *dev_priv,
753 		       struct vmw_buffer_object *vmw_bo,
754 		       size_t size, struct ttm_placement *placement,
755 		       bool interuptable,
756 		       void (*bo_free)(struct ttm_buffer_object *bo));
757 extern int vmw_user_bo_verify_access(struct ttm_buffer_object *bo,
758 				     struct ttm_object_file *tfile);
759 extern int vmw_user_bo_alloc(struct vmw_private *dev_priv,
760 			     struct ttm_object_file *tfile,
761 			     uint32_t size,
762 			     bool shareable,
763 			     uint32_t *handle,
764 			     struct vmw_buffer_object **p_dma_buf,
765 			     struct ttm_base_object **p_base);
766 extern int vmw_user_bo_reference(struct ttm_object_file *tfile,
767 				 struct vmw_buffer_object *dma_buf,
768 				 uint32_t *handle);
769 extern int vmw_bo_alloc_ioctl(struct drm_device *dev, void *data,
770 			      struct drm_file *file_priv);
771 extern int vmw_bo_unref_ioctl(struct drm_device *dev, void *data,
772 			      struct drm_file *file_priv);
773 extern int vmw_user_bo_synccpu_ioctl(struct drm_device *dev, void *data,
774 				     struct drm_file *file_priv);
775 extern int vmw_user_bo_lookup(struct ttm_object_file *tfile,
776 			      uint32_t id, struct vmw_buffer_object **out,
777 			      struct ttm_base_object **base);
778 extern void vmw_bo_fence_single(struct ttm_buffer_object *bo,
779 				struct vmw_fence_obj *fence);
780 extern void *vmw_bo_map_and_cache(struct vmw_buffer_object *vbo);
781 extern void vmw_bo_unmap(struct vmw_buffer_object *vbo);
782 extern void vmw_bo_move_notify(struct ttm_buffer_object *bo,
783 			       struct ttm_mem_reg *mem);
784 extern void vmw_bo_swap_notify(struct ttm_buffer_object *bo);
785 extern struct vmw_buffer_object *
786 vmw_user_bo_noref_lookup(struct ttm_object_file *tfile, u32 handle);
787 
788 /**
789  * vmw_user_bo_noref_release - release a buffer object pointer looked up
790  * without reference
791  */
792 static inline void vmw_user_bo_noref_release(void)
793 {
794 	ttm_base_object_noref_release();
795 }
796 
797 
798 /**
799  * Misc Ioctl functionality - vmwgfx_ioctl.c
800  */
801 
802 extern int vmw_getparam_ioctl(struct drm_device *dev, void *data,
803 			      struct drm_file *file_priv);
804 extern int vmw_get_cap_3d_ioctl(struct drm_device *dev, void *data,
805 				struct drm_file *file_priv);
806 extern int vmw_present_ioctl(struct drm_device *dev, void *data,
807 			     struct drm_file *file_priv);
808 extern int vmw_present_readback_ioctl(struct drm_device *dev, void *data,
809 				      struct drm_file *file_priv);
810 extern __poll_t vmw_fops_poll(struct file *filp,
811 				  struct poll_table_struct *wait);
812 extern ssize_t vmw_fops_read(struct file *filp, char __user *buffer,
813 			     size_t count, loff_t *offset);
814 
815 /**
816  * Fifo utilities - vmwgfx_fifo.c
817  */
818 
819 extern int vmw_fifo_init(struct vmw_private *dev_priv,
820 			 struct vmw_fifo_state *fifo);
821 extern void vmw_fifo_release(struct vmw_private *dev_priv,
822 			     struct vmw_fifo_state *fifo);
823 extern void *vmw_fifo_reserve(struct vmw_private *dev_priv, uint32_t bytes);
824 extern void *
825 vmw_fifo_reserve_dx(struct vmw_private *dev_priv, uint32_t bytes, int ctx_id);
826 extern void vmw_fifo_commit(struct vmw_private *dev_priv, uint32_t bytes);
827 extern void vmw_fifo_commit_flush(struct vmw_private *dev_priv, uint32_t bytes);
828 extern int vmw_fifo_send_fence(struct vmw_private *dev_priv,
829 			       uint32_t *seqno);
830 extern void vmw_fifo_ping_host_locked(struct vmw_private *, uint32_t reason);
831 extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
832 extern bool vmw_fifo_have_3d(struct vmw_private *dev_priv);
833 extern bool vmw_fifo_have_pitchlock(struct vmw_private *dev_priv);
834 extern int vmw_fifo_emit_dummy_query(struct vmw_private *dev_priv,
835 				     uint32_t cid);
836 extern int vmw_fifo_flush(struct vmw_private *dev_priv,
837 			  bool interruptible);
838 
839 /**
840  * TTM glue - vmwgfx_ttm_glue.c
841  */
842 
843 extern int vmw_mmap(struct file *filp, struct vm_area_struct *vma);
844 
845 /**
846  * TTM buffer object driver - vmwgfx_ttm_buffer.c
847  */
848 
849 extern const size_t vmw_tt_size;
850 extern struct ttm_placement vmw_vram_placement;
851 extern struct ttm_placement vmw_vram_ne_placement;
852 extern struct ttm_placement vmw_vram_sys_placement;
853 extern struct ttm_placement vmw_vram_gmr_placement;
854 extern struct ttm_placement vmw_vram_gmr_ne_placement;
855 extern struct ttm_placement vmw_sys_placement;
856 extern struct ttm_placement vmw_sys_ne_placement;
857 extern struct ttm_placement vmw_evictable_placement;
858 extern struct ttm_placement vmw_srf_placement;
859 extern struct ttm_placement vmw_mob_placement;
860 extern struct ttm_placement vmw_mob_ne_placement;
861 extern struct ttm_placement vmw_nonfixed_placement;
862 extern struct ttm_bo_driver vmw_bo_driver;
863 extern int vmw_dma_quiescent(struct drm_device *dev);
864 extern int vmw_bo_map_dma(struct ttm_buffer_object *bo);
865 extern void vmw_bo_unmap_dma(struct ttm_buffer_object *bo);
866 extern const struct vmw_sg_table *
867 vmw_bo_sg_table(struct ttm_buffer_object *bo);
868 extern void vmw_piter_start(struct vmw_piter *viter,
869 			    const struct vmw_sg_table *vsgt,
870 			    unsigned long p_offs);
871 
872 /**
873  * vmw_piter_next - Advance the iterator one page.
874  *
875  * @viter: Pointer to the iterator to advance.
876  *
877  * Returns false if past the list of pages, true otherwise.
878  */
879 static inline bool vmw_piter_next(struct vmw_piter *viter)
880 {
881 	return viter->next(viter);
882 }
883 
884 /**
885  * vmw_piter_dma_addr - Return the DMA address of the current page.
886  *
887  * @viter: Pointer to the iterator
888  *
889  * Returns the DMA address of the page pointed to by @viter.
890  */
891 static inline dma_addr_t vmw_piter_dma_addr(struct vmw_piter *viter)
892 {
893 	return viter->dma_address(viter);
894 }
895 
896 /**
897  * vmw_piter_page - Return a pointer to the current page.
898  *
899  * @viter: Pointer to the iterator
900  *
901  * Returns the DMA address of the page pointed to by @viter.
902  */
903 static inline struct page *vmw_piter_page(struct vmw_piter *viter)
904 {
905 	return viter->page(viter);
906 }
907 
908 /**
909  * Command submission - vmwgfx_execbuf.c
910  */
911 
912 extern int vmw_execbuf_ioctl(struct drm_device *dev, unsigned long data,
913 			     struct drm_file *file_priv, size_t size);
914 extern int vmw_execbuf_process(struct drm_file *file_priv,
915 			       struct vmw_private *dev_priv,
916 			       void __user *user_commands,
917 			       void *kernel_commands,
918 			       uint32_t command_size,
919 			       uint64_t throttle_us,
920 			       uint32_t dx_context_handle,
921 			       struct drm_vmw_fence_rep __user
922 			       *user_fence_rep,
923 			       struct vmw_fence_obj **out_fence,
924 			       uint32_t flags);
925 extern void __vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv,
926 					    struct vmw_fence_obj *fence);
927 extern void vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv);
928 
929 extern int vmw_execbuf_fence_commands(struct drm_file *file_priv,
930 				      struct vmw_private *dev_priv,
931 				      struct vmw_fence_obj **p_fence,
932 				      uint32_t *p_handle);
933 extern void vmw_execbuf_copy_fence_user(struct vmw_private *dev_priv,
934 					struct vmw_fpriv *vmw_fp,
935 					int ret,
936 					struct drm_vmw_fence_rep __user
937 					*user_fence_rep,
938 					struct vmw_fence_obj *fence,
939 					uint32_t fence_handle,
940 					int32_t out_fence_fd,
941 					struct sync_file *sync_file);
942 bool vmw_cmd_describe(const void *buf, u32 *size, char const **cmd);
943 
944 /**
945  * IRQs and wating - vmwgfx_irq.c
946  */
947 
948 extern int vmw_wait_seqno(struct vmw_private *dev_priv, bool lazy,
949 			  uint32_t seqno, bool interruptible,
950 			  unsigned long timeout);
951 extern int vmw_irq_install(struct drm_device *dev, int irq);
952 extern void vmw_irq_uninstall(struct drm_device *dev);
953 extern bool vmw_seqno_passed(struct vmw_private *dev_priv,
954 				uint32_t seqno);
955 extern int vmw_fallback_wait(struct vmw_private *dev_priv,
956 			     bool lazy,
957 			     bool fifo_idle,
958 			     uint32_t seqno,
959 			     bool interruptible,
960 			     unsigned long timeout);
961 extern void vmw_update_seqno(struct vmw_private *dev_priv,
962 				struct vmw_fifo_state *fifo_state);
963 extern void vmw_seqno_waiter_add(struct vmw_private *dev_priv);
964 extern void vmw_seqno_waiter_remove(struct vmw_private *dev_priv);
965 extern void vmw_goal_waiter_add(struct vmw_private *dev_priv);
966 extern void vmw_goal_waiter_remove(struct vmw_private *dev_priv);
967 extern void vmw_generic_waiter_add(struct vmw_private *dev_priv, u32 flag,
968 				   int *waiter_count);
969 extern void vmw_generic_waiter_remove(struct vmw_private *dev_priv,
970 				      u32 flag, int *waiter_count);
971 
972 /**
973  * Rudimentary fence-like objects currently used only for throttling -
974  * vmwgfx_marker.c
975  */
976 
977 extern void vmw_marker_queue_init(struct vmw_marker_queue *queue);
978 extern void vmw_marker_queue_takedown(struct vmw_marker_queue *queue);
979 extern int vmw_marker_push(struct vmw_marker_queue *queue,
980 			   uint32_t seqno);
981 extern int vmw_marker_pull(struct vmw_marker_queue *queue,
982 			   uint32_t signaled_seqno);
983 extern int vmw_wait_lag(struct vmw_private *dev_priv,
984 			struct vmw_marker_queue *queue, uint32_t us);
985 
986 /**
987  * Kernel framebuffer - vmwgfx_fb.c
988  */
989 
990 int vmw_fb_init(struct vmw_private *vmw_priv);
991 int vmw_fb_close(struct vmw_private *dev_priv);
992 int vmw_fb_off(struct vmw_private *vmw_priv);
993 int vmw_fb_on(struct vmw_private *vmw_priv);
994 
995 /**
996  * Kernel modesetting - vmwgfx_kms.c
997  */
998 
999 int vmw_kms_init(struct vmw_private *dev_priv);
1000 int vmw_kms_close(struct vmw_private *dev_priv);
1001 int vmw_kms_save_vga(struct vmw_private *vmw_priv);
1002 int vmw_kms_restore_vga(struct vmw_private *vmw_priv);
1003 int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
1004 				struct drm_file *file_priv);
1005 void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv);
1006 void vmw_kms_cursor_snoop(struct vmw_surface *srf,
1007 			  struct ttm_object_file *tfile,
1008 			  struct ttm_buffer_object *bo,
1009 			  SVGA3dCmdHeader *header);
1010 int vmw_kms_write_svga(struct vmw_private *vmw_priv,
1011 		       unsigned width, unsigned height, unsigned pitch,
1012 		       unsigned bpp, unsigned depth);
1013 void vmw_kms_idle_workqueues(struct vmw_master *vmaster);
1014 bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
1015 				uint32_t pitch,
1016 				uint32_t height);
1017 u32 vmw_get_vblank_counter(struct drm_device *dev, unsigned int pipe);
1018 int vmw_enable_vblank(struct drm_device *dev, unsigned int pipe);
1019 void vmw_disable_vblank(struct drm_device *dev, unsigned int pipe);
1020 int vmw_kms_present(struct vmw_private *dev_priv,
1021 		    struct drm_file *file_priv,
1022 		    struct vmw_framebuffer *vfb,
1023 		    struct vmw_surface *surface,
1024 		    uint32_t sid, int32_t destX, int32_t destY,
1025 		    struct drm_vmw_rect *clips,
1026 		    uint32_t num_clips);
1027 int vmw_kms_update_layout_ioctl(struct drm_device *dev, void *data,
1028 				struct drm_file *file_priv);
1029 void vmw_kms_legacy_hotspot_clear(struct vmw_private *dev_priv);
1030 int vmw_kms_suspend(struct drm_device *dev);
1031 int vmw_kms_resume(struct drm_device *dev);
1032 void vmw_kms_lost_device(struct drm_device *dev);
1033 
1034 int vmw_dumb_create(struct drm_file *file_priv,
1035 		    struct drm_device *dev,
1036 		    struct drm_mode_create_dumb *args);
1037 
1038 int vmw_dumb_map_offset(struct drm_file *file_priv,
1039 			struct drm_device *dev, uint32_t handle,
1040 			uint64_t *offset);
1041 int vmw_dumb_destroy(struct drm_file *file_priv,
1042 		     struct drm_device *dev,
1043 		     uint32_t handle);
1044 extern int vmw_resource_pin(struct vmw_resource *res, bool interruptible);
1045 extern void vmw_resource_unpin(struct vmw_resource *res);
1046 extern enum vmw_res_type vmw_res_type(const struct vmw_resource *res);
1047 
1048 /**
1049  * Overlay control - vmwgfx_overlay.c
1050  */
1051 
1052 int vmw_overlay_init(struct vmw_private *dev_priv);
1053 int vmw_overlay_close(struct vmw_private *dev_priv);
1054 int vmw_overlay_ioctl(struct drm_device *dev, void *data,
1055 		      struct drm_file *file_priv);
1056 int vmw_overlay_stop_all(struct vmw_private *dev_priv);
1057 int vmw_overlay_resume_all(struct vmw_private *dev_priv);
1058 int vmw_overlay_pause_all(struct vmw_private *dev_priv);
1059 int vmw_overlay_claim(struct vmw_private *dev_priv, uint32_t *out);
1060 int vmw_overlay_unref(struct vmw_private *dev_priv, uint32_t stream_id);
1061 int vmw_overlay_num_overlays(struct vmw_private *dev_priv);
1062 int vmw_overlay_num_free_overlays(struct vmw_private *dev_priv);
1063 
1064 /**
1065  * GMR Id manager
1066  */
1067 
1068 extern const struct ttm_mem_type_manager_func vmw_gmrid_manager_func;
1069 
1070 /**
1071  * Prime - vmwgfx_prime.c
1072  */
1073 
1074 extern const struct dma_buf_ops vmw_prime_dmabuf_ops;
1075 extern int vmw_prime_fd_to_handle(struct drm_device *dev,
1076 				  struct drm_file *file_priv,
1077 				  int fd, u32 *handle);
1078 extern int vmw_prime_handle_to_fd(struct drm_device *dev,
1079 				  struct drm_file *file_priv,
1080 				  uint32_t handle, uint32_t flags,
1081 				  int *prime_fd);
1082 
1083 /*
1084  * MemoryOBject management -  vmwgfx_mob.c
1085  */
1086 struct vmw_mob;
1087 extern int vmw_mob_bind(struct vmw_private *dev_priv, struct vmw_mob *mob,
1088 			const struct vmw_sg_table *vsgt,
1089 			unsigned long num_data_pages, int32_t mob_id);
1090 extern void vmw_mob_unbind(struct vmw_private *dev_priv,
1091 			   struct vmw_mob *mob);
1092 extern void vmw_mob_destroy(struct vmw_mob *mob);
1093 extern struct vmw_mob *vmw_mob_create(unsigned long data_pages);
1094 extern int vmw_otables_setup(struct vmw_private *dev_priv);
1095 extern void vmw_otables_takedown(struct vmw_private *dev_priv);
1096 
1097 /*
1098  * Context management - vmwgfx_context.c
1099  */
1100 
1101 extern const struct vmw_user_resource_conv *user_context_converter;
1102 
1103 extern int vmw_context_check(struct vmw_private *dev_priv,
1104 			     struct ttm_object_file *tfile,
1105 			     int id,
1106 			     struct vmw_resource **p_res);
1107 extern int vmw_context_define_ioctl(struct drm_device *dev, void *data,
1108 				    struct drm_file *file_priv);
1109 extern int vmw_extended_context_define_ioctl(struct drm_device *dev, void *data,
1110 					     struct drm_file *file_priv);
1111 extern int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
1112 				     struct drm_file *file_priv);
1113 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1114 extern struct vmw_cmdbuf_res_manager *
1115 vmw_context_res_man(struct vmw_resource *ctx);
1116 extern struct vmw_resource *vmw_context_cotable(struct vmw_resource *ctx,
1117 						SVGACOTableType cotable_type);
1118 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1119 struct vmw_ctx_binding_state;
1120 extern struct vmw_ctx_binding_state *
1121 vmw_context_binding_state(struct vmw_resource *ctx);
1122 extern void vmw_dx_context_scrub_cotables(struct vmw_resource *ctx,
1123 					  bool readback);
1124 extern int vmw_context_bind_dx_query(struct vmw_resource *ctx_res,
1125 				     struct vmw_buffer_object *mob);
1126 extern struct vmw_buffer_object *
1127 vmw_context_get_dx_query_mob(struct vmw_resource *ctx_res);
1128 
1129 
1130 /*
1131  * Surface management - vmwgfx_surface.c
1132  */
1133 
1134 extern const struct vmw_user_resource_conv *user_surface_converter;
1135 
1136 extern void vmw_surface_res_free(struct vmw_resource *res);
1137 extern int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
1138 				     struct drm_file *file_priv);
1139 extern int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
1140 				    struct drm_file *file_priv);
1141 extern int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
1142 				       struct drm_file *file_priv);
1143 extern int vmw_gb_surface_define_ioctl(struct drm_device *dev, void *data,
1144 				       struct drm_file *file_priv);
1145 extern int vmw_gb_surface_reference_ioctl(struct drm_device *dev, void *data,
1146 					  struct drm_file *file_priv);
1147 extern int vmw_surface_check(struct vmw_private *dev_priv,
1148 			     struct ttm_object_file *tfile,
1149 			     uint32_t handle, int *id);
1150 extern int vmw_surface_validate(struct vmw_private *dev_priv,
1151 				struct vmw_surface *srf);
1152 int vmw_surface_gb_priv_define(struct drm_device *dev,
1153 			       uint32_t user_accounting_size,
1154 			       SVGA3dSurfaceAllFlags svga3d_flags,
1155 			       SVGA3dSurfaceFormat format,
1156 			       bool for_scanout,
1157 			       uint32_t num_mip_levels,
1158 			       uint32_t multisample_count,
1159 			       uint32_t array_size,
1160 			       struct drm_vmw_size size,
1161 			       SVGA3dMSPattern multisample_pattern,
1162 			       SVGA3dMSQualityLevel quality_level,
1163 			       struct vmw_surface **srf_out);
1164 extern int vmw_gb_surface_define_ext_ioctl(struct drm_device *dev,
1165 					   void *data,
1166 					   struct drm_file *file_priv);
1167 extern int vmw_gb_surface_reference_ext_ioctl(struct drm_device *dev,
1168 					      void *data,
1169 					      struct drm_file *file_priv);
1170 
1171 /*
1172  * Shader management - vmwgfx_shader.c
1173  */
1174 
1175 extern const struct vmw_user_resource_conv *user_shader_converter;
1176 
1177 extern int vmw_shader_define_ioctl(struct drm_device *dev, void *data,
1178 				   struct drm_file *file_priv);
1179 extern int vmw_shader_destroy_ioctl(struct drm_device *dev, void *data,
1180 				    struct drm_file *file_priv);
1181 extern int vmw_compat_shader_add(struct vmw_private *dev_priv,
1182 				 struct vmw_cmdbuf_res_manager *man,
1183 				 u32 user_key, const void *bytecode,
1184 				 SVGA3dShaderType shader_type,
1185 				 size_t size,
1186 				 struct list_head *list);
1187 extern int vmw_shader_remove(struct vmw_cmdbuf_res_manager *man,
1188 			     u32 user_key, SVGA3dShaderType shader_type,
1189 			     struct list_head *list);
1190 extern int vmw_dx_shader_add(struct vmw_cmdbuf_res_manager *man,
1191 			     struct vmw_resource *ctx,
1192 			     u32 user_key,
1193 			     SVGA3dShaderType shader_type,
1194 			     struct list_head *list);
1195 extern void vmw_dx_shader_cotable_list_scrub(struct vmw_private *dev_priv,
1196 					     struct list_head *list,
1197 					     bool readback);
1198 
1199 extern struct vmw_resource *
1200 vmw_shader_lookup(struct vmw_cmdbuf_res_manager *man,
1201 		  u32 user_key, SVGA3dShaderType shader_type);
1202 
1203 /*
1204  * Command buffer managed resources - vmwgfx_cmdbuf_res.c
1205  */
1206 
1207 extern struct vmw_cmdbuf_res_manager *
1208 vmw_cmdbuf_res_man_create(struct vmw_private *dev_priv);
1209 extern void vmw_cmdbuf_res_man_destroy(struct vmw_cmdbuf_res_manager *man);
1210 extern size_t vmw_cmdbuf_res_man_size(void);
1211 extern struct vmw_resource *
1212 vmw_cmdbuf_res_lookup(struct vmw_cmdbuf_res_manager *man,
1213 		      enum vmw_cmdbuf_res_type res_type,
1214 		      u32 user_key);
1215 extern void vmw_cmdbuf_res_revert(struct list_head *list);
1216 extern void vmw_cmdbuf_res_commit(struct list_head *list);
1217 extern int vmw_cmdbuf_res_add(struct vmw_cmdbuf_res_manager *man,
1218 			      enum vmw_cmdbuf_res_type res_type,
1219 			      u32 user_key,
1220 			      struct vmw_resource *res,
1221 			      struct list_head *list);
1222 extern int vmw_cmdbuf_res_remove(struct vmw_cmdbuf_res_manager *man,
1223 				 enum vmw_cmdbuf_res_type res_type,
1224 				 u32 user_key,
1225 				 struct list_head *list,
1226 				 struct vmw_resource **res);
1227 
1228 /*
1229  * COTable management - vmwgfx_cotable.c
1230  */
1231 extern const SVGACOTableType vmw_cotable_scrub_order[];
1232 extern struct vmw_resource *vmw_cotable_alloc(struct vmw_private *dev_priv,
1233 					      struct vmw_resource *ctx,
1234 					      u32 type);
1235 extern int vmw_cotable_notify(struct vmw_resource *res, int id);
1236 extern int vmw_cotable_scrub(struct vmw_resource *res, bool readback);
1237 extern void vmw_cotable_add_resource(struct vmw_resource *ctx,
1238 				     struct list_head *head);
1239 
1240 /*
1241  * Command buffer managerment vmwgfx_cmdbuf.c
1242  */
1243 struct vmw_cmdbuf_man;
1244 struct vmw_cmdbuf_header;
1245 
1246 extern struct vmw_cmdbuf_man *
1247 vmw_cmdbuf_man_create(struct vmw_private *dev_priv);
1248 extern int vmw_cmdbuf_set_pool_size(struct vmw_cmdbuf_man *man,
1249 				    size_t size, size_t default_size);
1250 extern void vmw_cmdbuf_remove_pool(struct vmw_cmdbuf_man *man);
1251 extern void vmw_cmdbuf_man_destroy(struct vmw_cmdbuf_man *man);
1252 extern int vmw_cmdbuf_idle(struct vmw_cmdbuf_man *man, bool interruptible,
1253 			   unsigned long timeout);
1254 extern void *vmw_cmdbuf_reserve(struct vmw_cmdbuf_man *man, size_t size,
1255 				int ctx_id, bool interruptible,
1256 				struct vmw_cmdbuf_header *header);
1257 extern void vmw_cmdbuf_commit(struct vmw_cmdbuf_man *man, size_t size,
1258 			      struct vmw_cmdbuf_header *header,
1259 			      bool flush);
1260 extern void *vmw_cmdbuf_alloc(struct vmw_cmdbuf_man *man,
1261 			      size_t size, bool interruptible,
1262 			      struct vmw_cmdbuf_header **p_header);
1263 extern void vmw_cmdbuf_header_free(struct vmw_cmdbuf_header *header);
1264 extern int vmw_cmdbuf_cur_flush(struct vmw_cmdbuf_man *man,
1265 				bool interruptible);
1266 extern void vmw_cmdbuf_irqthread(struct vmw_cmdbuf_man *man);
1267 
1268 /* CPU blit utilities - vmwgfx_blit.c */
1269 
1270 /**
1271  * struct vmw_diff_cpy - CPU blit information structure
1272  *
1273  * @rect: The output bounding box rectangle.
1274  * @line: The current line of the blit.
1275  * @line_offset: Offset of the current line segment.
1276  * @cpp: Bytes per pixel (granularity information).
1277  * @memcpy: Which memcpy function to use.
1278  */
1279 struct vmw_diff_cpy {
1280 	struct drm_rect rect;
1281 	size_t line;
1282 	size_t line_offset;
1283 	int cpp;
1284 	void (*do_cpy)(struct vmw_diff_cpy *diff, u8 *dest, const u8 *src,
1285 		       size_t n);
1286 };
1287 
1288 #define VMW_CPU_BLIT_INITIALIZER {	\
1289 	.do_cpy = vmw_memcpy,		\
1290 }
1291 
1292 #define VMW_CPU_BLIT_DIFF_INITIALIZER(_cpp) {	  \
1293 	.line = 0,				  \
1294 	.line_offset = 0,			  \
1295 	.rect = { .x1 = INT_MAX/2,		  \
1296 		  .y1 = INT_MAX/2,		  \
1297 		  .x2 = INT_MIN/2,		  \
1298 		  .y2 = INT_MIN/2		  \
1299 	},					  \
1300 	.cpp = _cpp,				  \
1301 	.do_cpy = vmw_diff_memcpy,		  \
1302 }
1303 
1304 void vmw_diff_memcpy(struct vmw_diff_cpy *diff, u8 *dest, const u8 *src,
1305 		     size_t n);
1306 
1307 void vmw_memcpy(struct vmw_diff_cpy *diff, u8 *dest, const u8 *src, size_t n);
1308 
1309 int vmw_bo_cpu_blit(struct ttm_buffer_object *dst,
1310 		    u32 dst_offset, u32 dst_stride,
1311 		    struct ttm_buffer_object *src,
1312 		    u32 src_offset, u32 src_stride,
1313 		    u32 w, u32 h,
1314 		    struct vmw_diff_cpy *diff);
1315 
1316 /* Host messaging -vmwgfx_msg.c: */
1317 int vmw_host_get_guestinfo(const char *guest_info_param,
1318 			   char *buffer, size_t *length);
1319 int vmw_host_log(const char *log);
1320 
1321 /**
1322  * Inline helper functions
1323  */
1324 
1325 static inline void vmw_surface_unreference(struct vmw_surface **srf)
1326 {
1327 	struct vmw_surface *tmp_srf = *srf;
1328 	struct vmw_resource *res = &tmp_srf->res;
1329 	*srf = NULL;
1330 
1331 	vmw_resource_unreference(&res);
1332 }
1333 
1334 static inline struct vmw_surface *vmw_surface_reference(struct vmw_surface *srf)
1335 {
1336 	(void) vmw_resource_reference(&srf->res);
1337 	return srf;
1338 }
1339 
1340 static inline void vmw_bo_unreference(struct vmw_buffer_object **buf)
1341 {
1342 	struct vmw_buffer_object *tmp_buf = *buf;
1343 
1344 	*buf = NULL;
1345 	if (tmp_buf != NULL) {
1346 		struct ttm_buffer_object *bo = &tmp_buf->base;
1347 
1348 		ttm_bo_unref(&bo);
1349 	}
1350 }
1351 
1352 static inline struct vmw_buffer_object *
1353 vmw_bo_reference(struct vmw_buffer_object *buf)
1354 {
1355 	if (ttm_bo_reference(&buf->base))
1356 		return buf;
1357 	return NULL;
1358 }
1359 
1360 static inline struct ttm_mem_global *vmw_mem_glob(struct vmw_private *dev_priv)
1361 {
1362 	return &ttm_mem_glob;
1363 }
1364 
1365 static inline void vmw_fifo_resource_inc(struct vmw_private *dev_priv)
1366 {
1367 	atomic_inc(&dev_priv->num_fifo_resources);
1368 }
1369 
1370 static inline void vmw_fifo_resource_dec(struct vmw_private *dev_priv)
1371 {
1372 	atomic_dec(&dev_priv->num_fifo_resources);
1373 }
1374 
1375 /**
1376  * vmw_mmio_read - Perform a MMIO read from volatile memory
1377  *
1378  * @addr: The address to read from
1379  *
1380  * This function is intended to be equivalent to ioread32() on
1381  * memremap'd memory, but without byteswapping.
1382  */
1383 static inline u32 vmw_mmio_read(u32 *addr)
1384 {
1385 	return READ_ONCE(*addr);
1386 }
1387 
1388 /**
1389  * vmw_mmio_write - Perform a MMIO write to volatile memory
1390  *
1391  * @addr: The address to write to
1392  *
1393  * This function is intended to be equivalent to iowrite32 on
1394  * memremap'd memory, but without byteswapping.
1395  */
1396 static inline void vmw_mmio_write(u32 value, u32 *addr)
1397 {
1398 	WRITE_ONCE(*addr, value);
1399 }
1400 #endif
1401