| 1 | /** @file
|
|---|
| 2 | * VBox Remote Desktop Protocol - Remote USB backend interface. (VRDP)
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2006-2020 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_INCLUDED_vrdpusb_h
|
|---|
| 27 | #define VBOX_INCLUDED_vrdpusb_h
|
|---|
| 28 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 29 | # pragma once
|
|---|
| 30 | #endif
|
|---|
| 31 |
|
|---|
| 32 | #include <VBox/cdefs.h>
|
|---|
| 33 | #include <VBox/types.h>
|
|---|
| 34 |
|
|---|
| 35 | #ifdef IN_RING0
|
|---|
| 36 | # error "There are no VRDP APIs available in Ring-0 Host Context!"
|
|---|
| 37 | #endif
|
|---|
| 38 | #ifdef IN_RC
|
|---|
| 39 | # error "There are no VRDP APIs available Guest Context!"
|
|---|
| 40 | #endif
|
|---|
| 41 |
|
|---|
| 42 |
|
|---|
| 43 | /** @defgroup grp_vrdpusb Remote USB over VURP
|
|---|
| 44 | * @ingroup grp_vusb
|
|---|
| 45 | * @{
|
|---|
| 46 | */
|
|---|
| 47 |
|
|---|
| 48 | #define REMOTE_USB_BACKEND_PREFIX_S "REMOTEUSB"
|
|---|
| 49 | #define REMOTE_USB_BACKEND_PREFIX_LEN 9
|
|---|
| 50 |
|
|---|
| 51 | /* Forward declaration. */
|
|---|
| 52 | struct _REMOTEUSBDEVICE;
|
|---|
| 53 | typedef struct _REMOTEUSBDEVICE *PREMOTEUSBDEVICE;
|
|---|
| 54 |
|
|---|
| 55 | /* Forward declaration. */
|
|---|
| 56 | struct _REMOTEUSBQURB;
|
|---|
| 57 | typedef struct _REMOTEUSBQURB *PREMOTEUSBQURB;
|
|---|
| 58 |
|
|---|
| 59 | /* Forward declaration. Actually a class. */
|
|---|
| 60 | struct _REMOTEUSBBACKEND;
|
|---|
| 61 | typedef struct _REMOTEUSBBACKEND *PREMOTEUSBBACKEND;
|
|---|
| 62 |
|
|---|
| 63 | /**
|
|---|
| 64 | * Pointer to this structure is passed to pfnCreateProxyDevice as the device
|
|---|
| 65 | * specific pointer, when creating remote devices.
|
|---|
| 66 | */
|
|---|
| 67 | typedef struct REMOTEUSBCALLBACK
|
|---|
| 68 | {
|
|---|
| 69 | PREMOTEUSBBACKEND pInstance;
|
|---|
| 70 |
|
|---|
| 71 | DECLCALLBACKMEMBER(int, pfnOpen) (PREMOTEUSBBACKEND pInstance, const char *pszAddress, size_t cbAddress, PREMOTEUSBDEVICE *ppDevice);
|
|---|
| 72 | DECLCALLBACKMEMBER(void, pfnClose) (PREMOTEUSBDEVICE pDevice);
|
|---|
| 73 | DECLCALLBACKMEMBER(int, pfnReset) (PREMOTEUSBDEVICE pDevice);
|
|---|
| 74 | DECLCALLBACKMEMBER(int, pfnSetConfig) (PREMOTEUSBDEVICE pDevice, uint8_t u8Cfg);
|
|---|
| 75 | DECLCALLBACKMEMBER(int, pfnClaimInterface) (PREMOTEUSBDEVICE pDevice, uint8_t u8Ifnum);
|
|---|
| 76 | DECLCALLBACKMEMBER(int, pfnReleaseInterface) (PREMOTEUSBDEVICE pDevice, uint8_t u8Ifnum);
|
|---|
| 77 | DECLCALLBACKMEMBER(int, pfnInterfaceSetting) (PREMOTEUSBDEVICE pDevice, uint8_t u8Ifnum, uint8_t u8Setting);
|
|---|
| 78 | DECLCALLBACKMEMBER(int, pfnQueueURB) (PREMOTEUSBDEVICE pDevice, uint8_t u8Type, uint8_t u8Ep, uint8_t u8Direction, uint32_t u32Len, void *pvData, void *pvURB, PREMOTEUSBQURB *ppRemoteURB);
|
|---|
| 79 | DECLCALLBACKMEMBER(int, pfnReapURB) (PREMOTEUSBDEVICE pDevice, uint32_t u32Millies, void **ppvURB, uint32_t *pu32Len, uint32_t *pu32Err);
|
|---|
| 80 | DECLCALLBACKMEMBER(int, pfnClearHaltedEP) (PREMOTEUSBDEVICE pDevice, uint8_t u8Ep);
|
|---|
| 81 | DECLCALLBACKMEMBER(void, pfnCancelURB) (PREMOTEUSBDEVICE pDevice, PREMOTEUSBQURB pRemoteURB);
|
|---|
| 82 | DECLCALLBACKMEMBER(int, pfnWakeup) (PREMOTEUSBDEVICE pDevice);
|
|---|
| 83 | } REMOTEUSBCALLBACK;
|
|---|
| 84 |
|
|---|
| 85 | /** @} */
|
|---|
| 86 |
|
|---|
| 87 | #endif /* !VBOX_INCLUDED_vrdpusb_h */
|
|---|
| 88 |
|
|---|
