VirtualBox

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

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

Added usb monitor driver major & minor version.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 8.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 InnoTek Systemberatung 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 1
69
70#define USBMON_MAJOR_VERSION 1
71#define USBMON_MINOR_VERSION 0
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
97#pragma pack(4)
98
99#define MAX_FILTER_NAME 128
100#define MAX_USB_SERIAL_STRING 64
101
102typedef struct
103{
104 uint16_t vid, did, rev;
105 char serial_hash[MAX_USB_SERIAL_STRING];
106
107 uint8_t fAttached;
108} USBSUP_GETDEV, *PUSBSUP_GETDEV;
109
110typedef struct
111{
112 uint32_t u32Major;
113 uint32_t u32Minor;
114} USBSUP_VERSION, *PUSBSUP_VERSION;
115
116#define MAX_VENDOR_NAME 16
117#define MAX_PRODUCT_NAME MAX_VENDOR_NAME
118#define MAX_REVISION_NAME MAX_VENDOR_NAME
119
120typedef struct
121{
122 char szVendor[MAX_VENDOR_NAME];
123 char szProduct[MAX_PRODUCT_NAME];
124 char szRevision[MAX_REVISION_NAME];
125 uintptr_t id;
126} USBSUP_FILTER, *PUSBSUP_FILTER;
127
128typedef struct
129{
130 uint8_t bInterfaceNumber;
131 uint8_t fClaimed;
132} USBSUP_CLAIMDEV, *PUSBSUP_CLAIMDEV;
133
134typedef USBSUP_CLAIMDEV USBSUP_RELEASEDEV;
135typedef PUSBSUP_CLAIMDEV PUSBSUP_RELEASEDEV;
136
137typedef struct
138{
139 uint32_t cUSBDevices;
140} USBSUP_GETNUMDEV, *PUSBSUP_GETNUMDEV;
141
142typedef struct
143{
144 uint8_t fUSBChange;
145 uint32_t cUSBStateChange;
146} USBSUP_USB_CHANGE, *PUSBSUP_USB_CHANGE;
147
148typedef struct
149{
150 uint8_t bConfigurationValue;
151} USBSUP_SET_CONFIG, *PUSBSUP_SET_CONFIG;
152
153typedef struct
154{
155 uint8_t bInterfaceNumber;
156 uint8_t bAlternateSetting;
157} USBSUP_SELECT_INTERFACE, *PUSBSUP_SELECT_INTERFACE;
158
159typedef struct
160{
161 uint8_t bEndpoint;
162} USBSUP_CLEAR_ENDPOINT, *PUSBSUP_CLEAR_ENDPOINT;
163
164typedef enum
165{
166 USBSUP_TRANSFER_TYPE_CTRL = 0,
167 USBSUP_TRANSFER_TYPE_ISOC = 1,
168 USBSUP_TRANSFER_TYPE_BULK = 2,
169 USBSUP_TRANSFER_TYPE_INTR = 3,
170 USBSUP_TRANSFER_TYPE_MSG = 4
171} USBSUP_TRANSFER_TYPE;
172
173typedef enum
174{
175 USBSUP_DIRECTION_SETUP = 0,
176 USBSUP_DIRECTION_IN = 1,
177 USBSUP_DIRECTION_OUT = 2
178} USBSUP_DIRECTION;
179
180
181typedef enum
182{
183 USBSUP_XFER_OK = 0,
184 USBSUP_XFER_STALL = 1,
185 USBSUP_XFER_DNR = 2,
186 USBSUP_XFER_CRC = 3
187} USBSUP_ERROR;
188
189typedef struct
190{
191 USBSUP_TRANSFER_TYPE type; /* [in] QUSB_TRANSFER_TYPE_XXX */
192 uint32_t ep; /* [in] index to dev->pipe */
193 USBSUP_DIRECTION dir; /* [in] QUSB_DIRECTION_XXX */
194 uint32_t error; /* [out] QUSB_XFER_XXX */
195 size_t len; /* [in/out] may change */
196 void *buf; /* [in/out] depends on dir */
197} USBSUP_URB, *PUSBSUP_URB;
198
199#pragma pack() /* paranoia */
200
201
202__BEGIN_DECLS
203
204#ifdef IN_RING3
205
206/** @defgroup grp_usblib_r3 USBLIB Host Context Ring 3 API
207 * @{
208 */
209
210/**
211 * Initialize the USB library
212 *
213 * @returns VBox status code.
214 */
215VBOXDDU_DECL(int) usbLibInit();
216
217/**
218 * Terminate the USB library
219 *
220 * @returns VBox status code.
221 */
222VBOXDDU_DECL(int) usbLibTerm();
223
224/**
225 * Add USB device filter
226 *
227 * @returns VBox status code.
228 * @param pszVendor Vendor filter string
229 * @param pszProduct Product filter string
230 * @param pszRevision Revision filter string
231 * @param ppID Pointer to filter id
232 */
233VBOXDDU_DECL(int) usbLibInsertFilter(const char *pszVendor, const char *pszProduct, const char *pszRevision, void **ppID);
234
235/**
236 * Remove USB device filter
237 *
238 * @returns VBox status code.
239 * @param aID Filter id
240 */
241VBOXDDU_DECL(int) usbLibRemoveFilter (void *aID);
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 */
250VBOXDDU_DECL(int) usbLibGetDevices(PUSBDEVICE *ppDevices, uint32_t *pcbNumDevices);
251
252/**
253 * Check for USB device arrivals or removals
254 *
255 * @returns boolean
256 */
257VBOXDDU_DECL(bool) usbLibHasPendingDeviceChanges();
258
259/** @} */
260#endif
261
262/** @} */
263
264__END_DECLS
265
266
267#endif
268
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