VirtualBox

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

Last change on this file since 34801 was 34306, checked in by vboxsync, 14 years ago

USBLib-win: unused function
  • 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 - Library for wrapping up the VBoxUSB functionality, Windows flavor.
3 * (DEV,HDrv,Main)
4 */
5
6/*
7 * Copyright (C) 2006-2010 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 "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 1
77#define USBMON_MINOR_VERSION 1
78
79#define USBDRV_MAJOR_VERSION 3
80#define USBDRV_MINOR_VERSION 1
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
106#pragma pack(4)
107
108#define MAX_FILTER_NAME 128
109#define MAX_USB_SERIAL_STRING 64
110
111typedef struct
112{
113 uint16_t vid, did, rev;
114 char serial_hash[MAX_USB_SERIAL_STRING];
115
116 uint8_t fAttached;
117 uint8_t fHiSpeed;
118} USBSUP_GETDEV, *PUSBSUP_GETDEV;
119
120typedef struct
121{
122 uint32_t u32Major;
123 uint32_t u32Minor;
124} USBSUP_VERSION, *PUSBSUP_VERSION;
125
126#endif /* RT_OS_WINDOWS */
127
128typedef struct USBSUP_FLTADDOUT
129{
130 uintptr_t uId; /* The ID. */
131 int rc; /* The return code. */
132} USBSUP_FLTADDOUT, *PUSBSUP_FLTADDOUT;
133
134typedef struct
135{
136 uint16_t usVendorId;
137 uint16_t usProductId;
138 uint16_t usRevision;
139} USBSUP_CAPTURE, *PUSBSUP_CAPTURE;
140
141typedef USBSUP_CAPTURE USBSUP_RELEASE;
142typedef PUSBSUP_CAPTURE PUSBSUP_RELEASE;
143
144typedef struct
145{
146 uint8_t bInterfaceNumber;
147 uint8_t fClaimed;
148} USBSUP_CLAIMDEV, *PUSBSUP_CLAIMDEV;
149
150typedef USBSUP_CLAIMDEV USBSUP_RELEASEDEV;
151typedef PUSBSUP_CLAIMDEV PUSBSUP_RELEASEDEV;
152
153typedef struct
154{
155 uint32_t cUSBDevices;
156} USBSUP_GETNUMDEV, *PUSBSUP_GETNUMDEV;
157
158typedef struct
159{
160 uint8_t fUSBChange;
161 uint32_t cUSBStateChange;
162} USBSUP_USB_CHANGE, *PUSBSUP_USB_CHANGE;
163
164typedef struct
165{
166 uint8_t bConfigurationValue;
167} USBSUP_SET_CONFIG, *PUSBSUP_SET_CONFIG;
168
169typedef struct
170{
171 uint8_t bInterfaceNumber;
172 uint8_t bAlternateSetting;
173} USBSUP_SELECT_INTERFACE, *PUSBSUP_SELECT_INTERFACE;
174
175typedef struct
176{
177 uint8_t bEndpoint;
178} USBSUP_CLEAR_ENDPOINT, *PUSBSUP_CLEAR_ENDPOINT;
179
180typedef enum
181{
182 USBSUP_TRANSFER_TYPE_CTRL = 0,
183 USBSUP_TRANSFER_TYPE_ISOC = 1,
184 USBSUP_TRANSFER_TYPE_BULK = 2,
185 USBSUP_TRANSFER_TYPE_INTR = 3,
186 USBSUP_TRANSFER_TYPE_MSG = 4
187} USBSUP_TRANSFER_TYPE;
188
189typedef enum
190{
191 USBSUP_DIRECTION_SETUP = 0,
192 USBSUP_DIRECTION_IN = 1,
193 USBSUP_DIRECTION_OUT = 2
194} USBSUP_DIRECTION;
195
196typedef enum
197{
198 USBSUP_FLAG_NONE = 0,
199 USBSUP_FLAG_SHORT_OK = 1
200} USBSUP_XFER_FLAG;
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_XFER_NAC = 4,
209 USBSUP_XFER_UNDERRUN = 5,
210 USBSUP_XFER_OVERRUN = 6
211} USBSUP_ERROR;
212
213typedef struct USBSUP_ISOCPKT
214{
215 uint16_t cb; /* [in/out] packet size/size transferred */
216 uint16_t off; /* [in] offset of packet in buffer */
217 USBSUP_ERROR stat; /* [out] packet status */
218} USBSUP_ISOCPKT;
219
220typedef struct
221{
222 USBSUP_TRANSFER_TYPE type; /* [in] USBSUP_TRANSFER_TYPE_XXX */
223 uint32_t ep; /* [in] index to dev->pipe */
224 USBSUP_DIRECTION dir; /* [in] USBSUP_DIRECTION_XXX */
225 USBSUP_XFER_FLAG flags; /* [in] USBSUP_FLAG_XXX */
226 USBSUP_ERROR error; /* [out] USBSUP_XFER_XXX */
227 size_t len; /* [in/out] may change */
228 void *buf; /* [in/out] depends on dir */
229 uint32_t numIsoPkts; /* [in] number of isochronous packets (8 max) */
230 USBSUP_ISOCPKT aIsoPkts[8]; /* [in/out] isochronous packet descriptors */
231} USBSUP_URB, *PUSBSUP_URB;
232
233#pragma pack() /* paranoia */
234
235
236RT_C_DECLS_BEGIN
237
238#ifdef IN_RING3
239
240/** @defgroup grp_usblib_r3 USBLIB Host Context Ring 3 API
241 * @{
242 */
243
244/**
245 * Return all attached USB devices.
246 *
247 * @returns VBox status code
248 * @param ppDevices Receives pointer to list of devices
249 * @param pcbNumDevices Number of USB devices in the list
250 */
251USBLIB_DECL(int) USBLibGetDevices(PUSBDEVICE *ppDevices, uint32_t *pcbNumDevices);
252
253/**
254 * Check for USB device arrivals or removals
255 *
256 * @returns boolean
257 */
258USBLIB_DECL(bool) USBLibHasPendingDeviceChanges(void);
259
260/**
261 * Capture specified USB device
262 *
263 * @returns VBox status code
264 * @param usVendorId Vendor id
265 * @param usProductId Product id
266 * @param usRevision Revision
267 */
268USBLIB_DECL(int) USBLibCaptureDevice(uint16_t usVendorId, uint16_t usProductId, uint16_t usRevision);
269
270/**
271 * Release specified USB device to the host.
272 *
273 * @returns VBox status code
274 * @param usVendorId Vendor id
275 * @param usProductId Product id
276 * @param usRevision Revision
277 */
278USBLIB_DECL(int) USBLibReleaseDevice(uint16_t usVendorId, uint16_t usProductId, uint16_t usRevision);
279
280/** @} */
281#endif
282
283/** @} */
284
285RT_C_DECLS_END
286
287
288#endif
289
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