[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"

#define VMWGFX_DRIVER_DATE "20100927"
#define VMWGFX_DRIVER_MAJOR 1
#define VMWGFX_DRIVER_MINOR 4
#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
#define VMWGFX_MAX_DISPLAYS 16

#define VMW_PL_GMR TTM_PL_PRIV0
#define VMW_PL_FLAG_GMR TTM_PL_FLAG_PRIV0

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

	/* 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_fence_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;
	__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_fence_queue fence_queue;
};

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 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;
	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 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;
	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);
void vmw_3d_resource_dec(struct vmw_private *dev_priv);

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

/**
 * 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);
extern void vmw_update_sequence(struct vmw_private *dev_priv,
				struct vmw_fifo_state *fifo_state);


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

extern void vmw_fence_queue_init(struct vmw_fence_queue *queue);
extern void vmw_fence_queue_takedown(struct vmw_fence_queue *queue);
extern int vmw_fence_push(struct vmw_fence_queue *queue,
			  uint32_t sequence);
extern int vmw_fence_pull(struct vmw_fence_queue *queue,
			  uint32_t signaled_sequence);
extern int vmw_wait_lag(struct vmw_private *dev_priv,
			struct vmw_fence_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);
void vmw_kms_write_svga(struct vmw_private *vmw_priv,
			unsigned width, unsigned height, unsigned pitch,
			unsigned bpp, unsigned depth);
int vmw_kms_update_layout_ioctl(struct drm_device *dev, void *data,
				struct drm_file *file_priv);
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;
}

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