← Back to branch summary

~ubuntu-branches/ubuntu/raring/virtualbox-ose/raring

« back to all changes in this revision

Viewing changes to include/VBox/VBoxUhgsmi.h

  • Committer: Bazaar Package Importer
  • Author(s): Felix Geyer
  • Date: 2011-01-30 23:27:25 UTC
  • mfrom: (0.3.12 upstream)
  • Revision ID: james.westby@ubuntu.com-20110130232725-2ouajjd2ggdet0zd
Tags: 4.0.2-dfsg-1ubuntu1
* Merge from Debian unstable, remaining changes:
  - Add Apport hook.
    - debian/virtualbox-ose.files/source_virtualbox-ose.py
    - debian/virtualbox-ose.install
  - Drop *-source packages.
* Drop ubuntu-01-fix-build-gcc45.patch, fixed upstream.
* Drop ubuntu-02-as-needed.patch, added to the Debian package.

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/VBox/VBoxUhgsmi.h
 
1
/*
 
2
 * Copyright (C) 2010 Oracle Corporation
 
3
 *
 
4
 * This file is part of VirtualBox Open Source Edition (OSE), as
 
5
 * available from http://www.virtualbox.org. This file is free software;
 
6
 * you can redistribute it and/or modify it under the terms of the GNU
 
7
 * General Public License (GPL) as published by the Free Software
 
8
 * Foundation, in version 2 as it comes in the "COPYING" file of the
 
9
 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
 
10
 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
 
11
 *
 
12
 * The contents of this file may alternatively be used under the terms
 
13
 * of the Common Development and Distribution License Version 1.0
 
14
 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
 
15
 * VirtualBox OSE distribution, in which case the provisions of the
 
16
 * CDDL are applicable instead of those of the GPL.
 
17
 *
 
18
 * You may elect to license modified versions of this file under the
 
19
 * terms and conditions of either the GPL or the CDDL or both.
 
20
 */
 
21
#ifndef ___VBoxUhgsmi_h__
 
22
#define ___VBoxUhgsmi_h__
 
23
 
 
24
#include <iprt/cdefs.h>
 
25
#include <iprt/types.h>
 
26
 
 
27
typedef struct VBOXUHGSMI *PVBOXUHGSMI;
 
28
 
 
29
typedef struct VBOXUHGSMI_BUFFER *PVBOXUHGSMI_BUFFER;
 
30
typedef void* HVBOXUHGSMI_SYNCHOBJECT;
 
31
 
 
32
typedef enum
 
33
{
 
34
    VBOXUHGSMI_SYNCHOBJECT_TYPE_NONE = 0,
 
35
    VBOXUHGSMI_SYNCHOBJECT_TYPE_EVENT,
 
36
    VBOXUHGSMI_SYNCHOBJECT_TYPE_SEMAPHORE
 
37
} VBOXUHGSMI_SYNCHOBJECT_TYPE;
 
38
 
 
39
typedef struct VBOXUHGSMI_BUFFER_LOCK_FLAGS
 
40
{
 
41
    union
 
42
    {
 
43
        struct
 
44
        {
 
45
            uint32_t bReadOnly   : 1;
 
46
            uint32_t bWriteOnly  : 1;
 
47
            uint32_t bDonotWait  : 1;
 
48
            uint32_t bDiscard    : 1;
 
49
            uint32_t bLockEntire : 1;
 
50
            uint32_t Reserved    : 27;
 
51
        };
 
52
        uint32_t Value;
 
53
    };
 
54
} VBOXUHGSMI_BUFFER_LOCK_FLAGS;
 
55
 
 
56
typedef struct VBOXUHGSMI_BUFFER_SUBMIT_FLAGS
 
57
{
 
58
    union
 
59
    {
 
60
        struct
 
61
        {
 
62
            uint32_t bHostReadOnly          : 1;
 
63
            uint32_t bHostWriteOnly         : 1;
 
64
            uint32_t bDoNotRetire           : 1; /* <- the buffer will be uset in a subsequent command */
 
65
            uint32_t bDoNotSignalCompletion : 1; /* <- do not signal notification object on completion for this alloc */
 
66
            uint32_t bEntireBuffer          : 1;
 
67
            uint32_t Reserved               : 27;
 
68
        };
 
69
        uint32_t Value;
 
70
    };
 
71
} VBOXUHGSMI_BUFFER_SUBMIT_FLAGS, *PVBOXUHGSMI_BUFFER_SUBMIT_FLAGS;
 
72
 
 
73
/* the caller can specify NULL as a hSynch and specify a valid enmSynchType to make UHGSMI create a proper object itself,
 
74
 *  */
 
75
typedef DECLCALLBACK(int) FNVBOXUHGSMI_BUFFER_CREATE(PVBOXUHGSMI pHgsmi, uint32_t cbBuf,
 
76
        VBOXUHGSMI_SYNCHOBJECT_TYPE enmSynchType, HVBOXUHGSMI_SYNCHOBJECT hSynch,
 
77
        PVBOXUHGSMI_BUFFER* ppBuf);
 
78
typedef FNVBOXUHGSMI_BUFFER_CREATE *PFNVBOXUHGSMI_BUFFER_CREATE;
 
79
 
 
80
typedef struct VBOXUHGSMI_BUFFER_SUBMIT
 
81
{
 
82
    PVBOXUHGSMI_BUFFER pBuf;
 
83
    uint32_t offData;
 
84
    uint32_t cbData;
 
85
    VBOXUHGSMI_BUFFER_SUBMIT_FLAGS fFlags;
 
86
} VBOXUHGSMI_BUFFER_SUBMIT, *PVBOXUHGSMI_BUFFER_SUBMIT;
 
87
 
 
88
typedef DECLCALLBACK(int) FNVBOXUHGSMI_BUFFER_SUBMIT_ASYNCH(PVBOXUHGSMI pHgsmi, PVBOXUHGSMI_BUFFER_SUBMIT aBuffers, uint32_t cBuffers);
 
89
typedef FNVBOXUHGSMI_BUFFER_SUBMIT_ASYNCH *PFNVBOXUHGSMI_BUFFER_SUBMIT_ASYNCH;
 
90
 
 
91
typedef DECLCALLBACK(int) FNVBOXUHGSMI_BUFFER_DESTROY(PVBOXUHGSMI_BUFFER pBuf);
 
92
typedef FNVBOXUHGSMI_BUFFER_DESTROY *PFNVBOXUHGSMI_BUFFER_DESTROY;
 
93
 
 
94
typedef DECLCALLBACK(int) FNVBOXUHGSMI_BUFFER_LOCK(PVBOXUHGSMI_BUFFER pBuf, uint32_t offLock, uint32_t cbLock, VBOXUHGSMI_BUFFER_LOCK_FLAGS fFlags, void**pvLock);
 
95
typedef FNVBOXUHGSMI_BUFFER_LOCK *PFNVBOXUHGSMI_BUFFER_LOCK;
 
96
 
 
97
typedef DECLCALLBACK(int) FNVBOXUHGSMI_BUFFER_UNLOCK(PVBOXUHGSMI_BUFFER pBuf);
 
98
typedef FNVBOXUHGSMI_BUFFER_UNLOCK *PFNVBOXUHGSMI_BUFFER_UNLOCK;
 
99
 
 
100
typedef struct VBOXUHGSMI
 
101
{
 
102
    PFNVBOXUHGSMI_BUFFER_CREATE pfnBufferCreate;
 
103
    PFNVBOXUHGSMI_BUFFER_SUBMIT_ASYNCH pfnBufferSubmitAsynch;
 
104
    /* user custom data */
 
105
    void *pvUserData;
 
106
} VBOXUHGSMI, *PVBOXUHGSMI;
 
107
 
 
108
typedef struct VBOXUHGSMI_BUFFER
 
109
{
 
110
    PFNVBOXUHGSMI_BUFFER_LOCK pfnLock;
 
111
    PFNVBOXUHGSMI_BUFFER_UNLOCK pfnUnlock;
 
112
    PFNVBOXUHGSMI_BUFFER_DESTROY pfnDestroy;
 
113
 
 
114
    /* r/o data added for ease of access and simplicity
 
115
     * modifying it leads to unpredictable behavior */
 
116
    HVBOXUHGSMI_SYNCHOBJECT hSynch;
 
117
    VBOXUHGSMI_SYNCHOBJECT_TYPE enmSynchType;
 
118
    uint32_t cbBuffer;
 
119
    bool bSynchCreated;
 
120
    /* user custom data */
 
121
    void *pvUserData;
 
122
} VBOXUHGSMI_BUFFER, *PVBOXUHGSMI_BUFFER;
 
123
 
 
124
#endif /* #ifndef ___VBoxUhgsmi_h__ */