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_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         union {
 280                 SVGA3dShaderType shader_type;
 281                 SVGA3dRenderTargetType rt_type;
 282                 uint32 texture_stage;
 283         } i1;
 284 };
 285
 286 /**
 287  * struct vmw_ctx_binding - structure representing a single context binding
 288  *                        - suitable for tracking in a context
 289  *
 290  * @ctx_list: List head for context.
 291  * @res_list: List head for bound resource.
 292  * @bi: Binding info
 293  */
 294 struct vmw_ctx_binding {
 295         struct list_head ctx_list;
 296         struct list_head res_list;
 297         struct vmw_ctx_bindinfo bi;
 298 };
 299
 300
 301 /**
 302  * struct vmw_ctx_binding_state - context binding state
 303  *
 304  * @list: linked list of individual bindings.
 305  * @render_targets: Render target bindings.
 306  * @texture_units: Texture units/samplers bindings.
 307  * @shaders: Shader bindings.
 308  *
 309  * Note that this structure also provides storage space for the individual
 310  * struct vmw_ctx_binding objects, so that no dynamic allocation is needed
 311  * for individual bindings.
 312  *
 313  */
 314 struct vmw_ctx_binding_state {
 315         struct list_head list;
 316         struct vmw_ctx_binding render_targets[SVGA3D_RT_MAX];
 317         struct vmw_ctx_binding texture_units[SVGA3D_NUM_TEXTURE_UNITS];
 318         struct vmw_ctx_binding shaders[SVGA3D_SHADERTYPE_MAX];
 319 };
 320
 321 struct vmw_sw_context{
 322         struct drm_open_hash res_ht;
 323         bool res_ht_initialized;
 324         bool kernel; /**< is the called made from the kernel */
 325         struct vmw_fpriv *fp;
 326         struct list_head validate_nodes;
 327         struct vmw_relocation relocs[VMWGFX_MAX_RELOCATIONS];
 328         uint32_t cur_reloc;
 329         struct vmw_validate_buffer val_bufs[VMWGFX_MAX_VALIDATIONS];
 330         uint32_t cur_val_buf;
 331         uint32_t *cmd_bounce;
 332         uint32_t cmd_bounce_size;
 333         struct list_head resource_list;
 334         uint32_t fence_flags;
 335         struct ttm_buffer_object *cur_query_bo;
 336         struct list_head res_relocations;
 337         uint32_t *buf_start;
 338         struct vmw_res_cache_entry res_cache[vmw_res_max];
 339         struct vmw_resource *last_query_ctx;
 340         bool needs_post_query_barrier;
 341         struct vmw_resource *error_resource;
 342         struct vmw_ctx_binding_state staged_bindings;
 343         struct list_head staged_shaders;
 344 };
 345
 346 struct vmw_legacy_display;
 347 struct vmw_overlay;
 348
 349 struct vmw_master {
 350         struct ttm_lock lock;
 351         struct mutex fb_surf_mutex;
 352         struct list_head fb_surf;
 353 };
 354
 355 struct vmw_vga_topology_state {
 356         uint32_t width;
 357         uint32_t height;
 358         uint32_t primary;
 359         uint32_t pos_x;
 360         uint32_t pos_y;
 361 };
 362
 363 struct vmw_private {
 364         struct ttm_bo_device bdev;
 365         struct ttm_bo_global_ref bo_global_ref;
 366         struct drm_global_reference mem_global_ref;
 367
 368         struct vmw_fifo_state fifo;
 369
 370         struct drm_device *dev;
 371         unsigned long vmw_chipset;
 372         unsigned int io_start;
 373         uint32_t vram_start;
 374         uint32_t vram_size;
 375         uint32_t prim_bb_mem;
 376         uint32_t mmio_start;
 377         uint32_t mmio_size;
 378         uint32_t fb_max_width;
 379         uint32_t fb_max_height;
 380         uint32_t initial_width;
 381         uint32_t initial_height;
 382         __le32 __iomem *mmio_virt;
 383         int mmio_mtrr;
 384         uint32_t capabilities;
 385         uint32_t max_gmr_ids;
 386         uint32_t max_gmr_pages;
 387         uint32_t max_mob_pages;
 388         uint32_t memory_size;
 389         bool has_gmr;
 390         bool has_mob;
 391         struct mutex hw_mutex;
 392
 393         /*
 394          * VGA registers.
 395          */
 396
 397         struct vmw_vga_topology_state vga_save[VMWGFX_MAX_DISPLAYS];
 398         uint32_t vga_width;
 399         uint32_t vga_height;
 400         uint32_t vga_bpp;
 401         uint32_t vga_bpl;
 402         uint32_t vga_pitchlock;
 403
 404         uint32_t num_displays;
 405
 406         /*
 407          * Framebuffer info.
 408          */
 409
 410         void *fb_info;
 411         struct vmw_legacy_display *ldu_priv;
 412         struct vmw_screen_object_display *sou_priv;
 413         struct vmw_overlay *overlay_priv;
 414
 415         /*
 416          * Context and surface management.
 417          */
 418
 419         rwlock_t resource_lock;
 420         struct idr res_idr[vmw_res_max];
 421         /*
 422          * Block lastclose from racing with firstopen.
 423          */
 424
 425         struct mutex init_mutex;
 426
 427         /*
 428          * A resource manager for kernel-only surfaces and
 429          * contexts.
 430          */
 431
 432         struct ttm_object_device *tdev;
 433
 434         /*
 435          * Fencing and IRQs.
 436          */
 437
 438         atomic_t marker_seq;
 439         wait_queue_head_t fence_queue;
 440         wait_queue_head_t fifo_queue;
 441         int fence_queue_waiters; /* Protected by hw_mutex */
 442         int goal_queue_waiters; /* Protected by hw_mutex */
 443         atomic_t fifo_queue_waiters;
 444         uint32_t last_read_seqno;
 445         spinlock_t irq_lock;
 446         struct vmw_fence_manager *fman;
 447         uint32_t irq_mask;
 448
 449         /*
 450          * Device state
 451          */
 452
 453         uint32_t traces_state;
 454         uint32_t enable_state;
 455         uint32_t config_done_state;
 456
 457         /**
 458          * Execbuf
 459          */
 460         /**
 461          * Protected by the cmdbuf mutex.
 462          */
 463
 464         struct vmw_sw_context ctx;
 465         struct mutex cmdbuf_mutex;
 466         struct mutex binding_mutex;
 467
 468         /**
 469          * Operating mode.
 470          */
 471
 472         bool stealth;
 473         bool enable_fb;
 474
 475         /**
 476          * Master management.
 477          */
 478
 479         struct vmw_master *active_master;
 480         struct vmw_master fbdev_master;
 481         struct notifier_block pm_nb;
 482         bool suspended;
 483
 484         struct mutex release_mutex;
 485         uint32_t num_3d_resources;
 486
 487         /*
 488          * Query processing. These members
 489          * are protected by the cmdbuf mutex.
 490          */
 491
 492         struct ttm_buffer_object *dummy_query_bo;
 493         struct ttm_buffer_object *pinned_bo;
 494         uint32_t query_cid;
 495         uint32_t query_cid_valid;
 496         bool dummy_query_bo_pinned;
 497
 498         /*
 499          * Surface swapping. The "surface_lru" list is protected by the
 500          * resource lock in order to be able to destroy a surface and take
 501          * it off the lru atomically. "used_memory_size" is currently
 502          * protected by the cmdbuf mutex for simplicity.
 503          */
 504
 505         struct list_head res_lru[vmw_res_max];
 506         uint32_t used_memory_size;
 507
 508         /*
 509          * DMA mapping stuff.
 510          */
 511         enum vmw_dma_map_mode map_mode;
 512
 513         /*
 514          * Guest Backed stuff
 515          */
 516         struct ttm_buffer_object *otable_bo;
 517         struct vmw_otable *otables;
 518 };
 519
 520 static inline struct vmw_surface *vmw_res_to_srf(struct vmw_resource *res)
 521 {
 522         return container_of(res, struct vmw_surface, res);
 523 }
 524
 525 static inline struct vmw_private *vmw_priv(struct drm_device *dev)
 526 {
 527         return (struct vmw_private *)dev->dev_private;
 528 }
 529
 530 static inline struct vmw_fpriv *vmw_fpriv(struct drm_file *file_priv)
 531 {
 532         return (struct vmw_fpriv *)file_priv->driver_priv;
 533 }
 534
 535 static inline struct vmw_master *vmw_master(struct drm_master *master)
 536 {
 537         return (struct vmw_master *) master->driver_priv;
 538 }
 539
 540 static inline void vmw_write(struct vmw_private *dev_priv,
 541                              unsigned int offset, uint32_t value)
 542 {
 543         outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
 544         outl(value, dev_priv->io_start + VMWGFX_VALUE_PORT);
 545 }
 546
 547 static inline uint32_t vmw_read(struct vmw_private *dev_priv,
 548                                 unsigned int offset)
 549 {
 550         uint32_t val;
 551
 552         outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
 553         val = inl(dev_priv->io_start + VMWGFX_VALUE_PORT);
 554         return val;
 555 }
 556
 557 int vmw_3d_resource_inc(struct vmw_private *dev_priv, bool unhide_svga);
 558 void vmw_3d_resource_dec(struct vmw_private *dev_priv, bool hide_svga);
 559
 560 /**
 561  * GMR utilities - vmwgfx_gmr.c
 562  */
 563
 564 extern int vmw_gmr_bind(struct vmw_private *dev_priv,
 565                         const struct vmw_sg_table *vsgt,
 566                         unsigned long num_pages,
 567                         int gmr_id);
 568 extern void vmw_gmr_unbind(struct vmw_private *dev_priv, int gmr_id);
 569
 570 /**
 571  * Resource utilities - vmwgfx_resource.c
 572  */
 573 struct vmw_user_resource_conv;
 574
 575 extern void vmw_resource_unreference(struct vmw_resource **p_res);
 576 extern struct vmw_resource *vmw_resource_reference(struct vmw_resource *res);
 577 extern int vmw_resource_validate(struct vmw_resource *res);
 578 extern int vmw_resource_reserve(struct vmw_resource *res, bool no_backup);
 579 extern bool vmw_resource_needs_backup(const struct vmw_resource *res);
 580 extern int vmw_user_lookup_handle(struct vmw_private *dev_priv,
 581                                   struct ttm_object_file *tfile,
 582                                   uint32_t handle,
 583                                   struct vmw_surface **out_surf,
 584                                   struct vmw_dma_buffer **out_buf);
 585 extern int vmw_user_resource_lookup_handle(
 586         struct vmw_private *dev_priv,
 587         struct ttm_object_file *tfile,
 588         uint32_t handle,
 589         const struct vmw_user_resource_conv *converter,
 590         struct vmw_resource **p_res);
 591 extern void vmw_dmabuf_bo_free(struct ttm_buffer_object *bo);
 592 extern int vmw_dmabuf_init(struct vmw_private *dev_priv,
 593                            struct vmw_dma_buffer *vmw_bo,
 594                            size_t size, struct ttm_placement *placement,
 595                            bool interuptable,
 596                            void (*bo_free) (struct ttm_buffer_object *bo));
 597 extern int vmw_user_dmabuf_verify_access(struct ttm_buffer_object *bo,
 598                                   struct ttm_object_file *tfile);
 599 extern int vmw_user_dmabuf_alloc(struct vmw_private *dev_priv,
 600                                  struct ttm_object_file *tfile,
 601                                  uint32_t size,
 602                                  bool shareable,
 603                                  uint32_t *handle,
 604                                  struct vmw_dma_buffer **p_dma_buf);
 605 extern int vmw_user_dmabuf_reference(struct ttm_object_file *tfile,
 606                                      struct vmw_dma_buffer *dma_buf,
 607                                      uint32_t *handle);
 608 extern int vmw_dmabuf_alloc_ioctl(struct drm_device *dev, void *data,
 609                                   struct drm_file *file_priv);
 610 extern int vmw_dmabuf_unref_ioctl(struct drm_device *dev, void *data,
 611                                   struct drm_file *file_priv);
 612 extern int vmw_user_dmabuf_synccpu_ioctl(struct drm_device *dev, void *data,
 613                                          struct drm_file *file_priv);
 614 extern uint32_t vmw_dmabuf_validate_node(struct ttm_buffer_object *bo,
 615                                          uint32_t cur_validate_node);
 616 extern void vmw_dmabuf_validate_clear(struct ttm_buffer_object *bo);
 617 extern int vmw_user_dmabuf_lookup(struct ttm_object_file *tfile,
 618                                   uint32_t id, struct vmw_dma_buffer **out);
 619 extern int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
 620                                   struct drm_file *file_priv);
 621 extern int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
 622                                   struct drm_file *file_priv);
 623 extern int vmw_user_stream_lookup(struct vmw_private *dev_priv,
 624                                   struct ttm_object_file *tfile,
 625                                   uint32_t *inout_id,
 626                                   struct vmw_resource **out);
 627 extern void vmw_resource_unreserve(struct vmw_resource *res,
 628                                    struct vmw_dma_buffer *new_backup,
 629                                    unsigned long new_backup_offset);
 630 extern void vmw_resource_move_notify(struct ttm_buffer_object *bo,
 631                                      struct ttm_mem_reg *mem);
 632 extern void vmw_fence_single_bo(struct ttm_buffer_object *bo,
 633                                 struct vmw_fence_obj *fence);
 634 extern void vmw_resource_evict_all(struct vmw_private *dev_priv);
 635
 636 /**
 637  * DMA buffer helper routines - vmwgfx_dmabuf.c
 638  */
 639 extern int vmw_dmabuf_to_placement(struct vmw_private *vmw_priv,
 640                                    struct vmw_dma_buffer *bo,
 641                                    struct ttm_placement *placement,
 642                                    bool interruptible);
 643 extern int vmw_dmabuf_to_vram(struct vmw_private *dev_priv,
 644                               struct vmw_dma_buffer *buf,
 645                               bool pin, bool interruptible);
 646 extern int vmw_dmabuf_to_vram_or_gmr(struct vmw_private *dev_priv,
 647                                      struct vmw_dma_buffer *buf,
 648                                      bool pin, bool interruptible);
 649 extern int vmw_dmabuf_to_start_of_vram(struct vmw_private *vmw_priv,
 650                                        struct vmw_dma_buffer *bo,
 651                                        bool pin, bool interruptible);
 652 extern int vmw_dmabuf_unpin(struct vmw_private *vmw_priv,
 653                             struct vmw_dma_buffer *bo,
 654                             bool interruptible);
 655 extern void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *buf,
 656                                  SVGAGuestPtr *ptr);
 657 extern void vmw_bo_pin(struct ttm_buffer_object *bo, bool pin);
 658
 659 /**
 660  * Misc Ioctl functionality - vmwgfx_ioctl.c
 661  */
 662
 663 extern int vmw_getparam_ioctl(struct drm_device *dev, void *data,
 664                               struct drm_file *file_priv);
 665 extern int vmw_get_cap_3d_ioctl(struct drm_device *dev, void *data,
 666                                 struct drm_file *file_priv);
 667 extern int vmw_present_ioctl(struct drm_device *dev, void *data,
 668                              struct drm_file *file_priv);
 669 extern int vmw_present_readback_ioctl(struct drm_device *dev, void *data,
 670                                       struct drm_file *file_priv);
 671 extern unsigned int vmw_fops_poll(struct file *filp,
 672                                   struct poll_table_struct *wait);
 673 extern ssize_t vmw_fops_read(struct file *filp, char __user *buffer,
 674                              size_t count, loff_t *offset);
 675
 676 /**
 677  * Fifo utilities - vmwgfx_fifo.c
 678  */
 679
 680 extern int vmw_fifo_init(struct vmw_private *dev_priv,
 681                          struct vmw_fifo_state *fifo);
 682 extern void vmw_fifo_release(struct vmw_private *dev_priv,
 683                              struct vmw_fifo_state *fifo);
 684 extern void *vmw_fifo_reserve(struct vmw_private *dev_priv, uint32_t bytes);
 685 extern void vmw_fifo_commit(struct vmw_private *dev_priv, uint32_t bytes);
 686 extern int vmw_fifo_send_fence(struct vmw_private *dev_priv,
 687                                uint32_t *seqno);
 688 extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
 689 extern bool vmw_fifo_have_3d(struct vmw_private *dev_priv);
 690 extern bool vmw_fifo_have_pitchlock(struct vmw_private *dev_priv);
 691 extern int vmw_fifo_emit_dummy_query(struct vmw_private *dev_priv,
 692                                      uint32_t cid);
 693
 694 /**
 695  * TTM glue - vmwgfx_ttm_glue.c
 696  */
 697
 698 extern int vmw_ttm_global_init(struct vmw_private *dev_priv);
 699 extern void vmw_ttm_global_release(struct vmw_private *dev_priv);
 700 extern int vmw_mmap(struct file *filp, struct vm_area_struct *vma);
 701
 702 /**
 703  * TTM buffer object driver - vmwgfx_buffer.c
 704  */
 705
 706 extern const size_t vmw_tt_size;
 707 extern struct ttm_placement vmw_vram_placement;
 708 extern struct ttm_placement vmw_vram_ne_placement;
 709 extern struct ttm_placement vmw_vram_sys_placement;
 710 extern struct ttm_placement vmw_vram_gmr_placement;
 711 extern struct ttm_placement vmw_vram_gmr_ne_placement;
 712 extern struct ttm_placement vmw_sys_placement;
 713 extern struct ttm_placement vmw_sys_ne_placement;
 714 extern struct ttm_placement vmw_evictable_placement;
 715 extern struct ttm_placement vmw_srf_placement;
 716 extern struct ttm_placement vmw_mob_placement;
 717 extern struct ttm_bo_driver vmw_bo_driver;
 718 extern int vmw_dma_quiescent(struct drm_device *dev);
 719 extern int vmw_bo_map_dma(struct ttm_buffer_object *bo);
 720 extern void vmw_bo_unmap_dma(struct ttm_buffer_object *bo);
 721 extern const struct vmw_sg_table *
 722 vmw_bo_sg_table(struct ttm_buffer_object *bo);
 723 extern void vmw_piter_start(struct vmw_piter *viter,
 724                             const struct vmw_sg_table *vsgt,
 725                             unsigned long p_offs);
 726
 727 /**
 728  * vmw_piter_next - Advance the iterator one page.
 729  *
 730  * @viter: Pointer to the iterator to advance.
 731  *
 732  * Returns false if past the list of pages, true otherwise.
 733  */
 734 static inline bool vmw_piter_next(struct vmw_piter *viter)
 735 {
 736         return viter->next(viter);
 737 }
 738
 739 /**
 740  * vmw_piter_dma_addr - Return the DMA address of the current page.
 741  *
 742  * @viter: Pointer to the iterator
 743  *
 744  * Returns the DMA address of the page pointed to by @viter.
 745  */
 746 static inline dma_addr_t vmw_piter_dma_addr(struct vmw_piter *viter)
 747 {
 748         return viter->dma_address(viter);
 749 }
 750
 751 /**
 752  * vmw_piter_page - Return a pointer to the current page.
 753  *
 754  * @viter: Pointer to the iterator
 755  *
 756  * Returns the DMA address of the page pointed to by @viter.
 757  */
 758 static inline struct page *vmw_piter_page(struct vmw_piter *viter)
 759 {
 760         return viter->page(viter);
 761 }
 762
 763 /**
 764  * Command submission - vmwgfx_execbuf.c
 765  */
 766
 767 extern int vmw_execbuf_ioctl(struct drm_device *dev, void *data,
 768                              struct drm_file *file_priv);
 769 extern int vmw_execbuf_process(struct drm_file *file_priv,
 770                                struct vmw_private *dev_priv,
 771                                void __user *user_commands,
 772                                void *kernel_commands,
 773                                uint32_t command_size,
 774                                uint64_t throttle_us,
 775                                struct drm_vmw_fence_rep __user
 776                                *user_fence_rep,
 777                                struct vmw_fence_obj **out_fence);
 778 extern void __vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv,
 779                                             struct vmw_fence_obj *fence);
 780 extern void vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv);
 781
 782 extern int vmw_execbuf_fence_commands(struct drm_file *file_priv,
 783                                       struct vmw_private *dev_priv,
 784                                       struct vmw_fence_obj **p_fence,
 785                                       uint32_t *p_handle);
 786 extern void vmw_execbuf_copy_fence_user(struct vmw_private *dev_priv,
 787                                         struct vmw_fpriv *vmw_fp,
 788                                         int ret,
 789                                         struct drm_vmw_fence_rep __user
 790                                         *user_fence_rep,
 791                                         struct vmw_fence_obj *fence,
 792                                         uint32_t fence_handle);
 793
 794 /**
 795  * IRQs and wating - vmwgfx_irq.c
 796  */
 797
 798 extern irqreturn_t vmw_irq_handler(int irq, void *arg);
 799 extern int vmw_wait_seqno(struct vmw_private *dev_priv, bool lazy,
 800                              uint32_t seqno, bool interruptible,
 801                              unsigned long timeout);
 802 extern void vmw_irq_preinstall(struct drm_device *dev);
 803 extern int vmw_irq_postinstall(struct drm_device *dev);
 804 extern void vmw_irq_uninstall(struct drm_device *dev);
 805 extern bool vmw_seqno_passed(struct vmw_private *dev_priv,
 806                                 uint32_t seqno);
 807 extern int vmw_fallback_wait(struct vmw_private *dev_priv,
 808                              bool lazy,
 809                              bool fifo_idle,
 810                              uint32_t seqno,
 811                              bool interruptible,
 812                              unsigned long timeout);
 813 extern void vmw_update_seqno(struct vmw_private *dev_priv,
 814                                 struct vmw_fifo_state *fifo_state);
 815 extern void vmw_seqno_waiter_add(struct vmw_private *dev_priv);
 816 extern void vmw_seqno_waiter_remove(struct vmw_private *dev_priv);
 817 extern void vmw_goal_waiter_add(struct vmw_private *dev_priv);
 818 extern void vmw_goal_waiter_remove(struct vmw_private *dev_priv);
 819
 820 /**
 821  * Rudimentary fence-like objects currently used only for throttling -
 822  * vmwgfx_marker.c
 823  */
 824
 825 extern void vmw_marker_queue_init(struct vmw_marker_queue *queue);
 826 extern void vmw_marker_queue_takedown(struct vmw_marker_queue *queue);
 827 extern int vmw_marker_push(struct vmw_marker_queue *queue,
 828                           uint32_t seqno);
 829 extern int vmw_marker_pull(struct vmw_marker_queue *queue,
 830                           uint32_t signaled_seqno);
 831 extern int vmw_wait_lag(struct vmw_private *dev_priv,
 832                         struct vmw_marker_queue *queue, uint32_t us);
 833
 834 /**
 835  * Kernel framebuffer - vmwgfx_fb.c
 836  */
 837
 838 int vmw_fb_init(struct vmw_private *vmw_priv);
 839 int vmw_fb_close(struct vmw_private *dev_priv);
 840 int vmw_fb_off(struct vmw_private *vmw_priv);
 841 int vmw_fb_on(struct vmw_private *vmw_priv);
 842
 843 /**
 844  * Kernel modesetting - vmwgfx_kms.c
 845  */
 846
 847 int vmw_kms_init(struct vmw_private *dev_priv);
 848 int vmw_kms_close(struct vmw_private *dev_priv);
 849 int vmw_kms_save_vga(struct vmw_private *vmw_priv);
 850 int vmw_kms_restore_vga(struct vmw_private *vmw_priv);
 851 int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
 852                                 struct drm_file *file_priv);
 853 void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv);
 854 void vmw_kms_cursor_snoop(struct vmw_surface *srf,
 855                           struct ttm_object_file *tfile,
 856                           struct ttm_buffer_object *bo,
 857                           SVGA3dCmdHeader *header);
 858 int vmw_kms_write_svga(struct vmw_private *vmw_priv,
 859                        unsigned width, unsigned height, unsigned pitch,
 860                        unsigned bpp, unsigned depth);
 861 void vmw_kms_idle_workqueues(struct vmw_master *vmaster);
 862 bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
 863                                 uint32_t pitch,
 864                                 uint32_t height);
 865 u32 vmw_get_vblank_counter(struct drm_device *dev, int crtc);
 866 int vmw_enable_vblank(struct drm_device *dev, int crtc);
 867 void vmw_disable_vblank(struct drm_device *dev, int crtc);
 868 int vmw_kms_present(struct vmw_private *dev_priv,
 869                     struct drm_file *file_priv,
 870                     struct vmw_framebuffer *vfb,
 871                     struct vmw_surface *surface,
 872                     uint32_t sid, int32_t destX, int32_t destY,
 873                     struct drm_vmw_rect *clips,
 874                     uint32_t num_clips);
 875 int vmw_kms_readback(struct vmw_private *dev_priv,
 876                      struct drm_file *file_priv,
 877                      struct vmw_framebuffer *vfb,
 878                      struct drm_vmw_fence_rep __user *user_fence_rep,
 879                      struct drm_vmw_rect *clips,
 880                      uint32_t num_clips);
 881 int vmw_kms_update_layout_ioctl(struct drm_device *dev, void *data,
 882                                 struct drm_file *file_priv);
 883
 884 int vmw_dumb_create(struct drm_file *file_priv,
 885                     struct drm_device *dev,
 886                     struct drm_mode_create_dumb *args);
 887
 888 int vmw_dumb_map_offset(struct drm_file *file_priv,
 889                         struct drm_device *dev, uint32_t handle,
 890                         uint64_t *offset);
 891 int vmw_dumb_destroy(struct drm_file *file_priv,
 892                      struct drm_device *dev,
 893                      uint32_t handle);
 894 /**
 895  * Overlay control - vmwgfx_overlay.c
 896  */
 897
 898 int vmw_overlay_init(struct vmw_private *dev_priv);
 899 int vmw_overlay_close(struct vmw_private *dev_priv);
 900 int vmw_overlay_ioctl(struct drm_device *dev, void *data,
 901                       struct drm_file *file_priv);
 902 int vmw_overlay_stop_all(struct vmw_private *dev_priv);
 903 int vmw_overlay_resume_all(struct vmw_private *dev_priv);
 904 int vmw_overlay_pause_all(struct vmw_private *dev_priv);
 905 int vmw_overlay_claim(struct vmw_private *dev_priv, uint32_t *out);
 906 int vmw_overlay_unref(struct vmw_private *dev_priv, uint32_t stream_id);
 907 int vmw_overlay_num_overlays(struct vmw_private *dev_priv);
 908 int vmw_overlay_num_free_overlays(struct vmw_private *dev_priv);
 909
 910 /**
 911  * GMR Id manager
 912  */
 913
 914 extern const struct ttm_mem_type_manager_func vmw_gmrid_manager_func;
 915
 916 /**
 917  * Prime - vmwgfx_prime.c
 918  */
 919
 920 extern const struct dma_buf_ops vmw_prime_dmabuf_ops;
 921 extern int vmw_prime_fd_to_handle(struct drm_device *dev,
 922                                   struct drm_file *file_priv,
 923                                   int fd, u32 *handle);
 924 extern int vmw_prime_handle_to_fd(struct drm_device *dev,
 925                                   struct drm_file *file_priv,
 926                                   uint32_t handle, uint32_t flags,
 927                                   int *prime_fd);
 928
 929 /*
 930  * MemoryOBject management -  vmwgfx_mob.c
 931  */
 932 struct vmw_mob;
 933 extern int vmw_mob_bind(struct vmw_private *dev_priv, struct vmw_mob *mob,
 934                         const struct vmw_sg_table *vsgt,
 935                         unsigned long num_data_pages, int32_t mob_id);
 936 extern void vmw_mob_unbind(struct vmw_private *dev_priv,
 937                            struct vmw_mob *mob);
 938 extern void vmw_mob_destroy(struct vmw_mob *mob);
 939 extern struct vmw_mob *vmw_mob_create(unsigned long data_pages);
 940 extern int vmw_otables_setup(struct vmw_private *dev_priv);
 941 extern void vmw_otables_takedown(struct vmw_private *dev_priv);
 942
 943 /*
 944  * Context management - vmwgfx_context.c
 945  */
 946
 947 extern const struct vmw_user_resource_conv *user_context_converter;
 948
 949 extern struct vmw_resource *vmw_context_alloc(struct vmw_private *dev_priv);
 950
 951 extern int vmw_context_check(struct vmw_private *dev_priv,
 952                              struct ttm_object_file *tfile,
 953                              int id,
 954                              struct vmw_resource **p_res);
 955 extern int vmw_context_define_ioctl(struct drm_device *dev, void *data,
 956                                     struct drm_file *file_priv);
 957 extern int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
 958                                      struct drm_file *file_priv);
 959 extern int vmw_context_binding_add(struct vmw_ctx_binding_state *cbs,
 960                                    const struct vmw_ctx_bindinfo *ci);
 961 extern void
 962 vmw_context_binding_state_transfer(struct vmw_resource *res,
 963                                    struct vmw_ctx_binding_state *cbs);
 964 extern void vmw_context_binding_res_list_kill(struct list_head *head);
 965
 966 /*
 967  * Surface management - vmwgfx_surface.c
 968  */
 969
 970 extern const struct vmw_user_resource_conv *user_surface_converter;
 971
 972 extern void vmw_surface_res_free(struct vmw_resource *res);
 973 extern int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
 974                                      struct drm_file *file_priv);
 975 extern int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
 976                                     struct drm_file *file_priv);
 977 extern int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
 978                                        struct drm_file *file_priv);
 979 extern int vmw_gb_surface_define_ioctl(struct drm_device *dev, void *data,
 980                                        struct drm_file *file_priv);
 981 extern int vmw_gb_surface_reference_ioctl(struct drm_device *dev, void *data,
 982                                           struct drm_file *file_priv);
 983 extern int vmw_surface_check(struct vmw_private *dev_priv,
 984                              struct ttm_object_file *tfile,
 985                              uint32_t handle, int *id);
 986 extern int vmw_surface_validate(struct vmw_private *dev_priv,
 987                                 struct vmw_surface *srf);
 988
 989 /*
 990  * Shader management - vmwgfx_shader.c
 991  */
 992
 993 extern const struct vmw_user_resource_conv *user_shader_converter;
 994
 995 extern int vmw_shader_define_ioctl(struct drm_device *dev, void *data,
 996                                    struct drm_file *file_priv);
 997 extern int vmw_shader_destroy_ioctl(struct drm_device *dev, void *data,
 998                                     struct drm_file *file_priv);
 999 extern int vmw_compat_shader_lookup(struct vmw_compat_shader_manager *man,
1000                                     SVGA3dShaderType shader_type,
1001                                     u32 *user_key);
1002 extern void vmw_compat_shaders_commit(struct vmw_compat_shader_manager *man,
1003                                       struct list_head *list);
1004 extern void vmw_compat_shaders_revert(struct vmw_compat_shader_manager *man,
1005                                       struct list_head *list);
1006 extern int vmw_compat_shader_remove(struct vmw_compat_shader_manager *man,
1007                                     u32 user_key,
1008                                     SVGA3dShaderType shader_type,
1009                                     struct list_head *list);
1010 extern int vmw_compat_shader_add(struct vmw_compat_shader_manager *man,
1011                                  u32 user_key, const void *bytecode,
1012                                  SVGA3dShaderType shader_type,
1013                                  size_t size,
1014                                  struct ttm_object_file *tfile,
1015                                  struct list_head *list);
1016 extern struct vmw_compat_shader_manager *
1017 vmw_compat_shader_man_create(struct vmw_private *dev_priv);
1018 extern void
1019 vmw_compat_shader_man_destroy(struct vmw_compat_shader_manager *man);
1020
1021
1022 /**
1023  * Inline helper functions
1024  */
1025
1026 static inline void vmw_surface_unreference(struct vmw_surface **srf)
1027 {
1028         struct vmw_surface *tmp_srf = *srf;
1029         struct vmw_resource *res = &tmp_srf->res;
1030         *srf = NULL;
1031
1032         vmw_resource_unreference(&res);
1033 }
1034
1035 static inline struct vmw_surface *vmw_surface_reference(struct vmw_surface *srf)
1036 {
1037         (void) vmw_resource_reference(&srf->res);
1038         return srf;
1039 }
1040
1041 static inline void vmw_dmabuf_unreference(struct vmw_dma_buffer **buf)
1042 {
1043         struct vmw_dma_buffer *tmp_buf = *buf;
1044
1045         *buf = NULL;
1046         if (tmp_buf != NULL) {
1047                 struct ttm_buffer_object *bo = &tmp_buf->base;
1048
1049                 ttm_bo_unref(&bo);
1050         }
1051 }
1052
1053 static inline struct vmw_dma_buffer *vmw_dmabuf_reference(struct vmw_dma_buffer *buf)
1054 {
1055         if (ttm_bo_reference(&buf->base))
1056                 return buf;
1057         return NULL;
1058 }
1059
1060 static inline struct ttm_mem_global *vmw_mem_glob(struct vmw_private *dev_priv)
1061 {
1062         return (struct ttm_mem_global *) dev_priv->mem_global_ref.object;
1063 }
1064 #endif