VirtualBox

source: vbox/trunk/src/VBox/HostDrivers/VBoxUSB/solaris/VBoxUSB-solaris.c@ 52491

Last change on this file since 52491 was 52491, checked in by vboxsync, 10 years ago

HostDrivers/VBoxUSB/solaris: Fix uninitialized cbDataout when errors happens in the ioctl.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 144.4 KB
Line 
1/* $Id: VBoxUSB-solaris.c 52491 2014-08-25 11:31:20Z vboxsync $ */
2/** @file
3 * VirtualBox USB Client Driver, Solaris Hosts.
4 */
5
6/*
7 * Copyright (C) 2008-2013 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/*******************************************************************************
28* Header Files *
29*******************************************************************************/
30#define LOG_GROUP LOG_GROUP_USB_DRV
31#ifdef DEBUG_ramshankar
32# define LOG_ENABLED
33# define LOG_INSTANCE RTLogRelDefaultInstance()
34#endif
35#include <VBox/version.h>
36#include <VBox/log.h>
37#include <VBox/err.h>
38#include <VBox/cdefs.h>
39#include <VBox/sup.h>
40#include <VBox/usblib-solaris.h>
41
42#include <iprt/assert.h>
43#include <iprt/initterm.h>
44#include <iprt/semaphore.h>
45#include <iprt/mem.h>
46#include <iprt/process.h>
47#include <iprt/string.h>
48#include <iprt/path.h>
49#include <iprt/thread.h>
50
51#define USBDRV_MAJOR_VER 2
52#define USBDRV_MINOR_VER 0
53#include <sys/usb/usba.h>
54#include <sys/strsun.h>
55#include "usbai_private.h"
56#include <sys/archsystm.h>
57#include <sys/disp.h>
58
59/** @todo review the locking here, verify assumptions about code executed
60 * without the vboxusb_state_t::Mtx mutex */
61
62/*******************************************************************************
63* Defined Constants And Macros *
64*******************************************************************************/
65/** The module name. */
66#define DEVICE_NAME "vboxusb"
67/** The module description as seen in 'modinfo'. */
68#define DEVICE_DESC_DRV "VirtualBox USB"
69
70/** Endpoint states */
71#define VBOXUSB_EP_INITIALIZED 0xa1fa1fa
72#define VBOXUSB_EP_STATE_NONE RT_BIT(0)
73#define VBOXUSB_EP_STATE_CLOSED RT_BIT(1)
74#define VBOXUSB_EP_STATE_OPENED RT_BIT(2)
75/** Polling states */
76#define VBOXUSB_POLL_OFF RT_BIT(0)
77#define VBOXUSB_POLL_ON RT_BIT(1)
78#define VBOXUSB_POLL_REAP_PENDING RT_BIT(2)
79#define VBOXUSB_POLL_DEV_UNPLUGGED RT_BIT(3)
80
81/** -=-=-=-=-=-=- Standard Specifics -=-=-=-=-=-=- */
82/** Max. supported endpoints */
83#define VBOXUSB_MAX_ENDPOINTS 32
84/** Size of USB Ctrl Xfer Header */
85#define VBOXUSB_CTRL_XFER_SIZE 0x08
86/**
87 * USB2.0 (Sec. 9-13) Bits 10..0 is the max packet size; for high speed Isoc/Intr, bits 12..11 is
88 * number of additional transaction opportunities per microframe.
89 */
90#define VBOXUSB_PKT_SIZE(pkt) (pkt & 0x07FF) * (1 + ((pkt >> 11) & 3))
91/** Endpoint Xfer Type */
92#define VBOXUSB_XFER_TYPE(endp) ((endp)->EpDesc.bmAttributes & USB_EP_ATTR_MASK)
93/** Endpoint Xfer Direction */
94#define VBOXUSB_XFER_DIR(endp) ((endp)->EpDesc.bEndpointAddress & USB_EP_DIR_IN)
95
96/** -=-=-=-=-=-=- Tunable Parameters -=-=-=-=-=-=- */
97/** Time to wait while draining inflight UBRs on suspend, in seconds. */
98#define VBOXUSB_DRAIN_TIME 20
99/** Ctrl Xfer timeout in seconds. */
100#define VBOXUSB_CTRL_XFER_TIMEOUT 10
101/** Bulk Xfer timeout in seconds. */
102#define VBOXUSB_BULK_XFER_TIMEOUT 10
103/** Intr Xfer timeout in seconds. */
104#define VBOXUSB_INTR_XFER_TIMEOUT 10
105/** Maximum URB queue length. */
106#define VBOXUSB_URB_QUEUE_SIZE 64
107/** Maximum asynchronous requests per pipe */
108#define VBOXUSB_MAX_PIPE_ASYNC_REQS 2
109
110/** For enabling global symbols while debugging **/
111#if defined(DEBUG_ramshankar)
112# define LOCAL
113#else
114# define LOCAL static
115#endif
116
117
118/*******************************************************************************
119* Kernel Entry Hooks *
120*******************************************************************************/
121int VBoxUSBSolarisOpen(dev_t *pDev, int fFlag, int fType, cred_t *pCred);
122int VBoxUSBSolarisClose(dev_t Dev, int fFlag, int fType, cred_t *pCred);
123int VBoxUSBSolarisRead(dev_t Dev, struct uio *pUio, cred_t *pCred);
124int VBoxUSBSolarisWrite(dev_t Dev, struct uio *pUio, cred_t *pCred);
125int VBoxUSBSolarisIOCtl(dev_t Dev, int Cmd, intptr_t pArg, int Mode, cred_t *pCred, int *pVal);
126int VBoxUSBSolarisPoll(dev_t Dev, short fEvents, int fAnyYet, short *pReqEvents, struct pollhead **ppPollHead);
127int VBoxUSBSolarisGetInfo(dev_info_t *pDip, ddi_info_cmd_t enmCmd, void *pArg, void **ppResult);
128int VBoxUSBSolarisAttach(dev_info_t *pDip, ddi_attach_cmd_t enmCmd);
129int VBoxUSBSolarisDetach(dev_info_t *pDip, ddi_detach_cmd_t enmCmd);
130int VBoxUSBSolarisPower(dev_info_t *pDip, int Component, int Level);
131
132
133/*******************************************************************************
134* Structures and Typedefs *
135*******************************************************************************/
136/**
137 * cb_ops: for drivers that support char/block entry points
138 */
139static struct cb_ops g_VBoxUSBSolarisCbOps =
140{
141 VBoxUSBSolarisOpen,
142 VBoxUSBSolarisClose,
143 nodev, /* b strategy */
144 nodev, /* b dump */
145 nodev, /* b print */
146 VBoxUSBSolarisRead,
147 VBoxUSBSolarisWrite,
148 VBoxUSBSolarisIOCtl,
149 nodev, /* c devmap */
150 nodev, /* c mmap */
151 nodev, /* c segmap */
152 VBoxUSBSolarisPoll,
153 ddi_prop_op, /* property ops */
154 NULL, /* streamtab */
155 D_NEW | D_MP, /* compat. flag */
156 CB_REV, /* revision */
157 nodev, /* c aread */
158 nodev /* c awrite */
159};
160
161/**
162 * dev_ops: for driver device operations
163 */
164static struct dev_ops g_VBoxUSBSolarisDevOps =
165{
166 DEVO_REV, /* driver build revision */
167 0, /* ref count */
168 VBoxUSBSolarisGetInfo,
169 nulldev, /* identify */
170 nulldev, /* probe */
171 VBoxUSBSolarisAttach,
172 VBoxUSBSolarisDetach,
173 nodev, /* reset */
174 &g_VBoxUSBSolarisCbOps,
175 NULL, /* bus ops */
176 VBoxUSBSolarisPower,
177 ddi_quiesce_not_needed
178};
179
180/**
181 * modldrv: export driver specifics to the kernel
182 */
183static struct modldrv g_VBoxUSBSolarisModule =
184{
185 &mod_driverops, /* extern from kernel */
186 DEVICE_DESC_DRV " " VBOX_VERSION_STRING "r" RT_XSTR(VBOX_SVN_REV),
187 &g_VBoxUSBSolarisDevOps
188};
189
190/**
191 * modlinkage: export install/remove/info to the kernel
192 */
193static struct modlinkage g_VBoxUSBSolarisModLinkage =
194{
195 MODREV_1,
196 &g_VBoxUSBSolarisModule,
197 NULL,
198};
199
200/**
201 * vboxusb_ep_t: Endpoint structure with info. for managing an endpoint.
202 */
203typedef struct vboxusb_ep_t
204{
205 uint_t fInitialized; /* Whether this Endpoint is initialized */
206 uint_t EpState; /* Endpoint state */
207 usb_ep_descr_t EpDesc; /* Endpoint descriptor */
208 uchar_t uCfgValue; /* Configuration value */
209 uchar_t uInterface; /* Interface number */
210 uchar_t uAlt; /* Alternate number */
211 usb_pipe_handle_t pPipe; /* Endpoint pipe handle */
212 usb_pipe_policy_t PipePolicy; /* Endpoint policy */
213 bool fIsocPolling; /* Whether Isoc. IN polling is enabled */
214 list_t hIsocInUrbs; /* Isoc. IN inflight URBs */
215 uint16_t cIsocInUrbs; /* Number of Isoc. IN inflight URBs */
216 list_t hIsocInLandedReqs; /* Isoc. IN landed requests */
217 uint16_t cbIsocInLandedReqs; /* Cumulative size of landed Isoc. IN requests */
218 size_t cbMaxIsocData; /* Maximum size of Isoc. IN landed buffer */
219} vboxusb_ep_t;
220
221/**
222 * vboxusb_isoc_req_t: Isoc IN. requests queued from device till they are reaped.
223 */
224typedef struct vboxusb_isoc_req_t
225{
226 mblk_t *pMsg; /* Pointer to the data buffer */
227 uint32_t cIsocPkts; /* Number of Isoc pkts */
228 VUSBISOC_PKT_DESC aIsocPkts[8]; /* Array of Isoc pkt descriptors */
229 list_node_t hListLink;
230} vboxusb_isoc_req_t;
231
232/**
233 * VBOXUSB_URB_STATE: Internal USB URB state.
234 */
235typedef enum VBOXUSB_URB_STATE
236{
237 VBOXUSB_URB_STATE_FREE = 0x00,
238 VBOXUSB_URB_STATE_INFLIGHT = 0x04,
239 VBOXUSB_URB_STATE_LANDED = 0x08
240} VBOXUSB_URB_STATE;
241
242/**
243 * vboxusb_urb_t: kernel URB representation.
244 */
245typedef struct vboxusb_urb_t
246{
247 void *pvUrbR3; /* Userspace URB address (untouched, returned while reaping) */
248 uint8_t bEndpoint; /* Endpoint address */
249 VUSBXFERTYPE enmType; /* Xfer type */
250 VUSBDIRECTION enmDir; /* Xfer direction */
251 VUSBSTATUS enmStatus; /* URB status */
252 bool fShortOk; /* Whether receiving less data than requested is acceptable. */
253 RTR3PTR pvDataR3; /* Userspace address of the original data buffer */
254 size_t cbDataR3; /* Size of the data buffer */
255 mblk_t *pMsg; /* Pointer to the data buffer */
256 uint32_t cIsocPkts; /* Number of Isoc pkts */
257 VUSBISOC_PKT_DESC aIsocPkts[8]; /* Array of Isoc pkt descriptors */
258 VBOXUSB_URB_STATE enmState; /* Whether free/in-flight etc. */
259 struct vboxusb_state_t *pState; /* Pointer to the device instance */
260 list_node_t hListLink; /* List node link handle */
261} vboxusb_urb_t;
262
263/**
264 * vboxusb_power_t: Per Device Power Management info.
265 */
266typedef struct vboxusb_power_t
267{
268 uint_t PowerStates; /* Bit mask of the power states */
269 int PowerBusy; /* Busy counter */
270 bool fPowerWakeup; /* Whether remote power wakeup is enabled */
271 bool fPowerRaise; /* Whether to raise the power level */
272 uint8_t PowerLevel; /* Current power level */
273} vboxusb_power_t;
274
275/**
276 * vboxusb_state_t: Per Device instance state info.
277 */
278typedef struct vboxusb_state_t
279{
280 dev_info_t *pDip; /* Per instance device info. */
281 usb_client_dev_data_t *pDevDesc; /* Parsed & complete device descriptor */
282 uint8_t DevState; /* Current USB Device state */
283 bool fClosed; /* Whether the device (default control pipe) is closed */
284 bool fRestoreCfg; /* Whether we changed configs to restore while tearing down */
285 bool fGetCfgReqDone; /* First GET_CONFIG request has been circumvented */
286 kmutex_t Mtx; /* Mutex state protection */
287 usb_serialization_t StateMulti; /* State serialization */
288 size_t cbMaxBulkXfer; /* Maximum bulk xfer size */
289 vboxusb_ep_t aEps[VBOXUSB_MAX_ENDPOINTS]; /* All endpoints structures */
290 list_t hUrbs; /* Handle to list of free/inflight URBs */
291 list_t hLandedUrbs; /* Handle to list of landed URBs */
292 uint16_t cInflightUrbs; /* Number of inflight URBs. */
293 pollhead_t PollHead; /* Handle to pollhead for waking polling processes */
294 int fPoll; /* Polling status flag */
295 RTPROCESS Process; /* The process (id) of the session */
296 VBOXUSBREQ_CLIENT_INFO ClientInfo; /* Registration data */
297 vboxusb_power_t *pPower; /* Power Management */
298} vboxusb_state_t;
299
300
301/*******************************************************************************
302* Internal Functions *
303*******************************************************************************/
304LOCAL int vboxUSBSolarisInitEndPoint(vboxusb_state_t *pState, usb_ep_data_t *pEpData, uchar_t uCfgValue,
305 uchar_t uInterface, uchar_t uAlt);
306LOCAL int vboxUSBSolarisInitAllEndPoints(vboxusb_state_t *pState);
307LOCAL int vboxUSBSolarisInitEndPointsForConfig(vboxusb_state_t *pState, uint8_t uCfgIndex);
308LOCAL int vboxUSBSolarisInitEndPointsForInterfaceAlt(vboxusb_state_t *pState, uint8_t uInterface, uint8_t uAlt);
309LOCAL void vboxUSBSolarisDestroyAllEndPoints(vboxusb_state_t *pState);
310LOCAL void vboxUSBSolarisDestroyEndPoint(vboxusb_state_t *pState, vboxusb_ep_t *pEp);
311LOCAL void vboxUSBSolarisCloseAllPipes(vboxusb_state_t *pState, bool fControlPipe);
312LOCAL int vboxUSBSolarisOpenPipe(vboxusb_state_t *pState, vboxusb_ep_t *pEp);
313LOCAL void vboxUSBSolarisClosePipe(vboxusb_state_t *pState, vboxusb_ep_t *pEp);
314LOCAL int vboxUSBSolarisCtrlXfer(vboxusb_state_t *pState, vboxusb_ep_t *pEp, vboxusb_urb_t *pUrb);
315LOCAL void vboxUSBSolarisCtrlXferCompleted(usb_pipe_handle_t pPipe, usb_ctrl_req_t *pReq);
316LOCAL int vboxUSBSolarisBulkXfer(vboxusb_state_t *pState, vboxusb_ep_t *pEp, vboxusb_urb_t *purb);
317LOCAL void vboxUSBSolarisBulkXferCompleted(usb_pipe_handle_t pPipe, usb_bulk_req_t *pReq);
318LOCAL int vboxUSBSolarisIntrXfer(vboxusb_state_t *pState, vboxusb_ep_t *pEp, vboxusb_urb_t *pUrb);
319LOCAL void vboxUSBSolarisIntrXferCompleted(usb_pipe_handle_t pPipe, usb_intr_req_t *pReq);
320LOCAL int vboxUSBSolarisIsocXfer(vboxusb_state_t *pState, vboxusb_ep_t *pEp, vboxusb_urb_t *pUrb);
321LOCAL void vboxUSBSolarisIsocInXferCompleted(usb_pipe_handle_t pPipe, usb_isoc_req_t *pReq);
322LOCAL void vboxUSBSolarisIsocInXferError(usb_pipe_handle_t pPipe, usb_isoc_req_t *pReq);
323LOCAL void vboxUSBSolarisIsocOutXferCompleted(usb_pipe_handle_t pPipe, usb_isoc_req_t *pReq);
324LOCAL vboxusb_urb_t *vboxUSBSolarisGetIsocInURB(vboxusb_state_t *pState, PVBOXUSBREQ_URB pUrbReq);
325LOCAL vboxusb_urb_t *vboxUSBSolarisQueueURB(vboxusb_state_t *pState, PVBOXUSBREQ_URB pUrbReq, mblk_t *pMsg);
326LOCAL inline void vboxUSBSolarisConcatMsg(vboxusb_urb_t *pUrb);
327LOCAL inline void vboxUSBSolarisDeQueueURB(vboxusb_urb_t *pUrb, int URBStatus);
328LOCAL inline void vboxUSBSolarisNotifyComplete(vboxusb_state_t *pState);
329LOCAL int vboxUSBSolarisProcessIOCtl(int iFunction, void *pvState, int Mode, PVBOXUSBREQ pUSBReq, void *pvBuf,
330 size_t *pcbDataOut);
331LOCAL bool vboxUSBSolarisIsUSBDevice(dev_info_t *pDip);
332
333/** Device Operation Hooks */
334LOCAL int vboxUSBSolarisSendURB(vboxusb_state_t *pState, PVBOXUSBREQ_URB pUrbReq, int Mode);
335LOCAL int vboxUSBSolarisReapURB(vboxusb_state_t *pState, PVBOXUSBREQ_URB pUrbReq, int Mode);
336LOCAL int vboxUSBSolarisClearEndPoint(vboxusb_state_t *pState, uint8_t bEndpoint);
337LOCAL int vboxUSBSolarisSetConfig(vboxusb_state_t *pState, uint8_t bCfgValue);
338LOCAL int vboxUSBSolarisGetConfig(vboxusb_state_t *pState, uint8_t *pCfgValue);
339LOCAL int vboxUSBSolarisSetInterface(vboxusb_state_t *pState, uint8_t uInterface, uint8_t uAlt);
340LOCAL int vboxUSBSolarisCloseDevice(vboxusb_state_t *pState, VBOXUSB_RESET_LEVEL enmReset);
341LOCAL int vboxUSBSolarisAbortPipe(vboxusb_state_t *pState, uint8_t bEndpoint);
342LOCAL int vboxUSBSolarisGetConfigIndex(vboxusb_state_t *pState, uint_t uCfgValue);
343
344/** Hotplug & Power Management Hooks */
345LOCAL inline void vboxUSBSolarisNotifyHotplug(vboxusb_state_t *pState);
346LOCAL int vboxUSBSolarisDeviceDisconnected(dev_info_t *pDip);
347LOCAL int vboxUSBSolarisDeviceReconnected(dev_info_t *pDip);
348
349LOCAL int vboxUSBSolarisInitPower(vboxusb_state_t *pState);
350LOCAL void vboxUSBSolarisDestroyPower(vboxusb_state_t *pState);
351LOCAL int vboxUSBSolarisDeviceSuspend(vboxusb_state_t *pState);
352LOCAL void vboxUSBSolarisDeviceResume(vboxusb_state_t *pState);
353LOCAL void vboxUSBSolarisDeviceRestore(vboxusb_state_t *pState);
354LOCAL void vboxUSBSolarisPowerBusy(vboxusb_state_t *pState);
355LOCAL void vboxUSBSolarisPowerIdle(vboxusb_state_t *pState);
356
357/** Monitor Hooks */
358int VBoxUSBMonSolarisRegisterClient(dev_info_t *pClientDip, PVBOXUSB_CLIENT_INFO pClientInfo);
359int VBoxUSBMonSolarisUnregisterClient(dev_info_t *pClientDip);
360
361/** Callbacks from Monitor */
362LOCAL int vboxUSBSolarisSetConsumerCredentials(RTPROCESS Process, int Instance, void *pvReserved);
363
364
365/*******************************************************************************
366* Global Variables *
367*******************************************************************************/
368/** Global list of all device instances. */
369static void *g_pVBoxUSBSolarisState;
370
371/** The default endpoint descriptor */
372static usb_ep_descr_t g_VBoxUSBSolarisDefaultEpDesc = {7, 5, 0, USB_EP_ATTR_CONTROL, 8, 0};
373
374/** Hotplug events */
375static usb_event_t g_VBoxUSBSolarisEvents =
376{
377 vboxUSBSolarisDeviceDisconnected,
378 vboxUSBSolarisDeviceReconnected,
379 NULL, /* presuspend */
380 NULL /* postresume */
381};
382
383
384/**
385 * Kernel entry points
386 */
387int _init(void)
388{
389 LogFunc((DEVICE_NAME ":_init\n"));
390
391 /*
392 * Prevent module autounloading.
393 */
394 modctl_t *pModCtl = mod_getctl(&g_VBoxUSBSolarisModLinkage);
395 if (pModCtl)
396 pModCtl->mod_loadflags |= MOD_NOAUTOUNLOAD;
397 else
398 LogRel((DEVICE_NAME ":failed to disable autounloading!\n"));
399
400 /*
401 * Initialize IPRT R0 driver, which internally calls OS-specific r0 init.
402 */
403 int rc = RTR0Init(0);
404 if (RT_SUCCESS(rc))
405 {
406 rc = ddi_soft_state_init(&g_pVBoxUSBSolarisState, sizeof(vboxusb_state_t), 4 /* pre-alloc */);
407 if (!rc)
408 {
409 rc = mod_install(&g_VBoxUSBSolarisModLinkage);
410 if (!rc)
411 return rc;
412
413 LogRel((DEVICE_NAME ":mod_install failed! rc=%d\n", rc));
414 ddi_soft_state_fini(&g_pVBoxUSBSolarisState);
415 }
416 else
417 LogRel((DEVICE_NAME ":failed to initialize soft state.\n"));
418
419 RTR0Term();
420 }
421 else
422 LogRel((DEVICE_NAME ":RTR0Init failed! rc=%d\n", rc));
423 return RTErrConvertToErrno(rc);
424}
425
426
427int _fini(void)
428{
429 int rc;
430
431 LogFunc((DEVICE_NAME ":_fini\n"));
432
433 rc = mod_remove(&g_VBoxUSBSolarisModLinkage);
434 if (!rc)
435 {
436 ddi_soft_state_fini(&g_pVBoxUSBSolarisState);
437 RTR0Term();
438 }
439
440 return rc;
441}
442
443
444int _info(struct modinfo *pModInfo)
445{
446 LogFunc((DEVICE_NAME ":_info\n"));
447
448 return mod_info(&g_VBoxUSBSolarisModLinkage, pModInfo);
449}
450
451
452/**
453 * Attach entry point, to attach a device to the system or resume it.
454 *
455 * @param pDip The module structure instance.
456 * @param enmCmd Attach type (ddi_attach_cmd_t)
457 *
458 * @returns corresponding solaris error code.
459 */
460int VBoxUSBSolarisAttach(dev_info_t *pDip, ddi_attach_cmd_t enmCmd)
461{
462 LogFunc((DEVICE_NAME ":VBoxUSBSolarisAttach pDip=%p enmCmd=%d\n", pDip, enmCmd));
463
464 int rc;
465 int instance = ddi_get_instance(pDip);
466 vboxusb_state_t *pState = NULL;
467
468 switch (enmCmd)
469 {
470 case DDI_ATTACH:
471 {
472 rc = ddi_soft_state_zalloc(g_pVBoxUSBSolarisState, instance);
473 if (rc == DDI_SUCCESS)
474 {
475 pState = ddi_get_soft_state(g_pVBoxUSBSolarisState, instance);
476 if (RT_LIKELY(pState))
477 {
478 pState->pDip = pDip;
479 pState->pDevDesc = NULL;
480 pState->fClosed = false;
481 pState->fRestoreCfg = false;
482 pState->fGetCfgReqDone = false;
483 bzero(pState->aEps, sizeof(pState->aEps));
484 list_create(&pState->hUrbs, sizeof(vboxusb_urb_t), offsetof(vboxusb_urb_t, hListLink));
485 list_create(&pState->hLandedUrbs, sizeof(vboxusb_urb_t), offsetof(vboxusb_urb_t, hListLink));
486 pState->cInflightUrbs = 0;
487 pState->fPoll = VBOXUSB_POLL_OFF;
488 pState->Process = NIL_RTPROCESS;
489 pState->pPower = NULL;
490
491 /*
492 * There is a bug in usb_client_attach() as of Nevada 120 which panics when we bind to
493 * a non-USB device. So check if we are really binding to a USB device or not.
494 */
495 if (vboxUSBSolarisIsUSBDevice(pState->pDip))
496 {
497 /*
498 * Here starts the USB specifics.
499 */
500 rc = usb_client_attach(pState->pDip, USBDRV_VERSION, 0);
501 if (rc == USB_SUCCESS)
502 {
503 /*
504 * Parse out the entire descriptor.
505 */
506 rc = usb_get_dev_data(pState->pDip, &pState->pDevDesc, USB_PARSE_LVL_ALL, 0 /* Unused */);
507 if (rc == USB_SUCCESS)
508 {
509#ifdef DEBUG_ramshankar
510 usb_print_descr_tree(pState->pDip, pState->pDevDesc);
511#endif
512
513 /*
514 * Initialize state locks.
515 */
516 mutex_init(&pState->Mtx, NULL, MUTEX_DRIVER, pState->pDevDesc->dev_iblock_cookie);
517 pState->StateMulti = usb_init_serialization(pState->pDip, USB_INIT_SER_CHECK_SAME_THREAD);
518
519 /*
520 * Get maximum bulk transfer size supported by the HCD.
521 */
522 rc = usb_pipe_get_max_bulk_transfer_size(pState->pDip, &pState->cbMaxBulkXfer);
523 if (rc == USB_SUCCESS)
524 {
525 Log((DEVICE_NAME ":VBoxUSBSolarisAttach cbMaxBulkXfer=%d\n", pState->cbMaxBulkXfer));
526
527 /*
528 * Initialize all endpoints.
529 */
530 rc = vboxUSBSolarisInitAllEndPoints(pState);
531 if (RT_SUCCESS(rc))
532 {
533 /*
534 * Set the device state.
535 */
536 pState->DevState = USB_DEV_ONLINE;
537
538 /*
539 * Initialize power management for the device.
540 */
541 rc = vboxUSBSolarisInitPower(pState);
542 if (RT_SUCCESS(rc))
543 {
544 /*
545 * Update endpoints (descriptors) for the current config.
546 */
547 vboxUSBSolarisInitEndPointsForConfig(pState, usb_get_current_cfgidx(pState->pDip));
548
549 /*
550 * Publish the minor node.
551 */
552 rc = ddi_create_priv_minor_node(pDip, DEVICE_NAME, S_IFCHR, instance, DDI_PSEUDO, 0,
553 "none", "none", 0666);
554 if (RT_LIKELY(rc == DDI_SUCCESS))
555 {
556 /*
557 * Register hotplug callbacks.
558 */
559 rc = usb_register_event_cbs(pState->pDip, &g_VBoxUSBSolarisEvents, 0 /* flags */);
560 if (RT_LIKELY(rc == USB_SUCCESS))
561 {
562 /*
563 * Register with our monitor driver.
564 */
565 bzero(&pState->ClientInfo, sizeof(pState->ClientInfo));
566 char szDevicePath[MAXPATHLEN];
567 ddi_pathname(pState->pDip, szDevicePath);
568 RTStrPrintf(pState->ClientInfo.szClientPath,
569 sizeof(pState->ClientInfo.szClientPath),
570 "/devices%s:%s", szDevicePath,DEVICE_NAME);
571 RTPathStripFilename(szDevicePath);
572 RTStrPrintf(pState->ClientInfo.szDeviceIdent,
573 sizeof(pState->ClientInfo.szDeviceIdent),
574 "%#x:%#x:%d:%s",
575 pState->pDevDesc->dev_descr->idVendor,
576 pState->pDevDesc->dev_descr->idProduct,
577 pState->pDevDesc->dev_descr->bcdDevice, szDevicePath);
578 pState->ClientInfo.Instance = instance;
579 pState->ClientInfo.pfnSetConsumerCredentials = &vboxUSBSolarisSetConsumerCredentials;
580 rc = VBoxUSBMonSolarisRegisterClient(pState->pDip, &pState->ClientInfo);
581 if (RT_SUCCESS(rc))
582 {
583 LogRel((DEVICE_NAME ": Captured %s %#x:%#x:%d:%s\n",
584 pState->pDevDesc->dev_product ? pState->pDevDesc->dev_product
585 : "<Unnamed USB device>",
586 pState->pDevDesc->dev_descr->idVendor,
587 pState->pDevDesc->dev_descr->idProduct,
588 pState->pDevDesc->dev_descr->bcdDevice,
589 pState->ClientInfo.szClientPath));
590
591 return DDI_SUCCESS;
592 }
593 else
594 {
595 LogRel((DEVICE_NAME ":VBoxUSBMonSolarisRegisterClient failed! rc=%d "
596 "path=%s instance=%d\n", rc, pState->ClientInfo.szClientPath,
597 instance));
598 }
599
600 usb_unregister_event_cbs(pState->pDip, &g_VBoxUSBSolarisEvents);
601 }
602 else
603 LogRel((DEVICE_NAME ":VBoxUSBSolarisAttach failed to register hotplug "
604 "callbacks! rc=%d\n", rc));
605
606 ddi_remove_minor_node(pState->pDip, NULL);
607 }
608 else
609 {
610 LogRel((DEVICE_NAME ":VBoxUSBSolarisAttach ddi_create_minor_node failed! rc=%d\n",
611 rc));
612 }
613 }
614 else
615 {
616 LogRel((DEVICE_NAME ":VBoxUSBSolarisAttach failed to initialize power management! "
617 "rc=%d\n", rc));
618 }
619 }
620 else
621 {
622 LogRel((DEVICE_NAME ":VBoxUSBSolarisAttach vboxUSBSolarisInitAllEndPoints failed! "
623 "rc=%d\n"));
624 }
625 }
626 else
627 {
628 LogRel((DEVICE_NAME ":VBoxUSBSolarisAttach usb_pipe_get_max_bulk_transfer_size failed! "
629 "rc=%d\n", rc));
630 }
631
632 usb_fini_serialization(pState->StateMulti);
633 mutex_destroy(&pState->Mtx);
634 usb_free_dev_data(pState->pDip, pState->pDevDesc);
635 }
636 else
637 LogRel((DEVICE_NAME ":VBoxUSBSolarisAttach failed to get device descriptor. rc=%d\n", rc));
638
639 usb_client_detach(pState->pDip, NULL);
640 }
641 else
642 LogRel((DEVICE_NAME ":VBoxUSBSolarisAttach usb_client_attach failed! rc=%d\n", rc));
643 }
644 else
645 {
646 /* This would appear on every boot if it were LogRel() */
647 Log((DEVICE_NAME ":VBoxUSBSolarisAttach not a USB device.\n"));
648 }
649 }
650 else
651 LogRel((DEVICE_NAME ":VBoxUSBSolarisAttach failed to get soft state\n", sizeof(*pState)));
652
653 ddi_soft_state_free(g_pVBoxUSBSolarisState, instance);
654 }
655 else
656 LogRel((DEVICE_NAME ":VBoxUSBSolarisAttach failed to alloc soft state. rc=%d\n", rc));
657
658 return DDI_FAILURE;
659 }
660
661 case DDI_RESUME:
662 {
663 pState = ddi_get_soft_state(g_pVBoxUSBSolarisState, instance);
664 if (RT_UNLIKELY(!pState))
665 {
666 LogRel((DEVICE_NAME ":VBoxUSBSolarisAttach DDI_RESUME: failed to get soft state on detach.\n"));
667 return DDI_FAILURE;
668 }
669
670 vboxUSBSolarisDeviceResume(pState);
671 return DDI_SUCCESS;
672 }
673
674 default:
675 return DDI_FAILURE;
676 }
677}
678
679
680/**
681 * Detach entry point, to detach a device to the system or suspend it.
682 *
683 * @param pDip The module structure instance.
684 * @param enmCmd Attach type (ddi_attach_cmd_t)
685 *
686 * @returns corresponding solaris error code.
687 */
688int VBoxUSBSolarisDetach(dev_info_t *pDip, ddi_detach_cmd_t enmCmd)
689{
690 LogFunc((DEVICE_NAME ":VBoxUSBSolarisDetach pDip=%p enmCmd=%d\n", pDip, enmCmd));
691
692 int instance = ddi_get_instance(pDip);
693 vboxusb_state_t *pState = ddi_get_soft_state(g_pVBoxUSBSolarisState, instance);
694 if (RT_UNLIKELY(!pState))
695 {
696 LogRel((DEVICE_NAME ":VBoxUSBSolarisDetach failed to get soft state on detach.\n"));
697 return DDI_FAILURE;
698 }
699
700 switch (enmCmd)
701 {
702 case DDI_DETACH:
703 {
704 /*
705 * At this point it must be assumed that the default control pipe has
706 * already been closed by userland (via VBoxUSBSolarisClose() entry point).
707 * Once it's closed we can no longer open or reference the device here.
708 */
709
710 /*
711 * Notify userland if any that we're gone (while resetting device held by us).
712 */
713 vboxUSBSolarisNotifyHotplug(pState);
714
715 /*
716 * Unregister hotplug callback events first without holding the mutex as the callbacks
717 * would otherwise block on the mutex.
718 */
719 usb_unregister_event_cbs(pDip, &g_VBoxUSBSolarisEvents);
720
721
722 /*
723 * Serialize: paranoid; drain other driver activity.
724 */
725 usb_serialize_access(pState->StateMulti, USB_WAIT, 0);
726 usb_release_access(pState->StateMulti);
727 mutex_enter(&pState->Mtx);
728
729 /*
730 * Close all endpoints.
731 */
732 vboxUSBSolarisCloseAllPipes(pState, true /* ControlPipe */);
733 pState->fClosed = true;
734
735 /*
736 * Deinitialize power, destroy endpoints.
737 */
738 vboxUSBSolarisDestroyPower(pState);
739 vboxUSBSolarisDestroyAllEndPoints(pState);
740
741 /*
742 * Free up all URBs.
743 */
744 vboxusb_urb_t *pUrb = NULL;
745 while ((pUrb = list_remove_head(&pState->hUrbs)) != NULL)
746 {
747 if (pUrb->pMsg)
748 freemsg(pUrb->pMsg);
749 RTMemFree(pUrb);
750 }
751
752 while ((pUrb = list_remove_head(&pState->hLandedUrbs)) != NULL)
753 {
754 if (pUrb->pMsg)
755 freemsg(pUrb->pMsg);
756 RTMemFree(pUrb);
757 }
758 pState->cInflightUrbs = 0;
759 list_destroy(&pState->hUrbs);
760 list_destroy(&pState->hLandedUrbs);
761
762 /*
763 * Destroy locks, free up descriptor and detach from USBA.
764 */
765 mutex_exit(&pState->Mtx);
766 usb_fini_serialization(pState->StateMulti);
767 mutex_destroy(&pState->Mtx);
768
769 usb_free_dev_data(pState->pDip, pState->pDevDesc);
770 usb_client_detach(pState->pDip, NULL);
771
772 /*
773 * Deregister with our Monitor driver.
774 */
775 VBoxUSBMonSolarisUnregisterClient(pState->pDip);
776
777 ddi_remove_minor_node(pState->pDip, NULL);
778
779 LogRel((DEVICE_NAME ": Released %s %s\n",
780 pState->pDevDesc->dev_product ? pState->pDevDesc->dev_product : "<Unnamed USB device>",
781 pState->ClientInfo.szDeviceIdent));
782
783 ddi_soft_state_free(g_pVBoxUSBSolarisState, instance);
784 pState = NULL;
785
786 return DDI_SUCCESS;
787 }
788
789 case DDI_SUSPEND:
790 {
791 int rc = vboxUSBSolarisDeviceSuspend(pState);
792 if (RT_SUCCESS(rc))
793 return DDI_SUCCESS;
794
795 return DDI_FAILURE;
796 }
797
798 default:
799 return DDI_FAILURE;
800 }
801}
802
803
804/**
805 * Info entry point, called by solaris kernel for obtaining driver info.
806 *
807 * @param pDip The module structure instance (do not use).
808 * @param enmCmd Information request type.
809 * @param pvArg Type specific argument.
810 * @param ppvResult Where to store the requested info.
811 *
812 * @returns corresponding solaris error code.
813 */
814int VBoxUSBSolarisGetInfo(dev_info_t *pDip, ddi_info_cmd_t enmCmd, void *pvArg, void **ppvResult)
815{
816 LogFunc((DEVICE_NAME ":VBoxUSBSolarisGetInfo\n"));
817
818 vboxusb_state_t *pState = NULL;
819 int instance = getminor((dev_t)pvArg);
820
821 switch (enmCmd)
822 {
823 case DDI_INFO_DEVT2DEVINFO:
824 {
825 /*
826 * One is to one mapping of instance & minor number as we publish only one minor node per device.
827 */
828 pState = ddi_get_soft_state(g_pVBoxUSBSolarisState, instance);
829 if (pState)
830 {
831 *ppvResult = (void *)pState->pDip;
832 return DDI_SUCCESS;
833 }
834 else
835 LogRel((DEVICE_NAME ":VBoxUSBSolarisGetInfo failed to get device state.\n"));
836 return DDI_FAILURE;
837 }
838
839 case DDI_INFO_DEVT2INSTANCE:
840 {
841 *ppvResult = (void *)(uintptr_t)instance;
842 return DDI_SUCCESS;
843 }
844
845 default:
846 return DDI_FAILURE;
847 }
848}
849
850
851/**
852 * Callback invoked from the Monitor driver when a VM process tries to access
853 * this client instance. This determines which VM process will be allowed to
854 * open and access the USB device.
855 *
856 * @returns VBox status code.
857 *
858 * @param Process The VM process performing the client info. query.
859 * @param Instance This client instance (the one set while we register
860 * ourselves to the Monitor driver)
861 * @param pvReserved Reserved for future, unused.
862 */
863LOCAL int vboxUSBSolarisSetConsumerCredentials(RTPROCESS Process, int Instance, void *pvReserved)
864{
865 LogFunc((DEVICE_NAME ":vboxUSBSolarisSetConsumerCredentials Process=%u Instance=%d\n", Process, Instance));
866 vboxusb_state_t *pState = ddi_get_soft_state(g_pVBoxUSBSolarisState, Instance);
867 if (!pState)
868 {
869 LogRel((DEVICE_NAME ":vboxUSBSolarisSetConsumerCredentials failed to get device state for instance %d\n", Instance));
870 return VERR_INVALID_STATE;
871 }
872
873 int rc = VINF_SUCCESS;
874 mutex_enter(&pState->Mtx);
875
876 if (pState->Process == NIL_RTPROCESS)
877 pState->Process = Process;
878 else
879 {
880 LogRel((DEVICE_NAME ":vboxUSBSolarisSetConsumerCredentials failed! Process %u already has client open.\n",
881 pState->Process));
882 rc = VERR_RESOURCE_BUSY;
883 }
884
885 mutex_exit(&pState->Mtx);
886
887 return rc;
888}
889
890
891int VBoxUSBSolarisOpen(dev_t *pDev, int fFlag, int fType, cred_t *pCred)
892{
893 LogFunc((DEVICE_NAME ":VBoxUSBSolarisOpen pDev=%p fFlag=%d fType=%d pCred=%p\n", pDev, fFlag, fType, pCred));
894
895 /*
896 * Verify we are being opened as a character device
897 */
898 if (fType != OTYP_CHR)
899 return EINVAL;
900
901 /*
902 * One is to one mapping. (Minor<=>Instance).
903 */
904 int instance = getminor((dev_t)*pDev);
905 vboxusb_state_t *pState = ddi_get_soft_state(g_pVBoxUSBSolarisState, instance);
906 if (!pState)
907 {
908 LogRel((DEVICE_NAME ":VBoxUSBSolarisOpen failed to get device state for instance %d\n", instance));
909 return ENXIO;
910 }
911
912 mutex_enter(&pState->Mtx);
913
914 /*
915 * Only one user process can open a device instance at a time.
916 */
917 if (pState->Process != RTProcSelf())
918 {
919 if (pState->Process == NIL_RTPROCESS)
920 LogRel((DEVICE_NAME ":VBoxUSBSolarisOpen No prior information about authorized process.\n"));
921 else
922 LogRel((DEVICE_NAME ":VBoxUSBSolarisOpen Process %u is already using this device instance.\n", pState->Process));
923
924 mutex_exit(&pState->Mtx);
925 return EPERM;
926 }
927
928 pState->fPoll = VBOXUSB_POLL_ON;
929
930 mutex_exit(&pState->Mtx);
931
932 NOREF(fFlag);
933 NOREF(pCred);
934
935 return 0;
936}
937
938
939int VBoxUSBSolarisClose(dev_t Dev, int fFlag, int fType, cred_t *pCred)
940{
941 LogFunc((DEVICE_NAME ":VBoxUSBSolarisClose Dev=%d fFlag=%d fType=%d pCred=%p\n", Dev, fFlag, fType, pCred));
942
943 int instance = getminor((dev_t)Dev);
944 vboxusb_state_t *pState = ddi_get_soft_state(g_pVBoxUSBSolarisState, instance);
945 if (RT_UNLIKELY(!pState))
946 {
947 LogRel((DEVICE_NAME ":VBoxUSBSolarisClose failed to get device state for instance %d\n", instance));
948 return ENXIO;
949 }
950
951 mutex_enter(&pState->Mtx);
952 pState->fPoll = VBOXUSB_POLL_OFF;
953 pState->Process = NIL_RTPROCESS;
954 mutex_exit(&pState->Mtx);
955
956 return 0;
957}
958
959
960int VBoxUSBSolarisRead(dev_t Dev, struct uio *pUio, cred_t *pCred)
961{
962 LogFunc((DEVICE_NAME ":VBoxUSBSolarisRead\n"));
963 return ENOTSUP;
964}
965
966
967int VBoxUSBSolarisWrite(dev_t Dev, struct uio *pUio, cred_t *pCred)
968{
969 LogFunc((DEVICE_NAME ":VBoxUSBSolarisWrite\n"));
970 return ENOTSUP;
971}
972
973
974int VBoxUSBSolarisPoll(dev_t Dev, short fEvents, int fAnyYet, short *pReqEvents, struct pollhead **ppPollHead)
975{
976 LogFunc((DEVICE_NAME ":VBoxUSBSolarisPoll Dev=%d fEvents=%d fAnyYet=%d pReqEvents=%p\n", Dev, fEvents, fAnyYet, pReqEvents));
977
978 /*
979 * Get the device state (one to one mapping).
980 */
981 int instance = getminor((dev_t)Dev);
982 vboxusb_state_t *pState = ddi_get_soft_state(g_pVBoxUSBSolarisState, instance);
983 if (RT_UNLIKELY(!pState))
984 {
985 LogRel((DEVICE_NAME ":VBoxUSBSolarisPoll: no state data for %d\n", instance));
986 return ENXIO;
987 }
988
989 mutex_enter(&pState->Mtx);
990
991 /*
992 * "fEvents" HAS to be POLLIN. We won't bother to test it. The caller
993 * must always requests input events. Disconnect event (POLLHUP) is invalid in "fEvents".
994 */
995 fEvents = 0;
996 if (pState->fPoll & VBOXUSB_POLL_DEV_UNPLUGGED)
997 {
998 fEvents |= POLLHUP;
999 pState->fPoll &= ~VBOXUSB_POLL_DEV_UNPLUGGED;
1000 }
1001
1002 if (pState->fPoll & VBOXUSB_POLL_REAP_PENDING)
1003 {
1004 fEvents |= POLLIN;
1005 pState->fPoll &= ~VBOXUSB_POLL_REAP_PENDING;
1006 }
1007
1008 if ( !fEvents
1009 && !fAnyYet)
1010 {
1011 *ppPollHead = &pState->PollHead;
1012 }
1013
1014 *pReqEvents = fEvents;
1015
1016 mutex_exit(&pState->Mtx);
1017
1018 return 0;
1019}
1020
1021
1022int VBoxUSBSolarisPower(dev_info_t *pDip, int Component, int Level)
1023{
1024 LogFunc((DEVICE_NAME ":VBoxUSBSolarisPower pDip=%p Component=%d Level=%d\n", pDip, Component, Level));
1025
1026 int instance = ddi_get_instance(pDip);
1027 vboxusb_state_t *pState = ddi_get_soft_state(g_pVBoxUSBSolarisState, instance);
1028 if (RT_UNLIKELY(!pState))
1029 {
1030 LogRel((DEVICE_NAME ":VBoxUSBSolarisPower Failed! missing state.\n"));
1031 return DDI_FAILURE;
1032 }
1033
1034 if (!pState->pPower)
1035 return DDI_SUCCESS;
1036
1037 usb_serialize_access(pState->StateMulti, USB_WAIT, 0);
1038 mutex_enter(&pState->Mtx);
1039
1040 int rc = USB_FAILURE;
1041 if (pState->DevState == USB_DEV_ONLINE)
1042 {
1043 /*
1044 * Check if we are transitioning to a valid power state.
1045 */
1046 if (!USB_DEV_PWRSTATE_OK(pState->pPower->PowerStates, Level))
1047 {
1048 switch (Level)
1049 {
1050 case USB_DEV_OS_PWR_OFF:
1051 {
1052 if (pState->pPower->PowerBusy)
1053 break;
1054
1055 /*
1056 * USB D3 command.
1057 */
1058 pState->pPower->PowerLevel = USB_DEV_OS_PWR_OFF;
1059 mutex_exit(&pState->Mtx);
1060 rc = usb_set_device_pwrlvl3(pDip);
1061 mutex_enter(&pState->Mtx);
1062 break;
1063 }
1064
1065 case USB_DEV_OS_FULL_PWR:
1066 {
1067 /*
1068 * Can happen during shutdown of the OS.
1069 */
1070 pState->pPower->PowerLevel = USB_DEV_OS_FULL_PWR;
1071 mutex_exit(&pState->Mtx);
1072 rc = usb_set_device_pwrlvl0(pDip);
1073 mutex_enter(&pState->Mtx);
1074 break;
1075 }
1076
1077 default: /* Power levels 1, 2 not implemented */
1078 break;
1079 }
1080 }
1081 else
1082 Log((DEVICE_NAME ":USB_DEV_PWRSTATE_OK failed.\n"));
1083 }
1084 else
1085 rc = USB_SUCCESS;
1086
1087 mutex_exit(&pState->Mtx);
1088 usb_release_access(pState->StateMulti);
1089 return rc == USB_SUCCESS ? DDI_SUCCESS : DDI_FAILURE;
1090}
1091
1092
1093/** @def IOCPARM_LEN
1094 * Gets the length from the ioctl number.
1095 * This is normally defined by sys/ioccom.h on BSD systems...
1096 */
1097#ifndef IOCPARM_LEN
1098# define IOCPARM_LEN(Code) (((Code) >> 16) & IOCPARM_MASK)
1099#endif
1100
1101int VBoxUSBSolarisIOCtl(dev_t Dev, int Cmd, intptr_t pArg, int Mode, cred_t *pCred, int *pVal)
1102{
1103/* LogFunc((DEVICE_NAME ":VBoxUSBSolarisIOCtl Dev=%d Cmd=%d pArg=%p Mode=%d\n", Dev, Cmd, pArg)); */
1104
1105 /*
1106 * Get the device state (one to one mapping).
1107 */
1108 int instance = getminor((dev_t)Dev);
1109 vboxusb_state_t *pState = ddi_get_soft_state(g_pVBoxUSBSolarisState, instance);
1110 if (RT_UNLIKELY(!pState))
1111 {
1112 LogRel((DEVICE_NAME ":VBoxUSBSolarisIOCtl: no state data for %d\n", instance));
1113 return EINVAL;
1114 }
1115
1116 /*
1117 * Read the request wrapper.
1118 */
1119 VBOXUSBREQ ReqWrap;
1120 if (IOCPARM_LEN(Cmd) != sizeof(ReqWrap))
1121 {
1122 LogRel((DEVICE_NAME ": VBoxUSBSolarisIOCtl: bad request %#x size=%d expected=%d\n", Cmd, IOCPARM_LEN(Cmd),
1123 sizeof(ReqWrap)));
1124 return ENOTTY;
1125 }
1126
1127 int rc = ddi_copyin((void *)pArg, &ReqWrap, sizeof(ReqWrap), Mode);
1128 if (RT_UNLIKELY(rc))
1129 {
1130 LogRel((DEVICE_NAME ": VBoxUSBSolarisIOCtl: ddi_copyin failed to read header pArg=%p Cmd=%d. rc=%d.\n", pArg, Cmd, rc));
1131 return EINVAL;
1132 }
1133
1134 if (ReqWrap.u32Magic != VBOXUSB_MAGIC)
1135 {
1136 LogRel((DEVICE_NAME ": VBoxUSBSolarisIOCtl: bad magic %#x; pArg=%p Cmd=%d.\n", ReqWrap.u32Magic, pArg, Cmd));
1137 return EINVAL;
1138 }
1139 if (RT_UNLIKELY( ReqWrap.cbData == 0
1140 || ReqWrap.cbData > _1M*16))
1141 {
1142 LogRel((DEVICE_NAME ": VBoxUSBSolarisIOCtl: bad size %#x; pArg=%p Cmd=%d.\n", ReqWrap.cbData, pArg, Cmd));
1143 return EINVAL;
1144 }
1145
1146 /*
1147 * Read the request.
1148 */
1149 void *pvBuf = RTMemTmpAlloc(ReqWrap.cbData);
1150 if (RT_UNLIKELY(!pvBuf))
1151 {
1152 LogRel((DEVICE_NAME ":VBoxUSBSolarisIOCtl: RTMemTmpAlloc failed to alloc %d bytes.\n", ReqWrap.cbData));
1153 return ENOMEM;
1154 }
1155
1156 rc = ddi_copyin((void *)(uintptr_t)ReqWrap.pvDataR3, pvBuf, ReqWrap.cbData, Mode);
1157 if (RT_UNLIKELY(rc))
1158 {
1159 RTMemTmpFree(pvBuf);
1160 LogRel((DEVICE_NAME ":VBoxUSBSolarisIOCtl: ddi_copyin failed; pvBuf=%p pArg=%p Cmd=%d. rc=%d\n", pvBuf, pArg, Cmd, rc));
1161 return EFAULT;
1162 }
1163 if (RT_UNLIKELY( ReqWrap.cbData == 0
1164 || pvBuf == NULL))
1165 {
1166 RTMemTmpFree(pvBuf);
1167 LogRel((DEVICE_NAME ":VBoxUSBSolarisIOCtl: invalid request pvBuf=%p cbData=%d\n", pvBuf, ReqWrap.cbData));
1168 return EINVAL;
1169 }
1170
1171 /*
1172 * Process the IOCtl.
1173 */
1174 size_t cbDataOut = 0;
1175 rc = vboxUSBSolarisProcessIOCtl(Cmd, pState, Mode, &ReqWrap, pvBuf, &cbDataOut);
1176 ReqWrap.rc = rc;
1177 rc = 0;
1178
1179 if (RT_UNLIKELY(cbDataOut > ReqWrap.cbData))
1180 {
1181 LogRel((DEVICE_NAME ":VBoxUSBSolarisIOCtl: too much output data %d expected %d Truncating!\n", cbDataOut,
1182 ReqWrap.cbData));
1183 cbDataOut = ReqWrap.cbData;
1184 }
1185
1186 ReqWrap.cbData = cbDataOut;
1187
1188 /*
1189 * Copy VBOXUSBREQ back to userspace (which contains rc for USB operation).
1190 */
1191 rc = ddi_copyout(&ReqWrap, (void *)pArg, sizeof(ReqWrap), Mode);
1192 if (RT_LIKELY(!rc))
1193 {
1194 /*
1195 * Copy payload (if any) back to userspace.
1196 */
1197 if (cbDataOut > 0)
1198 {
1199 rc = ddi_copyout(pvBuf, (void *)(uintptr_t)ReqWrap.pvDataR3, cbDataOut, Mode);
1200 if (RT_UNLIKELY(rc))
1201 {
1202 LogRel((DEVICE_NAME ":VBoxUSBSolarisIOCtl: ddi_copyout failed; pvBuf=%p pArg=%p Cmd=%d. rc=%d\n", pvBuf, pArg,
1203 Cmd, rc));
1204 rc = EFAULT;
1205 }
1206 }
1207 }
1208 else
1209 {
1210 LogRel((DEVICE_NAME ":VBoxUSBSolarisIOCtl: ddi_copyout(1)failed; pReqWrap=%p pArg=%p Cmd=%d. rc=%d\n", &ReqWrap, pArg,
1211 Cmd, rc));
1212 rc = EFAULT;
1213 }
1214
1215 *pVal = rc;
1216 RTMemTmpFree(pvBuf);
1217 return rc;
1218}
1219
1220
1221/**
1222 * IOCtl processor for user to kernel and kernel to kernel communication.
1223 *
1224 * @returns VBox status code.
1225 *
1226 * @param iFunction The requested function.
1227 * @param pvState The USB device instance.
1228 * @param Mode The IOCtl mode.
1229 * @param pUSBReq Pointer to the VBOXUSB request.
1230 * @param pvBuf Pointer to the ring-3 URB.
1231 * @param pcbDataOut Where to store the IOCtl OUT data size.
1232 */
1233LOCAL int vboxUSBSolarisProcessIOCtl(int iFunction, void *pvState, int Mode, PVBOXUSBREQ pUSBReq, void *pvBuf, size_t *pcbDataOut)
1234{
1235// LogFunc((DEVICE_NAME ":vboxUSBSolarisProcessIOCtl iFunction=%d pvState=%p pUSBReq=%p\n", iFunction, pvState, pUSBReq));
1236
1237 AssertPtrReturn(pvState, VERR_INVALID_PARAMETER);
1238 vboxusb_state_t *pState = (vboxusb_state_t *)pvState;
1239 size_t cbData = pUSBReq->cbData;
1240 int rc;
1241
1242#define CHECKRET_MIN_SIZE(mnemonic, cbMin) \
1243 do { \
1244 if (cbData < (cbMin)) \
1245 { \
1246 LogRel((DEVICE_NAME ":vboxUSBSolarisProcessIOCtl: " mnemonic ": cbData=%#zx (%zu) min is %#zx (%zu)\n", \
1247 cbData, cbData, (size_t)(cbMin), (size_t)(cbMin))); \
1248 return VERR_BUFFER_OVERFLOW; \
1249 } \
1250 if ((cbMin) != 0 && !VALID_PTR(pvBuf)) \
1251 { \
1252 LogRel((DEVICE_NAME ":vboxUSBSolarisProcessIOCtl: " mnemonic ": Invalid pointer %p\n", pvBuf)); \
1253 return VERR_INVALID_PARAMETER; \
1254 } \
1255 } while (0)
1256
1257 switch (iFunction)
1258 {
1259 case VBOXUSB_IOCTL_SEND_URB:
1260 {
1261 CHECKRET_MIN_SIZE("SEND_URB", sizeof(VBOXUSBREQ_URB));
1262
1263 PVBOXUSBREQ_URB pUrbReq = (PVBOXUSBREQ_URB)pvBuf;
1264 rc = vboxUSBSolarisSendURB(pState, pUrbReq, Mode);
1265 *pcbDataOut = 0;
1266 Log((DEVICE_NAME ":vboxUSBSolarisProcessIOCtl: SEND_URB returned %d\n", rc));
1267 break;
1268 }
1269
1270 case VBOXUSB_IOCTL_REAP_URB:
1271 {
1272 CHECKRET_MIN_SIZE("REAP_URB", sizeof(VBOXUSBREQ_URB));
1273
1274 PVBOXUSBREQ_URB pUrbReq = (PVBOXUSBREQ_URB)pvBuf;
1275 rc = vboxUSBSolarisReapURB(pState, pUrbReq, Mode);
1276 *pcbDataOut = sizeof(VBOXUSBREQ_URB);
1277 Log((DEVICE_NAME ":vboxUSBSolarisProcessIOCtl: REAP_URB returned %d\n", rc));
1278 break;
1279 }
1280
1281 case VBOXUSB_IOCTL_CLEAR_EP:
1282 {
1283 CHECKRET_MIN_SIZE("CLEAR_EP", sizeof(VBOXUSBREQ_CLEAR_EP));
1284
1285 PVBOXUSBREQ_CLEAR_EP pClearEpReq = (PVBOXUSBREQ_CLEAR_EP)pvBuf;
1286 rc = vboxUSBSolarisClearEndPoint(pState, pClearEpReq->bEndpoint);
1287 *pcbDataOut = 0;
1288 Log((DEVICE_NAME ":vboxUSBSolarisProcessIOCtl: CLEAR_EP returned %d\n", rc));
1289 break;
1290 }
1291
1292 case VBOXUSB_IOCTL_SET_CONFIG:
1293 {
1294 CHECKRET_MIN_SIZE("SET_CONFIG", sizeof(VBOXUSBREQ_SET_CONFIG));
1295
1296 PVBOXUSBREQ_SET_CONFIG pSetCfgReq = (PVBOXUSBREQ_SET_CONFIG)pvBuf;
1297 rc = vboxUSBSolarisSetConfig(pState, pSetCfgReq->bConfigValue);
1298 *pcbDataOut = 0;
1299 Log((DEVICE_NAME ":vboxUSBSolarisProcessIOCtl: SET_CONFIG returned %d\n", rc));
1300 break;
1301 }
1302
1303 case VBOXUSB_IOCTL_SET_INTERFACE:
1304 {
1305 CHECKRET_MIN_SIZE("SET_INTERFACE", sizeof(VBOXUSBREQ_SET_INTERFACE));
1306
1307 PVBOXUSBREQ_SET_INTERFACE pSetInterfaceReq = (PVBOXUSBREQ_SET_INTERFACE)pvBuf;
1308 rc = vboxUSBSolarisSetInterface(pState, pSetInterfaceReq->bInterface, pSetInterfaceReq->bAlternate);
1309 *pcbDataOut = 0;
1310 Log((DEVICE_NAME ":vboxUSBSolarisProcessIOCtl: SET_INTERFACE returned %d\n", rc));
1311 break;
1312 }
1313
1314 case VBOXUSB_IOCTL_CLOSE_DEVICE:
1315 {
1316 CHECKRET_MIN_SIZE("CLOSE_DEVICE", sizeof(VBOXUSBREQ_CLOSE_DEVICE));
1317
1318 PVBOXUSBREQ_CLOSE_DEVICE pCloseDeviceReq = (PVBOXUSBREQ_CLOSE_DEVICE)pvBuf;
1319 rc = vboxUSBSolarisCloseDevice(pState, pCloseDeviceReq->ResetLevel);
1320 *pcbDataOut = 0;
1321 Log((DEVICE_NAME ":vboxUSBSolarisProcessIOCtl: CLOSE_DEVICE returned %d\n", rc));
1322 break;
1323 }
1324
1325 case VBOXUSB_IOCTL_ABORT_PIPE:
1326 {
1327 CHECKRET_MIN_SIZE("ABORT_PIPE", sizeof(VBOXUSBREQ_ABORT_PIPE));
1328
1329 PVBOXUSBREQ_ABORT_PIPE pAbortPipeReq = (PVBOXUSBREQ_ABORT_PIPE)pvBuf;
1330 rc = vboxUSBSolarisAbortPipe(pState, pAbortPipeReq->bEndpoint);
1331 *pcbDataOut = 0;
1332 Log((DEVICE_NAME ":vboxUSBSolarisProcessIOCtl: ABORT_PIPE returned %d\n", rc));
1333 break;
1334 }
1335
1336 case VBOXUSB_IOCTL_GET_CONFIG:
1337 {
1338 CHECKRET_MIN_SIZE("GET_CONFIG", sizeof(VBOXUSBREQ_GET_CONFIG));
1339
1340 PVBOXUSBREQ_GET_CONFIG pGetCfgReq = (PVBOXUSBREQ_GET_CONFIG)pvBuf;
1341 rc = vboxUSBSolarisGetConfig(pState, &pGetCfgReq->bConfigValue);
1342 *pcbDataOut = sizeof(VBOXUSBREQ_GET_CONFIG);
1343 Log((DEVICE_NAME ":vboxUSBSolarisProcessIOCtl: GET_CONFIG returned %d\n", rc));
1344 break;
1345 }
1346
1347 case VBOXUSB_IOCTL_GET_VERSION:
1348 {
1349 CHECKRET_MIN_SIZE("GET_VERSION", sizeof(VBOXUSBREQ_GET_VERSION));
1350
1351 PVBOXUSBREQ_GET_VERSION pGetVersionReq = (PVBOXUSBREQ_GET_VERSION)pvBuf;
1352 pGetVersionReq->u32Major = VBOXUSB_VERSION_MAJOR;
1353 pGetVersionReq->u32Minor = VBOXUSB_VERSION_MINOR;
1354 *pcbDataOut = sizeof(VBOXUSBREQ_GET_VERSION);
1355 rc = VINF_SUCCESS;
1356 Log((DEVICE_NAME ":vboxUSBSolarisProcessIOCtl: GET_VERSION returned %d\n", rc));
1357 break;
1358 }
1359
1360 default:
1361 {
1362 LogRel((DEVICE_NAME ":solarisUSBProcessIOCtl: Unknown request %#x\n", iFunction));
1363 rc = VERR_NOT_SUPPORTED;
1364 *pcbDataOut = 0;
1365 break;
1366 }
1367 }
1368
1369 pUSBReq->cbData = *pcbDataOut;
1370 return rc;
1371}
1372
1373
1374/**
1375 * Initialize device power management functions.
1376 *
1377 * @param pState The USB device instance.
1378 *
1379 * @returns VBox status code.
1380 */
1381LOCAL int vboxUSBSolarisInitPower(vboxusb_state_t *pState)
1382{
1383 LogFunc((DEVICE_NAME ":vboxUSBSolarisInitPower pState=%p\n", pState));
1384
1385 int rc = usb_handle_remote_wakeup(pState->pDip, USB_REMOTE_WAKEUP_ENABLE);
1386 if (rc == USB_SUCCESS)
1387 {
1388 vboxusb_power_t *pPower = RTMemAlloc(sizeof(vboxusb_power_t));
1389 if (RT_LIKELY(pPower))
1390 {
1391 mutex_enter(&pState->Mtx);
1392 pState->pPower = pPower;
1393 pState->pPower->fPowerWakeup = false;
1394 mutex_exit(&pState->Mtx);
1395
1396 uint_t PowerStates;
1397 rc = usb_create_pm_components(pState->pDip, &PowerStates);
1398 if (rc == USB_SUCCESS)
1399 {
1400 pState->pPower->fPowerWakeup = true;
1401 pState->pPower->PowerLevel = USB_DEV_OS_FULL_PWR;
1402 pState->pPower->PowerStates = PowerStates;
1403
1404 rc = pm_raise_power(pState->pDip, 0 /* component */, USB_DEV_OS_FULL_PWR);
1405
1406 if (rc != DDI_SUCCESS)
1407 {
1408 LogRel((DEVICE_NAME ":vboxUSBSolarisInitPower failed to raise power level usb(%#x,%#x).\n",
1409 pState->pDevDesc->dev_descr->idVendor, pState->pDevDesc->dev_descr->idProduct));
1410 }
1411 }
1412 else
1413 Log((DEVICE_NAME ":vboxUSBSolarisInitPower failed to create power components.\n"));
1414
1415 return VINF_SUCCESS;
1416 }
1417 else
1418 rc = VERR_NO_MEMORY;
1419 }
1420 else
1421 {
1422 Log((DEVICE_NAME ":vboxUSBSolarisInitPower failed to enable remote wakeup. No PM.\n"));
1423 rc = VINF_SUCCESS;
1424 }
1425
1426 return rc;
1427}
1428
1429
1430/**
1431 * Destroy device power management functions.
1432 *
1433 * @param pState The USB device instance.
1434 * @remarks Requires the device state mutex to be held.
1435 *
1436 * @returns VBox status code.
1437 */
1438LOCAL void vboxUSBSolarisDestroyPower(vboxusb_state_t *pState)
1439{
1440 LogFunc((DEVICE_NAME ":vboxUSBSolarisDestroyPower pState=%p\n", pState));
1441
1442 if (pState->pPower)
1443 {
1444 mutex_exit(&pState->Mtx);
1445 vboxUSBSolarisPowerBusy(pState);
1446 mutex_enter(&pState->Mtx);
1447
1448 int rc = -1;
1449 if ( pState->pPower->fPowerWakeup
1450 && pState->DevState != USB_DEV_DISCONNECTED)
1451 {
1452 mutex_exit(&pState->Mtx);
1453 rc = pm_raise_power(pState->pDip, 0 /* component */, USB_DEV_OS_FULL_PWR);
1454 if (rc != DDI_SUCCESS)
1455 Log((DEVICE_NAME ":vboxUSBSolarisDestroyPower raising power failed! rc=%d\n", rc));
1456
1457 rc = usb_handle_remote_wakeup(pState->pDip, USB_REMOTE_WAKEUP_DISABLE);
1458 if (rc != DDI_SUCCESS)
1459 Log((DEVICE_NAME ":vboxUSBSolarisDestroyPower failed to disable remote wakeup.\n"));
1460 }
1461 else
1462 mutex_exit(&pState->Mtx);
1463
1464 rc = pm_lower_power(pState->pDip, 0 /* component */, USB_DEV_OS_PWR_OFF);
1465 if (rc != DDI_SUCCESS)
1466 Log((DEVICE_NAME ":vboxUSBSolarisDestroyPower lowering power failed! rc=%d\n", rc));
1467
1468 vboxUSBSolarisPowerIdle(pState);
1469 mutex_enter(&pState->Mtx);
1470 RTMemFree(pState->pPower);
1471 pState->pPower = NULL;
1472 }
1473}
1474
1475
1476/**
1477 * Convert Solaris' USBA URB status to VBox's USB URB status.
1478 *
1479 * @param Status Solaris USBA USB URB status.
1480 *
1481 * @returns VBox USB URB status.
1482 */
1483static inline VUSBSTATUS vboxUSBSolarisGetUrbStatus(usb_cr_t Status)
1484{
1485 switch (Status)
1486 {
1487 case USB_CR_OK: return VUSBSTATUS_OK;
1488 case USB_CR_CRC: return VUSBSTATUS_CRC;
1489 case USB_CR_DEV_NOT_RESP: return VUSBSTATUS_DNR;
1490 case USB_CR_DATA_UNDERRUN: return VUSBSTATUS_DATA_UNDERRUN;
1491 case USB_CR_DATA_OVERRUN: return VUSBSTATUS_DATA_OVERRUN;
1492 case USB_CR_STALL: return VUSBSTATUS_STALL;
1493 /*
1494 case USB_CR_BITSTUFFING:
1495 case USB_CR_DATA_TOGGLE_MM:
1496 case USB_CR_PID_CHECKFAILURE:
1497 case USB_CR_UNEXP_PID:
1498 case USB_CR_BUFFER_OVERRUN:
1499 case USB_CR_BUFFER_UNDERRUN:
1500 case USB_CR_TIMEOUT:
1501 case USB_CR_NOT_ACCESSED:
1502 case USB_CR_NO_RESOURCES:
1503 case USB_CR_UNSPECIFIED_ERR:
1504 case USB_CR_STOPPED_POLLING:
1505 case USB_CR_PIPE_CLOSING:
1506 case USB_CR_PIPE_RESET:
1507 case USB_CR_NOT_SUPPORTED:
1508 case USB_CR_FLUSHED:
1509 case USB_CR_HC_HARDWARE_ERR:
1510 */
1511 default: return VUSBSTATUS_INVALID;
1512 }
1513}
1514
1515
1516/**
1517 * Convert Solaris' USBA error code to VBox's error code.
1518 *
1519 * @param UsbRc Solaris USBA error code.
1520 *
1521 * @returns VBox error code.
1522 */
1523static inline int vboxUSBSolarisToVBoxRC(int UsbRc)
1524{
1525 switch (UsbRc)
1526 {
1527 case USB_SUCCESS: return VINF_SUCCESS;
1528 case USB_INVALID_ARGS: return VERR_INVALID_PARAMETER;
1529 case USB_INVALID_PIPE: return VERR_BAD_PIPE;
1530 case USB_INVALID_CONTEXT: return VERR_INVALID_CONTEXT;
1531 case USB_BUSY: return VERR_PIPE_BUSY;
1532 case USB_PIPE_ERROR: return VERR_PIPE_IO_ERROR;
1533 /*
1534 case USB_FAILURE:
1535 case USB_NO_RESOURCES:
1536 case USB_NO_BANDWIDTH:
1537 case USB_NOT_SUPPORTED:
1538 case USB_PIPE_ERROR:
1539 case USB_NO_FRAME_NUMBER:
1540 case USB_INVALID_START_FRAME:
1541 case USB_HC_HARDWARE_ERROR:
1542 case USB_INVALID_REQUEST:
1543 case USB_INVALID_VERSION:
1544 case USB_INVALID_PERM:
1545 */
1546 default: return VERR_GENERAL_FAILURE;
1547 }
1548}
1549
1550
1551/**
1552 * Convert Solaris' USBA device state to VBox's error code.
1553 *
1554 * @param UsbRc Solaris USBA error code.
1555 *
1556 * @returns VBox error code.
1557 */
1558static inline int vboxUSBSolarisDeviceState(uint8_t uDeviceState)
1559{
1560 switch (uDeviceState)
1561 {
1562 case USB_DEV_ONLINE: return VINF_SUCCESS;
1563 case USB_DEV_SUSPENDED: return VERR_VUSB_DEVICE_IS_SUSPENDED;
1564 case USB_DEV_DISCONNECTED:
1565 case USB_DEV_PWRED_DOWN: return VERR_VUSB_DEVICE_NOT_ATTACHED;
1566 default: return VERR_GENERAL_FAILURE;
1567 }
1568}
1569
1570
1571/**
1572 * Check if the device is a USB device.
1573 *
1574 * @param pDip Pointer to this device info. structure.
1575 *
1576 * @returns If this is really a USB device returns true, otherwise false.
1577 */
1578LOCAL bool vboxUSBSolarisIsUSBDevice(dev_info_t *pDip)
1579{
1580 int rc = DDI_FAILURE;
1581
1582 /*
1583 * Check device for "usb" compatible property, root hubs->device would likely mean parent has no "usb" property.
1584 */
1585 char **ppszCompatible = NULL;
1586 uint_t cCompatible;
1587 rc = ddi_prop_lookup_string_array(DDI_DEV_T_ANY, pDip, DDI_PROP_DONTPASS, "compatible", &ppszCompatible, &cCompatible);
1588 if (RT_LIKELY(rc == DDI_PROP_SUCCESS))
1589 {
1590 while (cCompatible--)
1591 {
1592 Log((DEVICE_NAME ":vboxUSBSolarisIsUSBDevice compatible[%d]=%s\n", cCompatible, ppszCompatible[cCompatible]));
1593 if (!strncmp(ppszCompatible[cCompatible], "usb", 3))
1594 {
1595 Log((DEVICE_NAME ":vboxUSBSolarisIsUSBDevice verified device as USB. pszCompatible=%s\n",
1596 ppszCompatible[cCompatible]));
1597 ddi_prop_free(ppszCompatible);
1598 return true;
1599 }
1600 }
1601
1602 ddi_prop_free(ppszCompatible);
1603 ppszCompatible = NULL;
1604 }
1605 else
1606 Log((DEVICE_NAME ":vboxUSBSolarisIsUSBDevice USB property lookup failed. rc=%d\n", rc));
1607
1608 /*
1609 * Check parent for "usb" compatible property.
1610 */
1611 dev_info_t *pParentDip = ddi_get_parent(pDip);
1612 if (pParentDip)
1613 {
1614 rc = ddi_prop_lookup_string_array(DDI_DEV_T_ANY, pParentDip, DDI_PROP_DONTPASS, "compatible", &ppszCompatible,
1615 &cCompatible);
1616 if (RT_LIKELY(rc == DDI_PROP_SUCCESS))
1617 {
1618 while (cCompatible--)
1619 {
1620 Log((DEVICE_NAME ":vboxUSBSolarisIsUSBDevice parent compatible[%d]=%s\n", cCompatible,
1621 ppszCompatible[cCompatible]));
1622 if (!strncmp(ppszCompatible[cCompatible], "usb", 3))
1623 {
1624 Log((DEVICE_NAME ":vboxUSBSolarisIsUSBDevice verified device as USB. parent pszCompatible=%s\n",
1625 ppszCompatible[cCompatible]));
1626 ddi_prop_free(ppszCompatible);
1627 return true;
1628 }
1629 }
1630
1631 ddi_prop_free(ppszCompatible);
1632 ppszCompatible = NULL;
1633 }
1634 else
1635 Log((DEVICE_NAME ":vboxUSBSolarisIsUSBDevice USB parent property lookup failed. rc=%d\n", rc));
1636 }
1637 else
1638 Log((DEVICE_NAME ":vboxUSBSolarisIsUSBDevice failed to obtain parent device for property lookup.\n"));
1639
1640 return false;
1641}
1642
1643
1644/**
1645 * Submit a URB.
1646 *
1647 * @param pState The USB device instance.
1648 * @param pUrbReq Pointer to the VBox USB URB.
1649 * @param Mode The IOCtl mode.
1650 *
1651 * @returns VBox error code.
1652 */
1653LOCAL int vboxUSBSolarisSendURB(vboxusb_state_t *pState, PVBOXUSBREQ_URB pUrbReq, int Mode)
1654{
1655 uchar_t EndPtIndex = usb_get_ep_index(pUrbReq->bEndpoint);
1656 vboxusb_ep_t *pEp = &pState->aEps[EndPtIndex];
1657 AssertPtrReturn(pEp, VERR_INVALID_POINTER);
1658
1659 /* LogFunc((DEVICE_NAME ":vboxUSBSolarisSendUrb pState=%p pUrbReq=%p bEndpoint=%#x[%d] enmDir=%#x enmType=%#x cbData=%d pvData=%p\n",
1660 pState, pUrbReq, pUrbReq->bEndpoint, EndPtIndex, pUrbReq->enmDir, pUrbReq->enmType, pUrbReq->cbData, pUrbReq->pvData)); */
1661
1662 if (RT_UNLIKELY(!pUrbReq->pvData))
1663 {
1664 LogRel((DEVICE_NAME ":vboxUSBSolarisSendUrb Invalid request. No data.\n"));
1665 return VERR_INVALID_POINTER;
1666 }
1667
1668 /*
1669 * Allocate message block & copy userspace buffer for host to device Xfers and for
1670 * Control Xfers (since input has Setup header that needs copying).
1671 */
1672 mblk_t *pMsg = NULL;
1673 int rc = VINF_SUCCESS;
1674 if ( pUrbReq->enmDir == VUSBDIRECTION_OUT
1675 || pUrbReq->enmType == VUSBXFERTYPE_MSG)
1676 {
1677 pMsg = allocb(pUrbReq->cbData, BPRI_HI);
1678 if (RT_UNLIKELY(!pMsg))
1679 {
1680 LogRel((DEVICE_NAME ":vboxUSBSolarisSendUrb: failed to allocate %d bytes\n", pUrbReq->cbData));
1681 return VERR_NO_MEMORY;
1682 }
1683
1684 rc = ddi_copyin(pUrbReq->pvData, pMsg->b_wptr, pUrbReq->cbData, Mode);
1685 if (RT_UNLIKELY(rc))
1686 {
1687 LogRel((DEVICE_NAME ":vboxUSBSolarisSendUrb: ddi_copyin failed! rc=%d\n", rc));
1688 freemsg(pMsg);
1689 return VERR_NO_MEMORY;
1690 }
1691
1692 pMsg->b_wptr += pUrbReq->cbData;
1693 }
1694
1695 mutex_enter(&pState->Mtx);
1696 rc = vboxUSBSolarisDeviceState(pState->DevState);
1697
1698 if (pState->fClosed) /* Required for Isoc. IN Xfers which don't Xfer through the pipe after polling starts */
1699 rc = VERR_VUSB_DEVICE_NOT_ATTACHED;
1700
1701 if (RT_SUCCESS(rc))
1702 {
1703 /*
1704 * Open the pipe if needed.
1705 */
1706 rc = vboxUSBSolarisOpenPipe(pState, pEp);
1707 if (RT_UNLIKELY(RT_FAILURE(rc)))
1708 {
1709 mutex_exit(&pState->Mtx);
1710 freemsg(pMsg);
1711 LogRel((DEVICE_NAME ":vboxUSBSolarisSendUrb OpenPipe failed. pState=%p pUrbReq=%p bEndpoint=%#x enmDir=%#x "
1712 "enmType=%#x cbData=%d pvData=%p rc=%d\n", pState, pUrbReq, pUrbReq->bEndpoint, pUrbReq->enmDir,
1713 pUrbReq->enmType, pUrbReq->cbData, pUrbReq->pvData, rc));
1714 return VERR_BAD_PIPE;
1715 }
1716
1717 mutex_exit(&pState->Mtx);
1718
1719 vboxusb_urb_t *pUrb = NULL;
1720 if ( pUrbReq->enmType == VUSBXFERTYPE_ISOC
1721 && pUrbReq->enmDir == VUSBDIRECTION_IN)
1722 pUrb = vboxUSBSolarisGetIsocInURB(pState, pUrbReq);
1723 else
1724 pUrb = vboxUSBSolarisQueueURB(pState, pUrbReq, pMsg);
1725
1726 if (RT_LIKELY(pUrb))
1727 {
1728 switch (pUrb->enmType)
1729 {
1730 case VUSBXFERTYPE_MSG:
1731 {
1732 rc = vboxUSBSolarisCtrlXfer(pState, pEp, pUrb);
1733 break;
1734 }
1735
1736 case VUSBXFERTYPE_BULK:
1737 {
1738 rc = vboxUSBSolarisBulkXfer(pState, pEp, pUrb);
1739 break;
1740 }
1741
1742 case VUSBXFERTYPE_INTR:
1743 {
1744 rc = vboxUSBSolarisIntrXfer(pState, pEp, pUrb);
1745 break;
1746 }
1747
1748 case VUSBXFERTYPE_ISOC:
1749 {
1750 rc = vboxUSBSolarisIsocXfer(pState, pEp, pUrb);
1751 break;
1752 }
1753
1754 default:
1755 {
1756 rc = VERR_NOT_SUPPORTED;
1757 break;
1758 }
1759 }
1760
1761 if (RT_FAILURE(rc))
1762 {
1763 /** @todo We share the state mutex for protecting concurrent accesses to both
1764 * the inflight URB list as well as pUrb->pMsg (data). Probably make this
1765 * more fine grained later by having a different mutex for the URB if
1766 * it's really worth the trouble. */
1767 mutex_enter(&pState->Mtx);
1768 if (pUrb->pMsg)
1769 {
1770 freemsg(pUrb->pMsg);
1771 pUrb->pMsg = NULL;
1772 }
1773
1774 if ( pUrb->enmType == VUSBXFERTYPE_ISOC
1775 && pUrb->enmDir == VUSBDIRECTION_IN)
1776 {
1777 RTMemFree(pUrb);
1778 pUrb = NULL;
1779 }
1780 else
1781 {
1782 pUrb->pMsg = NULL;
1783 pUrb->enmState = VBOXUSB_URB_STATE_FREE;
1784 }
1785 mutex_exit(&pState->Mtx);
1786 }
1787 }
1788 else
1789 {
1790 LogRel((DEVICE_NAME ":vboxUSBSolarisSendUrb failed to queue URB.\n"));
1791 rc = VERR_NO_MEMORY;
1792 }
1793
1794 if ( RT_FAILURE(rc)
1795 && pUrb)
1796 {
1797 if ( pUrb->enmType != VUSBXFERTYPE_ISOC
1798 || pUrb->enmDir != VUSBDIRECTION_IN)
1799 {
1800 mutex_enter(&pState->Mtx);
1801 pState->cInflightUrbs--;
1802 mutex_exit(&pState->Mtx);
1803 }
1804 }
1805 }
1806 else
1807 {
1808 mutex_exit(&pState->Mtx);
1809 freemsg(pMsg);
1810 }
1811
1812 return rc;
1813}
1814
1815
1816/**
1817 * Reap a completed/error'd URB.
1818 *
1819 * @param pState The USB device instance.
1820 * @param pUrbReq Pointer to the VBox USB URB.
1821 * @param Mode The IOCtl mode.
1822 *
1823 * @returns VBox error code.
1824 */
1825LOCAL int vboxUSBSolarisReapURB(vboxusb_state_t *pState, PVBOXUSBREQ_URB pUrbReq, int Mode)
1826{
1827// LogFunc((DEVICE_NAME ":vboxUSBSolarisReapUrb pState=%p pUrbReq=%p\n", pState, pUrbReq));
1828
1829 AssertPtrReturn(pUrbReq, VERR_INVALID_POINTER);
1830
1831 int rc = VINF_SUCCESS;
1832 mutex_enter(&pState->Mtx);
1833 rc = vboxUSBSolarisDeviceState(pState->DevState);
1834 if (pState->fClosed)
1835 rc = VERR_VUSB_DEVICE_NOT_ATTACHED;
1836 if (RT_SUCCESS(rc))
1837 {
1838 vboxusb_urb_t *pUrb = list_remove_head(&pState->hLandedUrbs);
1839
1840 /*
1841 * It is safe to access pUrb->pMsg outside the state mutex because this is from the landed URB list
1842 * and not the inflight URB list.
1843 */
1844 mutex_exit(&pState->Mtx);
1845 if (pUrb)
1846 {
1847 /*
1848 * Copy the URB which will then be copied to user-space.
1849 */
1850 pUrbReq->pvUrbR3 = pUrb->pvUrbR3;
1851 pUrbReq->bEndpoint = pUrb->bEndpoint;
1852 pUrbReq->enmType = pUrb->enmType;
1853 pUrbReq->enmDir = pUrb->enmDir;
1854 pUrbReq->enmStatus = pUrb->enmStatus;
1855
1856 if (RT_LIKELY(pUrb->pMsg))
1857 {
1858 /*
1859 * Chain copy the message back into the user buffer.
1860 */
1861 if (RT_LIKELY(pUrb->pvDataR3 != NIL_RTR3PTR))
1862 {
1863 size_t cbData = RT_MIN(msgdsize(pUrb->pMsg), pUrb->cbDataR3);
1864 pUrbReq->cbData = cbData;
1865 pUrbReq->pvData = (void *)pUrb->pvDataR3;
1866
1867 /*
1868 * Paranoia: we should have a single message block almost always.
1869 */
1870 if (RT_LIKELY( !pUrb->pMsg->b_cont
1871 && cbData))
1872 {
1873 rc = ddi_copyout(pUrb->pMsg->b_rptr, (void *)pUrbReq->pvData, cbData, Mode);
1874 if (RT_UNLIKELY(rc))
1875 {
1876 LogRel((DEVICE_NAME ":vboxUSBSolarisReapUrb ddi_copyout failed! rc=%d\n", rc));
1877 pUrbReq->enmStatus = VUSBSTATUS_INVALID;
1878 }
1879 }
1880 else
1881 {
1882 RTR3PTR pvDataR3 = pUrb->pvDataR3;
1883 mblk_t *pMsg = pUrb->pMsg;
1884 while (pMsg)
1885 {
1886 size_t cbMsg = MBLKL(pMsg);
1887 if (cbMsg > 0)
1888 {
1889 rc = ddi_copyout(pMsg->b_rptr, (void *)pvDataR3, cbMsg, Mode);
1890 if (RT_UNLIKELY(rc != 0))
1891 {
1892 LogRel((DEVICE_NAME ":vboxUSBSolarisReapUrb ddi_copyout (2) failed! rc=%d\n", rc));
1893 pUrbReq->enmStatus = VUSBSTATUS_INVALID;
1894 break;
1895 }
1896 }
1897
1898 pMsg = pMsg->b_cont;
1899 pvDataR3 += cbMsg;
1900 if ((pvDataR3 - pUrb->pvDataR3) >= cbData)
1901 break;
1902 }
1903 }
1904
1905 Log((DEVICE_NAME ":vboxUSBSolarisReapUrb pvUrbR3=%p pvDataR3=%p cbData=%d\n", pUrbReq->pvUrbR3,
1906 pUrbReq->pvData, pUrbReq->cbData));
1907 }
1908 else
1909 {
1910 pUrbReq->cbData = 0;
1911 rc = VERR_INVALID_POINTER;
1912 Log((DEVICE_NAME ":vboxUSBSolarisReapUrb missing pvDataR3!!\n"));
1913 }
1914
1915 /*
1916 * Free buffer allocated in VBOXUSB_IOCTL_SEND_URB.
1917 */
1918 freemsg(pUrb->pMsg);
1919 pUrb->pMsg = NULL;
1920 }
1921 else
1922 {
1923 if (pUrb->enmType == VUSBXFERTYPE_ISOC)
1924 {
1925 if (pUrb->enmDir == VUSBDIRECTION_OUT)
1926 pUrbReq->cbData = pUrb->cbDataR3;
1927 else
1928 {
1929 pUrbReq->enmStatus = VUSBSTATUS_INVALID;
1930 pUrbReq->cbData = 0;
1931 }
1932 }
1933 else
1934 {
1935 Log((DEVICE_NAME ":vboxUSBSolarisReapUrb missing message.\n"));
1936 pUrbReq->cbData = 0;
1937 }
1938 }
1939
1940 /*
1941 * Copy Isoc packet descriptors.
1942 */
1943 if (pUrb->enmType == VUSBXFERTYPE_ISOC)
1944 {
1945 AssertCompile(sizeof(pUrbReq->aIsocPkts) == sizeof(pUrb->aIsocPkts));
1946 pUrbReq->cIsocPkts = pUrb->cIsocPkts;
1947
1948 for (unsigned i = 0; i < pUrb->cIsocPkts; i++)
1949 {
1950 pUrbReq->aIsocPkts[i].cbPkt = pUrb->aIsocPkts[i].cbPkt;
1951 pUrbReq->aIsocPkts[i].cbActPkt = pUrb->aIsocPkts[i].cbActPkt;
1952 pUrbReq->aIsocPkts[i].enmStatus = pUrb->aIsocPkts[i].enmStatus;
1953 }
1954
1955 if (pUrb->enmDir == VUSBDIRECTION_IN)
1956 {
1957 RTMemFree(pUrb);
1958 pUrb = NULL;
1959 }
1960 }
1961
1962 if (pUrb)
1963 {
1964 /*
1965 * Add URB back to the head of the free/inflight list.
1966 */
1967 pUrb->cbDataR3 = 0;
1968 pUrb->pvDataR3 = NIL_RTR3PTR;
1969 pUrb->enmState = VBOXUSB_URB_STATE_FREE;
1970 mutex_enter(&pState->Mtx);
1971 list_insert_head(&pState->hUrbs, pUrb);
1972 mutex_exit(&pState->Mtx);
1973 }
1974 }
1975 else
1976 pUrbReq->pvUrbR3 = NULL;
1977 }
1978 else
1979 mutex_exit(&pState->Mtx);
1980
1981 return rc;
1982}
1983
1984
1985/**
1986 * Clear a pipe (CLEAR_FEATURE).
1987 *
1988 * @param pState The USB device instance.
1989 * @param bEndpoint The Endpoint address.
1990 *
1991 * @returns VBox error code.
1992 */
1993LOCAL int vboxUSBSolarisClearEndPoint(vboxusb_state_t *pState, uint8_t bEndpoint)
1994{
1995 LogFunc((DEVICE_NAME ":vboxUSBSolarisClearEndPoint pState=%p bEndpoint=%#x\n", pState, bEndpoint));
1996
1997 /*
1998 * Serialize access: single threaded per Endpoint, one request at a time.
1999 */
2000 mutex_enter(&pState->Mtx);
2001 int rc = vboxUSBSolarisDeviceState(pState->DevState);
2002 if (RT_SUCCESS(rc))
2003 {
2004 uchar_t EndPtIndex = usb_get_ep_index(bEndpoint);
2005 vboxusb_ep_t *pEp = &pState->aEps[EndPtIndex];
2006 if (RT_LIKELY(pEp))
2007 {
2008 /*
2009 * Check if the endpoint is open to be cleared.
2010 */
2011 if (pEp->pPipe)
2012 {
2013 mutex_exit(&pState->Mtx);
2014#if 0
2015 /*
2016 * Asynchronous clear pipe.
2017 */
2018 rc = usb_clr_feature(pState->pDip, USB_DEV_REQ_RCPT_EP, USB_EP_HALT, bEndpoint,
2019 USB_FLAGS_NOSLEEP, /* Asynchronous */
2020 NULL, /* Completion callback */
2021 NULL); /* Exception callback */
2022#endif
2023 /*
2024 * Synchronous reset pipe.
2025 */
2026 usb_pipe_reset(pState->pDip, pEp->pPipe,
2027 USB_FLAGS_SLEEP, /* Synchronous */
2028 NULL, /* Completion callback */
2029 NULL); /* Exception callback */
2030
2031 mutex_enter(&pState->Mtx);
2032
2033 Log((DEVICE_NAME ":vboxUSBSolarisClearEndPoint bEndpoint=%#x[%d] returns %d\n", bEndpoint, EndPtIndex, rc));
2034
2035 rc = VINF_SUCCESS;
2036 }
2037 else
2038 {
2039 Log((DEVICE_NAME ":vboxUSBSolarisClearEndPoint not opened to be cleared. Faking success. bEndpoint=%#x.\n",
2040 bEndpoint));
2041 rc = VINF_SUCCESS;
2042 }
2043 }
2044 else
2045 {
2046 LogRel((DEVICE_NAME ":vboxUSBSolarisClearEndPoint Endpoint missing!! bEndpoint=%#x EndPtIndex=%d.\n", bEndpoint,
2047 EndPtIndex));
2048 rc = VERR_GENERAL_FAILURE;
2049 }
2050 }
2051 else
2052 Log((DEVICE_NAME ":vboxUSBSolarisClearEndPoint device state=%d not online.\n", pState->DevState));
2053
2054 mutex_exit(&pState->Mtx);
2055 return rc;
2056}
2057
2058
2059/**
2060 * Set configuration (SET_CONFIGURATION)
2061 *
2062 * @param pState The USB device instance.
2063 * @param uCfgValue The Configuration value.
2064 *
2065 * @returns VBox error code.
2066 */
2067LOCAL int vboxUSBSolarisSetConfig(vboxusb_state_t *pState, uint8_t bCfgValue)
2068{
2069 LogFunc((DEVICE_NAME ":vboxUSBSolarisSetConfig pState=%p bCfgValue=%#x\n", pState, bCfgValue));
2070
2071 /*
2072 * Serialize access: single threaded per Endpoint, one request at a time.
2073 */
2074 mutex_enter(&pState->Mtx);
2075 int rc = vboxUSBSolarisDeviceState(pState->DevState);
2076 if (RT_SUCCESS(rc))
2077 {
2078 vboxUSBSolarisCloseAllPipes(pState, false /* ControlPipe */);
2079 int iCfgIndex = vboxUSBSolarisGetConfigIndex(pState, bCfgValue);
2080
2081 if (iCfgIndex >= 0)
2082 {
2083 /*
2084 * Switch Config synchronously.
2085 */
2086 mutex_exit(&pState->Mtx);
2087 rc = usb_set_cfg(pState->pDip, (uint_t)iCfgIndex, USB_FLAGS_SLEEP, NULL /* callback */, NULL /* callback data */);
2088 mutex_enter(&pState->Mtx);
2089
2090 if (rc == USB_SUCCESS)
2091 {
2092 pState->fRestoreCfg = true;
2093 vboxUSBSolarisInitEndPointsForConfig(pState, iCfgIndex);
2094 rc = VINF_SUCCESS;
2095 }
2096 else
2097 {
2098 LogRel((DEVICE_NAME ":vboxUSBSolarisSetConfig usb_set_cfg failed for iCfgIndex=%#x bCfgValue=%#x rc=%d\n",
2099 iCfgIndex, bCfgValue, rc));
2100 rc = vboxUSBSolarisToVBoxRC(rc);
2101 }
2102 }
2103 else
2104 {
2105 LogRel((DEVICE_NAME ":vboxUSBSolarisSetConfig invalid iCfgIndex=%d bCfgValue=%#x\n", iCfgIndex, bCfgValue));
2106 rc = VERR_INVALID_HANDLE;
2107 }
2108 }
2109
2110 mutex_exit(&pState->Mtx);
2111
2112 return rc;
2113}
2114
2115
2116/**
2117 * Get configuration (GET_CONFIGURATION)
2118 *
2119 * @param pState The USB device instance.
2120 * @param pCfgValue Where to store the configuration value.
2121 *
2122 * @returns VBox error code.
2123 */
2124LOCAL int vboxUSBSolarisGetConfig(vboxusb_state_t *pState, uint8_t *pCfgValue)
2125{
2126 LogFunc((DEVICE_NAME ":vboxUSBSolarisGetConfig pState=%p pCfgValue=%p\n", pState, pCfgValue));
2127 AssertPtrReturn(pCfgValue, VERR_INVALID_POINTER);
2128
2129 /*
2130 * Solaris keeps the currently active configuration for the first time. Thus for the first request
2131 * we simply pass the cached configuration back to the user.
2132 */
2133 if (!pState->fGetCfgReqDone)
2134 {
2135 pState->fGetCfgReqDone = true;
2136 AssertPtrReturn(pState->pDevDesc, VERR_GENERAL_FAILURE);
2137 usb_cfg_data_t *pCurrCfg = pState->pDevDesc->dev_curr_cfg;
2138 if (pCurrCfg)
2139 {
2140 *pCfgValue = pCurrCfg->cfg_descr.bConfigurationValue;
2141 Log((DEVICE_NAME ":vboxUSBSolarisGetConfig cached config returned. CfgValue=%d\n", *pCfgValue));
2142 return VINF_SUCCESS;
2143 }
2144 }
2145
2146 /*
2147 * Get Config synchronously.
2148 */
2149 uint_t bCfgValue;
2150 int rc = usb_get_cfg(pState->pDip, &bCfgValue, USB_FLAGS_SLEEP);
2151 if (RT_LIKELY(rc == USB_SUCCESS))
2152 {
2153 *pCfgValue = bCfgValue;
2154 rc = VINF_SUCCESS;
2155 }
2156 else
2157 {
2158 LogRel((DEVICE_NAME ":vboxUSBSolarisGetConfig failed. rc=%d\n", rc));
2159 rc = vboxUSBSolarisToVBoxRC(rc);
2160 }
2161
2162 Log((DEVICE_NAME ":vboxUSBSolarisGetConfig returns %d CfgValue=%d\n", rc, *pCfgValue));
2163 return rc;
2164}
2165
2166
2167/**
2168 * Set interface (SET_INTERFACE)
2169 *
2170 * @param pState The USB device instance.
2171 * @param uInterface The Interface number.
2172 * @param uAlt The Alternate setting number.
2173 *
2174 * @returns VBox error code.
2175 */
2176LOCAL int vboxUSBSolarisSetInterface(vboxusb_state_t *pState, uint8_t uInterface, uint8_t uAlt)
2177{
2178 LogFunc((DEVICE_NAME ":vboxUSBSolarisSetInterface pState=%p uInterface=%#x uAlt=%#x\n", pState, uInterface, uAlt));
2179
2180 /*
2181 * Serialize access: single threaded per Endpoint, one request at a time.
2182 */
2183 mutex_enter(&pState->Mtx);
2184 int rc = vboxUSBSolarisDeviceState(pState->DevState);
2185 if (RT_SUCCESS(rc))
2186 {
2187 vboxUSBSolarisCloseAllPipes(pState, false /* ControlPipe */);
2188
2189 /*
2190 * Set Interface & Alt setting synchronously.
2191 */
2192 mutex_exit(&pState->Mtx);
2193 rc = usb_set_alt_if(pState->pDip, uInterface, uAlt, USB_FLAGS_SLEEP, NULL /* callback */, NULL /* callback data */);
2194 mutex_enter(&pState->Mtx);
2195
2196 if (rc == USB_SUCCESS)
2197 {
2198 vboxUSBSolarisInitEndPointsForInterfaceAlt(pState, uInterface, uAlt);
2199 rc = VINF_SUCCESS;
2200 }
2201 else
2202 {
2203 LogRel((DEVICE_NAME ":vboxUSBSolarisSetInterface usb_set_alt_if failed for uInterface=%#x bAlt=%#x rc=%d\n",
2204 uInterface, uAlt, rc));
2205 rc = vboxUSBSolarisToVBoxRC(rc);
2206 }
2207 }
2208
2209 mutex_exit(&pState->Mtx);
2210
2211 return rc;
2212}
2213
2214
2215/**
2216 * Close the USB device and reset it if required.
2217 *
2218 * @param pState The USB device instance.
2219 * @param ResetLevel The reset level.
2220 *
2221 * @returns VBox error code.
2222 */
2223LOCAL int vboxUSBSolarisCloseDevice(vboxusb_state_t *pState, VBOXUSB_RESET_LEVEL enmReset)
2224{
2225 Log((DEVICE_NAME ":vboxUSBSolarisCloseDevice pState=%p enmReset=%d\n", pState, enmReset));
2226
2227 /*
2228 * Serialize access: single threaded per Endpoint, one request at a time.
2229 */
2230 mutex_enter(&pState->Mtx);
2231 int rc = vboxUSBSolarisDeviceState(pState->DevState);
2232
2233 if (enmReset == VBOXUSB_RESET_LEVEL_CLOSE)
2234 {
2235 vboxUSBSolarisCloseAllPipes(pState, true /* ControlPipe */);
2236 pState->fClosed = true;
2237 }
2238 else
2239 vboxUSBSolarisCloseAllPipes(pState, false /* ControlPipe */);
2240
2241
2242 mutex_exit(&pState->Mtx);
2243
2244 if (RT_SUCCESS(rc))
2245 {
2246 switch (enmReset)
2247 {
2248 case VBOXUSB_RESET_LEVEL_REATTACH:
2249 rc = usb_reset_device(pState->pDip, USB_RESET_LVL_REATTACH);
2250 break;
2251
2252 case VBOXUSB_RESET_LEVEL_SOFT:
2253 rc = usb_reset_device(pState->pDip, USB_RESET_LVL_DEFAULT);
2254 break;
2255
2256 default:
2257 rc = USB_SUCCESS;
2258 break;
2259 }
2260
2261 rc = vboxUSBSolarisToVBoxRC(rc);
2262 }
2263
2264 Log((DEVICE_NAME ":vboxUSBSolarisCloseDevice returns %d\n", rc));
2265 return rc;
2266}
2267
2268
2269/**
2270 * Abort pending requests and reset the pipe.
2271 *
2272 * @param pState The USB device instance.
2273 * @param bEndpoint The Endpoint address.
2274 *
2275 * @returns VBox error code.
2276 */
2277LOCAL int vboxUSBSolarisAbortPipe(vboxusb_state_t *pState, uint8_t bEndpoint)
2278{
2279 LogFunc((DEVICE_NAME ":vboxUSBSolarisAbortPipe pState=%p bEndpoint=%#x\n", pState, bEndpoint));
2280
2281 /*
2282 * Serialize access: single threaded per Endpoint, one request at a time.
2283 */
2284 mutex_enter(&pState->Mtx);
2285 int rc = vboxUSBSolarisDeviceState(pState->DevState);
2286 if (RT_SUCCESS(rc))
2287 {
2288 uchar_t EndPtIndex = usb_get_ep_index(bEndpoint);
2289 vboxusb_ep_t *pEp = &pState->aEps[EndPtIndex];
2290 if (RT_LIKELY(pEp))
2291 {
2292 if (pEp->pPipe)
2293 {
2294 /*
2295 * Default Endpoint; aborting requests not supported, fake success.
2296 */
2297 if ((pEp->EpDesc.bEndpointAddress & USB_EP_NUM_MASK) == 0)
2298 {
2299 mutex_exit(&pState->Mtx);
2300 LogRel((DEVICE_NAME ":vboxUSBSolarisAbortPipe Cannot reset control pipe.\n"));
2301 return VERR_NOT_SUPPORTED;
2302 }
2303
2304 /*
2305 * Serialize access: single threaded per Endpoint, one request at a time.
2306 */
2307 mutex_exit(&pState->Mtx);
2308 usb_pipe_reset(pState->pDip, pEp->pPipe,
2309 USB_FLAGS_SLEEP, /* Synchronous */
2310 NULL, /* Completion callback */
2311 NULL); /* Callback data */
2312
2313 /*
2314 * Allow pending async requests to complete.
2315 */
2316 rc = usb_pipe_drain_reqs(pState->pDip, pEp->pPipe,
2317 USB_FLAGS_SLEEP, /* Synchronous */
2318 5, /* Timeout (seconds) */
2319 NULL, /* Completion callback */
2320 NULL); /* Callback data*/
2321
2322 mutex_enter(&pState->Mtx);
2323
2324 Log((DEVICE_NAME ":usb_pipe_drain_reqs returns %d\n", rc));
2325 rc = vboxUSBSolarisToVBoxRC(rc);
2326 }
2327 else
2328 {
2329 LogRel((DEVICE_NAME ":vboxUSBSolarisAbortPipe pipe not open. bEndpoint=%#x\n", bEndpoint));
2330 rc = VERR_PIPE_IO_ERROR;
2331 }
2332 }
2333 else
2334 {
2335 LogRel((DEVICE_NAME ":vboxUSBSolarisAbortPipe invalid pipe index %d bEndpoint=%#x\n", EndPtIndex, bEndpoint));
2336 rc = VERR_INVALID_HANDLE;
2337 }
2338 }
2339
2340 mutex_exit(&pState->Mtx);
2341
2342 LogFunc((DEVICE_NAME ":vboxUSBSolarisAbortPipe returns %d\n", rc));
2343 return rc;
2344}
2345
2346
2347/**
2348 * Initialize an endpoint.
2349 *
2350 * @param pState The USB device instance.
2351 * @param pEpData The Endpoint data.
2352 * @param uCfgValue The Configuration value.
2353 * @param uCfgIndex The Configuration index.
2354 * @param uInterface The Interface.
2355 * @param uAlt The Alternate setting.
2356 *
2357 * @returns VBox error code.
2358 */
2359LOCAL int vboxUSBSolarisInitEndPoint(vboxusb_state_t *pState, usb_ep_data_t *pEpData, uchar_t uCfgValue,
2360 uchar_t uInterface, uchar_t uAlt)
2361{
2362 LogFunc((DEVICE_NAME ":vboxUSBSolarisInitEndPoint pState=%p pEpData=%p CfgVal=%d Iface=%d Alt=%d", pState,
2363 pEpData, uCfgValue, uInterface, uAlt));
2364
2365 /*
2366 * Is this the default endpoint?
2367 */
2368 usb_ep_descr_t *pEpDesc = NULL;
2369 vboxusb_ep_t *pEp = NULL;
2370 int EpIndex = 0;
2371 if (!pEpData)
2372 {
2373 EpIndex = 0;
2374 pEpDesc = &g_VBoxUSBSolarisDefaultEpDesc;
2375 }
2376 else
2377 {
2378 EpIndex = usb_get_ep_index(pEpData->ep_descr.bEndpointAddress);
2379 pEpDesc = &pEpData->ep_descr;
2380 }
2381
2382 pEp = &pState->aEps[EpIndex];
2383 AssertRelease(pEp);
2384
2385 /*
2386 * Initialize the endpoint data structure.
2387 */
2388 pEp->EpDesc = *pEpDesc;
2389 pEp->uCfgValue = uCfgValue;
2390 pEp->uInterface = uInterface;
2391 pEp->uAlt = uAlt;
2392 if (pEp->fInitialized != VBOXUSB_EP_INITIALIZED)
2393 {
2394 pEp->pPipe = NULL;
2395 pEp->EpState = VBOXUSB_EP_STATE_CLOSED;
2396 bzero(&pEp->PipePolicy, sizeof(pEp->PipePolicy));
2397 pEp->PipePolicy.pp_max_async_reqs = VBOXUSB_MAX_PIPE_ASYNC_REQS;
2398 pEp->fIsocPolling = false;
2399 list_create(&pEp->hIsocInUrbs, sizeof(vboxusb_urb_t), offsetof(vboxusb_urb_t, hListLink));
2400 pEp->cIsocInUrbs = 0;
2401 list_create(&pEp->hIsocInLandedReqs, sizeof(vboxusb_isoc_req_t), offsetof(vboxusb_isoc_req_t, hListLink));
2402 pEp->cbIsocInLandedReqs = 0;
2403 pEp->cbMaxIsocData = 0;
2404 pEp->fInitialized = VBOXUSB_EP_INITIALIZED;
2405 }
2406 Log((DEVICE_NAME ":vboxUSBSolarisInitEndPoint done. %s:[%d] bEndpoint=%#x\n", !pEpData ? "Default " : "Endpoint",
2407 EpIndex, pEp->EpDesc.bEndpointAddress));
2408 return VINF_SUCCESS;
2409}
2410
2411
2412/**
2413 * Initialize all Endpoint structures.
2414 *
2415 * @param pState The USB device instance.
2416 *
2417 * @returns VBox status code.
2418 */
2419LOCAL int vboxUSBSolarisInitAllEndPoints(vboxusb_state_t *pState)
2420{
2421 LogFunc((DEVICE_NAME ":vboxUSBSolarisInitAllEndPoints pState=%p\n", pState));
2422
2423 /*
2424 * Initialize all Endpoints for all Alternate settings of all Interfaces of all Configs.
2425 */
2426 int rc = vboxUSBSolarisInitEndPoint(pState, NULL /* pEp */, 0 /* uCfgValue */, 0 /* uInterface */, 0 /* uAlt */);
2427
2428 if (RT_SUCCESS(rc))
2429 {
2430 /*
2431 * Initialize all Endpoints for all Alternate settings of all Interfaces of all Configs.
2432 */
2433 for (uchar_t uCfgIndex = 0; uCfgIndex < pState->pDevDesc->dev_n_cfg; uCfgIndex++)
2434 {
2435 rc = vboxUSBSolarisInitEndPointsForConfig(pState, uCfgIndex);
2436 if (RT_FAILURE(rc))
2437 {
2438 LogRel((DEVICE_NAME ":vboxUSBSolarisInitAllEndPoints: vboxUSBSolarisInitEndPoints uCfgIndex=%d failed. rc=%d\n",
2439 uCfgIndex, rc));
2440 return rc;
2441 }
2442 }
2443 }
2444 else
2445 LogRel((DEVICE_NAME ":vboxUSBSolarisInitAllEndPoints default Endpoint initialization failed!\n"));
2446
2447 return rc;
2448}
2449
2450
2451/**
2452 * Initialize Endpoints structures for the given Config.
2453 *
2454 * @param pState The USB device instance.
2455 * @param uCfgIndex The current Config. index.
2456 *
2457 * @returns VBox status code.
2458 */
2459LOCAL int vboxUSBSolarisInitEndPointsForConfig(vboxusb_state_t *pState, uint8_t uCfgIndex)
2460{
2461 LogFunc((DEVICE_NAME ":vboxUSBSolarisInitEndPointsForConfig pState=%p uCfgIndex=%d\n", pState, uCfgIndex));
2462 usb_cfg_data_t *pConfig = &pState->pDevDesc->dev_cfg[uCfgIndex];
2463 uchar_t uCfgValue = pConfig->cfg_descr.bConfigurationValue;
2464
2465 for (uchar_t uInterface = 0; uInterface < pConfig->cfg_n_if; uInterface++)
2466 {
2467 usb_if_data_t *pInterface = &pConfig->cfg_if[uInterface];
2468
2469 for (uchar_t uAlt = 0; uAlt < pInterface->if_n_alt; uAlt++)
2470 {
2471 usb_alt_if_data_t *pAlt = &pInterface->if_alt[uAlt];
2472
2473 for (uchar_t uEp = 0; uEp < pAlt->altif_n_ep; uEp++)
2474 {
2475 usb_ep_data_t *pEpData = &pAlt->altif_ep[uEp];
2476
2477 int rc = vboxUSBSolarisInitEndPoint(pState, pEpData, uCfgValue, uInterface, uAlt);
2478 if (RT_FAILURE(rc))
2479 {
2480 LogRel((DEVICE_NAME ":vboxUSBSolarisInitEndPointsForConfig: vboxUSBSolarisInitEndPoint failed! pEp=%p "
2481 "uCfgValue=%u uCfgIndex=%u uInterface=%u, uAlt=%u\n", uCfgValue, uCfgIndex, uInterface, uAlt));
2482 return rc;
2483 }
2484 }
2485 }
2486 }
2487 return VINF_SUCCESS;
2488}
2489
2490
2491/**
2492 * Initialize Endpoints structures for the given Interface & Alternate setting.
2493 *
2494 * @param pState The USB device instance.
2495 * @param uInterface The interface being switched to.
2496 * @param uAlt The alt being switched to.
2497 *
2498 * @returns VBox status code.
2499 */
2500LOCAL int vboxUSBSolarisInitEndPointsForInterfaceAlt(vboxusb_state_t *pState, uint8_t uInterface, uint8_t uAlt)
2501{
2502 LogFunc((DEVICE_NAME ":vboxUSBSolarisInitEndPointsForInterfaceAlt pState=%p uInterface=%d uAlt=%d\n", pState, uInterface,
2503 uAlt));
2504
2505 /* Doesn't hurt to be paranoid */
2506 uint_t uCfgIndex = usb_get_current_cfgidx(pState->pDip);
2507 if (RT_UNLIKELY(uCfgIndex >= pState->pDevDesc->dev_n_cfg))
2508 {
2509 LogRel((DEVICE_NAME ":vboxUSBSolarisInitEndPointsForInterfaceAlt invalid current config index %d\n", uCfgIndex));
2510 return VERR_GENERAL_FAILURE;
2511 }
2512
2513 usb_cfg_data_t *pConfig = &pState->pDevDesc->dev_cfg[uCfgIndex];
2514 uchar_t uCfgValue = pConfig->cfg_descr.bConfigurationValue;
2515 usb_if_data_t *pInterface = &pConfig->cfg_if[uInterface];
2516
2517 int rc = VINF_SUCCESS;
2518 if (RT_LIKELY(pInterface))
2519 {
2520 usb_alt_if_data_t *pAlt = &pInterface->if_alt[uAlt];
2521 if (RT_LIKELY(pAlt))
2522 {
2523 for (uchar_t uEp = 0; uEp < pAlt->altif_n_ep; uEp++)
2524 {
2525 usb_ep_data_t *pEpData = &pAlt->altif_ep[uEp];
2526 rc = vboxUSBSolarisInitEndPoint(pState, pEpData, uCfgValue, uInterface, uAlt);
2527 if (RT_FAILURE(rc))
2528 {
2529 LogRel((DEVICE_NAME ":vboxUSBSolarisInitEndPointsForInterfaceAlt: vboxUSBSolarisInitEndPoint failed! pEp=%p "
2530 "uCfgValue=%u uCfgIndex=%u uInterface=%u, uAlt=%u\n", uCfgValue, uCfgIndex, uInterface, uAlt));
2531 return rc;
2532 }
2533 }
2534 }
2535 else
2536 {
2537 LogRel((DEVICE_NAME ":vboxUSBSolarisInitEndPointsForInterfaceAlt missing alternate.\n"));
2538 rc = VERR_INVALID_POINTER;
2539 }
2540 }
2541 else
2542 {
2543 LogRel((DEVICE_NAME ":vboxUSBSolarisInitEndPointsForInterfaceAlt missing interface.\n"));
2544 rc = VERR_INVALID_POINTER;
2545 }
2546
2547 Log((DEVICE_NAME ":vboxUSBSolarisInitEndPointsForInterfaceAlt returns %d\n", rc));
2548 return rc;
2549}
2550
2551
2552/**
2553 * Destroy all Endpoint Xfer structures.
2554 *
2555 * @param pState The USB device instance.
2556 * @remarks Requires the state mutex to be held.
2557 * Call only from Detach() or similar as callbacks
2558 */
2559LOCAL void vboxUSBSolarisDestroyAllEndPoints(vboxusb_state_t *pState)
2560{
2561 LogFunc((DEVICE_NAME ":vboxUSBSolarisDestroyAllEndPoints pState=%p\n", pState));
2562
2563 Assert(mutex_owned(&pState->Mtx));
2564 for (unsigned i = 0; i < VBOXUSB_MAX_ENDPOINTS; i++)
2565 {
2566 vboxusb_ep_t *pEp = &pState->aEps[i];
2567 if (pEp)
2568 {
2569 vboxUSBSolarisDestroyEndPoint(pState, pEp);
2570 pEp = NULL;
2571 }
2572 }
2573}
2574
2575
2576/**
2577 * Destroy an Endpoint.
2578 *
2579 * @param pState The USB device instance.
2580 * @param pEp The Endpoint.
2581 * @remarks Requires the state mutex to be held.
2582 */
2583LOCAL void vboxUSBSolarisDestroyEndPoint(vboxusb_state_t *pState, vboxusb_ep_t *pEp)
2584{
2585 LogFunc((DEVICE_NAME ":vboxUSBSolarisDestroyEndPoint pState=%p pEp=%p\n", pState, pEp));
2586
2587 Assert(mutex_owned(&pState->Mtx));
2588 if (pEp->fInitialized == VBOXUSB_EP_INITIALIZED)
2589 {
2590 vboxusb_urb_t *pUrb = list_remove_head(&pEp->hIsocInUrbs);
2591 while (pUrb)
2592 {
2593 if (pUrb->pMsg)
2594 freemsg(pUrb->pMsg);
2595 RTMemFree(pUrb);
2596 pUrb = list_remove_head(&pEp->hIsocInUrbs);
2597 }
2598 pEp->cIsocInUrbs = 0;
2599 list_destroy(&pEp->hIsocInUrbs);
2600
2601 vboxusb_isoc_req_t *pIsocReq = list_remove_head(&pEp->hIsocInLandedReqs);
2602 while (pIsocReq)
2603 {
2604 kmem_free(pIsocReq, sizeof(vboxusb_isoc_req_t));
2605 pIsocReq = list_remove_head(&pEp->hIsocInLandedReqs);
2606 }
2607 pEp->cbIsocInLandedReqs = 0;
2608 list_destroy(&pEp->hIsocInLandedReqs);
2609
2610 pEp->fInitialized = 0;
2611 }
2612}
2613
2614
2615/**
2616 * Close all non-default Endpoints and drains the default pipe.
2617 *
2618 * @param pState The USB device instance.
2619 * @param fDefault Whether to close the default control pipe.
2620 *
2621 * @remarks Requires the device state mutex to be held.
2622 */
2623LOCAL void vboxUSBSolarisCloseAllPipes(vboxusb_state_t *pState, bool fDefault)
2624{
2625 LogFunc((DEVICE_NAME ":vboxUSBSolarisCloseAllPipes pState=%p\n", pState));
2626
2627 for (int i = 1; i < VBOXUSB_MAX_ENDPOINTS; i++)
2628 {
2629 vboxusb_ep_t *pEp = &pState->aEps[i];
2630 if ( pEp
2631 && pEp->pPipe)
2632 {
2633 Log((DEVICE_NAME ":vboxUSBSolarisCloseAllPipes closing[%d]\n", i));
2634 vboxUSBSolarisClosePipe(pState, pEp);
2635 }
2636 }
2637
2638 if (fDefault)
2639 {
2640 vboxusb_ep_t *pEp = &pState->aEps[0];
2641 if ( pEp
2642 && pEp->pPipe)
2643 {
2644 vboxUSBSolarisClosePipe(pState, pEp);
2645 Log((DEVICE_NAME ":vboxUSBSolarisCloseAllPipes closed default pipe.\n"));
2646 }
2647 }
2648}
2649
2650
2651/**
2652 * Open the pipe for an Endpoint.
2653 *
2654 * @param pState The USB device instance.
2655 * @param pEp The Endpoint.
2656 * @remarks Requires the device state mutex to be held.
2657 *
2658 * @returns VBox status code.
2659 */
2660LOCAL int vboxUSBSolarisOpenPipe(vboxusb_state_t *pState, vboxusb_ep_t *pEp)
2661{
2662 Assert(mutex_owned(&pState->Mtx));
2663
2664 /*
2665 * Make sure the Endpoint isn't open already.
2666 */
2667 if (pEp->pPipe)
2668 return VINF_SUCCESS;
2669
2670
2671 /*
2672 * Default Endpoint; already opened just copy the pipe handle.
2673 */
2674 if ((pEp->EpDesc.bEndpointAddress & USB_EP_NUM_MASK) == 0)
2675 {
2676 pEp->pPipe = pState->pDevDesc->dev_default_ph;
2677 pEp->EpState |= VBOXUSB_EP_STATE_OPENED;
2678 Log((DEVICE_NAME ":vboxUSBSolarisOpenPipe default pipe opened.\n"));
2679 return VINF_SUCCESS;
2680 }
2681
2682 /*
2683 * Open the non-default pipe for the Endpoint.
2684 */
2685 mutex_exit(&pState->Mtx);
2686 int rc = usb_pipe_open(pState->pDip, &pEp->EpDesc, &pEp->PipePolicy, USB_FLAGS_NOSLEEP, &pEp->pPipe);
2687 mutex_enter(&pState->Mtx);
2688 if (rc == USB_SUCCESS)
2689 {
2690 LogFunc((DEVICE_NAME ":vboxUSBSolarisOpenPipe: Opened pipe. pState=%p pEp=%p\n", pState, pEp));
2691 usb_pipe_set_private(pEp->pPipe, (usb_opaque_t)pEp);
2692
2693 /*
2694 * Determine input buffer size for Isoc. IN transfers.
2695 */
2696 if ( VBOXUSB_XFER_TYPE(pEp) == VUSBXFERTYPE_ISOC
2697 && VBOXUSB_XFER_DIR(pEp) == VUSB_DIR_TO_HOST)
2698 {
2699 /*
2700 * wMaxPacketSize bits 10..0 specifies maximum packet size which can hold 1024 bytes.
2701 * If bits 12..11 is non-zero, cbMax will be more than 1024 and thus the Endpoint is a
2702 * high-bandwidth Endpoint.
2703 */
2704 uint16_t cbMax = VBOXUSB_PKT_SIZE(pEp->EpDesc.wMaxPacketSize);
2705 if (cbMax <= 1024)
2706 {
2707 /* Buffer 1 second for highspeed and 8 seconds for fullspeed Endpoints. */
2708 pEp->cbMaxIsocData = 1000 * cbMax * 8;
2709 }
2710 else
2711 {
2712 /* Buffer about 400 milliseconds of data for highspeed high-bandwidth endpoints. */
2713 pEp->cbMaxIsocData = 400 * cbMax * 8;
2714 }
2715 Log((DEVICE_NAME ":vboxUSBSolarisOpenPipe pEp=%p cbMaxIsocData=%u\n", pEp->cbMaxIsocData));
2716 }
2717
2718 pEp->EpState |= VBOXUSB_EP_STATE_OPENED;
2719 rc = VINF_SUCCESS;
2720 }
2721 else
2722 {
2723 LogRel((DEVICE_NAME ":vboxUSBSolarisOpenPipe failed! rc=%d pState=%p pEp=%p\n", rc, pState, pEp));
2724 rc = VERR_BAD_PIPE;
2725 }
2726
2727 return rc;
2728}
2729
2730
2731/**
2732 * Close the pipe of the Endpoint.
2733 *
2734 * @param pState The USB device instance.
2735 * @param pEp The Endpoint.
2736 *
2737 * @remarks Requires the device state mutex to be held.
2738 */
2739LOCAL void vboxUSBSolarisClosePipe(vboxusb_state_t *pState, vboxusb_ep_t *pEp)
2740{
2741 LogFunc((DEVICE_NAME ":vboxUSBSolarisClosePipe pState=%p pEp=%p\n", pState, pEp));
2742 AssertPtr(pEp);
2743
2744 if (pEp->pPipe)
2745 {
2746 pEp->EpState &= ~(VBOXUSB_EP_STATE_OPENED);
2747
2748 /*
2749 * Default pipe: allow completion of pending requests.
2750 */
2751 if (pEp->pPipe == pState->pDevDesc->dev_default_ph)
2752 {
2753 mutex_exit(&pState->Mtx);
2754 usb_pipe_drain_reqs(pState->pDip, pEp->pPipe, 0, USB_FLAGS_SLEEP, NULL /* callback */, NULL /* callback arg. */);
2755 mutex_enter(&pState->Mtx);
2756 Log((DEVICE_NAME ":vboxUSBSolarisClosePipe closed default pipe\n"));
2757 }
2758 else
2759 {
2760 /*
2761 * Stop Isoc. IN polling if required.
2762 */
2763 if (pEp->fIsocPolling)
2764 {
2765 pEp->fIsocPolling = false;
2766 mutex_exit(&pState->Mtx);
2767 usb_pipe_stop_isoc_polling(pEp->pPipe, USB_FLAGS_NOSLEEP);
2768 mutex_enter(&pState->Mtx);
2769 }
2770
2771 /*
2772 * Non-default pipe: close it.
2773 */
2774 Log((DEVICE_NAME ":vboxUSBSolarisClosePipe pipe bmAttributes=%#x bEndpointAddress=%#x\n", pEp->EpDesc.bmAttributes,
2775 pEp->EpDesc.bEndpointAddress));
2776 mutex_exit(&pState->Mtx);
2777 usb_pipe_close(pState->pDip, pEp->pPipe, USB_FLAGS_SLEEP, NULL /* callback */, NULL /* callback arg. */);
2778 mutex_enter(&pState->Mtx);
2779 }
2780
2781 /*
2782 * Free the Endpoint data message block and reset pipe handle.
2783 */
2784 pEp->pPipe = NULL;
2785
2786 Log((DEVICE_NAME ":vboxUSBSolarisClosePipe successful. pEp=%p\n", pEp));
2787 }
2788
2789 Assert(pEp->pPipe == NULL);
2790}
2791
2792
2793/**
2794 * Find the Configuration index for the passed in Configuration value.
2795 *
2796 * @param pState The USB device instance.
2797 * @param uCfgValue The Configuration value.
2798 *
2799 * @returns The configuration index if found, otherwise -1.
2800 */
2801LOCAL int vboxUSBSolarisGetConfigIndex(vboxusb_state_t *pState, uint_t uCfgValue)
2802{
2803 for (int CfgIndex = 0; CfgIndex < pState->pDevDesc->dev_n_cfg; CfgIndex++)
2804 {
2805 usb_cfg_data_t *pConfig = &pState->pDevDesc->dev_cfg[CfgIndex];
2806 if (pConfig->cfg_descr.bConfigurationValue == uCfgValue)
2807 return CfgIndex;
2808 }
2809
2810 return -1;
2811}
2812
2813
2814/**
2815 * Allocates and initializes an Isoc. In URB from the ring-3 equivalent.
2816 *
2817 * @param pState The USB device instance.
2818 * @param pUrb The URB to initialize.
2819 * @param pUrbReq Opaque pointer to the complete request.
2820 * @param pMsg Pointer to the allocated request data.
2821 *
2822 * @returns The allocated Isoc. In URB to be used.
2823 */
2824LOCAL vboxusb_urb_t *vboxUSBSolarisGetIsocInURB(vboxusb_state_t *pState, PVBOXUSBREQ_URB pUrbReq)
2825{
2826 /*
2827 * Isoc. In URBs are not queued into the Inflight list like every other URBs.
2828 * For now we allocate each URB which gets queued into the respective Endpoint during Xfer.
2829 */
2830 vboxusb_urb_t *pUrb = RTMemAllocZ(sizeof(vboxusb_urb_t));
2831 if (RT_LIKELY(pUrb))
2832 {
2833 pUrb->enmState = VBOXUSB_URB_STATE_INFLIGHT;
2834 pUrb->pState = pState;
2835
2836 if (RT_LIKELY(pUrbReq))
2837 {
2838 pUrb->pvUrbR3 = pUrbReq->pvUrbR3;
2839 pUrb->bEndpoint = pUrbReq->bEndpoint;
2840 pUrb->enmType = pUrbReq->enmType;
2841 pUrb->enmDir = pUrbReq->enmDir;
2842 pUrb->enmStatus = pUrbReq->enmStatus;
2843 pUrb->cbDataR3 = pUrbReq->cbData;
2844 pUrb->pvDataR3 = (RTR3PTR)pUrbReq->pvData;
2845 pUrb->cIsocPkts = pUrbReq->cIsocPkts;
2846
2847 for (unsigned i = 0; i < pUrbReq->cIsocPkts; i++)
2848 pUrb->aIsocPkts[i].cbPkt = pUrbReq->aIsocPkts[i].cbPkt;
2849
2850 pUrb->pMsg = NULL;
2851 }
2852 }
2853 else
2854 LogRel((DEVICE_NAME ":vboxUSBSolarisGetIsocInURB failed to alloc %d bytes.\n", sizeof(vboxusb_urb_t)));
2855 return pUrb;
2856}
2857
2858
2859/**
2860 * Queues a URB reusing previously allocated URBs as required.
2861 *
2862 * @param pState The USB device instance.
2863 * @param pUrbReq Opaque pointer to the complete request.
2864 * @param pMsg Pointer to the allocated request data.
2865 *
2866 * @returns The allocated URB to be used, or NULL upon failure.
2867 */
2868LOCAL vboxusb_urb_t *vboxUSBSolarisQueueURB(vboxusb_state_t *pState, PVBOXUSBREQ_URB pUrbReq, mblk_t *pMsg)
2869{
2870 LogFunc((DEVICE_NAME ":vboxUSBSolarisQueueURB pState=%p pUrbReq=%p\n", pState, pUrbReq));
2871
2872 mutex_enter(&pState->Mtx);
2873
2874 /*
2875 * Discard oldest queued URB if we've queued max URBs and none of them have completed.
2876 */
2877 if (pState->cInflightUrbs >= VBOXUSB_URB_QUEUE_SIZE)
2878 {
2879 vboxusb_urb_t *pUrb = list_head(&pState->hUrbs);
2880 if (RT_LIKELY(pUrb))
2881 {
2882 if (pUrb->pMsg)
2883 {
2884 freemsg(pUrb->pMsg);
2885 pUrb->pMsg = NULL;
2886 }
2887 pUrb->enmState = VBOXUSB_URB_STATE_FREE;
2888 }
2889 }
2890
2891 vboxusb_urb_t *pUrb = list_head(&pState->hUrbs);
2892 if ( !pUrb
2893 || ( pUrb
2894 && pUrb->enmState != VBOXUSB_URB_STATE_FREE))
2895 {
2896 mutex_exit(&pState->Mtx);
2897 pUrb = RTMemAllocZ(sizeof(vboxusb_urb_t));
2898 if (RT_UNLIKELY(!pUrb))
2899 {
2900 LogRel((DEVICE_NAME ":vboxUSBSolarisQueueURB failed to alloc %d bytes.\n", sizeof(vboxusb_urb_t)));
2901 return NULL;
2902 }
2903 mutex_enter(&pState->Mtx);
2904 }
2905 else
2906 {
2907 /*
2908 * Remove from head and move to tail so that when several URBs are reaped continuously we get to use
2909 * up each one free 'head'.
2910 */
2911 Assert(pUrb && pUrb->enmState == VBOXUSB_URB_STATE_FREE);
2912 list_remove_head(&pState->hUrbs);
2913 }
2914
2915 list_insert_tail(&pState->hUrbs, pUrb);
2916 ++pState->cInflightUrbs;
2917
2918 pUrb->enmState = VBOXUSB_URB_STATE_INFLIGHT;
2919
2920 Assert(pUrb->pMsg == NULL);
2921 pUrb->pState = pState;
2922 Log((DEVICE_NAME ":vboxUSBSolarisQueueURB cInflightUrbs=%d\n", pState->cInflightUrbs));
2923
2924 if (RT_LIKELY(pUrbReq))
2925 {
2926 pUrb->pvUrbR3 = pUrbReq->pvUrbR3;
2927 pUrb->bEndpoint = pUrbReq->bEndpoint;
2928 pUrb->enmType = pUrbReq->enmType;
2929 pUrb->enmDir = pUrbReq->enmDir;
2930 pUrb->enmStatus = pUrbReq->enmStatus;
2931 pUrb->fShortOk = pUrbReq->fShortOk;
2932 pUrb->pvDataR3 = (RTR3PTR)pUrbReq->pvData;
2933 pUrb->cbDataR3 = pUrbReq->cbData;
2934 pUrb->cIsocPkts = pUrbReq->cIsocPkts;
2935
2936 if (pUrbReq->enmType == VUSBXFERTYPE_ISOC)
2937 {
2938 for (unsigned i = 0; i < pUrbReq->cIsocPkts; i++)
2939 pUrb->aIsocPkts[i].cbPkt = pUrbReq->aIsocPkts[i].cbPkt;
2940 }
2941
2942 pUrb->pMsg = pMsg;
2943 }
2944
2945 mutex_exit(&pState->Mtx);
2946
2947 return pUrb;
2948}
2949
2950
2951/**
2952 * Dequeues a completed URB into the landed list and informs user-land.
2953 *
2954 * @param pUrb The URB to move.
2955 * @param URBStatus The Solaris URB completion code.
2956 *
2957 * @remarks All pipes could be closed at this point (e.g. Device disconnected during inflight URBs)
2958 */
2959LOCAL inline void vboxUSBSolarisDeQueueURB(vboxusb_urb_t *pUrb, int URBStatus)
2960{
2961 LogFunc((DEVICE_NAME ":vboxUSBSolarisDeQueue pUrb=%p\n", pUrb));
2962 AssertPtrReturnVoid(pUrb);
2963
2964 pUrb->enmStatus = vboxUSBSolarisGetUrbStatus(URBStatus);
2965
2966 vboxusb_state_t *pState = pUrb->pState;
2967 if (RT_LIKELY(pState))
2968 {
2969 mutex_enter(&pState->Mtx);
2970 pUrb->enmState = VBOXUSB_URB_STATE_LANDED;
2971
2972 /*
2973 * Remove it from the inflight list & move it to landed list.
2974 */
2975 list_remove(&pState->hUrbs, pUrb);
2976 --pState->cInflightUrbs;
2977 list_insert_tail(&pState->hLandedUrbs, pUrb);
2978
2979 vboxUSBSolarisNotifyComplete(pUrb->pState);
2980 mutex_exit(&pState->Mtx);
2981 }
2982 else
2983 {
2984 Log((DEVICE_NAME ":vboxUSBSolarisDeQueue State Gone.\n"));
2985 freemsg(pUrb->pMsg);
2986 pUrb->pMsg = NULL;
2987 pUrb->enmStatus = VUSBSTATUS_INVALID;
2988 }
2989}
2990
2991
2992/**
2993 * Concatenates a chain message block into a single message block if possible.
2994 *
2995 * @param pUrb The URB to move.
2996 */
2997LOCAL inline void vboxUSBSolarisConcatMsg(vboxusb_urb_t *pUrb)
2998{
2999 /*
3000 * Concatenate the whole message rather than doing a chained copy while reaping.
3001 */
3002 if ( pUrb->pMsg
3003 && pUrb->pMsg->b_cont)
3004 {
3005 mblk_t *pFullMsg = msgpullup(pUrb->pMsg, -1 /* all data */);
3006 if (RT_LIKELY(pFullMsg))
3007 {
3008 freemsg(pUrb->pMsg);
3009 pUrb->pMsg = pFullMsg;
3010 }
3011 }
3012}
3013
3014
3015/**
3016 * User process poll wake up wrapper for asynchronous URB completion.
3017 *
3018 * @param pState The USB device instance.
3019 * @remarks Requires the device state mutex to be held.
3020 */
3021LOCAL inline void vboxUSBSolarisNotifyComplete(vboxusb_state_t *pState)
3022{
3023 if (pState->fPoll & VBOXUSB_POLL_ON)
3024 {
3025 pollhead_t *pPollHead = &pState->PollHead;
3026 pState->fPoll |= VBOXUSB_POLL_REAP_PENDING;
3027 mutex_exit(&pState->Mtx);
3028 pollwakeup(pPollHead, POLLIN);
3029 mutex_enter(&pState->Mtx);
3030 }
3031}
3032
3033
3034/**
3035 * User process poll wake up wrapper for hotplug events.
3036 *
3037 * @param pState The USB device instance.
3038 * @remarks Requires the device state mutex to be held.
3039 */
3040LOCAL inline void vboxUSBSolarisNotifyHotplug(vboxusb_state_t *pState)
3041{
3042 if (pState->fPoll & VBOXUSB_POLL_ON)
3043 {
3044 pollhead_t *pPollHead = &pState->PollHead;
3045 pState->fPoll |= VBOXUSB_POLL_DEV_UNPLUGGED;
3046 mutex_exit(&pState->Mtx);
3047 pollwakeup(pPollHead, POLLHUP);
3048 mutex_enter(&pState->Mtx);
3049 }
3050}
3051
3052
3053/**
3054 * Perform a Control Xfer.
3055 *
3056 * @param pState The USB device instance.
3057 * @param pEp The Endpoint for the Xfer.
3058 * @param pUrb The VBox USB URB.
3059 *
3060 * @returns VBox status code.
3061 * @remarks Any errors, the caller should free pUrb->pMsg.
3062 */
3063LOCAL int vboxUSBSolarisCtrlXfer(vboxusb_state_t *pState, vboxusb_ep_t *pEp, vboxusb_urb_t *pUrb)
3064{
3065 LogFunc((DEVICE_NAME ":vboxUSBSolarisCtrlXfer pState=%p pEp=%p pUrb=%p enmDir=%d cbData=%d\n", pState, pEp, pUrb,
3066 pUrb->enmDir, pUrb->cbDataR3));
3067
3068 AssertPtrReturn(pUrb->pMsg, VERR_INVALID_PARAMETER);
3069 uchar_t *pSetupData = pUrb->pMsg->b_rptr;
3070 size_t cbData = pUrb->cbDataR3 > VBOXUSB_CTRL_XFER_SIZE ? pUrb->cbDataR3 - VBOXUSB_CTRL_XFER_SIZE : 0;
3071
3072 /*
3073 * Allocate a wrapper request.
3074 */
3075 int rc = VINF_SUCCESS;
3076 usb_ctrl_req_t *pReq = usb_alloc_ctrl_req(pState->pDip, cbData, USB_FLAGS_NOSLEEP);
3077 if (RT_LIKELY(pReq))
3078 {
3079 /*
3080 * Initialize the Ctrl Xfer Header.
3081 */
3082 pReq->ctrl_bmRequestType = pSetupData[0];
3083 pReq->ctrl_bRequest = pSetupData[1];
3084 pReq->ctrl_wValue = (pSetupData[3] << VBOXUSB_CTRL_XFER_SIZE) | pSetupData[2];
3085 pReq->ctrl_wIndex = (pSetupData[5] << VBOXUSB_CTRL_XFER_SIZE) | pSetupData[4];
3086 pReq->ctrl_wLength = (pSetupData[7] << VBOXUSB_CTRL_XFER_SIZE) | pSetupData[6];
3087
3088 if ( pUrb->enmDir == VUSBDIRECTION_OUT
3089 && cbData)
3090 {
3091 pUrb->pMsg->b_rptr += VBOXUSB_CTRL_XFER_SIZE;
3092 bcopy(pUrb->pMsg->b_rptr, pReq->ctrl_data->b_wptr, cbData);
3093 pReq->ctrl_data->b_wptr += cbData;
3094 }
3095
3096 freemsg(pUrb->pMsg);
3097 pUrb->pMsg = NULL;
3098
3099 /*
3100 * Initialize callbacks and timeouts.
3101 */
3102 usb_req_attrs_t fAttributes = USB_ATTRS_AUTOCLEARING;
3103 if ( pUrb->enmDir == VUSBDIRECTION_IN
3104 && pUrb->fShortOk)
3105 {
3106 fAttributes |= USB_ATTRS_SHORT_XFER_OK;
3107 }
3108 pReq->ctrl_cb = vboxUSBSolarisCtrlXferCompleted;
3109 pReq->ctrl_exc_cb = vboxUSBSolarisCtrlXferCompleted;
3110 pReq->ctrl_timeout = VBOXUSB_CTRL_XFER_TIMEOUT;
3111 pReq->ctrl_attributes = fAttributes;
3112
3113 pReq->ctrl_client_private = (usb_opaque_t)pUrb;
3114
3115 LogFunc((DEVICE_NAME ":vboxUSBSolarisCtrlXfer ctrl_wLength=%#RX16 cbData=%#zx fShortOk=%RTbool\n", pReq->ctrl_wLength,
3116 cbData, !!(fAttributes & USB_ATTRS_SHORT_XFER_OK)));
3117 Log((DEVICE_NAME ":vboxUSBSolarisCtrlXfer %.*Rhxd\n", VBOXUSB_CTRL_XFER_SIZE, pSetupData));
3118
3119 /*
3120 * Submit the request.
3121 */
3122 rc = usb_pipe_ctrl_xfer(pEp->pPipe, pReq, USB_FLAGS_NOSLEEP);
3123
3124 if (RT_LIKELY(rc == USB_SUCCESS))
3125 return VINF_SUCCESS;
3126 else
3127 {
3128 LogRel((DEVICE_NAME ":vboxUSBSolarisCtrlXfer usb_pipe_ctrl_xfer failed! rc=%d\n", rc));
3129 rc = VERR_PIPE_IO_ERROR;
3130 }
3131
3132 usb_free_ctrl_req(pReq);
3133 }
3134 else
3135 {
3136 LogRel((DEVICE_NAME ":vboxUSBSolarisCtrlXfer failed to alloc request.\n"));
3137 rc = VERR_NO_MEMORY;
3138 }
3139
3140 return rc;
3141}
3142
3143
3144/**
3145 * Completion/Exception callback for Control Xfers.
3146 *
3147 * @param pPipe The Ctrl pipe handle.
3148 * @param pReq The Ctrl request.
3149 */
3150LOCAL void vboxUSBSolarisCtrlXferCompleted(usb_pipe_handle_t pPipe, usb_ctrl_req_t *pReq)
3151{
3152 LogFunc((DEVICE_NAME ":vboxUSBSolarisCtrlXferCompleted pPipe=%p pReq=%p\n", pPipe, pReq));
3153
3154 vboxusb_urb_t *pUrb = (vboxusb_urb_t *)pReq->ctrl_client_private;
3155 if (RT_LIKELY(pUrb))
3156 {
3157 /*
3158 * Funky stuff: We need to reconstruct the header for control transfers.
3159 * Let us chain along the data and while we dequeue the URB we attempt to
3160 * concatenate the entire message there.
3161 */
3162 mblk_t *pSetupMsg = allocb(sizeof(VUSBSETUP), BPRI_MED);
3163 if (RT_LIKELY(pSetupMsg))
3164 {
3165 VUSBSETUP SetupData;
3166 SetupData.bmRequestType = pReq->ctrl_bmRequestType;
3167 SetupData.bRequest = pReq->ctrl_bRequest;
3168 SetupData.wValue = pReq->ctrl_wValue;
3169 SetupData.wIndex = pReq->ctrl_wIndex;
3170 SetupData.wLength = pReq->ctrl_wLength;
3171 bcopy(&SetupData, pSetupMsg->b_wptr, sizeof(VUSBSETUP));
3172 pSetupMsg->b_wptr += sizeof(VUSBSETUP);
3173
3174 /*
3175 * Should be safe to update pMsg here without the state mutex, see vboxUSBSolarisSendURB()
3176 * and vboxUSBSolarisQueueURB() as the URB state is (still) not VBOXUSB_URB_STATE_FREE.
3177 */
3178 pUrb->pMsg = pSetupMsg;
3179 pUrb->pMsg->b_cont = pReq->ctrl_data;
3180 pReq->ctrl_data = NULL;
3181 vboxUSBSolarisConcatMsg(pUrb);
3182
3183#ifdef DEBUG_ramshankar
3184 if ( pUrb->pMsg
3185 && pUrb->pMsg->b_cont == NULL) /* Concat succeeded */
3186 {
3187 Log((DEVICE_NAME ":vboxUSBSolarisCtrlXferCompleted prepended header rc=%d cbData=%d.\n",
3188 pReq->ctrl_completion_reason, MBLKL(pUrb->pMsg)));
3189 Log((DEVICE_NAME ":%.*Rhxd\n", MBLKL(pUrb->pMsg), pUrb->pMsg->b_rptr));
3190 }
3191#endif
3192
3193 /*
3194 * Update the URB and move to landed list for reaping.
3195 */
3196 vboxUSBSolarisDeQueueURB(pUrb, pReq->ctrl_completion_reason);
3197 }
3198 else
3199 {
3200 LogRel((DEVICE_NAME ":vboxUSBSolarisCtrlXferCompleted failed to alloc %d bytes for Setup Header.\n",
3201 sizeof(VUSBSETUP)));
3202 }
3203 }
3204 else
3205 LogRel((DEVICE_NAME ":vboxUSBSolarisCtrlXferCompleted Extreme error! missing private data.\n"));
3206
3207 usb_free_ctrl_req(pReq);
3208}
3209
3210
3211/**
3212 * Perform a Bulk Xfer.
3213 *
3214 * @param pState The USB device instance.
3215 * @param pEp The Endpoint for the Xfer.
3216 * @param pUrb The VBox USB URB.
3217 *
3218 * @returns VBox status code.
3219 * @remarks Any errors, the caller should free pUrb->pMsg.
3220 */
3221LOCAL int vboxUSBSolarisBulkXfer(vboxusb_state_t *pState, vboxusb_ep_t *pEp, vboxusb_urb_t *pUrb)
3222{
3223 LogFunc((DEVICE_NAME ":vboxUSBSolarisBulkXfer pState=%p pEp=%p pUrb=%p enmDir=%d cbData=%d\n", pState, pEp, pUrb,
3224 pUrb->enmDir, pUrb->cbDataR3));
3225
3226 /*
3227 * Allocate a wrapper request.
3228 */
3229 int rc = VINF_SUCCESS;
3230 usb_bulk_req_t *pReq = usb_alloc_bulk_req(pState->pDip, pUrb->enmDir == VUSBDIRECTION_IN ? pUrb->cbDataR3 : 0,
3231 USB_FLAGS_NOSLEEP);
3232 if (RT_LIKELY(pReq))
3233 {
3234 /*
3235 * Initialize Bulk Xfer, callbacks and timeouts.
3236 */
3237 usb_req_attrs_t fAttributes = USB_ATTRS_AUTOCLEARING;
3238 if (pUrb->enmDir == VUSBDIRECTION_OUT)
3239 pReq->bulk_data = pUrb->pMsg;
3240 else if ( pUrb->enmDir == VUSBDIRECTION_IN
3241 && pUrb->fShortOk)
3242 {
3243 fAttributes |= USB_ATTRS_SHORT_XFER_OK;
3244 }
3245
3246 pReq->bulk_len = pUrb->cbDataR3;
3247 pReq->bulk_cb = vboxUSBSolarisBulkXferCompleted;
3248 pReq->bulk_exc_cb = vboxUSBSolarisBulkXferCompleted;
3249 pReq->bulk_timeout = VBOXUSB_BULK_XFER_TIMEOUT;
3250 pReq->bulk_attributes = fAttributes;
3251 pReq->bulk_client_private = (usb_opaque_t)pUrb;
3252
3253 /* Don't obtain state lock here, we're just reading unchanging data... */
3254 if (RT_UNLIKELY(pUrb->cbDataR3 > pState->cbMaxBulkXfer))
3255 {
3256 LogRel((DEVICE_NAME ":vboxUSBSolarisBulkXfer requesting %d bytes when only %d bytes supported by device\n",
3257 pUrb->cbDataR3, pState->cbMaxBulkXfer));
3258 }
3259
3260 /*
3261 * Submit the request.
3262 */
3263 rc = usb_pipe_bulk_xfer(pEp->pPipe, pReq, USB_FLAGS_NOSLEEP);
3264
3265 if (RT_LIKELY(rc == USB_SUCCESS))
3266 return VINF_SUCCESS;
3267 else
3268 {
3269 LogRel((DEVICE_NAME ":vboxUSBSolarisBulkXfer usb_pipe_bulk_xfer enmDir=%#x Ep=%#x failed! rc=%d\n", pUrb->enmDir,
3270 pUrb->bEndpoint, rc));
3271 rc = VERR_PIPE_IO_ERROR;
3272 }
3273
3274 if (pUrb->enmDir == VUSBDIRECTION_OUT) /* pUrb->pMsg freed by caller */
3275 pReq->bulk_data = NULL;
3276
3277 usb_free_bulk_req(pReq);
3278 }
3279 else
3280 {
3281 LogRel((DEVICE_NAME ":vboxUSBSolarisBulkXfer failed to alloc bulk request.\n"));
3282 rc = VERR_NO_MEMORY;
3283 }
3284
3285 return rc;
3286}
3287
3288
3289/**
3290 * Completion/Exception callback for Bulk Xfers.
3291 *
3292 * @param pPipe The Bulk pipe handle.
3293 * @param pReq The Bulk request.
3294 */
3295LOCAL void vboxUSBSolarisBulkXferCompleted(usb_pipe_handle_t pPipe, usb_bulk_req_t *pReq)
3296{
3297 LogFunc((DEVICE_NAME ":vboxUSBSolarisBulkXferCompleted pPipe=%p pReq=%p\n", pPipe, pReq));
3298
3299 vboxusb_ep_t *pEp = (vboxusb_ep_t *)usb_pipe_get_private(pPipe);
3300 if (RT_LIKELY(pEp))
3301 {
3302 vboxusb_urb_t *pUrb = (vboxusb_urb_t *)pReq->bulk_client_private;
3303 if (RT_LIKELY(pUrb))
3304 {
3305 if (pUrb->enmDir == VUSBDIRECTION_OUT)
3306 pReq->bulk_data = NULL;
3307 else
3308 {
3309 if (pReq->bulk_completion_reason == USB_CR_OK)
3310 {
3311 pUrb->pMsg = pReq->bulk_data;
3312 pReq->bulk_data = NULL;
3313 vboxUSBSolarisConcatMsg(pUrb);
3314 }
3315 }
3316
3317 Log((DEVICE_NAME ":vboxUSBSolarisBulkXferCompleted %s. rc=%d cbData=%d\n",
3318 pReq->bulk_completion_reason != USB_CR_OK ? "failed URB" : "success",
3319 pReq->bulk_completion_reason, pUrb->pMsg ? MBLKL(pUrb->pMsg) : 0));
3320
3321 /*
3322 * Update the URB and move to tail for reaping.
3323 */
3324 vboxUSBSolarisDeQueueURB(pUrb, pReq->bulk_completion_reason);
3325 usb_free_bulk_req(pReq);
3326 return;
3327 }
3328 else
3329 LogRel((DEVICE_NAME ":vboxUSBSolarisBulkXferCompleted Extreme error! private request data missing.\n"));
3330 }
3331 else
3332 Log((DEVICE_NAME ":vboxUSBSolarisBulkXferCompleted Pipe Gone.\n"));
3333
3334 usb_free_bulk_req(pReq);
3335}
3336
3337
3338/**
3339 * Perform an Interrupt Xfer.
3340 *
3341 * @param pState The USB device instance.
3342 * @param pEp The Endpoint for the Xfer.
3343 * @param pUrb The VBox USB URB.
3344 *
3345 * @returns VBox status code.
3346 * @remarks Any errors, the caller should free pUrb->pMsg.
3347 */
3348LOCAL int vboxUSBSolarisIntrXfer(vboxusb_state_t *pState, vboxusb_ep_t *pEp, vboxusb_urb_t *pUrb)
3349{
3350 LogFunc((DEVICE_NAME ":vboxUSBSolarisIntrXfer pState=%p pEp=%p pUrb=%p enmDir=%d cbData=%d\n", pState, pEp, pUrb,
3351 pUrb->enmDir, pUrb->cbDataR3));
3352
3353 int rc = VINF_SUCCESS;
3354 usb_intr_req_t *pReq = usb_alloc_intr_req(pState->pDip, 0 /* length */, USB_FLAGS_NOSLEEP);
3355 if (RT_LIKELY(pReq))
3356 {
3357 /*
3358 * Initialize Intr Xfer, callbacks & timeouts.
3359 */
3360 if (pUrb->enmDir == VUSBDIRECTION_OUT)
3361 {
3362 pReq->intr_data = pUrb->pMsg;
3363 pReq->intr_attributes = USB_ATTRS_AUTOCLEARING;
3364 }
3365 else
3366 {
3367 Assert(pUrb->enmDir == VUSBDIRECTION_IN);
3368 pReq->intr_data = NULL;
3369 pReq->intr_attributes = USB_ATTRS_AUTOCLEARING | USB_ATTRS_ONE_XFER | (pUrb->fShortOk ? USB_ATTRS_SHORT_XFER_OK : 0);
3370 }
3371
3372 pReq->intr_len = pUrb->cbDataR3; /* Not pEp->EpDesc.wMaxPacketSize */
3373 pReq->intr_cb = vboxUSBSolarisIntrXferCompleted;
3374 pReq->intr_exc_cb = vboxUSBSolarisIntrXferCompleted;
3375 pReq->intr_timeout = VBOXUSB_INTR_XFER_TIMEOUT;
3376 pReq->intr_client_private = (usb_opaque_t)pUrb;
3377
3378 /*
3379 * Submit the request.
3380 */
3381 rc = usb_pipe_intr_xfer(pEp->pPipe, pReq, USB_FLAGS_NOSLEEP);
3382
3383 if (RT_LIKELY(rc == USB_SUCCESS))
3384 return VINF_SUCCESS;
3385 else
3386 {
3387 LogRel((DEVICE_NAME ":vboxUSBSolarisIntrXfer usb_pipe_intr_xfer failed! rc=%d\n", rc));
3388 rc = VERR_PIPE_IO_ERROR;
3389 }
3390
3391 pReq->intr_data = NULL;
3392 usb_free_intr_req(pReq);
3393 }
3394 else
3395 {
3396 LogRel((DEVICE_NAME ":vboxUSBSolarisIntrXfer failed to alloc intr request.\n"));
3397 rc = VERR_NO_MEMORY;
3398 }
3399
3400 return rc;
3401}
3402
3403
3404/**
3405 * Completion/Exception callback for Intr Xfers.
3406 *
3407 * @param pPipe The Intr pipe handle.
3408 * @param pReq The Intr request.
3409 */
3410LOCAL void vboxUSBSolarisIntrXferCompleted(usb_pipe_handle_t pPipe, usb_intr_req_t *pReq)
3411{
3412 LogFunc((DEVICE_NAME ":vboxUSBSolarisIntrXferCompleted pPipe=%p pReq=%p\n", pPipe, pReq));
3413
3414 vboxusb_ep_t *pEp = (vboxusb_ep_t *)usb_pipe_get_private(pPipe);
3415 if (RT_LIKELY(pEp))
3416 {
3417 vboxusb_urb_t *pUrb = (vboxusb_urb_t *)pReq->intr_client_private;
3418 if (RT_LIKELY(pUrb))
3419 {
3420 if (pUrb->enmDir == VUSBDIRECTION_OUT)
3421 pReq->intr_data = NULL;
3422 else
3423 {
3424 if (pReq->intr_completion_reason == USB_CR_OK)
3425 {
3426 pUrb->pMsg = pReq->intr_data;
3427 pReq->intr_data = NULL;
3428 }
3429 }
3430
3431 Log((DEVICE_NAME ":vboxUSBSolarisIntrXferCompleted rc=%d pMsg=%p enmDir=%#x\n", pReq->intr_completion_reason,
3432 pUrb->pMsg, pUrb->enmDir));
3433
3434 /*
3435 * Update the URB and move to landed list for reaping.
3436 */
3437 vboxUSBSolarisDeQueueURB(pUrb, pReq->intr_completion_reason);
3438 usb_free_intr_req(pReq);
3439 return;
3440 }
3441 else
3442 LogRel((DEVICE_NAME ":vboxUSBSolarisIntrXferCompleted Extreme error! private request data missing.\n"));
3443 }
3444 else
3445 Log((DEVICE_NAME ":vboxUSBSolarisIntrXferCompleted Pipe Gone.\n"));
3446
3447 usb_free_intr_req(pReq);
3448}
3449
3450
3451/**
3452 * Perform an Isochronous Xfer.
3453 *
3454 * @param pState The USB device instance.
3455 * @param pEp The Endpoint for the Xfer.
3456 * @param pUrb The VBox USB URB.
3457 *
3458 * @returns VBox status code.
3459 * @remarks Any errors, the caller should free pUrb->pMsg.
3460 */
3461LOCAL int vboxUSBSolarisIsocXfer(vboxusb_state_t *pState, vboxusb_ep_t *pEp, vboxusb_urb_t *pUrb)
3462{
3463// LogFunc((DEVICE_NAME ":vboxUSBSolarisIsocXfer pState=%p pEp=%p pUrb=%p\n", pState, pEp, pUrb));
3464
3465 /*
3466 * For Isoc. IN transfers we perform one request and USBA polls the device continuously
3467 * and supplies our Xfer callback with input data. We cannot perform one-shot Isoc. In transfers.
3468 */
3469 size_t cbData = (pUrb->enmDir == VUSBDIRECTION_IN ? pUrb->cIsocPkts * pUrb->aIsocPkts[0].cbPkt : 0);
3470 if (pUrb->enmDir == VUSBDIRECTION_IN)
3471 {
3472 Log((DEVICE_NAME ":vboxUSBSolarisIsocXfer Isoc. In queueing.\n"));
3473
3474 mutex_enter(&pState->Mtx);
3475 if (pEp->fIsocPolling)
3476 {
3477 /*
3478 * Queue a maximum of cbMaxIsocData bytes, else fail.
3479 */
3480 if (pEp->cbIsocInLandedReqs + cbData > pEp->cbMaxIsocData)
3481 {
3482 mutex_exit(&pState->Mtx);
3483 Log((DEVICE_NAME ":vboxUSBSolarisIsocXfer Max Isoc. data %d bytes queued\n", pEp->cbMaxIsocData));
3484 return VERR_TOO_MUCH_DATA;
3485 }
3486
3487 list_insert_tail(&pEp->hIsocInUrbs, pUrb);
3488 ++pEp->cIsocInUrbs;
3489
3490 mutex_exit(&pState->Mtx);
3491 return VINF_SUCCESS;
3492 }
3493 mutex_exit(&pState->Mtx);
3494 }
3495
3496 int rc = VINF_SUCCESS;
3497 usb_isoc_req_t *pReq = usb_alloc_isoc_req(pState->pDip, pUrb->cIsocPkts, cbData, USB_FLAGS_NOSLEEP);
3498 Log((DEVICE_NAME ":vboxUSBSolarisIsocXfer enmDir=%#x cIsocPkts=%d aIsocPkts[0]=%d cbDataR3=%d\n", pUrb->enmDir,
3499 pUrb->cIsocPkts, pUrb->aIsocPkts[0].cbPkt, pUrb->cbDataR3));
3500 if (RT_LIKELY(pReq))
3501 {
3502 /*
3503 * Initialize Isoc Xfer, callbacks & timeouts.
3504 */
3505 for (unsigned i = 0; i < pUrb->cIsocPkts; i++)
3506 pReq->isoc_pkt_descr[i].isoc_pkt_length = pUrb->aIsocPkts[i].cbPkt;
3507
3508 if (pUrb->enmDir == VUSBDIRECTION_OUT)
3509 {
3510 pReq->isoc_data = pUrb->pMsg;
3511 pReq->isoc_attributes = USB_ATTRS_AUTOCLEARING | USB_ATTRS_ISOC_XFER_ASAP;
3512 pReq->isoc_cb = vboxUSBSolarisIsocOutXferCompleted;
3513 pReq->isoc_exc_cb = vboxUSBSolarisIsocOutXferCompleted;
3514 pReq->isoc_client_private = (usb_opaque_t)pUrb;
3515 }
3516 else
3517 {
3518 pReq->isoc_attributes = USB_ATTRS_AUTOCLEARING | USB_ATTRS_ISOC_XFER_ASAP | USB_ATTRS_SHORT_XFER_OK;
3519 pReq->isoc_cb = vboxUSBSolarisIsocInXferCompleted;
3520 pReq->isoc_exc_cb = vboxUSBSolarisIsocInXferError;
3521 pReq->isoc_client_private = (usb_opaque_t)pState;
3522 }
3523 pReq->isoc_pkts_count = pUrb->cIsocPkts;
3524 pReq->isoc_pkts_length = 0; /* auto compute */
3525
3526 /*
3527 * Submit the request.
3528 */
3529 rc = usb_pipe_isoc_xfer(pEp->pPipe, pReq, USB_FLAGS_NOSLEEP);
3530 if (RT_LIKELY(rc == USB_SUCCESS))
3531 {
3532 if (pUrb->enmDir == VUSBDIRECTION_IN)
3533 {
3534 /*
3535 * Add the first Isoc. IN URB to the queue as well.
3536 */
3537 mutex_enter(&pState->Mtx);
3538 list_insert_tail(&pEp->hIsocInUrbs, pUrb);
3539 ++pEp->cIsocInUrbs;
3540 pEp->fIsocPolling = true;
3541 mutex_exit(&pState->Mtx);
3542 }
3543
3544 return VINF_SUCCESS;
3545 }
3546 else
3547 {
3548 LogRel((DEVICE_NAME ":vboxUSBSolarisIsocXfer usb_pipe_isoc_xfer failed! rc=%d\n", rc));
3549 rc = VERR_PIPE_IO_ERROR;
3550
3551 if (pUrb->enmDir == VUSBDIRECTION_IN)
3552 {
3553 mutex_enter(&pState->Mtx);
3554 vboxusb_urb_t *pIsocFailedUrb = list_remove_tail(&pEp->hIsocInUrbs);
3555 if (pIsocFailedUrb)
3556 {
3557 RTMemFree(pIsocFailedUrb);
3558 --pEp->cIsocInUrbs;
3559 }
3560 pEp->fIsocPolling = false;
3561 mutex_exit(&pState->Mtx);
3562 }
3563 }
3564
3565 if (pUrb->enmDir == VUSBDIRECTION_OUT) /* pUrb->pMsg freed by caller */
3566 pReq->isoc_data = NULL;
3567
3568 usb_free_isoc_req(pReq);
3569 }
3570 else
3571 {
3572 LogRel((DEVICE_NAME ":vboxUSBSolarisIsocXfer failed to alloc isoc req for %d packets\n", pUrb->cIsocPkts));
3573 rc = VERR_NO_MEMORY;
3574 }
3575
3576 return rc;
3577}
3578
3579
3580/**
3581 * Completion/Exception callback for Isoc IN Xfers.
3582 *
3583 * @param pPipe The Intr pipe handle.
3584 * @param pReq The Intr request.
3585 *
3586 * @remarks Completion callback executes in interrupt context!
3587 */
3588LOCAL void vboxUSBSolarisIsocInXferCompleted(usb_pipe_handle_t pPipe, usb_isoc_req_t *pReq)
3589{
3590// LogFunc((DEVICE_NAME ":vboxUSBSolarisIsocInXferCompleted pPipe=%p pReq=%p\n", pPipe, pReq));
3591
3592 vboxusb_state_t *pState = (vboxusb_state_t *)pReq->isoc_client_private;
3593 if (RT_LIKELY(pState))
3594 {
3595 vboxusb_ep_t *pEp = (vboxusb_ep_t *)usb_pipe_get_private(pPipe);
3596 if ( pEp
3597 && pEp->pPipe)
3598 {
3599#if 0
3600 /*
3601 * Stop polling if all packets failed.
3602 */
3603 if (pReq->isoc_error_count == pReq->isoc_pkts_count)
3604 {
3605 Log((DEVICE_NAME ":vboxUSBSolarisIsocInXferCompleted stopping polling! Too many errors.\n"));
3606 mutex_exit(&pState->Mtx);
3607 usb_pipe_stop_isoc_polling(pPipe, USB_FLAGS_NOSLEEP);
3608 mutex_enter(&pState->Mtx);
3609 pEp->fIsocPolling = false;
3610 }
3611#endif
3612
3613 AssertCompile(sizeof(VUSBISOC_PKT_DESC) == sizeof(usb_isoc_pkt_descr_t));
3614
3615 if (RT_LIKELY(pReq->isoc_data))
3616 {
3617 Log((DEVICE_NAME ":vboxUSBSolarisIsocInXferCompleted cIsocInUrbs=%d cbIsocInLandedReqs=%d\n", pEp->cIsocInUrbs,
3618 pEp->cbIsocInLandedReqs));
3619
3620 mutex_enter(&pState->Mtx);
3621
3622 /*
3623 * If there are waiting URBs, satisfy the oldest one.
3624 */
3625 if ( pEp->cIsocInUrbs > 0
3626 && pEp->cbIsocInLandedReqs == 0)
3627 {
3628 vboxusb_urb_t *pUrb = list_remove_head(&pEp->hIsocInUrbs);
3629 if (RT_LIKELY(pUrb))
3630 {
3631 --pEp->cIsocInUrbs;
3632 mutex_exit(&pState->Mtx);
3633
3634 for (unsigned i = 0; i < pReq->isoc_pkts_count; i++)
3635 {
3636 pUrb->aIsocPkts[i].cbActPkt = pReq->isoc_pkt_descr[i].isoc_pkt_actual_length;
3637 pUrb->aIsocPkts[i].enmStatus = vboxUSBSolarisGetUrbStatus(pReq->isoc_pkt_descr[i].isoc_pkt_status);
3638 }
3639
3640 pUrb->pMsg = pReq->isoc_data;
3641 pReq->isoc_data = NULL;
3642
3643 /*
3644 * Move to landed list
3645 */
3646 mutex_enter(&pState->Mtx);
3647 list_insert_tail(&pState->hLandedUrbs, pUrb);
3648 vboxUSBSolarisNotifyComplete(pState);
3649 }
3650 else
3651 {
3652 /* Huh!? cIsocInUrbs is wrong then! Should never happen unless we decide to decrement cIsocInUrbs in
3653 Reap time */
3654 pEp->cIsocInUrbs = 0;
3655 LogRel((DEVICE_NAME ":vboxUSBSolarisIsocInXferCompleted Extreme error! Isoc. counter b0rked!\n"));
3656 }
3657
3658 mutex_exit(&pState->Mtx);
3659 usb_free_isoc_req(pReq);
3660 return;
3661 }
3662
3663#if 0
3664 /*
3665 * If the maximum buffer size is reached, discard the oldest data.
3666 */
3667 if (pEp->cbIsocInLandedReqs + MBLKL(pReq->isoc_data) > pEp->cbMaxIsocData)
3668 {
3669 vboxusb_isoc_req_t *pOldReq = list_remove_head(&pEp->hIsocInLandedReqs);
3670 if (RT_LIKELY(pOldReq))
3671 {
3672 pEp->cbIsocInLandedReqs -= MBLKL(pOldReq->pMsg);
3673 kmem_free(pOldReq, sizeof(vboxusb_isoc_req_t));
3674 }
3675 }
3676
3677 mutex_exit(&pState->Mtx);
3678
3679 /*
3680 * Buffer incoming data if the guest has not yet queued any Input URBs.
3681 */
3682 Log((DEVICE_NAME ":vboxUSBSolarisIsocInXferCompleted Buffering\n"));
3683 vboxusb_isoc_req_t *pIsocReq = kmem_alloc(sizeof(vboxusb_isoc_req_t), KM_NOSLEEP);
3684 if (RT_LIKELY(pIsocReq))
3685 {
3686 pIsocReq->pMsg = pReq->isoc_data;
3687 pReq->isoc_data = NULL;
3688 pIsocReq->cIsocPkts = pReq->isoc_pkts_count;
3689#if 0
3690 for (unsigned i = 0; i < pReq->isoc_pkts_count; i++)
3691 {
3692 pIsocReq->aIsocPkts[i].cbActPkt = pReq->isoc_pkt_descr[i].isoc_pkt_actual_length;
3693 pIsocReq->aIsocPkts[i].enmStatus = vboxUSBSolarisGetUrbStatus(pReq->isoc_pkt_descr[i].isoc_pkt_status);
3694 }
3695#else
3696 bcopy(pReq->isoc_pkt_descr, pIsocReq->aIsocPkts, pReq->isoc_pkts_count * sizeof(VUSBISOC_PKT_DESC));
3697#endif
3698
3699 mutex_enter(&pState->Mtx);
3700 list_insert_tail(&pEp->hIsocInLandedReqs, pIsocReq);
3701 pEp->cbIsocInLandedReqs += MBLKL(pIsocReq->pMsg);
3702 mutex_exit(&pState->Mtx);
3703 }
3704 else
3705 {
3706 LogRel((DEVICE_NAME ":vboxUSBSolarisIsocInXferCompleted failed to alloc %d bytes for Isoc. queueing\n",
3707 sizeof(vboxusb_isoc_req_t)));
3708 }
3709
3710 /*
3711 * Drain the input URB buffer with the device buffer, queueing them with the landed URBs.
3712 */
3713 mutex_enter(&pState->Mtx);
3714 while (pEp->cIsocInUrbs)
3715 {
3716 vboxusb_urb_t *pUrb = list_remove_head(&pEp->hIsocInUrbs);
3717 if (RT_UNLIKELY(!pUrb))
3718 break;
3719
3720 vboxusb_isoc_req_t *pBuffReq = list_remove_head(&pEp->hIsocInLandedReqs);
3721 if (!pBuffReq)
3722 {
3723 list_insert_head(&pEp->hIsocInUrbs, pUrb);
3724 break;
3725 }
3726
3727 --pEp->cIsocInUrbs;
3728 pEp->cbIsocInLandedReqs -= MBLKL(pBuffReq->pMsg);
3729 mutex_exit(&pState->Mtx);
3730
3731#if 0
3732 for (unsigned i = 0; i < pBuffReq->cIsocPkts; i++)
3733 {
3734 pUrb->aIsocPkts[i].cbActPkt = pBuffReq->aIsocPkts[i].cbActPkt;
3735 pUrb->aIsocPkts[i].enmStatus = pBuffReq->aIsocPkts[i].enmStatus;
3736 }
3737#else
3738 bcopy(pBuffReq->aIsocPkts, pUrb->aIsocPkts, pBuffReq->cIsocPkts * sizeof(VUSBISOC_PKT_DESC));
3739#endif
3740 pUrb->pMsg = pBuffReq->pMsg;
3741 pBuffReq->pMsg = NULL;
3742 kmem_free(pBuffReq, sizeof(vboxusb_isoc_req_t));
3743
3744 /*
3745 * Move to landed list
3746 */
3747 mutex_enter(&pState->Mtx);
3748 list_insert_tail(&pState->hLandedUrbs, pUrb);
3749 vboxUSBSolarisNotifyComplete(pState);
3750 }
3751#endif
3752
3753 mutex_exit(&pState->Mtx);
3754 usb_free_isoc_req(pReq);
3755 return;
3756 }
3757 else
3758 LogRel((DEVICE_NAME ":vboxUSBSolarisIsocInXferCompleted data missing.\n"));
3759 }
3760 else
3761 LogRel((DEVICE_NAME ":vboxUSBSolarisIsocInXferCompleted Pipe Gone.\n"));
3762 }
3763 else
3764 Log((DEVICE_NAME ":vboxUSBSolarisIsocInXferCompleted State Gone.\n"));
3765
3766 usb_free_isoc_req(pReq);
3767}
3768
3769
3770/**
3771 * Exception callback for Isoc IN Xfers.
3772 *
3773 * @param pPipe The Intr pipe handle.
3774 * @param pReq The Intr request.
3775 * @remarks Completion callback executes in interrupt context!
3776 */
3777LOCAL void vboxUSBSolarisIsocInXferError(usb_pipe_handle_t pPipe, usb_isoc_req_t *pReq)
3778{
3779 LogFunc((DEVICE_NAME ":vboxUSBSolarisIsocInXferError pPipe=%p pReq=%p\n", pPipe, pReq));
3780
3781 vboxusb_state_t *pState = (vboxusb_state_t *)pReq->isoc_client_private;
3782 if (RT_UNLIKELY(!pState))
3783 {
3784 Log((DEVICE_NAME ":vboxUSBSolarisIsocInXferError State Gone.\n"));
3785 usb_free_isoc_req(pReq);
3786 return;
3787 }
3788
3789 mutex_enter(&pState->Mtx);
3790 vboxusb_ep_t *pEp = (vboxusb_ep_t *)usb_pipe_get_private(pPipe);
3791 if (RT_UNLIKELY(!pEp))
3792 {
3793 Log((DEVICE_NAME ":vboxUSBSolarisIsocInXferError Pipe Gone.\n"));
3794 mutex_exit(&pState->Mtx);
3795 usb_free_isoc_req(pReq);
3796 return;
3797 }
3798
3799 switch(pReq->isoc_completion_reason)
3800 {
3801 case USB_CR_NO_RESOURCES:
3802 {
3803 /*
3804 * Resubmit the request in case the original request did not complete due to
3805 * immediately unavailable requests
3806 */
3807 mutex_exit(&pState->Mtx);
3808 usb_pipe_isoc_xfer(pPipe, pReq, USB_FLAGS_NOSLEEP);
3809 Log((DEVICE_NAME ":vboxUSBSolarisIsocInXferError resubmitted Isoc. IN request due to immediately unavailable "
3810 "resources.\n"));
3811
3812 return;
3813 }
3814
3815 case USB_CR_PIPE_CLOSING:
3816 case USB_CR_STOPPED_POLLING:
3817 case USB_CR_PIPE_RESET:
3818 {
3819 pEp->fIsocPolling = false;
3820 usb_free_isoc_req(pReq);
3821 break;
3822 }
3823
3824 default:
3825 {
3826 Log((DEVICE_NAME ":vboxUSBSolarisIsocInXferError stopping Isoc. In. polling due to rc=%d\n",
3827 pReq->isoc_completion_reason));
3828 pEp->fIsocPolling = false;
3829 mutex_exit(&pState->Mtx);
3830 usb_pipe_stop_isoc_polling(pPipe, USB_FLAGS_NOSLEEP);
3831 usb_free_isoc_req(pReq);
3832 mutex_enter(&pState->Mtx);
3833 break;
3834 }
3835 }
3836
3837 /*
3838 * Dequeue i.e. delete the last queued Isoc In. URB. as failed.
3839 */
3840 vboxusb_urb_t *pUrb = list_remove_tail(&pEp->hIsocInUrbs);
3841 if (pUrb)
3842 {
3843 --pEp->cIsocInUrbs;
3844 Log((DEVICE_NAME ":vboxUSBSolarisIsocInXferError Deleting last queued URB as it failed.\n"));
3845 freemsg(pUrb->pMsg);
3846 RTMemFree(pUrb);
3847 vboxUSBSolarisNotifyComplete(pState);
3848 }
3849
3850 mutex_exit(&pState->Mtx);
3851}
3852
3853
3854/**
3855 * Completion/Exception callback for Isoc OUT Xfers.
3856 *
3857 * @param pPipe The Intr pipe handle.
3858 * @param pReq The Intr request.
3859 * @remarks Completion callback executes in interrupt context!
3860 */
3861LOCAL void vboxUSBSolarisIsocOutXferCompleted(usb_pipe_handle_t pPipe, usb_isoc_req_t *pReq)
3862{
3863 LogFunc((DEVICE_NAME ":vboxUSBSolarisIsocOutXferCompleted pPipe=%p pReq=%p\n", pPipe, pReq));
3864
3865 vboxusb_ep_t *pEp = (vboxusb_ep_t *)usb_pipe_get_private(pPipe);
3866 if (RT_LIKELY(pEp))
3867 {
3868 vboxusb_urb_t *pUrb = (vboxusb_urb_t *)pReq->isoc_client_private;
3869 if (RT_LIKELY(pUrb))
3870 {
3871 size_t cbActPkt = 0;
3872 for (int i = 0; i < pReq->isoc_pkts_count; i++)
3873 {
3874 cbActPkt += pReq->isoc_pkt_descr[i].isoc_pkt_actual_length;
3875 pUrb->aIsocPkts[i].cbActPkt = pReq->isoc_pkt_descr[i].isoc_pkt_actual_length;
3876 pUrb->aIsocPkts[i].enmStatus = vboxUSBSolarisGetUrbStatus(pReq->isoc_pkt_descr[i].isoc_pkt_status);
3877 }
3878
3879 Log((DEVICE_NAME ":vboxUSBSolarisIsocOutXferCompleted cIsocPkts=%d cbData=%d cbActPkt=%d\n", pUrb->cIsocPkts,
3880 pUrb->cbDataR3, cbActPkt));
3881
3882 if (pReq->isoc_completion_reason == USB_CR_OK)
3883 {
3884 if (RT_UNLIKELY(pUrb->pMsg != pReq->isoc_data)) /* Paranoia */
3885 {
3886 freemsg(pUrb->pMsg);
3887 pUrb->pMsg = pReq->isoc_data;
3888 }
3889 }
3890 pReq->isoc_data = NULL;
3891
3892 pUrb->cIsocPkts = pReq->isoc_pkts_count;
3893 pUrb->cbDataR3 = cbActPkt;
3894
3895 /*
3896 * Update the URB and move to landed list for reaping.
3897 */
3898 vboxUSBSolarisDeQueueURB(pUrb, pReq->isoc_completion_reason);
3899 usb_free_isoc_req(pReq);
3900 return;
3901 }
3902 else
3903 Log((DEVICE_NAME ":vboxUSBSolarisIsocOutXferCompleted missing private data!?! Dropping OUT pUrb.\n"));
3904 }
3905 else
3906 Log((DEVICE_NAME ":vboxUSBSolarisIsocOutXferCompleted Pipe Gone.\n"));
3907
3908 usb_free_isoc_req(pReq);
3909}
3910
3911
3912/**
3913 * Callback when the device gets disconnected.
3914 *
3915 * @param pDip The module structure instance.
3916 *
3917 * @returns Solaris USB error code.
3918 */
3919LOCAL int vboxUSBSolarisDeviceDisconnected(dev_info_t *pDip)
3920{
3921 LogFunc((DEVICE_NAME ":vboxUSBSolarisDeviceDisconnected pDip=%p\n", pDip));
3922
3923 int instance = ddi_get_instance(pDip);
3924 vboxusb_state_t *pState = ddi_get_soft_state(g_pVBoxUSBSolarisState, instance);
3925
3926 if (RT_LIKELY(pState))
3927 {
3928 /*
3929 * Serialize access: exclusive access to the state.
3930 */
3931 usb_serialize_access(pState->StateMulti, USB_WAIT, 0);
3932 mutex_enter(&pState->Mtx);
3933
3934 pState->DevState = USB_DEV_DISCONNECTED;
3935
3936 vboxUSBSolarisCloseAllPipes(pState, true /* ControlPipe */);
3937 vboxUSBSolarisNotifyHotplug(pState);
3938
3939 mutex_exit(&pState->Mtx);
3940 usb_release_access(pState->StateMulti);
3941
3942 return USB_SUCCESS;
3943 }
3944
3945 LogRel((DEVICE_NAME ":vboxUSBSolarisDeviceDisconnected failed to get device state!\n"));
3946 return USB_FAILURE;
3947}
3948
3949
3950/**
3951 * Callback when the device gets reconnected.
3952 *
3953 * @param pDip The module structure instance.
3954 *
3955 * @returns Solaris USB error code.
3956 */
3957LOCAL int vboxUSBSolarisDeviceReconnected(dev_info_t *pDip)
3958{
3959 LogFunc((DEVICE_NAME ":vboxUSBSolarisDeviceReconnected pDip=%p\n", pDip));
3960
3961 int instance = ddi_get_instance(pDip);
3962 vboxusb_state_t *pState = ddi_get_soft_state(g_pVBoxUSBSolarisState, instance);
3963
3964 if (RT_LIKELY(pState))
3965 {
3966 vboxUSBSolarisDeviceRestore(pState);
3967 return USB_SUCCESS;
3968 }
3969
3970 LogRel((DEVICE_NAME ":vboxUSBSolarisDeviceReconnected failed to get device state!\n"));
3971 return USB_FAILURE;
3972}
3973
3974
3975/**
3976 * Restore device state after a reconnect or resume.
3977 *
3978 * @param pState The USB device instance.
3979 */
3980LOCAL void vboxUSBSolarisDeviceRestore(vboxusb_state_t *pState)
3981{
3982 LogFunc((DEVICE_NAME ":vboxUSBSolarisDeviceRestore pState=%p\n", pState));
3983 AssertPtrReturnVoid(pState);
3984
3985 /*
3986 * Raise device power.
3987 */
3988 vboxUSBSolarisPowerBusy(pState);
3989 int rc = pm_raise_power(pState->pDip, 0 /* component */, USB_DEV_OS_FULL_PWR);
3990
3991 /*
3992 * Check if the same device is resumed/reconnected.
3993 */
3994 rc = usb_check_same_device(pState->pDip,
3995 NULL, /* log handle */
3996 USB_LOG_L2, /* log level */
3997 -1, /* log mask */
3998 USB_CHK_ALL, /* check level */
3999 NULL); /* device string */
4000
4001 if (rc != USB_SUCCESS)
4002 {
4003 mutex_enter(&pState->Mtx);
4004 pState->DevState = USB_DEV_DISCONNECTED;
4005 mutex_exit(&pState->Mtx);
4006
4007 /* Do we need to inform userland here? */
4008 vboxUSBSolarisPowerIdle(pState);
4009 Log((DEVICE_NAME ":vboxUSBSolarisDeviceRestore not the same device.\n"));
4010 return;
4011 }
4012
4013 /*
4014 * Serialize access to not race with other PM functions.
4015 */
4016 usb_serialize_access(pState->StateMulti, USB_WAIT, 0);
4017
4018 mutex_enter(&pState->Mtx);
4019 if (pState->DevState == USB_DEV_DISCONNECTED)
4020 pState->DevState = USB_DEV_ONLINE;
4021 else if (pState->DevState == USB_DEV_SUSPENDED)
4022 pState->DevState = USB_DEV_ONLINE;
4023
4024 mutex_exit(&pState->Mtx);
4025 usb_release_access(pState->StateMulti);
4026
4027 vboxUSBSolarisPowerIdle(pState);
4028}
4029
4030
4031/**
4032 * Restore device state after a reconnect or resume.
4033 *
4034 * @param pState The USB device instance.
4035 *
4036 * @returns VBox status code.
4037 */
4038LOCAL int vboxUSBSolarisDeviceSuspend(vboxusb_state_t *pState)
4039{
4040 LogFunc((DEVICE_NAME ":vboxUSBSolarisDeviceSuspend pState=%p\n", pState));
4041
4042 int rc = VERR_VUSB_DEVICE_IS_SUSPENDED;
4043 mutex_enter(&pState->Mtx);
4044
4045 switch (pState->DevState)
4046 {
4047 case USB_DEV_SUSPENDED:
4048 {
4049 LogRel((DEVICE_NAME ":vboxUSBSolarisDeviceSuspend: Invalid device state %d\n", pState->DevState));
4050 break;
4051 }
4052
4053 case USB_DEV_ONLINE:
4054 case USB_DEV_DISCONNECTED:
4055 case USB_DEV_PWRED_DOWN:
4056 {
4057 int PreviousState = pState->DevState;
4058 pState->DevState = USB_DEV_DISCONNECTED;
4059
4060 /*
4061 * Drain pending URBs.
4062 */
4063 for (int i = 0; i < VBOXUSB_DRAIN_TIME; i++)
4064 {
4065 if (pState->cInflightUrbs < 1)
4066 break;
4067
4068 mutex_exit(&pState->Mtx);
4069 delay(drv_usectohz(100000));
4070 mutex_enter(&pState->Mtx);
4071 }
4072
4073 /*
4074 * Deny suspend if we still have pending URBs.
4075 */
4076 if (pState->cInflightUrbs > 0)
4077 {
4078 pState->DevState = PreviousState;
4079 LogRel((DEVICE_NAME ":Cannot suspend, still have %d inflight URBs.\n", pState->cInflightUrbs));
4080
4081 mutex_exit(&pState->Mtx);
4082 return VERR_RESOURCE_BUSY;
4083 }
4084
4085 pState->cInflightUrbs = 0;
4086
4087 /*
4088 * Serialize access to not race with Open/Detach/Close and
4089 * Close all pipes including the default pipe.
4090 */
4091 mutex_exit(&pState->Mtx);
4092 usb_serialize_access(pState->StateMulti, USB_WAIT, 0);
4093 mutex_enter(&pState->Mtx);
4094
4095 vboxUSBSolarisCloseAllPipes(pState, true /* default pipe */);
4096 vboxUSBSolarisNotifyHotplug(pState);
4097
4098 mutex_exit(&pState->Mtx);
4099 usb_release_access(pState->StateMulti);
4100 return VINF_SUCCESS;
4101 }
4102 }
4103
4104 mutex_exit(&pState->Mtx);
4105 Log((DEVICE_NAME ":vboxUSBSolarisDeviceSuspend returns %d\n", rc));
4106 return rc;
4107}
4108
4109
4110/**
4111 * Restore device state after a reconnect or resume.
4112 *
4113 * @param pState The USB device instance.
4114 */
4115LOCAL void vboxUSBSolarisDeviceResume(vboxusb_state_t *pState)
4116{
4117 LogFunc((DEVICE_NAME ":vboxUSBSolarisDeviceResume pState=%p\n", pState));
4118 return vboxUSBSolarisDeviceRestore(pState);
4119}
4120
4121
4122/**
4123 * Flag the PM component as busy so the system will not manage it's power.
4124 *
4125 * @param pState The USB device instance.
4126 */
4127LOCAL void vboxUSBSolarisPowerBusy(vboxusb_state_t *pState)
4128{
4129 LogFunc((DEVICE_NAME ":vboxUSBSolarisPowerBusy pState=%p\n", pState));
4130 AssertPtrReturnVoid(pState);
4131
4132 mutex_enter(&pState->Mtx);
4133 if (pState->pPower)
4134 {
4135 pState->pPower->PowerBusy++;
4136 mutex_exit(&pState->Mtx);
4137
4138 int rc = pm_busy_component(pState->pDip, 0 /* component */);
4139 if (rc != DDI_SUCCESS)
4140 {
4141 Log((DEVICE_NAME ":vboxUSBSolarisPowerBusy busy component failed! rc=%d\n", rc));
4142 mutex_enter(&pState->Mtx);
4143 pState->pPower->PowerBusy--;
4144 mutex_exit(&pState->Mtx);
4145 }
4146 }
4147 else
4148 mutex_exit(&pState->Mtx);
4149}
4150
4151
4152/**
4153 * Flag the PM component as idle so its power managed by the system.
4154 *
4155 * @param pState The USB device instance.
4156 */
4157LOCAL void vboxUSBSolarisPowerIdle(vboxusb_state_t *pState)
4158{
4159 LogFunc((DEVICE_NAME ":vboxUSBSolarisPowerIdle pState=%p\n", pState));
4160 AssertPtrReturnVoid(pState);
4161
4162 if (pState->pPower)
4163 {
4164 int rc = pm_idle_component(pState->pDip, 0 /* component */);
4165 if (rc == DDI_SUCCESS)
4166 {
4167 mutex_enter(&pState->Mtx);
4168 Assert(pState->pPower->PowerBusy > 0);
4169 pState->pPower->PowerBusy--;
4170 mutex_exit(&pState->Mtx);
4171 }
4172 else
4173 Log((DEVICE_NAME ":vboxUSBSolarisPowerIdle idle component failed! rc=%d\n", rc));
4174 }
4175}
4176
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