Changeset 34429 in vbox for trunk/include

Timestamp:

Nov 27, 2010 1:56:46 AM (14 years ago)

Author:

vboxsync

Message:

Additions/WINNT/Graphics and Additions/common/VBoxVideo: move the basic guest HGSMI code from WINNT into common, document it and make sure it builds without requiring Windows headers

File:

• trunk/include/VBox/VBoxVideoGuest.h (modified) (2 diffs)

trunk/include/VBox/VBoxVideoGuest.h

@@ -32 +32 @@
 #include <VBox/HGSMI/HGSMI.h>
 #include <VBox/HGSMI/HGSMIChSetup.h>
+
+#ifdef VBOX_XPDM_MINIPORT
+RT_C_DECLS_BEGIN
+# include "miniport.h"
+# include "ntddvdeo.h"
+# include <Video.h>
+RT_C_DECLS_END
+#else
+# include <iprt/asm-amd64-x86.h>
+#endif
+
+RT_C_DECLS_BEGIN
 
 /**
@@ -74 +86 @@
 } HGSMIHOSTCOMMANDCONTEXT, *PHGSMIHOSTCOMMANDCONTEXT;
 
+/** @name Helper functions
+ * @{ */
+/** Write an 8-bit value to an I/O port. */
+DECLINLINE(void) VBoxVideoCmnPortWriteUchar(RTIOPORT Port, uint8_t Value)
+{
+#ifdef VBOX_XPDM_MINIPORT
+    VideoPortWritePortUchar((PUCHAR)Port, Value);
+#else  /** @todo make these explicit */
+    ASMOutU8(Port, Value);
+#endif
+}
+
+/** Write a 16-bit value to an I/O port. */
+DECLINLINE(void) VBoxVideoCmnPortWriteUshort(RTIOPORT Port, uint16_t Value)
+{
+#ifdef VBOX_XPDM_MINIPORT
+    VideoPortWritePortUshort((PUSHORT)Port,Value);
+#else
+    ASMOutU16(Port, Value);
+#endif
+}
+
+/** Write a 32-bit value to an I/O port. */
+DECLINLINE(void) VBoxVideoCmnPortWriteUlong(RTIOPORT Port, uint32_t Value)
+{
+#ifdef VBOX_XPDM_MINIPORT
+    VideoPortWritePortUlong((PULONG)Port,Value);
+#else
+    ASMOutU32(Port, Value);
+#endif
+}
+
+/** Read an 8-bit value from an I/O port. */
+DECLINLINE(uint8_t) VBoxVideoCmnPortReadUchar(RTIOPORT Port)
+{
+#ifdef VBOX_XPDM_MINIPORT
+    return VideoPortReadPortUchar((PUCHAR)Port);
+#else
+    return ASMInU8(Port);
+#endif
+}
+
+/** Read a 16-bit value from an I/O port. */
+DECLINLINE(uint16_t) VBoxVideoCmnPortReadUshort(RTIOPORT Port)
+{
+#ifdef VBOX_XPDM_MINIPORT
+    return VideoPortReadPortUshort((PUSHORT)Port);
+#else
+    return ASMInU16(Port);
+#endif
+}
+
+/** Read a 32-bit value from an I/O port. */
+DECLINLINE(uint32_t) VBoxVideoCmnPortReadUlong(RTIOPORT Port)
+{
+#ifdef VBOX_XPDM_MINIPORT
+    return VideoPortReadPortUlong((PULONG)Port);
+#else
+    return ASMInU32(Port);
+#endif
+}
+
+/** @}  */
+
+/** @name Base HGSMI APIs
+ * @{ */
+
+/** Acknowlege an IRQ. */
+DECLINLINE(void) VBoxHGSMIClearIrq(PHGSMIHOSTCOMMANDCONTEXT pCtx)
+{
+    VBoxVideoCmnPortWriteUlong(pCtx->port, HGSMIOFFSET_VOID);
+}
+
+RTDECL(void)     VBoxHGSMIHostCmdComplete(PHGSMIHOSTCOMMANDCONTEXT pCtx,
+                                          void *pvMem);
+RTDECL(void)     VBoxHGSMIProcessHostQueue(PHGSMIHOSTCOMMANDCONTEXT pCtx);
+RTDECL(bool)     VBoxHGSMIIsSupported(void);
+RTDECL(void *)   VBoxHGSMIBufferAlloc(PHGSMIGUESTCOMMANDCONTEXT pCtx,
+                                      HGSMISIZE cbData,
+                                      uint8_t u8Ch,
+                                      uint16_t u16Op);
+RTDECL(void)     VBoxHGSMIBufferFree(PHGSMIGUESTCOMMANDCONTEXT pCtx,
+                                     void *pvBuffer);
+RTDECL(int)      VBoxHGSMIBufferSubmit(PHGSMIGUESTCOMMANDCONTEXT pCtx,
+                                       void *pvBuffer);
+
+typedef struct VBVAINFOVIEW *PVBVAINFOVIEW;
+/**
+ * Callback funtion called from @a VBoxHGSMISendViewInfo to initialise
+ * the @a VBVAINFOVIEW structure for each screen.
+ *
+ * @returns  iprt status code
+ * @param  pvData  context data for the callback, passed to @a
+ *                 VBoxHGSMISendViewInfo along with the callback
+ * @param  pInfo   array of @a VBVAINFOVIEW structures to be filled in
+ * @todo  explicitly pass the array size
+ */
+typedef DECLCALLBACK(int) FNHGSMIFILLVIEWINFO (void *pvData,
+                                               PVBVAINFOVIEW pInfo);
+/** Pointer to a FNHGSMIFILLVIEWINFO callback */
+typedef FNHGSMIFILLVIEWINFO *PFNHGSMIFILLVIEWINFO;
+
+RTDECL(int)      VBoxHGSMISendViewInfo(PHGSMIGUESTCOMMANDCONTEXT pCtx,
+                                       uint32_t u32Count,
+                                       PFNHGSMIFILLVIEWINFO pfnFill,
+                                       void *pvData);
+RTDECL(void)     VBoxHGSMIGetBaseMappingInfo(uint32_t cbVRAM,
+                                             uint32_t *poffVRAMBaseMapping,
+                                             uint32_t *pcbMapping,
+                                             uint32_t *poffGuestHeapMemory,
+                                             uint32_t *pcbGuestHeapMemory,
+                                             uint32_t *poffHostFlags);
+/** @todo we should provide a cleanup function too as part of the API */
+RTDECL(int)      VBoxHGSMISetupGuestContext(PHGSMIGUESTCOMMANDCONTEXT pCtx,
+                                            void *pvGuestHeapMemory,
+                                            uint32_t cbGuestHeapMemory,
+                                            uint32_t offVRAMGuestHeapMemory);
+RTDECL(void)     VBoxHGSMIGetHostAreaMapping(PHGSMIGUESTCOMMANDCONTEXT pCtx,
+                                             uint32_t cbVRAM,
+                                             uint32_t offVRAMBaseMapping,
+                                             uint32_t *poffVRAMHostArea,
+                                             uint32_t *pcbHostArea);
+RTDECL(void)     VBoxHGSMISetupHostContext(PHGSMIHOSTCOMMANDCONTEXT pCtx,
+                                           void *pvBaseMapping,
+                                           uint32_t offHostFlags,
+                                           void *pvHostAreaMapping,
+                                           uint32_t offVRAMHostArea,
+                                           uint32_t cbHostArea);
+RTDECL(int)      VBoxHGSMISendHostCtxInfo(PHGSMIGUESTCOMMANDCONTEXT pCtx,
+                                          HGSMIOFFSET offVRAMFlagsLocation,
+                                          uint32_t fCaps,
+                                          uint32_t offVRAMHostArea,
+                                          uint32_t cbHostArea);
+RTDECL(uint32_t) VBoxHGSMIGetMonitorCount(PHGSMIGUESTCOMMANDCONTEXT pCtx);
+RTDECL(bool)     VBoxHGSMIUpdatePointerShape(PHGSMIGUESTCOMMANDCONTEXT pCtx,
+                                             uint32_t fFlags,
+                                             uint32_t cHotX,
+                                             uint32_t cHotY,
+                                             uint32_t cWidth,
+                                             uint32_t cHeight,
+                                             uint8_t *pPixels,
+                                             uint32_t cbLength);
+
+/** @}  */
+
+RT_C_DECLS_END
 
 #endif /* __HGSMI_GUEST_h__*/