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