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