VirtualBox

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

Last change on this file since 29567 was 28800, checked in by vboxsync, 15 years ago

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