pdmusb.h@ 41788

Last change on this file since 41788 was 40907, checked in by vboxsync, 13 years ago
Working on tracking IRQs for tracing and logging purposes.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 37.7 KB

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

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

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

Download in other formats: