VirtualBox

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

Last change on this file since 24130 was 21217, checked in by vboxsync, 15 years ago

include/VBox/*.h: Mark which components the header files relate to.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 9.8 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-2007 Sun Microsystems, Inc.
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 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
27 * Clara, CA 95054 USA or visit http://www.sun.com if you need
28 * additional information or have any questions.
29 */
30
31#ifndef ___VBox_usblib_win_h
32#define ___VBox_usblib_win_h
33
34#include <VBox/cdefs.h>
35#include <VBox/types.h>
36#include <VBox/usb.h>
37
38#ifdef RT_OS_WINDOWS
39
40#include <initguid.h>
41// {6068EB61-98E7-4c98-9E20-1F068295909A}
42DEFINE_GUID(GUID_CLASS_VBOXUSB, 0x873fdf, 0xCAFE, 0x80EE, 0xaa, 0x5e, 0x0, 0xc0, 0x4f, 0xb1, 0x72, 0xb);
43
44#define USBFLT_SERVICE_NAME "\\\\.\\VBoxUSBFlt"
45#define USBFLT_NTDEVICE_NAME_STRING L"\\Device\\VBoxUSBFlt"
46#define USBFLT_SYMBOLIC_NAME_STRING L"\\DosDevices\\VBoxUSBFlt"
47
48#define USBMON_SERVICE_NAME "VBoxUSBMon"
49#define USBMON_DEVICE_NAME "\\\\.\\VBoxUSBMon"
50#define USBMON_DEVICE_NAME_NT L"\\Device\\VBoxUSBMon"
51#define USBMON_DEVICE_NAME_DOS L"\\DosDevices\\VBoxUSBMon"
52
53/*
54 * IOCtl numbers.
55 * We're using the Win32 type of numbers here, thus the macros below.
56 */
57
58#ifndef CTL_CODE
59# if defined(RT_OS_WINDOWS)
60# define CTL_CODE(DeviceType, Function, Method, Access) \
61 ( ((DeviceType) << 16) | ((Access) << 14) | ((Function) << 2) | (Method))
62#else /* unix: */
63# define CTL_CODE(DeviceType, Function, Method_ignored, Access_ignored) \
64 ( (3 << 30) | ((DeviceType) << 8) | (Function) | (sizeof(SUPDRVIOCTLDATA) << 16) )
65# endif
66#endif
67#ifndef METHOD_BUFFERED
68# define METHOD_BUFFERED 0
69#endif
70#ifndef FILE_WRITE_ACCESS
71# define FILE_WRITE_ACCESS 0x0002
72#endif
73#ifndef FILE_DEVICE_UNKNOWN
74# define FILE_DEVICE_UNKNOWN 0x00000022
75#endif
76
77#define USBFLT_MAJOR_VERSION 1
78#define USBFLT_MINOR_VERSION 3
79
80#define USBMON_MAJOR_VERSION 1
81#define USBMON_MINOR_VERSION 1
82
83#define USBDRV_MAJOR_VERSION 3
84#define USBDRV_MINOR_VERSION 0
85
86#define SUPUSB_IOCTL_TEST CTL_CODE(FILE_DEVICE_UNKNOWN, 0x601, METHOD_BUFFERED, FILE_WRITE_ACCESS)
87#define SUPUSB_IOCTL_GET_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x603, METHOD_BUFFERED, FILE_WRITE_ACCESS)
88#define SUPUSB_IOCTL_SEND_URB CTL_CODE(FILE_DEVICE_UNKNOWN, 0x607, METHOD_BUFFERED, FILE_WRITE_ACCESS)
89#define SUPUSB_IOCTL_USB_RESET CTL_CODE(FILE_DEVICE_UNKNOWN, 0x608, METHOD_BUFFERED, FILE_WRITE_ACCESS)
90#define SUPUSB_IOCTL_USB_SELECT_INTERFACE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x609, METHOD_BUFFERED, FILE_WRITE_ACCESS)
91#define SUPUSB_IOCTL_USB_SET_CONFIG CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60A, METHOD_BUFFERED, FILE_WRITE_ACCESS)
92#define SUPUSB_IOCTL_USB_CLAIM_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60B, METHOD_BUFFERED, FILE_WRITE_ACCESS)
93#define SUPUSB_IOCTL_USB_RELEASE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60C, METHOD_BUFFERED, FILE_WRITE_ACCESS)
94#define SUPUSB_IOCTL_IS_OPERATIONAL CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60D, METHOD_BUFFERED, FILE_WRITE_ACCESS)
95#define SUPUSB_IOCTL_USB_CLEAR_ENDPOINT CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60E, METHOD_BUFFERED, FILE_WRITE_ACCESS)
96#define SUPUSB_IOCTL_GET_VERSION CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60F, METHOD_BUFFERED, FILE_WRITE_ACCESS)
97
98#define SUPUSBFLT_IOCTL_GET_NUM_DEVICES CTL_CODE(FILE_DEVICE_UNKNOWN, 0x602, METHOD_BUFFERED, FILE_WRITE_ACCESS)
99#define SUPUSBFLT_IOCTL_USB_CHANGE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x604, METHOD_BUFFERED, FILE_WRITE_ACCESS)
100#define SUPUSBFLT_IOCTL_DISABLE_CAPTURE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x605, METHOD_BUFFERED, FILE_WRITE_ACCESS)
101#define SUPUSBFLT_IOCTL_ENABLE_CAPTURE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x606, METHOD_BUFFERED, FILE_WRITE_ACCESS)
102#define SUPUSBFLT_IOCTL_IGNORE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60F, METHOD_BUFFERED, FILE_WRITE_ACCESS)
103#define SUPUSBFLT_IOCTL_GET_VERSION CTL_CODE(FILE_DEVICE_UNKNOWN, 0x610, METHOD_BUFFERED, FILE_WRITE_ACCESS)
104#define SUPUSBFLT_IOCTL_ADD_FILTER CTL_CODE(FILE_DEVICE_UNKNOWN, 0x611, METHOD_BUFFERED, FILE_WRITE_ACCESS)
105#define SUPUSBFLT_IOCTL_REMOVE_FILTER CTL_CODE(FILE_DEVICE_UNKNOWN, 0x612, METHOD_BUFFERED, FILE_WRITE_ACCESS)
106#define SUPUSBFLT_IOCTL_CAPTURE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x613, METHOD_BUFFERED, FILE_WRITE_ACCESS)
107#define SUPUSBFLT_IOCTL_RELEASE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x614, 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
114typedef struct
115{
116 uint16_t vid, did, rev;
117 char serial_hash[MAX_USB_SERIAL_STRING];
118
119 uint8_t fAttached;
120 uint8_t fHiSpeed;
121} USBSUP_GETDEV, *PUSBSUP_GETDEV;
122
123typedef struct
124{
125 uint32_t u32Major;
126 uint32_t u32Minor;
127} USBSUP_VERSION, *PUSBSUP_VERSION;
128
129#endif /* RT_OS_WINDOWS */
130
131typedef struct USBSUP_FLTADDOUT
132{
133 uintptr_t uId; /* The ID. */
134 int rc; /* The return code. */
135} USBSUP_FLTADDOUT, *PUSBSUP_FLTADDOUT;
136
137typedef struct
138{
139 uint16_t usVendorId;
140 uint16_t usProductId;
141 uint16_t usRevision;
142} USBSUP_CAPTURE, *PUSBSUP_CAPTURE;
143
144typedef USBSUP_CAPTURE USBSUP_RELEASE;
145typedef PUSBSUP_CAPTURE PUSBSUP_RELEASE;
146
147typedef struct
148{
149 uint8_t bInterfaceNumber;
150 uint8_t fClaimed;
151} USBSUP_CLAIMDEV, *PUSBSUP_CLAIMDEV;
152
153typedef USBSUP_CLAIMDEV USBSUP_RELEASEDEV;
154typedef PUSBSUP_CLAIMDEV PUSBSUP_RELEASEDEV;
155
156typedef struct
157{
158 uint32_t cUSBDevices;
159} USBSUP_GETNUMDEV, *PUSBSUP_GETNUMDEV;
160
161typedef struct
162{
163 uint8_t fUSBChange;
164 uint32_t cUSBStateChange;
165} USBSUP_USB_CHANGE, *PUSBSUP_USB_CHANGE;
166
167typedef struct
168{
169 uint8_t bConfigurationValue;
170} USBSUP_SET_CONFIG, *PUSBSUP_SET_CONFIG;
171
172typedef struct
173{
174 uint8_t bInterfaceNumber;
175 uint8_t bAlternateSetting;
176} USBSUP_SELECT_INTERFACE, *PUSBSUP_SELECT_INTERFACE;
177
178typedef struct
179{
180 uint8_t bEndpoint;
181} USBSUP_CLEAR_ENDPOINT, *PUSBSUP_CLEAR_ENDPOINT;
182
183typedef enum
184{
185 USBSUP_TRANSFER_TYPE_CTRL = 0,
186 USBSUP_TRANSFER_TYPE_ISOC = 1,
187 USBSUP_TRANSFER_TYPE_BULK = 2,
188 USBSUP_TRANSFER_TYPE_INTR = 3,
189 USBSUP_TRANSFER_TYPE_MSG = 4
190} USBSUP_TRANSFER_TYPE;
191
192typedef enum
193{
194 USBSUP_DIRECTION_SETUP = 0,
195 USBSUP_DIRECTION_IN = 1,
196 USBSUP_DIRECTION_OUT = 2
197} USBSUP_DIRECTION;
198
199typedef enum
200{
201 USBSUP_FLAG_NONE = 0,
202 USBSUP_FLAG_SHORT_OK = 1
203} USBSUP_XFER_FLAG;
204
205typedef enum
206{
207 USBSUP_XFER_OK = 0,
208 USBSUP_XFER_STALL = 1,
209 USBSUP_XFER_DNR = 2,
210 USBSUP_XFER_CRC = 3,
211 USBSUP_XFER_NAC = 4,
212 USBSUP_XFER_UNDERRUN = 5,
213 USBSUP_XFER_OVERRUN = 6
214} USBSUP_ERROR;
215
216typedef struct USBSUP_ISOCPKT
217{
218 uint16_t cb; /* [in/out] packet size/size transferred */
219 uint16_t off; /* [in] offset of packet in buffer */
220 USBSUP_ERROR stat; /* [out] packet status */
221} USBSUP_ISOCPKT;
222
223typedef struct
224{
225 USBSUP_TRANSFER_TYPE type; /* [in] USBSUP_TRANSFER_TYPE_XXX */
226 uint32_t ep; /* [in] index to dev->pipe */
227 USBSUP_DIRECTION dir; /* [in] USBSUP_DIRECTION_XXX */
228 USBSUP_XFER_FLAG flags; /* [in] USBSUP_FLAG_XXX */
229 USBSUP_ERROR error; /* [out] USBSUP_XFER_XXX */
230 size_t len; /* [in/out] may change */
231 void *buf; /* [in/out] depends on dir */
232 uint32_t numIsoPkts; /* [in] number of isochronous packets (8 max) */
233 USBSUP_ISOCPKT aIsoPkts[8]; /* [in/out] isochronous packet descriptors */
234} USBSUP_URB, *PUSBSUP_URB;
235
236#pragma pack() /* paranoia */
237
238
239RT_C_DECLS_BEGIN
240
241#ifdef IN_RING3
242
243/** @defgroup grp_usblib_r3 USBLIB Host Context Ring 3 API
244 * @{
245 */
246
247/**
248 * Return all attached USB devices.
249 *
250 * @returns VBox status code
251 * @param ppDevices Receives pointer to list of devices
252 * @param pcbNumDevices Number of USB devices in the list
253 */
254USBLIB_DECL(int) USBLibGetDevices(PUSBDEVICE *ppDevices, uint32_t *pcbNumDevices);
255
256/**
257 * Check for USB device arrivals or removals
258 *
259 * @returns boolean
260 */
261USBLIB_DECL(bool) USBLibHasPendingDeviceChanges(void);
262
263/**
264 * Capture specified USB device
265 *
266 * @returns VBox status code
267 * @param usVendorId Vendor id
268 * @param usProductId Product id
269 * @param usRevision Revision
270 */
271USBLIB_DECL(int) USBLibCaptureDevice(uint16_t usVendorId, uint16_t usProductId, uint16_t usRevision);
272
273/**
274 * Release specified USB device to the host.
275 *
276 * @returns VBox status code
277 * @param usVendorId Vendor id
278 * @param usProductId Product id
279 * @param usRevision Revision
280 */
281USBLIB_DECL(int) USBLibReleaseDevice(uint16_t usVendorId, uint16_t usProductId, uint16_t usRevision);
282
283/** @} */
284#endif
285
286/** @} */
287
288RT_C_DECLS_END
289
290
291#endif
292
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