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