VirtualBox

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

Last change on this file since 6076 was 5999, checked in by vboxsync, 17 years ago

The Giant CDDL Dual-License Header Change.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 9.7 KB
Line 
1/** @file
2 * USBLIB - USB Support Library:
3 * This module implements the basic low-level OS interfaces for Windows hosts.
4 */
5
6/*
7 * Copyright (C) 2006-2007 innotek GmbH
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 "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 2
75
76#define USBMON_MAJOR_VERSION 1
77#define USBMON_MINOR_VERSION 1
78
79#define USBDRV_MAJOR_VERSION 1
80#define USBDRV_MINOR_VERSION 2
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
94#define SUPUSBFLT_IOCTL_GET_NUM_DEVICES CTL_CODE(FILE_DEVICE_UNKNOWN, 0x602, METHOD_BUFFERED, FILE_WRITE_ACCESS)
95#define SUPUSBFLT_IOCTL_USB_CHANGE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x604, METHOD_BUFFERED, FILE_WRITE_ACCESS)
96#define SUPUSBFLT_IOCTL_DISABLE_CAPTURE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x605, METHOD_BUFFERED, FILE_WRITE_ACCESS)
97#define SUPUSBFLT_IOCTL_ENABLE_CAPTURE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x606, METHOD_BUFFERED, FILE_WRITE_ACCESS)
98#define SUPUSBFLT_IOCTL_IGNORE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60F, METHOD_BUFFERED, FILE_WRITE_ACCESS)
99#define SUPUSBFLT_IOCTL_GET_VERSION CTL_CODE(FILE_DEVICE_UNKNOWN, 0x610, METHOD_BUFFERED, FILE_WRITE_ACCESS)
100#define SUPUSBFLT_IOCTL_ADD_FILTER CTL_CODE(FILE_DEVICE_UNKNOWN, 0x611, METHOD_BUFFERED, FILE_WRITE_ACCESS)
101#define SUPUSBFLT_IOCTL_REMOVE_FILTER CTL_CODE(FILE_DEVICE_UNKNOWN, 0x612, METHOD_BUFFERED, FILE_WRITE_ACCESS)
102#define SUPUSBFLT_IOCTL_CAPTURE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x613, METHOD_BUFFERED, FILE_WRITE_ACCESS)
103#define SUPUSBFLT_IOCTL_RELEASE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x614, METHOD_BUFFERED, FILE_WRITE_ACCESS)
104
105#pragma pack(4)
106
107#define MAX_FILTER_NAME 128
108#define MAX_USB_SERIAL_STRING 64
109
110typedef struct
111{
112 uint16_t vid, did, rev;
113 char serial_hash[MAX_USB_SERIAL_STRING];
114
115 uint8_t fAttached;
116} USBSUP_GETDEV, *PUSBSUP_GETDEV;
117
118typedef struct
119{
120 uint32_t u32Major;
121 uint32_t u32Minor;
122} USBSUP_VERSION, *PUSBSUP_VERSION;
123
124#endif /* RT_OS_WINDOWS */
125
126#define MAX_VENDOR_NAME 16
127#define MAX_PRODUCT_NAME MAX_VENDOR_NAME
128#define MAX_REVISION_NAME MAX_VENDOR_NAME
129
130typedef struct
131{
132 char szVendor[MAX_VENDOR_NAME];
133 char szProduct[MAX_PRODUCT_NAME];
134 char szRevision[MAX_REVISION_NAME];
135 uintptr_t id;
136} USBSUP_FILTER, *PUSBSUP_FILTER;
137
138
139typedef struct
140{
141 USHORT usVendorId;
142 USHORT usProductId;
143 USHORT usRevision;
144} USBSUP_CAPTURE, *PUSBSUP_CAPTURE;
145
146typedef USBSUP_CAPTURE USBSUP_RELEASE;
147typedef PUSBSUP_CAPTURE PUSBSUP_RELEASE;
148
149typedef struct
150{
151 uint8_t bInterfaceNumber;
152 uint8_t fClaimed;
153} USBSUP_CLAIMDEV, *PUSBSUP_CLAIMDEV;
154
155typedef USBSUP_CLAIMDEV USBSUP_RELEASEDEV;
156typedef PUSBSUP_CLAIMDEV PUSBSUP_RELEASEDEV;
157
158typedef struct
159{
160 uint32_t cUSBDevices;
161} USBSUP_GETNUMDEV, *PUSBSUP_GETNUMDEV;
162
163typedef struct
164{
165 uint8_t fUSBChange;
166 uint32_t cUSBStateChange;
167} USBSUP_USB_CHANGE, *PUSBSUP_USB_CHANGE;
168
169typedef struct
170{
171 uint8_t bConfigurationValue;
172} USBSUP_SET_CONFIG, *PUSBSUP_SET_CONFIG;
173
174typedef struct
175{
176 uint8_t bInterfaceNumber;
177 uint8_t bAlternateSetting;
178} USBSUP_SELECT_INTERFACE, *PUSBSUP_SELECT_INTERFACE;
179
180typedef struct
181{
182 uint8_t bEndpoint;
183} USBSUP_CLEAR_ENDPOINT, *PUSBSUP_CLEAR_ENDPOINT;
184
185typedef enum
186{
187 USBSUP_TRANSFER_TYPE_CTRL = 0,
188 USBSUP_TRANSFER_TYPE_ISOC = 1,
189 USBSUP_TRANSFER_TYPE_BULK = 2,
190 USBSUP_TRANSFER_TYPE_INTR = 3,
191 USBSUP_TRANSFER_TYPE_MSG = 4
192} USBSUP_TRANSFER_TYPE;
193
194typedef enum
195{
196 USBSUP_DIRECTION_SETUP = 0,
197 USBSUP_DIRECTION_IN = 1,
198 USBSUP_DIRECTION_OUT = 2
199} USBSUP_DIRECTION;
200
201
202typedef enum
203{
204 USBSUP_XFER_OK = 0,
205 USBSUP_XFER_STALL = 1,
206 USBSUP_XFER_DNR = 2,
207 USBSUP_XFER_CRC = 3
208} USBSUP_ERROR;
209
210typedef struct
211{
212 USBSUP_TRANSFER_TYPE type; /* [in] QUSB_TRANSFER_TYPE_XXX */
213 uint32_t ep; /* [in] index to dev->pipe */
214 USBSUP_DIRECTION dir; /* [in] QUSB_DIRECTION_XXX */
215 uint32_t error; /* [out] QUSB_XFER_XXX */
216 size_t len; /* [in/out] may change */
217 void *buf; /* [in/out] depends on dir */
218} USBSUP_URB, *PUSBSUP_URB;
219
220#pragma pack() /* paranoia */
221
222
223__BEGIN_DECLS
224
225#ifdef IN_RING3
226
227/** @defgroup grp_usblib_r3 USBLIB Host Context Ring 3 API
228 * @{
229 */
230
231/**
232 * Initialize the USB library
233 *
234 * @returns VBox status code.
235 */
236VBOXDDU_DECL(int) usbLibInit();
237
238/**
239 * Terminate the USB library
240 *
241 * @returns VBox status code.
242 */
243VBOXDDU_DECL(int) usbLibTerm();
244
245/**
246 * Add USB device filter
247 *
248 * @returns VBox status code.
249 * @param pszVendor Vendor filter string
250 * @param pszProduct Product filter string
251 * @param pszRevision Revision filter string
252 * @param ppID Pointer to filter id
253 */
254VBOXDDU_DECL(int) usbLibInsertFilter(const char *pszVendor, const char *pszProduct, const char *pszRevision, void **ppID);
255
256/**
257 * Remove USB device filter
258 *
259 * @returns VBox status code.
260 * @param aID Filter id
261 */
262VBOXDDU_DECL(int) usbLibRemoveFilter (void *aID);
263
264/**
265 * Return all attached USB devices.
266 *
267 * @returns VBox status code
268 * @param ppDevices Receives pointer to list of devices
269 * @param pcbNumDevices Number of USB devices in the list
270 */
271VBOXDDU_DECL(int) usbLibGetDevices(PUSBDEVICE *ppDevices, uint32_t *pcbNumDevices);
272
273/**
274 * Check for USB device arrivals or removals
275 *
276 * @returns boolean
277 */
278VBOXDDU_DECL(bool) usbLibHasPendingDeviceChanges();
279
280
281/**
282 * Capture specified USB device
283 *
284 * @returns VBox status code
285 * @param usVendorId Vendor id
286 * @param usProductId Product id
287 * @param usRevision Revision
288 */
289VBOXDDU_DECL(int) usbLibCaptureDevice(USHORT usVendorId, USHORT usProductId, USHORT usRevision);
290
291/**
292 * Release specified USB device to the host.
293 *
294 * @returns VBox status code
295 * @param usVendorId Vendor id
296 * @param usProductId Product id
297 * @param usRevision Revision
298 */
299VBOXDDU_DECL(int) usbLibReleaseDevice(USHORT usVendorId, USHORT usProductId, USHORT usRevision);
300
301
302/** @} */
303#endif
304
305/** @} */
306
307__END_DECLS
308
309
310#endif
311
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