[go: nahoru, domu]

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