1 // SPDX-License-Identifier: GPL-2.0 OR MIT
2 /**************************************************************************
3  *
4  * Copyright 2011-2022 VMware, Inc., Palo Alto, CA., USA
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 <drm/drm_atomic.h>
29 #include <drm/drm_atomic_helper.h>
30 #include <drm/drm_damage_helper.h>
31 #include <drm/drm_fourcc.h>
32 #include <drm/drm_plane_helper.h>
33 #include <drm/drm_vblank.h>
34 
35 #include "vmwgfx_kms.h"
36 
37 #define vmw_crtc_to_sou(x) \
38 	container_of(x, struct vmw_screen_object_unit, base.crtc)
39 #define vmw_encoder_to_sou(x) \
40 	container_of(x, struct vmw_screen_object_unit, base.encoder)
41 #define vmw_connector_to_sou(x) \
42 	container_of(x, struct vmw_screen_object_unit, base.connector)
43 
44 /**
45  * struct vmw_kms_sou_surface_dirty - Closure structure for
46  * blit surface to screen command.
47  * @base: The base type we derive from. Used by vmw_kms_helper_dirty().
48  * @left: Left side of bounding box.
49  * @right: Right side of bounding box.
50  * @top: Top side of bounding box.
51  * @bottom: Bottom side of bounding box.
52  * @dst_x: Difference between source clip rects and framebuffer coordinates.
53  * @dst_y: Difference between source clip rects and framebuffer coordinates.
54  * @sid: Surface id of surface to copy from.
55  */
56 struct vmw_kms_sou_surface_dirty {
57 	struct vmw_kms_dirty base;
58 	s32 left, right, top, bottom;
59 	s32 dst_x, dst_y;
60 	u32 sid;
61 };
62 
63 /*
64  * SVGA commands that are used by this code. Please see the device headers
65  * for explanation.
66  */
67 struct vmw_kms_sou_readback_blit {
68 	uint32 header;
69 	SVGAFifoCmdBlitScreenToGMRFB body;
70 };
71 
72 struct vmw_kms_sou_bo_blit {
73 	uint32 header;
74 	SVGAFifoCmdBlitGMRFBToScreen body;
75 };
76 
77 struct vmw_kms_sou_dirty_cmd {
78 	SVGA3dCmdHeader header;
79 	SVGA3dCmdBlitSurfaceToScreen body;
80 };
81 
82 struct vmw_kms_sou_define_gmrfb {
83 	uint32_t header;
84 	SVGAFifoCmdDefineGMRFB body;
85 };
86 
87 /*
88  * Display unit using screen objects.
89  */
90 struct vmw_screen_object_unit {
91 	struct vmw_display_unit base;
92 
93 	unsigned long buffer_size; /**< Size of allocated buffer */
94 	struct vmw_buffer_object *buffer; /**< Backing store buffer */
95 
96 	bool defined;
97 };
98 
99 static void vmw_sou_destroy(struct vmw_screen_object_unit *sou)
100 {
101 	vmw_du_cleanup(&sou->base);
102 	kfree(sou);
103 }
104 
105 
106 /*
107  * Screen Object Display Unit CRTC functions
108  */
109 
110 static void vmw_sou_crtc_destroy(struct drm_crtc *crtc)
111 {
112 	vmw_sou_destroy(vmw_crtc_to_sou(crtc));
113 }
114 
115 /*
116  * Send the fifo command to create a screen.
117  */
118 static int vmw_sou_fifo_create(struct vmw_private *dev_priv,
119 			       struct vmw_screen_object_unit *sou,
120 			       int x, int y,
121 			       struct drm_display_mode *mode)
122 {
123 	size_t fifo_size;
124 
125 	struct {
126 		struct {
127 			uint32_t cmdType;
128 		} header;
129 		SVGAScreenObject obj;
130 	} *cmd;
131 
132 	BUG_ON(!sou->buffer);
133 
134 	fifo_size = sizeof(*cmd);
135 	cmd = VMW_CMD_RESERVE(dev_priv, fifo_size);
136 	if (unlikely(cmd == NULL))
137 		return -ENOMEM;
138 
139 	memset(cmd, 0, fifo_size);
140 	cmd->header.cmdType = SVGA_CMD_DEFINE_SCREEN;
141 	cmd->obj.structSize = sizeof(SVGAScreenObject);
142 	cmd->obj.id = sou->base.unit;
143 	cmd->obj.flags = SVGA_SCREEN_HAS_ROOT |
144 		(sou->base.unit == 0 ? SVGA_SCREEN_IS_PRIMARY : 0);
145 	cmd->obj.size.width = mode->hdisplay;
146 	cmd->obj.size.height = mode->vdisplay;
147 	cmd->obj.root.x = x;
148 	cmd->obj.root.y = y;
149 	sou->base.set_gui_x = cmd->obj.root.x;
150 	sou->base.set_gui_y = cmd->obj.root.y;
151 
152 	/* Ok to assume that buffer is pinned in vram */
153 	vmw_bo_get_guest_ptr(&sou->buffer->base, &cmd->obj.backingStore.ptr);
154 	cmd->obj.backingStore.pitch = mode->hdisplay * 4;
155 
156 	vmw_cmd_commit(dev_priv, fifo_size);
157 
158 	sou->defined = true;
159 
160 	return 0;
161 }
162 
163 /*
164  * Send the fifo command to destroy a screen.
165  */
166 static int vmw_sou_fifo_destroy(struct vmw_private *dev_priv,
167 				struct vmw_screen_object_unit *sou)
168 {
169 	size_t fifo_size;
170 	int ret;
171 
172 	struct {
173 		struct {
174 			uint32_t cmdType;
175 		} header;
176 		SVGAFifoCmdDestroyScreen body;
177 	} *cmd;
178 
179 	/* no need to do anything */
180 	if (unlikely(!sou->defined))
181 		return 0;
182 
183 	fifo_size = sizeof(*cmd);
184 	cmd = VMW_CMD_RESERVE(dev_priv, fifo_size);
185 	if (unlikely(cmd == NULL))
186 		return -ENOMEM;
187 
188 	memset(cmd, 0, fifo_size);
189 	cmd->header.cmdType = SVGA_CMD_DESTROY_SCREEN;
190 	cmd->body.screenId = sou->base.unit;
191 
192 	vmw_cmd_commit(dev_priv, fifo_size);
193 
194 	/* Force sync */
195 	ret = vmw_fallback_wait(dev_priv, false, true, 0, false, 3*HZ);
196 	if (unlikely(ret != 0))
197 		DRM_ERROR("Failed to sync with HW");
198 	else
199 		sou->defined = false;
200 
201 	return ret;
202 }
203 
204 /**
205  * vmw_sou_crtc_mode_set_nofb - Create new screen
206  *
207  * @crtc: CRTC associated with the new screen
208  *
209  * This function creates/destroys a screen.  This function cannot fail, so if
210  * somehow we run into a failure, just do the best we can to get out.
211  */
212 static void vmw_sou_crtc_mode_set_nofb(struct drm_crtc *crtc)
213 {
214 	struct vmw_private *dev_priv;
215 	struct vmw_screen_object_unit *sou;
216 	struct vmw_framebuffer *vfb;
217 	struct drm_framebuffer *fb;
218 	struct drm_plane_state *ps;
219 	struct vmw_plane_state *vps;
220 	int ret;
221 
222 	sou = vmw_crtc_to_sou(crtc);
223 	dev_priv = vmw_priv(crtc->dev);
224 	ps = crtc->primary->state;
225 	fb = ps->fb;
226 	vps = vmw_plane_state_to_vps(ps);
227 
228 	vfb = (fb) ? vmw_framebuffer_to_vfb(fb) : NULL;
229 
230 	if (sou->defined) {
231 		ret = vmw_sou_fifo_destroy(dev_priv, sou);
232 		if (ret) {
233 			DRM_ERROR("Failed to destroy Screen Object\n");
234 			return;
235 		}
236 	}
237 
238 	if (vfb) {
239 		struct drm_connector_state *conn_state;
240 		struct vmw_connector_state *vmw_conn_state;
241 		int x, y;
242 
243 		sou->buffer = vps->bo;
244 		sou->buffer_size = vps->bo_size;
245 
246 		conn_state = sou->base.connector.state;
247 		vmw_conn_state = vmw_connector_state_to_vcs(conn_state);
248 
249 		x = vmw_conn_state->gui_x;
250 		y = vmw_conn_state->gui_y;
251 
252 		ret = vmw_sou_fifo_create(dev_priv, sou, x, y, &crtc->mode);
253 		if (ret)
254 			DRM_ERROR("Failed to define Screen Object %dx%d\n",
255 				  crtc->x, crtc->y);
256 
257 	} else {
258 		sou->buffer = NULL;
259 		sou->buffer_size = 0;
260 	}
261 }
262 
263 /**
264  * vmw_sou_crtc_helper_prepare - Noop
265  *
266  * @crtc:  CRTC associated with the new screen
267  *
268  * Prepares the CRTC for a mode set, but we don't need to do anything here.
269  */
270 static void vmw_sou_crtc_helper_prepare(struct drm_crtc *crtc)
271 {
272 }
273 
274 /**
275  * vmw_sou_crtc_atomic_enable - Noop
276  *
277  * @crtc: CRTC associated with the new screen
278  * @state: Unused
279  *
280  * This is called after a mode set has been completed.
281  */
282 static void vmw_sou_crtc_atomic_enable(struct drm_crtc *crtc,
283 				       struct drm_atomic_state *state)
284 {
285 }
286 
287 /**
288  * vmw_sou_crtc_atomic_disable - Turns off CRTC
289  *
290  * @crtc: CRTC to be turned off
291  * @state: Unused
292  */
293 static void vmw_sou_crtc_atomic_disable(struct drm_crtc *crtc,
294 					struct drm_atomic_state *state)
295 {
296 	struct vmw_private *dev_priv;
297 	struct vmw_screen_object_unit *sou;
298 	int ret;
299 
300 
301 	if (!crtc) {
302 		DRM_ERROR("CRTC is NULL\n");
303 		return;
304 	}
305 
306 	sou = vmw_crtc_to_sou(crtc);
307 	dev_priv = vmw_priv(crtc->dev);
308 
309 	if (sou->defined) {
310 		ret = vmw_sou_fifo_destroy(dev_priv, sou);
311 		if (ret)
312 			DRM_ERROR("Failed to destroy Screen Object\n");
313 	}
314 }
315 
316 static const struct drm_crtc_funcs vmw_screen_object_crtc_funcs = {
317 	.gamma_set = vmw_du_crtc_gamma_set,
318 	.destroy = vmw_sou_crtc_destroy,
319 	.reset = vmw_du_crtc_reset,
320 	.atomic_duplicate_state = vmw_du_crtc_duplicate_state,
321 	.atomic_destroy_state = vmw_du_crtc_destroy_state,
322 	.set_config = drm_atomic_helper_set_config,
323 	.page_flip = drm_atomic_helper_page_flip,
324 	.get_vblank_counter = vmw_get_vblank_counter,
325 	.enable_vblank = vmw_enable_vblank,
326 	.disable_vblank = vmw_disable_vblank,
327 };
328 
329 /*
330  * Screen Object Display Unit encoder functions
331  */
332 
333 static void vmw_sou_encoder_destroy(struct drm_encoder *encoder)
334 {
335 	vmw_sou_destroy(vmw_encoder_to_sou(encoder));
336 }
337 
338 static const struct drm_encoder_funcs vmw_screen_object_encoder_funcs = {
339 	.destroy = vmw_sou_encoder_destroy,
340 };
341 
342 /*
343  * Screen Object Display Unit connector functions
344  */
345 
346 static void vmw_sou_connector_destroy(struct drm_connector *connector)
347 {
348 	vmw_sou_destroy(vmw_connector_to_sou(connector));
349 }
350 
351 static const struct drm_connector_funcs vmw_sou_connector_funcs = {
352 	.dpms = vmw_du_connector_dpms,
353 	.detect = vmw_du_connector_detect,
354 	.fill_modes = vmw_du_connector_fill_modes,
355 	.destroy = vmw_sou_connector_destroy,
356 	.reset = vmw_du_connector_reset,
357 	.atomic_duplicate_state = vmw_du_connector_duplicate_state,
358 	.atomic_destroy_state = vmw_du_connector_destroy_state,
359 };
360 
361 
362 static const struct
363 drm_connector_helper_funcs vmw_sou_connector_helper_funcs = {
364 };
365 
366 
367 
368 /*
369  * Screen Object Display Plane Functions
370  */
371 
372 /**
373  * vmw_sou_primary_plane_cleanup_fb - Frees sou backing buffer
374  *
375  * @plane:  display plane
376  * @old_state: Contains the FB to clean up
377  *
378  * Unpins the display surface
379  *
380  * Returns 0 on success
381  */
382 static void
383 vmw_sou_primary_plane_cleanup_fb(struct drm_plane *plane,
384 				 struct drm_plane_state *old_state)
385 {
386 	struct vmw_plane_state *vps = vmw_plane_state_to_vps(old_state);
387 	struct drm_crtc *crtc = plane->state->crtc ?
388 		plane->state->crtc : old_state->crtc;
389 
390 	if (vps->bo)
391 		vmw_bo_unpin(vmw_priv(crtc->dev), vps->bo, false);
392 	vmw_bo_unreference(&vps->bo);
393 	vps->bo_size = 0;
394 
395 	vmw_du_plane_cleanup_fb(plane, old_state);
396 }
397 
398 
399 /**
400  * vmw_sou_primary_plane_prepare_fb - allocate backing buffer
401  *
402  * @plane:  display plane
403  * @new_state: info on the new plane state, including the FB
404  *
405  * The SOU backing buffer is our equivalent of the display plane.
406  *
407  * Returns 0 on success
408  */
409 static int
410 vmw_sou_primary_plane_prepare_fb(struct drm_plane *plane,
411 				 struct drm_plane_state *new_state)
412 {
413 	struct drm_framebuffer *new_fb = new_state->fb;
414 	struct drm_crtc *crtc = plane->state->crtc ?: new_state->crtc;
415 	struct vmw_plane_state *vps = vmw_plane_state_to_vps(new_state);
416 	struct vmw_private *dev_priv;
417 	size_t size;
418 	int ret;
419 
420 
421 	if (!new_fb) {
422 		vmw_bo_unreference(&vps->bo);
423 		vps->bo_size = 0;
424 
425 		return 0;
426 	}
427 
428 	size = new_state->crtc_w * new_state->crtc_h * 4;
429 	dev_priv = vmw_priv(crtc->dev);
430 
431 	if (vps->bo) {
432 		if (vps->bo_size == size) {
433 			/*
434 			 * Note that this might temporarily up the pin-count
435 			 * to 2, until cleanup_fb() is called.
436 			 */
437 			return vmw_bo_pin_in_vram(dev_priv, vps->bo,
438 						      true);
439 		}
440 
441 		vmw_bo_unreference(&vps->bo);
442 		vps->bo_size = 0;
443 	}
444 
445 	vmw_svga_enable(dev_priv);
446 
447 	/* After we have alloced the backing store might not be able to
448 	 * resume the overlays, this is preferred to failing to alloc.
449 	 */
450 	vmw_overlay_pause_all(dev_priv);
451 	ret = vmw_bo_create(dev_priv, size,
452 			    &vmw_vram_placement,
453 			    false, true, &vmw_bo_bo_free, &vps->bo);
454 	vmw_overlay_resume_all(dev_priv);
455 	if (ret) {
456 		vps->bo = NULL; /* vmw_bo_init frees on error */
457 		return ret;
458 	}
459 
460 	vps->bo_size = size;
461 
462 	/*
463 	 * TTM already thinks the buffer is pinned, but make sure the
464 	 * pin_count is upped.
465 	 */
466 	return vmw_bo_pin_in_vram(dev_priv, vps->bo, true);
467 }
468 
469 static uint32_t vmw_sou_bo_fifo_size(struct vmw_du_update_plane *update,
470 				     uint32_t num_hits)
471 {
472 	return sizeof(struct vmw_kms_sou_define_gmrfb) +
473 		sizeof(struct vmw_kms_sou_bo_blit) * num_hits;
474 }
475 
476 static uint32_t vmw_sou_bo_define_gmrfb(struct vmw_du_update_plane *update,
477 					void *cmd)
478 {
479 	struct vmw_framebuffer_bo *vfbbo =
480 		container_of(update->vfb, typeof(*vfbbo), base);
481 	struct vmw_kms_sou_define_gmrfb *gmr = cmd;
482 	int depth = update->vfb->base.format->depth;
483 
484 	/* Emulate RGBA support, contrary to svga_reg.h this is not
485 	 * supported by hosts. This is only a problem if we are reading
486 	 * this value later and expecting what we uploaded back.
487 	 */
488 	if (depth == 32)
489 		depth = 24;
490 
491 	gmr->header = SVGA_CMD_DEFINE_GMRFB;
492 
493 	gmr->body.format.bitsPerPixel = update->vfb->base.format->cpp[0] * 8;
494 	gmr->body.format.colorDepth = depth;
495 	gmr->body.format.reserved = 0;
496 	gmr->body.bytesPerLine = update->vfb->base.pitches[0];
497 	vmw_bo_get_guest_ptr(&vfbbo->buffer->base, &gmr->body.ptr);
498 
499 	return sizeof(*gmr);
500 }
501 
502 static uint32_t vmw_sou_bo_populate_clip(struct vmw_du_update_plane  *update,
503 					 void *cmd, struct drm_rect *clip,
504 					 uint32_t fb_x, uint32_t fb_y)
505 {
506 	struct vmw_kms_sou_bo_blit *blit = cmd;
507 
508 	blit->header = SVGA_CMD_BLIT_GMRFB_TO_SCREEN;
509 	blit->body.destScreenId = update->du->unit;
510 	blit->body.srcOrigin.x = fb_x;
511 	blit->body.srcOrigin.y = fb_y;
512 	blit->body.destRect.left = clip->x1;
513 	blit->body.destRect.top = clip->y1;
514 	blit->body.destRect.right = clip->x2;
515 	blit->body.destRect.bottom = clip->y2;
516 
517 	return sizeof(*blit);
518 }
519 
520 static uint32_t vmw_stud_bo_post_clip(struct vmw_du_update_plane  *update,
521 				      void *cmd, struct drm_rect *bb)
522 {
523 	return 0;
524 }
525 
526 /**
527  * vmw_sou_plane_update_bo - Update display unit for bo backed fb.
528  * @dev_priv: Device private.
529  * @plane: Plane state.
530  * @old_state: Old plane state.
531  * @vfb: Framebuffer which is blitted to display unit.
532  * @out_fence: If non-NULL, will return a ref-counted pointer to vmw_fence_obj.
533  *             The returned fence pointer may be NULL in which case the device
534  *             has already synchronized.
535  *
536  * Return: 0 on success or a negative error code on failure.
537  */
538 static int vmw_sou_plane_update_bo(struct vmw_private *dev_priv,
539 				   struct drm_plane *plane,
540 				   struct drm_plane_state *old_state,
541 				   struct vmw_framebuffer *vfb,
542 				   struct vmw_fence_obj **out_fence)
543 {
544 	struct vmw_du_update_plane_buffer bo_update;
545 
546 	memset(&bo_update, 0, sizeof(struct vmw_du_update_plane_buffer));
547 	bo_update.base.plane = plane;
548 	bo_update.base.old_state = old_state;
549 	bo_update.base.dev_priv = dev_priv;
550 	bo_update.base.du = vmw_crtc_to_du(plane->state->crtc);
551 	bo_update.base.vfb = vfb;
552 	bo_update.base.out_fence = out_fence;
553 	bo_update.base.mutex = NULL;
554 	bo_update.base.cpu_blit = false;
555 	bo_update.base.intr = true;
556 
557 	bo_update.base.calc_fifo_size = vmw_sou_bo_fifo_size;
558 	bo_update.base.post_prepare = vmw_sou_bo_define_gmrfb;
559 	bo_update.base.clip = vmw_sou_bo_populate_clip;
560 	bo_update.base.post_clip = vmw_stud_bo_post_clip;
561 
562 	return vmw_du_helper_plane_update(&bo_update.base);
563 }
564 
565 static uint32_t vmw_sou_surface_fifo_size(struct vmw_du_update_plane *update,
566 					  uint32_t num_hits)
567 {
568 	return sizeof(struct vmw_kms_sou_dirty_cmd) + sizeof(SVGASignedRect) *
569 		num_hits;
570 }
571 
572 static uint32_t vmw_sou_surface_post_prepare(struct vmw_du_update_plane *update,
573 					     void *cmd)
574 {
575 	struct vmw_du_update_plane_surface *srf_update;
576 
577 	srf_update = container_of(update, typeof(*srf_update), base);
578 
579 	/*
580 	 * SOU SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN is special in the sense that
581 	 * its bounding box is filled before iterating over all the clips. So
582 	 * store the FIFO start address and revisit to fill the details.
583 	 */
584 	srf_update->cmd_start = cmd;
585 
586 	return 0;
587 }
588 
589 static uint32_t vmw_sou_surface_pre_clip(struct vmw_du_update_plane *update,
590 					 void *cmd, uint32_t num_hits)
591 {
592 	struct vmw_kms_sou_dirty_cmd *blit = cmd;
593 	struct vmw_framebuffer_surface *vfbs;
594 
595 	vfbs = container_of(update->vfb, typeof(*vfbs), base);
596 
597 	blit->header.id = SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN;
598 	blit->header.size = sizeof(blit->body) + sizeof(SVGASignedRect) *
599 		num_hits;
600 
601 	blit->body.srcImage.sid = vfbs->surface->res.id;
602 	blit->body.destScreenId = update->du->unit;
603 
604 	/* Update the source and destination bounding box later in post_clip */
605 	blit->body.srcRect.left = 0;
606 	blit->body.srcRect.top = 0;
607 	blit->body.srcRect.right = 0;
608 	blit->body.srcRect.bottom = 0;
609 
610 	blit->body.destRect.left = 0;
611 	blit->body.destRect.top = 0;
612 	blit->body.destRect.right = 0;
613 	blit->body.destRect.bottom = 0;
614 
615 	return sizeof(*blit);
616 }
617 
618 static uint32_t vmw_sou_surface_clip_rect(struct vmw_du_update_plane *update,
619 					  void *cmd, struct drm_rect *clip,
620 					  uint32_t src_x, uint32_t src_y)
621 {
622 	SVGASignedRect *rect = cmd;
623 
624 	/*
625 	 * rects are relative to dest bounding box rect on screen object, so
626 	 * translate to it later in post_clip
627 	 */
628 	rect->left = clip->x1;
629 	rect->top = clip->y1;
630 	rect->right = clip->x2;
631 	rect->bottom = clip->y2;
632 
633 	return sizeof(*rect);
634 }
635 
636 static uint32_t vmw_sou_surface_post_clip(struct vmw_du_update_plane *update,
637 					  void *cmd, struct drm_rect *bb)
638 {
639 	struct vmw_du_update_plane_surface *srf_update;
640 	struct drm_plane_state *state = update->plane->state;
641 	struct drm_rect src_bb;
642 	struct vmw_kms_sou_dirty_cmd *blit;
643 	SVGASignedRect *rect;
644 	uint32_t num_hits;
645 	int translate_src_x;
646 	int translate_src_y;
647 	int i;
648 
649 	srf_update = container_of(update, typeof(*srf_update), base);
650 
651 	blit = srf_update->cmd_start;
652 	rect = (SVGASignedRect *)&blit[1];
653 
654 	num_hits = (blit->header.size - sizeof(blit->body))/
655 		sizeof(SVGASignedRect);
656 
657 	src_bb = *bb;
658 
659 	/* To translate bb back to fb src coord */
660 	translate_src_x = (state->src_x >> 16) - state->crtc_x;
661 	translate_src_y = (state->src_y >> 16) - state->crtc_y;
662 
663 	drm_rect_translate(&src_bb, translate_src_x, translate_src_y);
664 
665 	blit->body.srcRect.left = src_bb.x1;
666 	blit->body.srcRect.top = src_bb.y1;
667 	blit->body.srcRect.right = src_bb.x2;
668 	blit->body.srcRect.bottom = src_bb.y2;
669 
670 	blit->body.destRect.left = bb->x1;
671 	blit->body.destRect.top = bb->y1;
672 	blit->body.destRect.right = bb->x2;
673 	blit->body.destRect.bottom = bb->y2;
674 
675 	/* rects are relative to dest bb rect */
676 	for (i = 0; i < num_hits; i++) {
677 		rect->left -= bb->x1;
678 		rect->top -= bb->y1;
679 		rect->right -= bb->x1;
680 		rect->bottom -= bb->y1;
681 		rect++;
682 	}
683 
684 	return 0;
685 }
686 
687 /**
688  * vmw_sou_plane_update_surface - Update display unit for surface backed fb.
689  * @dev_priv: Device private.
690  * @plane: Plane state.
691  * @old_state: Old plane state.
692  * @vfb: Framebuffer which is blitted to display unit
693  * @out_fence: If non-NULL, will return a ref-counted pointer to vmw_fence_obj.
694  *             The returned fence pointer may be NULL in which case the device
695  *             has already synchronized.
696  *
697  * Return: 0 on success or a negative error code on failure.
698  */
699 static int vmw_sou_plane_update_surface(struct vmw_private *dev_priv,
700 					struct drm_plane *plane,
701 					struct drm_plane_state *old_state,
702 					struct vmw_framebuffer *vfb,
703 					struct vmw_fence_obj **out_fence)
704 {
705 	struct vmw_du_update_plane_surface srf_update;
706 
707 	memset(&srf_update, 0, sizeof(struct vmw_du_update_plane_surface));
708 	srf_update.base.plane = plane;
709 	srf_update.base.old_state = old_state;
710 	srf_update.base.dev_priv = dev_priv;
711 	srf_update.base.du = vmw_crtc_to_du(plane->state->crtc);
712 	srf_update.base.vfb = vfb;
713 	srf_update.base.out_fence = out_fence;
714 	srf_update.base.mutex = &dev_priv->cmdbuf_mutex;
715 	srf_update.base.cpu_blit = false;
716 	srf_update.base.intr = true;
717 
718 	srf_update.base.calc_fifo_size = vmw_sou_surface_fifo_size;
719 	srf_update.base.post_prepare = vmw_sou_surface_post_prepare;
720 	srf_update.base.pre_clip = vmw_sou_surface_pre_clip;
721 	srf_update.base.clip = vmw_sou_surface_clip_rect;
722 	srf_update.base.post_clip = vmw_sou_surface_post_clip;
723 
724 	return vmw_du_helper_plane_update(&srf_update.base);
725 }
726 
727 static void
728 vmw_sou_primary_plane_atomic_update(struct drm_plane *plane,
729 				    struct drm_atomic_state *state)
730 {
731 	struct drm_plane_state *old_state = drm_atomic_get_old_plane_state(state, plane);
732 	struct drm_plane_state *new_state = drm_atomic_get_new_plane_state(state, plane);
733 	struct drm_crtc *crtc = new_state->crtc;
734 	struct drm_pending_vblank_event *event = NULL;
735 	struct vmw_fence_obj *fence = NULL;
736 	int ret;
737 
738 	/* In case of device error, maintain consistent atomic state */
739 	if (crtc && new_state->fb) {
740 		struct vmw_private *dev_priv = vmw_priv(crtc->dev);
741 		struct vmw_framebuffer *vfb =
742 			vmw_framebuffer_to_vfb(new_state->fb);
743 
744 		if (vfb->bo)
745 			ret = vmw_sou_plane_update_bo(dev_priv, plane,
746 						      old_state, vfb, &fence);
747 		else
748 			ret = vmw_sou_plane_update_surface(dev_priv, plane,
749 							   old_state, vfb,
750 							   &fence);
751 		if (ret != 0)
752 			DRM_ERROR("Failed to update screen.\n");
753 	} else {
754 		/* Do nothing when fb and crtc is NULL (blank crtc) */
755 		return;
756 	}
757 
758 	/* For error case vblank event is send from vmw_du_crtc_atomic_flush */
759 	event = crtc->state->event;
760 	if (event && fence) {
761 		struct drm_file *file_priv = event->base.file_priv;
762 
763 		ret = vmw_event_fence_action_queue(file_priv,
764 						   fence,
765 						   &event->base,
766 						   &event->event.vbl.tv_sec,
767 						   &event->event.vbl.tv_usec,
768 						   true);
769 
770 		if (unlikely(ret != 0))
771 			DRM_ERROR("Failed to queue event on fence.\n");
772 		else
773 			crtc->state->event = NULL;
774 	}
775 
776 	if (fence)
777 		vmw_fence_obj_unreference(&fence);
778 }
779 
780 
781 static const struct drm_plane_funcs vmw_sou_plane_funcs = {
782 	.update_plane = drm_atomic_helper_update_plane,
783 	.disable_plane = drm_atomic_helper_disable_plane,
784 	.destroy = vmw_du_primary_plane_destroy,
785 	.reset = vmw_du_plane_reset,
786 	.atomic_duplicate_state = vmw_du_plane_duplicate_state,
787 	.atomic_destroy_state = vmw_du_plane_destroy_state,
788 };
789 
790 static const struct drm_plane_funcs vmw_sou_cursor_funcs = {
791 	.update_plane = drm_atomic_helper_update_plane,
792 	.disable_plane = drm_atomic_helper_disable_plane,
793 	.destroy = vmw_du_cursor_plane_destroy,
794 	.reset = vmw_du_plane_reset,
795 	.atomic_duplicate_state = vmw_du_plane_duplicate_state,
796 	.atomic_destroy_state = vmw_du_plane_destroy_state,
797 };
798 
799 /*
800  * Atomic Helpers
801  */
802 static const struct
803 drm_plane_helper_funcs vmw_sou_cursor_plane_helper_funcs = {
804 	.atomic_check = vmw_du_cursor_plane_atomic_check,
805 	.atomic_update = vmw_du_cursor_plane_atomic_update,
806 	.prepare_fb = vmw_du_cursor_plane_prepare_fb,
807 	.cleanup_fb = vmw_du_cursor_plane_cleanup_fb,
808 };
809 
810 static const struct
811 drm_plane_helper_funcs vmw_sou_primary_plane_helper_funcs = {
812 	.atomic_check = vmw_du_primary_plane_atomic_check,
813 	.atomic_update = vmw_sou_primary_plane_atomic_update,
814 	.prepare_fb = vmw_sou_primary_plane_prepare_fb,
815 	.cleanup_fb = vmw_sou_primary_plane_cleanup_fb,
816 };
817 
818 static const struct drm_crtc_helper_funcs vmw_sou_crtc_helper_funcs = {
819 	.prepare = vmw_sou_crtc_helper_prepare,
820 	.mode_set_nofb = vmw_sou_crtc_mode_set_nofb,
821 	.atomic_check = vmw_du_crtc_atomic_check,
822 	.atomic_begin = vmw_du_crtc_atomic_begin,
823 	.atomic_flush = vmw_du_crtc_atomic_flush,
824 	.atomic_enable = vmw_sou_crtc_atomic_enable,
825 	.atomic_disable = vmw_sou_crtc_atomic_disable,
826 };
827 
828 
829 static int vmw_sou_init(struct vmw_private *dev_priv, unsigned unit)
830 {
831 	struct vmw_screen_object_unit *sou;
832 	struct drm_device *dev = &dev_priv->drm;
833 	struct drm_connector *connector;
834 	struct drm_encoder *encoder;
835 	struct drm_plane *primary;
836 	struct vmw_cursor_plane *cursor;
837 	struct drm_crtc *crtc;
838 	int ret;
839 
840 	sou = kzalloc(sizeof(*sou), GFP_KERNEL);
841 	if (!sou)
842 		return -ENOMEM;
843 
844 	sou->base.unit = unit;
845 	crtc = &sou->base.crtc;
846 	encoder = &sou->base.encoder;
847 	connector = &sou->base.connector;
848 	primary = &sou->base.primary;
849 	cursor = &sou->base.cursor;
850 
851 	sou->base.pref_active = (unit == 0);
852 	sou->base.pref_width = dev_priv->initial_width;
853 	sou->base.pref_height = dev_priv->initial_height;
854 	sou->base.pref_mode = NULL;
855 
856 	/*
857 	 * Remove this after enabling atomic because property values can
858 	 * only exist in a state object
859 	 */
860 	sou->base.is_implicit = false;
861 
862 	/* Initialize primary plane */
863 	ret = drm_universal_plane_init(dev, primary,
864 				       0, &vmw_sou_plane_funcs,
865 				       vmw_primary_plane_formats,
866 				       ARRAY_SIZE(vmw_primary_plane_formats),
867 				       NULL, DRM_PLANE_TYPE_PRIMARY, NULL);
868 	if (ret) {
869 		DRM_ERROR("Failed to initialize primary plane");
870 		goto err_free;
871 	}
872 
873 	drm_plane_helper_add(primary, &vmw_sou_primary_plane_helper_funcs);
874 	drm_plane_enable_fb_damage_clips(primary);
875 
876 	/* Initialize cursor plane */
877 	ret = drm_universal_plane_init(dev, &cursor->base,
878 			0, &vmw_sou_cursor_funcs,
879 			vmw_cursor_plane_formats,
880 			ARRAY_SIZE(vmw_cursor_plane_formats),
881 			NULL, DRM_PLANE_TYPE_CURSOR, NULL);
882 	if (ret) {
883 		DRM_ERROR("Failed to initialize cursor plane");
884 		drm_plane_cleanup(&sou->base.primary);
885 		goto err_free;
886 	}
887 
888 	drm_plane_helper_add(&cursor->base, &vmw_sou_cursor_plane_helper_funcs);
889 
890 	ret = drm_connector_init(dev, connector, &vmw_sou_connector_funcs,
891 				 DRM_MODE_CONNECTOR_VIRTUAL);
892 	if (ret) {
893 		DRM_ERROR("Failed to initialize connector\n");
894 		goto err_free;
895 	}
896 
897 	drm_connector_helper_add(connector, &vmw_sou_connector_helper_funcs);
898 	connector->status = vmw_du_connector_detect(connector, true);
899 
900 	ret = drm_encoder_init(dev, encoder, &vmw_screen_object_encoder_funcs,
901 			       DRM_MODE_ENCODER_VIRTUAL, NULL);
902 	if (ret) {
903 		DRM_ERROR("Failed to initialize encoder\n");
904 		goto err_free_connector;
905 	}
906 
907 	(void) drm_connector_attach_encoder(connector, encoder);
908 	encoder->possible_crtcs = (1 << unit);
909 	encoder->possible_clones = 0;
910 
911 	ret = drm_connector_register(connector);
912 	if (ret) {
913 		DRM_ERROR("Failed to register connector\n");
914 		goto err_free_encoder;
915 	}
916 
917 	ret = drm_crtc_init_with_planes(dev, crtc, primary,
918 					&cursor->base,
919 					&vmw_screen_object_crtc_funcs, NULL);
920 	if (ret) {
921 		DRM_ERROR("Failed to initialize CRTC\n");
922 		goto err_free_unregister;
923 	}
924 
925 	drm_crtc_helper_add(crtc, &vmw_sou_crtc_helper_funcs);
926 
927 	drm_mode_crtc_set_gamma_size(crtc, 256);
928 
929 	drm_object_attach_property(&connector->base,
930 				   dev_priv->hotplug_mode_update_property, 1);
931 	drm_object_attach_property(&connector->base,
932 				   dev->mode_config.suggested_x_property, 0);
933 	drm_object_attach_property(&connector->base,
934 				   dev->mode_config.suggested_y_property, 0);
935 	return 0;
936 
937 err_free_unregister:
938 	drm_connector_unregister(connector);
939 err_free_encoder:
940 	drm_encoder_cleanup(encoder);
941 err_free_connector:
942 	drm_connector_cleanup(connector);
943 err_free:
944 	kfree(sou);
945 	return ret;
946 }
947 
948 int vmw_kms_sou_init_display(struct vmw_private *dev_priv)
949 {
950 	struct drm_device *dev = &dev_priv->drm;
951 	int i, ret;
952 
953 	if (!(dev_priv->capabilities & SVGA_CAP_SCREEN_OBJECT_2)) {
954 		return -ENOSYS;
955 	}
956 
957 	ret = -ENOMEM;
958 
959 	ret = drm_vblank_init(dev, VMWGFX_NUM_DISPLAY_UNITS);
960 	if (unlikely(ret != 0))
961 		return ret;
962 
963 	for (i = 0; i < VMWGFX_NUM_DISPLAY_UNITS; ++i)
964 		vmw_sou_init(dev_priv, i);
965 
966 	dev_priv->active_display_unit = vmw_du_screen_object;
967 
968 	drm_mode_config_reset(dev);
969 
970 	return 0;
971 }
972 
973 static int do_bo_define_gmrfb(struct vmw_private *dev_priv,
974 				  struct vmw_framebuffer *framebuffer)
975 {
976 	struct vmw_buffer_object *buf =
977 		container_of(framebuffer, struct vmw_framebuffer_bo,
978 			     base)->buffer;
979 	int depth = framebuffer->base.format->depth;
980 	struct {
981 		uint32_t header;
982 		SVGAFifoCmdDefineGMRFB body;
983 	} *cmd;
984 
985 	/* Emulate RGBA support, contrary to svga_reg.h this is not
986 	 * supported by hosts. This is only a problem if we are reading
987 	 * this value later and expecting what we uploaded back.
988 	 */
989 	if (depth == 32)
990 		depth = 24;
991 
992 	cmd = VMW_CMD_RESERVE(dev_priv, sizeof(*cmd));
993 	if (!cmd)
994 		return -ENOMEM;
995 
996 	cmd->header = SVGA_CMD_DEFINE_GMRFB;
997 	cmd->body.format.bitsPerPixel = framebuffer->base.format->cpp[0] * 8;
998 	cmd->body.format.colorDepth = depth;
999 	cmd->body.format.reserved = 0;
1000 	cmd->body.bytesPerLine = framebuffer->base.pitches[0];
1001 	/* Buffer is reserved in vram or GMR */
1002 	vmw_bo_get_guest_ptr(&buf->base, &cmd->body.ptr);
1003 	vmw_cmd_commit(dev_priv, sizeof(*cmd));
1004 
1005 	return 0;
1006 }
1007 
1008 /**
1009  * vmw_sou_surface_fifo_commit - Callback to fill in and submit a
1010  * blit surface to screen command.
1011  *
1012  * @dirty: The closure structure.
1013  *
1014  * Fills in the missing fields in the command, and translates the cliprects
1015  * to match the destination bounding box encoded.
1016  */
1017 static void vmw_sou_surface_fifo_commit(struct vmw_kms_dirty *dirty)
1018 {
1019 	struct vmw_kms_sou_surface_dirty *sdirty =
1020 		container_of(dirty, typeof(*sdirty), base);
1021 	struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
1022 	s32 trans_x = dirty->unit->crtc.x - sdirty->dst_x;
1023 	s32 trans_y = dirty->unit->crtc.y - sdirty->dst_y;
1024 	size_t region_size = dirty->num_hits * sizeof(SVGASignedRect);
1025 	SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];
1026 	int i;
1027 
1028 	if (!dirty->num_hits) {
1029 		vmw_cmd_commit(dirty->dev_priv, 0);
1030 		return;
1031 	}
1032 
1033 	cmd->header.id = SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN;
1034 	cmd->header.size = sizeof(cmd->body) + region_size;
1035 
1036 	/*
1037 	 * Use the destination bounding box to specify destination - and
1038 	 * source bounding regions.
1039 	 */
1040 	cmd->body.destRect.left = sdirty->left;
1041 	cmd->body.destRect.right = sdirty->right;
1042 	cmd->body.destRect.top = sdirty->top;
1043 	cmd->body.destRect.bottom = sdirty->bottom;
1044 
1045 	cmd->body.srcRect.left = sdirty->left + trans_x;
1046 	cmd->body.srcRect.right = sdirty->right + trans_x;
1047 	cmd->body.srcRect.top = sdirty->top + trans_y;
1048 	cmd->body.srcRect.bottom = sdirty->bottom + trans_y;
1049 
1050 	cmd->body.srcImage.sid = sdirty->sid;
1051 	cmd->body.destScreenId = dirty->unit->unit;
1052 
1053 	/* Blits are relative to the destination rect. Translate. */
1054 	for (i = 0; i < dirty->num_hits; ++i, ++blit) {
1055 		blit->left -= sdirty->left;
1056 		blit->right -= sdirty->left;
1057 		blit->top -= sdirty->top;
1058 		blit->bottom -= sdirty->top;
1059 	}
1060 
1061 	vmw_cmd_commit(dirty->dev_priv, region_size + sizeof(*cmd));
1062 
1063 	sdirty->left = sdirty->top = S32_MAX;
1064 	sdirty->right = sdirty->bottom = S32_MIN;
1065 }
1066 
1067 /**
1068  * vmw_sou_surface_clip - Callback to encode a blit surface to screen cliprect.
1069  *
1070  * @dirty: The closure structure
1071  *
1072  * Encodes a SVGASignedRect cliprect and updates the bounding box of the
1073  * BLIT_SURFACE_TO_SCREEN command.
1074  */
1075 static void vmw_sou_surface_clip(struct vmw_kms_dirty *dirty)
1076 {
1077 	struct vmw_kms_sou_surface_dirty *sdirty =
1078 		container_of(dirty, typeof(*sdirty), base);
1079 	struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
1080 	SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];
1081 
1082 	/* Destination rect. */
1083 	blit += dirty->num_hits;
1084 	blit->left = dirty->unit_x1;
1085 	blit->top = dirty->unit_y1;
1086 	blit->right = dirty->unit_x2;
1087 	blit->bottom = dirty->unit_y2;
1088 
1089 	/* Destination bounding box */
1090 	sdirty->left = min_t(s32, sdirty->left, dirty->unit_x1);
1091 	sdirty->top = min_t(s32, sdirty->top, dirty->unit_y1);
1092 	sdirty->right = max_t(s32, sdirty->right, dirty->unit_x2);
1093 	sdirty->bottom = max_t(s32, sdirty->bottom, dirty->unit_y2);
1094 
1095 	dirty->num_hits++;
1096 }
1097 
1098 /**
1099  * vmw_kms_sou_do_surface_dirty - Dirty part of a surface backed framebuffer
1100  *
1101  * @dev_priv: Pointer to the device private structure.
1102  * @framebuffer: Pointer to the surface-buffer backed framebuffer.
1103  * @clips: Array of clip rects. Either @clips or @vclips must be NULL.
1104  * @vclips: Alternate array of clip rects. Either @clips or @vclips must
1105  * be NULL.
1106  * @srf: Pointer to surface to blit from. If NULL, the surface attached
1107  * to @framebuffer will be used.
1108  * @dest_x: X coordinate offset to align @srf with framebuffer coordinates.
1109  * @dest_y: Y coordinate offset to align @srf with framebuffer coordinates.
1110  * @num_clips: Number of clip rects in @clips.
1111  * @inc: Increment to use when looping over @clips.
1112  * @out_fence: If non-NULL, will return a ref-counted pointer to a
1113  * struct vmw_fence_obj. The returned fence pointer may be NULL in which
1114  * case the device has already synchronized.
1115  * @crtc: If crtc is passed, perform surface dirty on that crtc only.
1116  *
1117  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1118  * interrupted.
1119  */
1120 int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
1121 				 struct vmw_framebuffer *framebuffer,
1122 				 struct drm_clip_rect *clips,
1123 				 struct drm_vmw_rect *vclips,
1124 				 struct vmw_resource *srf,
1125 				 s32 dest_x,
1126 				 s32 dest_y,
1127 				 unsigned num_clips, int inc,
1128 				 struct vmw_fence_obj **out_fence,
1129 				 struct drm_crtc *crtc)
1130 {
1131 	struct vmw_framebuffer_surface *vfbs =
1132 		container_of(framebuffer, typeof(*vfbs), base);
1133 	struct vmw_kms_sou_surface_dirty sdirty;
1134 	DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
1135 	int ret;
1136 
1137 	if (!srf)
1138 		srf = &vfbs->surface->res;
1139 
1140 	ret = vmw_validation_add_resource(&val_ctx, srf, 0, VMW_RES_DIRTY_NONE,
1141 					  NULL, NULL);
1142 	if (ret)
1143 		return ret;
1144 
1145 	ret = vmw_validation_prepare(&val_ctx, &dev_priv->cmdbuf_mutex, true);
1146 	if (ret)
1147 		goto out_unref;
1148 
1149 	sdirty.base.fifo_commit = vmw_sou_surface_fifo_commit;
1150 	sdirty.base.clip = vmw_sou_surface_clip;
1151 	sdirty.base.dev_priv = dev_priv;
1152 	sdirty.base.fifo_reserve_size = sizeof(struct vmw_kms_sou_dirty_cmd) +
1153 	  sizeof(SVGASignedRect) * num_clips;
1154 	sdirty.base.crtc = crtc;
1155 
1156 	sdirty.sid = srf->id;
1157 	sdirty.left = sdirty.top = S32_MAX;
1158 	sdirty.right = sdirty.bottom = S32_MIN;
1159 	sdirty.dst_x = dest_x;
1160 	sdirty.dst_y = dest_y;
1161 
1162 	ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
1163 				   dest_x, dest_y, num_clips, inc,
1164 				   &sdirty.base);
1165 	vmw_kms_helper_validation_finish(dev_priv, NULL, &val_ctx, out_fence,
1166 					 NULL);
1167 
1168 	return ret;
1169 
1170 out_unref:
1171 	vmw_validation_unref_lists(&val_ctx);
1172 	return ret;
1173 }
1174 
1175 /**
1176  * vmw_sou_bo_fifo_commit - Callback to submit a set of readback clips.
1177  *
1178  * @dirty: The closure structure.
1179  *
1180  * Commits a previously built command buffer of readback clips.
1181  */
1182 static void vmw_sou_bo_fifo_commit(struct vmw_kms_dirty *dirty)
1183 {
1184 	if (!dirty->num_hits) {
1185 		vmw_cmd_commit(dirty->dev_priv, 0);
1186 		return;
1187 	}
1188 
1189 	vmw_cmd_commit(dirty->dev_priv,
1190 			sizeof(struct vmw_kms_sou_bo_blit) *
1191 			dirty->num_hits);
1192 }
1193 
1194 /**
1195  * vmw_sou_bo_clip - Callback to encode a readback cliprect.
1196  *
1197  * @dirty: The closure structure
1198  *
1199  * Encodes a BLIT_GMRFB_TO_SCREEN cliprect.
1200  */
1201 static void vmw_sou_bo_clip(struct vmw_kms_dirty *dirty)
1202 {
1203 	struct vmw_kms_sou_bo_blit *blit = dirty->cmd;
1204 
1205 	blit += dirty->num_hits;
1206 	blit->header = SVGA_CMD_BLIT_GMRFB_TO_SCREEN;
1207 	blit->body.destScreenId = dirty->unit->unit;
1208 	blit->body.srcOrigin.x = dirty->fb_x;
1209 	blit->body.srcOrigin.y = dirty->fb_y;
1210 	blit->body.destRect.left = dirty->unit_x1;
1211 	blit->body.destRect.top = dirty->unit_y1;
1212 	blit->body.destRect.right = dirty->unit_x2;
1213 	blit->body.destRect.bottom = dirty->unit_y2;
1214 	dirty->num_hits++;
1215 }
1216 
1217 /**
1218  * vmw_kms_sou_do_bo_dirty - Dirty part of a buffer-object backed framebuffer
1219  *
1220  * @dev_priv: Pointer to the device private structure.
1221  * @framebuffer: Pointer to the buffer-object backed framebuffer.
1222  * @clips: Array of clip rects.
1223  * @vclips: Alternate array of clip rects. Either @clips or @vclips must
1224  * be NULL.
1225  * @num_clips: Number of clip rects in @clips.
1226  * @increment: Increment to use when looping over @clips.
1227  * @interruptible: Whether to perform waits interruptible if possible.
1228  * @out_fence: If non-NULL, will return a ref-counted pointer to a
1229  * struct vmw_fence_obj. The returned fence pointer may be NULL in which
1230  * case the device has already synchronized.
1231  * @crtc: If crtc is passed, perform bo dirty on that crtc only.
1232  *
1233  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1234  * interrupted.
1235  */
1236 int vmw_kms_sou_do_bo_dirty(struct vmw_private *dev_priv,
1237 				struct vmw_framebuffer *framebuffer,
1238 				struct drm_clip_rect *clips,
1239 				struct drm_vmw_rect *vclips,
1240 				unsigned num_clips, int increment,
1241 				bool interruptible,
1242 				struct vmw_fence_obj **out_fence,
1243 				struct drm_crtc *crtc)
1244 {
1245 	struct vmw_buffer_object *buf =
1246 		container_of(framebuffer, struct vmw_framebuffer_bo,
1247 			     base)->buffer;
1248 	struct vmw_kms_dirty dirty;
1249 	DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
1250 	int ret;
1251 
1252 	ret = vmw_validation_add_bo(&val_ctx, buf, false, false);
1253 	if (ret)
1254 		return ret;
1255 
1256 	ret = vmw_validation_prepare(&val_ctx, NULL, interruptible);
1257 	if (ret)
1258 		goto out_unref;
1259 
1260 	ret = do_bo_define_gmrfb(dev_priv, framebuffer);
1261 	if (unlikely(ret != 0))
1262 		goto out_revert;
1263 
1264 	dirty.crtc = crtc;
1265 	dirty.fifo_commit = vmw_sou_bo_fifo_commit;
1266 	dirty.clip = vmw_sou_bo_clip;
1267 	dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_bo_blit) *
1268 		num_clips;
1269 	ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
1270 				   0, 0, num_clips, increment, &dirty);
1271 	vmw_kms_helper_validation_finish(dev_priv, NULL, &val_ctx, out_fence,
1272 					 NULL);
1273 
1274 	return ret;
1275 
1276 out_revert:
1277 	vmw_validation_revert(&val_ctx);
1278 out_unref:
1279 	vmw_validation_unref_lists(&val_ctx);
1280 
1281 	return ret;
1282 }
1283 
1284 
1285 /**
1286  * vmw_sou_readback_fifo_commit - Callback to submit a set of readback clips.
1287  *
1288  * @dirty: The closure structure.
1289  *
1290  * Commits a previously built command buffer of readback clips.
1291  */
1292 static void vmw_sou_readback_fifo_commit(struct vmw_kms_dirty *dirty)
1293 {
1294 	if (!dirty->num_hits) {
1295 		vmw_cmd_commit(dirty->dev_priv, 0);
1296 		return;
1297 	}
1298 
1299 	vmw_cmd_commit(dirty->dev_priv,
1300 			sizeof(struct vmw_kms_sou_readback_blit) *
1301 			dirty->num_hits);
1302 }
1303 
1304 /**
1305  * vmw_sou_readback_clip - Callback to encode a readback cliprect.
1306  *
1307  * @dirty: The closure structure
1308  *
1309  * Encodes a BLIT_SCREEN_TO_GMRFB cliprect.
1310  */
1311 static void vmw_sou_readback_clip(struct vmw_kms_dirty *dirty)
1312 {
1313 	struct vmw_kms_sou_readback_blit *blit = dirty->cmd;
1314 
1315 	blit += dirty->num_hits;
1316 	blit->header = SVGA_CMD_BLIT_SCREEN_TO_GMRFB;
1317 	blit->body.srcScreenId = dirty->unit->unit;
1318 	blit->body.destOrigin.x = dirty->fb_x;
1319 	blit->body.destOrigin.y = dirty->fb_y;
1320 	blit->body.srcRect.left = dirty->unit_x1;
1321 	blit->body.srcRect.top = dirty->unit_y1;
1322 	blit->body.srcRect.right = dirty->unit_x2;
1323 	blit->body.srcRect.bottom = dirty->unit_y2;
1324 	dirty->num_hits++;
1325 }
1326 
1327 /**
1328  * vmw_kms_sou_readback - Perform a readback from the screen object system to
1329  * a buffer-object backed framebuffer.
1330  *
1331  * @dev_priv: Pointer to the device private structure.
1332  * @file_priv: Pointer to a struct drm_file identifying the caller.
1333  * Must be set to NULL if @user_fence_rep is NULL.
1334  * @vfb: Pointer to the buffer-object backed framebuffer.
1335  * @user_fence_rep: User-space provided structure for fence information.
1336  * Must be set to non-NULL if @file_priv is non-NULL.
1337  * @vclips: Array of clip rects.
1338  * @num_clips: Number of clip rects in @vclips.
1339  * @crtc: If crtc is passed, readback on that crtc only.
1340  *
1341  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1342  * interrupted.
1343  */
1344 int vmw_kms_sou_readback(struct vmw_private *dev_priv,
1345 			 struct drm_file *file_priv,
1346 			 struct vmw_framebuffer *vfb,
1347 			 struct drm_vmw_fence_rep __user *user_fence_rep,
1348 			 struct drm_vmw_rect *vclips,
1349 			 uint32_t num_clips,
1350 			 struct drm_crtc *crtc)
1351 {
1352 	struct vmw_buffer_object *buf =
1353 		container_of(vfb, struct vmw_framebuffer_bo, base)->buffer;
1354 	struct vmw_kms_dirty dirty;
1355 	DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
1356 	int ret;
1357 
1358 	ret = vmw_validation_add_bo(&val_ctx, buf, false, false);
1359 	if (ret)
1360 		return ret;
1361 
1362 	ret = vmw_validation_prepare(&val_ctx, NULL, true);
1363 	if (ret)
1364 		goto out_unref;
1365 
1366 	ret = do_bo_define_gmrfb(dev_priv, vfb);
1367 	if (unlikely(ret != 0))
1368 		goto out_revert;
1369 
1370 	dirty.crtc = crtc;
1371 	dirty.fifo_commit = vmw_sou_readback_fifo_commit;
1372 	dirty.clip = vmw_sou_readback_clip;
1373 	dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_readback_blit) *
1374 		num_clips;
1375 	ret = vmw_kms_helper_dirty(dev_priv, vfb, NULL, vclips,
1376 				   0, 0, num_clips, 1, &dirty);
1377 	vmw_kms_helper_validation_finish(dev_priv, file_priv, &val_ctx, NULL,
1378 					 user_fence_rep);
1379 
1380 	return ret;
1381 
1382 out_revert:
1383 	vmw_validation_revert(&val_ctx);
1384 out_unref:
1385 	vmw_validation_unref_lists(&val_ctx);
1386 
1387 	return ret;
1388 }
1389