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