1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/* $Id: UsbTestServiceGadgetHostInternal.h $ */
/** @file
* UsbTestServ - Remote USB test configuration and execution server, Gadget API.
*/
/*
* Copyright (C) 2016-2019 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE 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.
*/
#ifndef VBOX_INCLUDED_SRC_usb_UsbTestServiceGadgetHostInternal_h
#define VBOX_INCLUDED_SRC_usb_UsbTestServiceGadgetHostInternal_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <iprt/cdefs.h>
#include <iprt/types.h>
#include "UsbTestServiceGadget.h"
RT_C_DECLS_BEGIN
/** Pointer to an opaque type dependent gadget host instance data. */
typedef struct UTSGADGETHOSTTYPEINT *PUTSGADGETHOSTTYPEINT;
/** Pointer to a gadget host instance pointer. */
typedef PUTSGADGETHOSTTYPEINT *PPUTSGADETHOSTTYPEINT;
/**
* Gadget host interface.
*/
typedef struct UTSGADGETHOSTIF
{
/** The gadget host type implemented. */
UTSGADGETHOSTTYPE enmType;
/** Description. */
const char *pszDesc;
/** Size of the interface specific instance data. */
size_t cbIf;
/**
* Initializes the gadget host interface.
*
* @returns IPRT status code.
* @param pIf The interface specific instance data.
* @param paCfg The configuration of the interface.
*/
DECLR3CALLBACKMEMBER(int, pfnInit, (PUTSGADGETHOSTTYPEINT pIf, PCUTSGADGETCFGITEM paCfg));
/**
* Terminates the gadget host interface.
*
* @returns nothing.
* @param pIf The interface specific instance data.
*/
DECLR3CALLBACKMEMBER(void, pfnTerm, (PUTSGADGETHOSTTYPEINT pIf));
/**
* Adds the given gadget to the host interface.
*
* @returns IPRT status code.
* @param pIf The interface specific instance data.
* @param hGadget The gadget handle to add.
*/
DECLR3CALLBACKMEMBER(int, pfnGadgetAdd, (PUTSGADGETHOSTTYPEINT pIf, UTSGADGET hGadget));
/**
* Removes the given gadget from the host interface.
*
* @returns IPRT status code.
* @param pIf The interface specific instance data.
* @param hGadget The gadget handle to remove.
*/
DECLR3CALLBACKMEMBER(int, pfnGadgetRemove, (PUTSGADGETHOSTTYPEINT pIf, UTSGADGET hGadget));
/**
* Connects the given gadget to the host interface so it appears as connected to the client
* of the gadget host.
*
* @returns IPRT status code.
* @param pIf The interface specific instance data.
* @param hGadget The gadget handle to add.
*/
DECLR3CALLBACKMEMBER(int, pfnGadgetConnect, (PUTSGADGETHOSTTYPEINT pIf, UTSGADGET hGadget));
/**
* Disconnects the given gadget from the host interface so it appears as disconnected to the client
* of the gadget host.
*
* @returns IPRT status code.
* @param pIf The interface specific instance data.
* @param hGadget The gadget handle to add.
*/
DECLR3CALLBACKMEMBER(int, pfnGadgetDisconnect, (PUTSGADGETHOSTTYPEINT pIf, UTSGADGET hGadget));
} UTSGADGETHOSTIF;
/** Pointer to a gadget host callback table. */
typedef UTSGADGETHOSTIF *PUTSGADGETHOSTIF;
/** Pointer to a const gadget host callback table. */
typedef const struct UTSGADGETHOSTIF *PCUTSGADGETHOSTIF;
extern UTSGADGETHOSTIF const g_UtsGadgetHostIfUsbIp;
RT_C_DECLS_END
#endif /* !VBOX_INCLUDED_SRC_usb_UsbTestServiceGadgetHostInternal_h */
|
