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