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