1 /**************************************************************************
3 * Copyright © 2009-2014 VMware, Inc., Palo Alto, CA., USA
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
28 #ifndef _VMWGFX_DRV_H_
29 #define _VMWGFX_DRV_H_
31 #include "vmwgfx_reg.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"
43 #define VMWGFX_DRIVER_DATE "20150626"
44 #define VMWGFX_DRIVER_MAJOR 2
45 #define VMWGFX_DRIVER_MINOR 7
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
56 * Perhaps we should have sysfs entries for these.
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)
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
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
81 struct drm_master *locked_master;
82 struct ttm_object_file *tfile;
83 struct list_head fence_events;
87 struct vmw_dma_buffer {
88 struct ttm_buffer_object base;
89 struct list_head res_list;
94 * struct vmw_validate_buffer - Carries validation info about buffers.
96 * @base: Validation info for TTM.
97 * @hash: Hash entry for quick lookup of the TTM buffer object.
99 * This structure contains also driver private validation info
100 * on top of the info needed by TTM.
102 struct vmw_validate_buffer {
103 struct ttm_validate_buffer base;
104 struct drm_hash_item hash;
105 bool validate_as_mob;
109 struct vmw_resource {
111 struct vmw_private *dev_priv;
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 unsigned long pin_count; /* Protected by resource reserved */
120 const struct vmw_res_func *func;
121 struct list_head lru_head; /* Protected by the resource lock */
122 struct list_head mob_head; /* Protected by @backup reserved */
123 struct list_head binding_head; /* Protected by binding_mutex */
124 void (*res_free) (struct vmw_resource *res);
125 void (*hw_destroy) (struct vmw_resource *res);
130 * Resources that are managed using ioctls.
144 * Resources that are managed using command streams.
146 enum vmw_cmdbuf_res_type {
147 vmw_cmdbuf_res_shader,
151 struct vmw_cmdbuf_res_manager;
153 struct vmw_cursor_snooper {
154 struct drm_crtc *crtc;
159 struct vmw_framebuffer;
160 struct vmw_surface_offset;
163 struct vmw_resource res;
166 uint32_t mip_levels[DRM_VMW_MAX_SURFACE_FACES];
167 struct drm_vmw_size base_size;
168 struct drm_vmw_size *sizes;
172 /* TODO so far just a extra pointer */
173 struct vmw_cursor_snooper snooper;
174 struct vmw_surface_offset *offsets;
175 SVGA3dTextureFilter autogen_filter;
176 uint32_t multisample_count;
177 struct list_head view_list;
180 struct vmw_marker_queue {
181 struct list_head head;
187 struct vmw_fifo_state {
188 unsigned long reserved_size;
191 unsigned long static_buffer_size;
192 bool using_bounce_buffer;
193 uint32_t capabilities;
194 struct mutex fifo_mutex;
195 struct rw_semaphore rwsem;
196 struct vmw_marker_queue marker_queue;
200 struct vmw_relocation {
202 SVGAGuestPtr *location;
207 * struct vmw_res_cache_entry - resource information cache entry
209 * @valid: Whether the entry is valid, which also implies that the execbuf
210 * code holds a reference to the resource, and it's placed on the
212 * @handle: User-space handle of a resource.
213 * @res: Non-ref-counted pointer to the resource.
215 * Used to avoid frequent repeated user-space handle lookups of the
218 struct vmw_res_cache_entry {
221 struct vmw_resource *res;
222 struct vmw_resource_val_node *node;
226 * enum vmw_dma_map_mode - indicate how to perform TTM page dma mappings.
228 enum vmw_dma_map_mode {
229 vmw_dma_phys, /* Use physical page addresses */
230 vmw_dma_alloc_coherent, /* Use TTM coherent pages */
231 vmw_dma_map_populate, /* Unmap from DMA just after unpopulate */
232 vmw_dma_map_bind, /* Unmap from DMA just before unbind */
237 * struct vmw_sg_table - Scatter/gather table for binding, with additional
238 * device-specific information.
240 * @sgt: Pointer to a struct sg_table with binding information
241 * @num_regions: Number of regions with device-address contigous pages
243 struct vmw_sg_table {
244 enum vmw_dma_map_mode mode;
246 const dma_addr_t *addrs;
247 struct sg_table *sgt;
248 unsigned long num_regions;
249 unsigned long num_pages;
253 * struct vmw_piter - Page iterator that iterates over a list of pages
254 * and DMA addresses that could be either a scatter-gather list or
257 * @pages: Array of page pointers to the pages.
258 * @addrs: DMA addresses to the pages if coherent pages are used.
259 * @iter: Scatter-gather page iterator. Current position in SG list.
260 * @i: Current position in arrays.
261 * @num_pages: Number of pages total.
262 * @next: Function to advance the iterator. Returns false if past the list
263 * of pages, true otherwise.
264 * @dma_address: Function to return the DMA address of the current page.
268 const dma_addr_t *addrs;
269 struct sg_page_iter iter;
271 unsigned long num_pages;
272 bool (*next)(struct vmw_piter *);
273 dma_addr_t (*dma_address)(struct vmw_piter *);
274 struct page *(*page)(struct vmw_piter *);
278 * enum vmw_display_unit_type - Describes the display unit
280 enum vmw_display_unit_type {
283 vmw_du_screen_object,
288 struct vmw_sw_context{
289 struct drm_open_hash res_ht;
290 bool res_ht_initialized;
291 bool kernel; /**< is the called made from the kernel */
292 struct vmw_fpriv *fp;
293 struct list_head validate_nodes;
294 struct vmw_relocation relocs[VMWGFX_MAX_RELOCATIONS];
296 struct vmw_validate_buffer val_bufs[VMWGFX_MAX_VALIDATIONS];
297 uint32_t cur_val_buf;
298 uint32_t *cmd_bounce;
299 uint32_t cmd_bounce_size;
300 struct list_head resource_list;
301 struct list_head ctx_resource_list; /* For contexts and cotables */
302 struct vmw_dma_buffer *cur_query_bo;
303 struct list_head res_relocations;
305 struct vmw_res_cache_entry res_cache[vmw_res_max];
306 struct vmw_resource *last_query_ctx;
307 bool needs_post_query_barrier;
308 struct vmw_resource *error_resource;
309 struct vmw_ctx_binding_state *staged_bindings;
310 bool staged_bindings_inuse;
311 struct list_head staged_cmd_res;
312 struct vmw_resource_val_node *dx_ctx_node;
313 struct vmw_dma_buffer *dx_query_mob;
314 struct vmw_resource *dx_query_ctx;
315 struct vmw_cmdbuf_res_manager *man;
318 struct vmw_legacy_display;
322 struct ttm_lock lock;
325 struct vmw_vga_topology_state {
335 * struct vmw_otable - Guest Memory OBject table metadata
337 * @size: Size of the table (page-aligned).
338 * @page_table: Pointer to a struct vmw_mob holding the page table.
342 struct vmw_mob *page_table;
346 struct vmw_otable_batch {
347 unsigned num_otables;
348 struct vmw_otable *otables;
349 struct vmw_resource *context;
350 struct ttm_buffer_object *otable_bo;
354 struct ttm_bo_device bdev;
355 struct ttm_bo_global_ref bo_global_ref;
356 struct drm_global_reference mem_global_ref;
358 struct vmw_fifo_state fifo;
360 struct drm_device *dev;
361 unsigned long vmw_chipset;
362 unsigned int io_start;
365 uint32_t prim_bb_mem;
368 uint32_t fb_max_width;
369 uint32_t fb_max_height;
370 uint32_t texture_max_width;
371 uint32_t texture_max_height;
372 uint32_t stdu_max_width;
373 uint32_t stdu_max_height;
374 uint32_t initial_width;
375 uint32_t initial_height;
376 u32 __iomem *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;
394 struct vmw_vga_topology_state vga_save[VMWGFX_MAX_DISPLAYS];
399 uint32_t vga_pitchlock;
401 uint32_t num_displays;
408 enum vmw_display_unit_type active_display_unit;
409 struct vmw_legacy_display *ldu_priv;
410 struct vmw_screen_object_display *sou_priv;
411 struct vmw_overlay *overlay_priv;
414 * Context and surface management.
417 rwlock_t resource_lock;
418 struct idr res_idr[vmw_res_max];
420 * Block lastclose from racing with firstopen.
423 struct mutex init_mutex;
426 * A resource manager for kernel-only surfaces and
430 struct ttm_object_device *tdev;
437 wait_queue_head_t fence_queue;
438 wait_queue_head_t fifo_queue;
439 spinlock_t waiter_lock;
440 int fence_queue_waiters; /* Protected by waiter_lock */
441 int goal_queue_waiters; /* Protected by waiter_lock */
442 int cmdbuf_waiters; /* Protected by irq_lock */
443 int error_waiters; /* Protected by irq_lock */
444 atomic_t fifo_queue_waiters;
445 uint32_t last_read_seqno;
447 struct vmw_fence_manager *fman;
454 uint32_t traces_state;
455 uint32_t enable_state;
456 uint32_t config_done_state;
462 * Protected by the cmdbuf mutex.
465 struct vmw_sw_context ctx;
466 struct mutex cmdbuf_mutex;
467 struct mutex binding_mutex;
475 spinlock_t svga_lock;
481 struct vmw_master *active_master;
482 struct vmw_master fbdev_master;
483 struct notifier_block pm_nb;
485 bool refuse_hibernation;
487 struct mutex release_mutex;
488 atomic_t num_fifo_resources;
491 * Replace this with an rwsem as soon as we have down_xx_interruptible()
493 struct ttm_lock reservation_sem;
496 * Query processing. These members
497 * are protected by the cmdbuf mutex.
500 struct vmw_dma_buffer *dummy_query_bo;
501 struct vmw_dma_buffer *pinned_bo;
503 uint32_t query_cid_valid;
504 bool dummy_query_bo_pinned;
507 * Surface swapping. The "surface_lru" list is protected by the
508 * resource lock in order to be able to destroy a surface and take
509 * it off the lru atomically. "used_memory_size" is currently
510 * protected by the cmdbuf mutex for simplicity.
513 struct list_head res_lru[vmw_res_max];
514 uint32_t used_memory_size;
519 enum vmw_dma_map_mode map_mode;
524 struct vmw_otable_batch otable_batch;
526 struct vmw_cmdbuf_man *cman;
529 static inline struct vmw_surface *vmw_res_to_srf(struct vmw_resource *res)
531 return container_of(res, struct vmw_surface, res);
534 static inline struct vmw_private *vmw_priv(struct drm_device *dev)
536 return (struct vmw_private *)dev->dev_private;
539 static inline struct vmw_fpriv *vmw_fpriv(struct drm_file *file_priv)
541 return (struct vmw_fpriv *)file_priv->driver_priv;
544 static inline struct vmw_master *vmw_master(struct drm_master *master)
546 return (struct vmw_master *) master->driver_priv;
550 * The locking here is fine-grained, so that it is performed once
551 * for every read- and write operation. This is of course costly, but we
552 * don't perform much register access in the timing critical paths anyway.
553 * Instead we have the extra benefit of being sure that we don't forget
554 * the hw lock around register accesses.
556 static inline void vmw_write(struct vmw_private *dev_priv,
557 unsigned int offset, uint32_t value)
559 unsigned long irq_flags;
561 spin_lock_irqsave(&dev_priv->hw_lock, irq_flags);
562 outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
563 outl(value, dev_priv->io_start + VMWGFX_VALUE_PORT);
564 spin_unlock_irqrestore(&dev_priv->hw_lock, irq_flags);
567 static inline uint32_t vmw_read(struct vmw_private *dev_priv,
570 unsigned long irq_flags;
573 spin_lock_irqsave(&dev_priv->hw_lock, irq_flags);
574 outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
575 val = inl(dev_priv->io_start + VMWGFX_VALUE_PORT);
576 spin_unlock_irqrestore(&dev_priv->hw_lock, irq_flags);
581 extern void vmw_svga_enable(struct vmw_private *dev_priv);
582 extern void vmw_svga_disable(struct vmw_private *dev_priv);
586 * GMR utilities - vmwgfx_gmr.c
589 extern int vmw_gmr_bind(struct vmw_private *dev_priv,
590 const struct vmw_sg_table *vsgt,
591 unsigned long num_pages,
593 extern void vmw_gmr_unbind(struct vmw_private *dev_priv, int gmr_id);
596 * Resource utilities - vmwgfx_resource.c
598 struct vmw_user_resource_conv;
600 extern void vmw_resource_unreference(struct vmw_resource **p_res);
601 extern struct vmw_resource *vmw_resource_reference(struct vmw_resource *res);
602 extern struct vmw_resource *
603 vmw_resource_reference_unless_doomed(struct vmw_resource *res);
604 extern int vmw_resource_validate(struct vmw_resource *res);
605 extern int vmw_resource_reserve(struct vmw_resource *res, bool interruptible,
607 extern bool vmw_resource_needs_backup(const struct vmw_resource *res);
608 extern int vmw_user_lookup_handle(struct vmw_private *dev_priv,
609 struct ttm_object_file *tfile,
611 struct vmw_surface **out_surf,
612 struct vmw_dma_buffer **out_buf);
613 extern int vmw_user_resource_lookup_handle(
614 struct vmw_private *dev_priv,
615 struct ttm_object_file *tfile,
617 const struct vmw_user_resource_conv *converter,
618 struct vmw_resource **p_res);
619 extern void vmw_dmabuf_bo_free(struct ttm_buffer_object *bo);
620 extern int vmw_dmabuf_init(struct vmw_private *dev_priv,
621 struct vmw_dma_buffer *vmw_bo,
622 size_t size, struct ttm_placement *placement,
624 void (*bo_free) (struct ttm_buffer_object *bo));
625 extern int vmw_user_dmabuf_verify_access(struct ttm_buffer_object *bo,
626 struct ttm_object_file *tfile);
627 extern int vmw_user_dmabuf_alloc(struct vmw_private *dev_priv,
628 struct ttm_object_file *tfile,
632 struct vmw_dma_buffer **p_dma_buf);
633 extern int vmw_user_dmabuf_reference(struct ttm_object_file *tfile,
634 struct vmw_dma_buffer *dma_buf,
636 extern int vmw_dmabuf_alloc_ioctl(struct drm_device *dev, void *data,
637 struct drm_file *file_priv);
638 extern int vmw_dmabuf_unref_ioctl(struct drm_device *dev, void *data,
639 struct drm_file *file_priv);
640 extern int vmw_user_dmabuf_synccpu_ioctl(struct drm_device *dev, void *data,
641 struct drm_file *file_priv);
642 extern uint32_t vmw_dmabuf_validate_node(struct ttm_buffer_object *bo,
643 uint32_t cur_validate_node);
644 extern void vmw_dmabuf_validate_clear(struct ttm_buffer_object *bo);
645 extern int vmw_user_dmabuf_lookup(struct ttm_object_file *tfile,
646 uint32_t id, struct vmw_dma_buffer **out);
647 extern int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
648 struct drm_file *file_priv);
649 extern int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
650 struct drm_file *file_priv);
651 extern int vmw_user_stream_lookup(struct vmw_private *dev_priv,
652 struct ttm_object_file *tfile,
654 struct vmw_resource **out);
655 extern void vmw_resource_unreserve(struct vmw_resource *res,
657 struct vmw_dma_buffer *new_backup,
658 unsigned long new_backup_offset);
659 extern void vmw_resource_move_notify(struct ttm_buffer_object *bo,
660 struct ttm_mem_reg *mem);
661 extern void vmw_fence_single_bo(struct ttm_buffer_object *bo,
662 struct vmw_fence_obj *fence);
663 extern void vmw_resource_evict_all(struct vmw_private *dev_priv);
666 * DMA buffer helper routines - vmwgfx_dmabuf.c
668 extern int vmw_dmabuf_pin_in_placement(struct vmw_private *vmw_priv,
669 struct vmw_dma_buffer *bo,
670 struct ttm_placement *placement,
672 extern int vmw_dmabuf_pin_in_vram(struct vmw_private *dev_priv,
673 struct vmw_dma_buffer *buf,
675 extern int vmw_dmabuf_pin_in_vram_or_gmr(struct vmw_private *dev_priv,
676 struct vmw_dma_buffer *buf,
678 extern int vmw_dmabuf_pin_in_start_of_vram(struct vmw_private *vmw_priv,
679 struct vmw_dma_buffer *bo,
681 extern int vmw_dmabuf_unpin(struct vmw_private *vmw_priv,
682 struct vmw_dma_buffer *bo,
684 extern void vmw_bo_get_guest_ptr(const struct ttm_buffer_object *buf,
686 extern void vmw_bo_pin_reserved(struct vmw_dma_buffer *bo, bool pin);
689 * Misc Ioctl functionality - vmwgfx_ioctl.c
692 extern int vmw_getparam_ioctl(struct drm_device *dev, void *data,
693 struct drm_file *file_priv);
694 extern int vmw_get_cap_3d_ioctl(struct drm_device *dev, void *data,
695 struct drm_file *file_priv);
696 extern int vmw_present_ioctl(struct drm_device *dev, void *data,
697 struct drm_file *file_priv);
698 extern int vmw_present_readback_ioctl(struct drm_device *dev, void *data,
699 struct drm_file *file_priv);
700 extern unsigned int vmw_fops_poll(struct file *filp,
701 struct poll_table_struct *wait);
702 extern ssize_t vmw_fops_read(struct file *filp, char __user *buffer,
703 size_t count, loff_t *offset);
706 * Fifo utilities - vmwgfx_fifo.c
709 extern int vmw_fifo_init(struct vmw_private *dev_priv,
710 struct vmw_fifo_state *fifo);
711 extern void vmw_fifo_release(struct vmw_private *dev_priv,
712 struct vmw_fifo_state *fifo);
713 extern void *vmw_fifo_reserve(struct vmw_private *dev_priv, uint32_t bytes);
715 vmw_fifo_reserve_dx(struct vmw_private *dev_priv, uint32_t bytes, int ctx_id);
716 extern void vmw_fifo_commit(struct vmw_private *dev_priv, uint32_t bytes);
717 extern void vmw_fifo_commit_flush(struct vmw_private *dev_priv, uint32_t bytes);
718 extern int vmw_fifo_send_fence(struct vmw_private *dev_priv,
720 extern void vmw_fifo_ping_host_locked(struct vmw_private *, uint32_t reason);
721 extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
722 extern bool vmw_fifo_have_3d(struct vmw_private *dev_priv);
723 extern bool vmw_fifo_have_pitchlock(struct vmw_private *dev_priv);
724 extern int vmw_fifo_emit_dummy_query(struct vmw_private *dev_priv,
726 extern int vmw_fifo_flush(struct vmw_private *dev_priv,
730 * TTM glue - vmwgfx_ttm_glue.c
733 extern int vmw_ttm_global_init(struct vmw_private *dev_priv);
734 extern void vmw_ttm_global_release(struct vmw_private *dev_priv);
735 extern int vmw_mmap(struct file *filp, struct vm_area_struct *vma);
738 * TTM buffer object driver - vmwgfx_buffer.c
741 extern const size_t vmw_tt_size;
742 extern struct ttm_placement vmw_vram_placement;
743 extern struct ttm_placement vmw_vram_ne_placement;
744 extern struct ttm_placement vmw_vram_sys_placement;
745 extern struct ttm_placement vmw_vram_gmr_placement;
746 extern struct ttm_placement vmw_vram_gmr_ne_placement;
747 extern struct ttm_placement vmw_sys_placement;
748 extern struct ttm_placement vmw_sys_ne_placement;
749 extern struct ttm_placement vmw_evictable_placement;
750 extern struct ttm_placement vmw_srf_placement;
751 extern struct ttm_placement vmw_mob_placement;
752 extern struct ttm_placement vmw_mob_ne_placement;
753 extern struct ttm_bo_driver vmw_bo_driver;
754 extern int vmw_dma_quiescent(struct drm_device *dev);
755 extern int vmw_bo_map_dma(struct ttm_buffer_object *bo);
756 extern void vmw_bo_unmap_dma(struct ttm_buffer_object *bo);
757 extern const struct vmw_sg_table *
758 vmw_bo_sg_table(struct ttm_buffer_object *bo);
759 extern void vmw_piter_start(struct vmw_piter *viter,
760 const struct vmw_sg_table *vsgt,
761 unsigned long p_offs);
764 * vmw_piter_next - Advance the iterator one page.
766 * @viter: Pointer to the iterator to advance.
768 * Returns false if past the list of pages, true otherwise.
770 static inline bool vmw_piter_next(struct vmw_piter *viter)
772 return viter->next(viter);
776 * vmw_piter_dma_addr - Return the DMA address of the current page.
778 * @viter: Pointer to the iterator
780 * Returns the DMA address of the page pointed to by @viter.
782 static inline dma_addr_t vmw_piter_dma_addr(struct vmw_piter *viter)
784 return viter->dma_address(viter);
788 * vmw_piter_page - Return a pointer to the current page.
790 * @viter: Pointer to the iterator
792 * Returns the DMA address of the page pointed to by @viter.
794 static inline struct page *vmw_piter_page(struct vmw_piter *viter)
796 return viter->page(viter);
800 * Command submission - vmwgfx_execbuf.c
803 extern int vmw_execbuf_ioctl(struct drm_device *dev, unsigned long data,
804 struct drm_file *file_priv, size_t size);
805 extern int vmw_execbuf_process(struct drm_file *file_priv,
806 struct vmw_private *dev_priv,
807 void __user *user_commands,
808 void *kernel_commands,
809 uint32_t command_size,
810 uint64_t throttle_us,
811 uint32_t dx_context_handle,
812 struct drm_vmw_fence_rep __user
814 struct vmw_fence_obj **out_fence);
815 extern void __vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv,
816 struct vmw_fence_obj *fence);
817 extern void vmw_execbuf_release_pinned_bo(struct vmw_private *dev_priv);
819 extern int vmw_execbuf_fence_commands(struct drm_file *file_priv,
820 struct vmw_private *dev_priv,
821 struct vmw_fence_obj **p_fence,
823 extern void vmw_execbuf_copy_fence_user(struct vmw_private *dev_priv,
824 struct vmw_fpriv *vmw_fp,
826 struct drm_vmw_fence_rep __user
828 struct vmw_fence_obj *fence,
829 uint32_t fence_handle);
830 extern int vmw_validate_single_buffer(struct vmw_private *dev_priv,
831 struct ttm_buffer_object *bo,
833 bool validate_as_mob);
837 * IRQs and wating - vmwgfx_irq.c
840 extern irqreturn_t vmw_irq_handler(int irq, void *arg);
841 extern int vmw_wait_seqno(struct vmw_private *dev_priv, bool lazy,
842 uint32_t seqno, bool interruptible,
843 unsigned long timeout);
844 extern void vmw_irq_preinstall(struct drm_device *dev);
845 extern int vmw_irq_postinstall(struct drm_device *dev);
846 extern void vmw_irq_uninstall(struct drm_device *dev);
847 extern bool vmw_seqno_passed(struct vmw_private *dev_priv,
849 extern int vmw_fallback_wait(struct vmw_private *dev_priv,
854 unsigned long timeout);
855 extern void vmw_update_seqno(struct vmw_private *dev_priv,
856 struct vmw_fifo_state *fifo_state);
857 extern void vmw_seqno_waiter_add(struct vmw_private *dev_priv);
858 extern void vmw_seqno_waiter_remove(struct vmw_private *dev_priv);
859 extern void vmw_goal_waiter_add(struct vmw_private *dev_priv);
860 extern void vmw_goal_waiter_remove(struct vmw_private *dev_priv);
861 extern void vmw_generic_waiter_add(struct vmw_private *dev_priv, u32 flag,
863 extern void vmw_generic_waiter_remove(struct vmw_private *dev_priv,
864 u32 flag, int *waiter_count);
867 * Rudimentary fence-like objects currently used only for throttling -
871 extern void vmw_marker_queue_init(struct vmw_marker_queue *queue);
872 extern void vmw_marker_queue_takedown(struct vmw_marker_queue *queue);
873 extern int vmw_marker_push(struct vmw_marker_queue *queue,
875 extern int vmw_marker_pull(struct vmw_marker_queue *queue,
876 uint32_t signaled_seqno);
877 extern int vmw_wait_lag(struct vmw_private *dev_priv,
878 struct vmw_marker_queue *queue, uint32_t us);
881 * Kernel framebuffer - vmwgfx_fb.c
884 int vmw_fb_init(struct vmw_private *vmw_priv);
885 int vmw_fb_close(struct vmw_private *dev_priv);
886 int vmw_fb_off(struct vmw_private *vmw_priv);
887 int vmw_fb_on(struct vmw_private *vmw_priv);
890 * Kernel modesetting - vmwgfx_kms.c
893 int vmw_kms_init(struct vmw_private *dev_priv);
894 int vmw_kms_close(struct vmw_private *dev_priv);
895 int vmw_kms_save_vga(struct vmw_private *vmw_priv);
896 int vmw_kms_restore_vga(struct vmw_private *vmw_priv);
897 int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
898 struct drm_file *file_priv);
899 void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv);
900 void vmw_kms_cursor_snoop(struct vmw_surface *srf,
901 struct ttm_object_file *tfile,
902 struct ttm_buffer_object *bo,
903 SVGA3dCmdHeader *header);
904 int vmw_kms_write_svga(struct vmw_private *vmw_priv,
905 unsigned width, unsigned height, unsigned pitch,
906 unsigned bpp, unsigned depth);
907 void vmw_kms_idle_workqueues(struct vmw_master *vmaster);
908 bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
911 u32 vmw_get_vblank_counter(struct drm_device *dev, int crtc);
912 int vmw_enable_vblank(struct drm_device *dev, int crtc);
913 void vmw_disable_vblank(struct drm_device *dev, int crtc);
914 int vmw_kms_present(struct vmw_private *dev_priv,
915 struct drm_file *file_priv,
916 struct vmw_framebuffer *vfb,
917 struct vmw_surface *surface,
918 uint32_t sid, int32_t destX, int32_t destY,
919 struct drm_vmw_rect *clips,
921 int vmw_kms_update_layout_ioctl(struct drm_device *dev, void *data,
922 struct drm_file *file_priv);
924 int vmw_dumb_create(struct drm_file *file_priv,
925 struct drm_device *dev,
926 struct drm_mode_create_dumb *args);
928 int vmw_dumb_map_offset(struct drm_file *file_priv,
929 struct drm_device *dev, uint32_t handle,
931 int vmw_dumb_destroy(struct drm_file *file_priv,
932 struct drm_device *dev,
934 extern int vmw_resource_pin(struct vmw_resource *res, bool interruptible);
935 extern void vmw_resource_unpin(struct vmw_resource *res);
936 extern enum vmw_res_type vmw_res_type(const struct vmw_resource *res);
939 * Overlay control - vmwgfx_overlay.c
942 int vmw_overlay_init(struct vmw_private *dev_priv);
943 int vmw_overlay_close(struct vmw_private *dev_priv);
944 int vmw_overlay_ioctl(struct drm_device *dev, void *data,
945 struct drm_file *file_priv);
946 int vmw_overlay_stop_all(struct vmw_private *dev_priv);
947 int vmw_overlay_resume_all(struct vmw_private *dev_priv);
948 int vmw_overlay_pause_all(struct vmw_private *dev_priv);
949 int vmw_overlay_claim(struct vmw_private *dev_priv, uint32_t *out);
950 int vmw_overlay_unref(struct vmw_private *dev_priv, uint32_t stream_id);
951 int vmw_overlay_num_overlays(struct vmw_private *dev_priv);
952 int vmw_overlay_num_free_overlays(struct vmw_private *dev_priv);
958 extern const struct ttm_mem_type_manager_func vmw_gmrid_manager_func;
961 * Prime - vmwgfx_prime.c
964 extern const struct dma_buf_ops vmw_prime_dmabuf_ops;
965 extern int vmw_prime_fd_to_handle(struct drm_device *dev,
966 struct drm_file *file_priv,
967 int fd, u32 *handle);
968 extern int vmw_prime_handle_to_fd(struct drm_device *dev,
969 struct drm_file *file_priv,
970 uint32_t handle, uint32_t flags,
974 * MemoryOBject management - vmwgfx_mob.c
977 extern int vmw_mob_bind(struct vmw_private *dev_priv, struct vmw_mob *mob,
978 const struct vmw_sg_table *vsgt,
979 unsigned long num_data_pages, int32_t mob_id);
980 extern void vmw_mob_unbind(struct vmw_private *dev_priv,
981 struct vmw_mob *mob);
982 extern void vmw_mob_destroy(struct vmw_mob *mob);
983 extern struct vmw_mob *vmw_mob_create(unsigned long data_pages);
984 extern int vmw_otables_setup(struct vmw_private *dev_priv);
985 extern void vmw_otables_takedown(struct vmw_private *dev_priv);
988 * Context management - vmwgfx_context.c
991 extern const struct vmw_user_resource_conv *user_context_converter;
993 extern int vmw_context_check(struct vmw_private *dev_priv,
994 struct ttm_object_file *tfile,
996 struct vmw_resource **p_res);
997 extern int vmw_context_define_ioctl(struct drm_device *dev, void *data,
998 struct drm_file *file_priv);
999 extern int vmw_extended_context_define_ioctl(struct drm_device *dev, void *data,
1000 struct drm_file *file_priv);
1001 extern int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
1002 struct drm_file *file_priv);
1003 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1004 extern struct vmw_cmdbuf_res_manager *
1005 vmw_context_res_man(struct vmw_resource *ctx);
1006 extern struct vmw_resource *vmw_context_cotable(struct vmw_resource *ctx,
1007 SVGACOTableType cotable_type);
1008 extern struct list_head *vmw_context_binding_list(struct vmw_resource *ctx);
1009 struct vmw_ctx_binding_state;
1010 extern struct vmw_ctx_binding_state *
1011 vmw_context_binding_state(struct vmw_resource *ctx);
1012 extern void vmw_dx_context_scrub_cotables(struct vmw_resource *ctx,
1016 * Surface management - vmwgfx_surface.c
1019 extern const struct vmw_user_resource_conv *user_surface_converter;
1021 extern void vmw_surface_res_free(struct vmw_resource *res);
1022 extern int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
1023 struct drm_file *file_priv);
1024 extern int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
1025 struct drm_file *file_priv);
1026 extern int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
1027 struct drm_file *file_priv);
1028 extern int vmw_gb_surface_define_ioctl(struct drm_device *dev, void *data,
1029 struct drm_file *file_priv);
1030 extern int vmw_gb_surface_reference_ioctl(struct drm_device *dev, void *data,
1031 struct drm_file *file_priv);
1032 extern int vmw_surface_check(struct vmw_private *dev_priv,
1033 struct ttm_object_file *tfile,
1034 uint32_t handle, int *id);
1035 extern int vmw_surface_validate(struct vmw_private *dev_priv,
1036 struct vmw_surface *srf);
1037 int vmw_surface_gb_priv_define(struct drm_device *dev,
1038 uint32_t user_accounting_size,
1039 uint32_t svga3d_flags,
1040 SVGA3dSurfaceFormat format,
1042 uint32_t num_mip_levels,
1043 uint32_t multisample_count,
1044 uint32_t array_size,
1045 struct drm_vmw_size size,
1046 struct vmw_surface **srf_out);
1049 * Shader management - vmwgfx_shader.c
1052 extern const struct vmw_user_resource_conv *user_shader_converter;
1054 extern int vmw_shader_define_ioctl(struct drm_device *dev, void *data,
1055 struct drm_file *file_priv);
1056 extern int vmw_shader_destroy_ioctl(struct drm_device *dev, void *data,
1057 struct drm_file *file_priv);
1058 extern int vmw_compat_shader_add(struct vmw_private *dev_priv,
1059 struct vmw_cmdbuf_res_manager *man,
1060 u32 user_key, const void *bytecode,
1061 SVGA3dShaderType shader_type,
1063 struct list_head *list);
1064 extern int vmw_shader_remove(struct vmw_cmdbuf_res_manager *man,
1065 u32 user_key, SVGA3dShaderType shader_type,
1066 struct list_head *list);
1067 extern int vmw_dx_shader_add(struct vmw_cmdbuf_res_manager *man,
1068 struct vmw_resource *ctx,
1070 SVGA3dShaderType shader_type,
1071 struct list_head *list);
1072 extern void vmw_dx_shader_cotable_list_scrub(struct vmw_private *dev_priv,
1073 struct list_head *list,
1076 extern struct vmw_resource *
1077 vmw_shader_lookup(struct vmw_cmdbuf_res_manager *man,
1078 u32 user_key, SVGA3dShaderType shader_type);
1081 * Command buffer managed resources - vmwgfx_cmdbuf_res.c
1084 extern struct vmw_cmdbuf_res_manager *
1085 vmw_cmdbuf_res_man_create(struct vmw_private *dev_priv);
1086 extern void vmw_cmdbuf_res_man_destroy(struct vmw_cmdbuf_res_manager *man);
1087 extern size_t vmw_cmdbuf_res_man_size(void);
1088 extern struct vmw_resource *
1089 vmw_cmdbuf_res_lookup(struct vmw_cmdbuf_res_manager *man,
1090 enum vmw_cmdbuf_res_type res_type,
1092 extern void vmw_cmdbuf_res_revert(struct list_head *list);
1093 extern void vmw_cmdbuf_res_commit(struct list_head *list);
1094 extern int vmw_cmdbuf_res_add(struct vmw_cmdbuf_res_manager *man,
1095 enum vmw_cmdbuf_res_type res_type,
1097 struct vmw_resource *res,
1098 struct list_head *list);
1099 extern int vmw_cmdbuf_res_remove(struct vmw_cmdbuf_res_manager *man,
1100 enum vmw_cmdbuf_res_type res_type,
1102 struct list_head *list,
1103 struct vmw_resource **res);
1106 * COTable management - vmwgfx_cotable.c
1108 extern const SVGACOTableType vmw_cotable_scrub_order[];
1109 extern struct vmw_resource *vmw_cotable_alloc(struct vmw_private *dev_priv,
1110 struct vmw_resource *ctx,
1112 extern int vmw_cotable_notify(struct vmw_resource *res, int id);
1113 extern int vmw_cotable_scrub(struct vmw_resource *res, bool readback);
1114 extern void vmw_cotable_add_resource(struct vmw_resource *ctx,
1115 struct list_head *head);
1118 * Command buffer managerment vmwgfx_cmdbuf.c
1120 struct vmw_cmdbuf_man;
1121 struct vmw_cmdbuf_header;
1123 extern struct vmw_cmdbuf_man *
1124 vmw_cmdbuf_man_create(struct vmw_private *dev_priv);
1125 extern int vmw_cmdbuf_set_pool_size(struct vmw_cmdbuf_man *man,
1126 size_t size, size_t default_size);
1127 extern void vmw_cmdbuf_remove_pool(struct vmw_cmdbuf_man *man);
1128 extern void vmw_cmdbuf_man_destroy(struct vmw_cmdbuf_man *man);
1129 extern int vmw_cmdbuf_idle(struct vmw_cmdbuf_man *man, bool interruptible,
1130 unsigned long timeout);
1131 extern void *vmw_cmdbuf_reserve(struct vmw_cmdbuf_man *man, size_t size,
1132 int ctx_id, bool interruptible,
1133 struct vmw_cmdbuf_header *header);
1134 extern void vmw_cmdbuf_commit(struct vmw_cmdbuf_man *man, size_t size,
1135 struct vmw_cmdbuf_header *header,
1137 extern void vmw_cmdbuf_tasklet_schedule(struct vmw_cmdbuf_man *man);
1138 extern void *vmw_cmdbuf_alloc(struct vmw_cmdbuf_man *man,
1139 size_t size, bool interruptible,
1140 struct vmw_cmdbuf_header **p_header);
1141 extern void vmw_cmdbuf_header_free(struct vmw_cmdbuf_header *header);
1142 extern int vmw_cmdbuf_cur_flush(struct vmw_cmdbuf_man *man,
1143 bool interruptible);
1147 * Inline helper functions
1150 static inline void vmw_surface_unreference(struct vmw_surface **srf)
1152 struct vmw_surface *tmp_srf = *srf;
1153 struct vmw_resource *res = &tmp_srf->res;
1156 vmw_resource_unreference(&res);
1159 static inline struct vmw_surface *vmw_surface_reference(struct vmw_surface *srf)
1161 (void) vmw_resource_reference(&srf->res);
1165 static inline void vmw_dmabuf_unreference(struct vmw_dma_buffer **buf)
1167 struct vmw_dma_buffer *tmp_buf = *buf;
1170 if (tmp_buf != NULL) {
1171 struct ttm_buffer_object *bo = &tmp_buf->base;
1177 static inline struct vmw_dma_buffer *vmw_dmabuf_reference(struct vmw_dma_buffer *buf)
1179 if (ttm_bo_reference(&buf->base))
1184 static inline struct ttm_mem_global *vmw_mem_glob(struct vmw_private *dev_priv)
1186 return (struct ttm_mem_global *) dev_priv->mem_global_ref.object;
1189 static inline void vmw_fifo_resource_inc(struct vmw_private *dev_priv)
1191 atomic_inc(&dev_priv->num_fifo_resources);
1194 static inline void vmw_fifo_resource_dec(struct vmw_private *dev_priv)
1196 atomic_dec(&dev_priv->num_fifo_resources);