1// SPDX-License-Identifier: GPL-2.0 OR MIT
2/**************************************************************************
3 *
4 * Copyright 2009-2023 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 "vmwgfx_bo.h"
29#include "vmwgfx_kms.h"
30
31#include <drm/drm_atomic.h>
32#include <drm/drm_atomic_helper.h>
33#include <drm/drm_fourcc.h>
34
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
43struct 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 */
55struct vmw_legacy_display_unit {
56	struct vmw_display_unit base;
57
58	struct list_head active;
59};
60
61static 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
73static void vmw_ldu_crtc_destroy(struct drm_crtc *crtc)
74{
75	vmw_ldu_destroy(vmw_crtc_to_ldu(crtc));
76}
77
78static 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/*
140 * Pin the buffer in a location suitable for access by the
141 * display system.
142 */
143static int vmw_ldu_fb_pin(struct vmw_framebuffer *vfb)
144{
145	struct vmw_private *dev_priv = vmw_priv(vfb->base.dev);
146	struct vmw_bo *buf;
147	int ret;
148
149	buf = vfb->bo ?  vmw_framebuffer_to_vfbd(&vfb->base)->buffer :
150		vmw_framebuffer_to_vfbs(&vfb->base)->surface->res.guest_memory_bo;
151
152	if (!buf)
153		return 0;
154	WARN_ON(dev_priv->active_display_unit != vmw_du_legacy);
155
156	if (dev_priv->active_display_unit == vmw_du_legacy) {
157		vmw_overlay_pause_all(dev_priv);
158		ret = vmw_bo_pin_in_start_of_vram(dev_priv, buf, false);
159		vmw_overlay_resume_all(dev_priv);
160	} else
161		ret = -EINVAL;
162
163	return ret;
164}
165
166static int vmw_ldu_fb_unpin(struct vmw_framebuffer *vfb)
167{
168	struct vmw_private *dev_priv = vmw_priv(vfb->base.dev);
169	struct vmw_bo *buf;
170
171	buf = vfb->bo ?  vmw_framebuffer_to_vfbd(&vfb->base)->buffer :
172		vmw_framebuffer_to_vfbs(&vfb->base)->surface->res.guest_memory_bo;
173
174	if (WARN_ON(!buf))
175		return 0;
176
177	return vmw_bo_unpin(dev_priv, buf, false);
178}
179
180static int vmw_ldu_del_active(struct vmw_private *vmw_priv,
181			      struct vmw_legacy_display_unit *ldu)
182{
183	struct vmw_legacy_display *ld = vmw_priv->ldu_priv;
184	if (list_empty(&ldu->active))
185		return 0;
186
187	/* Must init otherwise list_empty(&ldu->active) will not work. */
188	list_del_init(&ldu->active);
189	if (--(ld->num_active) == 0) {
190		BUG_ON(!ld->fb);
191		WARN_ON(vmw_ldu_fb_unpin(ld->fb));
192		ld->fb = NULL;
193	}
194
195	return 0;
196}
197
198static int vmw_ldu_add_active(struct vmw_private *vmw_priv,
199			      struct vmw_legacy_display_unit *ldu,
200			      struct vmw_framebuffer *vfb)
201{
202	struct vmw_legacy_display *ld = vmw_priv->ldu_priv;
203	struct vmw_legacy_display_unit *entry;
204	struct list_head *at;
205
206	BUG_ON(!ld->num_active && ld->fb);
207	if (vfb != ld->fb) {
208		if (ld->fb)
209			WARN_ON(vmw_ldu_fb_unpin(ld->fb));
210		vmw_svga_enable(vmw_priv);
211		WARN_ON(vmw_ldu_fb_pin(vfb));
212		ld->fb = vfb;
213	}
214
215	if (!list_empty(&ldu->active))
216		return 0;
217
218	at = &ld->active;
219	list_for_each_entry(entry, &ld->active, active) {
220		if (entry->base.unit > ldu->base.unit)
221			break;
222
223		at = &entry->active;
224	}
225
226	list_add(&ldu->active, at);
227
228	ld->num_active++;
229
230	return 0;
231}
232
233/**
234 * vmw_ldu_crtc_mode_set_nofb - Enable svga
235 *
236 * @crtc: CRTC associated with the new screen
237 *
238 * For LDU, just enable the svga
239 */
240static void vmw_ldu_crtc_mode_set_nofb(struct drm_crtc *crtc)
241{
242}
243
244/**
245 * vmw_ldu_crtc_atomic_enable - Noop
246 *
247 * @crtc: CRTC associated with the new screen
248 * @state: Unused
249 *
250 * This is called after a mode set has been completed.  Here's
251 * usually a good place to call vmw_ldu_add_active/vmw_ldu_del_active
252 * but since for LDU the display plane is closely tied to the
253 * CRTC, it makes more sense to do those at plane update time.
254 */
255static void vmw_ldu_crtc_atomic_enable(struct drm_crtc *crtc,
256				       struct drm_atomic_state *state)
257{
258}
259
260/**
261 * vmw_ldu_crtc_atomic_disable - Turns off CRTC
262 *
263 * @crtc: CRTC to be turned off
264 * @state: Unused
265 */
266static void vmw_ldu_crtc_atomic_disable(struct drm_crtc *crtc,
267					struct drm_atomic_state *state)
268{
269}
270
271static const struct drm_crtc_funcs vmw_legacy_crtc_funcs = {
272	.gamma_set = vmw_du_crtc_gamma_set,
273	.destroy = vmw_ldu_crtc_destroy,
274	.reset = vmw_du_crtc_reset,
275	.atomic_duplicate_state = vmw_du_crtc_duplicate_state,
276	.atomic_destroy_state = vmw_du_crtc_destroy_state,
277	.set_config = drm_atomic_helper_set_config,
278	.page_flip = drm_atomic_helper_page_flip,
279};
280
281
282/*
283 * Legacy Display Unit encoder functions
284 */
285
286static void vmw_ldu_encoder_destroy(struct drm_encoder *encoder)
287{
288	vmw_ldu_destroy(vmw_encoder_to_ldu(encoder));
289}
290
291static const struct drm_encoder_funcs vmw_legacy_encoder_funcs = {
292	.destroy = vmw_ldu_encoder_destroy,
293};
294
295/*
296 * Legacy Display Unit connector functions
297 */
298
299static void vmw_ldu_connector_destroy(struct drm_connector *connector)
300{
301	vmw_ldu_destroy(vmw_connector_to_ldu(connector));
302}
303
304static const struct drm_connector_funcs vmw_legacy_connector_funcs = {
305	.dpms = vmw_du_connector_dpms,
306	.detect = vmw_du_connector_detect,
307	.fill_modes = vmw_du_connector_fill_modes,
308	.destroy = vmw_ldu_connector_destroy,
309	.reset = vmw_du_connector_reset,
310	.atomic_duplicate_state = vmw_du_connector_duplicate_state,
311	.atomic_destroy_state = vmw_du_connector_destroy_state,
312};
313
314static const struct
315drm_connector_helper_funcs vmw_ldu_connector_helper_funcs = {
316};
317
318static int vmw_kms_ldu_do_bo_dirty(struct vmw_private *dev_priv,
319				   struct vmw_framebuffer *framebuffer,
320				   unsigned int flags, unsigned int color,
321				   struct drm_mode_rect *clips,
322				   unsigned int num_clips);
323
324/*
325 * Legacy Display Plane Functions
326 */
327
328static void
329vmw_ldu_primary_plane_atomic_update(struct drm_plane *plane,
330				    struct drm_atomic_state *state)
331{
332	struct drm_plane_state *old_state = drm_atomic_get_old_plane_state(state,
333									   plane);
334	struct drm_plane_state *new_state = drm_atomic_get_new_plane_state(state,
335									   plane);
336	struct vmw_private *dev_priv;
337	struct vmw_legacy_display_unit *ldu;
338	struct vmw_framebuffer *vfb;
339	struct drm_framebuffer *fb;
340	struct drm_crtc *crtc = new_state->crtc ?: old_state->crtc;
341
342	ldu = vmw_crtc_to_ldu(crtc);
343	dev_priv = vmw_priv(plane->dev);
344	fb       = new_state->fb;
345
346	vfb = (fb) ? vmw_framebuffer_to_vfb(fb) : NULL;
347
348	if (vfb)
349		vmw_ldu_add_active(dev_priv, ldu, vfb);
350	else
351		vmw_ldu_del_active(dev_priv, ldu);
352
353	vmw_ldu_commit_list(dev_priv);
354
355	if (vfb && vmw_cmd_supported(dev_priv)) {
356		struct drm_mode_rect fb_rect = {
357			.x1 = 0,
358			.y1 = 0,
359			.x2 = vfb->base.width,
360			.y2 = vfb->base.height
361		};
362		struct drm_mode_rect *damage_rects = drm_plane_get_damage_clips(new_state);
363		u32 rect_count = drm_plane_get_damage_clips_count(new_state);
364		int ret;
365
366		if (!damage_rects) {
367			damage_rects = &fb_rect;
368			rect_count = 1;
369		}
370
371		ret = vmw_kms_ldu_do_bo_dirty(dev_priv, vfb, 0, 0, damage_rects, rect_count);
372
373		drm_WARN_ONCE(plane->dev, ret,
374			"vmw_kms_ldu_do_bo_dirty failed with: ret=%d\n", ret);
375
376		vmw_cmd_flush(dev_priv, false);
377	}
378}
379
380static const struct drm_plane_funcs vmw_ldu_plane_funcs = {
381	.update_plane = drm_atomic_helper_update_plane,
382	.disable_plane = drm_atomic_helper_disable_plane,
383	.destroy = vmw_du_primary_plane_destroy,
384	.reset = vmw_du_plane_reset,
385	.atomic_duplicate_state = vmw_du_plane_duplicate_state,
386	.atomic_destroy_state = vmw_du_plane_destroy_state,
387};
388
389static const struct drm_plane_funcs vmw_ldu_cursor_funcs = {
390	.update_plane = drm_atomic_helper_update_plane,
391	.disable_plane = drm_atomic_helper_disable_plane,
392	.destroy = vmw_du_cursor_plane_destroy,
393	.reset = vmw_du_plane_reset,
394	.atomic_duplicate_state = vmw_du_plane_duplicate_state,
395	.atomic_destroy_state = vmw_du_plane_destroy_state,
396};
397
398/*
399 * Atomic Helpers
400 */
401static const struct
402drm_plane_helper_funcs vmw_ldu_cursor_plane_helper_funcs = {
403	.atomic_check = vmw_du_cursor_plane_atomic_check,
404	.atomic_update = vmw_du_cursor_plane_atomic_update,
405	.prepare_fb = vmw_du_cursor_plane_prepare_fb,
406	.cleanup_fb = vmw_du_cursor_plane_cleanup_fb,
407};
408
409static const struct
410drm_plane_helper_funcs vmw_ldu_primary_plane_helper_funcs = {
411	.atomic_check = vmw_du_primary_plane_atomic_check,
412	.atomic_update = vmw_ldu_primary_plane_atomic_update,
413};
414
415static const struct drm_crtc_helper_funcs vmw_ldu_crtc_helper_funcs = {
416	.mode_set_nofb = vmw_ldu_crtc_mode_set_nofb,
417	.atomic_check = vmw_du_crtc_atomic_check,
418	.atomic_begin = vmw_du_crtc_atomic_begin,
419	.atomic_flush = vmw_du_crtc_atomic_flush,
420	.atomic_enable = vmw_ldu_crtc_atomic_enable,
421	.atomic_disable = vmw_ldu_crtc_atomic_disable,
422};
423
424
425static int vmw_ldu_init(struct vmw_private *dev_priv, unsigned unit)
426{
427	struct vmw_legacy_display_unit *ldu;
428	struct drm_device *dev = &dev_priv->drm;
429	struct drm_connector *connector;
430	struct drm_encoder *encoder;
431	struct drm_plane *primary;
432	struct vmw_cursor_plane *cursor;
433	struct drm_crtc *crtc;
434	int ret;
435
436	ldu = kzalloc(sizeof(*ldu), GFP_KERNEL);
437	if (!ldu)
438		return -ENOMEM;
439
440	ldu->base.unit = unit;
441	crtc = &ldu->base.crtc;
442	encoder = &ldu->base.encoder;
443	connector = &ldu->base.connector;
444	primary = &ldu->base.primary;
445	cursor = &ldu->base.cursor;
446
447	INIT_LIST_HEAD(&ldu->active);
448
449	ldu->base.pref_active = (unit == 0);
450	ldu->base.pref_width = dev_priv->initial_width;
451	ldu->base.pref_height = dev_priv->initial_height;
452	ldu->base.pref_mode = NULL;
453
454	/*
455	 * Remove this after enabling atomic because property values can
456	 * only exist in a state object
457	 */
458	ldu->base.is_implicit = true;
459
460	/* Initialize primary plane */
461	ret = drm_universal_plane_init(dev, primary,
462				       0, &vmw_ldu_plane_funcs,
463				       vmw_primary_plane_formats,
464				       ARRAY_SIZE(vmw_primary_plane_formats),
465				       NULL, DRM_PLANE_TYPE_PRIMARY, NULL);
466	if (ret) {
467		DRM_ERROR("Failed to initialize primary plane");
468		goto err_free;
469	}
470
471	drm_plane_helper_add(primary, &vmw_ldu_primary_plane_helper_funcs);
472
473	/*
474	 * We're going to be using traces and software cursors
475	 */
476	if (vmw_cmd_supported(dev_priv)) {
477		/* Initialize cursor plane */
478		ret = drm_universal_plane_init(dev, &cursor->base,
479					       0, &vmw_ldu_cursor_funcs,
480					       vmw_cursor_plane_formats,
481					       ARRAY_SIZE(vmw_cursor_plane_formats),
482					       NULL, DRM_PLANE_TYPE_CURSOR, NULL);
483		if (ret) {
484			DRM_ERROR("Failed to initialize cursor plane");
485			drm_plane_cleanup(&ldu->base.primary);
486			goto err_free;
487		}
488
489		drm_plane_helper_add(&cursor->base, &vmw_ldu_cursor_plane_helper_funcs);
490	}
491
492	ret = drm_connector_init(dev, connector, &vmw_legacy_connector_funcs,
493				 DRM_MODE_CONNECTOR_VIRTUAL);
494	if (ret) {
495		DRM_ERROR("Failed to initialize connector\n");
496		goto err_free;
497	}
498
499	drm_connector_helper_add(connector, &vmw_ldu_connector_helper_funcs);
500	connector->status = vmw_du_connector_detect(connector, true);
501
502	ret = drm_encoder_init(dev, encoder, &vmw_legacy_encoder_funcs,
503			       DRM_MODE_ENCODER_VIRTUAL, NULL);
504	if (ret) {
505		DRM_ERROR("Failed to initialize encoder\n");
506		goto err_free_connector;
507	}
508
509	(void) drm_connector_attach_encoder(connector, encoder);
510	encoder->possible_crtcs = (1 << unit);
511	encoder->possible_clones = 0;
512
513	ret = drm_connector_register(connector);
514	if (ret) {
515		DRM_ERROR("Failed to register connector\n");
516		goto err_free_encoder;
517	}
518
519	ret = drm_crtc_init_with_planes(dev, crtc, primary,
520		      vmw_cmd_supported(dev_priv) ? &cursor->base : NULL,
521		      &vmw_legacy_crtc_funcs, NULL);
522	if (ret) {
523		DRM_ERROR("Failed to initialize CRTC\n");
524		goto err_free_unregister;
525	}
526
527	drm_crtc_helper_add(crtc, &vmw_ldu_crtc_helper_funcs);
528
529	drm_mode_crtc_set_gamma_size(crtc, 256);
530
531	drm_object_attach_property(&connector->base,
532				   dev_priv->hotplug_mode_update_property, 1);
533	drm_object_attach_property(&connector->base,
534				   dev->mode_config.suggested_x_property, 0);
535	drm_object_attach_property(&connector->base,
536				   dev->mode_config.suggested_y_property, 0);
537	if (dev_priv->implicit_placement_property)
538		drm_object_attach_property
539			(&connector->base,
540			 dev_priv->implicit_placement_property,
541			 1);
542
543	return 0;
544
545err_free_unregister:
546	drm_connector_unregister(connector);
547err_free_encoder:
548	drm_encoder_cleanup(encoder);
549err_free_connector:
550	drm_connector_cleanup(connector);
551err_free:
552	kfree(ldu);
553	return ret;
554}
555
556int vmw_kms_ldu_init_display(struct vmw_private *dev_priv)
557{
558	struct drm_device *dev = &dev_priv->drm;
559	int i, ret;
560	int num_display_units = (dev_priv->capabilities & SVGA_CAP_MULTIMON) ?
561					VMWGFX_NUM_DISPLAY_UNITS : 1;
562
563	if (unlikely(dev_priv->ldu_priv)) {
564		return -EINVAL;
565	}
566
567	dev_priv->ldu_priv = kmalloc(sizeof(*dev_priv->ldu_priv), GFP_KERNEL);
568	if (!dev_priv->ldu_priv)
569		return -ENOMEM;
570
571	INIT_LIST_HEAD(&dev_priv->ldu_priv->active);
572	dev_priv->ldu_priv->num_active = 0;
573	dev_priv->ldu_priv->last_num_active = 0;
574	dev_priv->ldu_priv->fb = NULL;
575
576	vmw_kms_create_implicit_placement_property(dev_priv);
577
578	for (i = 0; i < num_display_units; ++i) {
579		ret = vmw_ldu_init(dev_priv, i);
580		if (ret != 0)
581			goto err_free;
582	}
583
584	dev_priv->active_display_unit = vmw_du_legacy;
585
586	drm_mode_config_reset(dev);
587
588	return 0;
589
590err_free:
591	kfree(dev_priv->ldu_priv);
592	dev_priv->ldu_priv = NULL;
593	return ret;
594}
595
596int vmw_kms_ldu_close_display(struct vmw_private *dev_priv)
597{
598	if (!dev_priv->ldu_priv)
599		return -ENOSYS;
600
601	BUG_ON(!list_empty(&dev_priv->ldu_priv->active));
602
603	kfree(dev_priv->ldu_priv);
604
605	return 0;
606}
607
608
609static int vmw_kms_ldu_do_bo_dirty(struct vmw_private *dev_priv,
610				   struct vmw_framebuffer *framebuffer,
611				   unsigned int flags, unsigned int color,
612				   struct drm_mode_rect *clips,
613				   unsigned int num_clips)
614{
615	size_t fifo_size;
616	int i;
617
618	struct {
619		uint32_t header;
620		SVGAFifoCmdUpdate body;
621	} *cmd;
622
623	fifo_size = sizeof(*cmd) * num_clips;
624	cmd = VMW_CMD_RESERVE(dev_priv, fifo_size);
625	if (unlikely(cmd == NULL))
626		return -ENOMEM;
627
628	memset(cmd, 0, fifo_size);
629	for (i = 0; i < num_clips; i++, clips++) {
630		cmd[i].header = SVGA_CMD_UPDATE;
631		cmd[i].body.x = clips->x1;
632		cmd[i].body.y = clips->y1;
633		cmd[i].body.width = clips->x2 - clips->x1;
634		cmd[i].body.height = clips->y2 - clips->y1;
635	}
636
637	vmw_cmd_commit(dev_priv, fifo_size);
638	return 0;
639}
640