pdmusb.h revision d0e467f88aeb4288b409908dbe1b96d07c7133b2
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * PDM - Pluggable Device Manager, USB Devices.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Copyright (C) 2006-2013 Oracle Corporation
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * available from http://www.virtualbox.org. This file is free software;
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * you can redistribute it and/or modify it under the terms of the GNU
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * General Public License (GPL) as published by the Free Software
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * The contents of this file may alternatively be used under the terms
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * of the Common Development and Distribution License Version 1.0
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * VirtualBox OSE distribution, in which case the provisions of the
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * CDDL are applicable instead of those of the GPL.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * You may elect to license modified versions of this file under the
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * terms and conditions of either the GPL or the CDDL or both.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync/** @defgroup grp_pdm_usbdev The USB Devices API
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @ingroup grp_pdm
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * A string entry for the USB descriptor cache.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync /** The string index. */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync /** The UTF-8 representation of the string. */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync const char *psz;
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync/** Pointer to a const string entry. */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsynctypedef PDMUSBDESCCACHESTRING const *PCPDMUSBDESCCACHESTRING;
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * A language entry for the USB descriptor cache.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync /** The language ID for the strings in this block. */
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync /** The number of strings in the array. */
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync /** Pointer to an array of associated strings.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * This must be sorted in ascending order by string index as a binary lookup
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * will be performed. */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync/** Pointer to a const language entry. */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsynctypedef PDMUSBDESCCACHELANG const *PCPDMUSBDESCCACHELANG;
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * USB descriptor cache.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * This structure is owned by the USB device but provided to the PDM/VUSB layer
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * thru the PDMUSBREG::pfnGetDescriptorCache method. PDM/VUSB will use the
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * information here to map addresses to endpoints, perform SET_CONFIGURATION
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * requests, and optionally perform GET_DESCRIPTOR requests (see flag).
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Currently, only device and configuration descriptors are cached.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync /** USB device descriptor */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync /** USB Descriptor arrays (pDev->bNumConfigurations) */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync /** Language IDs and their associated strings.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * This must be sorted in ascending order by language ID as a binary lookup
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * will be used. */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync /** The number of entries in the array pointed to by paLanguages. */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync /** Use the cached descriptors for GET_DESCRIPTOR requests. */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync /** Use the cached string descriptors. */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync/** Pointer to an USB descriptor cache. */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync/** Pointer to a const USB descriptor cache. */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync/** PDM Device Flags.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync/** A high-speed capable USB 2.0 device (also required to support full-speed). */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync/** Indicates that the device is fully emulated and is not used to pass through
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * a host device. */
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync/** PDM USB Device Registration Structure,
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * This structure is used when registering a device from VBoxUsbRegister() in HC Ring-3.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * The PDM will make use of this structure until the VM is destroyed.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsynctypedef struct PDMUSBREG
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync /** Structure version. PDM_DEVREG_VERSION defines the current version. */
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync /** Device name. */
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync /** The description of the device. The UTF-8 string pointed to shall, like this structure,
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * remain unchanged from registration till VM destruction. */
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync /** Flags, combination of the PDM_USBREG_FLAGS_* \#defines. */
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync /** Maximum number of instances (per VM). */
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync /** Size of the instance data. */
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * Construct an USB device instance for a VM.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @returns VBox status.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @param pUsbIns The USB device instance data.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * If the registration structure is needed, it will be
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * accessible thru pUsbDev->pReg.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @param iInstance Instance number. Use this to figure out which registers
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * and such to use. The instance number is also found in
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * pUsbDev->iInstance, but since it's likely to be
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * frequently used PDM passes it as parameter.
b514c03a427443a7ad18c1202d2ee7acc47cf9afvboxsync * @param pCfg Configuration node handle for the device. Use this to
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * obtain the configuration of the device instance. It is
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * also found in pUsbDev->pCfg, but since it is primary
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * usage will in this function it is passed as a parameter.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @param pCfgGlobal Handle to the global device configuration. Also found
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * in pUsbDev->pCfgGlobal.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @remarks This callback is required.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync DECLR3CALLBACKMEMBER(int, pfnConstruct,(PPDMUSBINS pUsbIns, int iInstance, PCFGMNODE pCfg, PCFGMNODE pCfgGlobal));
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * Destruct an USB device instance.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * Most VM resources are freed by the VM. This callback is provided so that any non-VM
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * resources can be freed correctly.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * This method will be called regardless of the pfnConstruct result to avoid
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * complicated failure paths.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @param pUsbIns The USB device instance data.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(void, pfnDestruct,(PPDMUSBINS pUsbIns));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Init complete notification.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * This can be done to do communication with other devices and other
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * initialization which requires everything to be in place.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns VBOX status code.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance data.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Not called when hotplugged.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(int, pfnVMInitComplete,(PPDMUSBINS pUsbIns));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * VM Power On notification.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns VBox status.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance data.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(void, pfnVMPowerOn,(PPDMUSBINS pUsbIns));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * VM Reset notification.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns VBox status.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance data.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(void, pfnVMReset,(PPDMUSBINS pUsbIns));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * VM Suspend notification.
bd96e81081052c309669f3f9b183cfec4fffbefbvboxsync * @returns VBox status.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance data.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(void, pfnVMSuspend,(PPDMUSBINS pUsbIns));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * VM Resume notification.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns VBox status.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance data.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(void, pfnVMResume,(PPDMUSBINS pUsbIns));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * VM Power Off notification.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * This is only called when the VMR3PowerOff call is made on a running VM. This
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * means that there is no notification if the VM was suspended before being
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * powered of. There will also be no callback when hot plugging devices.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance data.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(void, pfnVMPowerOff,(PPDMUSBINS pUsbIns));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Called after the constructor when attaching a device at run time.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * This can be used to do tasks normally assigned to pfnInitComplete and/or pfnVMPowerOn.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns VBox status.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance data.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(void, pfnHotPlugged,(PPDMUSBINS pUsbIns));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Called before the destructor when a device is unplugged at run time.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * This can be used to do tasks normally assigned to pfnVMSuspend and/or pfnVMPowerOff.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns VBox status.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance data.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(void, pfnHotUnplugged,(PPDMUSBINS pUsbIns));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Driver Attach command.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * This is called to let the USB device attach to a driver for a specified LUN
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * at runtime. This is not called during VM construction, the device constructor
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * have to attach to all the available drivers.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns VBox status code.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance data.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param iLUN The logical unit which is being detached.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param fFlags Flags, combination of the PDM_TACH_FLAGS_* \#defines.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(int, pfnDriverAttach,(PPDMUSBINS pUsbIns, unsigned iLUN, uint32_t fFlags));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Driver Detach notification.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * This is called when a driver is detaching itself from a LUN of the device.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * The device should adjust it's state to reflect this.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance data.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param iLUN The logical unit which is being detached.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param fFlags Flags, combination of the PDM_TACH_FLAGS_* \#defines.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(void, pfnDriverDetach,(PPDMUSBINS pUsbIns, unsigned iLUN, uint32_t fFlags));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Query the base interface of a logical unit.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns VBOX status code.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance data.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param iLUN The logicial unit to query.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param ppBase Where to store the pointer to the base interface of the LUN.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(int, pfnQueryInterface,(PPDMUSBINS pUsbIns, unsigned iLUN, PPDMIBASE *ppBase));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Requests the USB device to reset.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns VBox status code.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @param pUsbIns The USB device instance.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @param fResetOnLinux A hint to the usb proxy.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * Don't use this unless you're the linux proxy device.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @thread Any thread.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @remarks Optional.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync DECLR3CALLBACKMEMBER(int, pfnUsbReset,(PPDMUSBINS pUsbIns, bool fResetOnLinux));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Query device and configuration descriptors for the caching and servicing
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * relevant GET_DESCRIPTOR requests.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns Pointer to the descriptor cache (read-only).
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Mandatory.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(PCPDMUSBDESCCACHE, pfnUsbGetDescriptorCache,(PPDMUSBINS pUsbIns));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * SET_CONFIGURATION request.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns VBox status code.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param bConfigurationValue The bConfigurationValue of the new configuration.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pvOldCfgDesc Internal - for the device proxy.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pvOldIfState Internal - for the device proxy.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @param pvNewCfgDesc Internal - for the device proxy.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync DECLR3CALLBACKMEMBER(int, pfnUsbSetConfiguration,(PPDMUSBINS pUsbIns, uint8_t bConfigurationValue,
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync const void *pvOldCfgDesc, const void *pvOldIfState, const void *pvNewCfgDesc));
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * SET_INTERFACE request.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @returns VBox status code.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @param pUsbIns The USB device instance.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @param bInterfaceNumber The interface number.
914d33aebb63d8c288dfd1b7e74f8e2acf3eaa66vboxsync * @param bAlternateSetting The alternate setting.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(int, pfnUsbSetInterface,(PPDMUSBINS pUsbIns, uint8_t bInterfaceNumber, uint8_t bAlternateSetting));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Clears the halted state of an endpoint. (Optional)
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * This called when VUSB sees a CLEAR_FEATURE(ENDPOINT_HALT) on request
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * on the zero pipe.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns VBox status code.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param uEndpoint The endpoint to clear.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(int, pfnUsbClearHaltedEndpoint,(PPDMUSBINS pUsbIns, unsigned uEndpoint));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Allocates an URB.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * This can be used to make use of shared user/kernel mode buffers.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns VBox status code.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param pUsbIns The USB device instance.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param cbData The size of the data buffer.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param cTds The number of TDs.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param enmType The type of URB.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @param ppUrb Where to store the allocated URB.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Optional.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @remarks Not implemented yet.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync DECLR3CALLBACKMEMBER(int, pfnUrbNew,(PPDMUSBINS pUsbIns, size_t cbData, size_t cTds, VUSBXFERTYPE enmType, PVUSBURB *ppUrb));
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * Queues an URB for processing.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @returns VBox status code.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @retval VINF_SUCCESS on success.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @retval VERR_VUSB_DEVICE_NOT_ATTACHED if the device has been disconnected.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @retval VERR_VUSB_FAILED_TO_QUEUE_URB as a general failure kind of thing.
5b1d6bab9f4cf5dacf1883e7c4a40c84349f597fvboxsync * @retval TBD - document new stuff!
} PDMUSBREG;
#ifdef IN_RING3
typedef struct PDMUSBHLP
DECLR3CALLBACKMEMBER(int, pfnDriverAttach,(PPDMUSBINS pUsbIns, RTUINT iLun, PPDMIBASE pBaseInterface, PPDMIBASE *ppBaseInterface, const char *pszDesc));
DECLR3CALLBACKMEMBER(bool, pfnAssertEMT,(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction));
DECLR3CALLBACKMEMBER(bool, pfnAssertOther,(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction));
DECLR3CALLBACKMEMBER(int, pfnDBGFStopV,(PPDMUSBINS pUsbIns, const char *pszFile, unsigned iLine, const char *pszFunction, const char *pszFormat, va_list va));
DECLR3CALLBACKMEMBER(int, pfnDBGFInfoRegister,(PPDMUSBINS pUsbIns, const char *pszName, const char *pszDesc, PFNDBGFHANDLERUSB pfnHandler));
DECLR3CALLBACKMEMBER(int, pfnPDMQueueCreate,(PPDMUSBINS pUsbIns, RTUINT cbItem, RTUINT cItems, uint32_t cMilliesInterval,
* @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
DECLR3CALLBACKMEMBER(void, pfnSTAMRegisterV,(PPDMUSBINS pUsbIns, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
DECLR3CALLBACKMEMBER(int, pfnTMTimerCreate,(PPDMUSBINS pUsbIns, TMCLOCK enmClock, PFNTMTIMERUSB pfnCallback, void *pvUser,
DECLR3CALLBACKMEMBER(int, pfnVMSetErrorV,(PPDMUSBINS pUsbIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va));
DECLR3CALLBACKMEMBER(int, pfnVMSetRuntimeErrorV,(PPDMUSBINS pUsbIns, uint32_t fFlags, const char *pszErrorId, const char *pszFormat, va_list va));
DECLR3CALLBACKMEMBER(int, pfnThreadCreate,(PPDMUSBINS pUsbIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADUSB pfnThread,
DECLR3CALLBACKMEMBER(int, pfnSetAsyncNotification, (PPDMUSBINS pUSbIns, PFNPDMUSBASYNCNOTIFY pfnAsyncNotify));
} PDMUSBHLP;
typedef struct PDMUSBINS
#ifdef PDMUSBINSINT_DECLARED
PDMUSBINSINT s;
} Internal;
} PDMUSBINS;
AssertLogRelMsgReturn(PDM_VERSION_ARE_COMPATIBLE((pUsbIns)->pHlpR3->u32Version, PDM_USBHLP_VERSION), \
return VERR_PDM_USBINS_VERSION_MISMATCH; \
if (RT_UNLIKELY(!PDM_VERSION_ARE_COMPATIBLE((pUsbIns)->pHlpR3->u32Version, PDM_USBHLPR3_VERSION) )) \
return VERR_PDM_USBHLPR3_VERSION_MISMATCH; \
#define PDMIBASE_2_PDMUSB(pInterface) ( (PPDMUSBINS)((char *)(pInterface) - RT_OFFSETOF(PDMUSBINS, IBase)) )
#ifdef VBOX_STRICT
# define PDMUSB_ASSERT_EMT(pUsbIns) pUsbIns->pHlpR3->pfnAssertEMT(pUsbIns, __FILE__, __LINE__, __FUNCTION__)
#ifdef VBOX_STRICT
# define PDMUSB_ASSERT_OTHER(pUsbIns) pUsbIns->pHlpR3->pfnAssertOther(pUsbIns, __FILE__, __LINE__, __FUNCTION__)
#ifdef IN_RING3
DECLINLINE(int) PDMUsbHlpDriverAttach(PPDMUSBINS pUsbIns, RTUINT iLun, PPDMIBASE pBaseInterface, PPDMIBASE *ppBaseInterface, const char *pszDesc)
#ifdef VBOX_STRICT
int rc;
return rc;
return VINF_SUCCESS;
DECLINLINE(int) PDMUsbHlpThreadCreate(PPDMUSBINS pUsbIns, PPPDMTHREAD ppThread, void *pvUser, PFNPDMTHREADUSB pfnThread,
return pUsbIns->pHlpR3->pfnThreadCreate(pUsbIns, ppThread, pvUser, pfnThread, pfnWakeup, cbStack, enmType, pszName);
DECLINLINE(int) PDMUsbHlpSetAsyncNotification(PPDMUSBINS pUsbIns, PFNPDMUSBASYNCNOTIFY pfnAsyncNotify)
DECLINLINE(int) PDMUsbHlpVMSetError(PPDMUSBINS pUsbIns, int rc, RT_SRC_POS_DECL, const char *pszFormat, ...)
return rc;
DECLINLINE(int) PDMUsbHlpTMTimerCreate(PPDMUSBINS pUsbIns, TMCLOCK enmClock, PFNTMTIMERUSB pfnCallback, void *pvUser,
return pUsbIns->pHlpR3->pfnTMTimerCreate(pUsbIns, enmClock, pfnCallback, pvUser, fFlags, pszDesc, ppTimer);
typedef struct PDMUSBREGCB
} PDMUSBREGCB;
VMMR3DECL(int) PDMR3UsbCreateEmulatedDevice(PUVM pUVM, const char *pszDeviceName, PCFGMNODE pDeviceNode, PCRTUUID pUuid);
VMMR3DECL(int) PDMR3UsbCreateProxyDevice(PUVM pUVM, PCRTUUID pUuid, bool fRemote, const char *pszAddress, void *pvBackend,
VMMR3DECL(int) PDMR3UsbDriverAttach(PUVM pUVM, const char *pszDevice, unsigned iDevIns, unsigned iLun, uint32_t fFlags,