[deliverable/linux.git] / drivers / gpu / drm / vmwgfx / vmwgfx_drv.h

/**************************************************************************
 *
 * 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"
#include "vmwgfx_fence.h"

#define VMWGFX_DRIVER_DATE "20110901"
#define VMWGFX_DRIVER_MAJOR 2
#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_VALIDATIONS 2048
#define VMWGFX_MAX_DISPLAYS 16
#define VMWGFX_CMD_BOUNCE_INIT_SIZE 32768

#define VMW_PL_GMR TTM_PL_PRIV0
#define VMW_PL_FLAG_GMR TTM_PL_FLAG_PRIV0

#define VMW_RES_CONTEXT ttm_driver_type0
#define VMW_RES_SURFACE ttm_driver_type1
#define VMW_RES_STREAM ttm_driver_type2
#define VMW_RES_FENCE ttm_driver_type3

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;
	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);
	bool on_validate_list;
	/* 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_marker_queue {
	struct list_head head;
	struct timespec lag;
	struct timespec lag_time;
	spinlock_t lock;
};

struct vmw_fifo_state {
	unsigned long reserved_size;
	__le32 *dynamic_buffer;
	__le32 *static_buffer;
	unsigned long static_buffer_size;
	bool using_bounce_buffer;
	uint32_t capabilities;
	struct mutex fifo_mutex;
	struct rw_semaphore rwsem;
	struct vmw_marker_queue marker_queue;
};

struct vmw_relocation {
	SVGAGuestPtr *location;
	uint32_t index;
};

struct vmw_sw_context{
	struct ida bo_list;
	uint32_t last_cid;
	bool cid_valid;
	bool kernel; /**< is the called made from the kernel */
	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_VALIDATIONS];
	uint32_t cur_val_buf;
	uint32_t *cmd_bounce;
	uint32_t cmd_bounce_size;
	struct vmw_resource *resources[VMWGFX_MAX_VALIDATIONS];
	uint32_t num_ref_resources;
};

struct vmw_legacy_display;
struct vmw_overlay;

struct vmw_master {
	struct ttm_lock lock;
	struct mutex fb_surf_mutex;
	struct list_head fb_surf;
};

struct vmw_vga_topology_state {
	uint32_t width;
	uint32_t height;
	uint32_t primary;
	uint32_t pos_x;
	uint32_t pos_y;
};

struct vmw_private {
	struct ttm_bo_device bdev;
	struct ttm_bo_global_ref bo_global_ref;
	struct drm_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;
	uint32_t max_gmr_pages;
	uint32_t memory_size;
	bool has_gmr;
	struct mutex hw_mutex;

	/*
	 * VGA registers.
	 */

	struct vmw_vga_topology_state vga_save[VMWGFX_MAX_DISPLAYS];
	uint32_t vga_width;
	uint32_t vga_height;
	uint32_t vga_bpp;
	uint32_t vga_bpl;
	uint32_t vga_pitchlock;

	uint32_t num_displays;

	/*
	 * 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 marker_seq;
	wait_queue_head_t fence_queue;
	wait_queue_head_t fifo_queue;
	int fence_queue_waiters; /* Protected by hw_mutex */
	atomic_t fifo_queue_waiters;
	uint32_t last_read_seqno;
	spinlock_t irq_lock;
	struct vmw_fence_manager *fman;

	/*
	 * 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;
	struct mutex cmdbuf_mutex;

	/**
	 * Operating mode.
	 */

	bool stealth;
	bool is_opened;
	bool enable_fb;

	/**
	 * Master management.
	 */

	struct vmw_master *active_master;
	struct vmw_master fbdev_master;
	struct notifier_block pm_nb;
	bool suspended;

	struct mutex release_mutex;
	uint32_t num_3d_resources;
};

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;
}

int vmw_3d_resource_inc(struct vmw_private *dev_priv, bool unhide_svga);
void vmw_3d_resource_dec(struct vmw_private *dev_priv, bool hide_svga);

/**
 * GMR utilities - vmwgfx_gmr.c
 */

extern int vmw_gmr_bind(struct vmw_private *dev_priv,
			struct page *pages[],
			unsigned long num_pages,
			int gmr_id);
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,
			     struct vmw_resource **p_res);
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 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 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_get_cap_3d_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 *seqno);
extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
extern bool vmw_fifo_have_3d(struct vmw_private *dev_priv);
extern bool vmw_fifo_have_pitchlock(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_vram_gmr_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);
extern int vmw_execbuf_process(struct drm_file *file_priv,
			       struct vmw_private *dev_priv,
			       void __user *user_commands,
			       void *kernel_commands,
			       uint32_t command_size,
			       uint64_t throttle_us,
			       struct drm_vmw_fence_rep __user
			       *user_fence_rep);

/**
 * IRQs and wating - vmwgfx_irq.c
 */

extern irqreturn_t vmw_irq_handler(DRM_IRQ_ARGS);
extern int vmw_wait_seqno(struct vmw_private *dev_priv, bool lazy,
			     uint32_t seqno, 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_seqno_passed(struct vmw_private *dev_priv,
				uint32_t seqno);
extern int vmw_fallback_wait(struct vmw_private *dev_priv,
			     bool lazy,
			     bool fifo_idle,
			     uint32_t seqno,
			     bool interruptible,
			     unsigned long timeout);
extern void vmw_update_seqno(struct vmw_private *dev_priv,
				struct vmw_fifo_state *fifo_state);
extern void vmw_seqno_waiter_add(struct vmw_private *dev_priv);
extern void vmw_seqno_waiter_remove(struct vmw_private *dev_priv);

/**
 * Rudimentary fence-like objects currently used only for throttling -
 * vmwgfx_marker.c
 */

extern void vmw_marker_queue_init(struct vmw_marker_queue *queue);
extern void vmw_marker_queue_takedown(struct vmw_marker_queue *queue);
extern int vmw_marker_push(struct vmw_marker_queue *queue,
			  uint32_t seqno);
extern int vmw_marker_pull(struct vmw_marker_queue *queue,
			  uint32_t signaled_seqno);
extern int vmw_wait_lag(struct vmw_private *dev_priv,
			struct vmw_marker_queue *queue, uint32_t us);

/**
 * 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);
int vmw_kms_write_svga(struct vmw_private *vmw_priv,
		       unsigned width, unsigned height, unsigned pitch,
		       unsigned bpp, unsigned depth);
void vmw_kms_idle_workqueues(struct vmw_master *vmaster);
bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
				uint32_t pitch,
				uint32_t height);
u32 vmw_get_vblank_counter(struct drm_device *dev, int crtc);

/**
 * 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);

/**
 * GMR Id manager
 */

extern const struct ttm_mem_type_manager_func vmw_gmrid_manager_func;

/**
 * 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;
}

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