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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
/* $Id: VBoxUsbPnP.cpp $ */
/** @file
* USB PnP Handling
*/
/*
* Copyright (C) 2011-2023 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
*/
#include "VBoxUsbCmn.h"
static NTSTATUS vboxUsbPnPMnStartDevice(PVBOXUSBDEV_EXT pDevExt, PIRP pIrp)
{
IoCopyCurrentIrpStackLocationToNext(pIrp);
NTSTATUS Status = VBoxDrvToolIoPostSync(pDevExt->pLowerDO, pIrp);
Assert(NT_SUCCESS(Status) || Status == STATUS_NOT_SUPPORTED);
if (NT_SUCCESS(Status))
{
Status = vboxUsbRtStart(pDevExt);
Assert(Status == STATUS_SUCCESS);
if (NT_SUCCESS(Status))
{
vboxUsbPnPStateSet(pDevExt, ENMVBOXUSB_PNPSTATE_STARTED);
}
}
VBoxDrvToolIoComplete(pIrp, Status, 0);
vboxUsbDdiStateRelease(pDevExt);
return Status;
}
static NTSTATUS vboxUsbPnPMnQueryStopDevice(PVBOXUSBDEV_EXT pDevExt, PIRP pIrp)
{
vboxUsbPnPStateSet(pDevExt, ENMVBOXUSB_PNPSTATE_STOP_PENDING);
vboxUsbDdiStateReleaseAndWaitCompleted(pDevExt);
pIrp->IoStatus.Status = STATUS_SUCCESS;
pIrp->IoStatus.Information = 0;
IoSkipCurrentIrpStackLocation(pIrp);
return IoCallDriver(pDevExt->pLowerDO, pIrp);
}
static NTSTATUS vboxUsbPnPMnStopDevice(PVBOXUSBDEV_EXT pDevExt, PIRP pIrp)
{
vboxUsbPnPStateSet(pDevExt, ENMVBOXUSB_PNPSTATE_STOPPED);
vboxUsbRtClear(pDevExt);
NTSTATUS Status = VBoxUsbToolDevUnconfigure(pDevExt->pLowerDO);
Assert(NT_SUCCESS(Status));
pIrp->IoStatus.Status = Status;
pIrp->IoStatus.Information = 0;
IoSkipCurrentIrpStackLocation(pIrp);
Status = IoCallDriver(pDevExt->pLowerDO, pIrp);
vboxUsbDdiStateRelease(pDevExt);
return Status;
}
static NTSTATUS vboxUsbPnPMnCancelStopDevice(PVBOXUSBDEV_EXT pDevExt, PIRP pIrp)
{
ENMVBOXUSB_PNPSTATE enmState = vboxUsbPnPStateGet(pDevExt);
NTSTATUS Status = STATUS_SUCCESS;
IoCopyCurrentIrpStackLocationToNext(pIrp);
Status = VBoxDrvToolIoPostSync(pDevExt->pLowerDO, pIrp);
if (NT_SUCCESS(Status) && enmState == ENMVBOXUSB_PNPSTATE_STOP_PENDING)
{
vboxUsbPnPStateRestore(pDevExt);
}
Status = STATUS_SUCCESS;
VBoxDrvToolIoComplete(pIrp, Status, 0);
vboxUsbDdiStateRelease(pDevExt);
return Status;
}
static NTSTATUS vboxUsbPnPMnQueryRemoveDevice(PVBOXUSBDEV_EXT pDevExt, PIRP pIrp)
{
vboxUsbPnPStateSet(pDevExt, ENMVBOXUSB_PNPSTATE_REMOVE_PENDING);
vboxUsbDdiStateReleaseAndWaitCompleted(pDevExt);
pIrp->IoStatus.Status = STATUS_SUCCESS;
pIrp->IoStatus.Information = 0;
IoSkipCurrentIrpStackLocation(pIrp);
return IoCallDriver(pDevExt->pLowerDO, pIrp);
}
static NTSTATUS vboxUsbPnPRmDev(PVBOXUSBDEV_EXT pDevExt)
{
NTSTATUS Status = vboxUsbRtRm(pDevExt);
Assert(Status == STATUS_SUCCESS);
return Status;
}
static NTSTATUS vboxUsbPnPMnRemoveDevice(PVBOXUSBDEV_EXT pDevExt, PIRP pIrp)
{
ENMVBOXUSB_PNPSTATE enmState = vboxUsbPnPStateGet(pDevExt);
NTSTATUS Status = STATUS_SUCCESS;
if (enmState != ENMVBOXUSB_PNPSTATE_SURPRISE_REMOVED)
{
Status = vboxUsbPnPRmDev(pDevExt);
Assert(Status == STATUS_SUCCESS);
}
vboxUsbPnPStateSet(pDevExt, ENMVBOXUSB_PNPSTATE_REMOVED);
vboxUsbDdiStateRelease(pDevExt);
vboxUsbDdiStateReleaseAndWaitRemoved(pDevExt);
vboxUsbRtClear(pDevExt);
pIrp->IoStatus.Status = STATUS_SUCCESS;
pIrp->IoStatus.Information = 0;
IoSkipCurrentIrpStackLocation(pIrp);
Status = IoCallDriver(pDevExt->pLowerDO, pIrp);
IoDetachDevice(pDevExt->pLowerDO);
IoDeleteDevice(pDevExt->pFDO);
return Status;
}
static NTSTATUS vboxUsbPnPMnCancelRemoveDevice(PVBOXUSBDEV_EXT pDevExt, PIRP pIrp)
{
ENMVBOXUSB_PNPSTATE enmState = vboxUsbPnPStateGet(pDevExt);
NTSTATUS Status = STATUS_SUCCESS;
IoCopyCurrentIrpStackLocationToNext(pIrp);
Status = VBoxDrvToolIoPostSync(pDevExt->pLowerDO, pIrp);
if (NT_SUCCESS(Status) &&
enmState == ENMVBOXUSB_PNPSTATE_REMOVE_PENDING)
{
vboxUsbPnPStateRestore(pDevExt);
}
Status = STATUS_SUCCESS;
VBoxDrvToolIoComplete(pIrp, Status, 0);
vboxUsbDdiStateRelease(pDevExt);
return Status;
}
static NTSTATUS vboxUsbPnPMnSurpriseRemoval(PVBOXUSBDEV_EXT pDevExt, PIRP pIrp)
{
vboxUsbPnPStateSet(pDevExt, ENMVBOXUSB_PNPSTATE_SURPRISE_REMOVED);
NTSTATUS Status = vboxUsbPnPRmDev(pDevExt);
Assert(Status == STATUS_SUCCESS);
pIrp->IoStatus.Status = STATUS_SUCCESS;
pIrp->IoStatus.Information = 0;
IoSkipCurrentIrpStackLocation(pIrp);
Status = IoCallDriver(pDevExt->pLowerDO, pIrp);
vboxUsbDdiStateRelease(pDevExt);
return Status;
}
static NTSTATUS vboxUsbPnPMnQueryCapabilities(PVBOXUSBDEV_EXT pDevExt, PIRP pIrp)
{
PIO_STACK_LOCATION pSl = IoGetCurrentIrpStackLocation(pIrp);
PDEVICE_CAPABILITIES pDevCaps = pSl->Parameters.DeviceCapabilities.Capabilities;
if (pDevCaps->Version < 1 || pDevCaps->Size < sizeof (*pDevCaps))
{
AssertFailed();
/** @todo return more appropriate status ?? */
return STATUS_UNSUCCESSFUL;
}
pDevCaps->SurpriseRemovalOK = TRUE;
pIrp->IoStatus.Status = STATUS_SUCCESS;
IoCopyCurrentIrpStackLocationToNext(pIrp);
NTSTATUS Status = VBoxDrvToolIoPostSync(pDevExt->pLowerDO, pIrp);
Assert(NT_SUCCESS(Status));
if (NT_SUCCESS(Status))
{
pDevCaps->SurpriseRemovalOK = 1;
pDevExt->DdiState.DevCaps = *pDevCaps;
}
VBoxDrvToolIoComplete(pIrp, Status, 0);
vboxUsbDdiStateRelease(pDevExt);
return Status;
}
static NTSTATUS vboxUsbPnPMnDefault(PVBOXUSBDEV_EXT pDevExt, PIRP pIrp)
{
NTSTATUS Status;
IoSkipCurrentIrpStackLocation(pIrp);
Status = IoCallDriver(pDevExt->pLowerDO, pIrp);
vboxUsbDdiStateRelease(pDevExt);
return Status;
}
DECLHIDDEN(NTSTATUS) vboxUsbDispatchPnP(IN PDEVICE_OBJECT pDeviceObject, IN PIRP pIrp)
{
PVBOXUSBDEV_EXT pDevExt = (PVBOXUSBDEV_EXT)pDeviceObject->DeviceExtension;
if (!vboxUsbDdiStateRetainIfNotRemoved(pDevExt))
return VBoxDrvToolIoComplete(pIrp, STATUS_DELETE_PENDING, 0);
PIO_STACK_LOCATION pSl = IoGetCurrentIrpStackLocation(pIrp);
switch (pSl->MinorFunction)
{
case IRP_MN_START_DEVICE:
return vboxUsbPnPMnStartDevice(pDevExt, pIrp);
case IRP_MN_QUERY_STOP_DEVICE:
return vboxUsbPnPMnQueryStopDevice(pDevExt, pIrp);
case IRP_MN_STOP_DEVICE:
return vboxUsbPnPMnStopDevice(pDevExt, pIrp);
case IRP_MN_CANCEL_STOP_DEVICE:
return vboxUsbPnPMnCancelStopDevice(pDevExt, pIrp);
case IRP_MN_QUERY_REMOVE_DEVICE:
return vboxUsbPnPMnQueryRemoveDevice(pDevExt, pIrp);
case IRP_MN_REMOVE_DEVICE:
return vboxUsbPnPMnRemoveDevice(pDevExt, pIrp);
case IRP_MN_CANCEL_REMOVE_DEVICE:
return vboxUsbPnPMnCancelRemoveDevice(pDevExt, pIrp);
case IRP_MN_SURPRISE_REMOVAL:
return vboxUsbPnPMnSurpriseRemoval(pDevExt, pIrp);
case IRP_MN_QUERY_CAPABILITIES:
return vboxUsbPnPMnQueryCapabilities(pDevExt, pIrp);
default:
return vboxUsbPnPMnDefault(pDevExt, pIrp);
}
}
|
