vusb.h@ 36528

Last change on this file since 36528 was 36476, checked in by vboxsync, 14 years ago
Forgot to commit.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 33.9 KB

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

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

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

Download in other formats: