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