vusb.h@ 50449

Last change on this file since 50449 was 50449, checked in by vboxsync, 11 years ago
vusb.h: comment
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 36.0 KB

Line
1	/** @file
2	* VUSB - VirtualBox USB. (DEV,VMM)
3	*/
4
5	/*
6	* Copyright (C) 2006-2012 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef ___VBox_vusb_h
27	#define ___VBox_vusb_h
28
29	#include <VBox/cdefs.h>
30	#include <VBox/types.h>
31
32	#include <iprt/queueatomic.h>
33
34	struct PDMLED;
35
36	RT_C_DECLS_BEGIN
37
38	/** @defgroup grp_vusb VBox USB API
39	* @{
40	*/
41
42	/** @defgroup grp_vusb_std Standard Stuff
43	* @{ */
44
45	/** Frequency of USB bus (from spec). */
46	#define VUSB_BUS_HZ 12000000
47
48
49	/** @name USB Descriptor types (from spec)
50	* @{ */
51	#define VUSB_DT_DEVICE 0x01
52	#define VUSB_DT_CONFIG 0x02
53	#define VUSB_DT_STRING 0x03
54	#define VUSB_DT_INTERFACE 0x04
55	#define VUSB_DT_ENDPOINT 0x05
56	#define VUSB_DT_DEVICE_QUALIFIER 0x06
57	#define VUSB_DT_OTHER_SPEED_CFG 0x07
58	#define VUSB_DT_INTERFACE_POWER 0x08
59	#define VUSB_DT_INTERFACE_ASSOCIATION 0x0B
60	/** @} */
61
62	/** @name USB Descriptor minimum sizes (from spec)
63	* @{ */
64	#define VUSB_DT_DEVICE_MIN_LEN 18
65	#define VUSB_DT_CONFIG_MIN_LEN 9
66	#define VUSB_DT_CONFIG_STRING_MIN_LEN 2
67	#define VUSB_DT_INTERFACE_MIN_LEN 9
68	#define VUSB_DT_ENDPOINT_MIN_LEN 7
69	/** @} */
70
71
72	#pragma pack(1) /* ensure byte packing of the descriptors. */
73
74	/**
75	* USB language id descriptor (from specs).
76	*/
77	typedef struct VUSBDESCLANGID
78	{
79	uint8_t bLength;
80	uint8_t bDescriptorType;
81	} VUSBDESCLANGID;
82	/** Pointer to a USB language id descriptor. */
83	typedef VUSBDESCLANGID *PVUSBDESCLANGID;
84	/** Pointer to a const USB language id descriptor. */
85	typedef const VUSBDESCLANGID *PCVUSBDESCLANGID;
86
87
88	/**
89	* USB string descriptor (from specs).
90	*/
91	typedef struct VUSBDESCSTRING
92	{
93	uint8_t bLength;
94	uint8_t bDescriptorType;
95	} VUSBDESCSTRING;
96	/** Pointer to a USB string descriptor. */
97	typedef VUSBDESCSTRING *PVUSBDESCSTRING;
98	/** Pointer to a const USB string descriptor. */
99	typedef const VUSBDESCSTRING *PCVUSBDESCSTRING;
100
101
102	/**
103	* USB device descriptor (from spec)
104	*/
105	typedef struct VUSBDESCDEVICE
106	{
107	uint8_t bLength;
108	uint8_t bDescriptorType;
109	uint16_t bcdUSB;
110	uint8_t bDeviceClass;
111	uint8_t bDeviceSubClass;
112	uint8_t bDeviceProtocol;
113	uint8_t bMaxPacketSize0;
114	uint16_t idVendor;
115	uint16_t idProduct;
116	uint16_t bcdDevice;
117	uint8_t iManufacturer;
118	uint8_t iProduct;
119	uint8_t iSerialNumber;
120	uint8_t bNumConfigurations;
121	} VUSBDESCDEVICE;
122	/** Pointer to a USB device descriptor. */
123	typedef VUSBDESCDEVICE *PVUSBDESCDEVICE;
124	/** Pointer to a const USB device descriptor. */
125	typedef const VUSBDESCDEVICE *PCVUSBDESCDEVICE;
126
127	/**
128	* USB device qualifier (from spec 9.6.2)
129	*/
130	struct VUSBDEVICEQUALIFIER
131	{
132	uint8_t bLength;
133	uint8_t bDescriptorType;
134	uint16_t bcdUsb;
135	uint8_t bDeviceClass;
136	uint8_t bDeviceSubClass;
137	uint8_t bDeviceProtocol;
138	uint8_t bMaxPacketSize0;
139	uint8_t bNumConfigurations;
140	uint8_t bReserved;
141	};
142
143	typedef struct VUSBDEVICEQUALIFIER VUSBDEVICEQUALIFIER;
144	typedef VUSBDEVICEQUALIFIER *PVUSBDEVICEQUALIFIER;
145
146
147	/**
148	* USB configuration descriptor (from spec).
149	*/
150	typedef struct VUSBDESCCONFIG
151	{
152	uint8_t bLength;
153	uint8_t bDescriptorType;
154	uint16_t wTotalLength; /*< recalculated by VUSB when involved in URB. /
155	uint8_t bNumInterfaces;
156	uint8_t bConfigurationValue;
157	uint8_t iConfiguration;
158	uint8_t bmAttributes;
159	uint8_t MaxPower;
160	} VUSBDESCCONFIG;
161	/** Pointer to a USB configuration descriptor. */
162	typedef VUSBDESCCONFIG *PVUSBDESCCONFIG;
163	/** Pointer to a readonly USB configuration descriptor. */
164	typedef const VUSBDESCCONFIG *PCVUSBDESCCONFIG;
165
166
167	/**
168	* USB interface association descriptor (from USB ECN Interface Association Descriptors)
169	*/
170	typedef struct VUSBDESCIAD
171	{
172	uint8_t bLength;
173	uint8_t bDescriptorType;
174	uint8_t bFirstInterface;
175	uint8_t bInterfaceCount;
176	uint8_t bFunctionClass;
177	uint8_t bFunctionSubClass;
178	uint8_t bFunctionProtocol;
179	uint8_t iFunction;
180	} VUSBDESCIAD;
181	/** Pointer to a USB interface association descriptor. */
182	typedef VUSBDESCIAD *PVUSBDESCIAD;
183	/** Pointer to a readonly USB interface association descriptor. */
184	typedef const VUSBDESCIAD *PCVUSBDESCIAD;
185
186
187	/**
188	* USB interface descriptor (from spec)
189	*/
190	typedef struct VUSBDESCINTERFACE
191	{
192	uint8_t bLength;
193	uint8_t bDescriptorType;
194	uint8_t bInterfaceNumber;
195	uint8_t bAlternateSetting;
196	uint8_t bNumEndpoints;
197	uint8_t bInterfaceClass;
198	uint8_t bInterfaceSubClass;
199	uint8_t bInterfaceProtocol;
200	uint8_t iInterface;
201	} VUSBDESCINTERFACE;
202	/** Pointer to an USB interface descriptor. */
203	typedef VUSBDESCINTERFACE *PVUSBDESCINTERFACE;
204	/** Pointer to a const USB interface descriptor. */
205	typedef const VUSBDESCINTERFACE *PCVUSBDESCINTERFACE;
206
207
208	/**
209	* USB endpoint descriptor (from spec)
210	*/
211	typedef struct VUSBDESCENDPOINT
212	{
213	uint8_t bLength;
214	uint8_t bDescriptorType;
215	uint8_t bEndpointAddress;
216	uint8_t bmAttributes;
217	uint16_t wMaxPacketSize;
218	uint8_t bInterval;
219	} VUSBDESCENDPOINT;
220	/** Pointer to an USB endpoint descriptor. */
221	typedef VUSBDESCENDPOINT *PVUSBDESCENDPOINT;
222	/** Pointer to a const USB endpoint descriptor. */
223	typedef const VUSBDESCENDPOINT *PCVUSBDESCENDPOINT;
224
225	#pragma pack() /* end of the byte packing. */
226
227
228	/**
229	* USB configuration descriptor, the parsed variant used by VUSB.
230	*/
231	typedef struct VUSBDESCCONFIGEX
232	{
233	/** The USB descriptor data.
234	* @remark The wTotalLength member is recalculated before the data is passed to the guest. */
235	VUSBDESCCONFIG Core;
236	/** Pointer to additional descriptor bytes following what's covered by VUSBDESCCONFIG. */
237	void *pvMore;
238	/** Pointer to an array of the interfaces referenced in the configuration.
239	* Core.bNumInterfaces in size. */
240	const struct VUSBINTERFACE *paIfs;
241	/** Pointer to the original descriptor data read from the device. */
242	const void *pvOriginal;
243	} VUSBDESCCONFIGEX;
244	/** Pointer to a parsed USB configuration descriptor. */
245	typedef VUSBDESCCONFIGEX *PVUSBDESCCONFIGEX;
246	/** Pointer to a const parsed USB configuration descriptor. */
247	typedef const VUSBDESCCONFIGEX *PCVUSBDESCCONFIGEX;
248
249
250	/**
251	* For tracking the alternate interface settings of a configuration.
252	*/
253	typedef struct VUSBINTERFACE
254	{
255	/** Pointer to an array of interfaces. */
256	const struct VUSBDESCINTERFACEEX *paSettings;
257	/** The number of entries in the array. */
258	uint32_t cSettings;
259	} VUSBINTERFACE;
260	/** Pointer to a VUSBINTERFACE. */
261	typedef VUSBINTERFACE *PVUSBINTERFACE;
262	/** Pointer to a const VUSBINTERFACE. */
263	typedef const VUSBINTERFACE *PCVUSBINTERFACE;
264
265
266	/**
267	* USB interface descriptor, the parsed variant used by VUSB.
268	*/
269	typedef struct VUSBDESCINTERFACEEX
270	{
271	/** The USB descriptor data. */
272	VUSBDESCINTERFACE Core;
273	/** Pointer to additional descriptor bytes following what's covered by VUSBDESCINTERFACE. */
274	const void *pvMore;
275	/** Pointer to additional class- or vendor-specific interface descriptors. */
276	const void *pvClass;
277	/** Size of class- or vendor-specific descriptors. */
278	uint16_t cbClass;
279	/** Pointer to an array of the endpoints referenced by the interface.
280	* Core.bNumEndpoints in size. */
281	const struct VUSBDESCENDPOINTEX *paEndpoints;
282	/** Interface association descriptor, which prepends a group of interfaces,
283	* starting with this interface. */
284	PCVUSBDESCIAD pIAD;
285	/** Size of interface association descriptor. */
286	uint16_t cbIAD;
287	} VUSBDESCINTERFACEEX;
288	/** Pointer to an prased USB interface descriptor. */
289	typedef VUSBDESCINTERFACEEX *PVUSBDESCINTERFACEEX;
290	/** Pointer to a const parsed USB interface descriptor. */
291	typedef const VUSBDESCINTERFACEEX *PCVUSBDESCINTERFACEEX;
292
293
294	/**
295	* USB endpoint descriptor, the parsed variant used by VUSB.
296	*/
297	typedef struct VUSBDESCENDPOINTEX
298	{
299	/** The USB descriptor data.
300	* @remark The wMaxPacketSize member is converted to native endian. */
301	VUSBDESCENDPOINT Core;
302	/** Pointer to additional descriptor bytes following what's covered by VUSBDESCENDPOINT. */
303	const void *pvMore;
304	/** Pointer to additional class- or vendor-specific interface descriptors. */
305	const void *pvClass;
306	/** Size of class- or vendor-specific descriptors. */
307	uint16_t cbClass;
308	} VUSBDESCENDPOINTEX;
309	/** Pointer to a parsed USB endpoint descriptor. */
310	typedef VUSBDESCENDPOINTEX *PVUSBDESCENDPOINTEX;
311	/** Pointer to a const parsed USB endpoint descriptor. */
312	typedef const VUSBDESCENDPOINTEX *PCVUSBDESCENDPOINTEX;
313
314
315	/** @name USB Control message recipient codes (from spec)
316	* @{ */
317	#define VUSB_TO_DEVICE 0x0
318	#define VUSB_TO_INTERFACE 0x1
319	#define VUSB_TO_ENDPOINT 0x2
320	#define VUSB_TO_OTHER 0x3
321	#define VUSB_RECIP_MASK 0x1f
322	/** @} */
323
324	/** @name USB control pipe setup packet structure (from spec)
325	* @{ */
326	#define VUSB_REQ_SHIFT (5)
327	#define VUSB_REQ_STANDARD (0x0 << VUSB_REQ_SHIFT)
328	#define VUSB_REQ_CLASS (0x1 << VUSB_REQ_SHIFT)
329	#define VUSB_REQ_VENDOR (0x2 << VUSB_REQ_SHIFT)
330	#define VUSB_REQ_RESERVED (0x3 << VUSB_REQ_SHIFT)
331	#define VUSB_REQ_MASK (0x3 << VUSB_REQ_SHIFT)
332	/** @} */
333
334	#define VUSB_DIR_TO_DEVICE 0x00
335	#define VUSB_DIR_TO_HOST 0x80
336	#define VUSB_DIR_MASK 0x80
337
338	/**
339	* USB Setup request (from spec)
340	*/
341	typedef struct vusb_setup
342	{
343	uint8_t bmRequestType;
344	uint8_t bRequest;
345	uint16_t wValue;
346	uint16_t wIndex;
347	uint16_t wLength;
348	} VUSBSETUP;
349	/** Pointer to a setup request. */
350	typedef VUSBSETUP *PVUSBSETUP;
351	/** Pointer to a const setup request. */
352	typedef const VUSBSETUP *PCVUSBSETUP;
353
354	/** @name USB Standard device requests (from spec)
355	* @{ */
356	#define VUSB_REQ_GET_STATUS 0x00
357	#define VUSB_REQ_CLEAR_FEATURE 0x01
358	#define VUSB_REQ_SET_FEATURE 0x03
359	#define VUSB_REQ_SET_ADDRESS 0x05
360	#define VUSB_REQ_GET_DESCRIPTOR 0x06
361	#define VUSB_REQ_SET_DESCRIPTOR 0x07
362	#define VUSB_REQ_GET_CONFIGURATION 0x08
363	#define VUSB_REQ_SET_CONFIGURATION 0x09
364	#define VUSB_REQ_GET_INTERFACE 0x0a
365	#define VUSB_REQ_SET_INTERFACE 0x0b
366	#define VUSB_REQ_SYNCH_FRAME 0x0c
367	#define VUSB_REQ_MAX 0x0d
368	/** @} */
369
370	/** @} / / end of grp_vusb_std */
371
372
373
374	/** @name USB Standard version flags.
375	* @{ */
376	/** Indicates USB 1.1 support. */
377	#define VUSB_STDVER_11 RT_BIT(1)
378	/** Indicates USB 2.0 support. */
379	#define VUSB_STDVER_20 RT_BIT(2)
380	/** @} */
381
382
383	/** Pointer to a VBox USB device interface. */
384	typedef struct VUSBIDEVICE *PVUSBIDEVICE;
385
386	/** Pointer to a VUSB RootHub port interface. */
387	typedef struct VUSBIROOTHUBPORT *PVUSBIROOTHUBPORT;
388
389	/** Pointer to an USB request descriptor. */
390	typedef struct VUSBURB *PVUSBURB;
391
392
393
394	/**
395	* VBox USB port bitmap.
396	*
397	* Bit 0 == Port 0, ... , Bit 127 == Port 127.
398	*/
399	typedef struct VUSBPORTBITMAP
400	{
401	/** 128 bits */
402	char ach[16];
403	} VUSBPORTBITMAP;
404	/** Pointer to a VBox USB port bitmap. */
405	typedef VUSBPORTBITMAP *PVUSBPORTBITMAP;
406
407	#ifndef RDESKTOP
408
409	/**
410	* The VUSB RootHub port interface provided by the HCI (down).
411	* Pair with VUSBIROOTCONNECTOR
412	*/
413	typedef struct VUSBIROOTHUBPORT
414	{
415	/**
416	* Get the number of available ports in the hub.
417	*
418	* @returns The number of ports available.
419	* @param pInterface Pointer to this structure.
420	* @param pAvailable Bitmap indicating the available ports. Set bit == available port.
421	*/
422	DECLR3CALLBACKMEMBER(unsigned, pfnGetAvailablePorts,(PVUSBIROOTHUBPORT pInterface, PVUSBPORTBITMAP pAvailable));
423
424	/**
425	* Gets the supported USB versions.
426	*
427	* @returns The mask of supported USB versions.
428	* @param pInterface Pointer to this structure.
429	*/
430	DECLR3CALLBACKMEMBER(uint32_t, pfnGetUSBVersions,(PVUSBIROOTHUBPORT pInterface));
431
432	/**
433	* A device is being attached to a port in the roothub.
434	*
435	* @param pInterface Pointer to this structure.
436	* @param pDev Pointer to the device being attached.
437	* @param uPort The port number assigned to the device.
438	*/
439	DECLR3CALLBACKMEMBER(int, pfnAttach,(PVUSBIROOTHUBPORT pInterface, PVUSBIDEVICE pDev, unsigned uPort));
440
441	/**
442	* A device is being detached from a port in the roothub.
443	*
444	* @param pInterface Pointer to this structure.
445	* @param pDev Pointer to the device being detached.
446	* @param uPort The port number assigned to the device.
447	*/
448	DECLR3CALLBACKMEMBER(void, pfnDetach,(PVUSBIROOTHUBPORT pInterface, PVUSBIDEVICE pDev, unsigned uPort));
449
450	/**
451	* Reset the root hub.
452	*
453	* @returns VBox status code.
454	* @param pInterface Pointer to this structure.
455	* @param pResetOnLinux Whether or not to do real reset on linux.
456	*/
457	DECLR3CALLBACKMEMBER(int, pfnReset,(PVUSBIROOTHUBPORT pInterface, bool fResetOnLinux));
458
459	/**
460	* Transfer completion callback routine.
461	*
462	* VUSB will call this when a transfer have been completed
463	* in a one or another way.
464	*
465	* @param pInterface Pointer to this structure.
466	* @param pUrb Pointer to the URB in question.
467	*/
468	DECLR3CALLBACKMEMBER(void, pfnXferCompletion,(PVUSBIROOTHUBPORT pInterface, PVUSBURB urb));
469
470	/**
471	* Handle transfer errors.
472	*
473	* VUSB calls this when a transfer attempt failed. This function will respond
474	* indicating whether to retry or complete the URB with failure.
475	*
476	* @returns Retry indicator.
477	* @param pInterface Pointer to this structure.
478	* @param pUrb Pointer to the URB in question.
479	*/
480	DECLR3CALLBACKMEMBER(bool, pfnXferError,(PVUSBIROOTHUBPORT pInterface, PVUSBURB pUrb));
481
482	/** Alignment dummy. */
483	RTR3PTR Alignment;
484
485	} VUSBIROOTHUBPORT;
486	/** VUSBIROOTHUBPORT interface ID. */
487	#define VUSBIROOTHUBPORT_IID "e38e2978-7aa2-4860-94b6-9ef4a066d8a0"
488
489
490	/** Pointer to a VUSB RootHub connector interface. */
491	typedef struct VUSBIROOTHUBCONNECTOR *PVUSBIROOTHUBCONNECTOR;
492	/**
493	* The VUSB RootHub connector interface provided by the VBox USB RootHub driver
494	* (up).
495	* Pair with VUSBIROOTHUBPORT.
496	*/
497	typedef struct VUSBIROOTHUBCONNECTOR
498	{
499	/**
500	* Allocates a new URB for a transfer.
501	*
502	* Either submit using pfnSubmitUrb or free using VUSBUrbFree().
503	*
504	* @returns Pointer to a new URB.
505	* @returns NULL on failure - try again later.
506	* This will not fail if the device wasn't found. We'll fail it
507	* at submit time, since that makes the usage of this api simpler.
508	* @param pInterface Pointer to this struct.
509	* @param DstAddress The destination address of the URB.
510	* @param cbData The amount of data space required.
511	* @param cTds The amount of TD space.
512	*/
513	DECLR3CALLBACKMEMBER(PVUSBURB, pfnNewUrb,(PVUSBIROOTHUBCONNECTOR pInterface, uint8_t DstAddress, uint32_t cbData, uint32_t cTds));
514
515	/**
516	* Submits a URB for transfer.
517	* The transfer will do asynchronously if possible.
518	*
519	* @returns VBox status code.
520	* @param pInterface Pointer to this struct.
521	* @param pUrb Pointer to the URB returned by pfnNewUrb.
522	* The URB will be freed in case of failure.
523	* @param pLed Pointer to USB Status LED
524	*/
525	DECLR3CALLBACKMEMBER(int, pfnSubmitUrb,(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBURB pUrb, struct PDMLED *pLed));
526
527	/**
528	* Call to service asynchronous URB completions in a polling fashion.
529	*
530	* Reaped URBs will be finished by calling the completion callback,
531	* thus there is no return code or input or anything from this function
532	* except for potential state changes elsewhere.
533	*
534	* @returns VINF_SUCCESS if no URBs are pending upon return.
535	* @returns VERR_TIMEOUT if one or more URBs are still in flight upon returning.
536	* @returns Other VBox status code.
537	*
538	* @param pInterface Pointer to this struct.
539	* @param cMillies Number of milliseconds to poll for completion.
540	*/
541	DECLR3CALLBACKMEMBER(void, pfnReapAsyncUrbs,(PVUSBIROOTHUBCONNECTOR pInterface, RTMSINTERVAL cMillies));
542
543	/**
544	* Cancels and completes - with CRC failure - all URBs queued on an endpoint.
545	* This is done in response to guest URB cancellation.
546	*
547	* @returns VBox status code.
548	* @param pInterface Pointer to this struct.
549	* @param pUrb Pointer to a previously submitted URB.
550	*/
551	DECLR3CALLBACKMEMBER(int, pfnCancelUrbsEp,(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBURB pUrb));
552
553	/**
554	* Cancels and completes - with CRC failure - all in-flight async URBs.
555	* This is typically done before saving a state.
556	*
557	* @param pInterface Pointer to this struct.
558	*/
559	DECLR3CALLBACKMEMBER(void, pfnCancelAllUrbs,(PVUSBIROOTHUBCONNECTOR pInterface));
560
561	/**
562	* Attach the device to the root hub.
563	* The device must not be attached to any hub for this call to succeed.
564	*
565	* @returns VBox status code.
566	* @param pInterface Pointer to this struct.
567	* @param pDevice Pointer to the device (interface) attach.
568	*/
569	DECLR3CALLBACKMEMBER(int, pfnAttachDevice,(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBIDEVICE pDevice));
570
571	/**
572	* Detach the device from the root hub.
573	* The device must already be attached for this call to succeed.
574	*
575	* @returns VBox status code.
576	* @param pInterface Pointer to this struct.
577	* @param pDevice Pointer to the device (interface) to detach.
578	*/
579	DECLR3CALLBACKMEMBER(int, pfnDetachDevice,(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBIDEVICE pDevice));
580
581	} VUSBIROOTHUBCONNECTOR;
582	/** VUSBIROOTHUBCONNECTOR interface ID. */
583	#define VUSBIROOTHUBCONNECTOR_IID "d9a90c59-e3ff-4dff-9754-844557c3f7a0"
584
585
586	#ifdef IN_RING3
587	/** @copydoc VUSBIROOTHUBCONNECTOR::pfnNewUrb */
588	DECLINLINE(PVUSBURB) VUSBIRhNewUrb(PVUSBIROOTHUBCONNECTOR pInterface, uint32_t DstAddress, uint32_t cbData, uint32_t cTds)
589	{
590	return pInterface->pfnNewUrb(pInterface, DstAddress, cbData, cTds);
591	}
592
593	/** @copydoc VUSBIROOTHUBCONNECTOR::pfnSubmitUrb */
594	DECLINLINE(int) VUSBIRhSubmitUrb(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBURB pUrb, struct PDMLED *pLed)
595	{
596	return pInterface->pfnSubmitUrb(pInterface, pUrb, pLed);
597	}
598
599	/** @copydoc VUSBIROOTHUBCONNECTOR::pfnReapAsyncUrbs */
600	DECLINLINE(void) VUSBIRhReapAsyncUrbs(PVUSBIROOTHUBCONNECTOR pInterface, RTMSINTERVAL cMillies)
601	{
602	pInterface->pfnReapAsyncUrbs(pInterface, cMillies);
603	}
604
605	/** @copydoc VUSBIROOTHUBCONNECTOR::pfnCancelAllUrbs */
606	DECLINLINE(void) VUSBIRhCancelAllUrbs(PVUSBIROOTHUBCONNECTOR pInterface)
607	{
608	pInterface->pfnCancelAllUrbs(pInterface);
609	}
610
611	/** @copydoc VUSBIROOTHUBCONNECTOR::pfnAttachDevice */
612	DECLINLINE(int) VUSBIRhAttachDevice(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBIDEVICE pDevice)
613	{
614	return pInterface->pfnAttachDevice(pInterface, pDevice);
615	}
616
617	/** @copydoc VUSBIROOTHUBCONNECTOR::pfnDetachDevice */
618	DECLINLINE(int) VUSBIRhDetachDevice(PVUSBIROOTHUBCONNECTOR pInterface, PVUSBIDEVICE pDevice)
619	{
620	return pInterface->pfnDetachDevice(pInterface, pDevice);
621	}
622	#endif /* IN_RING3 */
623
624
625
626	/** Pointer to a Root Hub Configuration Interface. */
627	typedef struct VUSBIRHCONFIG *PVUSBIRHCONFIG;
628	/**
629	* Root Hub Configuration Interface (intended for MAIN).
630	* No interface pair.
631	*/
632	typedef struct VUSBIRHCONFIG
633	{
634	/**
635	* Creates a USB proxy device and attaches it to the root hub.
636	*
637	* @returns VBox status code.
638	* @param pInterface Pointer to the root hub configuration interface structure.
639	* @param pUuid Pointer to the UUID for the new device.
640	* @param fRemote Whether the device must use the VRDP backend.
641	* @param pszAddress OS specific device address.
642	* @param pvBackend An opaque pointer for the backend. Only used by
643	* the VRDP backend so far.
644	*/
645	DECLR3CALLBACKMEMBER(int, pfnCreateProxyDevice,(PVUSBIRHCONFIG pInterface, PCRTUUID pUuid, bool fRemote, const char pszAddress, void pvBackend));
646
647	/**
648	* Removes a USB proxy device from the root hub and destroys it.
649	*
650	* @returns VBox status code.
651	* @param pInterface Pointer to the root hub configuration interface structure.
652	* @param pUuid Pointer to the UUID for the device.
653	*/
654	DECLR3CALLBACKMEMBER(int, pfnDestroyProxyDevice,(PVUSBIRHCONFIG pInterface, PCRTUUID pUuid));
655
656	} VUSBIRHCONFIG;
657	/** VUSBIRHCONFIG interface ID. */
658	#define VUSBIRHCONFIG_IID "c354cd97-e85f-465e-bc12-b58798465f52"
659
660
661	#ifdef IN_RING3
662	/** @copydoc VUSBIRHCONFIG::pfnCreateProxyDevice */
663	DECLINLINE(int) VUSBIRhCreateProxyDevice(PVUSBIRHCONFIG pInterface, PCRTUUID pUuid, bool fRemote, const char pszAddress, void pvBackend)
664	{
665	return pInterface->pfnCreateProxyDevice(pInterface, pUuid, fRemote, pszAddress, pvBackend);
666	}
667
668	/** @copydoc VUSBIRHCONFIG::pfnDestroyProxyDevice */
669	DECLINLINE(int) VUSBIRhDestroyProxyDevice(PVUSBIRHCONFIG pInterface, PCRTUUID pUuid)
670	{
671	return pInterface->pfnDestroyProxyDevice(pInterface, pUuid);
672	}
673	#endif /* IN_RING3 */
674
675	#endif /* ! RDESKTOP */
676
677
678	/**
679	* VUSB device reset completion callback function.
680	* This is called by the reset thread when the reset has been completed.
681	*
682	* @param pDev Pointer to the virtual USB device core.
683	* @param rc The VBox status code of the reset operation.
684	* @param pvUser User specific argument.
685	*
686	* @thread The reset thread or EMT.
687	*/
688	typedef DECLCALLBACK(void) FNVUSBRESETDONE(PVUSBIDEVICE pDevice, int rc, void *pvUser);
689	/** Pointer to a device reset completion callback function (FNUSBRESETDONE). */
690	typedef FNVUSBRESETDONE *PFNVUSBRESETDONE;
691
692	/**
693	* The state of a VUSB Device.
694	*
695	* @remark The order of these states is vital.
696	*/
697	typedef enum VUSBDEVICESTATE
698	{
699	VUSB_DEVICE_STATE_INVALID = 0,
700	VUSB_DEVICE_STATE_DETACHED,
701	VUSB_DEVICE_STATE_ATTACHED,
702	VUSB_DEVICE_STATE_POWERED,
703	VUSB_DEVICE_STATE_DEFAULT,
704	VUSB_DEVICE_STATE_ADDRESS,
705	VUSB_DEVICE_STATE_CONFIGURED,
706	VUSB_DEVICE_STATE_SUSPENDED,
707	/** The device is being reset. Don't mess with it.
708	* Next states: VUSB_DEVICE_STATE_DEFAULT, VUSB_DEVICE_STATE_DESTROYED
709	*/
710	VUSB_DEVICE_STATE_RESET,
711	/** The device has been destroy. */
712	VUSB_DEVICE_STATE_DESTROYED,
713	/** The usual 32-bit hack. */
714	VUSB_DEVICE_STATE_32BIT_HACK = 0x7fffffff
715	} VUSBDEVICESTATE;
716
717	#ifndef RDESKTOP
718
719	/**
720	* USB Device Interface (up).
721	* No interface pair.
722	*/
723	typedef struct VUSBIDEVICE
724	{
725	/**
726	* Resets the device.
727	*
728	* Since a device reset shall take at least 10ms from the guest point of view,
729	* it must be performed asynchronously. We create a thread which performs this
730	* operation and ensures it will take at least 10ms.
731	*
732	* At times - like init - a synchronous reset is required, this can be done
733	* by passing NULL for pfnDone.
734	*
735	* -- internal stuff, move it --
736	* While the device is being reset it is in the VUSB_DEVICE_STATE_RESET state.
737	* On completion it will be in the VUSB_DEVICE_STATE_DEFAULT state if successful,
738	* or in the VUSB_DEVICE_STATE_DETACHED state if the rest failed.
739	* -- internal stuff, move it --
740	*
741	* @returns VBox status code.
742	* @param pInterface Pointer to this structure.
743	* @param fResetOnLinux Set if we can permit a real reset and a potential logical
744	* device reconnect on linux hosts.
745	* @param pfnDone Pointer to the completion routine. If NULL a synchronous
746	* reset is preformed not respecting the 10ms.
747	* @param pvUser User argument to the completion routine.
748	* @param pVM Pointer to the VM handle if callback in EMT is required. (optional)
749	*/
750	DECLR3CALLBACKMEMBER(int, pfnReset,(PVUSBIDEVICE pInterface, bool fResetOnLinux,
751	PFNVUSBRESETDONE pfnDone, void *pvUser, PVM pVM));
752
753	/**
754	* Powers on the device.
755	*
756	* @returns VBox status code.
757	* @param pInterface Pointer to the device interface structure.
758	*/
759	DECLR3CALLBACKMEMBER(int, pfnPowerOn,(PVUSBIDEVICE pInterface));
760
761	/**
762	* Powers off the device.
763	*
764	* @returns VBox status code.
765	* @param pInterface Pointer to the device interface structure.
766	*/
767	DECLR3CALLBACKMEMBER(int, pfnPowerOff,(PVUSBIDEVICE pInterface));
768
769	/**
770	* Get the state of the device.
771	*
772	* @returns Device state.
773	* @param pInterface Pointer to the device interface structure.
774	*/
775	DECLR3CALLBACKMEMBER(VUSBDEVICESTATE, pfnGetState,(PVUSBIDEVICE pInterface));
776
777	/**
778	* Returns whether the device is completely emulated.
779	*
780	* @returns true if the device is fully emulated and doesn't pass through
781	* a host device, false otherwise.
782	* @param pInterface Pointer to the device interface structure.
783	*/
784	DECLR3CALLBACKMEMBER(bool, pfnIsEmulated,(PVUSBIDEVICE pInterface));
785
786	} VUSBIDEVICE;
787	/** VUSBIDEVICE interface ID. */
788	#define VUSBIDEVICE_IID "f3facb2b-edd3-4b5b-b07e-2cc4d52a471e"
789
790
791	#ifdef IN_RING3
792	/**
793	* Resets the device.
794	*
795	* Since a device reset shall take at least 10ms from the guest point of view,
796	* it must be performed asynchronously. We create a thread which performs this
797	* operation and ensures it will take at least 10ms.
798	*
799	* At times - like init - a synchronous reset is required, this can be done
800	* by passing NULL for pfnDone.
801	*
802	* -- internal stuff, move it --
803	* While the device is being reset it is in the VUSB_DEVICE_STATE_RESET state.
804	* On completion it will be in the VUSB_DEVICE_STATE_DEFAULT state if successful,
805	* or in the VUSB_DEVICE_STATE_DETACHED state if the rest failed.
806	* -- internal stuff, move it --
807	*
808	* @returns VBox status code.
809	* @param pInterface Pointer to the device interface structure.
810	* @param fResetOnLinux Set if we can permit a real reset and a potential logical
811	* device reconnect on linux hosts.
812	* @param pfnDone Pointer to the completion routine. If NULL a synchronous
813	* reset is preformed not respecting the 10ms.
814	* @param pvUser User argument to the completion routine.
815	* @param pVM Pointer to the VM handle if callback in EMT is required. (optional)
816	*/
817	DECLINLINE(int) VUSBIDevReset(PVUSBIDEVICE pInterface, bool fResetOnLinux, PFNVUSBRESETDONE pfnDone, void *pvUser, PVM pVM)
818	{
819	return pInterface->pfnReset(pInterface, fResetOnLinux, pfnDone, pvUser, pVM);
820	}
821
822	/**
823	* Powers on the device.
824	*
825	* @returns VBox status code.
826	* @param pInterface Pointer to the device interface structure.
827	*/
828	DECLINLINE(int) VUSBIDevPowerOn(PVUSBIDEVICE pInterface)
829	{
830	return pInterface->pfnPowerOn(pInterface);
831	}
832
833	/**
834	* Powers off the device.
835	*
836	* @returns VBox status code.
837	* @param pInterface Pointer to the device interface structure.
838	*/
839	DECLINLINE(int) VUSBIDevPowerOff(PVUSBIDEVICE pInterface)
840	{
841	return pInterface->pfnPowerOff(pInterface);
842	}
843
844	/**
845	* Get the state of the device.
846	*
847	* @returns Device state.
848	* @param pInterface Pointer to the device interface structure.
849	*/
850	DECLINLINE(VUSBDEVICESTATE) VUSBIDevGetState(PVUSBIDEVICE pInterface)
851	{
852	return pInterface->pfnGetState(pInterface);
853	}
854
855	/**
856	* Returns whether the device is completely emulated.
857	*
858	* @returns true if the device is fully emulated and doesn't pass through
859	* a host device, false otherwise.
860	* @param pInterface Pointer to the device interface structure.
861	*/
862	DECLINLINE(bool) VUSBIDevIsEmulated(PVUSBIDEVICE pInterface)
863	{
864	return pInterface->pfnIsEmulated(pInterface);
865	}
866	#endif /* IN_RING3 */
867
868	#endif /* ! RDESKTOP */
869
870	/** @name URB
871	* @{ */
872
873	/**
874	* VUSB Transfer status codes.
875	*/
876	typedef enum VUSBSTATUS
877	{
878	/** Transer was ok. */
879	VUSBSTATUS_OK = 0,
880	/** Transfer stalled, endpoint halted. */
881	VUSBSTATUS_STALL,
882	/** Device not responding. */
883	VUSBSTATUS_DNR,
884	/** CRC error. */
885	VUSBSTATUS_CRC,
886	/** Data overrun error. */
887	VUSBSTATUS_DATA_UNDERRUN,
888	/** Data overrun error. */
889	VUSBSTATUS_DATA_OVERRUN,
890	/** The isochronous buffer hasn't been touched. */
891	VUSBSTATUS_NOT_ACCESSED,
892	/** Canceled/undone URB (VUSB internal). */
893	VUSBSTATUS_UNDO,
894	/** Invalid status. */
895	VUSBSTATUS_INVALID = 0x7f
896	} VUSBSTATUS;
897
898
899	/**
900	* VUSB Transfer types.
901	*/
902	typedef enum VUSBXFERTYPE
903	{
904	/** Control message. Used to represent a single control transfer. */
905	VUSBXFERTYPE_CTRL = 0,
906	/* Isochronous transfer. */
907	VUSBXFERTYPE_ISOC,
908	/** Bulk transfer. */
909	VUSBXFERTYPE_BULK,
910	/** Interrupt transfer. */
911	VUSBXFERTYPE_INTR,
912	/** Complete control message. Used to represent an entire control message. */
913	VUSBXFERTYPE_MSG,
914	/** Invalid transfer type. */
915	VUSBXFERTYPE_INVALID = 0x7f
916	} VUSBXFERTYPE;
917
918
919	/**
920	* VUSB transfer direction.
921	*/
922	typedef enum VUSBDIRECTION
923	{
924	/** Setup */
925	VUSBDIRECTION_SETUP = 0,
926	#define VUSB_DIRECTION_SETUP VUSBDIRECTION_SETUP
927	/** In - Device to host. */
928	VUSBDIRECTION_IN = 1,
929	#define VUSB_DIRECTION_IN VUSBDIRECTION_IN
930	/** Out - Host to device. */
931	VUSBDIRECTION_OUT = 2,
932	#define VUSB_DIRECTION_OUT VUSBDIRECTION_OUT
933	/** Invalid direction */
934	VUSBDIRECTION_INVALID = 0x7f
935	} VUSBDIRECTION;
936
937	/**
938	* The URB states
939	*/
940	typedef enum VUSBURBSTATE
941	{
942	/** The usual invalid state. */
943	VUSBURBSTATE_INVALID = 0,
944	/** The URB is free, i.e. not in use.
945	* Next state: ALLOCATED */
946	VUSBURBSTATE_FREE,
947	/** The URB is allocated, i.e. being prepared for submission.
948	* Next state: FREE, IN_FLIGHT */
949	VUSBURBSTATE_ALLOCATED,
950	/** The URB is in flight.
951	* Next state: REAPED, CANCELLED */
952	VUSBURBSTATE_IN_FLIGHT,
953	/** The URB has been reaped and is being completed.
954	* Next state: FREE */
955	VUSBURBSTATE_REAPED,
956	/** The URB has been cancelled and is awaiting reaping and immediate freeing.
957	* Next state: FREE */
958	VUSBURBSTATE_CANCELLED,
959	/** The end of the valid states (exclusive). */
960	VUSBURBSTATE_END,
961	/** The usual 32-bit blow up. */
962	VUSBURBSTATE_32BIT_HACK = 0x7fffffff
963	} VUSBURBSTATE;
964
965
966	/**
967	* Information about a isochronous packet.
968	*/
969	typedef struct VUSBURBISOCPKT
970	{
971	/** The size of the packet.
972	* IN: The packet size. I.e. the number of bytes to the next packet or end of buffer.
973	* OUT: The actual size transferred. */
974	uint16_t cb;
975	/** The offset of the packet. (Relative to VUSBURB::abData[0].)
976	* OUT: This can be changed by the USB device if it does some kind of buffer squeezing. */
977	uint16_t off;
978	/** The status of the transfer.
979	* IN: VUSBSTATUS_INVALID
980	* OUT: VUSBSTATUS_INVALID if nothing was done, otherwise the correct status. */
981	VUSBSTATUS enmStatus;
982	} VUSBURBISOCPKT;
983	/** Pointer to a isochronous packet. */
984	typedef VUSBURBISOCPKT *PVUSBURBISOCPTK;
985	/** Pointer to a const isochronous packet. */
986	typedef const VUSBURBISOCPKT *PCVUSBURBISOCPKT;
987
988	/**
989	* Asynchronous USB request descriptor
990	*/
991	typedef struct VUSBURB
992	{
993	/** URB magic value. */
994	uint32_t u32Magic;
995	/** The USR state. */
996	VUSBURBSTATE enmState;
997	/** URB description, can be null. intended for logging. */
998	char *pszDesc;
999
1000	#ifdef RDESKTOP
1001	/** The next URB in rdesktop-vrdp's linked list */
1002	PVUSBURB pNext;
1003	/** The previous URB in rdesktop-vrdp's linked list */
1004	PVUSBURB pPrev;
1005	/** The vrdp handle for the URB */
1006	uint32_t handle;
1007	/** Pointer used to find the usb proxy device */
1008	struct VUSBDEV *pDev;
1009	#endif
1010
1011	/** The VUSB data. */
1012	struct VUSBURBVUSB
1013	{
1014	/** URB chain pointer. */
1015	PVUSBURB pNext;
1016	/** URB chain pointer. */
1017	PVUSBURB *ppPrev;
1018	/** Pointer to the original for control messages. */
1019	PVUSBURB pCtrlUrb;
1020	/** Pointer to the VUSB device.
1021	* This may be NULL if the destination address is invalid. */
1022	struct VUSBDEV *pDev;
1023	/** Sepcific to the pfnFree function. */
1024	void *pvFreeCtx;
1025	/**
1026	* Callback which will free the URB once it's reaped and completed.
1027	* @param pUrb The URB.
1028	*/
1029	DECLCALLBACKMEMBER(void, pfnFree)(PVUSBURB pUrb);
1030	/** Submit timestamp. (logging only) */
1031	uint64_t u64SubmitTS;
1032	/** The allocated data length. */
1033	uint32_t cbDataAllocated;
1034	/** The allocated TD length. */
1035	uint32_t cTdsAllocated;
1036	} VUsb;
1037
1038	/** The host controller data. */
1039	struct VUSBURBHCI
1040	{
1041	/** The endpoint descriptor address. */
1042	RTGCPHYS32 EdAddr;
1043	/** Number of Tds in the array. */
1044	uint32_t cTds;
1045	/** Pointer to an array of TD info items.*/
1046	struct VUSBURBHCITD
1047	{
1048	/** Type of TD (private) */
1049	uint32_t TdType;
1050	/** The address of the */
1051	RTGCPHYS32 TdAddr;
1052	/** A copy of the TD. */
1053	uint32_t TdCopy[16];
1054	} *paTds;
1055	/** URB chain pointer. */
1056	PVUSBURB pNext;
1057	/** When this URB was created.
1058	* (Used for isochronous frames and for logging.) */
1059	uint32_t u32FrameNo;
1060	/** Flag indicating that the TDs have been unlinked. */
1061	bool fUnlinked;
1062	RTQUEUEATOMICITEM QueueItem;
1063	} Hci;
1064
1065	/** The device data. */
1066	struct VUSBURBDEV
1067	{
1068	/** Pointer to private device specific data. */
1069	void *pvPrivate;
1070	/** Used by the device when linking the URB in some list of its own. */
1071	PVUSBURB pNext;
1072	/** Work queue item. */
1073	RTQUEUEATOMICITEM QueueItem;
1074	} Dev;
1075
1076	#ifndef RDESKTOP
1077	/** The USB device instance this belongs to.
1078	* This is NULL if the device address is invalid, in which case this belongs to the hub. */
1079	PPDMUSBINS pUsbIns;
1080	#endif
1081	/** The device address.
1082	* This is set at allocation time. */
1083	uint8_t DstAddress;
1084
1085	/** The endpoint.
1086	* IN: Must be set before submitting the URB.
1087	* @remark This does not have the high bit (direction) set! */
1088	uint8_t EndPt;
1089	/** The transfer type.
1090	* IN: Must be set before submitting the URB. */
1091	VUSBXFERTYPE enmType;
1092	/** The transfer direction.
1093	* IN: Must be set before submitting the URB. */
1094	VUSBDIRECTION enmDir;
1095	/** Indicates whether it is OK to receive/send less data than requested.
1096	* IN: Must be initialized before submitting the URB. */
1097	bool fShortNotOk;
1098	/** The transfer status.
1099	* OUT: This is set when reaping the URB. */
1100	VUSBSTATUS enmStatus;
1101
1102	/** The number of isochronous packets describe in aIsocPkts.
1103	* This is ignored when enmType isn't VUSBXFERTYPE_ISOC. */
1104	uint32_t cIsocPkts;
1105	/** The iso packets within abData.
1106	* This is ignored when enmType isn't VUSBXFERTYPE_ISOC. */
1107	VUSBURBISOCPKT aIsocPkts[8];
1108
1109	/** The message length.
1110	* IN: The amount of data to send / receive - set at allocation time.
1111	* OUT: The amount of data sent / received. */
1112	uint32_t cbData;
1113	/** The message data.
1114	* IN: On host to device transfers, the data to send.
1115	* OUT: On device to host transfers, the data to received.
1116	* This array has actually a size of VUsb.cbDataAllocated, not 8KB! */
1117	uint8_t abData[8*_1K];
1118	} VUSBURB;
1119
1120	/** The magic value of a valid VUSBURB. (Murakami Haruki) */
1121	#define VUSBURB_MAGIC UINT32_C(0x19490112)
1122
1123	/** @} */
1124
1125
1126	/** @} */
1127
1128	RT_C_DECLS_END
1129
1130	#endif

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

source: vbox/trunk/include/VBox/vusb.h@ 50449

Download in other formats: