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