VirtualBox

source: vbox/trunk/include/VBox/usblib-win.h

Last change on this file was 98103, checked in by vboxsync, 16 months ago

Copyright year updates by scm.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.3 KB
Line 
1/** @file
2 * USBLib - Library for wrapping up the VBoxUSB functionality, Windows flavor.
3 * (DEV,HDrv,Main)
4 */
5
6/*
7 * Copyright (C) 2006-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * The contents of this file may alternatively be used under the terms
26 * of the Common Development and Distribution License Version 1.0
27 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
28 * in the VirtualBox distribution, in which case the provisions of the
29 * CDDL are applicable instead of those of the GPL.
30 *
31 * You may elect to license modified versions of this file under the
32 * terms and conditions of either the GPL or the CDDL or both.
33 *
34 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
35 */
36
37#ifndef VBOX_INCLUDED_usblib_win_h
38#define VBOX_INCLUDED_usblib_win_h
39#ifndef RT_WITHOUT_PRAGMA_ONCE
40# pragma once
41#endif
42
43#include <VBox/cdefs.h>
44#include <VBox/types.h>
45#include <VBox/usb.h>
46
47#include <initguid.h>
48
49
50/** @defgroup grp_usblib_win Windows USB Specifics
51 * @ingroup grp_usblib
52 * @{
53 */
54
55// {6068EB61-98E7-4c98-9E20-1F068295909A}
56DEFINE_GUID(GUID_CLASS_VBOXUSB, 0x873fdf, 0xCAFE, 0x80EE, 0xaa, 0x5e, 0x0, 0xc0, 0x4f, 0xb1, 0x72, 0xb);
57
58#define USBFLT_SERVICE_NAME "\\\\.\\VBoxUSBFlt"
59#define USBFLT_NTDEVICE_NAME_STRING L"\\Device\\VBoxUSBFlt"
60#define USBFLT_SYMBOLIC_NAME_STRING L"\\DosDevices\\VBoxUSBFlt"
61
62#define USBMON_SERVICE_NAME_W L"VBoxUSBMon"
63#define USBMON_DEVICE_NAME "\\\\.\\VBoxUSBMon"
64#define USBMON_DEVICE_NAME_NT L"\\Device\\VBoxUSBMon"
65#define USBMON_DEVICE_NAME_DOS L"\\DosDevices\\VBoxUSBMon"
66
67/*
68 * IOCtl numbers.
69 * We're using the Win32 type of numbers here, thus the macros below.
70 */
71
72#ifndef CTL_CODE
73# if defined(RT_OS_WINDOWS)
74# define CTL_CODE(DeviceType, Function, Method, Access) \
75 ( ((DeviceType) << 16) | ((Access) << 14) | ((Function) << 2) | (Method))
76#else /* unix: */
77# define CTL_CODE(DeviceType, Function, Method_ignored, Access_ignored) \
78 ( (3 << 30) | ((DeviceType) << 8) | (Function) | (sizeof(SUPDRVIOCTLDATA) << 16) )
79# endif
80#endif
81#ifndef METHOD_BUFFERED
82# define METHOD_BUFFERED 0
83#endif
84#ifndef FILE_WRITE_ACCESS
85# define FILE_WRITE_ACCESS 0x0002
86#endif
87#ifndef FILE_DEVICE_UNKNOWN
88# define FILE_DEVICE_UNKNOWN 0x00000022
89#endif
90
91#define USBMON_MAJOR_VERSION 5
92#define USBMON_MINOR_VERSION 0
93
94#define USBDRV_MAJOR_VERSION 5
95#define USBDRV_MINOR_VERSION 0
96
97#define SUPUSB_IOCTL_TEST CTL_CODE(FILE_DEVICE_UNKNOWN, 0x601, METHOD_BUFFERED, FILE_WRITE_ACCESS)
98#define SUPUSB_IOCTL_GET_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x603, METHOD_BUFFERED, FILE_WRITE_ACCESS)
99#define SUPUSB_IOCTL_SEND_URB CTL_CODE(FILE_DEVICE_UNKNOWN, 0x607, METHOD_BUFFERED, FILE_WRITE_ACCESS)
100#define SUPUSB_IOCTL_USB_RESET CTL_CODE(FILE_DEVICE_UNKNOWN, 0x608, METHOD_BUFFERED, FILE_WRITE_ACCESS)
101#define SUPUSB_IOCTL_USB_SELECT_INTERFACE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x609, METHOD_BUFFERED, FILE_WRITE_ACCESS)
102#define SUPUSB_IOCTL_USB_SET_CONFIG CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60A, METHOD_BUFFERED, FILE_WRITE_ACCESS)
103#define SUPUSB_IOCTL_USB_CLAIM_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60B, METHOD_BUFFERED, FILE_WRITE_ACCESS)
104#define SUPUSB_IOCTL_USB_RELEASE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60C, METHOD_BUFFERED, FILE_WRITE_ACCESS)
105#define SUPUSB_IOCTL_IS_OPERATIONAL CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60D, METHOD_BUFFERED, FILE_WRITE_ACCESS)
106#define SUPUSB_IOCTL_USB_CLEAR_ENDPOINT CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60E, METHOD_BUFFERED, FILE_WRITE_ACCESS)
107#define SUPUSB_IOCTL_GET_VERSION CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60F, METHOD_BUFFERED, FILE_WRITE_ACCESS)
108#define SUPUSB_IOCTL_USB_ABORT_ENDPOINT CTL_CODE(FILE_DEVICE_UNKNOWN, 0x610, METHOD_BUFFERED, FILE_WRITE_ACCESS)
109
110#define SUPUSBFLT_IOCTL_GET_NUM_DEVICES CTL_CODE(FILE_DEVICE_UNKNOWN, 0x602, METHOD_BUFFERED, FILE_WRITE_ACCESS)
111#define SUPUSBFLT_IOCTL_USB_CHANGE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x604, METHOD_BUFFERED, FILE_WRITE_ACCESS)
112#define SUPUSBFLT_IOCTL_DISABLE_CAPTURE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x605, METHOD_BUFFERED, FILE_WRITE_ACCESS)
113#define SUPUSBFLT_IOCTL_ENABLE_CAPTURE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x606, METHOD_BUFFERED, FILE_WRITE_ACCESS)
114#define SUPUSBFLT_IOCTL_IGNORE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60F, METHOD_BUFFERED, FILE_WRITE_ACCESS)
115#define SUPUSBFLT_IOCTL_GET_VERSION CTL_CODE(FILE_DEVICE_UNKNOWN, 0x610, METHOD_BUFFERED, FILE_WRITE_ACCESS)
116#define SUPUSBFLT_IOCTL_ADD_FILTER CTL_CODE(FILE_DEVICE_UNKNOWN, 0x611, METHOD_BUFFERED, FILE_WRITE_ACCESS)
117#define SUPUSBFLT_IOCTL_REMOVE_FILTER CTL_CODE(FILE_DEVICE_UNKNOWN, 0x612, METHOD_BUFFERED, FILE_WRITE_ACCESS)
118#define SUPUSBFLT_IOCTL_CAPTURE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x613, METHOD_BUFFERED, FILE_WRITE_ACCESS)
119#define SUPUSBFLT_IOCTL_RELEASE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x614, METHOD_BUFFERED, FILE_WRITE_ACCESS)
120#define SUPUSBFLT_IOCTL_RUN_FILTERS CTL_CODE(FILE_DEVICE_UNKNOWN, 0x615, METHOD_BUFFERED, FILE_WRITE_ACCESS)
121/* Used to be SUPUSBFLT_IOCTL_SET_NOTIFY_EVENT, 0x616 */
122#define SUPUSBFLT_IOCTL_GET_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x617, METHOD_BUFFERED, FILE_WRITE_ACCESS)
123
124#pragma pack(4)
125
126#define MAX_FILTER_NAME 128
127#define MAX_USB_SERIAL_STRING 64
128
129/* a user-mode handle that could be used for retriving device information
130 * from the monitor driver */
131typedef void* HVBOXUSBDEVUSR;
132
133typedef struct
134{
135 HVBOXUSBDEVUSR hDevice;
136} USBSUP_GETDEV, *PUSBSUP_GETDEV;
137
138typedef struct
139{
140 USBDEVICESTATE enmState;
141} USBSUP_GETDEV_MON, *PUSBSUP_GETDEV_MON;
142
143typedef struct
144{
145 uint32_t u32Major;
146 uint32_t u32Minor;
147} USBSUP_VERSION, *PUSBSUP_VERSION;
148
149
150typedef struct USBSUP_FLTADDOUT
151{
152 uintptr_t uId; /* The ID. */
153 int rc; /* The return code. */
154} USBSUP_FLTADDOUT, *PUSBSUP_FLTADDOUT;
155
156typedef struct
157{
158 uint16_t usVendorId;
159 uint16_t usProductId;
160 uint16_t usRevision;
161} USBSUP_CAPTURE, *PUSBSUP_CAPTURE;
162
163typedef USBSUP_CAPTURE USBSUP_RELEASE;
164typedef PUSBSUP_CAPTURE PUSBSUP_RELEASE;
165
166typedef struct
167{
168 uint8_t bInterfaceNumber;
169 uint8_t fClaimed;
170} USBSUP_CLAIMDEV, *PUSBSUP_CLAIMDEV;
171
172typedef USBSUP_CLAIMDEV USBSUP_RELEASEDEV;
173typedef PUSBSUP_CLAIMDEV PUSBSUP_RELEASEDEV;
174
175typedef struct
176{
177 uint32_t cUSBDevices;
178} USBSUP_GETNUMDEV, *PUSBSUP_GETNUMDEV;
179
180typedef struct
181{
182 uint8_t fUSBChange;
183 uint32_t cUSBStateChange;
184} USBSUP_USB_CHANGE, *PUSBSUP_USB_CHANGE;
185
186typedef struct
187{
188 uint8_t bConfigurationValue;
189} USBSUP_SET_CONFIG, *PUSBSUP_SET_CONFIG;
190
191typedef struct
192{
193 uint8_t bInterfaceNumber;
194 uint8_t bAlternateSetting;
195} USBSUP_SELECT_INTERFACE, *PUSBSUP_SELECT_INTERFACE;
196
197typedef struct
198{
199 uint8_t bEndpoint;
200} USBSUP_CLEAR_ENDPOINT, *PUSBSUP_CLEAR_ENDPOINT;
201
202typedef enum
203{
204 USBSUP_TRANSFER_TYPE_CTRL = 0,
205 USBSUP_TRANSFER_TYPE_ISOC = 1,
206 USBSUP_TRANSFER_TYPE_BULK = 2,
207 USBSUP_TRANSFER_TYPE_INTR = 3,
208 USBSUP_TRANSFER_TYPE_MSG = 4
209} USBSUP_TRANSFER_TYPE;
210
211typedef enum
212{
213 USBSUP_DIRECTION_SETUP = 0,
214 USBSUP_DIRECTION_IN = 1,
215 USBSUP_DIRECTION_OUT = 2
216} USBSUP_DIRECTION;
217
218typedef enum
219{
220 USBSUP_FLAG_NONE = 0,
221 USBSUP_FLAG_SHORT_OK = 1
222} USBSUP_XFER_FLAG;
223
224typedef enum
225{
226 USBSUP_XFER_OK = 0,
227 USBSUP_XFER_STALL = 1,
228 USBSUP_XFER_DNR = 2,
229 USBSUP_XFER_CRC = 3,
230 USBSUP_XFER_NAC = 4,
231 USBSUP_XFER_UNDERRUN = 5,
232 USBSUP_XFER_OVERRUN = 6
233} USBSUP_ERROR;
234
235typedef struct USBSUP_ISOCPKT
236{
237 uint16_t cb; /* [in/out] packet size/size transferred */
238 uint16_t off; /* [in] offset of packet in buffer */
239 USBSUP_ERROR stat; /* [out] packet status */
240} USBSUP_ISOCPKT;
241
242typedef struct
243{
244 USBSUP_TRANSFER_TYPE type; /* [in] USBSUP_TRANSFER_TYPE_XXX */
245 uint32_t ep; /* [in] index to dev->pipe */
246 USBSUP_DIRECTION dir; /* [in] USBSUP_DIRECTION_XXX */
247 USBSUP_XFER_FLAG flags; /* [in] USBSUP_FLAG_XXX */
248 USBSUP_ERROR error; /* [out] USBSUP_XFER_XXX */
249 size_t len; /* [in/out] may change */
250 void *buf; /* [in/out] depends on dir */
251 uint32_t numIsoPkts; /* [in] number of isochronous packets (8 max) */
252 USBSUP_ISOCPKT aIsoPkts[8]; /* [in/out] isochronous packet descriptors */
253} USBSUP_URB, *PUSBSUP_URB;
254
255typedef struct
256{
257 union
258 {
259 /* in: event handle */
260 void* hEvent;
261 /* out: result */
262 int rc;
263 } u;
264} USBSUP_SET_NOTIFY_EVENT, *PUSBSUP_SET_NOTIFY_EVENT;
265
266typedef struct
267{
268 uint16_t usVendorId;
269 uint16_t usProductId;
270 uint16_t usRevision;
271 uint16_t usAlignment;
272 char DrvKeyName[512];
273} USBSUP_DEVID, *PUSBSUP_DEVID;
274
275#pragma pack() /* paranoia */
276
277
278RT_C_DECLS_BEGIN
279
280#ifdef IN_RING3
281
282/** @defgroup grp_usblib_r3 USBLIB Host Context Ring 3 API
283 * @{
284 */
285
286/**
287 * Return all attached USB devices.
288 *
289 * @returns VBox status code
290 * @param ppDevices Receives pointer to list of devices
291 * @param pcbNumDevices Number of USB devices in the list
292 */
293USBLIB_DECL(int) USBLibGetDevices(PUSBDEVICE *ppDevices, uint32_t *pcbNumDevices);
294
295USBLIB_DECL(int) USBLibWaitChange(RTMSINTERVAL cMillies);
296
297USBLIB_DECL(int) USBLibInterruptWaitChange(void);
298
299USBLIB_DECL(int) USBLibRunFilters(void);
300
301/** @} */
302#endif
303
304/** @} */
305
306RT_C_DECLS_END
307
308#endif /* !VBOX_INCLUDED_usblib_win_h */
309
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use