VirtualBox

source: vbox/trunk/include/VBox/VBoxUhgsmi.h@ 64622

Last change on this file since 64622 was 62476, checked in by vboxsync, 8 years ago

(C) 2016

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.7 KB
Line 
1/** @file
2 * Document me, pretty please.
3 */
4
5/*
6 * Copyright (C) 2010-2016 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___VBox_VBoxUhgsmi_h
27#define ___VBox_VBoxUhgsmi_h
28
29#include <iprt/cdefs.h>
30#include <iprt/types.h>
31
32typedef struct VBOXUHGSMI *PVBOXUHGSMI;
33
34typedef struct VBOXUHGSMI_BUFFER *PVBOXUHGSMI_BUFFER;
35
36typedef struct VBOXUHGSMI_BUFFER_TYPE_FLAGS
37{
38 union
39 {
40 struct
41 {
42 uint32_t fCommand : 1;
43 uint32_t Reserved : 31;
44 };
45 uint32_t Value;
46 };
47} VBOXUHGSMI_BUFFER_TYPE_FLAGS;
48
49typedef struct VBOXUHGSMI_BUFFER_LOCK_FLAGS
50{
51 union
52 {
53 struct
54 {
55 uint32_t bReadOnly : 1;
56 uint32_t bWriteOnly : 1;
57 uint32_t bDonotWait : 1;
58 uint32_t bDiscard : 1;
59 uint32_t bLockEntire : 1;
60 uint32_t Reserved : 27;
61 };
62 uint32_t Value;
63 };
64} VBOXUHGSMI_BUFFER_LOCK_FLAGS;
65
66typedef struct VBOXUHGSMI_BUFFER_SUBMIT_FLAGS
67{
68 union
69 {
70 struct
71 {
72 uint32_t bHostReadOnly : 1;
73 uint32_t bHostWriteOnly : 1;
74 uint32_t bDoNotRetire : 1; /**< the buffer will be used in a subsequent command */
75 uint32_t bEntireBuffer : 1;
76 uint32_t Reserved : 28;
77 };
78 uint32_t Value;
79 };
80} VBOXUHGSMI_BUFFER_SUBMIT_FLAGS, *PVBOXUHGSMI_BUFFER_SUBMIT_FLAGS;
81
82/* the caller can specify NULL as a hSynch and specify a valid enmSynchType to make UHGSMI create a proper object itself,
83 * */
84typedef DECLCALLBACK(int) FNVBOXUHGSMI_BUFFER_CREATE(PVBOXUHGSMI pHgsmi, uint32_t cbBuf, VBOXUHGSMI_BUFFER_TYPE_FLAGS fType, PVBOXUHGSMI_BUFFER* ppBuf);
85typedef FNVBOXUHGSMI_BUFFER_CREATE *PFNVBOXUHGSMI_BUFFER_CREATE;
86
87typedef struct VBOXUHGSMI_BUFFER_SUBMIT
88{
89 PVBOXUHGSMI_BUFFER pBuf;
90 uint32_t offData;
91 uint32_t cbData;
92 VBOXUHGSMI_BUFFER_SUBMIT_FLAGS fFlags;
93} VBOXUHGSMI_BUFFER_SUBMIT, *PVBOXUHGSMI_BUFFER_SUBMIT;
94
95typedef DECLCALLBACK(int) FNVBOXUHGSMI_BUFFER_SUBMIT(PVBOXUHGSMI pHgsmi, PVBOXUHGSMI_BUFFER_SUBMIT aBuffers, uint32_t cBuffers);
96typedef FNVBOXUHGSMI_BUFFER_SUBMIT *PFNVBOXUHGSMI_BUFFER_SUBMIT;
97
98typedef DECLCALLBACK(int) FNVBOXUHGSMI_BUFFER_DESTROY(PVBOXUHGSMI_BUFFER pBuf);
99typedef FNVBOXUHGSMI_BUFFER_DESTROY *PFNVBOXUHGSMI_BUFFER_DESTROY;
100
101typedef DECLCALLBACK(int) FNVBOXUHGSMI_BUFFER_LOCK(PVBOXUHGSMI_BUFFER pBuf, uint32_t offLock, uint32_t cbLock, VBOXUHGSMI_BUFFER_LOCK_FLAGS fFlags, void**pvLock);
102typedef FNVBOXUHGSMI_BUFFER_LOCK *PFNVBOXUHGSMI_BUFFER_LOCK;
103
104typedef DECLCALLBACK(int) FNVBOXUHGSMI_BUFFER_UNLOCK(PVBOXUHGSMI_BUFFER pBuf);
105typedef FNVBOXUHGSMI_BUFFER_UNLOCK *PFNVBOXUHGSMI_BUFFER_UNLOCK;
106
107typedef struct VBOXUHGSMI
108{
109 PFNVBOXUHGSMI_BUFFER_CREATE pfnBufferCreate;
110 PFNVBOXUHGSMI_BUFFER_SUBMIT pfnBufferSubmit;
111 /** User custom data. */
112 void *pvUserData;
113} VBOXUHGSMI;
114
115typedef struct VBOXUHGSMI_BUFFER
116{
117 PFNVBOXUHGSMI_BUFFER_LOCK pfnLock;
118 PFNVBOXUHGSMI_BUFFER_UNLOCK pfnUnlock;
119 PFNVBOXUHGSMI_BUFFER_DESTROY pfnDestroy;
120
121 /* r/o data added for ease of access and simplicity
122 * modifying it leads to unpredictable behavior */
123 VBOXUHGSMI_BUFFER_TYPE_FLAGS fType;
124 uint32_t cbBuffer;
125 /** User custom data. */
126 void *pvUserData;
127} VBOXUHGSMI_BUFFER;
128
129#define VBoxUhgsmiBufferCreate(_pUhgsmi, _cbBuf, _fType, _ppBuf) ((_pUhgsmi)->pfnBufferCreate(_pUhgsmi, _cbBuf, _fType, _ppBuf))
130#define VBoxUhgsmiBufferSubmit(_pUhgsmi, _aBuffers, _cBuffers) ((_pUhgsmi)->pfnBufferSubmit(_pUhgsmi, _aBuffers, _cBuffers))
131
132#define VBoxUhgsmiBufferLock(_pBuf, _offLock, _cbLock, _fFlags, _pvLock) ((_pBuf)->pfnLock(_pBuf, _offLock, _cbLock, _fFlags, _pvLock))
133#define VBoxUhgsmiBufferUnlock(_pBuf) ((_pBuf)->pfnUnlock(_pBuf))
134#define VBoxUhgsmiBufferDestroy(_pBuf) ((_pBuf)->pfnDestroy(_pBuf))
135
136#endif
137
Note: See TracBrowser for help on using the repository browser.

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