drivers/gpu/drm/vmwgfx/vmwgfx_drv.h

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