DevVGA_VBVA.cpp@ 71590

Last change on this file since 71590 was 71590, checked in by vboxsync, 7 years ago
DevVGA,HGSMI,++: 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.0 KB

Line
1	/* $Id: DevVGA_VBVA.cpp 71590 2018-03-31 18:34:28Z 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.215389.xyz. 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(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	AssertRC(rc);
1202	if(RT_SUCCESS(rc))
1203	{
1204	rc = pCmd->rc;
1205	AssertMsg(RT_SUCCESS(rc) \|\| rc == VERR_NOT_IMPLEMENTED, ("%Rrc\n", rc));
1206	if(rc == VERR_NOT_IMPLEMENTED)
1207	{
1208	/** @todo set some flag in pVGAState indicating VHWA is not supported */
1209	/* VERR_NOT_IMPLEMENTED is not a failure, we just do not support it */
1210	rc = VINF_SUCCESS;
1211	}
1212
1213	if (!RT_SUCCESS(rc))
1214	break;
1215	}
1216	else
1217	break;
1218
1219	++iDisplay;
1220	if (iDisplay >= pVGAState->cMonitors)
1221	break;
1222	vbvaVHWAHHCommandReinit(pCmd, VBOXVHWACMD_TYPE_HH_CONSTRUCT, (int32_t)iDisplay);
1223	} while (true);
1224
1225	vbvaVHWAHHCommandRelease(pCmd);
1226
1227	return rc;
1228	}
1229	return VERR_OUT_OF_RESOURCES;
1230	}
1231
1232	int vbvaVHWAReset (PVGASTATE pVGAState)
1233	{
1234	vbvaVHWACommandClearAllPending(pVGAState);
1235
1236	/* ensure we have all pending cmds processed and h->g cmds disabled */
1237	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(VBOXVHWACMD_TYPE_HH_RESET, 0, 0);
1238	Assert(pCmd);
1239	if(pCmd)
1240	{
1241	int rc = VINF_SUCCESS;
1242	uint32_t iDisplay = 0;
1243
1244	do
1245	{
1246	rc =vbvaVHWAHHCommandPost(pVGAState, pCmd);
1247	AssertRC(rc);
1248	if(RT_SUCCESS(rc))
1249	{
1250	rc = pCmd->rc;
1251	AssertMsg(RT_SUCCESS(rc) \|\| rc == VERR_NOT_IMPLEMENTED, ("%Rrc\n", rc));
1252	if (rc == VERR_NOT_IMPLEMENTED)
1253	rc = VINF_SUCCESS;
1254	}
1255
1256	if (!RT_SUCCESS(rc))
1257	break;
1258
1259	++iDisplay;
1260	if (iDisplay >= pVGAState->cMonitors)
1261	break;
1262	vbvaVHWAHHCommandReinit(pCmd, VBOXVHWACMD_TYPE_HH_RESET, (int32_t)iDisplay);
1263
1264	} while (true);
1265
1266	vbvaVHWAHHCommandRelease(pCmd);
1267
1268	return rc;
1269	}
1270	return VERR_OUT_OF_RESOURCES;
1271	}
1272
1273	typedef DECLCALLBACK(bool) FNVBOXVHWAHHCMDPRECB(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, void pvContext);
1274	typedef FNVBOXVHWAHHCMDPRECB *PFNVBOXVHWAHHCMDPRECB;
1275
1276	typedef DECLCALLBACK(bool) FNVBOXVHWAHHCMDPOSTCB(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, int rc, void pvContext);
1277	typedef FNVBOXVHWAHHCMDPOSTCB *PFNVBOXVHWAHHCMDPOSTCB;
1278
1279	int vbvaVHWAHHPost(PVGASTATE pVGAState, VBOXVHWACMD pCmd, PFNVBOXVHWAHHCMDPRECB pfnPre, PFNVBOXVHWAHHCMDPOSTCB pfnPost, void pvContext)
1280	{
1281	const VBOXVHWACMD_TYPE enmType = pCmd->enmCmd;
1282	int rc = VINF_SUCCESS;
1283	uint32_t iDisplay = 0;
1284
1285	do
1286	{
1287	if (!pfnPre \|\| pfnPre(pVGAState, pCmd, iDisplay, pvContext))
1288	{
1289	rc = vbvaVHWAHHCommandPost(pVGAState, pCmd);
1290	AssertRC(rc);
1291	if (pfnPost)
1292	{
1293	if (!pfnPost(pVGAState, pCmd, iDisplay, rc, pvContext))
1294	{
1295	rc = VINF_SUCCESS;
1296	break;
1297	}
1298	rc = VINF_SUCCESS;
1299	}
1300	else if(RT_SUCCESS(rc))
1301	{
1302	rc = pCmd->rc;
1303	AssertMsg(RT_SUCCESS(rc) \|\| rc == VERR_NOT_IMPLEMENTED, ("%Rrc\n", rc));
1304	if(rc == VERR_NOT_IMPLEMENTED)
1305	{
1306	rc = VINF_SUCCESS;
1307	}
1308	}
1309
1310	if (!RT_SUCCESS(rc))
1311	break;
1312	}
1313
1314	++iDisplay;
1315	if (iDisplay >= pVGAState->cMonitors)
1316	break;
1317	vbvaVHWAHHCommandReinit(pCmd, enmType, (int32_t)iDisplay);
1318	} while (true);
1319
1320	return rc;
1321	}
1322
1323	/** @todo call this also on reset? */
1324	int vbvaVHWAEnable (PVGASTATE pVGAState, bool bEnable)
1325	{
1326	const VBOXVHWACMD_TYPE enmType = bEnable ? VBOXVHWACMD_TYPE_HH_ENABLE : VBOXVHWACMD_TYPE_HH_DISABLE;
1327	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(enmType, 0, 0);
1328	Assert(pCmd);
1329	if(pCmd)
1330	{
1331	int rc = vbvaVHWAHHPost (pVGAState, pCmd, NULL, NULL, NULL);
1332	vbvaVHWAHHCommandRelease(pCmd);
1333	return rc;
1334	}
1335	return VERR_OUT_OF_RESOURCES;
1336	}
1337
1338	int vboxVBVASaveStatePrep(PPDMDEVINS pDevIns)
1339	{
1340	/* ensure we have no pending commands */
1341	return vbvaVHWAEnable(PDMINS_2_DATA(pDevIns, PVGASTATE), false);
1342	}
1343
1344	int vboxVBVASaveStateDone(PPDMDEVINS pDevIns)
1345	{
1346	/* ensure we have no pending commands */
1347	return vbvaVHWAEnable(PDMINS_2_DATA(pDevIns, PVGASTATE), true);
1348	}
1349
1350	DECLCALLBACK(int) vbvaVHWACommandCompleteAsync(PPDMIDISPLAYVBVACALLBACKS pInterface, VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *pCmd)
1351	{
1352	int rc;
1353	Log(("VGA Command <<< Async rc %d %#p, %d\n", pCmd->rc, pCmd, pCmd->enmCmd));
1354
1355	if ((pCmd->Flags & VBOXVHWACMD_FLAG_HH_CMD) == 0)
1356	{
1357	PVGASTATE pVGAState = PPDMIDISPLAYVBVACALLBACKS_2_PVGASTATE(pInterface);
1358	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
1359
1360	Assert(pCmd->Flags & VBOXVHWACMD_FLAG_HG_ASYNCH);
1361	#ifdef VBOX_WITH_WDDM
1362	if (pVGAState->fGuestCaps & VBVACAPS_COMPLETEGCMD_BY_IOREAD)
1363	{
1364	rc = HGSMICompleteGuestCommand(pIns, pCmd, !!(pCmd->Flags & VBOXVHWACMD_FLAG_GH_ASYNCH_IRQ));
1365	AssertRC(rc);
1366	}
1367	else
1368	#endif
1369	{
1370	VBVAHOSTCMD RT_UNTRUSTED_VOLATILE_GUEST pHostCmd = NULL; / Shut up MSC. */
1371	if (pCmd->Flags & VBOXVHWACMD_FLAG_GH_ASYNCH_EVENT)
1372	{
1373	rc = HGSMIHostCommandAlloc(pIns,
1374	(void RT_UNTRUSTED_VOLATILE_GUEST **)&pHostCmd,
1375	VBVAHOSTCMD_SIZE(sizeof(VBVAHOSTCMDEVENT)),
1376	HGSMI_CH_VBVA,
1377	VBVAHG_EVENT);
1378	AssertRC(rc);
1379	if (RT_SUCCESS(rc))
1380	{
1381	memset((void *)pHostCmd, 0 , VBVAHOSTCMD_SIZE(sizeof(VBVAHOSTCMDEVENT)));
1382	pHostCmd->iDstID = pCmd->iDisplay;
1383	pHostCmd->customOpCode = 0;
1384	VBVAHOSTCMDEVENT *pBody = VBVAHOSTCMD_BODY(pHostCmd, VBVAHOSTCMDEVENT);
1385	pBody->pEvent = pCmd->GuestVBVAReserved1;
1386	}
1387	}
1388	else
1389	{
1390	HGSMIOFFSET offCmd = HGSMIPointerToOffsetHost(pIns, pCmd);
1391	Assert(offCmd != HGSMIOFFSET_VOID);
1392	if (offCmd != HGSMIOFFSET_VOID)
1393	{
1394	rc = HGSMIHostCommandAlloc(pIns,
1395	(void RT_UNTRUSTED_VOLATILE_GUEST **)&pHostCmd,
1396	VBVAHOSTCMD_SIZE(sizeof(VBVAHOSTCMDVHWACMDCOMPLETE)),
1397	HGSMI_CH_VBVA,
1398	VBVAHG_DISPLAY_CUSTOM);
1399	AssertRC(rc);
1400	if (RT_SUCCESS(rc))
1401	{
1402	memset((void *)pHostCmd, 0 , VBVAHOSTCMD_SIZE(sizeof(VBVAHOSTCMDVHWACMDCOMPLETE)));
1403	pHostCmd->iDstID = pCmd->iDisplay;
1404	pHostCmd->customOpCode = VBVAHG_DCUSTOM_VHWA_CMDCOMPLETE;
1405	VBVAHOSTCMDVHWACMDCOMPLETE *pBody = VBVAHOSTCMD_BODY(pHostCmd, VBVAHOSTCMDVHWACMDCOMPLETE);
1406	pBody->offCmd = offCmd;
1407	}
1408	}
1409	else
1410	rc = VERR_INVALID_PARAMETER;
1411	}
1412
1413	if (RT_SUCCESS(rc))
1414	{
1415	rc = HGSMIHostCommandSubmitAndFreeAsynch(pIns, pHostCmd, RT_BOOL(pCmd->Flags & VBOXVHWACMD_FLAG_GH_ASYNCH_IRQ));
1416	AssertRC(rc);
1417	if (RT_SUCCESS(rc))
1418	return rc;
1419
1420	HGSMIHostCommandFree (pIns, pHostCmd);
1421	}
1422	}
1423	}
1424	else
1425	{
1426	PFNVBOXVHWA_HH_CALLBACK pfn = VBOXVHWA_HH_CALLBACK_GET(pCmd);
1427	if (pfn)
1428	pfn(VBOXVHWA_HH_CALLBACK_GET_ARG(pCmd));
1429	rc = VINF_SUCCESS;
1430	}
1431	return rc;
1432	}
1433
1434	typedef struct VBOXVBVASAVEDSTATECBDATA
1435	{
1436	PSSMHANDLE pSSM;
1437	int rc;
1438	bool ab2DOn[VBOX_VIDEO_MAX_SCREENS];
1439	} VBOXVBVASAVEDSTATECBDATA, *PVBOXVBVASAVEDSTATECBDATA;
1440
1441	static DECLCALLBACK(bool) vboxVBVASaveStateBeginPostCb(PVGASTATE pVGAState, VBOXVHWACMD *pCmd, uint32_t iDisplay,
1442	int rc, void *pvContext)
1443	{
1444	RT_NOREF(pVGAState, pCmd);
1445	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1446	if (RT_FAILURE(pData->rc))
1447	return false;
1448	if (RT_FAILURE(rc))
1449	{
1450	pData->rc = rc;
1451	return false;
1452	}
1453
1454	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1455	if (iDisplay >= RT_ELEMENTS(pData->ab2DOn))
1456	{
1457	pData->rc = VERR_INVALID_PARAMETER;
1458	return false;
1459	}
1460
1461	Assert(RT_SUCCESS(pCmd->rc) \|\| pCmd->rc == VERR_NOT_IMPLEMENTED);
1462	if (RT_SUCCESS(pCmd->rc))
1463	{
1464	pData->ab2DOn[iDisplay] = true;
1465	}
1466	else if (pCmd->rc != VERR_NOT_IMPLEMENTED)
1467	{
1468	pData->rc = pCmd->rc;
1469	return false;
1470	}
1471
1472	return true;
1473	}
1474
1475	static DECLCALLBACK(bool)
1476	vboxVBVASaveStatePerformPreCb(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, void pvContext)
1477	{
1478	RT_NOREF(pVGAState, pCmd);
1479	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1480	if (RT_FAILURE(pData->rc))
1481	return false;
1482
1483	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1484	if (iDisplay >= RT_ELEMENTS(pData->ab2DOn))
1485	{
1486	pData->rc = VERR_INVALID_PARAMETER;
1487	return false;
1488	}
1489
1490	int rc;
1491
1492	if (pData->ab2DOn[iDisplay])
1493	{
1494	rc = SSMR3PutU32 (pData->pSSM, VBOXVBVASAVEDSTATE_VHWAAVAILABLE_MAGIC); AssertRC(rc);
1495	if (RT_FAILURE(rc))
1496	{
1497	pData->rc = rc;
1498	return false;
1499	}
1500	return true;
1501	}
1502
1503	rc = SSMR3PutU32 (pData->pSSM, VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC); AssertRC(rc);
1504	if (RT_FAILURE(rc))
1505	{
1506	pData->rc = rc;
1507	return false;
1508	}
1509
1510	return false;
1511	}
1512
1513	static DECLCALLBACK(bool) vboxVBVASaveStateEndPreCb(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, void pvContext)
1514	{
1515	RT_NOREF(pVGAState, pCmd);
1516	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1517	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1518	if (pData->ab2DOn[iDisplay])
1519	{
1520	return true;
1521	}
1522
1523	return false;
1524	}
1525
1526	static DECLCALLBACK(bool)
1527	vboxVBVALoadStatePerformPostCb(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, int rc, void pvContext)
1528	{
1529	RT_NOREF(pVGAState, pCmd);
1530	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1531	if (RT_FAILURE(pData->rc))
1532	return false;
1533	if (RT_FAILURE(rc))
1534	{
1535	pData->rc = rc;
1536	return false;
1537	}
1538
1539	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1540	if (iDisplay >= RT_ELEMENTS(pData->ab2DOn))
1541	{
1542	pData->rc = VERR_INVALID_PARAMETER;
1543	return false;
1544	}
1545
1546	Assert(RT_SUCCESS(pCmd->rc) \|\| pCmd->rc == VERR_NOT_IMPLEMENTED);
1547	if (pCmd->rc == VERR_NOT_IMPLEMENTED)
1548	{
1549	pData->rc = SSMR3SkipToEndOfUnit(pData->pSSM);
1550	AssertRC(pData->rc);
1551	return false;
1552	}
1553	if (RT_FAILURE(pCmd->rc))
1554	{
1555	pData->rc = pCmd->rc;
1556	return false;
1557	}
1558
1559	return true;
1560	}
1561
1562	static DECLCALLBACK(bool)
1563	vboxVBVALoadStatePerformPreCb(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, void pvContext)
1564	{
1565	RT_NOREF(pVGAState, pCmd);
1566	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1567	if (RT_FAILURE(pData->rc))
1568	return false;
1569
1570	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1571	if (iDisplay >= RT_ELEMENTS(pData->ab2DOn))
1572	{
1573	pData->rc = VERR_INVALID_PARAMETER;
1574	return false;
1575	}
1576
1577	int rc;
1578	uint32_t u32;
1579	rc = SSMR3GetU32(pData->pSSM, &u32); AssertRC(rc);
1580	if (RT_FAILURE(rc))
1581	{
1582	pData->rc = rc;
1583	return false;
1584	}
1585
1586	switch (u32)
1587	{
1588	case VBOXVBVASAVEDSTATE_VHWAAVAILABLE_MAGIC:
1589	pData->ab2DOn[iDisplay] = true;
1590	return true;
1591	case VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC:
1592	pData->ab2DOn[iDisplay] = false;
1593	return false;
1594	default:
1595	pData->rc = VERR_INVALID_STATE;
1596	return false;
1597	}
1598	}
1599	#endif /* #ifdef VBOX_WITH_VIDEOHWACCEL */
1600
1601	int vboxVBVASaveDevStateExec (PVGASTATE pVGAState, PSSMHANDLE pSSM)
1602	{
1603	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
1604	int rc = HGSMIHostSaveStateExec (pIns, pSSM);
1605	if (RT_SUCCESS(rc))
1606	{
1607	VGA_SAVED_STATE_PUT_MARKER(pSSM, 2);
1608
1609	/* Save VBVACONTEXT. */
1610	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pIns);
1611
1612	if (!pCtx)
1613	{
1614	AssertFailed();
1615
1616	/* Still write a valid value to the SSM. */
1617	rc = SSMR3PutU32 (pSSM, 0);
1618	AssertRCReturn(rc, rc);
1619	}
1620	else
1621	{
1622	#ifdef DEBUG_sunlover
1623	dumpctx(pCtx);
1624	#endif
1625
1626	rc = SSMR3PutU32 (pSSM, pCtx->cViews);
1627	AssertRCReturn(rc, rc);
1628
1629	uint32_t iView;
1630	for (iView = 0; iView < pCtx->cViews; iView++)
1631	{
1632	VBVAVIEW *pView = &pCtx->aViews[iView];
1633
1634	rc = SSMR3PutU32 (pSSM, pView->view.u32ViewIndex);
1635	AssertRCReturn(rc, rc);
1636	rc = SSMR3PutU32 (pSSM, pView->view.u32ViewOffset);
1637	AssertRCReturn(rc, rc);
1638	rc = SSMR3PutU32 (pSSM, pView->view.u32ViewSize);
1639	AssertRCReturn(rc, rc);
1640	rc = SSMR3PutU32 (pSSM, pView->view.u32MaxScreenSize);
1641	AssertRCReturn(rc, rc);
1642
1643	rc = SSMR3PutU32 (pSSM, pView->screen.u32ViewIndex);
1644	AssertRCReturn(rc, rc);
1645	rc = SSMR3PutS32 (pSSM, pView->screen.i32OriginX);
1646	AssertRCReturn(rc, rc);
1647	rc = SSMR3PutS32 (pSSM, pView->screen.i32OriginY);
1648	AssertRCReturn(rc, rc);
1649	rc = SSMR3PutU32 (pSSM, pView->screen.u32StartOffset);
1650	AssertRCReturn(rc, rc);
1651	rc = SSMR3PutU32 (pSSM, pView->screen.u32LineSize);
1652	AssertRCReturn(rc, rc);
1653	rc = SSMR3PutU32 (pSSM, pView->screen.u32Width);
1654	AssertRCReturn(rc, rc);
1655	rc = SSMR3PutU32 (pSSM, pView->screen.u32Height);
1656	AssertRCReturn(rc, rc);
1657	rc = SSMR3PutU16 (pSSM, pView->screen.u16BitsPerPixel);
1658	AssertRCReturn(rc, rc);
1659	rc = SSMR3PutU16 (pSSM, pView->screen.u16Flags);
1660	AssertRCReturn(rc, rc);
1661
1662	rc = SSMR3PutU32 (pSSM, pView->vbva.guest.pVBVA? pView->vbva.u32VBVAOffset: HGSMIOFFSET_VOID);
1663	AssertRCReturn(rc, rc);
1664
1665	rc = SSMR3PutU32 (pSSM, pView->vbva.partialRecord.cb);
1666	AssertRCReturn(rc, rc);
1667
1668	if (pView->vbva.partialRecord.cb > 0)
1669	{
1670	rc = SSMR3PutMem (pSSM, pView->vbva.partialRecord.pu8, pView->vbva.partialRecord.cb);
1671	AssertRCReturn(rc, rc);
1672	}
1673	}
1674
1675	/* Save mouse pointer shape information. */
1676	rc = SSMR3PutBool (pSSM, pCtx->mouseShapeInfo.fSet);
1677	AssertRCReturn(rc, rc);
1678	rc = SSMR3PutBool (pSSM, pCtx->mouseShapeInfo.fVisible);
1679	AssertRCReturn(rc, rc);
1680	rc = SSMR3PutBool (pSSM, pCtx->mouseShapeInfo.fAlpha);
1681	AssertRCReturn(rc, rc);
1682	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.u32HotX);
1683	AssertRCReturn(rc, rc);
1684	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.u32HotY);
1685	AssertRCReturn(rc, rc);
1686	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.u32Width);
1687	AssertRCReturn(rc, rc);
1688	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.u32Height);
1689	AssertRCReturn(rc, rc);
1690	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.cbShape);
1691	AssertRCReturn(rc, rc);
1692	if (pCtx->mouseShapeInfo.cbShape)
1693	{
1694	rc = SSMR3PutMem (pSSM, pCtx->mouseShapeInfo.pu8Shape, pCtx->mouseShapeInfo.cbShape);
1695	AssertRCReturn(rc, rc);
1696	}
1697
1698	#ifdef VBOX_WITH_WDDM
1699	/* Size of some additional data. For future extensions. */
1700	rc = SSMR3PutU32 (pSSM, 4);
1701	AssertRCReturn(rc, rc);
1702	rc = SSMR3PutU32 (pSSM, pVGAState->fGuestCaps);
1703	AssertRCReturn(rc, rc);
1704	#else
1705	/* Size of some additional data. For future extensions. */
1706	rc = SSMR3PutU32 (pSSM, 0);
1707	AssertRCReturn(rc, rc);
1708	#endif
1709	rc = SSMR3PutU32 (pSSM, RT_ELEMENTS(pCtx->aModeHints));
1710	AssertRCReturn(rc, rc);
1711	rc = SSMR3PutU32 (pSSM, sizeof(VBVAMODEHINT));
1712	AssertRCReturn(rc, rc);
1713	for (unsigned i = 0; i < RT_ELEMENTS(pCtx->aModeHints); ++i)
1714	{
1715	rc = SSMR3PutMem (pSSM, &pCtx->aModeHints[i],
1716	sizeof(VBVAMODEHINT));
1717	AssertRCReturn(rc, rc);
1718	}
1719	}
1720	}
1721
1722	return rc;
1723	}
1724
1725	int vboxVBVASaveStateExec (PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
1726	{
1727	PVGASTATE pVGAState = PDMINS_2_DATA(pDevIns, PVGASTATE);
1728	int rc;
1729	#ifdef VBOX_WITH_VIDEOHWACCEL
1730	VBOXVBVASAVEDSTATECBDATA VhwaData = {0};
1731	VhwaData.pSSM = pSSM;
1732	uint32_t cbCmd = sizeof (VBOXVHWACMD_HH_SAVESTATE_SAVEPERFORM); /* maximum cmd size */
1733	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEBEGIN, 0, cbCmd);
1734	Assert(pCmd);
1735	if(pCmd)
1736	{
1737	vbvaVHWAHHPost (pVGAState, pCmd, NULL, vboxVBVASaveStateBeginPostCb, &VhwaData);
1738	rc = VhwaData.rc;
1739	AssertRC(rc);
1740	if (RT_SUCCESS(rc))
1741	{
1742	#endif
1743	rc = vboxVBVASaveDevStateExec (pVGAState, pSSM);
1744	AssertRC(rc);
1745	#ifdef VBOX_WITH_VIDEOHWACCEL
1746	if (RT_SUCCESS(rc))
1747	{
1748	vbvaVHWAHHCommandReinit(pCmd, VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEPERFORM, 0);
1749	VBOXVHWACMD_HH_SAVESTATE_SAVEPERFORM *pSave = VBOXVHWACMD_BODY(pCmd, VBOXVHWACMD_HH_SAVESTATE_SAVEPERFORM);
1750	pSave->pSSM = pSSM;
1751	vbvaVHWAHHPost (pVGAState, pCmd, vboxVBVASaveStatePerformPreCb, NULL, &VhwaData);
1752	rc = VhwaData.rc;
1753	AssertRC(rc);
1754	if (RT_SUCCESS(rc))
1755	{
1756	rc = vbvaVHWACommandSavePending(pVGAState, pSSM);
1757	AssertRCReturn(rc, rc);
1758
1759	vbvaVHWAHHCommandReinit(pCmd, VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEEND, 0);
1760	vbvaVHWAHHPost (pVGAState, pCmd, vboxVBVASaveStateEndPreCb, NULL, &VhwaData);
1761	rc = VhwaData.rc;
1762	AssertRC(rc);
1763	}
1764	}
1765	}
1766
1767	vbvaVHWAHHCommandRelease(pCmd);
1768	}
1769	else
1770	rc = VERR_OUT_OF_RESOURCES;
1771	#else
1772	if (RT_SUCCESS(rc))
1773	{
1774	for (uint32_t i = 0; i < pVGAState->cMonitors; ++i)
1775	{
1776	rc = SSMR3PutU32 (pSSM, VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC);
1777	AssertRCReturn(rc, rc);
1778	}
1779	}
1780
1781	/* no pending commands */
1782	SSMR3PutU32(pSSM, 0);
1783	#endif
1784	return rc;
1785	}
1786
1787	int vboxVBVALoadStateExec (PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion)
1788	{
1789	if (uVersion < VGA_SAVEDSTATE_VERSION_HGSMI)
1790	{
1791	/* Nothing was saved. */
1792	return VINF_SUCCESS;
1793	}
1794
1795	PVGASTATE pVGAState = PDMINS_2_DATA(pDevIns, PVGASTATE);
1796	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
1797	int rc = HGSMIHostLoadStateExec (pIns, pSSM, uVersion);
1798	if (RT_SUCCESS(rc))
1799	{
1800	VGA_SAVED_STATE_GET_MARKER_RETURN_ON_MISMATCH(pSSM, uVersion, 2);
1801
1802	/* Load VBVACONTEXT. */
1803	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pIns);
1804
1805	if (!pCtx)
1806	{
1807	/* This should not happen. */
1808	AssertFailed();
1809	rc = VERR_INVALID_PARAMETER;
1810	}
1811	else
1812	{
1813	uint32_t cViews = 0;
1814	rc = SSMR3GetU32 (pSSM, &cViews);
1815	AssertRCReturn(rc, rc);
1816
1817	uint32_t iView;
1818	for (iView = 0; iView < cViews; iView++)
1819	{
1820	VBVAVIEW *pView = &pCtx->aViews[iView];
1821
1822	rc = SSMR3GetU32 (pSSM, &pView->view.u32ViewIndex);
1823	AssertRCReturn(rc, rc);
1824	rc = SSMR3GetU32 (pSSM, &pView->view.u32ViewOffset);
1825	AssertRCReturn(rc, rc);
1826	rc = SSMR3GetU32 (pSSM, &pView->view.u32ViewSize);
1827	AssertRCReturn(rc, rc);
1828	rc = SSMR3GetU32 (pSSM, &pView->view.u32MaxScreenSize);
1829	AssertRCReturn(rc, rc);
1830
1831	rc = SSMR3GetU32 (pSSM, &pView->screen.u32ViewIndex);
1832	AssertRCReturn(rc, rc);
1833	rc = SSMR3GetS32 (pSSM, &pView->screen.i32OriginX);
1834	AssertRCReturn(rc, rc);
1835	rc = SSMR3GetS32 (pSSM, &pView->screen.i32OriginY);
1836	AssertRCReturn(rc, rc);
1837	rc = SSMR3GetU32 (pSSM, &pView->screen.u32StartOffset);
1838	AssertRCReturn(rc, rc);
1839	rc = SSMR3GetU32 (pSSM, &pView->screen.u32LineSize);
1840	AssertRCReturn(rc, rc);
1841	rc = SSMR3GetU32 (pSSM, &pView->screen.u32Width);
1842	AssertRCReturn(rc, rc);
1843	rc = SSMR3GetU32 (pSSM, &pView->screen.u32Height);
1844	AssertRCReturn(rc, rc);
1845	rc = SSMR3GetU16 (pSSM, &pView->screen.u16BitsPerPixel);
1846	AssertRCReturn(rc, rc);
1847	rc = SSMR3GetU16 (pSSM, &pView->screen.u16Flags);
1848	AssertRCReturn(rc, rc);
1849
1850	rc = SSMR3GetU32 (pSSM, &pView->vbva.u32VBVAOffset);
1851	AssertRCReturn(rc, rc);
1852
1853	rc = SSMR3GetU32 (pSSM, &pView->vbva.partialRecord.cb);
1854	AssertRCReturn(rc, rc);
1855
1856	if (pView->vbva.partialRecord.cb == 0)
1857	{
1858	pView->vbva.partialRecord.pu8 = NULL;
1859	}
1860	else
1861	{
1862	Assert(pView->vbva.partialRecord.pu8 == NULL); /* Should be it. */
1863
1864	uint8_t pu8 = (uint8_t )RTMemAlloc(pView->vbva.partialRecord.cb);
1865
1866	if (!pu8)
1867	{
1868	return VERR_NO_MEMORY;
1869	}
1870
1871	pView->vbva.partialRecord.pu8 = pu8;
1872
1873	rc = SSMR3GetMem (pSSM, pView->vbva.partialRecord.pu8, pView->vbva.partialRecord.cb);
1874	AssertRCReturn(rc, rc);
1875	}
1876
1877	if (pView->vbva.u32VBVAOffset == HGSMIOFFSET_VOID)
1878	{
1879	pView->vbva.guest.pVBVA = NULL;
1880	}
1881	else
1882	{
1883	pView->vbva.guest.pVBVA = (VBVABUFFER *)HGSMIOffsetToPointerHost(pIns, pView->vbva.u32VBVAOffset);
1884	}
1885	}
1886
1887	if (uVersion > VGA_SAVEDSTATE_VERSION_WITH_CONFIG)
1888	{
1889	/* Read mouse pointer shape information. */
1890	rc = SSMR3GetBool (pSSM, &pCtx->mouseShapeInfo.fSet);
1891	AssertRCReturn(rc, rc);
1892	rc = SSMR3GetBool (pSSM, &pCtx->mouseShapeInfo.fVisible);
1893	AssertRCReturn(rc, rc);
1894	rc = SSMR3GetBool (pSSM, &pCtx->mouseShapeInfo.fAlpha);
1895	AssertRCReturn(rc, rc);
1896	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.u32HotX);
1897	AssertRCReturn(rc, rc);
1898	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.u32HotY);
1899	AssertRCReturn(rc, rc);
1900	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.u32Width);
1901	AssertRCReturn(rc, rc);
1902	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.u32Height);
1903	AssertRCReturn(rc, rc);
1904	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.cbShape);
1905	AssertRCReturn(rc, rc);
1906	if (pCtx->mouseShapeInfo.cbShape)
1907	{
1908	pCtx->mouseShapeInfo.pu8Shape = (uint8_t *)RTMemAlloc(pCtx->mouseShapeInfo.cbShape);
1909	if (pCtx->mouseShapeInfo.pu8Shape == NULL)
1910	{
1911	return VERR_NO_MEMORY;
1912	}
1913	pCtx->mouseShapeInfo.cbAllocated = pCtx->mouseShapeInfo.cbShape;
1914	rc = SSMR3GetMem (pSSM, pCtx->mouseShapeInfo.pu8Shape, pCtx->mouseShapeInfo.cbShape);
1915	AssertRCReturn(rc, rc);
1916	}
1917	else
1918	{
1919	pCtx->mouseShapeInfo.pu8Shape = NULL;
1920	}
1921
1922	/* Size of some additional data. For future extensions. */
1923	uint32_t cbExtra = 0;
1924	rc = SSMR3GetU32 (pSSM, &cbExtra);
1925	AssertRCReturn(rc, rc);
1926	#ifdef VBOX_WITH_WDDM
1927	if (cbExtra >= 4)
1928	{
1929	rc = SSMR3GetU32 (pSSM, &pVGAState->fGuestCaps);
1930	AssertRCReturn(rc, rc);
1931	pVGAState->pDrv->pfnVBVAGuestCapabilityUpdate(pVGAState->pDrv, pVGAState->fGuestCaps);
1932	cbExtra -= 4;
1933	}
1934	#endif
1935	if (cbExtra > 0)
1936	{
1937	rc = SSMR3Skip(pSSM, cbExtra);
1938	AssertRCReturn(rc, rc);
1939	}
1940
1941	if (uVersion >= VGA_SAVEDSTATE_VERSION_MODE_HINTS)
1942	{
1943	uint32_t cModeHints, cbModeHints;
1944	rc = SSMR3GetU32 (pSSM, &cModeHints);
1945	AssertRCReturn(rc, rc);
1946	rc = SSMR3GetU32 (pSSM, &cbModeHints);
1947	AssertRCReturn(rc, rc);
1948	memset(&pCtx->aModeHints, ~0, sizeof(pCtx->aModeHints));
1949	unsigned iHint;
1950	for (iHint = 0; iHint < cModeHints; ++iHint)
1951	{
1952	if ( cbModeHints <= sizeof(VBVAMODEHINT)
1953	&& iHint < RT_ELEMENTS(pCtx->aModeHints))
1954	rc = SSMR3GetMem(pSSM, &pCtx->aModeHints[iHint],
1955	cbModeHints);
1956	else
1957	rc = SSMR3Skip(pSSM, cbModeHints);
1958	AssertRCReturn(rc, rc);
1959	}
1960	}
1961	}
1962
1963	pCtx->cViews = iView;
1964	LogFlowFunc(("%d views loaded\n", pCtx->cViews));
1965
1966	if (uVersion > VGA_SAVEDSTATE_VERSION_WDDM)
1967	{
1968	bool fLoadCommands;
1969
1970	if (uVersion < VGA_SAVEDSTATE_VERSION_FIXED_PENDVHWA)
1971	{
1972	const char *pcszOsArch = SSMR3HandleHostOSAndArch(pSSM);
1973	Assert(pcszOsArch);
1974	fLoadCommands = !pcszOsArch \|\| RTStrNCmp(pcszOsArch, RT_STR_TUPLE("solaris"));
1975	}
1976	else
1977	fLoadCommands = true;
1978
1979	#ifdef VBOX_WITH_VIDEOHWACCEL
1980	uint32_t cbCmd = sizeof (VBOXVHWACMD_HH_SAVESTATE_LOADPERFORM); /* maximum cmd size */
1981	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(VBOXVHWACMD_TYPE_HH_SAVESTATE_LOADPERFORM, 0, cbCmd);
1982	Assert(pCmd);
1983	if(pCmd)
1984	{
1985	VBOXVBVASAVEDSTATECBDATA VhwaData = {0};
1986	VhwaData.pSSM = pSSM;
1987	VBOXVHWACMD_HH_SAVESTATE_LOADPERFORM *pLoad = VBOXVHWACMD_BODY(pCmd, VBOXVHWACMD_HH_SAVESTATE_LOADPERFORM);
1988	pLoad->pSSM = pSSM;
1989	vbvaVHWAHHPost (pVGAState, pCmd, vboxVBVALoadStatePerformPreCb, vboxVBVALoadStatePerformPostCb, &VhwaData);
1990	rc = VhwaData.rc;
1991	vbvaVHWAHHCommandRelease(pCmd);
1992	AssertRCReturn(rc, rc);
1993
1994	if (fLoadCommands)
1995	{
1996	rc = vbvaVHWACommandLoadPending(pVGAState, pSSM, uVersion);
1997	AssertRCReturn(rc, rc);
1998	}
1999	}
2000	else
2001	{
2002	rc = VERR_OUT_OF_RESOURCES;
2003	}
2004	#else
2005	uint32_t u32;
2006
2007	for (uint32_t i = 0; i < pVGAState->cMonitors; ++i)
2008	{
2009	rc = SSMR3GetU32(pSSM, &u32);
2010	AssertRCReturn(rc, rc);
2011
2012	if (u32 != VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC)
2013	{
2014	LogRel(("VBVA: 2D data while 2D is not supported\n"));
2015	return VERR_NOT_SUPPORTED;
2016	}
2017	}
2018
2019	if (fLoadCommands)
2020	{
2021	rc = SSMR3GetU32(pSSM, &u32);
2022	AssertRCReturn(rc, rc);
2023
2024	if (u32)
2025	{
2026	LogRel(("VBVA: 2D pending command while 2D is not supported\n"));
2027	return VERR_NOT_SUPPORTED;
2028	}
2029	}
2030	#endif
2031	}
2032
2033	#ifdef DEBUG_sunlover
2034	dumpctx(pCtx);
2035	#endif
2036	}
2037	}
2038
2039	return rc;
2040	}
2041
2042	int vboxVBVALoadStateDone(PPDMDEVINS pDevIns)
2043	{
2044	PVGASTATE pVGAState = PDMINS_2_DATA(pDevIns, PVGASTATE);
2045	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pVGAState->pHGSMI);
2046	if (pCtx)
2047	{
2048	uint32_t iView;
2049	for (iView = 0; iView < pCtx->cViews; iView++)
2050	{
2051	VBVAVIEW *pView = &pCtx->aViews[iView];
2052	if (pView->vbva.guest.pVBVA)
2053	{
2054	#ifdef VBOX_WITH_CRHGSMI
2055	Assert(!vboxCmdVBVAIsEnabled(pVGAState));
2056	#endif
2057	int rc = vbvaEnable(iView, pVGAState, pCtx, pView->vbva.guest.pVBVA, pView->vbva.u32VBVAOffset, true /* fRestored */);
2058	if (RT_SUCCESS(rc))
2059	vbvaResize(pVGAState, pView, &pView->screen, false);
2060	else
2061	LogRel(("VBVA: can not restore: %Rrc\n", rc));
2062	}
2063	}
2064
2065	if (pCtx->mouseShapeInfo.fSet)
2066	vbvaUpdateMousePointerShape(pVGAState, &pCtx->mouseShapeInfo, true);
2067	}
2068
2069	return VINF_SUCCESS;
2070	}
2071
2072	void VBVARaiseIrq (PVGASTATE pVGAState, uint32_t fFlags)
2073	{
2074	PPDMDEVINS pDevIns = pVGAState->pDevInsR3;
2075
2076	PDMCritSectEnter(&pVGAState->CritSectIRQ, VERR_SEM_BUSY);
2077
2078	const uint32_t fu32CurrentGuestFlags = HGSMIGetHostGuestFlags(pVGAState->pHGSMI);
2079	if ((fu32CurrentGuestFlags & HGSMIHOSTFLAGS_IRQ) == 0)
2080	{
2081	/* No IRQ set yet. */
2082	Assert(pVGAState->fu32PendingGuestFlags == 0);
2083
2084	HGSMISetHostGuestFlags(pVGAState->pHGSMI, HGSMIHOSTFLAGS_IRQ \| fFlags);
2085
2086	/* If VM is not running, the IRQ will be set in VBVAOnResume. */
2087	const VMSTATE enmVMState = PDMDevHlpVMState(pDevIns);
2088	if ( enmVMState == VMSTATE_RUNNING
2089	\|\| enmVMState == VMSTATE_RUNNING_LS)
2090	PDMDevHlpPCISetIrqNoWait(pDevIns, 0, PDM_IRQ_LEVEL_HIGH);
2091	}
2092	else
2093	{
2094	/* IRQ already set, remember the new flags. */
2095	pVGAState->fu32PendingGuestFlags \|= HGSMIHOSTFLAGS_IRQ \| fFlags;
2096	}
2097
2098	PDMCritSectLeave(&pVGAState->CritSectIRQ);
2099	}
2100
2101	void VBVAOnResume(PVGASTATE pThis)
2102	{
2103	PPDMDEVINS pDevIns = pThis->pDevInsR3;
2104
2105	PDMCritSectEnter(&pThis->CritSectIRQ, VERR_SEM_BUSY);
2106
2107	if (HGSMIGetHostGuestFlags(pThis->pHGSMI) & HGSMIHOSTFLAGS_IRQ)
2108	PDMDevHlpPCISetIrqNoWait(pDevIns, 0, PDM_IRQ_LEVEL_HIGH);
2109
2110	PDMCritSectLeave(&pThis->CritSectIRQ);
2111	}
2112
2113	static int vbvaHandleQueryConf32(PVGASTATE pVGAState, VBVACONF32 RT_UNTRUSTED_VOLATILE_GUEST *pConf32)
2114	{
2115	int rc = VINF_SUCCESS;
2116	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2117	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2118
2119	const uint32_t u32Index = pConf32->u32Index;
2120	ASMCompilerBarrier();
2121
2122	LogFlowFunc(("VBVA_QUERY_CONF32: u32Index %d, u32Value 0x%x\n",
2123	u32Index, pConf32->u32Value));
2124
2125	if (u32Index == VBOX_VBVA_CONF32_MONITOR_COUNT)
2126	{
2127	pConf32->u32Value = pCtx->cViews;
2128	}
2129	else if (u32Index == VBOX_VBVA_CONF32_HOST_HEAP_SIZE)
2130	{
2131	/** @todo a value calculated from the vram size */
2132	pConf32->u32Value = _64K;
2133	}
2134	else if ( u32Index == VBOX_VBVA_CONF32_MODE_HINT_REPORTING
2135	\|\| u32Index == VBOX_VBVA_CONF32_GUEST_CURSOR_REPORTING)
2136	{
2137	pConf32->u32Value = VINF_SUCCESS;
2138	}
2139	else if (u32Index == VBOX_VBVA_CONF32_CURSOR_CAPABILITIES)
2140	{
2141	pConf32->u32Value = pVGAState->fHostCursorCapabilities;
2142	}
2143	else if (u32Index == VBOX_VBVA_CONF32_SCREEN_FLAGS)
2144	{
2145	pConf32->u32Value = VBVA_SCREEN_F_ACTIVE
2146	\| VBVA_SCREEN_F_DISABLED
2147	\| VBVA_SCREEN_F_BLANK
2148	\| VBVA_SCREEN_F_BLANK2;
2149	}
2150	else if (u32Index == VBOX_VBVA_CONF32_MAX_RECORD_SIZE)
2151	{
2152	pConf32->u32Value = VBVA_MAX_RECORD_SIZE;
2153	}
2154	else
2155	{
2156	Log(("Unsupported VBVA_QUERY_CONF32 index %d!!!\n",
2157	u32Index));
2158	rc = VERR_INVALID_PARAMETER;
2159	}
2160
2161	return rc;
2162	}
2163
2164	static int vbvaHandleSetConf32(PVGASTATE pVGAState, VBVACONF32 RT_UNTRUSTED_VOLATILE_GUEST *pConf32)
2165	{
2166	NOREF(pVGAState);
2167
2168	VBVACONF32 parms;
2169	parms.u32Index = pConf32->u32Index;
2170	parms.u32Value = pConf32->u32Value;
2171	ASMCompilerBarrier();
2172
2173	LogFlowFunc(("VBVA_SET_CONF32: u32Index %d, u32Value 0x%x\n",
2174	parms.u32Index, parms.u32Value));
2175
2176	int rc = VINF_SUCCESS;
2177	if (parms.u32Index == VBOX_VBVA_CONF32_MONITOR_COUNT)
2178	{
2179	/* do nothing. this is a const. */
2180	}
2181	else if (parms.u32Index == VBOX_VBVA_CONF32_HOST_HEAP_SIZE)
2182	{
2183	/* do nothing. this is a const. */
2184	}
2185	else
2186	{
2187	Log(("Unsupported VBVA_SET_CONF32 index %d!!!\n",
2188	parms.u32Index));
2189	rc = VERR_INVALID_PARAMETER;
2190	}
2191
2192	return rc;
2193	}
2194
2195	static int vbvaHandleInfoHeap(PVGASTATE pVGAState, const VBVAINFOHEAP RT_UNTRUSTED_VOLATILE_GUEST *pInfoHeap)
2196	{
2197	VBVAINFOHEAP parms;
2198	parms.u32HeapOffset = pInfoHeap->u32HeapOffset;
2199	parms.u32HeapSize = pInfoHeap->u32HeapSize;
2200	ASMCompilerBarrier();
2201	LogFlowFunc(("VBVA_INFO_HEAP: offset 0x%x, size 0x%x\n",
2202	parms.u32HeapOffset, parms.u32HeapSize));
2203
2204	return HGSMIHostHeapSetup(pVGAState->pHGSMI, parms.u32HeapOffset, parms.u32HeapSize);
2205	}
2206
2207	int VBVAInfoView(PVGASTATE pVGAState, const VBVAINFOVIEW RT_UNTRUSTED_VOLATILE_GUEST *pView)
2208	{
2209	VBVAINFOVIEW view;
2210	view.u32ViewIndex = pView->u32ViewIndex;
2211	view.u32ViewOffset = pView->u32ViewOffset;
2212	view.u32ViewSize = pView->u32ViewSize;
2213	view.u32MaxScreenSize = pView->u32MaxScreenSize;
2214	ASMCompilerBarrier();
2215
2216	LogFlowFunc(("VBVA_INFO_VIEW: u32ViewIndex %d, u32ViewOffset 0x%x, u32ViewSize 0x%x, u32MaxScreenSize 0x%x\n",
2217	view.u32ViewIndex, view.u32ViewOffset, view.u32ViewSize, view.u32MaxScreenSize));
2218
2219	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2220	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2221
2222	if ( view.u32ViewIndex < pCtx->cViews
2223	&& view.u32ViewOffset <= pVGAState->vram_size
2224	&& view.u32ViewSize <= pVGAState->vram_size
2225	&& view.u32ViewOffset <= pVGAState->vram_size - view.u32ViewSize
2226	&& view.u32MaxScreenSize <= view.u32ViewSize)
2227	{
2228	pCtx->aViews[view.u32ViewIndex].view = view;
2229	return VINF_SUCCESS;
2230	}
2231
2232	LogRelFlow(("VBVA: InfoView: invalid data! index %d(%d), offset 0x%x, size 0x%x, max 0x%x, vram size 0x%x\n",
2233	view.u32ViewIndex, pCtx->cViews, view.u32ViewOffset, view.u32ViewSize,
2234	view.u32MaxScreenSize, pVGAState->vram_size));
2235	return VERR_INVALID_PARAMETER;
2236	}
2237
2238	int VBVAInfoScreen(PVGASTATE pVGAState, const VBVAINFOSCREEN RT_UNTRUSTED_VOLATILE_GUEST *pScreen)
2239	{
2240	VBVAINFOSCREEN screen;
2241	memcpy(&screen, (void *)pScreen, sizeof(screen));
2242	ASMCompilerBarrier();
2243	LogRel(("VBVA: InfoScreen: [%d] @%d,%d %dx%d, line 0x%x, BPP %d, flags 0x%x\n",
2244	screen.u32ViewIndex, screen.i32OriginX, screen.i32OriginY,
2245	screen.u32Width, screen.u32Height,
2246	screen.u32LineSize, screen.u16BitsPerPixel, screen.u16Flags));
2247
2248	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2249	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2250
2251	/* Allow screen.u16BitsPerPixel == 0 because legacy guest code used it for screen blanking. */
2252	if ( screen.u32ViewIndex < pCtx->cViews
2253	&& screen.u16BitsPerPixel <= 32
2254	&& screen.u32Width <= UINT16_MAX
2255	&& screen.u32Height <= UINT16_MAX
2256	&& screen.u32LineSize <= UINT16_MAX * 4)
2257	{
2258	const VBVAINFOVIEW *pView = &pCtx->aViews[screen.u32ViewIndex].view;
2259	const uint32_t u32BytesPerPixel = (screen.u16BitsPerPixel + 7) / 8;
2260	if (screen.u32Width <= screen.u32LineSize / (u32BytesPerPixel? u32BytesPerPixel: 1))
2261	{
2262	const uint64_t u64ScreenSize = (uint64_t)screen.u32LineSize * screen.u32Height;
2263	if ( screen.u32StartOffset <= pView->u32ViewSize
2264	&& u64ScreenSize <= pView->u32MaxScreenSize
2265	&& screen.u32StartOffset <= pView->u32ViewSize - (uint32_t)u64ScreenSize)
2266	{
2267	vbvaResize(pVGAState, &pCtx->aViews[screen.u32ViewIndex], &screen, true);
2268	return VINF_SUCCESS;
2269	}
2270
2271	LogRelFlow(("VBVA: InfoScreen: invalid data! size %#RX64, max %#RX32\n",
2272	u64ScreenSize, pView->u32MaxScreenSize));
2273	}
2274	}
2275	else
2276	LogRelFlow(("VBVA: InfoScreen: invalid data! index %RU32(%RU32)\n", screen.u32ViewIndex, pCtx->cViews));
2277
2278	return VERR_INVALID_PARAMETER;
2279	}
2280
2281	int VBVAGetInfoViewAndScreen(PVGASTATE pVGAState, uint32_t u32ViewIndex, VBVAINFOVIEW pView, VBVAINFOSCREEN pScreen)
2282	{
2283	if (u32ViewIndex >= pVGAState->cMonitors)
2284	return VERR_INVALID_PARAMETER;
2285
2286	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2287	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pIns);
2288
2289	if (pView)
2290	*pView = pCtx->aViews[u32ViewIndex].view;
2291
2292	if (pScreen)
2293	*pScreen = pCtx->aViews[u32ViewIndex].screen;
2294
2295	return VINF_SUCCESS;
2296	}
2297
2298	static int vbvaHandleEnable(PVGASTATE pVGAState, VBVAENABLE const volatile *pVbvaEnable, uint32_t u32ScreenId)
2299	{
2300	int rc = VINF_SUCCESS;
2301	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2302	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2303
2304	if (u32ScreenId > pCtx->cViews)
2305	return VERR_INVALID_PARAMETER;
2306
2307	uint32_t fEnableFlags = pVbvaEnable->u32Flags;
2308	uint32_t offEnable = pVbvaEnable->u32Offset;
2309	ASMCompilerBarrier();
2310
2311	LogFlowFunc(("VBVA_ENABLE[%d]: u32Flags 0x%x u32Offset %#x\n", u32ScreenId, fEnableFlags, offEnable));
2312
2313	if ((fEnableFlags & (VBVA_F_ENABLE \| VBVA_F_DISABLE)) == VBVA_F_ENABLE)
2314	{
2315	if (offEnable < pVGAState->vram_size)
2316	{
2317	/* Guest reported offset either absolute or relative to view. */
2318	if (fEnableFlags & VBVA_F_ABSOFFSET)
2319	{
2320	/* Offset from VRAM start. */
2321	if ( pVGAState->vram_size < RT_UOFFSETOF(VBVABUFFER, au8Data)
2322	\|\| offEnable > pVGAState->vram_size - RT_UOFFSETOF(VBVABUFFER, au8Data))
2323	{
2324	rc = VERR_INVALID_PARAMETER;
2325	}
2326	}
2327	else
2328	{
2329	/* Offset from the view start. */
2330	const VBVAINFOVIEW *pView = &pCtx->aViews[u32ScreenId].view;
2331	if ( pVGAState->vram_size - offEnable < pView->u32ViewOffset
2332	\|\| pView->u32ViewSize < RT_UOFFSETOF(VBVABUFFER, au8Data)
2333	\|\| offEnable > pView->u32ViewSize - RT_UOFFSETOF(VBVABUFFER, au8Data))
2334	{
2335	rc = VERR_INVALID_PARAMETER;
2336	}
2337	else
2338	{
2339	offEnable += pView->u32ViewOffset;
2340	}
2341	}
2342	}
2343	else
2344	{
2345	rc = VERR_INVALID_PARAMETER;
2346	}
2347
2348	if (RT_SUCCESS(rc))
2349	{
2350	VBVABUFFER pVBVA = (VBVABUFFER )HGSMIOffsetToPointerHost(pIns, offEnable);
2351	if (pVBVA)
2352	{
2353	/* Process any pending orders and empty the VBVA ring buffer. */
2354	vbvaFlush(pVGAState, pCtx);
2355
2356	rc = vbvaEnable(u32ScreenId, pVGAState, pCtx, pVBVA, offEnable, false /* fRestored */);
2357	}
2358	else
2359	{
2360	Log(("Invalid VBVABUFFER offset 0x%x!!!\n", offEnable));
2361	rc = VERR_INVALID_PARAMETER;
2362	}
2363	}
2364
2365	if (RT_FAILURE(rc))
2366	LogRelMax(8, ("VBVA: can not enable: %Rrc\n", rc));
2367	}
2368	else if ((fEnableFlags & (VBVA_F_ENABLE \| VBVA_F_DISABLE)) == VBVA_F_DISABLE)
2369	{
2370	rc = vbvaDisable(u32ScreenId, pVGAState, pCtx);
2371	}
2372	else
2373	{
2374	Log(("Invalid VBVA_ENABLE flags 0x%x!!!\n", fEnableFlags));
2375	rc = VERR_INVALID_PARAMETER;
2376	}
2377
2378	return rc;
2379	}
2380
2381	static int vbvaHandleQueryModeHints(PVGASTATE pVGAState, VBVAQUERYMODEHINTS volatile *pQueryModeHints, HGSMISIZE cbBuffer)
2382	{
2383	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2384	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2385
2386	uint16_t const cHintsQueried = pQueryModeHints->cHintsQueried;
2387	uint16_t const cbHintStructureGuest = pQueryModeHints->cbHintStructureGuest;
2388	ASMCompilerBarrier();
2389
2390	LogRelFlowFunc(("VBVA: HandleQueryModeHints: cHintsQueried=%RU16, cbHintStructureGuest=%RU16\n",
2391	cHintsQueried, cbHintStructureGuest));
2392	if (cbBuffer < sizeof(VBVAQUERYMODEHINTS) + (uint32_t)cHintsQueried * cbHintStructureGuest)
2393	return VERR_INVALID_PARAMETER;
2394
2395	uint8_t pbHint = (uint8_t )(pQueryModeHints + 1);
2396	memset(pbHint, ~0, cbBuffer - sizeof(VBVAQUERYMODEHINTS));
2397
2398	for (unsigned iHint = 0; iHint < cHintsQueried && iHint < VBOX_VIDEO_MAX_SCREENS; ++iHint)
2399	{
2400	memcpy(pbHint, &pCtx->aModeHints[iHint], RT_MIN(cbHintStructureGuest, sizeof(VBVAMODEHINT)));
2401	pbHint += cbHintStructureGuest;
2402	Assert((uintptr_t)(pbHint - (uint8_t *)pQueryModeHints) <= cbBuffer);
2403	}
2404
2405	return VINF_SUCCESS;
2406	}
2407
2408	/*
2409	*
2410	* New VBVA uses a new interface id: #define VBE_DISPI_ID_VBOX_VIDEO 0xBE01
2411	*
2412	* VBVA uses two 32 bits IO ports to write VRAM offsets of shared memory blocks for commands.
2413	* Read Write
2414	* Host port 0x3b0 to process completed
2415	* Guest port 0x3d0 control value? to process
2416	*
2417	*/
2418
2419	static DECLCALLBACK(void) vbvaNotifyGuest (void *pvCallback)
2420	{
2421	#if defined(VBOX_WITH_HGSMI) && (defined(VBOX_WITH_VIDEOHWACCEL) \|\| defined(VBOX_WITH_VDMA) \|\| defined(VBOX_WITH_WDDM))
2422	PVGASTATE pVGAState = (PVGASTATE)pvCallback;
2423	VBVARaiseIrq (pVGAState, 0);
2424	#else
2425	NOREF(pvCallback);
2426	/* Do nothing. Later the VMMDev/VGA IRQ can be used for the notification. */
2427	#endif
2428	}
2429
2430	/**
2431	* The guest submitted a command buffer (hit VGA_PORT_HGSMI_GUEST).
2432	*
2433	* Verify the buffer size and invoke corresponding handler.
2434	*
2435	* @return VBox status code.
2436	* @param pvHandler The VBVA channel context.
2437	* @param u16ChannelInfo Command code.
2438	* @param pvBuffer HGSMI buffer with command data. Considered volatile!
2439	* @param cbBuffer Size of command data.
2440	*
2441	* @thread EMT
2442	*/
2443	static DECLCALLBACK(int) vbvaChannelHandler(void *pvHandler, uint16_t u16ChannelInfo,
2444	void RT_UNTRUSTED_VOLATILE_GUEST *pvBuffer, HGSMISIZE cbBuffer)
2445	{
2446	int rc = VINF_SUCCESS;
2447
2448	LogFlowFunc(("pvHandler %p, u16ChannelInfo %d, pvBuffer %p, cbBuffer %u\n", pvHandler, u16ChannelInfo, pvBuffer, cbBuffer));
2449
2450	PVGASTATE pVGAState = (PVGASTATE)pvHandler;
2451	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2452	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2453
2454	switch (u16ChannelInfo)
2455	{
2456	#ifdef VBOX_WITH_CRHGSMI
2457	case VBVA_CMDVBVA_SUBMIT:
2458	rc = vboxCmdVBVACmdSubmit(pVGAState);
2459	break;
2460
2461	case VBVA_CMDVBVA_FLUSH:
2462	rc = vboxCmdVBVACmdFlush(pVGAState);
2463	break;
2464
2465	case VBVA_CMDVBVA_CTL:
2466	if (cbBuffer >= VBoxSHGSMIBufferHeaderSize() + sizeof(VBOXCMDVBVA_CTL))
2467	{
2468	VBOXCMDVBVA_CTL RT_UNTRUSTED_VOLATILE_GUEST *pCtl;
2469	pCtl = (VBOXCMDVBVA_CTL RT_UNTRUSTED_VOLATILE_GUEST )VBoxSHGSMIBufferData((VBOXSHGSMIHEADER RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer);
2470	rc = vboxCmdVBVACmdCtl(pVGAState, pCtl, cbBuffer - VBoxSHGSMIBufferHeaderSize());
2471	}
2472	else
2473	rc = VERR_INVALID_PARAMETER;
2474	break;
2475	#endif /* VBOX_WITH_CRHGSMI */
2476
2477	#ifdef VBOX_WITH_VDMA
2478	case VBVA_VDMA_CMD:
2479	if (cbBuffer >= VBoxSHGSMIBufferHeaderSize() + sizeof(VBOXVDMACBUF_DR))
2480	{
2481	VBOXVDMACBUF_DR RT_UNTRUSTED_VOLATILE_GUEST *pCmd;
2482	pCmd = (VBOXVDMACBUF_DR RT_UNTRUSTED_VOLATILE_GUEST )VBoxSHGSMIBufferData((VBOXSHGSMIHEADER RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer);
2483	vboxVDMACommand(pVGAState->pVdma, pCmd, cbBuffer - VBoxSHGSMIBufferHeaderSize());
2484	rc = VINF_SUCCESS;
2485	}
2486	else
2487	rc = VERR_INVALID_PARAMETER;
2488	break;
2489
2490	case VBVA_VDMA_CTL:
2491	if (cbBuffer >= VBoxSHGSMIBufferHeaderSize() + sizeof(VBOXVDMA_CTL))
2492	{
2493	VBOXVDMA_CTL RT_UNTRUSTED_VOLATILE_GUEST *pCmd;
2494	pCmd = (VBOXVDMA_CTL RT_UNTRUSTED_VOLATILE_GUEST )VBoxSHGSMIBufferData((VBOXSHGSMIHEADER RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer);
2495	vboxVDMAControl(pVGAState->pVdma, pCmd, cbBuffer - VBoxSHGSMIBufferHeaderSize());
2496	}
2497	else
2498	rc = VERR_INVALID_PARAMETER;
2499	break;
2500	#endif /* VBOX_WITH_VDMA */
2501
2502	case VBVA_QUERY_CONF32:
2503	if (cbBuffer >= sizeof(VBVACONF32))
2504	rc = vbvaHandleQueryConf32(pVGAState, (VBVACONF32 RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer);
2505	else
2506	rc = VERR_INVALID_PARAMETER;
2507	break;
2508
2509	case VBVA_SET_CONF32:
2510	if (cbBuffer >= sizeof(VBVACONF32))
2511	rc = vbvaHandleSetConf32(pVGAState, (VBVACONF32 RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer);
2512	else
2513	rc = VERR_INVALID_PARAMETER;
2514	break;
2515
2516	case VBVA_INFO_VIEW:
2517	/* Expect at least one VBVAINFOVIEW structure. */
2518	rc = VERR_INVALID_PARAMETER;
2519	if (cbBuffer >= sizeof(VBVAINFOVIEW))
2520	{
2521	#ifdef VBOX_WITH_CRHGSMI
2522	AssertMsgBreak(!vboxCmdVBVAIsEnabled(pVGAState), ("VBVA_INFO_VIEW is not acceptible for CmdVbva\n"));
2523	#endif
2524	/* Guest submits an array of VBVAINFOVIEW structures. */
2525	const VBVAINFOVIEW RT_UNTRUSTED_VOLATILE_GUEST pView = (VBVAINFOVIEW RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer;
2526	for (;
2527	cbBuffer >= sizeof(VBVAINFOVIEW);
2528	++pView, cbBuffer -= sizeof(VBVAINFOVIEW))
2529	{
2530	rc = VBVAInfoView(pVGAState, pView);
2531	if (RT_FAILURE(rc))
2532	break;
2533	}
2534	}
2535	break;
2536
2537	case VBVA_INFO_HEAP:
2538	if (cbBuffer >= sizeof(VBVAINFOHEAP))
2539	rc = vbvaHandleInfoHeap(pVGAState, (VBVAINFOHEAP RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer);
2540	else
2541	rc = VERR_INVALID_PARAMETER;
2542	break;
2543
2544	case VBVA_FLUSH:
2545	if (cbBuffer >= sizeof(VBVAFLUSH))
2546	rc = vbvaFlush(pVGAState, pCtx);
2547	else
2548	rc = VERR_INVALID_PARAMETER;
2549	break;
2550
2551	case VBVA_INFO_SCREEN:
2552	rc = VERR_INVALID_PARAMETER;
2553	#ifdef VBOX_WITH_CRHGSMI
2554	AssertMsgBreak(!vboxCmdVBVAIsEnabled(pVGAState), ("VBVA_INFO_SCREEN is not acceptible for CmdVbva\n"));
2555	#endif
2556	if (cbBuffer >= sizeof(VBVAINFOSCREEN))
2557	rc = VBVAInfoScreen(pVGAState, (VBVAINFOSCREEN RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer);
2558	break;
2559
2560	case VBVA_ENABLE:
2561	rc = VERR_INVALID_PARAMETER;
2562	#ifdef VBOX_WITH_CRHGSMI
2563	AssertMsgBreak(!vboxCmdVBVAIsEnabled(pVGAState), ("VBVA_ENABLE is not acceptible for CmdVbva\n"));
2564	#endif /* VBOX_WITH_CRHGSMI */
2565	if (cbBuffer >= sizeof(VBVAENABLE))
2566	{
2567	VBVAENABLE RT_UNTRUSTED_VOLATILE_GUEST pVbvaEnable = (VBVAENABLE RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer;
2568
2569	uint32_t u32ScreenId;
2570	const uint32_t u32Flags = pVbvaEnable->u32Flags;
2571	if (u32Flags & VBVA_F_EXTENDED)
2572	{
2573	if (cbBuffer >= sizeof(VBVAENABLE_EX))
2574	u32ScreenId = ((VBVAENABLE_EX RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer)->u32ScreenId;
2575	else
2576	{
2577	rc = VERR_INVALID_PARAMETER;
2578	break;
2579	}
2580	}
2581	else
2582	u32ScreenId = vbvaViewFromBufferPtr(pIns, pCtx, pvBuffer);
2583
2584	rc = vbvaHandleEnable(pVGAState, pVbvaEnable, u32ScreenId);
2585	pVbvaEnable->i32Result = rc;
2586	}
2587	break;
2588
2589	case VBVA_MOUSE_POINTER_SHAPE:
2590	if (cbBuffer >= sizeof(VBVAMOUSEPOINTERSHAPE))
2591	{
2592	VBVAMOUSEPOINTERSHAPE RT_UNTRUSTED_VOLATILE_GUEST *pShape;
2593	pShape = (VBVAMOUSEPOINTERSHAPE RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer;
2594	rc = vbvaMousePointerShape(pVGAState, pCtx, pShape, cbBuffer);
2595	pShape->i32Result = rc;
2596	}
2597	else
2598	rc = VERR_INVALID_PARAMETER;
2599	break;
2600
2601
2602	#ifdef VBOX_WITH_VIDEOHWACCEL
2603	case VBVA_VHWA_CMD:
2604	if (cbBuffer >= VBOXVHWACMD_HEADSIZE())
2605	{
2606	vbvaVHWAHandleCommand(pVGAState, (VBOXVHWACMD RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer);
2607	rc = VINF_SUCCESS;
2608	}
2609	else
2610	rc = VERR_INVALID_PARAMETER;
2611	break;
2612	#endif
2613
2614	#ifdef VBOX_WITH_WDDM
2615	case VBVA_INFO_CAPS:
2616	if (cbBuffer >= sizeof(VBVACAPS))
2617	{
2618	VBVACAPS RT_UNTRUSTED_VOLATILE_GUEST pCaps = (VBVACAPS RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer;
2619	pVGAState->fGuestCaps = pCaps->fCaps;
2620	pVGAState->pDrv->pfnVBVAGuestCapabilityUpdate(pVGAState->pDrv, pVGAState->fGuestCaps);
2621	pCaps->rc = rc = VINF_SUCCESS;
2622	}
2623	else
2624	rc = VERR_INVALID_PARAMETER;
2625	break;
2626	#endif
2627
2628	case VBVA_SCANLINE_CFG:
2629	if (cbBuffer >= sizeof(VBVASCANLINECFG))
2630	{
2631	VBVASCANLINECFG RT_UNTRUSTED_VOLATILE_GUEST pCfg = (VBVASCANLINECFG RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer;
2632	pVGAState->fScanLineCfg = pCfg->fFlags;
2633	pCfg->rc = rc = VINF_SUCCESS;
2634	}
2635	else
2636	rc = VERR_INVALID_PARAMETER;
2637	break;
2638
2639	case VBVA_QUERY_MODE_HINTS:
2640	if (cbBuffer >= sizeof(VBVAQUERYMODEHINTS))
2641	{
2642	VBVAQUERYMODEHINTS RT_UNTRUSTED_VOLATILE_GUEST *pQueryModeHints;
2643	pQueryModeHints = (VBVAQUERYMODEHINTS RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer;
2644	rc = vbvaHandleQueryModeHints(pVGAState, pQueryModeHints, cbBuffer);
2645	pQueryModeHints->rc = rc;
2646	}
2647	else
2648	rc = VERR_INVALID_PARAMETER;
2649	break;
2650
2651	case VBVA_REPORT_INPUT_MAPPING:
2652	if (cbBuffer >= sizeof(VBVAREPORTINPUTMAPPING))
2653	{
2654	VBVAREPORTINPUTMAPPING inputMapping;
2655	{
2656	VBVAREPORTINPUTMAPPING RT_UNTRUSTED_VOLATILE_GUEST *pInputMapping
2657	= (VBVAREPORTINPUTMAPPING RT_UNTRUSTED_VOLATILE_GUEST *)pvBuffer;
2658	inputMapping.x = pInputMapping->x;
2659	inputMapping.y = pInputMapping->y;
2660	inputMapping.cx = pInputMapping->cx;
2661	inputMapping.cy = pInputMapping->cy;
2662	}
2663	ASMCompilerBarrier();
2664
2665	LogRelFlowFunc(("VBVA: ChannelHandler: VBVA_REPORT_INPUT_MAPPING: x=%RI32, y=%RI32, cx=%RU32, cy=%RU32\n",
2666	inputMapping.x, inputMapping.y, inputMapping.cx, inputMapping.cy));
2667	pVGAState->pDrv->pfnVBVAInputMappingUpdate(pVGAState->pDrv,
2668	inputMapping.x, inputMapping.y,
2669	inputMapping.cx, inputMapping.cy);
2670	rc = VINF_SUCCESS;
2671	}
2672	else
2673	rc = VERR_INVALID_PARAMETER;
2674	break;
2675
2676	case VBVA_CURSOR_POSITION:
2677	if (cbBuffer >= sizeof(VBVACURSORPOSITION))
2678	{
2679	VBVACURSORPOSITION RT_UNTRUSTED_VOLATILE_GUEST pReport = (VBVACURSORPOSITION RT_UNTRUSTED_VOLATILE_GUEST )pvBuffer;
2680	VBVACURSORPOSITION Report;
2681	Report.fReportPosition = pReport->fReportPosition;
2682	Report.x = pReport->x;
2683	Report.y = pReport->y;
2684	ASMCompilerBarrier();
2685
2686	LogRelFlowFunc(("VBVA: ChannelHandler: VBVA_CURSOR_POSITION: fReportPosition=%RTbool, x=%RU32, y=%RU32\n",
2687	RT_BOOL(Report.fReportPosition), Report.x, Report.y));
2688
2689	pVGAState->pDrv->pfnVBVAReportCursorPosition(pVGAState->pDrv, RT_BOOL(Report.fReportPosition), Report.x, Report.y);
2690	pReport->x = pCtx->xCursor;
2691	pReport->y = pCtx->yCursor;
2692	rc = VINF_SUCCESS;
2693	}
2694	else
2695	rc = VERR_INVALID_PARAMETER;
2696	break;
2697
2698	default:
2699	Log(("Unsupported VBVA guest command %d (%#x)!!!\n", u16ChannelInfo, u16ChannelInfo));
2700	break;
2701	}
2702
2703	return rc;
2704	}
2705
2706	/* When VBVA is paused, then VGA device is allowed to work but
2707	* no HGSMI etc state is changed.
2708	*/
2709	void VBVAPause(PVGASTATE pVGAState, bool fPause)
2710	{
2711	if (!pVGAState \|\| !pVGAState->pHGSMI)
2712	{
2713	return;
2714	}
2715
2716	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pVGAState->pHGSMI);
2717
2718	if (pCtx)
2719	{
2720	pCtx->fPaused = fPause;
2721	}
2722	}
2723
2724	bool VBVAIsPaused(PVGASTATE pVGAState)
2725	{
2726	if (pVGAState && pVGAState->pHGSMI)
2727	{
2728	const VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pVGAState->pHGSMI);
2729	if (pCtx && pCtx->cViews)
2730	{
2731	/* If VBVA is enabled at all. */
2732	const VBVAVIEW *pView = &pCtx->aViews[0];
2733	if (pView->vbva.guest.pVBVA)
2734	return pCtx->fPaused;
2735	}
2736	}
2737	/* VBVA is disabled. */
2738	return true;
2739	}
2740
2741	void VBVAOnVBEChanged(PVGASTATE pVGAState)
2742	{
2743	/* The guest does not depend on host handling the VBE registers. */
2744	if (pVGAState->fGuestCaps & VBVACAPS_USE_VBVA_ONLY)
2745	{
2746	return;
2747	}
2748
2749	VBVAPause(pVGAState, (pVGAState->vbe_regs[VBE_DISPI_INDEX_ENABLE] & VBE_DISPI_ENABLED) == 0);
2750	}
2751
2752	void VBVAReset (PVGASTATE pVGAState)
2753	{
2754	if (!pVGAState \|\| !pVGAState->pHGSMI)
2755	{
2756	return;
2757	}
2758
2759	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pVGAState->pHGSMI);
2760
2761	#ifdef VBOX_WITH_VIDEOHWACCEL
2762	vbvaVHWAReset (pVGAState);
2763	#endif
2764
2765	HGSMIReset(pVGAState->pHGSMI);
2766	/* Make sure the IRQ is reset. */
2767	PDMDevHlpPCISetIrq(pVGAState->pDevInsR3, 0, PDM_IRQ_LEVEL_LOW);
2768	pVGAState->fu32PendingGuestFlags = 0;
2769
2770	if (pCtx)
2771	{
2772	vbvaFlush (pVGAState, pCtx);
2773
2774	unsigned uScreenId;
2775
2776	for (uScreenId = 0; uScreenId < pCtx->cViews; uScreenId++)
2777	{
2778	vbvaDisable (uScreenId, pVGAState, pCtx);
2779	}
2780
2781	pCtx->mouseShapeInfo.fSet = false;
2782	RTMemFree(pCtx->mouseShapeInfo.pu8Shape);
2783	pCtx->mouseShapeInfo.pu8Shape = NULL;
2784	pCtx->mouseShapeInfo.cbAllocated = 0;
2785	pCtx->mouseShapeInfo.cbShape = 0;
2786	}
2787
2788	}
2789
2790	int VBVAUpdateDisplay (PVGASTATE pVGAState)
2791	{
2792	int rc = VERR_NOT_SUPPORTED; /* Assuming that the VGA device will have to do updates. */
2793
2794	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pVGAState->pHGSMI);
2795
2796	if (pCtx)
2797	{
2798	if (!pCtx->fPaused)
2799	{
2800	rc = vbvaFlush (pVGAState, pCtx);
2801
2802	if (RT_SUCCESS (rc))
2803	{
2804	if (!pCtx->aViews[0].vbva.guest.pVBVA)
2805	{
2806	/* VBVA is not enabled for the first view, so VGA device must do updates. */
2807	rc = VERR_NOT_SUPPORTED;
2808	}
2809	}
2810	}
2811	}
2812
2813	return rc;
2814	}
2815
2816	static int vbvaSendModeHintWorker(PVGASTATE pThis, uint32_t cx, uint32_t cy,
2817	uint32_t cBPP, uint32_t iDisplay, uint32_t dx,
2818	uint32_t dy, uint32_t fEnabled,
2819	uint32_t fNotifyGuest)
2820	{
2821	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pThis->pHGSMI);
2822	/** @note See Display::setVideoModeHint: "It is up to the guest to decide
2823	* whether the hint is valid. Therefore don't do any VRAM sanity checks
2824	* here! */
2825	if (iDisplay >= RT_MIN(pThis->cMonitors, RT_ELEMENTS(pCtx->aModeHints)))
2826	return VERR_OUT_OF_RANGE;
2827	pCtx->aModeHints[iDisplay].magic = VBVAMODEHINT_MAGIC;
2828	pCtx->aModeHints[iDisplay].cx = cx;
2829	pCtx->aModeHints[iDisplay].cy = cy;
2830	pCtx->aModeHints[iDisplay].cBPP = cBPP;
2831	pCtx->aModeHints[iDisplay].dx = dx;
2832	pCtx->aModeHints[iDisplay].dy = dy;
2833	pCtx->aModeHints[iDisplay].fEnabled = fEnabled;
2834	if (fNotifyGuest && pThis->fGuestCaps & VBVACAPS_IRQ && pThis->fGuestCaps & VBVACAPS_VIDEO_MODE_HINTS)
2835	VBVARaiseIrq(pThis, HGSMIHOSTFLAGS_HOTPLUG);
2836	return VINF_SUCCESS;
2837	}
2838
2839	/** Converts a display port interface pointer to a vga state pointer. */
2840	#define IDISPLAYPORT_2_VGASTATE(pInterface) ( (PVGASTATE)((uintptr_t)pInterface - RT_OFFSETOF(VGASTATE, IPort)) )
2841
2842	DECLCALLBACK(int) vbvaPortSendModeHint(PPDMIDISPLAYPORT pInterface, uint32_t cx,
2843	uint32_t cy, uint32_t cBPP,
2844	uint32_t iDisplay, uint32_t dx,
2845	uint32_t dy, uint32_t fEnabled,
2846	uint32_t fNotifyGuest)
2847	{
2848	PVGASTATE pThis;
2849	int rc;
2850
2851	pThis = IDISPLAYPORT_2_VGASTATE(pInterface);
2852	rc = PDMCritSectEnter(&pThis->CritSect, VERR_SEM_BUSY);
2853	AssertRC(rc);
2854	rc = vbvaSendModeHintWorker(pThis, cx, cy, cBPP, iDisplay, dx, dy, fEnabled,
2855	fNotifyGuest);
2856	PDMCritSectLeave(&pThis->CritSect);
2857	return rc;
2858	}
2859
2860	DECLCALLBACK(void) vbvaPortReportHostCursorCapabilities(PPDMIDISPLAYPORT pInterface, uint32_t fCapabilitiesAdded,
2861	uint32_t fCapabilitiesRemoved)
2862	{
2863	PVGASTATE pThis = IDISPLAYPORT_2_VGASTATE(pInterface);
2864	int rc = PDMCritSectEnter(&pThis->CritSect, VERR_SEM_BUSY);
2865	AssertRC(rc);
2866	pThis->fHostCursorCapabilities \|= fCapabilitiesAdded;
2867	pThis->fHostCursorCapabilities &= ~fCapabilitiesRemoved;
2868	if (pThis->fGuestCaps & VBVACAPS_IRQ && pThis->fGuestCaps & VBVACAPS_DISABLE_CURSOR_INTEGRATION)
2869	VBVARaiseIrq(pThis, HGSMIHOSTFLAGS_CURSOR_CAPABILITIES);
2870	PDMCritSectLeave(&pThis->CritSect);
2871	}
2872
2873	DECLCALLBACK(void) vbvaPortReportHostCursorPosition(PPDMIDISPLAYPORT pInterface, uint32_t x, uint32_t y)
2874	{
2875	PVGASTATE pThis = IDISPLAYPORT_2_VGASTATE(pInterface);
2876	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pThis->pHGSMI);
2877	int rc = PDMCritSectEnter(&pThis->CritSect, VERR_SEM_BUSY);
2878	AssertRC(rc);
2879	pCtx->xCursor = x;
2880	pCtx->yCursor = y;
2881	PDMCritSectLeave(&pThis->CritSect);
2882	}
2883
2884	int VBVAInit(PVGASTATE pVGAState)
2885	{
2886	PPDMDEVINS pDevIns = pVGAState->pDevInsR3;
2887
2888	PVM pVM = PDMDevHlpGetVM(pDevIns);
2889
2890	int rc = HGSMICreate(&pVGAState->pHGSMI,
2891	pVM,
2892	"VBVA",
2893	0,
2894	pVGAState->vram_ptrR3,
2895	pVGAState->vram_size,
2896	vbvaNotifyGuest,
2897	pVGAState,
2898	sizeof(VBVACONTEXT));
2899	if (RT_SUCCESS(rc))
2900	{
2901	rc = HGSMIHostChannelRegister(pVGAState->pHGSMI,
2902	HGSMI_CH_VBVA,
2903	vbvaChannelHandler,
2904	pVGAState);
2905	if (RT_SUCCESS(rc))
2906	{
2907	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pVGAState->pHGSMI);
2908	pCtx->cViews = pVGAState->cMonitors;
2909	pCtx->fPaused = true;
2910	memset(pCtx->aModeHints, ~0, sizeof(pCtx->aModeHints));
2911	pVGAState->fHostCursorCapabilities = 0;
2912	}
2913	}
2914
2915	return rc;
2916
2917	}
2918
2919	void VBVADestroy(PVGASTATE pVGAState)
2920	{
2921	PHGSMIINSTANCE pHgsmi = pVGAState->pHGSMI;
2922	if (pHgsmi)
2923	{
2924	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pHgsmi);
2925	pCtx->mouseShapeInfo.fSet = false;
2926	RTMemFree(pCtx->mouseShapeInfo.pu8Shape);
2927	pCtx->mouseShapeInfo.pu8Shape = NULL;
2928	pCtx->mouseShapeInfo.cbAllocated = 0;
2929	pCtx->mouseShapeInfo.cbShape = 0;
2930
2931	HGSMIDestroy(pHgsmi);
2932	pVGAState->pHGSMI = NULL;
2933	}
2934	}
2935

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

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

Download in other formats: