xref: /linux/drivers/gpu/drm/vmwgfx/vmwgfx_drv.h (revision 2c1ed907520c50326b8f604907a8478b27881a2e)
1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
2 /**************************************************************************
3  *
4  * Copyright (c) 2009-2024 Broadcom. All Rights Reserved. The term
5  * “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a
8  * copy of this software and associated documentation files (the
9  * "Software"), to deal in the Software without restriction, including
10  * without limitation the rights to use, copy, modify, merge, publish,
11  * distribute, sub license, and/or sell copies of the Software, and to
12  * permit persons to whom the Software is furnished to do so, subject to
13  * the following conditions:
14  *
15  * The above copyright notice and this permission notice (including the
16  * next paragraph) shall be included in all copies or substantial portions
17  * of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
22  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
23  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
25  * USE OR OTHER DEALINGS IN THE SOFTWARE.
26  *
27  **************************************************************************/
28 
29 #ifndef _VMWGFX_DRV_H_
30 #define _VMWGFX_DRV_H_
31 
32 #include <linux/suspend.h>
33 #include <linux/sync_file.h>
34 #include <linux/hashtable.h>
35 
36 #include <drm/drm_auth.h>
37 #include <drm/drm_device.h>
38 #include <drm/drm_file.h>
39 #include <drm/drm_rect.h>
40 
41 #include <drm/ttm/ttm_execbuf_util.h>
42 #include <drm/ttm/ttm_tt.h>
43 #include <drm/ttm/ttm_placement.h>
44 #include <drm/ttm/ttm_bo.h>
45 
46 #include "ttm_object.h"
47 
48 #include "vmwgfx_fence.h"
49 #include "vmwgfx_reg.h"
50 #include "vmwgfx_validation.h"
51 
52 /*
53  * FIXME: vmwgfx_drm.h needs to be last due to dependencies.
54  * uapi headers should not depend on header files outside uapi/.
55  */
56 #include <drm/vmwgfx_drm.h>
57 
58 
59 #define VMWGFX_DRIVER_NAME "vmwgfx"
60 #define VMWGFX_DRIVER_MAJOR 2
61 #define VMWGFX_DRIVER_MINOR 20
62 #define VMWGFX_DRIVER_PATCHLEVEL 0
63 #define VMWGFX_FIFO_STATIC_SIZE (1024*1024)
64 #define VMWGFX_NUM_DISPLAY_UNITS 8
65 #define VMWGFX_CMD_BOUNCE_INIT_SIZE 32768
66 
67 #define VMWGFX_MIN_INITIAL_WIDTH 1280
68 #define VMWGFX_MIN_INITIAL_HEIGHT 800
69 
70 #define VMWGFX_PCI_ID_SVGA2              0x0405
71 #define VMWGFX_PCI_ID_SVGA3              0x0406
72 
73 /*
74  * This has to match get_count_order(SVGA_IRQFLAG_MAX)
75  */
76 #define VMWGFX_MAX_NUM_IRQS 6
77 
78 /*
79  * Perhaps we should have sysfs entries for these.
80  */
81 #define VMWGFX_NUM_GB_CONTEXT 256
82 #define VMWGFX_NUM_GB_SHADER 20000
83 #define VMWGFX_NUM_GB_SURFACE 32768
84 #define VMWGFX_NUM_GB_SCREEN_TARGET VMWGFX_NUM_DISPLAY_UNITS
85 #define VMWGFX_NUM_DXCONTEXT 256
86 #define VMWGFX_NUM_DXQUERY 512
87 #define VMWGFX_NUM_MOB (VMWGFX_NUM_GB_CONTEXT +\
88 			VMWGFX_NUM_GB_SHADER +\
89 			VMWGFX_NUM_GB_SURFACE +\
90 			VMWGFX_NUM_GB_SCREEN_TARGET)
91 
92 #define VMW_PL_GMR      (TTM_PL_PRIV + 0)
93 #define VMW_PL_MOB      (TTM_PL_PRIV + 1)
94 #define VMW_PL_SYSTEM   (TTM_PL_PRIV + 2)
95 
96 #define VMW_RES_CONTEXT ttm_driver_type0
97 #define VMW_RES_SURFACE ttm_driver_type1
98 #define VMW_RES_STREAM ttm_driver_type2
99 #define VMW_RES_FENCE ttm_driver_type3
100 #define VMW_RES_SHADER ttm_driver_type4
101 #define VMW_RES_HT_ORDER 12
102 
103 #define VMW_CURSOR_SNOOP_FORMAT SVGA3D_A8R8G8B8
104 #define VMW_CURSOR_SNOOP_WIDTH 64
105 #define VMW_CURSOR_SNOOP_HEIGHT 64
106 
107 #define MKSSTAT_CAPACITY_LOG2 5U
108 #define MKSSTAT_CAPACITY (1U << MKSSTAT_CAPACITY_LOG2)
109 
110 struct vmw_fpriv {
111 	struct ttm_object_file *tfile;
112 	bool gb_aware; /* user-space is guest-backed aware */
113 };
114 
115 struct vmwgfx_hash_item {
116 	struct hlist_node head;
117 	unsigned long key;
118 };
119 
120 struct vmw_res_func;
121 
122 /**
123  * struct vmw-resource - base class for hardware resources
124  *
125  * @kref: For refcounting.
126  * @dev_priv: Pointer to the device private for this resource. Immutable.
127  * @id: Device id. Protected by @dev_priv::resource_lock.
128  * @guest_memory_size: Guest memory buffer size. Immutable.
129  * @res_dirty: Resource contains data not yet in the guest memory buffer.
130  * Protected by resource reserved.
131  * @guest_memory_dirty: Guest memory buffer contains data not yet in the HW
132  * resource. Protected by resource reserved.
133  * @coherent: Emulate coherency by tracking vm accesses.
134  * @guest_memory_bo: The guest memory buffer if any. Protected by resource
135  * reserved.
136  * @guest_memory_offset: Offset into the guest memory buffer if any. Protected
137  * by resource reserved. Note that only a few resource types can have a
138  * @guest_memory_offset different from zero.
139  * @pin_count: The pin count for this resource. A pinned resource has a
140  * pin-count greater than zero. It is not on the resource LRU lists and its
141  * guest memory buffer is pinned. Hence it can't be evicted.
142  * @func: Method vtable for this resource. Immutable.
143  * @mob_node; Node for the MOB guest memory rbtree. Protected by
144  * @guest_memory_bo reserved.
145  * @lru_head: List head for the LRU list. Protected by @dev_priv::resource_lock.
146  * @binding_head: List head for the context binding list. Protected by
147  * the @dev_priv::binding_mutex
148  * @res_free: The resource destructor.
149  * @hw_destroy: Callback to destroy the resource on the device, as part of
150  * resource destruction.
151  */
152 struct vmw_bo;
153 struct vmw_bo;
154 struct vmw_resource_dirty;
155 struct vmw_resource {
156 	struct kref kref;
157 	struct vmw_private *dev_priv;
158 	int id;
159 	u32 used_prio;
160 	unsigned long guest_memory_size;
161 	u32 res_dirty : 1;
162 	u32 guest_memory_dirty : 1;
163 	u32 coherent : 1;
164 	struct vmw_bo *guest_memory_bo;
165 	unsigned long guest_memory_offset;
166 	unsigned long pin_count;
167 	const struct vmw_res_func *func;
168 	struct rb_node mob_node;
169 	struct list_head lru_head;
170 	struct list_head binding_head;
171 	struct vmw_resource_dirty *dirty;
172 	void (*res_free) (struct vmw_resource *res);
173 	void (*hw_destroy) (struct vmw_resource *res);
174 };
175 
176 
177 /*
178  * Resources that are managed using ioctls.
179  */
180 enum vmw_res_type {
181 	vmw_res_context,
182 	vmw_res_surface,
183 	vmw_res_stream,
184 	vmw_res_shader,
185 	vmw_res_dx_context,
186 	vmw_res_cotable,
187 	vmw_res_view,
188 	vmw_res_streamoutput,
189 	vmw_res_max
190 };
191 
192 /*
193  * Resources that are managed using command streams.
194  */
195 enum vmw_cmdbuf_res_type {
196 	vmw_cmdbuf_res_shader,
197 	vmw_cmdbuf_res_view,
198 	vmw_cmdbuf_res_streamoutput
199 };
200 
201 struct vmw_cmdbuf_res_manager;
202 
203 struct vmw_cursor_snooper {
204 	size_t age;
205 	uint32_t *image;
206 };
207 
208 struct vmw_framebuffer;
209 struct vmw_surface_offset;
210 
211 /**
212  * struct vmw_surface_metadata - Metadata describing a surface.
213  *
214  * @flags: Device flags.
215  * @format: Surface SVGA3D_x format.
216  * @mip_levels: Mip level for each face. For GB first index is used only.
217  * @multisample_count: Sample count.
218  * @multisample_pattern: Sample patterns.
219  * @quality_level: Quality level.
220  * @autogen_filter: Filter for automatically generated mipmaps.
221  * @array_size: Number of array elements for a 1D/2D texture. For cubemap
222                 texture number of faces * array_size. This should be 0 for pre
223 		SM4 device.
224  * @buffer_byte_stride: Buffer byte stride.
225  * @num_sizes: Size of @sizes. For GB surface this should always be 1.
226  * @base_size: Surface dimension.
227  * @sizes: Array representing mip sizes. Legacy only.
228  * @scanout: Whether this surface will be used for scanout.
229  *
230  * This tracks metadata for both legacy and guest backed surface.
231  */
232 struct vmw_surface_metadata {
233 	u64 flags;
234 	u32 format;
235 	u32 mip_levels[DRM_VMW_MAX_SURFACE_FACES];
236 	u32 multisample_count;
237 	u32 multisample_pattern;
238 	u32 quality_level;
239 	u32 autogen_filter;
240 	u32 array_size;
241 	u32 num_sizes;
242 	u32 buffer_byte_stride;
243 	struct drm_vmw_size base_size;
244 	struct drm_vmw_size *sizes;
245 	bool scanout;
246 };
247 
248 /**
249  * struct vmw_surface: Resource structure for a surface.
250  *
251  * @res: The base resource for this surface.
252  * @metadata: Metadata for this surface resource.
253  * @snooper: Cursor data. Legacy surface only.
254  * @offsets: Legacy surface only.
255  * @view_list: List of views bound to this surface.
256  */
257 struct vmw_surface {
258 	struct vmw_resource res;
259 	struct vmw_surface_metadata metadata;
260 	struct vmw_cursor_snooper snooper;
261 	struct vmw_surface_offset *offsets;
262 	struct list_head view_list;
263 };
264 
265 struct vmw_fifo_state {
266 	unsigned long reserved_size;
267 	u32 *dynamic_buffer;
268 	u32 *static_buffer;
269 	unsigned long static_buffer_size;
270 	bool using_bounce_buffer;
271 	uint32_t capabilities;
272 	struct mutex fifo_mutex;
273 	struct rw_semaphore rwsem;
274 };
275 
276 /**
277  * struct vmw_res_cache_entry - resource information cache entry
278  * @handle: User-space handle of a resource.
279  * @res: Non-ref-counted pointer to the resource.
280  * @valid_handle: Whether the @handle member is valid.
281  * @valid: Whether the entry is valid, which also implies that the execbuf
282  * code holds a reference to the resource, and it's placed on the
283  * validation list.
284  *
285  * Used to avoid frequent repeated user-space handle lookups of the
286  * same resource.
287  */
288 struct vmw_res_cache_entry {
289 	uint32_t handle;
290 	struct vmw_resource *res;
291 	void *private;
292 	unsigned short valid_handle;
293 	unsigned short valid;
294 };
295 
296 /**
297  * enum vmw_dma_map_mode - indicate how to perform TTM page dma mappings.
298  */
299 enum vmw_dma_map_mode {
300 	vmw_dma_alloc_coherent, /* Use TTM coherent pages */
301 	vmw_dma_map_populate,   /* Unmap from DMA just after unpopulate */
302 	vmw_dma_map_bind,       /* Unmap from DMA just before unbind */
303 	vmw_dma_map_max
304 };
305 
306 /**
307  * struct vmw_sg_table - Scatter/gather table for binding, with additional
308  * device-specific information.
309  *
310  * @sgt: Pointer to a struct sg_table with binding information
311  * @num_regions: Number of regions with device-address contiguous pages
312  */
313 struct vmw_sg_table {
314 	enum vmw_dma_map_mode mode;
315 	struct page **pages;
316 	const dma_addr_t *addrs;
317 	struct sg_table *sgt;
318 	unsigned long num_pages;
319 };
320 
321 /**
322  * struct vmw_piter - Page iterator that iterates over a list of pages
323  * and DMA addresses that could be either a scatter-gather list or
324  * arrays
325  *
326  * @pages: Array of page pointers to the pages.
327  * @addrs: DMA addresses to the pages if coherent pages are used.
328  * @iter: Scatter-gather page iterator. Current position in SG list.
329  * @i: Current position in arrays.
330  * @num_pages: Number of pages total.
331  * @next: Function to advance the iterator. Returns false if past the list
332  * of pages, true otherwise.
333  * @dma_address: Function to return the DMA address of the current page.
334  */
335 struct vmw_piter {
336 	struct page **pages;
337 	const dma_addr_t *addrs;
338 	struct sg_dma_page_iter iter;
339 	unsigned long i;
340 	unsigned long num_pages;
341 	bool (*next)(struct vmw_piter *);
342 	dma_addr_t (*dma_address)(struct vmw_piter *);
343 };
344 
345 
346 struct vmw_ttm_tt {
347 	struct ttm_tt dma_ttm;
348 	struct vmw_private *dev_priv;
349 	int gmr_id;
350 	struct vmw_mob *mob;
351 	int mem_type;
352 	struct sg_table sgt;
353 	struct vmw_sg_table vsgt;
354 	bool mapped;
355 	bool bound;
356 };
357 
358 /*
359  * enum vmw_display_unit_type - Describes the display unit
360  */
361 enum vmw_display_unit_type {
362 	vmw_du_invalid = 0,
363 	vmw_du_legacy,
364 	vmw_du_screen_object,
365 	vmw_du_screen_target,
366 	vmw_du_max
367 };
368 
369 struct vmw_validation_context;
370 struct vmw_ctx_validation_info;
371 
372 /**
373  * struct vmw_sw_context - Command submission context
374  * @res_ht: Pointer hash table used to find validation duplicates
375  * @kernel: Whether the command buffer originates from kernel code rather
376  * than from user-space
377  * @fp: If @kernel is false, points to the file of the client. Otherwise
378  * NULL
379  * @cmd_bounce: Command bounce buffer used for command validation before
380  * copying to fifo space
381  * @cmd_bounce_size: Current command bounce buffer size
382  * @cur_query_bo: Current buffer object used as query result buffer
383  * @bo_relocations: List of buffer object relocations
384  * @res_relocations: List of resource relocations
385  * @buf_start: Pointer to start of memory where command validation takes
386  * place
387  * @res_cache: Cache of recently looked up resources
388  * @last_query_ctx: Last context that submitted a query
389  * @needs_post_query_barrier: Whether a query barrier is needed after
390  * command submission
391  * @staged_bindings: Cached per-context binding tracker
392  * @staged_bindings_inuse: Whether the cached per-context binding tracker
393  * is in use
394  * @staged_cmd_res: List of staged command buffer managed resources in this
395  * command buffer
396  * @ctx_list: List of context resources referenced in this command buffer
397  * @dx_ctx_node: Validation metadata of the current DX context
398  * @dx_query_mob: The MOB used for DX queries
399  * @dx_query_ctx: The DX context used for the last DX query
400  * @man: Pointer to the command buffer managed resource manager
401  * @ctx: The validation context
402  */
403 struct vmw_sw_context{
404 	DECLARE_HASHTABLE(res_ht, VMW_RES_HT_ORDER);
405 	bool kernel;
406 	struct vmw_fpriv *fp;
407 	struct drm_file *filp;
408 	uint32_t *cmd_bounce;
409 	uint32_t cmd_bounce_size;
410 	struct vmw_bo *cur_query_bo;
411 	struct list_head bo_relocations;
412 	struct list_head res_relocations;
413 	uint32_t *buf_start;
414 	struct vmw_res_cache_entry res_cache[vmw_res_max];
415 	struct vmw_resource *last_query_ctx;
416 	bool needs_post_query_barrier;
417 	struct vmw_ctx_binding_state *staged_bindings;
418 	bool staged_bindings_inuse;
419 	struct list_head staged_cmd_res;
420 	struct list_head ctx_list;
421 	struct vmw_ctx_validation_info *dx_ctx_node;
422 	struct vmw_bo *dx_query_mob;
423 	struct vmw_resource *dx_query_ctx;
424 	struct vmw_cmdbuf_res_manager *man;
425 	struct vmw_validation_context *ctx;
426 };
427 
428 struct vmw_legacy_display;
429 struct vmw_overlay;
430 
431 /*
432  * struct vmw_otable - Guest Memory OBject table metadata
433  *
434  * @size:           Size of the table (page-aligned).
435  * @page_table:     Pointer to a struct vmw_mob holding the page table.
436  */
437 struct vmw_otable {
438 	unsigned long size;
439 	struct vmw_mob *page_table;
440 	bool enabled;
441 };
442 
443 struct vmw_otable_batch {
444 	unsigned num_otables;
445 	struct vmw_otable *otables;
446 	struct vmw_resource *context;
447 	struct vmw_bo *otable_bo;
448 };
449 
450 enum {
451 	VMW_IRQTHREAD_FENCE,
452 	VMW_IRQTHREAD_CMDBUF,
453 	VMW_IRQTHREAD_MAX
454 };
455 
456 /**
457  * enum vmw_sm_type - Graphics context capability supported by device.
458  * @VMW_SM_LEGACY: Pre DX context.
459  * @VMW_SM_4: Context support upto SM4.
460  * @VMW_SM_4_1: Context support upto SM4_1.
461  * @VMW_SM_5: Context support up to SM5.
462  * @VMW_SM_5_1X: Adds support for sm5_1 and gl43 extensions.
463  * @VMW_SM_MAX: Should be the last.
464  */
465 enum vmw_sm_type {
466 	VMW_SM_LEGACY = 0,
467 	VMW_SM_4,
468 	VMW_SM_4_1,
469 	VMW_SM_5,
470 	VMW_SM_5_1X,
471 	VMW_SM_MAX
472 };
473 
474 struct vmw_private {
475 	struct drm_device drm;
476 	struct ttm_device bdev;
477 
478 	u32 pci_id;
479 	resource_size_t io_start;
480 	resource_size_t vram_start;
481 	resource_size_t vram_size;
482 	resource_size_t max_primary_mem;
483 	u32 __iomem *rmmio;
484 	u32 *fifo_mem;
485 	resource_size_t fifo_mem_size;
486 	uint32_t fb_max_width;
487 	uint32_t fb_max_height;
488 	uint32_t texture_max_width;
489 	uint32_t texture_max_height;
490 	uint32_t stdu_max_width;
491 	uint32_t stdu_max_height;
492 	uint32_t initial_width;
493 	uint32_t initial_height;
494 	uint32_t capabilities;
495 	uint32_t capabilities2;
496 	uint32_t max_gmr_ids;
497 	uint32_t max_gmr_pages;
498 	uint32_t max_mob_pages;
499 	uint32_t max_mob_size;
500 	uint32_t memory_size;
501 	bool has_gmr;
502 	bool has_mob;
503 	spinlock_t hw_lock;
504 	bool assume_16bpp;
505 	u32 irqs[VMWGFX_MAX_NUM_IRQS];
506 	u32 num_irq_vectors;
507 
508 	enum vmw_sm_type sm_type;
509 
510 	/*
511 	 * Framebuffer info.
512 	 */
513 
514 	enum vmw_display_unit_type active_display_unit;
515 	struct vmw_legacy_display *ldu_priv;
516 	struct vmw_overlay *overlay_priv;
517 	struct drm_property *hotplug_mode_update_property;
518 	struct drm_property *implicit_placement_property;
519 	spinlock_t cursor_lock;
520 	struct drm_atomic_state *suspend_state;
521 
522 	/*
523 	 * Context and surface management.
524 	 */
525 
526 	spinlock_t resource_lock;
527 	struct idr res_idr[vmw_res_max];
528 
529 	/*
530 	 * A resource manager for kernel-only surfaces and
531 	 * contexts.
532 	 */
533 
534 	struct ttm_object_device *tdev;
535 
536 	/*
537 	 * Fencing and IRQs.
538 	 */
539 
540 	atomic_t marker_seq;
541 	wait_queue_head_t fence_queue;
542 	wait_queue_head_t fifo_queue;
543 	spinlock_t waiter_lock;
544 	int fence_queue_waiters; /* Protected by waiter_lock */
545 	int goal_queue_waiters; /* Protected by waiter_lock */
546 	int cmdbuf_waiters; /* Protected by waiter_lock */
547 	int error_waiters; /* Protected by waiter_lock */
548 	int fifo_queue_waiters; /* Protected by waiter_lock */
549 	uint32_t last_read_seqno;
550 	struct vmw_fence_manager *fman;
551 	uint32_t irq_mask; /* Updates protected by waiter_lock */
552 
553 	/*
554 	 * Device state
555 	 */
556 
557 	uint32_t traces_state;
558 	uint32_t enable_state;
559 	uint32_t config_done_state;
560 
561 	/**
562 	 * Execbuf
563 	 */
564 	/**
565 	 * Protected by the cmdbuf mutex.
566 	 */
567 
568 	struct vmw_sw_context ctx;
569 	struct mutex cmdbuf_mutex;
570 	struct mutex binding_mutex;
571 
572 	/**
573 	 * PM management.
574 	 */
575 	struct notifier_block pm_nb;
576 	bool refuse_hibernation;
577 	bool suspend_locked;
578 
579 	atomic_t num_fifo_resources;
580 
581 	/*
582 	 * Query processing. These members
583 	 * are protected by the cmdbuf mutex.
584 	 */
585 
586 	struct vmw_bo *dummy_query_bo;
587 	struct vmw_bo *pinned_bo;
588 	uint32_t query_cid;
589 	uint32_t query_cid_valid;
590 	bool dummy_query_bo_pinned;
591 
592 	/*
593 	 * Surface swapping. The "surface_lru" list is protected by the
594 	 * resource lock in order to be able to destroy a surface and take
595 	 * it off the lru atomically. "used_memory_size" is currently
596 	 * protected by the cmdbuf mutex for simplicity.
597 	 */
598 
599 	struct list_head res_lru[vmw_res_max];
600 	uint32_t used_memory_size;
601 
602 	/*
603 	 * DMA mapping stuff.
604 	 */
605 	enum vmw_dma_map_mode map_mode;
606 
607 	/*
608 	 * Guest Backed stuff
609 	 */
610 	struct vmw_otable_batch otable_batch;
611 
612 	struct vmw_fifo_state *fifo;
613 	struct vmw_cmdbuf_man *cman;
614 	DECLARE_BITMAP(irqthread_pending, VMW_IRQTHREAD_MAX);
615 
616 	uint32 *devcaps;
617 
618 	bool vkms_enabled;
619 	struct workqueue_struct *crc_workq;
620 
621 	/*
622 	 * mksGuestStat instance-descriptor and pid arrays
623 	 */
624 	struct page *mksstat_user_pages[MKSSTAT_CAPACITY];
625 	atomic_t mksstat_user_pids[MKSSTAT_CAPACITY];
626 
627 #if IS_ENABLED(CONFIG_DRM_VMWGFX_MKSSTATS)
628 	struct page *mksstat_kern_pages[MKSSTAT_CAPACITY];
629 	u8 mksstat_kern_top_timer[MKSSTAT_CAPACITY];
630 	atomic_t mksstat_kern_pids[MKSSTAT_CAPACITY];
631 #endif
632 };
633 
vmw_res_to_srf(struct vmw_resource * res)634 static inline struct vmw_surface *vmw_res_to_srf(struct vmw_resource *res)
635 {
636 	return container_of(res, struct vmw_surface, res);
637 }
638 
vmw_priv(struct drm_device * dev)639 static inline struct vmw_private *vmw_priv(struct drm_device *dev)
640 {
641 	return container_of(dev, struct vmw_private, drm);
642 }
643 
vmw_priv_from_ttm(struct ttm_device * bdev)644 static inline struct vmw_private *vmw_priv_from_ttm(struct ttm_device *bdev)
645 {
646 	return container_of(bdev, struct vmw_private, bdev);
647 }
648 
vmw_fpriv(struct drm_file * file_priv)649 static inline struct vmw_fpriv *vmw_fpriv(struct drm_file *file_priv)
650 {
651 	return (struct vmw_fpriv *)file_priv->driver_priv;
652 }
653 
654 /*
655  * SVGA v3 has mmio register access and lacks fifo cmds
656  */
vmw_is_svga_v3(const struct vmw_private * dev)657 static inline bool vmw_is_svga_v3(const struct vmw_private *dev)
658 {
659 	return dev->pci_id == VMWGFX_PCI_ID_SVGA3;
660 }
661 
662 /*
663  * The locking here is fine-grained, so that it is performed once
664  * for every read- and write operation. This is of course costly, but we
665  * don't perform much register access in the timing critical paths anyway.
666  * Instead we have the extra benefit of being sure that we don't forget
667  * the hw lock around register accesses.
668  */
vmw_write(struct vmw_private * dev_priv,unsigned int offset,uint32_t value)669 static inline void vmw_write(struct vmw_private *dev_priv,
670 			     unsigned int offset, uint32_t value)
671 {
672 	if (vmw_is_svga_v3(dev_priv)) {
673 		iowrite32(value, dev_priv->rmmio + offset);
674 	} else {
675 		spin_lock(&dev_priv->hw_lock);
676 		outl(offset, dev_priv->io_start + SVGA_INDEX_PORT);
677 		outl(value, dev_priv->io_start + SVGA_VALUE_PORT);
678 		spin_unlock(&dev_priv->hw_lock);
679 	}
680 }
681 
vmw_read(struct vmw_private * dev_priv,unsigned int offset)682 static inline uint32_t vmw_read(struct vmw_private *dev_priv,
683 				unsigned int offset)
684 {
685 	u32 val;
686 
687 	if (vmw_is_svga_v3(dev_priv)) {
688 		val = ioread32(dev_priv->rmmio + offset);
689 	} else {
690 		spin_lock(&dev_priv->hw_lock);
691 		outl(offset, dev_priv->io_start + SVGA_INDEX_PORT);
692 		val = inl(dev_priv->io_start + SVGA_VALUE_PORT);
693 		spin_unlock(&dev_priv->hw_lock);
694 	}
695 
696 	return val;
697 }
698 
699 /**
700  * has_sm4_context - Does the device support SM4 context.
701  * @dev_priv: Device private.
702  *
703  * Return: Bool value if device support SM4 context or not.
704  */
has_sm4_context(const struct vmw_private * dev_priv)705 static inline bool has_sm4_context(const struct vmw_private *dev_priv)
706 {
707 	return (dev_priv->sm_type >= VMW_SM_4);
708 }
709 
710 /**
711  * has_sm4_1_context - Does the device support SM4_1 context.
712  * @dev_priv: Device private.
713  *
714  * Return: Bool value if device support SM4_1 context or not.
715  */
has_sm4_1_context(const struct vmw_private * dev_priv)716 static inline bool has_sm4_1_context(const struct vmw_private *dev_priv)
717 {
718 	return (dev_priv->sm_type >= VMW_SM_4_1);
719 }
720 
721 /**
722  * has_sm5_context - Does the device support SM5 context.
723  * @dev_priv: Device private.
724  *
725  * Return: Bool value if device support SM5 context or not.
726  */
has_sm5_context(const struct vmw_private * dev_priv)727 static inline bool has_sm5_context(const struct vmw_private *dev_priv)
728 {
729 	return (dev_priv->sm_type >= VMW_SM_5);
730 }
731 
732 /**
733  * has_gl43_context - Does the device support GL43 context.
734  * @dev_priv: Device private.
735  *
736  * Return: Bool value if device support SM5 context or not.
737  */
has_gl43_context(const struct vmw_private * dev_priv)738 static inline bool has_gl43_context(const struct vmw_private *dev_priv)
739 {
740 	return (dev_priv->sm_type >= VMW_SM_5_1X);
741 }
742 
743 
vmw_max_num_uavs(struct vmw_private * dev_priv)744 static inline u32 vmw_max_num_uavs(struct vmw_private *dev_priv)
745 {
746 	return (has_gl43_context(dev_priv) ?
747 			SVGA3D_DX11_1_MAX_UAVIEWS : SVGA3D_MAX_UAVIEWS);
748 }
749 
750 extern void vmw_svga_enable(struct vmw_private *dev_priv);
751 extern void vmw_svga_disable(struct vmw_private *dev_priv);
752 bool vmwgfx_supported(struct vmw_private *vmw);
753 
754 
755 /**
756  * GMR utilities - vmwgfx_gmr.c
757  */
758 
759 extern int vmw_gmr_bind(struct vmw_private *dev_priv,
760 			const struct vmw_sg_table *vsgt,
761 			unsigned long num_pages,
762 			int gmr_id);
763 extern void vmw_gmr_unbind(struct vmw_private *dev_priv, int gmr_id);
764 
765 /**
766  * User handles
767  */
768 struct vmw_user_object {
769 	struct vmw_surface *surface;
770 	struct vmw_bo *buffer;
771 };
772 
773 int vmw_user_object_lookup(struct vmw_private *dev_priv, struct drm_file *filp,
774 			   u32 handle, struct vmw_user_object *uo);
775 struct vmw_user_object *vmw_user_object_ref(struct vmw_user_object *uo);
776 void vmw_user_object_unref(struct vmw_user_object *uo);
777 bool vmw_user_object_is_null(struct vmw_user_object *uo);
778 struct vmw_surface *vmw_user_object_surface(struct vmw_user_object *uo);
779 struct vmw_bo *vmw_user_object_buffer(struct vmw_user_object *uo);
780 void *vmw_user_object_map(struct vmw_user_object *uo);
781 void *vmw_user_object_map_size(struct vmw_user_object *uo, size_t size);
782 void vmw_user_object_unmap(struct vmw_user_object *uo);
783 bool vmw_user_object_is_mapped(struct vmw_user_object *uo);
784 
785 /**
786  * Resource utilities - vmwgfx_resource.c
787  */
788 struct vmw_user_resource_conv;
789 
790 extern void vmw_resource_unreference(struct vmw_resource **p_res);
791 extern struct vmw_resource *vmw_resource_reference(struct vmw_resource *res);
792 extern struct vmw_resource *
793 vmw_resource_reference_unless_doomed(struct vmw_resource *res);
794 extern int vmw_resource_validate(struct vmw_resource *res, bool intr,
795 				 bool dirtying);
796 extern int vmw_resource_reserve(struct vmw_resource *res, bool interruptible,
797 				bool no_backup);
798 extern bool vmw_resource_needs_backup(const struct vmw_resource *res);
799 extern int vmw_user_resource_lookup_handle(
800 	struct vmw_private *dev_priv,
801 	struct ttm_object_file *tfile,
802 	uint32_t handle,
803 	const struct vmw_user_resource_conv *converter,
804 	struct vmw_resource **p_res);
805 
806 extern int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
807 				  struct drm_file *file_priv);
808 extern int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
809 				  struct drm_file *file_priv);
810 extern int vmw_user_stream_lookup(struct vmw_private *dev_priv,
811 				  struct ttm_object_file *tfile,
812 				  uint32_t *inout_id,
813 				  struct vmw_resource **out);
814 extern void vmw_resource_unreserve(struct vmw_resource *res,
815 				   bool dirty_set,
816 				   bool dirty,
817 				   bool switch_guest_memory,
818 				   struct vmw_bo *new_guest_memory,
819 				   unsigned long new_guest_memory_offset);
820 extern void vmw_query_move_notify(struct ttm_buffer_object *bo,
821 				  struct ttm_resource *old_mem,
822 				  struct ttm_resource *new_mem);
823 int vmw_query_readback_all(struct vmw_bo *dx_query_mob);
824 void vmw_resource_evict_all(struct vmw_private *dev_priv);
825 void vmw_resource_unbind_list(struct vmw_bo *vbo);
826 void vmw_resource_mob_attach(struct vmw_resource *res);
827 void vmw_resource_mob_detach(struct vmw_resource *res);
828 void vmw_resource_dirty_update(struct vmw_resource *res, pgoff_t start,
829 			       pgoff_t end);
830 int vmw_resource_clean(struct vmw_resource *res);
831 int vmw_resources_clean(struct vmw_bo *vbo, pgoff_t start,
832 			pgoff_t end, pgoff_t *num_prefault);
833 
834 /**
835  * vmw_resource_mob_attached - Whether a resource currently has a mob attached
836  * @res: The resource
837  *
838  * Return: true if the resource has a mob attached, false otherwise.
839  */
vmw_resource_mob_attached(const struct vmw_resource * res)840 static inline bool vmw_resource_mob_attached(const struct vmw_resource *res)
841 {
842 	return !RB_EMPTY_NODE(&res->mob_node);
843 }
844 
845 /**
846  * GEM related functionality - vmwgfx_gem.c
847  */
848 struct vmw_bo_params;
849 int vmw_gem_object_create(struct vmw_private *vmw,
850 			  struct vmw_bo_params *params,
851 			  struct vmw_bo **p_vbo);
852 extern int vmw_gem_object_create_with_handle(struct vmw_private *dev_priv,
853 					     struct drm_file *filp,
854 					     uint32_t size,
855 					     uint32_t *handle,
856 					     struct vmw_bo **p_vbo);
857 extern int vmw_gem_object_create_ioctl(struct drm_device *dev, void *data,
858 				       struct drm_file *filp);
859 extern void vmw_debugfs_gem_init(struct vmw_private *vdev);
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 
874 /**
875  * Fifo utilities - vmwgfx_fifo.c
876  */
877 
878 extern struct vmw_fifo_state *vmw_fifo_create(struct vmw_private *dev_priv);
879 extern void vmw_fifo_destroy(struct vmw_private *dev_priv);
880 extern bool vmw_cmd_supported(struct vmw_private *vmw);
881 extern void *
882 vmw_cmd_ctx_reserve(struct vmw_private *dev_priv, uint32_t bytes, int ctx_id);
883 extern void vmw_cmd_commit(struct vmw_private *dev_priv, uint32_t bytes);
884 extern void vmw_cmd_commit_flush(struct vmw_private *dev_priv, uint32_t bytes);
885 extern int vmw_cmd_send_fence(struct vmw_private *dev_priv, uint32_t *seqno);
886 extern bool vmw_supports_3d(struct vmw_private *dev_priv);
887 extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
888 extern bool vmw_fifo_have_pitchlock(struct vmw_private *dev_priv);
889 extern int vmw_cmd_emit_dummy_query(struct vmw_private *dev_priv,
890 				    uint32_t cid);
891 extern int vmw_cmd_flush(struct vmw_private *dev_priv,
892 			 bool interruptible);
893 
894 #define VMW_CMD_CTX_RESERVE(__priv, __bytes, __ctx_id)                        \
895 ({                                                                            \
896 	vmw_cmd_ctx_reserve(__priv, __bytes, __ctx_id) ? : ({                 \
897 		DRM_ERROR("FIFO reserve failed at %s for %u bytes\n",         \
898 			  __func__, (unsigned int) __bytes);                  \
899 		NULL;                                                         \
900 	});                                                                   \
901 })
902 
903 #define VMW_CMD_RESERVE(__priv, __bytes)                                     \
904 	VMW_CMD_CTX_RESERVE(__priv, __bytes, SVGA3D_INVALID_ID)
905 
906 
907 /**
908  * vmw_fifo_caps - Returns the capabilities of the FIFO command
909  * queue or 0 if fifo memory isn't present.
910  * @dev_priv: The device private context
911  */
vmw_fifo_caps(const struct vmw_private * dev_priv)912 static inline uint32_t vmw_fifo_caps(const struct vmw_private *dev_priv)
913 {
914 	if (!dev_priv->fifo_mem || !dev_priv->fifo)
915 		return 0;
916 	return dev_priv->fifo->capabilities;
917 }
918 
919 
920 /**
921  * vmw_is_cursor_bypass3_enabled - Returns TRUE iff Cursor Bypass 3
922  * is enabled in the FIFO.
923  * @dev_priv: The device private context
924  */
925 static inline bool
vmw_is_cursor_bypass3_enabled(const struct vmw_private * dev_priv)926 vmw_is_cursor_bypass3_enabled(const struct vmw_private *dev_priv)
927 {
928 	return (vmw_fifo_caps(dev_priv) & SVGA_FIFO_CAP_CURSOR_BYPASS_3) != 0;
929 }
930 
931 /**
932  * TTM buffer object driver - vmwgfx_ttm_buffer.c
933  */
934 
935 extern const size_t vmw_tt_size;
936 extern struct ttm_placement vmw_vram_placement;
937 extern struct ttm_placement vmw_sys_placement;
938 extern struct ttm_device_funcs vmw_bo_driver;
939 extern const struct vmw_sg_table *
940 vmw_bo_sg_table(struct ttm_buffer_object *bo);
941 int vmw_bo_create_and_populate(struct vmw_private *dev_priv,
942 			       size_t bo_size,
943 			       u32 domain,
944 			       struct vmw_bo **bo_p);
945 
946 extern void vmw_piter_start(struct vmw_piter *viter,
947 			    const struct vmw_sg_table *vsgt,
948 			    unsigned long p_offs);
949 
950 /**
951  * vmw_piter_next - Advance the iterator one page.
952  *
953  * @viter: Pointer to the iterator to advance.
954  *
955  * Returns false if past the list of pages, true otherwise.
956  */
vmw_piter_next(struct vmw_piter * viter)957 static inline bool vmw_piter_next(struct vmw_piter *viter)
958 {
959 	return viter->next(viter);
960 }
961 
962 /**
963  * vmw_piter_dma_addr - Return the DMA address of the current page.
964  *
965  * @viter: Pointer to the iterator
966  *
967  * Returns the DMA address of the page pointed to by @viter.
968  */
vmw_piter_dma_addr(struct vmw_piter * viter)969 static inline dma_addr_t vmw_piter_dma_addr(struct vmw_piter *viter)
970 {
971 	return viter->dma_address(viter);
972 }
973 
974 /**
975  * vmw_piter_page - Return a pointer to the current page.
976  *
977  * @viter: Pointer to the iterator
978  *
979  * Returns the DMA address of the page pointed to by @viter.
980  */
vmw_piter_page(struct vmw_piter * viter)981 static inline struct page *vmw_piter_page(struct vmw_piter *viter)
982 {
983 	return viter->pages[viter->i];
984 }
985 
986 /**
987  * Command submission - vmwgfx_execbuf.c
988  */
989 
990 extern int vmw_execbuf_ioctl(struct drm_device *dev, void *data,
991 			     struct drm_file *file_priv);
992 extern int vmw_execbuf_process(struct drm_file *file_priv,
993 			       struct vmw_private *dev_priv,
994 			       void __user *user_commands,
995 			       void *kernel_commands,
996 			       uint32_t command_size,
997 			       uint64_t throttle_us,
998 			       uint32_t dx_context_handle,
999 			       struct drm_vmw_fence_rep __user
1000 			       *user_fence_rep,
1001 			       struct vmw_fence_obj **out_fence,
1002 			       uint32_t flags);
1003 extern void __vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv,
1004 					    struct vmw_fence_obj *fence);
1005 extern void vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv);
1006 
1007 extern int vmw_execbuf_fence_commands(struct drm_file *file_priv,
1008 				      struct vmw_private *dev_priv,
1009 				      struct vmw_fence_obj **p_fence,
1010 				      uint32_t *p_handle);
1011 extern int vmw_execbuf_copy_fence_user(struct vmw_private *dev_priv,
1012 					struct vmw_fpriv *vmw_fp,
1013 					int ret,
1014 					struct drm_vmw_fence_rep __user
1015 					*user_fence_rep,
1016 					struct vmw_fence_obj *fence,
1017 					uint32_t fence_handle,
1018 					int32_t out_fence_fd);
1019 bool vmw_cmd_describe(const void *buf, u32 *size, char const **cmd);
1020 
1021 /**
1022  * IRQs and wating - vmwgfx_irq.c
1023  */
1024 
1025 extern int vmw_irq_install(struct vmw_private *dev_priv);
1026 extern void vmw_irq_uninstall(struct drm_device *dev);
1027 extern bool vmw_seqno_passed(struct vmw_private *dev_priv,
1028 				uint32_t seqno);
1029 extern int vmw_fallback_wait(struct vmw_private *dev_priv,
1030 			     bool lazy,
1031 			     bool fifo_idle,
1032 			     uint32_t seqno,
1033 			     bool interruptible,
1034 			     unsigned long timeout);
1035 extern void vmw_update_seqno(struct vmw_private *dev_priv);
1036 extern void vmw_seqno_waiter_add(struct vmw_private *dev_priv);
1037 extern void vmw_seqno_waiter_remove(struct vmw_private *dev_priv);
1038 extern void vmw_goal_waiter_add(struct vmw_private *dev_priv);
1039 extern void vmw_goal_waiter_remove(struct vmw_private *dev_priv);
1040 extern void vmw_generic_waiter_add(struct vmw_private *dev_priv, u32 flag,
1041 				   int *waiter_count);
1042 extern void vmw_generic_waiter_remove(struct vmw_private *dev_priv,
1043 				      u32 flag, int *waiter_count);
1044 
1045 /**
1046  * Kernel modesetting - vmwgfx_kms.c
1047  */
1048 
1049 int vmw_kms_init(struct vmw_private *dev_priv);
1050 int vmw_kms_close(struct vmw_private *dev_priv);
1051 int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
1052 				struct drm_file *file_priv);
1053 void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv);
1054 void vmw_kms_cursor_snoop(struct vmw_surface *srf,
1055 			  struct ttm_object_file *tfile,
1056 			  struct ttm_buffer_object *bo,
1057 			  SVGA3dCmdHeader *header);
1058 int vmw_kms_write_svga(struct vmw_private *vmw_priv,
1059 		       unsigned width, unsigned height, unsigned pitch,
1060 		       unsigned bpp, unsigned depth);
1061 int vmw_kms_present(struct vmw_private *dev_priv,
1062 		    struct drm_file *file_priv,
1063 		    struct vmw_framebuffer *vfb,
1064 		    struct vmw_surface *surface,
1065 		    uint32_t sid, int32_t destX, int32_t destY,
1066 		    struct drm_vmw_rect *clips,
1067 		    uint32_t num_clips);
1068 int vmw_kms_update_layout_ioctl(struct drm_device *dev, void *data,
1069 				struct drm_file *file_priv);
1070 void vmw_kms_legacy_hotspot_clear(struct vmw_private *dev_priv);
1071 int vmw_kms_suspend(struct drm_device *dev);
1072 int vmw_kms_resume(struct drm_device *dev);
1073 void vmw_kms_lost_device(struct drm_device *dev);
1074 
1075 extern int vmw_resource_pin(struct vmw_resource *res, bool interruptible);
1076 extern void vmw_resource_unpin(struct vmw_resource *res);
1077 extern enum vmw_res_type vmw_res_type(const struct vmw_resource *res);
1078 
1079 /**
1080  * Overlay control - vmwgfx_overlay.c
1081  */
1082 
1083 int vmw_overlay_init(struct vmw_private *dev_priv);
1084 int vmw_overlay_close(struct vmw_private *dev_priv);
1085 int vmw_overlay_ioctl(struct drm_device *dev, void *data,
1086 		      struct drm_file *file_priv);
1087 int vmw_overlay_resume_all(struct vmw_private *dev_priv);
1088 int vmw_overlay_pause_all(struct vmw_private *dev_priv);
1089 int vmw_overlay_claim(struct vmw_private *dev_priv, uint32_t *out);
1090 int vmw_overlay_unref(struct vmw_private *dev_priv, uint32_t stream_id);
1091 int vmw_overlay_num_overlays(struct vmw_private *dev_priv);
1092 int vmw_overlay_num_free_overlays(struct vmw_private *dev_priv);
1093 
1094 /**
1095  * GMR Id manager
1096  */
1097 
1098 int vmw_gmrid_man_init(struct vmw_private *dev_priv, int type);
1099 void vmw_gmrid_man_fini(struct vmw_private *dev_priv, int type);
1100 
1101 /**
1102  * System memory manager
1103  */
1104 int vmw_sys_man_init(struct vmw_private *dev_priv);
1105 void vmw_sys_man_fini(struct vmw_private *dev_priv);
1106 
1107 /**
1108  * Prime - vmwgfx_prime.c
1109  */
1110 
1111 extern const struct dma_buf_ops vmw_prime_dmabuf_ops;
1112 extern int vmw_prime_fd_to_handle(struct drm_device *dev,
1113 				  struct drm_file *file_priv,
1114 				  int fd, u32 *handle);
1115 extern int vmw_prime_handle_to_fd(struct drm_device *dev,
1116 				  struct drm_file *file_priv,
1117 				  uint32_t handle, uint32_t flags,
1118 				  int *prime_fd);
1119 struct drm_gem_object *vmw_prime_import_sg_table(struct drm_device *dev,
1120 						 struct dma_buf_attachment *attach,
1121 						 struct sg_table *table);
1122 
1123 /*
1124  * MemoryOBject management -  vmwgfx_mob.c
1125  */
1126 struct vmw_mob;
1127 extern int vmw_mob_bind(struct vmw_private *dev_priv, struct vmw_mob *mob,
1128 			const struct vmw_sg_table *vsgt,
1129 			unsigned long num_data_pages, int32_t mob_id);
1130 extern void vmw_mob_unbind(struct vmw_private *dev_priv,
1131 			   struct vmw_mob *mob);
1132 extern void vmw_mob_destroy(struct vmw_mob *mob);
1133 extern struct vmw_mob *vmw_mob_create(unsigned long data_pages);
1134 extern int vmw_otables_setup(struct vmw_private *dev_priv);
1135 extern void vmw_otables_takedown(struct vmw_private *dev_priv);
1136 
1137 /*
1138  * Context management - vmwgfx_context.c
1139  */
1140 
1141 extern const struct vmw_user_resource_conv *user_context_converter;
1142 
1143 extern int vmw_context_define_ioctl(struct drm_device *dev, void *data,
1144 				    struct drm_file *file_priv);
1145 extern int vmw_extended_context_define_ioctl(struct drm_device *dev, void *data,
1146 					     struct drm_file *file_priv);
1147 extern int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
1148 				     struct drm_file *file_priv);
1149 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1150 extern struct vmw_cmdbuf_res_manager *
1151 vmw_context_res_man(struct vmw_resource *ctx);
1152 extern struct vmw_resource *vmw_context_cotable(struct vmw_resource *ctx,
1153 						SVGACOTableType cotable_type);
1154 struct vmw_ctx_binding_state;
1155 extern struct vmw_ctx_binding_state *
1156 vmw_context_binding_state(struct vmw_resource *ctx);
1157 extern void vmw_dx_context_scrub_cotables(struct vmw_resource *ctx,
1158 					  bool readback);
1159 extern int vmw_context_bind_dx_query(struct vmw_resource *ctx_res,
1160 				     struct vmw_bo *mob);
1161 extern struct vmw_bo *
1162 vmw_context_get_dx_query_mob(struct vmw_resource *ctx_res);
1163 
1164 
1165 /*
1166  * Surface management - vmwgfx_surface.c
1167  */
1168 
1169 extern const struct vmw_user_resource_conv *user_surface_converter;
1170 
1171 extern int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
1172 				     struct drm_file *file_priv);
1173 extern int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
1174 				    struct drm_file *file_priv);
1175 extern int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
1176 				       struct drm_file *file_priv);
1177 extern int vmw_gb_surface_define_ioctl(struct drm_device *dev, void *data,
1178 				       struct drm_file *file_priv);
1179 extern int vmw_gb_surface_reference_ioctl(struct drm_device *dev, void *data,
1180 					  struct drm_file *file_priv);
1181 extern int vmw_gb_surface_define_ext_ioctl(struct drm_device *dev,
1182 					   void *data,
1183 					   struct drm_file *file_priv);
1184 extern int vmw_gb_surface_reference_ext_ioctl(struct drm_device *dev,
1185 					      void *data,
1186 					      struct drm_file *file_priv);
1187 
1188 int vmw_gb_surface_define(struct vmw_private *dev_priv,
1189 			  const struct vmw_surface_metadata *req,
1190 			  struct vmw_surface **srf_out);
1191 struct vmw_surface *vmw_lookup_surface_for_buffer(struct vmw_private *vmw,
1192 						  struct vmw_bo *bo,
1193 						  u32 handle);
1194 u32 vmw_lookup_surface_handle_for_buffer(struct vmw_private *vmw,
1195 					 struct vmw_bo *bo,
1196 					 u32 handle);
1197 int vmw_dumb_create(struct drm_file *file_priv,
1198 		    struct drm_device *dev,
1199 		    struct drm_mode_create_dumb *args);
1200 
1201 /*
1202  * Shader management - vmwgfx_shader.c
1203  */
1204 
1205 extern const struct vmw_user_resource_conv *user_shader_converter;
1206 
1207 extern int vmw_shader_define_ioctl(struct drm_device *dev, void *data,
1208 				   struct drm_file *file_priv);
1209 extern int vmw_shader_destroy_ioctl(struct drm_device *dev, void *data,
1210 				    struct drm_file *file_priv);
1211 extern int vmw_compat_shader_add(struct vmw_private *dev_priv,
1212 				 struct vmw_cmdbuf_res_manager *man,
1213 				 u32 user_key, const void *bytecode,
1214 				 SVGA3dShaderType shader_type,
1215 				 size_t size,
1216 				 struct list_head *list);
1217 extern int vmw_shader_remove(struct vmw_cmdbuf_res_manager *man,
1218 			     u32 user_key, SVGA3dShaderType shader_type,
1219 			     struct list_head *list);
1220 extern int vmw_dx_shader_add(struct vmw_cmdbuf_res_manager *man,
1221 			     struct vmw_resource *ctx,
1222 			     u32 user_key,
1223 			     SVGA3dShaderType shader_type,
1224 			     struct list_head *list);
1225 extern void vmw_dx_shader_cotable_list_scrub(struct vmw_private *dev_priv,
1226 					     struct list_head *list,
1227 					     bool readback);
1228 
1229 extern struct vmw_resource *
1230 vmw_shader_lookup(struct vmw_cmdbuf_res_manager *man,
1231 		  u32 user_key, SVGA3dShaderType shader_type);
1232 
1233 /*
1234  * Streamoutput management
1235  */
1236 struct vmw_resource *
1237 vmw_dx_streamoutput_lookup(struct vmw_cmdbuf_res_manager *man,
1238 			   u32 user_key);
1239 int vmw_dx_streamoutput_add(struct vmw_cmdbuf_res_manager *man,
1240 			    struct vmw_resource *ctx,
1241 			    SVGA3dStreamOutputId user_key,
1242 			    struct list_head *list);
1243 void vmw_dx_streamoutput_set_size(struct vmw_resource *res, u32 size);
1244 int vmw_dx_streamoutput_remove(struct vmw_cmdbuf_res_manager *man,
1245 			       SVGA3dStreamOutputId user_key,
1246 			       struct list_head *list);
1247 void vmw_dx_streamoutput_cotable_list_scrub(struct vmw_private *dev_priv,
1248 					    struct list_head *list,
1249 					    bool readback);
1250 
1251 /*
1252  * Command buffer managed resources - vmwgfx_cmdbuf_res.c
1253  */
1254 
1255 extern struct vmw_cmdbuf_res_manager *
1256 vmw_cmdbuf_res_man_create(struct vmw_private *dev_priv);
1257 extern void vmw_cmdbuf_res_man_destroy(struct vmw_cmdbuf_res_manager *man);
1258 extern struct vmw_resource *
1259 vmw_cmdbuf_res_lookup(struct vmw_cmdbuf_res_manager *man,
1260 		      enum vmw_cmdbuf_res_type res_type,
1261 		      u32 user_key);
1262 extern void vmw_cmdbuf_res_revert(struct list_head *list);
1263 extern void vmw_cmdbuf_res_commit(struct list_head *list);
1264 extern int vmw_cmdbuf_res_add(struct vmw_cmdbuf_res_manager *man,
1265 			      enum vmw_cmdbuf_res_type res_type,
1266 			      u32 user_key,
1267 			      struct vmw_resource *res,
1268 			      struct list_head *list);
1269 extern int vmw_cmdbuf_res_remove(struct vmw_cmdbuf_res_manager *man,
1270 				 enum vmw_cmdbuf_res_type res_type,
1271 				 u32 user_key,
1272 				 struct list_head *list,
1273 				 struct vmw_resource **res);
1274 
1275 /*
1276  * COTable management - vmwgfx_cotable.c
1277  */
1278 extern const SVGACOTableType vmw_cotable_scrub_order[];
1279 extern struct vmw_resource *vmw_cotable_alloc(struct vmw_private *dev_priv,
1280 					      struct vmw_resource *ctx,
1281 					      u32 type);
1282 extern int vmw_cotable_notify(struct vmw_resource *res, int id);
1283 extern int vmw_cotable_scrub(struct vmw_resource *res, bool readback);
1284 extern void vmw_cotable_add_resource(struct vmw_resource *ctx,
1285 				     struct list_head *head);
1286 
1287 /*
1288  * Command buffer managerment vmwgfx_cmdbuf.c
1289  */
1290 struct vmw_cmdbuf_man;
1291 struct vmw_cmdbuf_header;
1292 
1293 extern struct vmw_cmdbuf_man *
1294 vmw_cmdbuf_man_create(struct vmw_private *dev_priv);
1295 extern int vmw_cmdbuf_set_pool_size(struct vmw_cmdbuf_man *man, size_t size);
1296 extern void vmw_cmdbuf_remove_pool(struct vmw_cmdbuf_man *man);
1297 extern void vmw_cmdbuf_man_destroy(struct vmw_cmdbuf_man *man);
1298 extern int vmw_cmdbuf_idle(struct vmw_cmdbuf_man *man, bool interruptible,
1299 			   unsigned long timeout);
1300 extern void *vmw_cmdbuf_reserve(struct vmw_cmdbuf_man *man, size_t size,
1301 				int ctx_id, bool interruptible,
1302 				struct vmw_cmdbuf_header *header);
1303 extern void vmw_cmdbuf_commit(struct vmw_cmdbuf_man *man, size_t size,
1304 			      struct vmw_cmdbuf_header *header,
1305 			      bool flush);
1306 extern void *vmw_cmdbuf_alloc(struct vmw_cmdbuf_man *man,
1307 			      size_t size, bool interruptible,
1308 			      struct vmw_cmdbuf_header **p_header);
1309 extern void vmw_cmdbuf_header_free(struct vmw_cmdbuf_header *header);
1310 extern int vmw_cmdbuf_cur_flush(struct vmw_cmdbuf_man *man,
1311 				bool interruptible);
1312 extern void vmw_cmdbuf_irqthread(struct vmw_cmdbuf_man *man);
1313 
1314 /* CPU blit utilities - vmwgfx_blit.c */
1315 
1316 /**
1317  * struct vmw_diff_cpy - CPU blit information structure
1318  *
1319  * @rect: The output bounding box rectangle.
1320  * @line: The current line of the blit.
1321  * @line_offset: Offset of the current line segment.
1322  * @cpp: Bytes per pixel (granularity information).
1323  * @memcpy: Which memcpy function to use.
1324  */
1325 struct vmw_diff_cpy {
1326 	struct drm_rect rect;
1327 	size_t line;
1328 	size_t line_offset;
1329 	int cpp;
1330 	void (*do_cpy)(struct vmw_diff_cpy *diff, u8 *dest, const u8 *src,
1331 		       size_t n);
1332 };
1333 
1334 #define VMW_CPU_BLIT_INITIALIZER {	\
1335 	.do_cpy = vmw_memcpy,		\
1336 }
1337 
1338 #define VMW_CPU_BLIT_DIFF_INITIALIZER(_cpp) {	  \
1339 	.line = 0,				  \
1340 	.line_offset = 0,			  \
1341 	.rect = { .x1 = INT_MAX/2,		  \
1342 		  .y1 = INT_MAX/2,		  \
1343 		  .x2 = INT_MIN/2,		  \
1344 		  .y2 = INT_MIN/2		  \
1345 	},					  \
1346 	.cpp = _cpp,				  \
1347 	.do_cpy = vmw_diff_memcpy,		  \
1348 }
1349 
1350 void vmw_diff_memcpy(struct vmw_diff_cpy *diff, u8 *dest, const u8 *src,
1351 		     size_t n);
1352 
1353 void vmw_memcpy(struct vmw_diff_cpy *diff, u8 *dest, const u8 *src, size_t n);
1354 
1355 int vmw_bo_cpu_blit(struct vmw_bo *dst,
1356 		    u32 dst_offset, u32 dst_stride,
1357 		    struct vmw_bo *src,
1358 		    u32 src_offset, u32 src_stride,
1359 		    u32 w, u32 h,
1360 		    struct vmw_diff_cpy *diff);
1361 
1362 /* Host messaging -vmwgfx_msg.c: */
1363 void vmw_disable_backdoor(void);
1364 int vmw_host_get_guestinfo(const char *guest_info_param,
1365 			   char *buffer, size_t *length);
1366 __printf(1, 2) int vmw_host_printf(const char *fmt, ...);
1367 int vmw_msg_ioctl(struct drm_device *dev, void *data,
1368 		  struct drm_file *file_priv);
1369 
1370 /* Host mksGuestStats -vmwgfx_msg.c: */
1371 int vmw_mksstat_get_kern_slot(pid_t pid, struct vmw_private *dev_priv);
1372 
1373 int vmw_mksstat_reset_ioctl(struct drm_device *dev, void *data,
1374 		      struct drm_file *file_priv);
1375 int vmw_mksstat_add_ioctl(struct drm_device *dev, void *data,
1376 		      struct drm_file *file_priv);
1377 int vmw_mksstat_remove_ioctl(struct drm_device *dev, void *data,
1378 		      struct drm_file *file_priv);
1379 int vmw_mksstat_remove_all(struct vmw_private *dev_priv);
1380 
1381 /* VMW logging */
1382 
1383 /**
1384  * VMW_DEBUG_USER - Debug output for user-space debugging.
1385  *
1386  * @fmt: printf() like format string.
1387  *
1388  * This macro is for logging user-space error and debugging messages for e.g.
1389  * command buffer execution errors due to malformed commands, invalid context,
1390  * etc.
1391  */
1392 #define VMW_DEBUG_USER(fmt, ...)                                              \
1393 	DRM_DEBUG_DRIVER(fmt, ##__VA_ARGS__)
1394 
1395 /* Resource dirtying - vmwgfx_page_dirty.c */
1396 void vmw_bo_dirty_scan(struct vmw_bo *vbo);
1397 int vmw_bo_dirty_add(struct vmw_bo *vbo);
1398 void vmw_bo_dirty_transfer_to_res(struct vmw_resource *res);
1399 void vmw_bo_dirty_clear_res(struct vmw_resource *res);
1400 void vmw_bo_dirty_release(struct vmw_bo *vbo);
1401 void vmw_bo_dirty_unmap(struct vmw_bo *vbo,
1402 			pgoff_t start, pgoff_t end);
1403 vm_fault_t vmw_bo_vm_fault(struct vm_fault *vmf);
1404 vm_fault_t vmw_bo_vm_mkwrite(struct vm_fault *vmf);
1405 
1406 
1407 /**
1408  * VMW_DEBUG_KMS - Debug output for kernel mode-setting
1409  *
1410  * This macro is for debugging vmwgfx mode-setting code.
1411  */
1412 #define VMW_DEBUG_KMS(fmt, ...)                                               \
1413 	DRM_DEBUG_DRIVER(fmt, ##__VA_ARGS__)
1414 
1415 /**
1416  * Inline helper functions
1417  */
1418 
vmw_surface_unreference(struct vmw_surface ** srf)1419 static inline void vmw_surface_unreference(struct vmw_surface **srf)
1420 {
1421 	struct vmw_surface *tmp_srf = *srf;
1422 	struct vmw_resource *res = &tmp_srf->res;
1423 	*srf = NULL;
1424 
1425 	vmw_resource_unreference(&res);
1426 }
1427 
vmw_surface_reference(struct vmw_surface * srf)1428 static inline struct vmw_surface *vmw_surface_reference(struct vmw_surface *srf)
1429 {
1430 	(void) vmw_resource_reference(&srf->res);
1431 	return srf;
1432 }
1433 
vmw_fifo_resource_inc(struct vmw_private * dev_priv)1434 static inline void vmw_fifo_resource_inc(struct vmw_private *dev_priv)
1435 {
1436 	atomic_inc(&dev_priv->num_fifo_resources);
1437 }
1438 
vmw_fifo_resource_dec(struct vmw_private * dev_priv)1439 static inline void vmw_fifo_resource_dec(struct vmw_private *dev_priv)
1440 {
1441 	atomic_dec(&dev_priv->num_fifo_resources);
1442 }
1443 
1444 /**
1445  * vmw_fifo_mem_read - Perform a MMIO read from the fifo memory
1446  *
1447  * @fifo_reg: The fifo register to read from
1448  *
1449  * This function is intended to be equivalent to ioread32() on
1450  * memremap'd memory, but without byteswapping.
1451  */
vmw_fifo_mem_read(struct vmw_private * vmw,uint32 fifo_reg)1452 static inline u32 vmw_fifo_mem_read(struct vmw_private *vmw, uint32 fifo_reg)
1453 {
1454 	BUG_ON(vmw_is_svga_v3(vmw));
1455 	return READ_ONCE(*(vmw->fifo_mem + fifo_reg));
1456 }
1457 
1458 /**
1459  * vmw_fifo_mem_write - Perform a MMIO write to volatile memory
1460  *
1461  * @addr: The fifo register to write to
1462  *
1463  * This function is intended to be equivalent to iowrite32 on
1464  * memremap'd memory, but without byteswapping.
1465  */
vmw_fifo_mem_write(struct vmw_private * vmw,u32 fifo_reg,u32 value)1466 static inline void vmw_fifo_mem_write(struct vmw_private *vmw, u32 fifo_reg,
1467 				      u32 value)
1468 {
1469 	BUG_ON(vmw_is_svga_v3(vmw));
1470 	WRITE_ONCE(*(vmw->fifo_mem + fifo_reg), value);
1471 }
1472 
vmw_fence_read(struct vmw_private * dev_priv)1473 static inline u32 vmw_fence_read(struct vmw_private *dev_priv)
1474 {
1475 	u32 fence;
1476 	if (vmw_is_svga_v3(dev_priv))
1477 		fence = vmw_read(dev_priv, SVGA_REG_FENCE);
1478 	else
1479 		fence = vmw_fifo_mem_read(dev_priv, SVGA_FIFO_FENCE);
1480 	return fence;
1481 }
1482 
vmw_fence_write(struct vmw_private * dev_priv,u32 fence)1483 static inline void vmw_fence_write(struct vmw_private *dev_priv,
1484 				  u32 fence)
1485 {
1486 	BUG_ON(vmw_is_svga_v3(dev_priv));
1487 	vmw_fifo_mem_write(dev_priv, SVGA_FIFO_FENCE, fence);
1488 }
1489 
vmw_irq_status_read(struct vmw_private * vmw)1490 static inline u32 vmw_irq_status_read(struct vmw_private *vmw)
1491 {
1492 	u32 status;
1493 	if (vmw_is_svga_v3(vmw))
1494 		status = vmw_read(vmw, SVGA_REG_IRQ_STATUS);
1495 	else
1496 		status = inl(vmw->io_start + SVGA_IRQSTATUS_PORT);
1497 	return status;
1498 }
1499 
vmw_irq_status_write(struct vmw_private * vmw,uint32 status)1500 static inline void vmw_irq_status_write(struct vmw_private *vmw,
1501 					uint32 status)
1502 {
1503 	if (vmw_is_svga_v3(vmw))
1504 		vmw_write(vmw, SVGA_REG_IRQ_STATUS, status);
1505 	else
1506 		outl(status, vmw->io_start + SVGA_IRQSTATUS_PORT);
1507 }
1508 
vmw_has_fences(struct vmw_private * vmw)1509 static inline bool vmw_has_fences(struct vmw_private *vmw)
1510 {
1511 	if ((vmw->capabilities & (SVGA_CAP_COMMAND_BUFFERS |
1512 				  SVGA_CAP_CMD_BUFFERS_2)) != 0)
1513 		return true;
1514 	return (vmw_fifo_caps(vmw) & SVGA_FIFO_CAP_FENCE) != 0;
1515 }
1516 
vmw_shadertype_is_valid(enum vmw_sm_type shader_model,u32 shader_type)1517 static inline bool vmw_shadertype_is_valid(enum vmw_sm_type shader_model,
1518 					   u32 shader_type)
1519 {
1520 	SVGA3dShaderType max_allowed = SVGA3D_SHADERTYPE_PREDX_MAX;
1521 
1522 	if (shader_model >= VMW_SM_5)
1523 		max_allowed = SVGA3D_SHADERTYPE_MAX;
1524 	else if (shader_model >= VMW_SM_4)
1525 		max_allowed = SVGA3D_SHADERTYPE_DX10_MAX;
1526 	return shader_type >= SVGA3D_SHADERTYPE_MIN && shader_type < max_allowed;
1527 }
1528 
1529 #endif
1530