VirtualBox

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

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