VirtualBox

source: vbox/trunk/src/VBox/Devices/USB/DrvVUSBRootHub.cpp@ 93956

Last change on this file since 93956 was 93956, checked in by vboxsync, 3 years ago

Devices/USB: Eliminiate some callback ping-pong and streamline the device attach/detach logic, bugref:10196 [fix, the saved state logic needs to use the new logic as well]
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 84.0 KB
Line 
1/* $Id: DrvVUSBRootHub.cpp 93956 2022-02-25 16:21:22Z vboxsync $ */
2/** @file
3 * Virtual USB - Root Hub Driver.
4 */
5
6/*
7 * Copyright (C) 2005-2022 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
18
19/** @page pg_dev_vusb VUSB - Virtual USB
20 *
21 * @todo read thru this and correct typos. Merge with old docs.
22 *
23 *
24 * The Virtual USB component glues USB devices and host controllers together.
25 * The VUSB takes the form of a PDM driver which is attached to the HCI. USB
26 * devices are created by, attached to, and managed by the VUSB roothub. The
27 * VUSB also exposes an interface which is used by Main to attach and detach
28 * proxied USB devices.
29 *
30 *
31 * @section sec_dev_vusb_urb The Life of an URB
32 *
33 * The URB is created when the HCI calls the roothub (VUSB) method pfnNewUrb.
34 * VUSB has a pool of URBs, if no free URBs are available a new one is
35 * allocated. The returned URB starts life in the ALLOCATED state and all
36 * fields are initialized with sensible defaults.
37 *
38 * The HCI then copies any request data into the URB if it's an host2dev
39 * transfer. It then submits the URB by calling the pfnSubmitUrb roothub
40 * method.
41 *
42 * pfnSubmitUrb will start by checking if it knows the device address, and if
43 * it doesn't the URB is completed with a device-not-ready error. When the
44 * device address is known to it, action is taken based on the kind of
45 * transfer it is. There are four kinds of transfers: 1. control, 2. bulk,
46 * 3. interrupt, and 4. isochronous. In either case something eventually ends
47 * up being submitted to the device.
48 *
49 *
50 * If an URB fails submitting, may or may not be completed. This depends on
51 * heuristics in some cases and on the kind of failure in others. If
52 * pfnSubmitUrb returns a failure, the HCI should retry submitting it at a
53 * later time. If pfnSubmitUrb returns success the URB is submitted, and it
54 * can even been completed.
55 *
56 * The URB is in the IN_FLIGHT state from the time it's successfully submitted
57 * and till it's reaped or cancelled.
58 *
59 * When an URB transfer or in some case submit failure occurs, the pfnXferError
60 * callback of the HCI is consulted about what to do. If pfnXferError indicates
61 * that the URB should be retried, pfnSubmitUrb will fail. If it indicates that
62 * it should fail, the URB will be completed.
63 *
64 * Completing an URB means that the URB status is set and the HCI
65 * pfnXferCompletion callback is invoked with the URB. The HCI is the supposed
66 * to report the transfer status to the guest OS. After completion the URB
67 * is freed and returned to the pool, unless it was cancelled. If it was
68 * cancelled it will have to await reaping before it's actually freed.
69 *
70 *
71 * @subsection subsec_dev_vusb_urb_ctrl Control
72 *
73 * The control transfer is the most complex one, from VUSB's point of view,
74 * with its three stages and being bi-directional. A control transfer starts
75 * with a SETUP packet containing the request description and two basic
76 * parameters. It is followed by zero or more DATA packets which either picks
77 * up incoming data (dev2host) or supplies the request data (host2dev). This
78 * can then be followed by a STATUS packet which gets the status of the whole
79 * transfer.
80 *
81 * What makes the control transfer complicated is that for a host2dev request
82 * the URB is assembled from the SETUP and DATA stage, and for a dev2host
83 * request the returned data must be kept around for the DATA stage. For both
84 * transfer directions the status of the transfer has to be kept around for
85 * the STATUS stage.
86 *
87 * To complicate matters further, VUSB must intercept and in some cases emulate
88 * some of the standard requests in order to keep the virtual device state
89 * correct and provide the correct virtualization of a device.
90 *
91 * @subsection subsec_dev_vusb_urb_bulk Bulk and Interrupt
92 *
93 * The bulk and interrupt transfer types are relativly simple compared to the
94 * control transfer. VUSB is not inspecting the request content or anything,
95 * but passes it down the device.
96 *
97 * @subsection subsec_dev_vusb_urb_isoc Isochronous
98 *
99 * This kind of transfers hasn't yet been implemented.
100 *
101 */
102
103
104/** @page pg_dev_vusb_old VUSB - Virtual USB Core
105 *
106 * The virtual USB core is controlled by the roothub and the underlying HCI
107 * emulator, it is responsible for device addressing, managing configurations,
108 * interfaces and endpoints, assembling and splitting multi-part control
109 * messages and in general acts as a middle layer between the USB device
110 * emulation code and USB HCI emulation code.
111 *
112 * All USB devices are represented by a struct vusb_dev. This structure
113 * contains things like the device state, device address, all the configuration
114 * descriptors, the currently selected configuration and a mapping between
115 * endpoint addresses and endpoint descriptors.
116 *
117 * Each vusb_dev also has a pointer to a vusb_dev_ops structure which serves as
118 * the virtual method table and includes a virtual constructor and destructor.
119 * After a vusb_dev is created it may be attached to a hub device such as a
120 * roothub (using vusbHubAttach). Although each hub structure has cPorts
121 * and cDevices fields, it is the responsibility of the hub device to allocate
122 * a free port for the new device.
123 *
124 * Devices can chose one of two interfaces for dealing with requests, the
125 * synchronous interface or the asynchronous interface. The synchronous
126 * interface is much simpler and ought to be used for devices which are
127 * unlikely to sleep for long periods in order to serve requests. The
128 * asynchronous interface on the other hand is more difficult to use but is
129 * useful for the USB proxy or if one were to write a mass storage device
130 * emulator. Currently the synchronous interface only supports control and bulk
131 * endpoints and is no longer used by anything.
132 *
133 * In order to use the asynchronous interface, the queue_urb, cancel_urb and
134 * pfnUrbReap fields must be set in the devices vusb_dev_ops structure. The
135 * queue_urb method is used to submit a request to a device without blocking,
136 * it returns 1 if successful and 0 on any kind of failure. A successfully
137 * queued URB is completed when the pfnUrbReap method returns it. Each function
138 * address is reference counted so that pfnUrbReap will only be called if there
139 * are URBs outstanding. For a roothub to reap an URB from any one of it's
140 * devices, the vusbRhReapAsyncUrbs() function is used.
141 *
142 * There are four types of messages an URB may contain:
143 * -# Control - represents a single packet of a multi-packet control
144 * transfer, these are only really used by the host controller to
145 * submit the parts to the usb core.
146 * -# Message - the usb core assembles multiple control transfers in
147 * to single message transfers. In this case the data buffer
148 * contains the setup packet in little endian followed by the full
149 * buffer. In the case of an host-to-device control message, the
150 * message packet is created when the STATUS transfer is seen. In
151 * the case of device-to-host messages, the message packet is
152 * created after the SETUP transfer is seen. Also, certain control
153 * requests never go the real device and get handled synchronously.
154 * -# Bulk - Currently the only endpoint type that does error checking
155 * and endpoint halting.
156 * -# Interrupt - The only non-periodic type supported.
157 *
158 * Hubs are special cases of devices, they have a number of downstream ports
159 * that other devices can be attached to and removed from.
160 *
161 * After a device has been attached (vusbHubAttach):
162 * -# The hub attach method is called, which sends a hub status
163 * change message to the OS.
164 * -# The OS resets the device, and it appears on the default
165 * address with it's config 0 selected (a pseudo-config that
166 * contains only 1 interface with 1 endpoint - the default
167 * message pipe).
168 * -# The OS assigns the device a new address and selects an
169 * appropriate config.
170 * -# The device is ready.
171 *
172 * After a device has been detached (vusbDevDetach):
173 * -# All pending URBs are cancelled.
174 * -# The devices address is unassigned.
175 * -# The hub detach method is called which signals the OS
176 * of the status change.
177 * -# The OS unlinks the ED's for that device.
178 *
179 * A device can also request detachment from within its own methods by
180 * calling vusbDevUnplugged().
181 *
182 * Roothubs are responsible for driving the whole system, they are special
183 * cases of hubs and as such implement attach and detach methods, each one
184 * is described by a struct vusb_roothub. Once a roothub has submitted an
185 * URB to the USB core, a number of callbacks to the roothub are required
186 * for when the URB completes, since the roothub typically wants to inform
187 * the OS when transfers are completed.
188 *
189 * There are four callbacks to be concerned with:
190 * -# prepare - This is called after the URB is successfully queued.
191 * -# completion - This is called after the URB completed.
192 * -# error - This is called if the URB errored, some systems have
193 * automatic resubmission of failed requests, so this callback
194 * should keep track of the error count and return 1 if the count
195 * is above the number of allowed resubmissions.
196 * -# halt_ep - This is called after errors on bulk pipes in order
197 * to halt the pipe.
198 *
199 */
200
201
202/*********************************************************************************************************************************
203* Header Files *
204*********************************************************************************************************************************/
205#define LOG_GROUP LOG_GROUP_DRV_VUSB
206#include <VBox/vmm/pdm.h>
207#include <VBox/vmm/vmapi.h>
208#include <VBox/err.h>
209#include <iprt/alloc.h>
210#include <VBox/log.h>
211#include <iprt/time.h>
212#include <iprt/thread.h>
213#include <iprt/semaphore.h>
214#include <iprt/string.h>
215#include <iprt/assert.h>
216#include <iprt/asm.h>
217#include <iprt/uuid.h>
218#include "VUSBInternal.h"
219#include "VBoxDD.h"
220
221
222#define VUSB_ROOTHUB_SAVED_STATE_VERSION 1
223
224
225/**
226 * Data used for reattaching devices on a state load.
227 */
228typedef struct VUSBROOTHUBLOAD
229{
230 /** Timer used once after state load to inform the guest about new devices.
231 * We do this to be sure the guest get any disconnect / reconnect on the
232 * same port. */
233 TMTIMERHANDLE hTimer;
234 /** Number of detached devices. */
235 unsigned cDevs;
236 /** Array of devices which were detached. */
237 PVUSBDEV apDevs[VUSB_DEVICES_MAX];
238} VUSBROOTHUBLOAD;
239
240
241/**
242 * Returns the attached VUSB device for the given port or NULL if none is attached.
243 *
244 * @returns Pointer to the VUSB device or NULL if not found.
245 * @param pThis The VUSB roothub device instance.
246 * @param uPort The port to get the device for.
247 *
248 * @note The reference count of the VUSB device structure is retained to prevent it from going away.
249 */
250static PVUSBDEV vusbR3RhGetVUsbDevByPortRetain(PVUSBROOTHUB pThis, uint32_t uPort)
251{
252 PVUSBDEV pDev = NULL;
253
254 AssertReturn(uPort < RT_ELEMENTS(pThis->apDevByPort), NULL);
255
256 RTCritSectEnter(&pThis->CritSectDevices);
257
258 pDev = pThis->apDevByPort[uPort];
259 if (RT_LIKELY(pDev))
260 vusbDevRetain(pDev);
261
262 RTCritSectLeave(&pThis->CritSectDevices);
263
264 return pDev;
265}
266
267
268/**
269 * Returns the attached VUSB device for the given port or NULL if none is attached.
270 *
271 * @returns Pointer to the VUSB device or NULL if not found.
272 * @param pThis The VUSB roothub device instance.
273 * @param u8Address The address to get the device for.
274 *
275 * @note The reference count of the VUSB device structure is retained to prevent it from going away.
276 */
277static PVUSBDEV vusbR3RhGetVUsbDevByAddrRetain(PVUSBROOTHUB pThis, uint8_t u8Address)
278{
279 PVUSBDEV pDev = NULL;
280
281 AssertReturn(u8Address < RT_ELEMENTS(pThis->apDevByAddr), NULL);
282
283 RTCritSectEnter(&pThis->CritSectDevices);
284
285 pDev = pThis->apDevByAddr[u8Address];
286 if (RT_LIKELY(pDev))
287 vusbDevRetain(pDev);
288
289 RTCritSectLeave(&pThis->CritSectDevices);
290
291 return pDev;
292}
293
294
295/**
296 * Returns a human readable string fromthe given USB speed enum.
297 *
298 * @returns Human readable string.
299 * @param enmSpeed The speed to stringify.
300 */
301static const char *vusbGetSpeedString(VUSBSPEED enmSpeed)
302{
303 const char *pszSpeed = NULL;
304
305 switch (enmSpeed)
306 {
307 case VUSB_SPEED_LOW:
308 pszSpeed = "Low";
309 break;
310 case VUSB_SPEED_FULL:
311 pszSpeed = "Full";
312 break;
313 case VUSB_SPEED_HIGH:
314 pszSpeed = "High";
315 break;
316 case VUSB_SPEED_VARIABLE:
317 pszSpeed = "Variable";
318 break;
319 case VUSB_SPEED_SUPER:
320 pszSpeed = "Super";
321 break;
322 case VUSB_SPEED_SUPERPLUS:
323 pszSpeed = "SuperPlus";
324 break;
325 default:
326 pszSpeed = "Unknown";
327 break;
328 }
329 return pszSpeed;
330}
331
332
333/**
334 * Attaches a device to a specific hub.
335 *
336 * This function is called by the vusb_add_device() and vusbRhAttachDevice().
337 *
338 * @returns VBox status code.
339 * @param pThis The roothub to attach it to.
340 * @param pDev The device to attach.
341 * @thread EMT
342 */
343static int vusbHubAttach(PVUSBROOTHUB pThis, PVUSBDEV pDev)
344{
345 LogFlow(("vusbHubAttach: pThis=%p[%s] pDev=%p[%s]\n", pThis, pThis->Hub.pszName, pDev, pDev->pUsbIns->pszName));
346
347 PVUSBHUB pHub = &pThis->Hub;
348
349 /*
350 * Assign a port.
351 */
352 int iPort = ASMBitFirstSet(&pThis->Bitmap, sizeof(pThis->Bitmap) * 8);
353 if (iPort < 0)
354 {
355 LogRel(("VUSB: No ports available!\n"));
356 return VERR_VUSB_NO_PORTS;
357 }
358 ASMBitClear(&pThis->Bitmap, iPort);
359 pHub->cDevices++;
360 pDev->i16Port = iPort;
361
362 /* Call the device attach helper, so it can initialize its state. */
363 int rc = vusbDevAttach(pDev, pHub);
364 if (RT_SUCCESS(rc))
365 {
366 RTCritSectEnter(&pThis->CritSectDevices);
367 Assert(!pThis->apDevByPort[iPort]);
368 pThis->apDevByPort[iPort] = pDev;
369 RTCritSectLeave(&pThis->CritSectDevices);
370
371 /*
372 * Call the HCI attach routine and let it have its say before the device is
373 * linked into the device list of this hub.
374 */
375 VUSBSPEED enmSpeed = pDev->IDevice.pfnGetSpeed(&pDev->IDevice);
376 rc = pThis->pIRhPort->pfnAttach(pThis->pIRhPort, iPort, enmSpeed);
377 if (RT_SUCCESS(rc))
378 {
379 LogRel(("VUSB: Attached '%s' to port %d on %s (%sSpeed)\n", pDev->pUsbIns->pszName,
380 iPort, pHub->pszName, vusbGetSpeedString(pDev->pUsbIns->enmSpeed)));
381 return VINF_SUCCESS;
382 }
383
384 /* Remove from the port in case of failure. */
385 RTCritSectEnter(&pThis->CritSectDevices);
386 Assert(!pThis->apDevByPort[iPort]);
387 pThis->apDevByPort[iPort] = NULL;
388 RTCritSectLeave(&pThis->CritSectDevices);
389
390 vusbDevDetach(pDev);
391 }
392
393 ASMBitSet(&pThis->Bitmap, iPort);
394 pHub->cDevices--;
395 pDev->i16Port = -1;
396 LogRel(("VUSB: Failed to attach '%s' to port %d, rc=%Rrc\n", pDev->pUsbIns->pszName, iPort, rc));
397
398 return rc;
399}
400
401
402/**
403 * Detaches the given device from the given roothub.
404 *
405 * @returns VBox status code.
406 * @param pThis The roothub to detach the device from.
407 * @param pDev The device to detach.
408 */
409static int vusbHubDetach(PVUSBROOTHUB pThis, PVUSBDEV pDev)
410{
411 PVUSBHUB pHub = &pThis->Hub;
412
413 Assert(pDev->i16Port != -1);
414
415 /* Cancel all in-flight URBs from this device. */
416 vusbDevCancelAllUrbs(pDev, true);
417
418 /*
419 * Detach the device and mark the port as available.
420 */
421 unsigned uPort = pDev->i16Port;
422 pDev->i16Port = -1;
423 pThis->pIRhPort->pfnDetach(pThis->pIRhPort, uPort);
424 ASMBitSet(&pThis->Bitmap, uPort);
425 pHub->cDevices--;
426
427 /* Check that it's attached and remove it. */
428 RTCritSectEnter(&pThis->CritSectDevices);
429 Assert(pThis->apDevByPort[uPort] == pDev);
430 pThis->apDevByPort[uPort] = NULL;
431
432 if (pDev->u8Address == VUSB_DEFAULT_ADDRESS)
433 {
434 AssertPtr(pThis->apDevByAddr[VUSB_DEFAULT_ADDRESS]);
435
436 if (pDev == pThis->apDevByAddr[VUSB_DEFAULT_ADDRESS])
437 pThis->apDevByAddr[VUSB_DEFAULT_ADDRESS] = pDev->pNextDefAddr;
438 else
439 {
440 /* Search the list for the device and remove it. */
441 PVUSBDEV pDevPrev = pThis->apDevByAddr[VUSB_DEFAULT_ADDRESS];
442
443 while ( pDevPrev
444 && pDevPrev->pNextDefAddr != pDev)
445 pDevPrev = pDevPrev->pNextDefAddr;
446
447 AssertPtr(pDevPrev);
448 pDevPrev->pNextDefAddr = pDev->pNextDefAddr;
449 }
450
451 pDev->pNextDefAddr = NULL;
452 }
453 else
454 {
455 Assert(pThis->apDevByAddr[pDev->u8Address] == pDev);
456 pThis->apDevByAddr[pDev->u8Address] = NULL;
457 }
458 RTCritSectLeave(&pThis->CritSectDevices);
459
460 /* Free resources. */
461 vusbDevDetach(pDev);
462 return VINF_SUCCESS;
463}
464
465
466
467/* -=-=-=-=-=- PDMUSBHUBREG methods -=-=-=-=-=- */
468
469/** @interface_method_impl{PDMUSBHUBREG,pfnAttachDevice} */
470static DECLCALLBACK(int) vusbPDMHubAttachDevice(PPDMDRVINS pDrvIns, PPDMUSBINS pUsbIns, const char *pszCaptureFilename, uint32_t *piPort)
471{
472 PVUSBROOTHUB pThis = PDMINS_2_DATA(pDrvIns, PVUSBROOTHUB);
473
474 /*
475 * Allocate a new VUSB device and initialize it.
476 */
477 PVUSBDEV pDev = (PVUSBDEV)RTMemAllocZ(sizeof(*pDev));
478 AssertReturn(pDev, VERR_NO_MEMORY);
479 int rc = vusbDevInit(pDev, pUsbIns, pszCaptureFilename);
480 if (RT_SUCCESS(rc))
481 {
482 pUsbIns->pvVUsbDev2 = pDev;
483 rc = vusbHubAttach(pThis, pDev);
484 if (RT_SUCCESS(rc))
485 {
486 *piPort = UINT32_MAX; /// @todo implement piPort
487 return rc;
488 }
489
490 RTMemFree(pDev->paIfStates);
491 pUsbIns->pvVUsbDev2 = NULL;
492 }
493 vusbDevRelease(pDev);
494 return rc;
495}
496
497
498/** @interface_method_impl{PDMUSBHUBREG,pfnDetachDevice} */
499static DECLCALLBACK(int) vusbPDMHubDetachDevice(PPDMDRVINS pDrvIns, PPDMUSBINS pUsbIns, uint32_t iPort)
500{
501 RT_NOREF(iPort);
502 PVUSBROOTHUB pThis = PDMINS_2_DATA(pDrvIns, PVUSBROOTHUB);
503 PVUSBHUB pHub = &pThis->Hub;
504 PVUSBDEV pDev = (PVUSBDEV)pUsbIns->pvVUsbDev2;
505 Assert(pDev);
506
507 LogRel(("VUSB: Detached '%s' from port %u on %s\n", pDev->pUsbIns->pszName, pDev->i16Port, pHub->pszName));
508
509 /*
510 * Deal with pending async reset.
511 * (anything but reset)
512 */
513 vusbDevSetStateCmp(pDev, VUSB_DEVICE_STATE_DEFAULT, VUSB_DEVICE_STATE_RESET);
514 vusbHubDetach(pThis, pDev);
515 vusbDevRelease(pDev);
516 return VINF_SUCCESS;
517}
518
519/**
520 * The hub registration structure.
521 */
522static const PDMUSBHUBREG g_vusbHubReg =
523{
524 PDM_USBHUBREG_VERSION,
525 vusbPDMHubAttachDevice,
526 vusbPDMHubDetachDevice,
527 PDM_USBHUBREG_VERSION
528};
529
530
531/* -=-=-=-=-=- VUSBIROOTHUBCONNECTOR methods -=-=-=-=-=- */
532
533
534/**
535 * Callback for freeing an URB.
536 * @param pUrb The URB to free.
537 */
538static DECLCALLBACK(void) vusbRhFreeUrb(PVUSBURB pUrb)
539{
540 /*
541 * Assert sanity.
542 */
543 vusbUrbAssert(pUrb);
544 PVUSBROOTHUB pRh = (PVUSBROOTHUB)pUrb->pVUsb->pvFreeCtx;
545 Assert(pRh);
546
547 Assert(pUrb->enmState != VUSBURBSTATE_FREE);
548
549 /*
550 * Free the URB description (logging builds only).
551 */
552 if (pUrb->pszDesc)
553 {
554 RTStrFree(pUrb->pszDesc);
555 pUrb->pszDesc = NULL;
556 }
557
558 /* The URB comes from the roothub if there is no device (invalid address). */
559 if (pUrb->pVUsb->pDev)
560 {
561 PVUSBDEV pDev = pUrb->pVUsb->pDev;
562
563 vusbUrbPoolFree(&pUrb->pVUsb->pDev->UrbPool, pUrb);
564 vusbDevRelease(pDev);
565 }
566 else
567 vusbUrbPoolFree(&pRh->Hub.Dev.UrbPool, pUrb);
568}
569
570
571/**
572 * Worker routine for vusbRhConnNewUrb().
573 */
574static PVUSBURB vusbRhNewUrb(PVUSBROOTHUB pRh, uint8_t DstAddress, uint32_t uPort, VUSBXFERTYPE enmType,
575 VUSBDIRECTION enmDir, uint32_t cbData, uint32_t cTds, const char *pszTag)
576{
577 RT_NOREF(pszTag);
578 PVUSBURBPOOL pUrbPool = &pRh->Hub.Dev.UrbPool;
579
580 if (RT_UNLIKELY(cbData > (32 * _1M)))
581 {
582 LogFunc(("Bad URB size (%u)!\n", cbData));
583 return NULL;
584 }
585
586 PVUSBDEV pDev;
587 if (uPort == VUSB_DEVICE_PORT_INVALID)
588 pDev = vusbR3RhGetVUsbDevByAddrRetain(pRh, DstAddress);
589 else
590 pDev = vusbR3RhGetVUsbDevByPortRetain(pRh, uPort);
591
592 if (pDev)
593 pUrbPool = &pDev->UrbPool;
594
595 PVUSBURB pUrb = vusbUrbPoolAlloc(pUrbPool, enmType, enmDir, cbData,
596 pRh->cbHci, pRh->cbHciTd, cTds);
597 if (RT_LIKELY(pUrb))
598 {
599 pUrb->pVUsb->pvFreeCtx = pRh;
600 pUrb->pVUsb->pfnFree = vusbRhFreeUrb;
601 pUrb->DstAddress = DstAddress;
602 pUrb->pVUsb->pDev = pDev;
603
604#ifdef LOG_ENABLED
605 const char *pszType = NULL;
606
607 switch(pUrb->enmType)
608 {
609 case VUSBXFERTYPE_CTRL:
610 pszType = "ctrl";
611 break;
612 case VUSBXFERTYPE_INTR:
613 pszType = "intr";
614 break;
615 case VUSBXFERTYPE_BULK:
616 pszType = "bulk";
617 break;
618 case VUSBXFERTYPE_ISOC:
619 pszType = "isoc";
620 break;
621 default:
622 pszType = "invld";
623 break;
624 }
625
626 pRh->iSerial = (pRh->iSerial + 1) % 10000;
627 RTStrAPrintf(&pUrb->pszDesc, "URB %p %s%c%04d (%s)", pUrb, pszType,
628 (pUrb->enmDir == VUSBDIRECTION_IN) ? '<' : ((pUrb->enmDir == VUSBDIRECTION_SETUP) ? 's' : '>'),
629 pRh->iSerial, pszTag ? pszTag : "<none>");
630#endif
631 }
632
633 return pUrb;
634}
635
636
637/**
638 * Calculate frame timer variables given a frame rate.
639 */
640static void vusbRhR3CalcTimerIntervals(PVUSBROOTHUB pThis, uint32_t u32FrameRate)
641{
642 pThis->nsWait = RT_NS_1SEC / u32FrameRate;
643 pThis->uFrameRate = u32FrameRate;
644 /* Inform the HCD about the new frame rate. */
645 pThis->pIRhPort->pfnFrameRateChanged(pThis->pIRhPort, u32FrameRate);
646}
647
648
649/**
650 * Calculates the new frame rate based on the idle detection and number of idle
651 * cycles.
652 *
653 * @returns nothing.
654 * @param pThis The roothub instance data.
655 * @param fIdle Flag whether the last frame didn't produce any activity.
656 */
657static void vusbRhR3FrameRateCalcNew(PVUSBROOTHUB pThis, bool fIdle)
658{
659 uint32_t uNewFrameRate = pThis->uFrameRate;
660
661 /*
662 * Adjust the frame timer interval based on idle detection.
663 */
664 if (fIdle)
665 {
666 pThis->cIdleCycles++;
667 /* Set the new frame rate based on how long we've been idle. Tunable. */
668 switch (pThis->cIdleCycles)
669 {
670 case 4: uNewFrameRate = 500; break; /* 2ms interval */
671 case 16:uNewFrameRate = 125; break; /* 8ms interval */
672 case 24:uNewFrameRate = 50; break; /* 20ms interval */
673 default: break;
674 }
675 /* Avoid overflow. */
676 if (pThis->cIdleCycles > 60000)
677 pThis->cIdleCycles = 20000;
678 }
679 else
680 {
681 if (pThis->cIdleCycles)
682 {
683 pThis->cIdleCycles = 0;
684 uNewFrameRate = pThis->uFrameRateDefault;
685 }
686 }
687
688 if ( uNewFrameRate != pThis->uFrameRate
689 && uNewFrameRate)
690 {
691 LogFlow(("Frame rate changed from %u to %u\n", pThis->uFrameRate, uNewFrameRate));
692 vusbRhR3CalcTimerIntervals(pThis, uNewFrameRate);
693 }
694}
695
696
697/**
698 * The core frame processing routine keeping track of the elapsed time and calling into
699 * the device emulation above us to do the work.
700 *
701 * @returns Relative timespan when to process the next frame.
702 * @param pThis The roothub instance data.
703 * @param fCallback Flag whether this method is called from the URB completion callback or
704 * from the worker thread (only used for statistics).
705 */
706DECLHIDDEN(uint64_t) vusbRhR3ProcessFrame(PVUSBROOTHUB pThis, bool fCallback)
707{
708 uint64_t tsNext = 0;
709 uint64_t tsNanoStart = RTTimeNanoTS();
710
711 /* Don't do anything if we are not supposed to process anything (EHCI and XHCI). */
712 if (!pThis->uFrameRateDefault)
713 return 0;
714
715 if (ASMAtomicXchgBool(&pThis->fFrameProcessing, true))
716 return pThis->nsWait;
717
718 if ( tsNanoStart > pThis->tsFrameProcessed
719 && tsNanoStart - pThis->tsFrameProcessed >= 750 * RT_NS_1US)
720 {
721 LogFlowFunc(("Starting new frame at ts %llu\n", tsNanoStart));
722
723 bool fIdle = pThis->pIRhPort->pfnStartFrame(pThis->pIRhPort, 0 /* u32FrameNo */);
724 vusbRhR3FrameRateCalcNew(pThis, fIdle);
725
726 uint64_t tsNow = RTTimeNanoTS();
727 tsNext = (tsNanoStart + pThis->nsWait) > tsNow ? (tsNanoStart + pThis->nsWait) - tsNow : 0;
728 pThis->tsFrameProcessed = tsNanoStart;
729 LogFlowFunc(("Current frame took %llu nano seconds to process, next frame in %llu ns\n", tsNow - tsNanoStart, tsNext));
730 if (fCallback)
731 STAM_COUNTER_INC(&pThis->StatFramesProcessedClbk);
732 else
733 STAM_COUNTER_INC(&pThis->StatFramesProcessedThread);
734 }
735 else
736 {
737 tsNext = (pThis->tsFrameProcessed + pThis->nsWait) > tsNanoStart ? (pThis->tsFrameProcessed + pThis->nsWait) - tsNanoStart : 0;
738 LogFlowFunc(("Next frame is too far away in the future, waiting... (tsNanoStart=%llu tsFrameProcessed=%llu)\n",
739 tsNanoStart, pThis->tsFrameProcessed));
740 }
741
742 ASMAtomicXchgBool(&pThis->fFrameProcessing, false);
743 LogFlowFunc(("returns %llu\n", tsNext));
744 return tsNext;
745}
746
747
748/**
749 * Worker for processing frames periodically.
750 *
751 * @returns VBox status code.
752 * @param pDrvIns The driver instance.
753 * @param pThread The PDM thread structure for the thread this worker runs on.
754 */
755static DECLCALLBACK(int) vusbRhR3PeriodFrameWorker(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
756{
757 RT_NOREF(pDrvIns);
758 int rc = VINF_SUCCESS;
759 PVUSBROOTHUB pThis = (PVUSBROOTHUB)pThread->pvUser;
760
761 if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
762 return VINF_SUCCESS;
763
764 while (pThread->enmState == PDMTHREADSTATE_RUNNING)
765 {
766 while ( !ASMAtomicReadU32(&pThis->uFrameRateDefault)
767 && pThread->enmState == PDMTHREADSTATE_RUNNING)
768 {
769 /* Signal the waiter that we are stopped now. */
770 rc = RTSemEventMultiSignal(pThis->hSemEventPeriodFrameStopped);
771 AssertRC(rc);
772
773 rc = RTSemEventMultiWait(pThis->hSemEventPeriodFrame, RT_INDEFINITE_WAIT);
774 RTSemEventMultiReset(pThis->hSemEventPeriodFrame);
775
776 /*
777 * Notify the device above about the frame rate changed if we are supposed to
778 * process frames.
779 */
780 uint32_t uFrameRate = ASMAtomicReadU32(&pThis->uFrameRateDefault);
781 if (uFrameRate)
782 vusbRhR3CalcTimerIntervals(pThis, uFrameRate);
783 }
784
785 AssertLogRelMsgReturn(RT_SUCCESS(rc) || rc == VERR_TIMEOUT, ("%Rrc\n", rc), rc);
786 if (RT_UNLIKELY(pThread->enmState != PDMTHREADSTATE_RUNNING))
787 break;
788
789 uint64_t tsNext = vusbRhR3ProcessFrame(pThis, false /* fCallback */);
790
791 if (tsNext >= 250 * RT_NS_1US)
792 {
793 rc = RTSemEventMultiWaitEx(pThis->hSemEventPeriodFrame, RTSEMWAIT_FLAGS_RELATIVE | RTSEMWAIT_FLAGS_NANOSECS | RTSEMWAIT_FLAGS_UNINTERRUPTIBLE,
794 tsNext);
795 AssertLogRelMsg(RT_SUCCESS(rc) || rc == VERR_TIMEOUT, ("%Rrc\n", rc));
796 RTSemEventMultiReset(pThis->hSemEventPeriodFrame);
797 }
798 }
799
800 return VINF_SUCCESS;
801}
802
803
804/**
805 * Unblock the periodic frame thread so it can respond to a state change.
806 *
807 * @returns VBox status code.
808 * @param pDrvIns The driver instance.
809 * @param pThread The send thread.
810 */
811static DECLCALLBACK(int) vusbRhR3PeriodFrameWorkerWakeup(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
812{
813 RT_NOREF(pThread);
814 PVUSBROOTHUB pThis = PDMINS_2_DATA(pDrvIns, PVUSBROOTHUB);
815 return RTSemEventMultiSignal(pThis->hSemEventPeriodFrame);
816}
817
818
819/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnSetUrbParams} */
820static DECLCALLBACK(int) vusbRhSetUrbParams(PVUSBIROOTHUBCONNECTOR pInterface, size_t cbHci, size_t cbHciTd)
821{
822 PVUSBROOTHUB pRh = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
823
824 pRh->cbHci = cbHci;
825 pRh->cbHciTd = cbHciTd;
826
827 return VINF_SUCCESS;
828}
829
830
831/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnReset} */
832static DECLCALLBACK(int) vusbR3RhReset(PVUSBIROOTHUBCONNECTOR pInterface, bool fResetOnLinux)
833{
834 PVUSBROOTHUB pRh = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
835 return pRh->pIRhPort->pfnReset(pRh->pIRhPort, fResetOnLinux);
836}
837
838
839/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnPowerOn} */
840static DECLCALLBACK(int) vusbR3RhPowerOn(PVUSBIROOTHUBCONNECTOR pInterface)
841{
842 PVUSBROOTHUB pRh = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
843 LogFlow(("vusR3bRhPowerOn: pRh=%p\n", pRh));
844
845 Assert( pRh->Hub.Dev.enmState != VUSB_DEVICE_STATE_DETACHED
846 && pRh->Hub.Dev.enmState != VUSB_DEVICE_STATE_RESET);
847
848 if (pRh->Hub.Dev.enmState == VUSB_DEVICE_STATE_ATTACHED)
849 pRh->Hub.Dev.enmState = VUSB_DEVICE_STATE_POWERED;
850
851 return VINF_SUCCESS;
852}
853
854
855/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnPowerOff} */
856static DECLCALLBACK(int) vusbR3RhPowerOff(PVUSBIROOTHUBCONNECTOR pInterface)
857{
858 PVUSBROOTHUB pThis = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
859 LogFlow(("vusbR3RhDevPowerOff: pThis=%p\n", pThis));
860
861 Assert( pThis->Hub.Dev.enmState != VUSB_DEVICE_STATE_DETACHED
862 && pThis->Hub.Dev.enmState != VUSB_DEVICE_STATE_RESET);
863
864 /*
865 * Cancel all URBs and reap them.
866 */
867 VUSBIRhCancelAllUrbs(&pThis->IRhConnector);
868 for (uint32_t uPort = 0; uPort < RT_ELEMENTS(pThis->apDevByPort); uPort++)
869 VUSBIRhReapAsyncUrbs(&pThis->IRhConnector, uPort, 0);
870
871 pThis->Hub.Dev.enmState = VUSB_DEVICE_STATE_ATTACHED;
872 return VINF_SUCCESS;
873}
874
875
876/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnNewUrb} */
877static DECLCALLBACK(PVUSBURB) vusbRhConnNewUrb(PVUSBIROOTHUBCONNECTOR pInterface, uint8_t DstAddress, uint32_t uPort, VUSBXFERTYPE enmType,
878 VUSBDIRECTION enmDir, uint32_t cbData, uint32_t cTds, const char *pszTag)
879{
880 PVUSBROOTHUB pRh = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
881 return vusbRhNewUrb(pRh, DstAddress, uPort, enmType, enmDir, cbData, cTds, pszTag);
882}
883
884
885/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnFreeUrb} */
886static DECLCALLBACK(int) vusbRhConnFreeUrb(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBURB pUrb)
887{
888 RT_NOREF(pInterface);
889 pUrb->pVUsb->pfnFree(pUrb);
890 return VINF_SUCCESS;
891}
892
893
894/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnSubmitUrb} */
895static DECLCALLBACK(int) vusbRhSubmitUrb(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBURB pUrb, PPDMLED pLed)
896{
897 PVUSBROOTHUB pRh = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
898 STAM_PROFILE_START(&pRh->StatSubmitUrb, a);
899
900#ifdef VBOX_WITH_STATISTICS
901 /*
902 * Total and per-type submit statistics.
903 */
904 Assert(pUrb->enmType >= 0 && pUrb->enmType < (int)RT_ELEMENTS(pRh->aTypes));
905 STAM_COUNTER_INC(&pRh->Total.StatUrbsSubmitted);
906 STAM_COUNTER_INC(&pRh->aTypes[pUrb->enmType].StatUrbsSubmitted);
907
908 STAM_COUNTER_ADD(&pRh->Total.StatReqBytes, pUrb->cbData);
909 STAM_COUNTER_ADD(&pRh->aTypes[pUrb->enmType].StatReqBytes, pUrb->cbData);
910 if (pUrb->enmDir == VUSBDIRECTION_IN)
911 {
912 STAM_COUNTER_ADD(&pRh->Total.StatReqReadBytes, pUrb->cbData);
913 STAM_COUNTER_ADD(&pRh->aTypes[pUrb->enmType].StatReqReadBytes, pUrb->cbData);
914 }
915 else
916 {
917 STAM_COUNTER_ADD(&pRh->Total.StatReqWriteBytes, pUrb->cbData);
918 STAM_COUNTER_ADD(&pRh->aTypes[pUrb->enmType].StatReqWriteBytes, pUrb->cbData);
919 }
920
921 if (pUrb->enmType == VUSBXFERTYPE_ISOC)
922 {
923 STAM_COUNTER_ADD(&pRh->StatIsocReqPkts, pUrb->cIsocPkts);
924 if (pUrb->enmDir == VUSBDIRECTION_IN)
925 STAM_COUNTER_ADD(&pRh->StatIsocReqReadPkts, pUrb->cIsocPkts);
926 else
927 STAM_COUNTER_ADD(&pRh->StatIsocReqWritePkts, pUrb->cIsocPkts);
928 }
929#endif
930
931 /* If there is a sniffer on the roothub record the URB there. */
932 if (pRh->hSniffer != VUSBSNIFFER_NIL)
933 {
934 int rc = VUSBSnifferRecordEvent(pRh->hSniffer, pUrb, VUSBSNIFFEREVENT_SUBMIT);
935 if (RT_FAILURE(rc))
936 LogRel(("VUSB: Capturing URB submit event on the root hub failed with %Rrc\n", rc));
937 }
938
939 /*
940 * The device was resolved when we allocated the URB.
941 * Submit it to the device if we found it, if not fail with device-not-ready.
942 */
943 int rc;
944 if ( pUrb->pVUsb->pDev
945 && pUrb->pVUsb->pDev->pUsbIns)
946 {
947 switch (pUrb->enmDir)
948 {
949 case VUSBDIRECTION_IN:
950 pLed->Asserted.s.fReading = pLed->Actual.s.fReading = 1;
951 rc = vusbUrbSubmit(pUrb);
952 pLed->Actual.s.fReading = 0;
953 break;
954 case VUSBDIRECTION_OUT:
955 pLed->Asserted.s.fWriting = pLed->Actual.s.fWriting = 1;
956 rc = vusbUrbSubmit(pUrb);
957 pLed->Actual.s.fWriting = 0;
958 break;
959 default:
960 rc = vusbUrbSubmit(pUrb);
961 break;
962 }
963
964 if (RT_FAILURE(rc))
965 {
966 LogFlow(("vusbRhSubmitUrb: freeing pUrb=%p\n", pUrb));
967 pUrb->pVUsb->pfnFree(pUrb);
968 }
969 }
970 else
971 {
972 vusbDevRetain(&pRh->Hub.Dev);
973 pUrb->pVUsb->pDev = &pRh->Hub.Dev;
974 Log(("vusb: pRh=%p: SUBMIT: Address %i not found!!!\n", pRh, pUrb->DstAddress));
975
976 pUrb->enmState = VUSBURBSTATE_REAPED;
977 pUrb->enmStatus = VUSBSTATUS_DNR;
978 vusbUrbCompletionRh(pUrb);
979 rc = VINF_SUCCESS;
980 }
981
982 STAM_PROFILE_STOP(&pRh->StatSubmitUrb, a);
983 return rc;
984}
985
986
987static DECLCALLBACK(int) vusbRhReapAsyncUrbsWorker(PVUSBDEV pDev, RTMSINTERVAL cMillies)
988{
989 if (!cMillies)
990 vusbUrbDoReapAsync(&pDev->LstAsyncUrbs, 0);
991 else
992 {
993 uint64_t u64Start = RTTimeMilliTS();
994 do
995 {
996 vusbUrbDoReapAsync(&pDev->LstAsyncUrbs, RT_MIN(cMillies >> 8, 10));
997 } while ( !RTListIsEmpty(&pDev->LstAsyncUrbs)
998 && RTTimeMilliTS() - u64Start < cMillies);
999 }
1000
1001 return VINF_SUCCESS;
1002}
1003
1004/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnReapAsyncUrbs} */
1005static DECLCALLBACK(void) vusbRhReapAsyncUrbs(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t uPort, RTMSINTERVAL cMillies)
1006{
1007 PVUSBROOTHUB pRh = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface); NOREF(pRh);
1008 PVUSBDEV pDev = vusbR3RhGetVUsbDevByPortRetain(pRh, uPort);
1009
1010 if ( !pDev
1011 || RTListIsEmpty(&pDev->LstAsyncUrbs))
1012 return;
1013
1014 STAM_PROFILE_START(&pRh->StatReapAsyncUrbs, a);
1015 int rc = vusbDevIoThreadExecSync(pDev, (PFNRT)vusbRhReapAsyncUrbsWorker, 2, pDev, cMillies);
1016 AssertRC(rc);
1017 STAM_PROFILE_STOP(&pRh->StatReapAsyncUrbs, a);
1018
1019 vusbDevRelease(pDev);
1020}
1021
1022
1023/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnCancelUrbsEp} */
1024static DECLCALLBACK(int) vusbRhCancelUrbsEp(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBURB pUrb)
1025{
1026 PVUSBROOTHUB pRh = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
1027 AssertReturn(pRh, VERR_INVALID_PARAMETER);
1028 AssertReturn(pUrb, VERR_INVALID_PARAMETER);
1029
1030 /// @todo This method of URB canceling may not work on non-Linux hosts.
1031 /*
1032 * Cancel and reap the URB(s) on an endpoint.
1033 */
1034 LogFlow(("vusbRhCancelUrbsEp: pRh=%p pUrb=%p\n", pRh, pUrb));
1035
1036 vusbUrbCancelAsync(pUrb, CANCELMODE_UNDO);
1037
1038 /* The reaper thread will take care of completing the URB. */
1039
1040 return VINF_SUCCESS;
1041}
1042
1043/**
1044 * Worker doing the actual cancelling of all outstanding URBs on the device I/O thread.
1045 *
1046 * @returns VBox status code.
1047 * @param pDev USB device instance data.
1048 */
1049static DECLCALLBACK(int) vusbRhCancelAllUrbsWorker(PVUSBDEV pDev)
1050{
1051 /*
1052 * Cancel the URBS.
1053 *
1054 * Not using th CritAsyncUrbs critical section here is safe
1055 * as the I/O thread is the only thread accessing this struture at the
1056 * moment.
1057 */
1058 PVUSBURBVUSB pVUsbUrb, pVUsbUrbNext;
1059 RTListForEachSafe(&pDev->LstAsyncUrbs, pVUsbUrb, pVUsbUrbNext, VUSBURBVUSBINT, NdLst)
1060 {
1061 PVUSBURB pUrb = pVUsbUrb->pUrb;
1062 /* Call the worker directly. */
1063 vusbUrbCancelWorker(pUrb, CANCELMODE_FAIL);
1064 }
1065
1066 return VINF_SUCCESS;
1067}
1068
1069/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnCancelAllUrbs} */
1070static DECLCALLBACK(void) vusbRhCancelAllUrbs(PVUSBIROOTHUBCONNECTOR pInterface)
1071{
1072 PVUSBROOTHUB pThis = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
1073
1074 RTCritSectEnter(&pThis->CritSectDevices);
1075 for (unsigned i = 0; i < RT_ELEMENTS(pThis->apDevByPort); i++)
1076 {
1077 PVUSBDEV pDev = pThis->apDevByPort[i];
1078 if (pDev)
1079 vusbDevIoThreadExecSync(pDev, (PFNRT)vusbRhCancelAllUrbsWorker, 1, pDev);
1080 }
1081 RTCritSectLeave(&pThis->CritSectDevices);
1082}
1083
1084/**
1085 * Worker doing the actual cancelling of all outstanding per-EP URBs on the
1086 * device I/O thread.
1087 *
1088 * @returns VBox status code.
1089 * @param pDev USB device instance data.
1090 * @param EndPt Endpoint number.
1091 * @param enmDir Endpoint direction.
1092 */
1093static DECLCALLBACK(int) vusbRhAbortEpWorker(PVUSBDEV pDev, int EndPt, VUSBDIRECTION enmDir)
1094{
1095 /*
1096 * Iterate the URBs, find ones corresponding to given EP, and cancel them.
1097 */
1098 PVUSBURBVUSB pVUsbUrb, pVUsbUrbNext;
1099 RTListForEachSafe(&pDev->LstAsyncUrbs, pVUsbUrb, pVUsbUrbNext, VUSBURBVUSBINT, NdLst)
1100 {
1101 PVUSBURB pUrb = pVUsbUrb->pUrb;
1102
1103 Assert(pUrb->pVUsb->pDev == pDev);
1104
1105 /* For the default control EP, direction does not matter. */
1106 if (pUrb->EndPt == EndPt && (pUrb->enmDir == enmDir || !EndPt))
1107 {
1108 LogFlow(("%s: vusbRhAbortEpWorker: CANCELING URB\n", pUrb->pszDesc));
1109 int rc = vusbUrbCancelWorker(pUrb, CANCELMODE_UNDO);
1110 AssertRC(rc);
1111 }
1112 }
1113
1114 return VINF_SUCCESS;
1115}
1116
1117
1118/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnAbortEp} */
1119static DECLCALLBACK(int) vusbRhAbortEp(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t uPort, int EndPt, VUSBDIRECTION enmDir)
1120{
1121 PVUSBROOTHUB pRh = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
1122 PVUSBDEV pDev = vusbR3RhGetVUsbDevByPortRetain(pRh, uPort);
1123
1124 if (&pRh->Hub != pDev->pHub)
1125 AssertFailedReturn(VERR_INVALID_PARAMETER);
1126
1127 vusbDevIoThreadExecSync(pDev, (PFNRT)vusbRhAbortEpWorker, 3, pDev, EndPt, enmDir);
1128 vusbDevRelease(pDev);
1129
1130 /* The reaper thread will take care of completing the URB. */
1131
1132 return VINF_SUCCESS;
1133}
1134
1135
1136/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnSetPeriodicFrameProcessing} */
1137static DECLCALLBACK(int) vusbRhSetFrameProcessing(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t uFrameRate)
1138{
1139 int rc = VINF_SUCCESS;
1140 PVUSBROOTHUB pThis = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
1141
1142 /* Create the frame thread lazily. */
1143 if ( !pThis->hThreadPeriodFrame
1144 && uFrameRate)
1145 {
1146 ASMAtomicXchgU32(&pThis->uFrameRateDefault, uFrameRate);
1147 pThis->uFrameRate = uFrameRate;
1148 vusbRhR3CalcTimerIntervals(pThis, uFrameRate);
1149
1150 rc = RTSemEventMultiCreate(&pThis->hSemEventPeriodFrame);
1151 AssertRCReturn(rc, rc);
1152
1153 rc = RTSemEventMultiCreate(&pThis->hSemEventPeriodFrameStopped);
1154 AssertRCReturn(rc, rc);
1155
1156 rc = PDMDrvHlpThreadCreate(pThis->pDrvIns, &pThis->hThreadPeriodFrame, pThis, vusbRhR3PeriodFrameWorker,
1157 vusbRhR3PeriodFrameWorkerWakeup, 0, RTTHREADTYPE_IO, "VUsbPeriodFrm");
1158 AssertRCReturn(rc, rc);
1159
1160 VMSTATE enmState = PDMDrvHlpVMState(pThis->pDrvIns);
1161 if ( enmState == VMSTATE_RUNNING
1162 || enmState == VMSTATE_RUNNING_LS)
1163 {
1164 rc = PDMDrvHlpThreadResume(pThis->pDrvIns, pThis->hThreadPeriodFrame);
1165 AssertRCReturn(rc, rc);
1166 }
1167 }
1168 else if ( pThis->hThreadPeriodFrame
1169 && !uFrameRate)
1170 {
1171 /* Stop processing. */
1172 uint32_t uFrameRateOld = ASMAtomicXchgU32(&pThis->uFrameRateDefault, uFrameRate);
1173 if (uFrameRateOld)
1174 {
1175 rc = RTSemEventMultiReset(pThis->hSemEventPeriodFrameStopped);
1176 AssertRC(rc);
1177
1178 /* Signal the frame thread to stop. */
1179 RTSemEventMultiSignal(pThis->hSemEventPeriodFrame);
1180
1181 /* Wait for signal from the thread that it stopped. */
1182 rc = RTSemEventMultiWait(pThis->hSemEventPeriodFrameStopped, RT_INDEFINITE_WAIT);
1183 AssertRC(rc);
1184 }
1185 }
1186 else if ( pThis->hThreadPeriodFrame
1187 && uFrameRate)
1188 {
1189 /* Just switch to the new frame rate and let the periodic frame thread pick it up. */
1190 uint32_t uFrameRateOld = ASMAtomicXchgU32(&pThis->uFrameRateDefault, uFrameRate);
1191
1192 /* Signal the frame thread to continue if it was stopped. */
1193 if (!uFrameRateOld)
1194 RTSemEventMultiSignal(pThis->hSemEventPeriodFrame);
1195 }
1196
1197 return rc;
1198}
1199
1200
1201/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnGetPeriodicFrameRate} */
1202static DECLCALLBACK(uint32_t) vusbRhGetPeriodicFrameRate(PVUSBIROOTHUBCONNECTOR pInterface)
1203{
1204 PVUSBROOTHUB pThis = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
1205
1206 return pThis->uFrameRate;
1207}
1208
1209/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnUpdateIsocFrameDelta} */
1210static DECLCALLBACK(uint32_t) vusbRhUpdateIsocFrameDelta(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t uPort,
1211 int EndPt, VUSBDIRECTION enmDir, uint16_t uNewFrameID, uint8_t uBits)
1212{
1213 PVUSBROOTHUB pRh = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
1214 AssertReturn(pRh, 0);
1215 PVUSBDEV pDev = vusbR3RhGetVUsbDevByPortRetain(pRh, uPort); AssertPtr(pDev);
1216 PVUSBPIPE pPipe = &pDev->aPipes[EndPt];
1217 uint32_t *puLastFrame;
1218 int32_t uFrameDelta;
1219 uint32_t uMaxVal = 1 << uBits;
1220
1221 puLastFrame = enmDir == VUSBDIRECTION_IN ? &pPipe->uLastFrameIn : &pPipe->uLastFrameOut;
1222 uFrameDelta = uNewFrameID - *puLastFrame;
1223 *puLastFrame = uNewFrameID;
1224 /* Take care of wrap-around. */
1225 if (uFrameDelta < 0)
1226 uFrameDelta += uMaxVal;
1227
1228 vusbDevRelease(pDev);
1229 return (uint16_t)uFrameDelta;
1230}
1231
1232
1233/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnDevReset} */
1234static DECLCALLBACK(int) vusbR3RhDevReset(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t uPort, bool fResetOnLinux,
1235 PFNVUSBRESETDONE pfnDone, void *pvUser, PVM pVM)
1236{
1237 PVUSBROOTHUB pThis = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
1238 PVUSBDEV pDev = vusbR3RhGetVUsbDevByPortRetain(pThis, uPort);
1239 AssertPtr(pDev);
1240
1241 int rc = VUSBIDevReset(&pDev->IDevice, fResetOnLinux, pfnDone, pvUser, pVM);
1242 vusbDevRelease(pDev);
1243 return rc;
1244}
1245
1246
1247/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnDevPowerOn} */
1248static DECLCALLBACK(int) vusbR3RhDevPowerOn(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t uPort)
1249{
1250 PVUSBROOTHUB pThis = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
1251 PVUSBDEV pDev = vusbR3RhGetVUsbDevByPortRetain(pThis, uPort);
1252 AssertPtr(pDev);
1253
1254 int rc = VUSBIDevPowerOn(&pDev->IDevice);
1255 vusbDevRelease(pDev);
1256 return rc;
1257}
1258
1259
1260/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnDevPowerOff} */
1261static DECLCALLBACK(int) vusbR3RhDevPowerOff(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t uPort)
1262{
1263 PVUSBROOTHUB pThis = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
1264 PVUSBDEV pDev = vusbR3RhGetVUsbDevByPortRetain(pThis, uPort);
1265 AssertPtr(pDev);
1266
1267 int rc = VUSBIDevPowerOff(&pDev->IDevice);
1268 vusbDevRelease(pDev);
1269 return rc;
1270}
1271
1272
1273/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnDevGetState} */
1274static DECLCALLBACK(VUSBDEVICESTATE) vusbR3RhDevGetState(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t uPort)
1275{
1276 PVUSBROOTHUB pThis = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
1277 PVUSBDEV pDev = vusbR3RhGetVUsbDevByPortRetain(pThis, uPort);
1278 AssertPtr(pDev);
1279
1280 VUSBDEVICESTATE enmState = VUSBIDevGetState(&pDev->IDevice);
1281 vusbDevRelease(pDev);
1282 return enmState;
1283}
1284
1285
1286/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnDevIsSavedStateSupported} */
1287static DECLCALLBACK(bool) vusbR3RhDevIsSavedStateSupported(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t uPort)
1288{
1289 PVUSBROOTHUB pThis = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
1290 PVUSBDEV pDev = vusbR3RhGetVUsbDevByPortRetain(pThis, uPort);
1291 AssertPtr(pDev);
1292
1293 bool fSavedStateSupported = VUSBIDevIsSavedStateSupported(&pDev->IDevice);
1294 vusbDevRelease(pDev);
1295 return fSavedStateSupported;
1296}
1297
1298
1299/** @interface_method_impl{VUSBIROOTHUBCONNECTOR,pfnDevGetSpeed} */
1300static DECLCALLBACK(VUSBSPEED) vusbR3RhDevGetSpeed(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t uPort)
1301{
1302 PVUSBROOTHUB pThis = VUSBIROOTHUBCONNECTOR_2_VUSBROOTHUB(pInterface);
1303 PVUSBDEV pDev = vusbR3RhGetVUsbDevByPortRetain(pThis, uPort);
1304 AssertPtr(pDev);
1305
1306 VUSBSPEED enmSpeed = pDev->IDevice.pfnGetSpeed(&pDev->IDevice);
1307 vusbDevRelease(pDev);
1308 return enmSpeed;
1309}
1310
1311
1312/**
1313 * @callback_method_impl{FNSSMDRVSAVEPREP, All URBs needs to be canceled.}
1314 */
1315static DECLCALLBACK(int) vusbR3RhSavePrep(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM)
1316{
1317 PVUSBROOTHUB pThis = PDMINS_2_DATA(pDrvIns, PVUSBROOTHUB);
1318 LogFlow(("vusbR3RhSavePrep:\n"));
1319 RT_NOREF(pSSM);
1320
1321 /*
1322 * Detach all proxied devices.
1323 */
1324 RTCritSectEnter(&pThis->CritSectDevices);
1325
1326 /** @todo we a) can't tell which are proxied, and b) this won't work well when continuing after saving! */
1327 for (unsigned i = 0; i < RT_ELEMENTS(pThis->apDevByPort); i++)
1328 {
1329 PVUSBDEV pDev = pThis->apDevByPort[i];
1330 if (pDev)
1331 {
1332 if (!VUSBIDevIsSavedStateSupported(&pDev->IDevice))
1333 {
1334 int rc = vusbHubDetach(pThis, pDev);
1335 AssertRC(rc);
1336
1337 /*
1338 * Save the device pointers here so we can reattach them afterwards.
1339 * This will work fine even if the save fails since the Done handler is
1340 * called unconditionally if the Prep handler was called.
1341 */
1342 pThis->apDevByPort[i] = pDev;
1343 }
1344 }
1345 }
1346
1347 RTCritSectLeave(&pThis->CritSectDevices);
1348
1349 /*
1350 * Kill old load data which might be hanging around.
1351 */
1352 if (pThis->pLoad)
1353 {
1354 PDMDrvHlpTimerDestroy(pDrvIns, pThis->pLoad->hTimer);
1355 pThis->pLoad->hTimer = NIL_TMTIMERHANDLE;
1356 PDMDrvHlpMMHeapFree(pDrvIns, pThis->pLoad);
1357 pThis->pLoad = NULL;
1358 }
1359
1360 return VINF_SUCCESS;
1361}
1362
1363
1364/**
1365 * @callback_method_impl{FNSSMDRVSAVEDONE}
1366 */
1367static DECLCALLBACK(int) vusbR3RhSaveDone(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM)
1368{
1369 PVUSBROOTHUB pThis = PDMINS_2_DATA(pDrvIns, PVUSBROOTHUB);
1370 PVUSBDEV aPortsOld[VUSB_DEVICES_MAX];
1371 unsigned i;
1372 LogFlow(("vusbR3RhSaveDone:\n"));
1373 RT_NOREF(pSSM);
1374
1375 /* Save the current data. */
1376 memcpy(aPortsOld, pThis->apDevByPort, sizeof(aPortsOld));
1377 AssertCompile(sizeof(aPortsOld) == sizeof(pThis->apDevByPort));
1378
1379 /*
1380 * NULL the dev pointers.
1381 */
1382 for (i = 0; i < RT_ELEMENTS(pThis->apDevByPort); i++)
1383 if (pThis->apDevByPort[i] && !VUSBIDevIsSavedStateSupported(&pThis->apDevByPort[i]->IDevice))
1384 pThis->apDevByPort[i] = NULL;
1385
1386 /*
1387 * Attach the devices.
1388 */
1389 for (i = 0; i < RT_ELEMENTS(pThis->apDevByPort); i++)
1390 {
1391 PVUSBDEV pDev = aPortsOld[i];
1392 if (pDev && !VUSBIDevIsSavedStateSupported(&pDev->IDevice))
1393 vusbHubAttach(pThis, pDev);
1394 }
1395
1396 return VINF_SUCCESS;
1397}
1398
1399
1400/**
1401 * @callback_method_impl{FNSSMDRVLOADPREP, This must detach the devices
1402 * currently attached and save them for reconnect after the state load has been
1403 * completed.}
1404 */
1405static DECLCALLBACK(int) vusbR3RhLoadPrep(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM)
1406{
1407 PVUSBROOTHUB pThis = PDMINS_2_DATA(pDrvIns, PVUSBROOTHUB);
1408 int rc = VINF_SUCCESS;
1409 LogFlow(("vusbR3RhLoadPrep:\n"));
1410 RT_NOREF(pSSM);
1411
1412 if (!pThis->pLoad)
1413 {
1414 VUSBROOTHUBLOAD Load;
1415 unsigned i;
1416
1417 /// @todo This is all bogus.
1418 /*
1419 * Detach all devices which are present in this session. Save them in the load
1420 * structure so we can reattach them after restoring the guest.
1421 */
1422 Load.hTimer = NIL_TMTIMERHANDLE;
1423 Load.cDevs = 0;
1424 for (i = 0; i < RT_ELEMENTS(pThis->apDevByPort); i++)
1425 {
1426 PVUSBDEV pDev = pThis->apDevByPort[i];
1427 if (pDev && !VUSBIDevIsSavedStateSupported(&pDev->IDevice))
1428 {
1429 Load.apDevs[Load.cDevs++] = pDev;
1430 vusbHubDetach(pThis, pDev);
1431 Assert(!pThis->apDevByPort[i]);
1432 }
1433 }
1434
1435 /*
1436 * Any devices to reattach? If so, duplicate the Load struct.
1437 */
1438 if (Load.cDevs)
1439 {
1440 pThis->pLoad = (PVUSBROOTHUBLOAD)RTMemAllocZ(sizeof(Load));
1441 if (!pThis->pLoad)
1442 return VERR_NO_MEMORY;
1443 *pThis->pLoad = Load;
1444 }
1445 }
1446 /* else: we ASSUME no device can be attached or detached in the time
1447 * between a state load and the pLoad stuff processing. */
1448 return rc;
1449}
1450
1451
1452/**
1453 * Reattaches devices after a saved state load.
1454 */
1455static DECLCALLBACK(void) vusbR3RhLoadReattachDevices(PPDMDRVINS pDrvIns, TMTIMERHANDLE hTimer, void *pvUser)
1456{
1457 PVUSBROOTHUB pThis = PDMINS_2_DATA(pDrvIns, PVUSBROOTHUB);
1458 PVUSBROOTHUBLOAD pLoad = pThis->pLoad;
1459 LogFlow(("vusbR3RhLoadReattachDevices:\n"));
1460 Assert(hTimer == pLoad->hTimer); RT_NOREF(pvUser);
1461
1462 /*
1463 * Reattach devices.
1464 */
1465 for (unsigned i = 0; i < pLoad->cDevs; i++)
1466 vusbHubAttach(pThis, pLoad->apDevs[i]);
1467
1468 /*
1469 * Cleanup.
1470 */
1471 PDMDrvHlpTimerDestroy(pDrvIns, hTimer);
1472 pLoad->hTimer = NIL_TMTIMERHANDLE;
1473 RTMemFree(pLoad);
1474 pThis->pLoad = NULL;
1475}
1476
1477
1478/**
1479 * @callback_method_impl{FNSSMDRVLOADDONE}
1480 */
1481static DECLCALLBACK(int) vusbR3RhLoadDone(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM)
1482{
1483 PVUSBROOTHUB pThis = PDMINS_2_DATA(pDrvIns, PVUSBROOTHUB);
1484 LogFlow(("vusbR3RhLoadDone:\n"));
1485 RT_NOREF(pSSM);
1486
1487 /*
1488 * Start a timer if we've got devices to reattach
1489 */
1490 if (pThis->pLoad)
1491 {
1492 int rc = PDMDrvHlpTMTimerCreate(pDrvIns, TMCLOCK_VIRTUAL, vusbR3RhLoadReattachDevices, NULL,
1493 TMTIMER_FLAGS_NO_CRIT_SECT | TMTIMER_FLAGS_NO_RING0,
1494 "VUSB reattach on load", &pThis->pLoad->hTimer);
1495 if (RT_SUCCESS(rc))
1496 rc = PDMDrvHlpTimerSetMillies(pDrvIns, pThis->pLoad->hTimer, 250);
1497 return rc;
1498 }
1499
1500 return VINF_SUCCESS;
1501}
1502
1503
1504/* -=-=-=-=-=- PDM Base interface methods -=-=-=-=-=- */
1505
1506
1507/**
1508 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
1509 */
1510static DECLCALLBACK(void *) vusbRhQueryInterface(PPDMIBASE pInterface, const char *pszIID)
1511{
1512 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
1513 PVUSBROOTHUB pRh = PDMINS_2_DATA(pDrvIns, PVUSBROOTHUB);
1514
1515 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
1516 PDMIBASE_RETURN_INTERFACE(pszIID, VUSBIROOTHUBCONNECTOR, &pRh->IRhConnector);
1517 PDMIBASE_RETURN_INTERFACE(pszIID, VUSBIDEVICE, &pRh->Hub.Dev.IDevice);
1518 return NULL;
1519}
1520
1521
1522/* -=-=-=-=-=- PDM Driver methods -=-=-=-=-=- */
1523
1524
1525/**
1526 * Destruct a driver instance.
1527 *
1528 * Most VM resources are freed by the VM. This callback is provided so that any non-VM
1529 * resources can be freed correctly.
1530 *
1531 * @param pDrvIns The driver instance data.
1532 */
1533static DECLCALLBACK(void) vusbRhDestruct(PPDMDRVINS pDrvIns)
1534{
1535 PVUSBROOTHUB pRh = PDMINS_2_DATA(pDrvIns, PVUSBROOTHUB);
1536 PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
1537
1538 vusbUrbPoolDestroy(&pRh->Hub.Dev.UrbPool);
1539 if (pRh->Hub.pszName)
1540 {
1541 RTStrFree(pRh->Hub.pszName);
1542 pRh->Hub.pszName = NULL;
1543 }
1544 if (pRh->hSniffer != VUSBSNIFFER_NIL)
1545 VUSBSnifferDestroy(pRh->hSniffer);
1546
1547 if (pRh->hSemEventPeriodFrame)
1548 RTSemEventMultiDestroy(pRh->hSemEventPeriodFrame);
1549
1550 if (pRh->hSemEventPeriodFrameStopped)
1551 RTSemEventMultiDestroy(pRh->hSemEventPeriodFrameStopped);
1552
1553 RTCritSectDelete(&pRh->CritSectDevices);
1554}
1555
1556
1557/**
1558 * Construct a root hub driver instance.
1559 *
1560 * @copydoc FNPDMDRVCONSTRUCT
1561 */
1562static DECLCALLBACK(int) vusbRhConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
1563{
1564 RT_NOREF(fFlags);
1565 PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
1566 PVUSBROOTHUB pThis = PDMINS_2_DATA(pDrvIns, PVUSBROOTHUB);
1567 PCPDMDRVHLPR3 pHlp = pDrvIns->pHlpR3;
1568
1569 LogFlow(("vusbRhConstruct: Instance %d\n", pDrvIns->iInstance));
1570
1571 /*
1572 * Validate configuration.
1573 */
1574 PDMDRV_VALIDATE_CONFIG_RETURN(pDrvIns, "CaptureFilename", "");
1575
1576 /*
1577 * Check that there are no drivers below us.
1578 */
1579 AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
1580 ("Configuration error: Not possible to attach anything to this driver!\n"),
1581 VERR_PDM_DRVINS_NO_ATTACH);
1582
1583 /*
1584 * Initialize the critical sections.
1585 */
1586 int rc = RTCritSectInit(&pThis->CritSectDevices);
1587 if (RT_FAILURE(rc))
1588 return rc;
1589
1590 char *pszCaptureFilename = NULL;
1591 rc = pHlp->pfnCFGMQueryStringAlloc(pCfg, "CaptureFilename", &pszCaptureFilename);
1592 if ( RT_FAILURE(rc)
1593 && rc != VERR_CFGM_VALUE_NOT_FOUND)
1594 return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS,
1595 N_("Configuration error: Failed to query value of \"CaptureFilename\""));
1596
1597 /*
1598 * Initialize the data members.
1599 */
1600 pDrvIns->IBase.pfnQueryInterface = vusbRhQueryInterface;
1601 /* the usb device */
1602 pThis->Hub.Dev.enmState = VUSB_DEVICE_STATE_ATTACHED;
1603 pThis->Hub.Dev.cRefs = 1;
1604 /* the hub */
1605 pThis->Hub.pRootHub = pThis;
1606 //pThis->hub.cPorts - later
1607 pThis->Hub.cDevices = 0;
1608 pThis->Hub.Dev.pHub = &pThis->Hub;
1609 RTStrAPrintf(&pThis->Hub.pszName, "RootHub#%d", pDrvIns->iInstance);
1610 /* misc */
1611 pThis->pDrvIns = pDrvIns;
1612 /* the connector */
1613 pThis->IRhConnector.pfnSetUrbParams = vusbRhSetUrbParams;
1614 pThis->IRhConnector.pfnReset = vusbR3RhReset;
1615 pThis->IRhConnector.pfnPowerOn = vusbR3RhPowerOn;
1616 pThis->IRhConnector.pfnPowerOff = vusbR3RhPowerOff;
1617 pThis->IRhConnector.pfnNewUrb = vusbRhConnNewUrb;
1618 pThis->IRhConnector.pfnFreeUrb = vusbRhConnFreeUrb;
1619 pThis->IRhConnector.pfnSubmitUrb = vusbRhSubmitUrb;
1620 pThis->IRhConnector.pfnReapAsyncUrbs = vusbRhReapAsyncUrbs;
1621 pThis->IRhConnector.pfnCancelUrbsEp = vusbRhCancelUrbsEp;
1622 pThis->IRhConnector.pfnCancelAllUrbs = vusbRhCancelAllUrbs;
1623 pThis->IRhConnector.pfnAbortEp = vusbRhAbortEp;
1624 pThis->IRhConnector.pfnSetPeriodicFrameProcessing = vusbRhSetFrameProcessing;
1625 pThis->IRhConnector.pfnGetPeriodicFrameRate = vusbRhGetPeriodicFrameRate;
1626 pThis->IRhConnector.pfnUpdateIsocFrameDelta = vusbRhUpdateIsocFrameDelta;
1627 pThis->IRhConnector.pfnDevReset = vusbR3RhDevReset;
1628 pThis->IRhConnector.pfnDevPowerOn = vusbR3RhDevPowerOn;
1629 pThis->IRhConnector.pfnDevPowerOff = vusbR3RhDevPowerOff;
1630 pThis->IRhConnector.pfnDevGetState = vusbR3RhDevGetState;
1631 pThis->IRhConnector.pfnDevIsSavedStateSupported = vusbR3RhDevIsSavedStateSupported;
1632 pThis->IRhConnector.pfnDevGetSpeed = vusbR3RhDevGetSpeed;
1633 pThis->hSniffer = VUSBSNIFFER_NIL;
1634 pThis->cbHci = 0;
1635 pThis->cbHciTd = 0;
1636 pThis->fFrameProcessing = false;
1637#ifdef LOG_ENABLED
1638 pThis->iSerial = 0;
1639#endif
1640 /*
1641 * Resolve interface(s).
1642 */
1643 pThis->pIRhPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, VUSBIROOTHUBPORT);
1644 AssertMsgReturn(pThis->pIRhPort, ("Configuration error: the device/driver above us doesn't expose any VUSBIROOTHUBPORT interface!\n"), VERR_PDM_MISSING_INTERFACE_ABOVE);
1645
1646 /*
1647 * Get number of ports and the availability bitmap.
1648 * ASSUME that the number of ports reported now at creation time is the max number.
1649 */
1650 pThis->Hub.cPorts = pThis->pIRhPort->pfnGetAvailablePorts(pThis->pIRhPort, &pThis->Bitmap);
1651 Log(("vusbRhConstruct: cPorts=%d\n", pThis->Hub.cPorts));
1652
1653 /*
1654 * Get the USB version of the attached HC.
1655 * ASSUME that version 2.0 implies high-speed.
1656 */
1657 pThis->fHcVersions = pThis->pIRhPort->pfnGetUSBVersions(pThis->pIRhPort);
1658 Log(("vusbRhConstruct: fHcVersions=%u\n", pThis->fHcVersions));
1659
1660 rc = vusbUrbPoolInit(&pThis->Hub.Dev.UrbPool);
1661 if (RT_FAILURE(rc))
1662 return rc;
1663
1664 if (pszCaptureFilename)
1665 {
1666 rc = VUSBSnifferCreate(&pThis->hSniffer, 0, pszCaptureFilename, NULL, NULL);
1667 if (RT_FAILURE(rc))
1668 return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS,
1669 N_("VUSBSniffer cannot open '%s' for writing. The directory must exist and it must be writable for the current user"),
1670 pszCaptureFilename);
1671
1672 PDMDrvHlpMMHeapFree(pDrvIns, pszCaptureFilename);
1673 }
1674
1675 /*
1676 * Register ourselves as a USB hub.
1677 * The current implementation uses the VUSBIRHCONFIG interface for communication.
1678 */
1679 PCPDMUSBHUBHLP pHlpUsb; /* not used currently */
1680 rc = PDMDrvHlpUSBRegisterHub(pDrvIns, pThis->fHcVersions, pThis->Hub.cPorts, &g_vusbHubReg, &pHlpUsb);
1681 if (RT_FAILURE(rc))
1682 return rc;
1683
1684 /*
1685 * Register the saved state data unit for attaching devices.
1686 */
1687 rc = PDMDrvHlpSSMRegisterEx(pDrvIns, VUSB_ROOTHUB_SAVED_STATE_VERSION, 0,
1688 NULL, NULL, NULL,
1689 vusbR3RhSavePrep, NULL, vusbR3RhSaveDone,
1690 vusbR3RhLoadPrep, NULL, vusbR3RhLoadDone);
1691 AssertRCReturn(rc, rc);
1692
1693 /*
1694 * Statistics. (It requires a 30" monitor or extremely tiny fonts to edit this "table".)
1695 */
1696#ifdef VBOX_WITH_STATISTICS
1697 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->Total.StatUrbsSubmitted, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "The number of URBs submitted.", "/VUSB/%d/UrbsSubmitted", pDrvIns->iInstance);
1698 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatUrbsSubmitted, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Bulk transfer.", "/VUSB/%d/UrbsSubmitted/Bulk", pDrvIns->iInstance);
1699 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatUrbsSubmitted, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Control transfer.", "/VUSB/%d/UrbsSubmitted/Ctrl", pDrvIns->iInstance);
1700 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatUrbsSubmitted, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Interrupt transfer.", "/VUSB/%d/UrbsSubmitted/Intr", pDrvIns->iInstance);
1701 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatUrbsSubmitted, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Isochronous transfer.", "/VUSB/%d/UrbsSubmitted/Isoc", pDrvIns->iInstance);
1702
1703 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->Total.StatUrbsCancelled, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "The number of URBs cancelled. (included in failed)", "/VUSB/%d/UrbsCancelled", pDrvIns->iInstance);
1704 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatUrbsCancelled, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Bulk transfer.", "/VUSB/%d/UrbsCancelled/Bulk", pDrvIns->iInstance);
1705 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatUrbsCancelled, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Control transfer.", "/VUSB/%d/UrbsCancelled/Ctrl", pDrvIns->iInstance);
1706 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatUrbsCancelled, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Interrupt transfer.", "/VUSB/%d/UrbsCancelled/Intr", pDrvIns->iInstance);
1707 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatUrbsCancelled, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Isochronous transfer.", "/VUSB/%d/UrbsCancelled/Isoc", pDrvIns->iInstance);
1708
1709 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->Total.StatUrbsFailed, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "The number of URBs failing.", "/VUSB/%d/UrbsFailed", pDrvIns->iInstance);
1710 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatUrbsFailed, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Bulk transfer.", "/VUSB/%d/UrbsFailed/Bulk", pDrvIns->iInstance);
1711 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatUrbsFailed, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Control transfer.", "/VUSB/%d/UrbsFailed/Ctrl", pDrvIns->iInstance);
1712 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatUrbsFailed, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Interrupt transfer.", "/VUSB/%d/UrbsFailed/Intr", pDrvIns->iInstance);
1713 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatUrbsFailed, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Isochronous transfer.", "/VUSB/%d/UrbsFailed/Isoc", pDrvIns->iInstance);
1714
1715 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->Total.StatReqBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Total requested transfer.", "/VUSB/%d/ReqBytes", pDrvIns->iInstance);
1716 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatReqBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Bulk transfer.", "/VUSB/%d/ReqBytes/Bulk", pDrvIns->iInstance);
1717 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatReqBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Control transfer.", "/VUSB/%d/ReqBytes/Ctrl", pDrvIns->iInstance);
1718 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatReqBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Interrupt transfer.", "/VUSB/%d/ReqBytes/Intr", pDrvIns->iInstance);
1719 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatReqBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Isochronous transfer.", "/VUSB/%d/ReqBytes/Isoc", pDrvIns->iInstance);
1720
1721 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->Total.StatReqReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Total requested read transfer.", "/VUSB/%d/ReqReadBytes", pDrvIns->iInstance);
1722 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatReqReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Bulk transfer.", "/VUSB/%d/ReqReadBytes/Bulk", pDrvIns->iInstance);
1723 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatReqReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Control transfer.", "/VUSB/%d/ReqReadBytes/Ctrl", pDrvIns->iInstance);
1724 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatReqReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Interrupt transfer.", "/VUSB/%d/ReqReadBytes/Intr", pDrvIns->iInstance);
1725 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatReqReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Isochronous transfer.", "/VUSB/%d/ReqReadBytes/Isoc", pDrvIns->iInstance);
1726
1727 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->Total.StatReqWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Total requested write transfer.", "/VUSB/%d/ReqWriteBytes", pDrvIns->iInstance);
1728 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatReqWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Bulk transfer.", "/VUSB/%d/ReqWriteBytes/Bulk", pDrvIns->iInstance);
1729 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatReqWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Control transfer.", "/VUSB/%d/ReqWriteBytes/Ctrl", pDrvIns->iInstance);
1730 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatReqWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Interrupt transfer.", "/VUSB/%d/ReqWriteBytes/Intr", pDrvIns->iInstance);
1731 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatReqWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Isochronous transfer.", "/VUSB/%d/ReqWriteBytes/Isoc", pDrvIns->iInstance);
1732
1733 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->Total.StatActBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Actual total transfer.", "/VUSB/%d/ActBytes", pDrvIns->iInstance);
1734 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatActBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Bulk transfer.", "/VUSB/%d/ActBytes/Bulk", pDrvIns->iInstance);
1735 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatActBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Control transfer.", "/VUSB/%d/ActBytes/Ctrl", pDrvIns->iInstance);
1736 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatActBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Interrupt transfer.", "/VUSB/%d/ActBytes/Intr", pDrvIns->iInstance);
1737 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatActBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Isochronous transfer.", "/VUSB/%d/ActBytes/Isoc", pDrvIns->iInstance);
1738
1739 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->Total.StatActReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Actual total read transfer.", "/VUSB/%d/ActReadBytes", pDrvIns->iInstance);
1740 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatActReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Bulk transfer.", "/VUSB/%d/ActReadBytes/Bulk", pDrvIns->iInstance);
1741 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatActReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Control transfer.", "/VUSB/%d/ActReadBytes/Ctrl", pDrvIns->iInstance);
1742 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatActReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Interrupt transfer.", "/VUSB/%d/ActReadBytes/Intr", pDrvIns->iInstance);
1743 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatActReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Isochronous transfer.", "/VUSB/%d/ActReadBytes/Isoc", pDrvIns->iInstance);
1744
1745 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->Total.StatActWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Actual total write transfer.", "/VUSB/%d/ActWriteBytes", pDrvIns->iInstance);
1746 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatActWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Bulk transfer.", "/VUSB/%d/ActWriteBytes/Bulk", pDrvIns->iInstance);
1747 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatActWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Control transfer.", "/VUSB/%d/ActWriteBytes/Ctrl", pDrvIns->iInstance);
1748 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatActWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Interrupt transfer.", "/VUSB/%d/ActWriteBytes/Intr", pDrvIns->iInstance);
1749 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatActWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Isochronous transfer.", "/VUSB/%d/ActWriteBytes/Isoc", pDrvIns->iInstance);
1750
1751 /* bulk */
1752 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatUrbsSubmitted, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Number of submitted URBs.", "/VUSB/%d/Bulk/Urbs", pDrvIns->iInstance);
1753 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatUrbsFailed, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Number of failed URBs.", "/VUSB/%d/Bulk/UrbsFailed", pDrvIns->iInstance);
1754 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatUrbsCancelled, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Number of cancelled URBs.", "/VUSB/%d/Bulk/UrbsFailed/Cancelled", pDrvIns->iInstance);
1755 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatActBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Number of bytes transferred.", "/VUSB/%d/Bulk/ActBytes", pDrvIns->iInstance);
1756 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatActReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Read.", "/VUSB/%d/Bulk/ActBytes/Read", pDrvIns->iInstance);
1757 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatActWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Write.", "/VUSB/%d/Bulk/ActBytes/Write", pDrvIns->iInstance);
1758 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatReqBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Requested number of bytes.", "/VUSB/%d/Bulk/ReqBytes", pDrvIns->iInstance);
1759 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatReqReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Read.", "/VUSB/%d/Bulk/ReqBytes/Read", pDrvIns->iInstance);
1760 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_BULK].StatReqWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Write.", "/VUSB/%d/Bulk/ReqBytes/Write", pDrvIns->iInstance);
1761
1762 /* control */
1763 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatUrbsSubmitted, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Number of submitted URBs.", "/VUSB/%d/Ctrl/Urbs", pDrvIns->iInstance);
1764 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatUrbsFailed, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Number of failed URBs.", "/VUSB/%d/Ctrl/UrbsFailed", pDrvIns->iInstance);
1765 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatUrbsCancelled, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Number of cancelled URBs.", "/VUSB/%d/Ctrl/UrbsFailed/Cancelled", pDrvIns->iInstance);
1766 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatActBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Number of bytes transferred.", "/VUSB/%d/Ctrl/ActBytes", pDrvIns->iInstance);
1767 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatActReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Read.", "/VUSB/%d/Ctrl/ActBytes/Read", pDrvIns->iInstance);
1768 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatActWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Write.", "/VUSB/%d/Ctrl/ActBytes/Write", pDrvIns->iInstance);
1769 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatReqBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Requested number of bytes.", "/VUSB/%d/Ctrl/ReqBytes", pDrvIns->iInstance);
1770 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatReqReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Read.", "/VUSB/%d/Ctrl/ReqBytes/Read", pDrvIns->iInstance);
1771 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_CTRL].StatReqWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Write.", "/VUSB/%d/Ctrl/ReqBytes/Write", pDrvIns->iInstance);
1772
1773 /* interrupt */
1774 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatUrbsSubmitted, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Number of submitted URBs.", "/VUSB/%d/Intr/Urbs", pDrvIns->iInstance);
1775 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatUrbsFailed, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Number of failed URBs.", "/VUSB/%d/Intr/UrbsFailed", pDrvIns->iInstance);
1776 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatUrbsCancelled, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Number of cancelled URBs.", "/VUSB/%d/Intr/UrbsFailed/Cancelled", pDrvIns->iInstance);
1777 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatActBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Number of bytes transferred.", "/VUSB/%d/Intr/ActBytes", pDrvIns->iInstance);
1778 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatActReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Read.", "/VUSB/%d/Intr/ActBytes/Read", pDrvIns->iInstance);
1779 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatActWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Write.", "/VUSB/%d/Intr/ActBytes/Write", pDrvIns->iInstance);
1780 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatReqBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Requested number of bytes.", "/VUSB/%d/Intr/ReqBytes", pDrvIns->iInstance);
1781 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatReqReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Read.", "/VUSB/%d/Intr/ReqBytes/Read", pDrvIns->iInstance);
1782 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_INTR].StatReqWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Write.", "/VUSB/%d/Intr/ReqBytes/Write", pDrvIns->iInstance);
1783
1784 /* isochronous */
1785 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatUrbsSubmitted, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Number of submitted URBs.", "/VUSB/%d/Isoc/Urbs", pDrvIns->iInstance);
1786 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatUrbsFailed, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Number of failed URBs.", "/VUSB/%d/Isoc/UrbsFailed", pDrvIns->iInstance);
1787 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatUrbsCancelled, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Number of cancelled URBs.", "/VUSB/%d/Isoc/UrbsFailed/Cancelled", pDrvIns->iInstance);
1788 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatActBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Number of bytes transferred.", "/VUSB/%d/Isoc/ActBytes", pDrvIns->iInstance);
1789 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatActReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Read.", "/VUSB/%d/Isoc/ActBytes/Read", pDrvIns->iInstance);
1790 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatActWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Write.", "/VUSB/%d/Isoc/ActBytes/Write", pDrvIns->iInstance);
1791 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatReqBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Requested number of bytes.", "/VUSB/%d/Isoc/ReqBytes", pDrvIns->iInstance);
1792 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatReqReadBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Read.", "/VUSB/%d/Isoc/ReqBytes/Read", pDrvIns->iInstance);
1793 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aTypes[VUSBXFERTYPE_ISOC].StatReqWriteBytes, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_BYTES, "Write.", "/VUSB/%d/Isoc/ReqBytes/Write", pDrvIns->iInstance);
1794 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatIsocActPkts, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Number of isochronous packets returning data.", "/VUSB/%d/Isoc/ActPkts", pDrvIns->iInstance);
1795 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatIsocActReadPkts, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Read.", "/VUSB/%d/Isoc/ActPkts/Read", pDrvIns->iInstance);
1796 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatIsocActWritePkts, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Write.", "/VUSB/%d/Isoc/ActPkts/Write", pDrvIns->iInstance);
1797 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatIsocReqPkts, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Requested number of isochronous packets.", "/VUSB/%d/Isoc/ReqPkts", pDrvIns->iInstance);
1798 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatIsocReqReadPkts, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Read.", "/VUSB/%d/Isoc/ReqPkts/Read", pDrvIns->iInstance);
1799 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatIsocReqWritePkts, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "Write.", "/VUSB/%d/Isoc/ReqPkts/Write", pDrvIns->iInstance);
1800
1801 for (unsigned i = 0; i < RT_ELEMENTS(pThis->aStatIsocDetails); i++)
1802 {
1803 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aStatIsocDetails[i].Pkts, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT, ".", "/VUSB/%d/Isoc/%d", pDrvIns->iInstance, i);
1804 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aStatIsocDetails[i].Ok, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT, ".", "/VUSB/%d/Isoc/%d/Ok", pDrvIns->iInstance, i);
1805 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aStatIsocDetails[i].Ok0, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT, ".", "/VUSB/%d/Isoc/%d/Ok0", pDrvIns->iInstance, i);
1806 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aStatIsocDetails[i].DataUnderrun, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT, ".", "/VUSB/%d/Isoc/%d/DataUnderrun", pDrvIns->iInstance, i);
1807 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aStatIsocDetails[i].DataUnderrun0, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT, ".", "/VUSB/%d/Isoc/%d/DataUnderrun0", pDrvIns->iInstance, i);
1808 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aStatIsocDetails[i].DataOverrun, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT, ".", "/VUSB/%d/Isoc/%d/DataOverrun", pDrvIns->iInstance, i);
1809 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aStatIsocDetails[i].NotAccessed, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT, ".", "/VUSB/%d/Isoc/%d/NotAccessed", pDrvIns->iInstance, i);
1810 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aStatIsocDetails[i].Misc, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_COUNT, ".", "/VUSB/%d/Isoc/%d/Misc", pDrvIns->iInstance, i);
1811 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->aStatIsocDetails[i].Bytes, STAMTYPE_COUNTER, STAMVISIBILITY_USED, STAMUNIT_BYTES, ".", "/VUSB/%d/Isoc/%d/Bytes", pDrvIns->iInstance, i);
1812 }
1813
1814 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatReapAsyncUrbs, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling the vusbRhReapAsyncUrbs body (omitting calls when nothing is in-flight).",
1815 "/VUSB/%d/ReapAsyncUrbs", pDrvIns->iInstance);
1816 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatSubmitUrb, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_TICKS_PER_CALL, "Profiling the vusbRhSubmitUrb body.",
1817 "/VUSB/%d/SubmitUrb", pDrvIns->iInstance);
1818 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatFramesProcessedThread, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Processed frames in the dedicated thread",
1819 "/VUSB/%d/FramesProcessedThread", pDrvIns->iInstance);
1820 PDMDrvHlpSTAMRegisterF(pDrvIns, &pThis->StatFramesProcessedClbk, STAMTYPE_COUNTER, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES, "Processed frames in the URB completion callback",
1821 "/VUSB/%d/FramesProcessedClbk", pDrvIns->iInstance);
1822#endif
1823 PDMDrvHlpSTAMRegisterF(pDrvIns, (void *)&pThis->Hub.Dev.UrbPool.cUrbsInPool, STAMTYPE_U32, STAMVISIBILITY_ALWAYS, STAMUNIT_COUNT, "The number of URBs in the pool.",
1824 "/VUSB/%d/cUrbsInPool", pDrvIns->iInstance);
1825
1826 return VINF_SUCCESS;
1827}
1828
1829
1830/**
1831 * VUSB Root Hub driver registration record.
1832 */
1833const PDMDRVREG g_DrvVUSBRootHub =
1834{
1835 /* u32Version */
1836 PDM_DRVREG_VERSION,
1837 /* szName */
1838 "VUSBRootHub",
1839 /* szRCMod */
1840 "",
1841 /* szR0Mod */
1842 "",
1843 /* pszDescription */
1844 "VUSB Root Hub Driver.",
1845 /* fFlags */
1846 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
1847 /* fClass. */
1848 PDM_DRVREG_CLASS_USB,
1849 /* cMaxInstances */
1850 ~0U,
1851 /* cbInstance */
1852 sizeof(VUSBROOTHUB),
1853 /* pfnConstruct */
1854 vusbRhConstruct,
1855 /* pfnDestruct */
1856 vusbRhDestruct,
1857 /* pfnRelocate */
1858 NULL,
1859 /* pfnIOCtl */
1860 NULL,
1861 /* pfnPowerOn */
1862 NULL,
1863 /* pfnReset */
1864 NULL,
1865 /* pfnSuspend */
1866 NULL,
1867 /* pfnResume */
1868 NULL,
1869 /* pfnAttach */
1870 NULL,
1871 /* pfnDetach */
1872 NULL,
1873 /* pfnPowerOff */
1874 NULL,
1875 /* pfnSoftReset */
1876 NULL,
1877 /* u32EndVersion */
1878 PDM_DRVREG_VERSION
1879};
1880
1881/*
1882 * Local Variables:
1883 * mode: c
1884 * c-file-style: "bsd"
1885 * c-basic-offset: 4
1886 * tab-width: 4
1887 * indent-tabs-mode: s
1888 * End:
1889 */
1890
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