VUSBUrb.cpp@ 53426

Last change on this file since 53426 was 53162, checked in by vboxsync, 10 years ago
build fix
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 82.7 KB

Line
1	/* $Id: VUSBUrb.cpp 53162 2014-10-29 09:16:50Z vboxsync $ */
2	/** @file
3	* Virtual USB - URBs.
4	*/
5
6	/*
7	* Copyright (C) 2006-2010 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	* Header Files *
20	*******************************************************************************/
21	#define LOG_GROUP LOG_GROUP_DRV_VUSB
22	#include <VBox/vmm/pdm.h>
23	#include <VBox/vmm/vmapi.h>
24	#include <VBox/err.h>
25	#include <iprt/alloc.h>
26	#include <VBox/log.h>
27	#include <iprt/time.h>
28	#include <iprt/thread.h>
29	#include <iprt/semaphore.h>
30	#include <iprt/string.h>
31	#include <iprt/assert.h>
32	#include <iprt/asm.h>
33	#include <iprt/env.h>
34	#include "VUSBInternal.h"
35
36
37
38	/*******************************************************************************
39	* Global Variables *
40	*******************************************************************************/
41	/** Strings for the CTLSTAGE enum values. */
42	const char * const g_apszCtlStates[4] =
43	{
44	"SETUP",
45	"DATA",
46	"STATUS",
47	"N/A"
48	};
49
50
51	/*******************************************************************************
52	* Internal Functions *
53	*******************************************************************************/
54	static PVUSBCTRLEXTRA vusbMsgAllocExtraData(PVUSBURB pUrb);
55
56
57	#ifdef LOG_ENABLED
58	DECLINLINE(const char *) vusbUrbStatusName(VUSBSTATUS enmStatus)
59	{
60	/** Strings for the URB statuses. */
61	static const char * const s_apszNames[] =
62	{
63	"OK",
64	"STALL",
65	"ERR_DNR",
66	"ERR_CRC",
67	"DATA_UNDERRUN",
68	"DATA_OVERRUN",
69	"NOT_ACCESSED",
70	"7", "8", "9", "10", "11", "12", "13", "14", "15"
71	};
72
73	return enmStatus < (int)RT_ELEMENTS(s_apszNames)
74	? s_apszNames[enmStatus]
75	: enmStatus == VUSBSTATUS_INVALID
76	? "INVALID"
77	: "??";
78	}
79
80	DECLINLINE(const char *) vusbUrbDirName(VUSBDIRECTION enmDir)
81	{
82	/** Strings for the URB directions. */
83	static const char * const s_apszNames[] =
84	{
85	"setup",
86	"in",
87	"out"
88	};
89
90	return enmDir < (int)RT_ELEMENTS(s_apszNames)
91	? s_apszNames[enmDir]
92	: "??";
93	}
94
95	DECLINLINE(const char *) vusbUrbTypeName(VUSBXFERTYPE enmType)
96	{
97	/** Strings for the URB types. */
98	static const char * const s_apszName[] =
99	{
100	"control-part",
101	"isochronous",
102	"bulk",
103	"interrupt",
104	"control"
105	};
106
107	return enmType < (int)RT_ELEMENTS(s_apszName)
108	? s_apszName[enmType]
109	: "??";
110	}
111
112	DECLINLINE(const char *) GetScsiErrCd(uint8_t ScsiErr)
113	{
114	switch (ScsiErr)
115	{
116	case 0: return "?";
117	}
118	return "?";
119	}
120
121	DECLINLINE(const char *) GetScsiKCQ(uint8_t Key, uint8_t ASC, uint8_t ASCQ)
122	{
123	switch (Key)
124	{
125	case 0:
126	switch (RT_MAKE_U16(ASC, ASCQ))
127	{
128	case RT_MAKE_U16(0x00, 0x00): return "No error";
129	}
130	break;
131
132	case 1:
133	return "Soft Error";
134
135	case 2:
136	return "Not Ready";
137
138	case 3:
139	return "Medium Error";
140
141	case 4:
142	return "Hard Error";
143
144	case 5:
145	return "Illegal Request";
146
147	case 6:
148	return "Unit Attention";
149
150	case 7:
151	return "Write Protected";
152
153	case 0xb:
154	return "Aborted Command";
155	}
156	return "?";
157	}
158
159
160	/**
161	* Logs an URB.
162	*
163	* Note that pUrb->pUsbIns, pUrb->VUsb.pDev and pUrb->VUsb.pDev->pUsbIns can all be NULL.
164	*/
165	void vusbUrbTrace(PVUSBURB pUrb, const char *pszMsg, bool fComplete)
166	{
167	PVUSBDEV pDev = pUrb->VUsb.pDev; /* Can be NULL when called from usbProxyConstruct and friends. */
168	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
169	const uint8_t *pbData = pUrb->abData;
170	uint32_t cbData = pUrb->cbData;
171	PCVUSBSETUP pSetup = NULL;
172	bool fDescriptors = false;
173	static size_t s_cchMaxMsg = 10;
174	size_t cchMsg = strlen(pszMsg);
175	if (cchMsg > s_cchMaxMsg)
176	s_cchMaxMsg = cchMsg;
177
178	Log(("%s: %*s: pDev=%p[%s] rc=%s a=%i e=%u d=%s t=%s cb=%#x(%d) Ed=%08x cTds=%d Td0=%08x ts=%RU64 (%RU64 ns ago) %s\n",
179	pUrb->pszDesc, s_cchMaxMsg, pszMsg,
180	pDev,
181	pUrb->pUsbIns ? pUrb->pUsbIns->pszName : "",
182	vusbUrbStatusName(pUrb->enmStatus),
183	pDev ? pDev->u8Address : -1,
184	pUrb->EndPt,
185	vusbUrbDirName(pUrb->enmDir),
186	vusbUrbTypeName(pUrb->enmType),
187	pUrb->cbData,
188	pUrb->cbData,
189	pUrb->Hci.EdAddr,
190	pUrb->Hci.cTds,
191	pUrb->Hci.cTds ? pUrb->Hci.paTds[0].TdAddr : ~(uint32_t)0,
192	pUrb->VUsb.u64SubmitTS,
193	RTTimeNanoTS() - pUrb->VUsb.u64SubmitTS,
194	pUrb->fShortNotOk ? "ShortNotOk" : "ShortOk"));
195
196	#ifndef DEBUG_bird
197	if ( pUrb->enmType == VUSBXFERTYPE_CTRL
198	&& pUrb->enmStatus == VUSBSTATUS_OK)
199	return;
200	#endif
201
202	if ( pUrb->enmType == VUSBXFERTYPE_MSG
203	\|\| ( pUrb->enmDir == VUSBDIRECTION_SETUP
204	&& pUrb->enmType == VUSBXFERTYPE_CTRL
205	&& cbData))
206	{
207	static const char * const s_apszReqDirs[] = {"host2dev", "dev2host"};
208	static const char * const s_apszReqTypes[] = {"std", "class", "vendor", "reserved"};
209	static const char * const s_apszReqRecipients[] = {"dev", "if", "endpoint", "other"};
210	static const char * const s_apszRequests[] =
211	{
212	"GET_STATUS", "CLEAR_FEATURE", "2?", "SET_FEATURE",
213	"4?", "SET_ADDRESS", "GET_DESCRIPTOR", "SET_DESCRIPTOR",
214	"GET_CONFIGURATION", "SET_CONFIGURATION", "GET_INTERFACE", "SET_INTERFACE",
215	"SYNCH_FRAME"
216	};
217	pSetup = (PVUSBSETUP)pUrb->abData;
218	pbData += sizeof(*pSetup);
219	cbData -= sizeof(*pSetup);
220
221	Log(("%s: %*s: CTRL: bmRequestType=0x%.2x (%s %s %s) bRequest=0x%.2x (%s) wValue=0x%.4x wIndex=0x%.4x wLength=0x%.4x\n",
222	pUrb->pszDesc, s_cchMaxMsg, pszMsg,
223	pSetup->bmRequestType, s_apszReqDirs[pSetup->bmRequestType >> 7], s_apszReqTypes[(pSetup->bmRequestType >> 5) & 0x3],
224	(unsigned)(pSetup->bmRequestType & 0xf) < RT_ELEMENTS(s_apszReqRecipients) ? s_apszReqRecipients[pSetup->bmRequestType & 0xf] : "??",
225	pSetup->bRequest, pSetup->bRequest < RT_ELEMENTS(s_apszRequests) ? s_apszRequests[pSetup->bRequest] : "??",
226	pSetup->wValue, pSetup->wIndex, pSetup->wLength));
227
228	if ( pSetup->bRequest == VUSB_REQ_GET_DESCRIPTOR
229	&& fComplete
230	&& pUrb->enmStatus == VUSBSTATUS_OK
231	&& ((pSetup->bmRequestType >> 5) & 0x3) < 2 /* vendor */)
232	fDescriptors = true;
233	}
234	else if ( fComplete
235	&& pUrb->enmDir == VUSBDIRECTION_IN
236	&& pUrb->enmType == VUSBXFERTYPE_CTRL
237	&& pUrb->enmStatus == VUSBSTATUS_OK
238	&& pPipe->pCtrl
239	&& pPipe->pCtrl->enmStage == CTLSTAGE_DATA
240	&& cbData > 0)
241	{
242	pSetup = pPipe->pCtrl->pMsg;
243	if (pSetup->bRequest == VUSB_REQ_GET_DESCRIPTOR)
244	fDescriptors = true;
245	}
246
247	/*
248	* Dump descriptors.
249	*/
250	if (fDescriptors)
251	{
252	const uint8_t *pb = pbData;
253	const uint8_t *pbEnd = pbData + cbData;
254	while (pb + 1 < pbEnd)
255	{
256	const unsigned cbLeft = pbEnd - pb;
257	const unsigned cbLength = *pb;
258	unsigned cb = cbLength;
259	uint8_t bDescriptorType = pb[1];
260
261	/* length out of bounds? */
262	if (cbLength > cbLeft)
263	{
264	cb = cbLeft;
265	if (cbLength != 0xff) /* ignore this */
266	Log(("URB: %*s: DESC: warning descriptor length goes beyond the end of the URB! cbLength=%d cbLeft=%d\n",
267	s_cchMaxMsg, pszMsg, cbLength, cbLeft));
268	}
269
270	if (cb >= 2)
271	{
272	Log(("URB: %*s: DESC: %04x: %25s = %#04x (%d)\n"
273	"URB: %*s: %04x: %25s = %#04x (",
274	s_cchMaxMsg, pszMsg, pb - pbData, "bLength", cbLength, cbLength,
275	s_cchMaxMsg, pszMsg, pb - pbData + 1, "bDescriptorType", bDescriptorType));
276
277	#pragma pack(1)
278	#define BYTE_FIELD(strct, memb) \
279	if ((unsigned)RT_OFFSETOF(strct, memb) < cb) \
280	Log(("URB: %*s: %04x: %25s = %#04x\n", s_cchMaxMsg, pszMsg, \
281	pb + RT_OFFSETOF(strct, memb) - pbData, #memb, pb[RT_OFFSETOF(strct, memb)]))
282	#define BYTE_FIELD_START(strct, memb) do { \
283	if ((unsigned)RT_OFFSETOF(strct, memb) < cb) \
284	{ \
285	Log(("URB: %*s: %04x: %25s = %#04x", s_cchMaxMsg, pszMsg, \
286	pb + RT_OFFSETOF(strct, memb) - pbData, #memb, pb[RT_OFFSETOF(strct, memb)]))
287	#define BYTE_FIELD_END(strct, memb) \
288	Log(("\n")); \
289	} } while (0)
290	#define WORD_FIELD(strct, memb) \
291	if ((unsigned)RT_OFFSETOF(strct, memb) + 1 < cb) \
292	Log(("URB: %*s: %04x: %25s = %#06x\n", s_cchMaxMsg, pszMsg, \
293	pb + RT_OFFSETOF(strct, memb) - pbData, #memb, (uint16_t )&pb[RT_OFFSETOF(strct, memb)]))
294	#define BCD_FIELD(strct, memb) \
295	if ((unsigned)RT_OFFSETOF(strct, memb) + 1 < cb) \
296	Log(("URB: %*s: %04x: %25s = %#06x (%02x.%02x)\n", s_cchMaxMsg, pszMsg, \
297	pb + RT_OFFSETOF(strct, memb) - pbData, #memb, (uint16_t )&pb[RT_OFFSETOF(strct, memb)], \
298	pb[RT_OFFSETOF(strct, memb) + 1], pb[RT_OFFSETOF(strct, memb)]))
299	#define SIZE_CHECK(strct) \
300	if (cb > sizeof(strct)) \
301	Log(("URB: %s: %04x: WARNING %d extra byte(s) %.Rhxs\n", s_cchMaxMsg, pszMsg, \
302	pb + sizeof(strct) - pbData, cb - sizeof(strct), cb - sizeof(strct), pb + sizeof(strct))); \
303	else if (cb < sizeof(strct)) \
304	Log(("URB: %*s: %04x: WARNING %d missing byte(s)! Expected size %d.\n", s_cchMaxMsg, pszMsg, \
305	pb + cb - pbData, sizeof(strct) - cb, sizeof(strct)))
306
307	/* on type */
308	switch (bDescriptorType)
309	{
310	case VUSB_DT_DEVICE:
311	{
312	struct dev_desc
313	{
314	uint8_t bLength;
315	uint8_t bDescriptorType;
316	uint16_t bcdUSB;
317	uint8_t bDeviceClass;
318	uint8_t bDeviceSubClass;
319	uint8_t bDeviceProtocol;
320	uint8_t bMaxPacketSize0;
321	uint16_t idVendor;
322	uint16_t idProduct;
323	uint16_t bcdDevice;
324	uint8_t iManufacturer;
325	uint8_t iProduct;
326	uint8_t iSerialNumber;
327	uint8_t bNumConfigurations;
328	} pDesc = (struct dev_desc )pb; NOREF(pDesc);
329	Log(("DEV)\n"));
330	BCD_FIELD( struct dev_desc, bcdUSB);
331	BYTE_FIELD(struct dev_desc, bDeviceClass);
332	BYTE_FIELD(struct dev_desc, bDeviceSubClass);
333	BYTE_FIELD(struct dev_desc, bDeviceProtocol);
334	BYTE_FIELD(struct dev_desc, bMaxPacketSize0);
335	WORD_FIELD(struct dev_desc, idVendor);
336	WORD_FIELD(struct dev_desc, idProduct);
337	BCD_FIELD( struct dev_desc, bcdDevice);
338	BYTE_FIELD(struct dev_desc, iManufacturer);
339	BYTE_FIELD(struct dev_desc, iProduct);
340	BYTE_FIELD(struct dev_desc, iSerialNumber);
341	BYTE_FIELD(struct dev_desc, bNumConfigurations);
342	SIZE_CHECK(struct dev_desc);
343	break;
344	}
345
346	case VUSB_DT_CONFIG:
347	{
348	struct cfg_desc
349	{
350	uint8_t bLength;
351	uint8_t bDescriptorType;
352	uint16_t wTotalLength;
353	uint8_t bNumInterfaces;
354	uint8_t bConfigurationValue;
355	uint8_t iConfiguration;
356	uint8_t bmAttributes;
357	uint8_t MaxPower;
358	} pDesc = (struct cfg_desc )pb; NOREF(pDesc);
359	Log(("CFG)\n"));
360	WORD_FIELD(struct cfg_desc, wTotalLength);
361	BYTE_FIELD(struct cfg_desc, bNumInterfaces);
362	BYTE_FIELD(struct cfg_desc, bConfigurationValue);
363	BYTE_FIELD(struct cfg_desc, iConfiguration);
364	BYTE_FIELD_START(struct cfg_desc, bmAttributes);
365	static const char * const s_apszTransType[4] = { "Control", "Isochronous", "Bulk", "Interrupt" };
366	static const char * const s_apszSyncType[4] = { "NoSync", "Asynchronous", "Adaptive", "Synchronous" };
367	static const char * const s_apszUsageType[4] = { "Data ep", "Feedback ep.", "Implicit feedback Data ep.", "Reserved" };
368	Log((" %s - %s - %s", s_apszTransType[(pDesc->bmAttributes & 0x3)],
369	s_apszSyncType[((pDesc->bmAttributes >> 2) & 0x3)], s_apszUsageType[((pDesc->bmAttributes >> 4) & 0x3)]));
370	BYTE_FIELD_END(struct cfg_desc, bmAttributes);
371	BYTE_FIELD(struct cfg_desc, MaxPower);
372	SIZE_CHECK(struct cfg_desc);
373	break;
374	}
375
376	case VUSB_DT_STRING:
377	if (!pSetup->wIndex)
378	{
379	/* langid array */
380	uint16_t pu16 = (uint16_t )pb + 1;
381	Log(("LANGIDs)\n"));
382	while ((uintptr_t)pu16 + 2 - (uintptr_t)pb <= cb)
383	{
384	Log(("URB: %*s: %04x: wLANGID[%#x] = %#06x\n",
385	s_cchMaxMsg, pszMsg, (uint8_t )pu16 - pbData, pu16 - (uint16_t )pb, *pu16));
386	pu16++;
387	}
388	if (cb & 1)
389	Log(("URB: %*s: %04x: WARNING descriptor size is odd! extra byte: %02\n",
390	s_cchMaxMsg, pszMsg, (uint8_t )pu16 - pbData, (uint8_t *)pu16));
391	}
392	else
393	{
394	/** a string. */
395	Log(("STRING)\n"));
396	if (cb > 2)
397	Log(("URB: %s: %04x: Length=%d String=%.ls\n",
398	s_cchMaxMsg, pszMsg, pb - pbData, cb - 2, cb / 2 - 1, pb + 2));
399	else
400	Log(("URB: %*s: %04x: Length=0!\n", s_cchMaxMsg, pszMsg, pb - pbData));
401	}
402	break;
403
404	case VUSB_DT_INTERFACE:
405	{
406	struct if_desc
407	{
408	uint8_t bLength;
409	uint8_t bDescriptorType;
410	uint8_t bInterfaceNumber;
411	uint8_t bAlternateSetting;
412	uint8_t bNumEndpoints;
413	uint8_t bInterfaceClass;
414	uint8_t bInterfaceSubClass;
415	uint8_t bInterfaceProtocol;
416	uint8_t iInterface;
417	} pDesc = (struct if_desc )pb; NOREF(pDesc);
418	Log(("IF)\n"));
419	BYTE_FIELD(struct if_desc, bInterfaceNumber);
420	BYTE_FIELD(struct if_desc, bAlternateSetting);
421	BYTE_FIELD(struct if_desc, bNumEndpoints);
422	BYTE_FIELD(struct if_desc, bInterfaceClass);
423	BYTE_FIELD(struct if_desc, bInterfaceSubClass);
424	BYTE_FIELD(struct if_desc, bInterfaceProtocol);
425	BYTE_FIELD(struct if_desc, iInterface);
426	SIZE_CHECK(struct if_desc);
427	break;
428	}
429
430	case VUSB_DT_ENDPOINT:
431	{
432	struct ep_desc
433	{
434	uint8_t bLength;
435	uint8_t bDescriptorType;
436	uint8_t bEndpointAddress;
437	uint8_t bmAttributes;
438	uint16_t wMaxPacketSize;
439	uint8_t bInterval;
440	} pDesc = (struct ep_desc )pb; NOREF(pDesc);
441	Log(("EP)\n"));
442	BYTE_FIELD(struct ep_desc, bEndpointAddress);
443	BYTE_FIELD(struct ep_desc, bmAttributes);
444	WORD_FIELD(struct ep_desc, wMaxPacketSize);
445	BYTE_FIELD(struct ep_desc, bInterval);
446	SIZE_CHECK(struct ep_desc);
447	break;
448	}
449
450	case VUSB_DT_DEVICE_QUALIFIER:
451	{
452	struct dq_desc
453	{
454	uint8_t bLength;
455	uint8_t bDescriptorType;
456	uint16_t bcdUSB;
457	uint8_t bDeviceClass;
458	uint8_t bDeviceSubClass;
459	uint8_t bDeviceProtocol;
460	uint8_t bMaxPacketSize0;
461	uint8_t bNumConfigurations;
462	uint8_t bReserved;
463	} pDQDesc = (struct dq_desc )pb; NOREF(pDQDesc);
464	Log(("DEVQ)\n"));
465	BCD_FIELD( struct dq_desc, bcdUSB);
466	BYTE_FIELD(struct dq_desc, bDeviceClass);
467	BYTE_FIELD(struct dq_desc, bDeviceSubClass);
468	BYTE_FIELD(struct dq_desc, bDeviceProtocol);
469	BYTE_FIELD(struct dq_desc, bMaxPacketSize0);
470	BYTE_FIELD(struct dq_desc, bNumConfigurations);
471	BYTE_FIELD(struct dq_desc, bReserved);
472	SIZE_CHECK(struct dq_desc);
473	break;
474	}
475
476	case VUSB_DT_OTHER_SPEED_CFG:
477	{
478	struct oth_cfg_desc
479	{
480	uint8_t bLength;
481	uint8_t bDescriptorType;
482	uint16_t wTotalLength;
483	uint8_t bNumInterfaces;
484	uint8_t bConfigurationValue;
485	uint8_t iConfiguration;
486	uint8_t bmAttributes;
487	uint8_t MaxPower;
488	} pDesc = (struct oth_cfg_desc )pb; NOREF(pDesc);
489	Log(("OCFG)\n"));
490	WORD_FIELD(struct oth_cfg_desc, wTotalLength);
491	BYTE_FIELD(struct oth_cfg_desc, bNumInterfaces);
492	BYTE_FIELD(struct oth_cfg_desc, bConfigurationValue);
493	BYTE_FIELD(struct oth_cfg_desc, iConfiguration);
494	BYTE_FIELD_START(struct oth_cfg_desc, bmAttributes);
495	static const char * const s_apszTransType[4] = { "Control", "Isochronous", "Bulk", "Interrupt" };
496	static const char * const s_apszSyncType[4] = { "NoSync", "Asynchronous", "Adaptive", "Synchronous" };
497	static const char * const s_apszUsageType[4] = { "Data ep", "Feedback ep.", "Implicit feedback Data ep.", "Reserved" };
498	Log((" %s - %s - %s", s_apszTransType[(pDesc->bmAttributes & 0x3)],
499	s_apszSyncType[((pDesc->bmAttributes >> 2) & 0x3)], s_apszUsageType[((pDesc->bmAttributes >> 4) & 0x3)]));
500	BYTE_FIELD_END(struct oth_cfg_desc, bmAttributes);
501	BYTE_FIELD(struct oth_cfg_desc, MaxPower);
502	SIZE_CHECK(struct oth_cfg_desc);
503	break;
504	}
505
506	case 0x21:
507	{
508	struct hid_desc
509	{
510	uint8_t bLength;
511	uint8_t bDescriptorType;
512	uint16_t bcdHid;
513	uint8_t bCountry;
514	uint8_t bNumDescriptors;
515	uint8_t bReportType;
516	uint16_t wReportLength;
517	} pDesc = (struct hid_desc )pb; NOREF(pDesc);
518	Log(("EP)\n"));
519	BCD_FIELD( struct hid_desc, bcdHid);
520	BYTE_FIELD(struct hid_desc, bCountry);
521	BYTE_FIELD(struct hid_desc, bNumDescriptors);
522	BYTE_FIELD(struct hid_desc, bReportType);
523	WORD_FIELD(struct hid_desc, wReportLength);
524	SIZE_CHECK(struct hid_desc);
525	break;
526	}
527
528	case 0xff:
529	Log(("UNKNOWN-ignore)\n"));
530	break;
531
532	default:
533	Log(("UNKNOWN)!!!\n"));
534	break;
535	}
536
537	#undef BYTE_FIELD
538	#undef WORD_FIELD
539	#undef BCD_FIELD
540	#undef SIZE_CHECK
541	#pragma pack()
542	}
543	else
544	{
545	Log(("URB: %*s: DESC: %04x: bLength=%d bDescriptorType=%d - invalid length\n",
546	s_cchMaxMsg, pszMsg, pb - pbData, cb, bDescriptorType));
547	break;
548	}
549
550	/* next */
551	pb += cb;
552	}
553	}
554
555	/*
556	* SCSI
557	*/
558	if ( pUrb->enmType == VUSBXFERTYPE_BULK
559	&& pUrb->enmDir == VUSBDIRECTION_OUT
560	&& pUrb->cbData >= 12
561	&& !memcmp(pUrb->abData, "USBC", 4))
562	{
563	const struct usbc
564	{
565	uint32_t Signature;
566	uint32_t Tag;
567	uint32_t DataTransferLength;
568	uint8_t Flags;
569	uint8_t Lun;
570	uint8_t Length;
571	uint8_t CDB[13];
572	} pUsbC = (struct usbc )pUrb->abData;
573	Log(("URB: %s: SCSI: Tag=%#x DataTransferLength=%#x Flags=%#x Lun=%#x Length=%#x CDB=%.Rhxs\n",
574	s_cchMaxMsg, pszMsg, pUsbC->Tag, pUsbC->DataTransferLength, pUsbC->Flags, pUsbC->Lun,
575	pUsbC->Length, pUsbC->Length, pUsbC->CDB));
576	const uint8_t *pb = &pUsbC->CDB[0];
577	switch (pb[0])
578	{
579	case 0x00: /* test unit read */
580	Log(("URB: %*s: SCSI: TEST_UNIT_READY LUN=%d Ctrl=%#RX8\n",
581	s_cchMaxMsg, pszMsg, pb[1] >> 5, pb[5]));
582	break;
583	case 0x03: /* Request Sense command */
584	Log(("URB: %*s: SCSI: REQUEST_SENSE LUN=%d AlcLen=%#RX16 Ctrl=%#RX8\n",
585	s_cchMaxMsg, pszMsg, pb[1] >> 5, pb[4], pb[5]));
586	break;
587	case 0x12: /* Inquiry command. */
588	Log(("URB: %*s: SCSI: INQUIRY EVPD=%d LUN=%d PgCd=%#RX8 AlcLen=%#RX8 Ctrl=%#RX8\n",
589	s_cchMaxMsg, pszMsg, pb[1] & 1, pb[1] >> 5, pb[2], pb[4], pb[5]));
590	break;
591	case 0x1a: /* Mode Sense(6) command */
592	Log(("URB: %*s: SCSI: MODE_SENSE6 LUN=%d DBD=%d PC=%d PgCd=%#RX8 AlcLen=%#RX8 Ctrl=%#RX8\n",
593	s_cchMaxMsg, pszMsg, pb[1] >> 5, !!(pb[1] & RT_BIT(3)), pb[2] >> 6, pb[2] & 0x3f, pb[4], pb[5]));
594	break;
595	case 0x5a:
596	Log(("URB: %*s: SCSI: MODE_SENSE10 LUN=%d DBD=%d PC=%d PgCd=%#RX8 AlcLen=%#RX16 Ctrl=%#RX8\n",
597	s_cchMaxMsg, pszMsg, pb[1] >> 5, !!(pb[1] & RT_BIT(3)), pb[2] >> 6, pb[2] & 0x3f,
598	RT_MAKE_U16(pb[8], pb[7]), pb[9]));
599	break;
600	case 0x25: /* Read Capacity(6) command. */
601	Log(("URB: %*s: SCSI: READ_CAPACITY\n",
602	s_cchMaxMsg, pszMsg));
603	break;
604	case 0x28: /* Read(10) command. */
605	Log(("URB: %*s: SCSI: READ10 RelAdr=%d FUA=%d DPO=%d LUN=%d LBA=%#RX32 Len=%#RX16 Ctrl=%#RX8\n",
606	s_cchMaxMsg, pszMsg,
607	pb[1] & 1, !!(pb[1] & RT_BIT(3)), !!(pb[1] & RT_BIT(4)), pb[1] >> 5,
608	RT_MAKE_U32_FROM_U8(pb[5], pb[4], pb[3], pb[2]),
609	RT_MAKE_U16(pb[8], pb[7]), pb[9]));
610	break;
611	case 0xa8: /* Read(12) command. */
612	Log(("URB: %*s: SCSI: READ12 RelAdr=%d FUA=%d DPO=%d LUN=%d LBA=%#RX32 Len=%#RX32 Ctrl=%#RX8\n",
613	s_cchMaxMsg, pszMsg,
614	pb[1] & 1, !!(pb[1] & RT_BIT(3)), !!(pb[1] & RT_BIT(4)), pb[1] >> 5,
615	RT_MAKE_U32_FROM_U8(pb[5], pb[4], pb[3], pb[2]),
616	RT_MAKE_U32_FROM_U8(pb[9], pb[8], pb[7], pb[6]),
617	pb[11]));
618	break;
619	case 0x3e: /* Read Long command. */
620	Log(("URB: %*s: SCSI: READ LONG RelAdr=%d Correct=%d LUN=%d LBA=%#RX16 ByteLen=%#RX16 Ctrl=%#RX8\n",
621	s_cchMaxMsg, pszMsg,
622	pb[1] & 1, !!(pb[1] & RT_BIT(1)), pb[1] >> 5,
623	RT_MAKE_U16(pb[3], pb[2]), RT_MAKE_U16(pb[6], pb[5]),
624	pb[11]));
625	break;
626	case 0x2a: /* Write(10) command. */
627	Log(("URB: %*s: SCSI: WRITE10 RelAdr=%d EBP=%d FUA=%d DPO=%d LUN=%d LBA=%#RX32 Len=%#RX16 Ctrl=%#RX8\n",
628	s_cchMaxMsg, pszMsg,
629	pb[1] & 1, !!(pb[1] & RT_BIT(2)), !!(pb[1] & RT_BIT(3)),
630	!!(pb[1] & RT_BIT(4)), pb[1] >> 5,
631	RT_MAKE_U32_FROM_U8(pb[5], pb[4], pb[3], pb[2]),
632	RT_MAKE_U16(pb[8], pb[7]), pb[9]));
633	break;
634	case 0xaa: /* Write(12) command. */
635	Log(("URB: %*s: SCSI: WRITE12 RelAdr=%d EBP=%d FUA=%d DPO=%d LUN=%d LBA=%#RX32 Len=%#RX32 Ctrl=%#RX8\n",
636	s_cchMaxMsg, pszMsg,
637	pb[1] & 1, !!(pb[1] & RT_BIT(3)), !!(pb[1] & RT_BIT(4)),
638	!!(pb[1] & RT_BIT(4)), pb[1] >> 5,
639	RT_MAKE_U32_FROM_U8(pb[5], pb[4], pb[3], pb[2]),
640	RT_MAKE_U32_FROM_U8(pb[9], pb[8], pb[7], pb[6]),
641	pb[11]));
642	break;
643	case 0x3f: /* Write Long command. */
644	Log(("URB: %*s: SCSI: WRITE LONG RelAdr=%d LUN=%d LBA=%#RX16 ByteLen=%#RX16 Ctrl=%#RX8\n",
645	s_cchMaxMsg, pszMsg,
646	pb[1] & 1, pb[1] >> 5,
647	RT_MAKE_U16(pb[3], pb[2]), RT_MAKE_U16(pb[6], pb[5]),
648	pb[11]));
649	break;
650	case 0x35: /* Synchronize Cache(10) command. */
651	Log(("URB: %*s: SCSI: SYNCHRONIZE_CACHE10\n",
652	s_cchMaxMsg, pszMsg));
653	break;
654	case 0xa0: /* Report LUNs command. */
655	Log(("URB: %*s: SCSI: REPORT_LUNS\n",
656	s_cchMaxMsg, pszMsg));
657	break;
658	default:
659	Log(("URB: %*s: SCSI: cmd=%#x\n",
660	s_cchMaxMsg, pszMsg, pb[0]));
661	break;
662	}
663	if (pDev)
664	pDev->Urb.u8ScsiCmd = pb[0];
665	}
666	else if ( fComplete
667	&& pUrb->enmType == VUSBXFERTYPE_BULK
668	&& pUrb->enmDir == VUSBDIRECTION_IN
669	&& pUrb->cbData >= 12
670	&& !memcmp(pUrb->abData, "USBS", 4))
671	{
672	const struct usbs
673	{
674	uint32_t Signature;
675	uint32_t Tag;
676	uint32_t DataResidue;
677	uint8_t Status;
678	uint8_t CDB[3];
679	} pUsbS = (struct usbs )pUrb->abData;
680	static const char * const s_apszStatuses[] = { "PASSED", "FAILED", "PHASE ERROR", "RESERVED" };
681	Log(("URB: %*s: SCSI: Tag=%#x DataResidue=%#RX32 Status=%#RX8 %s\n",
682	s_cchMaxMsg, pszMsg, pUsbS->Tag, pUsbS->DataResidue, pUsbS->Status,
683	s_apszStatuses[pUsbS->Status < RT_ELEMENTS(s_apszStatuses) ? pUsbS->Status : RT_ELEMENTS(s_apszStatuses) - 1]));
684	if (pDev)
685	pDev->Urb.u8ScsiCmd = 0xff;
686	}
687	else if ( fComplete
688	&& pUrb->enmType == VUSBXFERTYPE_BULK
689	&& pUrb->enmDir == VUSBDIRECTION_IN
690	&& pDev
691	&& pDev->Urb.u8ScsiCmd != 0xff)
692	{
693	const uint8_t *pb = pUrb->abData;
694	switch (pDev->Urb.u8ScsiCmd)
695	{
696	case 0x03: /* REQUEST_SENSE */
697	Log(("URB: %*s: SCSI: RESPONSE: REQUEST_SENSE (%s)\n",
698	s_cchMaxMsg, pszMsg, pb[0] & 7 ? "scsi compliant" : "not scsi compliant"));
699	Log(("URB: %*s: SCSI: ErrCd=%#RX8 (%s) Seg=%#RX8 Filemark=%d EOM=%d ILI=%d\n",
700	s_cchMaxMsg, pszMsg, pb[0] & 0x7f, GetScsiErrCd(pb[0] & 0x7f), pb[1],
701	pb[2] >> 7, !!(pb[2] & RT_BIT(6)), !!(pb[2] & RT_BIT(5))));
702	Log(("URB: %*s: SCSI: SenseKey=%#x ASC=%#RX8 ASCQ=%#RX8 : %s\n",
703	s_cchMaxMsg, pszMsg, pb[2] & 0xf, pb[12], pb[13],
704	GetScsiKCQ(pb[2] & 0xf, pb[12], pb[13])));
705	/** @todo more later */
706	break;
707
708	case 0x12: /* INQUIRY. */
709	{
710	unsigned cb = pb[4] + 5;
711	Log(("URB: %*s: SCSI: RESPONSE: INQUIRY\n"
712	"URB: %*s: SCSI: PeripheralQualifier=%d PeripheralType=%#RX8 RMB=%d DevTypeMod=%#RX8\n",
713	s_cchMaxMsg, pszMsg, s_cchMaxMsg, pszMsg,
714	pb[0] >> 5, pb[0] & 0x1f, pb[1] >> 7, pb[1] & 0x7f));
715	Log(("URB: %*s: SCSI: ISOVer=%d ECMAVer=%d ANSIVer=%d\n",
716	s_cchMaxMsg, pszMsg, pb[2] >> 6, (pb[2] >> 3) & 7, pb[2] & 7));
717	Log(("URB: %*s: SCSI: AENC=%d TrmlOP=%d RespDataFmt=%d (%s) AddLen=%d\n",
718	s_cchMaxMsg, pszMsg, pb[3] >> 7, (pb[3] >> 6) & 1,
719	pb[3] & 0xf, pb[3] & 0xf ? "legacy" : "scsi", pb[4]));
720	if (cb < 8)
721	break;
722	Log(("URB: %*s: SCSI: RelAdr=%d WBus32=%d WBus16=%d Sync=%d Linked=%d CmdQue=%d SftRe=%d\n",
723	s_cchMaxMsg, pszMsg, pb[7] >> 7, !!(pb[7] >> 6), !!(pb[7] >> 5), !!(pb[7] >> 4),
724	!!(pb[7] >> 3), !!(pb[7] >> 1), pb[7] & 1));
725	if (cb < 16)
726	break;
727	Log(("URB: %*s: SCSI: VendorId=%.8s\n", s_cchMaxMsg, pszMsg, &pb[8]));
728	if (cb < 32)
729	break;
730	Log(("URB: %*s: SCSI: ProductId=%.16s\n", s_cchMaxMsg, pszMsg, &pb[16]));
731	if (cb < 36)
732	break;
733	Log(("URB: %*s: SCSI: ProdRevLvl=%.4s\n", s_cchMaxMsg, pszMsg, &pb[32]));
734	if (cb > 36)
735	Log(("URB: %s: SCSI: VendorSpecific=%.s\n",
736	s_cchMaxMsg, pszMsg, RT_MIN(cb - 36, 20), &pb[36]));
737	if (cb > 96)
738	Log(("URB: %s: SCSI: VendorParam=%.Rhxs\n",
739	s_cchMaxMsg, pszMsg, cb - 96, &pb[96]));
740	break;
741	}
742
743	case 0x25: /* Read Capacity(6) command. */
744	Log(("URB: %*s: SCSI: RESPONSE: READ_CAPACITY\n"
745	"URB: %*s: SCSI: LBA=%#RX32 BlockLen=%#RX32\n",
746	s_cchMaxMsg, pszMsg, s_cchMaxMsg, pszMsg,
747	RT_MAKE_U32_FROM_U8(pb[3], pb[2], pb[1], pb[0]),
748	RT_MAKE_U32_FROM_U8(pb[7], pb[6], pb[5], pb[4])));
749	break;
750	}
751
752	pDev->Urb.u8ScsiCmd = 0xff;
753	}
754
755	/*
756	* The Quickcam control pipe.
757	*/
758	if ( pSetup
759	&& ((pSetup->bmRequestType >> 5) & 0x3) >= 2 /* vendor */
760	&& (fComplete \|\| !(pSetup->bmRequestType >> 7))
761	&& pDev
762	&& pDev->pDescCache
763	&& pDev->pDescCache->pDevice
764	&& pDev->pDescCache->pDevice->idVendor == 0x046d
765	&& ( pDev->pDescCache->pDevice->idProduct == 0x8f6
766	\|\| pDev->pDescCache->pDevice->idProduct == 0x8f5
767	\|\| pDev->pDescCache->pDevice->idProduct == 0x8f0)
768	)
769	{
770	pbData = (const uint8_t *)(pSetup + 1);
771	cbData = pUrb->cbData - sizeof(*pSetup);
772
773	if ( pSetup->bRequest == 0x04
774	&& pSetup->wIndex == 0
775	&& (cbData == 1 \|\| cbData == 2))
776	{
777	/* the value */
778	unsigned uVal = pbData[0];
779	if (cbData > 1)
780	uVal \|= (unsigned)pbData[1] << 8;
781
782	const char *pszReg = NULL;
783	switch (pSetup->wValue)
784	{
785	case 0: pszReg = "i2c init"; break;
786	case 0x0423: pszReg = "STV_REG23"; break;
787	case 0x0509: pszReg = "RED something"; break;
788	case 0x050a: pszReg = "GREEN something"; break;
789	case 0x050b: pszReg = "BLUE something"; break;
790	case 0x143f: pszReg = "COMMIT? INIT DONE?"; break;
791	case 0x1440: pszReg = "STV_ISO_ENABLE"; break;
792	case 0x1442: pszReg = uVal & (RT_BIT(7)\|RT_BIT(5)) ? "BUTTON PRESSED" : "BUTTON" ; break;
793	case 0x1443: pszReg = "STV_SCAN_RATE"; break;
794	case 0x1445: pszReg = "LED?"; break;
795	case 0x1500: pszReg = "STV_REG00"; break;
796	case 0x1501: pszReg = "STV_REG01"; break;
797	case 0x1502: pszReg = "STV_REG02"; break;
798	case 0x1503: pszReg = "STV_REG03"; break;
799	case 0x1504: pszReg = "STV_REG04"; break;
800	case 0x15c1: pszReg = "STV_ISO_SIZE"; break;
801	case 0x15c3: pszReg = "STV_Y_CTRL"; break;
802	case 0x1680: pszReg = "STV_X_CTRL"; break;
803	case 0xe00a: pszReg = "ProductId"; break;
804	default: pszReg = "[no clue]"; break;
805	}
806	if (pszReg)
807	Log(("URB: %*s: QUICKCAM: %s %#x (%d) %s '%s' (%#x)\n",
808	s_cchMaxMsg, pszMsg,
809	(pSetup->bmRequestType >> 7) ? "read" : "write", uVal, uVal, (pSetup->bmRequestType >> 7) ? "from" : "to",
810	pszReg, pSetup->wValue));
811	}
812	else if (cbData)
813	Log(("URB: %s: QUICKCAM: Unknown request: bRequest=%#x bmRequestType=%#x wValue=%#x wIndex=%#x: %.Rhxs\n", s_cchMaxMsg, pszMsg,
814	pSetup->bRequest, pSetup->bmRequestType, pSetup->wValue, pSetup->wIndex, cbData, pbData));
815	else
816	Log(("URB: %*s: QUICKCAM: Unknown request: bRequest=%#x bmRequestType=%#x wValue=%#x wIndex=%#x: (no data)\n", s_cchMaxMsg, pszMsg,
817	pSetup->bRequest, pSetup->bmRequestType, pSetup->wValue, pSetup->wIndex));
818	}
819
820	#if 1
821	if ( cbData /** @todo Fix RTStrFormatV to communicate .* so formatter doesn't apply defaults when cbData=0. */
822	&& (fComplete
823	? pUrb->enmDir != VUSBDIRECTION_OUT
824	: pUrb->enmDir == VUSBDIRECTION_OUT))
825	Log3(("%16.*Rhxd\n", cbData, pbData));
826	#endif
827	if (pUrb->enmType == VUSBXFERTYPE_MSG && pUrb->VUsb.pCtrlUrb)
828	vusbUrbTrace(pUrb->VUsb.pCtrlUrb, "NESTED MSG", fComplete);
829	}
830	#endif /* LOG_ENABLED */
831
832
833	/**
834	* Complete a SETUP stage URB.
835	*
836	* This is used both for dev2host and host2dev kind of transfers.
837	* It is used by both the sync and async control paths.
838	*/
839	static void vusbMsgSetupCompletion(PVUSBURB pUrb)
840	{
841	PVUSBDEV pDev = pUrb->VUsb.pDev;
842	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
843	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
844	PVUSBSETUP pSetup = pExtra->pMsg;
845
846	LogFlow(("%s: vusbMsgSetupCompletion: cbData=%d wLength=%#x cbLeft=%d pPipe=%p stage %s->DATA\n",
847	pUrb->pszDesc, pUrb->cbData, pSetup->wLength, pExtra->cbLeft, pPipe, g_apszCtlStates[pExtra->enmStage])); NOREF(pSetup);
848	pExtra->enmStage = CTLSTAGE_DATA;
849	pUrb->enmStatus = VUSBSTATUS_OK;
850	}
851
852	/**
853	* Complete a DATA stage URB.
854	*
855	* This is used both for dev2host and host2dev kind of transfers.
856	* It is used by both the sync and async control paths.
857	*/
858	static void vusbMsgDataCompletion(PVUSBURB pUrb)
859	{
860	PVUSBDEV pDev = pUrb->VUsb.pDev;
861	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
862	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
863	PVUSBSETUP pSetup = pExtra->pMsg;
864
865	LogFlow(("%s: vusbMsgDataCompletion: cbData=%d wLength=%#x cbLeft=%d pPipe=%p stage DATA\n",
866	pUrb->pszDesc, pUrb->cbData, pSetup->wLength, pExtra->cbLeft, pPipe)); NOREF(pSetup);
867
868	pUrb->enmStatus = VUSBSTATUS_OK;
869	}
870
871	/**
872	* Complete a STATUS stage URB.
873	*
874	* This is used both for dev2host and host2dev kind of transfers.
875	* It is used by both the sync and async control paths.
876	*/
877	static void vusbMsgStatusCompletion(PVUSBURB pUrb)
878	{
879	PVUSBDEV pDev = pUrb->VUsb.pDev;
880	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
881	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
882
883	if (pExtra->fOk)
884	{
885	/*
886	* vusbDevStdReqSetAddress requests are deferred.
887	*/
888	if (pDev->u8NewAddress != VUSB_INVALID_ADDRESS)
889	{
890	vusbDevSetAddress(pDev, pDev->u8NewAddress);
891	pDev->u8NewAddress = VUSB_INVALID_ADDRESS;
892	}
893
894	LogFlow(("%s: vusbMsgStatusCompletion: pDev=%p[%s] pPipe=%p err=OK stage %s->SETUP\n",
895	pUrb->pszDesc, pDev, pDev->pUsbIns->pszName, pPipe, g_apszCtlStates[pExtra->enmStage]));
896	pUrb->enmStatus = VUSBSTATUS_OK;
897	}
898	else
899	{
900	LogFlow(("%s: vusbMsgStatusCompletion: pDev=%p[%s] pPipe=%p err=STALL stage %s->SETUP\n",
901	pUrb->pszDesc, pDev, pDev->pUsbIns->pszName, pPipe, g_apszCtlStates[pExtra->enmStage]));
902	pUrb->enmStatus = VUSBSTATUS_STALL;
903	}
904
905	/*
906	* Done with this message sequence.
907	*/
908	pExtra->pbCur = NULL;
909	pExtra->enmStage = CTLSTAGE_SETUP;
910	}
911
912	/**
913	* This is a worker function for vusbMsgCompletion and
914	* vusbMsgSubmitSynchronously used to complete the original URB.
915	*
916	* @param pUrb The URB originating from the HCI.
917	*/
918	static void vusbCtrlCompletion(PVUSBURB pUrb)
919	{
920	PVUSBDEV pDev = pUrb->VUsb.pDev;
921	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
922	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
923	LogFlow(("%s: vusbCtrlCompletion: pDev=%p[%s]\n", pUrb->pszDesc, pDev, pDev->pUsbIns->pszName));
924
925	switch (pExtra->enmStage)
926	{
927	case CTLSTAGE_SETUP:
928	vusbMsgSetupCompletion(pUrb);
929	break;
930	case CTLSTAGE_DATA:
931	vusbMsgDataCompletion(pUrb);
932	break;
933	case CTLSTAGE_STATUS:
934	vusbMsgStatusCompletion(pUrb);
935	break;
936	}
937	}
938
939	/**
940	* Called from vusbUrbCompletionRh when it encounters a
941	* message type URB.
942	*
943	* @param pUrb The URB within the control pipe extra state data.
944	*/
945	static void vusbMsgCompletion(PVUSBURB pUrb)
946	{
947	PVUSBDEV pDev = pUrb->VUsb.pDev;
948	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
949
950	RTCritSectEnter(&pPipe->CritSectCtrl);
951	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
952
953	#ifdef LOG_ENABLED
954	LogFlow(("%s: vusbMsgCompletion: pDev=%p[%s]\n", pUrb->pszDesc, pDev, pDev->pUsbIns->pszName));
955	vusbUrbTrace(pUrb, "vusbMsgCompletion", true);
956	#endif
957	Assert(&pExtra->Urb == pUrb);
958
959
960	if (pUrb->enmStatus == VUSBSTATUS_OK)
961	pExtra->fOk = true;
962	else
963	pExtra->fOk = false;
964	pExtra->cbLeft = pUrb->cbData - sizeof(VUSBSETUP);
965
966	/*
967	* Complete the original URB.
968	*/
969	PVUSBURB pCtrlUrb = pUrb->VUsb.pCtrlUrb;
970	pCtrlUrb->enmState = VUSBURBSTATE_REAPED;
971	vusbCtrlCompletion(pCtrlUrb);
972
973	/*
974	* 'Free' the message URB, i.e. put it back to the allocated state.
975	*/
976	Assert( pUrb->enmState == VUSBURBSTATE_REAPED
977	\|\| pUrb->enmState == VUSBURBSTATE_CANCELLED);
978	if (pUrb->enmState != VUSBURBSTATE_CANCELLED)
979	pUrb->enmState = VUSBURBSTATE_ALLOCATED;
980	RTCritSectLeave(&pPipe->CritSectCtrl);
981
982	/* Complete the original control URB on the root hub now. */
983	vusbUrbCompletionRh(pCtrlUrb);
984	}
985
986	/**
987	* Deal with URB errors, talking thru the RH to the HCI.
988	*
989	* @returns true if it could be retried.
990	* @returns false if it should be completed with failure.
991	* @param pUrb The URB in question.
992	*/
993	int vusbUrbErrorRh(PVUSBURB pUrb)
994	{
995	PVUSBDEV pDev = pUrb->VUsb.pDev;
996	PVUSBROOTHUB pRh = vusbDevGetRh(pDev);
997	AssertPtrReturn(pRh, VERR_VUSB_DEVICE_NOT_ATTACHED);
998	LogFlow(("%s: vusbUrbErrorRh: pDev=%p[%s] rh=%p\n", pUrb->pszDesc, pDev, pDev->pUsbIns ? pDev->pUsbIns->pszName : "", pRh));
999	return pRh->pIRhPort->pfnXferError(pRh->pIRhPort, pUrb);
1000	}
1001
1002	/**
1003	* Does URB completion on roothub level.
1004	*
1005	* @param pUrb The URB to complete.
1006	*/
1007	void vusbUrbCompletionRh(PVUSBURB pUrb)
1008	{
1009	LogFlow(("%s: vusbUrbCompletionRh: type=%s status=%s\n",
1010	pUrb->pszDesc, vusbUrbTypeName(pUrb->enmType), vusbUrbStatusName(pUrb->enmStatus)));
1011	AssertMsg( pUrb->enmState == VUSBURBSTATE_REAPED
1012	\|\| pUrb->enmState == VUSBURBSTATE_CANCELLED, ("%d\n", pUrb->enmState));
1013
1014	if (pUrb->VUsb.pDev->hSniffer)
1015	{
1016	int rc = VUSBSnifferRecordEvent(pUrb->VUsb.pDev->hSniffer, pUrb,
1017	pUrb->enmStatus == VUSBSTATUS_OK
1018	? VUSBSNIFFEREVENT_COMPLETE
1019	: VUSBSNIFFEREVENT_ERROR_COMPLETE);
1020	if (RT_FAILURE(rc))
1021	LogRel(("VUSB: Capturing URB completion event failed with %Rrc\n", rc));
1022	}
1023
1024	PVUSBROOTHUB pRh = vusbDevGetRh(pUrb->VUsb.pDev);
1025	AssertPtrReturnVoid(pRh);
1026
1027	/* If there is a sniffer on the roothub record the completed URB there too. */
1028	if (pRh->hSniffer != VUSBSNIFFER_NIL)
1029	{
1030	int rc = VUSBSnifferRecordEvent(pRh->hSniffer, pUrb,
1031	pUrb->enmStatus == VUSBSTATUS_OK
1032	? VUSBSNIFFEREVENT_COMPLETE
1033	: VUSBSNIFFEREVENT_ERROR_COMPLETE);
1034	if (RT_FAILURE(rc))
1035	LogRel(("VUSB: Capturing URB completion event on the root hub failed with %Rrc\n", rc));
1036	}
1037
1038	#ifdef VBOX_WITH_STATISTICS
1039	/*
1040	* Total and per-type submit statistics.
1041	*/
1042	if (pUrb->enmType != VUSBXFERTYPE_MSG)
1043	{
1044	Assert(pUrb->enmType >= 0 && pUrb->enmType < (int)RT_ELEMENTS(pRh->aTypes));
1045
1046	if ( pUrb->enmStatus == VUSBSTATUS_OK
1047	\|\| pUrb->enmStatus == VUSBSTATUS_DATA_UNDERRUN
1048	\|\| pUrb->enmStatus == VUSBSTATUS_DATA_OVERRUN)
1049	{
1050	if (pUrb->enmType == VUSBXFERTYPE_ISOC)
1051	{
1052	for (unsigned i = 0; i < pUrb->cIsocPkts; i++)
1053	{
1054	const unsigned cb = pUrb->aIsocPkts[i].cb;
1055	if (cb)
1056	{
1057	STAM_COUNTER_ADD(&pRh->Total.StatActBytes, cb);
1058	STAM_COUNTER_ADD(&pRh->aTypes[VUSBXFERTYPE_ISOC].StatActBytes, cb);
1059	STAM_COUNTER_ADD(&pRh->aStatIsocDetails[i].Bytes, cb);
1060	if (pUrb->enmDir == VUSBDIRECTION_IN)
1061	{
1062	STAM_COUNTER_ADD(&pRh->Total.StatActReadBytes, cb);
1063	STAM_COUNTER_ADD(&pRh->aTypes[VUSBXFERTYPE_ISOC].StatActReadBytes, cb);
1064	}
1065	else
1066	{
1067	STAM_COUNTER_ADD(&pRh->Total.StatActWriteBytes, cb);
1068	STAM_COUNTER_ADD(&pRh->aTypes[VUSBXFERTYPE_ISOC].StatActWriteBytes, cb);
1069	}
1070	STAM_COUNTER_INC(&pRh->StatIsocActPkts);
1071	STAM_COUNTER_INC(&pRh->StatIsocActReadPkts);
1072	}
1073	STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].Pkts);
1074	switch (pUrb->aIsocPkts[i].enmStatus)
1075	{
1076	case VUSBSTATUS_OK:
1077	if (cb) STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].Ok);
1078	else STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].Ok0); break;
1079	case VUSBSTATUS_DATA_UNDERRUN:
1080	if (cb) STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].DataUnderrun);
1081	else STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].DataUnderrun0); break;
1082	case VUSBSTATUS_DATA_OVERRUN: STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].DataOverrun); break;
1083	case VUSBSTATUS_NOT_ACCESSED: STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].NotAccessed); break;
1084	default: STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].Misc); break;
1085	}
1086	}
1087	}
1088	else
1089	{
1090	STAM_COUNTER_ADD(&pRh->Total.StatActBytes, pUrb->cbData);
1091	STAM_COUNTER_ADD(&pRh->aTypes[pUrb->enmType].StatActBytes, pUrb->cbData);
1092	if (pUrb->enmDir == VUSBDIRECTION_IN)
1093	{
1094	STAM_COUNTER_ADD(&pRh->Total.StatActReadBytes, pUrb->cbData);
1095	STAM_COUNTER_ADD(&pRh->aTypes[pUrb->enmType].StatActReadBytes, pUrb->cbData);
1096	}
1097	else
1098	{
1099	STAM_COUNTER_ADD(&pRh->Total.StatActWriteBytes, pUrb->cbData);
1100	STAM_COUNTER_ADD(&pRh->aTypes[pUrb->enmType].StatActWriteBytes, pUrb->cbData);
1101	}
1102	}
1103	}
1104	else
1105	{
1106	/* (Note. this also counts the cancelled packets) */
1107	STAM_COUNTER_INC(&pRh->Total.StatUrbsFailed);
1108	STAM_COUNTER_INC(&pRh->aTypes[pUrb->enmType].StatUrbsFailed);
1109	}
1110	}
1111	#endif /* VBOX_WITH_STATISTICS */
1112
1113	/*
1114	* Msg transfers are special virtual transfers associated with
1115	* vusb, not the roothub
1116	*/
1117	switch (pUrb->enmType)
1118	{
1119	case VUSBXFERTYPE_MSG:
1120	vusbMsgCompletion(pUrb);
1121	return;
1122	case VUSBXFERTYPE_ISOC:
1123	/* Don't bother with error callback for isochronous URBs. */
1124	break;
1125
1126	#if 1 /** @todo r=bird: OHCI say "If the Transfer Descriptor is being
1127	* retired because of an error, the Host Controller must update
1128	* the Halt bit of the Endpoint Descriptor."
1129	*
1130	* So, I'll subject all transfertypes to the same halt stuff now. It could
1131	* just happen to fix the logitech disconnect trap in win2k.
1132	*/
1133	default:
1134	#endif
1135	case VUSBXFERTYPE_BULK:
1136	if (pUrb->enmStatus != VUSBSTATUS_OK)
1137	vusbUrbErrorRh(pUrb);
1138	break;
1139	}
1140	#ifdef LOG_ENABLED
1141	vusbUrbTrace(pUrb, "vusbUrbCompletionRh", true);
1142	#endif
1143
1144	pRh->pIRhPort->pfnXferCompletion(pRh->pIRhPort, pUrb);
1145	if (pUrb->enmState == VUSBURBSTATE_REAPED)
1146	{
1147	LogFlow(("%s: vusbUrbCompletionRh: Freeing URB\n", pUrb->pszDesc));
1148	pUrb->VUsb.pfnFree(pUrb);
1149	}
1150	}
1151
1152
1153	/**
1154	* Certain control requests must not ever be forwarded to the device because
1155	* they are required by the vusb core in order to maintain the vusb internal
1156	* data structures.
1157	*/
1158	DECLINLINE(bool) vusbUrbIsRequestSafe(PCVUSBSETUP pSetup, PVUSBURB pUrb)
1159	{
1160	if ((pSetup->bmRequestType & VUSB_REQ_MASK) != VUSB_REQ_STANDARD)
1161	return true;
1162
1163	switch (pSetup->bRequest)
1164	{
1165	case VUSB_REQ_CLEAR_FEATURE:
1166	return pUrb->EndPt != 0 /* not default control pipe */
1167	\|\| pSetup->wValue != 0 /* not ENDPOINT_HALT */
1168	\|\| !pUrb->pUsbIns->pReg->pfnUsbClearHaltedEndpoint; /* not special need for backend */
1169	case VUSB_REQ_SET_ADDRESS:
1170	case VUSB_REQ_SET_CONFIGURATION:
1171	case VUSB_REQ_GET_CONFIGURATION:
1172	case VUSB_REQ_SET_INTERFACE:
1173	case VUSB_REQ_GET_INTERFACE:
1174	return false;
1175
1176	/*
1177	* If the device wishes it, we'll use the cached device and
1178	* configuration descriptors. (We return false when we want to use the
1179	* cache. Yeah, it's a bit weird to read.)
1180	*/
1181	case VUSB_REQ_GET_DESCRIPTOR:
1182	if ( !pUrb->VUsb.pDev->pDescCache->fUseCachedDescriptors
1183	\|\| (pSetup->bmRequestType & VUSB_RECIP_MASK) != VUSB_TO_DEVICE)
1184	return true;
1185	switch (pSetup->wValue >> 8)
1186	{
1187	case VUSB_DT_DEVICE:
1188	case VUSB_DT_CONFIG:
1189	return false;
1190	case VUSB_DT_STRING:
1191	return !pUrb->VUsb.pDev->pDescCache->fUseCachedStringsDescriptors;
1192	default:
1193	return true;
1194	}
1195
1196	default:
1197	return true;
1198	}
1199	}
1200
1201
1202	/**
1203	* Queues an URB for asynchronous transfer.
1204	* A list of asynchronous URBs is kept by the roothub.
1205	*
1206	* @returns VBox status code (from pfnUrbQueue).
1207	* @param pUrb The URB.
1208	*/
1209	int vusbUrbQueueAsyncRh(PVUSBURB pUrb)
1210	{
1211	#ifdef LOG_ENABLED
1212	vusbUrbTrace(pUrb, "vusbUrbQueueAsyncRh", false);
1213	#endif
1214
1215	/* Immediately return in case of error.
1216	* XXX There is still a race: The Rh might vanish after this point! */
1217	PVUSBDEV pDev = pUrb->VUsb.pDev;
1218	PVUSBROOTHUB pRh = vusbDevGetRh(pDev);
1219	if (!pRh)
1220	{
1221	Log(("vusbUrbQueueAsyncRh returning VERR_OBJECT_DESTROYED\n"));
1222	return VERR_OBJECT_DESTROYED;
1223	}
1224
1225	RTCritSectEnter(&pDev->CritSectAsyncUrbs);
1226	int rc = pUrb->pUsbIns->pReg->pfnUrbQueue(pUrb->pUsbIns, pUrb);
1227	if (RT_FAILURE(rc))
1228	{
1229	LogFlow(("%s: vusbUrbQueueAsyncRh: returns %Rrc (queue_urb)\n", pUrb->pszDesc, rc));
1230	RTCritSectLeave(&pDev->CritSectAsyncUrbs);
1231	return rc;
1232	}
1233
1234	ASMAtomicIncU32(&pDev->aPipes[pUrb->EndPt].async);
1235
1236	/* Queue the pUrb on the roothub */
1237	pUrb->VUsb.pNext = pDev->pAsyncUrbHead;
1238	if (pDev->pAsyncUrbHead)
1239	pDev->pAsyncUrbHead->VUsb.ppPrev = &pUrb->VUsb.pNext;
1240	pDev->pAsyncUrbHead = pUrb;
1241	pUrb->VUsb.ppPrev = &pDev->pAsyncUrbHead;
1242	RTCritSectLeave(&pDev->CritSectAsyncUrbs);
1243
1244	return VINF_SUCCESS;
1245	}
1246
1247
1248	/**
1249	* Send a control message synchronously.
1250	* @return
1251	*/
1252	static void vusbMsgSubmitSynchronously(PVUSBURB pUrb, bool fSafeRequest)
1253	{
1254	PVUSBDEV pDev = pUrb->VUsb.pDev;
1255	Assert(pDev);
1256	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
1257	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
1258	PVUSBSETUP pSetup = pExtra->pMsg;
1259	LogFlow(("%s: vusbMsgSubmitSynchronously: pDev=%p[%s]\n", pUrb->pszDesc, pDev, pDev->pUsbIns ? pDev->pUsbIns->pszName : ""));
1260
1261	uint8_t pbData = (uint8_t )pExtra->pMsg + sizeof(*pSetup);
1262	uint32_t cbData = pSetup->wLength;
1263	bool fOk = false;
1264	if (!fSafeRequest)
1265	fOk = vusbDevStandardRequest(pDev, pUrb->EndPt, pSetup, pbData, &cbData);
1266	else
1267	AssertMsgFailed(("oops\n"));
1268
1269	pUrb->enmState = VUSBURBSTATE_REAPED;
1270	if (fOk)
1271	{
1272	pSetup->wLength = cbData;
1273	pUrb->enmStatus = VUSBSTATUS_OK;
1274	pExtra->fOk = true;
1275	}
1276	else
1277	{
1278	pUrb->enmStatus = VUSBSTATUS_STALL;
1279	pExtra->fOk = false;
1280	}
1281	pExtra->cbLeft = cbData; /* used by IN only */
1282
1283	vusbCtrlCompletion(pUrb);
1284	vusbUrbCompletionRh(pUrb);
1285
1286	/*
1287	* 'Free' the message URB, i.e. put it back to the allocated state.
1288	*/
1289	pExtra->Urb.enmState = VUSBURBSTATE_ALLOCATED;
1290	}
1291
1292	/**
1293	* Callback for dealing with device reset.
1294	*/
1295	void vusbMsgResetExtraData(PVUSBCTRLEXTRA pExtra)
1296	{
1297	if (!pExtra)
1298	return;
1299	pExtra->enmStage = CTLSTAGE_SETUP;
1300	if (pExtra->Urb.enmState != VUSBURBSTATE_CANCELLED)
1301	pExtra->Urb.enmState = VUSBURBSTATE_ALLOCATED;
1302	}
1303
1304
1305	/**
1306	* Callback to free a cancelled message URB.
1307	*
1308	* This is yet another place we're we have to performance acrobatics to
1309	* deal with cancelled URBs. sigh.
1310	*
1311	* The deal here is that we never free message URBs since they are integrated
1312	* into the message pipe state. But since cancel can leave URBs unreaped and in
1313	* a state which require them not to be freed, we'll have to do two things.
1314	* First, if a new message URB is processed we'll have to get a new message
1315	* pipe state. Second, we cannot just free the damn state structure because
1316	* that might lead to heap corruption since it might still be in-flight.
1317	*
1318	* The URB embedded into the message pipe control structure will start in an
1319	* ALLOCATED state. When submitted it will be go to the IN-FLIGHT state. When
1320	* reaped it will go from REAPED to ALLOCATED. When completed in the CANCELLED
1321	* state it will remain in that state (as does normal URBs).
1322	*
1323	* If a new message urb comes up while it's in the CANCELLED state, we will
1324	* orphan it and it will be freed here in vusbMsgFreeUrb. We indicate this
1325	* by setting VUsb.pvFreeCtx to NULL.
1326	*
1327	* If we have to free the message state structure because of device destruction,
1328	* configuration changes, or similar, we will orphan the message pipe state in
1329	* the same way by setting VUsb.pvFreeCtx to NULL and let this function free it.
1330	*
1331	* @param pUrb
1332	*/
1333	static DECLCALLBACK(void) vusbMsgFreeUrb(PVUSBURB pUrb)
1334	{
1335	vusbUrbAssert(pUrb);
1336	PVUSBCTRLEXTRA pExtra = (PVUSBCTRLEXTRA)((uint8_t *)pUrb - RT_OFFSETOF(VUSBCTRLEXTRA, Urb));
1337	if ( pUrb->enmState == VUSBURBSTATE_CANCELLED
1338	&& !pUrb->VUsb.pvFreeCtx)
1339	{
1340	LogFlow(("vusbMsgFreeUrb: Freeing orphan: %p (pUrb=%p)\n", pExtra, pUrb));
1341	RTMemFree(pExtra);
1342	}
1343	else
1344	{
1345	Assert(pUrb->VUsb.pvFreeCtx == &pExtra->Urb);
1346	pUrb->enmState = VUSBURBSTATE_ALLOCATED;
1347	}
1348	}
1349
1350	/**
1351	* Frees the extra state data associated with a message pipe.
1352	*
1353	* @param pExtra The data.
1354	*/
1355	void vusbMsgFreeExtraData(PVUSBCTRLEXTRA pExtra)
1356	{
1357	if (!pExtra)
1358	return;
1359	if (pExtra->Urb.enmState != VUSBURBSTATE_CANCELLED)
1360	{
1361	pExtra->Urb.u32Magic = 0;
1362	pExtra->Urb.enmState = VUSBURBSTATE_FREE;
1363	if (pExtra->Urb.pszDesc)
1364	RTStrFree(pExtra->Urb.pszDesc);
1365	RTMemFree(pExtra);
1366	}
1367	else
1368	pExtra->Urb.VUsb.pvFreeCtx = NULL; /* see vusbMsgFreeUrb */
1369	}
1370
1371	/**
1372	* Allocates the extra state data required for a control pipe.
1373	*
1374	* @returns Pointer to the allocated and initialized state data.
1375	* @returns NULL on out of memory condition.
1376	* @param pUrb A URB we can copy default data from.
1377	*/
1378	static PVUSBCTRLEXTRA vusbMsgAllocExtraData(PVUSBURB pUrb)
1379	{
1380	/** @todo reuse these? */
1381	PVUSBCTRLEXTRA pExtra;
1382	const size_t cbMax = sizeof(pExtra->Urb.abData) + sizeof(VUSBSETUP);
1383	pExtra = (PVUSBCTRLEXTRA)RTMemAllocZ(RT_OFFSETOF(VUSBCTRLEXTRA, Urb.abData[cbMax]));
1384	if (pExtra)
1385	{
1386	pExtra->enmStage = CTLSTAGE_SETUP;
1387	//pExtra->fOk = false;
1388	pExtra->pMsg = (PVUSBSETUP)pExtra->Urb.abData;
1389	pExtra->pbCur = (uint8_t *)(pExtra->pMsg + 1);
1390	//pExtra->cbLeft = 0;
1391	pExtra->cbMax = cbMax;
1392
1393	//pExtra->Urb.Dev.pvProxyUrb = NULL;
1394	pExtra->Urb.u32Magic = VUSBURB_MAGIC;
1395	pExtra->Urb.enmState = VUSBURBSTATE_ALLOCATED;
1396	#ifdef LOG_ENABLED
1397	RTStrAPrintf(&pExtra->Urb.pszDesc, "URB %p msg->%p", &pExtra->Urb, pUrb);
1398	#endif
1399	//pExtra->Urb.VUsb.pCtrlUrb = NULL;
1400	//pExtra->Urb.VUsb.pNext = NULL;
1401	//pExtra->Urb.VUsb.ppPrev = NULL;
1402	pExtra->Urb.VUsb.pDev = pUrb->VUsb.pDev;
1403	pExtra->Urb.VUsb.pfnFree = vusbMsgFreeUrb;
1404	pExtra->Urb.VUsb.pvFreeCtx = &pExtra->Urb;
1405	//pExtra->Urb.Hci = {0};
1406	//pExtra->Urb.Dev.pvProxyUrb = NULL;
1407	pExtra->Urb.pUsbIns = pUrb->pUsbIns;
1408	pExtra->Urb.DstAddress = pUrb->DstAddress;
1409	pExtra->Urb.EndPt = pUrb->EndPt;
1410	pExtra->Urb.enmType = VUSBXFERTYPE_MSG;
1411	pExtra->Urb.enmDir = VUSBDIRECTION_INVALID;
1412	//pExtra->Urb.fShortNotOk = false;
1413	pExtra->Urb.enmStatus = VUSBSTATUS_INVALID;
1414	//pExtra->Urb.cbData = 0;
1415	vusbUrbAssert(&pExtra->Urb);
1416	}
1417	return pExtra;
1418	}
1419
1420	/**
1421	* Sets up the message.
1422	*
1423	* The message is associated with the pipe, in what's currently called
1424	* control pipe extra state data (pointed to by pPipe->pCtrl). If this
1425	* is a OUT message, we will no go on collecting data URB. If it's a
1426	* IN message, we'll send it and then queue any incoming data for the
1427	* URBs collecting it.
1428	*
1429	* @returns Success indicator.
1430	*/
1431	static bool vusbMsgSetup(PVUSBPIPE pPipe, const void *pvBuf, uint32_t cbBuf)
1432	{
1433	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
1434	const VUSBSETUP *pSetupIn = (PVUSBSETUP)pvBuf;
1435
1436	/*
1437	* Validate length.
1438	*/
1439	if (cbBuf < sizeof(VUSBSETUP))
1440	{
1441	LogFlow(("vusbMsgSetup: pPipe=%p cbBuf=%u < %u (failure) !!!\n",
1442	pPipe, cbBuf, sizeof(VUSBSETUP)));
1443	return false;
1444	}
1445
1446	/*
1447	* Check if we've got an cancelled message URB. Allocate a new one in that case.
1448	*/
1449	if (pExtra->Urb.enmState == VUSBURBSTATE_CANCELLED)
1450	{
1451	void *pvNew = RTMemDup(pExtra, RT_OFFSETOF(VUSBCTRLEXTRA, Urb.abData[pExtra->cbMax]));
1452	if (!pvNew)
1453	{
1454	Log(("vusbMsgSetup: out of memory!!! cbReq=%u\n", RT_OFFSETOF(VUSBCTRLEXTRA, Urb.abData[pExtra->cbMax])));
1455	return false;
1456	}
1457	pExtra->Urb.VUsb.pvFreeCtx = NULL;
1458	LogFlow(("vusbMsgSetup: Replacing canceled pExtra=%p with %p.\n", pExtra, pvNew));
1459	pPipe->pCtrl = pExtra = (PVUSBCTRLEXTRA)pvNew;
1460	pExtra->pMsg = (PVUSBSETUP)pExtra->Urb.abData;
1461	pExtra->Urb.enmState = VUSBURBSTATE_ALLOCATED;
1462	}
1463
1464	/*
1465	* Check that we've got sufficient space in the message URB.
1466	*/
1467	if (pExtra->cbMax < cbBuf + pSetupIn->wLength)
1468	{
1469	uint32_t cbReq = RT_ALIGN_32(cbBuf + pSetupIn->wLength, 1024);
1470	PVUSBCTRLEXTRA pNew = (PVUSBCTRLEXTRA)RTMemRealloc(pExtra, RT_OFFSETOF(VUSBCTRLEXTRA, Urb.abData[cbReq]));
1471	if (!pNew)
1472	{
1473	Log(("vusbMsgSetup: out of memory!!! cbReq=%u %u\n",
1474	cbReq, RT_OFFSETOF(VUSBCTRLEXTRA, Urb.abData[cbReq])));
1475	return false;
1476	}
1477	if (pExtra != pNew)
1478	{
1479	pNew->pMsg = (PVUSBSETUP)pNew->Urb.abData;
1480	pExtra = pNew;
1481	}
1482	pExtra->cbMax = cbReq;
1483	}
1484	Assert(pExtra->Urb.enmState == VUSBURBSTATE_ALLOCATED);
1485
1486	/*
1487	* Copy the setup data and prepare for data.
1488	*/
1489	PVUSBSETUP pSetup = pExtra->pMsg;
1490	pExtra->fSubmitted = false;
1491	pExtra->Urb.enmState = VUSBURBSTATE_IN_FLIGHT;
1492	pExtra->pbCur = (uint8_t *)(pSetup + 1);
1493	pSetup->bmRequestType = pSetupIn->bmRequestType;
1494	pSetup->bRequest = pSetupIn->bRequest;
1495	pSetup->wValue = RT_LE2H_U16(pSetupIn->wValue);
1496	pSetup->wIndex = RT_LE2H_U16(pSetupIn->wIndex);
1497	pSetup->wLength = RT_LE2H_U16(pSetupIn->wLength);
1498
1499	LogFlow(("vusbMsgSetup(%p,,%d): bmRequestType=%#04x bRequest=%#04x wValue=%#06x wIndex=%#06x wLength=0x%.4x\n",
1500	pPipe, cbBuf, pSetup->bmRequestType, pSetup->bRequest, pSetup->wValue, pSetup->wIndex, pSetup->wLength));
1501	return true;
1502	}
1503
1504	/**
1505	* Build the message URB from the given control URB and accompanying message
1506	* pipe state which we grab from the device for the URB.
1507	*
1508	* @param pUrb The URB to submit.
1509	*/
1510	static void vusbMsgDoTransfer(PVUSBURB pUrb, PVUSBSETUP pSetup, PVUSBCTRLEXTRA pExtra, PVUSBPIPE pPipe, PVUSBDEV pDev)
1511	{
1512	/*
1513	* Mark this transfer as sent (cleared at setup time).
1514	*/
1515	Assert(!pExtra->fSubmitted);
1516	pExtra->fSubmitted = true;
1517
1518	/*
1519	* Do we have to do this synchronously?
1520	*/
1521	bool fSafeRequest = vusbUrbIsRequestSafe(pSetup, pUrb);
1522	if (!fSafeRequest)
1523	{
1524	vusbMsgSubmitSynchronously(pUrb, fSafeRequest);
1525	return;
1526	}
1527
1528	/*
1529	* Do it asynchronously.
1530	*/
1531	LogFlow(("%s: vusbMsgDoTransfer: ep=%d pMsgUrb=%p pPipe=%p stage=%s\n",
1532	pUrb->pszDesc, pUrb->EndPt, &pExtra->Urb, pPipe, g_apszCtlStates[pExtra->enmStage]));
1533	Assert(pExtra->Urb.enmType == VUSBXFERTYPE_MSG);
1534	Assert(pExtra->Urb.EndPt == pUrb->EndPt);
1535	pExtra->Urb.enmDir = (pSetup->bmRequestType & VUSB_DIR_TO_HOST) ? VUSBDIRECTION_IN : VUSBDIRECTION_OUT;
1536	pExtra->Urb.cbData = pSetup->wLength + sizeof(*pSetup);
1537	pExtra->Urb.VUsb.pCtrlUrb = pUrb;
1538	int rc = vusbUrbQueueAsyncRh(&pExtra->Urb);
1539	if (RT_FAILURE(rc))
1540	{
1541	/*
1542	* If we fail submitting it, will not retry but fail immediately.
1543	*
1544	* This keeps things simple. The host OS will have retried if
1545	* it's a proxied device, and if it's a virtual one it really means
1546	* it if it's failing a control message.
1547	*/
1548	LogFlow(("%s: vusbMsgDoTransfer: failed submitting urb! failing it with %s (rc=%Rrc)!!!\n",
1549	pUrb->pszDesc, rc == VERR_VUSB_DEVICE_NOT_ATTACHED ? "DNR" : "CRC", rc));
1550	pExtra->Urb.enmStatus = rc == VERR_VUSB_DEVICE_NOT_ATTACHED ? VUSBSTATUS_DNR : VUSBSTATUS_CRC;
1551	pExtra->Urb.enmState = VUSBURBSTATE_REAPED;
1552	vusbMsgCompletion(&pExtra->Urb);
1553	}
1554	}
1555
1556	/**
1557	* Fails a URB request with a pipe STALL error.
1558	*
1559	* @returns VINF_SUCCESS indicating that we've completed the URB.
1560	* @param pUrb The URB in question.
1561	*/
1562	static int vusbMsgStall(PVUSBURB pUrb)
1563	{
1564	PVUSBPIPE pPipe = &pUrb->VUsb.pDev->aPipes[pUrb->EndPt];
1565	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
1566	LogFlow(("%s: vusbMsgStall: pPipe=%p err=STALL stage %s->SETUP\n",
1567	pUrb->pszDesc, pPipe, g_apszCtlStates[pExtra->enmStage]));
1568
1569	pExtra->pbCur = NULL;
1570	pExtra->enmStage = CTLSTAGE_SETUP;
1571	pUrb->enmState = VUSBURBSTATE_REAPED;
1572	pUrb->enmStatus = VUSBSTATUS_STALL;
1573	vusbUrbCompletionRh(pUrb);
1574	return VINF_SUCCESS;
1575	}
1576
1577	/**
1578	* Submit a control message.
1579	*
1580	* Here we implement the USB defined traffic that occurs in message pipes
1581	* (aka control endpoints). We want to provide a single function for device
1582	* drivers so that they don't all have to reimplement the usb logic for
1583	* themselves. This means we need to keep a little bit of state information
1584	* because control transfers occur over multiple bus transactions. We may
1585	* also need to buffer data over multiple data stages.
1586	*
1587	* @returns VBox status code.
1588	* @param pUrb The URB to submit.
1589	*/
1590	static int vusbUrbSubmitCtrl(PVUSBURB pUrb)
1591	{
1592	#ifdef LOG_ENABLED
1593	vusbUrbTrace(pUrb, "vusbUrbSubmitCtrl", false);
1594	#endif
1595	PVUSBDEV pDev = pUrb->VUsb.pDev;
1596	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
1597
1598	RTCritSectEnter(&pPipe->CritSectCtrl);
1599	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
1600
1601	if (!pExtra && !(pExtra = pPipe->pCtrl = vusbMsgAllocExtraData(pUrb)))
1602	{
1603	RTCritSectLeave(&pPipe->CritSectCtrl);
1604	return VERR_VUSB_NO_URB_MEMORY;
1605	}
1606	PVUSBSETUP pSetup = pExtra->pMsg;
1607
1608	AssertMsgReturn(!pPipe->async, ("%u\n", pPipe->async), VERR_GENERAL_FAILURE);
1609
1610
1611	/*
1612	* A setup packet always resets the transaction and the
1613	* end of data transmission is signified by change in
1614	* data direction.
1615	*/
1616	if (pUrb->enmDir == VUSBDIRECTION_SETUP)
1617	{
1618	LogFlow(("%s: vusbUrbSubmitCtrl: pPipe=%p state %s->SETUP\n",
1619	pUrb->pszDesc, pPipe, g_apszCtlStates[pExtra->enmStage]));
1620	pExtra->enmStage = CTLSTAGE_SETUP;
1621	}
1622	else if ( pExtra->enmStage == CTLSTAGE_DATA
1623	/* (the STATUS stage direction goes the other way) */
1624	&& !!(pSetup->bmRequestType & VUSB_DIR_TO_HOST) != (pUrb->enmDir == VUSBDIRECTION_IN))
1625	{
1626	LogFlow(("%s: vusbUrbSubmitCtrl: pPipe=%p state %s->STATUS\n",
1627	pUrb->pszDesc, pPipe, g_apszCtlStates[pExtra->enmStage]));
1628	pExtra->enmStage = CTLSTAGE_STATUS;
1629	}
1630
1631	/*
1632	* Act according to the current message stage.
1633	*/
1634	switch (pExtra->enmStage)
1635	{
1636	case CTLSTAGE_SETUP:
1637	/*
1638	* When stall handshake is returned, all subsequent packets
1639	* must generate stall until a setup packet arrives.
1640	*/
1641	if (pUrb->enmDir != VUSBDIRECTION_SETUP)
1642	{
1643	Log(("%s: vusbUrbSubmitCtrl: Stall at setup stage (dir=%#x)!!\n", pUrb->pszDesc, pUrb->enmDir));
1644	vusbMsgStall(pUrb);
1645	break;
1646	}
1647
1648	/* Store setup details, return DNR if corrupt */
1649	if (!vusbMsgSetup(pPipe, pUrb->abData, pUrb->cbData))
1650	{
1651	pUrb->enmState = VUSBURBSTATE_REAPED;
1652	pUrb->enmStatus = VUSBSTATUS_DNR;
1653	vusbUrbCompletionRh(pUrb);
1654	break;
1655	}
1656	if (pPipe->pCtrl != pExtra)
1657	{
1658	pExtra = pPipe->pCtrl;
1659	pSetup = pExtra->pMsg;
1660	}
1661
1662	/* pre-buffer our output if it's device-to-host */
1663	if (pSetup->bmRequestType & VUSB_DIR_TO_HOST)
1664	vusbMsgDoTransfer(pUrb, pSetup, pExtra, pPipe, pDev);
1665	else if (pSetup->wLength)
1666	{
1667	LogFlow(("%s: vusbUrbSubmitCtrl: stage=SETUP - to dev: need data\n", pUrb->pszDesc));
1668	pUrb->enmState = VUSBURBSTATE_REAPED;
1669	vusbMsgSetupCompletion(pUrb);
1670	vusbUrbCompletionRh(pUrb);
1671	}
1672	/*
1673	* If there is no DATA stage, we must send it now since there are
1674	* no requirement of a STATUS stage.
1675	*/
1676	else
1677	{
1678	LogFlow(("%s: vusbUrbSubmitCtrl: stage=SETUP - to dev: sending\n", pUrb->pszDesc));
1679	vusbMsgDoTransfer(pUrb, pSetup, pExtra, pPipe, pDev);
1680	}
1681	break;
1682
1683	case CTLSTAGE_DATA:
1684	{
1685	/*
1686	* If a data stage exceeds the target buffer indicated in
1687	* setup return stall, if data stage returns stall there
1688	* will be no status stage.
1689	*/
1690	uint8_t pbData = (uint8_t )(pExtra->pMsg + 1);
1691	if (&pExtra->pbCur[pUrb->cbData] > &pbData[pSetup->wLength])
1692	{
1693	if (!pSetup->wLength) /* happens during iPhone detection with iTunes (correct?) */
1694	{
1695	Log(("%s: vusbUrbSubmitCtrl: pSetup->wLength == 0!! (iPhone)\n", pUrb->pszDesc));
1696	pSetup->wLength = pUrb->cbData;
1697	}
1698
1699	/* Variable length data transfers */
1700	if ( (pSetup->bmRequestType & VUSB_DIR_TO_HOST)
1701	\|\| pSetup->wLength == 0
1702	\|\| (pUrb->cbData % pSetup->wLength) == 0) /* magic which need explaining... */
1703	{
1704	uint8_t *pbEnd = pbData + pSetup->wLength;
1705	int cbLeft = pbEnd - pExtra->pbCur;
1706	LogFlow(("%s: vusbUrbSubmitCtrl: Var DATA, pUrb->cbData %d -> %d\n", pUrb->pszDesc, pUrb->cbData, cbLeft));
1707	pUrb->cbData = cbLeft;
1708	}
1709	else
1710	{
1711	Log(("%s: vusbUrbSubmitCtrl: Stall at data stage!!\n", pUrb->pszDesc));
1712	vusbMsgStall(pUrb);
1713	break;
1714	}
1715	}
1716
1717	if (pUrb->enmDir == VUSBDIRECTION_IN)
1718	{
1719	/* put data received from the device. */
1720	const uint32_t cbRead = RT_MIN(pUrb->cbData, pExtra->cbLeft);
1721	memcpy(pUrb->abData, pExtra->pbCur, cbRead);
1722
1723	/* advance */
1724	pExtra->pbCur += cbRead;
1725	if (pUrb->cbData == cbRead)
1726	pExtra->cbLeft -= pUrb->cbData;
1727	else
1728	{
1729	/* adjust the pUrb->cbData to reflect the number of bytes containing actual data. */
1730	LogFlow(("%s: vusbUrbSubmitCtrl: adjusting last DATA pUrb->cbData, %d -> %d\n",
1731	pUrb->pszDesc, pUrb->cbData, pExtra->cbLeft));
1732	pUrb->cbData = cbRead;
1733	pExtra->cbLeft = 0;
1734	}
1735	}
1736	else
1737	{
1738	/* get data for sending when completed. */
1739	memcpy(pExtra->pbCur, pUrb->abData, pUrb->cbData);
1740
1741	/* advance */
1742	pExtra->pbCur += pUrb->cbData;
1743
1744	/*
1745	* If we've got the necessary data, we'll send it now since there are
1746	* no requirement of a STATUS stage.
1747	*/
1748	if ( !pExtra->fSubmitted
1749	&& pExtra->pbCur - pbData >= pSetup->wLength)
1750	{
1751	LogFlow(("%s: vusbUrbSubmitCtrl: stage=DATA - to dev: sending\n", pUrb->pszDesc));
1752	vusbMsgDoTransfer(pUrb, pSetup, pExtra, pPipe, pDev);
1753	break;
1754	}
1755	}
1756
1757	pUrb->enmState = VUSBURBSTATE_REAPED;
1758	vusbMsgDataCompletion(pUrb);
1759	vusbUrbCompletionRh(pUrb);
1760	break;
1761	}
1762
1763	case CTLSTAGE_STATUS:
1764	if ( (pSetup->bmRequestType & VUSB_DIR_TO_HOST)
1765	\|\| pExtra->fSubmitted)
1766	{
1767	Assert(pExtra->fSubmitted);
1768	pUrb->enmState = VUSBURBSTATE_REAPED;
1769	vusbMsgStatusCompletion(pUrb);
1770	vusbUrbCompletionRh(pUrb);
1771	}
1772	else
1773	{
1774	LogFlow(("%s: vusbUrbSubmitCtrl: stage=STATUS - to dev: sending\n", pUrb->pszDesc));
1775	vusbMsgDoTransfer(pUrb, pSetup, pExtra, pPipe, pDev);
1776	}
1777	break;
1778	}
1779
1780	RTCritSectLeave(&pPipe->CritSectCtrl);
1781	return VINF_SUCCESS;
1782	}
1783
1784
1785	/**
1786	* Submit a interrupt URB.
1787	*
1788	* @returns VBox status code.
1789	* @param pUrb The URB to submit.
1790	*/
1791	static int vusbUrbSubmitInterrupt(PVUSBURB pUrb)
1792	{
1793	LogFlow(("%s: vusbUrbSubmitInterrupt: (sync)\n", pUrb->pszDesc));
1794	return vusbUrbQueueAsyncRh(pUrb);
1795	}
1796
1797
1798	/**
1799	* Submit a bulk URB.
1800	*
1801	* @returns VBox status code.
1802	* @param pUrb The URB to submit.
1803	*/
1804	static int vusbUrbSubmitBulk(PVUSBURB pUrb)
1805	{
1806	LogFlow(("%s: vusbUrbSubmitBulk: (async)\n", pUrb->pszDesc));
1807	return vusbUrbQueueAsyncRh(pUrb);
1808	}
1809
1810
1811	/**
1812	* Submit an isochronous URB.
1813	*
1814	* @returns VBox status code.
1815	* @param pUrb The URB to submit.
1816	*/
1817	static int vusbUrbSubmitIsochronous(PVUSBURB pUrb)
1818	{
1819	LogFlow(("%s: vusbUrbSubmitIsochronous: (async)\n", pUrb->pszDesc));
1820	return vusbUrbQueueAsyncRh(pUrb);
1821	}
1822
1823
1824	/**
1825	* Fail a URB with a 'hard-error' sort of error.
1826	*
1827	* @return VINF_SUCCESS (the Urb status indicates the error).
1828	* @param pUrb The URB.
1829	*/
1830	int vusbUrbSubmitHardError(PVUSBURB pUrb)
1831	{
1832	/* FIXME: Find out the correct return code from the spec */
1833	pUrb->enmState = VUSBURBSTATE_REAPED;
1834	pUrb->enmStatus = VUSBSTATUS_DNR;
1835	vusbUrbCompletionRh(pUrb);
1836	return VINF_SUCCESS;
1837	}
1838
1839
1840	/**
1841	* Submit a URB.
1842	*/
1843	int vusbUrbSubmit(PVUSBURB pUrb)
1844	{
1845	vusbUrbAssert(pUrb);
1846	Assert(pUrb->enmState == VUSBURBSTATE_ALLOCATED);
1847	PVUSBDEV pDev = pUrb->VUsb.pDev;
1848	PVUSBPIPE pPipe = NULL;
1849	Assert(pDev);
1850
1851	/*
1852	* Check that the device is in a valid state.
1853	*/
1854	const VUSBDEVICESTATE enmState = vusbDevGetState(pDev);
1855	if (enmState == VUSB_DEVICE_STATE_RESET)
1856	{
1857	LogRel(("VUSB: %s: power off ignored, the device is resetting!\n", pDev->pUsbIns->pszName));
1858	pUrb->enmStatus = VUSBSTATUS_DNR;
1859	/* This will postpone the TDs until we're done with the resetting. */
1860	return VERR_VUSB_DEVICE_IS_RESETTING;
1861	}
1862
1863	#ifdef LOG_ENABLED
1864	/* stamp it */
1865	pUrb->VUsb.u64SubmitTS = RTTimeNanoTS();
1866	#endif
1867
1868	/** @todo Check max packet size here too? */
1869
1870	/*
1871	* Validate the pipe.
1872	*/
1873	if (pUrb->EndPt >= VUSB_PIPE_MAX)
1874	{
1875	Log(("%s: pDev=%p[%s]: SUBMIT: ep %i >= %i!!!\n", pUrb->pszDesc, pDev, pDev->pUsbIns->pszName, pUrb->EndPt, VUSB_PIPE_MAX));
1876	return vusbUrbSubmitHardError(pUrb);
1877	}
1878	PCVUSBDESCENDPOINTEX pEndPtDesc;
1879	switch (pUrb->enmDir)
1880	{
1881	case VUSBDIRECTION_IN:
1882	pEndPtDesc = pDev->aPipes[pUrb->EndPt].in;
1883	pPipe = &pDev->aPipes[pUrb->EndPt];
1884	break;
1885	case VUSBDIRECTION_SETUP:
1886	case VUSBDIRECTION_OUT:
1887	default:
1888	pEndPtDesc = pDev->aPipes[pUrb->EndPt].out;
1889	break;
1890	}
1891	if (!pEndPtDesc)
1892	{
1893	Log(("%s: pDev=%p[%s]: SUBMIT: no endpoint!!! dir=%s e=%i\n",
1894	pUrb->pszDesc, pDev, pDev->pUsbIns->pszName, vusbUrbDirName(pUrb->enmDir), pUrb->EndPt));
1895	return vusbUrbSubmitHardError(pUrb);
1896	}
1897
1898	/*
1899	* Check for correct transfer types.
1900	* Our type codes are the same - what a coincidence.
1901	*/
1902	if ((pEndPtDesc->Core.bmAttributes & 0x3) != pUrb->enmType)
1903	{
1904	Log(("%s: pDev=%p[%s]: SUBMIT: %s transfer requested for %#x endpoint on DstAddress=%i ep=%i dir=%s\n",
1905	pUrb->pszDesc, pDev, pDev->pUsbIns->pszName, vusbUrbTypeName(pUrb->enmType), pEndPtDesc->Core.bmAttributes,
1906	pUrb->DstAddress, pUrb->EndPt, vusbUrbDirName(pUrb->enmDir)));
1907	return vusbUrbSubmitHardError(pUrb);
1908	}
1909
1910	/*
1911	* If there's a URB in the read-ahead buffer, use it.
1912	*/
1913	int rc;
1914
1915	if (pDev->hSniffer)
1916	{
1917	rc = VUSBSnifferRecordEvent(pDev->hSniffer, pUrb, VUSBSNIFFEREVENT_SUBMIT);
1918	if (RT_FAILURE(rc))
1919	LogRel(("VUSB: Capturing URB submit event failed with %Rrc\n", rc));
1920	}
1921
1922	#ifdef VBOX_WITH_USB
1923	if (pPipe && pPipe->hReadAhead)
1924	{
1925	rc = vusbUrbSubmitBufferedRead(pUrb, pPipe->hReadAhead);
1926	return rc;
1927	}
1928	#endif
1929
1930	/*
1931	* Take action based on type.
1932	*/
1933	pUrb->enmState = VUSBURBSTATE_IN_FLIGHT;
1934	switch (pUrb->enmType)
1935	{
1936	case VUSBXFERTYPE_CTRL:
1937	rc = vusbUrbSubmitCtrl(pUrb);
1938	break;
1939	case VUSBXFERTYPE_BULK:
1940	rc = vusbUrbSubmitBulk(pUrb);
1941	break;
1942	case VUSBXFERTYPE_INTR:
1943	rc = vusbUrbSubmitInterrupt(pUrb);
1944	break;
1945	case VUSBXFERTYPE_ISOC:
1946	rc = vusbUrbSubmitIsochronous(pUrb);
1947	break;
1948	default:
1949	AssertMsgFailed(("Unexpected pUrb type %d\n", pUrb->enmType));
1950	return vusbUrbSubmitHardError(pUrb);
1951	}
1952
1953	/*
1954	* The device was detached, so we fail everything.
1955	* (We should really detach and destroy the device, but we'll have to wait till Main reacts.)
1956	*/
1957	if (rc == VERR_VUSB_DEVICE_NOT_ATTACHED)
1958	rc = vusbUrbSubmitHardError(pUrb);
1959	/*
1960	* We don't increment error count if async URBs are in flight, in
1961	* this case we just assume we need to throttle back, this also
1962	* makes sure we don't halt bulk endpoints at the wrong time.
1963	*/
1964	else if ( RT_FAILURE(rc)
1965	&& !ASMAtomicReadU32(&pDev->aPipes[pUrb->EndPt].async)
1966	/* && pUrb->enmType == VUSBXFERTYPE_BULK ?? */
1967	&& !vusbUrbErrorRh(pUrb))
1968	{
1969	/* don't retry it anymore. */
1970	pUrb->enmState = VUSBURBSTATE_REAPED;
1971	pUrb->enmStatus = VUSBSTATUS_CRC;
1972	vusbUrbCompletionRh(pUrb);
1973	return VINF_SUCCESS;
1974	}
1975
1976	return rc;
1977	}
1978
1979
1980	/**
1981	* Reap in-flight URBs.
1982	*
1983	* @param pHead Pointer to the head of the URB list.
1984	* @param cMillies Number of milliseconds to block in each reap operation.
1985	* Use 0 to not block at all.
1986	*/
1987	void vusbUrbDoReapAsync(PVUSBURB pHead, RTMSINTERVAL cMillies)
1988	{
1989	PVUSBURB pUrb = pHead;
1990	while (pUrb)
1991	{
1992	vusbUrbAssert(pUrb);
1993	PVUSBURB pUrbNext = pUrb->VUsb.pNext;
1994	PVUSBDEV pDev = pUrb->VUsb.pDev;
1995
1996	/* Don't touch resetting devices - paranoid safety precaution. */
1997	if (vusbDevGetState(pDev) != VUSB_DEVICE_STATE_RESET)
1998	{
1999	/*
2000	* Reap most URBs pending on a single device.
2001	*/
2002	PVUSBURB pRipe;
2003
2004	/**
2005	* This is workaround for race(should be fixed) detach on one EMT thread and frame boundary timer on other
2006	* and leaked URBs (shouldn't be affected by leaked URBs).
2007	*/
2008	Assert(pDev->pUsbIns);
2009	while ( pDev->pUsbIns
2010	&& ((pRipe = pDev->pUsbIns->pReg->pfnUrbReap(pDev->pUsbIns, cMillies)) != NULL))
2011	{
2012	vusbUrbAssert(pRipe);
2013	if (pRipe == pUrbNext)
2014	pUrbNext = pUrbNext->VUsb.pNext;
2015	vusbUrbRipe(pRipe);
2016	}
2017	}
2018
2019	/* next */
2020	pUrb = pUrbNext;
2021	}
2022	}
2023
2024	/**
2025	* Reap URBs on a per device level.
2026	*
2027	* @returns nothing.
2028	* @param pDev The device instance to reap URBs for.
2029	* @param cMillies Number of milliseconds to block in each reap operation.
2030	* Use 0 to not block at all.
2031	*/
2032	void vusbUrbDoReapAsyncDev(PVUSBDEV pDev, RTMSINTERVAL cMillies)
2033	{
2034	Assert(pDev->enmState != VUSB_DEVICE_STATE_RESET);
2035
2036	/*
2037	* Reap most URBs pending on a single device.
2038	*/
2039	PVUSBURB pRipe;
2040
2041	/**
2042	* This is workaround for race(should be fixed) detach on one EMT thread and frame boundary timer on other
2043	* and leaked URBs (shouldn't be affected by leaked URBs).
2044	*/
2045
2046	if (ASMAtomicXchgBool(&pDev->fWokenUp, false))
2047	return;
2048
2049	Assert(pDev->pUsbIns);
2050	while ( pDev->pUsbIns
2051	&& ((pRipe = pDev->pUsbIns->pReg->pfnUrbReap(pDev->pUsbIns, cMillies)) != NULL))
2052	{
2053	vusbUrbAssert(pRipe);
2054	vusbUrbRipe(pRipe);
2055	if (ASMAtomicXchgBool(&pDev->fWokenUp, false))
2056	break;
2057	}
2058	}
2059
2060	/**
2061	* Completes the URB.
2062	*/
2063	static void vusbUrbCompletion(PVUSBURB pUrb)
2064	{
2065	Assert(pUrb->VUsb.pDev->aPipes);
2066	ASMAtomicDecU32(&pUrb->VUsb.pDev->aPipes[pUrb->EndPt].async);
2067
2068	if (pUrb->enmState == VUSBURBSTATE_REAPED)
2069	vusbUrbUnlink(pUrb);
2070	#ifdef VBOX_WITH_USB
2071	// Read-ahead URBs are handled differently
2072	if (pUrb->Hci.pNext != NULL)
2073	vusbUrbCompletionReadAhead(pUrb);
2074	else
2075	#endif
2076	vusbUrbCompletionRh(pUrb);
2077	}
2078
2079	/**
2080	* The worker for vusbUrbCancel() which is executed on the I/O thread.
2081	*
2082	* @returns nothing.
2083	* @param pUrb The URB to cancel.
2084	* @param enmMode The way the URB should be canceled.
2085	*/
2086	DECLHIDDEN(void) vusbUrbCancelWorker(PVUSBURB pUrb, CANCELMODE enmMode)
2087	{
2088	vusbUrbAssert(pUrb);
2089	#ifdef VBOX_WITH_STATISTICS
2090	PVUSBROOTHUB pRh = vusbDevGetRh(pUrb->VUsb.pDev);
2091	#endif
2092	if (pUrb->enmState == VUSBURBSTATE_IN_FLIGHT)
2093	{
2094	LogFlow(("%s: vusbUrbCancel: Canceling in-flight\n", pUrb->pszDesc));
2095	STAM_COUNTER_INC(&pRh->Total.StatUrbsCancelled);
2096	if (pUrb->enmType != VUSBXFERTYPE_MSG)
2097	{
2098	STAM_STATS({Assert(pUrb->enmType >= 0 && pUrb->enmType < (int)RT_ELEMENTS(pRh->aTypes));});
2099	STAM_COUNTER_INC(&pRh->aTypes[pUrb->enmType].StatUrbsCancelled);
2100	}
2101
2102	pUrb->enmState = VUSBURBSTATE_CANCELLED;
2103	PPDMUSBINS pUsbIns = pUrb->pUsbIns;
2104	pUsbIns->pReg->pfnUrbCancel(pUsbIns, pUrb);
2105	Assert(pUrb->enmState == VUSBURBSTATE_CANCELLED \|\| pUrb->enmState == VUSBURBSTATE_REAPED);
2106
2107	pUrb->enmStatus = VUSBSTATUS_CRC;
2108	vusbUrbCompletion(pUrb);
2109	}
2110	else if (pUrb->enmState == VUSBURBSTATE_REAPED)
2111	{
2112	LogFlow(("%s: vusbUrbCancel: Canceling reaped urb\n", pUrb->pszDesc));
2113	STAM_COUNTER_INC(&pRh->Total.StatUrbsCancelled);
2114	if (pUrb->enmType != VUSBXFERTYPE_MSG)
2115	{
2116	STAM_STATS({Assert(pUrb->enmType >= 0 && pUrb->enmType < (int)RT_ELEMENTS(pRh->aTypes));});
2117	STAM_COUNTER_INC(&pRh->aTypes[pUrb->enmType].StatUrbsCancelled);
2118	}
2119
2120	pUrb->enmStatus = VUSBSTATUS_CRC;
2121	vusbUrbCompletion(pUrb);
2122	}
2123	else
2124	{
2125	AssertMsg(pUrb->enmState == VUSBURBSTATE_CANCELLED, ("Invalid state %d, pUrb=%p\n", pUrb->enmState, pUrb));
2126	switch (enmMode)
2127	{
2128	default:
2129	AssertMsgFailed(("Invalid cancel mode\n"));
2130	case CANCELMODE_FAIL:
2131	pUrb->enmStatus = VUSBSTATUS_CRC;
2132	break;
2133	case CANCELMODE_UNDO:
2134	pUrb->enmStatus = VUSBSTATUS_UNDO;
2135	break;
2136
2137	}
2138	}
2139	}
2140
2141	/**
2142	* Cancels an URB with CRC failure.
2143	*
2144	* Cancelling an URB is a tricky thing. The USBProxy backend can not
2145	* all cancel it and we must keep the URB around until it's ripe and
2146	* can be reaped the normal way. However, we must complete the URB
2147	* now, before leaving this function. This is not nice. sigh.
2148	*
2149	* This function will cancel the URB if it's in-flight and complete
2150	* it. The device will in its pfnCancel method be given the chance to
2151	* say that the URB doesn't need reaping and should be unlinked.
2152	*
2153	* An URB which is in the cancel state after pfnCancel will remain in that
2154	* state and in the async list until its reaped. When it's finally reaped
2155	* it will be unlinked and freed without doing any completion.
2156	*
2157	* There are different modes of canceling an URB. When devices are being
2158	* disconnected etc., they will be completed with an error (CRC). However,
2159	* when the HC needs to temporarily halt communication with a device, the
2160	* URB/TD must be left alone if possible.
2161	*
2162	* @param pUrb The URB to cancel.
2163	* @param mode The way the URB should be canceled.
2164	*/
2165	void vusbUrbCancel(PVUSBURB pUrb, CANCELMODE mode)
2166	{
2167	int rc = vusbDevIoThreadExecSync(pUrb->VUsb.pDev, (PFNRT)vusbUrbCancelWorker, 2, pUrb, mode);
2168	AssertRC(rc);
2169	}
2170
2171
2172	/**
2173	* Async version of vusbUrbCancel() - doesn't wait for the cancelling to be complete.
2174	*/
2175	void vusbUrbCancelAsync(PVUSBURB pUrb, CANCELMODE mode)
2176	{
2177	int rc = vusbDevIoThreadExec(pUrb->VUsb.pDev, 0 /* fFlags */, (PFNRT)vusbUrbCancelWorker, 2, pUrb, mode);
2178	AssertRC(rc);
2179	}
2180
2181
2182	/**
2183	* Deals with a ripe URB (i.e. after reaping it).
2184	*
2185	* If an URB is in the reaped or in-flight state, we'll
2186	* complete it. If it's cancelled, we'll simply free it.
2187	* Any other states should never get here.
2188	*
2189	* @param pUrb The URB.
2190	*/
2191	void vusbUrbRipe(PVUSBURB pUrb)
2192	{
2193	if ( pUrb->enmState == VUSBURBSTATE_IN_FLIGHT
2194	\|\| pUrb->enmState == VUSBURBSTATE_REAPED)
2195	{
2196	pUrb->enmState = VUSBURBSTATE_REAPED;
2197	vusbUrbCompletion(pUrb);
2198	}
2199	else if (pUrb->enmState == VUSBURBSTATE_CANCELLED)
2200	{
2201	vusbUrbUnlink(pUrb);
2202	LogFlow(("%s: vusbUrbRipe: Freeing cancelled URB\n", pUrb->pszDesc));
2203	pUrb->VUsb.pfnFree(pUrb);
2204	}
2205	else
2206	AssertMsgFailed(("Invalid URB state %d; %s\n", pUrb->enmState, pUrb->pszDesc));
2207	}
2208
2209
2210	/*
2211	* Local Variables:
2212	* mode: c
2213	* c-file-style: "bsd"
2214	* c-basic-offset: 4
2215	* tab-width: 4
2216	* indent-tabs-mode: s
2217	* End:
2218	*/
2219

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Devices/USB/VUSBUrb.cpp@ 53426

Download in other formats: