diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-11 08:17:27 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-11 08:17:27 +0000 |
commit | f215e02bf85f68d3a6106c2a1f4f7f063f819064 (patch) | |
tree | 6bb5b92c046312c4e95ac2620b10ddf482d3fa8b /include/VBox/vrdpusb.h | |
parent | Initial commit. (diff) | |
download | virtualbox-f215e02bf85f68d3a6106c2a1f4f7f063f819064.tar.xz virtualbox-f215e02bf85f68d3a6106c2a1f4f7f063f819064.zip |
Adding upstream version 7.0.14-dfsg.upstream/7.0.14-dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | include/VBox/vrdpusb.h | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/include/VBox/vrdpusb.h b/include/VBox/vrdpusb.h new file mode 100644 index 00000000..6ee3b27c --- /dev/null +++ b/include/VBox/vrdpusb.h @@ -0,0 +1,135 @@ +/** @file + * VBox Remote Desktop Protocol - Remote USB backend interface. (VRDP) + */ + +/* + * Copyright (C) 2006-2023 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>. + * + * The contents of this file may alternatively be used under the terms + * of the Common Development and Distribution License Version 1.0 + * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included + * in the VirtualBox distribution, in which case the provisions of the + * CDDL are applicable instead of those of the GPL. + * + * You may elect to license modified versions of this file under the + * terms and conditions of either the GPL or the CDDL or both. + * + * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0 + */ + +#ifndef VBOX_INCLUDED_vrdpusb_h +#define VBOX_INCLUDED_vrdpusb_h +#ifndef RT_WITHOUT_PRAGMA_ONCE +# pragma once +#endif + +#include <VBox/cdefs.h> +#include <VBox/types.h> + +#ifdef IN_RING0 +# error "There are no VRDP APIs available in Ring-0 Host Context!" +#endif +#ifdef IN_RC +# error "There are no VRDP APIs available Guest Context!" +#endif + + +/** @defgroup grp_vrdpusb Remote USB over VURP + * @ingroup grp_vusb + * @{ + */ + +#define REMOTE_USB_BACKEND_PREFIX_S "REMOTEUSB" +#define REMOTE_USB_BACKEND_PREFIX_LEN 9 + +/* Forward declaration. */ +struct _REMOTEUSBDEVICE; +typedef struct _REMOTEUSBDEVICE *PREMOTEUSBDEVICE; + +/* Forward declaration. */ +struct _REMOTEUSBQURB; +typedef struct _REMOTEUSBQURB *PREMOTEUSBQURB; + +/* Forward declaration. Actually a class. */ +struct _REMOTEUSBBACKEND; +typedef struct _REMOTEUSBBACKEND *PREMOTEUSBBACKEND; + +/** + * Pointer to this structure is queried from USBREMOTEIF::pfnQueryRemoteUsbBackend. + */ +typedef struct REMOTEUSBCALLBACK +{ + PREMOTEUSBBACKEND pInstance; + + DECLCALLBACKMEMBER(int, pfnOpen,(PREMOTEUSBBACKEND pInstance, const char *pszAddress, size_t cbAddress, PREMOTEUSBDEVICE *ppDevice)); + DECLCALLBACKMEMBER(void, pfnClose,(PREMOTEUSBDEVICE pDevice)); + DECLCALLBACKMEMBER(int, pfnReset,(PREMOTEUSBDEVICE pDevice)); + DECLCALLBACKMEMBER(int, pfnSetConfig,(PREMOTEUSBDEVICE pDevice, uint8_t u8Cfg)); + DECLCALLBACKMEMBER(int, pfnClaimInterface,(PREMOTEUSBDEVICE pDevice, uint8_t u8Ifnum)); + DECLCALLBACKMEMBER(int, pfnReleaseInterface,(PREMOTEUSBDEVICE pDevice, uint8_t u8Ifnum)); + DECLCALLBACKMEMBER(int, pfnInterfaceSetting,(PREMOTEUSBDEVICE pDevice, uint8_t u8Ifnum, uint8_t u8Setting)); + DECLCALLBACKMEMBER(int, pfnQueueURB,(PREMOTEUSBDEVICE pDevice, uint8_t u8Type, uint8_t u8Ep, uint8_t u8Direction, uint32_t u32Len, void *pvData, void *pvURB, PREMOTEUSBQURB *ppRemoteURB)); + DECLCALLBACKMEMBER(int, pfnReapURB,(PREMOTEUSBDEVICE pDevice, uint32_t u32Millies, void **ppvURB, uint32_t *pu32Len, uint32_t *pu32Err)); + DECLCALLBACKMEMBER(int, pfnClearHaltedEP,(PREMOTEUSBDEVICE pDevice, uint8_t u8Ep)); + DECLCALLBACKMEMBER(void, pfnCancelURB,(PREMOTEUSBDEVICE pDevice, PREMOTEUSBQURB pRemoteURB)); + DECLCALLBACKMEMBER(int, pfnWakeup,(PREMOTEUSBDEVICE pDevice)); +} REMOTEUSBCALLBACK; +/** Pointer to a remote USB callback table. */ +typedef REMOTEUSBCALLBACK *PREMOTEUSBCALLBACK; + +/** + * Remote USB interface for querying the remote USB callback table for particular client. + * Returned from the *QueryGenericUserObject when passing REMOTEUSBIF_OID as the identifier. + */ +typedef struct REMOTEUSBIF +{ + /** Opaque user data to pass as the first parameter to the callbacks. */ + void *pvUser; + + /** + * Queries the remote USB interface callback table for a given UUID/client ID pair. + * + * @returns Pointer to the remote USB callback table or NULL if the client ID and or UUID is invalid. + * @param pvUser Opaque user data from this interface. + * @param pUuid The device UUID to query the interface for. + * @param idClient The client ID to query the interface for. + */ + DECLCALLBACKMEMBER(PREMOTEUSBCALLBACK, pfnQueryRemoteUsbBackend, (void *pvUser, PCRTUUID pUuid, uint32_t idClient)); +} REMOTEUSBIF; +/** Pointer to a remote USB interface. */ +typedef REMOTEUSBIF *PREMOTEUSBIF; + +/** The UUID to identify the remote USB interface. */ +#define REMOTEUSBIF_OID "87012f58-2ad6-4f89-b7b1-92f72c7ea8cc" + + +typedef struct EMULATEDUSBIF +{ + /** Opaque user data to pass as the first parameter to the callbacks. */ + void *pvUser; + + DECLCALLBACKMEMBER(int, pfnQueryEmulatedUsbDataById, (void *pvUser, const char *pszId, void **ppvEmUsbCb, void **ppvEmUsbCbData, void **ppvObject)); +} EMULATEDUSBIF; +typedef EMULATEDUSBIF *PEMULATEDUSBIF; + +#define EMULATEDUSBIF_OID "b7b4e194-ada0-4722-8e4e-1700ed9064f3" + +/** @} */ + +#endif /* !VBOX_INCLUDED_vrdpusb_h */ |