Merge remote-tracking branches 'asoc/fix/tlv320aic3x' and 'asoc/fix/wm8962' into...
[linux-drm-fsl-dcu.git] / drivers / gpu / drm / vmwgfx / vmwgfx_drv.c
1 /**************************************************************************
2  *
3  * Copyright © 2009-2015 VMware, Inc., Palo Alto, CA., USA
4  * All Rights Reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the
8  * "Software"), to deal in the Software without restriction, including
9  * without limitation the rights to use, copy, modify, merge, publish,
10  * distribute, sub license, and/or sell copies of the Software, and to
11  * permit persons to whom the Software is furnished to do so, subject to
12  * the following conditions:
13  *
14  * The above copyright notice and this permission notice (including the
15  * next paragraph) shall be included in all copies or substantial portions
16  * of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
21  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
25  *
26  **************************************************************************/
27 #include <linux/module.h>
28
29 #include <drm/drmP.h>
30 #include "vmwgfx_drv.h"
31 #include "vmwgfx_binding.h"
32 #include <drm/ttm/ttm_placement.h>
33 #include <drm/ttm/ttm_bo_driver.h>
34 #include <drm/ttm/ttm_object.h>
35 #include <drm/ttm/ttm_module.h>
36 #include <linux/dma_remapping.h>
37
38 #define VMWGFX_DRIVER_NAME "vmwgfx"
39 #define VMWGFX_DRIVER_DESC "Linux drm driver for VMware graphics devices"
40 #define VMWGFX_CHIP_SVGAII 0
41 #define VMW_FB_RESERVATION 0
42
43 #define VMW_MIN_INITIAL_WIDTH 800
44 #define VMW_MIN_INITIAL_HEIGHT 600
45
46
47 /**
48  * Fully encoded drm commands. Might move to vmw_drm.h
49  */
50
51 #define DRM_IOCTL_VMW_GET_PARAM                                 \
52         DRM_IOWR(DRM_COMMAND_BASE + DRM_VMW_GET_PARAM,          \
53                  struct drm_vmw_getparam_arg)
54 #define DRM_IOCTL_VMW_ALLOC_DMABUF                              \
55         DRM_IOWR(DRM_COMMAND_BASE + DRM_VMW_ALLOC_DMABUF,       \
56                 union drm_vmw_alloc_dmabuf_arg)
57 #define DRM_IOCTL_VMW_UNREF_DMABUF                              \
58         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_UNREF_DMABUF,        \
59                 struct drm_vmw_unref_dmabuf_arg)
60 #define DRM_IOCTL_VMW_CURSOR_BYPASS                             \
61         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_CURSOR_BYPASS,       \
62                  struct drm_vmw_cursor_bypass_arg)
63
64 #define DRM_IOCTL_VMW_CONTROL_STREAM                            \
65         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_CONTROL_STREAM,      \
66                  struct drm_vmw_control_stream_arg)
67 #define DRM_IOCTL_VMW_CLAIM_STREAM                              \
68         DRM_IOR(DRM_COMMAND_BASE + DRM_VMW_CLAIM_STREAM,        \
69                  struct drm_vmw_stream_arg)
70 #define DRM_IOCTL_VMW_UNREF_STREAM                              \
71         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_UNREF_STREAM,        \
72                  struct drm_vmw_stream_arg)
73
74 #define DRM_IOCTL_VMW_CREATE_CONTEXT                            \
75         DRM_IOR(DRM_COMMAND_BASE + DRM_VMW_CREATE_CONTEXT,      \
76                 struct drm_vmw_context_arg)
77 #define DRM_IOCTL_VMW_UNREF_CONTEXT                             \
78         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_UNREF_CONTEXT,       \
79                 struct drm_vmw_context_arg)
80 #define DRM_IOCTL_VMW_CREATE_SURFACE                            \
81         DRM_IOWR(DRM_COMMAND_BASE + DRM_VMW_CREATE_SURFACE,     \
82                  union drm_vmw_surface_create_arg)
83 #define DRM_IOCTL_VMW_UNREF_SURFACE                             \
84         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_UNREF_SURFACE,       \
85                  struct drm_vmw_surface_arg)
86 #define DRM_IOCTL_VMW_REF_SURFACE                               \
87         DRM_IOWR(DRM_COMMAND_BASE + DRM_VMW_REF_SURFACE,        \
88                  union drm_vmw_surface_reference_arg)
89 #define DRM_IOCTL_VMW_EXECBUF                                   \
90         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_EXECBUF,             \
91                 struct drm_vmw_execbuf_arg)
92 #define DRM_IOCTL_VMW_GET_3D_CAP                                \
93         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_GET_3D_CAP,          \
94                  struct drm_vmw_get_3d_cap_arg)
95 #define DRM_IOCTL_VMW_FENCE_WAIT                                \
96         DRM_IOWR(DRM_COMMAND_BASE + DRM_VMW_FENCE_WAIT,         \
97                  struct drm_vmw_fence_wait_arg)
98 #define DRM_IOCTL_VMW_FENCE_SIGNALED                            \
99         DRM_IOWR(DRM_COMMAND_BASE + DRM_VMW_FENCE_SIGNALED,     \
100                  struct drm_vmw_fence_signaled_arg)
101 #define DRM_IOCTL_VMW_FENCE_UNREF                               \
102         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_FENCE_UNREF,         \
103                  struct drm_vmw_fence_arg)
104 #define DRM_IOCTL_VMW_FENCE_EVENT                               \
105         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_FENCE_EVENT,         \
106                  struct drm_vmw_fence_event_arg)
107 #define DRM_IOCTL_VMW_PRESENT                                   \
108         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_PRESENT,             \
109                  struct drm_vmw_present_arg)
110 #define DRM_IOCTL_VMW_PRESENT_READBACK                          \
111         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_PRESENT_READBACK,    \
112                  struct drm_vmw_present_readback_arg)
113 #define DRM_IOCTL_VMW_UPDATE_LAYOUT                             \
114         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_UPDATE_LAYOUT,       \
115                  struct drm_vmw_update_layout_arg)
116 #define DRM_IOCTL_VMW_CREATE_SHADER                             \
117         DRM_IOWR(DRM_COMMAND_BASE + DRM_VMW_CREATE_SHADER,      \
118                  struct drm_vmw_shader_create_arg)
119 #define DRM_IOCTL_VMW_UNREF_SHADER                              \
120         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_UNREF_SHADER,        \
121                  struct drm_vmw_shader_arg)
122 #define DRM_IOCTL_VMW_GB_SURFACE_CREATE                         \
123         DRM_IOWR(DRM_COMMAND_BASE + DRM_VMW_GB_SURFACE_CREATE,  \
124                  union drm_vmw_gb_surface_create_arg)
125 #define DRM_IOCTL_VMW_GB_SURFACE_REF                            \
126         DRM_IOWR(DRM_COMMAND_BASE + DRM_VMW_GB_SURFACE_REF,     \
127                  union drm_vmw_gb_surface_reference_arg)
128 #define DRM_IOCTL_VMW_SYNCCPU                                   \
129         DRM_IOW(DRM_COMMAND_BASE + DRM_VMW_SYNCCPU,             \
130                  struct drm_vmw_synccpu_arg)
131 #define DRM_IOCTL_VMW_CREATE_EXTENDED_CONTEXT                   \
132         DRM_IOWR(DRM_COMMAND_BASE + DRM_VMW_CREATE_EXTENDED_CONTEXT,    \
133                 struct drm_vmw_context_arg)
134
135 /**
136  * The core DRM version of this macro doesn't account for
137  * DRM_COMMAND_BASE.
138  */
139
140 #define VMW_IOCTL_DEF(ioctl, func, flags) \
141   [DRM_IOCTL_NR(DRM_IOCTL_##ioctl) - DRM_COMMAND_BASE] = {DRM_IOCTL_##ioctl, flags, func}
142
143 /**
144  * Ioctl definitions.
145  */
146
147 static const struct drm_ioctl_desc vmw_ioctls[] = {
148         VMW_IOCTL_DEF(VMW_GET_PARAM, vmw_getparam_ioctl,
149                       DRM_AUTH | DRM_UNLOCKED | DRM_RENDER_ALLOW),
150         VMW_IOCTL_DEF(VMW_ALLOC_DMABUF, vmw_dmabuf_alloc_ioctl,
151                       DRM_AUTH | DRM_UNLOCKED | DRM_RENDER_ALLOW),
152         VMW_IOCTL_DEF(VMW_UNREF_DMABUF, vmw_dmabuf_unref_ioctl,
153                       DRM_UNLOCKED | DRM_RENDER_ALLOW),
154         VMW_IOCTL_DEF(VMW_CURSOR_BYPASS,
155                       vmw_kms_cursor_bypass_ioctl,
156                       DRM_MASTER | DRM_CONTROL_ALLOW | DRM_UNLOCKED),
157
158         VMW_IOCTL_DEF(VMW_CONTROL_STREAM, vmw_overlay_ioctl,
159                       DRM_MASTER | DRM_CONTROL_ALLOW | DRM_UNLOCKED),
160         VMW_IOCTL_DEF(VMW_CLAIM_STREAM, vmw_stream_claim_ioctl,
161                       DRM_MASTER | DRM_CONTROL_ALLOW | DRM_UNLOCKED),
162         VMW_IOCTL_DEF(VMW_UNREF_STREAM, vmw_stream_unref_ioctl,
163                       DRM_MASTER | DRM_CONTROL_ALLOW | DRM_UNLOCKED),
164
165         VMW_IOCTL_DEF(VMW_CREATE_CONTEXT, vmw_context_define_ioctl,
166                       DRM_AUTH | DRM_UNLOCKED | DRM_RENDER_ALLOW),
167         VMW_IOCTL_DEF(VMW_UNREF_CONTEXT, vmw_context_destroy_ioctl,
168                       DRM_UNLOCKED | DRM_RENDER_ALLOW),
169         VMW_IOCTL_DEF(VMW_CREATE_SURFACE, vmw_surface_define_ioctl,
170                       DRM_AUTH | DRM_UNLOCKED | DRM_RENDER_ALLOW),
171         VMW_IOCTL_DEF(VMW_UNREF_SURFACE, vmw_surface_destroy_ioctl,
172                       DRM_UNLOCKED | DRM_RENDER_ALLOW),
173         VMW_IOCTL_DEF(VMW_REF_SURFACE, vmw_surface_reference_ioctl,
174                       DRM_AUTH | DRM_UNLOCKED | DRM_RENDER_ALLOW),
175         VMW_IOCTL_DEF(VMW_EXECBUF, NULL, DRM_AUTH | DRM_UNLOCKED |
176                       DRM_RENDER_ALLOW),
177         VMW_IOCTL_DEF(VMW_FENCE_WAIT, vmw_fence_obj_wait_ioctl,
178                       DRM_UNLOCKED | DRM_RENDER_ALLOW),
179         VMW_IOCTL_DEF(VMW_FENCE_SIGNALED,
180                       vmw_fence_obj_signaled_ioctl,
181                       DRM_UNLOCKED | DRM_RENDER_ALLOW),
182         VMW_IOCTL_DEF(VMW_FENCE_UNREF, vmw_fence_obj_unref_ioctl,
183                       DRM_UNLOCKED | DRM_RENDER_ALLOW),
184         VMW_IOCTL_DEF(VMW_FENCE_EVENT, vmw_fence_event_ioctl,
185                       DRM_AUTH | DRM_UNLOCKED | DRM_RENDER_ALLOW),
186         VMW_IOCTL_DEF(VMW_GET_3D_CAP, vmw_get_cap_3d_ioctl,
187                       DRM_AUTH | DRM_UNLOCKED | DRM_RENDER_ALLOW),
188
189         /* these allow direct access to the framebuffers mark as master only */
190         VMW_IOCTL_DEF(VMW_PRESENT, vmw_present_ioctl,
191                       DRM_MASTER | DRM_AUTH | DRM_UNLOCKED),
192         VMW_IOCTL_DEF(VMW_PRESENT_READBACK,
193                       vmw_present_readback_ioctl,
194                       DRM_MASTER | DRM_AUTH | DRM_UNLOCKED),
195         VMW_IOCTL_DEF(VMW_UPDATE_LAYOUT,
196                       vmw_kms_update_layout_ioctl,
197                       DRM_MASTER | DRM_UNLOCKED),
198         VMW_IOCTL_DEF(VMW_CREATE_SHADER,
199                       vmw_shader_define_ioctl,
200                       DRM_AUTH | DRM_UNLOCKED | DRM_RENDER_ALLOW),
201         VMW_IOCTL_DEF(VMW_UNREF_SHADER,
202                       vmw_shader_destroy_ioctl,
203                       DRM_UNLOCKED | DRM_RENDER_ALLOW),
204         VMW_IOCTL_DEF(VMW_GB_SURFACE_CREATE,
205                       vmw_gb_surface_define_ioctl,
206                       DRM_AUTH | DRM_UNLOCKED | DRM_RENDER_ALLOW),
207         VMW_IOCTL_DEF(VMW_GB_SURFACE_REF,
208                       vmw_gb_surface_reference_ioctl,
209                       DRM_AUTH | DRM_UNLOCKED | DRM_RENDER_ALLOW),
210         VMW_IOCTL_DEF(VMW_SYNCCPU,
211                       vmw_user_dmabuf_synccpu_ioctl,
212                       DRM_UNLOCKED | DRM_RENDER_ALLOW),
213         VMW_IOCTL_DEF(VMW_CREATE_EXTENDED_CONTEXT,
214                       vmw_extended_context_define_ioctl,
215                       DRM_AUTH | DRM_UNLOCKED | DRM_RENDER_ALLOW),
216 };
217
218 static struct pci_device_id vmw_pci_id_list[] = {
219         {0x15ad, 0x0405, PCI_ANY_ID, PCI_ANY_ID, 0, 0, VMWGFX_CHIP_SVGAII},
220         {0, 0, 0}
221 };
222 MODULE_DEVICE_TABLE(pci, vmw_pci_id_list);
223
224 static int enable_fbdev = IS_ENABLED(CONFIG_DRM_VMWGFX_FBCON);
225 static int vmw_force_iommu;
226 static int vmw_restrict_iommu;
227 static int vmw_force_coherent;
228 static int vmw_restrict_dma_mask;
229
230 static int vmw_probe(struct pci_dev *, const struct pci_device_id *);
231 static void vmw_master_init(struct vmw_master *);
232 static int vmwgfx_pm_notifier(struct notifier_block *nb, unsigned long val,
233                               void *ptr);
234
235 MODULE_PARM_DESC(enable_fbdev, "Enable vmwgfx fbdev");
236 module_param_named(enable_fbdev, enable_fbdev, int, 0600);
237 MODULE_PARM_DESC(force_dma_api, "Force using the DMA API for TTM pages");
238 module_param_named(force_dma_api, vmw_force_iommu, int, 0600);
239 MODULE_PARM_DESC(restrict_iommu, "Try to limit IOMMU usage for TTM pages");
240 module_param_named(restrict_iommu, vmw_restrict_iommu, int, 0600);
241 MODULE_PARM_DESC(force_coherent, "Force coherent TTM pages");
242 module_param_named(force_coherent, vmw_force_coherent, int, 0600);
243 MODULE_PARM_DESC(restrict_dma_mask, "Restrict DMA mask to 44 bits with IOMMU");
244 module_param_named(restrict_dma_mask, vmw_restrict_dma_mask, int, 0600);
245
246
247 static void vmw_print_capabilities(uint32_t capabilities)
248 {
249         DRM_INFO("Capabilities:\n");
250         if (capabilities & SVGA_CAP_RECT_COPY)
251                 DRM_INFO("  Rect copy.\n");
252         if (capabilities & SVGA_CAP_CURSOR)
253                 DRM_INFO("  Cursor.\n");
254         if (capabilities & SVGA_CAP_CURSOR_BYPASS)
255                 DRM_INFO("  Cursor bypass.\n");
256         if (capabilities & SVGA_CAP_CURSOR_BYPASS_2)
257                 DRM_INFO("  Cursor bypass 2.\n");
258         if (capabilities & SVGA_CAP_8BIT_EMULATION)
259                 DRM_INFO("  8bit emulation.\n");
260         if (capabilities & SVGA_CAP_ALPHA_CURSOR)
261                 DRM_INFO("  Alpha cursor.\n");
262         if (capabilities & SVGA_CAP_3D)
263                 DRM_INFO("  3D.\n");
264         if (capabilities & SVGA_CAP_EXTENDED_FIFO)
265                 DRM_INFO("  Extended Fifo.\n");
266         if (capabilities & SVGA_CAP_MULTIMON)
267                 DRM_INFO("  Multimon.\n");
268         if (capabilities & SVGA_CAP_PITCHLOCK)
269                 DRM_INFO("  Pitchlock.\n");
270         if (capabilities & SVGA_CAP_IRQMASK)
271                 DRM_INFO("  Irq mask.\n");
272         if (capabilities & SVGA_CAP_DISPLAY_TOPOLOGY)
273                 DRM_INFO("  Display Topology.\n");
274         if (capabilities & SVGA_CAP_GMR)
275                 DRM_INFO("  GMR.\n");
276         if (capabilities & SVGA_CAP_TRACES)
277                 DRM_INFO("  Traces.\n");
278         if (capabilities & SVGA_CAP_GMR2)
279                 DRM_INFO("  GMR2.\n");
280         if (capabilities & SVGA_CAP_SCREEN_OBJECT_2)
281                 DRM_INFO("  Screen Object 2.\n");
282         if (capabilities & SVGA_CAP_COMMAND_BUFFERS)
283                 DRM_INFO("  Command Buffers.\n");
284         if (capabilities & SVGA_CAP_CMD_BUFFERS_2)
285                 DRM_INFO("  Command Buffers 2.\n");
286         if (capabilities & SVGA_CAP_GBOBJECTS)
287                 DRM_INFO("  Guest Backed Resources.\n");
288         if (capabilities & SVGA_CAP_DX)
289                 DRM_INFO("  DX Features.\n");
290 }
291
292 /**
293  * vmw_dummy_query_bo_create - create a bo to hold a dummy query result
294  *
295  * @dev_priv: A device private structure.
296  *
297  * This function creates a small buffer object that holds the query
298  * result for dummy queries emitted as query barriers.
299  * The function will then map the first page and initialize a pending
300  * occlusion query result structure, Finally it will unmap the buffer.
301  * No interruptible waits are done within this function.
302  *
303  * Returns an error if bo creation or initialization fails.
304  */
305 static int vmw_dummy_query_bo_create(struct vmw_private *dev_priv)
306 {
307         int ret;
308         struct vmw_dma_buffer *vbo;
309         struct ttm_bo_kmap_obj map;
310         volatile SVGA3dQueryResult *result;
311         bool dummy;
312
313         /*
314          * Create the vbo as pinned, so that a tryreserve will
315          * immediately succeed. This is because we're the only
316          * user of the bo currently.
317          */
318         vbo = kzalloc(sizeof(*vbo), GFP_KERNEL);
319         if (!vbo)
320                 return -ENOMEM;
321
322         ret = vmw_dmabuf_init(dev_priv, vbo, PAGE_SIZE,
323                               &vmw_sys_ne_placement, false,
324                               &vmw_dmabuf_bo_free);
325         if (unlikely(ret != 0))
326                 return ret;
327
328         ret = ttm_bo_reserve(&vbo->base, false, true, false, NULL);
329         BUG_ON(ret != 0);
330         vmw_bo_pin_reserved(vbo, true);
331
332         ret = ttm_bo_kmap(&vbo->base, 0, 1, &map);
333         if (likely(ret == 0)) {
334                 result = ttm_kmap_obj_virtual(&map, &dummy);
335                 result->totalSize = sizeof(*result);
336                 result->state = SVGA3D_QUERYSTATE_PENDING;
337                 result->result32 = 0xff;
338                 ttm_bo_kunmap(&map);
339         }
340         vmw_bo_pin_reserved(vbo, false);
341         ttm_bo_unreserve(&vbo->base);
342
343         if (unlikely(ret != 0)) {
344                 DRM_ERROR("Dummy query buffer map failed.\n");
345                 vmw_dmabuf_unreference(&vbo);
346         } else
347                 dev_priv->dummy_query_bo = vbo;
348
349         return ret;
350 }
351
352 /**
353  * vmw_request_device_late - Perform late device setup
354  *
355  * @dev_priv: Pointer to device private.
356  *
357  * This function performs setup of otables and enables large command
358  * buffer submission. These tasks are split out to a separate function
359  * because it reverts vmw_release_device_early and is intended to be used
360  * by an error path in the hibernation code.
361  */
362 static int vmw_request_device_late(struct vmw_private *dev_priv)
363 {
364         int ret;
365
366         if (dev_priv->has_mob) {
367                 ret = vmw_otables_setup(dev_priv);
368                 if (unlikely(ret != 0)) {
369                         DRM_ERROR("Unable to initialize "
370                                   "guest Memory OBjects.\n");
371                         return ret;
372                 }
373         }
374
375         if (dev_priv->cman) {
376                 ret = vmw_cmdbuf_set_pool_size(dev_priv->cman,
377                                                256*4096, 2*4096);
378                 if (ret) {
379                         struct vmw_cmdbuf_man *man = dev_priv->cman;
380
381                         dev_priv->cman = NULL;
382                         vmw_cmdbuf_man_destroy(man);
383                 }
384         }
385
386         return 0;
387 }
388
389 static int vmw_request_device(struct vmw_private *dev_priv)
390 {
391         int ret;
392
393         ret = vmw_fifo_init(dev_priv, &dev_priv->fifo);
394         if (unlikely(ret != 0)) {
395                 DRM_ERROR("Unable to initialize FIFO.\n");
396                 return ret;
397         }
398         vmw_fence_fifo_up(dev_priv->fman);
399         dev_priv->cman = vmw_cmdbuf_man_create(dev_priv);
400         if (IS_ERR(dev_priv->cman)) {
401                 dev_priv->cman = NULL;
402                 dev_priv->has_dx = false;
403         }
404
405         ret = vmw_request_device_late(dev_priv);
406         if (ret)
407                 goto out_no_mob;
408
409         ret = vmw_dummy_query_bo_create(dev_priv);
410         if (unlikely(ret != 0))
411                 goto out_no_query_bo;
412
413         return 0;
414
415 out_no_query_bo:
416         if (dev_priv->cman)
417                 vmw_cmdbuf_remove_pool(dev_priv->cman);
418         if (dev_priv->has_mob) {
419                 (void) ttm_bo_evict_mm(&dev_priv->bdev, VMW_PL_MOB);
420                 vmw_otables_takedown(dev_priv);
421         }
422         if (dev_priv->cman)
423                 vmw_cmdbuf_man_destroy(dev_priv->cman);
424 out_no_mob:
425         vmw_fence_fifo_down(dev_priv->fman);
426         vmw_fifo_release(dev_priv, &dev_priv->fifo);
427         return ret;
428 }
429
430 /**
431  * vmw_release_device_early - Early part of fifo takedown.
432  *
433  * @dev_priv: Pointer to device private struct.
434  *
435  * This is the first part of command submission takedown, to be called before
436  * buffer management is taken down.
437  */
438 static void vmw_release_device_early(struct vmw_private *dev_priv)
439 {
440         /*
441          * Previous destructions should've released
442          * the pinned bo.
443          */
444
445         BUG_ON(dev_priv->pinned_bo != NULL);
446
447         vmw_dmabuf_unreference(&dev_priv->dummy_query_bo);
448         if (dev_priv->cman)
449                 vmw_cmdbuf_remove_pool(dev_priv->cman);
450
451         if (dev_priv->has_mob) {
452                 ttm_bo_evict_mm(&dev_priv->bdev, VMW_PL_MOB);
453                 vmw_otables_takedown(dev_priv);
454         }
455 }
456
457 /**
458  * vmw_release_device_late - Late part of fifo takedown.
459  *
460  * @dev_priv: Pointer to device private struct.
461  *
462  * This is the last part of the command submission takedown, to be called when
463  * command submission is no longer needed. It may wait on pending fences.
464  */
465 static void vmw_release_device_late(struct vmw_private *dev_priv)
466 {
467         vmw_fence_fifo_down(dev_priv->fman);
468         if (dev_priv->cman)
469                 vmw_cmdbuf_man_destroy(dev_priv->cman);
470
471         vmw_fifo_release(dev_priv, &dev_priv->fifo);
472 }
473
474 /**
475  * Sets the initial_[width|height] fields on the given vmw_private.
476  *
477  * It does so by reading SVGA_REG_[WIDTH|HEIGHT] regs and then
478  * clamping the value to fb_max_[width|height] fields and the
479  * VMW_MIN_INITIAL_[WIDTH|HEIGHT].
480  * If the values appear to be invalid, set them to
481  * VMW_MIN_INITIAL_[WIDTH|HEIGHT].
482  */
483 static void vmw_get_initial_size(struct vmw_private *dev_priv)
484 {
485         uint32_t width;
486         uint32_t height;
487
488         width = vmw_read(dev_priv, SVGA_REG_WIDTH);
489         height = vmw_read(dev_priv, SVGA_REG_HEIGHT);
490
491         width = max_t(uint32_t, width, VMW_MIN_INITIAL_WIDTH);
492         height = max_t(uint32_t, height, VMW_MIN_INITIAL_HEIGHT);
493
494         if (width > dev_priv->fb_max_width ||
495             height > dev_priv->fb_max_height) {
496
497                 /*
498                  * This is a host error and shouldn't occur.
499                  */
500
501                 width = VMW_MIN_INITIAL_WIDTH;
502                 height = VMW_MIN_INITIAL_HEIGHT;
503         }
504
505         dev_priv->initial_width = width;
506         dev_priv->initial_height = height;
507 }
508
509 /**
510  * vmw_dma_select_mode - Determine how DMA mappings should be set up for this
511  * system.
512  *
513  * @dev_priv: Pointer to a struct vmw_private
514  *
515  * This functions tries to determine the IOMMU setup and what actions
516  * need to be taken by the driver to make system pages visible to the
517  * device.
518  * If this function decides that DMA is not possible, it returns -EINVAL.
519  * The driver may then try to disable features of the device that require
520  * DMA.
521  */
522 static int vmw_dma_select_mode(struct vmw_private *dev_priv)
523 {
524         static const char *names[vmw_dma_map_max] = {
525                 [vmw_dma_phys] = "Using physical TTM page addresses.",
526                 [vmw_dma_alloc_coherent] = "Using coherent TTM pages.",
527                 [vmw_dma_map_populate] = "Keeping DMA mappings.",
528                 [vmw_dma_map_bind] = "Giving up DMA mappings early."};
529 #ifdef CONFIG_X86
530         const struct dma_map_ops *dma_ops = get_dma_ops(dev_priv->dev->dev);
531
532 #ifdef CONFIG_INTEL_IOMMU
533         if (intel_iommu_enabled) {
534                 dev_priv->map_mode = vmw_dma_map_populate;
535                 goto out_fixup;
536         }
537 #endif
538
539         if (!(vmw_force_iommu || vmw_force_coherent)) {
540                 dev_priv->map_mode = vmw_dma_phys;
541                 DRM_INFO("DMA map mode: %s\n", names[dev_priv->map_mode]);
542                 return 0;
543         }
544
545         dev_priv->map_mode = vmw_dma_map_populate;
546
547         if (dma_ops->sync_single_for_cpu)
548                 dev_priv->map_mode = vmw_dma_alloc_coherent;
549 #ifdef CONFIG_SWIOTLB
550         if (swiotlb_nr_tbl() == 0)
551                 dev_priv->map_mode = vmw_dma_map_populate;
552 #endif
553
554 #ifdef CONFIG_INTEL_IOMMU
555 out_fixup:
556 #endif
557         if (dev_priv->map_mode == vmw_dma_map_populate &&
558             vmw_restrict_iommu)
559                 dev_priv->map_mode = vmw_dma_map_bind;
560
561         if (vmw_force_coherent)
562                 dev_priv->map_mode = vmw_dma_alloc_coherent;
563
564 #if !defined(CONFIG_SWIOTLB) && !defined(CONFIG_INTEL_IOMMU)
565         /*
566          * No coherent page pool
567          */
568         if (dev_priv->map_mode == vmw_dma_alloc_coherent)
569                 return -EINVAL;
570 #endif
571
572 #else /* CONFIG_X86 */
573         dev_priv->map_mode = vmw_dma_map_populate;
574 #endif /* CONFIG_X86 */
575
576         DRM_INFO("DMA map mode: %s\n", names[dev_priv->map_mode]);
577
578         return 0;
579 }
580
581 /**
582  * vmw_dma_masks - set required page- and dma masks
583  *
584  * @dev: Pointer to struct drm-device
585  *
586  * With 32-bit we can only handle 32 bit PFNs. Optionally set that
587  * restriction also for 64-bit systems.
588  */
589 #ifdef CONFIG_INTEL_IOMMU
590 static int vmw_dma_masks(struct vmw_private *dev_priv)
591 {
592         struct drm_device *dev = dev_priv->dev;
593
594         if (intel_iommu_enabled &&
595             (sizeof(unsigned long) == 4 || vmw_restrict_dma_mask)) {
596                 DRM_INFO("Restricting DMA addresses to 44 bits.\n");
597                 return dma_set_mask(dev->dev, DMA_BIT_MASK(44));
598         }
599         return 0;
600 }
601 #else
602 static int vmw_dma_masks(struct vmw_private *dev_priv)
603 {
604         return 0;
605 }
606 #endif
607
608 static int vmw_driver_load(struct drm_device *dev, unsigned long chipset)
609 {
610         struct vmw_private *dev_priv;
611         int ret;
612         uint32_t svga_id;
613         enum vmw_res_type i;
614         bool refuse_dma = false;
615
616         dev_priv = kzalloc(sizeof(*dev_priv), GFP_KERNEL);
617         if (unlikely(dev_priv == NULL)) {
618                 DRM_ERROR("Failed allocating a device private struct.\n");
619                 return -ENOMEM;
620         }
621
622         pci_set_master(dev->pdev);
623
624         dev_priv->dev = dev;
625         dev_priv->vmw_chipset = chipset;
626         dev_priv->last_read_seqno = (uint32_t) -100;
627         mutex_init(&dev_priv->cmdbuf_mutex);
628         mutex_init(&dev_priv->release_mutex);
629         mutex_init(&dev_priv->binding_mutex);
630         rwlock_init(&dev_priv->resource_lock);
631         ttm_lock_init(&dev_priv->reservation_sem);
632         spin_lock_init(&dev_priv->hw_lock);
633         spin_lock_init(&dev_priv->waiter_lock);
634         spin_lock_init(&dev_priv->cap_lock);
635         spin_lock_init(&dev_priv->svga_lock);
636
637         for (i = vmw_res_context; i < vmw_res_max; ++i) {
638                 idr_init(&dev_priv->res_idr[i]);
639                 INIT_LIST_HEAD(&dev_priv->res_lru[i]);
640         }
641
642         mutex_init(&dev_priv->init_mutex);
643         init_waitqueue_head(&dev_priv->fence_queue);
644         init_waitqueue_head(&dev_priv->fifo_queue);
645         dev_priv->fence_queue_waiters = 0;
646         atomic_set(&dev_priv->fifo_queue_waiters, 0);
647
648         dev_priv->used_memory_size = 0;
649
650         dev_priv->io_start = pci_resource_start(dev->pdev, 0);
651         dev_priv->vram_start = pci_resource_start(dev->pdev, 1);
652         dev_priv->mmio_start = pci_resource_start(dev->pdev, 2);
653
654         dev_priv->enable_fb = enable_fbdev;
655
656         vmw_write(dev_priv, SVGA_REG_ID, SVGA_ID_2);
657         svga_id = vmw_read(dev_priv, SVGA_REG_ID);
658         if (svga_id != SVGA_ID_2) {
659                 ret = -ENOSYS;
660                 DRM_ERROR("Unsupported SVGA ID 0x%x\n", svga_id);
661                 goto out_err0;
662         }
663
664         dev_priv->capabilities = vmw_read(dev_priv, SVGA_REG_CAPABILITIES);
665         ret = vmw_dma_select_mode(dev_priv);
666         if (unlikely(ret != 0)) {
667                 DRM_INFO("Restricting capabilities due to IOMMU setup.\n");
668                 refuse_dma = true;
669         }
670
671         dev_priv->vram_size = vmw_read(dev_priv, SVGA_REG_VRAM_SIZE);
672         dev_priv->mmio_size = vmw_read(dev_priv, SVGA_REG_MEM_SIZE);
673         dev_priv->fb_max_width = vmw_read(dev_priv, SVGA_REG_MAX_WIDTH);
674         dev_priv->fb_max_height = vmw_read(dev_priv, SVGA_REG_MAX_HEIGHT);
675
676         vmw_get_initial_size(dev_priv);
677
678         if (dev_priv->capabilities & SVGA_CAP_GMR2) {
679                 dev_priv->max_gmr_ids =
680                         vmw_read(dev_priv, SVGA_REG_GMR_MAX_IDS);
681                 dev_priv->max_gmr_pages =
682                         vmw_read(dev_priv, SVGA_REG_GMRS_MAX_PAGES);
683                 dev_priv->memory_size =
684                         vmw_read(dev_priv, SVGA_REG_MEMORY_SIZE);
685                 dev_priv->memory_size -= dev_priv->vram_size;
686         } else {
687                 /*
688                  * An arbitrary limit of 512MiB on surface
689                  * memory. But all HWV8 hardware supports GMR2.
690                  */
691                 dev_priv->memory_size = 512*1024*1024;
692         }
693         dev_priv->max_mob_pages = 0;
694         dev_priv->max_mob_size = 0;
695         if (dev_priv->capabilities & SVGA_CAP_GBOBJECTS) {
696                 uint64_t mem_size =
697                         vmw_read(dev_priv,
698                                  SVGA_REG_SUGGESTED_GBOBJECT_MEM_SIZE_KB);
699
700                 dev_priv->max_mob_pages = mem_size * 1024 / PAGE_SIZE;
701                 dev_priv->prim_bb_mem =
702                         vmw_read(dev_priv,
703                                  SVGA_REG_MAX_PRIMARY_BOUNDING_BOX_MEM);
704                 dev_priv->max_mob_size =
705                         vmw_read(dev_priv, SVGA_REG_MOB_MAX_SIZE);
706                 dev_priv->stdu_max_width =
707                         vmw_read(dev_priv, SVGA_REG_SCREENTARGET_MAX_WIDTH);
708                 dev_priv->stdu_max_height =
709                         vmw_read(dev_priv, SVGA_REG_SCREENTARGET_MAX_HEIGHT);
710
711                 vmw_write(dev_priv, SVGA_REG_DEV_CAP,
712                           SVGA3D_DEVCAP_MAX_TEXTURE_WIDTH);
713                 dev_priv->texture_max_width = vmw_read(dev_priv,
714                                                        SVGA_REG_DEV_CAP);
715                 vmw_write(dev_priv, SVGA_REG_DEV_CAP,
716                           SVGA3D_DEVCAP_MAX_TEXTURE_HEIGHT);
717                 dev_priv->texture_max_height = vmw_read(dev_priv,
718                                                         SVGA_REG_DEV_CAP);
719         } else {
720                 dev_priv->texture_max_width = 8192;
721                 dev_priv->texture_max_height = 8192;
722                 dev_priv->prim_bb_mem = dev_priv->vram_size;
723         }
724
725         vmw_print_capabilities(dev_priv->capabilities);
726
727         ret = vmw_dma_masks(dev_priv);
728         if (unlikely(ret != 0))
729                 goto out_err0;
730
731         if (dev_priv->capabilities & SVGA_CAP_GMR2) {
732                 DRM_INFO("Max GMR ids is %u\n",
733                          (unsigned)dev_priv->max_gmr_ids);
734                 DRM_INFO("Max number of GMR pages is %u\n",
735                          (unsigned)dev_priv->max_gmr_pages);
736                 DRM_INFO("Max dedicated hypervisor surface memory is %u kiB\n",
737                          (unsigned)dev_priv->memory_size / 1024);
738         }
739         DRM_INFO("Maximum display memory size is %u kiB\n",
740                  dev_priv->prim_bb_mem / 1024);
741         DRM_INFO("VRAM at 0x%08x size is %u kiB\n",
742                  dev_priv->vram_start, dev_priv->vram_size / 1024);
743         DRM_INFO("MMIO at 0x%08x size is %u kiB\n",
744                  dev_priv->mmio_start, dev_priv->mmio_size / 1024);
745
746         ret = vmw_ttm_global_init(dev_priv);
747         if (unlikely(ret != 0))
748                 goto out_err0;
749
750
751         vmw_master_init(&dev_priv->fbdev_master);
752         ttm_lock_set_kill(&dev_priv->fbdev_master.lock, false, SIGTERM);
753         dev_priv->active_master = &dev_priv->fbdev_master;
754
755         dev_priv->mmio_virt = ioremap_cache(dev_priv->mmio_start,
756                                             dev_priv->mmio_size);
757
758         if (unlikely(dev_priv->mmio_virt == NULL)) {
759                 ret = -ENOMEM;
760                 DRM_ERROR("Failed mapping MMIO.\n");
761                 goto out_err3;
762         }
763
764         /* Need mmio memory to check for fifo pitchlock cap. */
765         if (!(dev_priv->capabilities & SVGA_CAP_DISPLAY_TOPOLOGY) &&
766             !(dev_priv->capabilities & SVGA_CAP_PITCHLOCK) &&
767             !vmw_fifo_have_pitchlock(dev_priv)) {
768                 ret = -ENOSYS;
769                 DRM_ERROR("Hardware has no pitchlock\n");
770                 goto out_err4;
771         }
772
773         dev_priv->tdev = ttm_object_device_init
774                 (dev_priv->mem_global_ref.object, 12, &vmw_prime_dmabuf_ops);
775
776         if (unlikely(dev_priv->tdev == NULL)) {
777                 DRM_ERROR("Unable to initialize TTM object management.\n");
778                 ret = -ENOMEM;
779                 goto out_err4;
780         }
781
782         dev->dev_private = dev_priv;
783
784         ret = pci_request_regions(dev->pdev, "vmwgfx probe");
785         dev_priv->stealth = (ret != 0);
786         if (dev_priv->stealth) {
787                 /**
788                  * Request at least the mmio PCI resource.
789                  */
790
791                 DRM_INFO("It appears like vesafb is loaded. "
792                          "Ignore above error if any.\n");
793                 ret = pci_request_region(dev->pdev, 2, "vmwgfx stealth probe");
794                 if (unlikely(ret != 0)) {
795                         DRM_ERROR("Failed reserving the SVGA MMIO resource.\n");
796                         goto out_no_device;
797                 }
798         }
799
800         if (dev_priv->capabilities & SVGA_CAP_IRQMASK) {
801                 ret = drm_irq_install(dev, dev->pdev->irq);
802                 if (ret != 0) {
803                         DRM_ERROR("Failed installing irq: %d\n", ret);
804                         goto out_no_irq;
805                 }
806         }
807
808         dev_priv->fman = vmw_fence_manager_init(dev_priv);
809         if (unlikely(dev_priv->fman == NULL)) {
810                 ret = -ENOMEM;
811                 goto out_no_fman;
812         }
813
814         ret = ttm_bo_device_init(&dev_priv->bdev,
815                                  dev_priv->bo_global_ref.ref.object,
816                                  &vmw_bo_driver,
817                                  dev->anon_inode->i_mapping,
818                                  VMWGFX_FILE_PAGE_OFFSET,
819                                  false);
820         if (unlikely(ret != 0)) {
821                 DRM_ERROR("Failed initializing TTM buffer object driver.\n");
822                 goto out_no_bdev;
823         }
824
825         /*
826          * Enable VRAM, but initially don't use it until SVGA is enabled and
827          * unhidden.
828          */
829         ret = ttm_bo_init_mm(&dev_priv->bdev, TTM_PL_VRAM,
830                              (dev_priv->vram_size >> PAGE_SHIFT));
831         if (unlikely(ret != 0)) {
832                 DRM_ERROR("Failed initializing memory manager for VRAM.\n");
833                 goto out_no_vram;
834         }
835         dev_priv->bdev.man[TTM_PL_VRAM].use_type = false;
836
837         dev_priv->has_gmr = true;
838         if (((dev_priv->capabilities & (SVGA_CAP_GMR | SVGA_CAP_GMR2)) == 0) ||
839             refuse_dma || ttm_bo_init_mm(&dev_priv->bdev, VMW_PL_GMR,
840                                          VMW_PL_GMR) != 0) {
841                 DRM_INFO("No GMR memory available. "
842                          "Graphics memory resources are very limited.\n");
843                 dev_priv->has_gmr = false;
844         }
845
846         if (dev_priv->capabilities & SVGA_CAP_GBOBJECTS) {
847                 dev_priv->has_mob = true;
848                 if (ttm_bo_init_mm(&dev_priv->bdev, VMW_PL_MOB,
849                                    VMW_PL_MOB) != 0) {
850                         DRM_INFO("No MOB memory available. "
851                                  "3D will be disabled.\n");
852                         dev_priv->has_mob = false;
853                 }
854         }
855
856         if (dev_priv->has_mob) {
857                 spin_lock(&dev_priv->cap_lock);
858                 vmw_write(dev_priv, SVGA_REG_DEV_CAP, SVGA3D_DEVCAP_DX);
859                 dev_priv->has_dx = !!vmw_read(dev_priv, SVGA_REG_DEV_CAP);
860                 spin_unlock(&dev_priv->cap_lock);
861         }
862
863
864         ret = vmw_kms_init(dev_priv);
865         if (unlikely(ret != 0))
866                 goto out_no_kms;
867         vmw_overlay_init(dev_priv);
868
869         ret = vmw_request_device(dev_priv);
870         if (ret)
871                 goto out_no_fifo;
872
873         DRM_INFO("DX: %s\n", dev_priv->has_dx ? "yes." : "no.");
874
875         if (dev_priv->enable_fb) {
876                 vmw_fifo_resource_inc(dev_priv);
877                 vmw_svga_enable(dev_priv);
878                 vmw_fb_init(dev_priv);
879         }
880
881         dev_priv->pm_nb.notifier_call = vmwgfx_pm_notifier;
882         register_pm_notifier(&dev_priv->pm_nb);
883
884         return 0;
885
886 out_no_fifo:
887         vmw_overlay_close(dev_priv);
888         vmw_kms_close(dev_priv);
889 out_no_kms:
890         if (dev_priv->has_mob)
891                 (void) ttm_bo_clean_mm(&dev_priv->bdev, VMW_PL_MOB);
892         if (dev_priv->has_gmr)
893                 (void) ttm_bo_clean_mm(&dev_priv->bdev, VMW_PL_GMR);
894         (void)ttm_bo_clean_mm(&dev_priv->bdev, TTM_PL_VRAM);
895 out_no_vram:
896         (void)ttm_bo_device_release(&dev_priv->bdev);
897 out_no_bdev:
898         vmw_fence_manager_takedown(dev_priv->fman);
899 out_no_fman:
900         if (dev_priv->capabilities & SVGA_CAP_IRQMASK)
901                 drm_irq_uninstall(dev_priv->dev);
902 out_no_irq:
903         if (dev_priv->stealth)
904                 pci_release_region(dev->pdev, 2);
905         else
906                 pci_release_regions(dev->pdev);
907 out_no_device:
908         ttm_object_device_release(&dev_priv->tdev);
909 out_err4:
910         iounmap(dev_priv->mmio_virt);
911 out_err3:
912         vmw_ttm_global_release(dev_priv);
913 out_err0:
914         for (i = vmw_res_context; i < vmw_res_max; ++i)
915                 idr_destroy(&dev_priv->res_idr[i]);
916
917         if (dev_priv->ctx.staged_bindings)
918                 vmw_binding_state_free(dev_priv->ctx.staged_bindings);
919         kfree(dev_priv);
920         return ret;
921 }
922
923 static int vmw_driver_unload(struct drm_device *dev)
924 {
925         struct vmw_private *dev_priv = vmw_priv(dev);
926         enum vmw_res_type i;
927
928         unregister_pm_notifier(&dev_priv->pm_nb);
929
930         if (dev_priv->ctx.res_ht_initialized)
931                 drm_ht_remove(&dev_priv->ctx.res_ht);
932         vfree(dev_priv->ctx.cmd_bounce);
933         if (dev_priv->enable_fb) {
934                 vmw_fb_off(dev_priv);
935                 vmw_fb_close(dev_priv);
936                 vmw_fifo_resource_dec(dev_priv);
937                 vmw_svga_disable(dev_priv);
938         }
939
940         vmw_kms_close(dev_priv);
941         vmw_overlay_close(dev_priv);
942
943         if (dev_priv->has_gmr)
944                 (void)ttm_bo_clean_mm(&dev_priv->bdev, VMW_PL_GMR);
945         (void)ttm_bo_clean_mm(&dev_priv->bdev, TTM_PL_VRAM);
946
947         vmw_release_device_early(dev_priv);
948         if (dev_priv->has_mob)
949                 (void) ttm_bo_clean_mm(&dev_priv->bdev, VMW_PL_MOB);
950         (void) ttm_bo_device_release(&dev_priv->bdev);
951         vmw_release_device_late(dev_priv);
952         vmw_fence_manager_takedown(dev_priv->fman);
953         if (dev_priv->capabilities & SVGA_CAP_IRQMASK)
954                 drm_irq_uninstall(dev_priv->dev);
955         if (dev_priv->stealth)
956                 pci_release_region(dev->pdev, 2);
957         else
958                 pci_release_regions(dev->pdev);
959
960         ttm_object_device_release(&dev_priv->tdev);
961         iounmap(dev_priv->mmio_virt);
962         if (dev_priv->ctx.staged_bindings)
963                 vmw_binding_state_free(dev_priv->ctx.staged_bindings);
964         vmw_ttm_global_release(dev_priv);
965
966         for (i = vmw_res_context; i < vmw_res_max; ++i)
967                 idr_destroy(&dev_priv->res_idr[i]);
968
969         kfree(dev_priv);
970
971         return 0;
972 }
973
974 static void vmw_preclose(struct drm_device *dev,
975                          struct drm_file *file_priv)
976 {
977         struct vmw_fpriv *vmw_fp = vmw_fpriv(file_priv);
978         struct vmw_private *dev_priv = vmw_priv(dev);
979
980         vmw_event_fence_fpriv_gone(dev_priv->fman, &vmw_fp->fence_events);
981 }
982
983 static void vmw_postclose(struct drm_device *dev,
984                          struct drm_file *file_priv)
985 {
986         struct vmw_fpriv *vmw_fp;
987
988         vmw_fp = vmw_fpriv(file_priv);
989
990         if (vmw_fp->locked_master) {
991                 struct vmw_master *vmaster =
992                         vmw_master(vmw_fp->locked_master);
993
994                 ttm_lock_set_kill(&vmaster->lock, true, SIGTERM);
995                 ttm_vt_unlock(&vmaster->lock);
996                 drm_master_put(&vmw_fp->locked_master);
997         }
998
999         ttm_object_file_release(&vmw_fp->tfile);
1000         kfree(vmw_fp);
1001 }
1002
1003 static int vmw_driver_open(struct drm_device *dev, struct drm_file *file_priv)
1004 {
1005         struct vmw_private *dev_priv = vmw_priv(dev);
1006         struct vmw_fpriv *vmw_fp;
1007         int ret = -ENOMEM;
1008
1009         vmw_fp = kzalloc(sizeof(*vmw_fp), GFP_KERNEL);
1010         if (unlikely(vmw_fp == NULL))
1011                 return ret;
1012
1013         INIT_LIST_HEAD(&vmw_fp->fence_events);
1014         vmw_fp->tfile = ttm_object_file_init(dev_priv->tdev, 10);
1015         if (unlikely(vmw_fp->tfile == NULL))
1016                 goto out_no_tfile;
1017
1018         file_priv->driver_priv = vmw_fp;
1019
1020         return 0;
1021
1022 out_no_tfile:
1023         kfree(vmw_fp);
1024         return ret;
1025 }
1026
1027 static struct vmw_master *vmw_master_check(struct drm_device *dev,
1028                                            struct drm_file *file_priv,
1029                                            unsigned int flags)
1030 {
1031         int ret;
1032         struct vmw_fpriv *vmw_fp = vmw_fpriv(file_priv);
1033         struct vmw_master *vmaster;
1034
1035         if (file_priv->minor->type != DRM_MINOR_LEGACY ||
1036             !(flags & DRM_AUTH))
1037                 return NULL;
1038
1039         ret = mutex_lock_interruptible(&dev->master_mutex);
1040         if (unlikely(ret != 0))
1041                 return ERR_PTR(-ERESTARTSYS);
1042
1043         if (file_priv->is_master) {
1044                 mutex_unlock(&dev->master_mutex);
1045                 return NULL;
1046         }
1047
1048         /*
1049          * Check if we were previously master, but now dropped. In that
1050          * case, allow at least render node functionality.
1051          */
1052         if (vmw_fp->locked_master) {
1053                 mutex_unlock(&dev->master_mutex);
1054
1055                 if (flags & DRM_RENDER_ALLOW)
1056                         return NULL;
1057
1058                 DRM_ERROR("Dropped master trying to access ioctl that "
1059                           "requires authentication.\n");
1060                 return ERR_PTR(-EACCES);
1061         }
1062         mutex_unlock(&dev->master_mutex);
1063
1064         /*
1065          * Taking the drm_global_mutex after the TTM lock might deadlock
1066          */
1067         if (!(flags & DRM_UNLOCKED)) {
1068                 DRM_ERROR("Refusing locked ioctl access.\n");
1069                 return ERR_PTR(-EDEADLK);
1070         }
1071
1072         /*
1073          * Take the TTM lock. Possibly sleep waiting for the authenticating
1074          * master to become master again, or for a SIGTERM if the
1075          * authenticating master exits.
1076          */
1077         vmaster = vmw_master(file_priv->master);
1078         ret = ttm_read_lock(&vmaster->lock, true);
1079         if (unlikely(ret != 0))
1080                 vmaster = ERR_PTR(ret);
1081
1082         return vmaster;
1083 }
1084
1085 static long vmw_generic_ioctl(struct file *filp, unsigned int cmd,
1086                               unsigned long arg,
1087                               long (*ioctl_func)(struct file *, unsigned int,
1088                                                  unsigned long))
1089 {
1090         struct drm_file *file_priv = filp->private_data;
1091         struct drm_device *dev = file_priv->minor->dev;
1092         unsigned int nr = DRM_IOCTL_NR(cmd);
1093         struct vmw_master *vmaster;
1094         unsigned int flags;
1095         long ret;
1096
1097         /*
1098          * Do extra checking on driver private ioctls.
1099          */
1100
1101         if ((nr >= DRM_COMMAND_BASE) && (nr < DRM_COMMAND_END)
1102             && (nr < DRM_COMMAND_BASE + dev->driver->num_ioctls)) {
1103                 const struct drm_ioctl_desc *ioctl =
1104                         &vmw_ioctls[nr - DRM_COMMAND_BASE];
1105
1106                 if (nr == DRM_COMMAND_BASE + DRM_VMW_EXECBUF) {
1107                         ret = (long) drm_ioctl_permit(ioctl->flags, file_priv);
1108                         if (unlikely(ret != 0))
1109                                 return ret;
1110
1111                         if (unlikely((cmd & (IOC_IN | IOC_OUT)) != IOC_IN))
1112                                 goto out_io_encoding;
1113
1114                         return (long) vmw_execbuf_ioctl(dev, arg, file_priv,
1115                                                         _IOC_SIZE(cmd));
1116                 }
1117
1118                 if (unlikely(ioctl->cmd != cmd))
1119                         goto out_io_encoding;
1120
1121                 flags = ioctl->flags;
1122         } else if (!drm_ioctl_flags(nr, &flags))
1123                 return -EINVAL;
1124
1125         vmaster = vmw_master_check(dev, file_priv, flags);
1126         if (IS_ERR(vmaster)) {
1127                 ret = PTR_ERR(vmaster);
1128
1129                 if (ret != -ERESTARTSYS)
1130                         DRM_INFO("IOCTL ERROR Command %d, Error %ld.\n",
1131                                  nr, ret);
1132                 return ret;
1133         }
1134
1135         ret = ioctl_func(filp, cmd, arg);
1136         if (vmaster)
1137                 ttm_read_unlock(&vmaster->lock);
1138
1139         return ret;
1140
1141 out_io_encoding:
1142         DRM_ERROR("Invalid command format, ioctl %d\n",
1143                   nr - DRM_COMMAND_BASE);
1144
1145         return -EINVAL;
1146 }
1147
1148 static long vmw_unlocked_ioctl(struct file *filp, unsigned int cmd,
1149                                unsigned long arg)
1150 {
1151         return vmw_generic_ioctl(filp, cmd, arg, &drm_ioctl);
1152 }
1153
1154 #ifdef CONFIG_COMPAT
1155 static long vmw_compat_ioctl(struct file *filp, unsigned int cmd,
1156                              unsigned long arg)
1157 {
1158         return vmw_generic_ioctl(filp, cmd, arg, &drm_compat_ioctl);
1159 }
1160 #endif
1161
1162 static void vmw_lastclose(struct drm_device *dev)
1163 {
1164 }
1165
1166 static void vmw_master_init(struct vmw_master *vmaster)
1167 {
1168         ttm_lock_init(&vmaster->lock);
1169 }
1170
1171 static int vmw_master_create(struct drm_device *dev,
1172                              struct drm_master *master)
1173 {
1174         struct vmw_master *vmaster;
1175
1176         vmaster = kzalloc(sizeof(*vmaster), GFP_KERNEL);
1177         if (unlikely(vmaster == NULL))
1178                 return -ENOMEM;
1179
1180         vmw_master_init(vmaster);
1181         ttm_lock_set_kill(&vmaster->lock, true, SIGTERM);
1182         master->driver_priv = vmaster;
1183
1184         return 0;
1185 }
1186
1187 static void vmw_master_destroy(struct drm_device *dev,
1188                                struct drm_master *master)
1189 {
1190         struct vmw_master *vmaster = vmw_master(master);
1191
1192         master->driver_priv = NULL;
1193         kfree(vmaster);
1194 }
1195
1196 static int vmw_master_set(struct drm_device *dev,
1197                           struct drm_file *file_priv,
1198                           bool from_open)
1199 {
1200         struct vmw_private *dev_priv = vmw_priv(dev);
1201         struct vmw_fpriv *vmw_fp = vmw_fpriv(file_priv);
1202         struct vmw_master *active = dev_priv->active_master;
1203         struct vmw_master *vmaster = vmw_master(file_priv->master);
1204         int ret = 0;
1205
1206         if (active) {
1207                 BUG_ON(active != &dev_priv->fbdev_master);
1208                 ret = ttm_vt_lock(&active->lock, false, vmw_fp->tfile);
1209                 if (unlikely(ret != 0))
1210                         return ret;
1211
1212                 ttm_lock_set_kill(&active->lock, true, SIGTERM);
1213                 dev_priv->active_master = NULL;
1214         }
1215
1216         ttm_lock_set_kill(&vmaster->lock, false, SIGTERM);
1217         if (!from_open) {
1218                 ttm_vt_unlock(&vmaster->lock);
1219                 BUG_ON(vmw_fp->locked_master != file_priv->master);
1220                 drm_master_put(&vmw_fp->locked_master);
1221         }
1222
1223         dev_priv->active_master = vmaster;
1224
1225         return 0;
1226 }
1227
1228 static void vmw_master_drop(struct drm_device *dev,
1229                             struct drm_file *file_priv,
1230                             bool from_release)
1231 {
1232         struct vmw_private *dev_priv = vmw_priv(dev);
1233         struct vmw_fpriv *vmw_fp = vmw_fpriv(file_priv);
1234         struct vmw_master *vmaster = vmw_master(file_priv->master);
1235         int ret;
1236
1237         /**
1238          * Make sure the master doesn't disappear while we have
1239          * it locked.
1240          */
1241
1242         vmw_fp->locked_master = drm_master_get(file_priv->master);
1243         ret = ttm_vt_lock(&vmaster->lock, false, vmw_fp->tfile);
1244         if (unlikely((ret != 0))) {
1245                 DRM_ERROR("Unable to lock TTM at VT switch.\n");
1246                 drm_master_put(&vmw_fp->locked_master);
1247         }
1248
1249         ttm_lock_set_kill(&vmaster->lock, false, SIGTERM);
1250
1251         if (!dev_priv->enable_fb)
1252                 vmw_svga_disable(dev_priv);
1253
1254         dev_priv->active_master = &dev_priv->fbdev_master;
1255         ttm_lock_set_kill(&dev_priv->fbdev_master.lock, false, SIGTERM);
1256         ttm_vt_unlock(&dev_priv->fbdev_master.lock);
1257
1258         if (dev_priv->enable_fb)
1259                 vmw_fb_on(dev_priv);
1260 }
1261
1262 /**
1263  * __vmw_svga_enable - Enable SVGA mode, FIFO and use of VRAM.
1264  *
1265  * @dev_priv: Pointer to device private struct.
1266  * Needs the reservation sem to be held in non-exclusive mode.
1267  */
1268 static void __vmw_svga_enable(struct vmw_private *dev_priv)
1269 {
1270         spin_lock(&dev_priv->svga_lock);
1271         if (!dev_priv->bdev.man[TTM_PL_VRAM].use_type) {
1272                 vmw_write(dev_priv, SVGA_REG_ENABLE, SVGA_REG_ENABLE);
1273                 dev_priv->bdev.man[TTM_PL_VRAM].use_type = true;
1274         }
1275         spin_unlock(&dev_priv->svga_lock);
1276 }
1277
1278 /**
1279  * vmw_svga_enable - Enable SVGA mode, FIFO and use of VRAM.
1280  *
1281  * @dev_priv: Pointer to device private struct.
1282  */
1283 void vmw_svga_enable(struct vmw_private *dev_priv)
1284 {
1285         ttm_read_lock(&dev_priv->reservation_sem, false);
1286         __vmw_svga_enable(dev_priv);
1287         ttm_read_unlock(&dev_priv->reservation_sem);
1288 }
1289
1290 /**
1291  * __vmw_svga_disable - Disable SVGA mode and use of VRAM.
1292  *
1293  * @dev_priv: Pointer to device private struct.
1294  * Needs the reservation sem to be held in exclusive mode.
1295  * Will not empty VRAM. VRAM must be emptied by caller.
1296  */
1297 static void __vmw_svga_disable(struct vmw_private *dev_priv)
1298 {
1299         spin_lock(&dev_priv->svga_lock);
1300         if (dev_priv->bdev.man[TTM_PL_VRAM].use_type) {
1301                 dev_priv->bdev.man[TTM_PL_VRAM].use_type = false;
1302                 vmw_write(dev_priv, SVGA_REG_ENABLE,
1303                           SVGA_REG_ENABLE_HIDE |
1304                           SVGA_REG_ENABLE_ENABLE);
1305         }
1306         spin_unlock(&dev_priv->svga_lock);
1307 }
1308
1309 /**
1310  * vmw_svga_disable - Disable SVGA_MODE, and use of VRAM. Keep the fifo
1311  * running.
1312  *
1313  * @dev_priv: Pointer to device private struct.
1314  * Will empty VRAM.
1315  */
1316 void vmw_svga_disable(struct vmw_private *dev_priv)
1317 {
1318         ttm_write_lock(&dev_priv->reservation_sem, false);
1319         spin_lock(&dev_priv->svga_lock);
1320         if (dev_priv->bdev.man[TTM_PL_VRAM].use_type) {
1321                 dev_priv->bdev.man[TTM_PL_VRAM].use_type = false;
1322                 spin_unlock(&dev_priv->svga_lock);
1323                 if (ttm_bo_evict_mm(&dev_priv->bdev, TTM_PL_VRAM))
1324                         DRM_ERROR("Failed evicting VRAM buffers.\n");
1325                 vmw_write(dev_priv, SVGA_REG_ENABLE,
1326                           SVGA_REG_ENABLE_HIDE |
1327                           SVGA_REG_ENABLE_ENABLE);
1328         } else
1329                 spin_unlock(&dev_priv->svga_lock);
1330         ttm_write_unlock(&dev_priv->reservation_sem);
1331 }
1332
1333 static void vmw_remove(struct pci_dev *pdev)
1334 {
1335         struct drm_device *dev = pci_get_drvdata(pdev);
1336
1337         pci_disable_device(pdev);
1338         drm_put_dev(dev);
1339 }
1340
1341 static int vmwgfx_pm_notifier(struct notifier_block *nb, unsigned long val,
1342                               void *ptr)
1343 {
1344         struct vmw_private *dev_priv =
1345                 container_of(nb, struct vmw_private, pm_nb);
1346
1347         switch (val) {
1348         case PM_HIBERNATION_PREPARE:
1349                 if (dev_priv->enable_fb)
1350                         vmw_fb_off(dev_priv);
1351                 ttm_suspend_lock(&dev_priv->reservation_sem);
1352
1353                 /*
1354                  * This empties VRAM and unbinds all GMR bindings.
1355                  * Buffer contents is moved to swappable memory.
1356                  */
1357                 vmw_execbuf_release_pinned_bo(dev_priv);
1358                 vmw_resource_evict_all(dev_priv);
1359                 vmw_release_device_early(dev_priv);
1360                 ttm_bo_swapout_all(&dev_priv->bdev);
1361                 vmw_fence_fifo_down(dev_priv->fman);
1362                 break;
1363         case PM_POST_HIBERNATION:
1364         case PM_POST_RESTORE:
1365                 vmw_fence_fifo_up(dev_priv->fman);
1366                 ttm_suspend_unlock(&dev_priv->reservation_sem);
1367                 if (dev_priv->enable_fb)
1368                         vmw_fb_on(dev_priv);
1369                 break;
1370         case PM_RESTORE_PREPARE:
1371                 break;
1372         default:
1373                 break;
1374         }
1375         return 0;
1376 }
1377
1378 static int vmw_pci_suspend(struct pci_dev *pdev, pm_message_t state)
1379 {
1380         struct drm_device *dev = pci_get_drvdata(pdev);
1381         struct vmw_private *dev_priv = vmw_priv(dev);
1382
1383         if (dev_priv->refuse_hibernation)
1384                 return -EBUSY;
1385
1386         pci_save_state(pdev);
1387         pci_disable_device(pdev);
1388         pci_set_power_state(pdev, PCI_D3hot);
1389         return 0;
1390 }
1391
1392 static int vmw_pci_resume(struct pci_dev *pdev)
1393 {
1394         pci_set_power_state(pdev, PCI_D0);
1395         pci_restore_state(pdev);
1396         return pci_enable_device(pdev);
1397 }
1398
1399 static int vmw_pm_suspend(struct device *kdev)
1400 {
1401         struct pci_dev *pdev = to_pci_dev(kdev);
1402         struct pm_message dummy;
1403
1404         dummy.event = 0;
1405
1406         return vmw_pci_suspend(pdev, dummy);
1407 }
1408
1409 static int vmw_pm_resume(struct device *kdev)
1410 {
1411         struct pci_dev *pdev = to_pci_dev(kdev);
1412
1413         return vmw_pci_resume(pdev);
1414 }
1415
1416 static int vmw_pm_freeze(struct device *kdev)
1417 {
1418         struct pci_dev *pdev = to_pci_dev(kdev);
1419         struct drm_device *dev = pci_get_drvdata(pdev);
1420         struct vmw_private *dev_priv = vmw_priv(dev);
1421
1422         dev_priv->suspended = true;
1423         if (dev_priv->enable_fb)
1424                 vmw_fifo_resource_dec(dev_priv);
1425
1426         if (atomic_read(&dev_priv->num_fifo_resources) != 0) {
1427                 DRM_ERROR("Can't hibernate while 3D resources are active.\n");
1428                 if (dev_priv->enable_fb)
1429                         vmw_fifo_resource_inc(dev_priv);
1430                 WARN_ON(vmw_request_device_late(dev_priv));
1431                 dev_priv->suspended = false;
1432                 return -EBUSY;
1433         }
1434
1435         if (dev_priv->enable_fb)
1436                 __vmw_svga_disable(dev_priv);
1437         
1438         vmw_release_device_late(dev_priv);
1439
1440         return 0;
1441 }
1442
1443 static int vmw_pm_restore(struct device *kdev)
1444 {
1445         struct pci_dev *pdev = to_pci_dev(kdev);
1446         struct drm_device *dev = pci_get_drvdata(pdev);
1447         struct vmw_private *dev_priv = vmw_priv(dev);
1448         int ret;
1449
1450         vmw_write(dev_priv, SVGA_REG_ID, SVGA_ID_2);
1451         (void) vmw_read(dev_priv, SVGA_REG_ID);
1452
1453         if (dev_priv->enable_fb)
1454                 vmw_fifo_resource_inc(dev_priv);
1455
1456         ret = vmw_request_device(dev_priv);
1457         if (ret)
1458                 return ret;
1459
1460         if (dev_priv->enable_fb)
1461                 __vmw_svga_enable(dev_priv);
1462
1463         dev_priv->suspended = false;
1464
1465         return 0;
1466 }
1467
1468 static const struct dev_pm_ops vmw_pm_ops = {
1469         .freeze = vmw_pm_freeze,
1470         .thaw = vmw_pm_restore,
1471         .restore = vmw_pm_restore,
1472         .suspend = vmw_pm_suspend,
1473         .resume = vmw_pm_resume,
1474 };
1475
1476 static const struct file_operations vmwgfx_driver_fops = {
1477         .owner = THIS_MODULE,
1478         .open = drm_open,
1479         .release = drm_release,
1480         .unlocked_ioctl = vmw_unlocked_ioctl,
1481         .mmap = vmw_mmap,
1482         .poll = vmw_fops_poll,
1483         .read = vmw_fops_read,
1484 #if defined(CONFIG_COMPAT)
1485         .compat_ioctl = vmw_compat_ioctl,
1486 #endif
1487         .llseek = noop_llseek,
1488 };
1489
1490 static struct drm_driver driver = {
1491         .driver_features = DRIVER_HAVE_IRQ | DRIVER_IRQ_SHARED |
1492         DRIVER_MODESET | DRIVER_PRIME | DRIVER_RENDER,
1493         .load = vmw_driver_load,
1494         .unload = vmw_driver_unload,
1495         .lastclose = vmw_lastclose,
1496         .irq_preinstall = vmw_irq_preinstall,
1497         .irq_postinstall = vmw_irq_postinstall,
1498         .irq_uninstall = vmw_irq_uninstall,
1499         .irq_handler = vmw_irq_handler,
1500         .get_vblank_counter = vmw_get_vblank_counter,
1501         .enable_vblank = vmw_enable_vblank,
1502         .disable_vblank = vmw_disable_vblank,
1503         .ioctls = vmw_ioctls,
1504         .num_ioctls = ARRAY_SIZE(vmw_ioctls),
1505         .master_create = vmw_master_create,
1506         .master_destroy = vmw_master_destroy,
1507         .master_set = vmw_master_set,
1508         .master_drop = vmw_master_drop,
1509         .open = vmw_driver_open,
1510         .preclose = vmw_preclose,
1511         .postclose = vmw_postclose,
1512         .set_busid = drm_pci_set_busid,
1513
1514         .dumb_create = vmw_dumb_create,
1515         .dumb_map_offset = vmw_dumb_map_offset,
1516         .dumb_destroy = vmw_dumb_destroy,
1517
1518         .prime_fd_to_handle = vmw_prime_fd_to_handle,
1519         .prime_handle_to_fd = vmw_prime_handle_to_fd,
1520
1521         .fops = &vmwgfx_driver_fops,
1522         .name = VMWGFX_DRIVER_NAME,
1523         .desc = VMWGFX_DRIVER_DESC,
1524         .date = VMWGFX_DRIVER_DATE,
1525         .major = VMWGFX_DRIVER_MAJOR,
1526         .minor = VMWGFX_DRIVER_MINOR,
1527         .patchlevel = VMWGFX_DRIVER_PATCHLEVEL
1528 };
1529
1530 static struct pci_driver vmw_pci_driver = {
1531         .name = VMWGFX_DRIVER_NAME,
1532         .id_table = vmw_pci_id_list,
1533         .probe = vmw_probe,
1534         .remove = vmw_remove,
1535         .driver = {
1536                 .pm = &vmw_pm_ops
1537         }
1538 };
1539
1540 static int vmw_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
1541 {
1542         return drm_get_pci_dev(pdev, ent, &driver);
1543 }
1544
1545 static int __init vmwgfx_init(void)
1546 {
1547         int ret;
1548         ret = drm_pci_init(&driver, &vmw_pci_driver);
1549         if (ret)
1550                 DRM_ERROR("Failed initializing DRM.\n");
1551         return ret;
1552 }
1553
1554 static void __exit vmwgfx_exit(void)
1555 {
1556         drm_pci_exit(&driver, &vmw_pci_driver);
1557 }
1558
1559 module_init(vmwgfx_init);
1560 module_exit(vmwgfx_exit);
1561
1562 MODULE_AUTHOR("VMware Inc. and others");
1563 MODULE_DESCRIPTION("Standalone drm driver for the VMware SVGA device");
1564 MODULE_LICENSE("GPL and additional rights");
1565 MODULE_VERSION(__stringify(VMWGFX_DRIVER_MAJOR) "."
1566                __stringify(VMWGFX_DRIVER_MINOR) "."
1567                __stringify(VMWGFX_DRIVER_PATCHLEVEL) "."
1568                "0");