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