VirtualBox

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

Last change on this file since 41247 was 38016, checked in by vboxsync, 13 years ago

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