xref: /linux/drivers/gpu/drm/vmwgfx/vmwgfx_drv.h (revision 0883c2c06fb5bcf5b9e008270827e63c09a88c1e)
1 /**************************************************************************
2  *
3  * Copyright © 2009-2015 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 "20160210"
44 #define VMWGFX_DRIVER_MAJOR 2
45 #define VMWGFX_DRIVER_MINOR 10
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 1
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_DXCONTEXT 256
63 #define VMWGFX_NUM_DXQUERY 512
64 #define VMWGFX_NUM_MOB (VMWGFX_NUM_GB_CONTEXT +\
65 			VMWGFX_NUM_GB_SHADER +\
66 			VMWGFX_NUM_GB_SURFACE +\
67 			VMWGFX_NUM_GB_SCREEN_TARGET)
68 
69 #define VMW_PL_GMR TTM_PL_PRIV0
70 #define VMW_PL_FLAG_GMR TTM_PL_FLAG_PRIV0
71 #define VMW_PL_MOB TTM_PL_PRIV1
72 #define VMW_PL_FLAG_MOB TTM_PL_FLAG_PRIV1
73 
74 #define VMW_RES_CONTEXT ttm_driver_type0
75 #define VMW_RES_SURFACE ttm_driver_type1
76 #define VMW_RES_STREAM ttm_driver_type2
77 #define VMW_RES_FENCE ttm_driver_type3
78 #define VMW_RES_SHADER ttm_driver_type4
79 
80 struct vmw_fpriv {
81 	struct drm_master *locked_master;
82 	struct ttm_object_file *tfile;
83 	bool gb_aware;
84 };
85 
86 struct vmw_dma_buffer {
87 	struct ttm_buffer_object base;
88 	struct list_head res_list;
89 	s32 pin_count;
90 	/* Not ref-counted.  Protected by binding_mutex */
91 	struct vmw_resource *dx_query_ctx;
92 };
93 
94 /**
95  * struct vmw_validate_buffer - Carries validation info about buffers.
96  *
97  * @base: Validation info for TTM.
98  * @hash: Hash entry for quick lookup of the TTM buffer object.
99  *
100  * This structure contains also driver private validation info
101  * on top of the info needed by TTM.
102  */
103 struct vmw_validate_buffer {
104 	struct ttm_validate_buffer base;
105 	struct drm_hash_item hash;
106 	bool validate_as_mob;
107 };
108 
109 struct vmw_res_func;
110 struct vmw_resource {
111 	struct kref kref;
112 	struct vmw_private *dev_priv;
113 	int id;
114 	bool avail;
115 	unsigned long backup_size;
116 	bool res_dirty; /* Protected by backup buffer reserved */
117 	bool backup_dirty; /* Protected by backup buffer reserved */
118 	struct vmw_dma_buffer *backup;
119 	unsigned long backup_offset;
120 	unsigned long pin_count; /* Protected by resource reserved */
121 	const struct vmw_res_func *func;
122 	struct list_head lru_head; /* Protected by the resource lock */
123 	struct list_head mob_head; /* Protected by @backup reserved */
124 	struct list_head binding_head; /* Protected by binding_mutex */
125 	void (*res_free) (struct vmw_resource *res);
126 	void (*hw_destroy) (struct vmw_resource *res);
127 };
128 
129 
130 /*
131  * Resources that are managed using ioctls.
132  */
133 enum vmw_res_type {
134 	vmw_res_context,
135 	vmw_res_surface,
136 	vmw_res_stream,
137 	vmw_res_shader,
138 	vmw_res_dx_context,
139 	vmw_res_cotable,
140 	vmw_res_view,
141 	vmw_res_max
142 };
143 
144 /*
145  * Resources that are managed using command streams.
146  */
147 enum vmw_cmdbuf_res_type {
148 	vmw_cmdbuf_res_shader,
149 	vmw_cmdbuf_res_view
150 };
151 
152 struct vmw_cmdbuf_res_manager;
153 
154 struct vmw_cursor_snooper {
155 	struct drm_crtc *crtc;
156 	size_t age;
157 	uint32_t *image;
158 };
159 
160 struct vmw_framebuffer;
161 struct vmw_surface_offset;
162 
163 struct vmw_surface {
164 	struct vmw_resource res;
165 	uint32_t flags;
166 	uint32_t format;
167 	uint32_t mip_levels[DRM_VMW_MAX_SURFACE_FACES];
168 	struct drm_vmw_size base_size;
169 	struct drm_vmw_size *sizes;
170 	uint32_t num_sizes;
171 	bool scanout;
172 	uint32_t array_size;
173 	/* TODO so far just a extra pointer */
174 	struct vmw_cursor_snooper snooper;
175 	struct vmw_surface_offset *offsets;
176 	SVGA3dTextureFilter autogen_filter;
177 	uint32_t multisample_count;
178 	struct list_head view_list;
179 };
180 
181 struct vmw_marker_queue {
182 	struct list_head head;
183 	u64 lag;
184 	u64 lag_time;
185 	spinlock_t lock;
186 };
187 
188 struct vmw_fifo_state {
189 	unsigned long reserved_size;
190 	u32 *dynamic_buffer;
191 	u32 *static_buffer;
192 	unsigned long static_buffer_size;
193 	bool using_bounce_buffer;
194 	uint32_t capabilities;
195 	struct mutex fifo_mutex;
196 	struct rw_semaphore rwsem;
197 	struct vmw_marker_queue marker_queue;
198 	bool dx;
199 };
200 
201 struct vmw_relocation {
202 	SVGAMobId *mob_loc;
203 	SVGAGuestPtr *location;
204 	uint32_t index;
205 };
206 
207 /**
208  * struct vmw_res_cache_entry - resource information cache entry
209  *
210  * @valid: Whether the entry is valid, which also implies that the execbuf
211  * code holds a reference to the resource, and it's placed on the
212  * validation list.
213  * @handle: User-space handle of a resource.
214  * @res: Non-ref-counted pointer to the resource.
215  *
216  * Used to avoid frequent repeated user-space handle lookups of the
217  * same resource.
218  */
219 struct vmw_res_cache_entry {
220 	bool valid;
221 	uint32_t handle;
222 	struct vmw_resource *res;
223 	struct vmw_resource_val_node *node;
224 };
225 
226 /**
227  * enum vmw_dma_map_mode - indicate how to perform TTM page dma mappings.
228  */
229 enum vmw_dma_map_mode {
230 	vmw_dma_phys,           /* Use physical page addresses */
231 	vmw_dma_alloc_coherent, /* Use TTM coherent pages */
232 	vmw_dma_map_populate,   /* Unmap from DMA just after unpopulate */
233 	vmw_dma_map_bind,       /* Unmap from DMA just before unbind */
234 	vmw_dma_map_max
235 };
236 
237 /**
238  * struct vmw_sg_table - Scatter/gather table for binding, with additional
239  * device-specific information.
240  *
241  * @sgt: Pointer to a struct sg_table with binding information
242  * @num_regions: Number of regions with device-address contiguous pages
243  */
244 struct vmw_sg_table {
245 	enum vmw_dma_map_mode mode;
246 	struct page **pages;
247 	const dma_addr_t *addrs;
248 	struct sg_table *sgt;
249 	unsigned long num_regions;
250 	unsigned long num_pages;
251 };
252 
253 /**
254  * struct vmw_piter - Page iterator that iterates over a list of pages
255  * and DMA addresses that could be either a scatter-gather list or
256  * arrays
257  *
258  * @pages: Array of page pointers to the pages.
259  * @addrs: DMA addresses to the pages if coherent pages are used.
260  * @iter: Scatter-gather page iterator. Current position in SG list.
261  * @i: Current position in arrays.
262  * @num_pages: Number of pages total.
263  * @next: Function to advance the iterator. Returns false if past the list
264  * of pages, true otherwise.
265  * @dma_address: Function to return the DMA address of the current page.
266  */
267 struct vmw_piter {
268 	struct page **pages;
269 	const dma_addr_t *addrs;
270 	struct sg_page_iter iter;
271 	unsigned long i;
272 	unsigned long num_pages;
273 	bool (*next)(struct vmw_piter *);
274 	dma_addr_t (*dma_address)(struct vmw_piter *);
275 	struct page *(*page)(struct vmw_piter *);
276 };
277 
278 /*
279  * enum vmw_display_unit_type - Describes the display unit
280  */
281 enum vmw_display_unit_type {
282 	vmw_du_invalid = 0,
283 	vmw_du_legacy,
284 	vmw_du_screen_object,
285 	vmw_du_screen_target
286 };
287 
288 
289 struct vmw_sw_context{
290 	struct drm_open_hash res_ht;
291 	bool res_ht_initialized;
292 	bool kernel; /**< is the called made from the kernel */
293 	struct vmw_fpriv *fp;
294 	struct list_head validate_nodes;
295 	struct vmw_relocation relocs[VMWGFX_MAX_RELOCATIONS];
296 	uint32_t cur_reloc;
297 	struct vmw_validate_buffer val_bufs[VMWGFX_MAX_VALIDATIONS];
298 	uint32_t cur_val_buf;
299 	uint32_t *cmd_bounce;
300 	uint32_t cmd_bounce_size;
301 	struct list_head resource_list;
302 	struct list_head ctx_resource_list; /* For contexts and cotables */
303 	struct vmw_dma_buffer *cur_query_bo;
304 	struct list_head res_relocations;
305 	uint32_t *buf_start;
306 	struct vmw_res_cache_entry res_cache[vmw_res_max];
307 	struct vmw_resource *last_query_ctx;
308 	bool needs_post_query_barrier;
309 	struct vmw_resource *error_resource;
310 	struct vmw_ctx_binding_state *staged_bindings;
311 	bool staged_bindings_inuse;
312 	struct list_head staged_cmd_res;
313 	struct vmw_resource_val_node *dx_ctx_node;
314 	struct vmw_dma_buffer *dx_query_mob;
315 	struct vmw_resource *dx_query_ctx;
316 	struct vmw_cmdbuf_res_manager *man;
317 };
318 
319 struct vmw_legacy_display;
320 struct vmw_overlay;
321 
322 struct vmw_master {
323 	struct ttm_lock lock;
324 };
325 
326 struct vmw_vga_topology_state {
327 	uint32_t width;
328 	uint32_t height;
329 	uint32_t primary;
330 	uint32_t pos_x;
331 	uint32_t pos_y;
332 };
333 
334 
335 /*
336  * struct vmw_otable - Guest Memory OBject table metadata
337  *
338  * @size:           Size of the table (page-aligned).
339  * @page_table:     Pointer to a struct vmw_mob holding the page table.
340  */
341 struct vmw_otable {
342 	unsigned long size;
343 	struct vmw_mob *page_table;
344 	bool enabled;
345 };
346 
347 struct vmw_otable_batch {
348 	unsigned num_otables;
349 	struct vmw_otable *otables;
350 	struct vmw_resource *context;
351 	struct ttm_buffer_object *otable_bo;
352 };
353 
354 struct vmw_private {
355 	struct ttm_bo_device bdev;
356 	struct ttm_bo_global_ref bo_global_ref;
357 	struct drm_global_reference mem_global_ref;
358 
359 	struct vmw_fifo_state fifo;
360 
361 	struct drm_device *dev;
362 	unsigned long vmw_chipset;
363 	unsigned int io_start;
364 	uint32_t vram_start;
365 	uint32_t vram_size;
366 	uint32_t prim_bb_mem;
367 	uint32_t mmio_start;
368 	uint32_t mmio_size;
369 	uint32_t fb_max_width;
370 	uint32_t fb_max_height;
371 	uint32_t texture_max_width;
372 	uint32_t texture_max_height;
373 	uint32_t stdu_max_width;
374 	uint32_t stdu_max_height;
375 	uint32_t initial_width;
376 	uint32_t initial_height;
377 	u32 *mmio_virt;
378 	uint32_t capabilities;
379 	uint32_t max_gmr_ids;
380 	uint32_t max_gmr_pages;
381 	uint32_t max_mob_pages;
382 	uint32_t max_mob_size;
383 	uint32_t memory_size;
384 	bool has_gmr;
385 	bool has_mob;
386 	spinlock_t hw_lock;
387 	spinlock_t cap_lock;
388 	bool has_dx;
389 
390 	/*
391 	 * VGA registers.
392 	 */
393 
394 	struct vmw_vga_topology_state vga_save[VMWGFX_MAX_DISPLAYS];
395 	uint32_t vga_width;
396 	uint32_t vga_height;
397 	uint32_t vga_bpp;
398 	uint32_t vga_bpl;
399 	uint32_t vga_pitchlock;
400 
401 	uint32_t num_displays;
402 
403 	/*
404 	 * Framebuffer info.
405 	 */
406 
407 	void *fb_info;
408 	enum vmw_display_unit_type active_display_unit;
409 	struct vmw_legacy_display *ldu_priv;
410 	struct vmw_overlay *overlay_priv;
411 	struct drm_property *hotplug_mode_update_property;
412 	struct drm_property *implicit_placement_property;
413 	unsigned num_implicit;
414 	struct vmw_framebuffer *implicit_fb;
415 	struct mutex global_kms_state_mutex;
416 
417 	/*
418 	 * Context and surface management.
419 	 */
420 
421 	rwlock_t resource_lock;
422 	struct idr res_idr[vmw_res_max];
423 	/*
424 	 * Block lastclose from racing with firstopen.
425 	 */
426 
427 	struct mutex init_mutex;
428 
429 	/*
430 	 * A resource manager for kernel-only surfaces and
431 	 * contexts.
432 	 */
433 
434 	struct ttm_object_device *tdev;
435 
436 	/*
437 	 * Fencing and IRQs.
438 	 */
439 
440 	atomic_t marker_seq;
441 	wait_queue_head_t fence_queue;
442 	wait_queue_head_t fifo_queue;
443 	spinlock_t waiter_lock;
444 	int fence_queue_waiters; /* Protected by waiter_lock */
445 	int goal_queue_waiters; /* Protected by waiter_lock */
446 	int cmdbuf_waiters; /* Protected by waiter_lock */
447 	int error_waiters; /* Protected by waiter_lock */
448 	int fifo_queue_waiters; /* Protected by waiter_lock */
449 	uint32_t last_read_seqno;
450 	struct vmw_fence_manager *fman;
451 	uint32_t irq_mask; /* Updates protected by waiter_lock */
452 
453 	/*
454 	 * Device state
455 	 */
456 
457 	uint32_t traces_state;
458 	uint32_t enable_state;
459 	uint32_t config_done_state;
460 
461 	/**
462 	 * Execbuf
463 	 */
464 	/**
465 	 * Protected by the cmdbuf mutex.
466 	 */
467 
468 	struct vmw_sw_context ctx;
469 	struct mutex cmdbuf_mutex;
470 	struct mutex binding_mutex;
471 
472 	/**
473 	 * Operating mode.
474 	 */
475 
476 	bool stealth;
477 	bool enable_fb;
478 	spinlock_t svga_lock;
479 
480 	/**
481 	 * Master management.
482 	 */
483 
484 	struct vmw_master *active_master;
485 	struct vmw_master fbdev_master;
486 	struct notifier_block pm_nb;
487 	bool suspended;
488 	bool refuse_hibernation;
489 
490 	struct mutex release_mutex;
491 	atomic_t num_fifo_resources;
492 
493 	/*
494 	 * Replace this with an rwsem as soon as we have down_xx_interruptible()
495 	 */
496 	struct ttm_lock reservation_sem;
497 
498 	/*
499 	 * Query processing. These members
500 	 * are protected by the cmdbuf mutex.
501 	 */
502 
503 	struct vmw_dma_buffer *dummy_query_bo;
504 	struct vmw_dma_buffer *pinned_bo;
505 	uint32_t query_cid;
506 	uint32_t query_cid_valid;
507 	bool dummy_query_bo_pinned;
508 
509 	/*
510 	 * Surface swapping. The "surface_lru" list is protected by the
511 	 * resource lock in order to be able to destroy a surface and take
512 	 * it off the lru atomically. "used_memory_size" is currently
513 	 * protected by the cmdbuf mutex for simplicity.
514 	 */
515 
516 	struct list_head res_lru[vmw_res_max];
517 	uint32_t used_memory_size;
518 
519 	/*
520 	 * DMA mapping stuff.
521 	 */
522 	enum vmw_dma_map_mode map_mode;
523 
524 	/*
525 	 * Guest Backed stuff
526 	 */
527 	struct vmw_otable_batch otable_batch;
528 
529 	struct vmw_cmdbuf_man *cman;
530 };
531 
532 static inline struct vmw_surface *vmw_res_to_srf(struct vmw_resource *res)
533 {
534 	return container_of(res, struct vmw_surface, res);
535 }
536 
537 static inline struct vmw_private *vmw_priv(struct drm_device *dev)
538 {
539 	return (struct vmw_private *)dev->dev_private;
540 }
541 
542 static inline struct vmw_fpriv *vmw_fpriv(struct drm_file *file_priv)
543 {
544 	return (struct vmw_fpriv *)file_priv->driver_priv;
545 }
546 
547 static inline struct vmw_master *vmw_master(struct drm_master *master)
548 {
549 	return (struct vmw_master *) master->driver_priv;
550 }
551 
552 /*
553  * The locking here is fine-grained, so that it is performed once
554  * for every read- and write operation. This is of course costly, but we
555  * don't perform much register access in the timing critical paths anyway.
556  * Instead we have the extra benefit of being sure that we don't forget
557  * the hw lock around register accesses.
558  */
559 static inline void vmw_write(struct vmw_private *dev_priv,
560 			     unsigned int offset, uint32_t value)
561 {
562 	unsigned long irq_flags;
563 
564 	spin_lock_irqsave(&dev_priv->hw_lock, irq_flags);
565 	outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
566 	outl(value, dev_priv->io_start + VMWGFX_VALUE_PORT);
567 	spin_unlock_irqrestore(&dev_priv->hw_lock, irq_flags);
568 }
569 
570 static inline uint32_t vmw_read(struct vmw_private *dev_priv,
571 				unsigned int offset)
572 {
573 	unsigned long irq_flags;
574 	u32 val;
575 
576 	spin_lock_irqsave(&dev_priv->hw_lock, irq_flags);
577 	outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
578 	val = inl(dev_priv->io_start + VMWGFX_VALUE_PORT);
579 	spin_unlock_irqrestore(&dev_priv->hw_lock, irq_flags);
580 
581 	return val;
582 }
583 
584 extern void vmw_svga_enable(struct vmw_private *dev_priv);
585 extern void vmw_svga_disable(struct vmw_private *dev_priv);
586 
587 
588 /**
589  * GMR utilities - vmwgfx_gmr.c
590  */
591 
592 extern int vmw_gmr_bind(struct vmw_private *dev_priv,
593 			const struct vmw_sg_table *vsgt,
594 			unsigned long num_pages,
595 			int gmr_id);
596 extern void vmw_gmr_unbind(struct vmw_private *dev_priv, int gmr_id);
597 
598 /**
599  * Resource utilities - vmwgfx_resource.c
600  */
601 struct vmw_user_resource_conv;
602 
603 extern void vmw_resource_unreference(struct vmw_resource **p_res);
604 extern struct vmw_resource *vmw_resource_reference(struct vmw_resource *res);
605 extern struct vmw_resource *
606 vmw_resource_reference_unless_doomed(struct vmw_resource *res);
607 extern int vmw_resource_validate(struct vmw_resource *res);
608 extern int vmw_resource_reserve(struct vmw_resource *res, bool interruptible,
609 				bool no_backup);
610 extern bool vmw_resource_needs_backup(const struct vmw_resource *res);
611 extern int vmw_user_lookup_handle(struct vmw_private *dev_priv,
612 				  struct ttm_object_file *tfile,
613 				  uint32_t handle,
614 				  struct vmw_surface **out_surf,
615 				  struct vmw_dma_buffer **out_buf);
616 extern int vmw_user_resource_lookup_handle(
617 	struct vmw_private *dev_priv,
618 	struct ttm_object_file *tfile,
619 	uint32_t handle,
620 	const struct vmw_user_resource_conv *converter,
621 	struct vmw_resource **p_res);
622 extern void vmw_dmabuf_bo_free(struct ttm_buffer_object *bo);
623 extern int vmw_dmabuf_init(struct vmw_private *dev_priv,
624 			   struct vmw_dma_buffer *vmw_bo,
625 			   size_t size, struct ttm_placement *placement,
626 			   bool interuptable,
627 			   void (*bo_free) (struct ttm_buffer_object *bo));
628 extern int vmw_user_dmabuf_verify_access(struct ttm_buffer_object *bo,
629 				  struct ttm_object_file *tfile);
630 extern int vmw_user_dmabuf_alloc(struct vmw_private *dev_priv,
631 				 struct ttm_object_file *tfile,
632 				 uint32_t size,
633 				 bool shareable,
634 				 uint32_t *handle,
635 				 struct vmw_dma_buffer **p_dma_buf,
636 				 struct ttm_base_object **p_base);
637 extern int vmw_user_dmabuf_reference(struct ttm_object_file *tfile,
638 				     struct vmw_dma_buffer *dma_buf,
639 				     uint32_t *handle);
640 extern int vmw_dmabuf_alloc_ioctl(struct drm_device *dev, void *data,
641 				  struct drm_file *file_priv);
642 extern int vmw_dmabuf_unref_ioctl(struct drm_device *dev, void *data,
643 				  struct drm_file *file_priv);
644 extern int vmw_user_dmabuf_synccpu_ioctl(struct drm_device *dev, void *data,
645 					 struct drm_file *file_priv);
646 extern uint32_t vmw_dmabuf_validate_node(struct ttm_buffer_object *bo,
647 					 uint32_t cur_validate_node);
648 extern void vmw_dmabuf_validate_clear(struct ttm_buffer_object *bo);
649 extern int vmw_user_dmabuf_lookup(struct ttm_object_file *tfile,
650 				  uint32_t id, struct vmw_dma_buffer **out,
651 				  struct ttm_base_object **base);
652 extern int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
653 				  struct drm_file *file_priv);
654 extern int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
655 				  struct drm_file *file_priv);
656 extern int vmw_user_stream_lookup(struct vmw_private *dev_priv,
657 				  struct ttm_object_file *tfile,
658 				  uint32_t *inout_id,
659 				  struct vmw_resource **out);
660 extern void vmw_resource_unreserve(struct vmw_resource *res,
661 				   bool switch_backup,
662 				   struct vmw_dma_buffer *new_backup,
663 				   unsigned long new_backup_offset);
664 extern void vmw_resource_move_notify(struct ttm_buffer_object *bo,
665 				     struct ttm_mem_reg *mem);
666 extern void vmw_query_move_notify(struct ttm_buffer_object *bo,
667 				  struct ttm_mem_reg *mem);
668 extern int vmw_query_readback_all(struct vmw_dma_buffer *dx_query_mob);
669 extern void vmw_fence_single_bo(struct ttm_buffer_object *bo,
670 				struct vmw_fence_obj *fence);
671 extern void vmw_resource_evict_all(struct vmw_private *dev_priv);
672 
673 /**
674  * DMA buffer helper routines - vmwgfx_dmabuf.c
675  */
676 extern int vmw_dmabuf_pin_in_placement(struct vmw_private *vmw_priv,
677 				       struct vmw_dma_buffer *bo,
678 				       struct ttm_placement *placement,
679 				       bool interruptible);
680 extern int vmw_dmabuf_pin_in_vram(struct vmw_private *dev_priv,
681 				  struct vmw_dma_buffer *buf,
682 				  bool interruptible);
683 extern int vmw_dmabuf_pin_in_vram_or_gmr(struct vmw_private *dev_priv,
684 					 struct vmw_dma_buffer *buf,
685 					 bool interruptible);
686 extern int vmw_dmabuf_pin_in_start_of_vram(struct vmw_private *vmw_priv,
687 					   struct vmw_dma_buffer *bo,
688 					   bool interruptible);
689 extern int vmw_dmabuf_unpin(struct vmw_private *vmw_priv,
690 			    struct vmw_dma_buffer *bo,
691 			    bool interruptible);
692 extern void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *buf,
693 				 SVGAGuestPtr *ptr);
694 extern void vmw_bo_pin_reserved(struct vmw_dma_buffer *bo, bool pin);
695 
696 /**
697  * Misc Ioctl functionality - vmwgfx_ioctl.c
698  */
699 
700 extern int vmw_getparam_ioctl(struct drm_device *dev, void *data,
701 			      struct drm_file *file_priv);
702 extern int vmw_get_cap_3d_ioctl(struct drm_device *dev, void *data,
703 				struct drm_file *file_priv);
704 extern int vmw_present_ioctl(struct drm_device *dev, void *data,
705 			     struct drm_file *file_priv);
706 extern int vmw_present_readback_ioctl(struct drm_device *dev, void *data,
707 				      struct drm_file *file_priv);
708 extern unsigned int vmw_fops_poll(struct file *filp,
709 				  struct poll_table_struct *wait);
710 extern ssize_t vmw_fops_read(struct file *filp, char __user *buffer,
711 			     size_t count, loff_t *offset);
712 
713 /**
714  * Fifo utilities - vmwgfx_fifo.c
715  */
716 
717 extern int vmw_fifo_init(struct vmw_private *dev_priv,
718 			 struct vmw_fifo_state *fifo);
719 extern void vmw_fifo_release(struct vmw_private *dev_priv,
720 			     struct vmw_fifo_state *fifo);
721 extern void *vmw_fifo_reserve(struct vmw_private *dev_priv, uint32_t bytes);
722 extern void *
723 vmw_fifo_reserve_dx(struct vmw_private *dev_priv, uint32_t bytes, int ctx_id);
724 extern void vmw_fifo_commit(struct vmw_private *dev_priv, uint32_t bytes);
725 extern void vmw_fifo_commit_flush(struct vmw_private *dev_priv, uint32_t bytes);
726 extern int vmw_fifo_send_fence(struct vmw_private *dev_priv,
727 			       uint32_t *seqno);
728 extern void vmw_fifo_ping_host_locked(struct vmw_private *, uint32_t reason);
729 extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
730 extern bool vmw_fifo_have_3d(struct vmw_private *dev_priv);
731 extern bool vmw_fifo_have_pitchlock(struct vmw_private *dev_priv);
732 extern int vmw_fifo_emit_dummy_query(struct vmw_private *dev_priv,
733 				     uint32_t cid);
734 extern int vmw_fifo_flush(struct vmw_private *dev_priv,
735 			  bool interruptible);
736 
737 /**
738  * TTM glue - vmwgfx_ttm_glue.c
739  */
740 
741 extern int vmw_ttm_global_init(struct vmw_private *dev_priv);
742 extern void vmw_ttm_global_release(struct vmw_private *dev_priv);
743 extern int vmw_mmap(struct file *filp, struct vm_area_struct *vma);
744 
745 /**
746  * TTM buffer object driver - vmwgfx_buffer.c
747  */
748 
749 extern const size_t vmw_tt_size;
750 extern struct ttm_placement vmw_vram_placement;
751 extern struct ttm_placement vmw_vram_ne_placement;
752 extern struct ttm_placement vmw_vram_sys_placement;
753 extern struct ttm_placement vmw_vram_gmr_placement;
754 extern struct ttm_placement vmw_vram_gmr_ne_placement;
755 extern struct ttm_placement vmw_sys_placement;
756 extern struct ttm_placement vmw_sys_ne_placement;
757 extern struct ttm_placement vmw_evictable_placement;
758 extern struct ttm_placement vmw_srf_placement;
759 extern struct ttm_placement vmw_mob_placement;
760 extern struct ttm_placement vmw_mob_ne_placement;
761 extern struct ttm_bo_driver vmw_bo_driver;
762 extern int vmw_dma_quiescent(struct drm_device *dev);
763 extern int vmw_bo_map_dma(struct ttm_buffer_object *bo);
764 extern void vmw_bo_unmap_dma(struct ttm_buffer_object *bo);
765 extern const struct vmw_sg_table *
766 vmw_bo_sg_table(struct ttm_buffer_object *bo);
767 extern void vmw_piter_start(struct vmw_piter *viter,
768 			    const struct vmw_sg_table *vsgt,
769 			    unsigned long p_offs);
770 
771 /**
772  * vmw_piter_next - Advance the iterator one page.
773  *
774  * @viter: Pointer to the iterator to advance.
775  *
776  * Returns false if past the list of pages, true otherwise.
777  */
778 static inline bool vmw_piter_next(struct vmw_piter *viter)
779 {
780 	return viter->next(viter);
781 }
782 
783 /**
784  * vmw_piter_dma_addr - Return the DMA address of the current page.
785  *
786  * @viter: Pointer to the iterator
787  *
788  * Returns the DMA address of the page pointed to by @viter.
789  */
790 static inline dma_addr_t vmw_piter_dma_addr(struct vmw_piter *viter)
791 {
792 	return viter->dma_address(viter);
793 }
794 
795 /**
796  * vmw_piter_page - Return a pointer to the current page.
797  *
798  * @viter: Pointer to the iterator
799  *
800  * Returns the DMA address of the page pointed to by @viter.
801  */
802 static inline struct page *vmw_piter_page(struct vmw_piter *viter)
803 {
804 	return viter->page(viter);
805 }
806 
807 /**
808  * Command submission - vmwgfx_execbuf.c
809  */
810 
811 extern int vmw_execbuf_ioctl(struct drm_device *dev, unsigned long data,
812 			     struct drm_file *file_priv, size_t size);
813 extern int vmw_execbuf_process(struct drm_file *file_priv,
814 			       struct vmw_private *dev_priv,
815 			       void __user *user_commands,
816 			       void *kernel_commands,
817 			       uint32_t command_size,
818 			       uint64_t throttle_us,
819 			       uint32_t dx_context_handle,
820 			       struct drm_vmw_fence_rep __user
821 			       *user_fence_rep,
822 			       struct vmw_fence_obj **out_fence);
823 extern void __vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv,
824 					    struct vmw_fence_obj *fence);
825 extern void vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv);
826 
827 extern int vmw_execbuf_fence_commands(struct drm_file *file_priv,
828 				      struct vmw_private *dev_priv,
829 				      struct vmw_fence_obj **p_fence,
830 				      uint32_t *p_handle);
831 extern void vmw_execbuf_copy_fence_user(struct vmw_private *dev_priv,
832 					struct vmw_fpriv *vmw_fp,
833 					int ret,
834 					struct drm_vmw_fence_rep __user
835 					*user_fence_rep,
836 					struct vmw_fence_obj *fence,
837 					uint32_t fence_handle);
838 extern int vmw_validate_single_buffer(struct vmw_private *dev_priv,
839 				      struct ttm_buffer_object *bo,
840 				      bool interruptible,
841 				      bool validate_as_mob);
842 
843 
844 /**
845  * IRQs and wating - vmwgfx_irq.c
846  */
847 
848 extern irqreturn_t vmw_irq_handler(int irq, void *arg);
849 extern int vmw_wait_seqno(struct vmw_private *dev_priv, bool lazy,
850 			  uint32_t seqno, bool interruptible,
851 			  unsigned long timeout);
852 extern void vmw_irq_preinstall(struct drm_device *dev);
853 extern int vmw_irq_postinstall(struct drm_device *dev);
854 extern void vmw_irq_uninstall(struct drm_device *dev);
855 extern bool vmw_seqno_passed(struct vmw_private *dev_priv,
856 				uint32_t seqno);
857 extern int vmw_fallback_wait(struct vmw_private *dev_priv,
858 			     bool lazy,
859 			     bool fifo_idle,
860 			     uint32_t seqno,
861 			     bool interruptible,
862 			     unsigned long timeout);
863 extern void vmw_update_seqno(struct vmw_private *dev_priv,
864 				struct vmw_fifo_state *fifo_state);
865 extern void vmw_seqno_waiter_add(struct vmw_private *dev_priv);
866 extern void vmw_seqno_waiter_remove(struct vmw_private *dev_priv);
867 extern void vmw_goal_waiter_add(struct vmw_private *dev_priv);
868 extern void vmw_goal_waiter_remove(struct vmw_private *dev_priv);
869 extern void vmw_generic_waiter_add(struct vmw_private *dev_priv, u32 flag,
870 				   int *waiter_count);
871 extern void vmw_generic_waiter_remove(struct vmw_private *dev_priv,
872 				      u32 flag, int *waiter_count);
873 
874 /**
875  * Rudimentary fence-like objects currently used only for throttling -
876  * vmwgfx_marker.c
877  */
878 
879 extern void vmw_marker_queue_init(struct vmw_marker_queue *queue);
880 extern void vmw_marker_queue_takedown(struct vmw_marker_queue *queue);
881 extern int vmw_marker_push(struct vmw_marker_queue *queue,
882 			   uint32_t seqno);
883 extern int vmw_marker_pull(struct vmw_marker_queue *queue,
884 			   uint32_t signaled_seqno);
885 extern int vmw_wait_lag(struct vmw_private *dev_priv,
886 			struct vmw_marker_queue *queue, uint32_t us);
887 
888 /**
889  * Kernel framebuffer - vmwgfx_fb.c
890  */
891 
892 int vmw_fb_init(struct vmw_private *vmw_priv);
893 int vmw_fb_close(struct vmw_private *dev_priv);
894 int vmw_fb_off(struct vmw_private *vmw_priv);
895 int vmw_fb_on(struct vmw_private *vmw_priv);
896 
897 /**
898  * Kernel modesetting - vmwgfx_kms.c
899  */
900 
901 int vmw_kms_init(struct vmw_private *dev_priv);
902 int vmw_kms_close(struct vmw_private *dev_priv);
903 int vmw_kms_save_vga(struct vmw_private *vmw_priv);
904 int vmw_kms_restore_vga(struct vmw_private *vmw_priv);
905 int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
906 				struct drm_file *file_priv);
907 void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv);
908 void vmw_kms_cursor_snoop(struct vmw_surface *srf,
909 			  struct ttm_object_file *tfile,
910 			  struct ttm_buffer_object *bo,
911 			  SVGA3dCmdHeader *header);
912 int vmw_kms_write_svga(struct vmw_private *vmw_priv,
913 		       unsigned width, unsigned height, unsigned pitch,
914 		       unsigned bpp, unsigned depth);
915 void vmw_kms_idle_workqueues(struct vmw_master *vmaster);
916 bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
917 				uint32_t pitch,
918 				uint32_t height);
919 u32 vmw_get_vblank_counter(struct drm_device *dev, unsigned int pipe);
920 int vmw_enable_vblank(struct drm_device *dev, unsigned int pipe);
921 void vmw_disable_vblank(struct drm_device *dev, unsigned int pipe);
922 int vmw_kms_present(struct vmw_private *dev_priv,
923 		    struct drm_file *file_priv,
924 		    struct vmw_framebuffer *vfb,
925 		    struct vmw_surface *surface,
926 		    uint32_t sid, int32_t destX, int32_t destY,
927 		    struct drm_vmw_rect *clips,
928 		    uint32_t num_clips);
929 int vmw_kms_update_layout_ioctl(struct drm_device *dev, void *data,
930 				struct drm_file *file_priv);
931 void vmw_kms_legacy_hotspot_clear(struct vmw_private *dev_priv);
932 
933 int vmw_dumb_create(struct drm_file *file_priv,
934 		    struct drm_device *dev,
935 		    struct drm_mode_create_dumb *args);
936 
937 int vmw_dumb_map_offset(struct drm_file *file_priv,
938 			struct drm_device *dev, uint32_t handle,
939 			uint64_t *offset);
940 int vmw_dumb_destroy(struct drm_file *file_priv,
941 		     struct drm_device *dev,
942 		     uint32_t handle);
943 extern int vmw_resource_pin(struct vmw_resource *res, bool interruptible);
944 extern void vmw_resource_unpin(struct vmw_resource *res);
945 extern enum vmw_res_type vmw_res_type(const struct vmw_resource *res);
946 
947 /**
948  * Overlay control - vmwgfx_overlay.c
949  */
950 
951 int vmw_overlay_init(struct vmw_private *dev_priv);
952 int vmw_overlay_close(struct vmw_private *dev_priv);
953 int vmw_overlay_ioctl(struct drm_device *dev, void *data,
954 		      struct drm_file *file_priv);
955 int vmw_overlay_stop_all(struct vmw_private *dev_priv);
956 int vmw_overlay_resume_all(struct vmw_private *dev_priv);
957 int vmw_overlay_pause_all(struct vmw_private *dev_priv);
958 int vmw_overlay_claim(struct vmw_private *dev_priv, uint32_t *out);
959 int vmw_overlay_unref(struct vmw_private *dev_priv, uint32_t stream_id);
960 int vmw_overlay_num_overlays(struct vmw_private *dev_priv);
961 int vmw_overlay_num_free_overlays(struct vmw_private *dev_priv);
962 
963 /**
964  * GMR Id manager
965  */
966 
967 extern const struct ttm_mem_type_manager_func vmw_gmrid_manager_func;
968 
969 /**
970  * Prime - vmwgfx_prime.c
971  */
972 
973 extern const struct dma_buf_ops vmw_prime_dmabuf_ops;
974 extern int vmw_prime_fd_to_handle(struct drm_device *dev,
975 				  struct drm_file *file_priv,
976 				  int fd, u32 *handle);
977 extern int vmw_prime_handle_to_fd(struct drm_device *dev,
978 				  struct drm_file *file_priv,
979 				  uint32_t handle, uint32_t flags,
980 				  int *prime_fd);
981 
982 /*
983  * MemoryOBject management -  vmwgfx_mob.c
984  */
985 struct vmw_mob;
986 extern int vmw_mob_bind(struct vmw_private *dev_priv, struct vmw_mob *mob,
987 			const struct vmw_sg_table *vsgt,
988 			unsigned long num_data_pages, int32_t mob_id);
989 extern void vmw_mob_unbind(struct vmw_private *dev_priv,
990 			   struct vmw_mob *mob);
991 extern void vmw_mob_destroy(struct vmw_mob *mob);
992 extern struct vmw_mob *vmw_mob_create(unsigned long data_pages);
993 extern int vmw_otables_setup(struct vmw_private *dev_priv);
994 extern void vmw_otables_takedown(struct vmw_private *dev_priv);
995 
996 /*
997  * Context management - vmwgfx_context.c
998  */
999 
1000 extern const struct vmw_user_resource_conv *user_context_converter;
1001 
1002 extern int vmw_context_check(struct vmw_private *dev_priv,
1003 			     struct ttm_object_file *tfile,
1004 			     int id,
1005 			     struct vmw_resource **p_res);
1006 extern int vmw_context_define_ioctl(struct drm_device *dev, void *data,
1007 				    struct drm_file *file_priv);
1008 extern int vmw_extended_context_define_ioctl(struct drm_device *dev, void *data,
1009 					     struct drm_file *file_priv);
1010 extern int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
1011 				     struct drm_file *file_priv);
1012 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1013 extern struct vmw_cmdbuf_res_manager *
1014 vmw_context_res_man(struct vmw_resource *ctx);
1015 extern struct vmw_resource *vmw_context_cotable(struct vmw_resource *ctx,
1016 						SVGACOTableType cotable_type);
1017 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1018 struct vmw_ctx_binding_state;
1019 extern struct vmw_ctx_binding_state *
1020 vmw_context_binding_state(struct vmw_resource *ctx);
1021 extern void vmw_dx_context_scrub_cotables(struct vmw_resource *ctx,
1022 					  bool readback);
1023 extern int vmw_context_bind_dx_query(struct vmw_resource *ctx_res,
1024 				     struct vmw_dma_buffer *mob);
1025 extern struct vmw_dma_buffer *
1026 vmw_context_get_dx_query_mob(struct vmw_resource *ctx_res);
1027 
1028 
1029 /*
1030  * Surface management - vmwgfx_surface.c
1031  */
1032 
1033 extern const struct vmw_user_resource_conv *user_surface_converter;
1034 
1035 extern void vmw_surface_res_free(struct vmw_resource *res);
1036 extern int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
1037 				     struct drm_file *file_priv);
1038 extern int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
1039 				    struct drm_file *file_priv);
1040 extern int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
1041 				       struct drm_file *file_priv);
1042 extern int vmw_gb_surface_define_ioctl(struct drm_device *dev, void *data,
1043 				       struct drm_file *file_priv);
1044 extern int vmw_gb_surface_reference_ioctl(struct drm_device *dev, void *data,
1045 					  struct drm_file *file_priv);
1046 extern int vmw_surface_check(struct vmw_private *dev_priv,
1047 			     struct ttm_object_file *tfile,
1048 			     uint32_t handle, int *id);
1049 extern int vmw_surface_validate(struct vmw_private *dev_priv,
1050 				struct vmw_surface *srf);
1051 int vmw_surface_gb_priv_define(struct drm_device *dev,
1052 			       uint32_t user_accounting_size,
1053 			       uint32_t svga3d_flags,
1054 			       SVGA3dSurfaceFormat format,
1055 			       bool for_scanout,
1056 			       uint32_t num_mip_levels,
1057 			       uint32_t multisample_count,
1058 			       uint32_t array_size,
1059 			       struct drm_vmw_size size,
1060 			       struct vmw_surface **srf_out);
1061 
1062 /*
1063  * Shader management - vmwgfx_shader.c
1064  */
1065 
1066 extern const struct vmw_user_resource_conv *user_shader_converter;
1067 
1068 extern int vmw_shader_define_ioctl(struct drm_device *dev, void *data,
1069 				   struct drm_file *file_priv);
1070 extern int vmw_shader_destroy_ioctl(struct drm_device *dev, void *data,
1071 				    struct drm_file *file_priv);
1072 extern int vmw_compat_shader_add(struct vmw_private *dev_priv,
1073 				 struct vmw_cmdbuf_res_manager *man,
1074 				 u32 user_key, const void *bytecode,
1075 				 SVGA3dShaderType shader_type,
1076 				 size_t size,
1077 				 struct list_head *list);
1078 extern int vmw_shader_remove(struct vmw_cmdbuf_res_manager *man,
1079 			     u32 user_key, SVGA3dShaderType shader_type,
1080 			     struct list_head *list);
1081 extern int vmw_dx_shader_add(struct vmw_cmdbuf_res_manager *man,
1082 			     struct vmw_resource *ctx,
1083 			     u32 user_key,
1084 			     SVGA3dShaderType shader_type,
1085 			     struct list_head *list);
1086 extern void vmw_dx_shader_cotable_list_scrub(struct vmw_private *dev_priv,
1087 					     struct list_head *list,
1088 					     bool readback);
1089 
1090 extern struct vmw_resource *
1091 vmw_shader_lookup(struct vmw_cmdbuf_res_manager *man,
1092 		  u32 user_key, SVGA3dShaderType shader_type);
1093 
1094 /*
1095  * Command buffer managed resources - vmwgfx_cmdbuf_res.c
1096  */
1097 
1098 extern struct vmw_cmdbuf_res_manager *
1099 vmw_cmdbuf_res_man_create(struct vmw_private *dev_priv);
1100 extern void vmw_cmdbuf_res_man_destroy(struct vmw_cmdbuf_res_manager *man);
1101 extern size_t vmw_cmdbuf_res_man_size(void);
1102 extern struct vmw_resource *
1103 vmw_cmdbuf_res_lookup(struct vmw_cmdbuf_res_manager *man,
1104 		      enum vmw_cmdbuf_res_type res_type,
1105 		      u32 user_key);
1106 extern void vmw_cmdbuf_res_revert(struct list_head *list);
1107 extern void vmw_cmdbuf_res_commit(struct list_head *list);
1108 extern int vmw_cmdbuf_res_add(struct vmw_cmdbuf_res_manager *man,
1109 			      enum vmw_cmdbuf_res_type res_type,
1110 			      u32 user_key,
1111 			      struct vmw_resource *res,
1112 			      struct list_head *list);
1113 extern int vmw_cmdbuf_res_remove(struct vmw_cmdbuf_res_manager *man,
1114 				 enum vmw_cmdbuf_res_type res_type,
1115 				 u32 user_key,
1116 				 struct list_head *list,
1117 				 struct vmw_resource **res);
1118 
1119 /*
1120  * COTable management - vmwgfx_cotable.c
1121  */
1122 extern const SVGACOTableType vmw_cotable_scrub_order[];
1123 extern struct vmw_resource *vmw_cotable_alloc(struct vmw_private *dev_priv,
1124 					      struct vmw_resource *ctx,
1125 					      u32 type);
1126 extern int vmw_cotable_notify(struct vmw_resource *res, int id);
1127 extern int vmw_cotable_scrub(struct vmw_resource *res, bool readback);
1128 extern void vmw_cotable_add_resource(struct vmw_resource *ctx,
1129 				     struct list_head *head);
1130 
1131 /*
1132  * Command buffer managerment vmwgfx_cmdbuf.c
1133  */
1134 struct vmw_cmdbuf_man;
1135 struct vmw_cmdbuf_header;
1136 
1137 extern struct vmw_cmdbuf_man *
1138 vmw_cmdbuf_man_create(struct vmw_private *dev_priv);
1139 extern int vmw_cmdbuf_set_pool_size(struct vmw_cmdbuf_man *man,
1140 				    size_t size, size_t default_size);
1141 extern void vmw_cmdbuf_remove_pool(struct vmw_cmdbuf_man *man);
1142 extern void vmw_cmdbuf_man_destroy(struct vmw_cmdbuf_man *man);
1143 extern int vmw_cmdbuf_idle(struct vmw_cmdbuf_man *man, bool interruptible,
1144 			   unsigned long timeout);
1145 extern void *vmw_cmdbuf_reserve(struct vmw_cmdbuf_man *man, size_t size,
1146 				int ctx_id, bool interruptible,
1147 				struct vmw_cmdbuf_header *header);
1148 extern void vmw_cmdbuf_commit(struct vmw_cmdbuf_man *man, size_t size,
1149 			      struct vmw_cmdbuf_header *header,
1150 			      bool flush);
1151 extern void vmw_cmdbuf_tasklet_schedule(struct vmw_cmdbuf_man *man);
1152 extern void *vmw_cmdbuf_alloc(struct vmw_cmdbuf_man *man,
1153 			      size_t size, bool interruptible,
1154 			      struct vmw_cmdbuf_header **p_header);
1155 extern void vmw_cmdbuf_header_free(struct vmw_cmdbuf_header *header);
1156 extern int vmw_cmdbuf_cur_flush(struct vmw_cmdbuf_man *man,
1157 				bool interruptible);
1158 
1159 
1160 /**
1161  * Inline helper functions
1162  */
1163 
1164 static inline void vmw_surface_unreference(struct vmw_surface **srf)
1165 {
1166 	struct vmw_surface *tmp_srf = *srf;
1167 	struct vmw_resource *res = &tmp_srf->res;
1168 	*srf = NULL;
1169 
1170 	vmw_resource_unreference(&res);
1171 }
1172 
1173 static inline struct vmw_surface *vmw_surface_reference(struct vmw_surface *srf)
1174 {
1175 	(void) vmw_resource_reference(&srf->res);
1176 	return srf;
1177 }
1178 
1179 static inline void vmw_dmabuf_unreference(struct vmw_dma_buffer **buf)
1180 {
1181 	struct vmw_dma_buffer *tmp_buf = *buf;
1182 
1183 	*buf = NULL;
1184 	if (tmp_buf != NULL) {
1185 		struct ttm_buffer_object *bo = &tmp_buf->base;
1186 
1187 		ttm_bo_unref(&bo);
1188 	}
1189 }
1190 
1191 static inline struct vmw_dma_buffer *vmw_dmabuf_reference(struct vmw_dma_buffer *buf)
1192 {
1193 	if (ttm_bo_reference(&buf->base))
1194 		return buf;
1195 	return NULL;
1196 }
1197 
1198 static inline struct ttm_mem_global *vmw_mem_glob(struct vmw_private *dev_priv)
1199 {
1200 	return (struct ttm_mem_global *) dev_priv->mem_global_ref.object;
1201 }
1202 
1203 static inline void vmw_fifo_resource_inc(struct vmw_private *dev_priv)
1204 {
1205 	atomic_inc(&dev_priv->num_fifo_resources);
1206 }
1207 
1208 static inline void vmw_fifo_resource_dec(struct vmw_private *dev_priv)
1209 {
1210 	atomic_dec(&dev_priv->num_fifo_resources);
1211 }
1212 
1213 /**
1214  * vmw_mmio_read - Perform a MMIO read from volatile memory
1215  *
1216  * @addr: The address to read from
1217  *
1218  * This function is intended to be equivalent to ioread32() on
1219  * memremap'd memory, but without byteswapping.
1220  */
1221 static inline u32 vmw_mmio_read(u32 *addr)
1222 {
1223 	return READ_ONCE(*addr);
1224 }
1225 
1226 /**
1227  * vmw_mmio_write - Perform a MMIO write to volatile memory
1228  *
1229  * @addr: The address to write to
1230  *
1231  * This function is intended to be equivalent to iowrite32 on
1232  * memremap'd memory, but without byteswapping.
1233  */
1234 static inline void vmw_mmio_write(u32 value, u32 *addr)
1235 {
1236 	WRITE_ONCE(*addr, value);
1237 }
1238 
1239 /**
1240  * Add vmw_msg module function
1241  */
1242 extern int vmw_host_log(const char *log);
1243 
1244 #endif
1245