VirtualBox

source: vbox/trunk/include/VBox/usblib-solaris.h@ 64622

Last change on this file since 64622 was 62476, checked in by vboxsync, 8 years ago

(C) 2016
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.4 KB
Line 
1/** @file
2 * USBLib - Library for wrapping up the VBoxUSB functionality, Solaris flavor.
3 * (DEV,HDrv,Main)
4 */
5
6/*
7 * Copyright (C) 2008-2016 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_solaris_h
28#define ___VBox_usblib_solaris_h
29
30#include <VBox/cdefs.h>
31#include <VBox/usbfilter.h>
32#include <VBox/vusb.h>
33#include <sys/types.h>
34#include <sys/ioccom.h>
35#include <sys/param.h>
36
37RT_C_DECLS_BEGIN
38
39/** @defgroup grp_usblib_solaris Solaris USB Specifics
40 * @ingroup grp_usblib
41 * @{
42 */
43
44/** @name VBoxUSB specific IOCtls.
45 * VBoxUSB uses them for resetting USB devices requests from userland.
46 * USBProxyService/Device makes use of them to communicate with VBoxUSB.
47 * @{ */
48
49/** Ring-3 request wrapper for big requests.
50 *
51 * This is necessary because the ioctl number scheme on many Unixy OSes (esp. Solaris)
52 * only allows a relatively small size to be encoded into the request. So, for big
53 * request this generic form is used instead. */
54typedef struct VBOXUSBREQ
55{
56 /** Magic value (VBOXUSB(MON)_MAGIC). */
57 uint32_t u32Magic;
58 /** The size of the data buffer (In & Out). */
59 uint32_t cbData;
60 /** Result code of the request filled by driver. */
61 int32_t rc;
62 /** The user address of the data buffer. */
63 RTR3PTR pvDataR3;
64} VBOXUSBREQ;
65/** Pointer to a request wrapper for solaris. */
66typedef VBOXUSBREQ *PVBOXUSBREQ;
67/** Pointer to a const request wrapper for solaris. */
68typedef const VBOXUSBREQ *PCVBOXUSBREQ;
69
70#pragma pack(1)
71typedef struct
72{
73 /* Pointer to the Filter. */
74 USBFILTER Filter;
75 /* Where to store the added Filter (Id). */
76 uintptr_t uId;
77} VBOXUSBREQ_ADD_FILTER;
78
79typedef struct
80{
81 /* Pointer to Filter (Id) to be removed. */
82 uintptr_t uId;
83} VBOXUSBREQ_REMOVE_FILTER;
84
85typedef struct
86{
87 /** Whether to re-attach the driver. */
88 bool fReattach;
89 /* Physical path of the USB device. */
90 char szDevicePath[1];
91} VBOXUSBREQ_RESET_DEVICE;
92
93typedef struct
94{
95 /* Where to store the instance. */
96 int *pInstance;
97 /* Physical path of the USB device. */
98 char szDevicePath[1];
99} VBOXUSBREQ_DEVICE_INSTANCE;
100
101typedef struct
102{
103 /** Where to store the instance. */
104 int Instance;
105 /* Where to store the client path. */
106 char szClientPath[MAXPATHLEN];
107 /** Device identifier (VendorId:ProductId:Release:StaticPath) */
108 char szDeviceIdent[MAXPATHLEN+48];
109 /** Callback from monitor specifying client consumer (VM) credentials */
110 DECLR0CALLBACKMEMBER(int, pfnSetConsumerCredentials,(RTPROCESS Process, int Instance, void *pvReserved));
111} VBOXUSBREQ_CLIENT_INFO, *PVBOXUSBREQ_CLIENT_INFO;
112typedef VBOXUSBREQ_CLIENT_INFO VBOXUSB_CLIENT_INFO;
113typedef PVBOXUSBREQ_CLIENT_INFO PVBOXUSB_CLIENT_INFO;
114
115/** Isoc packet descriptor (Must mirror exactly Solaris USBA's usb_isoc_pkt_descr_t) */
116typedef struct
117{
118 ushort_t cbPkt; /* Size of the packet */
119 ushort_t cbActPkt; /* Size of the packet actually transferred */
120 VUSBSTATUS enmStatus; /* Per frame transfer status */
121} VUSBISOC_PKT_DESC;
122
123/** VBoxUSB IOCtls */
124typedef struct
125{
126 void *pvUrbR3; /* Pointer to userland URB (untouched by kernel driver) */
127 uint8_t bEndpoint; /* Endpoint address */
128 VUSBXFERTYPE enmType; /* Xfer type */
129 VUSBDIRECTION enmDir; /* Xfer direction */
130 VUSBSTATUS enmStatus; /* URB status */
131 bool fShortOk; /* Whether receiving less data than requested is acceptable. */
132 size_t cbData; /* Size of the data */
133 void *pvData; /* Pointer to the data */
134 uint32_t cIsocPkts; /* Number of Isoc packets */
135 VUSBISOC_PKT_DESC aIsocPkts[8]; /* Array of Isoc packet descriptors */
136} VBOXUSBREQ_URB, *PVBOXUSBREQ_URB;
137
138typedef struct
139{
140 uint8_t bEndpoint; /* Endpoint address */
141} VBOXUSBREQ_CLEAR_EP, *PVBOXUSBREQ_CLEAR_EP;
142
143
144typedef struct
145{
146 uint8_t bConfigValue; /* Configuration value */
147} VBOXUSBREQ_SET_CONFIG, *PVBOXUSBREQ_SET_CONFIG;
148typedef VBOXUSBREQ_SET_CONFIG VBOXUSBREQ_GET_CONFIG;
149typedef PVBOXUSBREQ_SET_CONFIG PVBOXUSBREQ_GET_CONFIG;
150
151typedef struct
152{
153 uint8_t bInterface; /* Interface number */
154 uint8_t bAlternate; /* Alternate setting */
155} VBOXUSBREQ_SET_INTERFACE, *PVBOXUSBREQ_SET_INTERFACE;
156
157typedef enum
158{
159 /** Close device not a reset. */
160 VBOXUSB_RESET_LEVEL_CLOSE = 0,
161 /** Hard reset resulting in device replug behaviour. */
162 VBOXUSB_RESET_LEVEL_REATTACH = 2,
163 /** Device-level reset. */
164 VBOXUSB_RESET_LEVEL_SOFT = 4
165} VBOXUSB_RESET_LEVEL;
166
167typedef struct
168{
169 VBOXUSB_RESET_LEVEL ResetLevel; /* Reset level after closing */
170} VBOXUSBREQ_CLOSE_DEVICE, *PVBOXUSBREQ_CLOSE_DEVICE;
171
172typedef struct
173{
174 uint8_t bEndpoint; /* Endpoint address */
175} VBOXUSBREQ_ABORT_PIPE, *PVBOXUSBREQ_ABORT_PIPE;
176
177typedef struct
178{
179 uint32_t u32Major; /* Driver major number */
180 uint32_t u32Minor; /* Driver minor number */
181} VBOXUSBREQ_GET_VERSION, *PVBOXUSBREQ_GET_VERSION;
182
183#pragma pack()
184
185/** The VBOXUSBREQ::u32Magic value for VBoxUSBMon. */
186#define VBOXUSBMON_MAGIC 0xba5eba11
187/** The VBOXUSBREQ::u32Magic value for VBoxUSB.*/
188#define VBOXUSB_MAGIC 0x601fba11
189/** The USBLib entry point for userland. */
190#define VBOXUSB_DEVICE_NAME "/dev/vboxusbmon"
191
192/** The USBMonitor Major version. */
193#define VBOXUSBMON_VERSION_MAJOR 2
194/** The USBMonitor Minor version. */
195#define VBOXUSBMON_VERSION_MINOR 1
196
197/** The USB Major version. */
198#define VBOXUSB_VERSION_MAJOR 1
199/** The USB Minor version. */
200#define VBOXUSB_VERSION_MINOR 1
201
202#ifdef RT_ARCH_AMD64
203# define VBOXUSB_IOCTL_FLAG 128
204#elif defined(RT_ARCH_X86)
205# define VBOXUSB_IOCTL_FLAG 0
206#else
207# error "dunno which arch this is!"
208#endif
209
210/** USB driver name*/
211#define VBOXUSB_DRIVER_NAME "vboxusb"
212
213/* No automatic buffering, size limited to 255 bytes => use VBOXUSBREQ for everything. */
214#define VBOXUSB_IOCTL_CODE(Function, Size) _IOWRN('V', (Function) | VBOXUSB_IOCTL_FLAG, sizeof(VBOXUSBREQ))
215#define VBOXUSB_IOCTL_CODE_FAST(Function) _IO( 'V', (Function) | VBOXUSB_IOCTL_FLAG)
216#define VBOXUSB_IOCTL_STRIP_SIZE(Code) (Code)
217
218#define VBOXUSBMON_IOCTL_ADD_FILTER VBOXUSB_IOCTL_CODE(1, (sizeof(VBoxUSBAddFilterReq)))
219#define VBOXUSBMON_IOCTL_REMOVE_FILTER VBOXUSB_IOCTL_CODE(2, (sizeof(VBoxUSBRemoveFilterReq)))
220#define VBOXUSBMON_IOCTL_RESET_DEVICE VBOXUSB_IOCTL_CODE(3, (sizeof(VBOXUSBREQ_RESET_DEVICE)))
221#define VBOXUSBMON_IOCTL_DEVICE_INSTANCE VBOXUSB_IOCTL_CODE(4, (sizeof(VBOXUSBREQ_DEVICE_INSTANCE)))
222#define VBOXUSBMON_IOCTL_CLIENT_INFO VBOXUSB_IOCTL_CODE(5, (sizeof(VBOXUSBREQ_CLIENT_PATH)))
223#define VBOXUSBMON_IOCTL_GET_VERSION VBOXUSB_IOCTL_CODE(6, (sizeof(VBOXUSBREQ_GET_VERSION)))
224
225/* VBoxUSB ioctls */
226#define VBOXUSB_IOCTL_SEND_URB VBOXUSB_IOCTL_CODE(20, (sizeof(VBOXUSBREQ_URB))) /* 1072146796 */
227#define VBOXUSB_IOCTL_REAP_URB VBOXUSB_IOCTL_CODE(21, (sizeof(VBOXUSBREQ_URB))) /* 1072146795 */
228#define VBOXUSB_IOCTL_CLEAR_EP VBOXUSB_IOCTL_CODE(22, (sizeof(VBOXUSBREQ_CLEAR_EP))) /* 1072146794 */
229#define VBOXUSB_IOCTL_SET_CONFIG VBOXUSB_IOCTL_CODE(23, (sizeof(VBOXUSBREQ_SET_CONFIG))) /* 1072146793 */
230#define VBOXUSB_IOCTL_SET_INTERFACE VBOXUSB_IOCTL_CODE(24, (sizeof(VBOXUSBREQ_SET_INTERFACE))) /* 1072146792 */
231#define VBOXUSB_IOCTL_CLOSE_DEVICE VBOXUSB_IOCTL_CODE(25, (sizeof(VBOXUSBREQ_CLOSE_DEVICE))) /* 1072146791 0xc0185699 */
232#define VBOXUSB_IOCTL_ABORT_PIPE VBOXUSB_IOCTL_CODE(26, (sizeof(VBOXUSBREQ_ABORT_PIPE))) /* 1072146790 */
233#define VBOXUSB_IOCTL_GET_CONFIG VBOXUSB_IOCTL_CODE(27, (sizeof(VBOXUSBREQ_GET_CONFIG))) /* 1072146789 */
234#define VBOXUSB_IOCTL_GET_VERSION VBOXUSB_IOCTL_CODE(28, (sizeof(VBOXUSBREQ_GET_VERSION))) /* 1072146788 */
235
236/** @} */
237
238/* USBLibHelper data for resetting the device. */
239typedef struct VBOXUSBHELPERDATA_RESET
240{
241 /** Path of the USB device. */
242 const char *pszDevicePath;
243 /** Re-enumerate or not. */
244 bool fHardReset;
245} VBOXUSBHELPERDATA_RESET;
246typedef VBOXUSBHELPERDATA_RESET *PVBOXUSBHELPERDATA_RESET;
247typedef const VBOXUSBHELPERDATA_RESET *PCVBOXUSBHELPERDATA_RESET;
248
249/* USBLibHelper data for device hijacking. */
250typedef struct VBOXUSBHELPERDATA_ALIAS
251{
252 /** Vendor ID. */
253 uint16_t idVendor;
254 /** Product ID. */
255 uint16_t idProduct;
256 /** Revision, integer part. */
257 uint16_t bcdDevice;
258 /** Path of the USB device. */
259 const char *pszDevicePath;
260} VBOXUSBHELPERDATA_ALIAS;
261typedef VBOXUSBHELPERDATA_ALIAS *PVBOXUSBHELPERDATA_ALIAS;
262typedef const VBOXUSBHELPERDATA_ALIAS *PCVBOXUSBHELPERDATA_ALIAS;
263
264USBLIB_DECL(int) USBLibResetDevice(char *pszDevicePath, bool fReattach);
265USBLIB_DECL(int) USBLibDeviceInstance(char *pszDevicePath, int *pInstance);
266USBLIB_DECL(int) USBLibGetClientInfo(char *pszDeviceIdent, char **ppszClientPath, int *pInstance);
267USBLIB_DECL(int) USBLibAddDeviceAlias(PUSBDEVICE pDevice);
268USBLIB_DECL(int) USBLibRemoveDeviceAlias(PUSBDEVICE pDevice);
269/*USBLIB_DECL(int) USBLibConfigureDevice(PUSBDEVICE pDevice);*/
270
271/** @} */
272RT_C_DECLS_END
273
274#endif
275
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