1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
/* $Id: VBoxWinDrvDefs.h $ */
/** @file
* VBoxWinDrvDefs - Common definitions for Windows driver installation functions.
*/
/*
* Copyright (C) 2024-2025 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef VBOX_INCLUDED_GuestHost_VBoxWinDrvDefs_h
#define VBOX_INCLUDED_GuestHost_VBoxWinDrvDefs_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <iprt/list.h>
#include <iprt/path.h>
#include <iprt/utf16.h>
/** If not defined explicitly, use the given / current target architecture.
* Note! Do *not* change the casing here, as this will be used for string comparison. */
#ifndef VBOXWINDRVINF_NATIVE_ARCH_STR /* For cross testing and testcases. */
# if defined(RT_ARCH_AMD64)
# define VBOXWINDRVINF_NATIVE_ARCH_STR "AMD64"
# elif defined(RT_ARCH_X86)
# define VBOXWINDRVINF_NATIVE_ARCH_STR "X86"
# elif defined(RT_ARCH_ARM64)
# define VBOXWINDRVINF_NATIVE_ARCH_STR "ARM64"
# else
# error "Port me!"
# endif
#endif
/** Defines a string which emits the decoration separator. */
#define VBOXWINDRVINF_DECORATION_SEP_STR "."
/** Defines a string which emits the decoration separator (UTF-16 version). */
#define VBOXWINDRVINF_DECORATION_SEP_UTF16_STR L"."
/** Defines a string which emits the bulld target's native architeture, e.g. "NTAMD64".
* Note! Do *not* change the casing here, as this will be used for string comparison. */
#define VBOXWINDRVINF_NT_NATIVE_ARCH_STR "NT" VBOXWINDRVINF_NATIVE_ARCH_STR
/** Defines a string which emits the bulld target's native architeture, e.g. ".NTAMD64". */
#define VBOXWINDRVINF_DOT_NT_NATIVE_ARCH_STR VBOXWINDRVINF_DECORATION_SEP_STR VBOXWINDRVINF_NT_NATIVE_ARCH_STR
/** Maximum INF catalog file (.cat) length (in characters). */
#define VBOXWINDRVINF_MAX_CATALOG_FILE_LEN 255
/** Maximum INF driver version length (in characters). */
#define VBOXWINDRVINF_MAX_DRIVER_VER_LEN 255
/** Maximum INF provider name length (in characters). */
#define VBOXWINDRVINF_MAX_PROVIDER_NAME_LEN 255
/** Maximum INF section name length (in characters). */
#define VBOXWINDRVINF_MAX_SECTION_NAME_LEN 255
/** Maximum INF model name length (in characters). */
#define VBOXWINDRVINF_MAX_MODEL_NAME_LEN 255
/** Maximum INF PnP ID length (in characters). */
#define VBOXWINDRVINF_MAX_PNP_ID_LEN 255
/**
* Enumeration specifying the INF (driver) type.
*/
typedef enum VBOXWINDRVINFTYPE
{
/** Invalid type. */
VBOXWINDRVINFTYPE_INVALID = 0,
/** Primitive driver.
* This uses a "DefaultInstall" (plus optionally "DefaultUninstall") sections
* and does not have a PnP ID. */
VBOXWINDRVINFTYPE_PRIMITIVE,
/** Normal driver.
* Uses a "Manufacturer" section and can have a PnP ID. */
VBOXWINDRVINFTYPE_NORMAL
} VBOXWINDRVINFTYPE;
/**
* Structure for keeping determined (or set) INF parameters
* required for driver (un)installation.
*/
typedef struct VBOXWINDRVINFPARMS
{
/** Model including decoration (e.g. "VBoxUSB.NTAMD64"); optional and might be NULL.
* For primitive drivers this always is NULL. */
PRTUTF16 pwszModel;
/** Hardware (Pnp) ID; optional and might be NULL.
* For primitive drivers this always is NULL. */
PRTUTF16 pwszPnpId;
/** Name of section to (un)install.
* This marks the main section (entry point) of the specific driver model to handle. */
PRTUTF16 pwszSection;
} VBOXWINDRVINFPARMS;
/** Pointer to a atructure for keeping determined (or set) INF parameters
* required for driver (un)installation.*/
typedef VBOXWINDRVINFPARMS *PVBOXWINDRVINFPARMS;
/**
* Structure for keeping INF Version section information.
*/
typedef struct VBOXWINDRVINFSECVERSION
{
/** Catalog (.cat) file. */
RTUTF16 wszCatalogFile[VBOXWINDRVINF_MAX_CATALOG_FILE_LEN];
/** Driver version. */
RTUTF16 wszDriverVer[VBOXWINDRVINF_MAX_DRIVER_VER_LEN];
/** Provider name. */
RTUTF16 wszProvider[VBOXWINDRVINF_MAX_PROVIDER_NAME_LEN];
} VBOXWINDRVINFSECVERSION;
/** Pointer to structure for keeping INF Version section information. */
typedef VBOXWINDRVINFSECVERSION *PVBOXWINDRVINFSECVERSION;
/**
* Enumeration for specifying an INF file list entry type.
*/
typedef enum
{
/** No / invalid type. */
VBOXWINDRVINFLISTENTRY_T_NONE = 0,
/** List entry is of type VBOXWINDRVINFLISTENTRY_COPYFILE. */
VBOXWINDRVINFLISTENTRY_T_COPYFILE
} VBOXWINDRVINFLISTENTRY_T;
/**
* Structure for keeping a single FileCopy file entry.
*/
typedef struct VBOXWINDRVINFLISTENTRY_COPYFILE
{
RTLISTNODE Node;
/** Absolute path to the file on the system. */
RTUTF16 wszFilePath[RTPATH_MAX];
} VBOXWINDRVINFLISTENTRY_COPYFILE;
/** Pointer to a structure for keeping a single FileCopy file entry. */
typedef VBOXWINDRVINFLISTENTRY_COPYFILE *PVBOXWINDRVINFLISTENTRY_COPYFILE;
/**
* Structure for keeping a list of one type of VBOXWINDRVINFLISTENTRY_XXX entries.
*/
typedef struct VBOXWINDRVINFLIST
{
/** List of VBOXWINDRVINFLISTENTRY_XXX entries. */
RTLISTANCHOR List;
/** Number of current entries of type VBOXWINDRVINFLISTENTRY_T_XXX. */
unsigned cEntries;
/** Type of entries this list contains. */
VBOXWINDRVINFLISTENTRY_T enmType;
} VBOXWINDRVINFLIST;
/** Pointer to a structure for keeping a list of FileCopy file entries.*/
typedef VBOXWINDRVINFLIST *PVBOXWINDRVINFLIST;
#endif /* !VBOX_INCLUDED_GuestHost_VBoxWinDrvDefs_h */
|
