1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
2 /**************************************************************************
3 *
4 * Copyright 2009-2015 VMware, Inc., Palo Alto, CA., USA
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
24 * USE OR OTHER DEALINGS IN THE SOFTWARE.
25 *
26 **************************************************************************/
27
28 #ifndef _VMWGFX_DRV_H_
29 #define _VMWGFX_DRV_H_
30
31 #include <linux/suspend.h>
32 #include <linux/sync_file.h>
33
34 #include <drm/drm_auth.h>
35 #include <drm/drm_device.h>
36 #include <drm/drm_file.h>
37 #include <drm/drm_hashtab.h>
38 #include <drm/drm_rect.h>
39
40 #include <drm/ttm/ttm_bo_driver.h>
41 #include <drm/ttm/ttm_execbuf_util.h>
42 #include <drm/ttm/ttm_module.h>
43
44 #include "ttm_lock.h"
45 #include "ttm_object.h"
46
47 #include "vmwgfx_fence.h"
48 #include "vmwgfx_reg.h"
49 #include "vmwgfx_validation.h"
50
51 /*
52 * FIXME: vmwgfx_drm.h needs to be last due to dependencies.
53 * uapi headers should not depend on header files outside uapi/.
54 */
55 #include <drm/vmwgfx_drm.h>
56
57
58 #define VMWGFX_DRIVER_NAME "vmwgfx"
59 #define VMWGFX_DRIVER_DATE "20200114"
60 #define VMWGFX_DRIVER_MAJOR 2
61 #define VMWGFX_DRIVER_MINOR 18
62 #define VMWGFX_DRIVER_PATCHLEVEL 0
63 #define VMWGFX_FIFO_STATIC_SIZE (1024*1024)
64 #define VMWGFX_MAX_RELOCATIONS 2048
65 #define VMWGFX_MAX_VALIDATIONS 2048
66 #define VMWGFX_MAX_DISPLAYS 16
67 #define VMWGFX_CMD_BOUNCE_INIT_SIZE 32768
68 #define VMWGFX_ENABLE_SCREEN_TARGET_OTABLE 1
69
70 /*
71 * Perhaps we should have sysfs entries for these.
72 */
73 #define VMWGFX_NUM_GB_CONTEXT 256
74 #define VMWGFX_NUM_GB_SHADER 20000
75 #define VMWGFX_NUM_GB_SURFACE 32768
76 #define VMWGFX_NUM_GB_SCREEN_TARGET VMWGFX_MAX_DISPLAYS
77 #define VMWGFX_NUM_DXCONTEXT 256
78 #define VMWGFX_NUM_DXQUERY 512
79 #define VMWGFX_NUM_MOB (VMWGFX_NUM_GB_CONTEXT +\
80 VMWGFX_NUM_GB_SHADER +\
81 VMWGFX_NUM_GB_SURFACE +\
82 VMWGFX_NUM_GB_SCREEN_TARGET)
83
84 #define VMW_PL_GMR (TTM_PL_PRIV + 0)
85 #define VMW_PL_MOB (TTM_PL_PRIV + 1)
86
87 #define VMW_RES_CONTEXT ttm_driver_type0
88 #define VMW_RES_SURFACE ttm_driver_type1
89 #define VMW_RES_STREAM ttm_driver_type2
90 #define VMW_RES_FENCE ttm_driver_type3
91 #define VMW_RES_SHADER ttm_driver_type4
92
93 struct vmw_fpriv {
94 struct ttm_object_file *tfile;
95 bool gb_aware; /* user-space is guest-backed aware */
96 };
97
98 /**
99 * struct vmw_buffer_object - TTM buffer object with vmwgfx additions
100 * @base: The TTM buffer object
101 * @res_tree: RB tree of resources using this buffer object as a backing MOB
102 * @pin_count: pin depth
103 * @cpu_writers: Number of synccpu write grabs. Protected by reservation when
104 * increased. May be decreased without reservation.
105 * @dx_query_ctx: DX context if this buffer object is used as a DX query MOB
106 * @map: Kmap object for semi-persistent mappings
107 * @res_prios: Eviction priority counts for attached resources
108 * @dirty: structure for user-space dirty-tracking
109 */
110 struct vmw_buffer_object {
111 struct ttm_buffer_object base;
112 struct rb_root res_tree;
113 s32 pin_count;
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_marker_queue {
281 struct list_head head;
282 u64 lag;
283 u64 lag_time;
284 spinlock_t lock;
285 };
286
287 struct vmw_fifo_state {
288 unsigned long reserved_size;
289 u32 *dynamic_buffer;
290 u32 *static_buffer;
291 unsigned long static_buffer_size;
292 bool using_bounce_buffer;
293 uint32_t capabilities;
294 struct mutex fifo_mutex;
295 struct rw_semaphore rwsem;
296 struct vmw_marker_queue marker_queue;
297 bool dx;
298 };
299
300 /**
301 * struct vmw_res_cache_entry - resource information cache entry
302 * @handle: User-space handle of a resource.
303 * @res: Non-ref-counted pointer to the resource.
304 * @valid_handle: Whether the @handle member is valid.
305 * @valid: Whether the entry is valid, which also implies that the execbuf
306 * code holds a reference to the resource, and it's placed on the
307 * validation list.
308 *
309 * Used to avoid frequent repeated user-space handle lookups of the
310 * same resource.
311 */
312 struct vmw_res_cache_entry {
313 uint32_t handle;
314 struct vmw_resource *res;
315 void *private;
316 unsigned short valid_handle;
317 unsigned short valid;
318 };
319
320 /**
321 * enum vmw_dma_map_mode - indicate how to perform TTM page dma mappings.
322 */
323 enum vmw_dma_map_mode {
324 vmw_dma_phys, /* Use physical page addresses */
325 vmw_dma_alloc_coherent, /* Use TTM coherent pages */
326 vmw_dma_map_populate, /* Unmap from DMA just after unpopulate */
327 vmw_dma_map_bind, /* Unmap from DMA just before unbind */
328 vmw_dma_map_max
329 };
330
331 /**
332 * struct vmw_sg_table - Scatter/gather table for binding, with additional
333 * device-specific information.
334 *
335 * @sgt: Pointer to a struct sg_table with binding information
336 * @num_regions: Number of regions with device-address contiguous pages
337 */
338 struct vmw_sg_table {
339 enum vmw_dma_map_mode mode;
340 struct page **pages;
341 const dma_addr_t *addrs;
342 struct sg_table *sgt;
343 unsigned long num_regions;
344 unsigned long num_pages;
345 };
346
347 /**
348 * struct vmw_piter - Page iterator that iterates over a list of pages
349 * and DMA addresses that could be either a scatter-gather list or
350 * arrays
351 *
352 * @pages: Array of page pointers to the pages.
353 * @addrs: DMA addresses to the pages if coherent pages are used.
354 * @iter: Scatter-gather page iterator. Current position in SG list.
355 * @i: Current position in arrays.
356 * @num_pages: Number of pages total.
357 * @next: Function to advance the iterator. Returns false if past the list
358 * of pages, true otherwise.
359 * @dma_address: Function to return the DMA address of the current page.
360 */
361 struct vmw_piter {
362 struct page **pages;
363 const dma_addr_t *addrs;
364 struct sg_dma_page_iter iter;
365 unsigned long i;
366 unsigned long num_pages;
367 bool (*next)(struct vmw_piter *);
368 dma_addr_t (*dma_address)(struct vmw_piter *);
369 struct page *(*page)(struct vmw_piter *);
370 };
371
372 /*
373 * enum vmw_display_unit_type - Describes the display unit
374 */
375 enum vmw_display_unit_type {
376 vmw_du_invalid = 0,
377 vmw_du_legacy,
378 vmw_du_screen_object,
379 vmw_du_screen_target
380 };
381
382 struct vmw_validation_context;
383 struct vmw_ctx_validation_info;
384
385 /**
386 * struct vmw_sw_context - Command submission context
387 * @res_ht: Pointer hash table used to find validation duplicates
388 * @kernel: Whether the command buffer originates from kernel code rather
389 * than from user-space
390 * @fp: If @kernel is false, points to the file of the client. Otherwise
391 * NULL
392 * @cmd_bounce: Command bounce buffer used for command validation before
393 * copying to fifo space
394 * @cmd_bounce_size: Current command bounce buffer size
395 * @cur_query_bo: Current buffer object used as query result buffer
396 * @bo_relocations: List of buffer object relocations
397 * @res_relocations: List of resource relocations
398 * @buf_start: Pointer to start of memory where command validation takes
399 * place
400 * @res_cache: Cache of recently looked up resources
401 * @last_query_ctx: Last context that submitted a query
402 * @needs_post_query_barrier: Whether a query barrier is needed after
403 * command submission
404 * @staged_bindings: Cached per-context binding tracker
405 * @staged_bindings_inuse: Whether the cached per-context binding tracker
406 * is in use
407 * @staged_cmd_res: List of staged command buffer managed resources in this
408 * command buffer
409 * @ctx_list: List of context resources referenced in this command buffer
410 * @dx_ctx_node: Validation metadata of the current DX context
411 * @dx_query_mob: The MOB used for DX queries
412 * @dx_query_ctx: The DX context used for the last DX query
413 * @man: Pointer to the command buffer managed resource manager
414 * @ctx: The validation context
415 */
416 struct vmw_sw_context{
417 struct drm_open_hash res_ht;
418 bool res_ht_initialized;
419 bool kernel;
420 struct vmw_fpriv *fp;
421 uint32_t *cmd_bounce;
422 uint32_t cmd_bounce_size;
423 struct vmw_buffer_object *cur_query_bo;
424 struct list_head bo_relocations;
425 struct list_head res_relocations;
426 uint32_t *buf_start;
427 struct vmw_res_cache_entry res_cache[vmw_res_max];
428 struct vmw_resource *last_query_ctx;
429 bool needs_post_query_barrier;
430 struct vmw_ctx_binding_state *staged_bindings;
431 bool staged_bindings_inuse;
432 struct list_head staged_cmd_res;
433 struct list_head ctx_list;
434 struct vmw_ctx_validation_info *dx_ctx_node;
435 struct vmw_buffer_object *dx_query_mob;
436 struct vmw_resource *dx_query_ctx;
437 struct vmw_cmdbuf_res_manager *man;
438 struct vmw_validation_context *ctx;
439 };
440
441 struct vmw_legacy_display;
442 struct vmw_overlay;
443
444 struct vmw_vga_topology_state {
445 uint32_t width;
446 uint32_t height;
447 uint32_t primary;
448 uint32_t pos_x;
449 uint32_t pos_y;
450 };
451
452
453 /*
454 * struct vmw_otable - Guest Memory OBject table metadata
455 *
456 * @size: Size of the table (page-aligned).
457 * @page_table: Pointer to a struct vmw_mob holding the page table.
458 */
459 struct vmw_otable {
460 unsigned long size;
461 struct vmw_mob *page_table;
462 bool enabled;
463 };
464
465 struct vmw_otable_batch {
466 unsigned num_otables;
467 struct vmw_otable *otables;
468 struct vmw_resource *context;
469 struct ttm_buffer_object *otable_bo;
470 };
471
472 enum {
473 VMW_IRQTHREAD_FENCE,
474 VMW_IRQTHREAD_CMDBUF,
475 VMW_IRQTHREAD_MAX
476 };
477
478 /**
479 * enum vmw_sm_type - Graphics context capability supported by device.
480 * @VMW_SM_LEGACY: Pre DX context.
481 * @VMW_SM_4: Context support upto SM4.
482 * @VMW_SM_4_1: Context support upto SM4_1.
483 * @VMW_SM_5: Context support up to SM5.
484 * @VMW_SM_MAX: Should be the last.
485 */
486 enum vmw_sm_type {
487 VMW_SM_LEGACY = 0,
488 VMW_SM_4,
489 VMW_SM_4_1,
490 VMW_SM_5,
491 VMW_SM_MAX
492 };
493
494 struct vmw_private {
495 struct ttm_bo_device bdev;
496
497 struct vmw_fifo_state fifo;
498
499 struct drm_device *dev;
500 struct drm_vma_offset_manager vma_manager;
501 unsigned long vmw_chipset;
502 unsigned int io_start;
503 uint32_t vram_start;
504 uint32_t vram_size;
505 uint32_t prim_bb_mem;
506 uint32_t mmio_start;
507 uint32_t mmio_size;
508 uint32_t fb_max_width;
509 uint32_t fb_max_height;
510 uint32_t texture_max_width;
511 uint32_t texture_max_height;
512 uint32_t stdu_max_width;
513 uint32_t stdu_max_height;
514 uint32_t initial_width;
515 uint32_t initial_height;
516 u32 *mmio_virt;
517 uint32_t capabilities;
518 uint32_t capabilities2;
519 uint32_t max_gmr_ids;
520 uint32_t max_gmr_pages;
521 uint32_t max_mob_pages;
522 uint32_t max_mob_size;
523 uint32_t memory_size;
524 bool has_gmr;
525 bool has_mob;
526 spinlock_t hw_lock;
527 spinlock_t cap_lock;
528 bool assume_16bpp;
529
530 enum vmw_sm_type sm_type;
531
532 /*
533 * Framebuffer info.
534 */
535
536 void *fb_info;
537 enum vmw_display_unit_type active_display_unit;
538 struct vmw_legacy_display *ldu_priv;
539 struct vmw_overlay *overlay_priv;
540 struct drm_property *hotplug_mode_update_property;
541 struct drm_property *implicit_placement_property;
542 struct mutex global_kms_state_mutex;
543 spinlock_t cursor_lock;
544 struct drm_atomic_state *suspend_state;
545
546 /*
547 * Context and surface management.
548 */
549
550 spinlock_t resource_lock;
551 struct idr res_idr[vmw_res_max];
552
553 /*
554 * A resource manager for kernel-only surfaces and
555 * contexts.
556 */
557
558 struct ttm_object_device *tdev;
559
560 /*
561 * Fencing and IRQs.
562 */
563
564 atomic_t marker_seq;
565 wait_queue_head_t fence_queue;
566 wait_queue_head_t fifo_queue;
567 spinlock_t waiter_lock;
568 int fence_queue_waiters; /* Protected by waiter_lock */
569 int goal_queue_waiters; /* Protected by waiter_lock */
570 int cmdbuf_waiters; /* Protected by waiter_lock */
571 int error_waiters; /* Protected by waiter_lock */
572 int fifo_queue_waiters; /* Protected by waiter_lock */
573 uint32_t last_read_seqno;
574 struct vmw_fence_manager *fman;
575 uint32_t irq_mask; /* Updates protected by waiter_lock */
576
577 /*
578 * Device state
579 */
580
581 uint32_t traces_state;
582 uint32_t enable_state;
583 uint32_t config_done_state;
584
585 /**
586 * Execbuf
587 */
588 /**
589 * Protected by the cmdbuf mutex.
590 */
591
592 struct vmw_sw_context ctx;
593 struct mutex cmdbuf_mutex;
594 struct mutex binding_mutex;
595
596 /**
597 * Operating mode.
598 */
599
600 bool stealth;
601 bool enable_fb;
602 spinlock_t svga_lock;
603
604 /**
605 * PM management.
606 */
607 struct notifier_block pm_nb;
608 bool refuse_hibernation;
609 bool suspend_locked;
610
611 struct mutex release_mutex;
612 atomic_t num_fifo_resources;
613
614 /*
615 * Replace this with an rwsem as soon as we have down_xx_interruptible()
616 */
617 struct ttm_lock reservation_sem;
618
619 /*
620 * Query processing. These members
621 * are protected by the cmdbuf mutex.
622 */
623
624 struct vmw_buffer_object *dummy_query_bo;
625 struct vmw_buffer_object *pinned_bo;
626 uint32_t query_cid;
627 uint32_t query_cid_valid;
628 bool dummy_query_bo_pinned;
629
630 /*
631 * Surface swapping. The "surface_lru" list is protected by the
632 * resource lock in order to be able to destroy a surface and take
633 * it off the lru atomically. "used_memory_size" is currently
634 * protected by the cmdbuf mutex for simplicity.
635 */
636
637 struct list_head res_lru[vmw_res_max];
638 uint32_t used_memory_size;
639
640 /*
641 * DMA mapping stuff.
642 */
643 enum vmw_dma_map_mode map_mode;
644
645 /*
646 * Guest Backed stuff
647 */
648 struct vmw_otable_batch otable_batch;
649
650 struct vmw_cmdbuf_man *cman;
651 DECLARE_BITMAP(irqthread_pending, VMW_IRQTHREAD_MAX);
652
653 /* Validation memory reservation */
654 struct vmw_validation_mem vvm;
655 };
656
vmw_res_to_srf(struct vmw_resource * res)657 static inline struct vmw_surface *vmw_res_to_srf(struct vmw_resource *res)
658 {
659 return container_of(res, struct vmw_surface, res);
660 }
661
vmw_priv(struct drm_device * dev)662 static inline struct vmw_private *vmw_priv(struct drm_device *dev)
663 {
664 return (struct vmw_private *)dev->dev_private;
665 }
666
vmw_fpriv(struct drm_file * file_priv)667 static inline struct vmw_fpriv *vmw_fpriv(struct drm_file *file_priv)
668 {
669 return (struct vmw_fpriv *)file_priv->driver_priv;
670 }
671
672 /*
673 * The locking here is fine-grained, so that it is performed once
674 * for every read- and write operation. This is of course costly, but we
675 * don't perform much register access in the timing critical paths anyway.
676 * Instead we have the extra benefit of being sure that we don't forget
677 * the hw lock around register accesses.
678 */
vmw_write(struct vmw_private * dev_priv,unsigned int offset,uint32_t value)679 static inline void vmw_write(struct vmw_private *dev_priv,
680 unsigned int offset, uint32_t value)
681 {
682 spin_lock(&dev_priv->hw_lock);
683 outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
684 outl(value, dev_priv->io_start + VMWGFX_VALUE_PORT);
685 spin_unlock(&dev_priv->hw_lock);
686 }
687
vmw_read(struct vmw_private * dev_priv,unsigned int offset)688 static inline uint32_t vmw_read(struct vmw_private *dev_priv,
689 unsigned int offset)
690 {
691 u32 val;
692
693 spin_lock(&dev_priv->hw_lock);
694 outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
695 val = inl(dev_priv->io_start + VMWGFX_VALUE_PORT);
696 spin_unlock(&dev_priv->hw_lock);
697
698 return val;
699 }
700
701 /**
702 * has_sm4_context - Does the device support SM4 context.
703 * @dev_priv: Device private.
704 *
705 * Return: Bool value if device support SM4 context or not.
706 */
has_sm4_context(const struct vmw_private * dev_priv)707 static inline bool has_sm4_context(const struct vmw_private *dev_priv)
708 {
709 return (dev_priv->sm_type >= VMW_SM_4);
710 }
711
712 /**
713 * has_sm4_1_context - Does the device support SM4_1 context.
714 * @dev_priv: Device private.
715 *
716 * Return: Bool value if device support SM4_1 context or not.
717 */
has_sm4_1_context(const struct vmw_private * dev_priv)718 static inline bool has_sm4_1_context(const struct vmw_private *dev_priv)
719 {
720 return (dev_priv->sm_type >= VMW_SM_4_1);
721 }
722
723 /**
724 * has_sm5_context - Does the device support SM5 context.
725 * @dev_priv: Device private.
726 *
727 * Return: Bool value if device support SM5 context or not.
728 */
has_sm5_context(const struct vmw_private * dev_priv)729 static inline bool has_sm5_context(const struct vmw_private *dev_priv)
730 {
731 return (dev_priv->sm_type >= VMW_SM_5);
732 }
733
734 extern void vmw_svga_enable(struct vmw_private *dev_priv);
735 extern void vmw_svga_disable(struct vmw_private *dev_priv);
736
737
738 /**
739 * GMR utilities - vmwgfx_gmr.c
740 */
741
742 extern int vmw_gmr_bind(struct vmw_private *dev_priv,
743 const struct vmw_sg_table *vsgt,
744 unsigned long num_pages,
745 int gmr_id);
746 extern void vmw_gmr_unbind(struct vmw_private *dev_priv, int gmr_id);
747
748 /**
749 * Resource utilities - vmwgfx_resource.c
750 */
751 struct vmw_user_resource_conv;
752
753 extern void vmw_resource_unreference(struct vmw_resource **p_res);
754 extern struct vmw_resource *vmw_resource_reference(struct vmw_resource *res);
755 extern struct vmw_resource *
756 vmw_resource_reference_unless_doomed(struct vmw_resource *res);
757 extern int vmw_resource_validate(struct vmw_resource *res, bool intr,
758 bool dirtying);
759 extern int vmw_resource_reserve(struct vmw_resource *res, bool interruptible,
760 bool no_backup);
761 extern bool vmw_resource_needs_backup(const struct vmw_resource *res);
762 extern int vmw_user_lookup_handle(struct vmw_private *dev_priv,
763 struct ttm_object_file *tfile,
764 uint32_t handle,
765 struct vmw_surface **out_surf,
766 struct vmw_buffer_object **out_buf);
767 extern int vmw_user_resource_lookup_handle(
768 struct vmw_private *dev_priv,
769 struct ttm_object_file *tfile,
770 uint32_t handle,
771 const struct vmw_user_resource_conv *converter,
772 struct vmw_resource **p_res);
773 extern struct vmw_resource *
774 vmw_user_resource_noref_lookup_handle(struct vmw_private *dev_priv,
775 struct ttm_object_file *tfile,
776 uint32_t handle,
777 const struct vmw_user_resource_conv *
778 converter);
779 extern int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
780 struct drm_file *file_priv);
781 extern int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
782 struct drm_file *file_priv);
783 extern int vmw_user_stream_lookup(struct vmw_private *dev_priv,
784 struct ttm_object_file *tfile,
785 uint32_t *inout_id,
786 struct vmw_resource **out);
787 extern void vmw_resource_unreserve(struct vmw_resource *res,
788 bool dirty_set,
789 bool dirty,
790 bool switch_backup,
791 struct vmw_buffer_object *new_backup,
792 unsigned long new_backup_offset);
793 extern void vmw_query_move_notify(struct ttm_buffer_object *bo,
794 struct ttm_resource *mem);
795 extern int vmw_query_readback_all(struct vmw_buffer_object *dx_query_mob);
796 extern void vmw_resource_evict_all(struct vmw_private *dev_priv);
797 extern void vmw_resource_unbind_list(struct vmw_buffer_object *vbo);
798 void vmw_resource_mob_attach(struct vmw_resource *res);
799 void vmw_resource_mob_detach(struct vmw_resource *res);
800 void vmw_resource_dirty_update(struct vmw_resource *res, pgoff_t start,
801 pgoff_t end);
802 int vmw_resources_clean(struct vmw_buffer_object *vbo, pgoff_t start,
803 pgoff_t end, pgoff_t *num_prefault);
804
805 /**
806 * vmw_resource_mob_attached - Whether a resource currently has a mob attached
807 * @res: The resource
808 *
809 * Return: true if the resource has a mob attached, false otherwise.
810 */
vmw_resource_mob_attached(const struct vmw_resource * res)811 static inline bool vmw_resource_mob_attached(const struct vmw_resource *res)
812 {
813 return !RB_EMPTY_NODE(&res->mob_node);
814 }
815
816 /**
817 * vmw_user_resource_noref_release - release a user resource pointer looked up
818 * without reference
819 */
vmw_user_resource_noref_release(void)820 static inline void vmw_user_resource_noref_release(void)
821 {
822 ttm_base_object_noref_release();
823 }
824
825 /**
826 * Buffer object helper functions - vmwgfx_bo.c
827 */
828 extern int vmw_bo_pin_in_placement(struct vmw_private *vmw_priv,
829 struct vmw_buffer_object *bo,
830 struct ttm_placement *placement,
831 bool interruptible);
832 extern int vmw_bo_pin_in_vram(struct vmw_private *dev_priv,
833 struct vmw_buffer_object *buf,
834 bool interruptible);
835 extern int vmw_bo_pin_in_vram_or_gmr(struct vmw_private *dev_priv,
836 struct vmw_buffer_object *buf,
837 bool interruptible);
838 extern int vmw_bo_pin_in_start_of_vram(struct vmw_private *vmw_priv,
839 struct vmw_buffer_object *bo,
840 bool interruptible);
841 extern int vmw_bo_unpin(struct vmw_private *vmw_priv,
842 struct vmw_buffer_object *bo,
843 bool interruptible);
844 extern void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *buf,
845 SVGAGuestPtr *ptr);
846 extern void vmw_bo_pin_reserved(struct vmw_buffer_object *bo, bool pin);
847 extern void vmw_bo_bo_free(struct ttm_buffer_object *bo);
848 extern int vmw_bo_init(struct vmw_private *dev_priv,
849 struct vmw_buffer_object *vmw_bo,
850 size_t size, struct ttm_placement *placement,
851 bool interruptible,
852 void (*bo_free)(struct ttm_buffer_object *bo));
853 extern int vmw_user_bo_verify_access(struct ttm_buffer_object *bo,
854 struct ttm_object_file *tfile);
855 extern int vmw_user_bo_alloc(struct vmw_private *dev_priv,
856 struct ttm_object_file *tfile,
857 uint32_t size,
858 bool shareable,
859 uint32_t *handle,
860 struct vmw_buffer_object **p_dma_buf,
861 struct ttm_base_object **p_base);
862 extern int vmw_user_bo_reference(struct ttm_object_file *tfile,
863 struct vmw_buffer_object *dma_buf,
864 uint32_t *handle);
865 extern int vmw_bo_alloc_ioctl(struct drm_device *dev, void *data,
866 struct drm_file *file_priv);
867 extern int vmw_bo_unref_ioctl(struct drm_device *dev, void *data,
868 struct drm_file *file_priv);
869 extern int vmw_user_bo_synccpu_ioctl(struct drm_device *dev, void *data,
870 struct drm_file *file_priv);
871 extern int vmw_user_bo_lookup(struct ttm_object_file *tfile,
872 uint32_t id, struct vmw_buffer_object **out,
873 struct ttm_base_object **base);
874 extern void vmw_bo_fence_single(struct ttm_buffer_object *bo,
875 struct vmw_fence_obj *fence);
876 extern void *vmw_bo_map_and_cache(struct vmw_buffer_object *vbo);
877 extern void vmw_bo_unmap(struct vmw_buffer_object *vbo);
878 extern void vmw_bo_move_notify(struct ttm_buffer_object *bo,
879 struct ttm_resource *mem);
880 extern void vmw_bo_swap_notify(struct ttm_buffer_object *bo);
881 extern struct vmw_buffer_object *
882 vmw_user_bo_noref_lookup(struct ttm_object_file *tfile, u32 handle);
883
884 /**
885 * vmw_user_bo_noref_release - release a buffer object pointer looked up
886 * without reference
887 */
vmw_user_bo_noref_release(void)888 static inline void vmw_user_bo_noref_release(void)
889 {
890 ttm_base_object_noref_release();
891 }
892
893 /**
894 * vmw_bo_adjust_prio - Adjust the buffer object eviction priority
895 * according to attached resources
896 * @vbo: The struct vmw_buffer_object
897 */
vmw_bo_prio_adjust(struct vmw_buffer_object * vbo)898 static inline void vmw_bo_prio_adjust(struct vmw_buffer_object *vbo)
899 {
900 int i = ARRAY_SIZE(vbo->res_prios);
901
902 while (i--) {
903 if (vbo->res_prios[i]) {
904 vbo->base.priority = i;
905 return;
906 }
907 }
908
909 vbo->base.priority = 3;
910 }
911
912 /**
913 * vmw_bo_prio_add - Notify a buffer object of a newly attached resource
914 * eviction priority
915 * @vbo: The struct vmw_buffer_object
916 * @prio: The resource priority
917 *
918 * After being notified, the code assigns the highest resource eviction priority
919 * to the backing buffer object (mob).
920 */
vmw_bo_prio_add(struct vmw_buffer_object * vbo,int prio)921 static inline void vmw_bo_prio_add(struct vmw_buffer_object *vbo, int prio)
922 {
923 if (vbo->res_prios[prio]++ == 0)
924 vmw_bo_prio_adjust(vbo);
925 }
926
927 /**
928 * vmw_bo_prio_del - Notify a buffer object of a resource with a certain
929 * priority being removed
930 * @vbo: The struct vmw_buffer_object
931 * @prio: The resource priority
932 *
933 * After being notified, the code assigns the highest resource eviction priority
934 * to the backing buffer object (mob).
935 */
vmw_bo_prio_del(struct vmw_buffer_object * vbo,int prio)936 static inline void vmw_bo_prio_del(struct vmw_buffer_object *vbo, int prio)
937 {
938 if (--vbo->res_prios[prio] == 0)
939 vmw_bo_prio_adjust(vbo);
940 }
941
942 /**
943 * Misc Ioctl functionality - vmwgfx_ioctl.c
944 */
945
946 extern int vmw_getparam_ioctl(struct drm_device *dev, void *data,
947 struct drm_file *file_priv);
948 extern int vmw_get_cap_3d_ioctl(struct drm_device *dev, void *data,
949 struct drm_file *file_priv);
950 extern int vmw_present_ioctl(struct drm_device *dev, void *data,
951 struct drm_file *file_priv);
952 extern int vmw_present_readback_ioctl(struct drm_device *dev, void *data,
953 struct drm_file *file_priv);
954 extern __poll_t vmw_fops_poll(struct file *filp,
955 struct poll_table_struct *wait);
956 extern ssize_t vmw_fops_read(struct file *filp, char __user *buffer,
957 size_t count, loff_t *offset);
958
959 /**
960 * Fifo utilities - vmwgfx_fifo.c
961 */
962
963 extern int vmw_fifo_init(struct vmw_private *dev_priv,
964 struct vmw_fifo_state *fifo);
965 extern void vmw_fifo_release(struct vmw_private *dev_priv,
966 struct vmw_fifo_state *fifo);
967 extern void *
968 vmw_fifo_reserve_dx(struct vmw_private *dev_priv, uint32_t bytes, int ctx_id);
969 extern void vmw_fifo_commit(struct vmw_private *dev_priv, uint32_t bytes);
970 extern void vmw_fifo_commit_flush(struct vmw_private *dev_priv, uint32_t bytes);
971 extern int vmw_fifo_send_fence(struct vmw_private *dev_priv,
972 uint32_t *seqno);
973 extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
974 extern bool vmw_fifo_have_3d(struct vmw_private *dev_priv);
975 extern bool vmw_fifo_have_pitchlock(struct vmw_private *dev_priv);
976 extern int vmw_fifo_emit_dummy_query(struct vmw_private *dev_priv,
977 uint32_t cid);
978 extern int vmw_fifo_flush(struct vmw_private *dev_priv,
979 bool interruptible);
980
981 #define VMW_FIFO_RESERVE_DX(__priv, __bytes, __ctx_id) \
982 ({ \
983 vmw_fifo_reserve_dx(__priv, __bytes, __ctx_id) ? : ({ \
984 DRM_ERROR("FIFO reserve failed at %s for %u bytes\n", \
985 __func__, (unsigned int) __bytes); \
986 NULL; \
987 }); \
988 })
989
990 #define VMW_FIFO_RESERVE(__priv, __bytes) \
991 VMW_FIFO_RESERVE_DX(__priv, __bytes, SVGA3D_INVALID_ID)
992
993 /**
994 * TTM glue - vmwgfx_ttm_glue.c
995 */
996
997 extern int vmw_mmap(struct file *filp, struct vm_area_struct *vma);
998
999 extern void vmw_validation_mem_init_ttm(struct vmw_private *dev_priv,
1000 size_t gran);
1001
1002 /**
1003 * TTM buffer object driver - vmwgfx_ttm_buffer.c
1004 */
1005
1006 extern const size_t vmw_tt_size;
1007 extern struct ttm_placement vmw_vram_placement;
1008 extern struct ttm_placement vmw_vram_ne_placement;
1009 extern struct ttm_placement vmw_vram_sys_placement;
1010 extern struct ttm_placement vmw_vram_gmr_placement;
1011 extern struct ttm_placement vmw_vram_gmr_ne_placement;
1012 extern struct ttm_placement vmw_sys_placement;
1013 extern struct ttm_placement vmw_sys_ne_placement;
1014 extern struct ttm_placement vmw_evictable_placement;
1015 extern struct ttm_placement vmw_srf_placement;
1016 extern struct ttm_placement vmw_mob_placement;
1017 extern struct ttm_placement vmw_mob_ne_placement;
1018 extern struct ttm_placement vmw_nonfixed_placement;
1019 extern struct ttm_bo_driver vmw_bo_driver;
1020 extern const struct vmw_sg_table *
1021 vmw_bo_sg_table(struct ttm_buffer_object *bo);
1022 extern int vmw_bo_create_and_populate(struct vmw_private *dev_priv,
1023 unsigned long bo_size,
1024 struct ttm_buffer_object **bo_p);
1025
1026 extern void vmw_piter_start(struct vmw_piter *viter,
1027 const struct vmw_sg_table *vsgt,
1028 unsigned long p_offs);
1029
1030 /**
1031 * vmw_piter_next - Advance the iterator one page.
1032 *
1033 * @viter: Pointer to the iterator to advance.
1034 *
1035 * Returns false if past the list of pages, true otherwise.
1036 */
vmw_piter_next(struct vmw_piter * viter)1037 static inline bool vmw_piter_next(struct vmw_piter *viter)
1038 {
1039 return viter->next(viter);
1040 }
1041
1042 /**
1043 * vmw_piter_dma_addr - Return the DMA address of the current page.
1044 *
1045 * @viter: Pointer to the iterator
1046 *
1047 * Returns the DMA address of the page pointed to by @viter.
1048 */
vmw_piter_dma_addr(struct vmw_piter * viter)1049 static inline dma_addr_t vmw_piter_dma_addr(struct vmw_piter *viter)
1050 {
1051 return viter->dma_address(viter);
1052 }
1053
1054 /**
1055 * vmw_piter_page - Return a pointer to the current page.
1056 *
1057 * @viter: Pointer to the iterator
1058 *
1059 * Returns the DMA address of the page pointed to by @viter.
1060 */
vmw_piter_page(struct vmw_piter * viter)1061 static inline struct page *vmw_piter_page(struct vmw_piter *viter)
1062 {
1063 return viter->page(viter);
1064 }
1065
1066 /**
1067 * Command submission - vmwgfx_execbuf.c
1068 */
1069
1070 extern int vmw_execbuf_ioctl(struct drm_device *dev, void *data,
1071 struct drm_file *file_priv);
1072 extern int vmw_execbuf_process(struct drm_file *file_priv,
1073 struct vmw_private *dev_priv,
1074 void __user *user_commands,
1075 void *kernel_commands,
1076 uint32_t command_size,
1077 uint64_t throttle_us,
1078 uint32_t dx_context_handle,
1079 struct drm_vmw_fence_rep __user
1080 *user_fence_rep,
1081 struct vmw_fence_obj **out_fence,
1082 uint32_t flags);
1083 extern void __vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv,
1084 struct vmw_fence_obj *fence);
1085 extern void vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv);
1086
1087 extern int vmw_execbuf_fence_commands(struct drm_file *file_priv,
1088 struct vmw_private *dev_priv,
1089 struct vmw_fence_obj **p_fence,
1090 uint32_t *p_handle);
1091 extern int vmw_execbuf_copy_fence_user(struct vmw_private *dev_priv,
1092 struct vmw_fpriv *vmw_fp,
1093 int ret,
1094 struct drm_vmw_fence_rep __user
1095 *user_fence_rep,
1096 struct vmw_fence_obj *fence,
1097 uint32_t fence_handle,
1098 int32_t out_fence_fd);
1099 bool vmw_cmd_describe(const void *buf, u32 *size, char const **cmd);
1100
1101 /**
1102 * IRQs and wating - vmwgfx_irq.c
1103 */
1104
1105 extern int vmw_wait_seqno(struct vmw_private *dev_priv, bool lazy,
1106 uint32_t seqno, bool interruptible,
1107 unsigned long timeout);
1108 extern int vmw_irq_install(struct drm_device *dev, int irq);
1109 extern void vmw_irq_uninstall(struct drm_device *dev);
1110 extern bool vmw_seqno_passed(struct vmw_private *dev_priv,
1111 uint32_t seqno);
1112 extern int vmw_fallback_wait(struct vmw_private *dev_priv,
1113 bool lazy,
1114 bool fifo_idle,
1115 uint32_t seqno,
1116 bool interruptible,
1117 unsigned long timeout);
1118 extern void vmw_update_seqno(struct vmw_private *dev_priv,
1119 struct vmw_fifo_state *fifo_state);
1120 extern void vmw_seqno_waiter_add(struct vmw_private *dev_priv);
1121 extern void vmw_seqno_waiter_remove(struct vmw_private *dev_priv);
1122 extern void vmw_goal_waiter_add(struct vmw_private *dev_priv);
1123 extern void vmw_goal_waiter_remove(struct vmw_private *dev_priv);
1124 extern void vmw_generic_waiter_add(struct vmw_private *dev_priv, u32 flag,
1125 int *waiter_count);
1126 extern void vmw_generic_waiter_remove(struct vmw_private *dev_priv,
1127 u32 flag, int *waiter_count);
1128
1129 /**
1130 * Rudimentary fence-like objects currently used only for throttling -
1131 * vmwgfx_marker.c
1132 */
1133
1134 extern void vmw_marker_queue_init(struct vmw_marker_queue *queue);
1135 extern void vmw_marker_queue_takedown(struct vmw_marker_queue *queue);
1136 extern int vmw_marker_push(struct vmw_marker_queue *queue,
1137 uint32_t seqno);
1138 extern int vmw_marker_pull(struct vmw_marker_queue *queue,
1139 uint32_t signaled_seqno);
1140 extern int vmw_wait_lag(struct vmw_private *dev_priv,
1141 struct vmw_marker_queue *queue, uint32_t us);
1142
1143 /**
1144 * Kernel framebuffer - vmwgfx_fb.c
1145 */
1146
1147 int vmw_fb_init(struct vmw_private *vmw_priv);
1148 int vmw_fb_close(struct vmw_private *dev_priv);
1149 int vmw_fb_off(struct vmw_private *vmw_priv);
1150 int vmw_fb_on(struct vmw_private *vmw_priv);
1151
1152 /**
1153 * Kernel modesetting - vmwgfx_kms.c
1154 */
1155
1156 int vmw_kms_init(struct vmw_private *dev_priv);
1157 int vmw_kms_close(struct vmw_private *dev_priv);
1158 int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
1159 struct drm_file *file_priv);
1160 void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv);
1161 void vmw_kms_cursor_snoop(struct vmw_surface *srf,
1162 struct ttm_object_file *tfile,
1163 struct ttm_buffer_object *bo,
1164 SVGA3dCmdHeader *header);
1165 int vmw_kms_write_svga(struct vmw_private *vmw_priv,
1166 unsigned width, unsigned height, unsigned pitch,
1167 unsigned bpp, unsigned depth);
1168 bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
1169 uint32_t pitch,
1170 uint32_t height);
1171 u32 vmw_get_vblank_counter(struct drm_crtc *crtc);
1172 int vmw_enable_vblank(struct drm_crtc *crtc);
1173 void vmw_disable_vblank(struct drm_crtc *crtc);
1174 int vmw_kms_present(struct vmw_private *dev_priv,
1175 struct drm_file *file_priv,
1176 struct vmw_framebuffer *vfb,
1177 struct vmw_surface *surface,
1178 uint32_t sid, int32_t destX, int32_t destY,
1179 struct drm_vmw_rect *clips,
1180 uint32_t num_clips);
1181 int vmw_kms_update_layout_ioctl(struct drm_device *dev, void *data,
1182 struct drm_file *file_priv);
1183 void vmw_kms_legacy_hotspot_clear(struct vmw_private *dev_priv);
1184 int vmw_kms_suspend(struct drm_device *dev);
1185 int vmw_kms_resume(struct drm_device *dev);
1186 void vmw_kms_lost_device(struct drm_device *dev);
1187
1188 int vmw_dumb_create(struct drm_file *file_priv,
1189 struct drm_device *dev,
1190 struct drm_mode_create_dumb *args);
1191
1192 int vmw_dumb_map_offset(struct drm_file *file_priv,
1193 struct drm_device *dev, uint32_t handle,
1194 uint64_t *offset);
1195 int vmw_dumb_destroy(struct drm_file *file_priv,
1196 struct drm_device *dev,
1197 uint32_t handle);
1198 extern int vmw_resource_pin(struct vmw_resource *res, bool interruptible);
1199 extern void vmw_resource_unpin(struct vmw_resource *res);
1200 extern enum vmw_res_type vmw_res_type(const struct vmw_resource *res);
1201
1202 /**
1203 * Overlay control - vmwgfx_overlay.c
1204 */
1205
1206 int vmw_overlay_init(struct vmw_private *dev_priv);
1207 int vmw_overlay_close(struct vmw_private *dev_priv);
1208 int vmw_overlay_ioctl(struct drm_device *dev, void *data,
1209 struct drm_file *file_priv);
1210 int vmw_overlay_resume_all(struct vmw_private *dev_priv);
1211 int vmw_overlay_pause_all(struct vmw_private *dev_priv);
1212 int vmw_overlay_claim(struct vmw_private *dev_priv, uint32_t *out);
1213 int vmw_overlay_unref(struct vmw_private *dev_priv, uint32_t stream_id);
1214 int vmw_overlay_num_overlays(struct vmw_private *dev_priv);
1215 int vmw_overlay_num_free_overlays(struct vmw_private *dev_priv);
1216
1217 /**
1218 * GMR Id manager
1219 */
1220
1221 int vmw_gmrid_man_init(struct vmw_private *dev_priv, int type);
1222 void vmw_gmrid_man_fini(struct vmw_private *dev_priv, int type);
1223
1224 /**
1225 * Prime - vmwgfx_prime.c
1226 */
1227
1228 extern const struct dma_buf_ops vmw_prime_dmabuf_ops;
1229 extern int vmw_prime_fd_to_handle(struct drm_device *dev,
1230 struct drm_file *file_priv,
1231 int fd, u32 *handle);
1232 extern int vmw_prime_handle_to_fd(struct drm_device *dev,
1233 struct drm_file *file_priv,
1234 uint32_t handle, uint32_t flags,
1235 int *prime_fd);
1236
1237 /*
1238 * MemoryOBject management - vmwgfx_mob.c
1239 */
1240 struct vmw_mob;
1241 extern int vmw_mob_bind(struct vmw_private *dev_priv, struct vmw_mob *mob,
1242 const struct vmw_sg_table *vsgt,
1243 unsigned long num_data_pages, int32_t mob_id);
1244 extern void vmw_mob_unbind(struct vmw_private *dev_priv,
1245 struct vmw_mob *mob);
1246 extern void vmw_mob_destroy(struct vmw_mob *mob);
1247 extern struct vmw_mob *vmw_mob_create(unsigned long data_pages);
1248 extern int vmw_otables_setup(struct vmw_private *dev_priv);
1249 extern void vmw_otables_takedown(struct vmw_private *dev_priv);
1250
1251 /*
1252 * Context management - vmwgfx_context.c
1253 */
1254
1255 extern const struct vmw_user_resource_conv *user_context_converter;
1256
1257 extern int vmw_context_define_ioctl(struct drm_device *dev, void *data,
1258 struct drm_file *file_priv);
1259 extern int vmw_extended_context_define_ioctl(struct drm_device *dev, void *data,
1260 struct drm_file *file_priv);
1261 extern int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
1262 struct drm_file *file_priv);
1263 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1264 extern struct vmw_cmdbuf_res_manager *
1265 vmw_context_res_man(struct vmw_resource *ctx);
1266 extern struct vmw_resource *vmw_context_cotable(struct vmw_resource *ctx,
1267 SVGACOTableType cotable_type);
1268 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1269 struct vmw_ctx_binding_state;
1270 extern struct vmw_ctx_binding_state *
1271 vmw_context_binding_state(struct vmw_resource *ctx);
1272 extern void vmw_dx_context_scrub_cotables(struct vmw_resource *ctx,
1273 bool readback);
1274 extern int vmw_context_bind_dx_query(struct vmw_resource *ctx_res,
1275 struct vmw_buffer_object *mob);
1276 extern struct vmw_buffer_object *
1277 vmw_context_get_dx_query_mob(struct vmw_resource *ctx_res);
1278
1279
1280 /*
1281 * Surface management - vmwgfx_surface.c
1282 */
1283
1284 extern const struct vmw_user_resource_conv *user_surface_converter;
1285
1286 extern int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
1287 struct drm_file *file_priv);
1288 extern int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
1289 struct drm_file *file_priv);
1290 extern int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
1291 struct drm_file *file_priv);
1292 extern int vmw_gb_surface_define_ioctl(struct drm_device *dev, void *data,
1293 struct drm_file *file_priv);
1294 extern int vmw_gb_surface_reference_ioctl(struct drm_device *dev, void *data,
1295 struct drm_file *file_priv);
1296 int vmw_surface_gb_priv_define(struct drm_device *dev,
1297 uint32_t user_accounting_size,
1298 SVGA3dSurfaceAllFlags svga3d_flags,
1299 SVGA3dSurfaceFormat format,
1300 bool for_scanout,
1301 uint32_t num_mip_levels,
1302 uint32_t multisample_count,
1303 uint32_t array_size,
1304 struct drm_vmw_size size,
1305 SVGA3dMSPattern multisample_pattern,
1306 SVGA3dMSQualityLevel quality_level,
1307 struct vmw_surface **srf_out);
1308 extern int vmw_gb_surface_define_ext_ioctl(struct drm_device *dev,
1309 void *data,
1310 struct drm_file *file_priv);
1311 extern int vmw_gb_surface_reference_ext_ioctl(struct drm_device *dev,
1312 void *data,
1313 struct drm_file *file_priv);
1314
1315 int vmw_gb_surface_define(struct vmw_private *dev_priv,
1316 uint32_t user_accounting_size,
1317 const struct vmw_surface_metadata *req,
1318 struct vmw_surface **srf_out);
1319
1320 /*
1321 * Shader management - vmwgfx_shader.c
1322 */
1323
1324 extern const struct vmw_user_resource_conv *user_shader_converter;
1325
1326 extern int vmw_shader_define_ioctl(struct drm_device *dev, void *data,
1327 struct drm_file *file_priv);
1328 extern int vmw_shader_destroy_ioctl(struct drm_device *dev, void *data,
1329 struct drm_file *file_priv);
1330 extern int vmw_compat_shader_add(struct vmw_private *dev_priv,
1331 struct vmw_cmdbuf_res_manager *man,
1332 u32 user_key, const void *bytecode,
1333 SVGA3dShaderType shader_type,
1334 size_t size,
1335 struct list_head *list);
1336 extern int vmw_shader_remove(struct vmw_cmdbuf_res_manager *man,
1337 u32 user_key, SVGA3dShaderType shader_type,
1338 struct list_head *list);
1339 extern int vmw_dx_shader_add(struct vmw_cmdbuf_res_manager *man,
1340 struct vmw_resource *ctx,
1341 u32 user_key,
1342 SVGA3dShaderType shader_type,
1343 struct list_head *list);
1344 extern void vmw_dx_shader_cotable_list_scrub(struct vmw_private *dev_priv,
1345 struct list_head *list,
1346 bool readback);
1347
1348 extern struct vmw_resource *
1349 vmw_shader_lookup(struct vmw_cmdbuf_res_manager *man,
1350 u32 user_key, SVGA3dShaderType shader_type);
1351
1352 /*
1353 * Streamoutput management
1354 */
1355 struct vmw_resource *
1356 vmw_dx_streamoutput_lookup(struct vmw_cmdbuf_res_manager *man,
1357 u32 user_key);
1358 int vmw_dx_streamoutput_add(struct vmw_cmdbuf_res_manager *man,
1359 struct vmw_resource *ctx,
1360 SVGA3dStreamOutputId user_key,
1361 struct list_head *list);
1362 void vmw_dx_streamoutput_set_size(struct vmw_resource *res, u32 size);
1363 int vmw_dx_streamoutput_remove(struct vmw_cmdbuf_res_manager *man,
1364 SVGA3dStreamOutputId user_key,
1365 struct list_head *list);
1366 void vmw_dx_streamoutput_cotable_list_scrub(struct vmw_private *dev_priv,
1367 struct list_head *list,
1368 bool readback);
1369
1370 /*
1371 * Command buffer managed resources - vmwgfx_cmdbuf_res.c
1372 */
1373
1374 extern struct vmw_cmdbuf_res_manager *
1375 vmw_cmdbuf_res_man_create(struct vmw_private *dev_priv);
1376 extern void vmw_cmdbuf_res_man_destroy(struct vmw_cmdbuf_res_manager *man);
1377 extern size_t vmw_cmdbuf_res_man_size(void);
1378 extern struct vmw_resource *
1379 vmw_cmdbuf_res_lookup(struct vmw_cmdbuf_res_manager *man,
1380 enum vmw_cmdbuf_res_type res_type,
1381 u32 user_key);
1382 extern void vmw_cmdbuf_res_revert(struct list_head *list);
1383 extern void vmw_cmdbuf_res_commit(struct list_head *list);
1384 extern int vmw_cmdbuf_res_add(struct vmw_cmdbuf_res_manager *man,
1385 enum vmw_cmdbuf_res_type res_type,
1386 u32 user_key,
1387 struct vmw_resource *res,
1388 struct list_head *list);
1389 extern int vmw_cmdbuf_res_remove(struct vmw_cmdbuf_res_manager *man,
1390 enum vmw_cmdbuf_res_type res_type,
1391 u32 user_key,
1392 struct list_head *list,
1393 struct vmw_resource **res);
1394
1395 /*
1396 * COTable management - vmwgfx_cotable.c
1397 */
1398 extern const SVGACOTableType vmw_cotable_scrub_order[];
1399 extern struct vmw_resource *vmw_cotable_alloc(struct vmw_private *dev_priv,
1400 struct vmw_resource *ctx,
1401 u32 type);
1402 extern int vmw_cotable_notify(struct vmw_resource *res, int id);
1403 extern int vmw_cotable_scrub(struct vmw_resource *res, bool readback);
1404 extern void vmw_cotable_add_resource(struct vmw_resource *ctx,
1405 struct list_head *head);
1406
1407 /*
1408 * Command buffer managerment vmwgfx_cmdbuf.c
1409 */
1410 struct vmw_cmdbuf_man;
1411 struct vmw_cmdbuf_header;
1412
1413 extern struct vmw_cmdbuf_man *
1414 vmw_cmdbuf_man_create(struct vmw_private *dev_priv);
1415 extern int vmw_cmdbuf_set_pool_size(struct vmw_cmdbuf_man *man,
1416 size_t size, size_t default_size);
1417 extern void vmw_cmdbuf_remove_pool(struct vmw_cmdbuf_man *man);
1418 extern void vmw_cmdbuf_man_destroy(struct vmw_cmdbuf_man *man);
1419 extern int vmw_cmdbuf_idle(struct vmw_cmdbuf_man *man, bool interruptible,
1420 unsigned long timeout);
1421 extern void *vmw_cmdbuf_reserve(struct vmw_cmdbuf_man *man, size_t size,
1422 int ctx_id, bool interruptible,
1423 struct vmw_cmdbuf_header *header);
1424 extern void vmw_cmdbuf_commit(struct vmw_cmdbuf_man *man, size_t size,
1425 struct vmw_cmdbuf_header *header,
1426 bool flush);
1427 extern void *vmw_cmdbuf_alloc(struct vmw_cmdbuf_man *man,
1428 size_t size, bool interruptible,
1429 struct vmw_cmdbuf_header **p_header);
1430 extern void vmw_cmdbuf_header_free(struct vmw_cmdbuf_header *header);
1431 extern int vmw_cmdbuf_cur_flush(struct vmw_cmdbuf_man *man,
1432 bool interruptible);
1433 extern void vmw_cmdbuf_irqthread(struct vmw_cmdbuf_man *man);
1434
1435 /* CPU blit utilities - vmwgfx_blit.c */
1436
1437 /**
1438 * struct vmw_diff_cpy - CPU blit information structure
1439 *
1440 * @rect: The output bounding box rectangle.
1441 * @line: The current line of the blit.
1442 * @line_offset: Offset of the current line segment.
1443 * @cpp: Bytes per pixel (granularity information).
1444 * @memcpy: Which memcpy function to use.
1445 */
1446 struct vmw_diff_cpy {
1447 struct drm_rect rect;
1448 size_t line;
1449 size_t line_offset;
1450 int cpp;
1451 void (*do_cpy)(struct vmw_diff_cpy *diff, u8 *dest, const u8 *src,
1452 size_t n);
1453 };
1454
1455 #define VMW_CPU_BLIT_INITIALIZER { \
1456 .do_cpy = vmw_memcpy, \
1457 }
1458
1459 #define VMW_CPU_BLIT_DIFF_INITIALIZER(_cpp) { \
1460 .line = 0, \
1461 .line_offset = 0, \
1462 .rect = { .x1 = INT_MAX/2, \
1463 .y1 = INT_MAX/2, \
1464 .x2 = INT_MIN/2, \
1465 .y2 = INT_MIN/2 \
1466 }, \
1467 .cpp = _cpp, \
1468 .do_cpy = vmw_diff_memcpy, \
1469 }
1470
1471 void vmw_diff_memcpy(struct vmw_diff_cpy *diff, u8 *dest, const u8 *src,
1472 size_t n);
1473
1474 void vmw_memcpy(struct vmw_diff_cpy *diff, u8 *dest, const u8 *src, size_t n);
1475
1476 int vmw_bo_cpu_blit(struct ttm_buffer_object *dst,
1477 u32 dst_offset, u32 dst_stride,
1478 struct ttm_buffer_object *src,
1479 u32 src_offset, u32 src_stride,
1480 u32 w, u32 h,
1481 struct vmw_diff_cpy *diff);
1482
1483 /* Host messaging -vmwgfx_msg.c: */
1484 int vmw_host_get_guestinfo(const char *guest_info_param,
1485 char *buffer, size_t *length);
1486 int vmw_host_log(const char *log);
1487 int vmw_msg_ioctl(struct drm_device *dev, void *data,
1488 struct drm_file *file_priv);
1489
1490 /* VMW logging */
1491
1492 /**
1493 * VMW_DEBUG_USER - Debug output for user-space debugging.
1494 *
1495 * @fmt: printf() like format string.
1496 *
1497 * This macro is for logging user-space error and debugging messages for e.g.
1498 * command buffer execution errors due to malformed commands, invalid context,
1499 * etc.
1500 */
1501 #define VMW_DEBUG_USER(fmt, ...) \
1502 DRM_DEBUG_DRIVER(fmt, ##__VA_ARGS__)
1503
1504 /* Resource dirtying - vmwgfx_page_dirty.c */
1505 void vmw_bo_dirty_scan(struct vmw_buffer_object *vbo);
1506 int vmw_bo_dirty_add(struct vmw_buffer_object *vbo);
1507 void vmw_bo_dirty_transfer_to_res(struct vmw_resource *res);
1508 void vmw_bo_dirty_clear_res(struct vmw_resource *res);
1509 void vmw_bo_dirty_release(struct vmw_buffer_object *vbo);
1510 void vmw_bo_dirty_unmap(struct vmw_buffer_object *vbo,
1511 pgoff_t start, pgoff_t end);
1512 vm_fault_t vmw_bo_vm_fault(struct vm_fault *vmf);
1513 vm_fault_t vmw_bo_vm_mkwrite(struct vm_fault *vmf);
1514 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
1515 vm_fault_t vmw_bo_vm_huge_fault(struct vm_fault *vmf,
1516 enum page_entry_size pe_size);
1517 #endif
1518
1519 /* Transparent hugepage support - vmwgfx_thp.c */
1520 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
1521 extern int vmw_thp_init(struct vmw_private *dev_priv);
1522 void vmw_thp_fini(struct vmw_private *dev_priv);
1523 #endif
1524
1525 /**
1526 * VMW_DEBUG_KMS - Debug output for kernel mode-setting
1527 *
1528 * This macro is for debugging vmwgfx mode-setting code.
1529 */
1530 #define VMW_DEBUG_KMS(fmt, ...) \
1531 DRM_DEBUG_DRIVER(fmt, ##__VA_ARGS__)
1532
1533 /**
1534 * Inline helper functions
1535 */
1536
vmw_surface_unreference(struct vmw_surface ** srf)1537 static inline void vmw_surface_unreference(struct vmw_surface **srf)
1538 {
1539 struct vmw_surface *tmp_srf = *srf;
1540 struct vmw_resource *res = &tmp_srf->res;
1541 *srf = NULL;
1542
1543 vmw_resource_unreference(&res);
1544 }
1545
vmw_surface_reference(struct vmw_surface * srf)1546 static inline struct vmw_surface *vmw_surface_reference(struct vmw_surface *srf)
1547 {
1548 (void) vmw_resource_reference(&srf->res);
1549 return srf;
1550 }
1551
vmw_bo_unreference(struct vmw_buffer_object ** buf)1552 static inline void vmw_bo_unreference(struct vmw_buffer_object **buf)
1553 {
1554 struct vmw_buffer_object *tmp_buf = *buf;
1555
1556 *buf = NULL;
1557 if (tmp_buf != NULL) {
1558 ttm_bo_put(&tmp_buf->base);
1559 }
1560 }
1561
1562 static inline struct vmw_buffer_object *
vmw_bo_reference(struct vmw_buffer_object * buf)1563 vmw_bo_reference(struct vmw_buffer_object *buf)
1564 {
1565 ttm_bo_get(&buf->base);
1566 return buf;
1567 }
1568
vmw_mem_glob(struct vmw_private * dev_priv)1569 static inline struct ttm_mem_global *vmw_mem_glob(struct vmw_private *dev_priv)
1570 {
1571 return &ttm_mem_glob;
1572 }
1573
vmw_fifo_resource_inc(struct vmw_private * dev_priv)1574 static inline void vmw_fifo_resource_inc(struct vmw_private *dev_priv)
1575 {
1576 atomic_inc(&dev_priv->num_fifo_resources);
1577 }
1578
vmw_fifo_resource_dec(struct vmw_private * dev_priv)1579 static inline void vmw_fifo_resource_dec(struct vmw_private *dev_priv)
1580 {
1581 atomic_dec(&dev_priv->num_fifo_resources);
1582 }
1583
1584 /**
1585 * vmw_mmio_read - Perform a MMIO read from volatile memory
1586 *
1587 * @addr: The address to read from
1588 *
1589 * This function is intended to be equivalent to ioread32() on
1590 * memremap'd memory, but without byteswapping.
1591 */
vmw_mmio_read(u32 * addr)1592 static inline u32 vmw_mmio_read(u32 *addr)
1593 {
1594 return READ_ONCE(*addr);
1595 }
1596
1597 /**
1598 * vmw_mmio_write - Perform a MMIO write to volatile memory
1599 *
1600 * @addr: The address to write to
1601 *
1602 * This function is intended to be equivalent to iowrite32 on
1603 * memremap'd memory, but without byteswapping.
1604 */
vmw_mmio_write(u32 value,u32 * addr)1605 static inline void vmw_mmio_write(u32 value, u32 *addr)
1606 {
1607 WRITE_ONCE(*addr, value);
1608 }
1609 #endif
1610