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