diff options
Diffstat (limited to 'src/VBox/Main/src-client/USBDeviceImpl.cpp')
| -rw-r--r-- | src/VBox/Main/src-client/USBDeviceImpl.cpp | 351 |
1 files changed, 351 insertions, 0 deletions
diff --git a/src/VBox/Main/src-client/USBDeviceImpl.cpp b/src/VBox/Main/src-client/USBDeviceImpl.cpp new file mode 100644 index 00000000..1e957514 --- /dev/null +++ b/src/VBox/Main/src-client/USBDeviceImpl.cpp @@ -0,0 +1,351 @@ +/* $Id: USBDeviceImpl.cpp $ */ +/** @file + * VirtualBox COM class implementation + */ + +/* + * Copyright (C) 2006-2022 Oracle and/or its affiliates. + * + * This file is part of VirtualBox base platform packages, as + * available from https://www.virtualbox.org. + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation, in version 3 of the + * License. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, see <https://www.gnu.org/licenses>. + * + * SPDX-License-Identifier: GPL-3.0-only + */ + +#define LOG_GROUP LOG_GROUP_MAIN_USBDEVICE +#include "LoggingNew.h" + +#include "USBDeviceImpl.h" + +#include "AutoCaller.h" + +#include <iprt/cpp/utils.h> + + +// constructor / destructor +///////////////////////////////////////////////////////////////////////////// + +DEFINE_EMPTY_CTOR_DTOR (OUSBDevice) + +HRESULT OUSBDevice::FinalConstruct() +{ + return BaseFinalConstruct(); +} + +void OUSBDevice::FinalRelease() +{ + uninit (); + BaseFinalRelease(); +} + +// public initializer/uninitializer for internal purposes only +///////////////////////////////////////////////////////////////////////////// + +/** + * Initializes the USB device object. + * + * @returns COM result indicator + * @param aUSBDevice The USB device (interface) to clone. + */ +HRESULT OUSBDevice::init(IUSBDevice *aUSBDevice) +{ + LogFlowThisFunc(("aUSBDevice=%p\n", aUSBDevice)); + + ComAssertRet(aUSBDevice, E_INVALIDARG); + + /* Enclose the state transition NotReady->InInit->Ready */ + AutoInitSpan autoInitSpan(this); + AssertReturn(autoInitSpan.isOk(), E_FAIL); + + HRESULT hrc = aUSBDevice->COMGETTER(VendorId)(&unconst(mData.vendorId)); + ComAssertComRCRet(hrc, hrc); + ComAssertRet(mData.vendorId, E_INVALIDARG); + + hrc = aUSBDevice->COMGETTER(ProductId)(&unconst(mData.productId)); + ComAssertComRCRet(hrc, hrc); + + hrc = aUSBDevice->COMGETTER(Revision)(&unconst(mData.revision)); + ComAssertComRCRet(hrc, hrc); + + Bstr bstr; + + hrc = aUSBDevice->COMGETTER(Manufacturer)(bstr.asOutParam()); + ComAssertComRCRet(hrc, hrc); + unconst(mData.manufacturer) = bstr; + + hrc = aUSBDevice->COMGETTER(Product)(bstr.asOutParam()); + ComAssertComRCRet(hrc, hrc); + unconst(mData.product) = bstr; + + hrc = aUSBDevice->COMGETTER(SerialNumber)(bstr.asOutParam()); + ComAssertComRCRet(hrc, hrc); + unconst(mData.serialNumber) = bstr; + + hrc = aUSBDevice->COMGETTER(Address)(bstr.asOutParam()); + ComAssertComRCRet(hrc, hrc); + unconst(mData.address) = bstr; + + hrc = aUSBDevice->COMGETTER(Backend)(bstr.asOutParam()); + ComAssertComRCRet(hrc, hrc); + unconst(mData.backend) = bstr; + + hrc = aUSBDevice->COMGETTER(Port)(&unconst(mData.port)); + ComAssertComRCRet(hrc, hrc); + + hrc = aUSBDevice->COMGETTER(PortPath)(bstr.asOutParam()); + ComAssertComRCRet(hrc, hrc); + + hrc = aUSBDevice->COMGETTER(Version)(&unconst(mData.version)); + ComAssertComRCRet(hrc, hrc); + + hrc = aUSBDevice->COMGETTER(Speed)(&unconst(mData.speed)); + ComAssertComRCRet(hrc, hrc); + + hrc = aUSBDevice->COMGETTER(Remote)(&unconst(mData.remote)); + ComAssertComRCRet(hrc, hrc); + + Bstr uuid; + hrc = aUSBDevice->COMGETTER(Id)(uuid.asOutParam()); + ComAssertComRCRet(hrc, hrc); + unconst(mData.id) = Guid(uuid); + + /* Confirm a successful initialization */ + autoInitSpan.setSucceeded(); + + return S_OK; +} + +/** + * Uninitializes the instance and sets the ready flag to FALSE. + * Called either from FinalRelease() or by the parent when it gets destroyed. + */ +void OUSBDevice::uninit() +{ + LogFlowThisFunc(("\n")); + + /* Enclose the state transition Ready->InUninit->NotReady */ + AutoUninitSpan autoUninitSpan(this); + if (autoUninitSpan.uninitDone()) + return; + + unconst(mData.id).clear(); + + unconst(mData.vendorId) = 0; + unconst(mData.productId) = 0; + unconst(mData.revision) = 0; + + unconst(mData.manufacturer).setNull(); + unconst(mData.product).setNull(); + unconst(mData.serialNumber).setNull(); + + unconst(mData.address).setNull(); + unconst(mData.backend).setNull(); + + unconst(mData.port) = 0; + unconst(mData.portPath).setNull(); + unconst(mData.version) = 1; + + unconst(mData.remote) = FALSE; +} + +// IUSBDevice properties +///////////////////////////////////////////////////////////////////////////// + +/** + * Returns the GUID. + * + * @returns COM status code + * @param aId Address of result variable. + */ +HRESULT OUSBDevice::getId(com::Guid &aId) +{ + /* this is const, no need to lock */ + aId = mData.id; + + return S_OK; +} + + +/** + * Returns the vendor Id. + * + * @returns COM status code + * @param aVendorId Where to store the vendor id. + */ +HRESULT OUSBDevice::getVendorId(USHORT *aVendorId) +{ + /* this is const, no need to lock */ + *aVendorId = mData.vendorId; + + return S_OK; +} + + +/** + * Returns the product Id. + * + * @returns COM status code + * @param aProductId Where to store the product id. + */ +HRESULT OUSBDevice::getProductId(USHORT *aProductId) +{ + /* this is const, no need to lock */ + *aProductId = mData.productId; + + return S_OK; +} + + +/** + * Returns the revision BCD. + * + * @returns COM status code + * @param aRevision Where to store the revision BCD. + */ +HRESULT OUSBDevice::getRevision(USHORT *aRevision) +{ + /* this is const, no need to lock */ + *aRevision = mData.revision; + + return S_OK; +} + +/** + * Returns the manufacturer string. + * + * @returns COM status code + * @param aManufacturer Where to put the return string. + */ +HRESULT OUSBDevice::getManufacturer(com::Utf8Str &aManufacturer) +{ + /* this is const, no need to lock */ + aManufacturer = mData.manufacturer; + + return S_OK; +} + + +/** + * Returns the product string. + * + * @returns COM status code + * @param aProduct Where to put the return string. + */ +HRESULT OUSBDevice::getProduct(com::Utf8Str &aProduct) +{ + /* this is const, no need to lock */ + aProduct = mData.product; + + return S_OK; +} + + +/** + * Returns the serial number string. + * + * @returns COM status code + * @param aSerialNumber Where to put the return string. + */ +HRESULT OUSBDevice::getSerialNumber(com::Utf8Str &aSerialNumber) +{ + /* this is const, no need to lock */ + aSerialNumber = mData.serialNumber; + + return S_OK; +} + + +/** + * Returns the host specific device address. + * + * @returns COM status code + * @param aAddress Where to put the return string. + */ +HRESULT OUSBDevice::getAddress(com::Utf8Str &aAddress) +{ + /* this is const, no need to lock */ + aAddress = mData.address; + + return S_OK; +} + +HRESULT OUSBDevice::getPort(USHORT *aPort) +{ + /* this is const, no need to lock */ + *aPort = mData.port; + + return S_OK; +} + +HRESULT OUSBDevice::getPortPath(com::Utf8Str &aPortPath) +{ + /* this is const, no need to lock */ + aPortPath = mData.portPath; + + return S_OK; +} + +HRESULT OUSBDevice::getVersion(USHORT *aVersion) +{ + /* this is const, no need to lock */ + *aVersion = mData.version; + + return S_OK; +} + +HRESULT OUSBDevice::getSpeed(USBConnectionSpeed_T *aSpeed) +{ + /* this is const, no need to lock */ + *aSpeed = mData.speed; + + return S_OK; +} + +HRESULT OUSBDevice::getRemote(BOOL *aRemote) +{ + /* this is const, no need to lock */ + *aRemote = mData.remote; + + return S_OK; +} + +/** + * Returns the device specific backend. + * + * @returns COM status code + * @param aBackend Where to put the return string. + */ +HRESULT OUSBDevice::getBackend(com::Utf8Str &aBackend) +{ + /* this is const, no need to lock */ + aBackend = mData.backend; + + return S_OK; +} + +HRESULT OUSBDevice::getDeviceInfo(std::vector<com::Utf8Str> &aInfo) +{ + /* this is const, no need to lock */ + aInfo.resize(2); + aInfo[0] = mData.manufacturer; + aInfo[1] = mData.product; + + return S_OK; +} + +// private methods +///////////////////////////////////////////////////////////////////////////// +/* vi: set tabstop=4 shiftwidth=4 expandtab: */ |