VirtualBox

source: vbox/trunk/include/VBox/usblib.h@ 3291

Last change on this file since 3291 was 2981, checked in by vboxsync, 18 years ago

InnoTek -> innotek: all the headers and comments.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 9.4 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 as published by the Free Software Foundation,
13 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
14 * distribution. VirtualBox OSE is distributed in the hope that it will
15 * be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * If you received this file as part of a commercial VirtualBox
18 * distribution, then only the terms of your commercial VirtualBox
19 * license agreement apply instead of the previous paragraph.
20 */
21
22
23#ifndef __VBox_usblib_h__
24#define __VBox_usblib_h__
25
26#include <VBox/cdefs.h>
27#include <VBox/types.h>
28#include <VBox/usb.h>
29
30#include <initguid.h>
31// {6068EB61-98E7-4c98-9E20-1F068295909A}
32DEFINE_GUID(GUID_CLASS_VBOXUSB, 0x873fdf, 0xCAFE, 0x80EE, 0xaa, 0x5e, 0x0, 0xc0, 0x4f, 0xb1, 0x72, 0xb);
33
34#define USBFLT_SERVICE_NAME "\\\\.\\VBoxUSBFlt"
35#define USBFLT_NTDEVICE_NAME_STRING L"\\Device\\VBoxUSBFlt"
36#define USBFLT_SYMBOLIC_NAME_STRING L"\\DosDevices\\VBoxUSBFlt"
37
38#define USBMON_SERVICE_NAME "VBoxUSBMon"
39#define USBMON_DEVICE_NAME "\\\\.\\VBoxUSBMon"
40#define USBMON_DEVICE_NAME_NT L"\\Device\\VBoxUSBMon"
41#define USBMON_DEVICE_NAME_DOS L"\\DosDevices\\VBoxUSBMon"
42
43/*
44 * IOCtl numbers.
45 * We're using the Win32 type of numbers here, thus the macros below.
46 */
47
48#ifndef CTL_CODE
49# if defined(__WIN__)
50# define CTL_CODE(DeviceType, Function, Method, Access) \
51 ( ((DeviceType) << 16) | ((Access) << 14) | ((Function) << 2) | (Method))
52#else /* unix: */
53# define CTL_CODE(DeviceType, Function, Method_ignored, Access_ignored) \
54 ( (3 << 30) | ((DeviceType) << 8) | (Function) | (sizeof(SUPDRVIOCTLDATA) << 16) )
55# endif
56#endif
57#ifndef METHOD_BUFFERED
58# define METHOD_BUFFERED 0
59#endif
60#ifndef FILE_WRITE_ACCESS
61# define FILE_WRITE_ACCESS 0x0002
62#endif
63#ifndef FILE_DEVICE_UNKNOWN
64# define FILE_DEVICE_UNKNOWN 0x00000022
65#endif
66
67#define USBFLT_MAJOR_VERSION 1
68#define USBFLT_MINOR_VERSION 2
69
70#define USBMON_MAJOR_VERSION 1
71#define USBMON_MINOR_VERSION 1
72
73#define USBDRV_MAJOR_VERSION 1
74#define USBDRV_MINOR_VERSION 2
75
76#define SUPUSB_IOCTL_TEST CTL_CODE(FILE_DEVICE_UNKNOWN, 0x601, METHOD_BUFFERED, FILE_WRITE_ACCESS)
77#define SUPUSB_IOCTL_GET_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x603, METHOD_BUFFERED, FILE_WRITE_ACCESS)
78#define SUPUSB_IOCTL_SEND_URB CTL_CODE(FILE_DEVICE_UNKNOWN, 0x607, METHOD_BUFFERED, FILE_WRITE_ACCESS)
79#define SUPUSB_IOCTL_USB_RESET CTL_CODE(FILE_DEVICE_UNKNOWN, 0x608, METHOD_BUFFERED, FILE_WRITE_ACCESS)
80#define SUPUSB_IOCTL_USB_SELECT_INTERFACE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x609, METHOD_BUFFERED, FILE_WRITE_ACCESS)
81#define SUPUSB_IOCTL_USB_SET_CONFIG CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60A, METHOD_BUFFERED, FILE_WRITE_ACCESS)
82#define SUPUSB_IOCTL_USB_CLAIM_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60B, METHOD_BUFFERED, FILE_WRITE_ACCESS)
83#define SUPUSB_IOCTL_USB_RELEASE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60C, METHOD_BUFFERED, FILE_WRITE_ACCESS)
84#define SUPUSB_IOCTL_IS_OPERATIONAL CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60D, METHOD_BUFFERED, FILE_WRITE_ACCESS)
85#define SUPUSB_IOCTL_USB_CLEAR_ENDPOINT CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60E, METHOD_BUFFERED, FILE_WRITE_ACCESS)
86#define SUPUSB_IOCTL_GET_VERSION CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60F, METHOD_BUFFERED, FILE_WRITE_ACCESS)
87
88#define SUPUSBFLT_IOCTL_GET_NUM_DEVICES CTL_CODE(FILE_DEVICE_UNKNOWN, 0x602, METHOD_BUFFERED, FILE_WRITE_ACCESS)
89#define SUPUSBFLT_IOCTL_USB_CHANGE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x604, METHOD_BUFFERED, FILE_WRITE_ACCESS)
90#define SUPUSBFLT_IOCTL_DISABLE_CAPTURE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x605, METHOD_BUFFERED, FILE_WRITE_ACCESS)
91#define SUPUSBFLT_IOCTL_ENABLE_CAPTURE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x606, METHOD_BUFFERED, FILE_WRITE_ACCESS)
92#define SUPUSBFLT_IOCTL_IGNORE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x60F, METHOD_BUFFERED, FILE_WRITE_ACCESS)
93#define SUPUSBFLT_IOCTL_GET_VERSION CTL_CODE(FILE_DEVICE_UNKNOWN, 0x610, METHOD_BUFFERED, FILE_WRITE_ACCESS)
94#define SUPUSBFLT_IOCTL_ADD_FILTER CTL_CODE(FILE_DEVICE_UNKNOWN, 0x611, METHOD_BUFFERED, FILE_WRITE_ACCESS)
95#define SUPUSBFLT_IOCTL_REMOVE_FILTER CTL_CODE(FILE_DEVICE_UNKNOWN, 0x612, METHOD_BUFFERED, FILE_WRITE_ACCESS)
96#define SUPUSBFLT_IOCTL_CAPTURE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x613, METHOD_BUFFERED, FILE_WRITE_ACCESS)
97#define SUPUSBFLT_IOCTL_RELEASE_DEVICE CTL_CODE(FILE_DEVICE_UNKNOWN, 0x614, METHOD_BUFFERED, FILE_WRITE_ACCESS)
98
99#pragma pack(4)
100
101#define MAX_FILTER_NAME 128
102#define MAX_USB_SERIAL_STRING 64
103
104typedef struct
105{
106 uint16_t vid, did, rev;
107 char serial_hash[MAX_USB_SERIAL_STRING];
108
109 uint8_t fAttached;
110} USBSUP_GETDEV, *PUSBSUP_GETDEV;
111
112typedef struct
113{
114 uint32_t u32Major;
115 uint32_t u32Minor;
116} USBSUP_VERSION, *PUSBSUP_VERSION;
117
118#define MAX_VENDOR_NAME 16
119#define MAX_PRODUCT_NAME MAX_VENDOR_NAME
120#define MAX_REVISION_NAME MAX_VENDOR_NAME
121
122typedef struct
123{
124 char szVendor[MAX_VENDOR_NAME];
125 char szProduct[MAX_PRODUCT_NAME];
126 char szRevision[MAX_REVISION_NAME];
127 uintptr_t id;
128} USBSUP_FILTER, *PUSBSUP_FILTER;
129
130
131typedef struct
132{
133 USHORT usVendorId;
134 USHORT usProductId;
135 USHORT usRevision;
136} USBSUP_CAPTURE, *PUSBSUP_CAPTURE;
137
138typedef USBSUP_CAPTURE USBSUP_RELEASE;
139typedef PUSBSUP_CAPTURE PUSBSUP_RELEASE;
140
141typedef struct
142{
143 uint8_t bInterfaceNumber;
144 uint8_t fClaimed;
145} USBSUP_CLAIMDEV, *PUSBSUP_CLAIMDEV;
146
147typedef USBSUP_CLAIMDEV USBSUP_RELEASEDEV;
148typedef PUSBSUP_CLAIMDEV PUSBSUP_RELEASEDEV;
149
150typedef struct
151{
152 uint32_t cUSBDevices;
153} USBSUP_GETNUMDEV, *PUSBSUP_GETNUMDEV;
154
155typedef struct
156{
157 uint8_t fUSBChange;
158 uint32_t cUSBStateChange;
159} USBSUP_USB_CHANGE, *PUSBSUP_USB_CHANGE;
160
161typedef struct
162{
163 uint8_t bConfigurationValue;
164} USBSUP_SET_CONFIG, *PUSBSUP_SET_CONFIG;
165
166typedef struct
167{
168 uint8_t bInterfaceNumber;
169 uint8_t bAlternateSetting;
170} USBSUP_SELECT_INTERFACE, *PUSBSUP_SELECT_INTERFACE;
171
172typedef struct
173{
174 uint8_t bEndpoint;
175} USBSUP_CLEAR_ENDPOINT, *PUSBSUP_CLEAR_ENDPOINT;
176
177typedef enum
178{
179 USBSUP_TRANSFER_TYPE_CTRL = 0,
180 USBSUP_TRANSFER_TYPE_ISOC = 1,
181 USBSUP_TRANSFER_TYPE_BULK = 2,
182 USBSUP_TRANSFER_TYPE_INTR = 3,
183 USBSUP_TRANSFER_TYPE_MSG = 4
184} USBSUP_TRANSFER_TYPE;
185
186typedef enum
187{
188 USBSUP_DIRECTION_SETUP = 0,
189 USBSUP_DIRECTION_IN = 1,
190 USBSUP_DIRECTION_OUT = 2
191} USBSUP_DIRECTION;
192
193
194typedef enum
195{
196 USBSUP_XFER_OK = 0,
197 USBSUP_XFER_STALL = 1,
198 USBSUP_XFER_DNR = 2,
199 USBSUP_XFER_CRC = 3
200} USBSUP_ERROR;
201
202typedef struct
203{
204 USBSUP_TRANSFER_TYPE type; /* [in] QUSB_TRANSFER_TYPE_XXX */
205 uint32_t ep; /* [in] index to dev->pipe */
206 USBSUP_DIRECTION dir; /* [in] QUSB_DIRECTION_XXX */
207 uint32_t error; /* [out] QUSB_XFER_XXX */
208 size_t len; /* [in/out] may change */
209 void *buf; /* [in/out] depends on dir */
210} USBSUP_URB, *PUSBSUP_URB;
211
212#pragma pack() /* paranoia */
213
214
215__BEGIN_DECLS
216
217#ifdef IN_RING3
218
219/** @defgroup grp_usblib_r3 USBLIB Host Context Ring 3 API
220 * @{
221 */
222
223/**
224 * Initialize the USB library
225 *
226 * @returns VBox status code.
227 */
228VBOXDDU_DECL(int) usbLibInit();
229
230/**
231 * Terminate the USB library
232 *
233 * @returns VBox status code.
234 */
235VBOXDDU_DECL(int) usbLibTerm();
236
237/**
238 * Add USB device filter
239 *
240 * @returns VBox status code.
241 * @param pszVendor Vendor filter string
242 * @param pszProduct Product filter string
243 * @param pszRevision Revision filter string
244 * @param ppID Pointer to filter id
245 */
246VBOXDDU_DECL(int) usbLibInsertFilter(const char *pszVendor, const char *pszProduct, const char *pszRevision, void **ppID);
247
248/**
249 * Remove USB device filter
250 *
251 * @returns VBox status code.
252 * @param aID Filter id
253 */
254VBOXDDU_DECL(int) usbLibRemoveFilter (void *aID);
255
256/**
257 * Return all attached USB devices.
258 *
259 * @returns VBox status code
260 * @param ppDevices Receives pointer to list of devices
261 * @param pcbNumDevices Number of USB devices in the list
262 */
263VBOXDDU_DECL(int) usbLibGetDevices(PUSBDEVICE *ppDevices, uint32_t *pcbNumDevices);
264
265/**
266 * Check for USB device arrivals or removals
267 *
268 * @returns boolean
269 */
270VBOXDDU_DECL(bool) usbLibHasPendingDeviceChanges();
271
272
273/**
274 * Capture specified USB device
275 *
276 * @returns VBox status code
277 * @param usVendorId Vendor id
278 * @param usProductId Product id
279 * @param usRevision Revision
280 */
281VBOXDDU_DECL(int) usbLibCaptureDevice(USHORT usVendorId, USHORT usProductId, USHORT usRevision);
282
283/**
284 * Release specified USB device to the host.
285 *
286 * @returns VBox status code
287 * @param usVendorId Vendor id
288 * @param usProductId Product id
289 * @param usRevision Revision
290 */
291VBOXDDU_DECL(int) usbLibReleaseDevice(USHORT usVendorId, USHORT usProductId, USHORT usRevision);
292
293
294/** @} */
295#endif
296
297/** @} */
298
299__END_DECLS
300
301
302#endif
303
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