1// SPDX-License-Identifier: GPL-2.0 OR MIT
2/**************************************************************************
3 *
4 * Copyright 2011-2015 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 */
56struct 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 */
67struct vmw_kms_sou_readback_blit {
68	uint32 header;
69	SVGAFifoCmdBlitScreenToGMRFB body;
70};
71
72struct vmw_kms_sou_bo_blit {
73	uint32 header;
74	SVGAFifoCmdBlitGMRFBToScreen body;
75};
76
77struct vmw_kms_sou_dirty_cmd {
78	SVGA3dCmdHeader header;
79	SVGA3dCmdBlitSurfaceToScreen body;
80};
81
82struct vmw_kms_sou_define_gmrfb {
83	uint32_t header;
84	SVGAFifoCmdDefineGMRFB body;
85};
86
87/**
88 * Display unit using screen objects.
89 */
90struct 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
99static 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
110static 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 */
118static 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_FIFO_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_fifo_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 */
166static 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_FIFO_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_fifo_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 */
212static 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 */
270static 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 *
279 * This is called after a mode set has been completed.
280 */
281static void vmw_sou_crtc_atomic_enable(struct drm_crtc *crtc,
282				       struct drm_crtc_state *old_state)
283{
284}
285
286/**
287 * vmw_sou_crtc_atomic_disable - Turns off CRTC
288 *
289 * @crtc: CRTC to be turned off
290 */
291static void vmw_sou_crtc_atomic_disable(struct drm_crtc *crtc,
292					struct drm_crtc_state *old_state)
293{
294	struct vmw_private *dev_priv;
295	struct vmw_screen_object_unit *sou;
296	int ret;
297
298
299	if (!crtc) {
300		DRM_ERROR("CRTC is NULL\n");
301		return;
302	}
303
304	sou = vmw_crtc_to_sou(crtc);
305	dev_priv = vmw_priv(crtc->dev);
306
307	if (sou->defined) {
308		ret = vmw_sou_fifo_destroy(dev_priv, sou);
309		if (ret)
310			DRM_ERROR("Failed to destroy Screen Object\n");
311	}
312}
313
314static const struct drm_crtc_funcs vmw_screen_object_crtc_funcs = {
315	.gamma_set = vmw_du_crtc_gamma_set,
316	.destroy = vmw_sou_crtc_destroy,
317	.reset = vmw_du_crtc_reset,
318	.atomic_duplicate_state = vmw_du_crtc_duplicate_state,
319	.atomic_destroy_state = vmw_du_crtc_destroy_state,
320	.set_config = drm_atomic_helper_set_config,
321	.page_flip = drm_atomic_helper_page_flip,
322	.get_vblank_counter = vmw_get_vblank_counter,
323	.enable_vblank = vmw_enable_vblank,
324	.disable_vblank = vmw_disable_vblank,
325};
326
327/*
328 * Screen Object Display Unit encoder functions
329 */
330
331static void vmw_sou_encoder_destroy(struct drm_encoder *encoder)
332{
333	vmw_sou_destroy(vmw_encoder_to_sou(encoder));
334}
335
336static const struct drm_encoder_funcs vmw_screen_object_encoder_funcs = {
337	.destroy = vmw_sou_encoder_destroy,
338};
339
340/*
341 * Screen Object Display Unit connector functions
342 */
343
344static void vmw_sou_connector_destroy(struct drm_connector *connector)
345{
346	vmw_sou_destroy(vmw_connector_to_sou(connector));
347}
348
349static const struct drm_connector_funcs vmw_sou_connector_funcs = {
350	.dpms = vmw_du_connector_dpms,
351	.detect = vmw_du_connector_detect,
352	.fill_modes = vmw_du_connector_fill_modes,
353	.destroy = vmw_sou_connector_destroy,
354	.reset = vmw_du_connector_reset,
355	.atomic_duplicate_state = vmw_du_connector_duplicate_state,
356	.atomic_destroy_state = vmw_du_connector_destroy_state,
357};
358
359
360static const struct
361drm_connector_helper_funcs vmw_sou_connector_helper_funcs = {
362};
363
364
365
366/*
367 * Screen Object Display Plane Functions
368 */
369
370/**
371 * vmw_sou_primary_plane_cleanup_fb - Frees sou backing buffer
372 *
373 * @plane:  display plane
374 * @old_state: Contains the FB to clean up
375 *
376 * Unpins the display surface
377 *
378 * Returns 0 on success
379 */
380static void
381vmw_sou_primary_plane_cleanup_fb(struct drm_plane *plane,
382				 struct drm_plane_state *old_state)
383{
384	struct vmw_plane_state *vps = vmw_plane_state_to_vps(old_state);
385	struct drm_crtc *crtc = plane->state->crtc ?
386		plane->state->crtc : old_state->crtc;
387
388	if (vps->bo)
389		vmw_bo_unpin(vmw_priv(crtc->dev), vps->bo, false);
390	vmw_bo_unreference(&vps->bo);
391	vps->bo_size = 0;
392
393	vmw_du_plane_cleanup_fb(plane, old_state);
394}
395
396
397/**
398 * vmw_sou_primary_plane_prepare_fb - allocate backing buffer
399 *
400 * @plane:  display plane
401 * @new_state: info on the new plane state, including the FB
402 *
403 * The SOU backing buffer is our equivalent of the display plane.
404 *
405 * Returns 0 on success
406 */
407static int
408vmw_sou_primary_plane_prepare_fb(struct drm_plane *plane,
409				 struct drm_plane_state *new_state)
410{
411	struct drm_framebuffer *new_fb = new_state->fb;
412	struct drm_crtc *crtc = plane->state->crtc ?: new_state->crtc;
413	struct vmw_plane_state *vps = vmw_plane_state_to_vps(new_state);
414	struct vmw_private *dev_priv;
415	size_t size;
416	int ret;
417
418
419	if (!new_fb) {
420		vmw_bo_unreference(&vps->bo);
421		vps->bo_size = 0;
422
423		return 0;
424	}
425
426	size = new_state->crtc_w * new_state->crtc_h * 4;
427	dev_priv = vmw_priv(crtc->dev);
428
429	if (vps->bo) {
430		if (vps->bo_size == size) {
431			/*
432			 * Note that this might temporarily up the pin-count
433			 * to 2, until cleanup_fb() is called.
434			 */
435			return vmw_bo_pin_in_vram(dev_priv, vps->bo,
436						      true);
437		}
438
439		vmw_bo_unreference(&vps->bo);
440		vps->bo_size = 0;
441	}
442
443	vps->bo = kzalloc(sizeof(*vps->bo), GFP_KERNEL);
444	if (!vps->bo)
445		return -ENOMEM;
446
447	vmw_svga_enable(dev_priv);
448
449	/* After we have alloced the backing store might not be able to
450	 * resume the overlays, this is preferred to failing to alloc.
451	 */
452	vmw_overlay_pause_all(dev_priv);
453	ret = vmw_bo_init(dev_priv, vps->bo, size,
454			      &vmw_vram_ne_placement,
455			      false, &vmw_bo_bo_free);
456	vmw_overlay_resume_all(dev_priv);
457	if (ret) {
458		vps->bo = NULL; /* vmw_bo_init frees on error */
459		return ret;
460	}
461
462	vps->bo_size = size;
463
464	/*
465	 * TTM already thinks the buffer is pinned, but make sure the
466	 * pin_count is upped.
467	 */
468	return vmw_bo_pin_in_vram(dev_priv, vps->bo, true);
469}
470
471static uint32_t vmw_sou_bo_fifo_size(struct vmw_du_update_plane *update,
472				     uint32_t num_hits)
473{
474	return sizeof(struct vmw_kms_sou_define_gmrfb) +
475		sizeof(struct vmw_kms_sou_bo_blit) * num_hits;
476}
477
478static uint32_t vmw_sou_bo_define_gmrfb(struct vmw_du_update_plane *update,
479					void *cmd)
480{
481	struct vmw_framebuffer_bo *vfbbo =
482		container_of(update->vfb, typeof(*vfbbo), base);
483	struct vmw_kms_sou_define_gmrfb *gmr = cmd;
484	int depth = update->vfb->base.format->depth;
485
486	/* Emulate RGBA support, contrary to svga_reg.h this is not
487	 * supported by hosts. This is only a problem if we are reading
488	 * this value later and expecting what we uploaded back.
489	 */
490	if (depth == 32)
491		depth = 24;
492
493	gmr->header = SVGA_CMD_DEFINE_GMRFB;
494
495	gmr->body.format.bitsPerPixel = update->vfb->base.format->cpp[0] * 8;
496	gmr->body.format.colorDepth = depth;
497	gmr->body.format.reserved = 0;
498	gmr->body.bytesPerLine = update->vfb->base.pitches[0];
499	vmw_bo_get_guest_ptr(&vfbbo->buffer->base, &gmr->body.ptr);
500
501	return sizeof(*gmr);
502}
503
504static uint32_t vmw_sou_bo_populate_clip(struct vmw_du_update_plane  *update,
505					 void *cmd, struct drm_rect *clip,
506					 uint32_t fb_x, uint32_t fb_y)
507{
508	struct vmw_kms_sou_bo_blit *blit = cmd;
509
510	blit->header = SVGA_CMD_BLIT_GMRFB_TO_SCREEN;
511	blit->body.destScreenId = update->du->unit;
512	blit->body.srcOrigin.x = fb_x;
513	blit->body.srcOrigin.y = fb_y;
514	blit->body.destRect.left = clip->x1;
515	blit->body.destRect.top = clip->y1;
516	blit->body.destRect.right = clip->x2;
517	blit->body.destRect.bottom = clip->y2;
518
519	return sizeof(*blit);
520}
521
522static uint32_t vmw_stud_bo_post_clip(struct vmw_du_update_plane  *update,
523				      void *cmd, struct drm_rect *bb)
524{
525	return 0;
526}
527
528/**
529 * vmw_sou_plane_update_bo - Update display unit for bo backed fb.
530 * @dev_priv: Device private.
531 * @plane: Plane state.
532 * @old_state: Old plane state.
533 * @vfb: Framebuffer which is blitted to display unit.
534 * @out_fence: If non-NULL, will return a ref-counted pointer to vmw_fence_obj.
535 *             The returned fence pointer may be NULL in which case the device
536 *             has already synchronized.
537 *
538 * Return: 0 on success or a negative error code on failure.
539 */
540static int vmw_sou_plane_update_bo(struct vmw_private *dev_priv,
541				   struct drm_plane *plane,
542				   struct drm_plane_state *old_state,
543				   struct vmw_framebuffer *vfb,
544				   struct vmw_fence_obj **out_fence)
545{
546	struct vmw_du_update_plane_buffer bo_update;
547
548	memset(&bo_update, 0, sizeof(struct vmw_du_update_plane_buffer));
549	bo_update.base.plane = plane;
550	bo_update.base.old_state = old_state;
551	bo_update.base.dev_priv = dev_priv;
552	bo_update.base.du = vmw_crtc_to_du(plane->state->crtc);
553	bo_update.base.vfb = vfb;
554	bo_update.base.out_fence = out_fence;
555	bo_update.base.mutex = NULL;
556	bo_update.base.cpu_blit = false;
557	bo_update.base.intr = true;
558
559	bo_update.base.calc_fifo_size = vmw_sou_bo_fifo_size;
560	bo_update.base.post_prepare = vmw_sou_bo_define_gmrfb;
561	bo_update.base.clip = vmw_sou_bo_populate_clip;
562	bo_update.base.post_clip = vmw_stud_bo_post_clip;
563
564	return vmw_du_helper_plane_update(&bo_update.base);
565}
566
567static uint32_t vmw_sou_surface_fifo_size(struct vmw_du_update_plane *update,
568					  uint32_t num_hits)
569{
570	return sizeof(struct vmw_kms_sou_dirty_cmd) + sizeof(SVGASignedRect) *
571		num_hits;
572}
573
574static uint32_t vmw_sou_surface_post_prepare(struct vmw_du_update_plane *update,
575					     void *cmd)
576{
577	struct vmw_du_update_plane_surface *srf_update;
578
579	srf_update = container_of(update, typeof(*srf_update), base);
580
581	/*
582	 * SOU SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN is special in the sense that
583	 * its bounding box is filled before iterating over all the clips. So
584	 * store the FIFO start address and revisit to fill the details.
585	 */
586	srf_update->cmd_start = cmd;
587
588	return 0;
589}
590
591static uint32_t vmw_sou_surface_pre_clip(struct vmw_du_update_plane *update,
592					 void *cmd, uint32_t num_hits)
593{
594	struct vmw_kms_sou_dirty_cmd *blit = cmd;
595	struct vmw_framebuffer_surface *vfbs;
596
597	vfbs = container_of(update->vfb, typeof(*vfbs), base);
598
599	blit->header.id = SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN;
600	blit->header.size = sizeof(blit->body) + sizeof(SVGASignedRect) *
601		num_hits;
602
603	blit->body.srcImage.sid = vfbs->surface->res.id;
604	blit->body.destScreenId = update->du->unit;
605
606	/* Update the source and destination bounding box later in post_clip */
607	blit->body.srcRect.left = 0;
608	blit->body.srcRect.top = 0;
609	blit->body.srcRect.right = 0;
610	blit->body.srcRect.bottom = 0;
611
612	blit->body.destRect.left = 0;
613	blit->body.destRect.top = 0;
614	blit->body.destRect.right = 0;
615	blit->body.destRect.bottom = 0;
616
617	return sizeof(*blit);
618}
619
620static uint32_t vmw_sou_surface_clip_rect(struct vmw_du_update_plane *update,
621					  void *cmd, struct drm_rect *clip,
622					  uint32_t src_x, uint32_t src_y)
623{
624	SVGASignedRect *rect = cmd;
625
626	/*
627	 * rects are relative to dest bounding box rect on screen object, so
628	 * translate to it later in post_clip
629	 */
630	rect->left = clip->x1;
631	rect->top = clip->y1;
632	rect->right = clip->x2;
633	rect->bottom = clip->y2;
634
635	return sizeof(*rect);
636}
637
638static uint32_t vmw_sou_surface_post_clip(struct vmw_du_update_plane *update,
639					  void *cmd, struct drm_rect *bb)
640{
641	struct vmw_du_update_plane_surface *srf_update;
642	struct drm_plane_state *state = update->plane->state;
643	struct drm_rect src_bb;
644	struct vmw_kms_sou_dirty_cmd *blit;
645	SVGASignedRect *rect;
646	uint32_t num_hits;
647	int translate_src_x;
648	int translate_src_y;
649	int i;
650
651	srf_update = container_of(update, typeof(*srf_update), base);
652
653	blit = srf_update->cmd_start;
654	rect = (SVGASignedRect *)&blit[1];
655
656	num_hits = (blit->header.size - sizeof(blit->body))/
657		sizeof(SVGASignedRect);
658
659	src_bb = *bb;
660
661	/* To translate bb back to fb src coord */
662	translate_src_x = (state->src_x >> 16) - state->crtc_x;
663	translate_src_y = (state->src_y >> 16) - state->crtc_y;
664
665	drm_rect_translate(&src_bb, translate_src_x, translate_src_y);
666
667	blit->body.srcRect.left = src_bb.x1;
668	blit->body.srcRect.top = src_bb.y1;
669	blit->body.srcRect.right = src_bb.x2;
670	blit->body.srcRect.bottom = src_bb.y2;
671
672	blit->body.destRect.left = bb->x1;
673	blit->body.destRect.top = bb->y1;
674	blit->body.destRect.right = bb->x2;
675	blit->body.destRect.bottom = bb->y2;
676
677	/* rects are relative to dest bb rect */
678	for (i = 0; i < num_hits; i++) {
679		rect->left -= bb->x1;
680		rect->top -= bb->y1;
681		rect->right -= bb->x1;
682		rect->bottom -= bb->y1;
683		rect++;
684	}
685
686	return 0;
687}
688
689/**
690 * vmw_sou_plane_update_surface - Update display unit for surface backed fb.
691 * @dev_priv: Device private.
692 * @plane: Plane state.
693 * @old_state: Old plane state.
694 * @vfb: Framebuffer which is blitted to display unit
695 * @out_fence: If non-NULL, will return a ref-counted pointer to vmw_fence_obj.
696 *             The returned fence pointer may be NULL in which case the device
697 *             has already synchronized.
698 *
699 * Return: 0 on success or a negative error code on failure.
700 */
701static int vmw_sou_plane_update_surface(struct vmw_private *dev_priv,
702					struct drm_plane *plane,
703					struct drm_plane_state *old_state,
704					struct vmw_framebuffer *vfb,
705					struct vmw_fence_obj **out_fence)
706{
707	struct vmw_du_update_plane_surface srf_update;
708
709	memset(&srf_update, 0, sizeof(struct vmw_du_update_plane_surface));
710	srf_update.base.plane = plane;
711	srf_update.base.old_state = old_state;
712	srf_update.base.dev_priv = dev_priv;
713	srf_update.base.du = vmw_crtc_to_du(plane->state->crtc);
714	srf_update.base.vfb = vfb;
715	srf_update.base.out_fence = out_fence;
716	srf_update.base.mutex = &dev_priv->cmdbuf_mutex;
717	srf_update.base.cpu_blit = false;
718	srf_update.base.intr = true;
719
720	srf_update.base.calc_fifo_size = vmw_sou_surface_fifo_size;
721	srf_update.base.post_prepare = vmw_sou_surface_post_prepare;
722	srf_update.base.pre_clip = vmw_sou_surface_pre_clip;
723	srf_update.base.clip = vmw_sou_surface_clip_rect;
724	srf_update.base.post_clip = vmw_sou_surface_post_clip;
725
726	return vmw_du_helper_plane_update(&srf_update.base);
727}
728
729static void
730vmw_sou_primary_plane_atomic_update(struct drm_plane *plane,
731				    struct drm_plane_state *old_state)
732{
733	struct drm_crtc *crtc = plane->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 && plane->state->fb) {
740		struct vmw_private *dev_priv = vmw_priv(crtc->dev);
741		struct vmw_framebuffer *vfb =
742			vmw_framebuffer_to_vfb(plane->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
781static 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
790static 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 */
802static const struct
803drm_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_plane_cleanup_fb,
808};
809
810static const struct
811drm_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
818static 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
829static 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->dev;
833	struct drm_connector *connector;
834	struct drm_encoder *encoder;
835	struct drm_plane *primary, *cursor;
836	struct drm_crtc *crtc;
837	int ret;
838
839	sou = kzalloc(sizeof(*sou), GFP_KERNEL);
840	if (!sou)
841		return -ENOMEM;
842
843	sou->base.unit = unit;
844	crtc = &sou->base.crtc;
845	encoder = &sou->base.encoder;
846	connector = &sou->base.connector;
847	primary = &sou->base.primary;
848	cursor = &sou->base.cursor;
849
850	sou->base.pref_active = (unit == 0);
851	sou->base.pref_width = dev_priv->initial_width;
852	sou->base.pref_height = dev_priv->initial_height;
853	sou->base.pref_mode = NULL;
854
855	/*
856	 * Remove this after enabling atomic because property values can
857	 * only exist in a state object
858	 */
859	sou->base.is_implicit = false;
860
861	/* Initialize primary plane */
862	ret = drm_universal_plane_init(dev, &sou->base.primary,
863				       0, &vmw_sou_plane_funcs,
864				       vmw_primary_plane_formats,
865				       ARRAY_SIZE(vmw_primary_plane_formats),
866				       NULL, DRM_PLANE_TYPE_PRIMARY, NULL);
867	if (ret) {
868		DRM_ERROR("Failed to initialize primary plane");
869		goto err_free;
870	}
871
872	drm_plane_helper_add(primary, &vmw_sou_primary_plane_helper_funcs);
873	drm_plane_enable_fb_damage_clips(primary);
874
875	/* Initialize cursor plane */
876	ret = drm_universal_plane_init(dev, &sou->base.cursor,
877			0, &vmw_sou_cursor_funcs,
878			vmw_cursor_plane_formats,
879			ARRAY_SIZE(vmw_cursor_plane_formats),
880			NULL, DRM_PLANE_TYPE_CURSOR, NULL);
881	if (ret) {
882		DRM_ERROR("Failed to initialize cursor plane");
883		drm_plane_cleanup(&sou->base.primary);
884		goto err_free;
885	}
886
887	drm_plane_helper_add(cursor, &vmw_sou_cursor_plane_helper_funcs);
888
889	ret = drm_connector_init(dev, connector, &vmw_sou_connector_funcs,
890				 DRM_MODE_CONNECTOR_VIRTUAL);
891	if (ret) {
892		DRM_ERROR("Failed to initialize connector\n");
893		goto err_free;
894	}
895
896	drm_connector_helper_add(connector, &vmw_sou_connector_helper_funcs);
897	connector->status = vmw_du_connector_detect(connector, true);
898
899	ret = drm_encoder_init(dev, encoder, &vmw_screen_object_encoder_funcs,
900			       DRM_MODE_ENCODER_VIRTUAL, NULL);
901	if (ret) {
902		DRM_ERROR("Failed to initialize encoder\n");
903		goto err_free_connector;
904	}
905
906	(void) drm_connector_attach_encoder(connector, encoder);
907	encoder->possible_crtcs = (1 << unit);
908	encoder->possible_clones = 0;
909
910	ret = drm_connector_register(connector);
911	if (ret) {
912		DRM_ERROR("Failed to register connector\n");
913		goto err_free_encoder;
914	}
915
916	ret = drm_crtc_init_with_planes(dev, crtc, &sou->base.primary,
917					&sou->base.cursor,
918					&vmw_screen_object_crtc_funcs, NULL);
919	if (ret) {
920		DRM_ERROR("Failed to initialize CRTC\n");
921		goto err_free_unregister;
922	}
923
924	drm_crtc_helper_add(crtc, &vmw_sou_crtc_helper_funcs);
925
926	drm_mode_crtc_set_gamma_size(crtc, 256);
927
928	drm_object_attach_property(&connector->base,
929				   dev_priv->hotplug_mode_update_property, 1);
930	drm_object_attach_property(&connector->base,
931				   dev->mode_config.suggested_x_property, 0);
932	drm_object_attach_property(&connector->base,
933				   dev->mode_config.suggested_y_property, 0);
934	return 0;
935
936err_free_unregister:
937	drm_connector_unregister(connector);
938err_free_encoder:
939	drm_encoder_cleanup(encoder);
940err_free_connector:
941	drm_connector_cleanup(connector);
942err_free:
943	kfree(sou);
944	return ret;
945}
946
947int vmw_kms_sou_init_display(struct vmw_private *dev_priv)
948{
949	struct drm_device *dev = dev_priv->dev;
950	int i, ret;
951
952	/* Screen objects won't work if GMR's aren't available */
953	if (!dev_priv->has_gmr)
954		return -ENOSYS;
955
956	if (!(dev_priv->capabilities & SVGA_CAP_SCREEN_OBJECT_2)) {
957		DRM_INFO("Not using screen objects,"
958			 " missing cap SCREEN_OBJECT_2\n");
959		return -ENOSYS;
960	}
961
962	ret = -ENOMEM;
963
964	ret = drm_vblank_init(dev, VMWGFX_NUM_DISPLAY_UNITS);
965	if (unlikely(ret != 0))
966		return ret;
967
968	for (i = 0; i < VMWGFX_NUM_DISPLAY_UNITS; ++i)
969		vmw_sou_init(dev_priv, i);
970
971	dev_priv->active_display_unit = vmw_du_screen_object;
972
973	drm_mode_config_reset(dev);
974
975	DRM_INFO("Screen Objects Display Unit initialized\n");
976
977	return 0;
978}
979
980static int do_bo_define_gmrfb(struct vmw_private *dev_priv,
981				  struct vmw_framebuffer *framebuffer)
982{
983	struct vmw_buffer_object *buf =
984		container_of(framebuffer, struct vmw_framebuffer_bo,
985			     base)->buffer;
986	int depth = framebuffer->base.format->depth;
987	struct {
988		uint32_t header;
989		SVGAFifoCmdDefineGMRFB body;
990	} *cmd;
991
992	/* Emulate RGBA support, contrary to svga_reg.h this is not
993	 * supported by hosts. This is only a problem if we are reading
994	 * this value later and expecting what we uploaded back.
995	 */
996	if (depth == 32)
997		depth = 24;
998
999	cmd = VMW_FIFO_RESERVE(dev_priv, sizeof(*cmd));
1000	if (!cmd)
1001		return -ENOMEM;
1002
1003	cmd->header = SVGA_CMD_DEFINE_GMRFB;
1004	cmd->body.format.bitsPerPixel = framebuffer->base.format->cpp[0] * 8;
1005	cmd->body.format.colorDepth = depth;
1006	cmd->body.format.reserved = 0;
1007	cmd->body.bytesPerLine = framebuffer->base.pitches[0];
1008	/* Buffer is reserved in vram or GMR */
1009	vmw_bo_get_guest_ptr(&buf->base, &cmd->body.ptr);
1010	vmw_fifo_commit(dev_priv, sizeof(*cmd));
1011
1012	return 0;
1013}
1014
1015/**
1016 * vmw_sou_surface_fifo_commit - Callback to fill in and submit a
1017 * blit surface to screen command.
1018 *
1019 * @dirty: The closure structure.
1020 *
1021 * Fills in the missing fields in the command, and translates the cliprects
1022 * to match the destination bounding box encoded.
1023 */
1024static void vmw_sou_surface_fifo_commit(struct vmw_kms_dirty *dirty)
1025{
1026	struct vmw_kms_sou_surface_dirty *sdirty =
1027		container_of(dirty, typeof(*sdirty), base);
1028	struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
1029	s32 trans_x = dirty->unit->crtc.x - sdirty->dst_x;
1030	s32 trans_y = dirty->unit->crtc.y - sdirty->dst_y;
1031	size_t region_size = dirty->num_hits * sizeof(SVGASignedRect);
1032	SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];
1033	int i;
1034
1035	if (!dirty->num_hits) {
1036		vmw_fifo_commit(dirty->dev_priv, 0);
1037		return;
1038	}
1039
1040	cmd->header.id = SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN;
1041	cmd->header.size = sizeof(cmd->body) + region_size;
1042
1043	/*
1044	 * Use the destination bounding box to specify destination - and
1045	 * source bounding regions.
1046	 */
1047	cmd->body.destRect.left = sdirty->left;
1048	cmd->body.destRect.right = sdirty->right;
1049	cmd->body.destRect.top = sdirty->top;
1050	cmd->body.destRect.bottom = sdirty->bottom;
1051
1052	cmd->body.srcRect.left = sdirty->left + trans_x;
1053	cmd->body.srcRect.right = sdirty->right + trans_x;
1054	cmd->body.srcRect.top = sdirty->top + trans_y;
1055	cmd->body.srcRect.bottom = sdirty->bottom + trans_y;
1056
1057	cmd->body.srcImage.sid = sdirty->sid;
1058	cmd->body.destScreenId = dirty->unit->unit;
1059
1060	/* Blits are relative to the destination rect. Translate. */
1061	for (i = 0; i < dirty->num_hits; ++i, ++blit) {
1062		blit->left -= sdirty->left;
1063		blit->right -= sdirty->left;
1064		blit->top -= sdirty->top;
1065		blit->bottom -= sdirty->top;
1066	}
1067
1068	vmw_fifo_commit(dirty->dev_priv, region_size + sizeof(*cmd));
1069
1070	sdirty->left = sdirty->top = S32_MAX;
1071	sdirty->right = sdirty->bottom = S32_MIN;
1072}
1073
1074/**
1075 * vmw_sou_surface_clip - Callback to encode a blit surface to screen cliprect.
1076 *
1077 * @dirty: The closure structure
1078 *
1079 * Encodes a SVGASignedRect cliprect and updates the bounding box of the
1080 * BLIT_SURFACE_TO_SCREEN command.
1081 */
1082static void vmw_sou_surface_clip(struct vmw_kms_dirty *dirty)
1083{
1084	struct vmw_kms_sou_surface_dirty *sdirty =
1085		container_of(dirty, typeof(*sdirty), base);
1086	struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
1087	SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];
1088
1089	/* Destination rect. */
1090	blit += dirty->num_hits;
1091	blit->left = dirty->unit_x1;
1092	blit->top = dirty->unit_y1;
1093	blit->right = dirty->unit_x2;
1094	blit->bottom = dirty->unit_y2;
1095
1096	/* Destination bounding box */
1097	sdirty->left = min_t(s32, sdirty->left, dirty->unit_x1);
1098	sdirty->top = min_t(s32, sdirty->top, dirty->unit_y1);
1099	sdirty->right = max_t(s32, sdirty->right, dirty->unit_x2);
1100	sdirty->bottom = max_t(s32, sdirty->bottom, dirty->unit_y2);
1101
1102	dirty->num_hits++;
1103}
1104
1105/**
1106 * vmw_kms_sou_do_surface_dirty - Dirty part of a surface backed framebuffer
1107 *
1108 * @dev_priv: Pointer to the device private structure.
1109 * @framebuffer: Pointer to the surface-buffer backed framebuffer.
1110 * @clips: Array of clip rects. Either @clips or @vclips must be NULL.
1111 * @vclips: Alternate array of clip rects. Either @clips or @vclips must
1112 * be NULL.
1113 * @srf: Pointer to surface to blit from. If NULL, the surface attached
1114 * to @framebuffer will be used.
1115 * @dest_x: X coordinate offset to align @srf with framebuffer coordinates.
1116 * @dest_y: Y coordinate offset to align @srf with framebuffer coordinates.
1117 * @num_clips: Number of clip rects in @clips.
1118 * @inc: Increment to use when looping over @clips.
1119 * @out_fence: If non-NULL, will return a ref-counted pointer to a
1120 * struct vmw_fence_obj. The returned fence pointer may be NULL in which
1121 * case the device has already synchronized.
1122 * @crtc: If crtc is passed, perform surface dirty on that crtc only.
1123 *
1124 * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1125 * interrupted.
1126 */
1127int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
1128				 struct vmw_framebuffer *framebuffer,
1129				 struct drm_clip_rect *clips,
1130				 struct drm_vmw_rect *vclips,
1131				 struct vmw_resource *srf,
1132				 s32 dest_x,
1133				 s32 dest_y,
1134				 unsigned num_clips, int inc,
1135				 struct vmw_fence_obj **out_fence,
1136				 struct drm_crtc *crtc)
1137{
1138	struct vmw_framebuffer_surface *vfbs =
1139		container_of(framebuffer, typeof(*vfbs), base);
1140	struct vmw_kms_sou_surface_dirty sdirty;
1141	DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
1142	int ret;
1143
1144	if (!srf)
1145		srf = &vfbs->surface->res;
1146
1147	ret = vmw_validation_add_resource(&val_ctx, srf, 0, VMW_RES_DIRTY_NONE,
1148					  NULL, NULL);
1149	if (ret)
1150		return ret;
1151
1152	ret = vmw_validation_prepare(&val_ctx, &dev_priv->cmdbuf_mutex, true);
1153	if (ret)
1154		goto out_unref;
1155
1156	sdirty.base.fifo_commit = vmw_sou_surface_fifo_commit;
1157	sdirty.base.clip = vmw_sou_surface_clip;
1158	sdirty.base.dev_priv = dev_priv;
1159	sdirty.base.fifo_reserve_size = sizeof(struct vmw_kms_sou_dirty_cmd) +
1160	  sizeof(SVGASignedRect) * num_clips;
1161	sdirty.base.crtc = crtc;
1162
1163	sdirty.sid = srf->id;
1164	sdirty.left = sdirty.top = S32_MAX;
1165	sdirty.right = sdirty.bottom = S32_MIN;
1166	sdirty.dst_x = dest_x;
1167	sdirty.dst_y = dest_y;
1168
1169	ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
1170				   dest_x, dest_y, num_clips, inc,
1171				   &sdirty.base);
1172	vmw_kms_helper_validation_finish(dev_priv, NULL, &val_ctx, out_fence,
1173					 NULL);
1174
1175	return ret;
1176
1177out_unref:
1178	vmw_validation_unref_lists(&val_ctx);
1179	return ret;
1180}
1181
1182/**
1183 * vmw_sou_bo_fifo_commit - Callback to submit a set of readback clips.
1184 *
1185 * @dirty: The closure structure.
1186 *
1187 * Commits a previously built command buffer of readback clips.
1188 */
1189static void vmw_sou_bo_fifo_commit(struct vmw_kms_dirty *dirty)
1190{
1191	if (!dirty->num_hits) {
1192		vmw_fifo_commit(dirty->dev_priv, 0);
1193		return;
1194	}
1195
1196	vmw_fifo_commit(dirty->dev_priv,
1197			sizeof(struct vmw_kms_sou_bo_blit) *
1198			dirty->num_hits);
1199}
1200
1201/**
1202 * vmw_sou_bo_clip - Callback to encode a readback cliprect.
1203 *
1204 * @dirty: The closure structure
1205 *
1206 * Encodes a BLIT_GMRFB_TO_SCREEN cliprect.
1207 */
1208static void vmw_sou_bo_clip(struct vmw_kms_dirty *dirty)
1209{
1210	struct vmw_kms_sou_bo_blit *blit = dirty->cmd;
1211
1212	blit += dirty->num_hits;
1213	blit->header = SVGA_CMD_BLIT_GMRFB_TO_SCREEN;
1214	blit->body.destScreenId = dirty->unit->unit;
1215	blit->body.srcOrigin.x = dirty->fb_x;
1216	blit->body.srcOrigin.y = dirty->fb_y;
1217	blit->body.destRect.left = dirty->unit_x1;
1218	blit->body.destRect.top = dirty->unit_y1;
1219	blit->body.destRect.right = dirty->unit_x2;
1220	blit->body.destRect.bottom = dirty->unit_y2;
1221	dirty->num_hits++;
1222}
1223
1224/**
1225 * vmw_kms_do_bo_dirty - Dirty part of a buffer-object backed framebuffer
1226 *
1227 * @dev_priv: Pointer to the device private structure.
1228 * @framebuffer: Pointer to the buffer-object backed framebuffer.
1229 * @clips: Array of clip rects.
1230 * @vclips: Alternate array of clip rects. Either @clips or @vclips must
1231 * be NULL.
1232 * @num_clips: Number of clip rects in @clips.
1233 * @increment: Increment to use when looping over @clips.
1234 * @interruptible: Whether to perform waits interruptible if possible.
1235 * @out_fence: If non-NULL, will return a ref-counted pointer to a
1236 * struct vmw_fence_obj. The returned fence pointer may be NULL in which
1237 * case the device has already synchronized.
1238 * @crtc: If crtc is passed, perform bo dirty on that crtc only.
1239 *
1240 * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1241 * interrupted.
1242 */
1243int vmw_kms_sou_do_bo_dirty(struct vmw_private *dev_priv,
1244				struct vmw_framebuffer *framebuffer,
1245				struct drm_clip_rect *clips,
1246				struct drm_vmw_rect *vclips,
1247				unsigned num_clips, int increment,
1248				bool interruptible,
1249				struct vmw_fence_obj **out_fence,
1250				struct drm_crtc *crtc)
1251{
1252	struct vmw_buffer_object *buf =
1253		container_of(framebuffer, struct vmw_framebuffer_bo,
1254			     base)->buffer;
1255	struct vmw_kms_dirty dirty;
1256	DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
1257	int ret;
1258
1259	ret = vmw_validation_add_bo(&val_ctx, buf, false, false);
1260	if (ret)
1261		return ret;
1262
1263	ret = vmw_validation_prepare(&val_ctx, NULL, interruptible);
1264	if (ret)
1265		goto out_unref;
1266
1267	ret = do_bo_define_gmrfb(dev_priv, framebuffer);
1268	if (unlikely(ret != 0))
1269		goto out_revert;
1270
1271	dirty.crtc = crtc;
1272	dirty.fifo_commit = vmw_sou_bo_fifo_commit;
1273	dirty.clip = vmw_sou_bo_clip;
1274	dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_bo_blit) *
1275		num_clips;
1276	ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
1277				   0, 0, num_clips, increment, &dirty);
1278	vmw_kms_helper_validation_finish(dev_priv, NULL, &val_ctx, out_fence,
1279					 NULL);
1280
1281	return ret;
1282
1283out_revert:
1284	vmw_validation_revert(&val_ctx);
1285out_unref:
1286	vmw_validation_unref_lists(&val_ctx);
1287
1288	return ret;
1289}
1290
1291
1292/**
1293 * vmw_sou_readback_fifo_commit - Callback to submit a set of readback clips.
1294 *
1295 * @dirty: The closure structure.
1296 *
1297 * Commits a previously built command buffer of readback clips.
1298 */
1299static void vmw_sou_readback_fifo_commit(struct vmw_kms_dirty *dirty)
1300{
1301	if (!dirty->num_hits) {
1302		vmw_fifo_commit(dirty->dev_priv, 0);
1303		return;
1304	}
1305
1306	vmw_fifo_commit(dirty->dev_priv,
1307			sizeof(struct vmw_kms_sou_readback_blit) *
1308			dirty->num_hits);
1309}
1310
1311/**
1312 * vmw_sou_readback_clip - Callback to encode a readback cliprect.
1313 *
1314 * @dirty: The closure structure
1315 *
1316 * Encodes a BLIT_SCREEN_TO_GMRFB cliprect.
1317 */
1318static void vmw_sou_readback_clip(struct vmw_kms_dirty *dirty)
1319{
1320	struct vmw_kms_sou_readback_blit *blit = dirty->cmd;
1321
1322	blit += dirty->num_hits;
1323	blit->header = SVGA_CMD_BLIT_SCREEN_TO_GMRFB;
1324	blit->body.srcScreenId = dirty->unit->unit;
1325	blit->body.destOrigin.x = dirty->fb_x;
1326	blit->body.destOrigin.y = dirty->fb_y;
1327	blit->body.srcRect.left = dirty->unit_x1;
1328	blit->body.srcRect.top = dirty->unit_y1;
1329	blit->body.srcRect.right = dirty->unit_x2;
1330	blit->body.srcRect.bottom = dirty->unit_y2;
1331	dirty->num_hits++;
1332}
1333
1334/**
1335 * vmw_kms_sou_readback - Perform a readback from the screen object system to
1336 * a buffer-object backed framebuffer.
1337 *
1338 * @dev_priv: Pointer to the device private structure.
1339 * @file_priv: Pointer to a struct drm_file identifying the caller.
1340 * Must be set to NULL if @user_fence_rep is NULL.
1341 * @vfb: Pointer to the buffer-object backed framebuffer.
1342 * @user_fence_rep: User-space provided structure for fence information.
1343 * Must be set to non-NULL if @file_priv is non-NULL.
1344 * @vclips: Array of clip rects.
1345 * @num_clips: Number of clip rects in @vclips.
1346 * @crtc: If crtc is passed, readback on that crtc only.
1347 *
1348 * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1349 * interrupted.
1350 */
1351int vmw_kms_sou_readback(struct vmw_private *dev_priv,
1352			 struct drm_file *file_priv,
1353			 struct vmw_framebuffer *vfb,
1354			 struct drm_vmw_fence_rep __user *user_fence_rep,
1355			 struct drm_vmw_rect *vclips,
1356			 uint32_t num_clips,
1357			 struct drm_crtc *crtc)
1358{
1359	struct vmw_buffer_object *buf =
1360		container_of(vfb, struct vmw_framebuffer_bo, base)->buffer;
1361	struct vmw_kms_dirty dirty;
1362	DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
1363	int ret;
1364
1365	ret = vmw_validation_add_bo(&val_ctx, buf, false, false);
1366	if (ret)
1367		return ret;
1368
1369	ret = vmw_validation_prepare(&val_ctx, NULL, true);
1370	if (ret)
1371		goto out_unref;
1372
1373	ret = do_bo_define_gmrfb(dev_priv, vfb);
1374	if (unlikely(ret != 0))
1375		goto out_revert;
1376
1377	dirty.crtc = crtc;
1378	dirty.fifo_commit = vmw_sou_readback_fifo_commit;
1379	dirty.clip = vmw_sou_readback_clip;
1380	dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_readback_blit) *
1381		num_clips;
1382	ret = vmw_kms_helper_dirty(dev_priv, vfb, NULL, vclips,
1383				   0, 0, num_clips, 1, &dirty);
1384	vmw_kms_helper_validation_finish(dev_priv, file_priv, &val_ctx, NULL,
1385					 user_fence_rep);
1386
1387	return ret;
1388
1389out_revert:
1390	vmw_validation_revert(&val_ctx);
1391out_unref:
1392	vmw_validation_unref_lists(&val_ctx);
1393
1394	return ret;
1395}
1396