text: /**************************************************************************
   *
   * Copyright © 2009 VMware, Inc., Palo Alto, CA., USA
   * All Rights Reserved.
   *
   * Permission is hereby granted, free of charge, to any person obtaining a
   * copy of this software and associated documentation files (the
   * "Software"), to deal in the Software without restriction, including
   * without limitation the rights to use, copy, modify, merge, publish,
   * distribute, sub license, and/or sell copies of the Software, and to
   * permit persons to whom the Software is furnished to do so, subject to
   * the following conditions:
   *
   * The above copyright notice and this permission notice (including the
   * next paragraph) shall be included in all copies or substantial portions
   * of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
   * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
   * USE OR OTHER DEALINGS IN THE SOFTWARE.
   *
   **************************************************************************/
  
  #ifndef _VMWGFX_DRV_H_
  #define _VMWGFX_DRV_H_
  
  #include "vmwgfx_reg.h"
  #include "drmP.h"
  #include "vmwgfx_drm.h"
  #include "drm_hashtab.h"
  #include "linux/suspend.h"
  #include "ttm/ttm_bo_driver.h"
  #include "ttm/ttm_object.h"
  #include "ttm/ttm_lock.h"
  #include "ttm/ttm_execbuf_util.h"
  #include "ttm/ttm_module.h"
  
  #define VMWGFX_DRIVER_DATE "20100209"
  #define VMWGFX_DRIVER_MAJOR 1
  #define VMWGFX_DRIVER_MINOR 0
  #define VMWGFX_DRIVER_PATCHLEVEL 0
  #define VMWGFX_FILE_PAGE_OFFSET 0x00100000
  #define VMWGFX_FIFO_STATIC_SIZE (1024*1024)
  #define VMWGFX_MAX_RELOCATIONS 2048
  #define VMWGFX_MAX_GMRS 2048
  
  struct vmw_fpriv {
  	struct drm_master *locked_master;
  	struct ttm_object_file *tfile;
  };
  
  struct vmw_dma_buffer {
  	struct ttm_buffer_object base;
  	struct list_head validate_list;
  	struct list_head gmr_lru;
  	uint32_t gmr_id;
  	bool gmr_bound;
  	uint32_t cur_validate_node;
  	bool on_validate_list;
  };
  
  struct vmw_resource {
  	struct kref kref;
  	struct vmw_private *dev_priv;
  	struct idr *idr;
  	int id;
  	enum ttm_object_type res_type;
  	bool avail;
  	void (*hw_destroy) (struct vmw_resource *res);
  	void (*res_free) (struct vmw_resource *res);
  
  	/* TODO is a generic snooper needed? */
  #if 0
  	void (*snoop)(struct vmw_resource *res,
  		      struct ttm_object_file *tfile,
  		      SVGA3dCmdHeader *header);
  	void *snoop_priv;
  #endif
  };
  
  struct vmw_cursor_snooper {
  	struct drm_crtc *crtc;
  	size_t age;
  	uint32_t *image;
  };
  
  struct vmw_surface {
  	struct vmw_resource res;
  	uint32_t flags;
  	uint32_t format;
  	uint32_t mip_levels[DRM_VMW_MAX_SURFACE_FACES];
  	struct drm_vmw_size *sizes;
  	uint32_t num_sizes;
  
  	bool scanout;
  
  	/* TODO so far just a extra pointer */
  	struct vmw_cursor_snooper snooper;
  };
  
  struct vmw_fifo_state {
  	unsigned long reserved_size;
  	__le32 *dynamic_buffer;
  	__le32 *static_buffer;
  	__le32 *last_buffer;
  	uint32_t last_data_size;
  	uint32_t last_buffer_size;
  	bool last_buffer_add;
  	unsigned long static_buffer_size;
  	bool using_bounce_buffer;
  	uint32_t capabilities;
  	struct mutex fifo_mutex;
  	struct rw_semaphore rwsem;
  };
  
  struct vmw_relocation {
  	SVGAGuestPtr *location;
  	uint32_t index;
  };
  
  struct vmw_sw_context{
  	struct ida bo_list;
  	uint32_t last_cid;
  	bool cid_valid;
  	uint32_t last_sid;
  	uint32_t sid_translation;
  	bool sid_valid;
  	struct ttm_object_file *tfile;
  	struct list_head validate_nodes;
  	struct vmw_relocation relocs[VMWGFX_MAX_RELOCATIONS];
  	uint32_t cur_reloc;
  	struct ttm_validate_buffer val_bufs[VMWGFX_MAX_GMRS];
  	uint32_t cur_val_buf;
  };
  
  struct vmw_legacy_display;
  struct vmw_overlay;
  
  struct vmw_master {
  	struct ttm_lock lock;
  };
  
  struct vmw_private {
  	struct ttm_bo_device bdev;
  	struct ttm_bo_global_ref bo_global_ref;
  	struct ttm_global_reference mem_global_ref;
  
  	struct vmw_fifo_state fifo;
  
  	struct drm_device *dev;
  	unsigned long vmw_chipset;
  	unsigned int io_start;
  	uint32_t vram_start;
  	uint32_t vram_size;
  	uint32_t mmio_start;
  	uint32_t mmio_size;
  	uint32_t fb_max_width;
  	uint32_t fb_max_height;
  	__le32 __iomem *mmio_virt;
  	int mmio_mtrr;
  	uint32_t capabilities;
  	uint32_t max_gmr_descriptors;
  	uint32_t max_gmr_ids;
  	struct mutex hw_mutex;
  
  	/*
  	 * VGA registers.
  	 */
  
  	uint32_t vga_width;
  	uint32_t vga_height;
  	uint32_t vga_depth;
  	uint32_t vga_bpp;
  	uint32_t vga_pseudo;
  	uint32_t vga_red_mask;
  	uint32_t vga_blue_mask;
  	uint32_t vga_green_mask;
  
  	/*
  	 * Framebuffer info.
  	 */
  
  	void *fb_info;
  	struct vmw_legacy_display *ldu_priv;
  	struct vmw_overlay *overlay_priv;
  
  	/*
  	 * Context and surface management.
  	 */
  
  	rwlock_t resource_lock;
  	struct idr context_idr;
  	struct idr surface_idr;
  	struct idr stream_idr;
  
  	/*
  	 * Block lastclose from racing with firstopen.
  	 */
  
  	struct mutex init_mutex;
  
  	/*
  	 * A resource manager for kernel-only surfaces and
  	 * contexts.
  	 */
  
  	struct ttm_object_device *tdev;
  
  	/*
  	 * Fencing and IRQs.
  	 */
  
  	atomic_t fence_seq;
  	wait_queue_head_t fence_queue;
  	wait_queue_head_t fifo_queue;
  	atomic_t fence_queue_waiters;
  	atomic_t fifo_queue_waiters;
  	uint32_t last_read_sequence;
  	spinlock_t irq_lock;
  
  	/*
  	 * Device state
  	 */
  
  	uint32_t traces_state;
  	uint32_t enable_state;
  	uint32_t config_done_state;
  
  	/**
  	 * Execbuf
  	 */
  	/**
  	 * Protected by the cmdbuf mutex.
  	 */
  
  	struct vmw_sw_context ctx;
  	uint32_t val_seq;
  	struct mutex cmdbuf_mutex;
  
  	/**
  	 * GMR management. Protected by the lru spinlock.
  	 */
  
  	struct ida gmr_ida;
  	struct list_head gmr_lru;
  
  
  	/**
  	 * Operating mode.
  	 */
  
  	bool stealth;
  	bool is_opened;
  
  	/**
  	 * Master management.
  	 */
  
  	struct vmw_master *active_master;
  	struct vmw_master fbdev_master;
  	struct notifier_block pm_nb;
  };
  
  static inline struct vmw_private *vmw_priv(struct drm_device *dev)
  {
  	return (struct vmw_private *)dev->dev_private;
  }
  
  static inline struct vmw_fpriv *vmw_fpriv(struct drm_file *file_priv)
  {
  	return (struct vmw_fpriv *)file_priv->driver_priv;
  }
  
  static inline struct vmw_master *vmw_master(struct drm_master *master)
  {
  	return (struct vmw_master *) master->driver_priv;
  }
  
  static inline void vmw_write(struct vmw_private *dev_priv,
  			     unsigned int offset, uint32_t value)
  {
  	outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
  	outl(value, dev_priv->io_start + VMWGFX_VALUE_PORT);
  }
  
  static inline uint32_t vmw_read(struct vmw_private *dev_priv,
  				unsigned int offset)
  {
  	uint32_t val;
  
  	outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
  	val = inl(dev_priv->io_start + VMWGFX_VALUE_PORT);
  	return val;
  }
  
  /**
   * GMR utilities - vmwgfx_gmr.c
   */
  
  extern int vmw_gmr_bind(struct vmw_private *dev_priv,
  			struct ttm_buffer_object *bo);
  extern void vmw_gmr_unbind(struct vmw_private *dev_priv, int gmr_id);
  
  /**
   * Resource utilities - vmwgfx_resource.c
   */
  
  extern struct vmw_resource *vmw_context_alloc(struct vmw_private *dev_priv);
  extern void vmw_resource_unreference(struct vmw_resource **p_res);
  extern struct vmw_resource *vmw_resource_reference(struct vmw_resource *res);
  extern int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
  				     struct drm_file *file_priv);
  extern int vmw_context_define_ioctl(struct drm_device *dev, void *data,
  				    struct drm_file *file_priv);
  extern int vmw_context_check(struct vmw_private *dev_priv,
  			     struct ttm_object_file *tfile,
  			     int id);
  extern void vmw_surface_res_free(struct vmw_resource *res);
  extern int vmw_surface_init(struct vmw_private *dev_priv,
  			    struct vmw_surface *srf,
  			    void (*res_free) (struct vmw_resource *res));
  extern int vmw_user_surface_lookup_handle(struct vmw_private *dev_priv,
  					  struct ttm_object_file *tfile,
  					  uint32_t handle,
  					  struct vmw_surface **out);
  extern int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
  				     struct drm_file *file_priv);
  extern int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
  				    struct drm_file *file_priv);
  extern int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
  				       struct drm_file *file_priv);
  extern int vmw_surface_check(struct vmw_private *dev_priv,
  			     struct ttm_object_file *tfile,
  			     uint32_t handle, int *id);
  extern void vmw_dmabuf_bo_free(struct ttm_buffer_object *bo);
  extern int vmw_dmabuf_init(struct vmw_private *dev_priv,
  			   struct vmw_dma_buffer *vmw_bo,
  			   size_t size, struct ttm_placement *placement,
  			   bool interuptable,
  			   void (*bo_free) (struct ttm_buffer_object *bo));
  extern int vmw_dmabuf_alloc_ioctl(struct drm_device *dev, void *data,
  				  struct drm_file *file_priv);
  extern int vmw_dmabuf_unref_ioctl(struct drm_device *dev, void *data,
  				  struct drm_file *file_priv);
  extern uint32_t vmw_dmabuf_validate_node(struct ttm_buffer_object *bo,
  					 uint32_t cur_validate_node);
  extern void vmw_dmabuf_validate_clear(struct ttm_buffer_object *bo);
  extern int vmw_user_dmabuf_lookup(struct ttm_object_file *tfile,
  				  uint32_t id, struct vmw_dma_buffer **out);
  extern uint32_t vmw_dmabuf_gmr(struct ttm_buffer_object *bo);
  extern void vmw_dmabuf_set_gmr(struct ttm_buffer_object *bo, uint32_t id);
  extern int vmw_gmr_id_alloc(struct vmw_private *dev_priv, uint32_t *p_id);
  extern int vmw_dmabuf_to_start_of_vram(struct vmw_private *vmw_priv,
  				       struct vmw_dma_buffer *bo);
  extern int vmw_dmabuf_from_vram(struct vmw_private *vmw_priv,
  				struct vmw_dma_buffer *bo);
  extern void vmw_dmabuf_gmr_unbind(struct ttm_buffer_object *bo);
  extern int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
  				  struct drm_file *file_priv);
  extern int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
  				  struct drm_file *file_priv);
  extern int vmw_user_stream_lookup(struct vmw_private *dev_priv,
  				  struct ttm_object_file *tfile,
  				  uint32_t *inout_id,
  				  struct vmw_resource **out);
  
  
  /**
   * Misc Ioctl functionality - vmwgfx_ioctl.c
   */
  
  extern int vmw_getparam_ioctl(struct drm_device *dev, void *data,
  			      struct drm_file *file_priv);
  extern int vmw_fifo_debug_ioctl(struct drm_device *dev, void *data,
  				struct drm_file *file_priv);
  
  /**
   * Fifo utilities - vmwgfx_fifo.c
   */
  
  extern int vmw_fifo_init(struct vmw_private *dev_priv,
  			 struct vmw_fifo_state *fifo);
  extern void vmw_fifo_release(struct vmw_private *dev_priv,
  			     struct vmw_fifo_state *fifo);
  extern void *vmw_fifo_reserve(struct vmw_private *dev_priv, uint32_t bytes);
  extern void vmw_fifo_commit(struct vmw_private *dev_priv, uint32_t bytes);
  extern int vmw_fifo_send_fence(struct vmw_private *dev_priv,
  			       uint32_t *sequence);
  extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
  extern int vmw_fifo_mmap(struct file *filp, struct vm_area_struct *vma);
  extern bool vmw_fifo_have_3d(struct vmw_private *dev_priv);
  
  /**
   * TTM glue - vmwgfx_ttm_glue.c
   */
  
  extern int vmw_ttm_global_init(struct vmw_private *dev_priv);
  extern void vmw_ttm_global_release(struct vmw_private *dev_priv);
  extern int vmw_mmap(struct file *filp, struct vm_area_struct *vma);
  
  /**
   * TTM buffer object driver - vmwgfx_buffer.c
   */
  
  extern struct ttm_placement vmw_vram_placement;
  extern struct ttm_placement vmw_vram_ne_placement;
  extern struct ttm_placement vmw_vram_sys_placement;
  extern struct ttm_placement vmw_sys_placement;
  extern struct ttm_bo_driver vmw_bo_driver;
  extern int vmw_dma_quiescent(struct drm_device *dev);
  
  /**
   * Command submission - vmwgfx_execbuf.c
   */
  
  extern int vmw_execbuf_ioctl(struct drm_device *dev, void *data,
  			     struct drm_file *file_priv);
  
  /**
   * IRQs and wating - vmwgfx_irq.c
   */
  
  extern irqreturn_t vmw_irq_handler(DRM_IRQ_ARGS);
  extern int vmw_wait_fence(struct vmw_private *dev_priv, bool lazy,
  			  uint32_t sequence, bool interruptible,
  			  unsigned long timeout);
  extern void vmw_irq_preinstall(struct drm_device *dev);
  extern int vmw_irq_postinstall(struct drm_device *dev);
  extern void vmw_irq_uninstall(struct drm_device *dev);
  extern bool vmw_fence_signaled(struct vmw_private *dev_priv,
  			       uint32_t sequence);
  extern int vmw_fence_wait_ioctl(struct drm_device *dev, void *data,
  				struct drm_file *file_priv);
  extern int vmw_fallback_wait(struct vmw_private *dev_priv,
  			     bool lazy,
  			     bool fifo_idle,
  			     uint32_t sequence,
  			     bool interruptible,
  			     unsigned long timeout);
  
  /**
   * Kernel framebuffer - vmwgfx_fb.c
   */
  
  int vmw_fb_init(struct vmw_private *vmw_priv);
  int vmw_fb_close(struct vmw_private *dev_priv);
  int vmw_fb_off(struct vmw_private *vmw_priv);
  int vmw_fb_on(struct vmw_private *vmw_priv);
  
  /**
   * Kernel modesetting - vmwgfx_kms.c
   */
  
  int vmw_kms_init(struct vmw_private *dev_priv);
  int vmw_kms_close(struct vmw_private *dev_priv);
  int vmw_kms_save_vga(struct vmw_private *vmw_priv);
  int vmw_kms_restore_vga(struct vmw_private *vmw_priv);
  int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
  				struct drm_file *file_priv);
  void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv);
  void vmw_kms_cursor_snoop(struct vmw_surface *srf,
  			  struct ttm_object_file *tfile,
  			  struct ttm_buffer_object *bo,
  			  SVGA3dCmdHeader *header);
  
  /**
   * Overlay control - vmwgfx_overlay.c
   */
  
  int vmw_overlay_init(struct vmw_private *dev_priv);
  int vmw_overlay_close(struct vmw_private *dev_priv);
  int vmw_overlay_ioctl(struct drm_device *dev, void *data,
  		      struct drm_file *file_priv);
  int vmw_overlay_stop_all(struct vmw_private *dev_priv);
  int vmw_overlay_resume_all(struct vmw_private *dev_priv);
  int vmw_overlay_pause_all(struct vmw_private *dev_priv);
  int vmw_overlay_claim(struct vmw_private *dev_priv, uint32_t *out);
  int vmw_overlay_unref(struct vmw_private *dev_priv, uint32_t stream_id);
  int vmw_overlay_num_overlays(struct vmw_private *dev_priv);
  int vmw_overlay_num_free_overlays(struct vmw_private *dev_priv);
  
  /**
   * Inline helper functions
   */
  
  static inline void vmw_surface_unreference(struct vmw_surface **srf)
  {
  	struct vmw_surface *tmp_srf = *srf;
  	struct vmw_resource *res = &tmp_srf->res;
  	*srf = NULL;
  
  	vmw_resource_unreference(&res);
  }
  
  static inline struct vmw_surface *vmw_surface_reference(struct vmw_surface *srf)
  {
  	(void) vmw_resource_reference(&srf->res);
  	return srf;
  }
  
  static inline void vmw_dmabuf_unreference(struct vmw_dma_buffer **buf)
  {
  	struct vmw_dma_buffer *tmp_buf = *buf;
  	struct ttm_buffer_object *bo = &tmp_buf->base;
  	*buf = NULL;
  
  	ttm_bo_unref(&bo);
  }
  
  static inline struct vmw_dma_buffer *vmw_dmabuf_reference(struct vmw_dma_buffer *buf)
  {
  	if (ttm_bo_reference(&buf->base))
  		return buf;
  	return NULL;
  }
  
  #endif
  