DevVGA_VBVA.cpp@ 63427

Last change on this file since 63427 was 62928, checked in by vboxsync, 8 years ago
Devices: warnings
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 96.9 KB

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

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

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

Download in other formats: