VUSBUrb.cpp@ 38251

Last change on this file since 38251 was 35346, checked in by vboxsync, 14 years ago
VMM reorg: Moving the public include files from include/VBox to include/VBox/vmm.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 79.2 KB

Line
1	/* $Id: VUSBUrb.cpp 35346 2010-12-27 16:13:13Z vboxsync $ */
2	/** @file
3	* Virtual USB - URBs.
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 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->pDevice
763	&& pDev->pDescCache->pDevice->idVendor == 0x046d
764	&& ( pDev->pDescCache->pDevice->idProduct == 0x8f6
765	\|\| pDev->pDescCache->pDevice->idProduct == 0x8f5
766	\|\| pDev->pDescCache->pDevice->idProduct == 0x8f0)
767	)
768	{
769	pbData = (const uint8_t *)(pSetup + 1);
770	cbData = pUrb->cbData - sizeof(*pSetup);
771
772	if ( pSetup->bRequest == 0x04
773	&& pSetup->wIndex == 0
774	&& (cbData == 1 \|\| cbData == 2))
775	{
776	/* the value */
777	unsigned uVal = pbData[0];
778	if (cbData > 1)
779	uVal \|= (unsigned)pbData[1] << 8;
780
781	const char *pszReg = NULL;
782	switch (pSetup->wValue)
783	{
784	case 0: pszReg = "i2c init"; break;
785	case 0x0423: pszReg = "STV_REG23"; break;
786	case 0x0509: pszReg = "RED something"; break;
787	case 0x050a: pszReg = "GREEN something"; break;
788	case 0x050b: pszReg = "BLUE something"; break;
789	case 0x143f: pszReg = "COMMIT? INIT DONE?"; break;
790	case 0x1440: pszReg = "STV_ISO_ENABLE"; break;
791	case 0x1442: pszReg = uVal & (RT_BIT(7)\|RT_BIT(5)) ? "BUTTON PRESSED" : "BUTTON" ; break;
792	case 0x1443: pszReg = "STV_SCAN_RATE"; break;
793	case 0x1445: pszReg = "LED?"; break;
794	case 0x1500: pszReg = "STV_REG00"; break;
795	case 0x1501: pszReg = "STV_REG01"; break;
796	case 0x1502: pszReg = "STV_REG02"; break;
797	case 0x1503: pszReg = "STV_REG03"; break;
798	case 0x1504: pszReg = "STV_REG04"; break;
799	case 0x15c1: pszReg = "STV_ISO_SIZE"; break;
800	case 0x15c3: pszReg = "STV_Y_CTRL"; break;
801	case 0x1680: pszReg = "STV_X_CTRL"; break;
802	case 0xe00a: pszReg = "ProductId"; break;
803	default: pszReg = "[no clue]"; break;
804	}
805	if (pszReg)
806	Log(("URB: %*s: QUICKCAM: %s %#x (%d) %s '%s' (%#x)\n",
807	s_cchMaxMsg, pszMsg,
808	(pSetup->bmRequestType >> 7) ? "read" : "write", uVal, uVal, (pSetup->bmRequestType >> 7) ? "from" : "to",
809	pszReg, pSetup->wValue));
810	}
811	else if (cbData)
812	Log(("URB: %s: QUICKCAM: Unknown request: bRequest=%#x bmRequestType=%#x wValue=%#x wIndex=%#x: %.Rhxs\n", s_cchMaxMsg, pszMsg,
813	pSetup->bRequest, pSetup->bmRequestType, pSetup->wValue, pSetup->wIndex, cbData, pbData));
814	else
815	Log(("URB: %*s: QUICKCAM: Unknown request: bRequest=%#x bmRequestType=%#x wValue=%#x wIndex=%#x: (no data)\n", s_cchMaxMsg, pszMsg,
816	pSetup->bRequest, pSetup->bmRequestType, pSetup->wValue, pSetup->wIndex));
817	}
818
819	#if 1
820	if ( cbData /** @todo Fix RTStrFormatV to communicate .* so formatter doesn't apply defaults when cbData=0. */
821	&& (fComplete
822	? pUrb->enmDir != VUSBDIRECTION_OUT
823	: pUrb->enmDir == VUSBDIRECTION_OUT))
824	Log3(("%16.*Rhxd\n", cbData, pbData));
825	#endif
826	if (pUrb->enmType == VUSBXFERTYPE_MSG && pUrb->VUsb.pCtrlUrb)
827	vusbUrbTrace(pUrb->VUsb.pCtrlUrb, "NESTED MSG", fComplete);
828	}
829	#endif /* LOG_ENABLED */
830
831
832	/**
833	* Complete a SETUP stage URB.
834	*
835	* This is used both for dev2host and host2dev kind of transfers.
836	* It is used by both the sync and async control paths.
837	*/
838	static void vusbMsgSetupCompletion(PVUSBURB pUrb)
839	{
840	PVUSBDEV pDev = pUrb->VUsb.pDev;
841	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
842	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
843	PVUSBSETUP pSetup = pExtra->pMsg;
844
845	LogFlow(("%s: vusbMsgSetupCompletion: cbData=%d wLength=%#x cbLeft=%d pPipe=%p stage %s->DATA\n",
846	pUrb->pszDesc, pUrb->cbData, pSetup->wLength, pExtra->cbLeft, pPipe, g_apszCtlStates[pExtra->enmStage])); NOREF(pSetup);
847	pExtra->enmStage = CTLSTAGE_DATA;
848	pUrb->enmStatus = VUSBSTATUS_OK;
849	}
850
851	/**
852	* Complete a DATA stage URB.
853	*
854	* This is used both for dev2host and host2dev kind of transfers.
855	* It is used by both the sync and async control paths.
856	*/
857	static void vusbMsgDataCompletion(PVUSBURB pUrb)
858	{
859	PVUSBDEV pDev = pUrb->VUsb.pDev;
860	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
861	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
862	PVUSBSETUP pSetup = pExtra->pMsg;
863
864	LogFlow(("%s: vusbMsgDataCompletion: cbData=%d wLength=%#x cbLeft=%d pPipe=%p stage DATA\n",
865	pUrb->pszDesc, pUrb->cbData, pSetup->wLength, pExtra->cbLeft, pPipe)); NOREF(pSetup);
866
867	pUrb->enmStatus = VUSBSTATUS_OK;
868	}
869
870	/**
871	* Complete a STATUS stage URB.
872	*
873	* This is used both for dev2host and host2dev kind of transfers.
874	* It is used by both the sync and async control paths.
875	*/
876	static void vusbMsgStatusCompletion(PVUSBURB pUrb)
877	{
878	PVUSBDEV pDev = pUrb->VUsb.pDev;
879	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
880	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
881
882	if (pExtra->fOk)
883	{
884	/*
885	* vusbDevStdReqSetAddress requests are deferred.
886	*/
887	if (pDev->u8NewAddress != VUSB_INVALID_ADDRESS)
888	{
889	vusbDevSetAddress(pDev, pDev->u8NewAddress);
890	pDev->u8NewAddress = VUSB_INVALID_ADDRESS;
891	}
892
893	LogFlow(("%s: vusbMsgStatusCompletion: pDev=%p[%s] pPipe=%p err=OK stage %s->SETUP\n",
894	pUrb->pszDesc, pDev, pDev->pUsbIns->pszName, pPipe, g_apszCtlStates[pExtra->enmStage]));
895	pUrb->enmStatus = VUSBSTATUS_OK;
896	}
897	else
898	{
899	LogFlow(("%s: vusbMsgStatusCompletion: pDev=%p[%s] pPipe=%p err=STALL stage %s->SETUP\n",
900	pUrb->pszDesc, pDev, pDev->pUsbIns->pszName, pPipe, g_apszCtlStates[pExtra->enmStage]));
901	pUrb->enmStatus = VUSBSTATUS_STALL;
902	}
903
904	/*
905	* Done with this message sequence.
906	*/
907	pExtra->pbCur = NULL;
908	pExtra->enmStage = CTLSTAGE_SETUP;
909	}
910
911	/**
912	* This is a worker function for vusbMsgCompletion and
913	* vusbMsgSubmitSynchronously used to complete the original URB.
914	*
915	* @param pUrb The URB originating from the HCI.
916	*/
917	static void vusbCtrlCompletion(PVUSBURB pUrb)
918	{
919	PVUSBDEV pDev = pUrb->VUsb.pDev;
920	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
921	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
922	LogFlow(("%s: vusbCtrlCompletion: pDev=%p[%s]\n", pUrb->pszDesc, pDev, pDev->pUsbIns->pszName));
923
924	switch (pExtra->enmStage)
925	{
926	case CTLSTAGE_SETUP:
927	vusbMsgSetupCompletion(pUrb);
928	break;
929	case CTLSTAGE_DATA:
930	vusbMsgDataCompletion(pUrb);
931	break;
932	case CTLSTAGE_STATUS:
933	vusbMsgStatusCompletion(pUrb);
934	break;
935	}
936	vusbUrbCompletionRh(pUrb);
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	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
950
951	#ifdef LOG_ENABLED
952	LogFlow(("%s: vusbMsgCompletion: pDev=%p[%s]\n", pUrb->pszDesc, pDev, pDev->pUsbIns->pszName));
953	vusbUrbTrace(pUrb, "vusbMsgCompletion", true);
954	#endif
955	Assert(&pExtra->Urb == pUrb);
956
957
958	if (pUrb->enmStatus == VUSBSTATUS_OK)
959	pExtra->fOk = true;
960	else
961	pExtra->fOk = false;
962	pExtra->cbLeft = pUrb->cbData - sizeof(VUSBSETUP);
963
964	/*
965	* Complete the original URB.
966	*/
967	PVUSBURB pCtrlUrb = pUrb->VUsb.pCtrlUrb;
968	pCtrlUrb->enmState = VUSBURBSTATE_REAPED;
969	vusbCtrlCompletion(pCtrlUrb);
970
971	/*
972	* 'Free' the message URB, i.e. put it back to the allocated state.
973	*/
974	Assert( pUrb->enmState == VUSBURBSTATE_REAPED
975	\|\| pUrb->enmState == VUSBURBSTATE_CANCELLED);
976	if (pUrb->enmState != VUSBURBSTATE_CANCELLED)
977	pUrb->enmState = VUSBURBSTATE_ALLOCATED;
978	}
979
980	/**
981	* Deal with URB errors, talking thru the RH to the HCI.
982	*
983	* @returns true if it could be retried.
984	* @returns false if it should be completed with failure.
985	* @param pUrb The URB in question.
986	*/
987	static int vusbUrbErrorRh(PVUSBURB pUrb)
988	{
989	PVUSBDEV pDev = pUrb->VUsb.pDev;
990	PVUSBROOTHUB pRh = vusbDevGetRh(pDev);
991	LogFlow(("%s: vusbUrbErrorRh: pDev=%p[%s] rh=%p\n", pUrb->pszDesc, pDev, pDev->pUsbIns ? pDev->pUsbIns->pszName : "", pRh));
992	return pRh->pIRhPort->pfnXferError(pRh->pIRhPort, pUrb);
993	}
994
995	/**
996	* Does URB completion on roothub level.
997	*
998	* @param pUrb The URB to complete.
999	*/
1000	void vusbUrbCompletionRh(PVUSBURB pUrb)
1001	{
1002	LogFlow(("%s: vusbUrbCompletionRh: type=%s status=%s\n",
1003	pUrb->pszDesc, vusbUrbTypeName(pUrb->enmType), vusbUrbStatusName(pUrb->enmStatus)));
1004	AssertMsg( pUrb->enmState == VUSBURBSTATE_REAPED
1005	\|\| pUrb->enmState == VUSBURBSTATE_CANCELLED, ("%d\n", pUrb->enmState));
1006
1007
1008	#ifdef VBOX_WITH_STATISTICS
1009	/*
1010	* Total and per-type submit statistics.
1011	*/
1012	PVUSBROOTHUB pRh = vusbDevGetRh(pUrb->VUsb.pDev);
1013	if (pUrb->enmType != VUSBXFERTYPE_MSG)
1014	{
1015	Assert(pUrb->enmType >= 0 && pUrb->enmType < (int)RT_ELEMENTS(pRh->aTypes));
1016
1017	if ( pUrb->enmStatus == VUSBSTATUS_OK
1018	\|\| pUrb->enmStatus == VUSBSTATUS_DATA_UNDERRUN
1019	\|\| pUrb->enmStatus == VUSBSTATUS_DATA_OVERRUN)
1020	{
1021	if (pUrb->enmType == VUSBXFERTYPE_ISOC)
1022	{
1023	for (unsigned i = 0; i < pUrb->cIsocPkts; i++)
1024	{
1025	const unsigned cb = pUrb->aIsocPkts[i].cb;
1026	if (cb)
1027	{
1028	STAM_COUNTER_ADD(&pRh->Total.StatActBytes, cb);
1029	STAM_COUNTER_ADD(&pRh->aTypes[VUSBXFERTYPE_ISOC].StatActBytes, cb);
1030	STAM_COUNTER_ADD(&pRh->aStatIsocDetails[i].Bytes, cb);
1031	if (pUrb->enmDir == VUSBDIRECTION_IN)
1032	{
1033	STAM_COUNTER_ADD(&pRh->Total.StatActReadBytes, cb);
1034	STAM_COUNTER_ADD(&pRh->aTypes[VUSBXFERTYPE_ISOC].StatActReadBytes, cb);
1035	}
1036	else
1037	{
1038	STAM_COUNTER_ADD(&pRh->Total.StatActWriteBytes, cb);
1039	STAM_COUNTER_ADD(&pRh->aTypes[VUSBXFERTYPE_ISOC].StatActWriteBytes, cb);
1040	}
1041	STAM_COUNTER_INC(&pRh->StatIsocActPkts);
1042	STAM_COUNTER_INC(&pRh->StatIsocActReadPkts);
1043	}
1044	STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].Pkts);
1045	switch (pUrb->aIsocPkts[i].enmStatus)
1046	{
1047	case VUSBSTATUS_OK:
1048	if (cb) STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].Ok);
1049	else STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].Ok0); break;
1050	case VUSBSTATUS_DATA_UNDERRUN:
1051	if (cb) STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].DataUnderrun);
1052	else STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].DataUnderrun0); break;
1053	case VUSBSTATUS_DATA_OVERRUN: STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].DataOverrun); break;
1054	case VUSBSTATUS_NOT_ACCESSED: STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].NotAccessed); break;
1055	default: STAM_COUNTER_INC(&pRh->aStatIsocDetails[i].Misc); break;
1056	}
1057	}
1058	}
1059	else
1060	{
1061	STAM_COUNTER_ADD(&pRh->Total.StatActBytes, pUrb->cbData);
1062	STAM_COUNTER_ADD(&pRh->aTypes[pUrb->enmType].StatActBytes, pUrb->cbData);
1063	if (pUrb->enmDir == VUSBDIRECTION_IN)
1064	{
1065	STAM_COUNTER_ADD(&pRh->Total.StatActReadBytes, pUrb->cbData);
1066	STAM_COUNTER_ADD(&pRh->aTypes[pUrb->enmType].StatActReadBytes, pUrb->cbData);
1067	}
1068	else
1069	{
1070	STAM_COUNTER_ADD(&pRh->Total.StatActWriteBytes, pUrb->cbData);
1071	STAM_COUNTER_ADD(&pRh->aTypes[pUrb->enmType].StatActWriteBytes, pUrb->cbData);
1072	}
1073	}
1074	}
1075	else
1076	{
1077	/* (Note. this also counts the cancelled packets) */
1078	STAM_COUNTER_INC(&pRh->Total.StatUrbsFailed);
1079	STAM_COUNTER_INC(&pRh->aTypes[pUrb->enmType].StatUrbsFailed);
1080	}
1081	}
1082	#endif /* VBOX_WITH_STATISTICS */
1083
1084	/*
1085	* Msg transfers are special virtual transfers associated with
1086	* vusb, not the roothub
1087	*/
1088	switch (pUrb->enmType)
1089	{
1090	case VUSBXFERTYPE_MSG:
1091	vusbMsgCompletion(pUrb);
1092	return;
1093	case VUSBXFERTYPE_ISOC:
1094	/* Don't bother with error callback for isochronous URBs. */
1095	break;
1096
1097	#if 1 /** @todo r=bird: OHCI say "If the Transfer Descriptor is being
1098	* retired because of an error, the Host Controller must update
1099	* the Halt bit of the Endpoint Descriptor."
1100	*
1101	* So, I'll subject all transfertypes to the same halt stuff now. It could
1102	* just happen to fix the logitech disconnect trap in win2k.
1103	*/
1104	default:
1105	#endif
1106	case VUSBXFERTYPE_BULK:
1107	if (pUrb->enmStatus != VUSBSTATUS_OK)
1108	vusbUrbErrorRh(pUrb);
1109	break;
1110	}
1111	#ifdef LOG_ENABLED
1112	vusbUrbTrace(pUrb, "vusbUrbCompletionRh", true);
1113	#endif
1114	#ifndef VBOX_WITH_STATISTICS
1115	PVUSBROOTHUB pRh = vusbDevGetRh(pUrb->VUsb.pDev);
1116	#endif
1117
1118	/** @todo explain why we do this pDev change. */
1119	PVUSBDEV pTmp = pUrb->VUsb.pDev;
1120	pUrb->VUsb.pDev = &pRh->Hub.Dev;
1121	pRh->pIRhPort->pfnXferCompletion(pRh->pIRhPort, pUrb);
1122	pUrb->VUsb.pDev = pTmp;
1123	if (pUrb->enmState == VUSBURBSTATE_REAPED)
1124	{
1125	LogFlow(("%s: vusbUrbCompletionRh: Freeing URB\n", pUrb->pszDesc));
1126	pUrb->VUsb.pfnFree(pUrb);
1127	}
1128	}
1129
1130
1131	/**
1132	* Certain control requests must not ever be forwarded to the device because
1133	* they are required by the vusb core in order to maintain the vusb internal
1134	* data structures.
1135	*/
1136	DECLINLINE(bool) vusbUrbIsRequestSafe(PCVUSBSETUP pSetup, PVUSBURB pUrb)
1137	{
1138	if ((pSetup->bmRequestType & VUSB_REQ_MASK) != VUSB_REQ_STANDARD)
1139	return true;
1140
1141	switch (pSetup->bRequest)
1142	{
1143	case VUSB_REQ_CLEAR_FEATURE:
1144	return pUrb->EndPt != 0 /* not default control pipe */
1145	\|\| pSetup->wValue != 0 /* not ENDPOINT_HALT */
1146	\|\| !pUrb->pUsbIns->pReg->pfnUsbClearHaltedEndpoint; /* not special need for backend */
1147	case VUSB_REQ_SET_ADDRESS:
1148	case VUSB_REQ_SET_CONFIGURATION:
1149	case VUSB_REQ_GET_CONFIGURATION:
1150	case VUSB_REQ_SET_INTERFACE:
1151	case VUSB_REQ_GET_INTERFACE:
1152	return false;
1153
1154	/*
1155	* If the device wishes it, we'll use the cached device and
1156	* configuration descriptors. (We return false when we want to use the
1157	* cache. Yeah, it's a bit weird to read.)
1158	*/
1159	case VUSB_REQ_GET_DESCRIPTOR:
1160	if ( !pUrb->VUsb.pDev->pDescCache->fUseCachedDescriptors
1161	\|\| (pSetup->bmRequestType & VUSB_RECIP_MASK) != VUSB_TO_DEVICE)
1162	return true;
1163	switch (pSetup->wValue >> 8)
1164	{
1165	case VUSB_DT_DEVICE:
1166	case VUSB_DT_CONFIG:
1167	return false;
1168	case VUSB_DT_STRING:
1169	return !pUrb->VUsb.pDev->pDescCache->fUseCachedStringsDescriptors;
1170	default:
1171	return true;
1172	}
1173
1174	default:
1175	return true;
1176	}
1177	}
1178
1179
1180	/**
1181	* Queues an URB for asynchronous transfer.
1182	* A list of asynchronous URBs is kept by the roothub.
1183	*
1184	* @returns VBox status code (from pfnUrbQueue).
1185	* @param pUrb The URB.
1186	*/
1187	int vusbUrbQueueAsyncRh(PVUSBURB pUrb)
1188	{
1189	#ifdef LOG_ENABLED
1190	vusbUrbTrace(pUrb, "vusbUrbQueueAsyncRh", false);
1191	#endif
1192
1193	/* Immediately return in case of error.
1194	* XXX There is still a race: The Rh might vanish after this point! */
1195	PVUSBDEV pDev = pUrb->VUsb.pDev;
1196	PVUSBROOTHUB pRh = vusbDevGetRh(pDev);
1197	if (!pRh)
1198	{
1199	Log(("vusbUrbQueueAsyncRh returning VERR_OBJECT_DESTROYED\n"));
1200	return VERR_OBJECT_DESTROYED;
1201	}
1202
1203	int rc = pUrb->pUsbIns->pReg->pfnUrbQueue(pUrb->pUsbIns, pUrb);
1204	if (RT_FAILURE(rc))
1205	{
1206	LogFlow(("%s: vusbUrbQueueAsyncRh: returns %Rrc (queue_urb)\n", pUrb->pszDesc, rc));
1207	return rc;
1208	}
1209
1210	pDev->aPipes[pUrb->EndPt].async++;
1211
1212	/* Queue the pUrb on the roothub */
1213	RTCritSectEnter(&pRh->CritSect);
1214	pUrb->VUsb.pNext = pRh->pAsyncUrbHead;
1215	if (pRh->pAsyncUrbHead)
1216	pRh->pAsyncUrbHead->VUsb.ppPrev = &pUrb->VUsb.pNext;
1217	pRh->pAsyncUrbHead = pUrb;
1218	pUrb->VUsb.ppPrev = &pRh->pAsyncUrbHead;
1219	RTCritSectLeave(&pRh->CritSect);
1220
1221	return rc;
1222	}
1223
1224
1225	/**
1226	* Send a control message synchronously.
1227	* @return
1228	*/
1229	static void vusbMsgSubmitSynchronously(PVUSBURB pUrb, bool fSafeRequest)
1230	{
1231	PVUSBDEV pDev = pUrb->VUsb.pDev;
1232	Assert(pDev);
1233	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
1234	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
1235	PVUSBSETUP pSetup = pExtra->pMsg;
1236	LogFlow(("%s: vusbMsgSubmitSynchronously: pDev=%p[%s]\n", pUrb->pszDesc, pDev, pDev->pUsbIns ? pDev->pUsbIns->pszName : ""));
1237
1238	uint8_t pbData = (uint8_t )pExtra->pMsg + sizeof(*pSetup);
1239	uint32_t cbData = pSetup->wLength;
1240	bool fOk = false;
1241	if (!fSafeRequest)
1242	fOk = vusbDevStandardRequest(pDev, pUrb->EndPt, pSetup, pbData, &cbData);
1243	else
1244	AssertMsgFailed(("oops\n"));
1245
1246	pUrb->enmState = VUSBURBSTATE_REAPED;
1247	if (fOk)
1248	{
1249	pSetup->wLength = cbData;
1250	pUrb->enmStatus = VUSBSTATUS_OK;
1251	pExtra->fOk = true;
1252	}
1253	else
1254	{
1255	pUrb->enmStatus = VUSBSTATUS_STALL;
1256	pExtra->fOk = false;
1257	}
1258	pExtra->cbLeft = cbData; /* used by IN only */
1259
1260	vusbCtrlCompletion(pUrb);
1261
1262	/*
1263	* 'Free' the message URB, i.e. put it back to the allocated state.
1264	*/
1265	pExtra->Urb.enmState = VUSBURBSTATE_ALLOCATED;
1266	}
1267
1268	/**
1269	* Callback for dealing with device reset.
1270	*/
1271	void vusbMsgResetExtraData(PVUSBCTRLEXTRA pExtra)
1272	{
1273	if (!pExtra)
1274	return;
1275	pExtra->enmStage = CTLSTAGE_SETUP;
1276	if (pExtra->Urb.enmState != VUSBURBSTATE_CANCELLED)
1277	pExtra->Urb.enmState = VUSBURBSTATE_ALLOCATED;
1278	}
1279
1280
1281	/**
1282	* Callback to free a cancelled message URB.
1283	*
1284	* This is yet another place we're we have to performance acrobatics to
1285	* deal with cancelled URBs. sigh.
1286	*
1287	* The deal here is that we never free message URBs since they are integrated
1288	* into the message pipe state. But since cancel can leave URBs unreaped and in
1289	* a state which require them not to be freed, we'll have to do two things.
1290	* First, if a new message URB is processed we'll have to get a new message
1291	* pipe state. Second, we cannot just free the damn state structure because
1292	* that might lead to heap corruption since it might still be in-flight.
1293	*
1294	* The URB embedded into the message pipe control structure will start in an
1295	* ALLOCATED state. When submitted it will be go to the IN-FLIGHT state. When
1296	* reaped it will go from REAPED to ALLOCATED. When completed in the CANCELLED
1297	* state it will remain in that state (as does normal URBs).
1298	*
1299	* If a new message urb comes up while it's in the CANCELLED state, we will
1300	* orphan it and it will be freed here in vusbMsgFreeUrb. We indicate this
1301	* by setting VUsb.pvFreeCtx to NULL.
1302	*
1303	* If we have to free the message state structure because of device destruction,
1304	* configuration changes, or similar, we will orphan the message pipe state in
1305	* the same way by setting VUsb.pvFreeCtx to NULL and let this function free it.
1306	*
1307	* @param pUrb
1308	*/
1309	static DECLCALLBACK(void) vusbMsgFreeUrb(PVUSBURB pUrb)
1310	{
1311	vusbUrbAssert(pUrb);
1312	PVUSBCTRLEXTRA pExtra = (PVUSBCTRLEXTRA)((uint8_t *)pUrb - RT_OFFSETOF(VUSBCTRLEXTRA, Urb));
1313	if ( pUrb->enmState == VUSBURBSTATE_CANCELLED
1314	&& !pUrb->VUsb.pvFreeCtx)
1315	{
1316	LogFlow(("vusbMsgFreeUrb: Freeing orphan: %p (pUrb=%p)\n", pExtra, pUrb));
1317	RTMemFree(pExtra);
1318	}
1319	else
1320	{
1321	Assert(pUrb->VUsb.pvFreeCtx == &pExtra->Urb);
1322	pUrb->enmState = VUSBURBSTATE_ALLOCATED;
1323	}
1324	}
1325
1326	/**
1327	* Frees the extra state data associated with a message pipe.
1328	*
1329	* @param pExtra The data.
1330	*/
1331	void vusbMsgFreeExtraData(PVUSBCTRLEXTRA pExtra)
1332	{
1333	if (!pExtra)
1334	return;
1335	if (pExtra->Urb.enmState != VUSBURBSTATE_CANCELLED)
1336	{
1337	pExtra->Urb.u32Magic = 0;
1338	pExtra->Urb.enmState = VUSBURBSTATE_FREE;
1339	if (pExtra->Urb.pszDesc)
1340	RTStrFree(pExtra->Urb.pszDesc);
1341	RTMemFree(pExtra);
1342	}
1343	else
1344	pExtra->Urb.VUsb.pvFreeCtx = NULL; /* see vusbMsgFreeUrb */
1345	}
1346
1347	/**
1348	* Allocates the extra state data required for a control pipe.
1349	*
1350	* @returns Pointer to the allocated and initialized state data.
1351	* @returns NULL on out of memory condition.
1352	* @param pUrb A URB we can copy default data from.
1353	*/
1354	static PVUSBCTRLEXTRA vusbMsgAllocExtraData(PVUSBURB pUrb)
1355	{
1356	/** @todo reuse these? */
1357	PVUSBCTRLEXTRA pExtra;
1358	const size_t cbMax = sizeof(pExtra->Urb.abData) + sizeof(VUSBSETUP);
1359	pExtra = (PVUSBCTRLEXTRA)RTMemAllocZ(RT_OFFSETOF(VUSBCTRLEXTRA, Urb.abData[cbMax]));
1360	if (pExtra)
1361	{
1362	pExtra->enmStage = CTLSTAGE_SETUP;
1363	//pExtra->fOk = false;
1364	pExtra->pMsg = (PVUSBSETUP)pExtra->Urb.abData;
1365	pExtra->pbCur = (uint8_t *)(pExtra->pMsg + 1);
1366	//pExtra->cbLeft = 0;
1367	pExtra->cbMax = cbMax;
1368
1369	//pExtra->Urb.Dev.pvProxyUrb = NULL;
1370	pExtra->Urb.u32Magic = VUSBURB_MAGIC;
1371	pExtra->Urb.enmState = VUSBURBSTATE_ALLOCATED;
1372	#ifdef LOG_ENABLED
1373	RTStrAPrintf(&pExtra->Urb.pszDesc, "URB %p msg->%p", &pExtra->Urb, pUrb);
1374	#endif
1375	//pExtra->Urb.VUsb.pCtrlUrb = NULL;
1376	//pExtra->Urb.VUsb.pNext = NULL;
1377	//pExtra->Urb.VUsb.ppPrev = NULL;
1378	pExtra->Urb.VUsb.pDev = pUrb->VUsb.pDev;
1379	pExtra->Urb.VUsb.pfnFree = vusbMsgFreeUrb;
1380	pExtra->Urb.VUsb.pvFreeCtx = &pExtra->Urb;
1381	//pExtra->Urb.Hci = {0};
1382	//pExtra->Urb.Dev.pvProxyUrb = NULL;
1383	pExtra->Urb.pUsbIns = pUrb->pUsbIns;
1384	pExtra->Urb.DstAddress = pUrb->DstAddress;
1385	pExtra->Urb.EndPt = pUrb->EndPt;
1386	pExtra->Urb.enmType = VUSBXFERTYPE_MSG;
1387	pExtra->Urb.enmDir = VUSBDIRECTION_INVALID;
1388	//pExtra->Urb.fShortNotOk = false;
1389	pExtra->Urb.enmStatus = VUSBSTATUS_INVALID;
1390	//pExtra->Urb.cbData = 0;
1391	vusbUrbAssert(&pExtra->Urb);
1392	}
1393	return pExtra;
1394	}
1395
1396	/**
1397	* Sets up the message.
1398	*
1399	* The message is associated with the pipe, in what's currently called
1400	* control pipe extra state data (pointed to by pPipe->pCtrl). If this
1401	* is a OUT message, we will no go on collecting data URB. If it's a
1402	* IN message, we'll send it and then queue any incoming data for the
1403	* URBs collecting it.
1404	*
1405	* @returns Success indicator.
1406	*/
1407	static bool vusbMsgSetup(PVUSBPIPE pPipe, const void *pvBuf, uint32_t cbBuf)
1408	{
1409	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
1410	const VUSBSETUP *pSetupIn = (PVUSBSETUP)pvBuf;
1411
1412	/*
1413	* Validate length.
1414	*/
1415	if (cbBuf < sizeof(VUSBSETUP))
1416	{
1417	LogFlow(("vusbMsgSetup: pPipe=%p cbBuf=%u < %u (failure) !!!\n",
1418	pPipe, cbBuf, sizeof(VUSBSETUP)));
1419	return false;
1420	}
1421
1422	/*
1423	* Check if we've got an cancelled message URB. Allocate a new one in that case.
1424	*/
1425	if (pExtra->Urb.enmState == VUSBURBSTATE_CANCELLED)
1426	{
1427	void *pvNew = RTMemDup(pExtra, RT_OFFSETOF(VUSBCTRLEXTRA, Urb.abData[pExtra->cbMax]));
1428	if (!pvNew)
1429	{
1430	Log(("vusbMsgSetup: out of memory!!! cbReq=%u\n", RT_OFFSETOF(VUSBCTRLEXTRA, Urb.abData[pExtra->cbMax])));
1431	return false;
1432	}
1433	pExtra->Urb.VUsb.pvFreeCtx = NULL;
1434	LogFlow(("vusbMsgSetup: Replacing canceled pExtra=%p with %p.\n", pExtra, pvNew));
1435	pPipe->pCtrl = pExtra = (PVUSBCTRLEXTRA)pvNew;
1436	pExtra->pMsg = (PVUSBSETUP)pExtra->Urb.abData;
1437	pExtra->Urb.enmState = VUSBURBSTATE_ALLOCATED;
1438	}
1439
1440	/*
1441	* Check that we've got sufficient space in the message URB.
1442	*/
1443	if (pExtra->cbMax < cbBuf + pSetupIn->wLength)
1444	{
1445	uint32_t cbReq = RT_ALIGN_32(cbBuf + pSetupIn->wLength, 1024);
1446	PVUSBCTRLEXTRA pNew = (PVUSBCTRLEXTRA)RTMemRealloc(pExtra, RT_OFFSETOF(VUSBCTRLEXTRA, Urb.abData[cbReq]));
1447	if (!pNew)
1448	{
1449	Log(("vusbMsgSetup: out of memory!!! cbReq=%u %u\n",
1450	cbReq, RT_OFFSETOF(VUSBCTRLEXTRA, Urb.abData[cbReq])));
1451	return false;
1452	}
1453	if (pExtra != pNew)
1454	{
1455	pNew->pMsg = (PVUSBSETUP)pNew->Urb.abData;
1456	pExtra = pNew;
1457	}
1458	pExtra->cbMax = cbReq;
1459	}
1460	Assert(pExtra->Urb.enmState == VUSBURBSTATE_ALLOCATED);
1461
1462	/*
1463	* Copy the setup data and prepare for data.
1464	*/
1465	PVUSBSETUP pSetup = pExtra->pMsg;
1466	pExtra->fSubmitted = false;
1467	pExtra->Urb.enmState = VUSBURBSTATE_IN_FLIGHT;
1468	pExtra->pbCur = (uint8_t *)(pSetup + 1);
1469	pSetup->bmRequestType = pSetupIn->bmRequestType;
1470	pSetup->bRequest = pSetupIn->bRequest;
1471	pSetup->wValue = RT_LE2H_U16(pSetupIn->wValue);
1472	pSetup->wIndex = RT_LE2H_U16(pSetupIn->wIndex);
1473	pSetup->wLength = RT_LE2H_U16(pSetupIn->wLength);
1474
1475	LogFlow(("vusbMsgSetup(%p,,%d): bmRequestType=%#04x bRequest=%#04x wValue=%#06x wIndex=%#06x wLength=%d\n",
1476	pPipe, cbBuf, pSetup->bmRequestType, pSetup->bRequest, pSetup->wValue, pSetup->wIndex, pSetup->wLength));
1477	return true;
1478	}
1479
1480	/**
1481	* Build the message URB from the given control URB and accompanying message
1482	* pipe state which we grab from the device for the URB.
1483	*
1484	* @param pUrb The URB to submit.
1485	*/
1486	static void vusbMsgDoTransfer(PVUSBURB pUrb, PVUSBSETUP pSetup, PVUSBCTRLEXTRA pExtra, PVUSBPIPE pPipe, PVUSBDEV pDev)
1487	{
1488	/*
1489	* Mark this transfer as sent (cleared at setup time).
1490	*/
1491	Assert(!pExtra->fSubmitted);
1492	pExtra->fSubmitted = true;
1493
1494	/*
1495	* Do we have to do this synchronously?
1496	*/
1497	bool fSafeRequest = vusbUrbIsRequestSafe(pSetup, pUrb);
1498	if (!fSafeRequest)
1499	{
1500	vusbMsgSubmitSynchronously(pUrb, fSafeRequest);
1501	return;
1502	}
1503
1504	/*
1505	* Do it asynchronously.
1506	*/
1507	LogFlow(("%s: vusbMsgDoTransfer: ep=%d pMsgUrb=%p pPipe=%p stage=%s\n",
1508	pUrb->pszDesc, pUrb->EndPt, &pExtra->Urb, pPipe, g_apszCtlStates[pExtra->enmStage]));
1509	Assert(pExtra->Urb.enmType == VUSBXFERTYPE_MSG);
1510	Assert(pExtra->Urb.EndPt == pUrb->EndPt);
1511	pExtra->Urb.enmDir = (pSetup->bmRequestType & VUSB_DIR_TO_HOST) ? VUSBDIRECTION_IN : VUSBDIRECTION_OUT;
1512	pExtra->Urb.cbData = pSetup->wLength + sizeof(*pSetup);
1513	pExtra->Urb.VUsb.pCtrlUrb = pUrb;
1514	int rc = vusbUrbQueueAsyncRh(&pExtra->Urb);
1515	if (RT_FAILURE(rc))
1516	{
1517	/*
1518	* If we fail submitting it, will not retry but fail immediately.
1519	*
1520	* This keeps things simple. The host OS will have retried if
1521	* it's a proxied device, and if it's a virtual one it really means
1522	* it if it's failing a control message.
1523	*/
1524	LogFlow(("%s: vusbMsgDoTransfer: failed submitting urb! failing it with %s (rc=%Rrc)!!!\n",
1525	pUrb->pszDesc, rc == VERR_VUSB_DEVICE_NOT_ATTACHED ? "DNR" : "CRC", rc));
1526	pExtra->Urb.enmStatus = rc == VERR_VUSB_DEVICE_NOT_ATTACHED ? VUSBSTATUS_DNR : VUSBSTATUS_CRC;
1527	pExtra->Urb.enmState = VUSBURBSTATE_REAPED;
1528	vusbMsgCompletion(&pExtra->Urb);
1529	}
1530	}
1531
1532	/**
1533	* Fails a URB request with a pipe STALL error.
1534	*
1535	* @returns VINF_SUCCESS indicating that we've completed the URB.
1536	* @param pUrb The URB in question.
1537	*/
1538	static int vusbMsgStall(PVUSBURB pUrb)
1539	{
1540	PVUSBPIPE pPipe = &pUrb->VUsb.pDev->aPipes[pUrb->EndPt];
1541	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
1542	LogFlow(("%s: vusbMsgStall: pPipe=%p err=STALL stage %s->SETUP\n",
1543	pUrb->pszDesc, pPipe, g_apszCtlStates[pExtra->enmStage]));
1544
1545	pExtra->pbCur = NULL;
1546	pExtra->enmStage = CTLSTAGE_SETUP;
1547	pUrb->enmState = VUSBURBSTATE_REAPED;
1548	pUrb->enmStatus = VUSBSTATUS_STALL;
1549	vusbUrbCompletionRh(pUrb);
1550	return VINF_SUCCESS;
1551	}
1552
1553	/**
1554	* Submit a control message.
1555	*
1556	* Here we implement the USB defined traffic that occurs in message pipes
1557	* (aka control endpoints). We want to provide a single function for device
1558	* drivers so that they don't all have to reimplement the usb logic for
1559	* themselves. This means we need to keep a little bit of state information
1560	* because control transfers occur over multiple bus transactions. We may
1561	* also need to buffer data over multiple data stages.
1562	*
1563	* @returns VBox status code.
1564	* @param pUrb The URB to submit.
1565	*/
1566	static int vusbUrbSubmitCtrl(PVUSBURB pUrb)
1567	{
1568	#ifdef LOG_ENABLED
1569	vusbUrbTrace(pUrb, "vusbUrbSubmitCtrl", false);
1570	#endif
1571	PVUSBDEV pDev = pUrb->VUsb.pDev;
1572	PVUSBPIPE pPipe = &pDev->aPipes[pUrb->EndPt];
1573	PVUSBCTRLEXTRA pExtra = pPipe->pCtrl;
1574	if (!pExtra && !(pExtra = pPipe->pCtrl = vusbMsgAllocExtraData(pUrb)))
1575	return VERR_VUSB_NO_URB_MEMORY;
1576	PVUSBSETUP pSetup = pExtra->pMsg;
1577
1578	AssertMsgReturn(!pPipe->async, ("%u\n", pPipe->async), VERR_GENERAL_FAILURE);
1579
1580
1581	/*
1582	* A setup packet always resets the transaction and the
1583	* end of data transmission is signified by change in
1584	* data direction.
1585	*/
1586	if (pUrb->enmDir == VUSBDIRECTION_SETUP)
1587	{
1588	LogFlow(("%s: vusbUrbSubmitCtrl: pPipe=%p state %s->SETUP\n",
1589	pUrb->pszDesc, pPipe, g_apszCtlStates[pExtra->enmStage]));
1590	pExtra->enmStage = CTLSTAGE_SETUP;
1591	}
1592	else if ( pExtra->enmStage == CTLSTAGE_DATA
1593	/* (the STATUS stage direction goes the other way) */
1594	&& !!(pSetup->bmRequestType & VUSB_DIR_TO_HOST) != (pUrb->enmDir == VUSBDIRECTION_IN))
1595	{
1596	LogFlow(("%s: vusbUrbSubmitCtrl: pPipe=%p state %s->STATUS\n",
1597	pUrb->pszDesc, pPipe, g_apszCtlStates[pExtra->enmStage]));
1598	pExtra->enmStage = CTLSTAGE_STATUS;
1599	}
1600
1601	/*
1602	* Act according to the current message stage.
1603	*/
1604	switch (pExtra->enmStage)
1605	{
1606	case CTLSTAGE_SETUP:
1607	/*
1608	* When stall handshake is returned, all subsequent packets
1609	* must generate stall until a setup packet arrives.
1610	*/
1611	if (pUrb->enmDir != VUSBDIRECTION_SETUP)
1612	{
1613	Log(("%s: vusbUrbSubmitCtrl: Stall at setup stage (dir=%#x)!!\n", pUrb->pszDesc, pUrb->enmDir));
1614	return vusbMsgStall(pUrb);
1615	}
1616
1617	/* Store setup details, return DNR if corrupt */
1618	if (!vusbMsgSetup(pPipe, pUrb->abData, pUrb->cbData))
1619	{
1620	pUrb->enmState = VUSBURBSTATE_REAPED;
1621	pUrb->enmStatus = VUSBSTATUS_DNR;
1622	vusbUrbCompletionRh(pUrb);
1623	return VINF_SUCCESS;
1624	}
1625	if (pPipe->pCtrl != pExtra)
1626	{
1627	pExtra = pPipe->pCtrl;
1628	pSetup = pExtra->pMsg;
1629	}
1630
1631	/* pre-buffer our output if it's device-to-host */
1632	if (pSetup->bmRequestType & VUSB_DIR_TO_HOST)
1633	vusbMsgDoTransfer(pUrb, pSetup, pExtra, pPipe, pDev);
1634	else if (pSetup->wLength)
1635	{
1636	LogFlow(("%s: vusbUrbSubmitCtrl: stage=SETUP - to dev: need data\n", pUrb->pszDesc));
1637	pUrb->enmState = VUSBURBSTATE_REAPED;
1638	vusbMsgSetupCompletion(pUrb);
1639	vusbUrbCompletionRh(pUrb);
1640	}
1641	/*
1642	* If there is no DATA stage, we must send it now since there are
1643	* no requirement of a STATUS stage.
1644	*/
1645	else
1646	{
1647	LogFlow(("%s: vusbUrbSubmitCtrl: stage=SETUP - to dev: sending\n", pUrb->pszDesc));
1648	vusbMsgDoTransfer(pUrb, pSetup, pExtra, pPipe, pDev);
1649	}
1650	break;
1651
1652	case CTLSTAGE_DATA:
1653	{
1654	/*
1655	* If a data stage exceeds the target buffer indicated in
1656	* setup return stall, if data stage returns stall there
1657	* will be no status stage.
1658	*/
1659	uint8_t pbData = (uint8_t )(pExtra->pMsg + 1);
1660	if (&pExtra->pbCur[pUrb->cbData] > &pbData[pSetup->wLength])
1661	{
1662	if (!pSetup->wLength) /* happens during iPhone detection with iTunes (correct?) */
1663	{
1664	Log(("%s: vusbUrbSubmitCtrl: pSetup->wLength == 0!! (iPhone)\n", pUrb->pszDesc));
1665	pSetup->wLength = pUrb->cbData;
1666	}
1667
1668	/* Variable length data transfers */
1669	if ( (pSetup->bmRequestType & VUSB_DIR_TO_HOST)
1670	\|\| pSetup->wLength == 0
1671	\|\| (pUrb->cbData % pSetup->wLength) == 0) /* magic which need explaining... */
1672	{
1673	uint8_t *pbEnd = pbData + pSetup->wLength;
1674	int cbLeft = pbEnd - pExtra->pbCur;
1675	LogFlow(("%s: vusbUrbSubmitCtrl: Var DATA, pUrb->cbData %d -> %d\n", pUrb->pszDesc, pUrb->cbData, cbLeft));
1676	pUrb->cbData = cbLeft;
1677	}
1678	else
1679	{
1680	Log(("%s: vusbUrbSubmitCtrl: Stall at data stage!!\n", pUrb->pszDesc));
1681	return vusbMsgStall(pUrb);
1682	}
1683	}
1684
1685	if (pUrb->enmDir == VUSBDIRECTION_IN)
1686	{
1687	/* put data received from the device. */
1688	const uint32_t cbRead = RT_MIN(pUrb->cbData, pExtra->cbLeft);
1689	memcpy(pUrb->abData, pExtra->pbCur, cbRead);
1690
1691	/* advance */
1692	pExtra->pbCur += cbRead;
1693	if (pUrb->cbData == cbRead)
1694	pExtra->cbLeft -= pUrb->cbData;
1695	else
1696	{
1697	/* adjust the pUrb->cbData to reflect the number of bytes containing actual data. */
1698	LogFlow(("%s: vusbUrbSubmitCtrl: adjusting last DATA pUrb->cbData, %d -> %d\n",
1699	pUrb->pszDesc, pUrb->cbData, pExtra->cbLeft));
1700	pUrb->cbData = cbRead;
1701	pExtra->cbLeft = 0;
1702	}
1703	}
1704	else
1705	{
1706	/* get data for sending when completed. */
1707	memcpy(pExtra->pbCur, pUrb->abData, pUrb->cbData);
1708
1709	/* advance */
1710	pExtra->pbCur += pUrb->cbData;
1711
1712	/*
1713	* If we've got the necessary data, we'll send it now since there are
1714	* no requirement of a STATUS stage.
1715	*/
1716	if ( !pExtra->fSubmitted
1717	&& pExtra->pbCur - pbData >= pSetup->wLength)
1718	{
1719	LogFlow(("%s: vusbUrbSubmitCtrl: stage=DATA - to dev: sending\n", pUrb->pszDesc));
1720	vusbMsgDoTransfer(pUrb, pSetup, pExtra, pPipe, pDev);
1721	break;
1722	}
1723	}
1724
1725	pUrb->enmState = VUSBURBSTATE_REAPED;
1726	vusbMsgDataCompletion(pUrb);
1727	vusbUrbCompletionRh(pUrb);
1728	break;
1729	}
1730
1731	case CTLSTAGE_STATUS:
1732	if ( (pSetup->bmRequestType & VUSB_DIR_TO_HOST)
1733	\|\| pExtra->fSubmitted)
1734	{
1735	Assert(pExtra->fSubmitted);
1736	pUrb->enmState = VUSBURBSTATE_REAPED;
1737	vusbMsgStatusCompletion(pUrb);
1738	vusbUrbCompletionRh(pUrb);
1739	}
1740	else
1741	{
1742	LogFlow(("%s: vusbUrbSubmitCtrl: stage=STATUS - to dev: sending\n", pUrb->pszDesc));
1743	vusbMsgDoTransfer(pUrb, pSetup, pExtra, pPipe, pDev);
1744	}
1745	break;
1746	}
1747
1748	return VINF_SUCCESS;
1749	}
1750
1751
1752	/**
1753	* Submit a interrupt URB.
1754	*
1755	* @returns VBox status code.
1756	* @param pUrb The URB to submit.
1757	*/
1758	static int vusbUrbSubmitInterrupt(PVUSBURB pUrb)
1759	{
1760	LogFlow(("%s: vusbUrbSubmitInterrupt: (sync)\n", pUrb->pszDesc));
1761	return vusbUrbQueueAsyncRh(pUrb);
1762	}
1763
1764
1765	/**
1766	* Submit a bulk URB.
1767	*
1768	* @returns VBox status code.
1769	* @param pUrb The URB to submit.
1770	*/
1771	static int vusbUrbSubmitBulk(PVUSBURB pUrb)
1772	{
1773	LogFlow(("%s: vusbUrbSubmitBulk: (async)\n", pUrb->pszDesc));
1774	return vusbUrbQueueAsyncRh(pUrb);
1775	}
1776
1777
1778	/**
1779	* Submit an isochronous URB.
1780	*
1781	* @returns VBox status code.
1782	* @param pUrb The URB to submit.
1783	*/
1784	static int vusbUrbSubmitIsochronous(PVUSBURB pUrb)
1785	{
1786	LogFlow(("%s: vusbUrbSubmitIsochronous: (async)\n", pUrb->pszDesc));
1787	return vusbUrbQueueAsyncRh(pUrb);
1788	}
1789
1790
1791	/**
1792	* Fail a URB with a 'hard-error' sort of error.
1793	*
1794	* @return VINF_SUCCESS (the Urb status indicates the error).
1795	* @param pUrb The URB.
1796	*/
1797	static int vusbUrbSubmitHardError(PVUSBURB pUrb)
1798	{
1799	/* FIXME: Find out the correct return code from the spec */
1800	pUrb->enmState = VUSBURBSTATE_REAPED;
1801	pUrb->enmStatus = VUSBSTATUS_DNR;
1802	vusbUrbCompletionRh(pUrb);
1803	return VINF_SUCCESS;
1804	}
1805
1806
1807	/**
1808	* Submit a URB.
1809	*/
1810	int vusbUrbSubmit(PVUSBURB pUrb)
1811	{
1812	vusbUrbAssert(pUrb);
1813	Assert(pUrb->enmState == VUSBURBSTATE_ALLOCATED);
1814	PVUSBDEV pDev = pUrb->VUsb.pDev;
1815	PVUSBPIPE pPipe = NULL;
1816	Assert(pDev);
1817
1818	/*
1819	* Check that the device is in a valid state.
1820	*/
1821	const VUSBDEVICESTATE enmState = pDev->enmState;
1822	if (enmState == VUSB_DEVICE_STATE_RESET)
1823	{
1824	LogRel(("VUSB: %s: power off ignored, the device is resetting!\n", pDev->pUsbIns->pszName));
1825	pUrb->enmStatus = VUSBSTATUS_DNR;
1826	/* This will postpone the TDs until we're done with the resetting. */
1827	return VERR_VUSB_DEVICE_IS_RESETTING;
1828	}
1829
1830	#ifdef LOG_ENABLED
1831	/* stamp it */
1832	pUrb->VUsb.u64SubmitTS = RTTimeNanoTS();
1833	#endif
1834
1835	/** @todo Check max packet size here too? */
1836
1837	/*
1838	* Validate the pipe.
1839	*/
1840	if (pUrb->EndPt >= VUSB_PIPE_MAX)
1841	{
1842	Log(("%s: pDev=%p[%s]: SUBMIT: ep %i >= %i!!!\n", pUrb->pszDesc, pDev, pDev->pUsbIns->pszName, pUrb->EndPt, VUSB_PIPE_MAX));
1843	return vusbUrbSubmitHardError(pUrb);
1844	}
1845	PCVUSBDESCENDPOINTEX pEndPtDesc;
1846	switch (pUrb->enmDir)
1847	{
1848	case VUSBDIRECTION_IN:
1849	pEndPtDesc = pDev->aPipes[pUrb->EndPt].in;
1850	pPipe = &pDev->aPipes[pUrb->EndPt];
1851	break;
1852	case VUSBDIRECTION_SETUP:
1853	case VUSBDIRECTION_OUT:
1854	default:
1855	pEndPtDesc = pDev->aPipes[pUrb->EndPt].out;
1856	break;
1857	}
1858	if (!pEndPtDesc)
1859	{
1860	Log(("%s: pDev=%p[%s]: SUBMIT: no endpoint!!! dir=%s e=%i\n",
1861	pUrb->pszDesc, pDev, pDev->pUsbIns->pszName, vusbUrbDirName(pUrb->enmDir), pUrb->EndPt));
1862	return vusbUrbSubmitHardError(pUrb);
1863	}
1864
1865	/*
1866	* Check for correct transfer types.
1867	* Our type codes are the same - what a coincidence.
1868	*/
1869	if ((pEndPtDesc->Core.bmAttributes & 0x3) != pUrb->enmType)
1870	{
1871	Log(("%s: pDev=%p[%s]: SUBMIT: %s transfer requested for %#x endpoint on DstAddress=%i ep=%i dir=%s\n",
1872	pUrb->pszDesc, pDev, pDev->pUsbIns->pszName, vusbUrbTypeName(pUrb->enmType), pEndPtDesc->Core.bmAttributes,
1873	pUrb->DstAddress, pUrb->EndPt, vusbUrbDirName(pUrb->enmDir)));
1874	return vusbUrbSubmitHardError(pUrb);
1875	}
1876
1877	/*
1878	* If there's a URB in the read-ahead buffer, use it.
1879	*/
1880	int rc;
1881
1882	#ifdef VBOX_WITH_USB
1883	if (pPipe && pPipe->pBuffUrbHead)
1884	{
1885	rc = vusbUrbSubmitBufferedRead(pUrb, pPipe);
1886	return rc;
1887	}
1888	#endif
1889
1890	/*
1891	* Take action based on type.
1892	*/
1893	pUrb->enmState = VUSBURBSTATE_IN_FLIGHT;
1894	switch (pUrb->enmType)
1895	{
1896	case VUSBXFERTYPE_CTRL:
1897	rc = vusbUrbSubmitCtrl(pUrb);
1898	break;
1899	case VUSBXFERTYPE_BULK:
1900	rc = vusbUrbSubmitBulk(pUrb);
1901	break;
1902	case VUSBXFERTYPE_INTR:
1903	rc = vusbUrbSubmitInterrupt(pUrb);
1904	break;
1905	case VUSBXFERTYPE_ISOC:
1906	rc = vusbUrbSubmitIsochronous(pUrb);
1907	break;
1908	default:
1909	AssertMsgFailed(("Unexpected pUrb type %d\n", pUrb->enmType));
1910	return vusbUrbSubmitHardError(pUrb);
1911	}
1912
1913	/*
1914	* The device was detached, so we fail everything.
1915	* (We should really detach and destroy the device, but we'll have to wait till Main reacts.)
1916	*/
1917	if (rc == VERR_VUSB_DEVICE_NOT_ATTACHED)
1918	rc = vusbUrbSubmitHardError(pUrb);
1919	/*
1920	* We don't increment error count if async URBs are in flight, in
1921	* this case we just assume we need to throttle back, this also
1922	* makes sure we don't halt bulk endpoints at the wrong time.
1923	*/
1924	else if ( RT_FAILURE(rc)
1925	&& !pDev->aPipes[pUrb->EndPt].async
1926	/* && pUrb->enmType == VUSBXFERTYPE_BULK ?? */
1927	&& !vusbUrbErrorRh(pUrb))
1928	{
1929	/* don't retry it anymore. */
1930	pUrb->enmState = VUSBURBSTATE_REAPED;
1931	pUrb->enmStatus = VUSBSTATUS_CRC;
1932	vusbUrbCompletionRh(pUrb);
1933	return VINF_SUCCESS;
1934	}
1935
1936	return rc;
1937	}
1938
1939
1940	/**
1941	* Reap in-flight URBs.
1942	*
1943	* @param pHead Pointer to the head of the URB list.
1944	* @param cMillies Number of milliseconds to block in each reap operation.
1945	* Use 0 to not block at all.
1946	*/
1947	void vusbUrbDoReapAsync(PVUSBURB pHead, RTMSINTERVAL cMillies)
1948	{
1949	PVUSBURB pUrb = pHead;
1950	while (pUrb)
1951	{
1952	vusbUrbAssert(pUrb);
1953	PVUSBURB pUrbNext = pUrb->VUsb.pNext;
1954	PVUSBDEV pDev = pUrb->VUsb.pDev;
1955
1956	/* Don't touch resetting devices - paranoid safety precaution. */
1957	if (pDev->enmState != VUSB_DEVICE_STATE_RESET)
1958	{
1959	/*
1960	* Reap most URBs pending on a single device.
1961	*/
1962	PVUSBURB pRipe;
1963	while ((pRipe = pDev->pUsbIns->pReg->pfnUrbReap(pDev->pUsbIns, cMillies)) != NULL)
1964	{
1965	vusbUrbAssert(pRipe);
1966	if (pRipe == pUrbNext)
1967	pUrbNext = pUrbNext->VUsb.pNext;
1968	vusbUrbRipe(pRipe);
1969	}
1970	}
1971
1972	/* next */
1973	pUrb = pUrbNext;
1974	}
1975	}
1976
1977
1978	/**
1979	* Completes the URB.
1980	*/
1981	static void vusbUrbCompletion(PVUSBURB pUrb)
1982	{
1983	Assert(pUrb->VUsb.pDev->aPipes);
1984	pUrb->VUsb.pDev->aPipes[pUrb->EndPt].async--;
1985
1986	if (pUrb->enmState == VUSBURBSTATE_REAPED)
1987	vusbUrbUnlink(pUrb);
1988	#ifdef VBOX_WITH_USB
1989	// Read-ahead URBs are handled differently
1990	if (pUrb->Hci.pNext != NULL)
1991	vusbUrbCompletionReadAhead(pUrb);
1992	else
1993	#endif
1994	vusbUrbCompletionRh(pUrb);
1995	}
1996
1997
1998	/**
1999	* Cancels an URB with CRC failure.
2000	*
2001	* Cancelling an URB is a tricky thing. The USBProxy backend can not
2002	* all cancel it and we must keep the URB around until it's ripe and
2003	* can be reaped the normal way. However, we must complete the URB
2004	* now, before leaving this function. This is not nice. sigh.
2005	*
2006	* This function will cancel the URB if it's in-flight and complete
2007	* it. The device will in its pfnCancel method be given the chance to
2008	* say that the URB doesn't need reaping and should be unlinked.
2009	*
2010	* An URB which is in the cancel state after pfnCancel will remain in that
2011	* state and in the async list until its reaped. When it's finally reaped
2012	* it will be unlinked and freed without doing any completion.
2013	*
2014	* There are different modes of canceling an URB. When devices are being
2015	* disconnected etc., they will be completed with an error (CRC). However,
2016	* when the HC needs to temporarily halt communication with a device, the
2017	* URB/TD must be left alone if possible.
2018	*
2019	* @param pUrb The URB to cancel.
2020	* @param mode The way the URB should be canceled.
2021	*/
2022	void vusbUrbCancel(PVUSBURB pUrb, CANCELMODE mode)
2023	{
2024	vusbUrbAssert(pUrb);
2025	#ifdef VBOX_WITH_STATISTICS
2026	PVUSBROOTHUB pRh = vusbDevGetRh(pUrb->VUsb.pDev);
2027	#endif
2028	if (pUrb->enmState == VUSBURBSTATE_IN_FLIGHT)
2029	{
2030	LogFlow(("%s: vusbUrbCancel: Canceling in-flight\n", pUrb->pszDesc));
2031	STAM_COUNTER_INC(&pRh->Total.StatUrbsCancelled);
2032	if (pUrb->enmType != VUSBXFERTYPE_MSG)
2033	{
2034	STAM_STATS({Assert(pUrb->enmType >= 0 && pUrb->enmType < (int)RT_ELEMENTS(pRh->aTypes));});
2035	STAM_COUNTER_INC(&pRh->aTypes[pUrb->enmType].StatUrbsCancelled);
2036	}
2037
2038	pUrb->enmState = VUSBURBSTATE_CANCELLED;
2039	PPDMUSBINS pUsbIns = pUrb->pUsbIns;
2040	pUsbIns->pReg->pfnUrbCancel(pUsbIns, pUrb);
2041	Assert(pUrb->enmState == VUSBURBSTATE_CANCELLED \|\| pUrb->enmState == VUSBURBSTATE_REAPED);
2042
2043	pUrb->enmStatus = VUSBSTATUS_CRC;
2044	vusbUrbCompletion(pUrb);
2045	}
2046	else if (pUrb->enmState == VUSBURBSTATE_REAPED)
2047	{
2048	LogFlow(("%s: vusbUrbCancel: Canceling reaped urb\n", pUrb->pszDesc));
2049	STAM_COUNTER_INC(&pRh->Total.StatUrbsCancelled);
2050	if (pUrb->enmType != VUSBXFERTYPE_MSG)
2051	{
2052	STAM_STATS({Assert(pUrb->enmType >= 0 && pUrb->enmType < (int)RT_ELEMENTS(pRh->aTypes));});
2053	STAM_COUNTER_INC(&pRh->aTypes[pUrb->enmType].StatUrbsCancelled);
2054	}
2055
2056	pUrb->enmStatus = VUSBSTATUS_CRC;
2057	vusbUrbCompletion(pUrb);
2058	}
2059	else
2060	{
2061	AssertMsg(pUrb->enmState == VUSBURBSTATE_CANCELLED, ("Invalid state %d, pUrb=%p\n", pUrb->enmState, pUrb));
2062	switch (mode)
2063	{
2064	default:
2065	AssertMsgFailed(("Invalid cancel mode\n"));
2066	case CANCELMODE_FAIL:
2067	pUrb->enmStatus = VUSBSTATUS_CRC;
2068	break;
2069	case CANCELMODE_UNDO:
2070	pUrb->enmStatus = VUSBSTATUS_UNDO;
2071	break;
2072
2073	}
2074	}
2075	}
2076
2077
2078	/**
2079	* Deals with a ripe URB (i.e. after reaping it).
2080	*
2081	* If an URB is in the reaped or in-flight state, we'll
2082	* complete it. If it's cancelled, we'll simply free it.
2083	* Any other states should never get here.
2084	*
2085	* @param pUrb The URB.
2086	*/
2087	void vusbUrbRipe(PVUSBURB pUrb)
2088	{
2089	if ( pUrb->enmState == VUSBURBSTATE_IN_FLIGHT
2090	\|\| pUrb->enmState == VUSBURBSTATE_REAPED)
2091	{
2092	pUrb->enmState = VUSBURBSTATE_REAPED;
2093	vusbUrbCompletion(pUrb);
2094	}
2095	else if (pUrb->enmState == VUSBURBSTATE_CANCELLED)
2096	{
2097	vusbUrbUnlink(pUrb);
2098	LogFlow(("%s: vusbUrbRipe: Freeing cancelled URB\n", pUrb->pszDesc));
2099	pUrb->VUsb.pfnFree(pUrb);
2100	}
2101	else
2102	AssertMsgFailed(("Invalid URB state %d; %s\n", pUrb->enmState, pUrb->pszDesc));
2103	}
2104
2105
2106	/*
2107	* Local Variables:
2108	* mode: c
2109	* c-file-style: "bsd"
2110	* c-basic-offset: 4
2111	* tab-width: 4
2112	* indent-tabs-mode: s
2113	* End:
2114	*/
2115

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

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

Download in other formats: