xref: /linux/drivers/gpu/drm/vmwgfx/vmwgfx_kms.c (revision e08a1d97d33e2ac05cd368b955f9fdc2823f15fd)
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 
28 #include "vmwgfx_kms.h"
29 
30 
31 /* Might need a hrtimer here? */
32 #define VMWGFX_PRESENT_RATE ((HZ / 60 > 0) ? HZ / 60 : 1)
33 
34 void vmw_du_cleanup(struct vmw_display_unit *du)
35 {
36 	if (du->cursor_surface)
37 		vmw_surface_unreference(&du->cursor_surface);
38 	if (du->cursor_dmabuf)
39 		vmw_dmabuf_unreference(&du->cursor_dmabuf);
40 	drm_connector_unregister(&du->connector);
41 	drm_crtc_cleanup(&du->crtc);
42 	drm_encoder_cleanup(&du->encoder);
43 	drm_connector_cleanup(&du->connector);
44 }
45 
46 /*
47  * Display Unit Cursor functions
48  */
49 
50 int vmw_cursor_update_image(struct vmw_private *dev_priv,
51 			    u32 *image, u32 width, u32 height,
52 			    u32 hotspotX, u32 hotspotY)
53 {
54 	struct {
55 		u32 cmd;
56 		SVGAFifoCmdDefineAlphaCursor cursor;
57 	} *cmd;
58 	u32 image_size = width * height * 4;
59 	u32 cmd_size = sizeof(*cmd) + image_size;
60 
61 	if (!image)
62 		return -EINVAL;
63 
64 	cmd = vmw_fifo_reserve(dev_priv, cmd_size);
65 	if (unlikely(cmd == NULL)) {
66 		DRM_ERROR("Fifo reserve failed.\n");
67 		return -ENOMEM;
68 	}
69 
70 	memset(cmd, 0, sizeof(*cmd));
71 
72 	memcpy(&cmd[1], image, image_size);
73 
74 	cmd->cmd = SVGA_CMD_DEFINE_ALPHA_CURSOR;
75 	cmd->cursor.id = 0;
76 	cmd->cursor.width = width;
77 	cmd->cursor.height = height;
78 	cmd->cursor.hotspotX = hotspotX;
79 	cmd->cursor.hotspotY = hotspotY;
80 
81 	vmw_fifo_commit_flush(dev_priv, cmd_size);
82 
83 	return 0;
84 }
85 
86 int vmw_cursor_update_dmabuf(struct vmw_private *dev_priv,
87 			     struct vmw_dma_buffer *dmabuf,
88 			     u32 width, u32 height,
89 			     u32 hotspotX, u32 hotspotY)
90 {
91 	struct ttm_bo_kmap_obj map;
92 	unsigned long kmap_offset;
93 	unsigned long kmap_num;
94 	void *virtual;
95 	bool dummy;
96 	int ret;
97 
98 	kmap_offset = 0;
99 	kmap_num = (width*height*4 + PAGE_SIZE - 1) >> PAGE_SHIFT;
100 
101 	ret = ttm_bo_reserve(&dmabuf->base, true, false, NULL);
102 	if (unlikely(ret != 0)) {
103 		DRM_ERROR("reserve failed\n");
104 		return -EINVAL;
105 	}
106 
107 	ret = ttm_bo_kmap(&dmabuf->base, kmap_offset, kmap_num, &map);
108 	if (unlikely(ret != 0))
109 		goto err_unreserve;
110 
111 	virtual = ttm_kmap_obj_virtual(&map, &dummy);
112 	ret = vmw_cursor_update_image(dev_priv, virtual, width, height,
113 				      hotspotX, hotspotY);
114 
115 	ttm_bo_kunmap(&map);
116 err_unreserve:
117 	ttm_bo_unreserve(&dmabuf->base);
118 
119 	return ret;
120 }
121 
122 
123 void vmw_cursor_update_position(struct vmw_private *dev_priv,
124 				bool show, int x, int y)
125 {
126 	u32 *fifo_mem = dev_priv->mmio_virt;
127 	uint32_t count;
128 
129 	vmw_mmio_write(show ? 1 : 0, fifo_mem + SVGA_FIFO_CURSOR_ON);
130 	vmw_mmio_write(x, fifo_mem + SVGA_FIFO_CURSOR_X);
131 	vmw_mmio_write(y, fifo_mem + SVGA_FIFO_CURSOR_Y);
132 	count = vmw_mmio_read(fifo_mem + SVGA_FIFO_CURSOR_COUNT);
133 	vmw_mmio_write(++count, fifo_mem + SVGA_FIFO_CURSOR_COUNT);
134 }
135 
136 
137 /*
138  * vmw_du_crtc_cursor_set2 - Driver cursor_set2 callback.
139  */
140 int vmw_du_crtc_cursor_set2(struct drm_crtc *crtc, struct drm_file *file_priv,
141 			    uint32_t handle, uint32_t width, uint32_t height,
142 			    int32_t hot_x, int32_t hot_y)
143 {
144 	struct vmw_private *dev_priv = vmw_priv(crtc->dev);
145 	struct vmw_display_unit *du = vmw_crtc_to_du(crtc);
146 	struct vmw_surface *surface = NULL;
147 	struct vmw_dma_buffer *dmabuf = NULL;
148 	s32 hotspot_x, hotspot_y;
149 	int ret;
150 
151 	/*
152 	 * FIXME: Unclear whether there's any global state touched by the
153 	 * cursor_set function, especially vmw_cursor_update_position looks
154 	 * suspicious. For now take the easy route and reacquire all locks. We
155 	 * can do this since the caller in the drm core doesn't check anything
156 	 * which is protected by any looks.
157 	 */
158 	drm_modeset_unlock_crtc(crtc);
159 	drm_modeset_lock_all(dev_priv->dev);
160 	hotspot_x = hot_x + du->hotspot_x;
161 	hotspot_y = hot_y + du->hotspot_y;
162 
163 	/* A lot of the code assumes this */
164 	if (handle && (width != 64 || height != 64)) {
165 		ret = -EINVAL;
166 		goto out;
167 	}
168 
169 	if (handle) {
170 		struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
171 
172 		ret = vmw_user_lookup_handle(dev_priv, tfile,
173 					     handle, &surface, &dmabuf);
174 		if (ret) {
175 			DRM_ERROR("failed to find surface or dmabuf: %i\n", ret);
176 			ret = -EINVAL;
177 			goto out;
178 		}
179 	}
180 
181 	/* need to do this before taking down old image */
182 	if (surface && !surface->snooper.image) {
183 		DRM_ERROR("surface not suitable for cursor\n");
184 		vmw_surface_unreference(&surface);
185 		ret = -EINVAL;
186 		goto out;
187 	}
188 
189 	/* takedown old cursor */
190 	if (du->cursor_surface) {
191 		du->cursor_surface->snooper.crtc = NULL;
192 		vmw_surface_unreference(&du->cursor_surface);
193 	}
194 	if (du->cursor_dmabuf)
195 		vmw_dmabuf_unreference(&du->cursor_dmabuf);
196 
197 	/* setup new image */
198 	ret = 0;
199 	if (surface) {
200 		/* vmw_user_surface_lookup takes one reference */
201 		du->cursor_surface = surface;
202 
203 		du->cursor_surface->snooper.crtc = crtc;
204 		du->cursor_age = du->cursor_surface->snooper.age;
205 		ret = vmw_cursor_update_image(dev_priv, surface->snooper.image,
206 					      64, 64, hotspot_x, hotspot_y);
207 	} else if (dmabuf) {
208 		/* vmw_user_surface_lookup takes one reference */
209 		du->cursor_dmabuf = dmabuf;
210 
211 		ret = vmw_cursor_update_dmabuf(dev_priv, dmabuf, width, height,
212 					       hotspot_x, hotspot_y);
213 	} else {
214 		vmw_cursor_update_position(dev_priv, false, 0, 0);
215 		goto out;
216 	}
217 
218 	if (!ret) {
219 		vmw_cursor_update_position(dev_priv, true,
220 					   du->cursor_x + hotspot_x,
221 					   du->cursor_y + hotspot_y);
222 		du->core_hotspot_x = hot_x;
223 		du->core_hotspot_y = hot_y;
224 	}
225 
226 out:
227 	drm_modeset_unlock_all(dev_priv->dev);
228 	drm_modeset_lock_crtc(crtc, crtc->cursor);
229 
230 	return ret;
231 }
232 
233 int vmw_du_crtc_cursor_move(struct drm_crtc *crtc, int x, int y)
234 {
235 	struct vmw_private *dev_priv = vmw_priv(crtc->dev);
236 	struct vmw_display_unit *du = vmw_crtc_to_du(crtc);
237 	bool shown = du->cursor_surface || du->cursor_dmabuf ? true : false;
238 
239 	du->cursor_x = x + du->set_gui_x;
240 	du->cursor_y = y + du->set_gui_y;
241 
242 	/*
243 	 * FIXME: Unclear whether there's any global state touched by the
244 	 * cursor_set function, especially vmw_cursor_update_position looks
245 	 * suspicious. For now take the easy route and reacquire all locks. We
246 	 * can do this since the caller in the drm core doesn't check anything
247 	 * which is protected by any looks.
248 	 */
249 	drm_modeset_unlock_crtc(crtc);
250 	drm_modeset_lock_all(dev_priv->dev);
251 
252 	vmw_cursor_update_position(dev_priv, shown,
253 				   du->cursor_x + du->hotspot_x +
254 				   du->core_hotspot_x,
255 				   du->cursor_y + du->hotspot_y +
256 				   du->core_hotspot_y);
257 
258 	drm_modeset_unlock_all(dev_priv->dev);
259 	drm_modeset_lock_crtc(crtc, crtc->cursor);
260 
261 	return 0;
262 }
263 
264 void vmw_kms_cursor_snoop(struct vmw_surface *srf,
265 			  struct ttm_object_file *tfile,
266 			  struct ttm_buffer_object *bo,
267 			  SVGA3dCmdHeader *header)
268 {
269 	struct ttm_bo_kmap_obj map;
270 	unsigned long kmap_offset;
271 	unsigned long kmap_num;
272 	SVGA3dCopyBox *box;
273 	unsigned box_count;
274 	void *virtual;
275 	bool dummy;
276 	struct vmw_dma_cmd {
277 		SVGA3dCmdHeader header;
278 		SVGA3dCmdSurfaceDMA dma;
279 	} *cmd;
280 	int i, ret;
281 
282 	cmd = container_of(header, struct vmw_dma_cmd, header);
283 
284 	/* No snooper installed */
285 	if (!srf->snooper.image)
286 		return;
287 
288 	if (cmd->dma.host.face != 0 || cmd->dma.host.mipmap != 0) {
289 		DRM_ERROR("face and mipmap for cursors should never != 0\n");
290 		return;
291 	}
292 
293 	if (cmd->header.size < 64) {
294 		DRM_ERROR("at least one full copy box must be given\n");
295 		return;
296 	}
297 
298 	box = (SVGA3dCopyBox *)&cmd[1];
299 	box_count = (cmd->header.size - sizeof(SVGA3dCmdSurfaceDMA)) /
300 			sizeof(SVGA3dCopyBox);
301 
302 	if (cmd->dma.guest.ptr.offset % PAGE_SIZE ||
303 	    box->x != 0    || box->y != 0    || box->z != 0    ||
304 	    box->srcx != 0 || box->srcy != 0 || box->srcz != 0 ||
305 	    box->d != 1    || box_count != 1) {
306 		/* TODO handle none page aligned offsets */
307 		/* TODO handle more dst & src != 0 */
308 		/* TODO handle more then one copy */
309 		DRM_ERROR("Cant snoop dma request for cursor!\n");
310 		DRM_ERROR("(%u, %u, %u) (%u, %u, %u) (%ux%ux%u) %u %u\n",
311 			  box->srcx, box->srcy, box->srcz,
312 			  box->x, box->y, box->z,
313 			  box->w, box->h, box->d, box_count,
314 			  cmd->dma.guest.ptr.offset);
315 		return;
316 	}
317 
318 	kmap_offset = cmd->dma.guest.ptr.offset >> PAGE_SHIFT;
319 	kmap_num = (64*64*4) >> PAGE_SHIFT;
320 
321 	ret = ttm_bo_reserve(bo, true, false, NULL);
322 	if (unlikely(ret != 0)) {
323 		DRM_ERROR("reserve failed\n");
324 		return;
325 	}
326 
327 	ret = ttm_bo_kmap(bo, kmap_offset, kmap_num, &map);
328 	if (unlikely(ret != 0))
329 		goto err_unreserve;
330 
331 	virtual = ttm_kmap_obj_virtual(&map, &dummy);
332 
333 	if (box->w == 64 && cmd->dma.guest.pitch == 64*4) {
334 		memcpy(srf->snooper.image, virtual, 64*64*4);
335 	} else {
336 		/* Image is unsigned pointer. */
337 		for (i = 0; i < box->h; i++)
338 			memcpy(srf->snooper.image + i * 64,
339 			       virtual + i * cmd->dma.guest.pitch,
340 			       box->w * 4);
341 	}
342 
343 	srf->snooper.age++;
344 
345 	ttm_bo_kunmap(&map);
346 err_unreserve:
347 	ttm_bo_unreserve(bo);
348 }
349 
350 /**
351  * vmw_kms_legacy_hotspot_clear - Clear legacy hotspots
352  *
353  * @dev_priv: Pointer to the device private struct.
354  *
355  * Clears all legacy hotspots.
356  */
357 void vmw_kms_legacy_hotspot_clear(struct vmw_private *dev_priv)
358 {
359 	struct drm_device *dev = dev_priv->dev;
360 	struct vmw_display_unit *du;
361 	struct drm_crtc *crtc;
362 
363 	drm_modeset_lock_all(dev);
364 	drm_for_each_crtc(crtc, dev) {
365 		du = vmw_crtc_to_du(crtc);
366 
367 		du->hotspot_x = 0;
368 		du->hotspot_y = 0;
369 	}
370 	drm_modeset_unlock_all(dev);
371 }
372 
373 void vmw_kms_cursor_post_execbuf(struct vmw_private *dev_priv)
374 {
375 	struct drm_device *dev = dev_priv->dev;
376 	struct vmw_display_unit *du;
377 	struct drm_crtc *crtc;
378 
379 	mutex_lock(&dev->mode_config.mutex);
380 
381 	list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
382 		du = vmw_crtc_to_du(crtc);
383 		if (!du->cursor_surface ||
384 		    du->cursor_age == du->cursor_surface->snooper.age)
385 			continue;
386 
387 		du->cursor_age = du->cursor_surface->snooper.age;
388 		vmw_cursor_update_image(dev_priv,
389 					du->cursor_surface->snooper.image,
390 					64, 64,
391 					du->hotspot_x + du->core_hotspot_x,
392 					du->hotspot_y + du->core_hotspot_y);
393 	}
394 
395 	mutex_unlock(&dev->mode_config.mutex);
396 }
397 
398 /*
399  * Generic framebuffer code
400  */
401 
402 /*
403  * Surface framebuffer code
404  */
405 
406 static void vmw_framebuffer_surface_destroy(struct drm_framebuffer *framebuffer)
407 {
408 	struct vmw_framebuffer_surface *vfbs =
409 		vmw_framebuffer_to_vfbs(framebuffer);
410 
411 	drm_framebuffer_cleanup(framebuffer);
412 	vmw_surface_unreference(&vfbs->surface);
413 	if (vfbs->base.user_obj)
414 		ttm_base_object_unref(&vfbs->base.user_obj);
415 
416 	kfree(vfbs);
417 }
418 
419 static int vmw_framebuffer_surface_dirty(struct drm_framebuffer *framebuffer,
420 				  struct drm_file *file_priv,
421 				  unsigned flags, unsigned color,
422 				  struct drm_clip_rect *clips,
423 				  unsigned num_clips)
424 {
425 	struct vmw_private *dev_priv = vmw_priv(framebuffer->dev);
426 	struct vmw_framebuffer_surface *vfbs =
427 		vmw_framebuffer_to_vfbs(framebuffer);
428 	struct drm_clip_rect norect;
429 	int ret, inc = 1;
430 
431 	/* Legacy Display Unit does not support 3D */
432 	if (dev_priv->active_display_unit == vmw_du_legacy)
433 		return -EINVAL;
434 
435 	drm_modeset_lock_all(dev_priv->dev);
436 
437 	ret = ttm_read_lock(&dev_priv->reservation_sem, true);
438 	if (unlikely(ret != 0)) {
439 		drm_modeset_unlock_all(dev_priv->dev);
440 		return ret;
441 	}
442 
443 	if (!num_clips) {
444 		num_clips = 1;
445 		clips = &norect;
446 		norect.x1 = norect.y1 = 0;
447 		norect.x2 = framebuffer->width;
448 		norect.y2 = framebuffer->height;
449 	} else if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY) {
450 		num_clips /= 2;
451 		inc = 2; /* skip source rects */
452 	}
453 
454 	if (dev_priv->active_display_unit == vmw_du_screen_object)
455 		ret = vmw_kms_sou_do_surface_dirty(dev_priv, &vfbs->base,
456 						   clips, NULL, NULL, 0, 0,
457 						   num_clips, inc, NULL);
458 	else
459 		ret = vmw_kms_stdu_surface_dirty(dev_priv, &vfbs->base,
460 						 clips, NULL, NULL, 0, 0,
461 						 num_clips, inc, NULL);
462 
463 	vmw_fifo_flush(dev_priv, false);
464 	ttm_read_unlock(&dev_priv->reservation_sem);
465 
466 	drm_modeset_unlock_all(dev_priv->dev);
467 
468 	return 0;
469 }
470 
471 /**
472  * vmw_kms_readback - Perform a readback from the screen system to
473  * a dma-buffer backed framebuffer.
474  *
475  * @dev_priv: Pointer to the device private structure.
476  * @file_priv: Pointer to a struct drm_file identifying the caller.
477  * Must be set to NULL if @user_fence_rep is NULL.
478  * @vfb: Pointer to the dma-buffer backed framebuffer.
479  * @user_fence_rep: User-space provided structure for fence information.
480  * Must be set to non-NULL if @file_priv is non-NULL.
481  * @vclips: Array of clip rects.
482  * @num_clips: Number of clip rects in @vclips.
483  *
484  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
485  * interrupted.
486  */
487 int vmw_kms_readback(struct vmw_private *dev_priv,
488 		     struct drm_file *file_priv,
489 		     struct vmw_framebuffer *vfb,
490 		     struct drm_vmw_fence_rep __user *user_fence_rep,
491 		     struct drm_vmw_rect *vclips,
492 		     uint32_t num_clips)
493 {
494 	switch (dev_priv->active_display_unit) {
495 	case vmw_du_screen_object:
496 		return vmw_kms_sou_readback(dev_priv, file_priv, vfb,
497 					    user_fence_rep, vclips, num_clips);
498 	case vmw_du_screen_target:
499 		return vmw_kms_stdu_dma(dev_priv, file_priv, vfb,
500 					user_fence_rep, NULL, vclips, num_clips,
501 					1, false, true);
502 	default:
503 		WARN_ONCE(true,
504 			  "Readback called with invalid display system.\n");
505 }
506 
507 	return -ENOSYS;
508 }
509 
510 
511 static const struct drm_framebuffer_funcs vmw_framebuffer_surface_funcs = {
512 	.destroy = vmw_framebuffer_surface_destroy,
513 	.dirty = vmw_framebuffer_surface_dirty,
514 };
515 
516 static int vmw_kms_new_framebuffer_surface(struct vmw_private *dev_priv,
517 					   struct vmw_surface *surface,
518 					   struct vmw_framebuffer **out,
519 					   const struct drm_mode_fb_cmd
520 					   *mode_cmd,
521 					   bool is_dmabuf_proxy)
522 
523 {
524 	struct drm_device *dev = dev_priv->dev;
525 	struct vmw_framebuffer_surface *vfbs;
526 	enum SVGA3dSurfaceFormat format;
527 	int ret;
528 
529 	/* 3D is only supported on HWv8 and newer hosts */
530 	if (dev_priv->active_display_unit == vmw_du_legacy)
531 		return -ENOSYS;
532 
533 	/*
534 	 * Sanity checks.
535 	 */
536 
537 	/* Surface must be marked as a scanout. */
538 	if (unlikely(!surface->scanout))
539 		return -EINVAL;
540 
541 	if (unlikely(surface->mip_levels[0] != 1 ||
542 		     surface->num_sizes != 1 ||
543 		     surface->base_size.width < mode_cmd->width ||
544 		     surface->base_size.height < mode_cmd->height ||
545 		     surface->base_size.depth != 1)) {
546 		DRM_ERROR("Incompatible surface dimensions "
547 			  "for requested mode.\n");
548 		return -EINVAL;
549 	}
550 
551 	switch (mode_cmd->depth) {
552 	case 32:
553 		format = SVGA3D_A8R8G8B8;
554 		break;
555 	case 24:
556 		format = SVGA3D_X8R8G8B8;
557 		break;
558 	case 16:
559 		format = SVGA3D_R5G6B5;
560 		break;
561 	case 15:
562 		format = SVGA3D_A1R5G5B5;
563 		break;
564 	default:
565 		DRM_ERROR("Invalid color depth: %d\n", mode_cmd->depth);
566 		return -EINVAL;
567 	}
568 
569 	/*
570 	 * For DX, surface format validation is done when surface->scanout
571 	 * is set.
572 	 */
573 	if (!dev_priv->has_dx && format != surface->format) {
574 		DRM_ERROR("Invalid surface format for requested mode.\n");
575 		return -EINVAL;
576 	}
577 
578 	vfbs = kzalloc(sizeof(*vfbs), GFP_KERNEL);
579 	if (!vfbs) {
580 		ret = -ENOMEM;
581 		goto out_err1;
582 	}
583 
584 	/* XXX get the first 3 from the surface info */
585 	vfbs->base.base.bits_per_pixel = mode_cmd->bpp;
586 	vfbs->base.base.pitches[0] = mode_cmd->pitch;
587 	vfbs->base.base.depth = mode_cmd->depth;
588 	vfbs->base.base.width = mode_cmd->width;
589 	vfbs->base.base.height = mode_cmd->height;
590 	vfbs->surface = vmw_surface_reference(surface);
591 	vfbs->base.user_handle = mode_cmd->handle;
592 	vfbs->is_dmabuf_proxy = is_dmabuf_proxy;
593 
594 	*out = &vfbs->base;
595 
596 	ret = drm_framebuffer_init(dev, &vfbs->base.base,
597 				   &vmw_framebuffer_surface_funcs);
598 	if (ret)
599 		goto out_err2;
600 
601 	return 0;
602 
603 out_err2:
604 	vmw_surface_unreference(&surface);
605 	kfree(vfbs);
606 out_err1:
607 	return ret;
608 }
609 
610 /*
611  * Dmabuf framebuffer code
612  */
613 
614 static void vmw_framebuffer_dmabuf_destroy(struct drm_framebuffer *framebuffer)
615 {
616 	struct vmw_framebuffer_dmabuf *vfbd =
617 		vmw_framebuffer_to_vfbd(framebuffer);
618 
619 	drm_framebuffer_cleanup(framebuffer);
620 	vmw_dmabuf_unreference(&vfbd->buffer);
621 	if (vfbd->base.user_obj)
622 		ttm_base_object_unref(&vfbd->base.user_obj);
623 
624 	kfree(vfbd);
625 }
626 
627 static int vmw_framebuffer_dmabuf_dirty(struct drm_framebuffer *framebuffer,
628 				 struct drm_file *file_priv,
629 				 unsigned flags, unsigned color,
630 				 struct drm_clip_rect *clips,
631 				 unsigned num_clips)
632 {
633 	struct vmw_private *dev_priv = vmw_priv(framebuffer->dev);
634 	struct vmw_framebuffer_dmabuf *vfbd =
635 		vmw_framebuffer_to_vfbd(framebuffer);
636 	struct drm_clip_rect norect;
637 	int ret, increment = 1;
638 
639 	drm_modeset_lock_all(dev_priv->dev);
640 
641 	ret = ttm_read_lock(&dev_priv->reservation_sem, true);
642 	if (unlikely(ret != 0)) {
643 		drm_modeset_unlock_all(dev_priv->dev);
644 		return ret;
645 	}
646 
647 	if (!num_clips) {
648 		num_clips = 1;
649 		clips = &norect;
650 		norect.x1 = norect.y1 = 0;
651 		norect.x2 = framebuffer->width;
652 		norect.y2 = framebuffer->height;
653 	} else if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY) {
654 		num_clips /= 2;
655 		increment = 2;
656 	}
657 
658 	switch (dev_priv->active_display_unit) {
659 	case vmw_du_screen_target:
660 		ret = vmw_kms_stdu_dma(dev_priv, NULL, &vfbd->base, NULL,
661 				       clips, NULL, num_clips, increment,
662 				       true, true);
663 		break;
664 	case vmw_du_screen_object:
665 		ret = vmw_kms_sou_do_dmabuf_dirty(dev_priv, &vfbd->base,
666 						  clips, NULL, num_clips,
667 						  increment, true, NULL);
668 		break;
669 	case vmw_du_legacy:
670 		ret = vmw_kms_ldu_do_dmabuf_dirty(dev_priv, &vfbd->base, 0, 0,
671 						  clips, num_clips, increment);
672 		break;
673 	default:
674 		ret = -EINVAL;
675 		WARN_ONCE(true, "Dirty called with invalid display system.\n");
676 		break;
677 	}
678 
679 	vmw_fifo_flush(dev_priv, false);
680 	ttm_read_unlock(&dev_priv->reservation_sem);
681 
682 	drm_modeset_unlock_all(dev_priv->dev);
683 
684 	return ret;
685 }
686 
687 static const struct drm_framebuffer_funcs vmw_framebuffer_dmabuf_funcs = {
688 	.destroy = vmw_framebuffer_dmabuf_destroy,
689 	.dirty = vmw_framebuffer_dmabuf_dirty,
690 };
691 
692 /**
693  * Pin the dmabuffer to the start of vram.
694  */
695 static int vmw_framebuffer_pin(struct vmw_framebuffer *vfb)
696 {
697 	struct vmw_private *dev_priv = vmw_priv(vfb->base.dev);
698 	struct vmw_dma_buffer *buf;
699 	int ret;
700 
701 	buf = vfb->dmabuf ?  vmw_framebuffer_to_vfbd(&vfb->base)->buffer :
702 		vmw_framebuffer_to_vfbs(&vfb->base)->surface->res.backup;
703 
704 	if (!buf)
705 		return 0;
706 
707 	switch (dev_priv->active_display_unit) {
708 	case vmw_du_legacy:
709 		vmw_overlay_pause_all(dev_priv);
710 		ret = vmw_dmabuf_pin_in_start_of_vram(dev_priv, buf, false);
711 		vmw_overlay_resume_all(dev_priv);
712 		break;
713 	case vmw_du_screen_object:
714 	case vmw_du_screen_target:
715 		if (vfb->dmabuf)
716 			return vmw_dmabuf_pin_in_vram_or_gmr(dev_priv, buf,
717 							     false);
718 
719 		return vmw_dmabuf_pin_in_placement(dev_priv, buf,
720 						   &vmw_mob_placement, false);
721 	default:
722 		return -EINVAL;
723 	}
724 
725 	return ret;
726 }
727 
728 static int vmw_framebuffer_unpin(struct vmw_framebuffer *vfb)
729 {
730 	struct vmw_private *dev_priv = vmw_priv(vfb->base.dev);
731 	struct vmw_dma_buffer *buf;
732 
733 	buf = vfb->dmabuf ?  vmw_framebuffer_to_vfbd(&vfb->base)->buffer :
734 		vmw_framebuffer_to_vfbs(&vfb->base)->surface->res.backup;
735 
736 	if (WARN_ON(!buf))
737 		return 0;
738 
739 	return vmw_dmabuf_unpin(dev_priv, buf, false);
740 }
741 
742 /**
743  * vmw_create_dmabuf_proxy - create a proxy surface for the DMA buf
744  *
745  * @dev: DRM device
746  * @mode_cmd: parameters for the new surface
747  * @dmabuf_mob: MOB backing the DMA buf
748  * @srf_out: newly created surface
749  *
750  * When the content FB is a DMA buf, we create a surface as a proxy to the
751  * same buffer.  This way we can do a surface copy rather than a surface DMA.
752  * This is a more efficient approach
753  *
754  * RETURNS:
755  * 0 on success, error code otherwise
756  */
757 static int vmw_create_dmabuf_proxy(struct drm_device *dev,
758 				   const struct drm_mode_fb_cmd *mode_cmd,
759 				   struct vmw_dma_buffer *dmabuf_mob,
760 				   struct vmw_surface **srf_out)
761 {
762 	uint32_t format;
763 	struct drm_vmw_size content_base_size;
764 	struct vmw_resource *res;
765 	unsigned int bytes_pp;
766 	int ret;
767 
768 	switch (mode_cmd->depth) {
769 	case 32:
770 	case 24:
771 		format = SVGA3D_X8R8G8B8;
772 		bytes_pp = 4;
773 		break;
774 
775 	case 16:
776 	case 15:
777 		format = SVGA3D_R5G6B5;
778 		bytes_pp = 2;
779 		break;
780 
781 	case 8:
782 		format = SVGA3D_P8;
783 		bytes_pp = 1;
784 		break;
785 
786 	default:
787 		DRM_ERROR("Invalid framebuffer format %d\n", mode_cmd->depth);
788 		return -EINVAL;
789 	}
790 
791 	content_base_size.width  = mode_cmd->pitch / bytes_pp;
792 	content_base_size.height = mode_cmd->height;
793 	content_base_size.depth  = 1;
794 
795 	ret = vmw_surface_gb_priv_define(dev,
796 			0, /* kernel visible only */
797 			0, /* flags */
798 			format,
799 			true, /* can be a scanout buffer */
800 			1, /* num of mip levels */
801 			0,
802 			0,
803 			content_base_size,
804 			srf_out);
805 	if (ret) {
806 		DRM_ERROR("Failed to allocate proxy content buffer\n");
807 		return ret;
808 	}
809 
810 	res = &(*srf_out)->res;
811 
812 	/* Reserve and switch the backing mob. */
813 	mutex_lock(&res->dev_priv->cmdbuf_mutex);
814 	(void) vmw_resource_reserve(res, false, true);
815 	vmw_dmabuf_unreference(&res->backup);
816 	res->backup = vmw_dmabuf_reference(dmabuf_mob);
817 	res->backup_offset = 0;
818 	vmw_resource_unreserve(res, false, NULL, 0);
819 	mutex_unlock(&res->dev_priv->cmdbuf_mutex);
820 
821 	return 0;
822 }
823 
824 
825 
826 static int vmw_kms_new_framebuffer_dmabuf(struct vmw_private *dev_priv,
827 					  struct vmw_dma_buffer *dmabuf,
828 					  struct vmw_framebuffer **out,
829 					  const struct drm_mode_fb_cmd
830 					  *mode_cmd)
831 
832 {
833 	struct drm_device *dev = dev_priv->dev;
834 	struct vmw_framebuffer_dmabuf *vfbd;
835 	unsigned int requested_size;
836 	int ret;
837 
838 	requested_size = mode_cmd->height * mode_cmd->pitch;
839 	if (unlikely(requested_size > dmabuf->base.num_pages * PAGE_SIZE)) {
840 		DRM_ERROR("Screen buffer object size is too small "
841 			  "for requested mode.\n");
842 		return -EINVAL;
843 	}
844 
845 	/* Limited framebuffer color depth support for screen objects */
846 	if (dev_priv->active_display_unit == vmw_du_screen_object) {
847 		switch (mode_cmd->depth) {
848 		case 32:
849 		case 24:
850 			/* Only support 32 bpp for 32 and 24 depth fbs */
851 			if (mode_cmd->bpp == 32)
852 				break;
853 
854 			DRM_ERROR("Invalid color depth/bbp: %d %d\n",
855 				  mode_cmd->depth, mode_cmd->bpp);
856 			return -EINVAL;
857 		case 16:
858 		case 15:
859 			/* Only support 16 bpp for 16 and 15 depth fbs */
860 			if (mode_cmd->bpp == 16)
861 				break;
862 
863 			DRM_ERROR("Invalid color depth/bbp: %d %d\n",
864 				  mode_cmd->depth, mode_cmd->bpp);
865 			return -EINVAL;
866 		default:
867 			DRM_ERROR("Invalid color depth: %d\n", mode_cmd->depth);
868 			return -EINVAL;
869 		}
870 	}
871 
872 	vfbd = kzalloc(sizeof(*vfbd), GFP_KERNEL);
873 	if (!vfbd) {
874 		ret = -ENOMEM;
875 		goto out_err1;
876 	}
877 
878 	vfbd->base.base.bits_per_pixel = mode_cmd->bpp;
879 	vfbd->base.base.pitches[0] = mode_cmd->pitch;
880 	vfbd->base.base.depth = mode_cmd->depth;
881 	vfbd->base.base.width = mode_cmd->width;
882 	vfbd->base.base.height = mode_cmd->height;
883 	vfbd->base.dmabuf = true;
884 	vfbd->buffer = vmw_dmabuf_reference(dmabuf);
885 	vfbd->base.user_handle = mode_cmd->handle;
886 	*out = &vfbd->base;
887 
888 	ret = drm_framebuffer_init(dev, &vfbd->base.base,
889 				   &vmw_framebuffer_dmabuf_funcs);
890 	if (ret)
891 		goto out_err2;
892 
893 	return 0;
894 
895 out_err2:
896 	vmw_dmabuf_unreference(&dmabuf);
897 	kfree(vfbd);
898 out_err1:
899 	return ret;
900 }
901 
902 /**
903  * vmw_kms_new_framebuffer - Create a new framebuffer.
904  *
905  * @dev_priv: Pointer to device private struct.
906  * @dmabuf: Pointer to dma buffer to wrap the kms framebuffer around.
907  * Either @dmabuf or @surface must be NULL.
908  * @surface: Pointer to a surface to wrap the kms framebuffer around.
909  * Either @dmabuf or @surface must be NULL.
910  * @only_2d: No presents will occur to this dma buffer based framebuffer. This
911  * Helps the code to do some important optimizations.
912  * @mode_cmd: Frame-buffer metadata.
913  */
914 struct vmw_framebuffer *
915 vmw_kms_new_framebuffer(struct vmw_private *dev_priv,
916 			struct vmw_dma_buffer *dmabuf,
917 			struct vmw_surface *surface,
918 			bool only_2d,
919 			const struct drm_mode_fb_cmd *mode_cmd)
920 {
921 	struct vmw_framebuffer *vfb = NULL;
922 	bool is_dmabuf_proxy = false;
923 	int ret;
924 
925 	/*
926 	 * We cannot use the SurfaceDMA command in an non-accelerated VM,
927 	 * therefore, wrap the DMA buf in a surface so we can use the
928 	 * SurfaceCopy command.
929 	 */
930 	if (dmabuf && only_2d &&
931 	    dev_priv->active_display_unit == vmw_du_screen_target) {
932 		ret = vmw_create_dmabuf_proxy(dev_priv->dev, mode_cmd,
933 					      dmabuf, &surface);
934 		if (ret)
935 			return ERR_PTR(ret);
936 
937 		is_dmabuf_proxy = true;
938 	}
939 
940 	/* Create the new framebuffer depending one what we have */
941 	if (surface) {
942 		ret = vmw_kms_new_framebuffer_surface(dev_priv, surface, &vfb,
943 						      mode_cmd,
944 						      is_dmabuf_proxy);
945 
946 		/*
947 		 * vmw_create_dmabuf_proxy() adds a reference that is no longer
948 		 * needed
949 		 */
950 		if (is_dmabuf_proxy)
951 			vmw_surface_unreference(&surface);
952 	} else if (dmabuf) {
953 		ret = vmw_kms_new_framebuffer_dmabuf(dev_priv, dmabuf, &vfb,
954 						     mode_cmd);
955 	} else {
956 		BUG();
957 	}
958 
959 	if (ret)
960 		return ERR_PTR(ret);
961 
962 	vfb->pin = vmw_framebuffer_pin;
963 	vfb->unpin = vmw_framebuffer_unpin;
964 
965 	return vfb;
966 }
967 
968 /*
969  * Generic Kernel modesetting functions
970  */
971 
972 static struct drm_framebuffer *vmw_kms_fb_create(struct drm_device *dev,
973 						 struct drm_file *file_priv,
974 						 const struct drm_mode_fb_cmd2 *mode_cmd2)
975 {
976 	struct vmw_private *dev_priv = vmw_priv(dev);
977 	struct ttm_object_file *tfile = vmw_fpriv(file_priv)->tfile;
978 	struct vmw_framebuffer *vfb = NULL;
979 	struct vmw_surface *surface = NULL;
980 	struct vmw_dma_buffer *bo = NULL;
981 	struct ttm_base_object *user_obj;
982 	struct drm_mode_fb_cmd mode_cmd;
983 	const struct drm_format_info *info;
984 	int ret;
985 
986 	info = drm_format_info(mode_cmd2->pixel_format);
987 	if (!info || !info->depth) {
988 		DRM_ERROR("Unsupported framebuffer format %s\n",
989 			  drm_get_format_name(mode_cmd2->pixel_format));
990 		return ERR_PTR(-EINVAL);
991 	}
992 
993 	mode_cmd.width = mode_cmd2->width;
994 	mode_cmd.height = mode_cmd2->height;
995 	mode_cmd.pitch = mode_cmd2->pitches[0];
996 	mode_cmd.handle = mode_cmd2->handles[0];
997 	mode_cmd.depth = info->depth;
998 	mode_cmd.bpp = info->cpp[0] * 8;
999 
1000 	/**
1001 	 * This code should be conditioned on Screen Objects not being used.
1002 	 * If screen objects are used, we can allocate a GMR to hold the
1003 	 * requested framebuffer.
1004 	 */
1005 
1006 	if (!vmw_kms_validate_mode_vram(dev_priv,
1007 					mode_cmd.pitch,
1008 					mode_cmd.height)) {
1009 		DRM_ERROR("Requested mode exceed bounding box limit.\n");
1010 		return ERR_PTR(-ENOMEM);
1011 	}
1012 
1013 	/*
1014 	 * Take a reference on the user object of the resource
1015 	 * backing the kms fb. This ensures that user-space handle
1016 	 * lookups on that resource will always work as long as
1017 	 * it's registered with a kms framebuffer. This is important,
1018 	 * since vmw_execbuf_process identifies resources in the
1019 	 * command stream using user-space handles.
1020 	 */
1021 
1022 	user_obj = ttm_base_object_lookup(tfile, mode_cmd.handle);
1023 	if (unlikely(user_obj == NULL)) {
1024 		DRM_ERROR("Could not locate requested kms frame buffer.\n");
1025 		return ERR_PTR(-ENOENT);
1026 	}
1027 
1028 	/**
1029 	 * End conditioned code.
1030 	 */
1031 
1032 	/* returns either a dmabuf or surface */
1033 	ret = vmw_user_lookup_handle(dev_priv, tfile,
1034 				     mode_cmd.handle,
1035 				     &surface, &bo);
1036 	if (ret)
1037 		goto err_out;
1038 
1039 	vfb = vmw_kms_new_framebuffer(dev_priv, bo, surface,
1040 				      !(dev_priv->capabilities & SVGA_CAP_3D),
1041 				      &mode_cmd);
1042 	if (IS_ERR(vfb)) {
1043 		ret = PTR_ERR(vfb);
1044 		goto err_out;
1045  	}
1046 
1047 err_out:
1048 	/* vmw_user_lookup_handle takes one ref so does new_fb */
1049 	if (bo)
1050 		vmw_dmabuf_unreference(&bo);
1051 	if (surface)
1052 		vmw_surface_unreference(&surface);
1053 
1054 	if (ret) {
1055 		DRM_ERROR("failed to create vmw_framebuffer: %i\n", ret);
1056 		ttm_base_object_unref(&user_obj);
1057 		return ERR_PTR(ret);
1058 	} else
1059 		vfb->user_obj = user_obj;
1060 
1061 	return &vfb->base;
1062 }
1063 
1064 static const struct drm_mode_config_funcs vmw_kms_funcs = {
1065 	.fb_create = vmw_kms_fb_create,
1066 };
1067 
1068 static int vmw_kms_generic_present(struct vmw_private *dev_priv,
1069 				   struct drm_file *file_priv,
1070 				   struct vmw_framebuffer *vfb,
1071 				   struct vmw_surface *surface,
1072 				   uint32_t sid,
1073 				   int32_t destX, int32_t destY,
1074 				   struct drm_vmw_rect *clips,
1075 				   uint32_t num_clips)
1076 {
1077 	return vmw_kms_sou_do_surface_dirty(dev_priv, vfb, NULL, clips,
1078 					    &surface->res, destX, destY,
1079 					    num_clips, 1, NULL);
1080 }
1081 
1082 
1083 int vmw_kms_present(struct vmw_private *dev_priv,
1084 		    struct drm_file *file_priv,
1085 		    struct vmw_framebuffer *vfb,
1086 		    struct vmw_surface *surface,
1087 		    uint32_t sid,
1088 		    int32_t destX, int32_t destY,
1089 		    struct drm_vmw_rect *clips,
1090 		    uint32_t num_clips)
1091 {
1092 	int ret;
1093 
1094 	switch (dev_priv->active_display_unit) {
1095 	case vmw_du_screen_target:
1096 		ret = vmw_kms_stdu_surface_dirty(dev_priv, vfb, NULL, clips,
1097 						 &surface->res, destX, destY,
1098 						 num_clips, 1, NULL);
1099 		break;
1100 	case vmw_du_screen_object:
1101 		ret = vmw_kms_generic_present(dev_priv, file_priv, vfb, surface,
1102 					      sid, destX, destY, clips,
1103 					      num_clips);
1104 		break;
1105 	default:
1106 		WARN_ONCE(true,
1107 			  "Present called with invalid display system.\n");
1108 		ret = -ENOSYS;
1109 		break;
1110 	}
1111 	if (ret)
1112 		return ret;
1113 
1114 	vmw_fifo_flush(dev_priv, false);
1115 
1116 	return 0;
1117 }
1118 
1119 static void
1120 vmw_kms_create_hotplug_mode_update_property(struct vmw_private *dev_priv)
1121 {
1122 	if (dev_priv->hotplug_mode_update_property)
1123 		return;
1124 
1125 	dev_priv->hotplug_mode_update_property =
1126 		drm_property_create_range(dev_priv->dev,
1127 					  DRM_MODE_PROP_IMMUTABLE,
1128 					  "hotplug_mode_update", 0, 1);
1129 
1130 	if (!dev_priv->hotplug_mode_update_property)
1131 		return;
1132 
1133 }
1134 
1135 int vmw_kms_init(struct vmw_private *dev_priv)
1136 {
1137 	struct drm_device *dev = dev_priv->dev;
1138 	int ret;
1139 
1140 	drm_mode_config_init(dev);
1141 	dev->mode_config.funcs = &vmw_kms_funcs;
1142 	dev->mode_config.min_width = 1;
1143 	dev->mode_config.min_height = 1;
1144 	dev->mode_config.max_width = dev_priv->texture_max_width;
1145 	dev->mode_config.max_height = dev_priv->texture_max_height;
1146 
1147 	drm_mode_create_suggested_offset_properties(dev);
1148 	vmw_kms_create_hotplug_mode_update_property(dev_priv);
1149 
1150 	ret = vmw_kms_stdu_init_display(dev_priv);
1151 	if (ret) {
1152 		ret = vmw_kms_sou_init_display(dev_priv);
1153 		if (ret) /* Fallback */
1154 			ret = vmw_kms_ldu_init_display(dev_priv);
1155 	}
1156 
1157 	return ret;
1158 }
1159 
1160 int vmw_kms_close(struct vmw_private *dev_priv)
1161 {
1162 	int ret;
1163 
1164 	/*
1165 	 * Docs says we should take the lock before calling this function
1166 	 * but since it destroys encoders and our destructor calls
1167 	 * drm_encoder_cleanup which takes the lock we deadlock.
1168 	 */
1169 	drm_mode_config_cleanup(dev_priv->dev);
1170 	if (dev_priv->active_display_unit == vmw_du_screen_object)
1171 		ret = vmw_kms_sou_close_display(dev_priv);
1172 	else if (dev_priv->active_display_unit == vmw_du_screen_target)
1173 		ret = vmw_kms_stdu_close_display(dev_priv);
1174 	else
1175 		ret = vmw_kms_ldu_close_display(dev_priv);
1176 
1177 	return ret;
1178 }
1179 
1180 int vmw_kms_cursor_bypass_ioctl(struct drm_device *dev, void *data,
1181 				struct drm_file *file_priv)
1182 {
1183 	struct drm_vmw_cursor_bypass_arg *arg = data;
1184 	struct vmw_display_unit *du;
1185 	struct drm_crtc *crtc;
1186 	int ret = 0;
1187 
1188 
1189 	mutex_lock(&dev->mode_config.mutex);
1190 	if (arg->flags & DRM_VMW_CURSOR_BYPASS_ALL) {
1191 
1192 		list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
1193 			du = vmw_crtc_to_du(crtc);
1194 			du->hotspot_x = arg->xhot;
1195 			du->hotspot_y = arg->yhot;
1196 		}
1197 
1198 		mutex_unlock(&dev->mode_config.mutex);
1199 		return 0;
1200 	}
1201 
1202 	crtc = drm_crtc_find(dev, arg->crtc_id);
1203 	if (!crtc) {
1204 		ret = -ENOENT;
1205 		goto out;
1206 	}
1207 
1208 	du = vmw_crtc_to_du(crtc);
1209 
1210 	du->hotspot_x = arg->xhot;
1211 	du->hotspot_y = arg->yhot;
1212 
1213 out:
1214 	mutex_unlock(&dev->mode_config.mutex);
1215 
1216 	return ret;
1217 }
1218 
1219 int vmw_kms_write_svga(struct vmw_private *vmw_priv,
1220 			unsigned width, unsigned height, unsigned pitch,
1221 			unsigned bpp, unsigned depth)
1222 {
1223 	if (vmw_priv->capabilities & SVGA_CAP_PITCHLOCK)
1224 		vmw_write(vmw_priv, SVGA_REG_PITCHLOCK, pitch);
1225 	else if (vmw_fifo_have_pitchlock(vmw_priv))
1226 		vmw_mmio_write(pitch, vmw_priv->mmio_virt +
1227 			       SVGA_FIFO_PITCHLOCK);
1228 	vmw_write(vmw_priv, SVGA_REG_WIDTH, width);
1229 	vmw_write(vmw_priv, SVGA_REG_HEIGHT, height);
1230 	vmw_write(vmw_priv, SVGA_REG_BITS_PER_PIXEL, bpp);
1231 
1232 	if (vmw_read(vmw_priv, SVGA_REG_DEPTH) != depth) {
1233 		DRM_ERROR("Invalid depth %u for %u bpp, host expects %u\n",
1234 			  depth, bpp, vmw_read(vmw_priv, SVGA_REG_DEPTH));
1235 		return -EINVAL;
1236 	}
1237 
1238 	return 0;
1239 }
1240 
1241 int vmw_kms_save_vga(struct vmw_private *vmw_priv)
1242 {
1243 	struct vmw_vga_topology_state *save;
1244 	uint32_t i;
1245 
1246 	vmw_priv->vga_width = vmw_read(vmw_priv, SVGA_REG_WIDTH);
1247 	vmw_priv->vga_height = vmw_read(vmw_priv, SVGA_REG_HEIGHT);
1248 	vmw_priv->vga_bpp = vmw_read(vmw_priv, SVGA_REG_BITS_PER_PIXEL);
1249 	if (vmw_priv->capabilities & SVGA_CAP_PITCHLOCK)
1250 		vmw_priv->vga_pitchlock =
1251 		  vmw_read(vmw_priv, SVGA_REG_PITCHLOCK);
1252 	else if (vmw_fifo_have_pitchlock(vmw_priv))
1253 		vmw_priv->vga_pitchlock = vmw_mmio_read(vmw_priv->mmio_virt +
1254 							SVGA_FIFO_PITCHLOCK);
1255 
1256 	if (!(vmw_priv->capabilities & SVGA_CAP_DISPLAY_TOPOLOGY))
1257 		return 0;
1258 
1259 	vmw_priv->num_displays = vmw_read(vmw_priv,
1260 					  SVGA_REG_NUM_GUEST_DISPLAYS);
1261 
1262 	if (vmw_priv->num_displays == 0)
1263 		vmw_priv->num_displays = 1;
1264 
1265 	for (i = 0; i < vmw_priv->num_displays; ++i) {
1266 		save = &vmw_priv->vga_save[i];
1267 		vmw_write(vmw_priv, SVGA_REG_DISPLAY_ID, i);
1268 		save->primary = vmw_read(vmw_priv, SVGA_REG_DISPLAY_IS_PRIMARY);
1269 		save->pos_x = vmw_read(vmw_priv, SVGA_REG_DISPLAY_POSITION_X);
1270 		save->pos_y = vmw_read(vmw_priv, SVGA_REG_DISPLAY_POSITION_Y);
1271 		save->width = vmw_read(vmw_priv, SVGA_REG_DISPLAY_WIDTH);
1272 		save->height = vmw_read(vmw_priv, SVGA_REG_DISPLAY_HEIGHT);
1273 		vmw_write(vmw_priv, SVGA_REG_DISPLAY_ID, SVGA_ID_INVALID);
1274 		if (i == 0 && vmw_priv->num_displays == 1 &&
1275 		    save->width == 0 && save->height == 0) {
1276 
1277 			/*
1278 			 * It should be fairly safe to assume that these
1279 			 * values are uninitialized.
1280 			 */
1281 
1282 			save->width = vmw_priv->vga_width - save->pos_x;
1283 			save->height = vmw_priv->vga_height - save->pos_y;
1284 		}
1285 	}
1286 
1287 	return 0;
1288 }
1289 
1290 int vmw_kms_restore_vga(struct vmw_private *vmw_priv)
1291 {
1292 	struct vmw_vga_topology_state *save;
1293 	uint32_t i;
1294 
1295 	vmw_write(vmw_priv, SVGA_REG_WIDTH, vmw_priv->vga_width);
1296 	vmw_write(vmw_priv, SVGA_REG_HEIGHT, vmw_priv->vga_height);
1297 	vmw_write(vmw_priv, SVGA_REG_BITS_PER_PIXEL, vmw_priv->vga_bpp);
1298 	if (vmw_priv->capabilities & SVGA_CAP_PITCHLOCK)
1299 		vmw_write(vmw_priv, SVGA_REG_PITCHLOCK,
1300 			  vmw_priv->vga_pitchlock);
1301 	else if (vmw_fifo_have_pitchlock(vmw_priv))
1302 		vmw_mmio_write(vmw_priv->vga_pitchlock,
1303 			       vmw_priv->mmio_virt + SVGA_FIFO_PITCHLOCK);
1304 
1305 	if (!(vmw_priv->capabilities & SVGA_CAP_DISPLAY_TOPOLOGY))
1306 		return 0;
1307 
1308 	for (i = 0; i < vmw_priv->num_displays; ++i) {
1309 		save = &vmw_priv->vga_save[i];
1310 		vmw_write(vmw_priv, SVGA_REG_DISPLAY_ID, i);
1311 		vmw_write(vmw_priv, SVGA_REG_DISPLAY_IS_PRIMARY, save->primary);
1312 		vmw_write(vmw_priv, SVGA_REG_DISPLAY_POSITION_X, save->pos_x);
1313 		vmw_write(vmw_priv, SVGA_REG_DISPLAY_POSITION_Y, save->pos_y);
1314 		vmw_write(vmw_priv, SVGA_REG_DISPLAY_WIDTH, save->width);
1315 		vmw_write(vmw_priv, SVGA_REG_DISPLAY_HEIGHT, save->height);
1316 		vmw_write(vmw_priv, SVGA_REG_DISPLAY_ID, SVGA_ID_INVALID);
1317 	}
1318 
1319 	return 0;
1320 }
1321 
1322 bool vmw_kms_validate_mode_vram(struct vmw_private *dev_priv,
1323 				uint32_t pitch,
1324 				uint32_t height)
1325 {
1326 	return ((u64) pitch * (u64) height) < (u64)
1327 		((dev_priv->active_display_unit == vmw_du_screen_target) ?
1328 		 dev_priv->prim_bb_mem : dev_priv->vram_size);
1329 }
1330 
1331 
1332 /**
1333  * Function called by DRM code called with vbl_lock held.
1334  */
1335 u32 vmw_get_vblank_counter(struct drm_device *dev, unsigned int pipe)
1336 {
1337 	return 0;
1338 }
1339 
1340 /**
1341  * Function called by DRM code called with vbl_lock held.
1342  */
1343 int vmw_enable_vblank(struct drm_device *dev, unsigned int pipe)
1344 {
1345 	return -ENOSYS;
1346 }
1347 
1348 /**
1349  * Function called by DRM code called with vbl_lock held.
1350  */
1351 void vmw_disable_vblank(struct drm_device *dev, unsigned int pipe)
1352 {
1353 }
1354 
1355 
1356 /*
1357  * Small shared kms functions.
1358  */
1359 
1360 static int vmw_du_update_layout(struct vmw_private *dev_priv, unsigned num,
1361 			 struct drm_vmw_rect *rects)
1362 {
1363 	struct drm_device *dev = dev_priv->dev;
1364 	struct vmw_display_unit *du;
1365 	struct drm_connector *con;
1366 
1367 	mutex_lock(&dev->mode_config.mutex);
1368 
1369 #if 0
1370 	{
1371 		unsigned int i;
1372 
1373 		DRM_INFO("%s: new layout ", __func__);
1374 		for (i = 0; i < num; i++)
1375 			DRM_INFO("(%i, %i %ux%u) ", rects[i].x, rects[i].y,
1376 				 rects[i].w, rects[i].h);
1377 		DRM_INFO("\n");
1378 	}
1379 #endif
1380 
1381 	list_for_each_entry(con, &dev->mode_config.connector_list, head) {
1382 		du = vmw_connector_to_du(con);
1383 		if (num > du->unit) {
1384 			du->pref_width = rects[du->unit].w;
1385 			du->pref_height = rects[du->unit].h;
1386 			du->pref_active = true;
1387 			du->gui_x = rects[du->unit].x;
1388 			du->gui_y = rects[du->unit].y;
1389 			drm_object_property_set_value
1390 			  (&con->base, dev->mode_config.suggested_x_property,
1391 			   du->gui_x);
1392 			drm_object_property_set_value
1393 			  (&con->base, dev->mode_config.suggested_y_property,
1394 			   du->gui_y);
1395 		} else {
1396 			du->pref_width = 800;
1397 			du->pref_height = 600;
1398 			du->pref_active = false;
1399 			drm_object_property_set_value
1400 			  (&con->base, dev->mode_config.suggested_x_property,
1401 			   0);
1402 			drm_object_property_set_value
1403 			  (&con->base, dev->mode_config.suggested_y_property,
1404 			   0);
1405 		}
1406 		con->status = vmw_du_connector_detect(con, true);
1407 	}
1408 
1409 	mutex_unlock(&dev->mode_config.mutex);
1410 	drm_sysfs_hotplug_event(dev);
1411 
1412 	return 0;
1413 }
1414 
1415 int vmw_du_crtc_gamma_set(struct drm_crtc *crtc,
1416 			  u16 *r, u16 *g, u16 *b,
1417 			  uint32_t size)
1418 {
1419 	struct vmw_private *dev_priv = vmw_priv(crtc->dev);
1420 	int i;
1421 
1422 	for (i = 0; i < size; i++) {
1423 		DRM_DEBUG("%d r/g/b = 0x%04x / 0x%04x / 0x%04x\n", i,
1424 			  r[i], g[i], b[i]);
1425 		vmw_write(dev_priv, SVGA_PALETTE_BASE + i * 3 + 0, r[i] >> 8);
1426 		vmw_write(dev_priv, SVGA_PALETTE_BASE + i * 3 + 1, g[i] >> 8);
1427 		vmw_write(dev_priv, SVGA_PALETTE_BASE + i * 3 + 2, b[i] >> 8);
1428 	}
1429 
1430 	return 0;
1431 }
1432 
1433 int vmw_du_connector_dpms(struct drm_connector *connector, int mode)
1434 {
1435 	return 0;
1436 }
1437 
1438 enum drm_connector_status
1439 vmw_du_connector_detect(struct drm_connector *connector, bool force)
1440 {
1441 	uint32_t num_displays;
1442 	struct drm_device *dev = connector->dev;
1443 	struct vmw_private *dev_priv = vmw_priv(dev);
1444 	struct vmw_display_unit *du = vmw_connector_to_du(connector);
1445 
1446 	num_displays = vmw_read(dev_priv, SVGA_REG_NUM_DISPLAYS);
1447 
1448 	return ((vmw_connector_to_du(connector)->unit < num_displays &&
1449 		 du->pref_active) ?
1450 		connector_status_connected : connector_status_disconnected);
1451 }
1452 
1453 static struct drm_display_mode vmw_kms_connector_builtin[] = {
1454 	/* 640x480@60Hz */
1455 	{ DRM_MODE("640x480", DRM_MODE_TYPE_DRIVER, 25175, 640, 656,
1456 		   752, 800, 0, 480, 489, 492, 525, 0,
1457 		   DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_NVSYNC) },
1458 	/* 800x600@60Hz */
1459 	{ DRM_MODE("800x600", DRM_MODE_TYPE_DRIVER, 40000, 800, 840,
1460 		   968, 1056, 0, 600, 601, 605, 628, 0,
1461 		   DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_PVSYNC) },
1462 	/* 1024x768@60Hz */
1463 	{ DRM_MODE("1024x768", DRM_MODE_TYPE_DRIVER, 65000, 1024, 1048,
1464 		   1184, 1344, 0, 768, 771, 777, 806, 0,
1465 		   DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_NVSYNC) },
1466 	/* 1152x864@75Hz */
1467 	{ DRM_MODE("1152x864", DRM_MODE_TYPE_DRIVER, 108000, 1152, 1216,
1468 		   1344, 1600, 0, 864, 865, 868, 900, 0,
1469 		   DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_PVSYNC) },
1470 	/* 1280x768@60Hz */
1471 	{ DRM_MODE("1280x768", DRM_MODE_TYPE_DRIVER, 79500, 1280, 1344,
1472 		   1472, 1664, 0, 768, 771, 778, 798, 0,
1473 		   DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC) },
1474 	/* 1280x800@60Hz */
1475 	{ DRM_MODE("1280x800", DRM_MODE_TYPE_DRIVER, 83500, 1280, 1352,
1476 		   1480, 1680, 0, 800, 803, 809, 831, 0,
1477 		   DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_NVSYNC) },
1478 	/* 1280x960@60Hz */
1479 	{ DRM_MODE("1280x960", DRM_MODE_TYPE_DRIVER, 108000, 1280, 1376,
1480 		   1488, 1800, 0, 960, 961, 964, 1000, 0,
1481 		   DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_PVSYNC) },
1482 	/* 1280x1024@60Hz */
1483 	{ DRM_MODE("1280x1024", DRM_MODE_TYPE_DRIVER, 108000, 1280, 1328,
1484 		   1440, 1688, 0, 1024, 1025, 1028, 1066, 0,
1485 		   DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_PVSYNC) },
1486 	/* 1360x768@60Hz */
1487 	{ DRM_MODE("1360x768", DRM_MODE_TYPE_DRIVER, 85500, 1360, 1424,
1488 		   1536, 1792, 0, 768, 771, 777, 795, 0,
1489 		   DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_PVSYNC) },
1490 	/* 1440x1050@60Hz */
1491 	{ DRM_MODE("1400x1050", DRM_MODE_TYPE_DRIVER, 121750, 1400, 1488,
1492 		   1632, 1864, 0, 1050, 1053, 1057, 1089, 0,
1493 		   DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC) },
1494 	/* 1440x900@60Hz */
1495 	{ DRM_MODE("1440x900", DRM_MODE_TYPE_DRIVER, 106500, 1440, 1520,
1496 		   1672, 1904, 0, 900, 903, 909, 934, 0,
1497 		   DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC) },
1498 	/* 1600x1200@60Hz */
1499 	{ DRM_MODE("1600x1200", DRM_MODE_TYPE_DRIVER, 162000, 1600, 1664,
1500 		   1856, 2160, 0, 1200, 1201, 1204, 1250, 0,
1501 		   DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_PVSYNC) },
1502 	/* 1680x1050@60Hz */
1503 	{ DRM_MODE("1680x1050", DRM_MODE_TYPE_DRIVER, 146250, 1680, 1784,
1504 		   1960, 2240, 0, 1050, 1053, 1059, 1089, 0,
1505 		   DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC) },
1506 	/* 1792x1344@60Hz */
1507 	{ DRM_MODE("1792x1344", DRM_MODE_TYPE_DRIVER, 204750, 1792, 1920,
1508 		   2120, 2448, 0, 1344, 1345, 1348, 1394, 0,
1509 		   DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC) },
1510 	/* 1853x1392@60Hz */
1511 	{ DRM_MODE("1856x1392", DRM_MODE_TYPE_DRIVER, 218250, 1856, 1952,
1512 		   2176, 2528, 0, 1392, 1393, 1396, 1439, 0,
1513 		   DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC) },
1514 	/* 1920x1200@60Hz */
1515 	{ DRM_MODE("1920x1200", DRM_MODE_TYPE_DRIVER, 193250, 1920, 2056,
1516 		   2256, 2592, 0, 1200, 1203, 1209, 1245, 0,
1517 		   DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC) },
1518 	/* 1920x1440@60Hz */
1519 	{ DRM_MODE("1920x1440", DRM_MODE_TYPE_DRIVER, 234000, 1920, 2048,
1520 		   2256, 2600, 0, 1440, 1441, 1444, 1500, 0,
1521 		   DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC) },
1522 	/* 2560x1600@60Hz */
1523 	{ DRM_MODE("2560x1600", DRM_MODE_TYPE_DRIVER, 348500, 2560, 2752,
1524 		   3032, 3504, 0, 1600, 1603, 1609, 1658, 0,
1525 		   DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC) },
1526 	/* Terminate */
1527 	{ DRM_MODE("", 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) },
1528 };
1529 
1530 /**
1531  * vmw_guess_mode_timing - Provide fake timings for a
1532  * 60Hz vrefresh mode.
1533  *
1534  * @mode - Pointer to a struct drm_display_mode with hdisplay and vdisplay
1535  * members filled in.
1536  */
1537 void vmw_guess_mode_timing(struct drm_display_mode *mode)
1538 {
1539 	mode->hsync_start = mode->hdisplay + 50;
1540 	mode->hsync_end = mode->hsync_start + 50;
1541 	mode->htotal = mode->hsync_end + 50;
1542 
1543 	mode->vsync_start = mode->vdisplay + 50;
1544 	mode->vsync_end = mode->vsync_start + 50;
1545 	mode->vtotal = mode->vsync_end + 50;
1546 
1547 	mode->clock = (u32)mode->htotal * (u32)mode->vtotal / 100 * 6;
1548 	mode->vrefresh = drm_mode_vrefresh(mode);
1549 }
1550 
1551 
1552 int vmw_du_connector_fill_modes(struct drm_connector *connector,
1553 				uint32_t max_width, uint32_t max_height)
1554 {
1555 	struct vmw_display_unit *du = vmw_connector_to_du(connector);
1556 	struct drm_device *dev = connector->dev;
1557 	struct vmw_private *dev_priv = vmw_priv(dev);
1558 	struct drm_display_mode *mode = NULL;
1559 	struct drm_display_mode *bmode;
1560 	struct drm_display_mode prefmode = { DRM_MODE("preferred",
1561 		DRM_MODE_TYPE_DRIVER | DRM_MODE_TYPE_PREFERRED,
1562 		0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
1563 		DRM_MODE_FLAG_NHSYNC | DRM_MODE_FLAG_PVSYNC)
1564 	};
1565 	int i;
1566 	u32 assumed_bpp = 4;
1567 
1568 	if (dev_priv->assume_16bpp)
1569 		assumed_bpp = 2;
1570 
1571 	if (dev_priv->active_display_unit == vmw_du_screen_target) {
1572 		max_width  = min(max_width,  dev_priv->stdu_max_width);
1573 		max_height = min(max_height, dev_priv->stdu_max_height);
1574 	}
1575 
1576 	/* Add preferred mode */
1577 	mode = drm_mode_duplicate(dev, &prefmode);
1578 	if (!mode)
1579 		return 0;
1580 	mode->hdisplay = du->pref_width;
1581 	mode->vdisplay = du->pref_height;
1582 	vmw_guess_mode_timing(mode);
1583 
1584 	if (vmw_kms_validate_mode_vram(dev_priv,
1585 					mode->hdisplay * assumed_bpp,
1586 					mode->vdisplay)) {
1587 		drm_mode_probed_add(connector, mode);
1588 	} else {
1589 		drm_mode_destroy(dev, mode);
1590 		mode = NULL;
1591 	}
1592 
1593 	if (du->pref_mode) {
1594 		list_del_init(&du->pref_mode->head);
1595 		drm_mode_destroy(dev, du->pref_mode);
1596 	}
1597 
1598 	/* mode might be null here, this is intended */
1599 	du->pref_mode = mode;
1600 
1601 	for (i = 0; vmw_kms_connector_builtin[i].type != 0; i++) {
1602 		bmode = &vmw_kms_connector_builtin[i];
1603 		if (bmode->hdisplay > max_width ||
1604 		    bmode->vdisplay > max_height)
1605 			continue;
1606 
1607 		if (!vmw_kms_validate_mode_vram(dev_priv,
1608 						bmode->hdisplay * assumed_bpp,
1609 						bmode->vdisplay))
1610 			continue;
1611 
1612 		mode = drm_mode_duplicate(dev, bmode);
1613 		if (!mode)
1614 			return 0;
1615 		mode->vrefresh = drm_mode_vrefresh(mode);
1616 
1617 		drm_mode_probed_add(connector, mode);
1618 	}
1619 
1620 	drm_mode_connector_list_update(connector);
1621 	/* Move the prefered mode first, help apps pick the right mode. */
1622 	drm_mode_sort(&connector->modes);
1623 
1624 	return 1;
1625 }
1626 
1627 int vmw_du_connector_set_property(struct drm_connector *connector,
1628 				  struct drm_property *property,
1629 				  uint64_t val)
1630 {
1631 	struct vmw_display_unit *du = vmw_connector_to_du(connector);
1632 	struct vmw_private *dev_priv = vmw_priv(connector->dev);
1633 
1634 	if (property == dev_priv->implicit_placement_property)
1635 		du->is_implicit = val;
1636 
1637 	return 0;
1638 }
1639 
1640 
1641 int vmw_kms_update_layout_ioctl(struct drm_device *dev, void *data,
1642 				struct drm_file *file_priv)
1643 {
1644 	struct vmw_private *dev_priv = vmw_priv(dev);
1645 	struct drm_vmw_update_layout_arg *arg =
1646 		(struct drm_vmw_update_layout_arg *)data;
1647 	void __user *user_rects;
1648 	struct drm_vmw_rect *rects;
1649 	unsigned rects_size;
1650 	int ret;
1651 	int i;
1652 	u64 total_pixels = 0;
1653 	struct drm_mode_config *mode_config = &dev->mode_config;
1654 	struct drm_vmw_rect bounding_box = {0};
1655 
1656 	if (!arg->num_outputs) {
1657 		struct drm_vmw_rect def_rect = {0, 0, 800, 600};
1658 		vmw_du_update_layout(dev_priv, 1, &def_rect);
1659 		return 0;
1660 	}
1661 
1662 	rects_size = arg->num_outputs * sizeof(struct drm_vmw_rect);
1663 	rects = kcalloc(arg->num_outputs, sizeof(struct drm_vmw_rect),
1664 			GFP_KERNEL);
1665 	if (unlikely(!rects))
1666 		return -ENOMEM;
1667 
1668 	user_rects = (void __user *)(unsigned long)arg->rects;
1669 	ret = copy_from_user(rects, user_rects, rects_size);
1670 	if (unlikely(ret != 0)) {
1671 		DRM_ERROR("Failed to get rects.\n");
1672 		ret = -EFAULT;
1673 		goto out_free;
1674 	}
1675 
1676 	for (i = 0; i < arg->num_outputs; ++i) {
1677 		if (rects[i].x < 0 ||
1678 		    rects[i].y < 0 ||
1679 		    rects[i].x + rects[i].w > mode_config->max_width ||
1680 		    rects[i].y + rects[i].h > mode_config->max_height) {
1681 			DRM_ERROR("Invalid GUI layout.\n");
1682 			ret = -EINVAL;
1683 			goto out_free;
1684 		}
1685 
1686 		/*
1687 		 * bounding_box.w and bunding_box.h are used as
1688 		 * lower-right coordinates
1689 		 */
1690 		if (rects[i].x + rects[i].w > bounding_box.w)
1691 			bounding_box.w = rects[i].x + rects[i].w;
1692 
1693 		if (rects[i].y + rects[i].h > bounding_box.h)
1694 			bounding_box.h = rects[i].y + rects[i].h;
1695 
1696 		total_pixels += (u64) rects[i].w * (u64) rects[i].h;
1697 	}
1698 
1699 	if (dev_priv->active_display_unit == vmw_du_screen_target) {
1700 		/*
1701 		 * For Screen Targets, the limits for a toplogy are:
1702 		 *	1. Bounding box (assuming 32bpp) must be < prim_bb_mem
1703 		 *      2. Total pixels (assuming 32bpp) must be < prim_bb_mem
1704 		 */
1705 		u64 bb_mem    = bounding_box.w * bounding_box.h * 4;
1706 		u64 pixel_mem = total_pixels * 4;
1707 
1708 		if (bb_mem > dev_priv->prim_bb_mem) {
1709 			DRM_ERROR("Topology is beyond supported limits.\n");
1710 			ret = -EINVAL;
1711 			goto out_free;
1712 		}
1713 
1714 		if (pixel_mem > dev_priv->prim_bb_mem) {
1715 			DRM_ERROR("Combined output size too large\n");
1716 			ret = -EINVAL;
1717 			goto out_free;
1718 		}
1719 	}
1720 
1721 	vmw_du_update_layout(dev_priv, arg->num_outputs, rects);
1722 
1723 out_free:
1724 	kfree(rects);
1725 	return ret;
1726 }
1727 
1728 /**
1729  * vmw_kms_helper_dirty - Helper to build commands and perform actions based
1730  * on a set of cliprects and a set of display units.
1731  *
1732  * @dev_priv: Pointer to a device private structure.
1733  * @framebuffer: Pointer to the framebuffer on which to perform the actions.
1734  * @clips: A set of struct drm_clip_rect. Either this os @vclips must be NULL.
1735  * Cliprects are given in framebuffer coordinates.
1736  * @vclips: A set of struct drm_vmw_rect cliprects. Either this or @clips must
1737  * be NULL. Cliprects are given in source coordinates.
1738  * @dest_x: X coordinate offset for the crtc / destination clip rects.
1739  * @dest_y: Y coordinate offset for the crtc / destination clip rects.
1740  * @num_clips: Number of cliprects in the @clips or @vclips array.
1741  * @increment: Integer with which to increment the clip counter when looping.
1742  * Used to skip a predetermined number of clip rects.
1743  * @dirty: Closure structure. See the description of struct vmw_kms_dirty.
1744  */
1745 int vmw_kms_helper_dirty(struct vmw_private *dev_priv,
1746 			 struct vmw_framebuffer *framebuffer,
1747 			 const struct drm_clip_rect *clips,
1748 			 const struct drm_vmw_rect *vclips,
1749 			 s32 dest_x, s32 dest_y,
1750 			 int num_clips,
1751 			 int increment,
1752 			 struct vmw_kms_dirty *dirty)
1753 {
1754 	struct vmw_display_unit *units[VMWGFX_NUM_DISPLAY_UNITS];
1755 	struct drm_crtc *crtc;
1756 	u32 num_units = 0;
1757 	u32 i, k;
1758 
1759 	dirty->dev_priv = dev_priv;
1760 
1761 	list_for_each_entry(crtc, &dev_priv->dev->mode_config.crtc_list, head) {
1762 		if (crtc->primary->fb != &framebuffer->base)
1763 			continue;
1764 		units[num_units++] = vmw_crtc_to_du(crtc);
1765 	}
1766 
1767 	for (k = 0; k < num_units; k++) {
1768 		struct vmw_display_unit *unit = units[k];
1769 		s32 crtc_x = unit->crtc.x;
1770 		s32 crtc_y = unit->crtc.y;
1771 		s32 crtc_width = unit->crtc.mode.hdisplay;
1772 		s32 crtc_height = unit->crtc.mode.vdisplay;
1773 		const struct drm_clip_rect *clips_ptr = clips;
1774 		const struct drm_vmw_rect *vclips_ptr = vclips;
1775 
1776 		dirty->unit = unit;
1777 		if (dirty->fifo_reserve_size > 0) {
1778 			dirty->cmd = vmw_fifo_reserve(dev_priv,
1779 						      dirty->fifo_reserve_size);
1780 			if (!dirty->cmd) {
1781 				DRM_ERROR("Couldn't reserve fifo space "
1782 					  "for dirty blits.\n");
1783 				return -ENOMEM;
1784 			}
1785 			memset(dirty->cmd, 0, dirty->fifo_reserve_size);
1786 		}
1787 		dirty->num_hits = 0;
1788 		for (i = 0; i < num_clips; i++, clips_ptr += increment,
1789 		       vclips_ptr += increment) {
1790 			s32 clip_left;
1791 			s32 clip_top;
1792 
1793 			/*
1794 			 * Select clip array type. Note that integer type
1795 			 * in @clips is unsigned short, whereas in @vclips
1796 			 * it's 32-bit.
1797 			 */
1798 			if (clips) {
1799 				dirty->fb_x = (s32) clips_ptr->x1;
1800 				dirty->fb_y = (s32) clips_ptr->y1;
1801 				dirty->unit_x2 = (s32) clips_ptr->x2 + dest_x -
1802 					crtc_x;
1803 				dirty->unit_y2 = (s32) clips_ptr->y2 + dest_y -
1804 					crtc_y;
1805 			} else {
1806 				dirty->fb_x = vclips_ptr->x;
1807 				dirty->fb_y = vclips_ptr->y;
1808 				dirty->unit_x2 = dirty->fb_x + vclips_ptr->w +
1809 					dest_x - crtc_x;
1810 				dirty->unit_y2 = dirty->fb_y + vclips_ptr->h +
1811 					dest_y - crtc_y;
1812 			}
1813 
1814 			dirty->unit_x1 = dirty->fb_x + dest_x - crtc_x;
1815 			dirty->unit_y1 = dirty->fb_y + dest_y - crtc_y;
1816 
1817 			/* Skip this clip if it's outside the crtc region */
1818 			if (dirty->unit_x1 >= crtc_width ||
1819 			    dirty->unit_y1 >= crtc_height ||
1820 			    dirty->unit_x2 <= 0 || dirty->unit_y2 <= 0)
1821 				continue;
1822 
1823 			/* Clip right and bottom to crtc limits */
1824 			dirty->unit_x2 = min_t(s32, dirty->unit_x2,
1825 					       crtc_width);
1826 			dirty->unit_y2 = min_t(s32, dirty->unit_y2,
1827 					       crtc_height);
1828 
1829 			/* Clip left and top to crtc limits */
1830 			clip_left = min_t(s32, dirty->unit_x1, 0);
1831 			clip_top = min_t(s32, dirty->unit_y1, 0);
1832 			dirty->unit_x1 -= clip_left;
1833 			dirty->unit_y1 -= clip_top;
1834 			dirty->fb_x -= clip_left;
1835 			dirty->fb_y -= clip_top;
1836 
1837 			dirty->clip(dirty);
1838 		}
1839 
1840 		dirty->fifo_commit(dirty);
1841 	}
1842 
1843 	return 0;
1844 }
1845 
1846 /**
1847  * vmw_kms_helper_buffer_prepare - Reserve and validate a buffer object before
1848  * command submission.
1849  *
1850  * @dev_priv. Pointer to a device private structure.
1851  * @buf: The buffer object
1852  * @interruptible: Whether to perform waits as interruptible.
1853  * @validate_as_mob: Whether the buffer should be validated as a MOB. If false,
1854  * The buffer will be validated as a GMR. Already pinned buffers will not be
1855  * validated.
1856  *
1857  * Returns 0 on success, negative error code on failure, -ERESTARTSYS if
1858  * interrupted by a signal.
1859  */
1860 int vmw_kms_helper_buffer_prepare(struct vmw_private *dev_priv,
1861 				  struct vmw_dma_buffer *buf,
1862 				  bool interruptible,
1863 				  bool validate_as_mob)
1864 {
1865 	struct ttm_buffer_object *bo = &buf->base;
1866 	int ret;
1867 
1868 	ttm_bo_reserve(bo, false, false, NULL);
1869 	ret = vmw_validate_single_buffer(dev_priv, bo, interruptible,
1870 					 validate_as_mob);
1871 	if (ret)
1872 		ttm_bo_unreserve(bo);
1873 
1874 	return ret;
1875 }
1876 
1877 /**
1878  * vmw_kms_helper_buffer_revert - Undo the actions of
1879  * vmw_kms_helper_buffer_prepare.
1880  *
1881  * @res: Pointer to the buffer object.
1882  *
1883  * Helper to be used if an error forces the caller to undo the actions of
1884  * vmw_kms_helper_buffer_prepare.
1885  */
1886 void vmw_kms_helper_buffer_revert(struct vmw_dma_buffer *buf)
1887 {
1888 	if (buf)
1889 		ttm_bo_unreserve(&buf->base);
1890 }
1891 
1892 /**
1893  * vmw_kms_helper_buffer_finish - Unreserve and fence a buffer object after
1894  * kms command submission.
1895  *
1896  * @dev_priv: Pointer to a device private structure.
1897  * @file_priv: Pointer to a struct drm_file representing the caller's
1898  * connection. Must be set to NULL if @user_fence_rep is NULL, and conversely
1899  * if non-NULL, @user_fence_rep must be non-NULL.
1900  * @buf: The buffer object.
1901  * @out_fence:  Optional pointer to a fence pointer. If non-NULL, a
1902  * ref-counted fence pointer is returned here.
1903  * @user_fence_rep: Optional pointer to a user-space provided struct
1904  * drm_vmw_fence_rep. If provided, @file_priv must also be provided and the
1905  * function copies fence data to user-space in a fail-safe manner.
1906  */
1907 void vmw_kms_helper_buffer_finish(struct vmw_private *dev_priv,
1908 				  struct drm_file *file_priv,
1909 				  struct vmw_dma_buffer *buf,
1910 				  struct vmw_fence_obj **out_fence,
1911 				  struct drm_vmw_fence_rep __user *
1912 				  user_fence_rep)
1913 {
1914 	struct vmw_fence_obj *fence;
1915 	uint32_t handle;
1916 	int ret;
1917 
1918 	ret = vmw_execbuf_fence_commands(file_priv, dev_priv, &fence,
1919 					 file_priv ? &handle : NULL);
1920 	if (buf)
1921 		vmw_fence_single_bo(&buf->base, fence);
1922 	if (file_priv)
1923 		vmw_execbuf_copy_fence_user(dev_priv, vmw_fpriv(file_priv),
1924 					    ret, user_fence_rep, fence,
1925 					    handle);
1926 	if (out_fence)
1927 		*out_fence = fence;
1928 	else
1929 		vmw_fence_obj_unreference(&fence);
1930 
1931 	vmw_kms_helper_buffer_revert(buf);
1932 }
1933 
1934 
1935 /**
1936  * vmw_kms_helper_resource_revert - Undo the actions of
1937  * vmw_kms_helper_resource_prepare.
1938  *
1939  * @res: Pointer to the resource. Typically a surface.
1940  *
1941  * Helper to be used if an error forces the caller to undo the actions of
1942  * vmw_kms_helper_resource_prepare.
1943  */
1944 void vmw_kms_helper_resource_revert(struct vmw_resource *res)
1945 {
1946 	vmw_kms_helper_buffer_revert(res->backup);
1947 	vmw_resource_unreserve(res, false, NULL, 0);
1948 	mutex_unlock(&res->dev_priv->cmdbuf_mutex);
1949 }
1950 
1951 /**
1952  * vmw_kms_helper_resource_prepare - Reserve and validate a resource before
1953  * command submission.
1954  *
1955  * @res: Pointer to the resource. Typically a surface.
1956  * @interruptible: Whether to perform waits as interruptible.
1957  *
1958  * Reserves and validates also the backup buffer if a guest-backed resource.
1959  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1960  * interrupted by a signal.
1961  */
1962 int vmw_kms_helper_resource_prepare(struct vmw_resource *res,
1963 				    bool interruptible)
1964 {
1965 	int ret = 0;
1966 
1967 	if (interruptible)
1968 		ret = mutex_lock_interruptible(&res->dev_priv->cmdbuf_mutex);
1969 	else
1970 		mutex_lock(&res->dev_priv->cmdbuf_mutex);
1971 
1972 	if (unlikely(ret != 0))
1973 		return -ERESTARTSYS;
1974 
1975 	ret = vmw_resource_reserve(res, interruptible, false);
1976 	if (ret)
1977 		goto out_unlock;
1978 
1979 	if (res->backup) {
1980 		ret = vmw_kms_helper_buffer_prepare(res->dev_priv, res->backup,
1981 						    interruptible,
1982 						    res->dev_priv->has_mob);
1983 		if (ret)
1984 			goto out_unreserve;
1985 	}
1986 	ret = vmw_resource_validate(res);
1987 	if (ret)
1988 		goto out_revert;
1989 	return 0;
1990 
1991 out_revert:
1992 	vmw_kms_helper_buffer_revert(res->backup);
1993 out_unreserve:
1994 	vmw_resource_unreserve(res, false, NULL, 0);
1995 out_unlock:
1996 	mutex_unlock(&res->dev_priv->cmdbuf_mutex);
1997 	return ret;
1998 }
1999 
2000 /**
2001  * vmw_kms_helper_resource_finish - Unreserve and fence a resource after
2002  * kms command submission.
2003  *
2004  * @res: Pointer to the resource. Typically a surface.
2005  * @out_fence: Optional pointer to a fence pointer. If non-NULL, a
2006  * ref-counted fence pointer is returned here.
2007  */
2008 void vmw_kms_helper_resource_finish(struct vmw_resource *res,
2009 			     struct vmw_fence_obj **out_fence)
2010 {
2011 	if (res->backup || out_fence)
2012 		vmw_kms_helper_buffer_finish(res->dev_priv, NULL, res->backup,
2013 					     out_fence, NULL);
2014 
2015 	vmw_resource_unreserve(res, false, NULL, 0);
2016 	mutex_unlock(&res->dev_priv->cmdbuf_mutex);
2017 }
2018 
2019 /**
2020  * vmw_kms_update_proxy - Helper function to update a proxy surface from
2021  * its backing MOB.
2022  *
2023  * @res: Pointer to the surface resource
2024  * @clips: Clip rects in framebuffer (surface) space.
2025  * @num_clips: Number of clips in @clips.
2026  * @increment: Integer with which to increment the clip counter when looping.
2027  * Used to skip a predetermined number of clip rects.
2028  *
2029  * This function makes sure the proxy surface is updated from its backing MOB
2030  * using the region given by @clips. The surface resource @res and its backing
2031  * MOB needs to be reserved and validated on call.
2032  */
2033 int vmw_kms_update_proxy(struct vmw_resource *res,
2034 			 const struct drm_clip_rect *clips,
2035 			 unsigned num_clips,
2036 			 int increment)
2037 {
2038 	struct vmw_private *dev_priv = res->dev_priv;
2039 	struct drm_vmw_size *size = &vmw_res_to_srf(res)->base_size;
2040 	struct {
2041 		SVGA3dCmdHeader header;
2042 		SVGA3dCmdUpdateGBImage body;
2043 	} *cmd;
2044 	SVGA3dBox *box;
2045 	size_t copy_size = 0;
2046 	int i;
2047 
2048 	if (!clips)
2049 		return 0;
2050 
2051 	cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd) * num_clips);
2052 	if (!cmd) {
2053 		DRM_ERROR("Couldn't reserve fifo space for proxy surface "
2054 			  "update.\n");
2055 		return -ENOMEM;
2056 	}
2057 
2058 	for (i = 0; i < num_clips; ++i, clips += increment, ++cmd) {
2059 		box = &cmd->body.box;
2060 
2061 		cmd->header.id = SVGA_3D_CMD_UPDATE_GB_IMAGE;
2062 		cmd->header.size = sizeof(cmd->body);
2063 		cmd->body.image.sid = res->id;
2064 		cmd->body.image.face = 0;
2065 		cmd->body.image.mipmap = 0;
2066 
2067 		if (clips->x1 > size->width || clips->x2 > size->width ||
2068 		    clips->y1 > size->height || clips->y2 > size->height) {
2069 			DRM_ERROR("Invalid clips outsize of framebuffer.\n");
2070 			return -EINVAL;
2071 		}
2072 
2073 		box->x = clips->x1;
2074 		box->y = clips->y1;
2075 		box->z = 0;
2076 		box->w = clips->x2 - clips->x1;
2077 		box->h = clips->y2 - clips->y1;
2078 		box->d = 1;
2079 
2080 		copy_size += sizeof(*cmd);
2081 	}
2082 
2083 	vmw_fifo_commit(dev_priv, copy_size);
2084 
2085 	return 0;
2086 }
2087 
2088 int vmw_kms_fbdev_init_data(struct vmw_private *dev_priv,
2089 			    unsigned unit,
2090 			    u32 max_width,
2091 			    u32 max_height,
2092 			    struct drm_connector **p_con,
2093 			    struct drm_crtc **p_crtc,
2094 			    struct drm_display_mode **p_mode)
2095 {
2096 	struct drm_connector *con;
2097 	struct vmw_display_unit *du;
2098 	struct drm_display_mode *mode;
2099 	int i = 0;
2100 
2101 	list_for_each_entry(con, &dev_priv->dev->mode_config.connector_list,
2102 			    head) {
2103 		if (i == unit)
2104 			break;
2105 
2106 		++i;
2107 	}
2108 
2109 	if (i != unit) {
2110 		DRM_ERROR("Could not find initial display unit.\n");
2111 		return -EINVAL;
2112 	}
2113 
2114 	if (list_empty(&con->modes))
2115 		(void) vmw_du_connector_fill_modes(con, max_width, max_height);
2116 
2117 	if (list_empty(&con->modes)) {
2118 		DRM_ERROR("Could not find initial display mode.\n");
2119 		return -EINVAL;
2120 	}
2121 
2122 	du = vmw_connector_to_du(con);
2123 	*p_con = con;
2124 	*p_crtc = &du->crtc;
2125 
2126 	list_for_each_entry(mode, &con->modes, head) {
2127 		if (mode->type & DRM_MODE_TYPE_PREFERRED)
2128 			break;
2129 	}
2130 
2131 	if (mode->type & DRM_MODE_TYPE_PREFERRED)
2132 		*p_mode = mode;
2133 	else {
2134 		WARN_ONCE(true, "Could not find initial preferred mode.\n");
2135 		*p_mode = list_first_entry(&con->modes,
2136 					   struct drm_display_mode,
2137 					   head);
2138 	}
2139 
2140 	return 0;
2141 }
2142 
2143 /**
2144  * vmw_kms_del_active - unregister a crtc binding to the implicit framebuffer
2145  *
2146  * @dev_priv: Pointer to a device private struct.
2147  * @du: The display unit of the crtc.
2148  */
2149 void vmw_kms_del_active(struct vmw_private *dev_priv,
2150 			struct vmw_display_unit *du)
2151 {
2152 	mutex_lock(&dev_priv->global_kms_state_mutex);
2153 	if (du->active_implicit) {
2154 		if (--(dev_priv->num_implicit) == 0)
2155 			dev_priv->implicit_fb = NULL;
2156 		du->active_implicit = false;
2157 	}
2158 	mutex_unlock(&dev_priv->global_kms_state_mutex);
2159 }
2160 
2161 /**
2162  * vmw_kms_add_active - register a crtc binding to an implicit framebuffer
2163  *
2164  * @vmw_priv: Pointer to a device private struct.
2165  * @du: The display unit of the crtc.
2166  * @vfb: The implicit framebuffer
2167  *
2168  * Registers a binding to an implicit framebuffer.
2169  */
2170 void vmw_kms_add_active(struct vmw_private *dev_priv,
2171 			struct vmw_display_unit *du,
2172 			struct vmw_framebuffer *vfb)
2173 {
2174 	mutex_lock(&dev_priv->global_kms_state_mutex);
2175 	WARN_ON_ONCE(!dev_priv->num_implicit && dev_priv->implicit_fb);
2176 
2177 	if (!du->active_implicit && du->is_implicit) {
2178 		dev_priv->implicit_fb = vfb;
2179 		du->active_implicit = true;
2180 		dev_priv->num_implicit++;
2181 	}
2182 	mutex_unlock(&dev_priv->global_kms_state_mutex);
2183 }
2184 
2185 /**
2186  * vmw_kms_screen_object_flippable - Check whether we can page-flip a crtc.
2187  *
2188  * @dev_priv: Pointer to device-private struct.
2189  * @crtc: The crtc we want to flip.
2190  *
2191  * Returns true or false depending whether it's OK to flip this crtc
2192  * based on the criterion that we must not have more than one implicit
2193  * frame-buffer at any one time.
2194  */
2195 bool vmw_kms_crtc_flippable(struct vmw_private *dev_priv,
2196 			    struct drm_crtc *crtc)
2197 {
2198 	struct vmw_display_unit *du = vmw_crtc_to_du(crtc);
2199 	bool ret;
2200 
2201 	mutex_lock(&dev_priv->global_kms_state_mutex);
2202 	ret = !du->is_implicit || dev_priv->num_implicit == 1;
2203 	mutex_unlock(&dev_priv->global_kms_state_mutex);
2204 
2205 	return ret;
2206 }
2207 
2208 /**
2209  * vmw_kms_update_implicit_fb - Update the implicit fb.
2210  *
2211  * @dev_priv: Pointer to device-private struct.
2212  * @crtc: The crtc the new implicit frame-buffer is bound to.
2213  */
2214 void vmw_kms_update_implicit_fb(struct vmw_private *dev_priv,
2215 				struct drm_crtc *crtc)
2216 {
2217 	struct vmw_display_unit *du = vmw_crtc_to_du(crtc);
2218 	struct vmw_framebuffer *vfb;
2219 
2220 	mutex_lock(&dev_priv->global_kms_state_mutex);
2221 
2222 	if (!du->is_implicit)
2223 		goto out_unlock;
2224 
2225 	vfb = vmw_framebuffer_to_vfb(crtc->primary->fb);
2226 	WARN_ON_ONCE(dev_priv->num_implicit != 1 &&
2227 		     dev_priv->implicit_fb != vfb);
2228 
2229 	dev_priv->implicit_fb = vfb;
2230 out_unlock:
2231 	mutex_unlock(&dev_priv->global_kms_state_mutex);
2232 }
2233 
2234 /**
2235  * vmw_kms_create_implicit_placement_proparty - Set up the implicit placement
2236  * property.
2237  *
2238  * @dev_priv: Pointer to a device private struct.
2239  * @immutable: Whether the property is immutable.
2240  *
2241  * Sets up the implicit placement property unless it's already set up.
2242  */
2243 void
2244 vmw_kms_create_implicit_placement_property(struct vmw_private *dev_priv,
2245 					   bool immutable)
2246 {
2247 	if (dev_priv->implicit_placement_property)
2248 		return;
2249 
2250 	dev_priv->implicit_placement_property =
2251 		drm_property_create_range(dev_priv->dev,
2252 					  immutable ?
2253 					  DRM_MODE_PROP_IMMUTABLE : 0,
2254 					  "implicit_placement", 0, 1);
2255 
2256 }
2257