1 /**************************************************************************
3 * Copyright © 2009 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 "vmwgfx_drm.h"
34 #include "drm_hashtab.h"
35 #include "linux/suspend.h"
36 #include "ttm/ttm_bo_driver.h"
37 #include "ttm/ttm_object.h"
38 #include "ttm/ttm_lock.h"
39 #include "ttm/ttm_execbuf_util.h"
40 #include "ttm/ttm_module.h"
42 #define VMWGFX_DRIVER_DATE "20100209"
43 #define VMWGFX_DRIVER_MAJOR 1
44 #define VMWGFX_DRIVER_MINOR 1
45 #define VMWGFX_DRIVER_PATCHLEVEL 0
46 #define VMWGFX_FILE_PAGE_OFFSET 0x00100000
47 #define VMWGFX_FIFO_STATIC_SIZE (1024*1024)
48 #define VMWGFX_MAX_RELOCATIONS 2048
49 #define VMWGFX_MAX_GMRS 2048
52 struct drm_master *locked_master;
53 struct ttm_object_file *tfile;
56 struct vmw_dma_buffer {
57 struct ttm_buffer_object base;
58 struct list_head validate_list;
59 struct list_head gmr_lru;
62 uint32_t cur_validate_node;
63 bool on_validate_list;
68 struct vmw_private *dev_priv;
71 enum ttm_object_type res_type;
73 void (*hw_destroy) (struct vmw_resource *res);
74 void (*res_free) (struct vmw_resource *res);
76 /* TODO is a generic snooper needed? */
78 void (*snoop)(struct vmw_resource *res,
79 struct ttm_object_file *tfile,
80 SVGA3dCmdHeader *header);
85 struct vmw_cursor_snooper {
86 struct drm_crtc *crtc;
92 struct vmw_resource res;
95 uint32_t mip_levels[DRM_VMW_MAX_SURFACE_FACES];
96 struct drm_vmw_size *sizes;
101 /* TODO so far just a extra pointer */
102 struct vmw_cursor_snooper snooper;
105 struct vmw_fence_queue {
106 struct list_head head;
108 struct timespec lag_time;
112 struct vmw_fifo_state {
113 unsigned long reserved_size;
114 __le32 *dynamic_buffer;
115 __le32 *static_buffer;
117 uint32_t last_data_size;
118 uint32_t last_buffer_size;
119 bool last_buffer_add;
120 unsigned long static_buffer_size;
121 bool using_bounce_buffer;
122 uint32_t capabilities;
123 struct mutex fifo_mutex;
124 struct rw_semaphore rwsem;
125 struct vmw_fence_queue fence_queue;
128 struct vmw_relocation {
129 SVGAGuestPtr *location;
133 struct vmw_sw_context{
138 uint32_t sid_translation;
140 struct ttm_object_file *tfile;
141 struct list_head validate_nodes;
142 struct vmw_relocation relocs[VMWGFX_MAX_RELOCATIONS];
144 struct ttm_validate_buffer val_bufs[VMWGFX_MAX_GMRS];
145 uint32_t cur_val_buf;
148 struct vmw_legacy_display;
152 struct ttm_lock lock;
156 struct ttm_bo_device bdev;
157 struct ttm_bo_global_ref bo_global_ref;
158 struct ttm_global_reference mem_global_ref;
160 struct vmw_fifo_state fifo;
162 struct drm_device *dev;
163 unsigned long vmw_chipset;
164 unsigned int io_start;
169 uint32_t fb_max_width;
170 uint32_t fb_max_height;
171 __le32 __iomem *mmio_virt;
173 uint32_t capabilities;
174 uint32_t max_gmr_descriptors;
175 uint32_t max_gmr_ids;
176 struct mutex hw_mutex;
187 uint32_t vga_red_mask;
188 uint32_t vga_blue_mask;
189 uint32_t vga_green_mask;
190 uint32_t vga_pitchlock;
197 struct vmw_legacy_display *ldu_priv;
198 struct vmw_overlay *overlay_priv;
201 * Context and surface management.
204 rwlock_t resource_lock;
205 struct idr context_idr;
206 struct idr surface_idr;
207 struct idr stream_idr;
210 * Block lastclose from racing with firstopen.
213 struct mutex init_mutex;
216 * A resource manager for kernel-only surfaces and
220 struct ttm_object_device *tdev;
227 wait_queue_head_t fence_queue;
228 wait_queue_head_t fifo_queue;
229 atomic_t fence_queue_waiters;
230 atomic_t fifo_queue_waiters;
231 uint32_t last_read_sequence;
238 uint32_t traces_state;
239 uint32_t enable_state;
240 uint32_t config_done_state;
246 * Protected by the cmdbuf mutex.
249 struct vmw_sw_context ctx;
251 struct mutex cmdbuf_mutex;
254 * GMR management. Protected by the lru spinlock.
258 struct list_head gmr_lru;
272 struct vmw_master *active_master;
273 struct vmw_master fbdev_master;
274 struct notifier_block pm_nb;
277 static inline struct vmw_private *vmw_priv(struct drm_device *dev)
279 return (struct vmw_private *)dev->dev_private;
282 static inline struct vmw_fpriv *vmw_fpriv(struct drm_file *file_priv)
284 return (struct vmw_fpriv *)file_priv->driver_priv;
287 static inline struct vmw_master *vmw_master(struct drm_master *master)
289 return (struct vmw_master *) master->driver_priv;
292 static inline void vmw_write(struct vmw_private *dev_priv,
293 unsigned int offset, uint32_t value)
295 outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
296 outl(value, dev_priv->io_start + VMWGFX_VALUE_PORT);
299 static inline uint32_t vmw_read(struct vmw_private *dev_priv,
304 outl(offset, dev_priv->io_start + VMWGFX_INDEX_PORT);
305 val = inl(dev_priv->io_start + VMWGFX_VALUE_PORT);
310 * GMR utilities - vmwgfx_gmr.c
313 extern int vmw_gmr_bind(struct vmw_private *dev_priv,
314 struct ttm_buffer_object *bo);
315 extern void vmw_gmr_unbind(struct vmw_private *dev_priv, int gmr_id);
318 * Resource utilities - vmwgfx_resource.c
321 extern struct vmw_resource *vmw_context_alloc(struct vmw_private *dev_priv);
322 extern void vmw_resource_unreference(struct vmw_resource **p_res);
323 extern struct vmw_resource *vmw_resource_reference(struct vmw_resource *res);
324 extern int vmw_context_destroy_ioctl(struct drm_device *dev, void *data,
325 struct drm_file *file_priv);
326 extern int vmw_context_define_ioctl(struct drm_device *dev, void *data,
327 struct drm_file *file_priv);
328 extern int vmw_context_check(struct vmw_private *dev_priv,
329 struct ttm_object_file *tfile,
331 extern void vmw_surface_res_free(struct vmw_resource *res);
332 extern int vmw_surface_init(struct vmw_private *dev_priv,
333 struct vmw_surface *srf,
334 void (*res_free) (struct vmw_resource *res));
335 extern int vmw_user_surface_lookup_handle(struct vmw_private *dev_priv,
336 struct ttm_object_file *tfile,
338 struct vmw_surface **out);
339 extern int vmw_surface_destroy_ioctl(struct drm_device *dev, void *data,
340 struct drm_file *file_priv);
341 extern int vmw_surface_define_ioctl(struct drm_device *dev, void *data,
342 struct drm_file *file_priv);
343 extern int vmw_surface_reference_ioctl(struct drm_device *dev, void *data,
344 struct drm_file *file_priv);
345 extern int vmw_surface_check(struct vmw_private *dev_priv,
346 struct ttm_object_file *tfile,
347 uint32_t handle, int *id);
348 extern void vmw_dmabuf_bo_free(struct ttm_buffer_object *bo);
349 extern int vmw_dmabuf_init(struct vmw_private *dev_priv,
350 struct vmw_dma_buffer *vmw_bo,
351 size_t size, struct ttm_placement *placement,
353 void (*bo_free) (struct ttm_buffer_object *bo));
354 extern int vmw_dmabuf_alloc_ioctl(struct drm_device *dev, void *data,
355 struct drm_file *file_priv);
356 extern int vmw_dmabuf_unref_ioctl(struct drm_device *dev, void *data,
357 struct drm_file *file_priv);
358 extern uint32_t vmw_dmabuf_validate_node(struct ttm_buffer_object *bo,
359 uint32_t cur_validate_node);
360 extern void vmw_dmabuf_validate_clear(struct ttm_buffer_object *bo);
361 extern int vmw_user_dmabuf_lookup(struct ttm_object_file *tfile,
362 uint32_t id, struct vmw_dma_buffer **out);
363 extern uint32_t vmw_dmabuf_gmr(struct ttm_buffer_object *bo);
364 extern void vmw_dmabuf_set_gmr(struct ttm_buffer_object *bo, uint32_t id);
365 extern int vmw_gmr_id_alloc(struct vmw_private *dev_priv, uint32_t *p_id);
366 extern int vmw_dmabuf_to_start_of_vram(struct vmw_private *vmw_priv,
367 struct vmw_dma_buffer *bo);
368 extern int vmw_dmabuf_from_vram(struct vmw_private *vmw_priv,
369 struct vmw_dma_buffer *bo);
370 extern void vmw_dmabuf_gmr_unbind(struct ttm_buffer_object *bo);
371 extern int vmw_stream_claim_ioctl(struct drm_device *dev, void *data,
372 struct drm_file *file_priv);
373 extern int vmw_stream_unref_ioctl(struct drm_device *dev, void *data,
374 struct drm_file *file_priv);
375 extern int vmw_user_stream_lookup(struct vmw_private *dev_priv,
376 struct ttm_object_file *tfile,
378 struct vmw_resource **out);
382 * Misc Ioctl functionality - vmwgfx_ioctl.c
385 extern int vmw_getparam_ioctl(struct drm_device *dev, void *data,
386 struct drm_file *file_priv);
387 extern int vmw_fifo_debug_ioctl(struct drm_device *dev, void *data,
388 struct drm_file *file_priv);
391 * Fifo utilities - vmwgfx_fifo.c
394 extern int vmw_fifo_init(struct vmw_private *dev_priv,
395 struct vmw_fifo_state *fifo);
396 extern void vmw_fifo_release(struct vmw_private *dev_priv,
397 struct vmw_fifo_state *fifo);
398 extern void *vmw_fifo_reserve(struct vmw_private *dev_priv, uint32_t bytes);
399 extern void vmw_fifo_commit(struct vmw_private *dev_priv, uint32_t bytes);
400 extern int vmw_fifo_send_fence(struct vmw_private *dev_priv,
402 extern void vmw_fifo_ping_host(struct vmw_private *dev_priv, uint32_t reason);
403 extern int vmw_fifo_mmap(struct file *filp, struct vm_area_struct *vma);
404 extern bool vmw_fifo_have_3d(struct vmw_private *dev_priv);
405 extern bool vmw_fifo_have_pitchlock(struct vmw_private *dev_priv);
408 * TTM glue - vmwgfx_ttm_glue.c
411 extern int vmw_ttm_global_init(struct vmw_private *dev_priv);
412 extern void vmw_ttm_global_release(struct vmw_private *dev_priv);
413 extern int vmw_mmap(struct file *filp, struct vm_area_struct *vma);
416 * TTM buffer object driver - vmwgfx_buffer.c
419 extern struct ttm_placement vmw_vram_placement;
420 extern struct ttm_placement vmw_vram_ne_placement;
421 extern struct ttm_placement vmw_vram_sys_placement;
422 extern struct ttm_placement vmw_sys_placement;
423 extern struct ttm_bo_driver vmw_bo_driver;
424 extern int vmw_dma_quiescent(struct drm_device *dev);
427 * Command submission - vmwgfx_execbuf.c
430 extern int vmw_execbuf_ioctl(struct drm_device *dev, void *data,
431 struct drm_file *file_priv);
434 * IRQs and wating - vmwgfx_irq.c
437 extern irqreturn_t vmw_irq_handler(DRM_IRQ_ARGS);
438 extern int vmw_wait_fence(struct vmw_private *dev_priv, bool lazy,
439 uint32_t sequence, bool interruptible,
440 unsigned long timeout);
441 extern void vmw_irq_preinstall(struct drm_device *dev);
442 extern int vmw_irq_postinstall(struct drm_device *dev);
443 extern void vmw_irq_uninstall(struct drm_device *dev);
444 extern bool vmw_fence_signaled(struct vmw_private *dev_priv,
446 extern int vmw_fence_wait_ioctl(struct drm_device *dev, void *data,
447 struct drm_file *file_priv);
448 extern int vmw_fallback_wait(struct vmw_private *dev_priv,
453 unsigned long timeout);
454 extern void vmw_update_sequence(struct vmw_private *dev_priv,
455 struct vmw_fifo_state *fifo_state);
459 * Rudimentary fence objects currently used only for throttling -
463 extern void vmw_fence_queue_init(struct vmw_fence_queue *queue);
464 extern void vmw_fence_queue_takedown(struct vmw_fence_queue *queue);
465 extern int vmw_fence_push(struct vmw_fence_queue *queue,
467 extern int vmw_fence_pull(struct vmw_fence_queue *queue,
468 uint32_t signaled_sequence);
469 extern int vmw_wait_lag(struct vmw_private *dev_priv,
470 struct vmw_fence_queue *queue, uint32_t us);
473 * Kernel framebuffer - vmwgfx_fb.c
476 int vmw_fb_init(struct vmw_private *vmw_priv);
477 int vmw_fb_close(struct vmw_private *dev_priv);
478 int vmw_fb_off(struct vmw_private *vmw_priv);
479 int vmw_fb_on(struct vmw_private *vmw_priv);
482 * Kernel modesetting - vmwgfx_kms.c
485 int vmw_kms_init(struct vmw_private *dev_priv);
486 int vmw_kms_close(struct vmw_private *dev_priv);
487 int vmw_kms_save_vga(struct vmw_private *vmw_priv);
488 int vmw_kms_restore_vga(struct vmw_private *vmw_priv);
489 int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
490 struct drm_file *file_priv);
491 void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv);
492 void vmw_kms_cursor_snoop(struct vmw_surface *srf,
493 struct ttm_object_file *tfile,
494 struct ttm_buffer_object *bo,
495 SVGA3dCmdHeader *header);
496 void vmw_kms_write_svga(struct vmw_private *vmw_priv,
497 unsigned width, unsigned height, unsigned pitch,
498 unsigned bbp, unsigned depth);
501 * Overlay control - vmwgfx_overlay.c
504 int vmw_overlay_init(struct vmw_private *dev_priv);
505 int vmw_overlay_close(struct vmw_private *dev_priv);
506 int vmw_overlay_ioctl(struct drm_device *dev, void *data,
507 struct drm_file *file_priv);
508 int vmw_overlay_stop_all(struct vmw_private *dev_priv);
509 int vmw_overlay_resume_all(struct vmw_private *dev_priv);
510 int vmw_overlay_pause_all(struct vmw_private *dev_priv);
511 int vmw_overlay_claim(struct vmw_private *dev_priv, uint32_t *out);
512 int vmw_overlay_unref(struct vmw_private *dev_priv, uint32_t stream_id);
513 int vmw_overlay_num_overlays(struct vmw_private *dev_priv);
514 int vmw_overlay_num_free_overlays(struct vmw_private *dev_priv);
517 * Inline helper functions
520 static inline void vmw_surface_unreference(struct vmw_surface **srf)
522 struct vmw_surface *tmp_srf = *srf;
523 struct vmw_resource *res = &tmp_srf->res;
526 vmw_resource_unreference(&res);
529 static inline struct vmw_surface *vmw_surface_reference(struct vmw_surface *srf)
531 (void) vmw_resource_reference(&srf->res);
535 static inline void vmw_dmabuf_unreference(struct vmw_dma_buffer **buf)
537 struct vmw_dma_buffer *tmp_buf = *buf;
538 struct ttm_buffer_object *bo = &tmp_buf->base;
544 static inline struct vmw_dma_buffer *vmw_dmabuf_reference(struct vmw_dma_buffer *buf)
546 if (ttm_bo_reference(&buf->base))