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