VirtualBox

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

Last change on this file since 56553 was 56291, checked in by vboxsync, 10 years ago

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