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