pdmusb.h@ 44528

Last change on this file since 44528 was 44528, checked in by vboxsync, 12 years ago
header (C) fixes
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 38.1 KB

Line
1	/** @file
2	* PDM - Pluggable Device Manager, USB Devices.
3	*/
4
5	/*
6	* Copyright (C) 2006-2013 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_vmm_pdmusb_h
27	#define ___VBox_vmm_pdmusb_h
28
29	#include <VBox/vmm/pdmqueue.h>
30	#include <VBox/vmm/pdmcritsect.h>
31	#include <VBox/vmm/pdmthread.h>
32	#include <VBox/vmm/pdmifs.h>
33	#include <VBox/vmm/pdmcommon.h>
34	#include <VBox/vmm/tm.h>
35	#include <VBox/vmm/ssm.h>
36	#include <VBox/vmm/cfgm.h>
37	#include <VBox/vmm/dbgf.h>
38	#include <VBox/vmm/mm.h>
39	#include <VBox/err.h>
40	#include <VBox/vusb.h>
41	#include <iprt/stdarg.h>
42
43	RT_C_DECLS_BEGIN
44
45	/** @defgroup grp_pdm_usbdev The USB Devices API
46	* @ingroup grp_pdm
47	* @{
48	*/
49
50
51	/**
52	* A string entry for the USB descriptor cache.
53	*/
54	typedef struct PDMUSBDESCCACHESTRING
55	{
56	/** The string index. */
57	uint8_t idx;
58	/** The UTF-8 representation of the string. */
59	const char *psz;
60	} PDMUSBDESCCACHESTRING;
61	/** Pointer to a const string entry. */
62	typedef PDMUSBDESCCACHESTRING const *PCPDMUSBDESCCACHESTRING;
63
64
65	/**
66	* A language entry for the USB descriptor cache.
67	*/
68	typedef struct PDMUSBDESCCACHELANG
69	{
70	/** The language ID for the strings in this block. */
71	uint16_t idLang;
72	/** The number of strings in the array. */
73	uint16_t cStrings;
74	/** Pointer to an array of associated strings.
75	* This must be sorted in ascending order by string index as a binary lookup
76	* will be performed. */
77	PCPDMUSBDESCCACHESTRING paStrings;
78	} PDMUSBDESCCACHELANG;
79	/** Pointer to a const language entry. */
80	typedef PDMUSBDESCCACHELANG const *PCPDMUSBDESCCACHELANG;
81
82
83	/**
84	* USB descriptor cache.
85	*
86	* This structure is owned by the USB device but provided to the PDM/VUSB layer
87	* thru the PDMUSBREG::pfnGetDescriptorCache method. PDM/VUSB will use the
88	* information here to map addresses to endpoints, perform SET_CONFIGURATION
89	* requests, and optionally perform GET_DESCRIPTOR requests (see flag).
90	*
91	* Currently, only device and configuration descriptors are cached.
92	*/
93	typedef struct PDMUSBDESCCACHE
94	{
95	/** USB device descriptor */
96	PCVUSBDESCDEVICE pDevice;
97	/** USB Descriptor arrays (pDev->bNumConfigurations) */
98	PCVUSBDESCCONFIGEX paConfigs;
99	/** Language IDs and their associated strings.
100	* This must be sorted in ascending order by language ID as a binary lookup
101	* will be used. */
102	PCPDMUSBDESCCACHELANG paLanguages;
103	/** The number of entries in the array pointed to by paLanguages. */
104	uint16_t cLanguages;
105	/** Use the cached descriptors for GET_DESCRIPTOR requests. */
106	bool fUseCachedDescriptors;
107	/** Use the cached string descriptors. */
108	bool fUseCachedStringsDescriptors;
109	} PDMUSBDESCCACHE;
110	/** Pointer to an USB descriptor cache. */
111	typedef PDMUSBDESCCACHE *PPDMUSBDESCCACHE;
112	/** Pointer to a const USB descriptor cache. */
113	typedef const PDMUSBDESCCACHE *PCPDMUSBDESCCACHE;
114
115
116	/** PDM Device Flags.
117	* @{ */
118	/** A high-speed capable USB 2.0 device (also required to support full-speed). */
119	#define PDM_USBREG_HIGHSPEED_CAPABLE RT_BIT(0)
120	/** @} */
121
122	/** PDM USB Device Registration Structure,
123	*
124	* This structure is used when registering a device from VBoxUsbRegister() in HC Ring-3.
125	* The PDM will make use of this structure until the VM is destroyed.
126	*/
127	typedef struct PDMUSBREG
128	{
129	/** Structure version. PDM_DEVREG_VERSION defines the current version. */
130	uint32_t u32Version;
131	/** Device name. */
132	char szName[32];
133	/** The description of the device. The UTF-8 string pointed to shall, like this structure,
134	* remain unchanged from registration till VM destruction. */
135	const char *pszDescription;
136
137	/** Flags, combination of the PDM_USBREG_FLAGS_* \#defines. */
138	RTUINT fFlags;
139	/** Maximum number of instances (per VM). */
140	RTUINT cMaxInstances;
141	/** Size of the instance data. */
142	RTUINT cbInstance;
143
144
145	/**
146	* Construct an USB device instance for a VM.
147	*
148	* @returns VBox status.
149	* @param pUsbIns The USB device instance data.
150	* If the registration structure is needed, it will be
151	* accessible thru pUsbDev->pReg.
152	* @param iInstance Instance number. Use this to figure out which registers
153	* and such to use. The instance number is also found in
154	* pUsbDev->iInstance, but since it's likely to be
155	* frequently used PDM passes it as parameter.
156	* @param pCfg Configuration node handle for the device. Use this to
157	* obtain the configuration of the device instance. It is
158	* also found in pUsbDev->pCfg, but since it is primary
159	* usage will in this function it is passed as a parameter.
160	* @param pCfgGlobal Handle to the global device configuration. Also found
161	* in pUsbDev->pCfgGlobal.
162	* @remarks This callback is required.
163	*/
164	DECLR3CALLBACKMEMBER(int, pfnConstruct,(PPDMUSBINS pUsbIns, int iInstance, PCFGMNODE pCfg, PCFGMNODE pCfgGlobal));
165
166	/**
167	* Destruct an USB device instance.
168	*
169	* Most VM resources are freed by the VM. This callback is provided so that any non-VM
170	* resources can be freed correctly.
171	*
172	* This method will be called regardless of the pfnConstruct result to avoid
173	* complicated failure paths.
174	*
175	* @param pUsbIns The USB device instance data.
176	* @remarks Optional.
177	*/
178	DECLR3CALLBACKMEMBER(void, pfnDestruct,(PPDMUSBINS pUsbIns));
179
180
181	/**
182	* Init complete notification.
183	*
184	* This can be done to do communication with other devices and other
185	* initialization which requires everything to be in place.
186	*
187	* @returns VBOX status code.
188	* @param pUsbIns The USB device instance data.
189	* @remarks Optional.
190	* @remarks Not called when hotplugged.
191	*/
192	DECLR3CALLBACKMEMBER(int, pfnVMInitComplete,(PPDMUSBINS pUsbIns));
193
194	/**
195	* VM Power On notification.
196	*
197	* @returns VBox status.
198	* @param pUsbIns The USB device instance data.
199	* @remarks Optional.
200	*/
201	DECLR3CALLBACKMEMBER(void, pfnVMPowerOn,(PPDMUSBINS pUsbIns));
202
203	/**
204	* VM Reset notification.
205	*
206	* @returns VBox status.
207	* @param pUsbIns The USB device instance data.
208	* @remarks Optional.
209	*/
210	DECLR3CALLBACKMEMBER(void, pfnVMReset,(PPDMUSBINS pUsbIns));
211
212	/**
213	* VM Suspend notification.
214	*
215	* @returns VBox status.
216	* @param pUsbIns The USB device instance data.
217	* @remarks Optional.
218	*/
219	DECLR3CALLBACKMEMBER(void, pfnVMSuspend,(PPDMUSBINS pUsbIns));
220
221	/**
222	* VM Resume notification.
223	*
224	* @returns VBox status.
225	* @param pUsbIns The USB device instance data.
226	* @remarks Optional.
227	*/
228	DECLR3CALLBACKMEMBER(void, pfnVMResume,(PPDMUSBINS pUsbIns));
229
230	/**
231	* VM Power Off notification.
232	*
233	* This is only called when the VMR3PowerOff call is made on a running VM. This
234	* means that there is no notification if the VM was suspended before being
235	* powered of. There will also be no callback when hot plugging devices.
236	*
237	* @param pUsbIns The USB device instance data.
238	*/
239	DECLR3CALLBACKMEMBER(void, pfnVMPowerOff,(PPDMUSBINS pUsbIns));
240
241	/**
242	* Called after the constructor when attaching a device at run time.
243	*
244	* This can be used to do tasks normally assigned to pfnInitComplete and/or pfnVMPowerOn.
245	*
246	* @returns VBox status.
247	* @param pUsbIns The USB device instance data.
248	* @remarks Optional.
249	*/
250	DECLR3CALLBACKMEMBER(void, pfnHotPlugged,(PPDMUSBINS pUsbIns));
251
252	/**
253	* Called before the destructor when a device is unplugged at run time.
254	*
255	* This can be used to do tasks normally assigned to pfnVMSuspend and/or pfnVMPowerOff.
256	*
257	* @returns VBox status.
258	* @param pUsbIns The USB device instance data.
259	* @remarks Optional.
260	*/
261	DECLR3CALLBACKMEMBER(void, pfnHotUnplugged,(PPDMUSBINS pUsbIns));
262	/**
263	* Driver Attach command.
264	*
265	* This is called to let the USB device attach to a driver for a specified LUN
266	* at runtime. This is not called during VM construction, the device constructor
267	* have to attach to all the available drivers.
268	*
269	* @returns VBox status code.
270	* @param pUsbIns The USB device instance data.
271	* @param iLUN The logical unit which is being detached.
272	* @remarks Optional.
273	*/
274	DECLR3CALLBACKMEMBER(int, pfnDriverAttach,(PPDMUSBINS pUsbIns, unsigned iLUN));
275
276	/**
277	* Driver Detach notification.
278	*
279	* This is called when a driver is detaching itself from a LUN of the device.
280	* The device should adjust it's state to reflect this.
281	*
282	* @param pUsbIns The USB device instance data.
283	* @param iLUN The logical unit which is being detached.
284	* @remarks Optional.
285	*/
286	DECLR3CALLBACKMEMBER(void, pfnDriverDetach,(PPDMUSBINS pUsbIns, unsigned iLUN));
287
288	/**
289	* Query the base interface of a logical unit.
290	*
291	* @returns VBOX status code.
292	* @param pUsbIns The USB device instance data.
293	* @param iLUN The logicial unit to query.
294	* @param ppBase Where to store the pointer to the base interface of the LUN.
295	* @remarks Optional.
296	*/
297	DECLR3CALLBACKMEMBER(int, pfnQueryInterface,(PPDMUSBINS pUsbIns, unsigned iLUN, PPDMIBASE *ppBase));
298
299	/**
300	* Requests the USB device to reset.
301	*
302	* @returns VBox status code.
303	* @param pUsbIns The USB device instance.
304	* @param fResetOnLinux A hint to the usb proxy.
305	* Don't use this unless you're the linux proxy device.
306	* @thread Any thread.
307	* @remarks Optional.
308	*/
309	DECLR3CALLBACKMEMBER(int, pfnUsbReset,(PPDMUSBINS pUsbIns, bool fResetOnLinux));
310
311	/**
312	* Query device and configuration descriptors for the caching and servicing
313	* relevant GET_DESCRIPTOR requests.
314	*
315	* @returns Pointer to the descriptor cache (read-only).
316	* @param pUsbIns The USB device instance.
317	* @remarks Mandatory.
318	*/
319	DECLR3CALLBACKMEMBER(PCPDMUSBDESCCACHE, pfnUsbGetDescriptorCache,(PPDMUSBINS pUsbIns));
320
321	/**
322	* SET_CONFIGURATION request.
323	*
324	* @returns VBox status code.
325	* @param pUsbIns The USB device instance.
326	* @param bConfigurationValue The bConfigurationValue of the new configuration.
327	* @param pvOldCfgDesc Internal - for the device proxy.
328	* @param pvOldIfState Internal - for the device proxy.
329	* @param pvNewCfgDesc Internal - for the device proxy.
330	* @remarks Optional.
331	*/
332	DECLR3CALLBACKMEMBER(int, pfnUsbSetConfiguration,(PPDMUSBINS pUsbIns, uint8_t bConfigurationValue,
333	const void pvOldCfgDesc, const void pvOldIfState, const void *pvNewCfgDesc));
334
335	/**
336	* SET_INTERFACE request.
337	*
338	* @returns VBox status code.
339	* @param pUsbIns The USB device instance.
340	* @param bInterfaceNumber The interface number.
341	* @param bAlternateSetting The alternate setting.
342	* @remarks Optional.
343	*/
344	DECLR3CALLBACKMEMBER(int, pfnUsbSetInterface,(PPDMUSBINS pUsbIns, uint8_t bInterfaceNumber, uint8_t bAlternateSetting));
345
346	/**
347	* Clears the halted state of an endpoint. (Optional)
348	*
349	* This called when VUSB sees a CLEAR_FEATURE(ENDPOINT_HALT) on request
350	* on the zero pipe.
351	*
352	* @returns VBox status code.
353	* @param pUsbIns The USB device instance.
354	* @param uEndpoint The endpoint to clear.
355	* @remarks Optional.
356	*/
357	DECLR3CALLBACKMEMBER(int, pfnUsbClearHaltedEndpoint,(PPDMUSBINS pUsbIns, unsigned uEndpoint));
358
359	/**
360	* Allocates an URB.
361	*
362	* This can be used to make use of shared user/kernel mode buffers.
363	*
364	* @returns VBox status code.
365	* @param pUsbIns The USB device instance.
366	* @param cbData The size of the data buffer.
367	* @param cTds The number of TDs.
368	* @param enmType The type of URB.
369	* @param ppUrb Where to store the allocated URB.
370	* @remarks Optional.
371	* @remarks Not implemented yet.
372	*/
373	DECLR3CALLBACKMEMBER(int, pfnUrbNew,(PPDMUSBINS pUsbIns, size_t cbData, size_t cTds, VUSBXFERTYPE enmType, PVUSBURB *ppUrb));
374
375	/**
376	* Queues an URB for processing.
377	*
378	* @returns VBox status code.
379	* @retval VINF_SUCCESS on success.
380	* @retval VERR_VUSB_DEVICE_NOT_ATTACHED if the device has been disconnected.
381	* @retval VERR_VUSB_FAILED_TO_QUEUE_URB as a general failure kind of thing.
382	* @retval TBD - document new stuff!
383	*
384	* @param pUsbIns The USB device instance.
385	* @param pUrb The URB to process.
386	* @remarks Mandatory.
387	*/
388	DECLR3CALLBACKMEMBER(int, pfnUrbQueue,(PPDMUSBINS pUsbIns, PVUSBURB pUrb));
389
390	/**
391	* Cancels an URB.
392	*
393	* @returns VBox status code.
394	* @param pUsbIns The USB device instance.
395	* @param pUrb The URB to cancel.
396	* @remarks Mandatory.
397	*/
398	DECLR3CALLBACKMEMBER(int, pfnUrbCancel,(PPDMUSBINS pUsbIns, PVUSBURB pUrb));
399
400	/**
401	* Reaps an URB.
402	*
403	* @returns A ripe URB, NULL if none.
404	* @param pUsbIns The USB device instance.
405	* @param cMillies How log to wait for an URB to become ripe.
406	* @remarks Mandatory.
407	*/
408	DECLR3CALLBACKMEMBER(PVUSBURB, pfnUrbReap,(PPDMUSBINS pUsbIns, RTMSINTERVAL cMillies));
409
410
411	/** Just some init precaution. Must be set to PDM_USBREG_VERSION. */
412	uint32_t u32TheEnd;
413	} PDMUSBREG;
414	/** Pointer to a PDM USB Device Structure. */
415	typedef PDMUSBREG *PPDMUSBREG;
416	/** Const pointer to a PDM USB Device Structure. */
417	typedef PDMUSBREG const *PCPDMUSBREG;
418
419	/** Current USBREG version number. */
420	#define PDM_USBREG_VERSION PDM_VERSION_MAKE(0xeeff, 1, 0)
421
422	/** PDM USB Device Flags.
423	* @{ */
424	/* none yet */
425	/** @} */
426
427
428	#ifdef IN_RING3
429
430	/**
431	* PDM USB Device API.
432	*/
433	typedef struct PDMUSBHLP
434	{
435	/** Structure version. PDM_USBHLP_VERSION defines the current version. */
436	uint32_t u32Version;
437
438	/**
439	* Attaches a driver (chain) to the USB device.
440	*
441	* The first call for a LUN this will serve as a registartion of the LUN. The pBaseInterface and
442	* the pszDesc string will be registered with that LUN and kept around for PDMR3QueryUSBDeviceLun().
443	*
444	* @returns VBox status code.
445	* @param pUsbIns The USB device instance.
446	* @param iLun The logical unit to attach.
447	* @param pBaseInterface Pointer to the base interface for that LUN. (device side / down)
448	* @param ppBaseInterface Where to store the pointer to the base interface. (driver side / up)
449	* @param pszDesc Pointer to a string describing the LUN. This string must remain valid
450	* for the live of the device instance.
451	*/
452	DECLR3CALLBACKMEMBER(int, pfnDriverAttach,(PPDMUSBINS pUsbIns, RTUINT iLun, PPDMIBASE pBaseInterface, PPDMIBASE ppBaseInterface, const char pszDesc));
453
454	/**
455	* Assert that the current thread is the emulation thread.
456	*
457	* @returns True if correct.
458	* @returns False if wrong.
459	* @param pUsbIns The USB device instance.
460	* @param pszFile Filename of the assertion location.
461	* @param iLine Linenumber of the assertion location.
462	* @param pszFunction Function of the assertion location.
463	*/
464	DECLR3CALLBACKMEMBER(bool, pfnAssertEMT,(PPDMUSBINS pUsbIns, const char pszFile, unsigned iLine, const char pszFunction));
465
466	/**
467	* Assert that the current thread is NOT the emulation thread.
468	*
469	* @returns True if correct.
470	* @returns False if wrong.
471	* @param pUsbIns The USB device instance.
472	* @param pszFile Filename of the assertion location.
473	* @param iLine Linenumber of the assertion location.
474	* @param pszFunction Function of the assertion location.
475	*/
476	DECLR3CALLBACKMEMBER(bool, pfnAssertOther,(PPDMUSBINS pUsbIns, const char pszFile, unsigned iLine, const char pszFunction));
477
478	/**
479	* Stops the VM and enters the debugger to look at the guest state.
480	*
481	* Use the PDMUsbDBGFStop() inline function with the RT_SRC_POS macro instead of
482	* invoking this function directly.
483	*
484	* @returns VBox status code which must be passed up to the VMM.
485	* @param pUsbIns The USB device instance.
486	* @param pszFile Filename of the assertion location.
487	* @param iLine The linenumber of the assertion location.
488	* @param pszFunction Function of the assertion location.
489	* @param pszFormat Message. (optional)
490	* @param va Message parameters.
491	*/
492	DECLR3CALLBACKMEMBER(int, pfnDBGFStopV,(PPDMUSBINS pUsbIns, const char pszFile, unsigned iLine, const char pszFunction, const char *pszFormat, va_list va));
493
494	/**
495	* Register a info handler with DBGF,
496	*
497	* @returns VBox status code.
498	* @param pUsbIns The USB device instance.
499	* @param pszName The identifier of the info.
500	* @param pszDesc The description of the info and any arguments the handler may take.
501	* @param pfnHandler The handler function to be called to display the info.
502	*/
503	DECLR3CALLBACKMEMBER(int, pfnDBGFInfoRegister,(PPDMUSBINS pUsbIns, const char pszName, const char pszDesc, PFNDBGFHANDLERUSB pfnHandler));
504
505	/**
506	* Allocate memory which is associated with current VM instance
507	* and automatically freed on it's destruction.
508	*
509	* @returns Pointer to allocated memory. The memory is NOT zero-ed.
510	* @param pUsbIns The USB device instance.
511	* @param cb Number of bytes to allocate.
512	*/
513	DECLR3CALLBACKMEMBER(void *, pfnMMHeapAlloc,(PPDMUSBINS pUsbIns, size_t cb));
514
515	/**
516	* Allocate memory which is associated with current VM instance
517	* and automatically freed on it's destruction. The memory is ZEROed.
518	*
519	* @returns Pointer to allocated memory. The memory is NOT zero-ed.
520	* @param pUsbIns The USB device instance.
521	* @param cb Number of bytes to allocate.
522	*/
523	DECLR3CALLBACKMEMBER(void *, pfnMMHeapAllocZ,(PPDMUSBINS pUsbIns, size_t cb));
524
525	/**
526	* Create a queue.
527	*
528	* @returns VBox status code.
529	* @param pUsbIns The USB device instance.
530	* @param cbItem Size a queue item.
531	* @param cItems Number of items in the queue.
532	* @param cMilliesInterval Number of milliseconds between polling the queue.
533	* If 0 then the emulation thread will be notified whenever an item arrives.
534	* @param pfnCallback The consumer function.
535	* @param pszName The queue base name. The instance number will be
536	* appended automatically.
537	* @param ppQueue Where to store the queue handle on success.
538	* @thread The emulation thread.
539	*/
540	DECLR3CALLBACKMEMBER(int, pfnPDMQueueCreate,(PPDMUSBINS pUsbIns, RTUINT cbItem, RTUINT cItems, uint32_t cMilliesInterval,
541	PFNPDMQUEUEUSB pfnCallback, const char pszName, PPDMQUEUE ppQueue));
542
543	/**
544	* Register a save state data unit.
545	*
546	* @returns VBox status.
547	* @param pUsbIns The USB device instance.
548	* @param uVersion Data layout version number.
549	* @param cbGuess The approximate amount of data in the unit.
550	* Only for progress indicators.
551	*
552	* @param pfnLivePrep Prepare live save callback, optional.
553	* @param pfnLiveExec Execute live save callback, optional.
554	* @param pfnLiveVote Vote live save callback, optional.
555	*
556	* @param pfnSavePrep Prepare save callback, optional.
557	* @param pfnSaveExec Execute save callback, optional.
558	* @param pfnSaveDone Done save callback, optional.
559	*
560	* @param pfnLoadPrep Prepare load callback, optional.
561	* @param pfnLoadExec Execute load callback, optional.
562	* @param pfnLoadDone Done load callback, optional.
563	*/
564	DECLR3CALLBACKMEMBER(int, pfnSSMRegister,(PPDMUSBINS pUsbIns, uint32_t uVersion, size_t cbGuess,
565	PFNSSMUSBLIVEPREP pfnLivePrep, PFNSSMUSBLIVEEXEC pfnLiveExec, PFNSSMUSBLIVEVOTE pfnLiveVote,
566	PFNSSMUSBSAVEPREP pfnSavePrep, PFNSSMUSBSAVEEXEC pfnSaveExec, PFNSSMUSBSAVEDONE pfnSaveDone,
567	PFNSSMUSBLOADPREP pfnLoadPrep, PFNSSMUSBLOADEXEC pfnLoadExec, PFNSSMUSBLOADDONE pfnLoadDone));
568
569	/**
570	* Register a STAM sample.
571	*
572	* Use the PDMUsbHlpSTAMRegister wrapper.
573	*
574	* @returns VBox status.
575	* @param pUsbIns The USB device instance.
576	* @param pvSample Pointer to the sample.
577	* @param enmType Sample type. This indicates what pvSample is pointing at.
578	* @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
579	* @param enmUnit Sample unit.
580	* @param pszDesc Sample description.
581	* @param pszName The sample name format string.
582	* @param va Arguments to the format string.
583	*/
584	DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterV,(PPDMUSBINS pUsbIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
585	STAMUNIT enmUnit, const char pszDesc, const char pszName, va_list va));
586
587	/**
588	* Creates a timer.
589	*
590	* @returns VBox status.
591	* @param pUsbIns The USB device instance.
592	* @param enmClock The clock to use on this timer.
593	* @param pfnCallback Callback function.
594	* @param pvUser User argument for the callback.
595	* @param fFlags Flags, see TMTIMER_FLAGS_*.
596	* @param pszDesc Pointer to description string which must stay around
597	* until the timer is fully destroyed (i.e. a bit after TMTimerDestroy()).
598	* @param ppTimer Where to store the timer on success.
599	*/
600	DECLR3CALLBACKMEMBER(int, pfnTMTimerCreate,(PPDMUSBINS pUsbIns, TMCLOCK enmClock, PFNTMTIMERUSB pfnCallback, void *pvUser,
601	uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer));
602
603	/**
604	* Set the VM error message
605	*
606	* @returns rc.
607	* @param pUsbIns The USB device instance.
608	* @param rc VBox status code.
609	* @param RT_SRC_POS_DECL Use RT_SRC_POS.
610	* @param pszFormat Error message format string.
611	* @param va Error message arguments.
612	*/
613	DECLR3CALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMUSBINS pUsbIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va));
614
615	/**
616	* Set the VM runtime error message
617	*
618	* @returns VBox status code.
619	* @param pUsbIns The USB device instance.
620	* @param fFlags The action flags. See VMSETRTERR_FLAGS_*.
621	* @param pszErrorId Error ID string.
622	* @param pszFormat Error message format string.
623	* @param va Error message arguments.
624	*/
625	DECLR3CALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMUSBINS pUsbIns, uint32_t fFlags, const char pszErrorId, const char pszFormat, va_list va));
626
627	/**
628	* Gets the VM state.
629	*
630	* @returns VM state.
631	* @param pUsbIns The USB device instance.
632	* @thread Any thread (just keep in mind that it's volatile info).
633	*/
634	DECLR3CALLBACKMEMBER(VMSTATE, pfnVMState, (PPDMUSBINS pUsbIns));
635
636	/**
637	* Creates a PDM thread.
638	*
639	* This differs from the RTThreadCreate() API in that PDM takes care of suspending,
640	* resuming, and destroying the thread as the VM state changes.
641	*
642	* @returns VBox status code.
643	* @param pDevIns The device instance.
644	* @param ppThread Where to store the thread 'handle'.
645	* @param pvUser The user argument to the thread function.
646	* @param pfnThread The thread function.
647	* @param pfnWakeup The wakup callback. This is called on the EMT
648	* thread when a state change is pending.
649	* @param cbStack See RTThreadCreate.
650	* @param enmType See RTThreadCreate.
651	* @param pszName See RTThreadCreate.
652	*/
653	DECLR3CALLBACKMEMBER(int, pfnThreadCreate,(PPDMUSBINS pUsbIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADUSB pfnThread,
654	PFNPDMTHREADWAKEUPUSB pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName));
655
656	/**
657	* Set up asynchronous handling of a suspend, reset or power off notification.
658	*
659	* This shall only be called when getting the notification. It must be called
660	* for each one.
661	*
662	* @returns VBox status code.
663	* @param pUSBIns The USB device instance.
664	* @param pfnAsyncNotify The callback.
665	* @thread EMT(0)
666	*/
667	DECLR3CALLBACKMEMBER(int, pfnSetAsyncNotification, (PPDMUSBINS pUSbIns, PFNPDMUSBASYNCNOTIFY pfnAsyncNotify));
668
669	/**
670	* Notify EMT(0) that the device has completed the asynchronous notification
671	* handling.
672	*
673	* This can be called at any time, spurious calls will simply be ignored.
674	*
675	* @param pUSBIns The USB device instance.
676	* @thread Any
677	*/
678	DECLR3CALLBACKMEMBER(void, pfnAsyncNotificationCompleted, (PPDMUSBINS pUsbIns));
679
680	/** Just a safety precaution. */
681	uint32_t u32TheEnd;
682	} PDMUSBHLP;
683	/** Pointer PDM USB Device API. */
684	typedef PDMUSBHLP *PPDMUSBHLP;
685	/** Pointer const PDM USB Device API. */
686	typedef const PDMUSBHLP *PCPDMUSBHLP;
687
688	/** Current USBHLP version number. */
689	#define PDM_USBHLP_VERSION PDM_VERSION_MAKE(0xeefe, 2, 0)
690
691	#endif /* IN_RING3 */
692
693	/**
694	* PDM USB Device Instance.
695	*/
696	typedef struct PDMUSBINS
697	{
698	/** Structure version. PDM_USBINS_VERSION defines the current version. */
699	uint32_t u32Version;
700	/** USB device instance number. */
701	uint32_t iInstance;
702	/** The base interface of the device.
703	* The device constructor initializes this if it has any device level
704	* interfaces to export. To obtain this interface call PDMR3QueryUSBDevice(). */
705	PDMIBASE IBase;
706	#if HC_ARCH_BITS == 32
707	uint32_t u32Alignment; /*< Alignment padding. /
708	#endif
709
710	/** Internal data. */
711	union
712	{
713	#ifdef PDMUSBINSINT_DECLARED
714	PDMUSBINSINT s;
715	#endif
716	uint8_t padding[HC_ARCH_BITS == 32 ? 96 : 128];
717	} Internal;
718
719	/** Pointer the PDM USB Device API. */
720	R3PTRTYPE(PCPDMUSBHLP) pHlpR3;
721	/** Pointer to the USB device registration structure. */
722	R3PTRTYPE(PCPDMUSBREG) pReg;
723	/** Configuration handle. */
724	R3PTRTYPE(PCFGMNODE) pCfg;
725	/** The (device) global configuration handle. */
726	R3PTRTYPE(PCFGMNODE) pCfgGlobal;
727	/** Pointer to device instance data. */
728	R3PTRTYPE(void *) pvInstanceDataR3;
729	/** Pointer to the VUSB Device structure.
730	* Internal to VUSB, don't touch.
731	* @todo Moved this to PDMUSBINSINT. */
732	R3PTRTYPE(void *) pvVUsbDev2;
733	/** Device name for using when logging.
734	* The constructor sets this and the destructor frees it. */
735	R3PTRTYPE(char *) pszName;
736	/** Tracing indicator. */
737	uint32_t fTracing;
738	/** The tracing ID of this device. */
739	uint32_t idTracing;
740	/** The USB version of the hub this device is attached to. Used to
741	* determine whether the device communicates at high-speed or full-/low-speed. */
742	uint32_t iUsbHubVersion;
743
744	/** Padding to make achInstanceData aligned at 32 byte boundary. */
745	uint32_t au32Padding[HC_ARCH_BITS == 32 ? 2 : 3];
746
747	/** Device instance data. The size of this area is defined
748	* in the PDMUSBREG::cbInstanceData field. */
749	char achInstanceData[8];
750	} PDMUSBINS;
751
752	/** Current USBINS version number. */
753	#define PDM_USBINS_VERSION PDM_VERSION_MAKE(0xeefd, 2, 0)
754
755	/**
756	* Checks the structure versions of the USB device instance and USB device
757	* helpers, returning if they are incompatible.
758	*
759	* This is for use in the constructor.
760	*
761	* @param pUsbIns The USB device instance pointer.
762	*/
763	#define PDMUSB_CHECK_VERSIONS_RETURN(pUsbIns) \
764	do \
765	{ \
766	PPDMUSBINS pUsbInsTypeCheck = (pUsbIns); NOREF(pUsbInsTypeCheck); \
767	AssertLogRelMsgReturn(PDM_VERSION_ARE_COMPATIBLE((pUsbIns)->u32Version, PDM_USBINS_VERSION), \
768	("DevIns=%#x mine=%#x\n", (pUsbIns)->u32Version, PDM_USBINS_VERSION), \
769	VERR_PDM_USBINS_VERSION_MISMATCH); \
770	AssertLogRelMsgReturn(PDM_VERSION_ARE_COMPATIBLE((pUsbIns)->pHlpR3->u32Version, PDM_USBHLP_VERSION), \
771	("DevHlp=%#x mine=%#x\n", (pUsbIns)->pHlpR3->u32Version, PDM_USBHLP_VERSION), \
772	VERR_PDM_USBHLPR3_VERSION_MISMATCH); \
773	} while (0)
774
775	/**
776	* Quietly checks the structure versions of the USB device instance and
777	* USB device helpers, returning if they are incompatible.
778	*
779	* This is for use in the destructor.
780	*
781	* @param pUsbIns The USB device instance pointer.
782	*/
783	#define PDMUSB_CHECK_VERSIONS_RETURN_QUIET(pUsbIns) \
784	do \
785	{ \
786	PPDMUSBINS pUsbInsTypeCheck = (pUsbIns); NOREF(pUsbInsTypeCheck); \
787	if (RT_UNLIKELY(!PDM_VERSION_ARE_COMPATIBLE((pUsbIns)->u32Version, PDM_USBINS_VERSION) )) \
788	return VERR_PDM_USBINS_VERSION_MISMATCH; \
789	if (RT_UNLIKELY(!PDM_VERSION_ARE_COMPATIBLE((pUsbIns)->pHlpR3->u32Version, PDM_USBHLPR3_VERSION) )) \
790	return VERR_PDM_USBHLPR3_VERSION_MISMATCH; \
791	} while (0)
792
793
794	/** Converts a pointer to the PDMUSBINS::IBase to a pointer to PDMUSBINS. */
795	#define PDMIBASE_2_PDMUSB(pInterface) ( (PPDMUSBINS)((char *)(pInterface) - RT_OFFSETOF(PDMUSBINS, IBase)) )
796
797
798	/** @def PDMUSB_ASSERT_EMT
799	* Assert that the current thread is the emulation thread.
800	*/
801	#ifdef VBOX_STRICT
802	# define PDMUSB_ASSERT_EMT(pUsbIns) pUsbIns->pHlpR3->pfnAssertEMT(pUsbIns, __FILE__, __LINE__, __FUNCTION__)
803	#else
804	# define PDMUSB_ASSERT_EMT(pUsbIns) do { } while (0)
805	#endif
806
807	/** @def PDMUSB_ASSERT_OTHER
808	* Assert that the current thread is NOT the emulation thread.
809	*/
810	#ifdef VBOX_STRICT
811	# define PDMUSB_ASSERT_OTHER(pUsbIns) pUsbIns->pHlpR3->pfnAssertOther(pUsbIns, __FILE__, __LINE__, __FUNCTION__)
812	#else
813	# define PDMUSB_ASSERT_OTHER(pUsbIns) do { } while (0)
814	#endif
815
816	/** @def PDMUSB_SET_ERROR
817	* Set the VM error. See PDMUsbHlpVMSetError() for printf like message
818	* formatting.
819	*/
820	#define PDMUSB_SET_ERROR(pUsbIns, rc, pszError) \
821	PDMUsbHlpVMSetError(pUsbIns, rc, RT_SRC_POS, "%s", pszError)
822
823	/** @def PDMUSB_SET_RUNTIME_ERROR
824	* Set the VM runtime error. See PDMUsbHlpVMSetRuntimeError() for printf like
825	* message formatting.
826	*/
827	#define PDMUSB_SET_RUNTIME_ERROR(pUsbIns, fFlags, pszErrorId, pszError) \
828	PDMUsbHlpVMSetRuntimeError(pUsbIns, fFlags, pszErrorId, "%s", pszError)
829
830
831	#ifdef IN_RING3
832
833	/**
834	* @copydoc PDMUSBHLP::pfnDriverAttach
835	*/
836	DECLINLINE(int) PDMUsbHlpDriverAttach(PPDMUSBINS pUsbIns, RTUINT iLun, PPDMIBASE pBaseInterface, PPDMIBASE ppBaseInterface, const char pszDesc)
837	{
838	return pUsbIns->pHlpR3->pfnDriverAttach(pUsbIns, iLun, pBaseInterface, ppBaseInterface, pszDesc);
839	}
840
841	/**
842	* VBOX_STRICT wrapper for pHlpR3->pfnDBGFStopV.
843	*
844	* @returns VBox status code which must be passed up to the VMM.
845	* @param pUsbIns Device instance.
846	* @param RT_SRC_POS_DECL Use RT_SRC_POS.
847	* @param pszFormat Message. (optional)
848	* @param ... Message parameters.
849	*/
850	DECLINLINE(int) PDMUsbDBGFStop(PPDMUSBINS pUsbIns, RT_SRC_POS_DECL, const char *pszFormat, ...)
851	{
852	#ifdef VBOX_STRICT
853	int rc;
854	va_list va;
855	va_start(va, pszFormat);
856	rc = pUsbIns->pHlpR3->pfnDBGFStopV(pUsbIns, RT_SRC_POS_ARGS, pszFormat, va);
857	va_end(va);
858	return rc;
859	#else
860	NOREF(pUsbIns);
861	NOREF(pszFile);
862	NOREF(iLine);
863	NOREF(pszFunction);
864	NOREF(pszFormat);
865	return VINF_SUCCESS;
866	#endif
867	}
868
869	/**
870	* @copydoc PDMUSBHLP::pfnVMState
871	*/
872	DECLINLINE(VMSTATE) PDMUsbHlpVMState(PPDMUSBINS pUsbIns)
873	{
874	return pUsbIns->pHlpR3->pfnVMState(pUsbIns);
875	}
876
877	/**
878	* @copydoc PDMUSBHLP::pfnThreadCreate
879	*/
880	DECLINLINE(int) PDMUsbHlpThreadCreate(PPDMUSBINS pUsbIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADUSB pfnThread,
881	PFNPDMTHREADWAKEUPUSB pfnWakeup, size_t cbStack, RTTHREADTYPE enmType, const char *pszName)
882	{
883	return pUsbIns->pHlpR3->pfnThreadCreate(pUsbIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
884	}
885
886
887	/**
888	* @copydoc PDMUSBHLP::pfnSetAsyncNotification
889	*/
890	DECLINLINE(int) PDMUsbHlpSetAsyncNotification(PPDMUSBINS pUsbIns, PFNPDMUSBASYNCNOTIFY pfnAsyncNotify)
891	{
892	return pUsbIns->pHlpR3->pfnSetAsyncNotification(pUsbIns, pfnAsyncNotify);
893	}
894
895	/**
896	* @copydoc PDMUSBHLP::pfnAsyncNotificationCompleted
897	*/
898	DECLINLINE(void) PDMUsbHlpAsyncNotificationCompleted(PPDMUSBINS pUsbIns)
899	{
900	pUsbIns->pHlpR3->pfnAsyncNotificationCompleted(pUsbIns);
901	}
902
903	/**
904	* Set the VM error message
905	*
906	* @returns rc.
907	* @param pUsbIns The USB device instance.
908	* @param rc VBox status code.
909	* @param RT_SRC_POS_DECL Use RT_SRC_POS.
910	* @param pszFormat Error message format string.
911	* @param ... Error message arguments.
912	*/
913	DECLINLINE(int) PDMUsbHlpVMSetError(PPDMUSBINS pUsbIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...)
914	{
915	va_list va;
916	va_start(va, pszFormat);
917	rc = pUsbIns->pHlpR3->pfnVMSetErrorV(pUsbIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
918	va_end(va);
919	return rc;
920	}
921
922	/**
923	* @copydoc PDMUSBHLP::pfnMMHeapAlloc
924	*/
925	DECLINLINE(void *) PDMUsbHlpMMHeapAlloc(PPDMUSBINS pUsbIns, size_t cb)
926	{
927	return pUsbIns->pHlpR3->pfnMMHeapAlloc(pUsbIns, cb);
928	}
929
930	/**
931	* @copydoc PDMUSBHLP::pfnMMHeapAllocZ
932	*/
933	DECLINLINE(void *) PDMUsbHlpMMHeapAllocZ(PPDMUSBINS pUsbIns, size_t cb)
934	{
935	return pUsbIns->pHlpR3->pfnMMHeapAllocZ(pUsbIns, cb);
936	}
937
938	/**
939	* Frees memory allocated by PDMUsbHlpMMHeapAlloc or PDMUsbHlpMMHeapAllocZ.
940	*
941	* @param pUsbIns The USB device instance.
942	* @param pv The memory to free. NULL is fine.
943	*/
944	DECLINLINE(void) PDMUsbHlpMMHeapFree(PPDMUSBINS pUsbIns, void *pv)
945	{
946	NOREF(pUsbIns);
947	MMR3HeapFree(pv);
948	}
949
950	/**
951	* @copydoc PDMUSBHLP::pfnTMTimerCreate
952	*/
953	DECLINLINE(int) PDMUsbHlpTMTimerCreate(PPDMUSBINS pUsbIns, TMCLOCK enmClock, PFNTMTIMERUSB pfnCallback, void *pvUser,
954	uint32_t fFlags, const char *pszDesc, PPTMTIMERR3 ppTimer)
955	{
956	return pUsbIns->pHlpR3->pfnTMTimerCreate(pUsbIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, ppTimer);
957	}
958
959	#endif /* IN_RING3 */
960
961
962
963	/** Pointer to callbacks provided to the VBoxUsbRegister() call. */
964	typedef const struct PDMUSBREGCB *PCPDMUSBREGCB;
965
966	/**
967	* Callbacks for VBoxUSBDeviceRegister().
968	*/
969	typedef struct PDMUSBREGCB
970	{
971	/** Interface version.
972	* This is set to PDM_USBREG_CB_VERSION. */
973	uint32_t u32Version;
974
975	/**
976	* Registers a device with the current VM instance.
977	*
978	* @returns VBox status code.
979	* @param pCallbacks Pointer to the callback table.
980	* @param pReg Pointer to the USB device registration record.
981	* This data must be permanent and readonly.
982	*/
983	DECLR3CALLBACKMEMBER(int, pfnRegister,(PCPDMUSBREGCB pCallbacks, PCPDMUSBREG pReg));
984	} PDMUSBREGCB;
985
986	/** Current version of the PDMUSBREGCB structure. */
987	#define PDM_USBREG_CB_VERSION PDM_VERSION_MAKE(0xeefc, 1, 0)
988
989
990	/**
991	* The VBoxUsbRegister callback function.
992	*
993	* PDM will invoke this function after loading a USB device module and letting
994	* the module decide which devices to register and how to handle conflicts.
995	*
996	* @returns VBox status code.
997	* @param pCallbacks Pointer to the callback table.
998	* @param u32Version VBox version number.
999	*/
1000	typedef DECLCALLBACK(int) FNPDMVBOXUSBREGISTER(PCPDMUSBREGCB pCallbacks, uint32_t u32Version);
1001
1002	VMMR3DECL(int) PDMR3UsbCreateProxyDevice(PUVM pUVM, PCRTUUID pUuid, bool fRemote, const char pszAddress, void pvBackend,
1003	uint32_t iUsbVersion, uint32_t fMaskedIfs);
1004	VMMR3DECL(int) PDMR3UsbDetachDevice(PUVM pUVM, PCRTUUID pUuid);
1005	VMMR3DECL(bool) PDMR3UsbHasHub(PUVM pUVM);
1006
1007
1008	/** @} */
1009
1010	RT_C_DECLS_END
1011
1012	#endif

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

source: vbox/trunk/include/VBox/vmm/pdmusb.h@ 44528

Download in other formats: