DevVGA_VBVA.cpp@ 67355

Last change on this file since 67355 was 65846, checked in by vboxsync, 8 years ago
use symbolic constant for _64K
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 97.0 KB

Line
1	/* $Id: DevVGA_VBVA.cpp 65846 2017-02-23 08:41:59Z vboxsync $ */
2	/** @file
3	* VirtualBox Video Acceleration (VBVA).
4	*/
5
6	/*
7	* Copyright (C) 2006-2016 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, const VBVAMOUSEPOINTERSHAPE pShape, HGSMISIZE cbShape)
729	{
730	const VBVAMOUSEPOINTERSHAPE parms = *pShape;
731
732	LogFlowFunc(("VBVA_MOUSE_POINTER_SHAPE: i32Result 0x%x, fu32Flags 0x%x, hot spot %d,%d, size %dx%d\n",
733	parms.i32Result,
734	parms.fu32Flags,
735	parms.u32HotX,
736	parms.u32HotY,
737	parms.u32Width,
738	parms.u32Height));
739
740	const bool fVisible = RT_BOOL(parms.fu32Flags & VBOX_MOUSE_POINTER_VISIBLE);
741	const bool fAlpha = RT_BOOL(parms.fu32Flags & VBOX_MOUSE_POINTER_ALPHA);
742	const bool fShape = RT_BOOL(parms.fu32Flags & VBOX_MOUSE_POINTER_SHAPE);
743
744	HGSMISIZE cbPointerData = 0;
745
746	if (fShape)
747	{
748	if (parms.u32Width > 8192 \|\| parms.u32Height > 8192)
749	{
750	Log(("vbvaMousePointerShape: unsupported size %ux%u\n",
751	parms.u32Width, parms.u32Height));
752	return VERR_INVALID_PARAMETER;
753	}
754
755	cbPointerData = ((((parms.u32Width + 7) / 8) * parms.u32Height + 3) & ~3)
756	+ parms.u32Width * 4 * parms.u32Height;
757	}
758
759	if (cbPointerData > cbShape - RT_UOFFSETOF(VBVAMOUSEPOINTERSHAPE, au8Data))
760	{
761	Log(("vbvaMousePointerShape: calculated pointer data size is too big (%d bytes, limit %d)\n",
762	cbPointerData, cbShape - RT_UOFFSETOF(VBVAMOUSEPOINTERSHAPE, au8Data)));
763	return VERR_INVALID_PARAMETER;
764	}
765
766	/* Save mouse info it will be used to restore mouse pointer after restoring saved state. */
767	pCtx->mouseShapeInfo.fSet = true;
768	pCtx->mouseShapeInfo.fVisible = fVisible;
769	if (fShape)
770	{
771	/* Data related to shape. */
772	pCtx->mouseShapeInfo.u32HotX = parms.u32HotX;
773	pCtx->mouseShapeInfo.u32HotY = parms.u32HotY;
774	pCtx->mouseShapeInfo.u32Width = parms.u32Width;
775	pCtx->mouseShapeInfo.u32Height = parms.u32Height;
776	pCtx->mouseShapeInfo.fAlpha = fAlpha;
777
778	/* Reallocate memory buffer if necessary. */
779	if (cbPointerData > pCtx->mouseShapeInfo.cbAllocated)
780	{
781	RTMemFree (pCtx->mouseShapeInfo.pu8Shape);
782	pCtx->mouseShapeInfo.pu8Shape = NULL;
783	pCtx->mouseShapeInfo.cbShape = 0;
784
785	uint8_t pu8Shape = (uint8_t )RTMemAlloc (cbPointerData);
786	if (pu8Shape)
787	{
788	pCtx->mouseShapeInfo.pu8Shape = pu8Shape;
789	pCtx->mouseShapeInfo.cbAllocated = cbPointerData;
790	}
791	}
792
793	/* Copy shape bitmaps. */
794	if (pCtx->mouseShapeInfo.pu8Shape)
795	{
796	memcpy(pCtx->mouseShapeInfo.pu8Shape, &pShape->au8Data[0], cbPointerData);
797	pCtx->mouseShapeInfo.cbShape = cbPointerData;
798	}
799	}
800
801	int rc = vbvaUpdateMousePointerShape(pVGAState, &pCtx->mouseShapeInfo, fShape);
802
803	return rc;
804	}
805
806	static uint32_t vbvaViewFromBufferPtr(PHGSMIINSTANCE pIns, const VBVACONTEXT pCtx, const void pvBuffer)
807	{
808	/* Check which view contains the buffer. */
809	HGSMIOFFSET offBuffer = HGSMIPointerToOffsetHost(pIns, pvBuffer);
810
811	if (offBuffer != HGSMIOFFSET_VOID)
812	{
813	unsigned uScreenId;
814	for (uScreenId = 0; uScreenId < pCtx->cViews; uScreenId++)
815	{
816	const VBVAINFOVIEW *pView = &pCtx->aViews[uScreenId].view;
817
818	if ( pView->u32ViewSize > 0
819	&& pView->u32ViewOffset <= offBuffer
820	&& offBuffer <= pView->u32ViewOffset + pView->u32ViewSize - 1)
821	{
822	return pView->u32ViewIndex;
823	}
824	}
825	}
826
827	return UINT32_MAX;
828	}
829
830	#ifdef DEBUG_sunlover
831	static void dumpctx(const VBVACONTEXT *pCtx)
832	{
833	Log(("VBVACONTEXT dump: cViews %d\n", pCtx->cViews));
834
835	uint32_t iView;
836	for (iView = 0; iView < pCtx->cViews; iView++)
837	{
838	const VBVAVIEW *pView = &pCtx->aViews[iView];
839
840	Log((" view %d o 0x%x s 0x%x m 0x%x\n",
841	pView->view.u32ViewIndex,
842	pView->view.u32ViewOffset,
843	pView->view.u32ViewSize,
844	pView->view.u32MaxScreenSize));
845
846	Log((" screen %d @%d,%d s 0x%x l 0x%x %dx%d bpp %d f 0x%x\n",
847	pView->screen.u32ViewIndex,
848	pView->screen.i32OriginX,
849	pView->screen.i32OriginY,
850	pView->screen.u32StartOffset,
851	pView->screen.u32LineSize,
852	pView->screen.u32Width,
853	pView->screen.u32Height,
854	pView->screen.u16BitsPerPixel,
855	pView->screen.u16Flags));
856
857	Log((" VBVA o 0x%x p %p\n",
858	pView->vbva.u32VBVAOffset,
859	pView->vbva.guest.pVBVA));
860
861	Log((" PR cb 0x%x p %p\n",
862	pView->vbva.partialRecord.cb,
863	pView->vbva.partialRecord.pu8));
864	}
865
866	dumpMouseShapeInfo(&pCtx->mouseShapeInfo);
867	}
868	#endif /* DEBUG_sunlover */
869
870	#define VBOXVBVASAVEDSTATE_VHWAAVAILABLE_MAGIC 0x12345678
871	#define VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC 0x9abcdef0
872
873	#ifdef VBOX_WITH_VIDEOHWACCEL
874	static void vbvaVHWAHHCommandReinit(VBOXVHWACMD* pHdr, VBOXVHWACMD_TYPE enmCmd, int32_t iDisplay)
875	{
876	memset(pHdr, 0, VBOXVHWACMD_HEADSIZE());
877	pHdr->cRefs = 1;
878	pHdr->iDisplay = iDisplay;
879	pHdr->rc = VERR_NOT_IMPLEMENTED;
880	pHdr->enmCmd = enmCmd;
881	pHdr->Flags = VBOXVHWACMD_FLAG_HH_CMD;
882	}
883
884	static VBOXVHWACMD *vbvaVHWAHHCommandCreate(VBOXVHWACMD_TYPE enmCmd, int32_t iDisplay, VBOXVHWACMD_LENGTH cbCmd)
885	{
886	VBOXVHWACMD pHdr = (VBOXVHWACMD )RTMemAllocZ(cbCmd + VBOXVHWACMD_HEADSIZE());
887	Assert(pHdr);
888	if (pHdr)
889	vbvaVHWAHHCommandReinit(pHdr, enmCmd, iDisplay);
890
891	return pHdr;
892	}
893
894	DECLINLINE(void) vbvaVHWAHHCommandRelease(VBOXVHWACMD *pCmd)
895	{
896	uint32_t cRefs = ASMAtomicDecU32(&pCmd->cRefs);
897	if (!cRefs)
898	RTMemFree(pCmd);
899	}
900
901	DECLINLINE(void) vbvaVHWAHHCommandRetain(VBOXVHWACMD *pCmd)
902	{
903	ASMAtomicIncU32(&pCmd->cRefs);
904	}
905
906	static void vbvaVHWACommandComplete(PVGASTATE pVGAState, PVBOXVHWACMD pCommand, bool fAsyncCommand)
907	{
908	if (fAsyncCommand)
909	{
910	Assert(pCommand->Flags & VBOXVHWACMD_FLAG_HG_ASYNCH);
911	vbvaVHWACommandCompleteAsync(&pVGAState->IVBVACallbacks, pCommand);
912	}
913	else
914	{
915	Log(("VGA Command <<< Sync rc %d %#p, %d\n", pCommand->rc, pCommand, pCommand->enmCmd));
916	pCommand->Flags &= ~VBOXVHWACMD_FLAG_HG_ASYNCH;
917	}
918
919	}
920
921	static void vbvaVHWACommandCompleteAllPending(PVGASTATE pVGAState, int rc)
922	{
923	if (!ASMAtomicUoReadU32(&pVGAState->pendingVhwaCommands.cPending))
924	return;
925
926	PDMCritSectEnter(&pVGAState->CritSect, VERR_SEM_BUSY);
927
928	VBOX_VHWA_PENDINGCMD pIter, pNext;
929	RTListForEachSafe(&pVGAState->pendingVhwaCommands.PendingList, pIter, pNext, VBOX_VHWA_PENDINGCMD, Node)
930	{
931	pIter->pCommand->rc = rc;
932	vbvaVHWACommandComplete(pVGAState, pIter->pCommand, true);
933
934	/* the command is submitted/processed, remove from the pend list */
935	RTListNodeRemove(&pIter->Node);
936	ASMAtomicDecU32(&pVGAState->pendingVhwaCommands.cPending);
937	RTMemFree(pIter);
938	}
939
940	PDMCritSectLeave(&pVGAState->CritSect);
941	}
942
943	static void vbvaVHWACommandClearAllPending(PVGASTATE pVGAState)
944	{
945	if (!ASMAtomicUoReadU32(&pVGAState->pendingVhwaCommands.cPending))
946	return;
947
948	PDMCritSectEnter(&pVGAState->CritSect, VERR_SEM_BUSY);
949
950	VBOX_VHWA_PENDINGCMD pIter, pNext;
951	RTListForEachSafe(&pVGAState->pendingVhwaCommands.PendingList, pIter, pNext, VBOX_VHWA_PENDINGCMD, Node)
952	{
953	RTListNodeRemove(&pIter->Node);
954	ASMAtomicDecU32(&pVGAState->pendingVhwaCommands.cPending);
955	RTMemFree(pIter);
956	}
957
958	PDMCritSectLeave(&pVGAState->CritSect);
959	}
960
961	static void vbvaVHWACommandPend(PVGASTATE pVGAState, PVBOXVHWACMD pCommand)
962	{
963	int rc = VERR_BUFFER_OVERFLOW;
964
965	if (ASMAtomicUoReadU32(&pVGAState->pendingVhwaCommands.cPending) < VBOX_VHWA_MAX_PENDING_COMMANDS)
966	{
967	VBOX_VHWA_PENDINGCMD pPend = (VBOX_VHWA_PENDINGCMD )RTMemAlloc(sizeof(*pPend));
968	if (pPend)
969	{
970	pCommand->Flags \|= VBOXVHWACMD_FLAG_HG_ASYNCH;
971	pPend->pCommand = pCommand;
972	PDMCritSectEnter(&pVGAState->CritSect, VERR_SEM_BUSY);
973	if (ASMAtomicUoReadU32(&pVGAState->pendingVhwaCommands.cPending) < VBOX_VHWA_MAX_PENDING_COMMANDS)
974	{
975	RTListAppend(&pVGAState->pendingVhwaCommands.PendingList, &pPend->Node);
976	ASMAtomicIncU32(&pVGAState->pendingVhwaCommands.cPending);
977	PDMCritSectLeave(&pVGAState->CritSect);
978	return;
979	}
980	PDMCritSectLeave(&pVGAState->CritSect);
981	LogRel(("VBVA: Pending command count has reached its threshold.. completing them all.."));
982	RTMemFree(pPend);
983	}
984	else
985	rc = VERR_NO_MEMORY;
986	}
987	else
988	LogRel(("VBVA: Pending command count has reached its threshold, completing them all.."));
989
990	vbvaVHWACommandCompleteAllPending(pVGAState, rc);
991
992	pCommand->rc = rc;
993
994	vbvaVHWACommandComplete(pVGAState, pCommand, false);
995	}
996
997	static bool vbvaVHWACommandCanPend(PVBOXVHWACMD pCommand)
998	{
999	switch (pCommand->enmCmd)
1000	{
1001	case VBOXVHWACMD_TYPE_HH_CONSTRUCT:
1002	case VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEBEGIN:
1003	case VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEEND:
1004	case VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEPERFORM:
1005	case VBOXVHWACMD_TYPE_HH_SAVESTATE_LOADPERFORM:
1006	return false;
1007	default:
1008	return true;
1009	}
1010	}
1011
1012	static int vbvaVHWACommandSavePending(PVGASTATE pVGAState, PSSMHANDLE pSSM)
1013	{
1014	int rc = SSMR3PutU32(pSSM, pVGAState->pendingVhwaCommands.cPending);
1015	AssertRCReturn(rc, rc);
1016
1017	VBOX_VHWA_PENDINGCMD *pIter;
1018	RTListForEach(&pVGAState->pendingVhwaCommands.PendingList, pIter, VBOX_VHWA_PENDINGCMD, Node)
1019	{
1020	rc = SSMR3PutU32(pSSM, (uint32_t)(((uint8_t)pIter->pCommand) - ((uint8_t)pVGAState->vram_ptrR3)));
1021	AssertRCReturn(rc, rc);
1022	}
1023	return rc;
1024	}
1025
1026	static int vbvaVHWACommandLoadPending(PVGASTATE pVGAState, PSSMHANDLE pSSM, uint32_t u32Version)
1027	{
1028	if (u32Version < VGA_SAVEDSTATE_VERSION_WITH_PENDVHWA)
1029	return VINF_SUCCESS;
1030
1031	uint32_t u32;
1032	int rc = SSMR3GetU32(pSSM, &u32);
1033	AssertRCReturn(rc, rc);
1034	for (uint32_t i = 0; i < u32; ++i)
1035	{
1036	uint32_t off32;
1037	rc = SSMR3GetU32(pSSM, &off32);
1038	AssertRCReturn(rc, rc);
1039	PVBOXVHWACMD pCommand = (PVBOXVHWACMD)((uint8_t *)pVGAState->vram_ptrR3 + off32);
1040	vbvaVHWACommandPend(pVGAState, pCommand);
1041	}
1042	return rc;
1043	}
1044
1045
1046	static bool vbvaVHWACommandSubmit(PVGASTATE pVGAState, PVBOXVHWACMD pCommand, bool fAsyncCommand)
1047	{
1048	bool fPend = false;
1049
1050	if (pVGAState->pDrv->pfnVHWACommandProcess)
1051	{
1052	Log(("VGA Command >>> %#p, %d\n", pCommand, pCommand->enmCmd));
1053	int rc = pVGAState->pDrv->pfnVHWACommandProcess(pVGAState->pDrv, pCommand);
1054	if (rc == VINF_CALLBACK_RETURN)
1055	{
1056	Log(("VGA Command --- Going Async %#p, %d\n", pCommand, pCommand->enmCmd));
1057	return true; /* command will be completed asynchronously, return right away */
1058	}
1059	else if (rc == VERR_INVALID_STATE)
1060	{
1061	Log(("VGA Command --- Trying Pend %#p, %d\n", pCommand, pCommand->enmCmd));
1062	fPend = vbvaVHWACommandCanPend(pCommand);
1063	if (!fPend)
1064	{
1065	Log(("VGA Command --- Can NOT Pend %#p, %d\n", pCommand, pCommand->enmCmd));
1066	pCommand->rc = rc;
1067	}
1068	else
1069	Log(("VGA Command --- Can Pend %#p, %d\n", pCommand, pCommand->enmCmd));
1070	}
1071	else
1072	{
1073	Log(("VGA Command --- Going Complete Sync rc %d %#p, %d\n", rc, pCommand, pCommand->enmCmd));
1074	pCommand->rc = rc;
1075	}
1076
1077	/* the command was completed, take a special care about it (seee below) */
1078	}
1079	else
1080	{
1081	AssertFailed();
1082	pCommand->rc = VERR_INVALID_STATE;
1083	}
1084
1085	if (fPend)
1086	return false;
1087
1088	vbvaVHWACommandComplete(pVGAState, pCommand, fAsyncCommand);
1089
1090	return true;
1091	}
1092
1093	static bool vbvaVHWACheckPendingCommands(PVGASTATE pVGAState)
1094	{
1095	if (!ASMAtomicUoReadU32(&pVGAState->pendingVhwaCommands.cPending))
1096	return true;
1097
1098	PDMCritSectEnter(&pVGAState->CritSect, VERR_SEM_BUSY);
1099
1100	VBOX_VHWA_PENDINGCMD pIter, pNext;
1101	RTListForEachSafe(&pVGAState->pendingVhwaCommands.PendingList, pIter, pNext, VBOX_VHWA_PENDINGCMD, Node)
1102	{
1103	if (!vbvaVHWACommandSubmit(pVGAState, pIter->pCommand, true))
1104	{
1105	PDMCritSectLeave(&pVGAState->CritSect);
1106	return false; /* the command should be pended still */
1107	}
1108
1109	/* the command is submitted/processed, remove from the pend list */
1110	RTListNodeRemove(&pIter->Node);
1111	ASMAtomicDecU32(&pVGAState->pendingVhwaCommands.cPending);
1112	RTMemFree(pIter);
1113	}
1114
1115	PDMCritSectLeave(&pVGAState->CritSect);
1116
1117	return true;
1118	}
1119
1120	void vbvaTimerCb(PVGASTATE pVGAState)
1121	{
1122	vbvaVHWACheckPendingCommands(pVGAState);
1123	}
1124	static void vbvaVHWAHandleCommand(PVGASTATE pVGAState, PVBOXVHWACMD pCmd)
1125	{
1126	if (vbvaVHWACheckPendingCommands(pVGAState))
1127	{
1128	if (vbvaVHWACommandSubmit(pVGAState, pCmd, false))
1129	return;
1130	}
1131
1132	vbvaVHWACommandPend(pVGAState, pCmd);
1133	}
1134
1135	static DECLCALLBACK(void) vbvaVHWAHHCommandSetEventCallback(void * pContext)
1136	{
1137	RTSemEventSignal((RTSEMEVENT)pContext);
1138	}
1139
1140	static int vbvaVHWAHHCommandPost(PVGASTATE pVGAState, VBOXVHWACMD* pCmd)
1141	{
1142	RTSEMEVENT hComplEvent;
1143	int rc = RTSemEventCreate(&hComplEvent);
1144	AssertRC(rc);
1145	if(RT_SUCCESS(rc))
1146	{
1147	/* ensure the cmd is not deleted until we process it */
1148	vbvaVHWAHHCommandRetain (pCmd);
1149	VBOXVHWA_HH_CALLBACK_SET(pCmd, vbvaVHWAHHCommandSetEventCallback, (void*)hComplEvent);
1150	vbvaVHWAHandleCommand(pVGAState, pCmd);
1151	if((ASMAtomicReadU32((volatile uint32_t *)&pCmd->Flags) & VBOXVHWACMD_FLAG_HG_ASYNCH) != 0)
1152	{
1153	rc = RTSemEventWaitNoResume(hComplEvent, RT_INDEFINITE_WAIT);
1154	}
1155	else
1156	{
1157	/* the command is completed */
1158	}
1159
1160	AssertRC(rc);
1161	if(RT_SUCCESS(rc))
1162	{
1163	RTSemEventDestroy(hComplEvent);
1164	}
1165	vbvaVHWAHHCommandRelease(pCmd);
1166	}
1167	return rc;
1168	}
1169
1170	int vbvaVHWAConstruct (PVGASTATE pVGAState)
1171	{
1172	pVGAState->pendingVhwaCommands.cPending = 0;
1173	RTListInit(&pVGAState->pendingVhwaCommands.PendingList);
1174
1175	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(VBOXVHWACMD_TYPE_HH_CONSTRUCT, 0, sizeof(VBOXVHWACMD_HH_CONSTRUCT));
1176	Assert(pCmd);
1177	if(pCmd)
1178	{
1179	uint32_t iDisplay = 0;
1180	int rc = VINF_SUCCESS;
1181	VBOXVHWACMD_HH_CONSTRUCT * pBody = VBOXVHWACMD_BODY(pCmd, VBOXVHWACMD_HH_CONSTRUCT);
1182
1183	do
1184	{
1185	memset(pBody, 0, sizeof(VBOXVHWACMD_HH_CONSTRUCT));
1186
1187	PPDMDEVINS pDevIns = pVGAState->pDevInsR3;
1188	PVM pVM = PDMDevHlpGetVM(pDevIns);
1189
1190	pBody->pVM = pVM;
1191	pBody->pvVRAM = pVGAState->vram_ptrR3;
1192	pBody->cbVRAM = pVGAState->vram_size;
1193
1194	rc = vbvaVHWAHHCommandPost(pVGAState, pCmd);
1195	AssertRC(rc);
1196	if(RT_SUCCESS(rc))
1197	{
1198	rc = pCmd->rc;
1199	AssertMsg(RT_SUCCESS(rc) \|\| rc == VERR_NOT_IMPLEMENTED, ("%Rrc\n", rc));
1200	if(rc == VERR_NOT_IMPLEMENTED)
1201	{
1202	/** @todo set some flag in pVGAState indicating VHWA is not supported */
1203	/* VERR_NOT_IMPLEMENTED is not a failure, we just do not support it */
1204	rc = VINF_SUCCESS;
1205	}
1206
1207	if (!RT_SUCCESS(rc))
1208	break;
1209	}
1210	else
1211	break;
1212
1213	++iDisplay;
1214	if (iDisplay >= pVGAState->cMonitors)
1215	break;
1216	vbvaVHWAHHCommandReinit(pCmd, VBOXVHWACMD_TYPE_HH_CONSTRUCT, (int32_t)iDisplay);
1217	} while (true);
1218
1219	vbvaVHWAHHCommandRelease(pCmd);
1220
1221	return rc;
1222	}
1223	return VERR_OUT_OF_RESOURCES;
1224	}
1225
1226	int vbvaVHWAReset (PVGASTATE pVGAState)
1227	{
1228	vbvaVHWACommandClearAllPending(pVGAState);
1229
1230	/* ensure we have all pending cmds processed and h->g cmds disabled */
1231	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(VBOXVHWACMD_TYPE_HH_RESET, 0, 0);
1232	Assert(pCmd);
1233	if(pCmd)
1234	{
1235	int rc = VINF_SUCCESS;
1236	uint32_t iDisplay = 0;
1237
1238	do
1239	{
1240	rc =vbvaVHWAHHCommandPost(pVGAState, pCmd);
1241	AssertRC(rc);
1242	if(RT_SUCCESS(rc))
1243	{
1244	rc = pCmd->rc;
1245	AssertMsg(RT_SUCCESS(rc) \|\| rc == VERR_NOT_IMPLEMENTED, ("%Rrc\n", rc));
1246	if (rc == VERR_NOT_IMPLEMENTED)
1247	rc = VINF_SUCCESS;
1248	}
1249
1250	if (!RT_SUCCESS(rc))
1251	break;
1252
1253	++iDisplay;
1254	if (iDisplay >= pVGAState->cMonitors)
1255	break;
1256	vbvaVHWAHHCommandReinit(pCmd, VBOXVHWACMD_TYPE_HH_RESET, (int32_t)iDisplay);
1257
1258	} while (true);
1259
1260	vbvaVHWAHHCommandRelease(pCmd);
1261
1262	return rc;
1263	}
1264	return VERR_OUT_OF_RESOURCES;
1265	}
1266
1267	typedef DECLCALLBACK(bool) FNVBOXVHWAHHCMDPRECB(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, void pvContext);
1268	typedef FNVBOXVHWAHHCMDPRECB *PFNVBOXVHWAHHCMDPRECB;
1269
1270	typedef DECLCALLBACK(bool) FNVBOXVHWAHHCMDPOSTCB(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, int rc, void pvContext);
1271	typedef FNVBOXVHWAHHCMDPOSTCB *PFNVBOXVHWAHHCMDPOSTCB;
1272
1273	int vbvaVHWAHHPost(PVGASTATE pVGAState, VBOXVHWACMD pCmd, PFNVBOXVHWAHHCMDPRECB pfnPre, PFNVBOXVHWAHHCMDPOSTCB pfnPost, void pvContext)
1274	{
1275	const VBOXVHWACMD_TYPE enmType = pCmd->enmCmd;
1276	int rc = VINF_SUCCESS;
1277	uint32_t iDisplay = 0;
1278
1279	do
1280	{
1281	if (!pfnPre \|\| pfnPre(pVGAState, pCmd, iDisplay, pvContext))
1282	{
1283	rc = vbvaVHWAHHCommandPost(pVGAState, pCmd);
1284	AssertRC(rc);
1285	if (pfnPost)
1286	{
1287	if (!pfnPost(pVGAState, pCmd, iDisplay, rc, pvContext))
1288	{
1289	rc = VINF_SUCCESS;
1290	break;
1291	}
1292	rc = VINF_SUCCESS;
1293	}
1294	else if(RT_SUCCESS(rc))
1295	{
1296	rc = pCmd->rc;
1297	AssertMsg(RT_SUCCESS(rc) \|\| rc == VERR_NOT_IMPLEMENTED, ("%Rrc\n", rc));
1298	if(rc == VERR_NOT_IMPLEMENTED)
1299	{
1300	rc = VINF_SUCCESS;
1301	}
1302	}
1303
1304	if (!RT_SUCCESS(rc))
1305	break;
1306	}
1307
1308	++iDisplay;
1309	if (iDisplay >= pVGAState->cMonitors)
1310	break;
1311	vbvaVHWAHHCommandReinit(pCmd, enmType, (int32_t)iDisplay);
1312	} while (true);
1313
1314	return rc;
1315	}
1316
1317	/** @todo call this also on reset? */
1318	int vbvaVHWAEnable (PVGASTATE pVGAState, bool bEnable)
1319	{
1320	const VBOXVHWACMD_TYPE enmType = bEnable ? VBOXVHWACMD_TYPE_HH_ENABLE : VBOXVHWACMD_TYPE_HH_DISABLE;
1321	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(enmType, 0, 0);
1322	Assert(pCmd);
1323	if(pCmd)
1324	{
1325	int rc = vbvaVHWAHHPost (pVGAState, pCmd, NULL, NULL, NULL);
1326	vbvaVHWAHHCommandRelease(pCmd);
1327	return rc;
1328	}
1329	return VERR_OUT_OF_RESOURCES;
1330	}
1331
1332	int vboxVBVASaveStatePrep(PPDMDEVINS pDevIns)
1333	{
1334	/* ensure we have no pending commands */
1335	return vbvaVHWAEnable(PDMINS_2_DATA(pDevIns, PVGASTATE), false);
1336	}
1337
1338	int vboxVBVASaveStateDone(PPDMDEVINS pDevIns)
1339	{
1340	/* ensure we have no pending commands */
1341	return vbvaVHWAEnable(PDMINS_2_DATA(pDevIns, PVGASTATE), true);
1342	}
1343
1344	DECLCALLBACK(int) vbvaVHWACommandCompleteAsync(PPDMIDISPLAYVBVACALLBACKS pInterface, PVBOXVHWACMD pCmd)
1345	{
1346	int rc;
1347	Log(("VGA Command <<< Async rc %d %#p, %d\n", pCmd->rc, pCmd, pCmd->enmCmd));
1348
1349	if ((pCmd->Flags & VBOXVHWACMD_FLAG_HH_CMD) == 0)
1350	{
1351	PVGASTATE pVGAState = PPDMIDISPLAYVBVACALLBACKS_2_PVGASTATE(pInterface);
1352	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
1353
1354	Assert(pCmd->Flags & VBOXVHWACMD_FLAG_HG_ASYNCH);
1355	#ifdef VBOX_WITH_WDDM
1356	if (pVGAState->fGuestCaps & VBVACAPS_COMPLETEGCMD_BY_IOREAD)
1357	{
1358	rc = HGSMICompleteGuestCommand(pIns, pCmd, !!(pCmd->Flags & VBOXVHWACMD_FLAG_GH_ASYNCH_IRQ));
1359	AssertRC(rc);
1360	}
1361	else
1362	#endif
1363	{
1364	VBVAHOSTCMD pHostCmd = NULL; / Shut up MSC. */
1365	if (pCmd->Flags & VBOXVHWACMD_FLAG_GH_ASYNCH_EVENT)
1366	{
1367	rc = HGSMIHostCommandAlloc(pIns,
1368	(void **)&pHostCmd,
1369	VBVAHOSTCMD_SIZE(sizeof(VBVAHOSTCMDEVENT)),
1370	HGSMI_CH_VBVA,
1371	VBVAHG_EVENT);
1372	AssertRC(rc);
1373	if (RT_SUCCESS(rc))
1374	{
1375	memset(pHostCmd, 0 , VBVAHOSTCMD_SIZE(sizeof(VBVAHOSTCMDEVENT)));
1376	pHostCmd->iDstID = pCmd->iDisplay;
1377	pHostCmd->customOpCode = 0;
1378	VBVAHOSTCMDEVENT *pBody = VBVAHOSTCMD_BODY(pHostCmd, VBVAHOSTCMDEVENT);
1379	pBody->pEvent = pCmd->GuestVBVAReserved1;
1380	}
1381	}
1382	else
1383	{
1384	HGSMIOFFSET offCmd = HGSMIPointerToOffsetHost(pIns, pCmd);
1385	Assert(offCmd != HGSMIOFFSET_VOID);
1386	if (offCmd != HGSMIOFFSET_VOID)
1387	{
1388	rc = HGSMIHostCommandAlloc(pIns,
1389	(void **)&pHostCmd,
1390	VBVAHOSTCMD_SIZE(sizeof(VBVAHOSTCMDVHWACMDCOMPLETE)),
1391	HGSMI_CH_VBVA,
1392	VBVAHG_DISPLAY_CUSTOM);
1393	AssertRC(rc);
1394	if (RT_SUCCESS(rc))
1395	{
1396	memset(pHostCmd, 0 , VBVAHOSTCMD_SIZE(sizeof(VBVAHOSTCMDVHWACMDCOMPLETE)));
1397	pHostCmd->iDstID = pCmd->iDisplay;
1398	pHostCmd->customOpCode = VBVAHG_DCUSTOM_VHWA_CMDCOMPLETE;
1399	VBVAHOSTCMDVHWACMDCOMPLETE *pBody = VBVAHOSTCMD_BODY(pHostCmd, VBVAHOSTCMDVHWACMDCOMPLETE);
1400	pBody->offCmd = offCmd;
1401	}
1402	}
1403	else
1404	rc = VERR_INVALID_PARAMETER;
1405	}
1406
1407	if (RT_SUCCESS(rc))
1408	{
1409	rc = HGSMIHostCommandSubmitAndFreeAsynch(pIns, pHostCmd, RT_BOOL(pCmd->Flags & VBOXVHWACMD_FLAG_GH_ASYNCH_IRQ));
1410	AssertRC(rc);
1411	if (RT_SUCCESS(rc))
1412	return rc;
1413
1414	HGSMIHostCommandFree (pIns, pHostCmd);
1415	}
1416	}
1417	}
1418	else
1419	{
1420	PFNVBOXVHWA_HH_CALLBACK pfn = VBOXVHWA_HH_CALLBACK_GET(pCmd);
1421	if (pfn)
1422	pfn(VBOXVHWA_HH_CALLBACK_GET_ARG(pCmd));
1423	rc = VINF_SUCCESS;
1424	}
1425	return rc;
1426	}
1427
1428	typedef struct VBOXVBVASAVEDSTATECBDATA
1429	{
1430	PSSMHANDLE pSSM;
1431	int rc;
1432	bool ab2DOn[VBOX_VIDEO_MAX_SCREENS];
1433	} VBOXVBVASAVEDSTATECBDATA, *PVBOXVBVASAVEDSTATECBDATA;
1434
1435	static DECLCALLBACK(bool) vboxVBVASaveStateBeginPostCb(PVGASTATE pVGAState, VBOXVHWACMD *pCmd, uint32_t iDisplay,
1436	int rc, void *pvContext)
1437	{
1438	RT_NOREF(pVGAState, pCmd);
1439	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1440	if (RT_FAILURE(pData->rc))
1441	return false;
1442	if (RT_FAILURE(rc))
1443	{
1444	pData->rc = rc;
1445	return false;
1446	}
1447
1448	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1449	if (iDisplay >= RT_ELEMENTS(pData->ab2DOn))
1450	{
1451	pData->rc = VERR_INVALID_PARAMETER;
1452	return false;
1453	}
1454
1455	Assert(RT_SUCCESS(pCmd->rc) \|\| pCmd->rc == VERR_NOT_IMPLEMENTED);
1456	if (RT_SUCCESS(pCmd->rc))
1457	{
1458	pData->ab2DOn[iDisplay] = true;
1459	}
1460	else if (pCmd->rc != VERR_NOT_IMPLEMENTED)
1461	{
1462	pData->rc = pCmd->rc;
1463	return false;
1464	}
1465
1466	return true;
1467	}
1468
1469	static DECLCALLBACK(bool)
1470	vboxVBVASaveStatePerformPreCb(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, void pvContext)
1471	{
1472	RT_NOREF(pVGAState, pCmd);
1473	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1474	if (RT_FAILURE(pData->rc))
1475	return false;
1476
1477	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1478	if (iDisplay >= RT_ELEMENTS(pData->ab2DOn))
1479	{
1480	pData->rc = VERR_INVALID_PARAMETER;
1481	return false;
1482	}
1483
1484	int rc;
1485
1486	if (pData->ab2DOn[iDisplay])
1487	{
1488	rc = SSMR3PutU32 (pData->pSSM, VBOXVBVASAVEDSTATE_VHWAAVAILABLE_MAGIC); AssertRC(rc);
1489	if (RT_FAILURE(rc))
1490	{
1491	pData->rc = rc;
1492	return false;
1493	}
1494	return true;
1495	}
1496
1497	rc = SSMR3PutU32 (pData->pSSM, VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC); AssertRC(rc);
1498	if (RT_FAILURE(rc))
1499	{
1500	pData->rc = rc;
1501	return false;
1502	}
1503
1504	return false;
1505	}
1506
1507	static DECLCALLBACK(bool) vboxVBVASaveStateEndPreCb(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, void pvContext)
1508	{
1509	RT_NOREF(pVGAState, pCmd);
1510	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1511	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1512	if (pData->ab2DOn[iDisplay])
1513	{
1514	return true;
1515	}
1516
1517	return false;
1518	}
1519
1520	static DECLCALLBACK(bool)
1521	vboxVBVALoadStatePerformPostCb(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, int rc, void pvContext)
1522	{
1523	RT_NOREF(pVGAState, pCmd);
1524	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1525	if (RT_FAILURE(pData->rc))
1526	return false;
1527	if (RT_FAILURE(rc))
1528	{
1529	pData->rc = rc;
1530	return false;
1531	}
1532
1533	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1534	if (iDisplay >= RT_ELEMENTS(pData->ab2DOn))
1535	{
1536	pData->rc = VERR_INVALID_PARAMETER;
1537	return false;
1538	}
1539
1540	Assert(RT_SUCCESS(pCmd->rc) \|\| pCmd->rc == VERR_NOT_IMPLEMENTED);
1541	if (pCmd->rc == VERR_NOT_IMPLEMENTED)
1542	{
1543	pData->rc = SSMR3SkipToEndOfUnit(pData->pSSM);
1544	AssertRC(pData->rc);
1545	return false;
1546	}
1547	if (RT_FAILURE(pCmd->rc))
1548	{
1549	pData->rc = pCmd->rc;
1550	return false;
1551	}
1552
1553	return true;
1554	}
1555
1556	static DECLCALLBACK(bool)
1557	vboxVBVALoadStatePerformPreCb(PVGASTATE pVGAState, VBOXVHWACMD pCmd, uint32_t iDisplay, void pvContext)
1558	{
1559	RT_NOREF(pVGAState, pCmd);
1560	PVBOXVBVASAVEDSTATECBDATA pData = (PVBOXVBVASAVEDSTATECBDATA)pvContext;
1561	if (RT_FAILURE(pData->rc))
1562	return false;
1563
1564	Assert(iDisplay < RT_ELEMENTS(pData->ab2DOn));
1565	if (iDisplay >= RT_ELEMENTS(pData->ab2DOn))
1566	{
1567	pData->rc = VERR_INVALID_PARAMETER;
1568	return false;
1569	}
1570
1571	int rc;
1572	uint32_t u32;
1573	rc = SSMR3GetU32(pData->pSSM, &u32); AssertRC(rc);
1574	if (RT_FAILURE(rc))
1575	{
1576	pData->rc = rc;
1577	return false;
1578	}
1579
1580	switch (u32)
1581	{
1582	case VBOXVBVASAVEDSTATE_VHWAAVAILABLE_MAGIC:
1583	pData->ab2DOn[iDisplay] = true;
1584	return true;
1585	case VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC:
1586	pData->ab2DOn[iDisplay] = false;
1587	return false;
1588	default:
1589	pData->rc = VERR_INVALID_STATE;
1590	return false;
1591	}
1592	}
1593	#endif /* #ifdef VBOX_WITH_VIDEOHWACCEL */
1594
1595	int vboxVBVASaveDevStateExec (PVGASTATE pVGAState, PSSMHANDLE pSSM)
1596	{
1597	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
1598	int rc = HGSMIHostSaveStateExec (pIns, pSSM);
1599	if (RT_SUCCESS(rc))
1600	{
1601	VGA_SAVED_STATE_PUT_MARKER(pSSM, 2);
1602
1603	/* Save VBVACONTEXT. */
1604	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pIns);
1605
1606	if (!pCtx)
1607	{
1608	AssertFailed();
1609
1610	/* Still write a valid value to the SSM. */
1611	rc = SSMR3PutU32 (pSSM, 0);
1612	AssertRCReturn(rc, rc);
1613	}
1614	else
1615	{
1616	#ifdef DEBUG_sunlover
1617	dumpctx(pCtx);
1618	#endif
1619
1620	rc = SSMR3PutU32 (pSSM, pCtx->cViews);
1621	AssertRCReturn(rc, rc);
1622
1623	uint32_t iView;
1624	for (iView = 0; iView < pCtx->cViews; iView++)
1625	{
1626	VBVAVIEW *pView = &pCtx->aViews[iView];
1627
1628	rc = SSMR3PutU32 (pSSM, pView->view.u32ViewIndex);
1629	AssertRCReturn(rc, rc);
1630	rc = SSMR3PutU32 (pSSM, pView->view.u32ViewOffset);
1631	AssertRCReturn(rc, rc);
1632	rc = SSMR3PutU32 (pSSM, pView->view.u32ViewSize);
1633	AssertRCReturn(rc, rc);
1634	rc = SSMR3PutU32 (pSSM, pView->view.u32MaxScreenSize);
1635	AssertRCReturn(rc, rc);
1636
1637	rc = SSMR3PutU32 (pSSM, pView->screen.u32ViewIndex);
1638	AssertRCReturn(rc, rc);
1639	rc = SSMR3PutS32 (pSSM, pView->screen.i32OriginX);
1640	AssertRCReturn(rc, rc);
1641	rc = SSMR3PutS32 (pSSM, pView->screen.i32OriginY);
1642	AssertRCReturn(rc, rc);
1643	rc = SSMR3PutU32 (pSSM, pView->screen.u32StartOffset);
1644	AssertRCReturn(rc, rc);
1645	rc = SSMR3PutU32 (pSSM, pView->screen.u32LineSize);
1646	AssertRCReturn(rc, rc);
1647	rc = SSMR3PutU32 (pSSM, pView->screen.u32Width);
1648	AssertRCReturn(rc, rc);
1649	rc = SSMR3PutU32 (pSSM, pView->screen.u32Height);
1650	AssertRCReturn(rc, rc);
1651	rc = SSMR3PutU16 (pSSM, pView->screen.u16BitsPerPixel);
1652	AssertRCReturn(rc, rc);
1653	rc = SSMR3PutU16 (pSSM, pView->screen.u16Flags);
1654	AssertRCReturn(rc, rc);
1655
1656	rc = SSMR3PutU32 (pSSM, pView->vbva.guest.pVBVA? pView->vbva.u32VBVAOffset: HGSMIOFFSET_VOID);
1657	AssertRCReturn(rc, rc);
1658
1659	rc = SSMR3PutU32 (pSSM, pView->vbva.partialRecord.cb);
1660	AssertRCReturn(rc, rc);
1661
1662	if (pView->vbva.partialRecord.cb > 0)
1663	{
1664	rc = SSMR3PutMem (pSSM, pView->vbva.partialRecord.pu8, pView->vbva.partialRecord.cb);
1665	AssertRCReturn(rc, rc);
1666	}
1667	}
1668
1669	/* Save mouse pointer shape information. */
1670	rc = SSMR3PutBool (pSSM, pCtx->mouseShapeInfo.fSet);
1671	AssertRCReturn(rc, rc);
1672	rc = SSMR3PutBool (pSSM, pCtx->mouseShapeInfo.fVisible);
1673	AssertRCReturn(rc, rc);
1674	rc = SSMR3PutBool (pSSM, pCtx->mouseShapeInfo.fAlpha);
1675	AssertRCReturn(rc, rc);
1676	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.u32HotX);
1677	AssertRCReturn(rc, rc);
1678	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.u32HotY);
1679	AssertRCReturn(rc, rc);
1680	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.u32Width);
1681	AssertRCReturn(rc, rc);
1682	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.u32Height);
1683	AssertRCReturn(rc, rc);
1684	rc = SSMR3PutU32 (pSSM, pCtx->mouseShapeInfo.cbShape);
1685	AssertRCReturn(rc, rc);
1686	if (pCtx->mouseShapeInfo.cbShape)
1687	{
1688	rc = SSMR3PutMem (pSSM, pCtx->mouseShapeInfo.pu8Shape, pCtx->mouseShapeInfo.cbShape);
1689	AssertRCReturn(rc, rc);
1690	}
1691
1692	#ifdef VBOX_WITH_WDDM
1693	/* Size of some additional data. For future extensions. */
1694	rc = SSMR3PutU32 (pSSM, 4);
1695	AssertRCReturn(rc, rc);
1696	rc = SSMR3PutU32 (pSSM, pVGAState->fGuestCaps);
1697	AssertRCReturn(rc, rc);
1698	#else
1699	/* Size of some additional data. For future extensions. */
1700	rc = SSMR3PutU32 (pSSM, 0);
1701	AssertRCReturn(rc, rc);
1702	#endif
1703	rc = SSMR3PutU32 (pSSM, RT_ELEMENTS(pCtx->aModeHints));
1704	AssertRCReturn(rc, rc);
1705	rc = SSMR3PutU32 (pSSM, sizeof(VBVAMODEHINT));
1706	AssertRCReturn(rc, rc);
1707	for (unsigned i = 0; i < RT_ELEMENTS(pCtx->aModeHints); ++i)
1708	{
1709	rc = SSMR3PutMem (pSSM, &pCtx->aModeHints[i],
1710	sizeof(VBVAMODEHINT));
1711	AssertRCReturn(rc, rc);
1712	}
1713	}
1714	}
1715
1716	return rc;
1717	}
1718
1719	int vboxVBVASaveStateExec (PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
1720	{
1721	PVGASTATE pVGAState = PDMINS_2_DATA(pDevIns, PVGASTATE);
1722	int rc;
1723	#ifdef VBOX_WITH_VIDEOHWACCEL
1724	VBOXVBVASAVEDSTATECBDATA VhwaData = {0};
1725	VhwaData.pSSM = pSSM;
1726	uint32_t cbCmd = sizeof (VBOXVHWACMD_HH_SAVESTATE_SAVEPERFORM); /* maximum cmd size */
1727	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEBEGIN, 0, cbCmd);
1728	Assert(pCmd);
1729	if(pCmd)
1730	{
1731	vbvaVHWAHHPost (pVGAState, pCmd, NULL, vboxVBVASaveStateBeginPostCb, &VhwaData);
1732	rc = VhwaData.rc;
1733	AssertRC(rc);
1734	if (RT_SUCCESS(rc))
1735	{
1736	#endif
1737	rc = vboxVBVASaveDevStateExec (pVGAState, pSSM);
1738	AssertRC(rc);
1739	#ifdef VBOX_WITH_VIDEOHWACCEL
1740	if (RT_SUCCESS(rc))
1741	{
1742	vbvaVHWAHHCommandReinit(pCmd, VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEPERFORM, 0);
1743	VBOXVHWACMD_HH_SAVESTATE_SAVEPERFORM *pSave = VBOXVHWACMD_BODY(pCmd, VBOXVHWACMD_HH_SAVESTATE_SAVEPERFORM);
1744	pSave->pSSM = pSSM;
1745	vbvaVHWAHHPost (pVGAState, pCmd, vboxVBVASaveStatePerformPreCb, NULL, &VhwaData);
1746	rc = VhwaData.rc;
1747	AssertRC(rc);
1748	if (RT_SUCCESS(rc))
1749	{
1750	rc = vbvaVHWACommandSavePending(pVGAState, pSSM);
1751	AssertRCReturn(rc, rc);
1752
1753	vbvaVHWAHHCommandReinit(pCmd, VBOXVHWACMD_TYPE_HH_SAVESTATE_SAVEEND, 0);
1754	vbvaVHWAHHPost (pVGAState, pCmd, vboxVBVASaveStateEndPreCb, NULL, &VhwaData);
1755	rc = VhwaData.rc;
1756	AssertRC(rc);
1757	}
1758	}
1759	}
1760
1761	vbvaVHWAHHCommandRelease(pCmd);
1762	}
1763	else
1764	rc = VERR_OUT_OF_RESOURCES;
1765	#else
1766	if (RT_SUCCESS(rc))
1767	{
1768	for (uint32_t i = 0; i < pVGAState->cMonitors; ++i)
1769	{
1770	rc = SSMR3PutU32 (pSSM, VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC);
1771	AssertRCReturn(rc, rc);
1772	}
1773	}
1774
1775	/* no pending commands */
1776	SSMR3PutU32(pSSM, 0);
1777	#endif
1778	return rc;
1779	}
1780
1781	int vboxVBVALoadStateExec (PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion)
1782	{
1783	if (uVersion < VGA_SAVEDSTATE_VERSION_HGSMI)
1784	{
1785	/* Nothing was saved. */
1786	return VINF_SUCCESS;
1787	}
1788
1789	PVGASTATE pVGAState = PDMINS_2_DATA(pDevIns, PVGASTATE);
1790	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
1791	int rc = HGSMIHostLoadStateExec (pIns, pSSM, uVersion);
1792	if (RT_SUCCESS(rc))
1793	{
1794	VGA_SAVED_STATE_GET_MARKER_RETURN_ON_MISMATCH(pSSM, uVersion, 2);
1795
1796	/* Load VBVACONTEXT. */
1797	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pIns);
1798
1799	if (!pCtx)
1800	{
1801	/* This should not happen. */
1802	AssertFailed();
1803	rc = VERR_INVALID_PARAMETER;
1804	}
1805	else
1806	{
1807	uint32_t cViews = 0;
1808	rc = SSMR3GetU32 (pSSM, &cViews);
1809	AssertRCReturn(rc, rc);
1810
1811	uint32_t iView;
1812	for (iView = 0; iView < cViews; iView++)
1813	{
1814	VBVAVIEW *pView = &pCtx->aViews[iView];
1815
1816	rc = SSMR3GetU32 (pSSM, &pView->view.u32ViewIndex);
1817	AssertRCReturn(rc, rc);
1818	rc = SSMR3GetU32 (pSSM, &pView->view.u32ViewOffset);
1819	AssertRCReturn(rc, rc);
1820	rc = SSMR3GetU32 (pSSM, &pView->view.u32ViewSize);
1821	AssertRCReturn(rc, rc);
1822	rc = SSMR3GetU32 (pSSM, &pView->view.u32MaxScreenSize);
1823	AssertRCReturn(rc, rc);
1824
1825	rc = SSMR3GetU32 (pSSM, &pView->screen.u32ViewIndex);
1826	AssertRCReturn(rc, rc);
1827	rc = SSMR3GetS32 (pSSM, &pView->screen.i32OriginX);
1828	AssertRCReturn(rc, rc);
1829	rc = SSMR3GetS32 (pSSM, &pView->screen.i32OriginY);
1830	AssertRCReturn(rc, rc);
1831	rc = SSMR3GetU32 (pSSM, &pView->screen.u32StartOffset);
1832	AssertRCReturn(rc, rc);
1833	rc = SSMR3GetU32 (pSSM, &pView->screen.u32LineSize);
1834	AssertRCReturn(rc, rc);
1835	rc = SSMR3GetU32 (pSSM, &pView->screen.u32Width);
1836	AssertRCReturn(rc, rc);
1837	rc = SSMR3GetU32 (pSSM, &pView->screen.u32Height);
1838	AssertRCReturn(rc, rc);
1839	rc = SSMR3GetU16 (pSSM, &pView->screen.u16BitsPerPixel);
1840	AssertRCReturn(rc, rc);
1841	rc = SSMR3GetU16 (pSSM, &pView->screen.u16Flags);
1842	AssertRCReturn(rc, rc);
1843
1844	rc = SSMR3GetU32 (pSSM, &pView->vbva.u32VBVAOffset);
1845	AssertRCReturn(rc, rc);
1846
1847	rc = SSMR3GetU32 (pSSM, &pView->vbva.partialRecord.cb);
1848	AssertRCReturn(rc, rc);
1849
1850	if (pView->vbva.partialRecord.cb == 0)
1851	{
1852	pView->vbva.partialRecord.pu8 = NULL;
1853	}
1854	else
1855	{
1856	Assert(pView->vbva.partialRecord.pu8 == NULL); /* Should be it. */
1857
1858	uint8_t pu8 = (uint8_t )RTMemAlloc(pView->vbva.partialRecord.cb);
1859
1860	if (!pu8)
1861	{
1862	return VERR_NO_MEMORY;
1863	}
1864
1865	pView->vbva.partialRecord.pu8 = pu8;
1866
1867	rc = SSMR3GetMem (pSSM, pView->vbva.partialRecord.pu8, pView->vbva.partialRecord.cb);
1868	AssertRCReturn(rc, rc);
1869	}
1870
1871	if (pView->vbva.u32VBVAOffset == HGSMIOFFSET_VOID)
1872	{
1873	pView->vbva.guest.pVBVA = NULL;
1874	}
1875	else
1876	{
1877	pView->vbva.guest.pVBVA = (VBVABUFFER *)HGSMIOffsetToPointerHost(pIns, pView->vbva.u32VBVAOffset);
1878	}
1879	}
1880
1881	if (uVersion > VGA_SAVEDSTATE_VERSION_WITH_CONFIG)
1882	{
1883	/* Read mouse pointer shape information. */
1884	rc = SSMR3GetBool (pSSM, &pCtx->mouseShapeInfo.fSet);
1885	AssertRCReturn(rc, rc);
1886	rc = SSMR3GetBool (pSSM, &pCtx->mouseShapeInfo.fVisible);
1887	AssertRCReturn(rc, rc);
1888	rc = SSMR3GetBool (pSSM, &pCtx->mouseShapeInfo.fAlpha);
1889	AssertRCReturn(rc, rc);
1890	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.u32HotX);
1891	AssertRCReturn(rc, rc);
1892	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.u32HotY);
1893	AssertRCReturn(rc, rc);
1894	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.u32Width);
1895	AssertRCReturn(rc, rc);
1896	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.u32Height);
1897	AssertRCReturn(rc, rc);
1898	rc = SSMR3GetU32 (pSSM, &pCtx->mouseShapeInfo.cbShape);
1899	AssertRCReturn(rc, rc);
1900	if (pCtx->mouseShapeInfo.cbShape)
1901	{
1902	pCtx->mouseShapeInfo.pu8Shape = (uint8_t *)RTMemAlloc(pCtx->mouseShapeInfo.cbShape);
1903	if (pCtx->mouseShapeInfo.pu8Shape == NULL)
1904	{
1905	return VERR_NO_MEMORY;
1906	}
1907	pCtx->mouseShapeInfo.cbAllocated = pCtx->mouseShapeInfo.cbShape;
1908	rc = SSMR3GetMem (pSSM, pCtx->mouseShapeInfo.pu8Shape, pCtx->mouseShapeInfo.cbShape);
1909	AssertRCReturn(rc, rc);
1910	}
1911	else
1912	{
1913	pCtx->mouseShapeInfo.pu8Shape = NULL;
1914	}
1915
1916	/* Size of some additional data. For future extensions. */
1917	uint32_t cbExtra = 0;
1918	rc = SSMR3GetU32 (pSSM, &cbExtra);
1919	AssertRCReturn(rc, rc);
1920	#ifdef VBOX_WITH_WDDM
1921	if (cbExtra >= 4)
1922	{
1923	rc = SSMR3GetU32 (pSSM, &pVGAState->fGuestCaps);
1924	AssertRCReturn(rc, rc);
1925	pVGAState->pDrv->pfnVBVAGuestCapabilityUpdate(pVGAState->pDrv, pVGAState->fGuestCaps);
1926	cbExtra -= 4;
1927	}
1928	#endif
1929	if (cbExtra > 0)
1930	{
1931	rc = SSMR3Skip(pSSM, cbExtra);
1932	AssertRCReturn(rc, rc);
1933	}
1934
1935	if (uVersion >= VGA_SAVEDSTATE_VERSION_MODE_HINTS)
1936	{
1937	uint32_t cModeHints, cbModeHints;
1938	rc = SSMR3GetU32 (pSSM, &cModeHints);
1939	AssertRCReturn(rc, rc);
1940	rc = SSMR3GetU32 (pSSM, &cbModeHints);
1941	AssertRCReturn(rc, rc);
1942	memset(&pCtx->aModeHints, ~0, sizeof(pCtx->aModeHints));
1943	unsigned iHint;
1944	for (iHint = 0; iHint < cModeHints; ++iHint)
1945	{
1946	if ( cbModeHints <= sizeof(VBVAMODEHINT)
1947	&& iHint < RT_ELEMENTS(pCtx->aModeHints))
1948	rc = SSMR3GetMem(pSSM, &pCtx->aModeHints[iHint],
1949	cbModeHints);
1950	else
1951	rc = SSMR3Skip(pSSM, cbModeHints);
1952	AssertRCReturn(rc, rc);
1953	}
1954	}
1955	}
1956
1957	pCtx->cViews = iView;
1958	LogFlowFunc(("%d views loaded\n", pCtx->cViews));
1959
1960	if (uVersion > VGA_SAVEDSTATE_VERSION_WDDM)
1961	{
1962	bool fLoadCommands;
1963
1964	if (uVersion < VGA_SAVEDSTATE_VERSION_FIXED_PENDVHWA)
1965	{
1966	const char *pcszOsArch = SSMR3HandleHostOSAndArch(pSSM);
1967	Assert(pcszOsArch);
1968	fLoadCommands = !pcszOsArch \|\| RTStrNCmp(pcszOsArch, RT_STR_TUPLE("solaris"));
1969	}
1970	else
1971	fLoadCommands = true;
1972
1973	#ifdef VBOX_WITH_VIDEOHWACCEL
1974	uint32_t cbCmd = sizeof (VBOXVHWACMD_HH_SAVESTATE_LOADPERFORM); /* maximum cmd size */
1975	VBOXVHWACMD *pCmd = vbvaVHWAHHCommandCreate(VBOXVHWACMD_TYPE_HH_SAVESTATE_LOADPERFORM, 0, cbCmd);
1976	Assert(pCmd);
1977	if(pCmd)
1978	{
1979	VBOXVBVASAVEDSTATECBDATA VhwaData = {0};
1980	VhwaData.pSSM = pSSM;
1981	VBOXVHWACMD_HH_SAVESTATE_LOADPERFORM *pLoad = VBOXVHWACMD_BODY(pCmd, VBOXVHWACMD_HH_SAVESTATE_LOADPERFORM);
1982	pLoad->pSSM = pSSM;
1983	vbvaVHWAHHPost (pVGAState, pCmd, vboxVBVALoadStatePerformPreCb, vboxVBVALoadStatePerformPostCb, &VhwaData);
1984	rc = VhwaData.rc;
1985	vbvaVHWAHHCommandRelease(pCmd);
1986	AssertRCReturn(rc, rc);
1987
1988	if (fLoadCommands)
1989	{
1990	rc = vbvaVHWACommandLoadPending(pVGAState, pSSM, uVersion);
1991	AssertRCReturn(rc, rc);
1992	}
1993	}
1994	else
1995	{
1996	rc = VERR_OUT_OF_RESOURCES;
1997	}
1998	#else
1999	uint32_t u32;
2000
2001	for (uint32_t i = 0; i < pVGAState->cMonitors; ++i)
2002	{
2003	rc = SSMR3GetU32(pSSM, &u32);
2004	AssertRCReturn(rc, rc);
2005
2006	if (u32 != VBOXVBVASAVEDSTATE_VHWAUNAVAILABLE_MAGIC)
2007	{
2008	LogRel(("VBVA: 2D data while 2D is not supported\n"));
2009	return VERR_NOT_SUPPORTED;
2010	}
2011	}
2012
2013	if (fLoadCommands)
2014	{
2015	rc = SSMR3GetU32(pSSM, &u32);
2016	AssertRCReturn(rc, rc);
2017
2018	if (u32)
2019	{
2020	LogRel(("VBVA: 2D pending command while 2D is not supported\n"));
2021	return VERR_NOT_SUPPORTED;
2022	}
2023	}
2024	#endif
2025	}
2026
2027	#ifdef DEBUG_sunlover
2028	dumpctx(pCtx);
2029	#endif
2030	}
2031	}
2032
2033	return rc;
2034	}
2035
2036	int vboxVBVALoadStateDone(PPDMDEVINS pDevIns)
2037	{
2038	PVGASTATE pVGAState = PDMINS_2_DATA(pDevIns, PVGASTATE);
2039	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pVGAState->pHGSMI);
2040	if (pCtx)
2041	{
2042	uint32_t iView;
2043	for (iView = 0; iView < pCtx->cViews; iView++)
2044	{
2045	VBVAVIEW *pView = &pCtx->aViews[iView];
2046	if (pView->vbva.guest.pVBVA)
2047	{
2048	#ifdef VBOX_WITH_CRHGSMI
2049	Assert(!vboxCmdVBVAIsEnabled(pVGAState));
2050	#endif
2051	int rc = vbvaEnable(iView, pVGAState, pCtx, pView->vbva.guest.pVBVA, pView->vbva.u32VBVAOffset, true /* fRestored */);
2052	if (RT_SUCCESS(rc))
2053	vbvaResize(pVGAState, pView, &pView->screen, false);
2054	else
2055	LogRel(("VBVA: can not restore: %Rrc\n", rc));
2056	}
2057	}
2058
2059	if (pCtx->mouseShapeInfo.fSet)
2060	vbvaUpdateMousePointerShape(pVGAState, &pCtx->mouseShapeInfo, true);
2061	}
2062
2063	return VINF_SUCCESS;
2064	}
2065
2066	void VBVARaiseIrq (PVGASTATE pVGAState, uint32_t fFlags)
2067	{
2068	PPDMDEVINS pDevIns = pVGAState->pDevInsR3;
2069
2070	PDMCritSectEnter(&pVGAState->CritSectIRQ, VERR_SEM_BUSY);
2071
2072	const uint32_t fu32CurrentGuestFlags = HGSMIGetHostGuestFlags(pVGAState->pHGSMI);
2073	if ((fu32CurrentGuestFlags & HGSMIHOSTFLAGS_IRQ) == 0)
2074	{
2075	/* No IRQ set yet. */
2076	Assert(pVGAState->fu32PendingGuestFlags == 0);
2077
2078	HGSMISetHostGuestFlags(pVGAState->pHGSMI, HGSMIHOSTFLAGS_IRQ \| fFlags);
2079
2080	/* If VM is not running, the IRQ will be set in VBVAOnResume. */
2081	const VMSTATE enmVMState = PDMDevHlpVMState(pDevIns);
2082	if ( enmVMState == VMSTATE_RUNNING
2083	\|\| enmVMState == VMSTATE_RUNNING_LS)
2084	PDMDevHlpPCISetIrqNoWait(pDevIns, 0, PDM_IRQ_LEVEL_HIGH);
2085	}
2086	else
2087	{
2088	/* IRQ already set, remember the new flags. */
2089	pVGAState->fu32PendingGuestFlags \|= HGSMIHOSTFLAGS_IRQ \| fFlags;
2090	}
2091
2092	PDMCritSectLeave(&pVGAState->CritSectIRQ);
2093	}
2094
2095	void VBVAOnResume(PVGASTATE pThis)
2096	{
2097	PPDMDEVINS pDevIns = pThis->pDevInsR3;
2098
2099	PDMCritSectEnter(&pThis->CritSectIRQ, VERR_SEM_BUSY);
2100
2101	if (HGSMIGetHostGuestFlags(pThis->pHGSMI) & HGSMIHOSTFLAGS_IRQ)
2102	PDMDevHlpPCISetIrqNoWait(pDevIns, 0, PDM_IRQ_LEVEL_HIGH);
2103
2104	PDMCritSectLeave(&pThis->CritSectIRQ);
2105	}
2106
2107	static int vbvaHandleQueryConf32(PVGASTATE pVGAState, VBVACONF32 *pConf32)
2108	{
2109	int rc = VINF_SUCCESS;
2110	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2111	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2112
2113	const uint32_t u32Index = pConf32->u32Index;
2114
2115	LogFlowFunc(("VBVA_QUERY_CONF32: u32Index %d, u32Value 0x%x\n",
2116	u32Index, pConf32->u32Value));
2117
2118	if (u32Index == VBOX_VBVA_CONF32_MONITOR_COUNT)
2119	{
2120	pConf32->u32Value = pCtx->cViews;
2121	}
2122	else if (u32Index == VBOX_VBVA_CONF32_HOST_HEAP_SIZE)
2123	{
2124	/** @todo a value calculated from the vram size */
2125	pConf32->u32Value = _64K;
2126	}
2127	else if ( u32Index == VBOX_VBVA_CONF32_MODE_HINT_REPORTING
2128	\|\| u32Index == VBOX_VBVA_CONF32_GUEST_CURSOR_REPORTING)
2129	{
2130	pConf32->u32Value = VINF_SUCCESS;
2131	}
2132	else if (u32Index == VBOX_VBVA_CONF32_CURSOR_CAPABILITIES)
2133	{
2134	pConf32->u32Value = pVGAState->fHostCursorCapabilities;
2135	}
2136	else if (u32Index == VBOX_VBVA_CONF32_SCREEN_FLAGS)
2137	{
2138	pConf32->u32Value = VBVA_SCREEN_F_ACTIVE
2139	\| VBVA_SCREEN_F_DISABLED
2140	\| VBVA_SCREEN_F_BLANK
2141	\| VBVA_SCREEN_F_BLANK2;
2142	}
2143	else if (u32Index == VBOX_VBVA_CONF32_MAX_RECORD_SIZE)
2144	{
2145	pConf32->u32Value = VBVA_MAX_RECORD_SIZE;
2146	}
2147	else
2148	{
2149	Log(("Unsupported VBVA_QUERY_CONF32 index %d!!!\n",
2150	u32Index));
2151	rc = VERR_INVALID_PARAMETER;
2152	}
2153
2154	return rc;
2155	}
2156
2157	static int vbvaHandleSetConf32(PVGASTATE pVGAState, VBVACONF32 *pConf32)
2158	{
2159	NOREF(pVGAState);
2160
2161	int rc = VINF_SUCCESS;
2162	const VBVACONF32 parms = *pConf32;
2163
2164	LogFlowFunc(("VBVA_SET_CONF32: u32Index %d, u32Value 0x%x\n",
2165	parms.u32Index, parms.u32Value));
2166
2167	if (parms.u32Index == VBOX_VBVA_CONF32_MONITOR_COUNT)
2168	{
2169	/* do nothing. this is a const. */
2170	}
2171	else if (parms.u32Index == VBOX_VBVA_CONF32_HOST_HEAP_SIZE)
2172	{
2173	/* do nothing. this is a const. */
2174	}
2175	else
2176	{
2177	Log(("Unsupported VBVA_SET_CONF32 index %d!!!\n",
2178	parms.u32Index));
2179	rc = VERR_INVALID_PARAMETER;
2180	}
2181
2182	return rc;
2183	}
2184
2185	static int vbvaHandleInfoHeap(PVGASTATE pVGAState, const VBVAINFOHEAP *pInfoHeap)
2186	{
2187	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2188
2189	const VBVAINFOHEAP parms = *pInfoHeap;
2190	LogFlowFunc(("VBVA_INFO_HEAP: offset 0x%x, size 0x%x\n",
2191	parms.u32HeapOffset, parms.u32HeapSize));
2192
2193	return HGSMIHostHeapSetup(pIns, parms.u32HeapOffset, parms.u32HeapSize);
2194	}
2195
2196	int VBVAInfoView(PVGASTATE pVGAState, const VBVAINFOVIEW *pView)
2197	{
2198	const VBVAINFOVIEW view = *pView;
2199
2200	LogFlowFunc(("VBVA_INFO_VIEW: u32ViewIndex %d, u32ViewOffset 0x%x, u32ViewSize 0x%x, u32MaxScreenSize 0x%x\n",
2201	view.u32ViewIndex, view.u32ViewOffset, view.u32ViewSize, view.u32MaxScreenSize));
2202
2203	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2204	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2205
2206	if ( view.u32ViewIndex < pCtx->cViews
2207	&& view.u32ViewOffset <= pVGAState->vram_size
2208	&& view.u32ViewSize <= pVGAState->vram_size
2209	&& view.u32ViewOffset <= pVGAState->vram_size - view.u32ViewSize
2210	&& view.u32MaxScreenSize <= view.u32ViewSize)
2211	{
2212	pCtx->aViews[view.u32ViewIndex].view = view;
2213	return VINF_SUCCESS;
2214	}
2215
2216	LogRelFlow(("VBVA: InfoView: invalid data! index %d(%d), offset 0x%x, size 0x%x, max 0x%x, vram size 0x%x\n",
2217	view.u32ViewIndex, pCtx->cViews, view.u32ViewOffset, view.u32ViewSize,
2218	view.u32MaxScreenSize, pVGAState->vram_size));
2219	return VERR_INVALID_PARAMETER;
2220	}
2221
2222	int VBVAInfoScreen(PVGASTATE pVGAState, const VBVAINFOSCREEN *pScreen)
2223	{
2224	const VBVAINFOSCREEN screen = *pScreen;
2225
2226	LogRel(("VBVA: InfoScreen: [%d] @%d,%d %dx%d, line 0x%x, BPP %d, flags 0x%x\n",
2227	screen.u32ViewIndex, screen.i32OriginX, screen.i32OriginY,
2228	screen.u32Width, screen.u32Height,
2229	screen.u32LineSize, screen.u16BitsPerPixel, screen.u16Flags));
2230
2231	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2232	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2233
2234	/* Allow screen.u16BitsPerPixel == 0 because legacy guest code used it for screen blanking. */
2235	if ( screen.u32ViewIndex < pCtx->cViews
2236	&& screen.u16BitsPerPixel <= 32
2237	&& screen.u32Width <= UINT16_MAX
2238	&& screen.u32Height <= UINT16_MAX
2239	&& screen.u32LineSize <= UINT16_MAX * 4)
2240	{
2241	const VBVAINFOVIEW *pView = &pCtx->aViews[screen.u32ViewIndex].view;
2242	const uint32_t u32BytesPerPixel = (screen.u16BitsPerPixel + 7) / 8;
2243	if (screen.u32Width <= screen.u32LineSize / (u32BytesPerPixel? u32BytesPerPixel: 1))
2244	{
2245	const uint64_t u64ScreenSize = (uint64_t)screen.u32LineSize * screen.u32Height;
2246	if ( screen.u32StartOffset <= pView->u32ViewSize
2247	&& u64ScreenSize <= pView->u32MaxScreenSize
2248	&& screen.u32StartOffset <= pView->u32ViewSize - (uint32_t)u64ScreenSize)
2249	{
2250	vbvaResize(pVGAState, &pCtx->aViews[screen.u32ViewIndex], &screen, true);
2251	return VINF_SUCCESS;
2252	}
2253
2254	/** @todo why not use "%#RX" instead of "0x%RX"? */
2255	LogRelFlow(("VBVA: InfoScreen: invalid data! size 0x%RX64, max 0x%RX32\n",
2256	u64ScreenSize, pView->u32MaxScreenSize));
2257	}
2258	}
2259	else
2260	{
2261	LogRelFlow(("VBVA: InfoScreen: invalid data! index %RU32(%RU32)\n", screen.u32ViewIndex,
2262	pCtx->cViews));
2263	}
2264
2265	return VERR_INVALID_PARAMETER;
2266	}
2267
2268	int VBVAGetInfoViewAndScreen(PVGASTATE pVGAState, uint32_t u32ViewIndex, VBVAINFOVIEW pView, VBVAINFOSCREEN pScreen)
2269	{
2270	if (u32ViewIndex >= pVGAState->cMonitors)
2271	return VERR_INVALID_PARAMETER;
2272
2273	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2274	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pIns);
2275
2276	if (pView)
2277	*pView = pCtx->aViews[u32ViewIndex].view;
2278
2279	if (pScreen)
2280	*pScreen = pCtx->aViews[u32ViewIndex].screen;
2281
2282	return VINF_SUCCESS;
2283	}
2284
2285	static int vbvaHandleEnable(PVGASTATE pVGAState, const VBVAENABLE *pVbvaEnable, uint32_t u32ScreenId)
2286	{
2287	int rc = VINF_SUCCESS;
2288	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2289	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2290
2291	if (u32ScreenId > pCtx->cViews)
2292	{
2293	return VERR_INVALID_PARAMETER;
2294	}
2295
2296	const VBVAENABLE parms = *pVbvaEnable;
2297
2298	LogFlowFunc(("VBVA_ENABLE[%d]: u32Flags 0x%x u32Offset 0x%x\n",
2299	u32ScreenId, parms.u32Flags, parms.u32Offset));
2300
2301	if ((parms.u32Flags & (VBVA_F_ENABLE \| VBVA_F_DISABLE)) == VBVA_F_ENABLE)
2302	{
2303	uint32_t u32Offset = parms.u32Offset;
2304	if (u32Offset < pVGAState->vram_size)
2305	{
2306	/* Guest reported offset either absolute or relative to view. */
2307	if (parms.u32Flags & VBVA_F_ABSOFFSET)
2308	{
2309	/* Offset from VRAM start. */
2310	if ( pVGAState->vram_size < RT_UOFFSETOF(VBVABUFFER, au8Data)
2311	\|\| u32Offset > pVGAState->vram_size - RT_UOFFSETOF(VBVABUFFER, au8Data))
2312	{
2313	rc = VERR_INVALID_PARAMETER;
2314	}
2315	}
2316	else
2317	{
2318	/* Offset from the view start. */
2319	const VBVAINFOVIEW *pView = &pCtx->aViews[u32ScreenId].view;
2320	if ( pVGAState->vram_size - u32Offset < pView->u32ViewOffset
2321	\|\| pView->u32ViewSize < RT_UOFFSETOF(VBVABUFFER, au8Data)
2322	\|\| u32Offset > pView->u32ViewSize - RT_UOFFSETOF(VBVABUFFER, au8Data))
2323	{
2324	rc = VERR_INVALID_PARAMETER;
2325	}
2326	else
2327	{
2328	u32Offset += pView->u32ViewOffset;
2329	}
2330	}
2331	}
2332	else
2333	{
2334	rc = VERR_INVALID_PARAMETER;
2335	}
2336
2337	if (RT_SUCCESS(rc))
2338	{
2339	VBVABUFFER pVBVA = (VBVABUFFER )HGSMIOffsetToPointerHost(pIns, u32Offset);
2340	if (pVBVA)
2341	{
2342	/* Process any pending orders and empty the VBVA ring buffer. */
2343	vbvaFlush(pVGAState, pCtx);
2344
2345	rc = vbvaEnable(u32ScreenId, pVGAState, pCtx, pVBVA, u32Offset, false /* fRestored */);
2346	}
2347	else
2348	{
2349	Log(("Invalid VBVABUFFER offset 0x%x!!!\n",
2350	parms.u32Offset));
2351	rc = VERR_INVALID_PARAMETER;
2352	}
2353	}
2354
2355	if (RT_FAILURE(rc))
2356	{
2357	LogRelMax(8, ("VBVA: can not enable: %Rrc\n", rc));
2358	}
2359	}
2360	else if ((parms.u32Flags & (VBVA_F_ENABLE \| VBVA_F_DISABLE)) == VBVA_F_DISABLE)
2361	{
2362	rc = vbvaDisable(u32ScreenId, pVGAState, pCtx);
2363	}
2364	else
2365	{
2366	Log(("Invalid VBVA_ENABLE flags 0x%x!!!\n",
2367	parms.u32Flags));
2368	rc = VERR_INVALID_PARAMETER;
2369	}
2370
2371	return rc;
2372	}
2373
2374	static int vbvaHandleQueryModeHints(PVGASTATE pVGAState, const VBVAQUERYMODEHINTS *pQueryModeHints, HGSMISIZE cbBuffer)
2375	{
2376	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2377	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2378
2379	const VBVAQUERYMODEHINTS parms = *pQueryModeHints;
2380
2381	LogRelFlowFunc(("VBVA: HandleQueryModeHints: cHintsQueried=%RU16, cbHintStructureGuest=%RU16\n",
2382	parms.cHintsQueried, parms.cbHintStructureGuest));
2383
2384	if (cbBuffer < sizeof(VBVAQUERYMODEHINTS)
2385	+ (uint64_t)parms.cHintsQueried * parms.cbHintStructureGuest)
2386	{
2387	return VERR_INVALID_PARAMETER;
2388	}
2389
2390	uint8_t pbHint = (uint8_t )pQueryModeHints + sizeof(VBVAQUERYMODEHINTS);
2391	memset(pbHint, ~0, cbBuffer - sizeof(VBVAQUERYMODEHINTS));
2392
2393	unsigned iHint;
2394	for (iHint = 0; iHint < parms.cHintsQueried
2395	&& iHint < VBOX_VIDEO_MAX_SCREENS; ++iHint)
2396	{
2397	memcpy(pbHint, &pCtx->aModeHints[iHint],
2398	RT_MIN(parms.cbHintStructureGuest, sizeof(VBVAMODEHINT)));
2399	pbHint += parms.cbHintStructureGuest;
2400	Assert((uintptr_t)(pbHint - (uint8_t *)pQueryModeHints) <= cbBuffer);
2401	}
2402
2403	return VINF_SUCCESS;
2404	}
2405
2406	/*
2407	*
2408	* New VBVA uses a new interface id: #define VBE_DISPI_ID_VBOX_VIDEO 0xBE01
2409	*
2410	* VBVA uses two 32 bits IO ports to write VRAM offsets of shared memory blocks for commands.
2411	* Read Write
2412	* Host port 0x3b0 to process completed
2413	* Guest port 0x3d0 control value? to process
2414	*
2415	*/
2416
2417	static DECLCALLBACK(void) vbvaNotifyGuest (void *pvCallback)
2418	{
2419	#if defined(VBOX_WITH_HGSMI) && (defined(VBOX_WITH_VIDEOHWACCEL) \|\| defined(VBOX_WITH_VDMA) \|\| defined(VBOX_WITH_WDDM))
2420	PVGASTATE pVGAState = (PVGASTATE)pvCallback;
2421	VBVARaiseIrq (pVGAState, 0);
2422	#else
2423	NOREF(pvCallback);
2424	/* Do nothing. Later the VMMDev/VGA IRQ can be used for the notification. */
2425	#endif
2426	}
2427
2428	/** The guest submitted a command buffer. Verify the buffer size and invoke corresponding handler.
2429	*
2430	* @return VBox status code.
2431	* @param pvHandler The VBVA channel context.
2432	* @param u16ChannelInfo Command code.
2433	* @param pvBuffer HGSMI buffer with command data.
2434	* @param cbBuffer Size of command data.
2435	*/
2436	static DECLCALLBACK(int) vbvaChannelHandler(void pvHandler, uint16_t u16ChannelInfo, void pvBuffer, HGSMISIZE cbBuffer)
2437	{
2438	int rc = VINF_SUCCESS;
2439
2440	LogFlowFunc(("pvHandler %p, u16ChannelInfo %d, pvBuffer %p, cbBuffer %u\n",
2441	pvHandler, u16ChannelInfo, pvBuffer, cbBuffer));
2442
2443	PVGASTATE pVGAState = (PVGASTATE)pvHandler;
2444	PHGSMIINSTANCE pIns = pVGAState->pHGSMI;
2445	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pIns);
2446
2447	switch (u16ChannelInfo)
2448	{
2449	#ifdef VBOX_WITH_CRHGSMI
2450	case VBVA_CMDVBVA_SUBMIT:
2451	{
2452	rc = vboxCmdVBVACmdSubmit(pVGAState);
2453	} break;
2454
2455	case VBVA_CMDVBVA_FLUSH:
2456	{
2457	rc = vboxCmdVBVACmdFlush(pVGAState);
2458	} break;
2459
2460	case VBVA_CMDVBVA_CTL:
2461	{
2462	if (cbBuffer < VBoxSHGSMIBufferHeaderSize() + sizeof(VBOXCMDVBVA_CTL))
2463	{
2464	rc = VERR_INVALID_PARAMETER;
2465	break;
2466	}
2467
2468	VBOXCMDVBVA_CTL pCtl = (VBOXCMDVBVA_CTL)VBoxSHGSMIBufferData((PVBOXSHGSMIHEADER)pvBuffer);
2469	rc = vboxCmdVBVACmdCtl(pVGAState, pCtl, cbBuffer - VBoxSHGSMIBufferHeaderSize());
2470	} break;
2471	#endif /* VBOX_WITH_CRHGSMI */
2472
2473	#ifdef VBOX_WITH_VDMA
2474	case VBVA_VDMA_CMD:
2475	{
2476	if (cbBuffer < VBoxSHGSMIBufferHeaderSize() + sizeof(VBOXVDMACBUF_DR))
2477	{
2478	rc = VERR_INVALID_PARAMETER;
2479	break;
2480	}
2481
2482	PVBOXVDMACBUF_DR pCmd = (PVBOXVDMACBUF_DR)VBoxSHGSMIBufferData((PVBOXSHGSMIHEADER)pvBuffer);
2483	vboxVDMACommand(pVGAState->pVdma, pCmd, cbBuffer - VBoxSHGSMIBufferHeaderSize());
2484	} break;
2485
2486	case VBVA_VDMA_CTL:
2487	{
2488	if (cbBuffer < VBoxSHGSMIBufferHeaderSize() + sizeof(VBOXVDMA_CTL))
2489	{
2490	rc = VERR_INVALID_PARAMETER;
2491	break;
2492	}
2493
2494	PVBOXVDMA_CTL pCmd = (PVBOXVDMA_CTL)VBoxSHGSMIBufferData((PVBOXSHGSMIHEADER)pvBuffer);
2495	vboxVDMAControl(pVGAState->pVdma, pCmd, cbBuffer - VBoxSHGSMIBufferHeaderSize());
2496	} break;
2497	#endif /* VBOX_WITH_VDMA */
2498
2499	case VBVA_QUERY_CONF32:
2500	{
2501	if (cbBuffer < sizeof(VBVACONF32))
2502	{
2503	rc = VERR_INVALID_PARAMETER;
2504	break;
2505	}
2506
2507	VBVACONF32 pConf32 = (VBVACONF32 )pvBuffer;
2508	rc = vbvaHandleQueryConf32(pVGAState, pConf32);
2509	} break;
2510
2511	case VBVA_SET_CONF32:
2512	{
2513	if (cbBuffer < sizeof(VBVACONF32))
2514	{
2515	rc = VERR_INVALID_PARAMETER;
2516	break;
2517	}
2518
2519	VBVACONF32 pConf32 = (VBVACONF32 )pvBuffer;
2520	rc = vbvaHandleSetConf32(pVGAState, pConf32);
2521	} break;
2522
2523	case VBVA_INFO_VIEW:
2524	{
2525	#ifdef VBOX_WITH_CRHGSMI
2526	if (vboxCmdVBVAIsEnabled(pVGAState))
2527	{
2528	AssertMsgFailed(("VBVA_INFO_VIEW is not acceptible for CmdVbva\n"));
2529	rc = VERR_INVALID_PARAMETER;
2530	break;
2531	}
2532	#endif /* VBOX_WITH_CRHGSMI */
2533
2534	/* Expect at least one VBVAINFOVIEW structure. */
2535	if (cbBuffer < sizeof(VBVAINFOVIEW))
2536	{
2537	rc = VERR_INVALID_PARAMETER;
2538	break;
2539	}
2540
2541	/* Guest submits an array of VBVAINFOVIEW structures. */
2542	const VBVAINFOVIEW pView = (VBVAINFOVIEW )pvBuffer;
2543	for (;
2544	cbBuffer >= sizeof(VBVAINFOVIEW);
2545	++pView, cbBuffer -= sizeof(VBVAINFOVIEW))
2546	{
2547	rc = VBVAInfoView(pVGAState, pView);
2548	if (RT_FAILURE(rc))
2549	break;
2550	}
2551	} break;
2552
2553	case VBVA_INFO_HEAP:
2554	{
2555	if (cbBuffer < sizeof(VBVAINFOHEAP))
2556	{
2557	rc = VERR_INVALID_PARAMETER;
2558	break;
2559	}
2560
2561	const VBVAINFOHEAP pInfoHeap = (VBVAINFOHEAP )pvBuffer;
2562	rc = vbvaHandleInfoHeap(pVGAState, pInfoHeap);
2563	} break;
2564
2565	case VBVA_FLUSH:
2566	{
2567	if (cbBuffer < sizeof(VBVAFLUSH))
2568	{
2569	rc = VERR_INVALID_PARAMETER;
2570	break;
2571	}
2572
2573	// const VBVAFLUSH pVbvaFlush = (VBVAFLUSH )pvBuffer;
2574	rc = vbvaFlush(pVGAState, pCtx);
2575	} break;
2576
2577	case VBVA_INFO_SCREEN:
2578	{
2579	#ifdef VBOX_WITH_CRHGSMI
2580	if (vboxCmdVBVAIsEnabled(pVGAState))
2581	{
2582	AssertMsgFailed(("VBVA_INFO_SCREEN is not acceptible for CmdVbva\n"));
2583	rc = VERR_INVALID_PARAMETER;
2584	break;
2585	}
2586	#endif /* VBOX_WITH_CRHGSMI */
2587
2588	if (cbBuffer < sizeof(VBVAINFOSCREEN))
2589	{
2590	rc = VERR_INVALID_PARAMETER;
2591	break;
2592	}
2593
2594	const VBVAINFOSCREEN pInfoScreen = (VBVAINFOSCREEN )pvBuffer;
2595	rc = VBVAInfoScreen(pVGAState, pInfoScreen);
2596	} break;
2597
2598	case VBVA_ENABLE:
2599	{
2600	#ifdef VBOX_WITH_CRHGSMI
2601	if (vboxCmdVBVAIsEnabled(pVGAState))
2602	{
2603	AssertMsgFailed(("VBVA_ENABLE is not acceptible for CmdVbva\n"));
2604	rc = VERR_INVALID_PARAMETER;
2605	break;
2606	}
2607	#endif /* VBOX_WITH_CRHGSMI */
2608
2609	if (cbBuffer < sizeof(VBVAENABLE))
2610	{
2611	rc = VERR_INVALID_PARAMETER;
2612	break;
2613	}
2614
2615	VBVAENABLE pVbvaEnable = (VBVAENABLE )pvBuffer;
2616
2617	uint32_t u32ScreenId;
2618	const uint32_t u32Flags = pVbvaEnable->u32Flags;
2619	if (u32Flags & VBVA_F_EXTENDED)
2620	{
2621	if (cbBuffer < sizeof(VBVAENABLE_EX))
2622	{
2623	rc = VERR_INVALID_PARAMETER;
2624	break;
2625	}
2626
2627	const VBVAENABLE_EX pEnableEx = (VBVAENABLE_EX )pvBuffer;
2628	u32ScreenId = pEnableEx->u32ScreenId;
2629	}
2630	else
2631	{
2632	u32ScreenId = vbvaViewFromBufferPtr(pIns, pCtx, pvBuffer);
2633	}
2634
2635	rc = vbvaHandleEnable(pVGAState, pVbvaEnable, u32ScreenId);
2636
2637	pVbvaEnable->i32Result = rc;
2638	} break;
2639
2640	case VBVA_MOUSE_POINTER_SHAPE:
2641	{
2642	if (cbBuffer < sizeof(VBVAMOUSEPOINTERSHAPE))
2643	{
2644	rc = VERR_INVALID_PARAMETER;
2645	break;
2646	}
2647
2648	VBVAMOUSEPOINTERSHAPE pShape = (VBVAMOUSEPOINTERSHAPE )pvBuffer;
2649	rc = vbvaMousePointerShape(pVGAState, pCtx, pShape, cbBuffer);
2650
2651	pShape->i32Result = rc;
2652	} break;
2653
2654
2655	#ifdef VBOX_WITH_VIDEOHWACCEL
2656	case VBVA_VHWA_CMD:
2657	{
2658	if (cbBuffer < VBOXVHWACMD_HEADSIZE())
2659	{
2660	rc = VERR_INVALID_PARAMETER;
2661	break;
2662	}
2663	vbvaVHWAHandleCommand(pVGAState, (PVBOXVHWACMD)pvBuffer);
2664	} break;
2665	#endif /* VBOX_WITH_VIDEOHWACCEL */
2666
2667	#ifdef VBOX_WITH_WDDM
2668	case VBVA_INFO_CAPS:
2669	{
2670	if (cbBuffer < sizeof(VBVACAPS))
2671	{
2672	rc = VERR_INVALID_PARAMETER;
2673	break;
2674	}
2675
2676	VBVACAPS pCaps = (VBVACAPS)pvBuffer;
2677	pVGAState->fGuestCaps = pCaps->fCaps;
2678	pVGAState->pDrv->pfnVBVAGuestCapabilityUpdate(pVGAState->pDrv,
2679	pVGAState->fGuestCaps);
2680	pCaps->rc = VINF_SUCCESS;
2681	} break;
2682	#endif /* VBOX_WITH_WDDM */
2683
2684	case VBVA_SCANLINE_CFG:
2685	{
2686	if (cbBuffer < sizeof(VBVASCANLINECFG))
2687	{
2688	rc = VERR_INVALID_PARAMETER;
2689	break;
2690	}
2691
2692	VBVASCANLINECFG pCfg = (VBVASCANLINECFG)pvBuffer;
2693	pVGAState->fScanLineCfg = pCfg->fFlags;
2694	pCfg->rc = VINF_SUCCESS;
2695	} break;
2696
2697	case VBVA_QUERY_MODE_HINTS:
2698	{
2699	if (cbBuffer < sizeof(VBVAQUERYMODEHINTS))
2700	{
2701	rc = VERR_INVALID_PARAMETER;
2702	break;
2703	}
2704
2705	VBVAQUERYMODEHINTS pQueryModeHints = (VBVAQUERYMODEHINTS)pvBuffer;
2706	rc = vbvaHandleQueryModeHints(pVGAState, pQueryModeHints, cbBuffer);
2707	pQueryModeHints->rc = rc;
2708	} break;
2709
2710	case VBVA_REPORT_INPUT_MAPPING:
2711	{
2712	if (cbBuffer < sizeof(VBVAREPORTINPUTMAPPING))
2713	{
2714	rc = VERR_INVALID_PARAMETER;
2715	break;
2716	}
2717
2718	const VBVAREPORTINPUTMAPPING inputMapping = (VBVAREPORTINPUTMAPPING )pvBuffer;
2719	LogRelFlowFunc(("VBVA: ChannelHandler: VBVA_REPORT_INPUT_MAPPING: x=%RI32, y=%RI32, cx=%RU32, cy=%RU32\n",
2720	inputMapping.x, inputMapping.y, inputMapping.cx, inputMapping.cy));
2721	pVGAState->pDrv->pfnVBVAInputMappingUpdate(pVGAState->pDrv,
2722	inputMapping.x, inputMapping.y,
2723	inputMapping.cx, inputMapping.cy);
2724	} break;
2725
2726	case VBVA_CURSOR_POSITION:
2727	{
2728	if (cbBuffer < sizeof(VBVACURSORPOSITION))
2729	{
2730	rc = VERR_INVALID_PARAMETER;
2731	break;
2732	}
2733
2734	VBVACURSORPOSITION pReport = (VBVACURSORPOSITION )pvBuffer;
2735
2736	LogRelFlowFunc(("VBVA: ChannelHandler: VBVA_CURSOR_POSITION: fReportPosition=%RTbool, x=%RU32, y=%RU32\n",
2737	RT_BOOL(pReport->fReportPosition), pReport->x, pReport->y));
2738
2739	pReport->x = pCtx->xCursor;
2740	pReport->y = pCtx->yCursor;
2741	} break;
2742
2743	default:
2744	Log(("Unsupported VBVA guest command %d!!!\n",
2745	u16ChannelInfo));
2746	break;
2747	}
2748
2749	return rc;
2750	}
2751
2752	/* When VBVA is paused, then VGA device is allowed to work but
2753	* no HGSMI etc state is changed.
2754	*/
2755	void VBVAPause(PVGASTATE pVGAState, bool fPause)
2756	{
2757	if (!pVGAState \|\| !pVGAState->pHGSMI)
2758	{
2759	return;
2760	}
2761
2762	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pVGAState->pHGSMI);
2763
2764	if (pCtx)
2765	{
2766	pCtx->fPaused = fPause;
2767	}
2768	}
2769
2770	bool VBVAIsPaused(PVGASTATE pVGAState)
2771	{
2772	if (pVGAState && pVGAState->pHGSMI)
2773	{
2774	const VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pVGAState->pHGSMI);
2775	if (pCtx && pCtx->cViews)
2776	{
2777	/* If VBVA is enabled at all. */
2778	const VBVAVIEW *pView = &pCtx->aViews[0];
2779	if (pView->vbva.guest.pVBVA)
2780	return pCtx->fPaused;
2781	}
2782	}
2783	/* VBVA is disabled. */
2784	return true;
2785	}
2786
2787	void VBVAOnVBEChanged(PVGASTATE pVGAState)
2788	{
2789	/* The guest does not depend on host handling the VBE registers. */
2790	if (pVGAState->fGuestCaps & VBVACAPS_USE_VBVA_ONLY)
2791	{
2792	return;
2793	}
2794
2795	VBVAPause(pVGAState, (pVGAState->vbe_regs[VBE_DISPI_INDEX_ENABLE] & VBE_DISPI_ENABLED) == 0);
2796	}
2797
2798	void VBVAReset (PVGASTATE pVGAState)
2799	{
2800	if (!pVGAState \|\| !pVGAState->pHGSMI)
2801	{
2802	return;
2803	}
2804
2805	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pVGAState->pHGSMI);
2806
2807	#ifdef VBOX_WITH_VIDEOHWACCEL
2808	vbvaVHWAReset (pVGAState);
2809	#endif
2810
2811	HGSMIReset(pVGAState->pHGSMI);
2812	/* Make sure the IRQ is reset. */
2813	PDMDevHlpPCISetIrq(pVGAState->pDevInsR3, 0, PDM_IRQ_LEVEL_LOW);
2814	pVGAState->fu32PendingGuestFlags = 0;
2815
2816	if (pCtx)
2817	{
2818	vbvaFlush (pVGAState, pCtx);
2819
2820	unsigned uScreenId;
2821
2822	for (uScreenId = 0; uScreenId < pCtx->cViews; uScreenId++)
2823	{
2824	vbvaDisable (uScreenId, pVGAState, pCtx);
2825	}
2826
2827	pCtx->mouseShapeInfo.fSet = false;
2828	RTMemFree(pCtx->mouseShapeInfo.pu8Shape);
2829	pCtx->mouseShapeInfo.pu8Shape = NULL;
2830	pCtx->mouseShapeInfo.cbAllocated = 0;
2831	pCtx->mouseShapeInfo.cbShape = 0;
2832	}
2833
2834	}
2835
2836	int VBVAUpdateDisplay (PVGASTATE pVGAState)
2837	{
2838	int rc = VERR_NOT_SUPPORTED; /* Assuming that the VGA device will have to do updates. */
2839
2840	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pVGAState->pHGSMI);
2841
2842	if (pCtx)
2843	{
2844	if (!pCtx->fPaused)
2845	{
2846	rc = vbvaFlush (pVGAState, pCtx);
2847
2848	if (RT_SUCCESS (rc))
2849	{
2850	if (!pCtx->aViews[0].vbva.guest.pVBVA)
2851	{
2852	/* VBVA is not enabled for the first view, so VGA device must do updates. */
2853	rc = VERR_NOT_SUPPORTED;
2854	}
2855	}
2856	}
2857	}
2858
2859	return rc;
2860	}
2861
2862	static int vbvaSendModeHintWorker(PVGASTATE pThis, uint32_t cx, uint32_t cy,
2863	uint32_t cBPP, uint32_t iDisplay, uint32_t dx,
2864	uint32_t dy, uint32_t fEnabled,
2865	uint32_t fNotifyGuest)
2866	{
2867	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pThis->pHGSMI);
2868	/** @note See Display::setVideoModeHint: "It is up to the guest to decide
2869	* whether the hint is valid. Therefore don't do any VRAM sanity checks
2870	* here! */
2871	if (iDisplay >= RT_MIN(pThis->cMonitors, RT_ELEMENTS(pCtx->aModeHints)))
2872	return VERR_OUT_OF_RANGE;
2873	pCtx->aModeHints[iDisplay].magic = VBVAMODEHINT_MAGIC;
2874	pCtx->aModeHints[iDisplay].cx = cx;
2875	pCtx->aModeHints[iDisplay].cy = cy;
2876	pCtx->aModeHints[iDisplay].cBPP = cBPP;
2877	pCtx->aModeHints[iDisplay].dx = dx;
2878	pCtx->aModeHints[iDisplay].dy = dy;
2879	pCtx->aModeHints[iDisplay].fEnabled = fEnabled;
2880	if (fNotifyGuest && pThis->fGuestCaps & VBVACAPS_IRQ && pThis->fGuestCaps & VBVACAPS_VIDEO_MODE_HINTS)
2881	VBVARaiseIrq(pThis, HGSMIHOSTFLAGS_HOTPLUG);
2882	return VINF_SUCCESS;
2883	}
2884
2885	/** Converts a display port interface pointer to a vga state pointer. */
2886	#define IDISPLAYPORT_2_VGASTATE(pInterface) ( (PVGASTATE)((uintptr_t)pInterface - RT_OFFSETOF(VGASTATE, IPort)) )
2887
2888	DECLCALLBACK(int) vbvaPortSendModeHint(PPDMIDISPLAYPORT pInterface, uint32_t cx,
2889	uint32_t cy, uint32_t cBPP,
2890	uint32_t iDisplay, uint32_t dx,
2891	uint32_t dy, uint32_t fEnabled,
2892	uint32_t fNotifyGuest)
2893	{
2894	PVGASTATE pThis;
2895	int rc;
2896
2897	pThis = IDISPLAYPORT_2_VGASTATE(pInterface);
2898	rc = PDMCritSectEnter(&pThis->CritSect, VERR_SEM_BUSY);
2899	AssertRC(rc);
2900	rc = vbvaSendModeHintWorker(pThis, cx, cy, cBPP, iDisplay, dx, dy, fEnabled,
2901	fNotifyGuest);
2902	PDMCritSectLeave(&pThis->CritSect);
2903	return rc;
2904	}
2905
2906	DECLCALLBACK(void) vbvaPortReportHostCursorCapabilities(PPDMIDISPLAYPORT pInterface, uint32_t fCapabilitiesAdded,
2907	uint32_t fCapabilitiesRemoved)
2908	{
2909	PVGASTATE pThis = IDISPLAYPORT_2_VGASTATE(pInterface);
2910	int rc = PDMCritSectEnter(&pThis->CritSect, VERR_SEM_BUSY);
2911	AssertRC(rc);
2912	pThis->fHostCursorCapabilities \|= fCapabilitiesAdded;
2913	pThis->fHostCursorCapabilities &= ~fCapabilitiesRemoved;
2914	if (pThis->fGuestCaps & VBVACAPS_IRQ && pThis->fGuestCaps & VBVACAPS_DISABLE_CURSOR_INTEGRATION)
2915	VBVARaiseIrq(pThis, HGSMIHOSTFLAGS_CURSOR_CAPABILITIES);
2916	PDMCritSectLeave(&pThis->CritSect);
2917	}
2918
2919	DECLCALLBACK(void) vbvaPortReportHostCursorPosition
2920	(PPDMIDISPLAYPORT pInterface, uint32_t x, uint32_t y)
2921	{
2922	PVGASTATE pThis = IDISPLAYPORT_2_VGASTATE(pInterface);
2923	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext(pThis->pHGSMI);
2924	int rc = PDMCritSectEnter(&pThis->CritSect, VERR_SEM_BUSY);
2925	AssertRC(rc);
2926	pCtx->xCursor = x;
2927	pCtx->yCursor = y;
2928	PDMCritSectLeave(&pThis->CritSect);
2929	}
2930
2931	int VBVAInit (PVGASTATE pVGAState)
2932	{
2933	PPDMDEVINS pDevIns = pVGAState->pDevInsR3;
2934
2935	PVM pVM = PDMDevHlpGetVM(pDevIns);
2936
2937	int rc = HGSMICreate (&pVGAState->pHGSMI,
2938	pVM,
2939	"VBVA",
2940	0,
2941	pVGAState->vram_ptrR3,
2942	pVGAState->vram_size,
2943	vbvaNotifyGuest,
2944	pVGAState,
2945	sizeof (VBVACONTEXT));
2946
2947	if (RT_SUCCESS (rc))
2948	{
2949	rc = HGSMIHostChannelRegister (pVGAState->pHGSMI,
2950	HGSMI_CH_VBVA,
2951	vbvaChannelHandler,
2952	pVGAState);
2953	if (RT_SUCCESS (rc))
2954	{
2955	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pVGAState->pHGSMI);
2956	pCtx->cViews = pVGAState->cMonitors;
2957	pCtx->fPaused = true;
2958	memset(pCtx->aModeHints, ~0, sizeof(pCtx->aModeHints));
2959	pVGAState->fHostCursorCapabilities = 0;
2960	}
2961	}
2962
2963	return rc;
2964
2965	}
2966
2967	void VBVADestroy (PVGASTATE pVGAState)
2968	{
2969	VBVACONTEXT pCtx = (VBVACONTEXT )HGSMIContext (pVGAState->pHGSMI);
2970
2971	if (pCtx)
2972	{
2973	pCtx->mouseShapeInfo.fSet = false;
2974	RTMemFree(pCtx->mouseShapeInfo.pu8Shape);
2975	pCtx->mouseShapeInfo.pu8Shape = NULL;
2976	pCtx->mouseShapeInfo.cbAllocated = 0;
2977	pCtx->mouseShapeInfo.cbShape = 0;
2978	}
2979
2980	HGSMIDestroy (pVGAState->pHGSMI);
2981	pVGAState->pHGSMI = NULL;
2982	}

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

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

Download in other formats: