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