1 /**************************************************************************
2  *
3  * Copyright © 2011-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 #include <drm/drm_plane_helper.h>
30 
31 
32 #define vmw_crtc_to_sou(x) \
33 	container_of(x, struct vmw_screen_object_unit, base.crtc)
34 #define vmw_encoder_to_sou(x) \
35 	container_of(x, struct vmw_screen_object_unit, base.encoder)
36 #define vmw_connector_to_sou(x) \
37 	container_of(x, struct vmw_screen_object_unit, base.connector)
38 
39 /**
40  * struct vmw_kms_sou_surface_dirty - Closure structure for
41  * blit surface to screen command.
42  * @base: The base type we derive from. Used by vmw_kms_helper_dirty().
43  * @left: Left side of bounding box.
44  * @right: Right side of bounding box.
45  * @top: Top side of bounding box.
46  * @bottom: Bottom side of bounding box.
47  * @dst_x: Difference between source clip rects and framebuffer coordinates.
48  * @dst_y: Difference between source clip rects and framebuffer coordinates.
49  * @sid: Surface id of surface to copy from.
50  */
51 struct vmw_kms_sou_surface_dirty {
52 	struct vmw_kms_dirty base;
53 	s32 left, right, top, bottom;
54 	s32 dst_x, dst_y;
55 	u32 sid;
56 };
57 
58 /*
59  * SVGA commands that are used by this code. Please see the device headers
60  * for explanation.
61  */
62 struct vmw_kms_sou_readback_blit {
63 	uint32 header;
64 	SVGAFifoCmdBlitScreenToGMRFB body;
65 };
66 
67 struct vmw_kms_sou_dmabuf_blit {
68 	uint32 header;
69 	SVGAFifoCmdBlitGMRFBToScreen body;
70 };
71 
72 struct vmw_kms_sou_dirty_cmd {
73 	SVGA3dCmdHeader header;
74 	SVGA3dCmdBlitSurfaceToScreen body;
75 };
76 
77 
78 /*
79  * Other structs.
80  */
81 
82 struct vmw_screen_object_display {
83 	unsigned num_implicit;
84 
85 	struct vmw_framebuffer *implicit_fb;
86 	SVGAFifoCmdDefineGMRFB cur;
87 	struct vmw_dma_buffer *pinned_gmrfb;
88 };
89 
90 /**
91  * Display unit using screen objects.
92  */
93 struct vmw_screen_object_unit {
94 	struct vmw_display_unit base;
95 
96 	unsigned long buffer_size; /**< Size of allocated buffer */
97 	struct vmw_dma_buffer *buffer; /**< Backing store buffer */
98 
99 	bool defined;
100 	bool active_implicit;
101 };
102 
103 static void vmw_sou_destroy(struct vmw_screen_object_unit *sou)
104 {
105 	vmw_du_cleanup(&sou->base);
106 	kfree(sou);
107 }
108 
109 
110 /*
111  * Screen Object Display Unit CRTC functions
112  */
113 
114 static void vmw_sou_crtc_destroy(struct drm_crtc *crtc)
115 {
116 	vmw_sou_destroy(vmw_crtc_to_sou(crtc));
117 }
118 
119 static void vmw_sou_del_active(struct vmw_private *vmw_priv,
120 			       struct vmw_screen_object_unit *sou)
121 {
122 	struct vmw_screen_object_display *ld = vmw_priv->sou_priv;
123 
124 	if (sou->active_implicit) {
125 		if (--(ld->num_implicit) == 0)
126 			ld->implicit_fb = NULL;
127 		sou->active_implicit = false;
128 	}
129 }
130 
131 static void vmw_sou_add_active(struct vmw_private *vmw_priv,
132 			       struct vmw_screen_object_unit *sou,
133 			       struct vmw_framebuffer *vfb)
134 {
135 	struct vmw_screen_object_display *ld = vmw_priv->sou_priv;
136 
137 	BUG_ON(!ld->num_implicit && ld->implicit_fb);
138 
139 	if (!sou->active_implicit && sou->base.is_implicit) {
140 		ld->implicit_fb = vfb;
141 		sou->active_implicit = true;
142 		ld->num_implicit++;
143 	}
144 }
145 
146 /**
147  * Send the fifo command to create a screen.
148  */
149 static int vmw_sou_fifo_create(struct vmw_private *dev_priv,
150 			       struct vmw_screen_object_unit *sou,
151 			       uint32_t x, uint32_t y,
152 			       struct drm_display_mode *mode)
153 {
154 	size_t fifo_size;
155 
156 	struct {
157 		struct {
158 			uint32_t cmdType;
159 		} header;
160 		SVGAScreenObject obj;
161 	} *cmd;
162 
163 	BUG_ON(!sou->buffer);
164 
165 	fifo_size = sizeof(*cmd);
166 	cmd = vmw_fifo_reserve(dev_priv, fifo_size);
167 	/* The hardware has hung, nothing we can do about it here. */
168 	if (unlikely(cmd == NULL)) {
169 		DRM_ERROR("Fifo reserve failed.\n");
170 		return -ENOMEM;
171 	}
172 
173 	memset(cmd, 0, fifo_size);
174 	cmd->header.cmdType = SVGA_CMD_DEFINE_SCREEN;
175 	cmd->obj.structSize = sizeof(SVGAScreenObject);
176 	cmd->obj.id = sou->base.unit;
177 	cmd->obj.flags = SVGA_SCREEN_HAS_ROOT |
178 		(sou->base.unit == 0 ? SVGA_SCREEN_IS_PRIMARY : 0);
179 	cmd->obj.size.width = mode->hdisplay;
180 	cmd->obj.size.height = mode->vdisplay;
181 	if (sou->base.is_implicit) {
182 		cmd->obj.root.x = x;
183 		cmd->obj.root.y = y;
184 	} else {
185 		cmd->obj.root.x = sou->base.gui_x;
186 		cmd->obj.root.y = sou->base.gui_y;
187 	}
188 
189 	/* Ok to assume that buffer is pinned in vram */
190 	vmw_bo_get_guest_ptr(&sou->buffer->base, &cmd->obj.backingStore.ptr);
191 	cmd->obj.backingStore.pitch = mode->hdisplay * 4;
192 
193 	vmw_fifo_commit(dev_priv, fifo_size);
194 
195 	sou->defined = true;
196 
197 	return 0;
198 }
199 
200 /**
201  * Send the fifo command to destroy a screen.
202  */
203 static int vmw_sou_fifo_destroy(struct vmw_private *dev_priv,
204 				struct vmw_screen_object_unit *sou)
205 {
206 	size_t fifo_size;
207 	int ret;
208 
209 	struct {
210 		struct {
211 			uint32_t cmdType;
212 		} header;
213 		SVGAFifoCmdDestroyScreen body;
214 	} *cmd;
215 
216 	/* no need to do anything */
217 	if (unlikely(!sou->defined))
218 		return 0;
219 
220 	fifo_size = sizeof(*cmd);
221 	cmd = vmw_fifo_reserve(dev_priv, fifo_size);
222 	/* the hardware has hung, nothing we can do about it here */
223 	if (unlikely(cmd == NULL)) {
224 		DRM_ERROR("Fifo reserve failed.\n");
225 		return -ENOMEM;
226 	}
227 
228 	memset(cmd, 0, fifo_size);
229 	cmd->header.cmdType = SVGA_CMD_DESTROY_SCREEN;
230 	cmd->body.screenId = sou->base.unit;
231 
232 	vmw_fifo_commit(dev_priv, fifo_size);
233 
234 	/* Force sync */
235 	ret = vmw_fallback_wait(dev_priv, false, true, 0, false, 3*HZ);
236 	if (unlikely(ret != 0))
237 		DRM_ERROR("Failed to sync with HW");
238 	else
239 		sou->defined = false;
240 
241 	return ret;
242 }
243 
244 /**
245  * Free the backing store.
246  */
247 static void vmw_sou_backing_free(struct vmw_private *dev_priv,
248 				 struct vmw_screen_object_unit *sou)
249 {
250 	vmw_dmabuf_unreference(&sou->buffer);
251 	sou->buffer_size = 0;
252 }
253 
254 /**
255  * Allocate the backing store for the buffer.
256  */
257 static int vmw_sou_backing_alloc(struct vmw_private *dev_priv,
258 				 struct vmw_screen_object_unit *sou,
259 				 unsigned long size)
260 {
261 	int ret;
262 
263 	if (sou->buffer_size == size)
264 		return 0;
265 
266 	if (sou->buffer)
267 		vmw_sou_backing_free(dev_priv, sou);
268 
269 	sou->buffer = kzalloc(sizeof(*sou->buffer), GFP_KERNEL);
270 	if (unlikely(sou->buffer == NULL))
271 		return -ENOMEM;
272 
273 	/* After we have alloced the backing store might not be able to
274 	 * resume the overlays, this is preferred to failing to alloc.
275 	 */
276 	vmw_overlay_pause_all(dev_priv);
277 	ret = vmw_dmabuf_init(dev_priv, sou->buffer, size,
278 			      &vmw_vram_ne_placement,
279 			      false, &vmw_dmabuf_bo_free);
280 	vmw_overlay_resume_all(dev_priv);
281 
282 	if (unlikely(ret != 0))
283 		sou->buffer = NULL; /* vmw_dmabuf_init frees on error */
284 	else
285 		sou->buffer_size = size;
286 
287 	return ret;
288 }
289 
290 static int vmw_sou_crtc_set_config(struct drm_mode_set *set)
291 {
292 	struct vmw_private *dev_priv;
293 	struct vmw_screen_object_unit *sou;
294 	struct drm_connector *connector;
295 	struct drm_display_mode *mode;
296 	struct drm_encoder *encoder;
297 	struct vmw_framebuffer *vfb;
298 	struct drm_framebuffer *fb;
299 	struct drm_crtc *crtc;
300 	int ret = 0;
301 
302 	if (!set)
303 		return -EINVAL;
304 
305 	if (!set->crtc)
306 		return -EINVAL;
307 
308 	/* get the sou */
309 	crtc = set->crtc;
310 	sou = vmw_crtc_to_sou(crtc);
311 	vfb = set->fb ? vmw_framebuffer_to_vfb(set->fb) : NULL;
312 	dev_priv = vmw_priv(crtc->dev);
313 
314 	if (set->num_connectors > 1) {
315 		DRM_ERROR("Too many connectors\n");
316 		return -EINVAL;
317 	}
318 
319 	if (set->num_connectors == 1 &&
320 	    set->connectors[0] != &sou->base.connector) {
321 		DRM_ERROR("Connector doesn't match %p %p\n",
322 			set->connectors[0], &sou->base.connector);
323 		return -EINVAL;
324 	}
325 
326 	/* sou only supports one fb active at the time */
327 	if (sou->base.is_implicit &&
328 	    dev_priv->sou_priv->implicit_fb && vfb &&
329 	    !(dev_priv->sou_priv->num_implicit == 1 &&
330 	      sou->active_implicit) &&
331 	    dev_priv->sou_priv->implicit_fb != vfb) {
332 		DRM_ERROR("Multiple framebuffers not supported\n");
333 		return -EINVAL;
334 	}
335 
336 	/* since they always map one to one these are safe */
337 	connector = &sou->base.connector;
338 	encoder = &sou->base.encoder;
339 
340 	/* should we turn the crtc off */
341 	if (set->num_connectors == 0 || !set->mode || !set->fb) {
342 		ret = vmw_sou_fifo_destroy(dev_priv, sou);
343 		/* the hardware has hung don't do anything more */
344 		if (unlikely(ret != 0))
345 			return ret;
346 
347 		connector->encoder = NULL;
348 		encoder->crtc = NULL;
349 		crtc->primary->fb = NULL;
350 		crtc->x = 0;
351 		crtc->y = 0;
352 		crtc->enabled = false;
353 
354 		vmw_sou_del_active(dev_priv, sou);
355 
356 		vmw_sou_backing_free(dev_priv, sou);
357 
358 		return 0;
359 	}
360 
361 
362 	/* we now know we want to set a mode */
363 	mode = set->mode;
364 	fb = set->fb;
365 
366 	if (set->x + mode->hdisplay > fb->width ||
367 	    set->y + mode->vdisplay > fb->height) {
368 		DRM_ERROR("set outside of framebuffer\n");
369 		return -EINVAL;
370 	}
371 
372 	vmw_svga_enable(dev_priv);
373 
374 	if (mode->hdisplay != crtc->mode.hdisplay ||
375 	    mode->vdisplay != crtc->mode.vdisplay) {
376 		/* no need to check if depth is different, because backing
377 		 * store depth is forced to 4 by the device.
378 		 */
379 
380 		ret = vmw_sou_fifo_destroy(dev_priv, sou);
381 		/* the hardware has hung don't do anything more */
382 		if (unlikely(ret != 0))
383 			return ret;
384 
385 		vmw_sou_backing_free(dev_priv, sou);
386 	}
387 
388 	if (!sou->buffer) {
389 		/* forced to depth 4 by the device */
390 		size_t size = mode->hdisplay * mode->vdisplay * 4;
391 		ret = vmw_sou_backing_alloc(dev_priv, sou, size);
392 		if (unlikely(ret != 0))
393 			return ret;
394 	}
395 
396 	ret = vmw_sou_fifo_create(dev_priv, sou, set->x, set->y, mode);
397 	if (unlikely(ret != 0)) {
398 		/*
399 		 * We are in a bit of a situation here, the hardware has
400 		 * hung and we may or may not have a buffer hanging of
401 		 * the screen object, best thing to do is not do anything
402 		 * if we where defined, if not just turn the crtc of.
403 		 * Not what userspace wants but it needs to htfu.
404 		 */
405 		if (sou->defined)
406 			return ret;
407 
408 		connector->encoder = NULL;
409 		encoder->crtc = NULL;
410 		crtc->primary->fb = NULL;
411 		crtc->x = 0;
412 		crtc->y = 0;
413 		crtc->enabled = false;
414 
415 		return ret;
416 	}
417 
418 	vmw_sou_add_active(dev_priv, sou, vfb);
419 
420 	connector->encoder = encoder;
421 	encoder->crtc = crtc;
422 	crtc->mode = *mode;
423 	crtc->primary->fb = fb;
424 	crtc->x = set->x;
425 	crtc->y = set->y;
426 	crtc->enabled = true;
427 
428 	return 0;
429 }
430 
431 /**
432  * Returns if this unit can be page flipped.
433  * Must be called with the mode_config mutex held.
434  */
435 static bool vmw_sou_screen_object_flippable(struct vmw_private *dev_priv,
436 					    struct drm_crtc *crtc)
437 {
438 	struct vmw_screen_object_unit *sou = vmw_crtc_to_sou(crtc);
439 
440 	if (!sou->base.is_implicit)
441 		return true;
442 
443 	if (dev_priv->sou_priv->num_implicit != 1)
444 		return false;
445 
446 	return true;
447 }
448 
449 /**
450  * Update the implicit fb to the current fb of this crtc.
451  * Must be called with the mode_config mutex held.
452  */
453 static void vmw_sou_update_implicit_fb(struct vmw_private *dev_priv,
454 				       struct drm_crtc *crtc)
455 {
456 	struct vmw_screen_object_unit *sou = vmw_crtc_to_sou(crtc);
457 
458 	BUG_ON(!sou->base.is_implicit);
459 
460 	dev_priv->sou_priv->implicit_fb =
461 		vmw_framebuffer_to_vfb(sou->base.crtc.primary->fb);
462 }
463 
464 static int vmw_sou_crtc_page_flip(struct drm_crtc *crtc,
465 				  struct drm_framebuffer *fb,
466 				  struct drm_pending_vblank_event *event,
467 				  uint32_t flags)
468 {
469 	struct vmw_private *dev_priv = vmw_priv(crtc->dev);
470 	struct drm_framebuffer *old_fb = crtc->primary->fb;
471 	struct vmw_framebuffer *vfb = vmw_framebuffer_to_vfb(fb);
472 	struct vmw_fence_obj *fence = NULL;
473 	struct drm_clip_rect clips;
474 	int ret;
475 
476 	/* require ScreenObject support for page flipping */
477 	if (!dev_priv->sou_priv)
478 		return -ENOSYS;
479 
480 	if (!vmw_sou_screen_object_flippable(dev_priv, crtc))
481 		return -EINVAL;
482 
483 	crtc->primary->fb = fb;
484 
485 	/* do a full screen dirty update */
486 	clips.x1 = clips.y1 = 0;
487 	clips.x2 = fb->width;
488 	clips.y2 = fb->height;
489 
490 	if (vfb->dmabuf)
491 		ret = vmw_kms_sou_do_dmabuf_dirty(dev_priv, vfb,
492 						  &clips, 1, 1,
493 						  true, &fence);
494 	else
495 		ret = vmw_kms_sou_do_surface_dirty(dev_priv, vfb,
496 						   &clips, NULL, NULL,
497 						   0, 0, 1, 1, &fence);
498 
499 
500 	if (ret != 0)
501 		goto out_no_fence;
502 	if (!fence) {
503 		ret = -EINVAL;
504 		goto out_no_fence;
505 	}
506 
507 	if (event) {
508 		struct drm_file *file_priv = event->base.file_priv;
509 
510 		ret = vmw_event_fence_action_queue(file_priv, fence,
511 						   &event->base,
512 						   &event->event.tv_sec,
513 						   &event->event.tv_usec,
514 						   true);
515 	}
516 
517 	/*
518 	 * No need to hold on to this now. The only cleanup
519 	 * we need to do if we fail is unref the fence.
520 	 */
521 	vmw_fence_obj_unreference(&fence);
522 
523 	if (vmw_crtc_to_du(crtc)->is_implicit)
524 		vmw_sou_update_implicit_fb(dev_priv, crtc);
525 
526 	return ret;
527 
528 out_no_fence:
529 	crtc->primary->fb = old_fb;
530 	return ret;
531 }
532 
533 static struct drm_crtc_funcs vmw_screen_object_crtc_funcs = {
534 	.save = vmw_du_crtc_save,
535 	.restore = vmw_du_crtc_restore,
536 	.cursor_set = vmw_du_crtc_cursor_set,
537 	.cursor_move = vmw_du_crtc_cursor_move,
538 	.gamma_set = vmw_du_crtc_gamma_set,
539 	.destroy = vmw_sou_crtc_destroy,
540 	.set_config = vmw_sou_crtc_set_config,
541 	.page_flip = vmw_sou_crtc_page_flip,
542 };
543 
544 /*
545  * Screen Object Display Unit encoder functions
546  */
547 
548 static void vmw_sou_encoder_destroy(struct drm_encoder *encoder)
549 {
550 	vmw_sou_destroy(vmw_encoder_to_sou(encoder));
551 }
552 
553 static struct drm_encoder_funcs vmw_screen_object_encoder_funcs = {
554 	.destroy = vmw_sou_encoder_destroy,
555 };
556 
557 /*
558  * Screen Object Display Unit connector functions
559  */
560 
561 static void vmw_sou_connector_destroy(struct drm_connector *connector)
562 {
563 	vmw_sou_destroy(vmw_connector_to_sou(connector));
564 }
565 
566 static struct drm_connector_funcs vmw_sou_connector_funcs = {
567 	.dpms = vmw_du_connector_dpms,
568 	.save = vmw_du_connector_save,
569 	.restore = vmw_du_connector_restore,
570 	.detect = vmw_du_connector_detect,
571 	.fill_modes = vmw_du_connector_fill_modes,
572 	.set_property = vmw_du_connector_set_property,
573 	.destroy = vmw_sou_connector_destroy,
574 };
575 
576 static int vmw_sou_init(struct vmw_private *dev_priv, unsigned unit)
577 {
578 	struct vmw_screen_object_unit *sou;
579 	struct drm_device *dev = dev_priv->dev;
580 	struct drm_connector *connector;
581 	struct drm_encoder *encoder;
582 	struct drm_crtc *crtc;
583 
584 	sou = kzalloc(sizeof(*sou), GFP_KERNEL);
585 	if (!sou)
586 		return -ENOMEM;
587 
588 	sou->base.unit = unit;
589 	crtc = &sou->base.crtc;
590 	encoder = &sou->base.encoder;
591 	connector = &sou->base.connector;
592 
593 	sou->active_implicit = false;
594 
595 	sou->base.pref_active = (unit == 0);
596 	sou->base.pref_width = dev_priv->initial_width;
597 	sou->base.pref_height = dev_priv->initial_height;
598 	sou->base.pref_mode = NULL;
599 	sou->base.is_implicit = true;
600 
601 	drm_connector_init(dev, connector, &vmw_sou_connector_funcs,
602 			   DRM_MODE_CONNECTOR_VIRTUAL);
603 	connector->status = vmw_du_connector_detect(connector, true);
604 
605 	drm_encoder_init(dev, encoder, &vmw_screen_object_encoder_funcs,
606 			 DRM_MODE_ENCODER_VIRTUAL);
607 	drm_mode_connector_attach_encoder(connector, encoder);
608 	encoder->possible_crtcs = (1 << unit);
609 	encoder->possible_clones = 0;
610 
611 	(void) drm_connector_register(connector);
612 
613 	drm_crtc_init(dev, crtc, &vmw_screen_object_crtc_funcs);
614 
615 	drm_mode_crtc_set_gamma_size(crtc, 256);
616 
617 	drm_object_attach_property(&connector->base,
618 				      dev->mode_config.dirty_info_property,
619 				      1);
620 
621 	return 0;
622 }
623 
624 int vmw_kms_sou_init_display(struct vmw_private *dev_priv)
625 {
626 	struct drm_device *dev = dev_priv->dev;
627 	int i, ret;
628 
629 	if (dev_priv->sou_priv) {
630 		DRM_INFO("sou system already on\n");
631 		return -EINVAL;
632 	}
633 
634 	if (!(dev_priv->capabilities & SVGA_CAP_SCREEN_OBJECT_2)) {
635 		DRM_INFO("Not using screen objects,"
636 			 " missing cap SCREEN_OBJECT_2\n");
637 		return -ENOSYS;
638 	}
639 
640 	ret = -ENOMEM;
641 	dev_priv->sou_priv = kmalloc(sizeof(*dev_priv->sou_priv), GFP_KERNEL);
642 	if (unlikely(!dev_priv->sou_priv))
643 		goto err_no_mem;
644 
645 	dev_priv->sou_priv->num_implicit = 0;
646 	dev_priv->sou_priv->implicit_fb = NULL;
647 
648 	ret = drm_vblank_init(dev, VMWGFX_NUM_DISPLAY_UNITS);
649 	if (unlikely(ret != 0))
650 		goto err_free;
651 
652 	ret = drm_mode_create_dirty_info_property(dev);
653 	if (unlikely(ret != 0))
654 		goto err_vblank_cleanup;
655 
656 	for (i = 0; i < VMWGFX_NUM_DISPLAY_UNITS; ++i)
657 		vmw_sou_init(dev_priv, i);
658 
659 	dev_priv->active_display_unit = vmw_du_screen_object;
660 
661 	DRM_INFO("Screen Objects Display Unit initialized\n");
662 
663 	return 0;
664 
665 err_vblank_cleanup:
666 	drm_vblank_cleanup(dev);
667 err_free:
668 	kfree(dev_priv->sou_priv);
669 	dev_priv->sou_priv = NULL;
670 err_no_mem:
671 	return ret;
672 }
673 
674 int vmw_kms_sou_close_display(struct vmw_private *dev_priv)
675 {
676 	struct drm_device *dev = dev_priv->dev;
677 
678 	if (!dev_priv->sou_priv)
679 		return -ENOSYS;
680 
681 	drm_vblank_cleanup(dev);
682 
683 	kfree(dev_priv->sou_priv);
684 
685 	return 0;
686 }
687 
688 static int do_dmabuf_define_gmrfb(struct vmw_private *dev_priv,
689 				  struct vmw_framebuffer *framebuffer)
690 {
691 	struct vmw_dma_buffer *buf =
692 		container_of(framebuffer, struct vmw_framebuffer_dmabuf,
693 			     base)->buffer;
694 	int depth = framebuffer->base.depth;
695 	struct {
696 		uint32_t header;
697 		SVGAFifoCmdDefineGMRFB body;
698 	} *cmd;
699 
700 	/* Emulate RGBA support, contrary to svga_reg.h this is not
701 	 * supported by hosts. This is only a problem if we are reading
702 	 * this value later and expecting what we uploaded back.
703 	 */
704 	if (depth == 32)
705 		depth = 24;
706 
707 	cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
708 	if (!cmd) {
709 		DRM_ERROR("Out of fifo space for dirty framebuffer command.\n");
710 		return -ENOMEM;
711 	}
712 
713 	cmd->header = SVGA_CMD_DEFINE_GMRFB;
714 	cmd->body.format.bitsPerPixel = framebuffer->base.bits_per_pixel;
715 	cmd->body.format.colorDepth = depth;
716 	cmd->body.format.reserved = 0;
717 	cmd->body.bytesPerLine = framebuffer->base.pitches[0];
718 	/* Buffer is reserved in vram or GMR */
719 	vmw_bo_get_guest_ptr(&buf->base, &cmd->body.ptr);
720 	vmw_fifo_commit(dev_priv, sizeof(*cmd));
721 
722 	return 0;
723 }
724 
725 /**
726  * vmw_sou_surface_fifo_commit - Callback to fill in and submit a
727  * blit surface to screen command.
728  *
729  * @dirty: The closure structure.
730  *
731  * Fills in the missing fields in the command, and translates the cliprects
732  * to match the destination bounding box encoded.
733  */
734 static void vmw_sou_surface_fifo_commit(struct vmw_kms_dirty *dirty)
735 {
736 	struct vmw_kms_sou_surface_dirty *sdirty =
737 		container_of(dirty, typeof(*sdirty), base);
738 	struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
739 	s32 trans_x = dirty->unit->crtc.x - sdirty->dst_x;
740 	s32 trans_y = dirty->unit->crtc.y - sdirty->dst_y;
741 	size_t region_size = dirty->num_hits * sizeof(SVGASignedRect);
742 	SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];
743 	int i;
744 
745 	cmd->header.id = SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN;
746 	cmd->header.size = sizeof(cmd->body) + region_size;
747 
748 	/*
749 	 * Use the destination bounding box to specify destination - and
750 	 * source bounding regions.
751 	 */
752 	cmd->body.destRect.left = sdirty->left;
753 	cmd->body.destRect.right = sdirty->right;
754 	cmd->body.destRect.top = sdirty->top;
755 	cmd->body.destRect.bottom = sdirty->bottom;
756 
757 	cmd->body.srcRect.left = sdirty->left + trans_x;
758 	cmd->body.srcRect.right = sdirty->right + trans_x;
759 	cmd->body.srcRect.top = sdirty->top + trans_y;
760 	cmd->body.srcRect.bottom = sdirty->bottom + trans_y;
761 
762 	cmd->body.srcImage.sid = sdirty->sid;
763 	cmd->body.destScreenId = dirty->unit->unit;
764 
765 	/* Blits are relative to the destination rect. Translate. */
766 	for (i = 0; i < dirty->num_hits; ++i, ++blit) {
767 		blit->left -= sdirty->left;
768 		blit->right -= sdirty->left;
769 		blit->top -= sdirty->top;
770 		blit->bottom -= sdirty->top;
771 	}
772 
773 	vmw_fifo_commit(dirty->dev_priv, region_size + sizeof(*cmd));
774 
775 	sdirty->left = sdirty->top = S32_MAX;
776 	sdirty->right = sdirty->bottom = S32_MIN;
777 }
778 
779 /**
780  * vmw_sou_surface_clip - Callback to encode a blit surface to screen cliprect.
781  *
782  * @dirty: The closure structure
783  *
784  * Encodes a SVGASignedRect cliprect and updates the bounding box of the
785  * BLIT_SURFACE_TO_SCREEN command.
786  */
787 static void vmw_sou_surface_clip(struct vmw_kms_dirty *dirty)
788 {
789 	struct vmw_kms_sou_surface_dirty *sdirty =
790 		container_of(dirty, typeof(*sdirty), base);
791 	struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
792 	SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];
793 
794 	/* Destination rect. */
795 	blit += dirty->num_hits;
796 	blit->left = dirty->unit_x1;
797 	blit->top = dirty->unit_y1;
798 	blit->right = dirty->unit_x2;
799 	blit->bottom = dirty->unit_y2;
800 
801 	/* Destination bounding box */
802 	sdirty->left = min_t(s32, sdirty->left, dirty->unit_x1);
803 	sdirty->top = min_t(s32, sdirty->top, dirty->unit_y1);
804 	sdirty->right = max_t(s32, sdirty->right, dirty->unit_x2);
805 	sdirty->bottom = max_t(s32, sdirty->bottom, dirty->unit_y2);
806 
807 	dirty->num_hits++;
808 }
809 
810 /**
811  * vmw_kms_sou_do_surface_dirty - Dirty part of a surface backed framebuffer
812  *
813  * @dev_priv: Pointer to the device private structure.
814  * @framebuffer: Pointer to the surface-buffer backed framebuffer.
815  * @clips: Array of clip rects. Either @clips or @vclips must be NULL.
816  * @vclips: Alternate array of clip rects. Either @clips or @vclips must
817  * be NULL.
818  * @srf: Pointer to surface to blit from. If NULL, the surface attached
819  * to @framebuffer will be used.
820  * @dest_x: X coordinate offset to align @srf with framebuffer coordinates.
821  * @dest_y: Y coordinate offset to align @srf with framebuffer coordinates.
822  * @num_clips: Number of clip rects in @clips.
823  * @inc: Increment to use when looping over @clips.
824  * @out_fence: If non-NULL, will return a ref-counted pointer to a
825  * struct vmw_fence_obj. The returned fence pointer may be NULL in which
826  * case the device has already synchronized.
827  *
828  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
829  * interrupted.
830  */
831 int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
832 				 struct vmw_framebuffer *framebuffer,
833 				 struct drm_clip_rect *clips,
834 				 struct drm_vmw_rect *vclips,
835 				 struct vmw_resource *srf,
836 				 s32 dest_x,
837 				 s32 dest_y,
838 				 unsigned num_clips, int inc,
839 				 struct vmw_fence_obj **out_fence)
840 {
841 	struct vmw_framebuffer_surface *vfbs =
842 		container_of(framebuffer, typeof(*vfbs), base);
843 	struct vmw_kms_sou_surface_dirty sdirty;
844 	int ret;
845 
846 	if (!srf)
847 		srf = &vfbs->surface->res;
848 
849 	ret = vmw_kms_helper_resource_prepare(srf, true);
850 	if (ret)
851 		return ret;
852 
853 	sdirty.base.fifo_commit = vmw_sou_surface_fifo_commit;
854 	sdirty.base.clip = vmw_sou_surface_clip;
855 	sdirty.base.dev_priv = dev_priv;
856 	sdirty.base.fifo_reserve_size = sizeof(struct vmw_kms_sou_dirty_cmd) +
857 	  sizeof(SVGASignedRect) * num_clips;
858 
859 	sdirty.sid = srf->id;
860 	sdirty.left = sdirty.top = S32_MAX;
861 	sdirty.right = sdirty.bottom = S32_MIN;
862 	sdirty.dst_x = dest_x;
863 	sdirty.dst_y = dest_y;
864 
865 	ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
866 				   dest_x, dest_y, num_clips, inc,
867 				   &sdirty.base);
868 	vmw_kms_helper_resource_finish(srf, out_fence);
869 
870 	return ret;
871 }
872 
873 /**
874  * vmw_sou_dmabuf_fifo_commit - Callback to submit a set of readback clips.
875  *
876  * @dirty: The closure structure.
877  *
878  * Commits a previously built command buffer of readback clips.
879  */
880 static void vmw_sou_dmabuf_fifo_commit(struct vmw_kms_dirty *dirty)
881 {
882 	vmw_fifo_commit(dirty->dev_priv,
883 			sizeof(struct vmw_kms_sou_dmabuf_blit) *
884 			dirty->num_hits);
885 }
886 
887 /**
888  * vmw_sou_dmabuf_clip - Callback to encode a readback cliprect.
889  *
890  * @dirty: The closure structure
891  *
892  * Encodes a BLIT_GMRFB_TO_SCREEN cliprect.
893  */
894 static void vmw_sou_dmabuf_clip(struct vmw_kms_dirty *dirty)
895 {
896 	struct vmw_kms_sou_dmabuf_blit *blit = dirty->cmd;
897 
898 	blit += dirty->num_hits;
899 	blit->header = SVGA_CMD_BLIT_GMRFB_TO_SCREEN;
900 	blit->body.destScreenId = dirty->unit->unit;
901 	blit->body.srcOrigin.x = dirty->fb_x;
902 	blit->body.srcOrigin.y = dirty->fb_y;
903 	blit->body.destRect.left = dirty->unit_x1;
904 	blit->body.destRect.top = dirty->unit_y1;
905 	blit->body.destRect.right = dirty->unit_x2;
906 	blit->body.destRect.bottom = dirty->unit_y2;
907 	dirty->num_hits++;
908 }
909 
910 /**
911  * vmw_kms_do_dmabuf_dirty - Dirty part of a dma-buffer backed framebuffer
912  *
913  * @dev_priv: Pointer to the device private structure.
914  * @framebuffer: Pointer to the dma-buffer backed framebuffer.
915  * @clips: Array of clip rects.
916  * @num_clips: Number of clip rects in @clips.
917  * @increment: Increment to use when looping over @clips.
918  * @interruptible: Whether to perform waits interruptible if possible.
919  * @out_fence: If non-NULL, will return a ref-counted pointer to a
920  * struct vmw_fence_obj. The returned fence pointer may be NULL in which
921  * case the device has already synchronized.
922  *
923  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
924  * interrupted.
925  */
926 int vmw_kms_sou_do_dmabuf_dirty(struct vmw_private *dev_priv,
927 				struct vmw_framebuffer *framebuffer,
928 				struct drm_clip_rect *clips,
929 				unsigned num_clips, int increment,
930 				bool interruptible,
931 				struct vmw_fence_obj **out_fence)
932 {
933 	struct vmw_dma_buffer *buf =
934 		container_of(framebuffer, struct vmw_framebuffer_dmabuf,
935 			     base)->buffer;
936 	struct vmw_kms_dirty dirty;
937 	int ret;
938 
939 	ret = vmw_kms_helper_buffer_prepare(dev_priv, buf, interruptible,
940 					    false);
941 	if (ret)
942 		return ret;
943 
944 	ret = do_dmabuf_define_gmrfb(dev_priv, framebuffer);
945 	if (unlikely(ret != 0))
946 		goto out_revert;
947 
948 	dirty.fifo_commit = vmw_sou_dmabuf_fifo_commit;
949 	dirty.clip = vmw_sou_dmabuf_clip;
950 	dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_dmabuf_blit) *
951 		num_clips;
952 	ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, NULL,
953 				   0, 0, num_clips, increment, &dirty);
954 	vmw_kms_helper_buffer_finish(dev_priv, NULL, buf, out_fence, NULL);
955 
956 	return ret;
957 
958 out_revert:
959 	vmw_kms_helper_buffer_revert(buf);
960 
961 	return ret;
962 }
963 
964 
965 /**
966  * vmw_sou_readback_fifo_commit - Callback to submit a set of readback clips.
967  *
968  * @dirty: The closure structure.
969  *
970  * Commits a previously built command buffer of readback clips.
971  */
972 static void vmw_sou_readback_fifo_commit(struct vmw_kms_dirty *dirty)
973 {
974 	vmw_fifo_commit(dirty->dev_priv,
975 			sizeof(struct vmw_kms_sou_readback_blit) *
976 			dirty->num_hits);
977 }
978 
979 /**
980  * vmw_sou_readback_clip - Callback to encode a readback cliprect.
981  *
982  * @dirty: The closure structure
983  *
984  * Encodes a BLIT_SCREEN_TO_GMRFB cliprect.
985  */
986 static void vmw_sou_readback_clip(struct vmw_kms_dirty *dirty)
987 {
988 	struct vmw_kms_sou_readback_blit *blit = dirty->cmd;
989 
990 	blit += dirty->num_hits;
991 	blit->header = SVGA_CMD_BLIT_SCREEN_TO_GMRFB;
992 	blit->body.srcScreenId = dirty->unit->unit;
993 	blit->body.destOrigin.x = dirty->fb_x;
994 	blit->body.destOrigin.y = dirty->fb_y;
995 	blit->body.srcRect.left = dirty->unit_x1;
996 	blit->body.srcRect.top = dirty->unit_y1;
997 	blit->body.srcRect.right = dirty->unit_x2;
998 	blit->body.srcRect.bottom = dirty->unit_y2;
999 	dirty->num_hits++;
1000 }
1001 
1002 /**
1003  * vmw_kms_sou_readback - Perform a readback from the screen object system to
1004  * a dma-buffer backed framebuffer.
1005  *
1006  * @dev_priv: Pointer to the device private structure.
1007  * @file_priv: Pointer to a struct drm_file identifying the caller.
1008  * Must be set to NULL if @user_fence_rep is NULL.
1009  * @vfb: Pointer to the dma-buffer backed framebuffer.
1010  * @user_fence_rep: User-space provided structure for fence information.
1011  * Must be set to non-NULL if @file_priv is non-NULL.
1012  * @vclips: Array of clip rects.
1013  * @num_clips: Number of clip rects in @vclips.
1014  *
1015  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1016  * interrupted.
1017  */
1018 int vmw_kms_sou_readback(struct vmw_private *dev_priv,
1019 			 struct drm_file *file_priv,
1020 			 struct vmw_framebuffer *vfb,
1021 			 struct drm_vmw_fence_rep __user *user_fence_rep,
1022 			 struct drm_vmw_rect *vclips,
1023 			 uint32_t num_clips)
1024 {
1025 	struct vmw_dma_buffer *buf =
1026 		container_of(vfb, struct vmw_framebuffer_dmabuf, base)->buffer;
1027 	struct vmw_kms_dirty dirty;
1028 	int ret;
1029 
1030 	ret = vmw_kms_helper_buffer_prepare(dev_priv, buf, true, false);
1031 	if (ret)
1032 		return ret;
1033 
1034 	ret = do_dmabuf_define_gmrfb(dev_priv, vfb);
1035 	if (unlikely(ret != 0))
1036 		goto out_revert;
1037 
1038 	dirty.fifo_commit = vmw_sou_readback_fifo_commit;
1039 	dirty.clip = vmw_sou_readback_clip;
1040 	dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_readback_blit) *
1041 		num_clips;
1042 	ret = vmw_kms_helper_dirty(dev_priv, vfb, NULL, vclips,
1043 				   0, 0, num_clips, 1, &dirty);
1044 	vmw_kms_helper_buffer_finish(dev_priv, file_priv, buf, NULL,
1045 				     user_fence_rep);
1046 
1047 	return ret;
1048 
1049 out_revert:
1050 	vmw_kms_helper_buffer_revert(buf);
1051 
1052 	return ret;
1053 }
1054