1 // SPDX-License-Identifier: GPL-2.0 OR MIT
2 /**************************************************************************
3  *
4  * Copyright 2009-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_fourcc.h>
31 #include <drm/drm_plane_helper.h>
32 #include <drm/drm_vblank.h>
33 
34 #include "vmwgfx_kms.h"
35 
36 #define vmw_crtc_to_ldu(x) \
37 	container_of(x, struct vmw_legacy_display_unit, base.crtc)
38 #define vmw_encoder_to_ldu(x) \
39 	container_of(x, struct vmw_legacy_display_unit, base.encoder)
40 #define vmw_connector_to_ldu(x) \
41 	container_of(x, struct vmw_legacy_display_unit, base.connector)
42 
43 struct vmw_legacy_display {
44 	struct list_head active;
45 
46 	unsigned num_active;
47 	unsigned last_num_active;
48 
49 	struct vmw_framebuffer *fb;
50 };
51 
52 /*
53  * Display unit using the legacy register interface.
54  */
55 struct vmw_legacy_display_unit {
56 	struct vmw_display_unit base;
57 
58 	struct list_head active;
59 };
60 
61 static void vmw_ldu_destroy(struct vmw_legacy_display_unit *ldu)
62 {
63 	list_del_init(&ldu->active);
64 	vmw_du_cleanup(&ldu->base);
65 	kfree(ldu);
66 }
67 
68 
69 /*
70  * Legacy Display Unit CRTC functions
71  */
72 
73 static void vmw_ldu_crtc_destroy(struct drm_crtc *crtc)
74 {
75 	vmw_ldu_destroy(vmw_crtc_to_ldu(crtc));
76 }
77 
78 static int vmw_ldu_commit_list(struct vmw_private *dev_priv)
79 {
80 	struct vmw_legacy_display *lds = dev_priv->ldu_priv;
81 	struct vmw_legacy_display_unit *entry;
82 	struct drm_framebuffer *fb = NULL;
83 	struct drm_crtc *crtc = NULL;
84 	int i;
85 
86 	/* If there is no display topology the host just assumes
87 	 * that the guest will set the same layout as the host.
88 	 */
89 	if (!(dev_priv->capabilities & SVGA_CAP_DISPLAY_TOPOLOGY)) {
90 		int w = 0, h = 0;
91 		list_for_each_entry(entry, &lds->active, active) {
92 			crtc = &entry->base.crtc;
93 			w = max(w, crtc->x + crtc->mode.hdisplay);
94 			h = max(h, crtc->y + crtc->mode.vdisplay);
95 		}
96 
97 		if (crtc == NULL)
98 			return 0;
99 		fb = crtc->primary->state->fb;
100 
101 		return vmw_kms_write_svga(dev_priv, w, h, fb->pitches[0],
102 					  fb->format->cpp[0] * 8,
103 					  fb->format->depth);
104 	}
105 
106 	if (!list_empty(&lds->active)) {
107 		entry = list_entry(lds->active.next, typeof(*entry), active);
108 		fb = entry->base.crtc.primary->state->fb;
109 
110 		vmw_kms_write_svga(dev_priv, fb->width, fb->height, fb->pitches[0],
111 				   fb->format->cpp[0] * 8, fb->format->depth);
112 	}
113 
114 	/* Make sure we always show something. */
115 	vmw_write(dev_priv, SVGA_REG_NUM_GUEST_DISPLAYS,
116 		  lds->num_active ? lds->num_active : 1);
117 
118 	i = 0;
119 	list_for_each_entry(entry, &lds->active, active) {
120 		crtc = &entry->base.crtc;
121 
122 		vmw_write(dev_priv, SVGA_REG_DISPLAY_ID, i);
123 		vmw_write(dev_priv, SVGA_REG_DISPLAY_IS_PRIMARY, !i);
124 		vmw_write(dev_priv, SVGA_REG_DISPLAY_POSITION_X, crtc->x);
125 		vmw_write(dev_priv, SVGA_REG_DISPLAY_POSITION_Y, crtc->y);
126 		vmw_write(dev_priv, SVGA_REG_DISPLAY_WIDTH, crtc->mode.hdisplay);
127 		vmw_write(dev_priv, SVGA_REG_DISPLAY_HEIGHT, crtc->mode.vdisplay);
128 
129 		i++;
130 	}
131 
132 	BUG_ON(i != lds->num_active);
133 
134 	lds->last_num_active = lds->num_active;
135 
136 	return 0;
137 }
138 
139 static int vmw_ldu_del_active(struct vmw_private *vmw_priv,
140 			      struct vmw_legacy_display_unit *ldu)
141 {
142 	struct vmw_legacy_display *ld = vmw_priv->ldu_priv;
143 	if (list_empty(&ldu->active))
144 		return 0;
145 
146 	/* Must init otherwise list_empty(&ldu->active) will not work. */
147 	list_del_init(&ldu->active);
148 	if (--(ld->num_active) == 0) {
149 		BUG_ON(!ld->fb);
150 		if (ld->fb->unpin)
151 			ld->fb->unpin(ld->fb);
152 		ld->fb = NULL;
153 	}
154 
155 	return 0;
156 }
157 
158 static int vmw_ldu_add_active(struct vmw_private *vmw_priv,
159 			      struct vmw_legacy_display_unit *ldu,
160 			      struct vmw_framebuffer *vfb)
161 {
162 	struct vmw_legacy_display *ld = vmw_priv->ldu_priv;
163 	struct vmw_legacy_display_unit *entry;
164 	struct list_head *at;
165 
166 	BUG_ON(!ld->num_active && ld->fb);
167 	if (vfb != ld->fb) {
168 		if (ld->fb && ld->fb->unpin)
169 			ld->fb->unpin(ld->fb);
170 		vmw_svga_enable(vmw_priv);
171 		if (vfb->pin)
172 			vfb->pin(vfb);
173 		ld->fb = vfb;
174 	}
175 
176 	if (!list_empty(&ldu->active))
177 		return 0;
178 
179 	at = &ld->active;
180 	list_for_each_entry(entry, &ld->active, active) {
181 		if (entry->base.unit > ldu->base.unit)
182 			break;
183 
184 		at = &entry->active;
185 	}
186 
187 	list_add(&ldu->active, at);
188 
189 	ld->num_active++;
190 
191 	return 0;
192 }
193 
194 /**
195  * vmw_ldu_crtc_mode_set_nofb - Enable svga
196  *
197  * @crtc: CRTC associated with the new screen
198  *
199  * For LDU, just enable the svga
200  */
201 static void vmw_ldu_crtc_mode_set_nofb(struct drm_crtc *crtc)
202 {
203 }
204 
205 /**
206  * vmw_ldu_crtc_atomic_enable - Noop
207  *
208  * @crtc: CRTC associated with the new screen
209  * @state: Unused
210  *
211  * This is called after a mode set has been completed.  Here's
212  * usually a good place to call vmw_ldu_add_active/vmw_ldu_del_active
213  * but since for LDU the display plane is closely tied to the
214  * CRTC, it makes more sense to do those at plane update time.
215  */
216 static void vmw_ldu_crtc_atomic_enable(struct drm_crtc *crtc,
217 				       struct drm_atomic_state *state)
218 {
219 }
220 
221 /**
222  * vmw_ldu_crtc_atomic_disable - Turns off CRTC
223  *
224  * @crtc: CRTC to be turned off
225  * @state: Unused
226  */
227 static void vmw_ldu_crtc_atomic_disable(struct drm_crtc *crtc,
228 					struct drm_atomic_state *state)
229 {
230 }
231 
232 static const struct drm_crtc_funcs vmw_legacy_crtc_funcs = {
233 	.gamma_set = vmw_du_crtc_gamma_set,
234 	.destroy = vmw_ldu_crtc_destroy,
235 	.reset = vmw_du_crtc_reset,
236 	.atomic_duplicate_state = vmw_du_crtc_duplicate_state,
237 	.atomic_destroy_state = vmw_du_crtc_destroy_state,
238 	.set_config = drm_atomic_helper_set_config,
239 	.get_vblank_counter = vmw_get_vblank_counter,
240 	.enable_vblank = vmw_enable_vblank,
241 	.disable_vblank = vmw_disable_vblank,
242 };
243 
244 
245 /*
246  * Legacy Display Unit encoder functions
247  */
248 
249 static void vmw_ldu_encoder_destroy(struct drm_encoder *encoder)
250 {
251 	vmw_ldu_destroy(vmw_encoder_to_ldu(encoder));
252 }
253 
254 static const struct drm_encoder_funcs vmw_legacy_encoder_funcs = {
255 	.destroy = vmw_ldu_encoder_destroy,
256 };
257 
258 /*
259  * Legacy Display Unit connector functions
260  */
261 
262 static void vmw_ldu_connector_destroy(struct drm_connector *connector)
263 {
264 	vmw_ldu_destroy(vmw_connector_to_ldu(connector));
265 }
266 
267 static const struct drm_connector_funcs vmw_legacy_connector_funcs = {
268 	.dpms = vmw_du_connector_dpms,
269 	.detect = vmw_du_connector_detect,
270 	.fill_modes = vmw_du_connector_fill_modes,
271 	.destroy = vmw_ldu_connector_destroy,
272 	.reset = vmw_du_connector_reset,
273 	.atomic_duplicate_state = vmw_du_connector_duplicate_state,
274 	.atomic_destroy_state = vmw_du_connector_destroy_state,
275 };
276 
277 static const struct
278 drm_connector_helper_funcs vmw_ldu_connector_helper_funcs = {
279 };
280 
281 /*
282  * Legacy Display Plane Functions
283  */
284 
285 static void
286 vmw_ldu_primary_plane_atomic_update(struct drm_plane *plane,
287 				    struct drm_atomic_state *state)
288 {
289 	struct drm_plane_state *old_state = drm_atomic_get_old_plane_state(state,
290 									   plane);
291 	struct drm_plane_state *new_state = drm_atomic_get_new_plane_state(state,
292 									   plane);
293 	struct vmw_private *dev_priv;
294 	struct vmw_legacy_display_unit *ldu;
295 	struct vmw_framebuffer *vfb;
296 	struct drm_framebuffer *fb;
297 	struct drm_crtc *crtc = new_state->crtc ?: old_state->crtc;
298 
299 
300 	ldu = vmw_crtc_to_ldu(crtc);
301 	dev_priv = vmw_priv(plane->dev);
302 	fb       = new_state->fb;
303 
304 	vfb = (fb) ? vmw_framebuffer_to_vfb(fb) : NULL;
305 
306 	if (vfb)
307 		vmw_ldu_add_active(dev_priv, ldu, vfb);
308 	else
309 		vmw_ldu_del_active(dev_priv, ldu);
310 
311 	vmw_ldu_commit_list(dev_priv);
312 }
313 
314 
315 static const struct drm_plane_funcs vmw_ldu_plane_funcs = {
316 	.update_plane = drm_atomic_helper_update_plane,
317 	.disable_plane = drm_atomic_helper_disable_plane,
318 	.destroy = vmw_du_primary_plane_destroy,
319 	.reset = vmw_du_plane_reset,
320 	.atomic_duplicate_state = vmw_du_plane_duplicate_state,
321 	.atomic_destroy_state = vmw_du_plane_destroy_state,
322 };
323 
324 static const struct drm_plane_funcs vmw_ldu_cursor_funcs = {
325 	.update_plane = drm_atomic_helper_update_plane,
326 	.disable_plane = drm_atomic_helper_disable_plane,
327 	.destroy = vmw_du_cursor_plane_destroy,
328 	.reset = vmw_du_plane_reset,
329 	.atomic_duplicate_state = vmw_du_plane_duplicate_state,
330 	.atomic_destroy_state = vmw_du_plane_destroy_state,
331 };
332 
333 /*
334  * Atomic Helpers
335  */
336 static const struct
337 drm_plane_helper_funcs vmw_ldu_cursor_plane_helper_funcs = {
338 	.atomic_check = vmw_du_cursor_plane_atomic_check,
339 	.atomic_update = vmw_du_cursor_plane_atomic_update,
340 	.prepare_fb = vmw_du_cursor_plane_prepare_fb,
341 	.cleanup_fb = vmw_du_cursor_plane_cleanup_fb,
342 };
343 
344 static const struct
345 drm_plane_helper_funcs vmw_ldu_primary_plane_helper_funcs = {
346 	.atomic_check = vmw_du_primary_plane_atomic_check,
347 	.atomic_update = vmw_ldu_primary_plane_atomic_update,
348 };
349 
350 static const struct drm_crtc_helper_funcs vmw_ldu_crtc_helper_funcs = {
351 	.mode_set_nofb = vmw_ldu_crtc_mode_set_nofb,
352 	.atomic_check = vmw_du_crtc_atomic_check,
353 	.atomic_begin = vmw_du_crtc_atomic_begin,
354 	.atomic_flush = vmw_du_crtc_atomic_flush,
355 	.atomic_enable = vmw_ldu_crtc_atomic_enable,
356 	.atomic_disable = vmw_ldu_crtc_atomic_disable,
357 };
358 
359 
360 static int vmw_ldu_init(struct vmw_private *dev_priv, unsigned unit)
361 {
362 	struct vmw_legacy_display_unit *ldu;
363 	struct drm_device *dev = &dev_priv->drm;
364 	struct drm_connector *connector;
365 	struct drm_encoder *encoder;
366 	struct drm_plane *primary;
367 	struct vmw_cursor_plane *cursor;
368 	struct drm_crtc *crtc;
369 	int ret;
370 
371 	ldu = kzalloc(sizeof(*ldu), GFP_KERNEL);
372 	if (!ldu)
373 		return -ENOMEM;
374 
375 	ldu->base.unit = unit;
376 	crtc = &ldu->base.crtc;
377 	encoder = &ldu->base.encoder;
378 	connector = &ldu->base.connector;
379 	primary = &ldu->base.primary;
380 	cursor = &ldu->base.cursor;
381 
382 	INIT_LIST_HEAD(&ldu->active);
383 
384 	ldu->base.pref_active = (unit == 0);
385 	ldu->base.pref_width = dev_priv->initial_width;
386 	ldu->base.pref_height = dev_priv->initial_height;
387 	ldu->base.pref_mode = NULL;
388 
389 	/*
390 	 * Remove this after enabling atomic because property values can
391 	 * only exist in a state object
392 	 */
393 	ldu->base.is_implicit = true;
394 
395 	/* Initialize primary plane */
396 	ret = drm_universal_plane_init(dev, primary,
397 				       0, &vmw_ldu_plane_funcs,
398 				       vmw_primary_plane_formats,
399 				       ARRAY_SIZE(vmw_primary_plane_formats),
400 				       NULL, DRM_PLANE_TYPE_PRIMARY, NULL);
401 	if (ret) {
402 		DRM_ERROR("Failed to initialize primary plane");
403 		goto err_free;
404 	}
405 
406 	drm_plane_helper_add(primary, &vmw_ldu_primary_plane_helper_funcs);
407 
408 	/*
409 	 * We're going to be using traces and software cursors
410 	 */
411 	if (vmw_cmd_supported(dev_priv)) {
412 		/* Initialize cursor plane */
413 		ret = drm_universal_plane_init(dev, &cursor->base,
414 					       0, &vmw_ldu_cursor_funcs,
415 					       vmw_cursor_plane_formats,
416 					       ARRAY_SIZE(vmw_cursor_plane_formats),
417 					       NULL, DRM_PLANE_TYPE_CURSOR, NULL);
418 		if (ret) {
419 			DRM_ERROR("Failed to initialize cursor plane");
420 			drm_plane_cleanup(&ldu->base.primary);
421 			goto err_free;
422 		}
423 
424 		drm_plane_helper_add(&cursor->base, &vmw_ldu_cursor_plane_helper_funcs);
425 	}
426 
427 	ret = drm_connector_init(dev, connector, &vmw_legacy_connector_funcs,
428 				 DRM_MODE_CONNECTOR_VIRTUAL);
429 	if (ret) {
430 		DRM_ERROR("Failed to initialize connector\n");
431 		goto err_free;
432 	}
433 
434 	drm_connector_helper_add(connector, &vmw_ldu_connector_helper_funcs);
435 	connector->status = vmw_du_connector_detect(connector, true);
436 
437 	ret = drm_encoder_init(dev, encoder, &vmw_legacy_encoder_funcs,
438 			       DRM_MODE_ENCODER_VIRTUAL, NULL);
439 	if (ret) {
440 		DRM_ERROR("Failed to initialize encoder\n");
441 		goto err_free_connector;
442 	}
443 
444 	(void) drm_connector_attach_encoder(connector, encoder);
445 	encoder->possible_crtcs = (1 << unit);
446 	encoder->possible_clones = 0;
447 
448 	ret = drm_connector_register(connector);
449 	if (ret) {
450 		DRM_ERROR("Failed to register connector\n");
451 		goto err_free_encoder;
452 	}
453 
454 	ret = drm_crtc_init_with_planes(dev, crtc, primary,
455 		      vmw_cmd_supported(dev_priv) ? &cursor->base : NULL,
456 		      &vmw_legacy_crtc_funcs, NULL);
457 	if (ret) {
458 		DRM_ERROR("Failed to initialize CRTC\n");
459 		goto err_free_unregister;
460 	}
461 
462 	drm_crtc_helper_add(crtc, &vmw_ldu_crtc_helper_funcs);
463 
464 	drm_mode_crtc_set_gamma_size(crtc, 256);
465 
466 	drm_object_attach_property(&connector->base,
467 				   dev_priv->hotplug_mode_update_property, 1);
468 	drm_object_attach_property(&connector->base,
469 				   dev->mode_config.suggested_x_property, 0);
470 	drm_object_attach_property(&connector->base,
471 				   dev->mode_config.suggested_y_property, 0);
472 	if (dev_priv->implicit_placement_property)
473 		drm_object_attach_property
474 			(&connector->base,
475 			 dev_priv->implicit_placement_property,
476 			 1);
477 
478 	return 0;
479 
480 err_free_unregister:
481 	drm_connector_unregister(connector);
482 err_free_encoder:
483 	drm_encoder_cleanup(encoder);
484 err_free_connector:
485 	drm_connector_cleanup(connector);
486 err_free:
487 	kfree(ldu);
488 	return ret;
489 }
490 
491 int vmw_kms_ldu_init_display(struct vmw_private *dev_priv)
492 {
493 	struct drm_device *dev = &dev_priv->drm;
494 	int i, ret;
495 	int num_display_units = (dev_priv->capabilities & SVGA_CAP_MULTIMON) ?
496 					VMWGFX_NUM_DISPLAY_UNITS : 1;
497 
498 	if (unlikely(dev_priv->ldu_priv)) {
499 		return -EINVAL;
500 	}
501 
502 	dev_priv->ldu_priv = kmalloc(sizeof(*dev_priv->ldu_priv), GFP_KERNEL);
503 	if (!dev_priv->ldu_priv)
504 		return -ENOMEM;
505 
506 	INIT_LIST_HEAD(&dev_priv->ldu_priv->active);
507 	dev_priv->ldu_priv->num_active = 0;
508 	dev_priv->ldu_priv->last_num_active = 0;
509 	dev_priv->ldu_priv->fb = NULL;
510 
511 	ret = drm_vblank_init(dev, num_display_units);
512 	if (ret != 0)
513 		goto err_free;
514 
515 	vmw_kms_create_implicit_placement_property(dev_priv);
516 
517 	for (i = 0; i < num_display_units; ++i) {
518 		ret = vmw_ldu_init(dev_priv, i);
519 		if (ret != 0)
520 			goto err_free;
521 	}
522 
523 	dev_priv->active_display_unit = vmw_du_legacy;
524 
525 	drm_mode_config_reset(dev);
526 
527 	return 0;
528 
529 err_free:
530 	kfree(dev_priv->ldu_priv);
531 	dev_priv->ldu_priv = NULL;
532 	return ret;
533 }
534 
535 int vmw_kms_ldu_close_display(struct vmw_private *dev_priv)
536 {
537 	if (!dev_priv->ldu_priv)
538 		return -ENOSYS;
539 
540 	BUG_ON(!list_empty(&dev_priv->ldu_priv->active));
541 
542 	kfree(dev_priv->ldu_priv);
543 
544 	return 0;
545 }
546 
547 
548 int vmw_kms_ldu_do_bo_dirty(struct vmw_private *dev_priv,
549 			    struct vmw_framebuffer *framebuffer,
550 			    unsigned int flags, unsigned int color,
551 			    struct drm_clip_rect *clips,
552 			    unsigned int num_clips, int increment)
553 {
554 	size_t fifo_size;
555 	int i;
556 
557 	struct {
558 		uint32_t header;
559 		SVGAFifoCmdUpdate body;
560 	} *cmd;
561 
562 	fifo_size = sizeof(*cmd) * num_clips;
563 	cmd = VMW_CMD_RESERVE(dev_priv, fifo_size);
564 	if (unlikely(cmd == NULL))
565 		return -ENOMEM;
566 
567 	memset(cmd, 0, fifo_size);
568 	for (i = 0; i < num_clips; i++, clips += increment) {
569 		cmd[i].header = SVGA_CMD_UPDATE;
570 		cmd[i].body.x = clips->x1;
571 		cmd[i].body.y = clips->y1;
572 		cmd[i].body.width = clips->x2 - clips->x1;
573 		cmd[i].body.height = clips->y2 - clips->y1;
574 	}
575 
576 	vmw_cmd_commit(dev_priv, fifo_size);
577 	return 0;
578 }
579