VirtualBox

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

Last change on this file was 104303, checked in by vboxsync, 5 weeks ago

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

© 2023 Oracle
Contact – Privacy policy – Terms of Use