DevVGA_VBVA.cpp@ 71595

Last change on this file since 71595 was 71592, checked in by vboxsync, 7 years ago
DevVGA,VBoxVideo: Code cleanup in progress. bugref:9094
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 99.1 KB

Line
1	/* $Id: DevVGA_VBVA.cpp 71592 2018-03-31 19:51:41Z vboxsync $ */
2	/** @file
3	* VirtualBox Video Acceleration (VBVA).
4	*/
5
6	/*
7	* Copyright (C) 2006-2017 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18
19	/*********************************************************************************************************************************
20	* Header Files *
21	*********************************************************************************************************************************/
22	#define LOG_GROUP LOG_GROUP_DEV_VGA
23	#include <VBox/vmm/pdmifs.h>
24	#include <VBox/vmm/pdmdev.h>
25	#include <VBox/vmm/pgm.h>
26	#include <VBox/vmm/ssm.h>
27	#include <VBox/VMMDev.h>
28	#include <VBoxVideo.h>
29	#include <iprt/alloc.h>
30	#include <iprt/assert.h>
31	#include <iprt/asm.h>
32	#include <iprt/string.h>
33	#include <iprt/param.h>
34	#ifdef VBOX_WITH_VIDEOHWACCEL
35	#include <iprt/semaphore.h>
36	#endif
37
38	#include "DevVGA.h"
39
40	/* A very detailed logging. */
41	#if 0 // def DEBUG_sunlover
42	#define LOGVBVABUFFER(a) LogFlow(a)
43	#else
44	#define LOGVBVABUFFER(a) do {} while (0)
45	#endif
46
47
48	/*********************************************************************************************************************************
49	* Structures and Typedefs *
50	*********************************************************************************************************************************/
51	typedef struct VBVAPARTIALRECORD
52	{
53	uint8_t *pu8;
54	uint32_t cb;
55	} VBVAPARTIALRECORD;
56
57	typedef struct VBVADATA
58	{
59	struct
60	{
61	VBVABUFFER pVBVA; / Pointer to the guest memory with the VBVABUFFER. */
62	uint8_t pu8Data; / For convenience, pointer to the guest ring buffer (VBVABUFFER::au8Data). */
63	} guest;
64	uint32_t u32VBVAOffset; /* VBVABUFFER offset in the guest VRAM. */
65	VBVAPARTIALRECORD partialRecord; /* Partial record temporary storage. */
66	uint32_t off32Data; /* The offset where the data starts in the VBVABUFFER.
67	* The host code uses it instead of VBVABUFFER::off32Data.
68	*/
69	uint32_t indexRecordFirst; /* Index of the first filled record in VBVABUFFER::aRecords. */
70	uint32_t cbPartialWriteThreshold; /* Copy of VBVABUFFER::cbPartialWriteThreshold used by host code. */
71	uint32_t cbData; /* Copy of VBVABUFFER::cbData used by host code. */
72	} VBVADATA;
73
74	typedef struct VBVAVIEW
75	{
76	VBVAINFOVIEW view;
77	VBVAINFOSCREEN screen;
78	VBVADATA vbva;
79	} VBVAVIEW;
80
81	typedef struct VBVAMOUSESHAPEINFO
82	{
83	bool fSet;
84	bool fVisible;
85	bool fAlpha;
86	uint32_t u32HotX;
87	uint32_t u32HotY;
88	uint32_t u32Width;
89	uint32_t u32Height;
90	uint32_t cbShape;
91	uint32_t cbAllocated;
92	uint8_t *pu8Shape;
93	} VBVAMOUSESHAPEINFO;
94
95	/** @todo saved state: save and restore VBVACONTEXT */
96	typedef struct VBVACONTEXT
97	{
98	uint32_t cViews;
99	VBVAVIEW aViews[VBOX_VIDEO_MAX_SCREENS];
100	VBVAMOUSESHAPEINFO mouseShapeInfo;
101	bool fPaused;
102	uint32_t xCursor;
103	uint32_t yCursor;
104	VBVAMODEHINT aModeHints[VBOX_VIDEO_MAX_SCREENS];
105	} VBVACONTEXT;
106
107
108	static void vbvaDataCleanup(VBVADATA *pVBVAData)
109	{
110	if (pVBVAData->guest.pVBVA)
111	{
112	RT_ZERO(pVBVAData->guest.pVBVA->hostFlags);
113	}
114
115	RTMemFree(pVBVAData->partialRecord.pu8);
116
117	RT_ZERO(*pVBVAData);
118	pVBVAData->u32VBVAOffset = HGSMIOFFSET_VOID;
119	}
120
121	/** Copies @a cb bytes from the VBVA ring buffer to the @a pu8Dst.
122	* Used for partial records or for records which cross the ring boundary.
123	*/
124	static bool vbvaFetchBytes(VBVADATA pVBVAData, uint8_t pu8Dst, uint32_t cb)
125	{
126	if (cb >= pVBVAData->cbData)
127	{
128	AssertMsgFailed(("cb = 0x%08X, ring buffer size 0x%08X", cb, pVBVAData->cbData));
129	return false;
130	}
131
132	const uint32_t u32BytesTillBoundary = pVBVAData->cbData - pVBVAData->off32Data;
133	const uint8_t *pu8Src = &pVBVAData->guest.pu8Data[pVBVAData->off32Data];
134	const int32_t i32Diff = cb - u32BytesTillBoundary;
135
136	if (i32Diff <= 0)
137	{
138	/* Chunk will not cross buffer boundary. */
139	memcpy(pu8Dst, pu8Src, cb);
140	}
141	else
142	{
143	/* Chunk crosses buffer boundary. */
144	memcpy(pu8Dst, pu8Src, u32BytesTillBoundary);
145	memcpy(pu8Dst + u32BytesTillBoundary, &pVBVAData->guest.pu8Data[0], i32Diff);
146	}
147
148	/* Advance data offset and sync with guest. */
149	pVBVAData->off32Data = (pVBVAData->off32Data + cb) % pVBVAData->cbData;
150	pVBVAData->guest.pVBVA->off32Data = pVBVAData->off32Data;
151	return true;
152	}
153
154
155	static bool vbvaPartialRead(uint32_t cbRecord, VBVADATA *pVBVAData)
156	{
157	VBVAPARTIALRECORD *pPartialRecord = &pVBVAData->partialRecord;
158	uint8_t *pu8New;
159
160	LOGVBVABUFFER(("vbvaPartialRead: p = %p, cb = %d, cbRecord 0x%08X\n",
161	pPartialRecord->pu8, pPartialRecord->cb, cbRecord));
162
163	Assert(cbRecord > pPartialRecord->cb); /* Caller ensures this. */
164
165	const uint32_t cbChunk = cbRecord - pPartialRecord->cb;
166	if (cbChunk >= pVBVAData->cbData)
167	{
168	return false;
169	}
170
171	if (pPartialRecord->pu8)
172	{
173	Assert(pPartialRecord->cb);
174	pu8New = (uint8_t *)RTMemRealloc(pPartialRecord->pu8, cbRecord);
175	}
176	else
177	{
178	Assert(!pPartialRecord->cb);
179	pu8New = (uint8_t *)RTMemAlloc(cbRecord);
180	}
181
182	if (!pu8New)
183	{
184	/* Memory allocation failed, fail the function. */
185	Log(("vbvaPartialRead: failed to (re)alocate memory for partial record!!! cbRecord 0x%08X\n",
186	cbRecord));
187
188	return false;
189	}
190
191	/* Fetch data from the ring buffer. */
192	if (!vbvaFetchBytes(pVBVAData, pu8New + pPartialRecord->cb, cbChunk))
193	{
194	return false;
195	}
196
197	pPartialRecord->pu8 = pu8New;
198	pPartialRecord->cb = cbRecord;
199
200	return true;
201	}
202
203	/* For contiguous chunks just return the address in the buffer.
204	* For crossing boundary - allocate a buffer from heap.
205	*/
206	static bool vbvaFetchCmd(VBVADATA pVBVAData, VBVACMDHDR ppHdr, uint32_t pcbCmd)
207	{
208	VBVAPARTIALRECORD *pPartialRecord = &pVBVAData->partialRecord;
209	uint32_t indexRecordFirst = pVBVAData->indexRecordFirst;
210	const uint32_t indexRecordFree = ASMAtomicReadU32(&pVBVAData->guest.pVBVA->indexRecordFree);
211
212	LOGVBVABUFFER(("first = %d, free = %d\n",
213	indexRecordFirst, indexRecordFree));
214
215	if (indexRecordFree >= RT_ELEMENTS(pVBVAData->guest.pVBVA->aRecords))
216	{
217	return false;
218	}
219
220	if (indexRecordFirst == indexRecordFree)
221	{
222	/* No records to process. Return without assigning output variables. */
223	return true;
224	}
225
226	uint32_t cbRecordCurrent = ASMAtomicReadU32(&pVBVAData->guest.pVBVA->aRecords[indexRecordFirst].cbRecord);
227
228	LOGVBVABUFFER(("cbRecord = 0x%08X, pPartialRecord->cb = 0x%08X\n", cbRecordCurrent, pPartialRecord->cb));
229
230	uint32_t cbRecord = cbRecordCurrent & ~VBVA_F_RECORD_PARTIAL;
231
232	if (cbRecord > VBVA_MAX_RECORD_SIZE)
233	{
234	return false;
235	}
236
237	if (pPartialRecord->cb)
238	{
239	/* There is a partial read in process. Continue with it. */
240	Assert (pPartialRecord->pu8);
241
242	LOGVBVABUFFER(("continue partial record cb = %d cbRecord 0x%08X, first = %d, free = %d\n",
243	pPartialRecord->cb, cbRecordCurrent, indexRecordFirst, indexRecordFree));
244
245	if (cbRecord > pPartialRecord->cb)
246	{
247	/* New data has been added to the record. */
248	if (!vbvaPartialRead(cbRecord, pVBVAData))
249	{
250	return false;
251	}
252	}
253
254	if (!(cbRecordCurrent & VBVA_F_RECORD_PARTIAL))
255	{
256	/* The record is completed by guest. Return it to the caller. */
257	ppHdr = (VBVACMDHDR )pPartialRecord->pu8;
258	*pcbCmd = pPartialRecord->cb;
259
260	pPartialRecord->pu8 = NULL;
261	pPartialRecord->cb = 0;
262
263	/* Advance the record index and sync with guest. */
264	pVBVAData->indexRecordFirst = (indexRecordFirst + 1) % RT_ELEMENTS(pVBVAData->guest.pVBVA->aRecords);
265	pVBVAData->guest.pVBVA->indexRecordFirst = pVBVAData->indexRecordFirst;
266
267	LOGVBVABUFFER(("partial done ok, data = %d, free = %d\n",
268	pVBVAData->off32Data, pVBVAData->guest.pVBVA->off32Free));
269	}
270
271	return true;
272	}
273
274	/* A new record need to be processed. */
275	if (cbRecordCurrent & VBVA_F_RECORD_PARTIAL)
276	{
277	/* Current record is being written by guest. '=' is important here,
278	* because the guest will do a FLUSH at this condition.
279	* This partial record is too large for the ring buffer and must
280	* be accumulated in an allocated buffer.
281	*/
282	if (cbRecord >= pVBVAData->cbData - pVBVAData->cbPartialWriteThreshold)
283	{
284	/* Partial read must be started. */
285	if (!vbvaPartialRead(cbRecord, pVBVAData))
286	{
287	return false;
288	}
289
290	LOGVBVABUFFER(("started partial record cb = 0x%08X cbRecord 0x%08X, first = %d, free = %d\n",
291	pPartialRecord->cb, cbRecordCurrent, indexRecordFirst, indexRecordFree));
292	}
293
294	return true;
295	}
296
297	/* Current record is complete. If it is not empty, process it. */
298	if (cbRecord >= pVBVAData->cbData)
299	{
300	return false;
301	}
302
303	if (cbRecord)
304	{
305	/* The size of largest contiguous chunk in the ring buffer. */
306	uint32_t u32BytesTillBoundary = pVBVAData->cbData - pVBVAData->off32Data;
307
308	/* The pointer to data in the ring buffer. */
309	uint8_t *pu8Src = &pVBVAData->guest.pu8Data[pVBVAData->off32Data];
310
311	/* Fetch or point the data. */
312	if (u32BytesTillBoundary >= cbRecord)
313	{
314	/* The command does not cross buffer boundary. Return address in the buffer. */
315	ppHdr = (VBVACMDHDR )pu8Src;
316
317	/* The data offset will be updated in vbvaReleaseCmd. */
318	}
319	else
320	{
321	/* The command crosses buffer boundary. Rare case, so not optimized. */
322	uint8_t pu8Dst = (uint8_t )RTMemAlloc(cbRecord);
323
324	if (!pu8Dst)
325	{
326	LogFlowFunc (("could not allocate %d bytes from heap!!!\n", cbRecord));
327	return false;
328	}
329
330	vbvaFetchBytes(pVBVAData, pu8Dst, cbRecord);
331
332	ppHdr = (VBVACMDHDR )pu8Dst;
333
334	LOGVBVABUFFER(("Allocated from heap %p\n", pu8Dst));
335	}
336	}
337
338	*pcbCmd = cbRecord;
339
340	/* Advance the record index and sync with guest. */
341	pVBVAData->indexRecordFirst = (indexRecordFirst + 1) % RT_ELEMENTS(pVBVAData->guest.pVBVA->aRecords);
342	pVBVAData->guest.pVBVA->indexRecordFirst = pVBVAData->indexRecordFirst;
343
344	LOGVBVABUFFER(("done ok, data = %d, free = %d\n",
345	pVBVAData->off32Data, pVBVAData->guest.pVBVA->off32Free));
346
347	return true;
348	}
349
350	static void vbvaReleaseCmd(VBVADATA pVBVAData, VBVACMDHDR pHdr, uint32_t cbCmd)
351	{
352	VBVAPARTIALRECORD *pPartialRecord = &pVBVAData->partialRecord;
353	const uint8_t *au8RingBuffer = pVBVAData->guest.pu8Data;
354
355	if ( (uintptr_t)pHdr >= (uintptr_t)au8RingBuffer
356	&& (uintptr_t)pHdr < (uintptr_t)&au8RingBuffer[pVBVAData->cbData])
357	{
358	/* The pointer is inside ring buffer. Must be continuous chunk. */
359	Assert(pVBVAData->cbData - (uint32_t)((uint8_t *)pHdr - au8RingBuffer) >= cbCmd);
360
361	/* Advance data offset and sync with guest. */
362	pVBVAData->off32Data = (pVBVAData->off32Data + cbCmd) % pVBVAData->cbData;
363	pVBVAData->guest.pVBVA->off32Data = pVBVAData->off32Data;
364
365	Assert(!pPartialRecord->pu8 && pPartialRecord->cb == 0);
366	}
367	else
368	{
369	/* The pointer is outside. It is then an allocated copy. */
370	LOGVBVABUFFER(("Free heap %p\n", pHdr));
371
372	if ((uint8_t *)pHdr == pPartialRecord->pu8)
373	{
374	pPartialRecord->pu8 = NULL;
375	pPartialRecord->cb = 0;
376	}
377	else
378	{
379	Assert(!pPartialRecord->pu8 && pPartialRecord->cb == 0);
380	}
381
382	RTMemFree(pHdr);
383	}
384	}
385
386	static int vbvaFlushProcess(unsigned uScreenId, PVGASTATE pVGAState, VBVADATA *pVBVAData)
387	{
388	LOGVBVABUFFER(("uScreenId %d, indexRecordFirst = %d, indexRecordFree = %d, off32Data = %d, off32Free = %d\n",
389	uScreenId, pVBVAData->indexRecordFirst, pVBVAData->guest.pVBVA->indexRecordFree,
390	pVBVAData->off32Data, pVBVAData->guest.pVBVA->off32Free));
391	struct {
392	/* The rectangle that includes all dirty rectangles. */
393	int32_t xLeft;
394	int32_t xRight;
395	int32_t yTop;
396	int32_t yBottom;
397	} dirtyRect;
398	RT_ZERO(dirtyRect);
399
400	bool fUpdate = false; /* Whether there were any updates. */
401	bool fDirtyEmpty = true;
402
403	for (;;)
404	{
405	VBVACMDHDR *phdr = NULL;
406	uint32_t cbCmd = UINT32_MAX;
407
408	/* Fetch the command data. */
409	if (!vbvaFetchCmd(pVBVAData, &phdr, &cbCmd))
410	{
411	LogFunc(("unable to fetch command. off32Data = %d, off32Free = %d!!!\n",
412	pVBVAData->off32Data, pVBVAData->guest.pVBVA->off32Free));
413
414	return VERR_NOT_SUPPORTED;
415	}
416
417	if (cbCmd == uint32_t(~0))
418	{
419	/* No more commands yet in the queue. */
420	break;
421	}
422
423	if (cbCmd < sizeof(VBVACMDHDR))
424	{
425	LogFunc(("short command. off32Data = %d, off32Free = %d, cbCmd %d!!!\n",
426	pVBVAData->off32Data, pVBVAData->guest.pVBVA->off32Free, cbCmd));
427
428	return VERR_NOT_SUPPORTED;
429	}
430
431	if (cbCmd != 0)
432	{
433	if (!fUpdate)
434	{
435	pVGAState->pDrv->pfnVBVAUpdateBegin(pVGAState->pDrv, uScreenId);
436	fUpdate = true;
437	}
438
439	/* Updates the rectangle and sends the command to the VRDP server. */
440	pVGAState->pDrv->pfnVBVAUpdateProcess(pVGAState->pDrv, uScreenId, phdr, cbCmd);
441
442	int32_t xRight = phdr->x + phdr->w;
443	int32_t yBottom = phdr->y + phdr->h;
444
445	/* These are global coords, relative to the primary screen. */
446
447	LOGVBVABUFFER(("cbCmd = %d, x=%d, y=%d, w=%d, h=%d\n",
448	cbCmd, phdr->x, phdr->y, phdr->w, phdr->h));
449	LogRel3(("%s: update command cbCmd = %d, x=%d, y=%d, w=%d, h=%d\n",
450	__FUNCTION__, cbCmd, phdr->x, phdr->y, phdr->w, phdr->h));
451
452	/* Collect all rects into one. */
453	if (fDirtyEmpty)
454	{
455	/* This is the first rectangle to be added. */
456	dirtyRect.xLeft = phdr->x;
457	dirtyRect.yTop = phdr->y;
458	dirtyRect.xRight = xRight;
459	dirtyRect.yBottom = yBottom;
460	fDirtyEmpty = false;
461	}
462	else
463	{
464	/* Adjust region coordinates. */
465	if (dirtyRect.xLeft > phdr->x)
466	{
467	dirtyRect.xLeft = phdr->x;
468	}
469
470	if (dirtyRect.yTop > phdr->y)
471	{
472	dirtyRect.yTop = phdr->y;
473	}
474
475	if (dirtyRect.xRight < xRight)
476	{
477	dirtyRect.xRight = xRight;
478	}
479
480	if (dirtyRect.yBottom < yBottom)
481	{
482	dirtyRect.yBottom = yBottom;
483	}
484	}
485	}
486
487	vbvaReleaseCmd(pVBVAData, phdr, cbCmd);
488	}
489
490	if (fUpdate)
491	{
492	if (dirtyRect.xRight - dirtyRect.xLeft)
493	{
494	LogRel3(("%s: sending update screen=%d, x=%d, y=%d, w=%d, h=%d\n",
495	__FUNCTION__, uScreenId, dirtyRect.xLeft,
496	dirtyRect.yTop, dirtyRect.xRight - dirtyRect.xLeft,
497	dirtyRect.yBottom - dirtyRect.yTop));
498	pVGAState->pDrv->pfnVBVAUpdateEnd(pVGAState->pDrv, uScreenId, dirtyRect.xLeft, dirtyRect.yTop,
499	dirtyRect.xRight - dirtyRect.xLeft, dirtyRect.yBottom - dirtyRect.yTop);
500	}
501	else
502	{
503	pVGAState->pDrv->pfnVBVAUpdateEnd(pVGAState->pDrv, uScreenId, 0, 0, 0, 0);
504	}
505	}
506
507	return VINF_SUCCESS;
508	}
509
510	static int vbvaFlush(PVGASTATE pVGAState, VBVACONTEXT *pCtx)
511	{
512	int rc = VINF_SUCCESS;
513
514	unsigned uScreenId;
515	for (uScreenId = 0; uScreenId < pCtx->cViews; uScreenId++)
516	{
517	VBVADATA *pVBVAData = &pCtx->aViews[uScreenId].vbva;
518
519	if (pVBVAData->guest.pVBVA)
520	{
521	rc = vbvaFlushProcess(uScreenId, pVGAState, pVBVAData);
522	if (RT_FAILURE(rc))
523	{
524	break;
525	}
526	}
527	}
528
529	if (RT_FAILURE(rc))
530	{
531	/* Turn off VBVA processing. */
532	LogRel(("VBVA: Disabling (%Rrc)\n", rc));
533	pVGAState->fGuestCaps = 0;
534	pVGAState->pDrv->pfnVBVAGuestCapabilityUpdate(pVGAState->pDrv, pVGAState->fGuestCaps);
535	for (uScreenId = 0; uScreenId < pCtx->cViews; uScreenId++)
536	{
537	VBVADATA *pVBVAData = &pCtx->aViews[uScreenId].vbva;
538	if (pVBVAData->guest.pVBVA)
539	{
540	vbvaDataCleanup(pVBVAData);
541	pVGAState->pDrv->pfnVBVADisable(pVGAState->pDrv, uScreenId);
542	}
543	}
544	}
545
546	return rc;
547	}
548
549	static int vbvaResize(PVGASTATE pVGAState, VBVAVIEW pView, const VBVAINFOSCREEN pNewScreen, bool fResetInputMapping)
550	{
551	/* Callers ensure that pNewScreen contains valid data. */
552
553	/* Apply these changes. */
554	pView->screen = *pNewScreen;
555
556	uint8_t *pu8VRAM = pVGAState->vram_ptrR3 + pView->view.u32ViewOffset;
557	return pVGAState->pDrv->pfnVBVAResize (pVGAState->pDrv, &pView->view, &pView->screen, pu8VRAM, fResetInputMapping);
558	}
559
560	static int vbvaEnable(unsigned uScreenId, PVGASTATE pVGAState, VBVACONTEXT pCtx, VBVABUFFER pVBVA, uint32_t u32Offset, bool fRestored)
561	{
562	int rc;
563
564	/* Check if VBVABUFFER content makes sense. */
565	const VBVABUFFER parms = *pVBVA;
566
567	uint32_t cbVBVABuffer = RT_UOFFSETOF(VBVABUFFER, au8Data) + parms.cbData;
568	if ( parms.cbData > UINT32_MAX - RT_UOFFSETOF(VBVABUFFER, au8Data)
569	\|\| cbVBVABuffer > pVGAState->vram_size
570	\|\| u32Offset > pVGAState->vram_size - cbVBVABuffer)
571	{
572	return VERR_INVALID_PARAMETER;
573	}
574
575	if (!fRestored)
576	{
577	if ( parms.off32Data != 0
578	\|\| parms.off32Free != 0
579	\|\| parms.indexRecordFirst != 0
580	\|\| parms.indexRecordFree != 0)
581	{
582	return VERR_INVALID_PARAMETER;
583	}
584	}
585
586	if ( parms.cbPartialWriteThreshold >= parms.cbData
587	\|\| parms.cbPartialWriteThreshold == 0)
588	{
589	return VERR_INVALID_PARAMETER;
590	}
591
592	if (pVGAState->pDrv->pfnVBVAEnable)
593	{
594	RT_ZERO(pVBVA->hostFlags);
595	rc = pVGAState->pDrv->pfnVBVAEnable(pVGAState->pDrv, uScreenId, &pVBVA->hostFlags, false);
596	}
597	else
598	{
599	rc = VERR_NOT_SUPPORTED;
600	}
601
602	if (RT_SUCCESS(rc))
603	{
604	/* pVBVA->hostFlags has been set up by pfnVBVAEnable. */
605	LogFlowFunc(("u32HostEvents 0x%08X, u32SupportedOrders 0x%08X\n",
606	pVBVA->hostFlags.u32HostEvents, pVBVA->hostFlags.u32SupportedOrders));
607
608	VBVADATA *pVBVAData = &pCtx->aViews[uScreenId].vbva;
609	pVBVAData->guest.pVBVA = pVBVA;
610	pVBVAData->guest.pu8Data = &pVBVA->au8Data[0];
611	pVBVAData->u32VBVAOffset = u32Offset;
612	pVBVAData->off32Data = parms.off32Data;
613	pVBVAData->indexRecordFirst = parms.indexRecordFirst;
614	pVBVAData->cbPartialWriteThreshold = parms.cbPartialWriteThreshold;
615	pVBVAData->cbData = parms.cbData;
616
617	if (!fRestored)
618	{
619	/** @todo Actually this function must not touch the partialRecord structure at all,
620	* because initially it is a zero and when VBVA is disabled this should be set to zero.
621	* But I'm not sure that no code depends on zeroing partialRecord here.
622	* So for now (a quick fix for 4.1) just do not do this if the VM was restored,
623	* when partialRecord might be loaded already from the saved state.
624	*/
625	pVBVAData->partialRecord.pu8 = NULL;
626	pVBVAData->partialRecord.cb = 0;
627	}
628
629	/* VBVA is working so disable the pause. */
630	pCtx->fPaused = false;
631	}
632
633	return rc;
634	}
635
636	static int vbvaDisable (unsigned uScreenId, PVGASTATE pVGAState, VBVACONTEXT *pCtx)
637	{
638	/* Process any pending orders and empty the VBVA ring buffer. */
639	vbvaFlush (pVGAState, pCtx);
640
641	VBVADATA *pVBVAData = &pCtx->aViews[uScreenId].vbva;
642	vbvaDataCleanup(pVBVAData);
643
644	if (uScreenId == 0)
645	{
646	pVGAState->fGuestCaps = 0;
647	pVGAState->pDrv->pfnVBVAGuestCapabilityUpdate(pVGAState->pDrv, pVGAState->fGuestCaps);
648	}
649	pVGAState->pDrv->pfnVBVADisable(pVGAState->pDrv, uScreenId);
650	return VINF_SUCCESS;
651	}
652
653	bool VBVAIsEnabled(PVGASTATE pVGAState)
654	{
655	PHGSMIINSTANCE pHGSMI = pVGAState->pHGSMI;
656	if (pHGSMI)
657	{
658	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pHGSMI);
659	if (pCtx)
660	{
661	if (pCtx->cViews)
662	{
663	VBVAVIEW * pView = &pCtx->aViews[0];
664	if (pView->vbva.guest.pVBVA)
665	return true;
666	}
667	}
668	}
669	return false;
670	}
671
672	#ifdef DEBUG_sunlover
673	void dumpMouseShapeInfo(const VBVAMOUSESHAPEINFO *pMouseShapeInfo)
674	{
675	LogFlow(("fSet = %d, fVisible %d, fAlpha %d, @%d,%d %dx%d (%p, %d/%d)\n",
676	pMouseShapeInfo->fSet,
677	pMouseShapeInfo->fVisible,
678	pMouseShapeInfo->fAlpha,
679	pMouseShapeInfo->u32HotX,
680	pMouseShapeInfo->u32HotY,
681	pMouseShapeInfo->u32Width,
682	pMouseShapeInfo->u32Height,
683	pMouseShapeInfo->pu8Shape,
684	pMouseShapeInfo->cbShape,
685	pMouseShapeInfo->cbAllocated
686	));
687	}
688	#endif
689
690	static int vbvaUpdateMousePointerShape(PVGASTATE pVGAState, VBVAMOUSESHAPEINFO *pMouseShapeInfo, bool fShape)
691	{
692	LogFlowFunc(("pVGAState %p, pMouseShapeInfo %p, fShape %d\n",
693	pVGAState, pMouseShapeInfo, fShape));
694	#ifdef DEBUG_sunlover
695	dumpMouseShapeInfo(pMouseShapeInfo);
696	#endif
697
698	if (pVGAState->pDrv->pfnVBVAMousePointerShape == NULL)
699	{
700	return VERR_NOT_SUPPORTED;
701	}
702
703	int rc;
704	if (fShape && pMouseShapeInfo->pu8Shape != NULL)
705	{
706	rc = pVGAState->pDrv->pfnVBVAMousePointerShape (pVGAState->pDrv,
707	pMouseShapeInfo->fVisible,
708	pMouseShapeInfo->fAlpha,
709	pMouseShapeInfo->u32HotX,
710	pMouseShapeInfo->u32HotY,
711	pMouseShapeInfo->u32Width,
712	pMouseShapeInfo->u32Height,
713	pMouseShapeInfo->pu8Shape);
714	}
715	else
716	{
717	rc = pVGAState->pDrv->pfnVBVAMousePointerShape (pVGAState->pDrv,
718	pMouseShapeInfo->fVisible,
719	false,
720	0, 0,
721	0, 0,
722	NULL);
723	}
724
725	return rc;
726	}
727
728	static int vbvaMousePointerShape(PVGASTATE pVGAState, VBVACONTEXT *pCtx,
729	const VBVAMOUSEPOINTERSHAPE RT_UNTRUSTED_VOLATILE_GUEST *pShape, HGSMISIZE cbShape)
730	{
731	VBVAMOUSEPOINTERSHAPE parms;
732	memcpy(&parms, (void *)pShape, sizeof(parms));
733	ASMCompilerBarrier();
734
735	LogFlowFunc(("VBVA_MOUSE_POINTER_SHAPE: i32Result 0x%x, fu32Flags 0x%x, hot spot %d,%d, size %dx%d\n",
736	parms.i32Result,
737	parms.fu32Flags,
738	parms.u32HotX,
739	parms.u32HotY,
740	parms.u32Width,
741	parms.u32Height));
742
743	const bool fVisible = RT_BOOL(parms.fu32Flags & VBOX_MOUSE_POINTER_VISIBLE);
744	const bool fAlpha = RT_BOOL(parms.fu32Flags & VBOX_MOUSE_POINTER_ALPHA);
745	const bool fShape = RT_BOOL(parms.fu32Flags & VBOX_MOUSE_POINTER_SHAPE);
746
747	HGSMISIZE cbPointerData = 0;
748
749	if (fShape)
750	{
751	if (parms.u32Width > 8192 \|\| parms.u32Height > 8192)
752	{
753	Log(("vbvaMousePointerShape: unsupported size %ux%u\n", parms.u32Width, parms.u32Height));
754	return VERR_INVALID_PARAMETER;
755	}
756
757	cbPointerData = ((((parms.u32Width + 7) / 8) * parms.u32Height + 3) & ~3)
758	+ parms.u32Width * 4 * parms.u32Height;
759	}
760
761	if (cbPointerData > cbShape - RT_UOFFSETOF(VBVAMOUSEPOINTERSHAPE, au8Data))
762	{
763	Log(("vbvaMousePointerShape: calculated pointer data size is too big (%d bytes, limit %d)\n",
764	cbPointerData, cbShape - RT_UOFFSETOF(VBVAMOUSEPOINTERSHAPE, au8Data)));
765	return VERR_INVALID_PARAMETER;
766	}
767
768	/* Save mouse info it will be used to restore mouse pointer after restoring saved state. */
769	pCtx->mouseShapeInfo.fSet = true;
770	pCtx->mouseShapeInfo.fVisible = fVisible;
771	if (fShape)
772	{
773	/* Data related to shape. */
774	pCtx->mouseShapeInfo.u32HotX = parms.u32HotX;
775	pCtx->mouseShapeInfo.u32HotY = parms.u32HotY;
776	pCtx->mouseShapeInfo.u32Width = parms.u32Width;
777	pCtx->mouseShapeInfo.u32Height = parms.u32Height;
778	pCtx->mouseShapeInfo.fAlpha = fAlpha;
779
780	/* Reallocate memory buffer if necessary. */
781	if (cbPointerData > pCtx->mouseShapeInfo.cbAllocated)
782	{
783	RTMemFree (pCtx->mouseShapeInfo.pu8Shape);
784	pCtx->mouseShapeInfo.pu8Shape = NULL;
785	pCtx->mouseShapeInfo.cbShape = 0;
786
787	uint8_t pu8Shape = (uint8_t )RTMemAlloc (cbPointerData);
788	if (pu8Shape)
789	{
790	pCtx->mouseShapeInfo.pu8Shape = pu8Shape;
791	pCtx->mouseShapeInfo.cbAllocated = cbPointerData;
792	}
793	}
794
795	/* Copy shape bitmaps. */
796	if (pCtx->mouseShapeInfo.pu8Shape)
797	{
798	memcpy(pCtx->mouseShapeInfo.pu8Shape, (void *)&pShape->au8Data[0], cbPointerData);
799	pCtx->mouseShapeInfo.cbShape = cbPointerData;
800	}
801	}
802
803	int rc = vbvaUpdateMousePointerShape(pVGAState, &pCtx->mouseShapeInfo, fShape);
804
805	return rc;
806	}
807
808	static uint32_t vbvaViewFromBufferPtr(PHGSMIINSTANCE pIns, const VBVACONTEXT *pCtx,
809	const void RT_UNTRUSTED_VOLATILE_GUEST *pvBuffer)
810	{
811	/* Check which view contains the buffer. */
812	HGSMIOFFSET offBuffer = HGSMIPointerToOffsetHost(pIns, pvBuffer);
813
814	if (offBuffer != HGSMIOFFSET_VOID)
815	{
816	unsigned uScreenId;
817	for (uScreenId = 0; uScreenId < pCtx->cViews; uScreenId++)
818	{
819	const VBVAINFOVIEW *pView = &pCtx->aViews[uScreenId].view;
820
821	if ( pView->u32ViewSize > 0
822	&& pView->u32ViewOffset <= offBuffer
823	&& offBuffer <= pView->u32ViewOffset + pView->u32ViewSize - 1)
824	{
825	return pView->u32ViewIndex;
826	}
827	}
828	}
829
830	return UINT32_MAX;
831	}
832
833	#ifdef DEBUG_sunlover
834	static void dumpctx(const VBVACONTEXT *pCtx)
835	{
836	Log(("VBVACONTEXT dump: cViews %d\n", pCtx->cViews));
837
838	uint32_t iView;
839	for (iView = 0; iView < pCtx->cViews; iView++)
840	{
841	const VBVAVIEW *pView = &pCtx->aViews[iView];
842
843	Log((" view %d o 0x%x s 0x%x m 0x%x\n",
844	pView->view.u32ViewIndex,
845	pView->view.u32ViewOffset,
846	pView->view.u32ViewSize,
847	pView->view.u32MaxScreenSize));
848
849	Log((" screen %d @%d,%d s 0x%x l 0x%x %dx%d bpp %d f 0x%x\n",
850	pView->screen.u32ViewIndex,
851	pView->screen.i32OriginX,
852	pView->screen.i32OriginY,
853	pView->screen.u32StartOffset,
854	pView->screen.u32LineSize,
855	pView->screen.u32Width,
856	pView->screen.u32Height,
857	pView->screen.u16BitsPerPixel,
858	pView->screen.u16Flags));
859
860	Log((" VBVA o 0x%x p %p\n",
861	pView->vbva.u32VBVAOffset,
862	pView->vbva.guest.pVBVA));
863
864	Log((" PR cb 0x%x p %p\n",
865	pView->vbva.partialRecord.cb,
866	pView->vbva.partialRecord.pu8));
867	}
868
869	dumpMouseShapeInfo(&pCtx->mouseShapeInfo);
870	}
871	#endif /* DEBUG_sunlover */
872
873	#define VBOXVBVASAVEDSTATE_VHWAAVAILABLE_MAGIC 0x12345678
874	#define VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC 0x9abcdef0
875
876	#ifdef VBOX_WITH_VIDEOHWACCEL
877	static void vbvaVHWAHHCommandReinit(VBOXVHWACMD* pHdr, VBOXVHWACMD_TYPE enmCmd, int32_t iDisplay)
878	{
879	memset(pHdr, 0, VBOXVHWACMD_HEADSIZE());
880	pHdr->cRefs = 1;
881	pHdr->iDisplay = iDisplay;
882	pHdr->rc = VERR_NOT_IMPLEMENTED;
883	pHdr->enmCmd = enmCmd;
884	pHdr->Flags = VBOXVHWACMD_FLAG_HH_CMD;
885	}
886
887	static VBOXVHWACMD *vbvaVHWAHHCommandCreate(VBOXVHWACMD_TYPE enmCmd, int32_t iDisplay, VBOXVHWACMD_LENGTH cbCmd)
888	{
889	VBOXVHWACMD pHdr = (VBOXVHWACMD )RTMemAllocZ(cbCmd + VBOXVHWACMD_HEADSIZE());
890	Assert(pHdr);
891	if (pHdr)
892	vbvaVHWAHHCommandReinit(pHdr, enmCmd, iDisplay);
893
894	return pHdr;
895	}
896
897	DECLINLINE(void) vbvaVHWAHHCommandRelease(VBOXVHWACMD *pCmd)
898	{
899	uint32_t cRefs = ASMAtomicDecU32(&pCmd->cRefs);
900	if (!cRefs)
901	RTMemFree(pCmd);
902	}
903
904	DECLINLINE(void) vbvaVHWAHHCommandRetain(VBOXVHWACMD *pCmd)
905	{
906	ASMAtomicIncU32(&pCmd->cRefs);
907	}
908
909	static void vbvaVHWACommandComplete(PVGASTATE pVGAState, VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *pCommand, bool fAsyncCommand)
910	{
911	if (fAsyncCommand)
912	{
913	Assert(pCommand->Flags & VBOXVHWACMD_FLAG_HG_ASYNCH);
914	vbvaVHWACommandCompleteAsync(&pVGAState->IVBVACallbacks, pCommand);
915	}
916	else
917	{
918	Log(("VGA Command <<< Sync rc %d %#p, %d\n", pCommand->rc, pCommand, pCommand->enmCmd));
919	pCommand->Flags &= ~VBOXVHWACMD_FLAG_HG_ASYNCH;
920	}
921
922	}
923
924	static void vbvaVHWACommandCompleteAllPending(PVGASTATE pVGAState, int rc)
925	{
926	if (!ASMAtomicUoReadU32(&pVGAState->pendingVhwaCommands.cPending))
927	return;
928
929	PDMCritSectEnter(&pVGAState->CritSect, VERR_SEM_BUSY);
930
931	VBOX_VHWA_PENDINGCMD pIter, pNext;
932	RTListForEachSafe(&pVGAState->pendingVhwaCommands.PendingList, pIter, pNext, VBOX_VHWA_PENDINGCMD, Node)
933	{
934	pIter->pCommand->rc = rc;
935	vbvaVHWACommandComplete(pVGAState, pIter->pCommand, true);
936
937	/* the command is submitted/processed, remove from the pend list */
938	RTListNodeRemove(&pIter->Node);
939	ASMAtomicDecU32(&pVGAState->pendingVhwaCommands.cPending);
940	RTMemFree(pIter);
941	}
942
943	PDMCritSectLeave(&pVGAState->CritSect);
944	}
945
946	static void vbvaVHWACommandClearAllPending(PVGASTATE pVGAState)
947	{
948	if (!ASMAtomicUoReadU32(&pVGAState->pendingVhwaCommands.cPending))
949	return;
950
951	PDMCritSectEnter(&pVGAState->CritSect, VERR_SEM_BUSY);
952
953	VBOX_VHWA_PENDINGCMD pIter, pNext;
954	RTListForEachSafe(&pVGAState->pendingVhwaCommands.PendingList, pIter, pNext, VBOX_VHWA_PENDINGCMD, Node)
955	{
956	RTListNodeRemove(&pIter->Node);
957	ASMAtomicDecU32(&pVGAState->pendingVhwaCommands.cPending);
958	RTMemFree(pIter);
959	}
960
961	PDMCritSectLeave(&pVGAState->CritSect);
962	}
963
964	static void vbvaVHWACommandPend(PVGASTATE pVGAState, VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *pCommand)
965	{
966	int rc = VERR_BUFFER_OVERFLOW;
967
968	if (ASMAtomicUoReadU32(&pVGAState->pendingVhwaCommands.cPending) < VBOX_VHWA_MAX_PENDING_COMMANDS)
969	{
970	VBOX_VHWA_PENDINGCMD pPend = (VBOX_VHWA_PENDINGCMD )RTMemAlloc(sizeof(*pPend));
971	if (pPend)
972	{
973	pCommand->Flags \|= VBOXVHWACMD_FLAG_HG_ASYNCH;
974	pPend->pCommand = pCommand;
975	PDMCritSectEnter(&pVGAState->CritSect, VERR_SEM_BUSY);
976	if (ASMAtomicUoReadU32(&pVGAState->pendingVhwaCommands.cPending) < VBOX_VHWA_MAX_PENDING_COMMANDS)
977	{
978	RTListAppend(&pVGAState->pendingVhwaCommands.PendingList, &pPend->Node);
979	ASMAtomicIncU32(&pVGAState->pendingVhwaCommands.cPending);
980	PDMCritSectLeave(&pVGAState->CritSect);
981	return;
982	}
983	PDMCritSectLeave(&pVGAState->CritSect);
984	LogRel(("VBVA: Pending command count has reached its threshold.. completing them all.."));
985	RTMemFree(pPend);
986	}
987	else
988	rc = VERR_NO_MEMORY;
989	}
990	else
991	LogRel(("VBVA: Pending command count has reached its threshold, completing them all.."));
992
993	vbvaVHWACommandCompleteAllPending(pVGAState, rc);
994
995	pCommand->rc = rc;
996
997	vbvaVHWACommandComplete(pVGAState, pCommand, false);
998	}
999
1000	static bool vbvaVHWACommandCanPend(VBOXVHWACMD_TYPE enmCmd)
1001	{
1002	switch (enmCmd)
1003	{
1004	case VBOXVHWACMD_TYPE_HH_CONSTRUCT:
1005	case VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEBEGIN:
1006	case VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEEND:
1007	case VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEPERFORM:
1008	case VBOXVHWACMD_TYPE_HH_SAVESTATE_LOADPERFORM:
1009	return false;
1010	default:
1011	return true;
1012	}
1013	}
1014
1015	static int vbvaVHWACommandSavePending(PVGASTATE pVGAState, PSSMHANDLE pSSM)
1016	{
1017	int rc = SSMR3PutU32(pSSM, pVGAState->pendingVhwaCommands.cPending);
1018	AssertRCReturn(rc, rc);
1019
1020	VBOX_VHWA_PENDINGCMD *pIter;
1021	RTListForEach(&pVGAState->pendingVhwaCommands.PendingList, pIter, VBOX_VHWA_PENDINGCMD, Node)
1022	{
1023	rc = SSMR3PutU32(pSSM, (uint32_t)(((uint8_t)pIter->pCommand) - ((uint8_t)pVGAState->vram_ptrR3)));
1024	AssertRCReturn(rc, rc);
1025	}
1026	return rc;
1027	}
1028
1029	static int vbvaVHWACommandLoadPending(PVGASTATE pVGAState, PSSMHANDLE pSSM, uint32_t u32Version)
1030	{
1031	if (u32Version < VGA_SAVEDSTATE_VERSION_WITH_PENDVHWA)
1032	return VINF_SUCCESS;
1033
1034	uint32_t u32;
1035	int rc = SSMR3GetU32(pSSM, &u32);
1036	AssertRCReturn(rc, rc);
1037	for (uint32_t i = 0; i < u32; ++i)
1038	{
1039	uint32_t off32;
1040	rc = SSMR3GetU32(pSSM, &off32);
1041	AssertRCReturn(rc, rc);
1042	VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *pCommand
1043	= (VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST )((uint8_t volatile )pVGAState->vram_ptrR3 + off32);
1044	vbvaVHWACommandPend(pVGAState, pCommand);
1045	}
1046	return rc;
1047	}
1048
1049
1050	static bool vbvaVHWACommandSubmit(PVGASTATE pVGAState, VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *pCommand, bool fAsyncCommand)
1051	{
1052	VBOXVHWACMD_TYPE enmCmd = pCommand->enmCmd;
1053	ASMCompilerBarrier();
1054
1055	bool fPend = false;
1056	if (pVGAState->pDrv->pfnVHWACommandProcess)
1057	{
1058	Log(("VGA Command >>> %#p, %d\n", pCommand, enmCmd));
1059	int rc = pVGAState->pDrv->pfnVHWACommandProcess(pVGAState->pDrv, enmCmd, pCommand);
1060	if (rc == VINF_CALLBACK_RETURN)
1061	{
1062	Log(("VGA Command --- Going Async %#p, %d\n", pCommand, enmCmd));
1063	return true; /* command will be completed asynchronously, return right away */
1064	}
1065	if (rc == VERR_INVALID_STATE)
1066	{
1067	Log(("VGA Command --- Trying Pend %#p, %d\n", pCommand, enmCmd));
1068	fPend = vbvaVHWACommandCanPend(enmCmd);
1069	if (!fPend)
1070	{
1071	Log(("VGA Command --- Can NOT Pend %#p, %d\n", pCommand, enmCmd));
1072	pCommand->rc = rc;
1073	}
1074	else
1075	Log(("VGA Command --- Can Pend %#p, %d\n", pCommand, enmCmd));
1076	}
1077	else
1078	{
1079	Log(("VGA Command --- Going Complete Sync rc %d %#p, %d\n", rc, pCommand, enmCmd));
1080	pCommand->rc = rc;
1081	}
1082
1083	/* the command was completed, take a special care about it (seee below) */
1084	}
1085	else
1086	{
1087	AssertFailed();
1088	pCommand->rc = VERR_INVALID_STATE;
1089	}
1090
1091	if (fPend)
1092	return false;
1093
1094	vbvaVHWACommandComplete(pVGAState, pCommand, fAsyncCommand);
1095
1096	return true;
1097	}
1098
1099	static bool vbvaVHWACheckPendingCommands(PVGASTATE pVGAState)
1100	{
1101	if (!ASMAtomicUoReadU32(&pVGAState->pendingVhwaCommands.cPending))
1102	return true;
1103
1104	PDMCritSectEnter(&pVGAState->CritSect, VERR_SEM_BUSY);
1105
1106	VBOX_VHWA_PENDINGCMD pIter, pNext;
1107	RTListForEachSafe(&pVGAState->pendingVhwaCommands.PendingList, pIter, pNext, VBOX_VHWA_PENDINGCMD, Node)
1108	{
1109	if (!vbvaVHWACommandSubmit(pVGAState, pIter->pCommand, true))
1110	{
1111	PDMCritSectLeave(&pVGAState->CritSect);
1112	return false; /* the command should be pended still */
1113	}
1114
1115	/* the command is submitted/processed, remove from the pend list */
1116	RTListNodeRemove(&pIter->Node);
1117	ASMAtomicDecU32(&pVGAState->pendingVhwaCommands.cPending);
1118	RTMemFree(pIter);
1119	}
1120
1121	PDMCritSectLeave(&pVGAState->CritSect);
1122
1123	return true;
1124	}
1125
1126	void vbvaTimerCb(PVGASTATE pVGAState)
1127	{
1128	vbvaVHWACheckPendingCommands(pVGAState);
1129	}
1130	static void vbvaVHWAHandleCommand(PVGASTATE pVGAState, VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *pCmd)
1131	{
1132	if (vbvaVHWACheckPendingCommands(pVGAState))
1133	{
1134	if (vbvaVHWACommandSubmit(pVGAState, pCmd, false))
1135	return;
1136	}
1137
1138	vbvaVHWACommandPend(pVGAState, pCmd);
1139	}
1140
1141	static DECLCALLBACK(void) vbvaVHWAHHCommandSetEventCallback(void * pContext)
1142	{
1143	RTSemEventSignal((RTSEMEVENT)pContext);
1144	}
1145
1146	static int vbvaVHWAHHCommandPost(PVGASTATE pVGAState, VBOXVHWACMD* pCmd)
1147	{
1148	RTSEMEVENT hComplEvent;
1149	int rc = RTSemEventCreate(&hComplEvent);
1150	AssertRC(rc);
1151	if(RT_SUCCESS(rc))
1152	{
1153	/* ensure the cmd is not deleted until we process it */
1154	vbvaVHWAHHCommandRetain (pCmd);
1155	VBOXVHWA_HH_CALLBACK_SET(pCmd, vbvaVHWAHHCommandSetEventCallback, (void*)hComplEvent);
1156	vbvaVHWAHandleCommand(pVGAState, pCmd);
1157	if((ASMAtomicReadU32((volatile uint32_t *)&pCmd->Flags) & VBOXVHWACMD_FLAG_HG_ASYNCH) != 0)
1158	{
1159	rc = RTSemEventWaitNoResume(hComplEvent, RT_INDEFINITE_WAIT);
1160	}
1161	else
1162	{
1163	/* the command is completed */
1164	}
1165
1166	AssertRC(rc);
1167	if(RT_SUCCESS(rc))
1168	{
1169	RTSemEventDestroy(hComplEvent);
1170	}
1171	vbvaVHWAHHCommandRelease(pCmd);
1172	}
1173	return rc;
1174	}
1175
1176	int vbvaVHWAConstruct(PVGASTATE pVGAState)
1177	{
1178	pVGAState->pendingVhwaCommands.cPending = 0;
1179	RTListInit(&pVGAState->pendingVhwaCommands.PendingList);
1180
1181	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(VBOXVHWACMD_TYPE_HH_CONSTRUCT, 0, sizeof(VBOXVHWACMD_HH_CONSTRUCT));
1182	Assert(pCmd);
1183	if(pCmd)
1184	{
1185	uint32_t iDisplay = 0;
1186	int rc = VINF_SUCCESS;
1187	VBOXVHWACMD_HH_CONSTRUCT *pBody = VBOXVHWACMD_BODY_HOST_HEAP(pCmd, VBOXVHWACMD_HH_CONSTRUCT);
1188
1189	do
1190	{
1191	memset(pBody, 0, sizeof(VBOXVHWACMD_HH_CONSTRUCT));
1192
1193	PPDMDEVINS pDevIns = pVGAState->pDevInsR3;
1194	PVM pVM = PDMDevHlpGetVM(pDevIns);
1195
1196	pBody->pVM = pVM;
1197	pBody->pvVRAM = pVGAState->vram_ptrR3;
1198	pBody->cbVRAM = pVGAState->vram_size;
1199
1200	rc = vbvaVHWAHHCommandPost(pVGAState, pCmd);
1201	ASMCompilerBarrier();
1202
1203	AssertRC(rc);
1204	if (RT_SUCCESS(rc))
1205	{
1206	rc = pCmd->rc;
1207	AssertMsg(RT_SUCCESS(rc) \|\| rc == VERR_NOT_IMPLEMENTED, ("%Rrc\n", rc));
1208	if(rc == VERR_NOT_IMPLEMENTED)
1209	{
1210	/** @todo set some flag in pVGAState indicating VHWA is not supported */
1211	/* VERR_NOT_IMPLEMENTED is not a failure, we just do not support it */
1212	rc = VINF_SUCCESS;
1213	}
1214
1215	if (!RT_SUCCESS(rc))
1216	break;
1217	}
1218	else
1219	break;
1220
1221	++iDisplay;
1222	if (iDisplay >= pVGAState->cMonitors)
1223	break;
1224	vbvaVHWAHHCommandReinit(pCmd, VBOXVHWACMD_TYPE_HH_CONSTRUCT, (int32_t)iDisplay);
1225	} while (true);
1226
1227	vbvaVHWAHHCommandRelease(pCmd);
1228
1229	return rc;
1230	}
1231	return VERR_OUT_OF_RESOURCES;
1232	}
1233
1234	int vbvaVHWAReset(PVGASTATE pVGAState)
1235	{
1236	vbvaVHWACommandClearAllPending(pVGAState);
1237
1238	/* ensure we have all pending cmds processed and h->g cmds disabled */
1239	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(VBOXVHWACMD_TYPE_HH_RESET, 0, 0);
1240	Assert(pCmd);
1241	if(pCmd)
1242	{
1243	int rc = VINF_SUCCESS;
1244	uint32_t iDisplay = 0;
1245
1246	do
1247	{
1248	rc =vbvaVHWAHHCommandPost(pVGAState, pCmd);
1249	AssertRC(rc);
1250	if(RT_SUCCESS(rc))
1251	{
1252	rc = pCmd->rc;
1253	AssertMsg(RT_SUCCESS(rc) \|\| rc == VERR_NOT_IMPLEMENTED, ("%Rrc\n", rc));
1254	if (rc == VERR_NOT_IMPLEMENTED)
1255	rc = VINF_SUCCESS;
1256	}
1257
1258	if (!RT_SUCCESS(rc))
1259	break;
1260
1261	++iDisplay;
1262	if (iDisplay >= pVGAState->cMonitors)
1263	break;
1264	vbvaVHWAHHCommandReinit(pCmd, VBOXVHWACMD_TYPE_HH_RESET, (int32_t)iDisplay);
1265
1266	} while (true);
1267
1268	vbvaVHWAHHCommandRelease(pCmd);
1269
1270	return rc;
1271	}
1272	return VERR_OUT_OF_RESOURCES;
1273	}
1274
1275	typedef DECLCALLBACK(bool) FNVBOXVHWAHHCMDPRECB(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, void pvContext);
1276	typedef FNVBOXVHWAHHCMDPRECB *PFNVBOXVHWAHHCMDPRECB;
1277
1278	typedef DECLCALLBACK(bool) FNVBOXVHWAHHCMDPOSTCB(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, int rc, void pvContext);
1279	typedef FNVBOXVHWAHHCMDPOSTCB *PFNVBOXVHWAHHCMDPOSTCB;
1280
1281	int vbvaVHWAHHPost(PVGASTATE pVGAState, VBOXVHWACMD pCmd, PFNVBOXVHWAHHCMDPRECB pfnPre, PFNVBOXVHWAHHCMDPOSTCB pfnPost, void pvContext)
1282	{
1283	const VBOXVHWACMD_TYPE enmType = pCmd->enmCmd;
1284	int rc = VINF_SUCCESS;
1285	uint32_t iDisplay = 0;
1286
1287	do
1288	{
1289	if (!pfnPre \|\| pfnPre(pVGAState, pCmd, iDisplay, pvContext))
1290	{
1291	rc = vbvaVHWAHHCommandPost(pVGAState, pCmd);
1292	AssertRC(rc);
1293	if (pfnPost)
1294	{
1295	if (!pfnPost(pVGAState, pCmd, iDisplay, rc, pvContext))
1296	{
1297	rc = VINF_SUCCESS;
1298	break;
1299	}
1300	rc = VINF_SUCCESS;
1301	}
1302	else if(RT_SUCCESS(rc))
1303	{
1304	rc = pCmd->rc;
1305	AssertMsg(RT_SUCCESS(rc) \|\| rc == VERR_NOT_IMPLEMENTED, ("%Rrc\n", rc));
1306	if(rc == VERR_NOT_IMPLEMENTED)
1307	{
1308	rc = VINF_SUCCESS;
1309	}
1310	}
1311
1312	if (!RT_SUCCESS(rc))
1313	break;
1314	}
1315
1316	++iDisplay;
1317	if (iDisplay >= pVGAState->cMonitors)
1318	break;
1319	vbvaVHWAHHCommandReinit(pCmd, enmType, (int32_t)iDisplay);
1320	} while (true);
1321
1322	return rc;
1323	}
1324
1325	/** @todo call this also on reset? */
1326	int vbvaVHWAEnable (PVGASTATE pVGAState, bool bEnable)
1327	{
1328	const VBOXVHWACMD_TYPE enmType = bEnable ? VBOXVHWACMD_TYPE_HH_ENABLE : VBOXVHWACMD_TYPE_HH_DISABLE;
1329	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(enmType, 0, 0);
1330	Assert(pCmd);
1331	if(pCmd)
1332	{
1333	int rc = vbvaVHWAHHPost (pVGAState, pCmd, NULL, NULL, NULL);
1334	vbvaVHWAHHCommandRelease(pCmd);
1335	return rc;
1336	}
1337	return VERR_OUT_OF_RESOURCES;
1338	}
1339
1340	int vboxVBVASaveStatePrep(PPDMDEVINS pDevIns)
1341	{
1342	/* ensure we have no pending commands */
1343	return vbvaVHWAEnable(PDMINS_2_DATA(pDevIns, PVGASTATE), false);
1344	}
1345
1346	int vboxVBVASaveStateDone(PPDMDEVINS pDevIns)
1347	{
1348	/* ensure we have no pending commands */
1349	return vbvaVHWAEnable(PDMINS_2_DATA(pDevIns, PVGASTATE), true);
1350	}
1351
1352	DECLCALLBACK(int) vbvaVHWACommandCompleteAsync(PPDMIDISPLAYVBVACALLBACKS pInterface, VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *pCmd)
1353	{
1354	int rc;
1355	Log(("VGA Command <<< Async rc %d %#p, %d\n", pCmd->rc, pCmd, pCmd->enmCmd));
1356
1357	if ((pCmd->Flags & VBOXVHWACMD_FLAG_HH_CMD) == 0)
1358	{
1359	PVGASTATE pVGAState = PPDMIDISPLAYVBVACALLBACKS_2_PVGASTATE(pInterface);
1360	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
1361
1362	Assert(pCmd->Flags & VBOXVHWACMD_FLAG_HG_ASYNCH);
1363	#ifdef VBOX_WITH_WDDM
1364	if (pVGAState->fGuestCaps & VBVACAPS_COMPLETEGCMD_BY_IOREAD)
1365	{
1366	rc = HGSMICompleteGuestCommand(pIns, pCmd, !!(pCmd->Flags & VBOXVHWACMD_FLAG_GH_ASYNCH_IRQ));
1367	AssertRC(rc);
1368	}
1369	else
1370	#endif
1371	{
1372	VBVAHOSTCMD RT_UNTRUSTED_VOLATILE_GUEST pHostCmd = NULL; / Shut up MSC. */
1373	if (pCmd->Flags & VBOXVHWACMD_FLAG_GH_ASYNCH_EVENT)
1374	{
1375	rc = HGSMIHostCommandAlloc(pIns,
1376	(void RT_UNTRUSTED_VOLATILE_GUEST **)&pHostCmd,
1377	VBVAHOSTCMD_SIZE(sizeof(VBVAHOSTCMDEVENT)),
1378	HGSMI_CH_VBVA,
1379	VBVAHG_EVENT);
1380	AssertRC(rc);
1381	if (RT_SUCCESS(rc))
1382	{
1383	memset((void *)pHostCmd, 0 , VBVAHOSTCMD_SIZE(sizeof(VBVAHOSTCMDEVENT)));
1384	pHostCmd->iDstID = pCmd->iDisplay;
1385	pHostCmd->customOpCode = 0;
1386	VBVAHOSTCMDEVENT RT_UNTRUSTED_VOLATILE_GUEST *pBody = VBVAHOSTCMD_BODY(pHostCmd, VBVAHOSTCMDEVENT);
1387	pBody->pEvent = pCmd->GuestVBVAReserved1;
1388	}
1389	}
1390	else
1391	{
1392	HGSMIOFFSET offCmd = HGSMIPointerToOffsetHost(pIns, pCmd);
1393	Assert(offCmd != HGSMIOFFSET_VOID);
1394	if (offCmd != HGSMIOFFSET_VOID)
1395	{
1396	rc = HGSMIHostCommandAlloc(pIns,
1397	(void RT_UNTRUSTED_VOLATILE_GUEST **)&pHostCmd,
1398	VBVAHOSTCMD_SIZE(sizeof(VBVAHOSTCMDVHWACMDCOMPLETE)),
1399	HGSMI_CH_VBVA,
1400	VBVAHG_DISPLAY_CUSTOM);
1401	AssertRC(rc);
1402	if (RT_SUCCESS(rc))
1403	{
1404	memset((void *)pHostCmd, 0 , VBVAHOSTCMD_SIZE(sizeof(VBVAHOSTCMDVHWACMDCOMPLETE)));
1405	pHostCmd->iDstID = pCmd->iDisplay;
1406	pHostCmd->customOpCode = VBVAHG_DCUSTOM_VHWA_CMDCOMPLETE;
1407	VBVAHOSTCMDVHWACMDCOMPLETE RT_UNTRUSTED_VOLATILE_GUEST *pBody
1408	= VBVAHOSTCMD_BODY(pHostCmd, VBVAHOSTCMDVHWACMDCOMPLETE);
1409	pBody->offCmd = offCmd;
1410	}
1411	}
1412	else
1413	rc = VERR_INVALID_PARAMETER;
1414	}
1415
1416	if (RT_SUCCESS(rc))
1417	{
1418	rc = HGSMIHostCommandSubmitAndFreeAsynch(pIns, pHostCmd, RT_BOOL(pCmd->Flags & VBOXVHWACMD_FLAG_GH_ASYNCH_IRQ));
1419	AssertRC(rc);
1420	if (RT_SUCCESS(rc))
1421	return rc;
1422
1423	HGSMIHostCommandFree (pIns, pHostCmd);
1424	}
1425	}
1426	}
1427	else
1428	{
1429	PFNVBOXVHWA_HH_CALLBACK pfn = VBOXVHWA_HH_CALLBACK_GET(pCmd);
1430	if (pfn)
1431	pfn(VBOXVHWA_HH_CALLBACK_GET_ARG(pCmd));
1432	rc = VINF_SUCCESS;
1433	}
1434	return rc;
1435	}
1436
1437	typedef struct VBOXVBVASAVEDSTATECBDATA
1438	{
1439	PSSMHANDLE pSSM;
1440	int rc;
1441	bool ab2DOn[VBOX_VIDEO_MAX_SCREENS];
1442	} VBOXVBVASAVEDSTATECBDATA, *PVBOXVBVASAVEDSTATECBDATA;
1443
1444	static DECLCALLBACK(bool) vboxVBVASaveStateBeginPostCb(PVGASTATE pVGAState, VBOXVHWACMD *pCmd, uint32_t iDisplay,
1445	int rc, void *pvContext)
1446	{
1447	RT_NOREF(pVGAState, pCmd);
1448	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1449	if (RT_FAILURE(pData->rc))
1450	return false;
1451	if (RT_FAILURE(rc))
1452	{
1453	pData->rc = rc;
1454	return false;
1455	}
1456
1457	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1458	if (iDisplay >= RT_ELEMENTS(pData->ab2DOn))
1459	{
1460	pData->rc = VERR_INVALID_PARAMETER;
1461	return false;
1462	}
1463
1464	Assert(RT_SUCCESS(pCmd->rc) \|\| pCmd->rc == VERR_NOT_IMPLEMENTED);
1465	if (RT_SUCCESS(pCmd->rc))
1466	{
1467	pData->ab2DOn[iDisplay] = true;
1468	}
1469	else if (pCmd->rc != VERR_NOT_IMPLEMENTED)
1470	{
1471	pData->rc = pCmd->rc;
1472	return false;
1473	}
1474
1475	return true;
1476	}
1477
1478	static DECLCALLBACK(bool)
1479	vboxVBVASaveStatePerformPreCb(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, void pvContext)
1480	{
1481	RT_NOREF(pVGAState, pCmd);
1482	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1483	if (RT_FAILURE(pData->rc))
1484	return false;
1485
1486	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1487	if (iDisplay >= RT_ELEMENTS(pData->ab2DOn))
1488	{
1489	pData->rc = VERR_INVALID_PARAMETER;
1490	return false;
1491	}
1492
1493	int rc;
1494
1495	if (pData->ab2DOn[iDisplay])
1496	{
1497	rc = SSMR3PutU32 (pData->pSSM, VBOXVBVASAVEDSTATE_VHWAAVAILABLE_MAGIC); AssertRC(rc);
1498	if (RT_FAILURE(rc))
1499	{
1500	pData->rc = rc;
1501	return false;
1502	}
1503	return true;
1504	}
1505
1506	rc = SSMR3PutU32 (pData->pSSM, VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC); AssertRC(rc);
1507	if (RT_FAILURE(rc))
1508	{
1509	pData->rc = rc;
1510	return false;
1511	}
1512
1513	return false;
1514	}
1515
1516	static DECLCALLBACK(bool) vboxVBVASaveStateEndPreCb(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, void pvContext)
1517	{
1518	RT_NOREF(pVGAState, pCmd);
1519	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1520	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1521	if (pData->ab2DOn[iDisplay])
1522	{
1523	return true;
1524	}
1525
1526	return false;
1527	}
1528
1529	static DECLCALLBACK(bool)
1530	vboxVBVALoadStatePerformPostCb(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, int rc, void pvContext)
1531	{
1532	RT_NOREF(pVGAState, pCmd);
1533	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1534	if (RT_FAILURE(pData->rc))
1535	return false;
1536	if (RT_FAILURE(rc))
1537	{
1538	pData->rc = rc;
1539	return false;
1540	}
1541
1542	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1543	if (iDisplay >= RT_ELEMENTS(pData->ab2DOn))
1544	{
1545	pData->rc = VERR_INVALID_PARAMETER;
1546	return false;
1547	}
1548
1549	Assert(RT_SUCCESS(pCmd->rc) \|\| pCmd->rc == VERR_NOT_IMPLEMENTED);
1550	if (pCmd->rc == VERR_NOT_IMPLEMENTED)
1551	{
1552	pData->rc = SSMR3SkipToEndOfUnit(pData->pSSM);
1553	AssertRC(pData->rc);
1554	return false;
1555	}
1556	if (RT_FAILURE(pCmd->rc))
1557	{
1558	pData->rc = pCmd->rc;
1559	return false;
1560	}
1561
1562	return true;
1563	}
1564
1565	static DECLCALLBACK(bool)
1566	vboxVBVALoadStatePerformPreCb(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, void pvContext)
1567	{
1568	RT_NOREF(pVGAState, pCmd);
1569	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1570	if (RT_FAILURE(pData->rc))
1571	return false;
1572
1573	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1574	if (iDisplay >= RT_ELEMENTS(pData->ab2DOn))
1575	{
1576	pData->rc = VERR_INVALID_PARAMETER;
1577	return false;
1578	}
1579
1580	int rc;
1581	uint32_t u32;
1582	rc = SSMR3GetU32(pData->pSSM, &u32); AssertRC(rc);
1583	if (RT_FAILURE(rc))
1584	{
1585	pData->rc = rc;
1586	return false;
1587	}
1588
1589	switch (u32)
1590	{
1591	case VBOXVBVASAVEDSTATE_VHWAAVAILABLE_MAGIC:
1592	pData->ab2DOn[iDisplay] = true;
1593	return true;
1594	case VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC:
1595	pData->ab2DOn[iDisplay] = false;
1596	return false;
1597	default:
1598	pData->rc = VERR_INVALID_STATE;
1599	return false;
1600	}
1601	}
1602	#endif /* #ifdef VBOX_WITH_VIDEOHWACCEL */
1603
1604	int vboxVBVASaveDevStateExec (PVGASTATE pVGAState, PSSMHANDLE pSSM)
1605	{
1606	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
1607	int rc = HGSMIHostSaveStateExec (pIns, pSSM);
1608	if (RT_SUCCESS(rc))
1609	{
1610	VGA_SAVED_STATE_PUT_MARKER(pSSM, 2);
1611
1612	/* Save VBVACONTEXT. */
1613	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pIns);
1614
1615	if (!pCtx)
1616	{
1617	AssertFailed();
1618
1619	/* Still write a valid value to the SSM. */
1620	rc = SSMR3PutU32 (pSSM, 0);
1621	AssertRCReturn(rc, rc);
1622	}
1623	else
1624	{
1625	#ifdef DEBUG_sunlover
1626	dumpctx(pCtx);
1627	#endif
1628
1629	rc = SSMR3PutU32 (pSSM, pCtx->cViews);
1630	AssertRCReturn(rc, rc);
1631
1632	uint32_t iView;
1633	for (iView = 0; iView < pCtx->cViews; iView++)
1634	{
1635	VBVAVIEW *pView = &pCtx->aViews[iView];
1636
1637	rc = SSMR3PutU32 (pSSM, pView->view.u32ViewIndex);
1638	AssertRCReturn(rc, rc);
1639	rc = SSMR3PutU32 (pSSM, pView->view.u32ViewOffset);
1640	AssertRCReturn(rc, rc);
1641	rc = SSMR3PutU32 (pSSM, pView->view.u32ViewSize);
1642	AssertRCReturn(rc, rc);
1643	rc = SSMR3PutU32 (pSSM, pView->view.u32MaxScreenSize);
1644	AssertRCReturn(rc, rc);
1645
1646	rc = SSMR3PutU32 (pSSM, pView->screen.u32ViewIndex);
1647	AssertRCReturn(rc, rc);
1648	rc = SSMR3PutS32 (pSSM, pView->screen.i32OriginX);
1649	AssertRCReturn(rc, rc);
1650	rc = SSMR3PutS32 (pSSM, pView->screen.i32OriginY);
1651	AssertRCReturn(rc, rc);
1652	rc = SSMR3PutU32 (pSSM, pView->screen.u32StartOffset);
1653	AssertRCReturn(rc, rc);
1654	rc = SSMR3PutU32 (pSSM, pView->screen.u32LineSize);
1655	AssertRCReturn(rc, rc);
1656	rc = SSMR3PutU32 (pSSM, pView->screen.u32Width);
1657	AssertRCReturn(rc, rc);
1658	rc = SSMR3PutU32 (pSSM, pView->screen.u32Height);
1659	AssertRCReturn(rc, rc);
1660	rc = SSMR3PutU16 (pSSM, pView->screen.u16BitsPerPixel);
1661	AssertRCReturn(rc, rc);
1662	rc = SSMR3PutU16 (pSSM, pView->screen.u16Flags);
1663	AssertRCReturn(rc, rc);
1664
1665	rc = SSMR3PutU32 (pSSM, pView->vbva.guest.pVBVA? pView->vbva.u32VBVAOffset: HGSMIOFFSET_VOID);
1666	AssertRCReturn(rc, rc);
1667
1668	rc = SSMR3PutU32 (pSSM, pView->vbva.partialRecord.cb);
1669	AssertRCReturn(rc, rc);
1670
1671	if (pView->vbva.partialRecord.cb > 0)
1672	{
1673	rc = SSMR3PutMem (pSSM, pView->vbva.partialRecord.pu8, pView->vbva.partialRecord.cb);
1674	AssertRCReturn(rc, rc);
1675	}
1676	}
1677
1678	/* Save mouse pointer shape information. */
1679	rc = SSMR3PutBool (pSSM, pCtx->mouseShapeInfo.fSet);
1680	AssertRCReturn(rc, rc);
1681	rc = SSMR3PutBool (pSSM, pCtx->mouseShapeInfo.fVisible);
1682	AssertRCReturn(rc, rc);
1683	rc = SSMR3PutBool (pSSM, pCtx->mouseShapeInfo.fAlpha);
1684	AssertRCReturn(rc, rc);
1685	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.u32HotX);
1686	AssertRCReturn(rc, rc);
1687	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.u32HotY);
1688	AssertRCReturn(rc, rc);
1689	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.u32Width);
1690	AssertRCReturn(rc, rc);
1691	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.u32Height);
1692	AssertRCReturn(rc, rc);
1693	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.cbShape);
1694	AssertRCReturn(rc, rc);
1695	if (pCtx->mouseShapeInfo.cbShape)
1696	{
1697	rc = SSMR3PutMem (pSSM, pCtx->mouseShapeInfo.pu8Shape, pCtx->mouseShapeInfo.cbShape);
1698	AssertRCReturn(rc, rc);
1699	}
1700
1701	#ifdef VBOX_WITH_WDDM
1702	/* Size of some additional data. For future extensions. */
1703	rc = SSMR3PutU32 (pSSM, 4);
1704	AssertRCReturn(rc, rc);
1705	rc = SSMR3PutU32 (pSSM, pVGAState->fGuestCaps);
1706	AssertRCReturn(rc, rc);
1707	#else
1708	/* Size of some additional data. For future extensions. */
1709	rc = SSMR3PutU32 (pSSM, 0);
1710	AssertRCReturn(rc, rc);
1711	#endif
1712	rc = SSMR3PutU32 (pSSM, RT_ELEMENTS(pCtx->aModeHints));
1713	AssertRCReturn(rc, rc);
1714	rc = SSMR3PutU32 (pSSM, sizeof(VBVAMODEHINT));
1715	AssertRCReturn(rc, rc);
1716	for (unsigned i = 0; i < RT_ELEMENTS(pCtx->aModeHints); ++i)
1717	{
1718	rc = SSMR3PutMem (pSSM, &pCtx->aModeHints[i],
1719	sizeof(VBVAMODEHINT));
1720	AssertRCReturn(rc, rc);
1721	}
1722	}
1723	}
1724
1725	return rc;
1726	}
1727
1728	int vboxVBVASaveStateExec (PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
1729	{
1730	PVGASTATE pVGAState = PDMINS_2_DATA(pDevIns, PVGASTATE);
1731	int rc;
1732	#ifdef VBOX_WITH_VIDEOHWACCEL
1733	VBOXVBVASAVEDSTATECBDATA VhwaData = {0};
1734	VhwaData.pSSM = pSSM;
1735	uint32_t cbCmd = sizeof (VBOXVHWACMD_HH_SAVESTATE_SAVEPERFORM); /* maximum cmd size */
1736	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEBEGIN, 0, cbCmd);
1737	Assert(pCmd);
1738	if(pCmd)
1739	{
1740	vbvaVHWAHHPost (pVGAState, pCmd, NULL, vboxVBVASaveStateBeginPostCb, &VhwaData);
1741	rc = VhwaData.rc;
1742	AssertRC(rc);
1743	if (RT_SUCCESS(rc))
1744	{
1745	#endif
1746	rc = vboxVBVASaveDevStateExec (pVGAState, pSSM);
1747	AssertRC(rc);
1748	#ifdef VBOX_WITH_VIDEOHWACCEL
1749	if (RT_SUCCESS(rc))
1750	{
1751	vbvaVHWAHHCommandReinit(pCmd, VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEPERFORM, 0);
1752	VBOXVHWACMD_HH_SAVESTATE_SAVEPERFORM *pSave = VBOXVHWACMD_BODY_HOST_HEAP(pCmd, VBOXVHWACMD_HH_SAVESTATE_SAVEPERFORM);
1753	pSave->pSSM = pSSM;
1754	vbvaVHWAHHPost (pVGAState, pCmd, vboxVBVASaveStatePerformPreCb, NULL, &VhwaData);
1755	rc = VhwaData.rc;
1756	AssertRC(rc);
1757	if (RT_SUCCESS(rc))
1758	{
1759	rc = vbvaVHWACommandSavePending(pVGAState, pSSM);
1760	AssertRCReturn(rc, rc);
1761
1762	vbvaVHWAHHCommandReinit(pCmd, VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEEND, 0);
1763	vbvaVHWAHHPost (pVGAState, pCmd, vboxVBVASaveStateEndPreCb, NULL, &VhwaData);
1764	rc = VhwaData.rc;
1765	AssertRC(rc);
1766	}
1767	}
1768	}
1769
1770	vbvaVHWAHHCommandRelease(pCmd);
1771	}
1772	else
1773	rc = VERR_OUT_OF_RESOURCES;
1774	#else
1775	if (RT_SUCCESS(rc))
1776	{
1777	for (uint32_t i = 0; i < pVGAState->cMonitors; ++i)
1778	{
1779	rc = SSMR3PutU32 (pSSM, VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC);
1780	AssertRCReturn(rc, rc);
1781	}
1782	}
1783
1784	/* no pending commands */
1785	SSMR3PutU32(pSSM, 0);
1786	#endif
1787	return rc;
1788	}
1789
1790	int vboxVBVALoadStateExec (PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion)
1791	{
1792	if (uVersion < VGA_SAVEDSTATE_VERSION_HGSMI)
1793	{
1794	/* Nothing was saved. */
1795	return VINF_SUCCESS;
1796	}
1797
1798	PVGASTATE pVGAState = PDMINS_2_DATA(pDevIns, PVGASTATE);
1799	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
1800	int rc = HGSMIHostLoadStateExec (pIns, pSSM, uVersion);
1801	if (RT_SUCCESS(rc))
1802	{
1803	VGA_SAVED_STATE_GET_MARKER_RETURN_ON_MISMATCH(pSSM, uVersion, 2);
1804
1805	/* Load VBVACONTEXT. */
1806	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pIns);
1807
1808	if (!pCtx)
1809	{
1810	/* This should not happen. */
1811	AssertFailed();
1812	rc = VERR_INVALID_PARAMETER;
1813	}
1814	else
1815	{
1816	uint32_t cViews = 0;
1817	rc = SSMR3GetU32 (pSSM, &cViews);
1818	AssertRCReturn(rc, rc);
1819
1820	uint32_t iView;
1821	for (iView = 0; iView < cViews; iView++)
1822	{
1823	VBVAVIEW *pView = &pCtx->aViews[iView];
1824
1825	rc = SSMR3GetU32 (pSSM, &pView->view.u32ViewIndex);
1826	AssertRCReturn(rc, rc);
1827	rc = SSMR3GetU32 (pSSM, &pView->view.u32ViewOffset);
1828	AssertRCReturn(rc, rc);
1829	rc = SSMR3GetU32 (pSSM, &pView->view.u32ViewSize);
1830	AssertRCReturn(rc, rc);
1831	rc = SSMR3GetU32 (pSSM, &pView->view.u32MaxScreenSize);
1832	AssertRCReturn(rc, rc);
1833
1834	rc = SSMR3GetU32 (pSSM, &pView->screen.u32ViewIndex);
1835	AssertRCReturn(rc, rc);
1836	rc = SSMR3GetS32 (pSSM, &pView->screen.i32OriginX);
1837	AssertRCReturn(rc, rc);
1838	rc = SSMR3GetS32 (pSSM, &pView->screen.i32OriginY);
1839	AssertRCReturn(rc, rc);
1840	rc = SSMR3GetU32 (pSSM, &pView->screen.u32StartOffset);
1841	AssertRCReturn(rc, rc);
1842	rc = SSMR3GetU32 (pSSM, &pView->screen.u32LineSize);
1843	AssertRCReturn(rc, rc);
1844	rc = SSMR3GetU32 (pSSM, &pView->screen.u32Width);
1845	AssertRCReturn(rc, rc);
1846	rc = SSMR3GetU32 (pSSM, &pView->screen.u32Height);
1847	AssertRCReturn(rc, rc);
1848	rc = SSMR3GetU16 (pSSM, &pView->screen.u16BitsPerPixel);
1849	AssertRCReturn(rc, rc);
1850	rc = SSMR3GetU16 (pSSM, &pView->screen.u16Flags);
1851	AssertRCReturn(rc, rc);
1852
1853	rc = SSMR3GetU32 (pSSM, &pView->vbva.u32VBVAOffset);
1854	AssertRCReturn(rc, rc);
1855
1856	rc = SSMR3GetU32 (pSSM, &pView->vbva.partialRecord.cb);
1857	AssertRCReturn(rc, rc);
1858
1859	if (pView->vbva.partialRecord.cb == 0)
1860	{
1861	pView->vbva.partialRecord.pu8 = NULL;
1862	}
1863	else
1864	{
1865	Assert(pView->vbva.partialRecord.pu8 == NULL); /* Should be it. */
1866
1867	uint8_t pu8 = (uint8_t )RTMemAlloc(pView->vbva.partialRecord.cb);
1868
1869	if (!pu8)
1870	{
1871	return VERR_NO_MEMORY;
1872	}
1873
1874	pView->vbva.partialRecord.pu8 = pu8;
1875
1876	rc = SSMR3GetMem (pSSM, pView->vbva.partialRecord.pu8, pView->vbva.partialRecord.cb);
1877	AssertRCReturn(rc, rc);
1878	}
1879
1880	if (pView->vbva.u32VBVAOffset == HGSMIOFFSET_VOID)
1881	{
1882	pView->vbva.guest.pVBVA = NULL;
1883	}
1884	else
1885	{
1886	pView->vbva.guest.pVBVA = (VBVABUFFER *)HGSMIOffsetToPointerHost(pIns, pView->vbva.u32VBVAOffset);
1887	}
1888	}
1889
1890	if (uVersion > VGA_SAVEDSTATE_VERSION_WITH_CONFIG)
1891	{
1892	/* Read mouse pointer shape information. */
1893	rc = SSMR3GetBool (pSSM, &pCtx->mouseShapeInfo.fSet);
1894	AssertRCReturn(rc, rc);
1895	rc = SSMR3GetBool (pSSM, &pCtx->mouseShapeInfo.fVisible);
1896	AssertRCReturn(rc, rc);
1897	rc = SSMR3GetBool (pSSM, &pCtx->mouseShapeInfo.fAlpha);
1898	AssertRCReturn(rc, rc);
1899	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.u32HotX);
1900	AssertRCReturn(rc, rc);
1901	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.u32HotY);
1902	AssertRCReturn(rc, rc);
1903	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.u32Width);
1904	AssertRCReturn(rc, rc);
1905	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.u32Height);
1906	AssertRCReturn(rc, rc);
1907	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.cbShape);
1908	AssertRCReturn(rc, rc);
1909	if (pCtx->mouseShapeInfo.cbShape)
1910	{
1911	pCtx->mouseShapeInfo.pu8Shape = (uint8_t *)RTMemAlloc(pCtx->mouseShapeInfo.cbShape);
1912	if (pCtx->mouseShapeInfo.pu8Shape == NULL)
1913	{
1914	return VERR_NO_MEMORY;
1915	}
1916	pCtx->mouseShapeInfo.cbAllocated = pCtx->mouseShapeInfo.cbShape;
1917	rc = SSMR3GetMem (pSSM, pCtx->mouseShapeInfo.pu8Shape, pCtx->mouseShapeInfo.cbShape);
1918	AssertRCReturn(rc, rc);
1919	}
1920	else
1921	{
1922	pCtx->mouseShapeInfo.pu8Shape = NULL;
1923	}
1924
1925	/* Size of some additional data. For future extensions. */
1926	uint32_t cbExtra = 0;
1927	rc = SSMR3GetU32 (pSSM, &cbExtra);
1928	AssertRCReturn(rc, rc);
1929	#ifdef VBOX_WITH_WDDM
1930	if (cbExtra >= 4)
1931	{
1932	rc = SSMR3GetU32 (pSSM, &pVGAState->fGuestCaps);
1933	AssertRCReturn(rc, rc);
1934	pVGAState->pDrv->pfnVBVAGuestCapabilityUpdate(pVGAState->pDrv, pVGAState->fGuestCaps);
1935	cbExtra -= 4;
1936	}
1937	#endif
1938	if (cbExtra > 0)
1939	{
1940	rc = SSMR3Skip(pSSM, cbExtra);
1941	AssertRCReturn(rc, rc);
1942	}
1943
1944	if (uVersion >= VGA_SAVEDSTATE_VERSION_MODE_HINTS)
1945	{
1946	uint32_t cModeHints, cbModeHints;
1947	rc = SSMR3GetU32 (pSSM, &cModeHints);
1948	AssertRCReturn(rc, rc);
1949	rc = SSMR3GetU32 (pSSM, &cbModeHints);
1950	AssertRCReturn(rc, rc);
1951	memset(&pCtx->aModeHints, ~0, sizeof(pCtx->aModeHints));
1952	unsigned iHint;
1953	for (iHint = 0; iHint < cModeHints; ++iHint)
1954	{
1955	if ( cbModeHints <= sizeof(VBVAMODEHINT)
1956	&& iHint < RT_ELEMENTS(pCtx->aModeHints))
1957	rc = SSMR3GetMem(pSSM, &pCtx->aModeHints[iHint],
1958	cbModeHints);
1959	else
1960	rc = SSMR3Skip(pSSM, cbModeHints);
1961	AssertRCReturn(rc, rc);
1962	}
1963	}
1964	}
1965
1966	pCtx->cViews = iView;
1967	LogFlowFunc(("%d views loaded\n", pCtx->cViews));
1968
1969	if (uVersion > VGA_SAVEDSTATE_VERSION_WDDM)
1970	{
1971	bool fLoadCommands;
1972
1973	if (uVersion < VGA_SAVEDSTATE_VERSION_FIXED_PENDVHWA)
1974	{
1975	const char *pcszOsArch = SSMR3HandleHostOSAndArch(pSSM);
1976	Assert(pcszOsArch);
1977	fLoadCommands = !pcszOsArch \|\| RTStrNCmp(pcszOsArch, RT_STR_TUPLE("solaris"));
1978	}
1979	else
1980	fLoadCommands = true;
1981
1982	#ifdef VBOX_WITH_VIDEOHWACCEL
1983	uint32_t cbCmd = sizeof (VBOXVHWACMD_HH_SAVESTATE_LOADPERFORM); /* maximum cmd size */
1984	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(VBOXVHWACMD_TYPE_HH_SAVESTATE_LOADPERFORM, 0, cbCmd);
1985	Assert(pCmd);
1986	if(pCmd)
1987	{
1988	VBOXVBVASAVEDSTATECBDATA VhwaData = {0};
1989	VhwaData.pSSM = pSSM;
1990	VBOXVHWACMD_HH_SAVESTATE_LOADPERFORM *pLoad = VBOXVHWACMD_BODY_HOST_HEAP(pCmd, VBOXVHWACMD_HH_SAVESTATE_LOADPERFORM);
1991	pLoad->pSSM = pSSM;
1992	vbvaVHWAHHPost (pVGAState, pCmd, vboxVBVALoadStatePerformPreCb, vboxVBVALoadStatePerformPostCb, &VhwaData);
1993	rc = VhwaData.rc;
1994	vbvaVHWAHHCommandRelease(pCmd);
1995	AssertRCReturn(rc, rc);
1996
1997	if (fLoadCommands)
1998	{
1999	rc = vbvaVHWACommandLoadPending(pVGAState, pSSM, uVersion);
2000	AssertRCReturn(rc, rc);
2001	}
2002	}
2003	else
2004	{
2005	rc = VERR_OUT_OF_RESOURCES;
2006	}
2007	#else
2008	uint32_t u32;
2009
2010	for (uint32_t i = 0; i < pVGAState->cMonitors; ++i)
2011	{
2012	rc = SSMR3GetU32(pSSM, &u32);
2013	AssertRCReturn(rc, rc);
2014
2015	if (u32 != VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC)
2016	{
2017	LogRel(("VBVA: 2D data while 2D is not supported\n"));
2018	return VERR_NOT_SUPPORTED;
2019	}
2020	}
2021
2022	if (fLoadCommands)
2023	{
2024	rc = SSMR3GetU32(pSSM, &u32);
2025	AssertRCReturn(rc, rc);
2026
2027	if (u32)
2028	{
2029	LogRel(("VBVA: 2D pending command while 2D is not supported\n"));
2030	return VERR_NOT_SUPPORTED;
2031	}
2032	}
2033	#endif
2034	}
2035
2036	#ifdef DEBUG_sunlover
2037	dumpctx(pCtx);
2038	#endif
2039	}
2040	}
2041
2042	return rc;
2043	}
2044
2045	int vboxVBVALoadStateDone(PPDMDEVINS pDevIns)
2046	{
2047	PVGASTATE pVGAState = PDMINS_2_DATA(pDevIns, PVGASTATE);
2048	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pVGAState->pHGSMI);
2049	if (pCtx)
2050	{
2051	uint32_t iView;
2052	for (iView = 0; iView < pCtx->cViews; iView++)
2053	{
2054	VBVAVIEW *pView = &pCtx->aViews[iView];
2055	if (pView->vbva.guest.pVBVA)
2056	{
2057	#ifdef VBOX_WITH_CRHGSMI
2058	Assert(!vboxCmdVBVAIsEnabled(pVGAState));
2059	#endif
2060	int rc = vbvaEnable(iView, pVGAState, pCtx, pView->vbva.guest.pVBVA, pView->vbva.u32VBVAOffset, true /* fRestored */);
2061	if (RT_SUCCESS(rc))
2062	vbvaResize(pVGAState, pView, &pView->screen, false);
2063	else
2064	LogRel(("VBVA: can not restore: %Rrc\n", rc));
2065	}
2066	}
2067
2068	if (pCtx->mouseShapeInfo.fSet)
2069	vbvaUpdateMousePointerShape(pVGAState, &pCtx->mouseShapeInfo, true);
2070	}
2071
2072	return VINF_SUCCESS;
2073	}
2074
2075	void VBVARaiseIrq (PVGASTATE pVGAState, uint32_t fFlags)
2076	{
2077	PPDMDEVINS pDevIns = pVGAState->pDevInsR3;
2078
2079	PDMCritSectEnter(&pVGAState->CritSectIRQ, VERR_SEM_BUSY);
2080
2081	const uint32_t fu32CurrentGuestFlags = HGSMIGetHostGuestFlags(pVGAState->pHGSMI);
2082	if ((fu32CurrentGuestFlags & HGSMIHOSTFLAGS_IRQ) == 0)
2083	{
2084	/* No IRQ set yet. */
2085	Assert(pVGAState->fu32PendingGuestFlags == 0);
2086
2087	HGSMISetHostGuestFlags(pVGAState->pHGSMI, HGSMIHOSTFLAGS_IRQ \| fFlags);
2088
2089	/* If VM is not running, the IRQ will be set in VBVAOnResume. */
2090	const VMSTATE enmVMState = PDMDevHlpVMState(pDevIns);
2091	if ( enmVMState == VMSTATE_RUNNING
2092	\|\| enmVMState == VMSTATE_RUNNING_LS)
2093	PDMDevHlpPCISetIrqNoWait(pDevIns, 0, PDM_IRQ_LEVEL_HIGH);
2094	}
2095	else
2096	{
2097	/* IRQ already set, remember the new flags. */
2098	pVGAState->fu32PendingGuestFlags \|= HGSMIHOSTFLAGS_IRQ \| fFlags;
2099	}
2100
2101	PDMCritSectLeave(&pVGAState->CritSectIRQ);
2102	}
2103
2104	void VBVAOnResume(PVGASTATE pThis)
2105	{
2106	PPDMDEVINS pDevIns = pThis->pDevInsR3;
2107
2108	PDMCritSectEnter(&pThis->CritSectIRQ, VERR_SEM_BUSY);
2109
2110	if (HGSMIGetHostGuestFlags(pThis->pHGSMI) & HGSMIHOSTFLAGS_IRQ)
2111	PDMDevHlpPCISetIrqNoWait(pDevIns, 0, PDM_IRQ_LEVEL_HIGH);
2112
2113	PDMCritSectLeave(&pThis->CritSectIRQ);
2114	}
2115
2116	static int vbvaHandleQueryConf32(PVGASTATE pVGAState, VBVACONF32 RT_UNTRUSTED_VOLATILE_GUEST *pConf32)
2117	{
2118	int rc = VINF_SUCCESS;
2119	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2120	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2121
2122	const uint32_t u32Index = pConf32->u32Index;
2123	ASMCompilerBarrier();
2124
2125	LogFlowFunc(("VBVA_QUERY_CONF32: u32Index %d, u32Value 0x%x\n",
2126	u32Index, pConf32->u32Value));
2127
2128	if (u32Index == VBOX_VBVA_CONF32_MONITOR_COUNT)
2129	{
2130	pConf32->u32Value = pCtx->cViews;
2131	}
2132	else if (u32Index == VBOX_VBVA_CONF32_HOST_HEAP_SIZE)
2133	{
2134	/** @todo a value calculated from the vram size */
2135	pConf32->u32Value = _64K;
2136	}
2137	else if ( u32Index == VBOX_VBVA_CONF32_MODE_HINT_REPORTING
2138	\|\| u32Index == VBOX_VBVA_CONF32_GUEST_CURSOR_REPORTING)
2139	{
2140	pConf32->u32Value = VINF_SUCCESS;
2141	}
2142	else if (u32Index == VBOX_VBVA_CONF32_CURSOR_CAPABILITIES)
2143	{
2144	pConf32->u32Value = pVGAState->fHostCursorCapabilities;
2145	}
2146	else if (u32Index == VBOX_VBVA_CONF32_SCREEN_FLAGS)
2147	{
2148	pConf32->u32Value = VBVA_SCREEN_F_ACTIVE
2149	\| VBVA_SCREEN_F_DISABLED
2150	\| VBVA_SCREEN_F_BLANK
2151	\| VBVA_SCREEN_F_BLANK2;
2152	}
2153	else if (u32Index == VBOX_VBVA_CONF32_MAX_RECORD_SIZE)
2154	{
2155	pConf32->u32Value = VBVA_MAX_RECORD_SIZE;
2156	}
2157	else
2158	{
2159	Log(("Unsupported VBVA_QUERY_CONF32 index %d!!!\n",
2160	u32Index));
2161	rc = VERR_INVALID_PARAMETER;
2162	}
2163
2164	return rc;
2165	}
2166
2167	static int vbvaHandleSetConf32(PVGASTATE pVGAState, VBVACONF32 RT_UNTRUSTED_VOLATILE_GUEST *pConf32)
2168	{
2169	NOREF(pVGAState);
2170
2171	VBVACONF32 parms;
2172	parms.u32Index = pConf32->u32Index;
2173	parms.u32Value = pConf32->u32Value;
2174	ASMCompilerBarrier();
2175
2176	LogFlowFunc(("VBVA_SET_CONF32: u32Index %d, u32Value 0x%x\n",
2177	parms.u32Index, parms.u32Value));
2178
2179	int rc = VINF_SUCCESS;
2180	if (parms.u32Index == VBOX_VBVA_CONF32_MONITOR_COUNT)
2181	{
2182	/* do nothing. this is a const. */
2183	}
2184	else if (parms.u32Index == VBOX_VBVA_CONF32_HOST_HEAP_SIZE)
2185	{
2186	/* do nothing. this is a const. */
2187	}
2188	else
2189	{
2190	Log(("Unsupported VBVA_SET_CONF32 index %d!!!\n",
2191	parms.u32Index));
2192	rc = VERR_INVALID_PARAMETER;
2193	}
2194
2195	return rc;
2196	}
2197
2198	static int vbvaHandleInfoHeap(PVGASTATE pVGAState, const VBVAINFOHEAP RT_UNTRUSTED_VOLATILE_GUEST *pInfoHeap)
2199	{
2200	VBVAINFOHEAP parms;
2201	parms.u32HeapOffset = pInfoHeap->u32HeapOffset;
2202	parms.u32HeapSize = pInfoHeap->u32HeapSize;
2203	ASMCompilerBarrier();
2204	LogFlowFunc(("VBVA_INFO_HEAP: offset 0x%x, size 0x%x\n",
2205	parms.u32HeapOffset, parms.u32HeapSize));
2206
2207	return HGSMIHostHeapSetup(pVGAState->pHGSMI, parms.u32HeapOffset, parms.u32HeapSize);
2208	}
2209
2210	int VBVAInfoView(PVGASTATE pVGAState, const VBVAINFOVIEW RT_UNTRUSTED_VOLATILE_GUEST *pView)
2211	{
2212	VBVAINFOVIEW view;
2213	view.u32ViewIndex = pView->u32ViewIndex;
2214	view.u32ViewOffset = pView->u32ViewOffset;
2215	view.u32ViewSize = pView->u32ViewSize;
2216	view.u32MaxScreenSize = pView->u32MaxScreenSize;
2217	ASMCompilerBarrier();
2218
2219	LogFlowFunc(("VBVA_INFO_VIEW: u32ViewIndex %d, u32ViewOffset 0x%x, u32ViewSize 0x%x, u32MaxScreenSize 0x%x\n",
2220	view.u32ViewIndex, view.u32ViewOffset, view.u32ViewSize, view.u32MaxScreenSize));
2221
2222	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2223	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2224
2225	if ( view.u32ViewIndex < pCtx->cViews
2226	&& view.u32ViewOffset <= pVGAState->vram_size
2227	&& view.u32ViewSize <= pVGAState->vram_size
2228	&& view.u32ViewOffset <= pVGAState->vram_size - view.u32ViewSize
2229	&& view.u32MaxScreenSize <= view.u32ViewSize)
2230	{
2231	pCtx->aViews[view.u32ViewIndex].view = view;
2232	return VINF_SUCCESS;
2233	}
2234
2235	LogRelFlow(("VBVA: InfoView: invalid data! index %d(%d), offset 0x%x, size 0x%x, max 0x%x, vram size 0x%x\n",
2236	view.u32ViewIndex, pCtx->cViews, view.u32ViewOffset, view.u32ViewSize,
2237	view.u32MaxScreenSize, pVGAState->vram_size));
2238	return VERR_INVALID_PARAMETER;
2239	}
2240
2241	int VBVAInfoScreen(PVGASTATE pVGAState, const VBVAINFOSCREEN RT_UNTRUSTED_VOLATILE_GUEST *pScreen)
2242	{
2243	VBVAINFOSCREEN screen;
2244	memcpy(&screen, (void *)pScreen, sizeof(screen));
2245	ASMCompilerBarrier();
2246	LogRel(("VBVA: InfoScreen: [%d] @%d,%d %dx%d, line 0x%x, BPP %d, flags 0x%x\n",
2247	screen.u32ViewIndex, screen.i32OriginX, screen.i32OriginY,
2248	screen.u32Width, screen.u32Height,
2249	screen.u32LineSize, screen.u16BitsPerPixel, screen.u16Flags));
2250
2251	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2252	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2253
2254	/* Allow screen.u16BitsPerPixel == 0 because legacy guest code used it for screen blanking. */
2255	if ( screen.u32ViewIndex < pCtx->cViews
2256	&& screen.u16BitsPerPixel <= 32
2257	&& screen.u32Width <= UINT16_MAX
2258	&& screen.u32Height <= UINT16_MAX
2259	&& screen.u32LineSize <= UINT16_MAX * 4)
2260	{
2261	const VBVAINFOVIEW *pView = &pCtx->aViews[screen.u32ViewIndex].view;
2262	const uint32_t u32BytesPerPixel = (screen.u16BitsPerPixel + 7) / 8;
2263	if (screen.u32Width <= screen.u32LineSize / (u32BytesPerPixel? u32BytesPerPixel: 1))
2264	{
2265	const uint64_t u64ScreenSize = (uint64_t)screen.u32LineSize * screen.u32Height;
2266	if ( screen.u32StartOffset <= pView->u32ViewSize
2267	&& u64ScreenSize <= pView->u32MaxScreenSize
2268	&& screen.u32StartOffset <= pView->u32ViewSize - (uint32_t)u64ScreenSize)
2269	{
2270	vbvaResize(pVGAState, &pCtx->aViews[screen.u32ViewIndex], &screen, true);
2271	return VINF_SUCCESS;
2272	}
2273
2274	LogRelFlow(("VBVA: InfoScreen: invalid data! size %#RX64, max %#RX32\n",
2275	u64ScreenSize, pView->u32MaxScreenSize));
2276	}
2277	}
2278	else
2279	LogRelFlow(("VBVA: InfoScreen: invalid data! index %RU32(%RU32)\n", screen.u32ViewIndex, pCtx->cViews));
2280
2281	return VERR_INVALID_PARAMETER;
2282	}
2283
2284	int VBVAGetInfoViewAndScreen(PVGASTATE pVGAState, uint32_t u32ViewIndex, VBVAINFOVIEW pView, VBVAINFOSCREEN pScreen)
2285	{
2286	if (u32ViewIndex >= pVGAState->cMonitors)
2287	return VERR_INVALID_PARAMETER;
2288
2289	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2290	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pIns);
2291
2292	if (pView)
2293	*pView = pCtx->aViews[u32ViewIndex].view;
2294
2295	if (pScreen)
2296	*pScreen = pCtx->aViews[u32ViewIndex].screen;
2297
2298	return VINF_SUCCESS;
2299	}
2300
2301	static int vbvaHandleEnable(PVGASTATE pVGAState, VBVAENABLE const volatile *pVbvaEnable, uint32_t u32ScreenId)
2302	{
2303	int rc = VINF_SUCCESS;
2304	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2305	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2306
2307	if (u32ScreenId > pCtx->cViews)
2308	return VERR_INVALID_PARAMETER;
2309
2310	uint32_t fEnableFlags = pVbvaEnable->u32Flags;
2311	uint32_t offEnable = pVbvaEnable->u32Offset;
2312	ASMCompilerBarrier();
2313
2314	LogFlowFunc(("VBVA_ENABLE[%d]: u32Flags 0x%x u32Offset %#x\n", u32ScreenId, fEnableFlags, offEnable));
2315
2316	if ((fEnableFlags & (VBVA_F_ENABLE \| VBVA_F_DISABLE)) == VBVA_F_ENABLE)
2317	{
2318	if (offEnable < pVGAState->vram_size)
2319	{
2320	/* Guest reported offset either absolute or relative to view. */
2321	if (fEnableFlags & VBVA_F_ABSOFFSET)
2322	{
2323	/* Offset from VRAM start. */
2324	if ( pVGAState->vram_size < RT_UOFFSETOF(VBVABUFFER, au8Data)
2325	\|\| offEnable > pVGAState->vram_size - RT_UOFFSETOF(VBVABUFFER, au8Data))
2326	{
2327	rc = VERR_INVALID_PARAMETER;
2328	}
2329	}
2330	else
2331	{
2332	/* Offset from the view start. */
2333	const VBVAINFOVIEW *pView = &pCtx->aViews[u32ScreenId].view;
2334	if ( pVGAState->vram_size - offEnable < pView->u32ViewOffset
2335	\|\| pView->u32ViewSize < RT_UOFFSETOF(VBVABUFFER, au8Data)
2336	\|\| offEnable > pView->u32ViewSize - RT_UOFFSETOF(VBVABUFFER, au8Data))
2337	{
2338	rc = VERR_INVALID_PARAMETER;
2339	}
2340	else
2341	{
2342	offEnable += pView->u32ViewOffset;
2343	}
2344	}
2345	}
2346	else
2347	{
2348	rc = VERR_INVALID_PARAMETER;
2349	}
2350
2351	if (RT_SUCCESS(rc))
2352	{
2353	VBVABUFFER pVBVA = (VBVABUFFER )HGSMIOffsetToPointerHost(pIns, offEnable);
2354	if (pVBVA)
2355	{
2356	/* Process any pending orders and empty the VBVA ring buffer. */
2357	vbvaFlush(pVGAState, pCtx);
2358
2359	rc = vbvaEnable(u32ScreenId, pVGAState, pCtx, pVBVA, offEnable, false /* fRestored */);
2360	}
2361	else
2362	{
2363	Log(("Invalid VBVABUFFER offset 0x%x!!!\n", offEnable));
2364	rc = VERR_INVALID_PARAMETER;
2365	}
2366	}
2367
2368	if (RT_FAILURE(rc))
2369	LogRelMax(8, ("VBVA: can not enable: %Rrc\n", rc));
2370	}
2371	else if ((fEnableFlags & (VBVA_F_ENABLE \| VBVA_F_DISABLE)) == VBVA_F_DISABLE)
2372	{
2373	rc = vbvaDisable(u32ScreenId, pVGAState, pCtx);
2374	}
2375	else
2376	{
2377	Log(("Invalid VBVA_ENABLE flags 0x%x!!!\n", fEnableFlags));
2378	rc = VERR_INVALID_PARAMETER;
2379	}
2380
2381	return rc;
2382	}
2383
2384	static int vbvaHandleQueryModeHints(PVGASTATE pVGAState, VBVAQUERYMODEHINTS volatile *pQueryModeHints, HGSMISIZE cbBuffer)
2385	{
2386	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2387	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2388
2389	uint16_t const cHintsQueried = pQueryModeHints->cHintsQueried;
2390	uint16_t const cbHintStructureGuest = pQueryModeHints->cbHintStructureGuest;
2391	ASMCompilerBarrier();
2392
2393	LogRelFlowFunc(("VBVA: HandleQueryModeHints: cHintsQueried=%RU16, cbHintStructureGuest=%RU16\n",
2394	cHintsQueried, cbHintStructureGuest));
2395	if (cbBuffer < sizeof(VBVAQUERYMODEHINTS) + (uint32_t)cHintsQueried * cbHintStructureGuest)
2396	return VERR_INVALID_PARAMETER;
2397
2398	uint8_t pbHint = (uint8_t )(pQueryModeHints + 1);
2399	memset(pbHint, ~0, cbBuffer - sizeof(VBVAQUERYMODEHINTS));
2400
2401	for (unsigned iHint = 0; iHint < cHintsQueried && iHint < VBOX_VIDEO_MAX_SCREENS; ++iHint)
2402	{
2403	memcpy(pbHint, &pCtx->aModeHints[iHint], RT_MIN(cbHintStructureGuest, sizeof(VBVAMODEHINT)));
2404	pbHint += cbHintStructureGuest;
2405	Assert((uintptr_t)(pbHint - (uint8_t *)pQueryModeHints) <= cbBuffer);
2406	}
2407
2408	return VINF_SUCCESS;
2409	}
2410
2411	/*
2412	*
2413	* New VBVA uses a new interface id: #define VBE_DISPI_ID_VBOX_VIDEO 0xBE01
2414	*
2415	* VBVA uses two 32 bits IO ports to write VRAM offsets of shared memory blocks for commands.
2416	* Read Write
2417	* Host port 0x3b0 to process completed
2418	* Guest port 0x3d0 control value? to process
2419	*
2420	*/
2421
2422	static DECLCALLBACK(void) vbvaNotifyGuest (void *pvCallback)
2423	{
2424	#if defined(VBOX_WITH_HGSMI) && (defined(VBOX_WITH_VIDEOHWACCEL) \|\| defined(VBOX_WITH_VDMA) \|\| defined(VBOX_WITH_WDDM))
2425	PVGASTATE pVGAState = (PVGASTATE)pvCallback;
2426	VBVARaiseIrq (pVGAState, 0);
2427	#else
2428	NOREF(pvCallback);
2429	/* Do nothing. Later the VMMDev/VGA IRQ can be used for the notification. */
2430	#endif
2431	}
2432
2433	/**
2434	* The guest submitted a command buffer (hit VGA_PORT_HGSMI_GUEST).
2435	*
2436	* Verify the buffer size and invoke corresponding handler.
2437	*
2438	* @return VBox status code.
2439	* @param pvHandler The VBVA channel context.
2440	* @param u16ChannelInfo Command code.
2441	* @param pvBuffer HGSMI buffer with command data. Considered volatile!
2442	* @param cbBuffer Size of command data.
2443	*
2444	* @thread EMT
2445	*/
2446	static DECLCALLBACK(int) vbvaChannelHandler(void *pvHandler, uint16_t u16ChannelInfo,
2447	void RT_UNTRUSTED_VOLATILE_GUEST *pvBuffer, HGSMISIZE cbBuffer)
2448	{
2449	int rc = VINF_SUCCESS;
2450
2451	LogFlowFunc(("pvHandler %p, u16ChannelInfo %d, pvBuffer %p, cbBuffer %u\n", pvHandler, u16ChannelInfo, pvBuffer, cbBuffer));
2452
2453	PVGASTATE pVGAState = (PVGASTATE)pvHandler;
2454	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2455	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2456
2457	switch (u16ChannelInfo)
2458	{
2459	#ifdef VBOX_WITH_CRHGSMI
2460	case VBVA_CMDVBVA_SUBMIT:
2461	rc = vboxCmdVBVACmdSubmit(pVGAState);
2462	break;
2463
2464	case VBVA_CMDVBVA_FLUSH:
2465	rc = vboxCmdVBVACmdFlush(pVGAState);
2466	break;
2467
2468	case VBVA_CMDVBVA_CTL:
2469	if (cbBuffer >= VBoxSHGSMIBufferHeaderSize() + sizeof(VBOXCMDVBVA_CTL))
2470	{
2471	VBOXCMDVBVA_CTL RT_UNTRUSTED_VOLATILE_GUEST *pCtl;
2472	pCtl = (VBOXCMDVBVA_CTL RT_UNTRUSTED_VOLATILE_GUEST )VBoxSHGSMIBufferData((VBOXSHGSMIHEADER RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer);
2473	rc = vboxCmdVBVACmdCtl(pVGAState, pCtl, cbBuffer - VBoxSHGSMIBufferHeaderSize());
2474	}
2475	else
2476	rc = VERR_INVALID_PARAMETER;
2477	break;
2478	#endif /* VBOX_WITH_CRHGSMI */
2479
2480	#ifdef VBOX_WITH_VDMA
2481	case VBVA_VDMA_CMD:
2482	if (cbBuffer >= VBoxSHGSMIBufferHeaderSize() + sizeof(VBOXVDMACBUF_DR))
2483	{
2484	VBOXVDMACBUF_DR RT_UNTRUSTED_VOLATILE_GUEST *pCmd;
2485	pCmd = (VBOXVDMACBUF_DR RT_UNTRUSTED_VOLATILE_GUEST )VBoxSHGSMIBufferData((VBOXSHGSMIHEADER RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer);
2486	vboxVDMACommand(pVGAState->pVdma, pCmd, cbBuffer - VBoxSHGSMIBufferHeaderSize());
2487	rc = VINF_SUCCESS;
2488	}
2489	else
2490	rc = VERR_INVALID_PARAMETER;
2491	break;
2492
2493	case VBVA_VDMA_CTL:
2494	if (cbBuffer >= VBoxSHGSMIBufferHeaderSize() + sizeof(VBOXVDMA_CTL))
2495	{
2496	VBOXVDMA_CTL RT_UNTRUSTED_VOLATILE_GUEST *pCmd;
2497	pCmd = (VBOXVDMA_CTL RT_UNTRUSTED_VOLATILE_GUEST )VBoxSHGSMIBufferData((VBOXSHGSMIHEADER RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer);
2498	vboxVDMAControl(pVGAState->pVdma, pCmd, cbBuffer - VBoxSHGSMIBufferHeaderSize());
2499	}
2500	else
2501	rc = VERR_INVALID_PARAMETER;
2502	break;
2503	#endif /* VBOX_WITH_VDMA */
2504
2505	case VBVA_QUERY_CONF32:
2506	if (cbBuffer >= sizeof(VBVACONF32))
2507	rc = vbvaHandleQueryConf32(pVGAState, (VBVACONF32 RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer);
2508	else
2509	rc = VERR_INVALID_PARAMETER;
2510	break;
2511
2512	case VBVA_SET_CONF32:
2513	if (cbBuffer >= sizeof(VBVACONF32))
2514	rc = vbvaHandleSetConf32(pVGAState, (VBVACONF32 RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer);
2515	else
2516	rc = VERR_INVALID_PARAMETER;
2517	break;
2518
2519	case VBVA_INFO_VIEW:
2520	/* Expect at least one VBVAINFOVIEW structure. */
2521	rc = VERR_INVALID_PARAMETER;
2522	if (cbBuffer >= sizeof(VBVAINFOVIEW))
2523	{
2524	#ifdef VBOX_WITH_CRHGSMI
2525	AssertMsgBreak(!vboxCmdVBVAIsEnabled(pVGAState), ("VBVA_INFO_VIEW is not acceptible for CmdVbva\n"));
2526	#endif
2527	/* Guest submits an array of VBVAINFOVIEW structures. */
2528	const VBVAINFOVIEW RT_UNTRUSTED_VOLATILE_GUEST pView = (VBVAINFOVIEW RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer;
2529	for (;
2530	cbBuffer >= sizeof(VBVAINFOVIEW);
2531	++pView, cbBuffer -= sizeof(VBVAINFOVIEW))
2532	{
2533	rc = VBVAInfoView(pVGAState, pView);
2534	if (RT_FAILURE(rc))
2535	break;
2536	}
2537	}
2538	break;
2539
2540	case VBVA_INFO_HEAP:
2541	if (cbBuffer >= sizeof(VBVAINFOHEAP))
2542	rc = vbvaHandleInfoHeap(pVGAState, (VBVAINFOHEAP RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer);
2543	else
2544	rc = VERR_INVALID_PARAMETER;
2545	break;
2546
2547	case VBVA_FLUSH:
2548	if (cbBuffer >= sizeof(VBVAFLUSH))
2549	rc = vbvaFlush(pVGAState, pCtx);
2550	else
2551	rc = VERR_INVALID_PARAMETER;
2552	break;
2553
2554	case VBVA_INFO_SCREEN:
2555	rc = VERR_INVALID_PARAMETER;
2556	#ifdef VBOX_WITH_CRHGSMI
2557	AssertMsgBreak(!vboxCmdVBVAIsEnabled(pVGAState), ("VBVA_INFO_SCREEN is not acceptible for CmdVbva\n"));
2558	#endif
2559	if (cbBuffer >= sizeof(VBVAINFOSCREEN))
2560	rc = VBVAInfoScreen(pVGAState, (VBVAINFOSCREEN RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer);
2561	break;
2562
2563	case VBVA_ENABLE:
2564	rc = VERR_INVALID_PARAMETER;
2565	#ifdef VBOX_WITH_CRHGSMI
2566	AssertMsgBreak(!vboxCmdVBVAIsEnabled(pVGAState), ("VBVA_ENABLE is not acceptible for CmdVbva\n"));
2567	#endif /* VBOX_WITH_CRHGSMI */
2568	if (cbBuffer >= sizeof(VBVAENABLE))
2569	{
2570	VBVAENABLE RT_UNTRUSTED_VOLATILE_GUEST pVbvaEnable = (VBVAENABLE RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer;
2571
2572	uint32_t u32ScreenId;
2573	const uint32_t u32Flags = pVbvaEnable->u32Flags;
2574	if (u32Flags & VBVA_F_EXTENDED)
2575	{
2576	if (cbBuffer >= sizeof(VBVAENABLE_EX))
2577	u32ScreenId = ((VBVAENABLE_EX RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer)->u32ScreenId;
2578	else
2579	{
2580	rc = VERR_INVALID_PARAMETER;
2581	break;
2582	}
2583	}
2584	else
2585	u32ScreenId = vbvaViewFromBufferPtr(pIns, pCtx, pvBuffer);
2586
2587	rc = vbvaHandleEnable(pVGAState, pVbvaEnable, u32ScreenId);
2588	pVbvaEnable->i32Result = rc;
2589	}
2590	break;
2591
2592	case VBVA_MOUSE_POINTER_SHAPE:
2593	if (cbBuffer >= sizeof(VBVAMOUSEPOINTERSHAPE))
2594	{
2595	VBVAMOUSEPOINTERSHAPE RT_UNTRUSTED_VOLATILE_GUEST *pShape;
2596	pShape = (VBVAMOUSEPOINTERSHAPE RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer;
2597	rc = vbvaMousePointerShape(pVGAState, pCtx, pShape, cbBuffer);
2598	pShape->i32Result = rc;
2599	}
2600	else
2601	rc = VERR_INVALID_PARAMETER;
2602	break;
2603
2604
2605	#ifdef VBOX_WITH_VIDEOHWACCEL
2606	case VBVA_VHWA_CMD:
2607	if (cbBuffer >= VBOXVHWACMD_HEADSIZE())
2608	{
2609	vbvaVHWAHandleCommand(pVGAState, (VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer);
2610	rc = VINF_SUCCESS;
2611	}
2612	else
2613	rc = VERR_INVALID_PARAMETER;
2614	break;
2615	#endif
2616
2617	#ifdef VBOX_WITH_WDDM
2618	case VBVA_INFO_CAPS:
2619	if (cbBuffer >= sizeof(VBVACAPS))
2620	{
2621	VBVACAPS RT_UNTRUSTED_VOLATILE_GUEST pCaps = (VBVACAPS RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer;
2622	pVGAState->fGuestCaps = pCaps->fCaps;
2623	pVGAState->pDrv->pfnVBVAGuestCapabilityUpdate(pVGAState->pDrv, pVGAState->fGuestCaps);
2624	pCaps->rc = rc = VINF_SUCCESS;
2625	}
2626	else
2627	rc = VERR_INVALID_PARAMETER;
2628	break;
2629	#endif
2630
2631	case VBVA_SCANLINE_CFG:
2632	if (cbBuffer >= sizeof(VBVASCANLINECFG))
2633	{
2634	VBVASCANLINECFG RT_UNTRUSTED_VOLATILE_GUEST pCfg = (VBVASCANLINECFG RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer;
2635	pVGAState->fScanLineCfg = pCfg->fFlags;
2636	pCfg->rc = rc = VINF_SUCCESS;
2637	}
2638	else
2639	rc = VERR_INVALID_PARAMETER;
2640	break;
2641
2642	case VBVA_QUERY_MODE_HINTS:
2643	if (cbBuffer >= sizeof(VBVAQUERYMODEHINTS))
2644	{
2645	VBVAQUERYMODEHINTS RT_UNTRUSTED_VOLATILE_GUEST *pQueryModeHints;
2646	pQueryModeHints = (VBVAQUERYMODEHINTS RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer;
2647	rc = vbvaHandleQueryModeHints(pVGAState, pQueryModeHints, cbBuffer);
2648	pQueryModeHints->rc = rc;
2649	}
2650	else
2651	rc = VERR_INVALID_PARAMETER;
2652	break;
2653
2654	case VBVA_REPORT_INPUT_MAPPING:
2655	if (cbBuffer >= sizeof(VBVAREPORTINPUTMAPPING))
2656	{
2657	VBVAREPORTINPUTMAPPING inputMapping;
2658	{
2659	VBVAREPORTINPUTMAPPING RT_UNTRUSTED_VOLATILE_GUEST *pInputMapping
2660	= (VBVAREPORTINPUTMAPPING RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer;
2661	inputMapping.x = pInputMapping->x;
2662	inputMapping.y = pInputMapping->y;
2663	inputMapping.cx = pInputMapping->cx;
2664	inputMapping.cy = pInputMapping->cy;
2665	}
2666	ASMCompilerBarrier();
2667
2668	LogRelFlowFunc(("VBVA: ChannelHandler: VBVA_REPORT_INPUT_MAPPING: x=%RI32, y=%RI32, cx=%RU32, cy=%RU32\n",
2669	inputMapping.x, inputMapping.y, inputMapping.cx, inputMapping.cy));
2670	pVGAState->pDrv->pfnVBVAInputMappingUpdate(pVGAState->pDrv,
2671	inputMapping.x, inputMapping.y,
2672	inputMapping.cx, inputMapping.cy);
2673	rc = VINF_SUCCESS;
2674	}
2675	else
2676	rc = VERR_INVALID_PARAMETER;
2677	break;
2678
2679	case VBVA_CURSOR_POSITION:
2680	if (cbBuffer >= sizeof(VBVACURSORPOSITION))
2681	{
2682	VBVACURSORPOSITION RT_UNTRUSTED_VOLATILE_GUEST pReport = (VBVACURSORPOSITION RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer;
2683	VBVACURSORPOSITION Report;
2684	Report.fReportPosition = pReport->fReportPosition;
2685	Report.x = pReport->x;
2686	Report.y = pReport->y;
2687	ASMCompilerBarrier();
2688
2689	LogRelFlowFunc(("VBVA: ChannelHandler: VBVA_CURSOR_POSITION: fReportPosition=%RTbool, x=%RU32, y=%RU32\n",
2690	RT_BOOL(Report.fReportPosition), Report.x, Report.y));
2691
2692	pVGAState->pDrv->pfnVBVAReportCursorPosition(pVGAState->pDrv, RT_BOOL(Report.fReportPosition), Report.x, Report.y);
2693	pReport->x = pCtx->xCursor;
2694	pReport->y = pCtx->yCursor;
2695	rc = VINF_SUCCESS;
2696	}
2697	else
2698	rc = VERR_INVALID_PARAMETER;
2699	break;
2700
2701	default:
2702	Log(("Unsupported VBVA guest command %d (%#x)!!!\n", u16ChannelInfo, u16ChannelInfo));
2703	break;
2704	}
2705
2706	return rc;
2707	}
2708
2709	/* When VBVA is paused, then VGA device is allowed to work but
2710	* no HGSMI etc state is changed.
2711	*/
2712	void VBVAPause(PVGASTATE pVGAState, bool fPause)
2713	{
2714	if (!pVGAState \|\| !pVGAState->pHGSMI)
2715	{
2716	return;
2717	}
2718
2719	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pVGAState->pHGSMI);
2720
2721	if (pCtx)
2722	{
2723	pCtx->fPaused = fPause;
2724	}
2725	}
2726
2727	bool VBVAIsPaused(PVGASTATE pVGAState)
2728	{
2729	if (pVGAState && pVGAState->pHGSMI)
2730	{
2731	const VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pVGAState->pHGSMI);
2732	if (pCtx && pCtx->cViews)
2733	{
2734	/* If VBVA is enabled at all. */
2735	const VBVAVIEW *pView = &pCtx->aViews[0];
2736	if (pView->vbva.guest.pVBVA)
2737	return pCtx->fPaused;
2738	}
2739	}
2740	/* VBVA is disabled. */
2741	return true;
2742	}
2743
2744	void VBVAOnVBEChanged(PVGASTATE pVGAState)
2745	{
2746	/* The guest does not depend on host handling the VBE registers. */
2747	if (pVGAState->fGuestCaps & VBVACAPS_USE_VBVA_ONLY)
2748	{
2749	return;
2750	}
2751
2752	VBVAPause(pVGAState, (pVGAState->vbe_regs[VBE_DISPI_INDEX_ENABLE] & VBE_DISPI_ENABLED) == 0);
2753	}
2754
2755	void VBVAReset (PVGASTATE pVGAState)
2756	{
2757	if (!pVGAState \|\| !pVGAState->pHGSMI)
2758	{
2759	return;
2760	}
2761
2762	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pVGAState->pHGSMI);
2763
2764	#ifdef VBOX_WITH_VIDEOHWACCEL
2765	vbvaVHWAReset (pVGAState);
2766	#endif
2767
2768	HGSMIReset(pVGAState->pHGSMI);
2769	/* Make sure the IRQ is reset. */
2770	PDMDevHlpPCISetIrq(pVGAState->pDevInsR3, 0, PDM_IRQ_LEVEL_LOW);
2771	pVGAState->fu32PendingGuestFlags = 0;
2772
2773	if (pCtx)
2774	{
2775	vbvaFlush (pVGAState, pCtx);
2776
2777	unsigned uScreenId;
2778
2779	for (uScreenId = 0; uScreenId < pCtx->cViews; uScreenId++)
2780	{
2781	vbvaDisable (uScreenId, pVGAState, pCtx);
2782	}
2783
2784	pCtx->mouseShapeInfo.fSet = false;
2785	RTMemFree(pCtx->mouseShapeInfo.pu8Shape);
2786	pCtx->mouseShapeInfo.pu8Shape = NULL;
2787	pCtx->mouseShapeInfo.cbAllocated = 0;
2788	pCtx->mouseShapeInfo.cbShape = 0;
2789	}
2790
2791	}
2792
2793	int VBVAUpdateDisplay (PVGASTATE pVGAState)
2794	{
2795	int rc = VERR_NOT_SUPPORTED; /* Assuming that the VGA device will have to do updates. */
2796
2797	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pVGAState->pHGSMI);
2798
2799	if (pCtx)
2800	{
2801	if (!pCtx->fPaused)
2802	{
2803	rc = vbvaFlush (pVGAState, pCtx);
2804
2805	if (RT_SUCCESS (rc))
2806	{
2807	if (!pCtx->aViews[0].vbva.guest.pVBVA)
2808	{
2809	/* VBVA is not enabled for the first view, so VGA device must do updates. */
2810	rc = VERR_NOT_SUPPORTED;
2811	}
2812	}
2813	}
2814	}
2815
2816	return rc;
2817	}
2818
2819	static int vbvaSendModeHintWorker(PVGASTATE pThis, uint32_t cx, uint32_t cy,
2820	uint32_t cBPP, uint32_t iDisplay, uint32_t dx,
2821	uint32_t dy, uint32_t fEnabled,
2822	uint32_t fNotifyGuest)
2823	{
2824	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pThis->pHGSMI);
2825	/** @note See Display::setVideoModeHint: "It is up to the guest to decide
2826	* whether the hint is valid. Therefore don't do any VRAM sanity checks
2827	* here! */
2828	if (iDisplay >= RT_MIN(pThis->cMonitors, RT_ELEMENTS(pCtx->aModeHints)))
2829	return VERR_OUT_OF_RANGE;
2830	pCtx->aModeHints[iDisplay].magic = VBVAMODEHINT_MAGIC;
2831	pCtx->aModeHints[iDisplay].cx = cx;
2832	pCtx->aModeHints[iDisplay].cy = cy;
2833	pCtx->aModeHints[iDisplay].cBPP = cBPP;
2834	pCtx->aModeHints[iDisplay].dx = dx;
2835	pCtx->aModeHints[iDisplay].dy = dy;
2836	pCtx->aModeHints[iDisplay].fEnabled = fEnabled;
2837	if (fNotifyGuest && pThis->fGuestCaps & VBVACAPS_IRQ && pThis->fGuestCaps & VBVACAPS_VIDEO_MODE_HINTS)
2838	VBVARaiseIrq(pThis, HGSMIHOSTFLAGS_HOTPLUG);
2839	return VINF_SUCCESS;
2840	}
2841
2842	/** Converts a display port interface pointer to a vga state pointer. */
2843	#define IDISPLAYPORT_2_VGASTATE(pInterface) ( (PVGASTATE)((uintptr_t)pInterface - RT_OFFSETOF(VGASTATE, IPort)) )
2844
2845	DECLCALLBACK(int) vbvaPortSendModeHint(PPDMIDISPLAYPORT pInterface, uint32_t cx,
2846	uint32_t cy, uint32_t cBPP,
2847	uint32_t iDisplay, uint32_t dx,
2848	uint32_t dy, uint32_t fEnabled,
2849	uint32_t fNotifyGuest)
2850	{
2851	PVGASTATE pThis;
2852	int rc;
2853
2854	pThis = IDISPLAYPORT_2_VGASTATE(pInterface);
2855	rc = PDMCritSectEnter(&pThis->CritSect, VERR_SEM_BUSY);
2856	AssertRC(rc);
2857	rc = vbvaSendModeHintWorker(pThis, cx, cy, cBPP, iDisplay, dx, dy, fEnabled,
2858	fNotifyGuest);
2859	PDMCritSectLeave(&pThis->CritSect);
2860	return rc;
2861	}
2862
2863	DECLCALLBACK(void) vbvaPortReportHostCursorCapabilities(PPDMIDISPLAYPORT pInterface, uint32_t fCapabilitiesAdded,
2864	uint32_t fCapabilitiesRemoved)
2865	{
2866	PVGASTATE pThis = IDISPLAYPORT_2_VGASTATE(pInterface);
2867	int rc = PDMCritSectEnter(&pThis->CritSect, VERR_SEM_BUSY);
2868	AssertRC(rc);
2869	pThis->fHostCursorCapabilities \|= fCapabilitiesAdded;
2870	pThis->fHostCursorCapabilities &= ~fCapabilitiesRemoved;
2871	if (pThis->fGuestCaps & VBVACAPS_IRQ && pThis->fGuestCaps & VBVACAPS_DISABLE_CURSOR_INTEGRATION)
2872	VBVARaiseIrq(pThis, HGSMIHOSTFLAGS_CURSOR_CAPABILITIES);
2873	PDMCritSectLeave(&pThis->CritSect);
2874	}
2875
2876	DECLCALLBACK(void) vbvaPortReportHostCursorPosition(PPDMIDISPLAYPORT pInterface, uint32_t x, uint32_t y)
2877	{
2878	PVGASTATE pThis = IDISPLAYPORT_2_VGASTATE(pInterface);
2879	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pThis->pHGSMI);
2880	int rc = PDMCritSectEnter(&pThis->CritSect, VERR_SEM_BUSY);
2881	AssertRC(rc);
2882	pCtx->xCursor = x;
2883	pCtx->yCursor = y;
2884	PDMCritSectLeave(&pThis->CritSect);
2885	}
2886
2887	int VBVAInit(PVGASTATE pVGAState)
2888	{
2889	PPDMDEVINS pDevIns = pVGAState->pDevInsR3;
2890
2891	PVM pVM = PDMDevHlpGetVM(pDevIns);
2892
2893	int rc = HGSMICreate(&pVGAState->pHGSMI,
2894	pVM,
2895	"VBVA",
2896	0,
2897	pVGAState->vram_ptrR3,
2898	pVGAState->vram_size,
2899	vbvaNotifyGuest,
2900	pVGAState,
2901	sizeof(VBVACONTEXT));
2902	if (RT_SUCCESS(rc))
2903	{
2904	rc = HGSMIHostChannelRegister(pVGAState->pHGSMI,
2905	HGSMI_CH_VBVA,
2906	vbvaChannelHandler,
2907	pVGAState);
2908	if (RT_SUCCESS(rc))
2909	{
2910	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pVGAState->pHGSMI);
2911	pCtx->cViews = pVGAState->cMonitors;
2912	pCtx->fPaused = true;
2913	memset(pCtx->aModeHints, ~0, sizeof(pCtx->aModeHints));
2914	pVGAState->fHostCursorCapabilities = 0;
2915	}
2916	}
2917
2918	return rc;
2919
2920	}
2921
2922	void VBVADestroy(PVGASTATE pVGAState)
2923	{
2924	PHGSMIINSTANCE pHgsmi = pVGAState->pHGSMI;
2925	if (pHgsmi)
2926	{
2927	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pHgsmi);
2928	pCtx->mouseShapeInfo.fSet = false;
2929	RTMemFree(pCtx->mouseShapeInfo.pu8Shape);
2930	pCtx->mouseShapeInfo.pu8Shape = NULL;
2931	pCtx->mouseShapeInfo.cbAllocated = 0;
2932	pCtx->mouseShapeInfo.cbShape = 0;
2933
2934	HGSMIDestroy(pHgsmi);
2935	pVGAState->pHGSMI = NULL;
2936	}
2937	}
2938

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Devices/Graphics/DevVGA_VBVA.cpp@ 71595

Download in other formats: