1 | /* $Id: UsbTestServiceGadgetInternal.h 99739 2023-05-11 01:01:08Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * UsbTestServ - Remote USB test configuration and execution server, Interal gadget interfaces.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2016-2023 Oracle and/or its affiliates.
|
---|
8 | *
|
---|
9 | * This file is part of VirtualBox base platform packages, as
|
---|
10 | * available from https://www.virtualbox.org.
|
---|
11 | *
|
---|
12 | * This program is free software; you can redistribute it and/or
|
---|
13 | * modify it under the terms of the GNU General Public License
|
---|
14 | * as published by the Free Software Foundation, in version 3 of the
|
---|
15 | * License.
|
---|
16 | *
|
---|
17 | * This program is distributed in the hope that it will be useful, but
|
---|
18 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
20 | * General Public License for more details.
|
---|
21 | *
|
---|
22 | * You should have received a copy of the GNU General Public License
|
---|
23 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
---|
24 | *
|
---|
25 | * The contents of this file may alternatively be used under the terms
|
---|
26 | * of the Common Development and Distribution License Version 1.0
|
---|
27 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
---|
28 | * in the VirtualBox distribution, in which case the provisions of the
|
---|
29 | * CDDL are applicable instead of those of the GPL.
|
---|
30 | *
|
---|
31 | * You may elect to license modified versions of this file under the
|
---|
32 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
33 | *
|
---|
34 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
---|
35 | */
|
---|
36 |
|
---|
37 | #ifndef VBOX_INCLUDED_SRC_usb_UsbTestServiceGadgetInternal_h
|
---|
38 | #define VBOX_INCLUDED_SRC_usb_UsbTestServiceGadgetInternal_h
|
---|
39 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
---|
40 | # pragma once
|
---|
41 | #endif
|
---|
42 |
|
---|
43 | #include <iprt/cdefs.h>
|
---|
44 | #include <iprt/types.h>
|
---|
45 |
|
---|
46 | #include "UsbTestServiceGadget.h"
|
---|
47 |
|
---|
48 | RT_C_DECLS_BEGIN
|
---|
49 |
|
---|
50 | /** Pointer to an opaque type dependent gadget host instance data. */
|
---|
51 | typedef struct UTSGADGETCLASSINT *PUTSGADGETCLASSINT;
|
---|
52 | /** Pointer to a gadget host instance pointer. */
|
---|
53 | typedef PUTSGADGETCLASSINT *PPUTSGADGETCLASSINT;
|
---|
54 |
|
---|
55 | /**
|
---|
56 | * Gadget class interface.
|
---|
57 | */
|
---|
58 | typedef struct UTSGADGETCLASSIF
|
---|
59 | {
|
---|
60 | /** The gadget class type implemented. */
|
---|
61 | UTSGADGETCLASS enmClass;
|
---|
62 | /** Description. */
|
---|
63 | const char *pszDesc;
|
---|
64 | /** Size of the class specific instance data. */
|
---|
65 | size_t cbClass;
|
---|
66 |
|
---|
67 | /**
|
---|
68 | * Initializes the gadget class instance.
|
---|
69 | *
|
---|
70 | * @returns IPRT status code.
|
---|
71 | * @param pClass The interface specific instance data.
|
---|
72 | * @param paCfg The configuration of the interface.
|
---|
73 | */
|
---|
74 | DECLR3CALLBACKMEMBER(int, pfnInit, (PUTSGADGETCLASSINT pClass, PCUTSGADGETCFGITEM paCfg));
|
---|
75 |
|
---|
76 | /**
|
---|
77 | * Terminates the gadget class instance.
|
---|
78 | *
|
---|
79 | * @param pClass The interface specific instance data.
|
---|
80 | */
|
---|
81 | DECLR3CALLBACKMEMBER(void, pfnTerm, (PUTSGADGETCLASSINT pClass));
|
---|
82 |
|
---|
83 | /**
|
---|
84 | * Returns the bus ID of the class instance.
|
---|
85 | *
|
---|
86 | * @returns Bus ID.
|
---|
87 | * @param pClass The interface specific instance data.
|
---|
88 | */
|
---|
89 | DECLR3CALLBACKMEMBER(uint32_t, pfnGetBusId, (PUTSGADGETCLASSINT pClass));
|
---|
90 |
|
---|
91 | /**
|
---|
92 | * Connects the gadget.
|
---|
93 | *
|
---|
94 | * @returns IPRT status code.
|
---|
95 | * @param pClass The interface specific instance data.
|
---|
96 | */
|
---|
97 | DECLR3CALLBACKMEMBER(int, pfnConnect, (PUTSGADGETCLASSINT pClass));
|
---|
98 |
|
---|
99 | /**
|
---|
100 | * Disconnect the gadget.
|
---|
101 | *
|
---|
102 | * @returns IPRT status code.
|
---|
103 | * @param pClass The interface specific instance data.
|
---|
104 | */
|
---|
105 | DECLR3CALLBACKMEMBER(int, pfnDisconnect, (PUTSGADGETCLASSINT pClass));
|
---|
106 |
|
---|
107 | } UTSGADGETCLASSIF;
|
---|
108 | /** Pointer to a gadget class callback table. */
|
---|
109 | typedef UTSGADGETCLASSIF *PUTSGADGETCLASSIF;
|
---|
110 | /** Pointer to a const gadget host callback table. */
|
---|
111 | typedef const struct UTSGADGETCLASSIF *PCUTSGADGETCLASSIF;
|
---|
112 |
|
---|
113 | extern UTSGADGETCLASSIF const g_UtsGadgetClassTest;
|
---|
114 |
|
---|
115 | RT_C_DECLS_END
|
---|
116 |
|
---|
117 | #endif /* !VBOX_INCLUDED_SRC_usb_UsbTestServiceGadgetInternal_h */
|
---|
118 |
|
---|