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 "drmP.h"
  33 #include "vmwgfx_drm.h"
  34 #include "drm_hashtab.h"
  35 #include "linux/suspend.h"
  36 #include "ttm/ttm_bo_driver.h"
  37 #include "ttm/ttm_object.h"
  38 #include "ttm/ttm_lock.h"
  39 #include "ttm/ttm_execbuf_util.h"
  40 #include "ttm/ttm_module.h"
  41 #include "vmwgfx_fence.h"
  42
  43 #define VMWGFX_DRIVER_DATE "20110901"
  44 #define VMWGFX_DRIVER_MAJOR 2
  45 #define VMWGFX_DRIVER_MINOR 0
  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 #define VMW_PL_GMR TTM_PL_PRIV0
  55 #define VMW_PL_FLAG_GMR TTM_PL_FLAG_PRIV0
  56
  57 #define VMW_RES_CONTEXT ttm_driver_type0
  58 #define VMW_RES_SURFACE ttm_driver_type1
  59 #define VMW_RES_STREAM ttm_driver_type2
  60 #define VMW_RES_FENCE ttm_driver_type3
  61
  62 struct vmw_fpriv {
  63         struct drm_master *locked_master;
  64         struct ttm_object_file *tfile;
  65 };
  66
  67 struct vmw_dma_buffer {
  68         struct ttm_buffer_object base;
  69         struct list_head validate_list;
  70         bool gmr_bound;
  71         uint32_t cur_validate_node;
  72         bool on_validate_list;
  73 };
  74
  75 struct vmw_resource {
  76         struct kref kref;
  77         struct vmw_private *dev_priv;
  78         struct idr *idr;
  79         int id;
  80         enum ttm_object_type res_type;
  81         bool avail;
  82         void (*hw_destroy) (struct vmw_resource *res);
  83         void (*res_free) (struct vmw_resource *res);
  84         struct list_head validate_head;
  85         struct list_head query_head; /* Protected by the cmdbuf mutex */
  86         /* TODO is a generic snooper needed? */
  87 #if 0
  88         void (*snoop)(struct vmw_resource *res,
  89                       struct ttm_object_file *tfile,
  90                       SVGA3dCmdHeader *header);
  91         void *snoop_priv;
  92 #endif
  93 };
  94
  95 struct vmw_cursor_snooper {
  96         struct drm_crtc *crtc;
  97         size_t age;
  98         uint32_t *image;
  99 };
 100
 101 struct vmw_framebuffer;
 102
 103 struct vmw_surface {
 104         struct vmw_resource res;
 105         uint32_t flags;
 106         uint32_t format;
 107         uint32_t mip_levels[DRM_VMW_MAX_SURFACE_FACES];
 108         struct drm_vmw_size *sizes;
 109         uint32_t num_sizes;
 110
 111         bool scanout;
 112
 113         /* TODO so far just a extra pointer */
 114         struct vmw_cursor_snooper snooper;
 115 };
 116
 117 struct vmw_marker_queue {
 118         struct list_head head;
 119         struct timespec lag;
 120         struct timespec lag_time;
 121         spinlock_t lock;
 122 };
 123
 124 struct vmw_fifo_state {
 125         unsigned long reserved_size;
 126         __le32 *dynamic_buffer;
 127         __le32 *static_buffer;
 128         unsigned long static_buffer_size;
 129         bool using_bounce_buffer;
 130         uint32_t capabilities;
 131         struct mutex fifo_mutex;
 132         struct rw_semaphore rwsem;
 133         struct vmw_marker_queue marker_queue;
 134 };
 135
 136 struct vmw_relocation {
 137         SVGAGuestPtr *location;
 138         uint32_t index;
 139 };
 140
 141 struct vmw_sw_context{
 142         struct ida bo_list;
 143         uint32_t last_cid;
 144         bool cid_valid;
 145         bool kernel; /**< is the called made from the kernel */
 146         struct vmw_resource *cur_ctx;
 147         uint32_t last_sid;
 148         uint32_t sid_translation;
 149         bool sid_valid;
 150         struct ttm_object_file *tfile;
 151         struct list_head validate_nodes;
 152         struct vmw_relocation relocs[VMWGFX_MAX_RELOCATIONS];
 153         uint32_t cur_reloc;
 154         struct ttm_validate_buffer val_bufs[VMWGFX_MAX_VALIDATIONS];
 155         uint32_t cur_val_buf;
 156         uint32_t *cmd_bounce;
 157         uint32_t cmd_bounce_size;
 158         struct list_head resource_list;
 159         uint32_t fence_flags;
 160         struct list_head query_list;
 161         struct ttm_buffer_object *cur_query_bo;
 162         uint32_t cur_query_cid;
 163         bool query_cid_valid;
 164 };
 165
 166 struct vmw_legacy_display;
 167 struct vmw_overlay;
 168
 169 struct vmw_master {
 170         struct ttm_lock lock;
 171         struct mutex fb_surf_mutex;
 172         struct list_head fb_surf;
 173 };
 174
 175 struct vmw_vga_topology_state {
 176         uint32_t width;
 177         uint32_t height;
 178         uint32_t primary;
 179         uint32_t pos_x;
 180         uint32_t pos_y;
 181 };
 182
 183 struct vmw_private {
 184         struct ttm_bo_device bdev;
 185         struct ttm_bo_global_ref bo_global_ref;
 186         struct drm_global_reference mem_global_ref;
 187
 188         struct vmw_fifo_state fifo;
 189
 190         struct drm_device *dev;
 191         unsigned long vmw_chipset;
 192         unsigned int io_start;
 193         uint32_t vram_start;
 194         uint32_t vram_size;
 195         uint32_t mmio_start;
 196         uint32_t mmio_size;
 197         uint32_t fb_max_width;
 198         uint32_t fb_max_height;
 199         __le32 __iomem *mmio_virt;
 200         int mmio_mtrr;
 201         uint32_t capabilities;
 202         uint32_t max_gmr_descriptors;
 203         uint32_t max_gmr_ids;
 204         uint32_t max_gmr_pages;
 205         uint32_t memory_size;
 206         bool has_gmr;
 207         struct mutex hw_mutex;
 208
 209         /*
 210          * VGA registers.
 211          */
 212
 213         struct vmw_vga_topology_state vga_save[VMWGFX_MAX_DISPLAYS];
 214         uint32_t vga_width;
 215         uint32_t vga_height;
 216         uint32_t vga_bpp;
 217         uint32_t vga_bpl;
 218         uint32_t vga_pitchlock;
 219
 220         uint32_t num_displays;
 221
 222         /*
 223          * Framebuffer info.
 224          */
 225
 226         void *fb_info;
 227         struct vmw_legacy_display *ldu_priv;
 228         struct vmw_screen_object_display *sou_priv;
 229         struct vmw_overlay *overlay_priv;
 230
 231         /*
 232          * Context and surface management.
 233          */
 234
 235         rwlock_t resource_lock;
 236         struct idr context_idr;
 237         struct idr surface_idr;
 238         struct idr stream_idr;
 239
 240         /*
 241          * Block lastclose from racing with firstopen.
 242          */
 243
 244         struct mutex init_mutex;
 245
 246         /*
 247          * A resource manager for kernel-only surfaces and
 248          * contexts.
 249          */
 250
 251         struct ttm_object_device *tdev;
 252
 253         /*
 254          * Fencing and IRQs.
 255          */
 256
 257         atomic_t marker_seq;
 258         wait_queue_head_t fence_queue;
 259         wait_queue_head_t fifo_queue;
 260         int fence_queue_waiters; /* Protected by hw_mutex */
 261         atomic_t fifo_queue_waiters;
 262         uint32_t last_read_seqno;
 263         spinlock_t irq_lock;
 264         struct vmw_fence_manager *fman;
 265
 266         /*
 267          * Device state
 268          */
 269
 270         uint32_t traces_state;
 271         uint32_t enable_state;
 272         uint32_t config_done_state;
 273
 274         /**
 275          * Execbuf
 276          */
 277         /**
 278          * Protected by the cmdbuf mutex.
 279          */
 280
 281         struct vmw_sw_context ctx;
 282         struct mutex cmdbuf_mutex;
 283
 284         /**
 285          * Operating mode.
 286          */
 287
 288         bool stealth;
 289         bool is_opened;
 290         bool enable_fb;
 291
 292         /**
 293          * Master management.
 294          */
 295
 296         struct vmw_master *active_master;
 297         struct vmw_master fbdev_master;
 298         struct notifier_block pm_nb;
 299         bool suspended;
 300
 301         struct mutex release_mutex;
 302         uint32_t num_3d_resources;
 303
 304         /*
 305          * Query processing. These members
 306          * are protected by the cmdbuf mutex.
 307          */
 308
 309         struct ttm_buffer_object *dummy_query_bo;
 310         struct ttm_buffer_object *pinned_bo;
 311         uint32_t query_cid;
 312         bool dummy_query_bo_pinned;
 313 };
 314
 315 static inline struct vmw_private *vmw_priv(struct drm_device *dev)
 316 {
 317         return (struct vmw_private *)dev->dev_private;
 318 }
 319
 320 static inline struct vmw_fpriv *vmw_fpriv(struct drm_file *file_priv)
 321 {
 322         return (struct vmw_fpriv *)file_priv->driver_priv;
 323 }
 324
 325 static inline struct vmw_master *vmw_master(struct drm_master *master)
 326 {
 327         return (struct vmw_master *) master->driver_priv;
 328 }
 329
 330 static inline void vmw_write(struct vmw_private *dev_priv,
 331                              unsigned int offset, uint32_t value)
 332 {
 333         outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
 334         outl(value, dev_priv->io_start + VMWGFX_VALUE_PORT);
 335 }
 336
 337 static inline uint32_t vmw_read(struct vmw_private *dev_priv,
 338                                 unsigned int offset)
 339 {
 340         uint32_t val;
 341
 342         outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
 343         val = inl(dev_priv->io_start + VMWGFX_VALUE_PORT);
 344         return val;
 345 }
 346
 347 int vmw_3d_resource_inc(struct vmw_private *dev_priv, bool unhide_svga);
 348 void vmw_3d_resource_dec(struct vmw_private *dev_priv, bool hide_svga);
 349
 350 /**
 351  * GMR utilities - vmwgfx_gmr.c
 352  */
 353
 354 extern int vmw_gmr_bind(struct vmw_private *dev_priv,
 355                         struct page *pages[],
 356                         unsigned long num_pages,
 357                         int gmr_id);
 358 extern void vmw_gmr_unbind(struct vmw_private *dev_priv, int gmr_id);
 359
 360 /**
 361  * Resource utilities - vmwgfx_resource.c
 362  */
 363
 364 extern struct vmw_resource *vmw_context_alloc(struct vmw_private *dev_priv);
 365 extern void vmw_resource_unreference(struct vmw_resource **p_res);
 366 extern struct vmw_resource *vmw_resource_reference(struct vmw_resource *res);
 367 extern int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
 368                                      struct drm_file *file_priv);
 369 extern int vmw_context_define_ioctl(struct drm_device *dev, void *data,
 370                                     struct drm_file *file_priv);
 371 extern int vmw_context_check(struct vmw_private *dev_priv,
 372                              struct ttm_object_file *tfile,
 373                              int id,
 374                              struct vmw_resource **p_res);
 375 extern void vmw_surface_res_free(struct vmw_resource *res);
 376 extern int vmw_surface_init(struct vmw_private *dev_priv,
 377                             struct vmw_surface *srf,
 378                             void (*res_free) (struct vmw_resource *res));
 379 extern int vmw_user_surface_lookup_handle(struct vmw_private *dev_priv,
 380                                           struct ttm_object_file *tfile,
 381                                           uint32_t handle,
 382                                           struct vmw_surface **out);
 383 extern int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
 384                                      struct drm_file *file_priv);
 385 extern int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
 386                                     struct drm_file *file_priv);
 387 extern int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
 388                                        struct drm_file *file_priv);
 389 extern int vmw_surface_check(struct vmw_private *dev_priv,
 390                              struct ttm_object_file *tfile,
 391                              uint32_t handle, int *id);
 392 extern void vmw_dmabuf_bo_free(struct ttm_buffer_object *bo);
 393 extern int vmw_dmabuf_init(struct vmw_private *dev_priv,
 394                            struct vmw_dma_buffer *vmw_bo,
 395                            size_t size, struct ttm_placement *placement,
 396                            bool interuptable,
 397                            void (*bo_free) (struct ttm_buffer_object *bo));
 398 extern int vmw_dmabuf_alloc_ioctl(struct drm_device *dev, void *data,
 399                                   struct drm_file *file_priv);
 400 extern int vmw_dmabuf_unref_ioctl(struct drm_device *dev, void *data,
 401                                   struct drm_file *file_priv);
 402 extern uint32_t vmw_dmabuf_validate_node(struct ttm_buffer_object *bo,
 403                                          uint32_t cur_validate_node);
 404 extern void vmw_dmabuf_validate_clear(struct ttm_buffer_object *bo);
 405 extern int vmw_user_dmabuf_lookup(struct ttm_object_file *tfile,
 406                                   uint32_t id, struct vmw_dma_buffer **out);
 407 extern int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
 408                                   struct drm_file *file_priv);
 409 extern int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
 410                                   struct drm_file *file_priv);
 411 extern int vmw_user_stream_lookup(struct vmw_private *dev_priv,
 412                                   struct ttm_object_file *tfile,
 413                                   uint32_t *inout_id,
 414                                   struct vmw_resource **out);
 415
 416 /**
 417  * DMA buffer helper routines - vmwgfx_dmabuf.c
 418  */
 419 extern int vmw_dmabuf_to_placement(struct vmw_private *vmw_priv,
 420                                    struct vmw_dma_buffer *bo,
 421                                    struct ttm_placement *placement,
 422                                    bool interruptible);
 423 extern int vmw_dmabuf_to_vram(struct vmw_private *dev_priv,
 424                               struct vmw_dma_buffer *buf,
 425                               bool pin, bool interruptible);
 426 extern int vmw_dmabuf_to_vram_or_gmr(struct vmw_private *dev_priv,
 427                                      struct vmw_dma_buffer *buf,
 428                                      bool pin, bool interruptible);
 429 extern int vmw_dmabuf_to_start_of_vram(struct vmw_private *vmw_priv,
 430                                        struct vmw_dma_buffer *bo,
 431                                        bool pin, bool interruptible);
 432 extern int vmw_dmabuf_unpin(struct vmw_private *vmw_priv,
 433                             struct vmw_dma_buffer *bo,
 434                             bool interruptible);
 435 extern void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *buf,
 436                                  SVGAGuestPtr *ptr);
 437 extern void vmw_bo_pin(struct ttm_buffer_object *bo, bool pin);
 438
 439 /**
 440  * Misc Ioctl functionality - vmwgfx_ioctl.c
 441  */
 442
 443 extern int vmw_getparam_ioctl(struct drm_device *dev, void *data,
 444                               struct drm_file *file_priv);
 445 extern int vmw_get_cap_3d_ioctl(struct drm_device *dev, void *data,
 446                                 struct drm_file *file_priv);
 447 extern int vmw_present_ioctl(struct drm_device *dev, void *data,
 448                              struct drm_file *file_priv);
 449 extern int vmw_present_readback_ioctl(struct drm_device *dev, void *data,
 450                                       struct drm_file *file_priv);
 451
 452 /**
 453  * Fifo utilities - vmwgfx_fifo.c
 454  */
 455
 456 extern int vmw_fifo_init(struct vmw_private *dev_priv,
 457                          struct vmw_fifo_state *fifo);
 458 extern void vmw_fifo_release(struct vmw_private *dev_priv,
 459                              struct vmw_fifo_state *fifo);
 460 extern void *vmw_fifo_reserve(struct vmw_private *dev_priv, uint32_t bytes);
 461 extern void vmw_fifo_commit(struct vmw_private *dev_priv, uint32_t bytes);
 462 extern int vmw_fifo_send_fence(struct vmw_private *dev_priv,
 463                                uint32_t *seqno);
 464 extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
 465 extern bool vmw_fifo_have_3d(struct vmw_private *dev_priv);
 466 extern bool vmw_fifo_have_pitchlock(struct vmw_private *dev_priv);
 467 extern int vmw_fifo_emit_dummy_query(struct vmw_private *dev_priv,
 468                                      uint32_t cid);
 469
 470 /**
 471  * TTM glue - vmwgfx_ttm_glue.c
 472  */
 473
 474 extern int vmw_ttm_global_init(struct vmw_private *dev_priv);
 475 extern void vmw_ttm_global_release(struct vmw_private *dev_priv);
 476 extern int vmw_mmap(struct file *filp, struct vm_area_struct *vma);
 477
 478 /**
 479  * TTM buffer object driver - vmwgfx_buffer.c
 480  */
 481
 482 extern struct ttm_placement vmw_vram_placement;
 483 extern struct ttm_placement vmw_vram_ne_placement;
 484 extern struct ttm_placement vmw_vram_sys_placement;
 485 extern struct ttm_placement vmw_vram_gmr_placement;
 486 extern struct ttm_placement vmw_vram_gmr_ne_placement;
 487 extern struct ttm_placement vmw_sys_placement;
 488 extern struct ttm_placement vmw_evictable_placement;
 489 extern struct ttm_bo_driver vmw_bo_driver;
 490 extern int vmw_dma_quiescent(struct drm_device *dev);
 491
 492 /**
 493  * Command submission - vmwgfx_execbuf.c
 494  */
 495
 496 extern int vmw_execbuf_ioctl(struct drm_device *dev, void *data,
 497                              struct drm_file *file_priv);
 498 extern int vmw_execbuf_process(struct drm_file *file_priv,
 499                                struct vmw_private *dev_priv,
 500                                void __user *user_commands,
 501                                void *kernel_commands,
 502                                uint32_t command_size,
 503                                uint64_t throttle_us,
 504                                struct drm_vmw_fence_rep __user
 505                                *user_fence_rep);
 506
 507 extern void
 508 vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv,
 509                               bool only_on_cid_match, uint32_t cid);
 510
 511 /**
 512  * IRQs and wating - vmwgfx_irq.c
 513  */
 514
 515 extern irqreturn_t vmw_irq_handler(DRM_IRQ_ARGS);
 516 extern int vmw_wait_seqno(struct vmw_private *dev_priv, bool lazy,
 517                              uint32_t seqno, bool interruptible,
 518                              unsigned long timeout);
 519 extern void vmw_irq_preinstall(struct drm_device *dev);
 520 extern int vmw_irq_postinstall(struct drm_device *dev);
 521 extern void vmw_irq_uninstall(struct drm_device *dev);
 522 extern bool vmw_seqno_passed(struct vmw_private *dev_priv,
 523                                 uint32_t seqno);
 524 extern int vmw_fallback_wait(struct vmw_private *dev_priv,
 525                              bool lazy,
 526                              bool fifo_idle,
 527                              uint32_t seqno,
 528                              bool interruptible,
 529                              unsigned long timeout);
 530 extern void vmw_update_seqno(struct vmw_private *dev_priv,
 531                                 struct vmw_fifo_state *fifo_state);
 532 extern void vmw_seqno_waiter_add(struct vmw_private *dev_priv);
 533 extern void vmw_seqno_waiter_remove(struct vmw_private *dev_priv);
 534
 535 /**
 536  * Rudimentary fence-like objects currently used only for throttling -
 537  * vmwgfx_marker.c
 538  */
 539
 540 extern void vmw_marker_queue_init(struct vmw_marker_queue *queue);
 541 extern void vmw_marker_queue_takedown(struct vmw_marker_queue *queue);
 542 extern int vmw_marker_push(struct vmw_marker_queue *queue,
 543                           uint32_t seqno);
 544 extern int vmw_marker_pull(struct vmw_marker_queue *queue,
 545                           uint32_t signaled_seqno);
 546 extern int vmw_wait_lag(struct vmw_private *dev_priv,
 547                         struct vmw_marker_queue *queue, uint32_t us);
 548
 549 /**
 550  * Kernel framebuffer - vmwgfx_fb.c
 551  */
 552
 553 int vmw_fb_init(struct vmw_private *vmw_priv);
 554 int vmw_fb_close(struct vmw_private *dev_priv);
 555 int vmw_fb_off(struct vmw_private *vmw_priv);
 556 int vmw_fb_on(struct vmw_private *vmw_priv);
 557
 558 /**
 559  * Kernel modesetting - vmwgfx_kms.c
 560  */
 561
 562 int vmw_kms_init(struct vmw_private *dev_priv);
 563 int vmw_kms_close(struct vmw_private *dev_priv);
 564 int vmw_kms_save_vga(struct vmw_private *vmw_priv);
 565 int vmw_kms_restore_vga(struct vmw_private *vmw_priv);
 566 int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
 567                                 struct drm_file *file_priv);
 568 void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv);
 569 void vmw_kms_cursor_snoop(struct vmw_surface *srf,
 570                           struct ttm_object_file *tfile,
 571                           struct ttm_buffer_object *bo,
 572                           SVGA3dCmdHeader *header);
 573 int vmw_kms_write_svga(struct vmw_private *vmw_priv,
 574                        unsigned width, unsigned height, unsigned pitch,
 575                        unsigned bpp, unsigned depth);
 576 void vmw_kms_idle_workqueues(struct vmw_master *vmaster);
 577 bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
 578                                 uint32_t pitch,
 579                                 uint32_t height);
 580 u32 vmw_get_vblank_counter(struct drm_device *dev, int crtc);
 581 int vmw_kms_present(struct vmw_private *dev_priv,
 582                     struct drm_file *file_priv,
 583                     struct vmw_framebuffer *vfb,
 584                     struct vmw_surface *surface,
 585                     uint32_t sid, int32_t destX, int32_t destY,
 586                     struct drm_vmw_rect *clips,
 587                     uint32_t num_clips);
 588 int vmw_kms_readback(struct vmw_private *dev_priv,
 589                      struct drm_file *file_priv,
 590                      struct vmw_framebuffer *vfb,
 591                      struct drm_vmw_fence_rep __user *user_fence_rep,
 592                      struct drm_vmw_rect *clips,
 593                      uint32_t num_clips);
 594
 595 /**
 596  * Overlay control - vmwgfx_overlay.c
 597  */
 598
 599 int vmw_overlay_init(struct vmw_private *dev_priv);
 600 int vmw_overlay_close(struct vmw_private *dev_priv);
 601 int vmw_overlay_ioctl(struct drm_device *dev, void *data,
 602                       struct drm_file *file_priv);
 603 int vmw_overlay_stop_all(struct vmw_private *dev_priv);
 604 int vmw_overlay_resume_all(struct vmw_private *dev_priv);
 605 int vmw_overlay_pause_all(struct vmw_private *dev_priv);
 606 int vmw_overlay_claim(struct vmw_private *dev_priv, uint32_t *out);
 607 int vmw_overlay_unref(struct vmw_private *dev_priv, uint32_t stream_id);
 608 int vmw_overlay_num_overlays(struct vmw_private *dev_priv);
 609 int vmw_overlay_num_free_overlays(struct vmw_private *dev_priv);
 610
 611 /**
 612  * GMR Id manager
 613  */
 614
 615 extern const struct ttm_mem_type_manager_func vmw_gmrid_manager_func;
 616
 617 /**
 618  * Inline helper functions
 619  */
 620
 621 static inline void vmw_surface_unreference(struct vmw_surface **srf)
 622 {
 623         struct vmw_surface *tmp_srf = *srf;
 624         struct vmw_resource *res = &tmp_srf->res;
 625         *srf = NULL;
 626
 627         vmw_resource_unreference(&res);
 628 }
 629
 630 static inline struct vmw_surface *vmw_surface_reference(struct vmw_surface *srf)
 631 {
 632         (void) vmw_resource_reference(&srf->res);
 633         return srf;
 634 }
 635
 636 static inline void vmw_dmabuf_unreference(struct vmw_dma_buffer **buf)
 637 {
 638         struct vmw_dma_buffer *tmp_buf = *buf;
 639         struct ttm_buffer_object *bo = &tmp_buf->base;
 640         *buf = NULL;
 641
 642         ttm_bo_unref(&bo);
 643 }
 644
 645 static inline struct vmw_dma_buffer *vmw_dmabuf_reference(struct vmw_dma_buffer *buf)
 646 {
 647         if (ttm_bo_reference(&buf->base))
 648                 return buf;
 649         return NULL;
 650 }
 651
 652 static inline struct ttm_mem_global *vmw_mem_glob(struct vmw_private *dev_priv)
 653 {
 654         return (struct ttm_mem_global *) dev_priv->mem_global_ref.object;
 655 }
 656 #endif