drivers/gpu/drm/vmwgfx/vmwgfx_drv.h

   1 /**************************************************************************
   2  *
   3  * Copyright © 2009 VMware, Inc., Palo Alto, CA., USA
   4  * All Rights Reserved.
   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_reg.h"
  32 #include <drm/drmP.h>
  33 #include <drm/vmwgfx_drm.h>
  34 #include <drm/drm_hashtab.h>
  35 #include <linux/suspend.h>
  36 #include <drm/ttm/ttm_bo_driver.h>
  37 #include <drm/ttm/ttm_object.h>
  38 #include <drm/ttm/ttm_lock.h>
  39 #include <drm/ttm/ttm_execbuf_util.h>
  40 #include <drm/ttm/ttm_module.h>
  41 #include "vmwgfx_fence.h"
  42
  43 #define VMWGFX_DRIVER_DATE "20140228"
  44 #define VMWGFX_DRIVER_MAJOR 2
  45 #define VMWGFX_DRIVER_MINOR 5
  46 #define VMWGFX_DRIVER_PATCHLEVEL 0
  47 #define VMWGFX_FILE_PAGE_OFFSET 0x00100000
  48 #define VMWGFX_FIFO_STATIC_SIZE (1024*1024)
  49 #define VMWGFX_MAX_RELOCATIONS 2048
  50 #define VMWGFX_MAX_VALIDATIONS 2048
  51 #define VMWGFX_MAX_DISPLAYS 16
  52 #define VMWGFX_CMD_BOUNCE_INIT_SIZE 32768
  53 #define VMWGFX_ENABLE_SCREEN_TARGET_OTABLE 0
  54
  55 /*
  56  * Perhaps we should have sysfs entries for these.
  57  */
  58 #define VMWGFX_NUM_GB_CONTEXT 256
  59 #define VMWGFX_NUM_GB_SHADER 20000
  60 #define VMWGFX_NUM_GB_SURFACE 32768
  61 #define VMWGFX_NUM_GB_SCREEN_TARGET VMWGFX_MAX_DISPLAYS
  62 #define VMWGFX_NUM_MOB (VMWGFX_NUM_GB_CONTEXT +\
  63                         VMWGFX_NUM_GB_SHADER +\
  64                         VMWGFX_NUM_GB_SURFACE +\
  65                         VMWGFX_NUM_GB_SCREEN_TARGET)
  66
  67 #define VMW_PL_GMR TTM_PL_PRIV0
  68 #define VMW_PL_FLAG_GMR TTM_PL_FLAG_PRIV0
  69 #define VMW_PL_MOB TTM_PL_PRIV1
  70 #define VMW_PL_FLAG_MOB TTM_PL_FLAG_PRIV1
  71
  72 #define VMW_RES_CONTEXT ttm_driver_type0
  73 #define VMW_RES_SURFACE ttm_driver_type1
  74 #define VMW_RES_STREAM ttm_driver_type2
  75 #define VMW_RES_FENCE ttm_driver_type3
  76 #define VMW_RES_SHADER ttm_driver_type4
  77
  78 struct vmw_compat_shader_manager;
  79
  80 struct vmw_fpriv {
  81         struct drm_master *locked_master;
  82         struct ttm_object_file *tfile;
  83         struct list_head fence_events;
  84         bool gb_aware;
  85         struct vmw_compat_shader_manager *shman;
  86 };
  87
  88 struct vmw_dma_buffer {
  89         struct ttm_buffer_object base;
  90         struct list_head res_list;
  91 };
  92
  93 /**
  94  * struct vmw_validate_buffer - Carries validation info about buffers.
  95  *
  96  * @base: Validation info for TTM.
  97  * @hash: Hash entry for quick lookup of the TTM buffer object.
  98  *
  99  * This structure contains also driver private validation info
 100  * on top of the info needed by TTM.
 101  */
 102 struct vmw_validate_buffer {
 103         struct ttm_validate_buffer base;
 104         struct drm_hash_item hash;
 105         bool validate_as_mob;
 106 };
 107
 108 struct vmw_res_func;
 109 struct vmw_resource {
 110         struct kref kref;
 111         struct vmw_private *dev_priv;
 112         int id;
 113         bool avail;
 114         unsigned long backup_size;
 115         bool res_dirty; /* Protected by backup buffer reserved */
 116         bool backup_dirty; /* Protected by backup buffer reserved */
 117         struct vmw_dma_buffer *backup;
 118         unsigned long backup_offset;
 119         const struct vmw_res_func *func;
 120         struct list_head lru_head; /* Protected by the resource lock */
 121         struct list_head mob_head; /* Protected by @backup reserved */
 122         struct list_head binding_head; /* Protected by binding_mutex */
 123         void (*res_free) (struct vmw_resource *res);
 124         void (*hw_destroy) (struct vmw_resource *res);
 125 };
 126
 127 enum vmw_res_type {
 128         vmw_res_context,
 129         vmw_res_surface,
 130         vmw_res_stream,
 131         vmw_res_shader,
 132         vmw_res_max
 133 };
 134
 135 struct vmw_cursor_snooper {
 136         struct drm_crtc *crtc;
 137         size_t age;
 138         uint32_t *image;
 139 };
 140
 141 struct vmw_framebuffer;
 142 struct vmw_surface_offset;
 143
 144 struct vmw_surface {
 145         struct vmw_resource res;
 146         uint32_t flags;
 147         uint32_t format;
 148         uint32_t mip_levels[DRM_VMW_MAX_SURFACE_FACES];
 149         struct drm_vmw_size base_size;
 150         struct drm_vmw_size *sizes;
 151         uint32_t num_sizes;
 152         bool scanout;
 153         /* TODO so far just a extra pointer */
 154         struct vmw_cursor_snooper snooper;
 155         struct vmw_surface_offset *offsets;
 156         SVGA3dTextureFilter autogen_filter;
 157         uint32_t multisample_count;
 158 };
 159
 160 struct vmw_marker_queue {
 161         struct list_head head;
 162         struct timespec lag;
 163         struct timespec lag_time;
 164         spinlock_t lock;
 165 };
 166
 167 struct vmw_fifo_state {
 168         unsigned long reserved_size;
 169         __le32 *dynamic_buffer;
 170         __le32 *static_buffer;
 171         unsigned long static_buffer_size;
 172         bool using_bounce_buffer;
 173         uint32_t capabilities;
 174         struct mutex fifo_mutex;
 175         struct rw_semaphore rwsem;
 176         struct vmw_marker_queue marker_queue;
 177 };
 178
 179 struct vmw_relocation {
 180         SVGAMobId *mob_loc;
 181         SVGAGuestPtr *location;
 182         uint32_t index;
 183 };
 184
 185 /**
 186  * struct vmw_res_cache_entry - resource information cache entry
 187  *
 188  * @valid: Whether the entry is valid, which also implies that the execbuf
 189  * code holds a reference to the resource, and it's placed on the
 190  * validation list.
 191  * @handle: User-space handle of a resource.
 192  * @res: Non-ref-counted pointer to the resource.
 193  *
 194  * Used to avoid frequent repeated user-space handle lookups of the
 195  * same resource.
 196  */
 197 struct vmw_res_cache_entry {
 198         bool valid;
 199         uint32_t handle;
 200         struct vmw_resource *res;
 201         struct vmw_resource_val_node *node;
 202 };
 203
 204 /**
 205  * enum vmw_dma_map_mode - indicate how to perform TTM page dma mappings.
 206  */
 207 enum vmw_dma_map_mode {
 208         vmw_dma_phys,           /* Use physical page addresses */
 209         vmw_dma_alloc_coherent, /* Use TTM coherent pages */
 210         vmw_dma_map_populate,   /* Unmap from DMA just after unpopulate */
 211         vmw_dma_map_bind,       /* Unmap from DMA just before unbind */
 212         vmw_dma_map_max
 213 };
 214
 215 /**
 216  * struct vmw_sg_table - Scatter/gather table for binding, with additional
 217  * device-specific information.
 218  *
 219  * @sgt: Pointer to a struct sg_table with binding information
 220  * @num_regions: Number of regions with device-address contigous pages
 221  */
 222 struct vmw_sg_table {
 223         enum vmw_dma_map_mode mode;
 224         struct page **pages;
 225         const dma_addr_t *addrs;
 226         struct sg_table *sgt;
 227         unsigned long num_regions;
 228         unsigned long num_pages;
 229 };
 230
 231 /**
 232  * struct vmw_piter - Page iterator that iterates over a list of pages
 233  * and DMA addresses that could be either a scatter-gather list or
 234  * arrays
 235  *
 236  * @pages: Array of page pointers to the pages.
 237  * @addrs: DMA addresses to the pages if coherent pages are used.
 238  * @iter: Scatter-gather page iterator. Current position in SG list.
 239  * @i: Current position in arrays.
 240  * @num_pages: Number of pages total.
 241  * @next: Function to advance the iterator. Returns false if past the list
 242  * of pages, true otherwise.
 243  * @dma_address: Function to return the DMA address of the current page.
 244  */
 245 struct vmw_piter {
 246         struct page **pages;
 247         const dma_addr_t *addrs;
 248         struct sg_page_iter iter;
 249         unsigned long i;
 250         unsigned long num_pages;
 251         bool (*next)(struct vmw_piter *);
 252         dma_addr_t (*dma_address)(struct vmw_piter *);
 253         struct page *(*page)(struct vmw_piter *);
 254 };
 255
 256 /*
 257  * enum vmw_ctx_binding_type - abstract resource to context binding types
 258  */
 259 enum vmw_ctx_binding_type {
 260         vmw_ctx_binding_shader,
 261         vmw_ctx_binding_rt,
 262         vmw_ctx_binding_tex,
 263         vmw_ctx_binding_max
 264 };
 265
 266 /**
 267  * struct vmw_ctx_bindinfo - structure representing a single context binding
 268  *
 269  * @ctx: Pointer to the context structure. NULL means the binding is not
 270  * active.
 271  * @res: Non ref-counted pointer to the bound resource.
 272  * @bt: The binding type.
 273  * @i1: Union of information needed to unbind.
 274  */
 275 struct vmw_ctx_bindinfo {
 276         struct vmw_resource *ctx;
 277         struct vmw_resource *res;
 278         enum vmw_ctx_binding_type bt;
 279         bool scrubbed;
 280         union {
 281                 SVGA3dShaderType shader_type;
 282                 SVGA3dRenderTargetType rt_type;
 283                 uint32 texture_stage;
 284         } i1;
 285 };
 286
 287 /**
 288  * struct vmw_ctx_binding - structure representing a single context binding
 289  *                        - suitable for tracking in a context
 290  *
 291  * @ctx_list: List head for context.
 292  * @res_list: List head for bound resource.
 293  * @bi: Binding info
 294  */
 295 struct vmw_ctx_binding {
 296         struct list_head ctx_list;
 297         struct list_head res_list;
 298         struct vmw_ctx_bindinfo bi;
 299 };
 300
 301
 302 /**
 303  * struct vmw_ctx_binding_state - context binding state
 304  *
 305  * @list: linked list of individual bindings.
 306  * @render_targets: Render target bindings.
 307  * @texture_units: Texture units/samplers bindings.
 308  * @shaders: Shader bindings.
 309  *
 310  * Note that this structure also provides storage space for the individual
 311  * struct vmw_ctx_binding objects, so that no dynamic allocation is needed
 312  * for individual bindings.
 313  *
 314  */
 315 struct vmw_ctx_binding_state {
 316         struct list_head list;
 317         struct vmw_ctx_binding render_targets[SVGA3D_RT_MAX];
 318         struct vmw_ctx_binding texture_units[SVGA3D_NUM_TEXTURE_UNITS];
 319         struct vmw_ctx_binding shaders[SVGA3D_SHADERTYPE_MAX];
 320 };
 321
 322 struct vmw_sw_context{
 323         struct drm_open_hash res_ht;
 324         bool res_ht_initialized;
 325         bool kernel; /**< is the called made from the kernel */
 326         struct vmw_fpriv *fp;
 327         struct list_head validate_nodes;
 328         struct vmw_relocation relocs[VMWGFX_MAX_RELOCATIONS];
 329         uint32_t cur_reloc;
 330         struct vmw_validate_buffer val_bufs[VMWGFX_MAX_VALIDATIONS];
 331         uint32_t cur_val_buf;
 332         uint32_t *cmd_bounce;
 333         uint32_t cmd_bounce_size;
 334         struct list_head resource_list;
 335         uint32_t fence_flags;
 336         struct ttm_buffer_object *cur_query_bo;
 337         struct list_head res_relocations;
 338         uint32_t *buf_start;
 339         struct vmw_res_cache_entry res_cache[vmw_res_max];
 340         struct vmw_resource *last_query_ctx;
 341         bool needs_post_query_barrier;
 342         struct vmw_resource *error_resource;
 343         struct vmw_ctx_binding_state staged_bindings;
 344         struct list_head staged_shaders;
 345 };
 346
 347 struct vmw_legacy_display;
 348 struct vmw_overlay;
 349
 350 struct vmw_master {
 351         struct ttm_lock lock;
 352         struct mutex fb_surf_mutex;
 353         struct list_head fb_surf;
 354 };
 355
 356 struct vmw_vga_topology_state {
 357         uint32_t width;
 358         uint32_t height;
 359         uint32_t primary;
 360         uint32_t pos_x;
 361         uint32_t pos_y;
 362 };
 363
 364 struct vmw_private {
 365         struct ttm_bo_device bdev;
 366         struct ttm_bo_global_ref bo_global_ref;
 367         struct drm_global_reference mem_global_ref;
 368
 369         struct vmw_fifo_state fifo;
 370
 371         struct drm_device *dev;
 372         unsigned long vmw_chipset;
 373         unsigned int io_start;
 374         uint32_t vram_start;
 375         uint32_t vram_size;
 376         uint32_t prim_bb_mem;
 377         uint32_t mmio_start;
 378         uint32_t mmio_size;
 379         uint32_t fb_max_width;
 380         uint32_t fb_max_height;
 381         uint32_t initial_width;
 382         uint32_t initial_height;
 383         __le32 __iomem *mmio_virt;
 384         int mmio_mtrr;
 385         uint32_t capabilities;
 386         uint32_t max_gmr_ids;
 387         uint32_t max_gmr_pages;
 388         uint32_t max_mob_pages;
 389         uint32_t max_mob_size;
 390         uint32_t memory_size;
 391         bool has_gmr;
 392         bool has_mob;
 393         struct mutex hw_mutex;
 394
 395         /*
 396          * VGA registers.
 397          */
 398
 399         struct vmw_vga_topology_state vga_save[VMWGFX_MAX_DISPLAYS];
 400         uint32_t vga_width;
 401         uint32_t vga_height;
 402         uint32_t vga_bpp;
 403         uint32_t vga_bpl;
 404         uint32_t vga_pitchlock;
 405
 406         uint32_t num_displays;
 407
 408         /*
 409          * Framebuffer info.
 410          */
 411
 412         void *fb_info;
 413         struct vmw_legacy_display *ldu_priv;
 414         struct vmw_screen_object_display *sou_priv;
 415         struct vmw_overlay *overlay_priv;
 416
 417         /*
 418          * Context and surface management.
 419          */
 420
 421         rwlock_t resource_lock;
 422         struct idr res_idr[vmw_res_max];
 423         /*
 424          * Block lastclose from racing with firstopen.
 425          */
 426
 427         struct mutex init_mutex;
 428
 429         /*
 430          * A resource manager for kernel-only surfaces and
 431          * contexts.
 432          */
 433
 434         struct ttm_object_device *tdev;
 435
 436         /*
 437          * Fencing and IRQs.
 438          */
 439
 440         atomic_t marker_seq;
 441         wait_queue_head_t fence_queue;
 442         wait_queue_head_t fifo_queue;
 443         int fence_queue_waiters; /* Protected by hw_mutex */
 444         int goal_queue_waiters; /* Protected by hw_mutex */
 445         atomic_t fifo_queue_waiters;
 446         uint32_t last_read_seqno;
 447         spinlock_t irq_lock;
 448         struct vmw_fence_manager *fman;
 449         uint32_t irq_mask;
 450
 451         /*
 452          * Device state
 453          */
 454
 455         uint32_t traces_state;
 456         uint32_t enable_state;
 457         uint32_t config_done_state;
 458
 459         /**
 460          * Execbuf
 461          */
 462         /**
 463          * Protected by the cmdbuf mutex.
 464          */
 465
 466         struct vmw_sw_context ctx;
 467         struct mutex cmdbuf_mutex;
 468         struct mutex binding_mutex;
 469
 470         /**
 471          * Operating mode.
 472          */
 473
 474         bool stealth;
 475         bool enable_fb;
 476
 477         /**
 478          * Master management.
 479          */
 480
 481         struct vmw_master *active_master;
 482         struct vmw_master fbdev_master;
 483         struct notifier_block pm_nb;
 484         bool suspended;
 485
 486         struct mutex release_mutex;
 487         uint32_t num_3d_resources;
 488
 489         /*
 490          * Query processing. These members
 491          * are protected by the cmdbuf mutex.
 492          */
 493
 494         struct ttm_buffer_object *dummy_query_bo;
 495         struct ttm_buffer_object *pinned_bo;
 496         uint32_t query_cid;
 497         uint32_t query_cid_valid;
 498         bool dummy_query_bo_pinned;
 499
 500         /*
 501          * Surface swapping. The "surface_lru" list is protected by the
 502          * resource lock in order to be able to destroy a surface and take
 503          * it off the lru atomically. "used_memory_size" is currently
 504          * protected by the cmdbuf mutex for simplicity.
 505          */
 506
 507         struct list_head res_lru[vmw_res_max];
 508         uint32_t used_memory_size;
 509
 510         /*
 511          * DMA mapping stuff.
 512          */
 513         enum vmw_dma_map_mode map_mode;
 514
 515         /*
 516          * Guest Backed stuff
 517          */
 518         struct ttm_buffer_object *otable_bo;
 519         struct vmw_otable *otables;
 520 };
 521
 522 static inline struct vmw_surface *vmw_res_to_srf(struct vmw_resource *res)
 523 {
 524         return container_of(res, struct vmw_surface, res);
 525 }
 526
 527 static inline struct vmw_private *vmw_priv(struct drm_device *dev)
 528 {
 529         return (struct vmw_private *)dev->dev_private;
 530 }
 531
 532 static inline struct vmw_fpriv *vmw_fpriv(struct drm_file *file_priv)
 533 {
 534         return (struct vmw_fpriv *)file_priv->driver_priv;
 535 }
 536
 537 static inline struct vmw_master *vmw_master(struct drm_master *master)
 538 {
 539         return (struct vmw_master *) master->driver_priv;
 540 }
 541
 542 static inline void vmw_write(struct vmw_private *dev_priv,
 543                              unsigned int offset, uint32_t value)
 544 {
 545         outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
 546         outl(value, dev_priv->io_start + VMWGFX_VALUE_PORT);
 547 }
 548
 549 static inline uint32_t vmw_read(struct vmw_private *dev_priv,
 550                                 unsigned int offset)
 551 {
 552         uint32_t val;
 553
 554         outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
 555         val = inl(dev_priv->io_start + VMWGFX_VALUE_PORT);
 556         return val;
 557 }
 558
 559 int vmw_3d_resource_inc(struct vmw_private *dev_priv, bool unhide_svga);
 560 void vmw_3d_resource_dec(struct vmw_private *dev_priv, bool hide_svga);
 561
 562 /**
 563  * GMR utilities - vmwgfx_gmr.c
 564  */
 565
 566 extern int vmw_gmr_bind(struct vmw_private *dev_priv,
 567                         const struct vmw_sg_table *vsgt,
 568                         unsigned long num_pages,
 569                         int gmr_id);
 570 extern void vmw_gmr_unbind(struct vmw_private *dev_priv, int gmr_id);
 571
 572 /**
 573  * Resource utilities - vmwgfx_resource.c
 574  */
 575 struct vmw_user_resource_conv;
 576
 577 extern void vmw_resource_unreference(struct vmw_resource **p_res);
 578 extern struct vmw_resource *vmw_resource_reference(struct vmw_resource *res);
 579 extern struct vmw_resource *
 580 vmw_resource_reference_unless_doomed(struct vmw_resource *res);
 581 extern int vmw_resource_validate(struct vmw_resource *res);
 582 extern int vmw_resource_reserve(struct vmw_resource *res, bool no_backup);
 583 extern bool vmw_resource_needs_backup(const struct vmw_resource *res);
 584 extern int vmw_user_lookup_handle(struct vmw_private *dev_priv,
 585                                   struct ttm_object_file *tfile,
 586                                   uint32_t handle,
 587                                   struct vmw_surface **out_surf,
 588                                   struct vmw_dma_buffer **out_buf);
 589 extern int vmw_user_resource_lookup_handle(
 590         struct vmw_private *dev_priv,
 591         struct ttm_object_file *tfile,
 592         uint32_t handle,
 593         const struct vmw_user_resource_conv *converter,
 594         struct vmw_resource **p_res);
 595 extern void vmw_dmabuf_bo_free(struct ttm_buffer_object *bo);
 596 extern int vmw_dmabuf_init(struct vmw_private *dev_priv,
 597                            struct vmw_dma_buffer *vmw_bo,
 598                            size_t size, struct ttm_placement *placement,
 599                            bool interuptable,
 600                            void (*bo_free) (struct ttm_buffer_object *bo));
 601 extern int vmw_user_dmabuf_verify_access(struct ttm_buffer_object *bo,
 602                                   struct ttm_object_file *tfile);
 603 extern int vmw_user_dmabuf_alloc(struct vmw_private *dev_priv,
 604                                  struct ttm_object_file *tfile,
 605                                  uint32_t size,
 606                                  bool shareable,
 607                                  uint32_t *handle,
 608                                  struct vmw_dma_buffer **p_dma_buf);
 609 extern int vmw_user_dmabuf_reference(struct ttm_object_file *tfile,
 610                                      struct vmw_dma_buffer *dma_buf,
 611                                      uint32_t *handle);
 612 extern int vmw_dmabuf_alloc_ioctl(struct drm_device *dev, void *data,
 613                                   struct drm_file *file_priv);
 614 extern int vmw_dmabuf_unref_ioctl(struct drm_device *dev, void *data,
 615                                   struct drm_file *file_priv);
 616 extern int vmw_user_dmabuf_synccpu_ioctl(struct drm_device *dev, void *data,
 617                                          struct drm_file *file_priv);
 618 extern uint32_t vmw_dmabuf_validate_node(struct ttm_buffer_object *bo,
 619                                          uint32_t cur_validate_node);
 620 extern void vmw_dmabuf_validate_clear(struct ttm_buffer_object *bo);
 621 extern int vmw_user_dmabuf_lookup(struct ttm_object_file *tfile,
 622                                   uint32_t id, struct vmw_dma_buffer **out);
 623 extern int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
 624                                   struct drm_file *file_priv);
 625 extern int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
 626                                   struct drm_file *file_priv);
 627 extern int vmw_user_stream_lookup(struct vmw_private *dev_priv,
 628                                   struct ttm_object_file *tfile,
 629                                   uint32_t *inout_id,
 630                                   struct vmw_resource **out);
 631 extern void vmw_resource_unreserve(struct vmw_resource *res,
 632                                    struct vmw_dma_buffer *new_backup,
 633                                    unsigned long new_backup_offset);
 634 extern void vmw_resource_move_notify(struct ttm_buffer_object *bo,
 635                                      struct ttm_mem_reg *mem);
 636 extern void vmw_fence_single_bo(struct ttm_buffer_object *bo,
 637                                 struct vmw_fence_obj *fence);
 638 extern void vmw_resource_evict_all(struct vmw_private *dev_priv);
 639
 640 /**
 641  * DMA buffer helper routines - vmwgfx_dmabuf.c
 642  */
 643 extern int vmw_dmabuf_to_placement(struct vmw_private *vmw_priv,
 644                                    struct vmw_dma_buffer *bo,
 645                                    struct ttm_placement *placement,
 646                                    bool interruptible);
 647 extern int vmw_dmabuf_to_vram(struct vmw_private *dev_priv,
 648                               struct vmw_dma_buffer *buf,
 649                               bool pin, bool interruptible);
 650 extern int vmw_dmabuf_to_vram_or_gmr(struct vmw_private *dev_priv,
 651                                      struct vmw_dma_buffer *buf,
 652                                      bool pin, bool interruptible);
 653 extern int vmw_dmabuf_to_start_of_vram(struct vmw_private *vmw_priv,
 654                                        struct vmw_dma_buffer *bo,
 655                                        bool pin, bool interruptible);
 656 extern int vmw_dmabuf_unpin(struct vmw_private *vmw_priv,
 657                             struct vmw_dma_buffer *bo,
 658                             bool interruptible);
 659 extern void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *buf,
 660                                  SVGAGuestPtr *ptr);
 661 extern void vmw_bo_pin(struct ttm_buffer_object *bo, bool pin);
 662
 663 /**
 664  * Misc Ioctl functionality - vmwgfx_ioctl.c
 665  */
 666
 667 extern int vmw_getparam_ioctl(struct drm_device *dev, void *data,
 668                               struct drm_file *file_priv);
 669 extern int vmw_get_cap_3d_ioctl(struct drm_device *dev, void *data,
 670                                 struct drm_file *file_priv);
 671 extern int vmw_present_ioctl(struct drm_device *dev, void *data,
 672                              struct drm_file *file_priv);
 673 extern int vmw_present_readback_ioctl(struct drm_device *dev, void *data,
 674                                       struct drm_file *file_priv);
 675 extern unsigned int vmw_fops_poll(struct file *filp,
 676                                   struct poll_table_struct *wait);
 677 extern ssize_t vmw_fops_read(struct file *filp, char __user *buffer,
 678                              size_t count, loff_t *offset);
 679
 680 /**
 681  * Fifo utilities - vmwgfx_fifo.c
 682  */
 683
 684 extern int vmw_fifo_init(struct vmw_private *dev_priv,
 685                          struct vmw_fifo_state *fifo);
 686 extern void vmw_fifo_release(struct vmw_private *dev_priv,
 687                              struct vmw_fifo_state *fifo);
 688 extern void *vmw_fifo_reserve(struct vmw_private *dev_priv, uint32_t bytes);
 689 extern void vmw_fifo_commit(struct vmw_private *dev_priv, uint32_t bytes);
 690 extern int vmw_fifo_send_fence(struct vmw_private *dev_priv,
 691                                uint32_t *seqno);
 692 extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
 693 extern bool vmw_fifo_have_3d(struct vmw_private *dev_priv);
 694 extern bool vmw_fifo_have_pitchlock(struct vmw_private *dev_priv);
 695 extern int vmw_fifo_emit_dummy_query(struct vmw_private *dev_priv,
 696                                      uint32_t cid);
 697
 698 /**
 699  * TTM glue - vmwgfx_ttm_glue.c
 700  */
 701
 702 extern int vmw_ttm_global_init(struct vmw_private *dev_priv);
 703 extern void vmw_ttm_global_release(struct vmw_private *dev_priv);
 704 extern int vmw_mmap(struct file *filp, struct vm_area_struct *vma);
 705
 706 /**
 707  * TTM buffer object driver - vmwgfx_buffer.c
 708  */
 709
 710 extern const size_t vmw_tt_size;
 711 extern struct ttm_placement vmw_vram_placement;
 712 extern struct ttm_placement vmw_vram_ne_placement;
 713 extern struct ttm_placement vmw_vram_sys_placement;
 714 extern struct ttm_placement vmw_vram_gmr_placement;
 715 extern struct ttm_placement vmw_vram_gmr_ne_placement;
 716 extern struct ttm_placement vmw_sys_placement;
 717 extern struct ttm_placement vmw_sys_ne_placement;
 718 extern struct ttm_placement vmw_evictable_placement;
 719 extern struct ttm_placement vmw_srf_placement;
 720 extern struct ttm_placement vmw_mob_placement;
 721 extern struct ttm_bo_driver vmw_bo_driver;
 722 extern int vmw_dma_quiescent(struct drm_device *dev);
 723 extern int vmw_bo_map_dma(struct ttm_buffer_object *bo);
 724 extern void vmw_bo_unmap_dma(struct ttm_buffer_object *bo);
 725 extern const struct vmw_sg_table *
 726 vmw_bo_sg_table(struct ttm_buffer_object *bo);
 727 extern void vmw_piter_start(struct vmw_piter *viter,
 728                             const struct vmw_sg_table *vsgt,
 729                             unsigned long p_offs);
 730
 731 /**
 732  * vmw_piter_next - Advance the iterator one page.
 733  *
 734  * @viter: Pointer to the iterator to advance.
 735  *
 736  * Returns false if past the list of pages, true otherwise.
 737  */
 738 static inline bool vmw_piter_next(struct vmw_piter *viter)
 739 {
 740         return viter->next(viter);
 741 }
 742
 743 /**
 744  * vmw_piter_dma_addr - Return the DMA address of the current page.
 745  *
 746  * @viter: Pointer to the iterator
 747  *
 748  * Returns the DMA address of the page pointed to by @viter.
 749  */
 750 static inline dma_addr_t vmw_piter_dma_addr(struct vmw_piter *viter)
 751 {
 752         return viter->dma_address(viter);
 753 }
 754
 755 /**
 756  * vmw_piter_page - Return a pointer to the current page.
 757  *
 758  * @viter: Pointer to the iterator
 759  *
 760  * Returns the DMA address of the page pointed to by @viter.
 761  */
 762 static inline struct page *vmw_piter_page(struct vmw_piter *viter)
 763 {
 764         return viter->page(viter);
 765 }
 766
 767 /**
 768  * Command submission - vmwgfx_execbuf.c
 769  */
 770
 771 extern int vmw_execbuf_ioctl(struct drm_device *dev, void *data,
 772                              struct drm_file *file_priv);
 773 extern int vmw_execbuf_process(struct drm_file *file_priv,
 774                                struct vmw_private *dev_priv,
 775                                void __user *user_commands,
 776                                void *kernel_commands,
 777                                uint32_t command_size,
 778                                uint64_t throttle_us,
 779                                struct drm_vmw_fence_rep __user
 780                                *user_fence_rep,
 781                                struct vmw_fence_obj **out_fence);
 782 extern void __vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv,
 783                                             struct vmw_fence_obj *fence);
 784 extern void vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv);
 785
 786 extern int vmw_execbuf_fence_commands(struct drm_file *file_priv,
 787                                       struct vmw_private *dev_priv,
 788                                       struct vmw_fence_obj **p_fence,
 789                                       uint32_t *p_handle);
 790 extern void vmw_execbuf_copy_fence_user(struct vmw_private *dev_priv,
 791                                         struct vmw_fpriv *vmw_fp,
 792                                         int ret,
 793                                         struct drm_vmw_fence_rep __user
 794                                         *user_fence_rep,
 795                                         struct vmw_fence_obj *fence,
 796                                         uint32_t fence_handle);
 797
 798 /**
 799  * IRQs and wating - vmwgfx_irq.c
 800  */
 801
 802 extern irqreturn_t vmw_irq_handler(int irq, void *arg);
 803 extern int vmw_wait_seqno(struct vmw_private *dev_priv, bool lazy,
 804                              uint32_t seqno, bool interruptible,
 805                              unsigned long timeout);
 806 extern void vmw_irq_preinstall(struct drm_device *dev);
 807 extern int vmw_irq_postinstall(struct drm_device *dev);
 808 extern void vmw_irq_uninstall(struct drm_device *dev);
 809 extern bool vmw_seqno_passed(struct vmw_private *dev_priv,
 810                                 uint32_t seqno);
 811 extern int vmw_fallback_wait(struct vmw_private *dev_priv,
 812                              bool lazy,
 813                              bool fifo_idle,
 814                              uint32_t seqno,
 815                              bool interruptible,
 816                              unsigned long timeout);
 817 extern void vmw_update_seqno(struct vmw_private *dev_priv,
 818                                 struct vmw_fifo_state *fifo_state);
 819 extern void vmw_seqno_waiter_add(struct vmw_private *dev_priv);
 820 extern void vmw_seqno_waiter_remove(struct vmw_private *dev_priv);
 821 extern void vmw_goal_waiter_add(struct vmw_private *dev_priv);
 822 extern void vmw_goal_waiter_remove(struct vmw_private *dev_priv);
 823
 824 /**
 825  * Rudimentary fence-like objects currently used only for throttling -
 826  * vmwgfx_marker.c
 827  */
 828
 829 extern void vmw_marker_queue_init(struct vmw_marker_queue *queue);
 830 extern void vmw_marker_queue_takedown(struct vmw_marker_queue *queue);
 831 extern int vmw_marker_push(struct vmw_marker_queue *queue,
 832                           uint32_t seqno);
 833 extern int vmw_marker_pull(struct vmw_marker_queue *queue,
 834                           uint32_t signaled_seqno);
 835 extern int vmw_wait_lag(struct vmw_private *dev_priv,
 836                         struct vmw_marker_queue *queue, uint32_t us);
 837
 838 /**
 839  * Kernel framebuffer - vmwgfx_fb.c
 840  */
 841
 842 int vmw_fb_init(struct vmw_private *vmw_priv);
 843 int vmw_fb_close(struct vmw_private *dev_priv);
 844 int vmw_fb_off(struct vmw_private *vmw_priv);
 845 int vmw_fb_on(struct vmw_private *vmw_priv);
 846
 847 /**
 848  * Kernel modesetting - vmwgfx_kms.c
 849  */
 850
 851 int vmw_kms_init(struct vmw_private *dev_priv);
 852 int vmw_kms_close(struct vmw_private *dev_priv);
 853 int vmw_kms_save_vga(struct vmw_private *vmw_priv);
 854 int vmw_kms_restore_vga(struct vmw_private *vmw_priv);
 855 int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
 856                                 struct drm_file *file_priv);
 857 void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv);
 858 void vmw_kms_cursor_snoop(struct vmw_surface *srf,
 859                           struct ttm_object_file *tfile,
 860                           struct ttm_buffer_object *bo,
 861                           SVGA3dCmdHeader *header);
 862 int vmw_kms_write_svga(struct vmw_private *vmw_priv,
 863                        unsigned width, unsigned height, unsigned pitch,
 864                        unsigned bpp, unsigned depth);
 865 void vmw_kms_idle_workqueues(struct vmw_master *vmaster);
 866 bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
 867                                 uint32_t pitch,
 868                                 uint32_t height);
 869 u32 vmw_get_vblank_counter(struct drm_device *dev, int crtc);
 870 int vmw_enable_vblank(struct drm_device *dev, int crtc);
 871 void vmw_disable_vblank(struct drm_device *dev, int crtc);
 872 int vmw_kms_present(struct vmw_private *dev_priv,
 873                     struct drm_file *file_priv,
 874                     struct vmw_framebuffer *vfb,
 875                     struct vmw_surface *surface,
 876                     uint32_t sid, int32_t destX, int32_t destY,
 877                     struct drm_vmw_rect *clips,
 878                     uint32_t num_clips);
 879 int vmw_kms_readback(struct vmw_private *dev_priv,
 880                      struct drm_file *file_priv,
 881                      struct vmw_framebuffer *vfb,
 882                      struct drm_vmw_fence_rep __user *user_fence_rep,
 883                      struct drm_vmw_rect *clips,
 884                      uint32_t num_clips);
 885 int vmw_kms_update_layout_ioctl(struct drm_device *dev, void *data,
 886                                 struct drm_file *file_priv);
 887
 888 int vmw_dumb_create(struct drm_file *file_priv,
 889                     struct drm_device *dev,
 890                     struct drm_mode_create_dumb *args);
 891
 892 int vmw_dumb_map_offset(struct drm_file *file_priv,
 893                         struct drm_device *dev, uint32_t handle,
 894                         uint64_t *offset);
 895 int vmw_dumb_destroy(struct drm_file *file_priv,
 896                      struct drm_device *dev,
 897                      uint32_t handle);
 898 /**
 899  * Overlay control - vmwgfx_overlay.c
 900  */
 901
 902 int vmw_overlay_init(struct vmw_private *dev_priv);
 903 int vmw_overlay_close(struct vmw_private *dev_priv);
 904 int vmw_overlay_ioctl(struct drm_device *dev, void *data,
 905                       struct drm_file *file_priv);
 906 int vmw_overlay_stop_all(struct vmw_private *dev_priv);
 907 int vmw_overlay_resume_all(struct vmw_private *dev_priv);
 908 int vmw_overlay_pause_all(struct vmw_private *dev_priv);
 909 int vmw_overlay_claim(struct vmw_private *dev_priv, uint32_t *out);
 910 int vmw_overlay_unref(struct vmw_private *dev_priv, uint32_t stream_id);
 911 int vmw_overlay_num_overlays(struct vmw_private *dev_priv);
 912 int vmw_overlay_num_free_overlays(struct vmw_private *dev_priv);
 913
 914 /**
 915  * GMR Id manager
 916  */
 917
 918 extern const struct ttm_mem_type_manager_func vmw_gmrid_manager_func;
 919
 920 /**
 921  * Prime - vmwgfx_prime.c
 922  */
 923
 924 extern const struct dma_buf_ops vmw_prime_dmabuf_ops;
 925 extern int vmw_prime_fd_to_handle(struct drm_device *dev,
 926                                   struct drm_file *file_priv,
 927                                   int fd, u32 *handle);
 928 extern int vmw_prime_handle_to_fd(struct drm_device *dev,
 929                                   struct drm_file *file_priv,
 930                                   uint32_t handle, uint32_t flags,
 931                                   int *prime_fd);
 932
 933 /*
 934  * MemoryOBject management -  vmwgfx_mob.c
 935  */
 936 struct vmw_mob;
 937 extern int vmw_mob_bind(struct vmw_private *dev_priv, struct vmw_mob *mob,
 938                         const struct vmw_sg_table *vsgt,
 939                         unsigned long num_data_pages, int32_t mob_id);
 940 extern void vmw_mob_unbind(struct vmw_private *dev_priv,
 941                            struct vmw_mob *mob);
 942 extern void vmw_mob_destroy(struct vmw_mob *mob);
 943 extern struct vmw_mob *vmw_mob_create(unsigned long data_pages);
 944 extern int vmw_otables_setup(struct vmw_private *dev_priv);
 945 extern void vmw_otables_takedown(struct vmw_private *dev_priv);
 946
 947 /*
 948  * Context management - vmwgfx_context.c
 949  */
 950
 951 extern const struct vmw_user_resource_conv *user_context_converter;
 952
 953 extern struct vmw_resource *vmw_context_alloc(struct vmw_private *dev_priv);
 954
 955 extern int vmw_context_check(struct vmw_private *dev_priv,
 956                              struct ttm_object_file *tfile,
 957                              int id,
 958                              struct vmw_resource **p_res);
 959 extern int vmw_context_define_ioctl(struct drm_device *dev, void *data,
 960                                     struct drm_file *file_priv);
 961 extern int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
 962                                      struct drm_file *file_priv);
 963 extern int vmw_context_binding_add(struct vmw_ctx_binding_state *cbs,
 964                                    const struct vmw_ctx_bindinfo *ci);
 965 extern void
 966 vmw_context_binding_state_transfer(struct vmw_resource *res,
 967                                    struct vmw_ctx_binding_state *cbs);
 968 extern void vmw_context_binding_res_list_kill(struct list_head *head);
 969 extern void vmw_context_binding_res_list_scrub(struct list_head *head);
 970 extern int vmw_context_rebind_all(struct vmw_resource *ctx);
 971 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
 972
 973 /*
 974  * Surface management - vmwgfx_surface.c
 975  */
 976
 977 extern const struct vmw_user_resource_conv *user_surface_converter;
 978
 979 extern void vmw_surface_res_free(struct vmw_resource *res);
 980 extern int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
 981                                      struct drm_file *file_priv);
 982 extern int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
 983                                     struct drm_file *file_priv);
 984 extern int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
 985                                        struct drm_file *file_priv);
 986 extern int vmw_gb_surface_define_ioctl(struct drm_device *dev, void *data,
 987                                        struct drm_file *file_priv);
 988 extern int vmw_gb_surface_reference_ioctl(struct drm_device *dev, void *data,
 989                                           struct drm_file *file_priv);
 990 extern int vmw_surface_check(struct vmw_private *dev_priv,
 991                              struct ttm_object_file *tfile,
 992                              uint32_t handle, int *id);
 993 extern int vmw_surface_validate(struct vmw_private *dev_priv,
 994                                 struct vmw_surface *srf);
 995
 996 /*
 997  * Shader management - vmwgfx_shader.c
 998  */
 999
1000 extern const struct vmw_user_resource_conv *user_shader_converter;
1001
1002 extern int vmw_shader_define_ioctl(struct drm_device *dev, void *data,
1003                                    struct drm_file *file_priv);
1004 extern int vmw_shader_destroy_ioctl(struct drm_device *dev, void *data,
1005                                     struct drm_file *file_priv);
1006 extern int vmw_compat_shader_lookup(struct vmw_compat_shader_manager *man,
1007                                     SVGA3dShaderType shader_type,
1008                                     u32 *user_key);
1009 extern void vmw_compat_shaders_commit(struct vmw_compat_shader_manager *man,
1010                                       struct list_head *list);
1011 extern void vmw_compat_shaders_revert(struct vmw_compat_shader_manager *man,
1012                                       struct list_head *list);
1013 extern int vmw_compat_shader_remove(struct vmw_compat_shader_manager *man,
1014                                     u32 user_key,
1015                                     SVGA3dShaderType shader_type,
1016                                     struct list_head *list);
1017 extern int vmw_compat_shader_add(struct vmw_compat_shader_manager *man,
1018                                  u32 user_key, const void *bytecode,
1019                                  SVGA3dShaderType shader_type,
1020                                  size_t size,
1021                                  struct ttm_object_file *tfile,
1022                                  struct list_head *list);
1023 extern struct vmw_compat_shader_manager *
1024 vmw_compat_shader_man_create(struct vmw_private *dev_priv);
1025 extern void
1026 vmw_compat_shader_man_destroy(struct vmw_compat_shader_manager *man);
1027
1028
1029 /**
1030  * Inline helper functions
1031  */
1032
1033 static inline void vmw_surface_unreference(struct vmw_surface **srf)
1034 {
1035         struct vmw_surface *tmp_srf = *srf;
1036         struct vmw_resource *res = &tmp_srf->res;
1037         *srf = NULL;
1038
1039         vmw_resource_unreference(&res);
1040 }
1041
1042 static inline struct vmw_surface *vmw_surface_reference(struct vmw_surface *srf)
1043 {
1044         (void) vmw_resource_reference(&srf->res);
1045         return srf;
1046 }
1047
1048 static inline void vmw_dmabuf_unreference(struct vmw_dma_buffer **buf)
1049 {
1050         struct vmw_dma_buffer *tmp_buf = *buf;
1051
1052         *buf = NULL;
1053         if (tmp_buf != NULL) {
1054                 struct ttm_buffer_object *bo = &tmp_buf->base;
1055
1056                 ttm_bo_unref(&bo);
1057         }
1058 }
1059
1060 static inline struct vmw_dma_buffer *vmw_dmabuf_reference(struct vmw_dma_buffer *buf)
1061 {
1062         if (ttm_bo_reference(&buf->base))
1063                 return buf;
1064         return NULL;
1065 }
1066
1067 static inline struct ttm_mem_global *vmw_mem_glob(struct vmw_private *dev_priv)
1068 {
1069         return (struct ttm_mem_global *) dev_priv->mem_global_ref.object;
1070 }
1071 #endif