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