VirtualBox

source: vbox/trunk/src/VBox/Additions/WINNT/Graphics/Display/driver.h@ 21836

Last change on this file since 21836 was 21611, checked in by vboxsync, 16 years ago

video hw accel: DdLock optimization
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 16.3 KB
Line 
1/******************************Module*Header*******************************\
2*
3 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
4 *
5 * This file is part of VirtualBox Open Source Edition (OSE), as
6 * available from http://www.virtualbox.org. This file is free software;
7 * you can redistribute it and/or modify it under the terms of the GNU
8 * General Public License (GPL) as published by the Free Software
9 * Foundation, in version 2 as it comes in the "COPYING" file of the
10 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
11 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
12 *
13 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
14 * Clara, CA 95054 USA or visit http://www.sun.com if you need
15 * additional information or have any questions.
16*/
17/*
18* Based in part on Microsoft DDK sample code
19*
20* *******************
21* * GDI SAMPLE CODE *
22* *******************
23*
24* Module Name: driver.h
25*
26* contains prototypes for the frame buffer driver.
27*
28* Copyright (c) 1992-1998 Microsoft Corporation
29\**************************************************************************/
30
31#include "stddef.h"
32#include <stdarg.h>
33#include "windef.h"
34#include "wingdi.h"
35#include "winddi.h"
36#include "devioctl.h"
37#include "ntddvdeo.h"
38#include "debug.h"
39
40#include "../Miniport/vboxioctl.h"
41
42#include <VBox/VBoxVideo.h>
43
44/* Forward declaration. */
45struct _PDEV;
46typedef struct _PDEV PDEV;
47typedef PDEV *PPDEV;
48
49typedef struct _VBOXDISPLAYINFO
50{
51 VBOXVIDEOINFOHDR hdrLink;
52 VBOXVIDEOINFOLINK link;
53 VBOXVIDEOINFOHDR hdrScreen;
54 VBOXVIDEOINFOSCREEN screen;
55 VBOXVIDEOINFOHDR hdrHostEvents;
56 VBOXVIDEOINFOHOSTEVENTS hostEvents;
57 VBOXVIDEOINFOHDR hdrEnd;
58} VBOXDISPLAYINFO;
59
60#include "vbvavrdp.h"
61#include "vrdpbmp.h"
62
63/* Saved screen bits information. */
64typedef struct _SSB
65{
66 ULONG ident; /* 1 based index in the stack = the handle returned by DrvSaveScreenBits (SS_SAVE) */
67 BYTE *pBuffer; /* Buffer where screen bits are saved. */
68} SSB;
69
70/* VRAM
71 * | | | | |
72 * 0+framebuffer+ddraw heap+VBVA buffer+displayinfo=cScreenSize
73 */
74typedef struct _VRAMLAYOUT
75{
76 ULONG cbVRAM;
77
78 ULONG offFrameBuffer;
79 ULONG cbFrameBuffer;
80
81 ULONG offDDRAWHeap; //@todo
82 ULONG cbDDRAWHeap;
83
84 ULONG offVBVABuffer;
85 ULONG cbVBVABuffer;
86
87 ULONG offDisplayInformation;
88 ULONG cbDisplayInformation;
89} VRAMLAYOUT;
90
91typedef struct
92{
93 PPDEV ppdev;
94} VBOXSURF, *PVBOXSURF;
95
96#ifdef VBOX_WITH_VIDEOHWACCEL
97typedef struct _VBOXVHWAREGION
98{
99 RECTL Rect;
100 bool bValid;
101}VBOXVHWAREGION, *PVBOXVHWAREGION;
102
103typedef struct _VBOXVHWASURFDESC
104{
105 VBOXVHWA_SURFHANDLE hHostHandle;
106 volatile uint32_t cPendingBltsSrc;
107 volatile uint32_t cPendingBltsDst;
108 volatile uint32_t cPendingFlipsCurr;
109 volatile uint32_t cPendingFlipsTarg;
110 uint32_t cBitsPerPixel;
111 bool bHidden;
112 VBOXVHWAREGION DirtyRegion;
113}VBOXVHWASURFDESC, *PVBOXVHWASURFDESC;
114
115typedef struct _VBOXVHWAINFO
116{
117 uint32_t caps;
118 uint32_t caps2;
119 uint32_t colorKeyCaps;
120 uint32_t stretchCaps;
121 uint32_t surfaceCaps;
122 uint32_t numOverlays;
123 uint32_t numFourCC;
124 HGSMIOFFSET FourCC;
125 BOOLEAN bVHWAEnabled;
126} VBOXVHWAINFO;
127#endif
128
129struct _PDEV
130{
131 HANDLE hDriver; // Handle to \Device\Screen
132 HDEV hdevEng; // Engine's handle to PDEV
133 HSURF hsurfScreenBitmap; // Engine's handle to VRAM screen bitmap surface
134 SURFOBJ *psoScreenBitmap; // VRAM screen bitmap surface
135 HSURF hsurfScreen; // Engine's handle to VRAM screen device surface
136 ULONG ulBitmapType;
137 HPALETTE hpalDefault; // Handle to the default palette for device.
138 PBYTE pjScreen; // This is pointer to base screen address
139 ULONG cxScreen; // Visible screen width
140 ULONG cyScreen; // Visible screen height
141 POINTL ptlOrg; // Where this display is anchored in
142 // the virtual desktop.
143 POINTL ptlDevOrg; // Device origin for DualView (0,0 for primary view).
144 ULONG ulMode; // Mode the mini-port driver is in.
145 LONG lDeltaScreen; // Distance from one scan to the next.
146
147 PVOID pOffscreenList; // linked list of DCI offscreen surfaces.
148 FLONG flRed; // For bitfields device, Red Mask
149 FLONG flGreen; // For bitfields device, Green Mask
150 FLONG flBlue; // For bitfields device, Blue Mask
151 ULONG cPaletteShift; // number of bits the 8-8-8 palette must
152 // be shifted by to fit in the hardware
153 // palette.
154 ULONG ulBitCount; // # of bits per pel 8,16,24,32 are only supported.
155 POINTL ptlHotSpot; // adjustment for pointer hot spot
156 VIDEO_POINTER_CAPABILITIES PointerCapabilities; // HW pointer abilities
157 PVIDEO_POINTER_ATTRIBUTES pPointerAttributes; // hardware pointer attributes
158 DWORD cjPointerAttributes; // Size of buffer allocated
159 BOOL fHwCursorActive; // Are we currently using the hw cursor
160 PALETTEENTRY *pPal; // If this is pal managed, this is the pal
161 BOOL bSupportDCI; // Does the miniport support DCI?
162 FLONG flHooks;
163
164#ifndef VBOX_WITH_HGSMI
165 VBVAENABLERESULT vbva;
166 uint32_t u32VRDPResetFlag;
167#endif /* !VBOX_WITH_HGSMI */
168 BOOL fHwBufferOverflow;
169 VBVARECORD *pRecord;
170 VRDPBC cache;
171
172 ULONG cSSB; // Number of active saved screen bits records in the following array.
173 SSB aSSB[4]; // LIFO type stack for saved screen areas.
174
175#ifndef VBOX_WITH_HGSMI
176 VBOXDISPLAYINFO *pInfo;
177 BOOLEAN bVBoxVideoSupported;
178#endif /* !VBOX_WITH_HGSMI */
179 ULONG iDevice;
180 VRAMLAYOUT layout;
181
182 PVBOXSURF pdsurfScreen;
183
184#ifdef VBOX_WITH_DDRAW
185 BOOL bDdExclusiveMode;
186 DWORD dwNewDDSurfaceOffset;
187 DWORD cHeaps;
188 VIDEOMEMORY* pvmList;
189 struct {
190 DWORD bLocked;
191 RECTL rArea;
192 } ddLock;
193#endif /* VBOX_WITH_DDRAW */
194
195#ifdef VBOX_WITH_HGSMI
196 BOOLEAN bHGSMISupported;
197 HGSMIHEAP hgsmiDisplayHeap;
198 VBVABUFFER *pVBVA; /* Pointer to the pjScreen + layout->offVBVABuffer. NULL if VBVA is not enabled. */
199
200 HVBOXVIDEOHGSMI hMpHGSMI; /* context handler passed to miniport HGSMI callbacks */
201 PFNVBOXVIDEOHGSMICOMPLETION pfnHGSMICommandComplete; /* called to complete the command we receive from the miniport */
202 PFNVBOXVIDEOHGSMICOMMANDS pfnHGSMIRequestCommands; /* called to requests the commands posted to us from the host */
203#endif /* VBOX_WITH_HGSMI */
204
205#ifdef VBOX_WITH_VIDEOHWACCEL
206 VBOXVHWAINFO vhwaInfo;
207#endif
208};
209
210#ifdef VBOX_WITH_OPENGL
211typedef struct
212{
213 DWORD dwVersion;
214 DWORD dwDriverVersion;
215 WCHAR szDriverName[256];
216} OPENGL_INFO, *POPENGL_INFO;
217#endif
218
219#ifndef VBOX_WITH_HGSMI
220/* The global semaphore handle for all driver instances. */
221extern HSEMAPHORE ghsemHwBuffer;
222#endif /* !VBOX_WITH_HGSMI */
223
224
225#ifdef VBOX_WITH_HGSMI
226#define VBE_DISPI_IOPORT_INDEX 0x01CE
227#define VBE_DISPI_IOPORT_DATA 0x01CF
228#define VBE_DISPI_INDEX_VBVA_GUEST 0xc
229#endif /* VBOX_WITH_HGSMI */
230
231extern BOOL g_bOnNT40;
232
233DWORD getAvailableModes(HANDLE, PVIDEO_MODE_INFORMATION *, DWORD *);
234BOOL bInitPDEV(PPDEV, PDEVMODEW, GDIINFO *, DEVINFO *);
235BOOL bInitSURF(PPDEV, BOOL);
236BOOL bInitPaletteInfo(PPDEV, DEVINFO *);
237BOOL bInitPointer(PPDEV, DEVINFO *);
238BOOL bInit256ColorPalette(PPDEV);
239BOOL bInitNotificationThread(PPDEV);
240VOID vStopNotificationThread (PPDEV);
241VOID vDisablePalette(PPDEV);
242VOID vDisableSURF(PPDEV);
243
244#define MAX_CLUT_SIZE (sizeof(VIDEO_CLUT) + (sizeof(ULONG) * 256))
245
246//
247// Determines the size of the DriverExtra information in the DEVMODE
248// structure passed to and from the display driver.
249//
250
251#define DRIVER_EXTRA_SIZE 0
252
253#define DLL_NAME L"VBoxDisp" // Name of the DLL in UNICODE
254#define STANDARD_DEBUG_PREFIX "VBOXDISP: " // All debug output is prefixed
255#define ALLOC_TAG 'bvDD' // Four byte tag (characters in
256 // reverse order) used for memory
257 // allocations
258
259// VBOX
260typedef struct _CLIPRECTS {
261 ULONG c;
262 RECTL arcl[64];
263} CLIPRECTS;
264
265typedef struct _VRDPCLIPRECTS
266{
267 RECTL rclDstOrig; /* Original bounding rectancle. */
268 RECTL rclDst; /* Bounding rectangle of all rects. */
269 CLIPRECTS rects; /* Rectangles to update. */
270} VRDPCLIPRECTS;
271
272
273BOOL vboxVbvaEnable (PPDEV ppdev);
274void vboxVbvaDisable (PPDEV ppdev);
275
276BOOL vboxHwBufferBeginUpdate (PPDEV ppdev);
277void vboxHwBufferEndUpdate (PPDEV ppdev);
278
279BOOL vboxWrite (PPDEV ppdev, const void *pv, uint32_t cb);
280
281BOOL vboxOrderSupported (PPDEV ppdev, unsigned code);
282
283void VBoxProcessDisplayInfo(PPDEV ppdev);
284void VBoxUpdateDisplayInfo (PPDEV ppdev);
285
286void drvLoadEng (void);
287
288#ifdef VBOX_WITH_HGSMI
289void vboxVBVAHostCommandComplete(PPDEV ppdev, VBVAHOSTCMD * pCmd);
290
291 #ifdef VBOX_WITH_VIDEOHWACCEL
292
293#define VBOXDD_CHECKFLAG(_v, _f) ((_v) & (_f)) == (_f)
294
295typedef DECLCALLBACK(void) FNVBOXVHWACMDCOMPLETION(PPDEV ppdev, VBOXVHWACMD * pCmd, void * pContext);
296typedef FNVBOXVHWACMDCOMPLETION *PFNVBOXVHWACMDCOMPLETION;
297
298void vboxVHWARectUnited(RECTL * pDst, RECTL * pRect1, RECTL * pRect2);
299bool vboxVHWARectIsEmpty(RECTL * pRect);
300bool vboxVHWARectIntersect(RECTL * pRect1, RECTL * pRect2);
301bool vboxVHWARectInclude(RECTL * pRect1, RECTL * pRect2);
302bool vboxVHWARegionIntersects(PVBOXVHWAREGION pReg, RECTL * pRect);
303bool vboxVHWARegionIncludes(PVBOXVHWAREGION pReg, RECTL * pRect);
304bool vboxVHWARegionIncluded(PVBOXVHWAREGION pReg, RECTL * pRect);
305void vboxVHWARegionSet(PVBOXVHWAREGION pReg, RECTL * pRect);
306void vboxVHWARegionAdd(PVBOXVHWAREGION pReg, RECTL * pRect);
307void vboxVHWARegionInit(PVBOXVHWAREGION pReg);
308void vboxVHWARegionClear(PVBOXVHWAREGION pReg);
309
310VBOXVHWACMD* vboxVHWACommandCreate (PPDEV ppdev, VBOXVHWACMD_TYPE enmCmd, VBOXVHWACMD_LENGTH cbCmd);
311void vboxVHWACommandFree (PPDEV ppdev, VBOXVHWACMD* pCmd);
312BOOL vboxVHWACommandSubmit (PPDEV ppdev, VBOXVHWACMD* pCmd);
313void vboxVHWACommandSubmitAsynch (PPDEV ppdev, VBOXVHWACMD* pCmd, PFNVBOXVHWACMDCOMPLETION pfnCompletion, void * pContext);
314void vboxVHWACommandSubmitAsynchByEvent (PPDEV ppdev, VBOXVHWACMD* pCmd, PEVENT pEvent);
315void vboxVHWACommandCheckHostCmds(PPDEV ppdev);
316
317int vboxVHWAInitHostInfo1(PPDEV ppdev);
318int vboxVHWAInitHostInfo2(PPDEV ppdev, DWORD *pFourCC);
319
320VBOXVHWACMD_QUERYINFO1* vboxVHWAQueryHostInfo1(PPDEV ppdev);
321void vboxVHWAFreeHostInfo1(PPDEV ppdev, VBOXVHWACMD_QUERYINFO1* pInfo);
322VBOXVHWACMD_QUERYINFO2* vboxVHWAQueryHostInfo2(PPDEV ppdev, uint32_t numFourCC);
323void vboxVHWAFreeHostInfo2(PPDEV ppdev, VBOXVHWACMD_QUERYINFO2* pInfo);
324
325void vboxVHWAInit();
326void vboxVHWATerm();
327uint32_t vboxVHWAUnsupportedDDCAPS(uint32_t caps);
328uint32_t vboxVHWAUnsupportedDDSCAPS(uint32_t caps);
329uint32_t vboxVHWAUnsupportedDDPFS(uint32_t caps);
330uint32_t vboxVHWASupportedDDCAPS(uint32_t caps);
331uint32_t vboxVHWASupportedDDSCAPS(uint32_t caps);
332uint32_t vboxVHWASupportedDDPFS(uint32_t caps);
333
334uint32_t vboxVHWAUnsupportedDDCEYCAPS(uint32_t caps);
335uint32_t vboxVHWASupportedDDCEYCAPS(uint32_t caps);
336
337uint32_t vboxVHWAToDDBLTs(uint32_t caps);
338uint32_t vboxVHWAFromDDBLTs(uint32_t caps);
339
340uint32_t vboxVHWAFromDDCAPS2(uint32_t caps);
341uint32_t vboxVHWAToDDCAPS2(uint32_t caps);
342
343void vboxVHWAFromDDBLTFX(VBOXVHWA_BLTFX *pVHWABlt, DDBLTFX *pDdBlt);
344
345void vboxVHWAFromDDCOLORKEY(VBOXVHWA_COLORKEY *pVHWACKey, DDCOLORKEY *pDdCKey);
346
347uint32_t vboxVHWAFromDDOVERs(uint32_t caps);
348uint32_t vboxVHWAToDDOVERs(uint32_t caps);
349uint32_t vboxVHWAFromDDCKEYs(uint32_t caps);
350uint32_t vboxVHWAToDDCKEYs(uint32_t caps);
351
352void vboxVHWAFromDDOVERLAYFX(VBOXVHWA_OVERLAYFX *pVHWAOverlay, DDOVERLAYFX *pDdOverlay);
353
354uint32_t vboxVHWAFromDDCAPS(uint32_t caps);
355uint32_t vboxVHWAToDDCAPS(uint32_t caps);
356uint32_t vboxVHWAFromDDSCAPS(uint32_t caps);
357uint32_t vboxVHWAToDDSCAPS(uint32_t caps);
358uint32_t vboxVHWAFromDDPFS(uint32_t caps);
359uint32_t vboxVHWAToDDPFS(uint32_t caps);
360uint32_t vboxVHWAFromDDCKEYCAPS(uint32_t caps);
361uint32_t vboxVHWAToDDCKEYCAPS(uint32_t caps);
362int vboxVHWAFromDDPIXELFORMAT(VBOXVHWA_PIXELFORMAT *pVHWAFormat, DDPIXELFORMAT *pDdFormat);
363int vboxVHWAFromDDSURFACEDESC(VBOXVHWA_SURFACEDESC *pVHWADesc, DDSURFACEDESC *pDdDesc);
364void vboxVHWAFromRECTL(VBOXVHWA_RECTL *pDst, RECTL *pSrc);
365PVBOXVHWASURFDESC vboxVHWASurfDescAlloc();
366void vboxVHWASurfDescFree(PVBOXVHWASURFDESC pDesc);
367
368int vboxVHWAEnable(PPDEV ppdev);
369int vboxVHWADisable(PPDEV ppdev);
370
371 #endif
372#endif
373
374BOOL bIsScreenSurface (SURFOBJ *pso);
375
376__inline SURFOBJ *getSurfObj (SURFOBJ *pso)
377{
378 if (pso)
379 {
380 PPDEV ppdev = (PPDEV)pso->dhpdev;
381
382 if (ppdev)
383 {
384 if (ppdev->psoScreenBitmap && pso->hsurf == ppdev->hsurfScreen)
385 {
386 /* Convert the device PSO to the bitmap PSO which can be passed to Eng*. */
387 pso = ppdev->psoScreenBitmap;
388 }
389 }
390 }
391
392 return pso;
393}
394
395#define CONV_SURF(_pso) getSurfObj (_pso)
396
397__inline int format2BytesPerPixel(const SURFOBJ *pso)
398{
399 switch (pso->iBitmapFormat)
400 {
401 case BMF_16BPP: return 2;
402 case BMF_24BPP: return 3;
403 case BMF_32BPP: return 4;
404 }
405
406 return 0;
407}
408
409#ifdef VBOX_VBVA_ADJUST_RECT
410void vrdpAdjustRect (SURFOBJ *pso, RECTL *prcl);
411BOOL vbvaFindChangedRect (SURFOBJ *psoDest, SURFOBJ *psoSrc, RECTL *prclDest, POINTL *pptlSrc);
412#endif /* VBOX_VBVA_ADJUST_RECT */
413
414void vrdpReportDirtyRect (PPDEV ppdev, RECTL *prcl);
415void vbvaReportDirtyRect (PPDEV ppdev, RECTL *prcl);
416
417#define VRDP_TEXT_MAX_GLYPH_SIZE 0x100
418#define VRDP_TEXT_MAX_GLYPHS 0xfe
419
420BOOL vboxReportText (PPDEV ppdev,
421 VRDPCLIPRECTS *pClipRects,
422 STROBJ *pstro,
423 FONTOBJ *pfo,
424 RECTL *prclOpaque,
425 ULONG ulForeRGB,
426 ULONG ulBackRGB
427 );
428
429BOOL vrdpReportOrderGeneric (PPDEV ppdev,
430 const VRDPCLIPRECTS *pClipRects,
431 const void *pvOrder,
432 unsigned cbOrder,
433 unsigned code);
434
435
436#include <iprt/assert.h>
437
438#define VBVA_ASSERT(expr) \
439 do { \
440 if (!(expr)) \
441 { \
442 AssertMsg1(#expr, __LINE__, __FILE__, __PRETTY_FUNCTION__); \
443 AssertMsg2("!!!\n"); \
444 } \
445 } while (0)
446
447#ifdef STAT_sunlover
448extern ULONG gStatCopyBitsOffscreenToScreen;
449extern ULONG gStatCopyBitsScreenToScreen;
450extern ULONG gStatBitBltOffscreenToScreen;
451extern ULONG gStatBitBltScreenToScreen;
452extern ULONG gStatUnchangedOffscreenToScreen;
453extern ULONG gStatUnchangedOffscreenToScreenCRC;
454extern ULONG gStatNonTransientEngineBitmaps;
455extern ULONG gStatTransientEngineBitmaps;
456extern ULONG gStatUnchangedBitmapsCRC;
457extern ULONG gStatUnchangedBitmapsDeviceCRC;
458extern ULONG gStatBitmapsCRC;
459extern ULONG gStatBitBltScreenPattern;
460extern ULONG gStatBitBltScreenSquare;
461extern ULONG gStatBitBltScreenPatternReported;
462extern ULONG gStatBitBltScreenSquareReported;
463extern ULONG gStatCopyBitsScreenSquare;
464
465extern ULONG gStatEnablePDEV;
466extern ULONG gStatCompletePDEV;
467extern ULONG gStatDisablePDEV;
468extern ULONG gStatEnableSurface;
469extern ULONG gStatDisableSurface;
470extern ULONG gStatAssertMode;
471extern ULONG gStatDisableDriver;
472extern ULONG gStatCreateDeviceBitmap;
473extern ULONG gStatDeleteDeviceBitmap;
474extern ULONG gStatDitherColor;
475extern ULONG gStatStrokePath;
476extern ULONG gStatFillPath;
477extern ULONG gStatStrokeAndFillPath;
478extern ULONG gStatPaint;
479extern ULONG gStatBitBlt;
480extern ULONG gStatCopyBits;
481extern ULONG gStatStretchBlt;
482extern ULONG gStatSetPalette;
483extern ULONG gStatTextOut;
484extern ULONG gStatSetPointerShape;
485extern ULONG gStatMovePointer;
486extern ULONG gStatLineTo;
487extern ULONG gStatSynchronize;
488extern ULONG gStatGetModes;
489extern ULONG gStatGradientFill;
490extern ULONG gStatStretchBltROP;
491extern ULONG gStatPlgBlt;
492extern ULONG gStatAlphaBlend;
493extern ULONG gStatTransparentBlt;
494
495void statPrint (void);
496
497#define STATDRVENTRY(a, b) do { if (bIsScreenSurface (b)) gStat##a++; } while (0)
498#define STATPRINT do { statPrint (); } while (0)
499#else
500#define STATDRVENTRY(a, b)
501#define STATPRINT
502#endif /* STAT_sunlover */
Note: See TracBrowser for help on using the repository browser.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette